Docs: Add Tips section

This commit is contained in:
Adam Porter 2020-11-05 11:21:06 -06:00
parent 028c25c106
commit f88fb549a3
2 changed files with 62 additions and 43 deletions

View file

@ -68,6 +68,7 @@ Installing with [[https://framagit.org/steckerhalter/quelpa][Quelpa]] is easy:
- [[#ancestordescendant-predicates][Ancestor/descendant predicates]] - [[#ancestordescendant-predicates][Ancestor/descendant predicates]]
- [[#datetime-predicates][Date/time predicates]] - [[#datetime-predicates][Date/time predicates]]
- [[#functions--macros][Functions / Macros]] - [[#functions--macros][Functions / Macros]]
- [[#tips][Tips]]
:END: :END:
# These links work on GitHub's Org renderer but not in Org. # These links work on GitHub's Org renderer but not in Org.
@ -395,6 +396,10 @@ Examples:
Expands into a call to ~org-ql-select~ with the same arguments. For convenience, arguments should be unquoted. Expands into a call to ~org-ql-select~ with the same arguments. For convenience, arguments should be unquoted.
** Tips
+ Org QL View buffers can be bookmarked with Emacs bookmark commands, e.g. =C-x r m=. This also integrates with [[https://github.com/alphapapa/org-sidebar][org-sidebar]] and [[https://github.com/alphapapa/burly.el][Burly]].
* Changelog * Changelog
:PROPERTIES: :PROPERTIES:
:TOC: ignore-children :TOC: ignore-children

View file

@ -35,6 +35,7 @@ Usage
* Commands:: * Commands::
* Queries:: * Queries::
* Functions / Macros:: * Functions / Macros::
* Tips::
Commands Commands
@ -153,7 +154,7 @@ File: README.info, Node: Usage, Next: Changelog, Prev: Installation, Up: Top
******* *******
• • • •
• • • • • • • • • •
Feedback on these APIs is welcome. Eventually, after being tested Feedback on these APIs is welcome. Eventually, after being tested
and polished, they will be considered stable. and polished, they will be considered stable.
@ -164,6 +165,7 @@ and polished, they will be considered stable.
* Commands:: * Commands::
* Queries:: * Queries::
* Functions / Macros:: * Functions / Macros::
* Tips::
 
File: README.info, Node: Commands, Next: Queries, Up: Usage File: README.info, Node: Commands, Next: Queries, Up: Usage
@ -542,7 +544,7 @@ number of days. The number can be negative to invert the direction.
scheduled at any time. scheduled at any time.
 
File: README.info, Node: Functions / Macros, Prev: Queries, Up: Usage File: README.info, Node: Functions / Macros, Next: Tips, Prev: Queries, Up: Usage
4.3 Functions / Macros 4.3 Functions / Macros
====================== ======================
@ -708,6 +710,17 @@ File: README.info, Node: Listing / acting-on results, Prev: Agenda-like views,
Expands into a call to org-ql-select with the same arguments. Expands into a call to org-ql-select with the same arguments.
For convenience, arguments should be unquoted. For convenience, arguments should be unquoted.

File: README.info, Node: Tips, Prev: Functions / Macros, Up: Usage
4.4 Tips
========
• Org QL View buffers can be bookmarked with Emacs bookmark commands,
e.g. C-x r m. This also integrates with org-sidebar
(https://github.com/alphapapa/org-sidebar) and Burly
(https://github.com/alphapapa/burly.el).
 
File: README.info, Node: Changelog, Next: Notes, Prev: Usage, Up: Top File: README.info, Node: Changelog, Next: Notes, Prev: Usage, Up: Top
@ -1169,47 +1182,48 @@ GPLv3
 
Tag Table: Tag Table:
Node: Top225 Node: Top225
Node: Contents1512 Node: Contents1521
Node: Screenshots1635 Node: Screenshots1644
Node: Installation1753 Node: Installation1762
Node: Quelpa2391 Node: Quelpa2400
Node: Usage2834 Node: Usage2843
Node: Commands3183 Node: Commands3205
Node: org-ql-search3656 Node: org-ql-search3678
Node: helm-org-ql5370 Node: helm-org-ql5392
Node: org-ql-view5782 Node: org-ql-view5804
Node: org-ql-view-sidebar6282 Node: org-ql-view-sidebar6304
Node: org-ql-view-recent-items6638 Node: org-ql-view-recent-items6660
Node: org-ql-sparse-tree7122 Node: org-ql-sparse-tree7144
Node: Queries7922 Node: Queries7944
Node: Non-sexp query syntax8830 Node: Non-sexp query syntax8852
Node: General predicates10537 Node: General predicates10559
Node: Ancestor/descendant predicates15752 Node: Ancestor/descendant predicates15774
Node: Date/time predicates16880 Node: Date/time predicates16902
Node: Functions / Macros19535 Node: Functions / Macros19557
Node: Agenda-like views19768 Node: Agenda-like views19803
Node: Listing / acting-on results21173 Node: Listing / acting-on results21208
Node: Changelog25775 Node: Tips25810
Node: 05-pre26414 Node: Changelog26141
Node: 04627003 Node: 05-pre26780
Node: 04527406 Node: 04627369
Node: 04427765 Node: 04527772
Node: 04328122 Node: 04428131
Node: 04228317 Node: 04328488
Node: 04128476 Node: 04228683
Node: 0428715 Node: 04128842
Node: 03232646 Node: 0429081
Node: 03133023 Node: 03233012
Node: 0333220 Node: 03133389
Node: 02336195 Node: 0333586
Node: 02236423 Node: 02336561
Node: 02136691 Node: 02236789
Node: 0236890 Node: 02137057
Node: 0140925 Node: 0237256
Node: Notes41026 Node: 0141291
Node: Comparison with Org Agenda searches41188 Node: Notes41392
Node: org-sidebar42060 Node: Comparison with Org Agenda searches41554
Node: License42339 Node: org-sidebar42426
Node: License42705
 
End Tag Table End Tag Table