Docs: Improve ToCs
This commit is contained in:
parent
1f79632372
commit
c4f9a58fd6
2 changed files with 92 additions and 85 deletions
106
org-ql.info
106
org-ql.info
|
|
@ -93,7 +93,8 @@ File: README.info, Node: Contents, Next: Screenshots, Prev: Top, Up: Top
|
|||
**********
|
||||
|
||||
• • •
|
||||
• • • • •
|
||||
• •
|
||||
• • • • • •
|
||||
|
||||
File: README.info, Node: Screenshots, Next: Installation, Prev: Contents, Up: Top
|
||||
|
||||
|
|
@ -145,22 +146,7 @@ File: README.info, Node: Usage, Next: Changelog, Prev: Installation, Up: Top
|
|||
4 Usage
|
||||
*******
|
||||
|
||||
These commands and functions are included:
|
||||
|
||||
• *Showing an agenda-like view:*
|
||||
• ‘org-ql-search’ (command)
|
||||
• ‘org-ql-view’ (command)
|
||||
• ‘org-ql-view-sidebar’ (command)
|
||||
• ‘org-ql-block’ (agenda block function)
|
||||
• *Showing a tree in a buffer:*
|
||||
• ‘org-ql-sparse-tree’ (command)
|
||||
• *Showing results with Helm*:
|
||||
• ‘helm-org-ql’ (command)
|
||||
• *Returning a list of matches or acting on them:*
|
||||
• ‘org-ql’ (macro)
|
||||
• ‘org-ql-select’ (function)
|
||||
• ‘org-ql-query’ (function)
|
||||
|
||||
• • •
|
||||
Feedback on these APIs is welcome. Eventually, after being tested
|
||||
and polished, they will be considered stable.
|
||||
|
||||
|
|
@ -178,6 +164,16 @@ File: README.info, Node: Commands, Next: Queries, Up: Usage
|
|||
4.1 Commands
|
||||
============
|
||||
|
||||
• *Showing an agenda-like view:*
|
||||
• (command)
|
||||
• (command)
|
||||
• (command)
|
||||
• (command)
|
||||
• *Showing a tree in a buffer:*
|
||||
• (command)
|
||||
• *Showing results with Helm*:
|
||||
• (command)
|
||||
|
||||
* Menu:
|
||||
|
||||
* org-ql-search::
|
||||
|
|
@ -298,10 +294,11 @@ 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 Org
|
||||
buffer; when it returns non-nil, the heading matches the query.
|
||||
• • •
|
||||
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
|
||||
Org buffer; when it returns non-nil, the heading matches the query.
|
||||
|
||||
*Notes:*
|
||||
• Bare strings like ‘"string"’ are automatically converted to
|
||||
|
|
@ -511,6 +508,9 @@ File: README.info, Node: Functions / Macros, Prev: Queries, Up: Usage
|
|||
4.3 Functions / Macros
|
||||
======================
|
||||
|
||||
•
|
||||
• •
|
||||
• • •
|
||||
* Menu:
|
||||
|
||||
* Agenda-like views::
|
||||
|
|
@ -1006,38 +1006,38 @@ GPLv3
|
|||
Tag Table:
|
||||
Node: Top225
|
||||
Node: Contents1367
|
||||
Node: Screenshots1515
|
||||
Node: Installation1633
|
||||
Node: Quelpa2271
|
||||
Node: Usage2714
|
||||
Node: Commands3624
|
||||
Node: org-ql-search3853
|
||||
Node: helm-org-ql5501
|
||||
Node: org-ql-view5913
|
||||
Node: org-ql-view-sidebar6111
|
||||
Node: org-ql-view-recent-items6467
|
||||
Node: org-ql-sparse-tree6951
|
||||
Node: Queries7751
|
||||
Node: Non-sexp query syntax8593
|
||||
Node: Predicates10292
|
||||
Node: Date/time predicates15454
|
||||
Node: Functions / Macros18089
|
||||
Node: Agenda-like views18276
|
||||
Node: Listing / acting-on results19681
|
||||
Node: Changelog24283
|
||||
Node: 04-pre24820
|
||||
Node: 03226835
|
||||
Node: 03127216
|
||||
Node: 0327411
|
||||
Node: 02330384
|
||||
Node: 02230610
|
||||
Node: 02130876
|
||||
Node: 0231073
|
||||
Node: 0135106
|
||||
Node: Notes35205
|
||||
Node: Comparison with Org Agenda searches35367
|
||||
Node: org-sidebar36238
|
||||
Node: License36517
|
||||
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 predicates15157
|
||||
Node: Functions / Macros17792
|
||||
Node: Agenda-like views18025
|
||||
Node: Listing / acting-on results19430
|
||||
Node: Changelog24032
|
||||
Node: 04-pre24569
|
||||
Node: 03226584
|
||||
Node: 03126965
|
||||
Node: 0327160
|
||||
Node: 02330133
|
||||
Node: 02230359
|
||||
Node: 02130625
|
||||
Node: 0230822
|
||||
Node: 0134855
|
||||
Node: Notes34954
|
||||
Node: Comparison with Org Agenda searches35116
|
||||
Node: org-sidebar35987
|
||||
Node: License36266
|
||||
|
||||
End Tag Table
|
||||
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue