Docs: Update changelog, Usage
This commit is contained in:
parent
58d29d0fff
commit
2319fc9d8b
2 changed files with 113 additions and 77 deletions
|
|
@ -119,6 +119,12 @@ Note that these commands are compatible with [[https://github.com/oantolin/embar
|
||||||
|
|
||||||
[[images/org-ql-find.png]]
|
[[images/org-ql-find.png]]
|
||||||
|
|
||||||
|
*** org-ql-open-link
|
||||||
|
|
||||||
|
This command finds links in entries matching the input query and offers them for selection; the selected link is then opened with ~org-open-at-point~.
|
||||||
|
|
||||||
|
The input is matched using the default predicate, which means it searches both entry content and outline paths. This is helpful when a collection of links are kept in Org files: rather than having to first visit the entry containing the desired link, then locate it within the entry, and then open it, the user can simply select the link and open it directly. For example, if an entry with the heading =Emacs= contained a link named =mailing list=, one could search for =Emacs list= and open the link to the mailing list directly.
|
||||||
|
|
||||||
*** org-ql-refile
|
*** org-ql-refile
|
||||||
|
|
||||||
This command refiles the current Org entry to one selected by searching with Org QL completion. It searches files listed in ~org-refile-targets~ as well as the current buffer.
|
This command refiles the current Org entry to one selected by searching with Org QL completion. It searches files listed in ~org-refile-targets~ as well as the current buffer.
|
||||||
|
|
@ -554,6 +560,7 @@ Simple links may also be written manually in either sexp or non-sexp form, like:
|
||||||
+ Function ~org-ql-completing-read~, used by command ~org-ql-find~, now specifies the completion category as ~org-heading~, providing compatibility with [[https://github.com/oantolin/embark][Embark]]. (This is a powerful feature, as it means any ~org-ql-find~ result can be acted on from inside the search results with Embark, which provides common actions from Org Agenda and Org speed keys bindings.) ([[https://github.com/alphapapa/org-ql/issues/299][#299]]. Thanks to [[https://github.com/oantolin][Omar Antolín Camarena]], [[https://github.com/minad][Daniel Mendler]], and [[https://github.com/akirak][Akira Komamura]].)
|
+ Function ~org-ql-completing-read~, used by command ~org-ql-find~, now specifies the completion category as ~org-heading~, providing compatibility with [[https://github.com/oantolin/embark][Embark]]. (This is a powerful feature, as it means any ~org-ql-find~ result can be acted on from inside the search results with Embark, which provides common actions from Org Agenda and Org speed keys bindings.) ([[https://github.com/alphapapa/org-ql/issues/299][#299]]. Thanks to [[https://github.com/oantolin][Omar Antolín Camarena]], [[https://github.com/minad][Daniel Mendler]], and [[https://github.com/akirak][Akira Komamura]].)
|
||||||
+ Command ~org-ql-find~ may be called in an ~org-agenda~ or ~org-ql-view~ buffer to search the buffers which contributed to the agenda/view buffer.
|
+ Command ~org-ql-find~ may be called in an ~org-agenda~ or ~org-ql-view~ buffer to search the buffers which contributed to the agenda/view buffer.
|
||||||
+ Command ~org-ql-find-path~, which searches outline paths in the current buffer.
|
+ Command ~org-ql-find-path~, which searches outline paths in the current buffer.
|
||||||
|
+ Command ~org-ql-open-link~, which finds links in entries matching the given query, and opens the selected one with ~org-open-at-point~. (This is helpful when a collection of links are kept in Org files: rather than having to first visit the entry containing the desired link, then locate it within the entry, and then open it, the user can simply select the link and open it directly.)
|
||||||
|
|
||||||
*Compatibility*
|
*Compatibility*
|
||||||
|
|
||||||
|
|
|
||||||
183
org-ql.info
183
org-ql.info
|
|
@ -48,6 +48,7 @@ Usage
|
||||||
Commands
|
Commands
|
||||||
|
|
||||||
* org-ql-find::
|
* org-ql-find::
|
||||||
|
* org-ql-open-link::
|
||||||
* org-ql-refile::
|
* org-ql-refile::
|
||||||
* org-ql-search::
|
* org-ql-search::
|
||||||
* helm-org-ql::
|
* helm-org-ql::
|
||||||
|
|
@ -207,6 +208,7 @@ File: README.info, Node: Commands, Next: Queries, Up: Usage
|
||||||
* Menu:
|
* Menu:
|
||||||
|
|
||||||
* org-ql-find::
|
* org-ql-find::
|
||||||
|
* org-ql-open-link::
|
||||||
* org-ql-refile::
|
* org-ql-refile::
|
||||||
* org-ql-search::
|
* org-ql-search::
|
||||||
* helm-org-ql::
|
* helm-org-ql::
|
||||||
|
|
@ -216,7 +218,7 @@ File: README.info, Node: Commands, Next: Queries, Up: Usage
|
||||||
* org-ql-sparse-tree::
|
* org-ql-sparse-tree::
|
||||||
|
|
||||||
|
|
||||||
File: README.info, Node: org-ql-find, Next: org-ql-refile, Up: Commands
|
File: README.info, Node: org-ql-find, Next: org-ql-open-link, Up: Commands
|
||||||
|
|
||||||
4.1.1 org-ql-find
|
4.1.1 org-ql-find
|
||||||
-----------------
|
-----------------
|
||||||
|
|
@ -237,9 +239,28 @@ called on a completion candidate (i.e. a search result) to act on it
|
||||||
immediately, without having to visit the entry in its source Org buffer.
|
immediately, without having to visit the entry in its source Org buffer.
|
||||||
|
|
||||||
|
|
||||||
File: README.info, Node: org-ql-refile, Next: org-ql-search, Prev: org-ql-find, Up: Commands
|
File: README.info, Node: org-ql-open-link, Next: org-ql-refile, Prev: org-ql-find, Up: Commands
|
||||||
|
|
||||||
4.1.2 org-ql-refile
|
4.1.2 org-ql-open-link
|
||||||
|
----------------------
|
||||||
|
|
||||||
|
This command finds links in entries matching the input query and offers
|
||||||
|
them for selection; the selected link is then opened with
|
||||||
|
‘org-open-at-point’.
|
||||||
|
|
||||||
|
The input is matched using the default predicate, which means it
|
||||||
|
searches both entry content and outline paths. This is helpful when a
|
||||||
|
collection of links are kept in Org files: rather than having to first
|
||||||
|
visit the entry containing the desired link, then locate it within the
|
||||||
|
entry, and then open it, the user can simply select the link and open it
|
||||||
|
directly. For example, if an entry with the heading ‘Emacs’ contained a
|
||||||
|
link named ‘mailing list’, one could search for ‘Emacs list’ and open
|
||||||
|
the link to the mailing list directly.
|
||||||
|
|
||||||
|
|
||||||
|
File: README.info, Node: org-ql-refile, Next: org-ql-search, Prev: org-ql-open-link, Up: Commands
|
||||||
|
|
||||||
|
4.1.3 org-ql-refile
|
||||||
-------------------
|
-------------------
|
||||||
|
|
||||||
This command refiles the current Org entry to one selected by searching
|
This command refiles the current Org entry to one selected by searching
|
||||||
|
|
@ -249,7 +270,7 @@ with Org QL completion. It searches files listed in
|
||||||
|
|
||||||
File: README.info, Node: org-ql-search, Next: helm-org-ql, Prev: org-ql-refile, Up: Commands
|
File: README.info, Node: org-ql-search, Next: helm-org-ql, Prev: org-ql-refile, Up: Commands
|
||||||
|
|
||||||
4.1.3 org-ql-search
|
4.1.4 org-ql-search
|
||||||
-------------------
|
-------------------
|
||||||
|
|
||||||
_Note: This command supports both sexp queries and ._
|
_Note: This command supports both sexp queries and ._
|
||||||
|
|
@ -297,7 +318,7 @@ entry in its source Org buffer.
|
||||||
|
|
||||||
File: README.info, Node: helm-org-ql, Next: org-ql-view, Prev: org-ql-search, Up: Commands
|
File: README.info, Node: helm-org-ql, Next: org-ql-view, Prev: org-ql-search, Up: Commands
|
||||||
|
|
||||||
4.1.4 helm-org-ql
|
4.1.5 helm-org-ql
|
||||||
-----------------
|
-----------------
|
||||||
|
|
||||||
_Note: This command uses . It is available separately in the package
|
_Note: This command uses . It is available separately in the package
|
||||||
|
|
@ -311,7 +332,7 @@ _Note: This command uses . It is available separately in the package
|
||||||
|
|
||||||
File: README.info, Node: org-ql-view, Next: org-ql-view-sidebar, Prev: helm-org-ql, Up: Commands
|
File: README.info, Node: org-ql-view, Next: org-ql-view-sidebar, Prev: helm-org-ql, Up: Commands
|
||||||
|
|
||||||
4.1.5 org-ql-view
|
4.1.6 org-ql-view
|
||||||
-----------------
|
-----------------
|
||||||
|
|
||||||
Choose and display a view stored in ‘org-ql-views’.
|
Choose and display a view stored in ‘org-ql-views’.
|
||||||
|
|
@ -326,7 +347,7 @@ Choose and display a view stored in ‘org-ql-views’.
|
||||||
|
|
||||||
File: README.info, Node: org-ql-view-sidebar, Next: org-ql-view-recent-items, Prev: org-ql-view, Up: Commands
|
File: README.info, Node: org-ql-view-sidebar, Next: org-ql-view-recent-items, Prev: org-ql-view, Up: Commands
|
||||||
|
|
||||||
4.1.6 org-ql-view-sidebar
|
4.1.7 org-ql-view-sidebar
|
||||||
-------------------------
|
-------------------------
|
||||||
|
|
||||||
Show a sidebar window listing views stored in ‘org-ql-views’ for easy
|
Show a sidebar window listing views stored in ‘org-ql-views’ for easy
|
||||||
|
|
@ -336,7 +357,7 @@ point, and press ‘c’ to customize the view at point.
|
||||||
|
|
||||||
File: README.info, Node: org-ql-view-recent-items, Next: org-ql-sparse-tree, Prev: org-ql-view-sidebar, Up: Commands
|
File: README.info, Node: org-ql-view-recent-items, Next: org-ql-sparse-tree, Prev: org-ql-view-sidebar, Up: Commands
|
||||||
|
|
||||||
4.1.7 org-ql-view-recent-items
|
4.1.8 org-ql-view-recent-items
|
||||||
------------------------------
|
------------------------------
|
||||||
|
|
||||||
Show items in ‘FILES’ from last ‘DAYS’ days with timestamps of ‘TYPE’.
|
Show items in ‘FILES’ from last ‘DAYS’ days with timestamps of ‘TYPE’.
|
||||||
|
|
@ -347,7 +368,7 @@ returned by the function ‘org-agenda-files’.
|
||||||
|
|
||||||
File: README.info, Node: org-ql-sparse-tree, Prev: org-ql-view-recent-items, Up: Commands
|
File: README.info, Node: org-ql-sparse-tree, Prev: org-ql-view-recent-items, Up: Commands
|
||||||
|
|
||||||
4.1.8 org-ql-sparse-tree
|
4.1.9 org-ql-sparse-tree
|
||||||
------------------------
|
------------------------
|
||||||
|
|
||||||
Arguments: ‘(query &key keep-previous (buffer (current-buffer)))’
|
Arguments: ‘(query &key keep-previous (buffer (current-buffer)))’
|
||||||
|
|
@ -1059,6 +1080,13 @@ File: README.info, Node: 08-pre, Next: 073, Up: Changelog
|
||||||
agenda/view buffer.
|
agenda/view buffer.
|
||||||
• Command ‘org-ql-find-path’, which searches outline paths in the
|
• Command ‘org-ql-find-path’, which searches outline paths in the
|
||||||
current buffer.
|
current buffer.
|
||||||
|
• Command ‘org-ql-open-link’, which finds links in entries matching
|
||||||
|
the given query, and opens the selected one with
|
||||||
|
‘org-open-at-point’. (This is helpful when a collection of links
|
||||||
|
are kept in Org files: rather than having to first visit the entry
|
||||||
|
containing the desired link, then locate it within the entry, and
|
||||||
|
then open it, the user can simply select the link and open it
|
||||||
|
directly.)
|
||||||
|
|
||||||
*Compatibility*
|
*Compatibility*
|
||||||
|
|
||||||
|
|
@ -1811,74 +1839,75 @@ GPLv3
|
||||||
|
|
||||||
Tag Table:
|
Tag Table:
|
||||||
Node: Top225
|
Node: Top225
|
||||||
Node: Contents1824
|
Node: Contents1845
|
||||||
Node: Screenshots1947
|
Node: Screenshots1968
|
||||||
Node: Installation2065
|
Node: Installation2086
|
||||||
Node: Quelpa2579
|
Node: Quelpa2600
|
||||||
Node: Helm support3107
|
Node: Helm support3128
|
||||||
Node: Usage3510
|
Node: Usage3531
|
||||||
Node: Commands3908
|
Node: Commands3929
|
||||||
Node: org-ql-find4352
|
Node: org-ql-find4394
|
||||||
Node: org-ql-refile5167
|
Node: org-ql-open-link5212
|
||||||
Node: org-ql-search5490
|
Node: org-ql-refile6067
|
||||||
Node: helm-org-ql7421
|
Node: org-ql-search6395
|
||||||
Node: org-ql-view7799
|
Node: helm-org-ql8326
|
||||||
Node: org-ql-view-sidebar8329
|
Node: org-ql-view8704
|
||||||
Node: org-ql-view-recent-items8709
|
Node: org-ql-view-sidebar9234
|
||||||
Node: org-ql-sparse-tree9205
|
Node: org-ql-view-recent-items9614
|
||||||
Node: Queries10005
|
Node: org-ql-sparse-tree10110
|
||||||
Node: Non-sexp query syntax11122
|
Node: Queries10910
|
||||||
Node: General predicates12881
|
Node: Non-sexp query syntax12027
|
||||||
Node: Ancestor/descendant predicates19868
|
Node: General predicates13786
|
||||||
Node: Date/time predicates20996
|
Node: Ancestor/descendant predicates20773
|
||||||
Node: Functions / Macros24120
|
Node: Date/time predicates21901
|
||||||
Node: Agenda-like views24418
|
Node: Functions / Macros25025
|
||||||
Ref: Function org-ql-block24580
|
Node: Agenda-like views25323
|
||||||
Node: Listing / acting-on results25841
|
Ref: Function org-ql-block25485
|
||||||
Ref: Caching26049
|
Node: Listing / acting-on results26746
|
||||||
Ref: Function org-ql-select26962
|
Ref: Caching26954
|
||||||
Ref: Function org-ql-query29388
|
Ref: Function org-ql-select27867
|
||||||
Ref: Macro org-ql (deprecated)31162
|
Ref: Function org-ql-query30293
|
||||||
Node: Custom predicates31477
|
Ref: Macro org-ql (deprecated)32067
|
||||||
Ref: Macro org-ql-defpred31701
|
Node: Custom predicates32382
|
||||||
Node: Dynamic block35142
|
Ref: Macro org-ql-defpred32606
|
||||||
Node: Links37866
|
Node: Dynamic block36047
|
||||||
Node: Tips38553
|
Node: Links38771
|
||||||
Node: Changelog38877
|
Node: Tips39458
|
||||||
Node: 08-pre39687
|
Node: Changelog39782
|
||||||
Node: 07341020
|
Node: 08-pre40592
|
||||||
Node: 07241755
|
Node: 07342357
|
||||||
Node: 07142674
|
Node: 07243092
|
||||||
Node: 0743483
|
Node: 07144011
|
||||||
Node: 06346407
|
Node: 0744820
|
||||||
Node: 06246938
|
Node: 06347744
|
||||||
Node: 06147243
|
Node: 06248275
|
||||||
Node: 0647811
|
Node: 06148580
|
||||||
Node: 05250865
|
Node: 0649148
|
||||||
Node: 05151167
|
Node: 05252202
|
||||||
Node: 0551592
|
Node: 05152504
|
||||||
Node: 04953123
|
Node: 0552929
|
||||||
Node: 04853405
|
Node: 04954460
|
||||||
Node: 04753754
|
Node: 04854742
|
||||||
Node: 04654163
|
Node: 04755091
|
||||||
Node: 04554571
|
Node: 04655500
|
||||||
Node: 04454932
|
Node: 04555908
|
||||||
Node: 04355291
|
Node: 04456269
|
||||||
Node: 04255494
|
Node: 04356628
|
||||||
Node: 04155655
|
Node: 04256831
|
||||||
Node: 0455902
|
Node: 04156992
|
||||||
Node: 03260003
|
Node: 0457239
|
||||||
Node: 03160406
|
Node: 03261340
|
||||||
Node: 0360603
|
Node: 03161743
|
||||||
Node: 02363903
|
Node: 0361940
|
||||||
Node: 02264137
|
Node: 02365240
|
||||||
Node: 02164417
|
Node: 02265474
|
||||||
Node: 0264622
|
Node: 02165754
|
||||||
Node: 0168700
|
Node: 0265959
|
||||||
Node: Notes68801
|
Node: 0170037
|
||||||
Node: Comparison with Org Agenda searches68963
|
Node: Notes70138
|
||||||
Node: org-sidebar69852
|
Node: Comparison with Org Agenda searches70300
|
||||||
Node: License70131
|
Node: org-sidebar71189
|
||||||
|
Node: License71468
|
||||||
|
|
||||||
End Tag Table
|
End Tag Table
|
||||||
|
|
||||||
|
|
|
||||||
Loading…
Add table
Add a link
Reference in a new issue