branch: externals/taxy
commit 6382bec8ceecdef746b7a89bd3de85a7448ae8fc
Author: Adam Porter <a...@alphapapa.net>
Commit: Adam Porter <a...@alphapapa.net>
Docs: Update summary
---
README.org | 2 +
taxy.info | 228 ++++++++++++++++++++++++++++++-------------------------------
2 files changed, 113 insertions(+), 117 deletions(-)
diff --git a/README.org b/README.org
index 297f881..0d90f38 100644
--- a/README.org
+++ b/README.org
@@ -16,6 +16,8 @@ Helpful features include:
+ Dynamic taxonomies :: Objects may be classified into hierarchies
automatically defined at runtime based on their attributes.
+ Reusable taxonomies :: Taxonomy definitions may be stored in variables and
reused in other taxonomies' descendant groups.
++ Classification domain-specific language :: Easily define a custom DSL used
to classify items dynamically (which can be extended by users).
++ Flexible table view :: Based on =magit-section=, with easily defined
columns (also extendable by users).
* Contents :noexport:
:PROPERTIES:
diff --git a/taxy.info b/taxy.info
index a098e48..ca9ce83 100644
--- a/taxy.info
+++ b/taxy.info
@@ -1,4 +1,4 @@
-This is README.info, produced by makeinfo version 5.2 from README.texi.
+This is README.info, produced by makeinfo version 6.5 from README.texi.
INFO-DIR-SECTION Emacs
START-INFO-DIR-ENTRY
@@ -11,6 +11,30 @@ File: README.info, Node: Top, Next: Examples, Up: (dir)
taxy.el
*******
+https://elpa.gnu.org/packages/taxy.svg
+(https://elpa.gnu.org/packages/taxy.html)
+
+ _Now, where did I put that..._
+
+ This library provides a programmable way to classify arbitrary
+objects into a hierarchical taxonomy. (That’s a lot of fancy words to
+say that this lets you automatically put things in nested groups.)
+
+ Helpful features include:
+
+Dynamic taxonomies
+ Objects may be classified into hierarchies automatically defined at
+ runtime based on their attributes.
+Reusable taxonomies
+ Taxonomy definitions may be stored in variables and reused in other
+ taxonomies’ descendant groups.
+Classification domain-specific language
+ Easily define a custom DSL used to classify items dynamically
+ (which can be extended by users).
+Flexible table view
+ Based on ‘magit-section’, with easily defined columns (also
+ extendable by users).
+
* Menu:
* Examples::
@@ -30,9 +54,6 @@ Examples
* Sporty (understanding completely)::
* Applications::
-
-
-
Usage
* Reusable taxys::
@@ -41,73 +62,46 @@ Usage
* Dynamic taxys::
* Magit section::
-
-
-
Dynamic taxys
* Multi-level dynamic taxys::
-* "Chains" of independent, multi-level dynamic taxys: "Chains" of independent
multi-level dynamic taxys.
+* "Chains" of independent, multi-level dynamic taxys: "Chains" of independent
multi-level dynamic taxys.
* Defining a classification domain-specific language::
Changelog
-* 0.7-pre: 07-pre.
-* 0.6: 06.
-* 0.5: 05.
-* 0.4: 04.
-* 0.3: 03.
-* 0.2: 02.
-* 0.1: 01.
-
+* 0.7-pre: 07-pre.
+* 0.6: 06.
+* 0.5: 05.
+* 0.4: 04.
+* 0.3: 03.
+* 0.2: 02.
+* 0.1: 01.
0.6
* Additions::
-
0.5
-* Additions: Additionsx.
+* Additions: Additions (1).
* Fixes::
-
-
-
0.3
* Changes::
-* Fixes: Fixesx.
-
-
+* Fixes: Fixes (1).
0.2
-* Changes: Changesx.
-* Additions: Additionsxx.
-* Fixes: Fixesxx.
+* Changes: Changes (1).
+* Additions: Additions (2).
+* Fixes: Fixes (2).
Development
* Copyright assignment::
-<https://elpa.gnu.org/packages/taxy.svg>
-(https://elpa.gnu.org/packages/taxy.html)
-
- _Now, where did I put that…_
-
- This library provides a programmable way to classify arbitrary
-objects into a hierarchical taxonomy. (That’s a lot of fancy words to
-say that this lets you automatically put things in nested groups.)
-
- Helpful features include:
-
-‘Dynamic taxonomies’
- Objects may be classified into hierarchies automatically defined at
- runtime based on their attributes.
-‘Reusable taxonomies’
- Taxonomy definitions may be stored in variables and reused in other
- taxonomies’ descendant groups.
File: README.info, Node: Examples, Next: Installation, Prev: Top, Up: Top
@@ -164,8 +158,8 @@ Let’s imagine a silly taxonomy of numbers below 100:
(10 25 35 50 55 65 70 85 95))))))
You might think about how to produce that by writing some imperative
-code, but taxy allows you to do so in a more declarative and functional
-manner:
+code, but ‘taxy’ allows you to do so in a more declarative and
+functional manner:
(require 'taxy)
@@ -268,7 +262,7 @@ first taxy, i.e. non-vowels.
("Consonants" "Well, if they aren't vowels..."
("B" "C" "D" "F" "G" "H" "J" "K" "L" "M" "N"))))
- Oops, we forgot the letters after N! Let’s add them, too:
+ Oops, we forgot the letters after N! Let’s add them, too:
(taxy-plain
(taxy-fill (reverse
@@ -500,8 +494,8 @@ File: README.info, Node: Installation, Next: Usage,
Prev: Examples, Up: Top
2 Installation
**************
-taxy is distributed in GNU ELPA (https://elpa.gnu.org/), which is
-available in Emacs by default. Use M-x package-install RET taxy RET,
+‘taxy’ is distributed in GNU ELPA (https://elpa.gnu.org/), which is
+available in Emacs by default. Use ‘M-x package-install RET taxy RET’,
then ‘(require 'taxy)’ in your Elisp project.
@@ -562,8 +556,8 @@ File: README.info, Node: Reusable taxys, Next: Threading
macros, Up: Usage
Since taxys are structs, they may be stored in variables and used in
other structs (being sure to copy the root taxy with ‘taxy-emptied’
-before filling). For example, this shows using taxy to classify Matrix
-rooms in Ement.el (https://github.com/alphapapa/ement.el):
+before filling). For example, this shows using ‘taxy’ to classify
+Matrix rooms in Ement.el (https://github.com/alphapapa/ement.el):
(defun ement-roomy-buffer (room)
(alist-get 'buffer (ement-room-local room)))
@@ -697,7 +691,7 @@ File: README.info, Node: Dynamic taxys, Next: Magit
section, Prev: Modifying
• • •
You may not always know in advance what taxonomy a set of objects
-fits into, so taxy lets you add taxys dynamically by using the ‘:take’
+fits into, so ‘taxy’ lets you add taxys dynamically by using the ‘:take’
function to add a taxy when an object is "taken into" a parent taxy’s
items. For example, you could dynamically classify buffers by their
major mode like so:
@@ -753,7 +747,7 @@ and it produces this taxonomy of buffers:
* Menu:
* Multi-level dynamic taxys::
-* "Chains" of independent, multi-level dynamic taxys: "Chains" of independent
multi-level dynamic taxys.
+* "Chains" of independent, multi-level dynamic taxys: "Chains" of independent
multi-level dynamic taxys.
* Defining a classification domain-specific language::
@@ -1008,7 +1002,7 @@ File: README.info, Node: Magit section, Prev: Dynamic
taxys, Up: Usage
3.5 Magit section
=================
-Showing a taxy with magit-section is very easy:
+Showing a ‘taxy’ with ‘magit-section’ is very easy:
(require 'taxy-magit-section)
@@ -1020,8 +1014,8 @@ Showing a taxy with magit-section is very easy:
That shows a buffer like this:
- Note that while taxy-magit-section.el is installed with the taxy
-package, the magit-section package is not automatically installed with
+ Note that while ‘taxy-magit-section.el’ is installed with the ‘taxy’
+package, the ‘magit-section’ package is not automatically installed with
it.
@@ -1032,13 +1026,13 @@ File: README.info, Node: Changelog, Next:
Development, Prev: Usage, Up: Top
* Menu:
-* 0.7-pre: 07-pre.
-* 0.6: 06.
-* 0.5: 05.
-* 0.4: 04.
-* 0.3: 03.
-* 0.2: 02.
-* 0.1: 01.
+* 0.7-pre: 07-pre.
+* 0.6: 06.
+* 0.5: 05.
+* 0.4: 04.
+* 0.3: 03.
+* 0.2: 02.
+* 0.1: 01.
File: README.info, Node: 07-pre, Next: 06, Up: Changelog
@@ -1084,7 +1078,7 @@ File: README.info, Node: Additions, Up: 06
indentation to each item. (Used to disable that behavior when
items are pre-indented strings, e.g. as formatted by
‘taxy-magit-section-format-items’.)
- • Example application deffy, which shows an overview of top-level
+ • Example application ‘deffy’, which shows an overview of top-level
definitions and forms in an Elisp project or file. (Likely to be
published as a separate package later.)
@@ -1096,11 +1090,11 @@ File: README.info, Node: 05, Next: 04, Prev: 06,
Up: Changelog
* Menu:
-* Additions: Additionsx.
+* Additions: Additions (1).
* Fixes::
-File: README.info, Node: Additionsx, Next: Fixes, Up: 05
+File: README.info, Node: Additions (1), Next: Fixes, Up: 05
4.3.1 Additions
---------------
@@ -1122,7 +1116,7 @@ File: README.info, Node: Additionsx, Next: Fixes, Up:
05
• New example ‘taxy-package-report’.
-File: README.info, Node: Fixes, Prev: Additionsx, Up: 05
+File: README.info, Node: Fixes, Prev: Additions (1), Up: 05
4.3.2 Fixes
-----------
@@ -1147,21 +1141,21 @@ File: README.info, Node: 03, Next: 02, Prev: 04,
Up: Changelog
* Menu:
* Changes::
-* Fixes: Fixesx.
+* Fixes: Fixes (1).
-File: README.info, Node: Changes, Next: Fixesx, Up: 03
+File: README.info, Node: Changes, Next: Fixes (1), Up: 03
4.5.1 Changes
-------------
- • Within the ‘taxy’ struct and related functions, the term objects is
- renamed to items, which is shorter and has the same meaning. This
- makes code a bit more concise (e.g. ‘(taxy-objects taxy)’ becomes
- ‘(taxy-items taxy)’).
+ • Within the ‘taxy’ struct and related functions, the term ‘objects’
+ is renamed to ‘items’, which is shorter and has the same meaning.
+ This makes code a bit more concise (e.g. ‘(taxy-objects taxy)’
+ becomes ‘(taxy-items taxy)’).
-File: README.info, Node: Fixesx, Prev: Changes, Up: 03
+File: README.info, Node: Fixes (1), Prev: Changes, Up: 03
4.5.2 Fixes
-----------
@@ -1180,12 +1174,12 @@ File: README.info, Node: 02, Next: 01, Prev: 03,
Up: Changelog
* Menu:
-* Changes: Changesx.
-* Additions: Additionsxx.
-* Fixes: Fixesxx.
+* Changes: Changes (1).
+* Additions: Additions (2).
+* Fixes: Fixes (2).
-File: README.info, Node: Changesx, Next: Additionsxx, Up: 02
+File: README.info, Node: Changes (1), Next: Additions (2), Up: 02
4.6.1 Changes
-------------
@@ -1195,7 +1189,7 @@ File: README.info, Node: Changesx, Next: Additionsxx,
Up: 02
reason to maintain two versions.
-File: README.info, Node: Additionsxx, Next: Fixesxx, Prev: Changesx, Up: 02
+File: README.info, Node: Additions (2), Next: Fixes (2), Prev: Changes (1),
Up: 02
4.6.2 Additions
---------------
@@ -1210,10 +1204,10 @@ File: README.info, Node: Additionsxx, Next: Fixesxx,
Prev: Changesx, Up: 02
now be a function or a list of functions (or a list of a list of
functions, etc.). Lists of functions create "chains" of
independent, dynamic taxys descending from a single root taxy. See
- *note example: "Chains" of independent multi-level dynamic taxys.
+ .
-File: README.info, Node: Fixesxx, Prev: Additionsxx, Up: 02
+File: README.info, Node: Fixes (2), Prev: Additions (2), Up: 02
4.6.3 Fixes
-----------
@@ -1252,7 +1246,7 @@ This package is part of GNU Emacs
(https://www.gnu.org/software/emacs/),
being distributed in GNU ELPA (https://elpa.gnu.org/). Contributions to
this project must follow GNU guidelines, which means that, as with other
parts of Emacs, patches of more than a few lines must be accompanied by
-having assigned copyright for the contribution to the FSF. Contributors
+having assigned copyright for the contribution to the FSF. Contributors
who wish to do so may contact emacs-de...@gnu.org <emacs-de...@gnu.org>
to request the assignment form.
@@ -1277,41 +1271,41 @@ GPLv3
Tag Table:
Node: Top218
-Node: Examples1849
-Node: Numbery (starting basically)2168
-Node: Lettery (filling incrementally)7923
-Node: Sporty (understanding completely)10436
-Node: Applications16423
-Node: Installation16823
-Node: Usage17124
-Node: Reusable taxys19261
-Node: Threading macros23408
-Node: Modifying filled taxys23947
-Node: Dynamic taxys24765
-Node: Multi-level dynamic taxys27409
-Node: "Chains" of independent multi-level dynamic taxys29602
-Node: Defining a classification domain-specific language32533
-Node: Magit section36696
-Node: Changelog37345
-Node: 07-pre37555
-Node: 0637661
-Node: Additions37776
-Node: 0539116
-Node: Additionsx39249
-Node: Fixes40352
-Node: 0440503
-Node: 0340725
-Node: Changes40852
-Node: Fixesx41201
-Node: 0241633
-Node: Changesx41798
-Node: Additionsxx42085
-Node: Fixesxx43001
-Node: 0143251
-Node: Development43350
-Node: Copyright assignment43556
-Node: Credits44143
-Node: License44333
+Node: Examples2085
+Node: Numbery (starting basically)2404
+Node: Lettery (filling incrementally)8165
+Node: Sporty (understanding completely)10679
+Node: Applications16666
+Node: Installation17066
+Node: Usage17379
+Node: Reusable taxys19516
+Node: Threading macros23669
+Node: Modifying filled taxys24208
+Node: Dynamic taxys25026
+Node: Multi-level dynamic taxys27675
+Node: "Chains" of independent multi-level dynamic taxys29868
+Node: Defining a classification domain-specific language32799
+Node: Magit section36962
+Node: Changelog37641
+Node: 07-pre37844
+Node: 0637950
+Node: Additions38065
+Node: 0539411
+Node: Additions (1)39546
+Node: Fixes40652
+Node: 0440806
+Node: 0341028
+Node: Changes41157
+Node: Fixes (1)41520
+Node: 0241955
+Node: Changes (1)42124
+Node: Additions (2)42416
+Node: Fixes (2)43275
+Node: 0143529
+Node: Development43628
+Node: Copyright assignment43834
+Node: Credits44422
+Node: License44612
End Tag Table
