diff --git a/README.org b/README.org index 15649ee..1e8a661 100644 --- a/README.org +++ b/README.org @@ -9,7 +9,7 @@ This package provides a query language for Org files. It offers two syntax styles: Lisp-like sexps and search engine-like keywords. -It includes three libraries: The =org-ql= library is flexible and may be used as a backend for other tools. The libraries =org-ql-search= and =helm-org-ql= provide interactive search commands and saved views. +It includes three libraries: The =org-ql= library is flexible and may be used as a backend for other tools. The libraries =org-ql-search= and =helm-org-ql= (a separate package) provide interactive search commands and saved views. * Contents :PROPERTIES: @@ -38,11 +38,9 @@ It includes three libraries: The =org-ql= library is flexible and may be used as :TOC: ignore-children :END: -The package may be installed directly from [[https://melpa.org/#/org-ql][MELPA]] or with other tools like [[https://framagit.org/steckerhalter/quelpa][Quelpa]]. +The package =org-ql= may be installed directly from [[https://melpa.org/#/org-ql][MELPA]] or with other tools like [[https://framagit.org/steckerhalter/quelpa][Quelpa]]. -After installation, you can use the commands without additional configuration. /Note: The command =helm-org-ql= only works if the package =helm-org= is installed; Helm is not a dependency of this package, so it's not automatically installed./ - -To use the functions and macros in your own Elisp code, use libraries =org-ql= and =org-ql-view=. +After installation, you can use the commands without additional configuration. To use the functions and macros in your own Elisp code, use libraries =org-ql= and =org-ql-view=. ** Quelpa @@ -53,7 +51,18 @@ Installing with [[https://framagit.org/steckerhalter/quelpa][Quelpa]] is easy: #+BEGIN_SRC elisp (use-package org-ql - :quelpa (org-ql :fetcher github :repo "alphapapa/org-ql")) + :quelpa (org-ql :fetcher github :repo "alphapapa/org-ql" + :files (:defaults (:exclude "helm-org-ql.el")))) +#+END_SRC + +** Helm support + +The command =helm-org-ql= is available in the package =helm-org-ql=. It may be installed from MELPA, or with Quelpa, like so: + +#+BEGIN_SRC elisp + (use-package helm-org-ql + :quelpa (helm-org-ql :fetcher github :repo "alphapapa/org-ql" + :files ("helm-org-ql.el"))) #+END_SRC * Usage @@ -123,9 +132,9 @@ Read ~QUERY~ and search with ~org-ql~. Interactively, prompt for these variable *** helm-org-ql -/Note: This command uses [[#non-sexp-query-syntax][non-sexp queries]]./ +/Note: This command uses [[#non-sexp-query-syntax][non-sexp queries]]. It is available separately in the package =helm-org-ql=./ -This command displays matches with Helm. *Note:* Helm is not a package dependency, so this command only works if the package =helm-org= is installed. +This command displays matches with Helm. + Press =C-x C-s= in the Helm session to save the results to an =org-ql-search= buffer. @@ -510,6 +519,9 @@ Simple links may also be written manually in either sexp or non-sexp form, like: *Added* + Macro =org-ql-defpred=, used to define search predicates. (See [[file:examples/defpred.org][tutorial]].) +*Changed* ++ Helm support (including the command =helm-org-ql=) has been moved to a separate package, =helm-org-ql=. + *Internal* + Predicates are now defined more cleanly with a macro (=org-ql-defpred=) that consolidates functionality related to each predicate. This will also allow users to more easily define custom predicates. diff --git a/org-ql.info b/org-ql.info index bf5c7e5..d19b873 100644 --- a/org-ql.info +++ b/org-ql.info @@ -28,6 +28,8 @@ org-ql Installation * Quelpa:: +* Helm support:: + Usage @@ -100,7 +102,8 @@ syntax styles: Lisp-like sexps and search engine-like keywords. It includes three libraries: The org-ql library is flexible and may be used as a backend for other tools. The libraries org-ql-search and -helm-org-ql provide interactive search commands and saved views. +helm-org-ql (a separate package) provide interactive search commands and +saved views.  File: README.info, Node: Contents, Next: Screenshots, Prev: Top, Up: Top @@ -121,24 +124,21 @@ File: README.info, Node: Installation, Next: Usage, Prev: Screenshots, Up: T 3 Installation ************** -The package may be installed directly from MELPA +The package org-ql may be installed directly from MELPA (https://melpa.org/#/org-ql) or with other tools like Quelpa (https://framagit.org/steckerhalter/quelpa). After installation, you can use the commands without additional -configuration. _Note: The command helm-org-ql only works if the package -helm-org is installed; Helm is not a dependency of this package, so it’s -not automatically installed._ - - To use the functions and macros in your own Elisp code, use libraries -org-ql and org-ql-view. +configuration. To use the functions and macros in your own Elisp code, +use libraries org-ql and org-ql-view. * Menu: * Quelpa:: +* Helm support::  -File: README.info, Node: Quelpa, Up: Installation +File: README.info, Node: Quelpa, Next: Helm support, Up: Installation 3.1 Quelpa ========== @@ -152,7 +152,21 @@ easy: 2. Add this form to your init file: (use-package org-ql - :quelpa (org-ql :fetcher github :repo "alphapapa/org-ql")) + :quelpa (org-ql :fetcher github :repo "alphapapa/org-ql" + :files (:defaults (:exclude "helm-org-ql.el")))) + + +File: README.info, Node: Helm support, Prev: Quelpa, Up: Installation + +3.2 Helm support +================ + +The command helm-org-ql is available in the package helm-org-ql. It may +be installed from MELPA, or with Quelpa, like so: + + (use-package helm-org-ql + :quelpa (helm-org-ql :fetcher github :repo "alphapapa/org-ql" + :files ("helm-org-ql.el")))  File: README.info, Node: Usage, Next: Changelog, Prev: Installation, Up: Top @@ -250,11 +264,10 @@ File: README.info, Node: helm-org-ql, Next: org-ql-view, Prev: org-ql-search, 4.1.2 helm-org-ql ----------------- -_Note: This command uses ._ +_Note: This command uses . It is available separately in the package +helm-org-ql._ - This command displays matches with Helm. *Note:* Helm is not a -package dependency, so this command only works if the package helm-org -is installed. + This command displays matches with Helm. • Press C-x C-s in the Helm session to save the results to an org-ql-search buffer. @@ -950,6 +963,10 @@ File: README.info, Node: 06-pre, Next: 05, Up: Changelog • Macro org-ql-defpred, used to define search predicates. (See tutorial (examples/defpred.org).) + *Changed* + • Helm support (including the command helm-org-ql) has been moved to + a separate package, helm-org-ql. + *Internal* • Predicates are now defined more cleanly with a macro (org-ql-defpred) that consolidates functionality related to each @@ -1443,55 +1460,56 @@ GPLv3  Tag Table: Node: Top225 -Node: Contents1628 -Node: Screenshots1751 -Node: Installation1869 -Node: Quelpa2507 -Node: Usage2950 -Node: Commands3348 -Node: org-ql-search3821 -Node: helm-org-ql5471 -Node: org-ql-view5883 -Node: org-ql-view-sidebar6383 -Node: org-ql-view-recent-items6739 -Node: org-ql-sparse-tree7223 -Node: Queries8023 -Node: Non-sexp query syntax9134 -Node: General predicates10841 -Node: Ancestor/descendant predicates16254 -Node: Date/time predicates17382 -Node: Functions / Macros20037 -Node: Agenda-like views20335 -Node: Listing / acting-on results21740 -Node: Custom predicates27362 -Node: Dynamic block30853 -Node: Links33551 -Node: Tips34238 -Node: Changelog34556 -Node: 06-pre35252 -Node: 0535692 -Node: 04937169 -Node: 04837443 -Node: 04737790 -Node: 04638185 -Node: 04538585 -Node: 04438944 -Node: 04339301 -Node: 04239496 -Node: 04139657 -Node: 0439898 -Node: 03243831 -Node: 03144210 -Node: 0344407 -Node: 02347382 -Node: 02247610 -Node: 02147878 -Node: 0248077 -Node: 0152112 -Node: Notes52213 -Node: Comparison with Org Agenda searches52375 -Node: org-sidebar53247 -Node: License53526 +Node: Contents1667 +Node: Screenshots1790 +Node: Installation1908 +Node: Quelpa2404 +Node: Helm support2932 +Node: Usage3323 +Node: Commands3721 +Node: org-ql-search4194 +Node: helm-org-ql5844 +Node: org-ql-view6204 +Node: org-ql-view-sidebar6704 +Node: org-ql-view-recent-items7060 +Node: org-ql-sparse-tree7544 +Node: Queries8344 +Node: Non-sexp query syntax9455 +Node: General predicates11162 +Node: Ancestor/descendant predicates16575 +Node: Date/time predicates17703 +Node: Functions / Macros20358 +Node: Agenda-like views20656 +Node: Listing / acting-on results22061 +Node: Custom predicates27683 +Node: Dynamic block31174 +Node: Links33872 +Node: Tips34559 +Node: Changelog34877 +Node: 06-pre35573 +Node: 0536139 +Node: 04937616 +Node: 04837890 +Node: 04738237 +Node: 04638632 +Node: 04539032 +Node: 04439391 +Node: 04339748 +Node: 04239943 +Node: 04140104 +Node: 0440345 +Node: 03244278 +Node: 03144657 +Node: 0344854 +Node: 02347829 +Node: 02248057 +Node: 02148325 +Node: 0248524 +Node: 0152559 +Node: Notes52660 +Node: Comparison with Org Agenda searches52822 +Node: org-sidebar53694 +Node: License53973  End Tag Table