From 8f2baa10a3573b1f487dbc176dc68adcd88d370d Mon Sep 17 00:00:00 2001 From: Adam Porter Date: Wed, 22 Jan 2020 23:02:10 -0600 Subject: [PATCH] Docs: Fix ToC, info file --- README.org | 13 ++++-- org-ql.info | 123 ++++++++++++++++++++++++++++++---------------------- 2 files changed, 82 insertions(+), 54 deletions(-) diff --git a/README.org b/README.org index 46ff63a..0103630 100644 --- a/README.org +++ b/README.org @@ -60,10 +60,17 @@ Installing with [[https://framagit.org/steckerhalter/quelpa][Quelpa]] is easy: #+END_SRC * Usage +:PROPERTIES: +:TOC: :include descendants :depth 1 +:END: :CONTENTS: -- [[#commands][Commands]] -- [[#queries][Queries]] -- [[#functions--macros][Functions / Macros]] +- [[#commands][Commands]] +- [[#queries][Queries]] + - [[#non-sexp-query-syntax][Non-sexp query syntax]] + - [[#general-predicates][General predicates]] + - [[#ancestordescendant-predicates][Ancestor/descendant predicates]] + - [[#datetime-predicates][Date/time predicates]] +- [[#functions--macros][Functions / Macros]] :END: # These links work on GitHub's Org renderer but not in Org. diff --git a/org-ql.info b/org-ql.info index 5184668..08b38c5 100644 --- a/org-ql.info +++ b/org-ql.info @@ -50,7 +50,8 @@ Commands Queries * Non-sexp query syntax:: -* Predicates:: +* General predicates:: +* Ancestor/descendant predicates:: * Date/time predicates:: @@ -146,7 +147,8 @@ File: README.info, Node: Usage, Next: Changelog, Prev: Installation, Up: Top 4 Usage ******* - • • • + • • + • • • • • Feedback on these APIs is welcome. Eventually, after being tested and polished, they will be considered stable. @@ -294,7 +296,7 @@ File: README.info, Node: Queries, Next: Functions / Macros, Prev: Commands, 4.2 Queries =========== - • • • + • • • • An org-ql query is a lisp form which may contain arbitrary lisp forms, as well as certain built-in predicates. It is byte-compiled into a predicate function which is tested with point on each heading in an @@ -311,11 +313,12 @@ Org buffer; when it returns non-nil, the heading matches the query. * Menu: * Non-sexp query syntax:: -* Predicates:: +* General predicates:: +* Ancestor/descendant predicates:: * Date/time predicates::  -File: README.info, Node: Non-sexp query syntax, Next: Predicates, Up: Queries +File: README.info, Node: Non-sexp query syntax, Next: General predicates, Up: Queries 4.2.1 Non-sexp query syntax --------------------------- @@ -345,24 +348,16 @@ non-sexp syntax, so multiple priorities should be passed instead, as seen in the last example.  -File: README.info, Node: Predicates, Next: Date/time predicates, Prev: Non-sexp query syntax, Up: Queries +File: README.info, Node: General predicates, Next: Ancestor/descendant predicates, Prev: Non-sexp query syntax, Up: Queries -4.2.2 Predicates ----------------- +4.2.2 General predicates +------------------------ Arguments are listed next to predicate names, where applicable. ‘category (&optional categories)’ Return non-nil if current heading is in one or more of ‘CATEGORIES’ (a list of strings). -‘children (&optional query)’ - Return non-nil if current heading has direct child headings. If - ‘QUERY’, test it against child headings. This selector may be - nested, e.g. to match grandchild headings. -‘descendants (&optional query)’ - Return non-nil if current heading has descendant headings. If - ‘QUERY’, test it against descendant headings. This selector may be - nested (if you can grok the nesting!). ‘done’ Return non-nil if entry’s ‘TODO’ keyword is in ‘org-done-keywords’. ‘habit’ @@ -444,9 +439,32 @@ Arguments are listed next to predicate names, where applicable. ‘org-done-keywords’).  -File: README.info, Node: Date/time predicates, Prev: Predicates, Up: Queries +File: README.info, Node: Ancestor/descendant predicates, Next: Date/time predicates, Prev: General predicates, Up: Queries -4.2.3 Date/time predicates +4.2.3 Ancestor/descendant predicates +------------------------------------ + +‘ancestors (&optional query)’ + Return non-nil if current heading has ancestor headings. If + ‘QUERY’, return non-nil if an ancestor heading matches it. This + selector may be nested. +‘children (&optional query)’ + Return non-nil if current heading has direct child headings. If + ‘QUERY’, return non-nil if a child heading matches it. This + selector may be nested, e.g. to match grandchild headings. +‘descendants (&optional query)’ + Return non-nil if current heading has descendant headings. If + ‘QUERY’, return non-nil if a descendant heading matches it. This + selector may be nested (if you can grok the nesting!). +‘parent (&optional query)’ + Return non-nil if current heading has a direct parent heading. If + ‘QUERY’, return non-nil if the parent heading matches it. This + selector may be nested, e.g. to match grandparent headings. + + +File: README.info, Node: Date/time predicates, Prev: Ancestor/descendant predicates, Up: Queries + +4.2.4 Date/time predicates -------------------------- All of these predicates take optional keyword arguments ‘:from’, ‘:to:’, @@ -722,6 +740,8 @@ will be pushed to the master branch when ready. • Predicates outline-path (alias olp) and outline-path-segment (alias olps). • Predicate ‘src’, which matches Org Babel source blocks. + • Predicates parent and ancestors. (Thanks to Josh Moller-Mara + (https://github.com/mm--).) • Alias h for heading predicate. • Alias r for regexp predicate. (Thanks to Feng Shu (https://github.com/tumashu).) @@ -1037,39 +1057,40 @@ GPLv3  Tag Table: Node: Top225 -Node: Contents1367 -Node: Screenshots1541 -Node: Installation1659 -Node: Quelpa2297 -Node: Usage2740 -Node: Commands3064 -Node: org-ql-search3537 -Node: helm-org-ql5185 -Node: org-ql-view5597 -Node: org-ql-view-sidebar5795 -Node: org-ql-view-recent-items6151 -Node: org-ql-sparse-tree6635 -Node: Queries7435 -Node: Non-sexp query syntax8296 -Node: Predicates9995 -Node: Date/time predicates15217 -Node: Functions / Macros17852 -Node: Agenda-like views18085 -Node: Listing / acting-on results19490 -Node: Changelog24092 -Node: 04-pre24629 -Node: 03228251 -Node: 03128632 -Node: 0328827 -Node: 02331800 -Node: 02232026 -Node: 02132292 -Node: 0232489 -Node: 0136522 -Node: Notes36621 -Node: Comparison with Org Agenda searches36783 -Node: org-sidebar37654 -Node: License37933 +Node: Contents1410 +Node: Screenshots1584 +Node: Installation1702 +Node: Quelpa2340 +Node: Usage2783 +Node: Commands3132 +Node: org-ql-search3605 +Node: helm-org-ql5253 +Node: org-ql-view5665 +Node: org-ql-view-sidebar5863 +Node: org-ql-view-recent-items6219 +Node: org-ql-sparse-tree6703 +Node: Queries7503 +Node: Non-sexp query syntax8411 +Node: General predicates10118 +Node: Ancestor/descendant predicates14925 +Node: Date/time predicates16053 +Node: Functions / Macros18708 +Node: Agenda-like views18941 +Node: Listing / acting-on results20346 +Node: Changelog24948 +Node: 04-pre25485 +Node: 03229219 +Node: 03129600 +Node: 0329795 +Node: 02332768 +Node: 02232994 +Node: 02133260 +Node: 0233457 +Node: 0137490 +Node: Notes37589 +Node: Comparison with Org Agenda searches37751 +Node: org-sidebar38622 +Node: License38901  End Tag Table