Compare commits
No commits in common. "master" and "stable/0.5" have entirely different histories.
master
...
stable/0.5
50 changed files with 2171 additions and 8604 deletions
78
.github/ISSUE_TEMPLATE/bug_report.yml
vendored
78
.github/ISSUE_TEMPLATE/bug_report.yml
vendored
|
|
@ -1,78 +0,0 @@
|
|||
name: Bug Report
|
||||
description: File a bug report
|
||||
# labels: ["bug"]
|
||||
# assignees:
|
||||
# - alphapapa
|
||||
body:
|
||||
- type: markdown
|
||||
attributes:
|
||||
value: |
|
||||
Thanks for taking the time to fill out this bug report!
|
||||
- type: input
|
||||
id: os-platform
|
||||
attributes:
|
||||
label: OS/platform
|
||||
description: What operating system or platform are you running Emacs on?
|
||||
validations:
|
||||
required: true
|
||||
- type: textarea
|
||||
id: emacs-provenance
|
||||
attributes:
|
||||
label: Emacs version and provenance
|
||||
description: What version of Emacs are you using, where did you acquire it, and how did you install it?
|
||||
validations:
|
||||
required: true
|
||||
- type: input
|
||||
id: emacs-command
|
||||
attributes:
|
||||
label: Emacs command
|
||||
description: By what method did you run Emacs? (i.e. what command did you run?)
|
||||
validations:
|
||||
required: true
|
||||
- type: textarea
|
||||
id: org-provenance
|
||||
attributes:
|
||||
label: Org version and provenance
|
||||
description: What version of Org are you using, where did you acquire it, and how did you install it?
|
||||
validations:
|
||||
required: true
|
||||
- type: input
|
||||
id: package-provenance
|
||||
attributes:
|
||||
label: org-ql package version and provenance
|
||||
description: What version of org-ql are you using, where did you acquire it, and how did you install it?
|
||||
validations:
|
||||
required: true
|
||||
- type: textarea
|
||||
id: actions
|
||||
attributes:
|
||||
label: Actions taken
|
||||
description: What actions did you take, step-by-step, in order, before the problem was noticed?
|
||||
validations:
|
||||
required: true
|
||||
- type: textarea
|
||||
id: results
|
||||
attributes:
|
||||
label: Observed results
|
||||
description: What behavior did you observe that seemed wrong?
|
||||
validations:
|
||||
required: true
|
||||
- type: textarea
|
||||
id: expected
|
||||
attributes:
|
||||
label: Expected results
|
||||
description: What behavior did you expect to observe?
|
||||
validations:
|
||||
required: true
|
||||
- type: textarea
|
||||
id: backtrace
|
||||
attributes:
|
||||
label: Backtrace
|
||||
description: If an error was signaled, please use `M-x toggle-debug-on-error RET` and cause the error to happen again, then paste the contents of the `*Backtrace*` buffer here.
|
||||
render: elisp
|
||||
- type: textarea
|
||||
id: etc
|
||||
attributes:
|
||||
label: Etc.
|
||||
description: Any other information that seems relevant
|
||||
|
||||
5
.github/ISSUE_TEMPLATE/config.yml
vendored
5
.github/ISSUE_TEMPLATE/config.yml
vendored
|
|
@ -1,5 +0,0 @@
|
|||
blank_issues_enabled: true
|
||||
contact_links:
|
||||
- name: Support questions
|
||||
url: https://github.com/alphapapa/org-ql/discussions
|
||||
about: Please ask and answer support questions here.
|
||||
45
.github/ISSUE_TEMPLATE/feature_request.yml
vendored
45
.github/ISSUE_TEMPLATE/feature_request.yml
vendored
|
|
@ -1,45 +0,0 @@
|
|||
name: Feature Request
|
||||
description: File a feature request
|
||||
labels: ["enhancement"]
|
||||
body:
|
||||
- type: input
|
||||
id: os-platform
|
||||
attributes:
|
||||
label: OS/platform
|
||||
description: What operating system or platform are you running Emacs on?
|
||||
validations:
|
||||
required: true
|
||||
- type: textarea
|
||||
id: emacs-provenance
|
||||
attributes:
|
||||
label: Emacs version and provenance
|
||||
description: What version of Emacs are you using, where did you acquire it, and how did you install it?
|
||||
validations:
|
||||
required: true
|
||||
- type: textarea
|
||||
id: org-provenance
|
||||
attributes:
|
||||
label: Org version and provenance
|
||||
description: What version of Org are you using, where did you acquire it, and how did you install it?
|
||||
validations:
|
||||
required: true
|
||||
- type: input
|
||||
id: package-provenance
|
||||
attributes:
|
||||
label: org-ql package version and provenance
|
||||
description: What version of org-ql are you using, where did you acquire it, and how did you install it?
|
||||
validations:
|
||||
required: true
|
||||
- type: textarea
|
||||
id: description
|
||||
attributes:
|
||||
label: Description
|
||||
description: Describe your request.
|
||||
validations:
|
||||
required: true
|
||||
- type: textarea
|
||||
id: etc
|
||||
attributes:
|
||||
label: Etc.
|
||||
description: Any other information that seems relevant
|
||||
|
||||
14
.github/workflows/test.yml
vendored
14
.github/workflows/test.yml
vendored
|
|
@ -1,7 +1,7 @@
|
|||
# * test.yml --- Test Emacs packages using makem.sh on GitHub Actions
|
||||
|
||||
# URL: https://github.com/alphapapa/makem.sh
|
||||
# Version: 0.3
|
||||
# Version: 0.2
|
||||
|
||||
# * Commentary:
|
||||
|
||||
|
|
@ -31,8 +31,8 @@ on:
|
|||
pull_request:
|
||||
push:
|
||||
# Comment out this section to enable testing of all branches.
|
||||
# branches:
|
||||
# - master
|
||||
branches:
|
||||
- master
|
||||
|
||||
jobs:
|
||||
build:
|
||||
|
|
@ -41,14 +41,8 @@ jobs:
|
|||
fail-fast: false
|
||||
matrix:
|
||||
emacs_version:
|
||||
- 26.3
|
||||
- 27.1
|
||||
- 27.2
|
||||
- 28.1
|
||||
- 28.2
|
||||
- 29.1
|
||||
- 29.2
|
||||
- 29.3
|
||||
- 29.4
|
||||
- snapshot
|
||||
steps:
|
||||
- uses: purcell/setup-emacs@master
|
||||
|
|
|
|||
6
Makefile
6
Makefile
|
|
@ -1,7 +1,7 @@
|
|||
# * makem.sh/Makefile --- Script to aid building and testing Emacs Lisp packages
|
||||
|
||||
# URL: https://github.com/alphapapa/makem.sh
|
||||
# Version: 0.5
|
||||
# Version: 0.2
|
||||
|
||||
# * Arguments
|
||||
|
||||
|
|
@ -38,9 +38,7 @@ endif
|
|||
|
||||
verbose = $(v)
|
||||
|
||||
ifneq (,$(findstring vvv,$(verbose)))
|
||||
VERBOSE = "-vvv"
|
||||
else ifneq (,$(findstring vv,$(verbose)))
|
||||
ifneq (,$(findstring vv,$(verbose)))
|
||||
VERBOSE = "-vv"
|
||||
else ifneq (,$(findstring v,$(verbose)))
|
||||
VERBOSE = "-v"
|
||||
|
|
|
|||
407
README.org
407
README.org
|
|
@ -1,6 +1,7 @@
|
|||
#+TITLE: org-ql
|
||||
|
||||
# NOTE: Using =BEGIN_HTML= for this causes TeX/info export to fail, but this HTML block works.
|
||||
# #+HTML: <a href=https://alphapapa.github.io/dont-tread-on-emacs/><img src="images/dont-tread-on-emacs-150.png" align="right"></a>
|
||||
#+HTML: <img src="images/dog.png" align="right">
|
||||
|
||||
# NOTE: To avoid having this in the info manual, we use HTML rather than Org syntax; it still appears with the GitHub renderer.
|
||||
|
|
@ -8,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= (a separate package) 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= provide interactive search commands and saved views.
|
||||
|
||||
* Contents
|
||||
:PROPERTIES:
|
||||
|
|
@ -19,7 +20,6 @@ It includes three libraries: The =org-ql= library is flexible and may be used as
|
|||
- [[#installation][Installation]]
|
||||
- [[#usage][Usage]]
|
||||
- [[#changelog][Changelog]]
|
||||
- [[#development][Development]]
|
||||
:END:
|
||||
|
||||
|
||||
|
|
@ -38,9 +38,11 @@ It includes three libraries: The =org-ql= library is flexible and may be used as
|
|||
:TOC: ignore-children
|
||||
:END:
|
||||
|
||||
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]].
|
||||
The package 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. 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. /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=.
|
||||
|
||||
** Quelpa
|
||||
|
||||
|
|
@ -51,18 +53,7 @@ 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"
|
||||
: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")))
|
||||
:quelpa (org-ql :fetcher github :repo "alphapapa/org-ql"))
|
||||
#+END_SRC
|
||||
|
||||
* Usage
|
||||
|
|
@ -94,41 +85,15 @@ Lisp code examples are in [[examples.org]].
|
|||
:TOC: ignore-children
|
||||
:END:
|
||||
|
||||
+ *Jumping to an entry:*
|
||||
- [[#org-ql-find][org-ql-find]] and related commands
|
||||
- [[#helm-org-ql][helm-org-ql]]
|
||||
+ *Showing an agenda-like view:*
|
||||
- [[#org-ql-search][org-ql-search]]
|
||||
- [[#org-ql-view][org-ql-view]]
|
||||
- [[#org-ql-view-sidebar][org-ql-view-sidebar]]
|
||||
- [[#org-ql-view-recent-items][org-ql-view-recent-items]]
|
||||
- [[#org-ql-search][org-ql-search]] (command)
|
||||
- [[#org-ql-view][org-ql-view]] (command)
|
||||
- [[#org-ql-view-sidebar][org-ql-view-sidebar]] (command)
|
||||
- [[#org-ql-view-recent-items][org-ql-view-recent-items]] (command)
|
||||
+ *Showing a tree in a buffer:*
|
||||
- [[#org-ql-sparse-tree][org-ql-sparse-tree]]
|
||||
|
||||
*** org-ql-find
|
||||
|
||||
/Note: These commands use [[#non-sexp-query-syntax][non-sexp queries]]./
|
||||
|
||||
These commands jump to a heading selected using Emacs's built-in completion facilities with an Org QL query:
|
||||
|
||||
- ~org-ql-find~ searches in the current buffer.
|
||||
- ~org-ql-find-path~ searches outline paths in the current buffer.
|
||||
- ~org-ql-find-in-agenda~ searches in ~(org-agenda-files)~.
|
||||
- ~org-ql-find-in-org-directory~ searches in ~org-directory~.
|
||||
|
||||
Note that these commands are compatible with [[https://github.com/oantolin/embark][Embark]]: the ~embark-act~ command can be 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, and ~embark-export~ may be called to show the results in an ~org-ql-view~ buffer.
|
||||
|
||||
[[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
|
||||
|
||||
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.
|
||||
- [[#org-ql-sparse-tree][org-ql-sparse-tree]] (command)
|
||||
+ *Showing results with Helm*:
|
||||
- [[#helm-org-ql][helm-org-ql]] (command)
|
||||
|
||||
*** org-ql-search
|
||||
|
||||
|
|
@ -156,13 +121,11 @@ Read ~QUERY~ and search with ~org-ql~. Interactively, prompt for these variable
|
|||
|
||||
*Note:* The view buffer is currently put in ~org-agenda-mode~, which means that /some/ Org Agenda commands work, such as jumping to entries and changing item priorities (without necessarily updating the view). This feature is experimental and not guaranteed to work correctly with all commands. (It works to the extent it does because the appropriate text properties are placed on each item, imitating an Agenda buffer.)
|
||||
|
||||
*Note:* Also, this buffer is compatible with [[https://github.com/oantolin/embark][Embark]]: the ~embark-act~ command can be called on an entry to act on it immediately, without having to visit the entry in its source Org buffer.
|
||||
|
||||
*** helm-org-ql
|
||||
|
||||
/Note: This command uses [[#non-sexp-query-syntax][non-sexp queries]]. It is available separately in the package =helm-org-ql=./
|
||||
/Note: This command uses [[#non-sexp-query-syntax][non-sexp queries]]./
|
||||
|
||||
This command displays matches with Helm.
|
||||
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.
|
||||
|
||||
+ Press =C-x C-s= in the Helm session to save the results to an =org-ql-search= buffer.
|
||||
|
||||
|
|
@ -226,21 +189,17 @@ The command =org-ql-search= also accepts, and the command =helm-org-ql= only acc
|
|||
| ~(and (tags "space") (not (regexp "moon")))~ | ~tags:space !moon~ |
|
||||
| ~(priority >= B)~ | ~priority:A,B~ |
|
||||
|
||||
Note that the =effort=, =level=, and =priority= predicates do not support comparators in the non-sexp syntax, so multiple arguments should be passed instead, as seen in the last example.
|
||||
Note that the =priority= predicate does not support comparators in the non-sexp syntax, so multiple priorities should be passed instead, as seen in the last example.
|
||||
|
||||
*** General predicates
|
||||
|
||||
Arguments are listed next to predicate names, where applicable.
|
||||
|
||||
+ =blocked= :: Return non-nil if current heading is blocked. Calls ~org-entry-blocked-p~, which see.
|
||||
+ =category (&rest categories)= :: Return non-nil if current heading is in one or more of ~CATEGORIES~ (a list of strings).
|
||||
+ =category (&optional categories)= :: Return non-nil if current heading is in one or more of ~CATEGORIES~ (a list of strings).
|
||||
+ =done= :: Return non-nil if entry's ~TODO~ keyword is in ~org-done-keywords~.
|
||||
+ =effort (&optional effort-or-comparator effort)= :: Return non-nil if current heading's effort property matches arguments. The following forms are accepted: ~(effort DURATION)~: Matches if effort is ~DURATION~. ~(effort DURATION DURATION)~: Matches if effort is between DURATIONs, inclusive. ~(effort COMPARATOR DURATION)~: Matches if effort compares to ~DURATION~ with ~COMPARATOR~. ~COMPARATOR~ may be ~<~, ~<=~, ~>~, or ~>=~. ~DURATION~ should be an Org effort string, like =5= or =0:05=.
|
||||
+ =habit= :: Return non-nil if entry is a habit.
|
||||
+ =heading (&rest strings)= :: Return non-nil if current entry's heading matches all ~STRINGS~. Matching is done case-insensitively.
|
||||
+ =heading (&rest regexps)= :: Return non-nil if current entry's heading matches all ~REGEXPS~ (regexp strings).
|
||||
- Aliases: =h=.
|
||||
+ ~heading-regexp (&rest regexps)~ :: Return non-nil if current entry's heading matches all ~REGEXPS~ (regexp strings). Matching is done case-insensitively.
|
||||
- Aliases: ~h*~.
|
||||
+ =level (level-or-comparator &optional level)= :: Return non-nil if current heading's outline level matches arguments. The following forms are accepted: ~(level NUMBER)~: Matches if heading level is ~NUMBER~. ~(level NUMBER NUMBER)~: Matches if heading level is equal to or between NUMBERs. ~(level COMPARATOR NUMBER)~: Matches if heading level compares to ~NUMBER~ with ~COMPARATOR~. ~COMPARATOR~ may be ~<~, ~<=~, ~>~, or ~>=~.
|
||||
+ =link (&optional description-or-target &key description target regexp-p)= :: Return non-nil if current heading contains a link matching arguments. ~DESCRIPTION-OR-TARGET~ is matched against the link's description and target. Alternatively, one or both of ~DESCRIPTION~ and ~TARGET~ may be matched separately. Without arguments, return non-nil if any link is found.
|
||||
+ =outline-path (&rest strings)= :: Return non-nil if current node's outline path matches all of ~STRINGS~. Each string may appear as a substring in any part of the node's outline path. For example, the path =Food/Fruits/Grapes= would match ~(olp "Fruit" "Grape")~.
|
||||
|
|
@ -249,23 +208,20 @@ Arguments are listed next to predicate names, where applicable.
|
|||
- Aliases: ~olps~.
|
||||
+ =path (&rest regexps)= :: Return non-nil if current heading's buffer's filename path matches any of ~REGEXPS~ (regexp strings). Without arguments, return non-nil if buffer is file-backed.
|
||||
+ =priority (&rest args)= :: Return non-nil if current heading has a certain priority. ~ARGS~ may be either a list of one or more priority letters as strings, or a comparator function symbol followed by a priority letter string. For example: ~(priority "A") (priority "A" "B") (priority '>= "B")~ Note that items without a priority cookie never match this predicate (while Org itself considers items without a cookie to have the default priority, which, by default, is equal to priority ~B~).
|
||||
+ =property (property &optional value &key inherit)= :: Return non-nil if current entry has ~PROPERTY~ (a string), and optionally ~VALUE~ (a string). If ~INHERIT~ is nil, only match entries with ~PROPERTY~ set on the entry; if t, also match entries with inheritance. If ~INHERIT~ is not specified, use the value of ~org-use-property-inheritance~, which see.
|
||||
+ =property (property &optional value)= :: Return non-nil if current entry has ~PROPERTY~ (a string), and optionally ~VALUE~ (a string). Note that property inheritance is currently /not/ enabled for this predicate. If you need to test with inheritance, you could use a custom predicate form, like ~(org-entry-get (point) "PROPERTY" 'inherit)~.
|
||||
+ =regexp (&rest regexps)= :: Return non-nil if current entry matches all of ~REGEXPS~ (regexp strings). Matches against entire entry, from beginning of its heading to the next heading.
|
||||
- Aliases: =r=.
|
||||
+ =rifle (&rest strings)= :: Return non-nil if each string is found in either the entry or its outline path. Works like =org-rifle=. This is probably the most useful, intuitive, general-purpose predicate.
|
||||
- Aliases: ~smart~.
|
||||
- *Note:* By default, this is the default predicate used for plain-string query tokens (i.e. given without a specified predicate). This can be customized with the option ~org-ql-default-predicate~.
|
||||
+ ~src (&key lang regexps)~ :: Return non-nil if current entry contains an Org Babel source block. If ~LANG~ is non-nil, match blocks of that language. If ~REGEXPS~ is non-nil, require that block's contents match all regexps. Matching is done case-insensitively.
|
||||
+ =tags (&rest tags)= :: Return non-nil if current heading has one or more of ~TAGS~ (a list of strings). Tests both inherited and local tags.
|
||||
+ =tags-inherited (&rest tags)= :: Return non-nil if current heading's inherited tags include one or more of ~TAGS~ (a list of strings). If ~TAGS~ is nil, return non-nil if heading has any inherited tags.
|
||||
+ ~src (&key lang regexps)~ :: Return non-nil if current entry contains an Org Babel source block. If ~LANG~ is non-nil, match blocks of that language. If ~REGEXPS~ is non-nil, require that block's contents match all regexps.
|
||||
+ =tags (&optional tags)= :: Return non-nil if current heading has one or more of ~TAGS~ (a list of strings). Tests both inherited and local tags.
|
||||
+ =tags-inherited (&optional tags)= :: Return non-nil if current heading's inherited tags include one or more of ~TAGS~ (a list of strings). If ~TAGS~ is nil, return non-nil if heading has any inherited tags.
|
||||
- Aliases: ~inherited-tags~, ~tags-i~, ~itags~.
|
||||
+ =tags-local (&rest tags)= :: Return non-nil if current heading's local tags include one or more of ~TAGS~ (a list of strings). If ~TAGS~ is nil, return non-nil if heading has any local tags.
|
||||
+ =tags-local (&optional tags)= :: Return non-nil if current heading's local tags include one or more of ~TAGS~ (a list of strings). If ~TAGS~ is nil, return non-nil if heading has any local tags.
|
||||
- Aliases: ~local-tags~, ~tags-l~, ~ltags~.
|
||||
+ =tags-all (&rest tags)= :: Return non-nil if current heading includes all of ~TAGS~. Tests both inherited and local tags.
|
||||
+ =tags-all (tags)= :: Return non-nil if current heading includes all of ~TAGS~. Tests both inherited and local tags.
|
||||
- Aliases: ~tags&~.
|
||||
+ =tags-regexp (&rest regexps)= :: Return non-nil if current heading has tags matching one or more of ~REGEXPS~. Tests both inherited and local tags.
|
||||
- Aliases: ~tags*~.
|
||||
+ =todo (&rest keywords)= :: Return non-nil if current heading is a ~TODO~ item. With ~KEYWORDS~, return non-nil if its keyword is one of ~KEYWORDS~ (a list of strings). When called without arguments, only matches non-done tasks (i.e. does not match keywords in ~org-done-keywords~).
|
||||
+ =todo (&optional keywords)= :: Return non-nil if current heading is a ~TODO~ item. With ~KEYWORDS~, return non-nil if its keyword is one of ~KEYWORDS~ (a list of strings). When called without arguments, only matches non-done tasks (i.e. does not match keywords in ~org-done-keywords~).
|
||||
|
||||
*** Ancestor/descendant predicates
|
||||
|
||||
|
|
@ -276,50 +232,41 @@ Arguments are listed next to predicate names, where applicable.
|
|||
|
||||
*** Date/time predicates
|
||||
|
||||
These predicates take optional keyword arguments:
|
||||
All of these predicates take optional keyword arguments ~:from~, ~:to:~, and ~:on~:
|
||||
|
||||
+ ~:from~: Match entries whose timestamp is on or after timestamp ~:from~.
|
||||
+ ~:to~: Match entries whose timestamp is on or before timestamp ~:to~.
|
||||
+ ~:on~: Match entries whose timestamp is on date ~:on~.
|
||||
+ ~:with-time~: If unspecified, match timestamps with or without times (i.e. HH:MM). If nil, match timestamps without times. If t, match timestamps with times.
|
||||
+ If ~:from~, return non-nil if entry has a timestamp on or after ~:from~.
|
||||
+ If ~:to~, return non-nil if entry has a timestamp on or before ~:to~.
|
||||
+ If ~:on~, return non-nil if entry has a timestamp on date ~:on~.
|
||||
|
||||
Timestamp/date arguments should be either a number of days (positive to look forward, or negative to look backward), a string parseable by ~parse-time-string~ (the string may omit the time value), the symbol ~today~, or a ~ts~ struct.
|
||||
Argument values should be either a number of days (positive to look forward, or negative to look backward), a ~ts~ struct, or a string parseable by ~parse-time-string~ (the string may omit the time value).
|
||||
|
||||
+ *Predicates*
|
||||
- =ts= :: Return non-nil if current entry has a timestamp in given period. Without arguments, return non-nil if entry has a timestamp.
|
||||
- =ts= :: Return non-nil if current entry has a timestamp in given period. If no arguments are specified, return non-nil if entry has any timestamp.
|
||||
- =ts-active=, =ts-a= :: Like =ts=, but only matches active timestamps.
|
||||
- =ts-inactive=, =ts-i= :: Like =ts=, but only matches inactive timestamps.
|
||||
|
||||
The following predicates, in addition to the keyword arguments, can also take a single argument, a number, which looks backward or forward a number of days. The number can be negative to invert the direction.
|
||||
|
||||
These two predicates interpret a single number argument as if it were passed to the ~:from~ keyword argument, which eases the common case of searching for items clocked or closed in the past few days:
|
||||
|
||||
+ *Backward-looking*
|
||||
- =clocked= :: Return non-nil if current entry was clocked in given period. Without arguments, return non-nil if entry was ever clocked. Note: Clock entries are expected to be clocked out. Currently clocked entries (i.e. with unclosed timestamp ranges) are ignored.
|
||||
- =closed= :: Return non-nil if current entry was closed in given period. Without arguments, return non-nil if entry is closed.
|
||||
|
||||
These predicates interpret a single number argument as if it were passed to the ~:to~ keyword argument, which eases the common case of searching for items planned in the next few days:
|
||||
- =clocked= :: Return non-nil if current entry was clocked in given period. If no arguments are specified, return non-nil if entry was clocked at any time. Note: Clock entries are expected to be clocked out. Currently clocked entries (i.e. with unclosed timestamp ranges) are ignored.
|
||||
- =closed= :: Return non-nil if current entry was closed in given period. If no arguments are specified, return non-nil if entry was closed at any time.
|
||||
|
||||
+ *Forward-looking*
|
||||
- =deadline= :: Return non-nil if current entry has deadline in given period. If argument is =auto=, return non-nil if entry has deadline within =org-deadline-warning-days=. Without arguments, return non-nil if entry has any deadline.
|
||||
- =planning= :: Return non-nil if current entry has planning timestamp (i.e. its deadline, scheduled, or closed timestamp) in given period. Without arguments, return non-nil if entry has any planning timestamp.
|
||||
- =scheduled= :: Return non-nil if current entry is scheduled in given period. Without arguments, return non-nil if entry is scheduled.
|
||||
- =deadline= :: Return non-nil if current entry has deadline in given period. If argument is =auto=, return non-nil if entry has deadline within =org-deadline-warning-days=. If no arguments are specified, return non-nil if entry has any deadline.
|
||||
- =planning= :: Return non-nil if current entry has planning timestamp in given period (i.e. its deadline, scheduled, or closed timestamp). If no arguments are specified, return non-nil if entry is scheduled at any time.
|
||||
- =scheduled= :: Return non-nil if current entry is scheduled in given period. If no arguments are specified, return non-nil if entry is scheduled at any time.
|
||||
|
||||
** Functions / Macros
|
||||
:PROPERTIES:
|
||||
:TOC: :include descendants
|
||||
:TOC: ignore-children
|
||||
:END:
|
||||
:CONTENTS:
|
||||
|
||||
- [[#agenda-like-views][Agenda-like views]]
|
||||
- [[#function-org-ql-block][Function: org-ql-block]]
|
||||
- [[#listing--acting-on-results][Listing / acting-on results]]
|
||||
- [[#caching][Caching]]
|
||||
- [[#function-org-ql-select][Function: org-ql-select]]
|
||||
- [[#function-org-ql-query][Function: org-ql-query]]
|
||||
- [[#macro-org-ql-deprecated][Macro: org-ql (deprecated)]]
|
||||
- [[#custom-predicates][Custom predicates]]
|
||||
- [[#macro-org-ql-defpred][Macro: org-ql-defpred]]
|
||||
:END:
|
||||
- [[#macro-org-ql][Macro: org-ql]]
|
||||
|
||||
*** Agenda-like views
|
||||
|
||||
|
|
@ -354,9 +301,9 @@ The variable =org-ql-block-header= may be bound to a string to use as the block
|
|||
|
||||
**** Caching
|
||||
|
||||
Org QL uses a per-buffer cache to speed up subsequent searches. It's keyed on query expressions and match actions, which means that, for the same query and same match action in the same buffer, if the buffer has not been modified since the last time the query was run, the cached match-action result will be returned, and the query will not be evaluated in that buffer again.
|
||||
Org QL uses a per-buffer cache to speed up subsequent searches. It's keyed on query expressions, which means that, for the same query in the same buffer, if the buffer has not been modified since the last time the query was run, the cached result will be returned, and the query will not be evaluated in that buffer again.
|
||||
|
||||
Therefore, since neither query expressions nor match actions are guaranteed to be evaluated when the following functions are called, they should be free of side effects. Or, if a side effect is required, the cache should be invalidated (e.g. by incrementing the buffer's modified tick, or by using a query expression or match action that has yet to be cached). /Note: Future improvements will allow the cache to be more easily disabled or cleared./
|
||||
Therefore, since query expressions are not guaranteed to be evaluated when these functions are called, they should be free of side effects. Any side effects should be done in the action expression instead.
|
||||
|
||||
**** Function: ~org-ql-select~
|
||||
|
||||
|
|
@ -380,7 +327,7 @@ Return items matching ~QUERY~ in ~BUFFERS-OR-FILES~.
|
|||
|
||||
If ~NARROW~ is non-nil, buffers are not widened (the default is to widen and search the entire buffer).
|
||||
|
||||
~SORT~ is either nil, in which case items are not sorted; or one or a list of defined ~org-ql~ sorting methods (~date~, ~deadline~, ~scheduled~, ~closed~, ~todo~, ~priority~, or ~random~); or a user-defined comparator function that accepts two items as arguments and returns nil or non-nil.
|
||||
~SORT~ is either nil, in which case items are not sorted; or one or a list of defined ~org-ql~ sorting methods (~date~, ~deadline~, ~scheduled~, ~todo~, ~priority~, or ~random~); or a user-defined comparator function that accepts two items as arguments and returns nil or non-nil.
|
||||
|
||||
Examples:
|
||||
|
||||
|
|
@ -452,58 +399,18 @@ Examples:
|
|||
;; => ((headline (:raw-value "Visit the moon" ...) ...) ...)
|
||||
#+END_SRC
|
||||
|
||||
**** Macro: ~org-ql~ (deprecated)
|
||||
**** Macro: ~org-ql~
|
||||
|
||||
/Arguments:/ ~(buffers-or-files query &key sort narrow markers action)~
|
||||
|
||||
Expands into a call to ~org-ql-select~ with the same arguments. For convenience, arguments should be unquoted.
|
||||
|
||||
/Note: This macro is deprecated and will be removed in v0.7./
|
||||
|
||||
*** Custom predicates
|
||||
|
||||
+ See: [[file:examples/defpred.org][Custom predicate tutorial]]
|
||||
|
||||
**** Macro: =org-ql-defpred=
|
||||
|
||||
/Arguments:/ ~(name args docstring &key body preambles normalizers)~
|
||||
|
||||
Define an ~org-ql~ selector predicate named ~org-ql--predicate-NAME~. ~NAME~ may be a symbol or a list of symbols: if a list, the first is used as ~NAME~ and the rest are aliases. ~A~ function is only created for ~NAME~, not for aliases, so a normalizer should be used to replace aliases with ~NAME~ in queries (keep reading).
|
||||
|
||||
~ARGS~ is a ~cl-defun~-style argument list. ~DOCSTRING~ is the function's docstring.
|
||||
|
||||
~BODY~ is the body of the predicate. It will be evaluated with point on the beginning of an Org heading and should return non-nil if the heading's entry is a match.
|
||||
|
||||
~PREAMBLES~ and ~NORMALIZERS~ are lists of ~pcase~ forms matched against Org ~QL~ query sexps. They are spliced into ~pcase~ forms in the definitions of the functions ~org-ql--query-preamble~ and ~org-ql--normalize-query~, which see. Those functions are redefined when this macro is expanded, unless variable ~org-ql-defpred-defer~ is non-nil, in which case those functions should be redefined manually after defining predicates by calling ~org-ql--define-query-preamble-fn~ and ~org-ql--define-normalize-query-fn~.
|
||||
|
||||
~NORMALIZERS~ are used to normalize query expressions to standard forms. For example, when the predicate has aliases, the aliases should be replaced with predicate names using a normalizer. Also, predicate arguments may be put into a more optimal form so that the predicate has less work to do at query time. NOTE: Normalizers are applied to a query repeatedly until the query is fully normalized, so normalizers should be carefully written to avoid infinite loops.
|
||||
|
||||
~PREAMBLES~ refer to regular expressions which may be used to search through a buffer directly to a potential match rather than testing the predicate body on each heading. (Naming things is hard.) In each ~pcase~ form in ~PREAMBLES~, the ~pcase~ expression (not the pattern) should be a plist with the following keys, each value of which should be an expression which may refer to variables bound in the pattern:
|
||||
|
||||
~:regexp~ Regular expression which searches directly to a potential match.
|
||||
|
||||
~:case-fold~ Bound to ~case-fold-search~ around the regexp search.
|
||||
|
||||
~:query~ Expression which should replace the query expression, or ~query~ if it should not be changed (e.g. if the regexp is insufficient to determine whether a heading matches, in which case the predicate's body needs to be tested on the heading). If the regexp guarantees a match, this may be simply ~t~, leaving the query expression with no work to do, which improves performance.
|
||||
|
||||
For convenience, within the ~pcase~ patterns, the symbol ~predicate-names~ is a special form which is replaced with a pattern matching any of the predicate's name and aliases. For example, if ~NAME~ were:
|
||||
|
||||
~(heading h)~
|
||||
|
||||
Then if ~NORMALIZERS~ were:
|
||||
|
||||
~((`(,predicate-names . ,args) `(heading ,@args)))~
|
||||
|
||||
It would be expanded to:
|
||||
|
||||
~((`(,(or 'heading 'h) . ,args) `(heading ,@args)))~
|
||||
|
||||
** Dynamic block
|
||||
|
||||
Org QL provides a dynamic block that lists entries in the current document matching a query. In the header, these parameters are supported:
|
||||
|
||||
+ ~:query~: An Org QL query expression in either sexp or non-sexp form.
|
||||
+ ~:columns~ A list of columns, including ~heading~, ~todo~, ~property~, ~priority~, ~deadline~, ~scheduled~, ~closed~.
|
||||
+ ~:columns~ A list of columns, including ~heading~, ~todo~, ~property~, ~priority~, ~deadline~, ~scheduled~.
|
||||
- Each column may also be specified as a list with the second element being a header string. For example, to abbreviate the priority column: ~(priority "P")~.
|
||||
- For certain columns, like =property=, arguments may be passed by specifying the column type itself as a list. For example, to display a column showing the values of a ~property~ named ~milestone~, with the header being abbreviated to ~M~: ~((property "milestone") "M")~.
|
||||
+ ~:sort~ One or a list of Org QL sorting methods (see ~org-ql-select~).
|
||||
|
|
@ -554,222 +461,6 @@ Simple links may also be written manually in either sexp or non-sexp form, like:
|
|||
|
||||
/Note:/ Breaking changes may be made before version 1.0, but in the event of major changes, attempts at backward compatibility will be made with obsolescence declarations, translation of arguments, etc. Users who need stability guarantees before 1.0 may choose to use tagged stable releases.
|
||||
|
||||
** 0.9-pre
|
||||
|
||||
*Additions*
|
||||
+ Face ~org-ql-view-query~, applied to view queries in header line.
|
||||
+ Face ~org-ql-view-title~, applied to view titles in header line.
|
||||
+ Option ~org-ql-view-relative-deadline-prefix~.
|
||||
|
||||
*Changes*
|
||||
+ Command ~org-ql-find~ respects narrowing of the current buffer by default, allowing searching within the narrowed region. (Using one ~C-u~ argument widens the current buffer, and using two ~C-u~ arguments prompts for the buffers to search.)
|
||||
+ Function ~org-ql-completing-read~ accepts a new ~NARROWP~ argument, which is passed to ~org-ql-select~.
|
||||
|
||||
*Fixes*
|
||||
+ Customization group for face ~org-ql-view-due-date~.
|
||||
+ Apply Org syntax font-locking to items in ~org-ql-view~ buffers.
|
||||
|
||||
*** helm-org-ql
|
||||
|
||||
Tagged v0.6.2, fixing a compilation warning.
|
||||
|
||||
** 0.8.10
|
||||
|
||||
*Fixes*
|
||||
+ Command ~org-ql-refile~ uses the base buffer when refiling to an indirect buffer. ([[https://github.com/alphapapa/org-ql/issues/466][#466]].)
|
||||
+ Predicate ~link~ could signal an error when searching text that is mistakenly recognized as an Org link (e.g. Bash double-bracket constructs in a source block). (Thanks to [[https://github.com/jwiegley][John Wiegley]] for reporting.)
|
||||
|
||||
** 0.8.9
|
||||
|
||||
*Fixes*
|
||||
+ Predicate ~property~ when called with argument form ~(property "PROPERTY-NAME" :inherit t)~. ([[https://github.com/alphapapa/org-ql/issues/460][#460]]. Thanks to [[https://github.com/Stewmath][Stewmath]] for reporting.)
|
||||
+ Predicate ~level~'s preamble optimizer allows expressions in place of the numeric argument. (See [[https://github.com/alphapapa/org-ql/issues/460][#460]]. Thanks to [[https://github.com/Stewmath][Stewmath]] for reporting.)
|
||||
+ Reading of view settings from Org links in upcoming Emacs version. ([[https://github.com/alphapapa/org-ql/issues/461][#461]]. Thanks to [[https://github.com/snogge][Ola Nilsson]] for help debugging, and for maintaining [[https://github.com/jorgenschaefer/emacs-buttercup][Buttercup]].)
|
||||
|
||||
*Compatibility*
|
||||
+ Fix compilation error on Emacs 30. ([[https://github.com/alphapapa/org-ql/issues/433][#433]]. Thanks to [[https://github.com/akirak][Akira Komamura]] and [[https://github.com/monnier][Stefan Monnier]].)
|
||||
|
||||
** 0.8.8
|
||||
|
||||
*Fixes*
|
||||
+ Remove text properties from to-do keywords before displaying them in an ~org-ql-view~ buffer. (Such text properties could cause them to, e.g. display with extra leading spaces, depending on which other modes might be enabled in the source Org buffer.)
|
||||
+ Binding of ~completion-styles-alist~ in ~org-ql-completing-read~. (This fixes compatibility with Helm's ~helm~ completion style, as well as default Emacs completion in recursive minibuffers. [[https://github.com/alphapapa/org-ql/issues/337][#337]]. Thanks to [[https://github.com/progfolio][Nicholas Vollmer]], [[https://github.com/9viz][viz]], and [[https://github.com/karthink][Karthik Chikmagalur]] for reporting and suggesting fixes.)
|
||||
+ Use of the context snippet function for ~org-ql-completing-read~. ([[https://github.com/alphapapa/org-ql/issues/419][#419]]. Thanks to [[https://github.com/tpeacock19][tpeacock19]] for reporting.)
|
||||
|
||||
** 0.8.7
|
||||
|
||||
*Fixes*
|
||||
+ Timestamps with internal time ranges (e.g. ~<2024-06-26 10:00-11:00>~) are matched for simple queries. (This support is not yet comprehensive, e.g. a query that depends on the specific inner time range may not behave as expected. Previously such timestamps were not matched at all. See [[https://github.com/alphapapa/org-ql/pull/237][#237]] and [[https://github.com/alphapapa/org-ql/issues/371][#371]]. Thanks to [[https://github.com/yantar92][Ihor Radchenko]].)
|
||||
+ Timestamps with day-of-the-week abbreviations are matched more flexibly (allowing, e.g. a period in French locales). (See [[https://github.com/alphapapa/org-ql/discussions/429][#429]], [[https://github.com/alphapapa/org-ql/issues/432][#432]]. Thanks to [[https://github.com/neurolit][Florian D.]] for reporting.)
|
||||
+ Command ~org-ql-search~ did not narrow properly when called interactively.
|
||||
|
||||
*Compatibility*
|
||||
+ Dynamic blocks work with Org 9.7. ([[https://github.com/alphapapa/org-ql/issues/431][#431]]. Thanks to [[https://github.com/jezcope][Jez Cope]] for reporting.)
|
||||
|
||||
** 0.8.6
|
||||
|
||||
*Fixes*
|
||||
+ Bookmarking ~org-ql-view~ buffers when the ~buffers-files~ argument is a symbol (like ~org-agenda-files~).
|
||||
|
||||
** 0.8.5
|
||||
|
||||
*Fixes*
|
||||
+ Predicate ~heading~ incorrectly matched strings as regular expressions, sometimes returning incorrect results. (See [[https://github.com/alphapapa/org-ql/discussions/410][discussion]]. Thanks to [[https://github.com/al3xandru][Alex Popescu]] for reporting.)
|
||||
+ Predicates ~ancestor~ and ~parent~ did not normalize their sub-queries, sometimes returning incorrect results. ([[https://github.com/alphapapa/org-ql/issues/365][#365]]. Thanks to [[https://github.com/kofm][Gabriele Mongiano]] for reporting.)
|
||||
|
||||
** 0.8.4
|
||||
|
||||
*Fixes*
|
||||
|
||||
+ Command ~org-ql-find~ goes to the selected entry in the base buffer (rather than potentially an indirect buffer, whose narrowing could leave the selected entry hidden. The nuances around going to entries in buffers that may be indirect and/or narrowed are surprisingly complicated. Hopefully this is the last fix).
|
||||
|
||||
** 0.8.3
|
||||
|
||||
*Fixes*
|
||||
|
||||
+ Command ~org-ql-find~ incorrectly moved point. (See [[https://github.com/alphapapa/org-ql/issues/380#issuecomment-1881913025][#380]]. Thanks to [[https://github.com/oantolin][Omar Antolín Camarena]] for reporting.)
|
||||
|
||||
** 0.8.2
|
||||
|
||||
*Fixes*
|
||||
|
||||
+ Command ~org-ql-find~ incorrectly restored the buffer after jumping when not using indirect buffers. (See [[https://github.com/alphapapa/org-ql/issues/380#issuecomment-1881913025][#380]]. Thanks to [[https://github.com/bram85][Bram Schoenmakers]] for reporting.)
|
||||
|
||||
** 0.8.1
|
||||
|
||||
*Fixes*
|
||||
|
||||
+ Command ~org-ql-find~ widens the buffer before going to the selected entry.
|
||||
+ In ~org-ql-view~ buffers, links in headings remain clickable links. (Fixes [[https://github.com/alphapapa/org-ql/issues/282][#282]]. Thanks to [[https://github.com/jakebox][Jacob Boxerman]] for reporting.)
|
||||
|
||||
** 0.8
|
||||
|
||||
*Additions*
|
||||
|
||||
+ 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-completing-read-export~, bound to ~C-c C-e~ or ~embark-export~ while in an ~org-ql-completing-read~ session, exits and shows an ~org-ql-view~ buffer for the current search.
|
||||
+ 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-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.)
|
||||
+ Items in ~org-ql-view~ buffers now include the ~org-category~ text property, like Org Agenda buffers, which allows grouping with ~org-super-agenda~'s category-related selectors. ([[https://github.com/alphapapa/org-ql/issues/363][#363]]. Thanks to [[https://github.com/kofm][Gabriele Mongiano]] for reporting.)
|
||||
|
||||
*Fixes*
|
||||
|
||||
+ Predicate ~property~ correctly uses the value of ~org-use-property-inheritance~ when not specified. ([[https://github.com/alphapapa/org-ql/pull/346][#346]], [[https://github.com/alphapapa/org-ql/issues/356][#356]]. Thanks to [[https://github.com/bram85][Bram Schoenmakers]].)
|
||||
|
||||
*Compatibility*
|
||||
|
||||
+ Emacs 27.1 or later is now required.
|
||||
+ Org v9.7's ~org-element~ API changes required some adjustments. ([[https://github.com/alphapapa/org-ql/issues/364][#364]]. Thanks to several users for reporting, and to [[https://github.com/yantar92][Ihor Radchenko]] for his feedback.)
|
||||
|
||||
** 0.7.4
|
||||
|
||||
*Fixes*
|
||||
+ Ignore empty quoted strings in plain-string queries ([[https://github.com/alphapapa/org-ql/issues/383][#383]]).
|
||||
|
||||
** 0.7.3
|
||||
|
||||
*Fixes*
|
||||
+ Disable ~case-fold-search~ when collecting headings in outline paths. (Headings that started with a word that is also a to-do keyword but with different capitalization would be matched incorrectly.)
|
||||
+ Saving of ~org-ql-view~ views. ([[https://github.com/alphapapa/org-ql/issues/378][#378]]. Thanks to [[https://github.com/Pentaquark1][Pentaquark1]] for reporting.)
|
||||
+ Command ~org-ql-find~ didn't move point to the selected entry. ([[https://github.com/alphapapa/org-ql/issues/380][#380]]. Thanks to [[https://github.com/oantolin][Omar Antolín Camarena]] for reporting.)
|
||||
|
||||
** 0.7.2
|
||||
|
||||
*Fixes*
|
||||
+ Timestamp predicates are more tolerant of partial input (e.g. preventing errors while the user is typing a query into ~org-ql-find~).
|
||||
+ Query parser ignores leading whitespace (e.g. preventing errors while the user is typing a query into ~org-ql-find~).
|
||||
+ Use of ~org-ql-find~ with ~:query-prefix~ argument prevented selection of results. ([[https://github.com/alphapapa/org-ql/issues/351][#351]]. Thanks to [[https://github.com/danielfleischer][Daniel Fleischer]] for reporting.)
|
||||
+ Handle narrowed buffers correctly in ~org-ql-find~.
|
||||
+ Warn about empty headings in ~org-ql-completing-read~ (the Org format allows a heading line to have no text, but it's useless for this purpose, and usually indicates unnoticed corruption).
|
||||
|
||||
** 0.7.1
|
||||
|
||||
*Fixes*
|
||||
+ Function ~org-ql-completing-read~ is more compatible with default Emacs completion. (See [[https://github.com/alphapapa/org-ql/issues/338][#338]]. Thanks to [[https://github.com/arozbiz][arozbiz]] for reporting.)
|
||||
+ Function ~org-ql-completing-read~ would sometimes stop updating with changes in input. (See [[https://github.com/alphapapa/org-ql/issues/350][#350]]. Thanks to [[https://github.com/anpandey][Ankit Raj Pandey]] for reporting and fixing, and to [[https://github.com/minad][Daniel Mendler]] for advising.)
|
||||
+ In ~org-ql-completing-read~, format links for display, and use ~org-entry-get~ internally rather than ~org-get-heading~.
|
||||
|
||||
** 0.7
|
||||
|
||||
*Added*
|
||||
+ Command ~org-ql-find~, which jumps to entries selected using Emacs's built-in completion facilities and Org QL queries (like ~helm-org-ql~, but doesn't require Helm.).
|
||||
+ Command ~org-ql-refile~, which refiles the entry at point to one selected using Org QL completion.
|
||||
+ Predicate ~rifle~, which matches an entry if each of the given arguments is found in either the entry's contents or its outline path. This provides very intuitive results, mimicing the behavior of [[https://github.com/alphapapa/org-rifle][=org-rifle=]]. In fact, the results are so useful that it's now the default predicate for plain-string query tokens. (It is also aliased to ~smart~, since it's so "smart," and not all users have used =org-rifle=.)
|
||||
+ Option ~org-ql-default-predicate~, applied to plain-string query tokens (before, the ~regexp~ predicate was always used, but now it may be customized).
|
||||
+ Alias ~c~ for predicate ~category~.
|
||||
+ Predicate ~property~ now accepts the argument ~:inherit~ to match entries with property inheritance, and when unspecified, the option ~org-use-property-inheritance~ controls whether inheritance is used.
|
||||
+ Predicate ~blocked~. (Thanks to [[https://github.com/akirak][Akira Komamura]].)
|
||||
|
||||
*Changed*
|
||||
+ Give more useful error message for invalid queries.
|
||||
+ Predicate ~src~ now matches case-insensitively.
|
||||
+ Command ~org-ql-sparse-tree~ accepts both string and sexp queries. (Thanks to [[https://github.com/akirak][Akira Komamura]].)
|
||||
|
||||
*Fixed*
|
||||
+ Predicate ~link~ matches links whose descriptions contain escaped brackets (changed in Org 9.3). (Thanks to [[https://github.com/exot][Daniel Borchmann]] for reporting.)
|
||||
+ Predicate ~src~'s matching of begin/end block lines, normalization of arguments, and handling in non-sexp queries. (Thanks to [[https://github.com/akirak][Akira Komamura]] for reporting.)
|
||||
+ Predicate ~src~'s behavior with various arguments.
|
||||
+ Various compilation warnings.
|
||||
|
||||
*Internal*
|
||||
+ Certain query predicates, when called multiple times in an ~and~ sub-expression, are optimized to a single call.
|
||||
+ Use ~buffer-chars-modified-tick~ instead of ~buffer-modified-tick~. (Thanks to [[https://github.com/yantar92][Ihor Radchenko]].)
|
||||
+ Implemented tests for ~src~ predicate.
|
||||
|
||||
*Credits*
|
||||
+ Thanks to [[https://github.com/chasecaleb][Caleb Chase]] for help with [[https://github.com/alphapapa/org-ql/pull/285][#285]], fixed in [[https://github.com/alphapapa/org-ql/commit/91908186fcca4b5fd2e9d26da5bc0375c2b41acf][9190818]].
|
||||
|
||||
** 0.6.3
|
||||
|
||||
*Fixed*
|
||||
+ Non-sexp query parsing with updated version 1.0.1 of the ~peg~ package. (Fixes [[https://github.com/alphapapa/org-ql/issues/314][#314]], [[https://github.com/alphapapa/org-ql/issues/316][#316]]. Thanks to [[https://github.com/akirak][Akira Komamura]] and [[https://github.com/joonro][Joon Ro]] for reporting.)
|
||||
+ Require library ~org-duration~ (apparently necessary in newer Org versions).
|
||||
|
||||
** 0.6.2
|
||||
|
||||
*Fixed*
|
||||
+ ~link~ predicate when used in an ~or~'ed query. ([[https://github.com/alphapapa/org-ql/issues/279][#279]]. Thanks to [[https://github.com/telenieko][Marc Fargas]] for reporting.)
|
||||
|
||||
** 0.6.1
|
||||
|
||||
*Fixed*
|
||||
+ In dynamic blocks, links to headings with statistics cookies were broken. (Fixes [[https://github.com/alphapapa/org-ql/issues/248][#248]]. Thanks to [[https://github.com/maikol-solis][Maikol Solis]] and [[https://github.com/yantar92][Ihor Radchenko]].)
|
||||
|
||||
*Updated*
|
||||
+ Compatibility with new macro names in Transient. ([[https://github.com/alphapapa/org-ql/pull/269][#269]]. Thanks to [[https://github.com/tarsius][Jonas Bernoulli]].)
|
||||
|
||||
** 0.6
|
||||
|
||||
*Added*
|
||||
+ Macro =org-ql-defpred=, used to define search predicates. (See [[file:examples/defpred.org][tutorial]].)
|
||||
+ Predicate ~effort~.
|
||||
+ Predicate ~heading-regexp~, which matches regular expressions against heading text (alias: ~h*~).
|
||||
+ Timestamp-related predicates now accept an optional ~:with-time~ argument, which allows matching timestamps with or without times (i.e. HH:MM).
|
||||
+ Sorting methods:
|
||||
- ~reverse~
|
||||
- ~closed~ (Thanks to [[https://github.com/yejianye][Ryan Ye]].)
|
||||
+ Dynamic block column ~closed~. (Thanks to [[https://github.com/yejianye][Ryan Ye]].)
|
||||
+ Abbreviate filenames in bookmarks. (Thanks to [[https://github.com/akirak][Akira Komamura]].)
|
||||
|
||||
*Changed*
|
||||
+ The order in which sorting functions is applied has been reversed. For example, ~:sort '(todo priority date)~ now does what ~:sort '(date priority todo)~ did in earlier versions. (This change is made to enable the new ~reverse~ sorting method.) Users who have customized =org-ql-views= will need to update the stored views' sorting methods to preserve the desired sort order.
|
||||
+ Helm support (including the command =helm-org-ql=) has been moved to a separate package, =helm-org-ql=.
|
||||
+ Predicate ~heading~ now matches plain strings instead of regular expressions.
|
||||
+ Update =dash= dependency, and remove dependency on obsolete =dash-functional=. (Fixes [[https://github.com/alphapapa/org-ql/issues/179][#179]], [[https://github.com/alphapapa/org-ql/issues/209][#209]]. Thanks to [[https://github.com/landakram][Mark Hudnall]], [[https://github.com/akirak][Akira Komamura]], [[https://github.com/natask][Nathanael kinfe]], [[https://github.com/benthamite][Pablo Stafforini]], [[https://github.com/jmay][Jason May]], and [[https://github.com/basil-conto][Basil L. Contovounesios]].)
|
||||
|
||||
*Removed*
|
||||
+ Obsolete macro ~org-ql~ (obsolete since 0.5, replaced by functions ~org-ql-select~ and ~org-ql-query~).
|
||||
|
||||
*Fixed*
|
||||
+ Timestamp-related predicates called with relative-date arguments did not properly invalidate the query cache. (Fixes [[https://github.com/alphapapa/org-ql/issues/223][#223]]. Thanks to [[https://github.com/yantar92][Ihor Radchenko]] for reporting.)
|
||||
|
||||
*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.
|
||||
+ Version 1.0 of library ~peg~ is now required.
|
||||
+ Improvements to how arguments to timestamp-related predicates are processed.
|
||||
+ Predicate normalizers are now applied repeatedly until a query is fully normalized. (Normalizers should be written with this in mind to avoid infinite loops.)
|
||||
|
||||
** 0.5.2
|
||||
|
||||
*Fixed*
|
||||
|
|
@ -1003,14 +694,6 @@ Tagged v0.6.2, fixing a compilation warning.
|
|||
|
||||
First tagged release.
|
||||
|
||||
* Development
|
||||
|
||||
Bug reports, feature requests, and suggestions are welcome. For patches, see below.
|
||||
|
||||
** Copyright assignment
|
||||
|
||||
While Org QL is currently distributed in MELPA, it's [[https://github.com/alphapapa/org-ql/issues/409][intended]] to merge Org QL into Org mode. When that happens, it will become a part of Emacs and Org, and therefore cumulative contributions of more than 15 lines of code will require that the author assign copyright of such contributions to the FSF. Authors who are interested in doing so may contact [[mailto:assign@gnu.org][assign@gnu.org]] to request the appropriate form.
|
||||
|
||||
* Notes
|
||||
:PROPERTIES:
|
||||
:TOC: :ignore this
|
||||
|
|
|
|||
|
|
@ -5,7 +5,6 @@
|
|||
:TOC: :include siblings :ignore this
|
||||
:END:
|
||||
:CONTENTS:
|
||||
- [[#custom-predicates][Custom predicates]]
|
||||
- [[#agenda-like-view][Agenda-like view]]
|
||||
- [[#entries-from-the-past-week][Entries from the past week]]
|
||||
- [[#find-entries-matching-a-certain-custom_id][Find entries matching a certain CUSTOM_ID]]
|
||||
|
|
@ -19,10 +18,6 @@
|
|||
- [[#task-list-for-files-in-subdirectories][Task list for files in subdirectories]]
|
||||
:END:
|
||||
|
||||
* Custom predicates
|
||||
|
||||
+ [[file:examples/defpred.org][Custom predicate tutorial]]
|
||||
|
||||
* Agenda-like view
|
||||
|
||||
Show an agenda-like view, similar to a "traditional" Org Agenda with Log Mode turned on.
|
||||
|
|
@ -35,7 +30,7 @@ Show an agenda-like view, similar to a "traditional" Org Agenda with Log Mode tu
|
|||
(scheduled :to today)
|
||||
(ts-active :on today)))
|
||||
(closed :on today))
|
||||
:sort '(todo priority date))
|
||||
:sort '(date priority todo))
|
||||
#+END_SRC
|
||||
|
||||
Another example, showing grouping with [[https://github.com/alphapapa/org-super-agenda][org-super-agenda]]:
|
||||
|
|
@ -76,7 +71,7 @@ Show entries that have any timestamp within the past week. Group by date using
|
|||
(org-ql-search (org-agenda-files)
|
||||
'(ts :from -7 :to today)
|
||||
:title "Recent Items"
|
||||
:sort '(todo priority date)
|
||||
:sort '(date priority todo)
|
||||
:super-groups '((:auto-ts t)))
|
||||
#+END_SRC
|
||||
|
||||
|
|
|
|||
|
|
@ -1,766 +0,0 @@
|
|||
<?xml version="1.0" encoding="utf-8"?>
|
||||
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN"
|
||||
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
|
||||
<html xmlns="http://www.w3.org/1999/xhtml" lang="en" xml:lang="en">
|
||||
<head>
|
||||
<!-- 2020-11-23 Mon 03:31 -->
|
||||
<meta http-equiv="Content-Type" content="text/html;charset=utf-8" />
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1" />
|
||||
<title>Org QL Custom Predicates Tutorial</title>
|
||||
<meta name="generator" content="Org mode" />
|
||||
<style type="text/css">
|
||||
<!--/*--><![CDATA[/*><!--*/
|
||||
.title { text-align: center;
|
||||
margin-bottom: .2em; }
|
||||
.subtitle { text-align: center;
|
||||
font-size: medium;
|
||||
font-weight: bold;
|
||||
margin-top:0; }
|
||||
.todo { font-family: monospace; color: red; }
|
||||
.done { font-family: monospace; color: green; }
|
||||
.priority { font-family: monospace; color: orange; }
|
||||
.tag { background-color: #eee; font-family: monospace;
|
||||
padding: 2px; font-size: 80%; font-weight: normal; }
|
||||
.timestamp { color: #bebebe; }
|
||||
.timestamp-kwd { color: #5f9ea0; }
|
||||
.org-right { margin-left: auto; margin-right: 0px; text-align: right; }
|
||||
.org-left { margin-left: 0px; margin-right: auto; text-align: left; }
|
||||
.org-center { margin-left: auto; margin-right: auto; text-align: center; }
|
||||
.underline { text-decoration: underline; }
|
||||
#postamble p, #preamble p { font-size: 90%; margin: .2em; }
|
||||
p.verse { margin-left: 3%; }
|
||||
pre {
|
||||
border: 1px solid #ccc;
|
||||
box-shadow: 3px 3px 3px #eee;
|
||||
padding: 8pt;
|
||||
font-family: monospace;
|
||||
overflow: auto;
|
||||
margin: 1.2em;
|
||||
}
|
||||
pre.src {
|
||||
position: relative;
|
||||
overflow: visible;
|
||||
padding-top: 1.2em;
|
||||
}
|
||||
pre.src:before {
|
||||
display: none;
|
||||
position: absolute;
|
||||
background-color: white;
|
||||
top: -10px;
|
||||
right: 10px;
|
||||
padding: 3px;
|
||||
border: 1px solid black;
|
||||
}
|
||||
pre.src:hover:before { display: inline;}
|
||||
/* Languages per Org manual */
|
||||
pre.src-asymptote:before { content: 'Asymptote'; }
|
||||
pre.src-awk:before { content: 'Awk'; }
|
||||
pre.src-C:before { content: 'C'; }
|
||||
/* pre.src-C++ doesn't work in CSS */
|
||||
pre.src-clojure:before { content: 'Clojure'; }
|
||||
pre.src-css:before { content: 'CSS'; }
|
||||
pre.src-D:before { content: 'D'; }
|
||||
pre.src-ditaa:before { content: 'ditaa'; }
|
||||
pre.src-dot:before { content: 'Graphviz'; }
|
||||
pre.src-calc:before { content: 'Emacs Calc'; }
|
||||
pre.src-emacs-lisp:before { content: 'Emacs Lisp'; }
|
||||
pre.src-fortran:before { content: 'Fortran'; }
|
||||
pre.src-gnuplot:before { content: 'gnuplot'; }
|
||||
pre.src-haskell:before { content: 'Haskell'; }
|
||||
pre.src-java:before { content: 'Java'; }
|
||||
pre.src-js:before { content: 'Javascript'; }
|
||||
pre.src-latex:before { content: 'LaTeX'; }
|
||||
pre.src-ledger:before { content: 'Ledger'; }
|
||||
pre.src-lisp:before { content: 'Lisp'; }
|
||||
pre.src-lilypond:before { content: 'Lilypond'; }
|
||||
pre.src-lua:before { content: 'Lua'; }
|
||||
pre.src-matlab:before { content: 'MATLAB'; }
|
||||
pre.src-mscgen:before { content: 'Mscgen'; }
|
||||
pre.src-ocaml:before { content: 'Objective Caml'; }
|
||||
pre.src-octave:before { content: 'Octave'; }
|
||||
pre.src-org:before { content: 'Org mode'; }
|
||||
pre.src-oz:before { content: 'OZ'; }
|
||||
pre.src-plantuml:before { content: 'Plantuml'; }
|
||||
pre.src-processing:before { content: 'Processing.js'; }
|
||||
pre.src-python:before { content: 'Python'; }
|
||||
pre.src-R:before { content: 'R'; }
|
||||
pre.src-ruby:before { content: 'Ruby'; }
|
||||
pre.src-sass:before { content: 'Sass'; }
|
||||
pre.src-scheme:before { content: 'Scheme'; }
|
||||
pre.src-screen:before { content: 'Gnu Screen'; }
|
||||
pre.src-sed:before { content: 'Sed'; }
|
||||
pre.src-sh:before { content: 'shell'; }
|
||||
pre.src-sql:before { content: 'SQL'; }
|
||||
pre.src-sqlite:before { content: 'SQLite'; }
|
||||
/* additional languages in org.el's org-babel-load-languages alist */
|
||||
pre.src-forth:before { content: 'Forth'; }
|
||||
pre.src-io:before { content: 'IO'; }
|
||||
pre.src-J:before { content: 'J'; }
|
||||
pre.src-makefile:before { content: 'Makefile'; }
|
||||
pre.src-maxima:before { content: 'Maxima'; }
|
||||
pre.src-perl:before { content: 'Perl'; }
|
||||
pre.src-picolisp:before { content: 'Pico Lisp'; }
|
||||
pre.src-scala:before { content: 'Scala'; }
|
||||
pre.src-shell:before { content: 'Shell Script'; }
|
||||
pre.src-ebnf2ps:before { content: 'ebfn2ps'; }
|
||||
/* additional language identifiers per "defun org-babel-execute"
|
||||
in ob-*.el */
|
||||
pre.src-cpp:before { content: 'C++'; }
|
||||
pre.src-abc:before { content: 'ABC'; }
|
||||
pre.src-coq:before { content: 'Coq'; }
|
||||
pre.src-groovy:before { content: 'Groovy'; }
|
||||
/* additional language identifiers from org-babel-shell-names in
|
||||
ob-shell.el: ob-shell is the only babel language using a lambda to put
|
||||
the execution function name together. */
|
||||
pre.src-bash:before { content: 'bash'; }
|
||||
pre.src-csh:before { content: 'csh'; }
|
||||
pre.src-ash:before { content: 'ash'; }
|
||||
pre.src-dash:before { content: 'dash'; }
|
||||
pre.src-ksh:before { content: 'ksh'; }
|
||||
pre.src-mksh:before { content: 'mksh'; }
|
||||
pre.src-posh:before { content: 'posh'; }
|
||||
/* Additional Emacs modes also supported by the LaTeX listings package */
|
||||
pre.src-ada:before { content: 'Ada'; }
|
||||
pre.src-asm:before { content: 'Assembler'; }
|
||||
pre.src-caml:before { content: 'Caml'; }
|
||||
pre.src-delphi:before { content: 'Delphi'; }
|
||||
pre.src-html:before { content: 'HTML'; }
|
||||
pre.src-idl:before { content: 'IDL'; }
|
||||
pre.src-mercury:before { content: 'Mercury'; }
|
||||
pre.src-metapost:before { content: 'MetaPost'; }
|
||||
pre.src-modula-2:before { content: 'Modula-2'; }
|
||||
pre.src-pascal:before { content: 'Pascal'; }
|
||||
pre.src-ps:before { content: 'PostScript'; }
|
||||
pre.src-prolog:before { content: 'Prolog'; }
|
||||
pre.src-simula:before { content: 'Simula'; }
|
||||
pre.src-tcl:before { content: 'tcl'; }
|
||||
pre.src-tex:before { content: 'TeX'; }
|
||||
pre.src-plain-tex:before { content: 'Plain TeX'; }
|
||||
pre.src-verilog:before { content: 'Verilog'; }
|
||||
pre.src-vhdl:before { content: 'VHDL'; }
|
||||
pre.src-xml:before { content: 'XML'; }
|
||||
pre.src-nxml:before { content: 'XML'; }
|
||||
/* add a generic configuration mode; LaTeX export needs an additional
|
||||
(add-to-list 'org-latex-listings-langs '(conf " ")) in .emacs */
|
||||
pre.src-conf:before { content: 'Configuration File'; }
|
||||
|
||||
table { border-collapse:collapse; }
|
||||
caption.t-above { caption-side: top; }
|
||||
caption.t-bottom { caption-side: bottom; }
|
||||
td, th { vertical-align:top; }
|
||||
th.org-right { text-align: center; }
|
||||
th.org-left { text-align: center; }
|
||||
th.org-center { text-align: center; }
|
||||
td.org-right { text-align: right; }
|
||||
td.org-left { text-align: left; }
|
||||
td.org-center { text-align: center; }
|
||||
dt { font-weight: bold; }
|
||||
.footpara { display: inline; }
|
||||
.footdef { margin-bottom: 1em; }
|
||||
.figure { padding: 1em; }
|
||||
.figure p { text-align: center; }
|
||||
.inlinetask {
|
||||
padding: 10px;
|
||||
border: 2px solid gray;
|
||||
margin: 10px;
|
||||
background: #ffffcc;
|
||||
}
|
||||
#org-div-home-and-up
|
||||
{ text-align: right; font-size: 70%; white-space: nowrap; }
|
||||
textarea { overflow-x: auto; }
|
||||
.linenr { font-size: smaller }
|
||||
.code-highlighted { background-color: #ffff00; }
|
||||
.org-info-js_info-navigation { border-style: none; }
|
||||
#org-info-js_console-label
|
||||
{ font-size: 10px; font-weight: bold; white-space: nowrap; }
|
||||
.org-info-js_search-highlight
|
||||
{ background-color: #ffff00; color: #000000; font-weight: bold; }
|
||||
.org-svg { width: 90%; }
|
||||
/*]]>*/-->
|
||||
</style>
|
||||
<link rel="stylesheet" type="text/css" href="export/styles/darksun/css/darksun.css"/>
|
||||
<script type="text/javascript" src="export/styles/darksun/js/jquery-1.11.0.min.js"></script>
|
||||
<script type="text/javascript" src="export/styles/darksun/js/jquery-ui-1.10.2.min.js"></script>
|
||||
<script type="text/javascript" src="export/styles/darksun/js/jquery.localscroll-min.js"></script>
|
||||
<script type="text/javascript" src="export/styles/darksun/js/jquery.scrollTo-1.4.3.1-min.js"></script>
|
||||
<script type="text/javascript" src="export/styles/darksun/js/jquery.zclip.min.js"></script>
|
||||
<script type="text/javascript" src="export/styles/darksun/js/darksun.js"></script>
|
||||
<script type="text/javascript" src="export/styles/lib/js/jquery.stickytableheaders.min.js"></script>
|
||||
<script type="text/javascript">
|
||||
/*
|
||||
@licstart The following is the entire license notice for the
|
||||
JavaScript code in this tag.
|
||||
|
||||
Copyright (C) 2012-2013 Free Software Foundation, Inc.
|
||||
|
||||
The JavaScript code in this tag is free software: you can
|
||||
redistribute it and/or modify it under the terms of the GNU
|
||||
General Public License (GNU GPL) as published by the Free Software
|
||||
Foundation, either version 3 of the License, or (at your option)
|
||||
any later version. The code is distributed WITHOUT ANY WARRANTY;
|
||||
without even the implied warranty of MERCHANTABILITY or FITNESS
|
||||
FOR A PARTICULAR PURPOSE. See the GNU GPL for more details.
|
||||
|
||||
As additional permission under GNU GPL version 3 section 7, you
|
||||
may distribute non-source (e.g., minimized or compacted) forms of
|
||||
that code without the copy of the GNU GPL normally required by
|
||||
section 4, provided you include this license notice and a URL
|
||||
through which recipients can access the Corresponding Source.
|
||||
|
||||
|
||||
@licend The above is the entire license notice
|
||||
for the JavaScript code in this tag.
|
||||
*/
|
||||
<!--/*--><![CDATA[/*><!--*/
|
||||
function CodeHighlightOn(elem, id)
|
||||
{
|
||||
var target = document.getElementById(id);
|
||||
if(null != target) {
|
||||
elem.cacheClassElem = elem.className;
|
||||
elem.cacheClassTarget = target.className;
|
||||
target.className = "code-highlighted";
|
||||
elem.className = "code-highlighted";
|
||||
}
|
||||
}
|
||||
function CodeHighlightOff(elem, id)
|
||||
{
|
||||
var target = document.getElementById(id);
|
||||
if(elem.cacheClassElem)
|
||||
elem.className = elem.cacheClassElem;
|
||||
if(elem.cacheClassTarget)
|
||||
target.className = elem.cacheClassTarget;
|
||||
}
|
||||
/*]]>*///-->
|
||||
</script>
|
||||
</head>
|
||||
<body>
|
||||
<div id="content">
|
||||
<h1 class="title">Org QL Custom Predicates Tutorial</h1>
|
||||
<div id="table-of-contents">
|
||||
<h2>Table of Contents</h2>
|
||||
<div id="text-table-of-contents">
|
||||
<ul>
|
||||
<li><a href="#Using%20built-in%20predicates">Using built-in predicates</a></li>
|
||||
<li><a href="#A%20custom%20~%28person%29~%20predicate">A custom <code>(person)</code> predicate</a></li>
|
||||
<li><a href="#Searching%20for%20multiple%20people%20at%20once">Searching for multiple people at once</a></li>
|
||||
<li><a href="#Normalizing%20queries%20to%20rewrite%20arguments">Normalizing queries to rewrite arguments</a></li>
|
||||
<li><a href="#Non-sexp%20query%20syntax">Non-sexp query syntax</a></li>
|
||||
<li><a href="#Using%20multiple%20predicates">Using multiple predicates</a></li>
|
||||
<li><a href="#Predicate%20aliases">Predicate aliases</a></li>
|
||||
<li><a href="#Be%20formless">Be formless</a></li>
|
||||
<li><a href="#Conclusion">Conclusion</a></li>
|
||||
<li><a href="#Appendix%3A%20Anaphoric%20macros">Appendix: Anaphoric macros</a></li>
|
||||
<li><a href="#Example%20data">Example data</a>
|
||||
<ul>
|
||||
<li><a href="#Loud%20pet%20parakeet">Loud pet parakeet   <span class="tag"><span class="personAlice">personAlice</span></span></a></li>
|
||||
<li><a href="#Missing%20sticky%20notes">Missing sticky notes   <span class="tag"><span class="personAlice">personAlice</span></span></a></li>
|
||||
<li><a href="#Dirty%20dishes%20in%20sink">Dirty dishes in sink   <span class="tag"><span class="personAlice">personAlice</span></span></a></li>
|
||||
<li><a href="#Stinky%20coffee%20breath">Stinky coffee breath</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
</div>
|
||||
</div>
|
||||
<p>
|
||||
<span class="timestamp-wrapper"><span class="timestamp">[2020-11-22 Sun 22:35] </span></span> Imagine you have weekly meetings with other people, and during the week you take notes about items to discuss at each meeting. When the time for a meeting comes, you want to quickly and easily search for all of the items to discuss at the meeting.
|
||||
</p>
|
||||
|
||||
<p>
|
||||
You've been experimenting with different ways to track such data in Org. You've tried using tags, but some of the names in question conflict with other tags in your data (e.g. someone's named Charles, but you also work with a firm named Charles, Inc., and you'd prefer to continue using the tag <code>Charles</code> for entries about that firm), so you've been using tags like <code>:personNAME:</code>, which seems awkward. You've tried using a <code>:person: NAME</code> property on entries, which has the advantage of not cluttering the tags list, but also the disadvantage of not being readily visible in an outline.
|
||||
</p>
|
||||
|
||||
<p>
|
||||
So you haven't decided on a long-term solution, but the meetings aren't going to wait–you need to search that data now, and you have a mix of both tags and properties in your entries. What you need is to be able to search for all of the entries about Alice (which you've tagged <code>:personAlice:</code>) when you're meeting with her, and all of the entries about Bob (which have the property <code>:person: Bob</code>) when you're meeting with him. What do you do?
|
||||
</p>
|
||||
|
||||
<div id="outline-container-Using%20built-in%20predicates" class="outline-2">
|
||||
<h2 id="Using%20built-in%20predicates">Using built-in predicates</h2>
|
||||
<div class="outline-text-2" id="text-Using%20built-in%20predicates">
|
||||
<p>
|
||||
You could start by using built-in Org QL predicates to search your data. For example:
|
||||
</p>
|
||||
|
||||
<div class="org-src-container">
|
||||
<pre class="src src-elisp"><span style="color: #a17e11;">(</span><span style="color: #3d85b7; text-decoration: underline;">org-ql-query</span><span style="color: #3d85b7;"> </span><span style="color: #3d85b7; font-weight: bold;">:select</span><span style="color: #3d85b7;"> '(</span><span style="color: #78880e;">org-get-heading </span><span style="color: #78880e; font-weight: bold;">:no-tags</span><span style="color: #3d85b7;">)</span>
|
||||
<span style="color: #3d85b7; font-weight: bold;">:from</span><span style="color: #3d85b7;"> (</span><span style="color: #78880e; text-decoration: underline;">current-buffer</span><span style="color: #3d85b7;">)</span>
|
||||
<span style="color: #3d85b7; font-weight: bold;">:where</span><span style="color: #3d85b7;"> '(</span><span style="color: #78880e; font-weight: bold;">or</span><span style="color: #78880e;"> (</span><span style="color: #3d8b85; text-decoration: underline;">tags</span><span style="color: #3d8b85;"> </span><span style="color: #65bc957591ca;">"personAlice"</span><span style="color: #78880e;">)</span>
|
||||
<span style="color: #78880e;">(</span><span style="color: #3d8b85; text-decoration: underline;">property</span><span style="color: #3d8b85;"> </span><span style="color: #65bc957591ca;">"person"</span> <span style="color: #65bc957591ca;">"Bob"</span><span style="color: #78880e;">)</span><span style="color: #3d85b7;">)</span><span style="color: #a17e11;">)</span>
|
||||
</pre>
|
||||
</div>
|
||||
|
||||
<ul class="org-ul">
|
||||
<li>[#A] Loud pet parakeet</li>
|
||||
<li>[#C] Missing sticky notes</li>
|
||||
<li>[#C] Dirty dishes in sink</li>
|
||||
<li>[#A] Stinky coffee breath</li>
|
||||
</ul>
|
||||
|
||||
<p>
|
||||
That was easy enough, but it's not very…semantic. You have to think about the implementation details: Alice uses tags, Bob uses properties, and what if Charlie uses both? It starts to feel complicated, and it's a lot to type out every time. Is there an easier way?
|
||||
</p>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<div id="outline-container-A%20custom%20~%28person%29~%20predicate" class="outline-2">
|
||||
<h2 id="A%20custom%20~%28person%29~%20predicate">A custom <code>(person)</code> predicate</h2>
|
||||
<div class="outline-text-2" id="text-A%20custom%20~%28person%29~%20predicate">
|
||||
<p>
|
||||
Enter <code>org-ql</code> custom search predicates. Let's start simple, by defining a predicate to search for just the <code>:person:</code> property, one person at a time. The predicate will take one argument, a person's name, and search for that property. It would look like this:
|
||||
</p>
|
||||
|
||||
<div class="org-src-container">
|
||||
<pre class="src src-elisp"><span style="color: #a17e11;">(</span><span style="color: #3d85b7; font-weight: bold;">org-ql-defpred</span><span style="color: #3d85b7;"> person (</span><span style="color: #78880e;">name</span><span style="color: #3d85b7;">)</span>
|
||||
<span style="color: #73139976b41e;">"Search for entries with the \"person\" property being NAME."</span>
|
||||
<span style="color: #3d85b7; font-weight: bold;">:body</span><span style="color: #3d85b7;"> (</span><span style="color: #78880e; text-decoration: underline;">property</span><span style="color: #78880e;"> </span><span style="color: #921da24c26e6;">"person"</span> <span style="color: #78880e;">name</span><span style="color: #3d85b7;">)</span><span style="color: #a17e11;">)</span>
|
||||
</pre>
|
||||
</div>
|
||||
|
||||
<p>
|
||||
Now, let's see what results we get for searching this file for entries about Bob:
|
||||
</p>
|
||||
|
||||
<div class="org-src-container">
|
||||
<pre class="src src-elisp"><span style="color: #a17e11;">(</span><span style="color: #3d85b7; text-decoration: underline;">org-ql-query</span><span style="color: #3d85b7;"> </span><span style="color: #3d85b7; font-weight: bold;">:select</span><span style="color: #3d85b7;"> '(</span><span style="color: #78880e;">org-get-heading </span><span style="color: #78880e; font-weight: bold;">:no-tags</span><span style="color: #3d85b7;">)</span>
|
||||
<span style="color: #3d85b7; font-weight: bold;">:from</span><span style="color: #3d85b7;"> (</span><span style="color: #78880e; text-decoration: underline;">current-buffer</span><span style="color: #3d85b7;">)</span>
|
||||
<span style="color: #3d85b7; font-weight: bold;">:where</span><span style="color: #3d85b7;"> '(</span><span style="color: #78880e;">person </span><span style="color: #921da24c26e6;">"Bob"</span><span style="color: #3d85b7;">)</span><span style="color: #a17e11;">)</span>
|
||||
</pre>
|
||||
</div>
|
||||
|
||||
<ul class="org-ul">
|
||||
<li>[#C] Missing sticky notes</li>
|
||||
<li>[#C] Dirty dishes in sink</li>
|
||||
<li>[#A] Stinky coffee breath</li>
|
||||
</ul>
|
||||
|
||||
<p>
|
||||
Hmm, looks like we need to remind Bob to wash his mug and take some mints after lunch. Now what do we need to discuss with Alice?
|
||||
</p>
|
||||
|
||||
<div class="org-src-container">
|
||||
<pre class="src src-elisp"><span style="color: #a17e11;">(</span><span style="color: #3d85b7; text-decoration: underline;">org-ql-query</span><span style="color: #3d85b7;"> </span><span style="color: #3d85b7; font-weight: bold;">:select</span><span style="color: #3d85b7;"> '(</span><span style="color: #78880e;">org-get-heading </span><span style="color: #78880e; font-weight: bold;">:no-tags</span><span style="color: #3d85b7;">)</span>
|
||||
<span style="color: #3d85b7; font-weight: bold;">:from</span><span style="color: #3d85b7;"> (</span><span style="color: #78880e; text-decoration: underline;">current-buffer</span><span style="color: #3d85b7;">)</span>
|
||||
<span style="color: #3d85b7; font-weight: bold;">:where</span><span style="color: #3d85b7;"> '(</span><span style="color: #78880e;">person </span><span style="color: #921da24c26e6;">"Alice"</span><span style="color: #3d85b7;">)</span><span style="color: #a17e11;">)</span>
|
||||
</pre>
|
||||
</div>
|
||||
|
||||
<pre class="example">
|
||||
</pre>
|
||||
|
||||
<p>
|
||||
Nothing? Oh, right, Alice's entries use the <code>:personAlice:</code> tag, so we'll also need to search those kind of entries. Let's make the predicate do that, too:
|
||||
</p>
|
||||
|
||||
<div class="org-src-container">
|
||||
<pre class="src src-elisp"><span style="color: #a17e11;">(</span><span style="color: #3d85b7; font-weight: bold;">org-ql-defpred</span><span style="color: #3d85b7;"> person (</span><span style="color: #78880e;">name</span><span style="color: #3d85b7;">)</span>
|
||||
<span style="color: #73139976b41e;">"Search for entries with the \"person\" property being NAME or having the tag \"personNAME\"."</span>
|
||||
<span style="color: #3d85b7; font-weight: bold;">:body</span><span style="color: #3d85b7;"> (</span><span style="color: #78880e; font-weight: bold;">or</span><span style="color: #78880e;"> (</span><span style="color: #3d8b85; text-decoration: underline;">property</span><span style="color: #3d8b85;"> </span><span style="color: #65bc957591ca;">"person"</span> <span style="color: #3d8b85;">name</span><span style="color: #78880e;">)</span>
|
||||
<span style="color: #78880e;">(</span><span style="color: #3d8b85; text-decoration: underline;">tags</span><span style="color: #3d8b85;"> (</span><span style="color: #a17e11; text-decoration: underline;">concat</span><span style="color: #a17e11;"> </span><span style="color: #b86396762cce;">"person"</span> <span style="color: #a17e11;">name</span><span style="color: #3d8b85;">)</span><span style="color: #78880e;">)</span><span style="color: #3d85b7;">)</span><span style="color: #a17e11;">)</span>
|
||||
</pre>
|
||||
</div>
|
||||
|
||||
<p>
|
||||
How about now?
|
||||
</p>
|
||||
|
||||
<div class="org-src-container">
|
||||
<pre class="src src-elisp"><span style="color: #a17e11;">(</span><span style="color: #3d85b7; text-decoration: underline;">org-ql-query</span><span style="color: #3d85b7;"> </span><span style="color: #3d85b7; font-weight: bold;">:select</span><span style="color: #3d85b7;"> '(</span><span style="color: #78880e;">org-get-heading </span><span style="color: #78880e; font-weight: bold;">:no-tags</span><span style="color: #3d85b7;">)</span>
|
||||
<span style="color: #3d85b7; font-weight: bold;">:from</span><span style="color: #3d85b7;"> (</span><span style="color: #78880e; text-decoration: underline;">current-buffer</span><span style="color: #3d85b7;">)</span>
|
||||
<span style="color: #3d85b7; font-weight: bold;">:where</span><span style="color: #3d85b7;"> '(</span><span style="color: #78880e;">person </span><span style="color: #921da24c26e6;">"Alice"</span><span style="color: #3d85b7;">)</span><span style="color: #a17e11;">)</span>
|
||||
</pre>
|
||||
</div>
|
||||
|
||||
<ul class="org-ul">
|
||||
<li>[#A] Loud pet parakeet</li>
|
||||
<li>[#C] Missing sticky notes</li>
|
||||
<li>[#C] Dirty dishes in sink</li>
|
||||
</ul>
|
||||
|
||||
<p>
|
||||
Hmm, I thought we already told her to leave Polly at home.
|
||||
</p>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<div id="outline-container-Searching%20for%20multiple%20people%20at%20once" class="outline-2">
|
||||
<h2 id="Searching%20for%20multiple%20people%20at%20once">Searching for multiple people at once</h2>
|
||||
<div class="outline-text-2" id="text-Searching%20for%20multiple%20people%20at%20once">
|
||||
<p>
|
||||
Oh, wait, this week is shortened due to holidays, so we're having a combined meeting. How do we search for entries about either of them? Well, this is the obvious solution:
|
||||
</p>
|
||||
|
||||
<div class="org-src-container">
|
||||
<pre class="src src-elisp"><span style="color: #a17e11;">(</span><span style="color: #3d85b7; text-decoration: underline;">org-ql-query</span><span style="color: #3d85b7;"> </span><span style="color: #3d85b7; font-weight: bold;">:select</span><span style="color: #3d85b7;"> '(</span><span style="color: #78880e;">org-get-heading </span><span style="color: #78880e; font-weight: bold;">:no-tags</span><span style="color: #3d85b7;">)</span>
|
||||
<span style="color: #3d85b7; font-weight: bold;">:from</span><span style="color: #3d85b7;"> (</span><span style="color: #78880e; text-decoration: underline;">current-buffer</span><span style="color: #3d85b7;">)</span>
|
||||
<span style="color: #3d85b7; font-weight: bold;">:where</span><span style="color: #3d85b7;"> '(</span><span style="color: #78880e; font-weight: bold;">or</span><span style="color: #78880e;"> (</span><span style="color: #3d8b85;">person </span><span style="color: #65bc957591ca;">"Alice"</span><span style="color: #78880e;">)</span>
|
||||
<span style="color: #78880e;">(</span><span style="color: #3d8b85;">person </span><span style="color: #65bc957591ca;">"Bob"</span><span style="color: #78880e;">)</span><span style="color: #3d85b7;">)</span><span style="color: #a17e11;">)</span>
|
||||
</pre>
|
||||
</div>
|
||||
|
||||
<ul class="org-ul">
|
||||
<li>[#A] Loud pet parakeet</li>
|
||||
<li>[#C] Missing sticky notes</li>
|
||||
<li>[#C] Dirty dishes in sink</li>
|
||||
<li>[#A] Stinky coffee breath</li>
|
||||
</ul>
|
||||
|
||||
<p>
|
||||
And that works fine. But it seems like a lot to type. Could we make the <code>person</code> predicate accept multiple names instead?
|
||||
</p>
|
||||
|
||||
<div class="org-src-container">
|
||||
<pre class="src src-elisp"><span style="color: #a17e11;">(</span><span style="color: #3d85b7; font-weight: bold;">org-ql-defpred</span><span style="color: #3d85b7;"> person (</span><span style="color: #78880e;">&rest</span><span style="color: #78880e;"> names</span><span style="color: #3d85b7;">)</span>
|
||||
<span style="color: #73139976b41e;">"Search for entries about any of NAMES."</span>
|
||||
<span style="color: #3d85b7; font-weight: bold;">:body</span><span style="color: #3d85b7;"> (</span><span style="color: #78880e; font-weight: bold;">cl-loop</span><span style="color: #78880e;"> for name in names</span>
|
||||
<span style="color: #78880e;"> thereis (</span><span style="color: #3d8b85; font-weight: bold;">or</span><span style="color: #3d8b85;"> (</span><span style="color: #a17e11; text-decoration: underline;">property</span><span style="color: #a17e11;"> </span><span style="color: #b86396762cce;">"person"</span> <span style="color: #a17e11;">name</span><span style="color: #3d8b85;">)</span>
|
||||
<span style="color: #3d8b85;">(</span><span style="color: #a17e11; text-decoration: underline;">tags</span><span style="color: #a17e11;"> (</span><span style="color: #3d85b7; text-decoration: underline;">concat</span><span style="color: #3d85b7;"> </span><span style="color: #73139976b41e;">"person"</span> <span style="color: #3d85b7;">name</span><span style="color: #a17e11;">)</span><span style="color: #3d8b85;">)</span><span style="color: #78880e;">)</span><span style="color: #3d85b7;">)</span><span style="color: #a17e11;">)</span>
|
||||
</pre>
|
||||
</div>
|
||||
|
||||
<p>
|
||||
Now let's search again:
|
||||
</p>
|
||||
|
||||
<div class="org-src-container">
|
||||
<pre class="src src-elisp"><span style="color: #a17e11;">(</span><span style="color: #3d85b7; text-decoration: underline;">org-ql-query</span><span style="color: #3d85b7;"> </span><span style="color: #3d85b7; font-weight: bold;">:select</span><span style="color: #3d85b7;"> '(</span><span style="color: #78880e;">org-get-heading </span><span style="color: #78880e; font-weight: bold;">:no-tags</span><span style="color: #3d85b7;">)</span>
|
||||
<span style="color: #3d85b7; font-weight: bold;">:from</span><span style="color: #3d85b7;"> (</span><span style="color: #78880e; text-decoration: underline;">current-buffer</span><span style="color: #3d85b7;">)</span>
|
||||
<span style="color: #3d85b7; font-weight: bold;">:where</span><span style="color: #3d85b7;"> '(</span><span style="color: #78880e;">person </span><span style="color: #921da24c26e6;">"Alice"</span> <span style="color: #921da24c26e6;">"Bob"</span><span style="color: #3d85b7;">)</span><span style="color: #a17e11;">)</span>
|
||||
</pre>
|
||||
</div>
|
||||
|
||||
<ul class="org-ul">
|
||||
<li>[#A] Loud pet parakeet</li>
|
||||
<li>[#C] Missing sticky notes</li>
|
||||
<li>[#C] Dirty dishes in sink</li>
|
||||
<li>[#A] Stinky coffee breath</li>
|
||||
</ul>
|
||||
|
||||
<p>
|
||||
That was easy!
|
||||
</p>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<div id="outline-container-Normalizing%20queries%20to%20rewrite%20arguments" class="outline-2">
|
||||
<h2 id="Normalizing%20queries%20to%20rewrite%20arguments">Normalizing queries to rewrite arguments</h2>
|
||||
<div class="outline-text-2" id="text-Normalizing%20queries%20to%20rewrite%20arguments">
|
||||
<p>
|
||||
Now, all this is well and good if you don't have hundreds of thousands of Org entries in your files. But what if you do? All that <code>concat</code>'ing happening on every entry could add up, and the query might take a few seconds. What if we could do that stringing-along just once, before running the query? We want to turn our <code>(person "Alice" "Bob")</code> query into this, with the <code>:personNAME:</code> strings already made and the per-person <code>(property ...)</code> predicates also included:
|
||||
</p>
|
||||
|
||||
<div class="org-src-container">
|
||||
<pre class="src src-elisp"><span style="color: #a17e11;">(</span><span style="color: #3d85b7; font-weight: bold;">or</span><span style="color: #3d85b7;"> (</span><span style="color: #78880e; text-decoration: underline;">tags</span><span style="color: #78880e;"> </span><span style="color: #921da24c26e6;">"personAlice"</span> <span style="color: #921da24c26e6;">"personBob"</span><span style="color: #3d85b7;">)</span>
|
||||
<span style="color: #3d85b7;">(</span><span style="color: #78880e; text-decoration: underline;">property</span><span style="color: #78880e;"> </span><span style="color: #921da24c26e6;">"person"</span> <span style="color: #921da24c26e6;">"Alice"</span><span style="color: #3d85b7;">)</span>
|
||||
<span style="color: #3d85b7;">(</span><span style="color: #78880e; text-decoration: underline;">property</span><span style="color: #78880e;"> </span><span style="color: #921da24c26e6;">"person"</span> <span style="color: #921da24c26e6;">"Bob"</span><span style="color: #3d85b7;">)</span><span style="color: #a17e11;">)</span>
|
||||
</pre>
|
||||
</div>
|
||||
|
||||
<p>
|
||||
Can we do that? In fact, we can, by using a query normalizer. Normalizers are <code>pcase</code> forms (I <i>know</i>) that normalize query expressions before execution. We can use one to rewrite the query ahead of time, like this:
|
||||
</p>
|
||||
|
||||
<div class="org-src-container">
|
||||
<pre class="src src-elisp"><span style="color: #a17e11;">(</span><span style="color: #3d85b7; font-weight: bold;">org-ql-defpred</span><span style="color: #3d85b7;"> person (</span><span style="color: #78880e;">&rest</span><span style="color: #78880e;"> names</span><span style="color: #3d85b7;">)</span>
|
||||
<span style="color: #73139976b41e;">"Search for entries about any of NAMES."</span>
|
||||
<span style="color: #3d85b7; font-weight: bold;">:normalizers</span><span style="color: #3d85b7;"> (</span><span style="color: #78880e;">(</span><span style="color: #3d8b85;">`(</span><span style="color: #a17e11;">person . ,names</span><span style="color: #3d8b85;">)</span>
|
||||
<span style="color: #3d8b85;">`(</span><span style="color: #a17e11; font-weight: bold;">or</span><span style="color: #a17e11;"> (</span><span style="color: #3d85b7; text-decoration: underline;">tags</span><span style="color: #3d85b7;"> ,@(</span><span style="color: #78880e; font-weight: bold;">cl-loop</span><span style="color: #78880e;"> for name in names</span>
|
||||
<span style="color: #78880e;"> collect (</span><span style="color: #3d8b85; text-decoration: underline;">concat</span><span style="color: #3d8b85;"> </span><span style="color: #65bc957591ca;">"person"</span> <span style="color: #3d8b85;">name</span><span style="color: #78880e;">)</span><span style="color: #3d85b7;">)</span><span style="color: #a17e11;">)</span>
|
||||
<span style="color: #a17e11;">,@(</span><span style="color: #3d85b7; font-weight: bold;">cl-loop</span><span style="color: #3d85b7;"> for name in names</span>
|
||||
<span style="color: #3d85b7;"> collect `(</span><span style="color: #78880e;">property </span><span style="color: #921da24c26e6;">"person"</span> <span style="color: #78880e;">,name</span><span style="color: #3d85b7;">)</span><span style="color: #a17e11;">)</span><span style="color: #3d8b85;">)</span><span style="color: #78880e;">)</span><span style="color: #3d85b7;">)</span>
|
||||
<span style="color: #3d85b7; font-weight: bold;">:body</span><span style="color: #3d85b7;"> (</span><span style="color: #78880e; font-weight: bold;">cl-loop</span><span style="color: #78880e;"> for name in names</span>
|
||||
<span style="color: #78880e;"> thereis (</span><span style="color: #3d8b85; font-weight: bold;">or</span><span style="color: #3d8b85;"> (</span><span style="color: #a17e11; text-decoration: underline;">property</span><span style="color: #a17e11;"> </span><span style="color: #b86396762cce;">"person"</span> <span style="color: #a17e11;">name</span><span style="color: #3d8b85;">)</span>
|
||||
<span style="color: #3d8b85;">(</span><span style="color: #a17e11; text-decoration: underline;">tags</span><span style="color: #a17e11;"> name</span><span style="color: #3d8b85;">)</span><span style="color: #78880e;">)</span><span style="color: #3d85b7;">)</span><span style="color: #a17e11;">)</span>
|
||||
</pre>
|
||||
</div>
|
||||
|
||||
<p>
|
||||
Now, don't faint from all the backquoting and unquoting–it's just Lisp, nothing to be afraid of! Let's slow down a moment and see what the normalized query looks like to be sure we're doing it correctly:
|
||||
</p>
|
||||
|
||||
<div class="org-src-container">
|
||||
<pre class="src src-elisp"><span style="color: #a17e11;">(</span><span style="color: #3d85b7; text-decoration: underline;">org-ql--normalize-query</span><span style="color: #3d85b7;"> '(</span><span style="color: #78880e;">person </span><span style="color: #921da24c26e6;">"Alice"</span> <span style="color: #921da24c26e6;">"Bob"</span><span style="color: #3d85b7;">)</span><span style="color: #a17e11;">)</span>
|
||||
</pre>
|
||||
</div>
|
||||
|
||||
<div class="org-src-container">
|
||||
<pre class="src src-elisp"><span style="color: #a17e11;">(</span><span style="color: #3d85b7; font-weight: bold;">or</span><span style="color: #3d85b7;"> (</span><span style="color: #78880e; text-decoration: underline;">tags</span><span style="color: #78880e;"> </span><span style="color: #921da24c26e6;">"personAlice"</span> <span style="color: #921da24c26e6;">"personBob"</span><span style="color: #3d85b7;">)</span>
|
||||
<span style="color: #3d85b7;">(</span><span style="color: #78880e; text-decoration: underline;">property</span><span style="color: #78880e;"> </span><span style="color: #921da24c26e6;">"person"</span> <span style="color: #921da24c26e6;">"Alice"</span><span style="color: #3d85b7;">)</span>
|
||||
<span style="color: #3d85b7;">(</span><span style="color: #78880e; text-decoration: underline;">property</span><span style="color: #78880e;"> </span><span style="color: #921da24c26e6;">"person"</span> <span style="color: #921da24c26e6;">"Bob"</span><span style="color: #3d85b7;">)</span><span style="color: #a17e11;">)</span>
|
||||
</pre>
|
||||
</div>
|
||||
|
||||
<p>
|
||||
And, as they say, Bob's your uncle! Or even if he isn't, let's see if it works:
|
||||
</p>
|
||||
|
||||
<div class="org-src-container">
|
||||
<pre class="src src-elisp"><span style="color: #a17e11;">(</span><span style="color: #3d85b7; text-decoration: underline;">org-ql-query</span><span style="color: #3d85b7;"> </span><span style="color: #3d85b7; font-weight: bold;">:select</span><span style="color: #3d85b7;"> '(</span><span style="color: #78880e;">org-get-heading </span><span style="color: #78880e; font-weight: bold;">:no-tags</span><span style="color: #3d85b7;">)</span>
|
||||
<span style="color: #3d85b7; font-weight: bold;">:from</span><span style="color: #3d85b7;"> (</span><span style="color: #78880e; text-decoration: underline;">current-buffer</span><span style="color: #3d85b7;">)</span>
|
||||
<span style="color: #3d85b7; font-weight: bold;">:where</span><span style="color: #3d85b7;"> '(</span><span style="color: #78880e;">person </span><span style="color: #921da24c26e6;">"Alice"</span> <span style="color: #921da24c26e6;">"Bob"</span><span style="color: #3d85b7;">)</span><span style="color: #a17e11;">)</span>
|
||||
</pre>
|
||||
</div>
|
||||
|
||||
<ul class="org-ul">
|
||||
<li>[#A] Loud pet parakeet</li>
|
||||
<li>[#C] Missing sticky notes</li>
|
||||
<li>[#C] Dirty dishes in sink</li>
|
||||
<li>[#A] Stinky coffee breath</li>
|
||||
</ul>
|
||||
|
||||
<p>
|
||||
Yep, same result as the non-normalized query. And look at how much simpler it is to write <code>(person "Alice" "Bob")</code> than to write <code>(or (tags "personAlice" "personBob") (property "person" "Alice") (property "person" "Bob"))</code>.
|
||||
</p>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<div id="outline-container-Non-sexp%20query%20syntax" class="outline-2">
|
||||
<h2 id="Non-sexp%20query%20syntax">Non-sexp query syntax</h2>
|
||||
<div class="outline-text-2" id="text-Non-sexp%20query%20syntax">
|
||||
<p>
|
||||
But wait, that's not all! If you order now, we'll throw in non-sexp query syntax for free! That's right, your search could be as simple as typing <code>person:Alice,Bob</code>!
|
||||
</p>
|
||||
|
||||
<div class="org-src-container">
|
||||
<pre class="src src-elisp"><span style="color: #a17e11;">(</span><span style="color: #3d85b7; text-decoration: underline;">org-ql-search</span><span style="color: #3d85b7;"> (</span><span style="color: #78880e; text-decoration: underline;">current-buffer</span><span style="color: #3d85b7;">)</span> <span style="color: #73139976b41e;">"person:Alice,Bob"</span><span style="color: #a17e11;">)</span>
|
||||
</pre>
|
||||
</div>
|
||||
|
||||
<p>
|
||||
Don't believe me? Well, you see, queries in this syntax are converted to the sexp syntax, like:
|
||||
</p>
|
||||
|
||||
<div class="org-src-container">
|
||||
<pre class="src src-elisp"><span style="color: #a17e11;">(</span><span style="color: #3d85b7; text-decoration: underline;">org-ql--query-string-to-sexp</span><span style="color: #3d85b7;"> </span><span style="color: #73139976b41e;">"person:Alice,Bob"</span><span style="color: #a17e11;">)</span>
|
||||
</pre>
|
||||
</div>
|
||||
|
||||
<div class="org-src-container">
|
||||
<pre class="src src-elisp"><span style="color: #a17e11;">(</span><span style="color: #3d85b7;">person </span><span style="color: #73139976b41e;">"Alice"</span> <span style="color: #73139976b41e;">"Bob"</span><span style="color: #a17e11;">)</span>
|
||||
</pre>
|
||||
</div>
|
||||
|
||||
<p>
|
||||
And that happens automatically when you use a search command like <code>org-ql-search</code>. If you have <code>org-ql</code> installed already, you could even click this link: <a href="person:Alice,Bob">Alice or Bob</a>. Which, in Org syntax, looks like:
|
||||
</p>
|
||||
|
||||
<div class="org-src-container">
|
||||
<pre class="src src-org"><span style="color: #b58900; text-decoration: underline;"><a href="org-ql-search:person:Alice,Bob">org-ql-search:person:Alice,Bob</a></span>
|
||||
</pre>
|
||||
</div>
|
||||
|
||||
<p>
|
||||
And that would open an Agenda Mode buffer that looks like this:
|
||||
</p>
|
||||
|
||||
<pre class="example">
|
||||
Query: (person "Alice" "Bob") In:meetings.org
|
||||
[#A] Loud pet parakeet :personAlice:
|
||||
[#C] Missing sticky notes :personAlice:
|
||||
[#C] Dirty dishes in sink :personAlice:
|
||||
[#A] Stinky coffee breath
|
||||
</pre>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<div id="outline-container-Using%20multiple%20predicates" class="outline-2">
|
||||
<h2 id="Using%20multiple%20predicates">Using multiple predicates</h2>
|
||||
<div class="outline-text-2" id="text-Using%20multiple%20predicates">
|
||||
<p>
|
||||
Oops, you forgot that there's a birthday party in 20 minutes, so you only have time to talk about the highest priority items at this joint meeting today.
|
||||
</p>
|
||||
|
||||
<p>
|
||||
No problem, let's just select high-priority items:
|
||||
</p>
|
||||
|
||||
<div class="org-src-container">
|
||||
<pre class="src src-elisp"><span style="color: #a17e11;">(</span><span style="color: #3d85b7; text-decoration: underline;">org-ql-search</span><span style="color: #3d85b7;"> (</span><span style="color: #78880e; text-decoration: underline;">current-buffer</span><span style="color: #3d85b7;">)</span> <span style="color: #73139976b41e;">"person:Alice,Bob priority:A"</span><span style="color: #a17e11;">)</span>
|
||||
</pre>
|
||||
</div>
|
||||
|
||||
<p>
|
||||
Which shows:
|
||||
</p>
|
||||
|
||||
<pre class="example">
|
||||
Query: (and (person "Alice" "Bob") (priority "A")) In:meetings.org
|
||||
[#A] Loud pet parakeet :personAlice:
|
||||
[#A] Stinky coffee breath
|
||||
</pre>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<div id="outline-container-Predicate%20aliases" class="outline-2">
|
||||
<h2 id="Predicate%20aliases">Predicate aliases</h2>
|
||||
<div class="outline-text-2" id="text-Predicate%20aliases">
|
||||
<p>
|
||||
And, you know what, if you're just so busy that you don't even have time to type the word <code>person</code>, you can add an abbreviated alias, <code>p</code>, like this:
|
||||
</p>
|
||||
|
||||
<div class="org-src-container">
|
||||
<pre class="src src-elisp"><span style="color: #a17e11;">(</span><span style="color: #3d85b7; font-weight: bold;">org-ql-defpred</span><span style="color: #3d85b7;"> (</span><span style="color: #78880e;">person p</span><span style="color: #3d85b7;">)</span> <span style="color: #3d85b7;">(</span><span style="color: #78880e;">&rest</span><span style="color: #78880e;"> names</span><span style="color: #3d85b7;">)</span>
|
||||
<span style="color: #73139976b41e;">"Search for entries about any of NAMES."</span>
|
||||
<span style="color: #3d85b7; font-weight: bold;">:normalizers</span><span style="color: #3d85b7;"> (</span><span style="color: #78880e;">(</span><span style="color: #3d8b85;">`(</span><span style="color: #a17e11;">,predicate-names . ,names</span><span style="color: #3d8b85;">)</span>
|
||||
<span style="color: #3d8b85;">`(</span><span style="color: #a17e11; font-weight: bold;">or</span><span style="color: #a17e11;"> (</span><span style="color: #3d85b7; text-decoration: underline;">tags</span><span style="color: #3d85b7;"> ,@(</span><span style="color: #78880e; font-weight: bold;">cl-loop</span><span style="color: #78880e;"> for name in names</span>
|
||||
<span style="color: #78880e;"> collect (</span><span style="color: #3d8b85; text-decoration: underline;">concat</span><span style="color: #3d8b85;"> </span><span style="color: #65bc957591ca;">"person"</span> <span style="color: #3d8b85;">name</span><span style="color: #78880e;">)</span><span style="color: #3d85b7;">)</span><span style="color: #a17e11;">)</span>
|
||||
<span style="color: #a17e11;">,@(</span><span style="color: #3d85b7; font-weight: bold;">cl-loop</span><span style="color: #3d85b7;"> for name in names</span>
|
||||
<span style="color: #3d85b7;"> collect `(</span><span style="color: #78880e;">property </span><span style="color: #921da24c26e6;">"person"</span> <span style="color: #78880e;">,name</span><span style="color: #3d85b7;">)</span><span style="color: #a17e11;">)</span><span style="color: #3d8b85;">)</span><span style="color: #78880e;">)</span><span style="color: #3d85b7;">)</span>
|
||||
<span style="color: #3d85b7; font-weight: bold;">:body</span><span style="color: #3d85b7;"> (</span><span style="color: #78880e; font-weight: bold;">cl-loop</span><span style="color: #78880e;"> for name in names</span>
|
||||
<span style="color: #78880e;"> thereis (</span><span style="color: #3d8b85; font-weight: bold;">or</span><span style="color: #3d8b85;"> (</span><span style="color: #a17e11; text-decoration: underline;">property</span><span style="color: #a17e11;"> </span><span style="color: #b86396762cce;">"person"</span> <span style="color: #a17e11;">name</span><span style="color: #3d8b85;">)</span>
|
||||
<span style="color: #3d8b85;">(</span><span style="color: #a17e11; text-decoration: underline;">tags</span><span style="color: #a17e11;"> (</span><span style="color: #3d85b7; text-decoration: underline;">concat</span><span style="color: #3d85b7;"> </span><span style="color: #73139976b41e;">"person"</span> <span style="color: #3d85b7;">name</span><span style="color: #a17e11;">)</span><span style="color: #3d8b85;">)</span><span style="color: #78880e;">)</span><span style="color: #3d85b7;">)</span><span style="color: #a17e11;">)</span>
|
||||
</pre>
|
||||
</div>
|
||||
|
||||
<p>
|
||||
Let's try it:
|
||||
</p>
|
||||
|
||||
<div class="org-src-container">
|
||||
<pre class="src src-elisp"><span style="color: #a17e11;">(</span><span style="color: #3d85b7; text-decoration: underline;">org-ql-search</span><span style="color: #3d85b7;"> (</span><span style="color: #78880e; text-decoration: underline;">current-buffer</span><span style="color: #3d85b7;">)</span> <span style="color: #73139976b41e;">"p:Alice,Bob priority:A"</span><span style="color: #a17e11;">)</span>
|
||||
</pre>
|
||||
</div>
|
||||
|
||||
<p>
|
||||
And that shows:
|
||||
</p>
|
||||
|
||||
<pre class="example">
|
||||
Query: (and (person "Alice" "Bob") (priority "A")) In:meetings.org
|
||||
[#A] Loud pet parakeet :personAlice:
|
||||
[#A] Stinky coffee breath
|
||||
</pre>
|
||||
|
||||
<p>
|
||||
(It's up to you to remember whether <code>p</code> means <code>person</code> or <code>priority</code>, but code can't solve everything.)
|
||||
</p>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<div id="outline-container-Be%20formless" class="outline-2">
|
||||
<h2 id="Be%20formless">Be formless</h2>
|
||||
<div class="outline-text-2" id="text-Be%20formless">
|
||||
<p>
|
||||
We can even go a step further: since the normalizer rewrites the query to call the <code>property</code> and <code>tags</code> predicates instead, this <code>person</code> predicate doesn't even need a body form!
|
||||
</p>
|
||||
|
||||
<div class="org-src-container">
|
||||
<pre class="src src-elisp"><span style="color: #a17e11;">(</span><span style="color: #3d85b7; font-weight: bold;">org-ql-defpred</span><span style="color: #3d85b7;"> (</span><span style="color: #78880e;">person p</span><span style="color: #3d85b7;">)</span> <span style="color: #3d85b7;">(</span><span style="color: #78880e;">&rest</span><span style="color: #78880e;"> names</span><span style="color: #3d85b7;">)</span>
|
||||
<span style="color: #73139976b41e;">"Search for entries about any of NAMES."</span>
|
||||
<span style="color: #3d85b7; font-weight: bold;">:normalizers</span><span style="color: #3d85b7;"> (</span><span style="color: #78880e;">(</span><span style="color: #3d8b85;">`(</span><span style="color: #a17e11;">,predicate-names . ,names</span><span style="color: #3d8b85;">)</span>
|
||||
<span style="color: #3d8b85;">`(</span><span style="color: #a17e11; font-weight: bold;">or</span><span style="color: #a17e11;"> (</span><span style="color: #3d85b7; text-decoration: underline;">tags</span><span style="color: #3d85b7;"> ,@(</span><span style="color: #78880e; font-weight: bold;">cl-loop</span><span style="color: #78880e;"> for name in names</span>
|
||||
<span style="color: #78880e;"> collect (</span><span style="color: #3d8b85; text-decoration: underline;">concat</span><span style="color: #3d8b85;"> </span><span style="color: #65bc957591ca;">"person"</span> <span style="color: #3d8b85;">name</span><span style="color: #78880e;">)</span><span style="color: #3d85b7;">)</span><span style="color: #a17e11;">)</span>
|
||||
<span style="color: #a17e11;">,@(</span><span style="color: #3d85b7; font-weight: bold;">cl-loop</span><span style="color: #3d85b7;"> for name in names</span>
|
||||
<span style="color: #3d85b7;"> collect `(</span><span style="color: #78880e;">property </span><span style="color: #921da24c26e6;">"person"</span> <span style="color: #78880e;">,name</span><span style="color: #3d85b7;">)</span><span style="color: #a17e11;">)</span><span style="color: #3d8b85;">)</span><span style="color: #78880e;">)</span><span style="color: #3d85b7;">)</span><span style="color: #a17e11;">)</span>
|
||||
</pre>
|
||||
</div>
|
||||
|
||||
<p>
|
||||
Will it still work?
|
||||
</p>
|
||||
|
||||
<div class="org-src-container">
|
||||
<pre class="src src-elisp"><span style="color: #a17e11;">(</span><span style="color: #3d85b7; text-decoration: underline;">org-ql-query</span><span style="color: #3d85b7;"> </span><span style="color: #3d85b7; font-weight: bold;">:select</span><span style="color: #3d85b7;"> '(</span><span style="color: #78880e;">org-get-heading </span><span style="color: #78880e; font-weight: bold;">:no-tags</span><span style="color: #3d85b7;">)</span>
|
||||
<span style="color: #3d85b7; font-weight: bold;">:from</span><span style="color: #3d85b7;"> (</span><span style="color: #78880e; text-decoration: underline;">current-buffer</span><span style="color: #3d85b7;">)</span>
|
||||
<span style="color: #3d85b7; font-weight: bold;">:where</span><span style="color: #3d85b7;"> '(</span><span style="color: #78880e;">person </span><span style="color: #921da24c26e6;">"Alice"</span> <span style="color: #921da24c26e6;">"Bob"</span><span style="color: #3d85b7;">)</span><span style="color: #a17e11;">)</span>
|
||||
</pre>
|
||||
</div>
|
||||
|
||||
<ul class="org-ul">
|
||||
<li>[#A] Loud pet parakeet</li>
|
||||
<li>[#C] Missing sticky notes</li>
|
||||
<li>[#C] Dirty dishes in sink</li>
|
||||
<li>[#A] Stinky coffee breath</li>
|
||||
</ul>
|
||||
|
||||
<p>
|
||||
It does!
|
||||
</p>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<div id="outline-container-Conclusion" class="outline-2">
|
||||
<h2 id="Conclusion">Conclusion</h2>
|
||||
<div class="outline-text-2" id="text-Conclusion">
|
||||
<p>
|
||||
In this tutorial, we've gone from having to write lengthy, complex query expressions for accommodating idiosyncratic requirements, to being able to write simple query expressions that abstract away ugly details, to rewriting those query expressions into a more optimal form before a search is even run. The end result is an Org Query Language that is customized to meet your specific needs.
|
||||
</p>
|
||||
|
||||
<p>
|
||||
What new custom predicates will you write next?
|
||||
</p>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<div id="outline-container-Appendix%3A%20Anaphoric%20macros" class="outline-2">
|
||||
<h2 id="Appendix%3A%20Anaphoric%20macros">Appendix: Anaphoric macros</h2>
|
||||
<div class="outline-text-2" id="text-Appendix%3A%20Anaphoric%20macros">
|
||||
<p>
|
||||
Finally, if you're a Lisper who appreciates anaphora, you might prefer a more syntactically concise definition of the predicate using Dash macros:
|
||||
</p>
|
||||
|
||||
<div class="org-src-container">
|
||||
<pre class="src src-elisp"><span style="color: #a17e11;">(</span><span style="color: #3d85b7; font-weight: bold;">org-ql-defpred</span><span style="color: #3d85b7;"> (</span><span style="color: #78880e;">person p</span><span style="color: #3d85b7;">)</span> <span style="color: #3d85b7;">(</span><span style="color: #78880e;">&rest</span><span style="color: #78880e;"> names</span><span style="color: #3d85b7;">)</span>
|
||||
<span style="color: #73139976b41e;">"Search for entries about any of NAMES."</span>
|
||||
<span style="color: #3d85b7; font-weight: bold;">:normalizers</span><span style="color: #3d85b7;"> (</span><span style="color: #78880e;">(</span><span style="color: #3d8b85;">`(</span><span style="color: #a17e11;">,predicate-names . ,names</span><span style="color: #3d8b85;">)</span>
|
||||
<span style="color: #3d8b85;">`(</span><span style="color: #a17e11; font-weight: bold;">or</span><span style="color: #a17e11;"> (</span><span style="color: #3d85b7; text-decoration: underline;">tags</span><span style="color: #3d85b7;"> ,@(</span><span style="color: #78880e; font-weight: bold;">--map</span><span style="color: #78880e;"> `(</span><span style="color: #3d8b85;">concat </span><span style="color: #65bc957591ca;">"person"</span> <span style="color: #3d8b85;">,</span><span style="color: #3d8b85;">it</span><span style="color: #78880e;">)</span> <span style="color: #78880e;">names</span><span style="color: #3d85b7;">)</span><span style="color: #a17e11;">)</span>
|
||||
<span style="color: #a17e11;">,@(</span><span style="color: #3d85b7; font-weight: bold;">--map</span><span style="color: #3d85b7;"> `(</span><span style="color: #78880e;">property </span><span style="color: #921da24c26e6;">"person"</span> <span style="color: #78880e;">,</span><span style="color: #78880e;">it</span><span style="color: #3d85b7;">)</span> <span style="color: #3d85b7;">names</span><span style="color: #a17e11;">)</span><span style="color: #3d8b85;">)</span><span style="color: #78880e;">)</span><span style="color: #3d85b7;">)</span><span style="color: #a17e11;">)</span>
|
||||
</pre>
|
||||
</div>
|
||||
|
||||
<p>
|
||||
Let's make sure it works:
|
||||
</p>
|
||||
|
||||
<div class="org-src-container">
|
||||
<pre class="src src-elisp"><span style="color: #a17e11;">(</span><span style="color: #3d85b7; text-decoration: underline;">org-ql-query</span><span style="color: #3d85b7;"> </span><span style="color: #3d85b7; font-weight: bold;">:select</span><span style="color: #3d85b7;"> '(</span><span style="color: #78880e;">org-get-heading </span><span style="color: #78880e; font-weight: bold;">:no-tags</span><span style="color: #3d85b7;">)</span>
|
||||
<span style="color: #3d85b7; font-weight: bold;">:from</span><span style="color: #3d85b7;"> (</span><span style="color: #78880e; text-decoration: underline;">current-buffer</span><span style="color: #3d85b7;">)</span>
|
||||
<span style="color: #3d85b7; font-weight: bold;">:where</span><span style="color: #3d85b7;"> '(</span><span style="color: #78880e;">person </span><span style="color: #921da24c26e6;">"Alice"</span> <span style="color: #921da24c26e6;">"Bob"</span><span style="color: #3d85b7;">)</span><span style="color: #a17e11;">)</span>
|
||||
</pre>
|
||||
</div>
|
||||
|
||||
<ul class="org-ul">
|
||||
<li>[#A] Loud pet parakeet</li>
|
||||
<li>[#C] Missing sticky notes</li>
|
||||
<li>[#C] Dirty dishes in sink</li>
|
||||
<li>[#A] Stinky coffee breath</li>
|
||||
</ul>
|
||||
|
||||
<p>
|
||||
Lisp is fun!
|
||||
</p>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<div id="outline-container-Example%20data" class="outline-2">
|
||||
<h2 id="Example%20data">Example data</h2>
|
||||
<div class="outline-text-2" id="text-Example%20data">
|
||||
</div>
|
||||
|
||||
<div id="outline-container-Loud%20pet%20parakeet" class="outline-3">
|
||||
<h3 id="Loud%20pet%20parakeet">Loud pet parakeet   <span class="tag"><span class="personAlice">personAlice</span></span></h3>
|
||||
</div>
|
||||
|
||||
<div id="outline-container-Missing%20sticky%20notes" class="outline-3">
|
||||
<h3 id="Missing%20sticky%20notes">Missing sticky notes   <span class="tag"><span class="personAlice">personAlice</span></span></h3>
|
||||
<div class="outline-text-3" id="text-Missing%20sticky%20notes">
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<div id="outline-container-Dirty%20dishes%20in%20sink" class="outline-3">
|
||||
<h3 id="Dirty%20dishes%20in%20sink">Dirty dishes in sink   <span class="tag"><span class="personAlice">personAlice</span></span></h3>
|
||||
<div class="outline-text-3" id="text-Dirty%20dishes%20in%20sink">
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<div id="outline-container-Stinky%20coffee%20breath" class="outline-3">
|
||||
<h3 id="Stinky%20coffee%20breath">Stinky coffee breath</h3>
|
||||
<div class="outline-text-3" id="text-Stinky%20coffee%20breath">
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
<div id="postamble" class="status">
|
||||
<p class="date">Created: 2020-11-23 Mon 03:31</p>
|
||||
<p class="validation"><a href="http://validator.w3.org/check?uri=referer">Validate</a></p>
|
||||
</div>
|
||||
</body>
|
||||
</html>
|
||||
|
|
@ -1,390 +0,0 @@
|
|||
#+TITLE: Org QL Custom Predicates Tutorial
|
||||
#+OPTIONS: author:nil creator:nil created:nil date:nil num:nil title:t broken-links:t
|
||||
#+SETUPFILE: export/setup/theme-darksun-local.setup
|
||||
|
||||
[2020-11-22 Sun 22:35] Imagine you have weekly meetings with other people, and during the week you take notes about items to discuss at each meeting. When the time for a meeting comes, you want to quickly and easily search for all of the items to discuss at the meeting.
|
||||
|
||||
You've been experimenting with different ways to track such data in Org. You've tried using tags, but some of the names in question conflict with other tags in your data (e.g. someone's named Charles, but you also work with a firm named Charles, Inc., and you'd prefer to continue using the tag =Charles= for entries about that firm), so you've been using tags like ~:personNAME:~, which seems awkward. You've tried using a ~:person: NAME~ property on entries, which has the advantage of not cluttering the tags list, but also the disadvantage of not being readily visible in an outline.
|
||||
|
||||
So you haven't decided on a long-term solution, but the meetings aren't going to wait--you need to search that data now, and you have a mix of both tags and properties in your entries. What you need is to be able to search for all of the entries about Alice (which you've tagged ~:personAlice:~) when you're meeting with her, and all of the entries about Bob (which have the property ~:person: Bob~) when you're meeting with him. What do you do?
|
||||
|
||||
* Contents :noexport:
|
||||
:PROPERTIES:
|
||||
:TOC: :include siblings :ignore this
|
||||
:END:
|
||||
:CONTENTS:
|
||||
- [[#using-built-in-predicates][Using built-in predicates]]
|
||||
- [[#a-custom-person-predicate][A custom (person) predicate]]
|
||||
- [[#searching-for-multiple-people-at-once][Searching for multiple people at once]]
|
||||
- [[#normalizing-queries-to-rewrite-arguments][Normalizing queries to rewrite arguments]]
|
||||
- [[#non-sexp-query-syntax][Non-sexp query syntax]]
|
||||
- [[#using-multiple-predicates][Using multiple predicates]]
|
||||
- [[#predicate-aliases][Predicate aliases]]
|
||||
- [[#be-formless][Be formless]]
|
||||
- [[#conclusion][Conclusion]]
|
||||
- [[#appendix-anaphoric-macros][Appendix: Anaphoric macros]]
|
||||
:END:
|
||||
|
||||
* Using built-in predicates
|
||||
|
||||
You could start by using built-in Org QL predicates to search your data. For example:
|
||||
|
||||
#+BEGIN_SRC elisp :results list :exports both :cache yes
|
||||
(org-ql-query :select '(org-get-heading :no-tags)
|
||||
:from (current-buffer)
|
||||
:where '(or (tags "personAlice")
|
||||
(property "person" "Bob")))
|
||||
#+END_SRC
|
||||
|
||||
#+RESULTS[91a413cda23cb65d6bb99212e111f283e5a5c910]:
|
||||
- [#A] Loud pet parakeet
|
||||
- [#C] Missing sticky notes
|
||||
- [#C] Dirty dishes in sink
|
||||
- [#A] Stinky coffee breath
|
||||
|
||||
That was easy enough, but it's not very...semantic. You have to think about the implementation details: Alice uses tags, Bob uses properties, and what if Charlie uses both? It starts to feel complicated, and it's a lot to type out every time. Is there an easier way?
|
||||
|
||||
* A custom ~(person)~ predicate
|
||||
|
||||
Enter =org-ql= custom search predicates. Let's start simple, by defining a predicate to search for just the ~:person:~ property, one person at a time. The predicate will take one argument, a person's name, and search for that property. It would look like this:
|
||||
|
||||
#+BEGIN_SRC elisp :results silent :exports code
|
||||
(org-ql-defpred person (name)
|
||||
"Search for entries with the \"person\" property being NAME."
|
||||
:body (property "person" name))
|
||||
#+END_SRC
|
||||
|
||||
Now, let's see what results we get for searching this file for entries about Bob:
|
||||
|
||||
#+BEGIN_SRC elisp :results list :exports both :cache yes
|
||||
(org-ql-query :select '(org-get-heading :no-tags)
|
||||
:from (current-buffer)
|
||||
:where '(person "Bob"))
|
||||
#+END_SRC
|
||||
|
||||
#+RESULTS[c11a4ce2c4f179d7487c9b46eff9f72766bc2bc4]:
|
||||
- [#C] Missing sticky notes
|
||||
- [#C] Dirty dishes in sink
|
||||
- [#A] Stinky coffee breath
|
||||
|
||||
Hmm, looks like we need to remind Bob to wash his mug and take some mints after lunch. Now what do we need to discuss with Alice?
|
||||
|
||||
#+BEGIN_SRC elisp :results list :exports both :cache yes
|
||||
(org-ql-query :select '(org-get-heading :no-tags)
|
||||
:from (current-buffer)
|
||||
:where '(person "Alice"))
|
||||
#+END_SRC
|
||||
|
||||
#+RESULTS[1f12f437042bbc077a4696d707805c1367f2ca3d]:
|
||||
#+BEGIN_EXAMPLE
|
||||
|
||||
#+END_EXAMPLE
|
||||
|
||||
Nothing? Oh, right, Alice's entries use the ~:personAlice:~ tag, so we'll also need to search those kind of entries. Let's make the predicate do that, too:
|
||||
|
||||
#+BEGIN_SRC elisp :results silent :exports code
|
||||
(org-ql-defpred person (name)
|
||||
"Search for entries with the \"person\" property being NAME or having the tag \"personNAME\"."
|
||||
:body (or (property "person" name)
|
||||
(tags (concat "person" name))))
|
||||
#+END_SRC
|
||||
|
||||
How about now?
|
||||
|
||||
#+BEGIN_SRC elisp :results list :exports both :cache yes
|
||||
(org-ql-query :select '(org-get-heading :no-tags)
|
||||
:from (current-buffer)
|
||||
:where '(person "Alice"))
|
||||
#+END_SRC
|
||||
|
||||
#+RESULTS[1f12f437042bbc077a4696d707805c1367f2ca3d]:
|
||||
- [#A] Loud pet parakeet
|
||||
- [#C] Missing sticky notes
|
||||
- [#C] Dirty dishes in sink
|
||||
|
||||
Hmm, I thought we already told her to leave Polly at home.
|
||||
|
||||
* Searching for multiple people at once
|
||||
|
||||
Oh, wait, this week is shortened due to holidays, so we're having a combined meeting. How do we search for entries about either of them? Well, this is the obvious solution:
|
||||
|
||||
#+BEGIN_SRC elisp :results list :exports both :cache yes
|
||||
(org-ql-query :select '(org-get-heading :no-tags)
|
||||
:from (current-buffer)
|
||||
:where '(or (person "Alice")
|
||||
(person "Bob")))
|
||||
#+END_SRC
|
||||
|
||||
#+RESULTS[4e4c75bde4fbceaadb076a53410c1625d1283e06]:
|
||||
- [#A] Loud pet parakeet
|
||||
- [#C] Missing sticky notes
|
||||
- [#C] Dirty dishes in sink
|
||||
- [#A] Stinky coffee breath
|
||||
|
||||
And that works fine. But it seems like a lot to type. Could we make the =person= predicate accept multiple names instead?
|
||||
|
||||
#+BEGIN_SRC elisp :results silent :exports code
|
||||
(org-ql-defpred person (&rest names)
|
||||
"Search for entries about any of NAMES."
|
||||
:body (cl-loop for name in names
|
||||
thereis (or (property "person" name)
|
||||
(tags (concat "person" name)))))
|
||||
#+END_SRC
|
||||
|
||||
Now let's search again:
|
||||
|
||||
#+BEGIN_SRC elisp :results list :exports both :cache yes
|
||||
(org-ql-query :select '(org-get-heading :no-tags)
|
||||
:from (current-buffer)
|
||||
:where '(person "Alice" "Bob"))
|
||||
#+END_SRC
|
||||
|
||||
#+RESULTS[4f5971c56616f01d8d3c28a66ef380495ee3e158]:
|
||||
- [#A] Loud pet parakeet
|
||||
- [#C] Missing sticky notes
|
||||
- [#C] Dirty dishes in sink
|
||||
- [#A] Stinky coffee breath
|
||||
|
||||
That was easy!
|
||||
|
||||
* Normalizing queries to rewrite arguments
|
||||
|
||||
Now, all this is well and good if you don't have hundreds of thousands of Org entries in your files. But what if you do? All that =concat='ing happening on every entry could add up, and the query might take a few seconds. What if we could do that stringing-along just once, before running the query? We want to turn our ~(person "Alice" "Bob")~ query into this, with the =:personNAME:= strings already made and the per-person ~(property ...)~ predicates also included:
|
||||
|
||||
#+BEGIN_SRC elisp
|
||||
(or (tags "personAlice" "personBob")
|
||||
(property "person" "Alice")
|
||||
(property "person" "Bob"))
|
||||
#+END_SRC
|
||||
|
||||
Can we do that? In fact, we can, by using a query normalizer. Normalizers are =pcase= forms (I /know/) that normalize query expressions before execution. We can use one to rewrite the query ahead of time, like this:
|
||||
|
||||
#+BEGIN_SRC elisp :results silent :exports code
|
||||
(org-ql-defpred person (&rest names)
|
||||
"Search for entries about any of NAMES."
|
||||
:normalizers ((`(person . ,names)
|
||||
`(or (tags ,@(cl-loop for name in names
|
||||
collect (concat "person" name)))
|
||||
,@(cl-loop for name in names
|
||||
collect `(property "person" ,name)))))
|
||||
:body (cl-loop for name in names
|
||||
thereis (or (property "person" name)
|
||||
(tags name))))
|
||||
#+END_SRC
|
||||
|
||||
/NOTE: Normalizers are applied to a query repeatedly until the query is fully normalized, so normalizers should be carefully written to avoid infinite loops. In this example, there is no risk of an infinite loop, because the normalized query no longer contains the ~person~ predicate, so the normalizer only applies to the query once./
|
||||
|
||||
Now, don't faint from all the backquoting and unquoting--it's just Lisp, nothing to be afraid of! Let's slow down a moment and see what the normalized query looks like to be sure we're doing it correctly:
|
||||
|
||||
#+BEGIN_SRC elisp :results code :exports both :cache yes
|
||||
(org-ql--normalize-query '(person "Alice" "Bob"))
|
||||
#+END_SRC
|
||||
|
||||
#+RESULTS[ebc46fff31b72359353dda539a26c95b7d650df2]:
|
||||
#+BEGIN_SRC elisp
|
||||
(or (tags "personAlice" "personBob")
|
||||
(property "person" "Alice")
|
||||
(property "person" "Bob"))
|
||||
#+END_SRC
|
||||
|
||||
And, as they say, Bob's your uncle! Or even if he isn't, let's see if it works:
|
||||
|
||||
#+BEGIN_SRC elisp :results list :exports both :cache yes
|
||||
(org-ql-query :select '(org-get-heading :no-tags)
|
||||
:from (current-buffer)
|
||||
:where '(person "Alice" "Bob"))
|
||||
#+END_SRC
|
||||
|
||||
#+RESULTS[4f5971c56616f01d8d3c28a66ef380495ee3e158]:
|
||||
- [#A] Loud pet parakeet
|
||||
- [#C] Missing sticky notes
|
||||
- [#C] Dirty dishes in sink
|
||||
- [#A] Stinky coffee breath
|
||||
|
||||
Yep, same result as the non-normalized query. And look at how much simpler it is to write ~(person "Alice" "Bob")~ than to write ~(or (tags "personAlice" "personBob") (property "person" "Alice") (property "person" "Bob"))~.
|
||||
|
||||
* Non-sexp query syntax
|
||||
|
||||
But wait, that's not all! If you order now, we'll throw in non-sexp query syntax for free! That's right, your search could be as simple as typing ~person:Alice,Bob~!
|
||||
|
||||
#+BEGIN_SRC elisp :results none :exports code
|
||||
(org-ql-search (current-buffer) "person:Alice,Bob")
|
||||
#+END_SRC
|
||||
|
||||
Don't believe me? Well, you see, queries in this syntax are converted to the sexp syntax, like:
|
||||
|
||||
#+BEGIN_SRC elisp :results code :exports both :cache yes
|
||||
(org-ql--query-string-to-sexp "person:Alice,Bob")
|
||||
#+END_SRC
|
||||
|
||||
#+RESULTS[a60655544956644605c23c152570185c329faa87]:
|
||||
#+BEGIN_SRC elisp
|
||||
(person "Alice" "Bob")
|
||||
#+END_SRC
|
||||
|
||||
And that happens automatically when you use a search command like =org-ql-search=. If you have =org-ql= installed already, you could even click this link: [[org-ql-search:person:Alice,Bob][Alice or Bob]]. Which, in Org syntax, looks like:
|
||||
|
||||
#+BEGIN_SRC org
|
||||
[[org-ql-search:person:Alice,Bob]]
|
||||
#+END_SRC
|
||||
|
||||
And that would open an Agenda Mode buffer that looks like this:
|
||||
|
||||
#+BEGIN_EXAMPLE
|
||||
Query: (person "Alice" "Bob") In:meetings.org
|
||||
[#A] Loud pet parakeet :personAlice:
|
||||
[#C] Missing sticky notes :personAlice:
|
||||
[#C] Dirty dishes in sink :personAlice:
|
||||
[#A] Stinky coffee breath
|
||||
#+END_EXAMPLE
|
||||
|
||||
* Using multiple predicates
|
||||
|
||||
Oops, you forgot that there's a birthday party in 20 minutes, so you only have time to talk about the highest priority items at this joint meeting today.
|
||||
|
||||
No problem, let's just select high-priority items:
|
||||
|
||||
#+BEGIN_SRC elisp :results silent :exports code
|
||||
(org-ql-search (current-buffer) "person:Alice,Bob priority:A")
|
||||
#+END_SRC
|
||||
|
||||
Which shows:
|
||||
|
||||
#+BEGIN_EXAMPLE
|
||||
Query: (and (person "Alice" "Bob") (priority "A")) In:meetings.org
|
||||
[#A] Loud pet parakeet :personAlice:
|
||||
[#A] Stinky coffee breath
|
||||
#+END_EXAMPLE
|
||||
|
||||
* Predicate aliases
|
||||
|
||||
And, you know what, if you're just so busy that you don't even have time to type the word =person=, you can add an abbreviated alias, =p=, like this:
|
||||
|
||||
#+BEGIN_SRC elisp :results silent :exports code
|
||||
(org-ql-defpred (person p) (&rest names)
|
||||
"Search for entries about any of NAMES."
|
||||
:normalizers ((`(,predicate-names . ,names)
|
||||
`(or (tags ,@(cl-loop for name in names
|
||||
collect (concat "person" name)))
|
||||
,@(cl-loop for name in names
|
||||
collect `(property "person" ,name)))))
|
||||
:body (cl-loop for name in names
|
||||
thereis (or (property "person" name)
|
||||
(tags (concat "person" name)))))
|
||||
#+END_SRC
|
||||
|
||||
Let's try it:
|
||||
|
||||
#+BEGIN_SRC elisp :results silent :exports code
|
||||
(org-ql-search (current-buffer) "p:Alice,Bob priority:A")
|
||||
#+END_SRC
|
||||
|
||||
And that shows:
|
||||
|
||||
#+BEGIN_EXAMPLE
|
||||
Query: (and (person "Alice" "Bob") (priority "A")) In:meetings.org
|
||||
[#A] Loud pet parakeet :personAlice:
|
||||
[#A] Stinky coffee breath
|
||||
#+END_EXAMPLE
|
||||
|
||||
(It's up to you to remember whether =p= means =person= or =priority=, but code can't solve everything.)
|
||||
|
||||
* Be formless
|
||||
|
||||
We can even go a step further: since the normalizer rewrites the query to call the =property= and =tags= predicates instead, this =person= predicate doesn't even need a body form!
|
||||
|
||||
#+BEGIN_SRC elisp :results silent :exports code
|
||||
(org-ql-defpred (person p) (&rest names)
|
||||
"Search for entries about any of NAMES."
|
||||
:normalizers ((`(,predicate-names . ,names)
|
||||
`(or (tags ,@(cl-loop for name in names
|
||||
collect (concat "person" name)))
|
||||
,@(cl-loop for name in names
|
||||
collect `(property "person" ,name))))))
|
||||
#+END_SRC
|
||||
|
||||
Will it still work?
|
||||
|
||||
#+BEGIN_SRC elisp :results list :exports both :cache yes
|
||||
(org-ql-query :select '(org-get-heading :no-tags)
|
||||
:from (current-buffer)
|
||||
:where '(person "Alice" "Bob"))
|
||||
#+END_SRC
|
||||
|
||||
#+RESULTS[4f5971c56616f01d8d3c28a66ef380495ee3e158]:
|
||||
- [#A] Loud pet parakeet
|
||||
- [#C] Missing sticky notes
|
||||
- [#C] Dirty dishes in sink
|
||||
- [#A] Stinky coffee breath
|
||||
|
||||
It does!
|
||||
|
||||
* Conclusion
|
||||
|
||||
In this tutorial, we've gone from having to write lengthy, complex query expressions for accommodating idiosyncratic requirements, to being able to write simple query expressions that abstract away ugly details, to rewriting those query expressions into a more optimal form before a search is even run. The end result is an Org Query Language that is customized to meet your specific needs.
|
||||
|
||||
What new custom predicates will you write next?
|
||||
|
||||
* Appendix: Anaphoric macros
|
||||
|
||||
Finally, if you're a Lisper who appreciates anaphora, you might prefer a more syntactically concise definition of the predicate using Dash macros:
|
||||
|
||||
#+BEGIN_SRC elisp :results silent :exports code
|
||||
(org-ql-defpred (person p) (&rest names)
|
||||
"Search for entries about any of NAMES."
|
||||
:normalizers ((`(,predicate-names . ,names)
|
||||
`(or (tags ,@(--map (concat "person" it) names))
|
||||
,@(--map `(property "person" ,it) names)))))
|
||||
#+END_SRC
|
||||
|
||||
Let's make sure it normalizes correctly:
|
||||
|
||||
#+BEGIN_SRC elisp :results code :exports both :cache yes
|
||||
(org-ql--normalize-query '(person "Alice" "Bob"))
|
||||
#+END_SRC
|
||||
|
||||
#+RESULTS[ebc46fff31b72359353dda539a26c95b7d650df2]:
|
||||
#+BEGIN_SRC elisp
|
||||
(or (tags "personAlice" "personBob")
|
||||
(property "person" "Alice")
|
||||
(property "person" "Bob"))
|
||||
#+END_SRC
|
||||
|
||||
It does, so the query also produces the correct results:
|
||||
|
||||
#+BEGIN_SRC elisp :results list :exports both :cache yes
|
||||
(org-ql-query :select '(org-get-heading :no-tags)
|
||||
:from (current-buffer)
|
||||
:where '(person "Alice" "Bob"))
|
||||
#+END_SRC
|
||||
|
||||
#+RESULTS[4f5971c56616f01d8d3c28a66ef380495ee3e158]:
|
||||
- [#A] Loud pet parakeet
|
||||
- [#C] Missing sticky notes
|
||||
- [#C] Dirty dishes in sink
|
||||
- [#A] Stinky coffee breath
|
||||
|
||||
Lisp is fun!
|
||||
|
||||
* Example data
|
||||
:PROPERTIES:
|
||||
:TOC: :ignore (this descendants)
|
||||
:END:
|
||||
|
||||
** [#A] Loud pet parakeet :personAlice:
|
||||
|
||||
** [#C] Missing sticky notes :personAlice:
|
||||
:PROPERTIES:
|
||||
:person: Bob
|
||||
:END:
|
||||
|
||||
** [#C] Dirty dishes in sink :personAlice:
|
||||
:PROPERTIES:
|
||||
:person: Bob
|
||||
:END:
|
||||
|
||||
** [#A] Stinky coffee breath
|
||||
:PROPERTIES:
|
||||
:person: Bob
|
||||
:END:
|
||||
|
||||
|
|
@ -1,17 +0,0 @@
|
|||
# -*- mode: org; -*-
|
||||
|
||||
# The files that hide sections and display a navbar and ToC are commented out.
|
||||
|
||||
# #+HTML_HEAD: <link rel="stylesheet" type="text/css" href="export/styles/darksun/css/htmlize.css"/>
|
||||
#+HTML_HEAD: <link rel="stylesheet" type="text/css" href="export/styles/darksun/css/darksun.css"/>
|
||||
# #+HTML_HEAD: <link rel="stylesheet" type="text/css" href="export/styles/darksun/css/hideshow.css"/>
|
||||
|
||||
#+HTML_HEAD: <script type="text/javascript" src="export/styles/darksun/js/jquery-1.11.0.min.js"></script>
|
||||
#+HTML_HEAD: <script type="text/javascript" src="export/styles/darksun/js/jquery-ui-1.10.2.min.js"></script>
|
||||
|
||||
#+HTML_HEAD: <script type="text/javascript" src="export/styles/darksun/js/jquery.localscroll-min.js"></script>
|
||||
#+HTML_HEAD: <script type="text/javascript" src="export/styles/darksun/js/jquery.scrollTo-1.4.3.1-min.js"></script>
|
||||
#+HTML_HEAD: <script type="text/javascript" src="export/styles/darksun/js/jquery.zclip.min.js"></script>
|
||||
#+HTML_HEAD: <script type="text/javascript" src="export/styles/darksun/js/darksun.js"></script>
|
||||
# #+HTML_HEAD: <script type="text/javascript" src="export/styles/darksun/js/hideshow.js"></script>
|
||||
#+HTML_HEAD: <script type="text/javascript" src="export/styles/lib/js/jquery.stickytableheaders.min.js"></script>
|
||||
|
|
@ -1,15 +0,0 @@
|
|||
# -*- mode: org; -*-
|
||||
|
||||
#+HTML_HEAD: <link rel="stylesheet" type="text/css" href="http://www.pirilampo.org/styles/darksun/css/htmlize.css"/>
|
||||
#+HTML_HEAD: <link rel="stylesheet" type="text/css" href="http://www.pirilampo.org/styles/darksun/css/darksun.css"/>
|
||||
#+HTML_HEAD: <link rel="stylesheet" type="text/css" href="http://www.pirilampo.org/styles/darksun/css/hideshow.css"/>
|
||||
|
||||
#+HTML_HEAD: <script type="text/javascript" src="http://www.pirilampo.org/styles/darksun/js/jquery-1.11.0.min.js"></script>
|
||||
#+HTML_HEAD: <script type="text/javascript" src="http://www.pirilampo.org/styles/darksun/js/jquery-ui-1.10.2.min.js"></script>
|
||||
|
||||
#+HTML_HEAD: <script type="text/javascript" src="http://www.pirilampo.org/styles/darksun/js/jquery.localscroll-min.js"></script>
|
||||
#+HTML_HEAD: <script type="text/javascript" src="http://www.pirilampo.org/styles/darksun/js/jquery.scrollTo-1.4.3.1-min.js"></script>
|
||||
#+HTML_HEAD: <script type="text/javascript" src="http://www.pirilampo.org/styles/darksun/js/jquery.zclip.min.js"></script>
|
||||
#+HTML_HEAD: <script type="text/javascript" src="http://www.pirilampo.org/styles/darksun/js/darksun.js"></script>
|
||||
#+HTML_HEAD: <script type="text/javascript" src="http://www.pirilampo.org/styles/darksun/js/hideshow.js"></script>
|
||||
#+HTML_HEAD: <script type="text/javascript" src="http://www.pirilampo.org/styles/lib/js/jquery.stickytableheaders.min.js"></script>
|
||||
|
|
@ -1,264 +0,0 @@
|
|||
* {
|
||||
border-color: #657b83;
|
||||
}
|
||||
a {
|
||||
color: #268bd2 !important;
|
||||
}
|
||||
a:visited {
|
||||
color: #6c71c4 !important;
|
||||
}
|
||||
body {
|
||||
background-color: #002b36 !important;
|
||||
color: #839496 !important;
|
||||
font-family: Libre Baskerville, serif;
|
||||
}
|
||||
html {
|
||||
background-color: #002b36 !important;
|
||||
}
|
||||
input,
|
||||
textarea {
|
||||
background-color: #073642 !important;
|
||||
color: #839496 !important;
|
||||
}
|
||||
blockquote,
|
||||
code,
|
||||
pre {
|
||||
background-color: #073642 !important;
|
||||
border: 1px solid #094352 !important;
|
||||
border-radius: 2px;
|
||||
box-shadow: none;
|
||||
color: #839496 !important;
|
||||
}
|
||||
code {
|
||||
font-size: 1.2em;
|
||||
}
|
||||
img {
|
||||
margin: 0.5em;
|
||||
}
|
||||
.buttons {
|
||||
background-color: #073642 !important;
|
||||
color: #93a1a1 !important;
|
||||
font-family: sans-serif;
|
||||
font-size: 1.5rem;
|
||||
}
|
||||
.hsReviewPanel {
|
||||
display: none;
|
||||
}
|
||||
.title {
|
||||
border: 0;
|
||||
}
|
||||
#postamble {
|
||||
display: none;
|
||||
}
|
||||
#banner {
|
||||
text-align: center;
|
||||
}
|
||||
#tabs {
|
||||
background-color: #073642 !important;
|
||||
float: left;
|
||||
margin: 0px 0px 20px 0px;
|
||||
padding: 0;
|
||||
width: 100%;
|
||||
font-family: sans-serif;
|
||||
}
|
||||
#tabs ul {
|
||||
margin: 0;
|
||||
padding: 0;
|
||||
}
|
||||
#tabs li {
|
||||
float: left;
|
||||
list-style-type: none;
|
||||
margin: 0px 2px 0px 0px;
|
||||
padding: 0px 0px 0px 0px;
|
||||
white-space: nowrap;
|
||||
}
|
||||
#tabs li a {
|
||||
display: block;
|
||||
font-size: 120%;
|
||||
font-weight: bold;
|
||||
margin: 0;
|
||||
padding: 4px 10px 4px 10px;
|
||||
text-decoration: none;
|
||||
}
|
||||
#tabs li a:hover {
|
||||
color: #90c5eb !important;
|
||||
}
|
||||
#tabs li.ui-tabs-active a {
|
||||
background-color: #094352 !important;
|
||||
color: #59a9e1 !important;
|
||||
}
|
||||
#content {
|
||||
clear: both;
|
||||
width: 80%;
|
||||
}
|
||||
#content > p {
|
||||
margin: 1em;
|
||||
}
|
||||
#content > div > h2 {
|
||||
margin: 0.25rem;
|
||||
}
|
||||
#postamble {
|
||||
text-align: right;
|
||||
}
|
||||
blockquote {
|
||||
background-color: #073642 !important;
|
||||
padding-left: 0.75em;
|
||||
padding-right: 0.75em;
|
||||
padding-top: 0.01em;
|
||||
padding-bottom: 0.01em;
|
||||
overflow: hidden;
|
||||
margin-left: 0;
|
||||
}
|
||||
.outline-text-2,
|
||||
.outline-text-3,
|
||||
.outline-text-4,
|
||||
.outline-text-5,
|
||||
.outline-text-6 {
|
||||
padding-left: 4%;
|
||||
}
|
||||
.outline-3 {
|
||||
padding-left: 4%;
|
||||
}
|
||||
.outline-4 {
|
||||
padding-left: 4%;
|
||||
}
|
||||
.outline-5 {
|
||||
padding-left: 4%;
|
||||
}
|
||||
.outline-6 {
|
||||
padding-left: 4%;
|
||||
}
|
||||
h1,
|
||||
h2,
|
||||
h3,
|
||||
h4,
|
||||
h5,
|
||||
h6 {
|
||||
font-family: sans-serif;
|
||||
border-bottom: 2px solid;
|
||||
border-color: #094352 !important;
|
||||
}
|
||||
a:hover {
|
||||
text-decoration: underline;
|
||||
}
|
||||
#search {
|
||||
display: block;
|
||||
float: right;
|
||||
}
|
||||
.tag {
|
||||
background-color: #002b36 !important;
|
||||
color: #93a1a1 !important;
|
||||
border: 0px;
|
||||
}
|
||||
.tag span {
|
||||
background-color: #094352 !important;
|
||||
margin: 0.25em;
|
||||
padding: 0.25em;
|
||||
}
|
||||
#table-of-contents {
|
||||
display: table;
|
||||
float: right;
|
||||
}
|
||||
#table-of-contents h2 {
|
||||
display: none;
|
||||
}
|
||||
#table-of-contents li {
|
||||
list-style-type: none;
|
||||
}
|
||||
#table-of-contents a:hover {
|
||||
text-decoration: underline;
|
||||
}
|
||||
#minitoc {
|
||||
background-color: #073642 !important;
|
||||
position: fixed;
|
||||
top: 0px;
|
||||
right: -5px;
|
||||
padding: 0.5em;
|
||||
z-index: 200;
|
||||
width: 18%;
|
||||
word-wrap: normal;
|
||||
overflow: hidden;
|
||||
}
|
||||
#minitoc ul {
|
||||
margin: 0.5em;
|
||||
padding-left: 1em;
|
||||
}
|
||||
#minitoc h2 {
|
||||
margin-top: 0;
|
||||
margin-bottom: 0;
|
||||
font-size: 110%;
|
||||
}
|
||||
#minitoc a {
|
||||
display: block;
|
||||
font-family: sans-serif;
|
||||
text-decoration: none;
|
||||
}
|
||||
#minitoc a:hover {
|
||||
text-decoration: underline;
|
||||
}
|
||||
/* #minitoc a { */
|
||||
/* display: none; */
|
||||
/* } */
|
||||
#minitoc:hover a {
|
||||
display: block;
|
||||
}
|
||||
#toTop {
|
||||
top: -100px;
|
||||
position: fixed;
|
||||
text-align: center;
|
||||
z-index: 999;
|
||||
display: none;
|
||||
}
|
||||
#toTop:hover {
|
||||
text-decoration: underline;
|
||||
}
|
||||
#left-panel-wrapper {
|
||||
display: none;
|
||||
position: fixed;
|
||||
z-index: 200;
|
||||
}
|
||||
#left-panel-contents {
|
||||
display: none;
|
||||
position: fixed;
|
||||
text-align: left;
|
||||
top: 0;
|
||||
z-index: 200;
|
||||
}
|
||||
#left-panel-button {
|
||||
transform: rotate(90deg);
|
||||
left: -23px;
|
||||
position: fixed;
|
||||
top: 50%;
|
||||
z-index: 200;
|
||||
}
|
||||
#right-panel-wrapper {
|
||||
position: fixed;
|
||||
z-index: 200;
|
||||
}
|
||||
#right-panel-contents {
|
||||
display: none;
|
||||
z-index: 200;
|
||||
position: fixed;
|
||||
text-align: left;
|
||||
top: 0;
|
||||
}
|
||||
.snippet-copy-to-clipboard {
|
||||
display: none;
|
||||
position: absolute;
|
||||
left: 50px;
|
||||
top: 50px;
|
||||
}
|
||||
.org-ol > li,
|
||||
.org-dl > dt {
|
||||
margin-top: 0.5em;
|
||||
}
|
||||
.org-ul {
|
||||
margin-top: 1em;
|
||||
margin-bottom: 1em;
|
||||
}
|
||||
.org-ul li {
|
||||
margin-top: 0.5em;
|
||||
}
|
||||
.org-ul > li > a {
|
||||
font-family: sans-serif;
|
||||
}
|
||||
|
|
@ -1,110 +0,0 @@
|
|||
/* hideshow.css --- HideShow CSS file */
|
||||
|
||||
/* Copyright (C) 2014 All Right Reserved, Fabrice Niessen */
|
||||
|
||||
/* This file is free software: you can redistribute it and/or */
|
||||
/* modify it under the terms of the GNU General Public License as */
|
||||
/* published by the Free Software Foundation, either version 3 of */
|
||||
/* the License, or (at your option) any later version. */
|
||||
|
||||
/* This file is distributed in the hope that it will be useful, */
|
||||
/* but WITHOUT ANY WARRANTY; without even the implied warranty of */
|
||||
/* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the */
|
||||
/* GNU General Public License for more details. */
|
||||
|
||||
/* Author: Fabrice Niessen <(concat "fniessen" at-sign "pirilampo.org")> */
|
||||
/* URL: https://github.com/fniessen/hide-show/ */
|
||||
/* Version: 20140912.1722 */
|
||||
|
||||
.hsExpanded.hsAnchor {background: #EE7700;}
|
||||
|
||||
.buttons {
|
||||
padding: 0px 7px 13px 0px;
|
||||
background: #0A3F69;
|
||||
}
|
||||
|
||||
.hsButton {
|
||||
color: white;
|
||||
float: right;
|
||||
font-size: 70%;
|
||||
margin-left: 10px;
|
||||
}
|
||||
|
||||
.hsButton:hover {
|
||||
text-decoration: underline;
|
||||
cursor: pointer;
|
||||
}
|
||||
|
||||
.ellipsis {
|
||||
color: #999999;
|
||||
/* background-color: #FFF8C0; */
|
||||
/* float: right; */
|
||||
margin-left: 0.6em;
|
||||
}
|
||||
|
||||
.hsReview {
|
||||
border: 1px solid #A4A4A4;
|
||||
background-color: white;
|
||||
z-index: 500; /* must be greater then z-index of hsOverlay */
|
||||
position: relative; /* required for z-index to work */
|
||||
}
|
||||
|
||||
#hsOverlay {
|
||||
width: 100%;
|
||||
height: 100%;
|
||||
position: fixed;
|
||||
left: 0px;
|
||||
top: 0px;
|
||||
background-color: #000;
|
||||
opacity: .70;
|
||||
z-index: 250; /* must be greater than any other z-index (except the one for .hsReview */
|
||||
}
|
||||
|
||||
.hsReviewPanel {
|
||||
background-color: #757176;
|
||||
color: white;
|
||||
line-height: 1.1em;
|
||||
margin: 10px 0px;
|
||||
padding: 10px;
|
||||
position: fixed;
|
||||
width: auto;
|
||||
bottom: 0px;
|
||||
right: 0px;
|
||||
z-index: 501;
|
||||
text-align: center;
|
||||
}
|
||||
|
||||
.hsReviewPanel.hsReviewing {
|
||||
display: none;
|
||||
}
|
||||
|
||||
.hsReviewPanel:hover {
|
||||
cursor: pointer;
|
||||
}
|
||||
|
||||
.hsReviewingPanel {
|
||||
background-color: white;
|
||||
color: #757176;
|
||||
line-height: 1.1em;
|
||||
margin: 10px 0px;
|
||||
padding: 10px;
|
||||
position: fixed;
|
||||
width: auto;
|
||||
bottom: 0px;
|
||||
right: 0px;
|
||||
z-index: 501;
|
||||
text-align: center;
|
||||
}
|
||||
|
||||
.hsReviewButton:hover {
|
||||
cursor: pointer;
|
||||
}
|
||||
|
||||
.hsUnselectable {
|
||||
-webkit-touch-callout: none;
|
||||
-webkit-user-select: none;
|
||||
-khtml-user-select: none;
|
||||
-moz-user-select: none;
|
||||
-ms-user-select: none;
|
||||
user-select: none;
|
||||
}
|
||||
|
|
@ -1,145 +0,0 @@
|
|||
.org-bold { /* bold */ font-weight: bold; }
|
||||
.org-bold-italic { /* bold-italic */ font-weight: bold; font-style: italic; }
|
||||
.org-buffer-menu-buffer { /* buffer-menu-buffer */ font-weight: bold; }
|
||||
.org-builtin { /* font-lock-builtin-face */ color: #7a378b; }
|
||||
.org-button { /* button */ text-decoration: underline; }
|
||||
.org-calendar-today { /* calendar-today */ text-decoration: underline; }
|
||||
.org-change-log-acknowledgement { /* change-log-acknowledgement */ color: #b22222; }
|
||||
.org-change-log-conditionals { /* change-log-conditionals */ color: #a0522d; }
|
||||
.org-change-log-date { /* change-log-date */ color: #8b2252; }
|
||||
.org-change-log-email { /* change-log-email */ color: #a0522d; }
|
||||
.org-change-log-file { /* change-log-file */ color: #0000ff; }
|
||||
.org-change-log-function { /* change-log-function */ color: #a0522d; }
|
||||
.org-change-log-list { /* change-log-list */ color: #a020f0; }
|
||||
.org-change-log-name { /* change-log-name */ color: #008b8b; }
|
||||
.org-comint-highlight-input { /* comint-highlight-input */ font-weight: bold; }
|
||||
.org-comint-highlight-prompt { /* comint-highlight-prompt */ color: #00008b; }
|
||||
.org-comment { /* font-lock-comment-face */ color: #b22222; }
|
||||
.org-comment-delimiter { /* font-lock-comment-delimiter-face */ color: #b22222; }
|
||||
.org-completions-annotations { /* completions-annotations */ font-style: italic; }
|
||||
.org-completions-common-part { /* completions-common-part */ color: #000000; background-color: #ffffff; }
|
||||
.org-completions-first-difference { /* completions-first-difference */ font-weight: bold; }
|
||||
.org-constant { /* font-lock-constant-face */ color: #008b8b; }
|
||||
.org-diary { /* diary */ color: #ff0000; }
|
||||
.org-diff-context { /* diff-context */ color: #7f7f7f; }
|
||||
.org-diff-file-header { /* diff-file-header */ background-color: #b3b3b3; font-weight: bold; }
|
||||
.org-diff-function { /* diff-function */ background-color: #cccccc; }
|
||||
.org-diff-header { /* diff-header */ background-color: #cccccc; }
|
||||
.org-diff-hunk-header { /* diff-hunk-header */ background-color: #cccccc; }
|
||||
.org-diff-index { /* diff-index */ background-color: #b3b3b3; font-weight: bold; }
|
||||
.org-diff-nonexistent { /* diff-nonexistent */ background-color: #b3b3b3; font-weight: bold; }
|
||||
.org-diff-refine-change { /* diff-refine-change */ background-color: #d9d9d9; }
|
||||
.org-dired-directory { /* dired-directory */ color: #0000ff; }
|
||||
.org-dired-flagged { /* dired-flagged */ color: #ff0000; font-weight: bold; }
|
||||
.org-dired-header { /* dired-header */ color: #228b22; }
|
||||
.org-dired-ignored { /* dired-ignored */ color: #7f7f7f; }
|
||||
.org-dired-mark { /* dired-mark */ color: #008b8b; }
|
||||
.org-dired-marked { /* dired-marked */ color: #ff0000; font-weight: bold; }
|
||||
.org-dired-perm-write { /* dired-perm-write */ color: #b22222; }
|
||||
.org-dired-symlink { /* dired-symlink */ color: #a020f0; }
|
||||
.org-dired-warning { /* dired-warning */ color: #ff0000; font-weight: bold; }
|
||||
.org-doc { /* font-lock-doc-face */ color: #8b2252; }
|
||||
.org-escape-glyph { /* escape-glyph */ color: #a52a2a; }
|
||||
.org-file-name-shadow { /* file-name-shadow */ color: #7f7f7f; }
|
||||
.org-flyspell-duplicate { /* flyspell-duplicate */ color: #cdad00; font-weight: bold; text-decoration: underline; }
|
||||
.org-flyspell-incorrect { /* flyspell-incorrect */ color: #ff4500; font-weight: bold; text-decoration: underline; }
|
||||
.org-fringe { /* fringe */ background-color: #f2f2f2; }
|
||||
.org-function-name { /* font-lock-function-name-face */ color: #0000ff; }
|
||||
.org-header-line { /* header-line */ color: #333333; background-color: #e5e5e5; }
|
||||
.org-help-argument-name { /* help-argument-name */ font-style: italic; }
|
||||
.org-highlight { /* highlight */ background-color: #b4eeb4; }
|
||||
.org-holiday { /* holiday */ background-color: #ffc0cb; }
|
||||
.org-isearch { /* isearch */ color: #b0e2ff; background-color: #cd00cd; }
|
||||
.org-isearch-fail { /* isearch-fail */ background-color: #ffc1c1; }
|
||||
.org-italic { /* italic */ font-style: italic; }
|
||||
.org-keyword { /* font-lock-keyword-face */ color: #a020f0; }
|
||||
.org-lazy-highlight { /* lazy-highlight */ background-color: #afeeee; }
|
||||
.org-link { /* link */ color: #0000ff; text-decoration: underline; }
|
||||
.org-link-visited { /* link-visited */ color: #8b008b; text-decoration: underline; }
|
||||
.org-log-edit-header { /* log-edit-header */ color: #a020f0; }
|
||||
.org-log-edit-summary { /* log-edit-summary */ color: #0000ff; }
|
||||
.org-log-edit-unknown-header { /* log-edit-unknown-header */ color: #b22222; }
|
||||
.org-match { /* match */ background-color: #ffff00; }
|
||||
.org-next-error { /* next-error */ background-color: #eedc82; }
|
||||
.org-nobreak-space { /* nobreak-space */ color: #a52a2a; text-decoration: underline; }
|
||||
.org-org-archived { /* org-archived */ color: #7f7f7f; }
|
||||
.org-org-block { /* org-block */ color: #7f7f7f; }
|
||||
.org-org-block-begin-line { /* org-block-begin-line */ color: #b22222; }
|
||||
.org-org-block-end-line { /* org-block-end-line */ color: #b22222; }
|
||||
.org-org-checkbox { /* org-checkbox */ font-weight: bold; }
|
||||
.org-org-checkbox-statistics-done { /* org-checkbox-statistics-done */ color: #228b22; font-weight: bold; }
|
||||
.org-org-checkbox-statistics-todo { /* org-checkbox-statistics-todo */ color: #ff0000; font-weight: bold; }
|
||||
.org-org-clock-overlay { /* org-clock-overlay */ background-color: #ffff00; }
|
||||
.org-org-code { /* org-code */ color: #7f7f7f; }
|
||||
.org-org-column { /* org-column */ background-color: #e5e5e5; }
|
||||
.org-org-column-title { /* org-column-title */ background-color: #e5e5e5; font-weight: bold; text-decoration: underline; }
|
||||
.org-org-date { /* org-date */ color: #a020f0; text-decoration: underline; }
|
||||
.org-org-document-info { /* org-document-info */ color: #191970; }
|
||||
.org-org-document-info-keyword { /* org-document-info-keyword */ color: #7f7f7f; }
|
||||
.org-org-document-title { /* org-document-title */ color: #191970; font-size: 144%; font-weight: bold; }
|
||||
.org-org-done { /* org-done */ color: #228b22; font-weight: bold; }
|
||||
.org-org-drawer { /* org-drawer */ color: #0000ff; }
|
||||
.org-org-ellipsis { /* org-ellipsis */ color: #b8860b; text-decoration: underline; }
|
||||
.org-org-footnote { /* org-footnote */ color: #a020f0; text-decoration: underline; }
|
||||
.org-org-formula { /* org-formula */ color: #b22222; }
|
||||
.org-org-headline-done { /* org-headline-done */ color: #bc8f8f; }
|
||||
.org-org-hide { /* org-hide */ color: #ffffff; }
|
||||
.org-org-latex-and-export-specials { /* org-latex-and-export-specials */ color: #8b4513; }
|
||||
.org-org-level-1 { /* org-level-1 */ color: #0000ff; }
|
||||
.org-org-level-2 { /* org-level-2 */ color: #a0522d; }
|
||||
.org-org-level-3 { /* org-level-3 */ color: #a020f0; }
|
||||
.org-org-level-4 { /* org-level-4 */ color: #b22222; }
|
||||
.org-org-level-5 { /* org-level-5 */ color: #228b22; }
|
||||
.org-org-level-6 { /* org-level-6 */ color: #008b8b; }
|
||||
.org-org-level-7 { /* org-level-7 */ color: #7a378b; }
|
||||
.org-org-level-8 { /* org-level-8 */ color: #8b2252; }
|
||||
.org-org-link { /* org-link */ color: #0000ff; text-decoration: underline; }
|
||||
.org-org-meta-line { /* org-meta-line */ color: #b22222; }
|
||||
.org-org-mode-line-clock { /* org-mode-line-clock */ color: #000000; background-color: #bfbfbf; }
|
||||
.org-org-mode-line-clock-overrun { /* org-mode-line-clock-overrun */ color: #000000; background-color: #ff0000; }
|
||||
.org-org-quote { /* org-quote */ color: #7f7f7f; }
|
||||
.org-org-scheduled { /* org-scheduled */ color: #006400; }
|
||||
.org-org-scheduled-previously { /* org-scheduled-previously */ color: #b22222; }
|
||||
.org-org-scheduled-today { /* org-scheduled-today */ color: #006400; }
|
||||
.org-org-sexp-date { /* org-sexp-date */ color: #a020f0; }
|
||||
.org-org-special-keyword { /* org-special-keyword */ color: #a020f0; }
|
||||
.org-org-table { /* org-table */ color: #0000ff; }
|
||||
.org-org-tag { /* org-tag */ font-weight: bold; }
|
||||
.org-org-target { /* org-target */ text-decoration: underline; }
|
||||
.org-org-time-grid { /* org-time-grid */ color: #b8860b; }
|
||||
.org-org-todo { /* org-todo */ color: #ff0000; font-weight: bold; }
|
||||
.org-org-upcoming-deadline { /* org-upcoming-deadline */ color: #b22222; }
|
||||
.org-org-verbatim { /* org-verbatim */ color: #7f7f7f; }
|
||||
.org-org-verse { /* org-verse */ color: #7f7f7f; }
|
||||
.org-org-warning { /* org-warning */ color: #ff0000; font-weight: bold; }
|
||||
.org-outline-1 { /* outline-1 */ color: #0000ff; }
|
||||
.org-outline-2 { /* outline-2 */ color: #a0522d; }
|
||||
.org-outline-3 { /* outline-3 */ color: #a020f0; }
|
||||
.org-outline-4 { /* outline-4 */ color: #b22222; }
|
||||
.org-outline-5 { /* outline-5 */ color: #228b22; }
|
||||
.org-outline-6 { /* outline-6 */ color: #008b8b; }
|
||||
.org-outline-7 { /* outline-7 */ color: #7a378b; }
|
||||
.org-outline-8 { /* outline-8 */ color: #8b2252; }
|
||||
.org-preprocessor { /* font-lock-preprocessor-face */ color: #7a378b; }
|
||||
.org-query-replace { /* query-replace */ color: #b0e2ff; background-color: #cd00cd; }
|
||||
.org-regexp-grouping-backslash { /* font-lock-regexp-grouping-backslash */ font-weight: bold; }
|
||||
.org-regexp-grouping-construct { /* font-lock-regexp-grouping-construct */ font-weight: bold; }
|
||||
.org-region { /* region */ background-color: #eedc82; }
|
||||
.org-secondary-selection { /* secondary-selection */ background-color: #ffff00; }
|
||||
.org-shadow { /* shadow */ color: #7f7f7f; }
|
||||
.org-show-paren-match { /* show-paren-match */ background-color: #40e0d0; }
|
||||
.org-show-paren-mismatch { /* show-paren-mismatch */ color: #ffffff; background-color: #a020f0; }
|
||||
.org-string { /* font-lock-string-face */ color: #8b2252; }
|
||||
.org-tool-bar { /* tool-bar */ color: #000000; background-color: #bfbfbf; }
|
||||
.org-tooltip { /* tooltip */ color: #000000; background-color: #ffffe0; }
|
||||
.org-trailing-whitespace { /* trailing-whitespace */ background-color: #ff0000; }
|
||||
.org-type { /* font-lock-type-face */ color: #228b22; }
|
||||
.org-underline { /* underline */ text-decoration: underline; }
|
||||
.org-variable-name { /* font-lock-variable-name-face */ color: #a0522d; }
|
||||
.org-warning { /* font-lock-warning-face */ color: #ff0000; font-weight: bold; }
|
||||
.org-widget-button { /* widget-button */ font-weight: bold; }
|
||||
.org-widget-button-pressed { /* widget-button-pressed */ color: #ff0000; }
|
||||
.org-widget-documentation { /* widget-documentation */ color: #006400; }
|
||||
.org-widget-field { /* widget-field */ background-color: #d9d9d9; }
|
||||
.org-widget-inactive { /* widget-inactive */ color: #7f7f7f; }
|
||||
.org-widget-single-line-field { /* widget-single-line-field */ background-color: #d9d9d9; }
|
||||
Binary file not shown.
|
Before Width: | Height: | Size: 3.1 KiB |
Binary file not shown.
|
Before Width: | Height: | Size: 625 B |
Binary file not shown.
|
Before Width: | Height: | Size: 3 KiB |
Binary file not shown.
|
Before Width: | Height: | Size: 4.3 KiB |
Binary file not shown.
|
Before Width: | Height: | Size: 4.5 KiB |
Binary file not shown.
|
Before Width: | Height: | Size: 4.3 KiB |
Binary file not shown.
|
Before Width: | Height: | Size: 3 KiB |
Binary file not shown.
|
Before Width: | Height: | Size: 4.2 KiB |
|
|
@ -1,524 +0,0 @@
|
|||
// darksun.js --- darksun JS file
|
||||
//
|
||||
// Copyright (C) 2011-2016 All Right Reserved, Fabrice Niessen
|
||||
//
|
||||
// This file is free software: you can redistribute it and/or
|
||||
// modify it under the terms of the GNU General Public License as
|
||||
// published by the Free Software Foundation, either version 3 of
|
||||
// the License, or (at your option) any later version.
|
||||
//
|
||||
// This file is distributed in the hope that it will be useful,
|
||||
// but WITHOUT ANY WARRANTY; without even the implied warranty of
|
||||
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
||||
// GNU General Public License for more details.
|
||||
//
|
||||
// Author: Fabrice Niessen <(concat "fniessen" at-sign "pirilampo.org")>
|
||||
// URL: https://github.com/fniessen/org-html-themes/
|
||||
// Version: 20140515.1841
|
||||
|
||||
$(function() {
|
||||
$('p').
|
||||
html(function(index, old) {
|
||||
return old.replace('FIXME',
|
||||
'<span class="fixme">FIXME</span>');
|
||||
});
|
||||
$('p').
|
||||
html(function(index, old) {
|
||||
return old.replace('XXX',
|
||||
'<span class="fixme">XXX</span>');
|
||||
});
|
||||
});
|
||||
|
||||
// Remove leading section number
|
||||
$(function() {
|
||||
$('.section-number-2').text("");
|
||||
for (var i = 3; i <= 5; i++) {
|
||||
$('.section-number-' + i).each(function() {
|
||||
$(this).text($(this).text().replace(/^[0-9]+\./g, ""));
|
||||
});
|
||||
}
|
||||
});
|
||||
|
||||
$(function() {
|
||||
$('<div id="minitoc" class="dontprint"></div>').prependTo('body');
|
||||
});
|
||||
|
||||
// generate contents of minitoc
|
||||
function generateMiniToc(divId) {
|
||||
$('#minitoc-content').empty().append('<h2>In this section</h2><ul></ul>');
|
||||
$('#' + divId).find('h3').each(function(i) {
|
||||
// [2018-09-03 Mon 03:48] Get text up to non-breaking space,
|
||||
// to omit the tags. If there are no tags, there will be no
|
||||
// , so get all the text. (This fixes a bug in the
|
||||
// original code.)
|
||||
let text = null;
|
||||
let pos = $(this).text().search(/ | ►/);
|
||||
if (pos > 0) {
|
||||
text = $(this).text().substring(0, pos);
|
||||
}
|
||||
else {
|
||||
text = $(this).text();
|
||||
}
|
||||
$("#minitoc-content>ul").append("<li><a href='#" + $(this).attr("id") + "'>"
|
||||
+ text + "</a></li>");
|
||||
});
|
||||
// Ensure that the target is expanded (hideShow)
|
||||
$('#minitoc-content a[href^="#"]').click(function() {
|
||||
var href = $(this).attr('href');
|
||||
hsExpandAnchor(href);
|
||||
});
|
||||
}
|
||||
|
||||
// display tabs
|
||||
function tabifySections() {
|
||||
|
||||
// hide TOC (if present)
|
||||
$('#table-of-contents').hide();
|
||||
|
||||
// grab the list of `h2' from the page
|
||||
var allSections = [];
|
||||
$('h2')
|
||||
.each(function() {
|
||||
// Remove TODO keywords and tags (contained in spans)
|
||||
var tabText = $(this).clone().find('span').remove().end()
|
||||
.text().trim();
|
||||
var tabId = $(this).parent().attr('id');
|
||||
if (tabText) {
|
||||
// - remove heading number (all leading digits)
|
||||
// - remove progress logging (between square brackets)
|
||||
// - remove leading and trailing spaces
|
||||
tabText = tabText.replace(/^\d+\s+/, '').replace(/\[[\d/%]+\]/, '').trim();
|
||||
|
||||
allSections.push({
|
||||
text: tabText,
|
||||
id: tabId
|
||||
});
|
||||
}
|
||||
});
|
||||
|
||||
// create the tab links
|
||||
var tabs = $('<ul id="tabs"></ul>');
|
||||
for (i = 0; i < allSections.length; i++) {
|
||||
var item = allSections[i];
|
||||
html = $('<li><a href="#' + item.id + '">' + item.text + '</a></li>');
|
||||
tabs.append(html);
|
||||
}
|
||||
|
||||
// insert tabs menu after title (`h1'), or at the beginning of the content
|
||||
if($('.title').length !== 0) {
|
||||
$('.title').after(tabs);
|
||||
}
|
||||
else {
|
||||
$('#content').prepend(tabs);
|
||||
}
|
||||
}
|
||||
|
||||
function selectTabAndScroll(href) {
|
||||
// At this point we assume that href is local (starts with #)
|
||||
// alert(href);
|
||||
|
||||
// Find the tab to activate
|
||||
var targetTab = $(href).closest('.ui-tabs-panel');
|
||||
var targetTabId = targetTab.attr('id');
|
||||
var targetTabAriaLabel = targetTab.attr('aria-labelledby');
|
||||
|
||||
var targetTabIndex = $("#content ul li")
|
||||
.index($('[aria-labelledby="' + targetTabAriaLabel + '"]'));
|
||||
|
||||
// Activate target tab
|
||||
$('#content').tabs('option', 'active', targetTabIndex);
|
||||
|
||||
// Rebuild minitoc
|
||||
generateMiniToc(targetTabId);
|
||||
|
||||
// Set the location hash
|
||||
// document.location.hash = href;
|
||||
|
||||
// Scroll to top if href was a tab
|
||||
if (href == '#' + targetTabId) {
|
||||
// alert(targetTabId);
|
||||
$.scrollTo(0);
|
||||
}
|
||||
// Scroll to href if href was not a tab
|
||||
else {
|
||||
$.scrollTo(href);
|
||||
}
|
||||
}
|
||||
|
||||
$(document).ready(function() {
|
||||
$('#preamble').remove();
|
||||
$('#table-of-contents').remove();
|
||||
|
||||
// Initialize hideShow
|
||||
hsInit();
|
||||
|
||||
// Prepare for tabs
|
||||
tabifySections();
|
||||
|
||||
// Build the tabs from the #content div
|
||||
$('#content').tabs();
|
||||
|
||||
// Set default animation
|
||||
$('#content').tabs('option', 'show', true);
|
||||
|
||||
// Rebuild minitoc when a tab is activated
|
||||
$('#content').tabs({
|
||||
activate: function(event, ui) {
|
||||
var divId = ui.newTab.attr('aria-controls');
|
||||
generateMiniToc(divId);
|
||||
}
|
||||
});
|
||||
|
||||
// Required to get the link of the tab in URL
|
||||
$('#content ul').localScroll({
|
||||
target: '#content',
|
||||
duration: 0,
|
||||
hash: true
|
||||
});
|
||||
|
||||
// Handle hash in URL
|
||||
if ($('#content') && document.location.hash) {
|
||||
hsExpandAnchor(document.location.hash);
|
||||
selectTabAndScroll(document.location.hash);
|
||||
}
|
||||
// If no hash, build the minitoc anyway for selected tab
|
||||
else {
|
||||
var divId = $('#content div[aria-expanded=true]').attr('id');
|
||||
generateMiniToc(divId);
|
||||
}
|
||||
|
||||
// Handle click on internal links
|
||||
$('.ui-tabs-panel a[href^="#"]').click(function(e) {
|
||||
var href = $(this).attr('href');
|
||||
hsExpandAnchor(href);
|
||||
selectTabAndScroll(href);
|
||||
e.preventDefault();
|
||||
});
|
||||
|
||||
// add sticky headers to tables
|
||||
$('table').stickyTableHeaders();
|
||||
});
|
||||
|
||||
function copyToClipboard(text)
|
||||
{
|
||||
if (window.clipboardData && window.clipboardData.setData) { // Internet Explorer
|
||||
window.clipboardData.setData("Text", text);
|
||||
}
|
||||
else { // Fallback solution
|
||||
window.prompt("Copy to clipboard: Ctrl+C, Enter", text);
|
||||
}
|
||||
}
|
||||
|
||||
$(document).ready(function() {
|
||||
// Assuming that the ZeroClipboard swf file is in the same folder than darksun,
|
||||
// get the path to it (it will be relative to the current page location).
|
||||
var bbScriptPath = $('script[src$="darksun.js"]').attr('src'); // the js file path
|
||||
var bbPathToZeroClipboardSwf = bbScriptPath.replace('darksun.js', 'ZeroClipboard.swf');
|
||||
|
||||
// Add copy to clipboard snippets
|
||||
$('.org-src-container').prepend('<div class="snippet-copy-to-clipboard"><span class="copy-to-clipboard-button">[copy]</span></div>');
|
||||
|
||||
// Display/hide snippets on source block mouseenter/mouseleave
|
||||
$(document).on('mouseenter', '.org-src-container', function () {
|
||||
$(this).find('.snippet-copy-to-clipboard').show();
|
||||
|
||||
// Need to call zclip here, once the button is visible.
|
||||
// Beacause when the button is not visible, zclip does nothing.
|
||||
if ((window.location.protocol != 'file:') && ($(this).find('.zclip').length == 0)) {
|
||||
$(this).find('.copy-to-clipboard-button').zclip({
|
||||
//path: 'http://www.steamdev.com/zclip/js/ZeroClipboard.swf',
|
||||
//path: 'styles/darksun/js/ZeroClipboard.swf',
|
||||
path: bbPathToZeroClipboardSwf,
|
||||
copy: function() {
|
||||
return $(this).parent().parent().find('.src').text();
|
||||
}
|
||||
});
|
||||
}
|
||||
}).on('mouseleave', '.org-src-container', function () {
|
||||
$(this).find('.snippet-copy-to-clipboard').hide();
|
||||
});
|
||||
|
||||
// Handle copy to clipboard (here, for a local file only 'file://...'
|
||||
if (window.location.protocol == 'file:') { // if local file use browser-specific code
|
||||
$('.copy-to-clipboard-button').click(function() {
|
||||
// Get the text to be copied
|
||||
var text = $(this).parent().parent().find('.src').text();
|
||||
text = text.replace(/\n/g, "\r\n");
|
||||
// alert(text);
|
||||
copyToClipboard(text);
|
||||
});
|
||||
}
|
||||
});
|
||||
|
||||
$(function() {
|
||||
$('li > code :contains("[X]")')
|
||||
.parent()
|
||||
.addClass('checked')
|
||||
.end()
|
||||
.remove();
|
||||
$('li > code :contains("[-]")')
|
||||
.parent()
|
||||
.addClass('halfchecked')
|
||||
.end()
|
||||
.remove();
|
||||
$('li > code :contains("[ ]")')
|
||||
.parent()
|
||||
.addClass('unchecked')
|
||||
.end()
|
||||
.remove();
|
||||
});
|
||||
|
||||
$(function() {
|
||||
$('i :contains("[#A]")')
|
||||
.replaceWith('<i><span style="color: #F67777;">[#A]</span></i>');
|
||||
$('i :contains("[#B]")')
|
||||
.replaceWith('<i><span style="color: #B6E864;">[#B]</span></i>');
|
||||
$('i :contains("[#C]")')
|
||||
.replaceWith('<i><span style="color: #C3DCFF;">[#C]</span></i>');
|
||||
});
|
||||
|
||||
function togglePanel(e) {
|
||||
e.preventDefault();
|
||||
|
||||
$("#left-panel-contents").toggleClass('active').toggle(200);
|
||||
$("#right-panel-contents").toggleClass('active').toggle(200);
|
||||
|
||||
var slidePos =
|
||||
$("#left-panel-button").css("left") == "-23px"? '182px': '-23px';
|
||||
|
||||
$("#left-panel-button").
|
||||
animate({"left": slidePos, "opacity": 0.9}, {duration: "200" });
|
||||
|
||||
// if ($("#left-panel-contents").hasClass('active')) {
|
||||
// hsHideTodoKeyword('done');
|
||||
// } else {
|
||||
// hsShowTodoKeyword('done');
|
||||
// }
|
||||
|
||||
// return false;
|
||||
}
|
||||
|
||||
$(function() {
|
||||
$('<div id="left-panel-wrapper" class="dontprint"><div id="left-panel-contents" style="opacity: 0.9"></div><div id="left-panel-button" class="dontprint"><a href="#">Dashboard</a></div></div>')
|
||||
.appendTo('body');
|
||||
|
||||
$('<div id="right-panel-wrapper" class="dontprint"><div id="right-panel-contents" style="opacity: 0.9"></div></div>')
|
||||
.appendTo('body');
|
||||
|
||||
$('#left-panel-button').click(togglePanel);
|
||||
});
|
||||
|
||||
$(function() {
|
||||
var ul = $('<ul id="listOfTodo"></ul>').appendTo('#left-panel-contents');
|
||||
var countOfTodo = {}, listOfTodo = [], totalOfTodo = 0;
|
||||
|
||||
// assign the counts (avoid double-counting elements from the ToC)
|
||||
$('span.todo').not($('#table-of-contents span.todo')).each(function() {
|
||||
var $thisTodo = $(this).text().trim();
|
||||
|
||||
if ($.inArray($thisTodo, listOfTodo) == -1) {
|
||||
countOfTodo[$thisTodo] = 1;
|
||||
listOfTodo.push($thisTodo);
|
||||
}
|
||||
else
|
||||
countOfTodo[$thisTodo] += 1;
|
||||
totalOfTodo += 1;
|
||||
});
|
||||
|
||||
function scoreTodo(t) {
|
||||
switch (t) {
|
||||
case 'NEW': return 1;
|
||||
case 'TODO': return 2;
|
||||
case 'STRT': return 3;
|
||||
case 'WAIT': return 4;
|
||||
case 'DLGT': return 5;
|
||||
case 'SDAY': return 6;
|
||||
case 'DFRD': return 7;
|
||||
case 'DONE': return 8;
|
||||
case 'CANX': return 9;
|
||||
default: return 0;
|
||||
}
|
||||
}
|
||||
|
||||
function compareTodo(a, b) {
|
||||
if (scoreTodo(a) < scoreTodo(b)) return -1;
|
||||
if (scoreTodo(a) > scoreTodo(b)) return 1;
|
||||
return 0;
|
||||
}
|
||||
|
||||
listOfTodo.sort(compareTodo);
|
||||
|
||||
// display
|
||||
for (i = 0; i < listOfTodo.length; i++) {
|
||||
var $thisTodo = listOfTodo[i];
|
||||
$(ul).append('<li><span class="todo ' + $thisTodo + '">'+ $thisTodo + '</span>'
|
||||
+ ' <small>(' + countOfTodo[$thisTodo] + ')</small></li>');
|
||||
}
|
||||
|
||||
$('#listOfTodo')
|
||||
.before('<b>Next Actions</b> <small>(' + totalOfTodo + ')</small>:<br>');
|
||||
});
|
||||
|
||||
$(function() {
|
||||
var ul = $('<ul id="listOfDone"></ul>').appendTo('#left-panel-contents');
|
||||
var countOfDone = {}, listOfDone = [], totalOfDone = 0;
|
||||
|
||||
// assign the counts (avoid double-counting elements from the ToC)
|
||||
$('span.done').not($('#table-of-contents span.done')).each(function() {
|
||||
var $thisDone = $(this).text().trim();
|
||||
|
||||
if ($.inArray($thisDone, listOfDone) == -1) {
|
||||
countOfDone[$thisDone] = 1;
|
||||
listOfDone.push($thisDone);
|
||||
}
|
||||
else
|
||||
countOfDone[$thisDone] += 1;
|
||||
totalOfDone += 1;
|
||||
});
|
||||
|
||||
// display
|
||||
for (i = 0; i < listOfDone.length; i++) {
|
||||
var $thisDone = listOfDone[i];
|
||||
$(ul).append('<li><span class="done ' + $thisDone + '">'+ $thisDone + '</span>'
|
||||
+ ' <small>(' + countOfDone[$thisDone] + ')</small></li>');
|
||||
}
|
||||
|
||||
$('#listOfDone')
|
||||
.before('<b>Done Actions</b> <small>(' + totalOfDone + '):</small><br>');
|
||||
});
|
||||
|
||||
$(function() {
|
||||
var ul = $('<ul id="listOfTags"></ul>').appendTo('#right-panel-contents');
|
||||
var countOfTags = {}, listOfTags = [], totalOfTags = 0;
|
||||
|
||||
// assign the counts (avoid double-counting elements from the ToC)
|
||||
$('span.tag').not($('#table-of-contents span.tag')).each(function() {
|
||||
var $thisTagGroup = $(this).text().trim().split(/\s/);
|
||||
// \s matches spaces, tabs, new lines, etc.
|
||||
|
||||
for (tag in $thisTagGroup) {
|
||||
if ($.inArray($thisTagGroup[tag], listOfTags) == -1) {
|
||||
countOfTags[$thisTagGroup[tag]] = 1;
|
||||
listOfTags.push($thisTagGroup[tag]);
|
||||
}
|
||||
else
|
||||
countOfTags[$thisTagGroup[tag]] += 1;
|
||||
totalOfTags += 1;
|
||||
}
|
||||
});
|
||||
|
||||
listOfTags.sort();
|
||||
|
||||
// display
|
||||
for (i = 0; i < listOfTags.length; i++) {
|
||||
var $thisTag = listOfTags[i];
|
||||
// $(ul).append('<li><span class="tag ' + $thisTag + '">'+
|
||||
// $thisTag + '</span> <small>(' + countOfTags[$thisTag] + ')</small></li>');
|
||||
$(ul).append('<li><span class="tag"><span class="' + $thisTag + '">' + $thisTag
|
||||
+ '</span></span>'
|
||||
+ ' <small>(' + countOfTags[$thisTag] + ')</small></li>');
|
||||
}
|
||||
|
||||
$('#listOfTags')
|
||||
.before('<b>Contexts</b> <small>(' + totalOfTags + '):</small><br>');
|
||||
});
|
||||
|
||||
$(function() {
|
||||
$('.done').parent(':header').parent().find(':header').addClass('DONEheader');
|
||||
$('.done').parent(':header').parent().css({color: '#999999'});
|
||||
});
|
||||
|
||||
$(function() {
|
||||
$('span.todo').click(function(e) {
|
||||
var orgKeyword = $(this).text().trim();
|
||||
$('.' + orgKeyword).toggleClass('selected');
|
||||
$('#content .' + orgKeyword).parent().parent()
|
||||
.toggleClass('match' + orgKeyword);
|
||||
$('#left-panel-wrapper .' + orgKeyword).parent()
|
||||
.toggleClass('match' + orgKeyword);
|
||||
e.preventDefault();
|
||||
})
|
||||
});
|
||||
|
||||
$(function() {
|
||||
$('.tag span').click(function(e) {
|
||||
var orgTag = $(this).text().trim();
|
||||
$('.' + orgTag).toggleClass('selected');
|
||||
$('#content .' + orgTag).parent().parent().parent()
|
||||
.toggleClass('matchtag');
|
||||
$('#right-panel-wrapper .' + orgTag).parent().parent()
|
||||
.toggleClass('matchtag');
|
||||
e.preventDefault();
|
||||
})
|
||||
});
|
||||
|
||||
function clickPreviousTab() {
|
||||
var active = $('#content').tabs('option', 'active');
|
||||
// Avoid going back to last tab
|
||||
if (active == 0) return;
|
||||
|
||||
$('#content').tabs('option', 'active', active - 1);
|
||||
|
||||
// Set the location href
|
||||
var href = $('#content div[aria-expanded=true]').attr('id');
|
||||
document.location.hash = href;
|
||||
$.scrollTo(0);
|
||||
}
|
||||
|
||||
function clickNextTab() {
|
||||
var active = $('#content').tabs('option', 'active');
|
||||
$('#content').tabs('option', 'active', active + 1);
|
||||
|
||||
// Set the location href
|
||||
var href = $('#content div[aria-expanded=true]').attr('id');
|
||||
document.location.hash = href;
|
||||
$.scrollTo(0);
|
||||
}
|
||||
|
||||
function orgDefkey(e) {
|
||||
if (!e)
|
||||
var e = window.event;
|
||||
var keycode = (e.keyCode) ? e.keyCode : e.which;
|
||||
var actualkey = String.fromCharCode(keycode);
|
||||
switch (actualkey) {
|
||||
case "?": // help (dashboard)
|
||||
case "h":
|
||||
togglePanel(e);
|
||||
break;
|
||||
case "n": // next
|
||||
clickNextTab();
|
||||
break;
|
||||
case "p": // previous
|
||||
clickPreviousTab();
|
||||
break;
|
||||
// case "b": // scroll down - should be mapped to Shift-SPC
|
||||
// $(window).scrollTop($(window).scrollTop()-$(window).height());
|
||||
// break;
|
||||
case "<": // scroll to top
|
||||
$(window).scrollTop(0);
|
||||
break;
|
||||
case ">": // scroll to bottom
|
||||
$(window).scrollTop($(document).height());
|
||||
break;
|
||||
case "-": // collapse all
|
||||
hsCollapseAll();
|
||||
break;
|
||||
case "+": // expand all
|
||||
hsExpandAll();
|
||||
break;
|
||||
case "r": // go to next task
|
||||
hsReviewTaskNext();
|
||||
break;
|
||||
case "R": // go to previous task
|
||||
hsReviewTaskPrev();
|
||||
break;
|
||||
case "q": // quit reviewing
|
||||
hsReviewTaskQuit();
|
||||
break;
|
||||
case "g": // refresh the page (from the server, rather than the cache)
|
||||
location.reload(true);
|
||||
break;
|
||||
}
|
||||
}
|
||||
|
||||
document.onkeypress = orgDefkey;
|
||||
|
|
@ -1,335 +0,0 @@
|
|||
// hideshow.js --- HideShow JS file
|
||||
//
|
||||
// Copyright (C) 2014 All Right Reserved, Fabrice Niessen
|
||||
//
|
||||
// This file is free software: you can redistribute it and/or
|
||||
// modify it under the terms of the GNU General Public License as
|
||||
// published by the Free Software Foundation, either version 3 of
|
||||
// the License, or (at your option) any later version.
|
||||
//
|
||||
// This file is distributed in the hope that it will be useful,
|
||||
// but WITHOUT ANY WARRANTY; without even the implied warranty of
|
||||
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
||||
// GNU General Public License for more details.
|
||||
//
|
||||
// Author: Fabrice Niessen <(concat "fniessen" at-sign "pirilampo.org")>
|
||||
// URL: https://github.com/fniessen/hide-show/
|
||||
// Version: 20140912.1722
|
||||
|
||||
// var HS_COLLAPSIBLE_HEADERS = $('h3, h4, h5'); // collapsible headers
|
||||
|
||||
if (typeof HS_STARTUP_FOLDED === 'undefined') {
|
||||
var HS_STARTUP_FOLDED = false; // Show just the overview, or show all.
|
||||
}
|
||||
|
||||
if (typeof HS_SHOW_ALL_TEXT === 'undefined') {
|
||||
var HS_SHOW_ALL_TEXT = 'Expand';
|
||||
}
|
||||
if (typeof HS_HIDE_ALL_TEXT === 'undefined') {
|
||||
var HS_HIDE_ALL_TEXT = 'Collapse';
|
||||
}
|
||||
|
||||
if (typeof HS_ALWAYS_DISPLAY_ICON === 'undefined') {
|
||||
var HS_ALWAYS_DISPLAY_ICON = false; // Display an icon for all states, or
|
||||
// just when closed.
|
||||
}
|
||||
|
||||
if (typeof HS_ICON_CLOSED === 'undefined') {
|
||||
var HS_ICON_CLOSED = '►'; // black right-pointing pointer
|
||||
}
|
||||
if (typeof HS_ICON_OPEN === 'undefined') {
|
||||
var HS_ICON_OPEN = '▼'; // black down-pointing triangle
|
||||
}
|
||||
if (typeof HS_ICON_EMPTY === 'undefined') {
|
||||
var HS_ICON_EMPTY = '■'; // black square
|
||||
}
|
||||
|
||||
if (typeof HS_SHOW_ALL_OPEN_DONE_TREES === 'undefined') {
|
||||
var HS_SHOW_ALL_OPEN_DONE_TREES = false; // Expand all will open DONE trees.
|
||||
}
|
||||
|
||||
if (typeof HS_CLASS === 'undefined') {
|
||||
var HS_CLASS = 'hsCollapsible';
|
||||
}
|
||||
|
||||
// Expand a header
|
||||
function hsExpand(header) {
|
||||
hsExpand2(header, true);
|
||||
}
|
||||
|
||||
// Expand a header
|
||||
function hsExpand2(header, expandDoneHeader) {
|
||||
// Ignore non collapsible entries
|
||||
if (!header.parent().hasClass(HS_CLASS)) return;
|
||||
|
||||
// Do not expand DONE node if not required
|
||||
if (hsIsDoneHeader(header) && !expandDoneHeader) return;
|
||||
|
||||
header.children('span[class="ellipsis"]').remove();
|
||||
if (HS_ALWAYS_DISPLAY_ICON == true) {
|
||||
header.append('<span class="ellipsis"> ' + HS_ICON_OPEN + '</span>');
|
||||
}
|
||||
header.parent().removeClass('hsCollapsed').addClass('hsExpanded');
|
||||
header.nextAll().show();
|
||||
}
|
||||
|
||||
// Expand a header and all its parents
|
||||
function hsExpandParents(header) {
|
||||
hsExpand(header);
|
||||
header.parents('.hsCollapsed').each(function() {
|
||||
hsExpand($(this).children(':header'));
|
||||
});
|
||||
}
|
||||
|
||||
// Collapse a header and all its parents
|
||||
function hsCollapseParents(header) {
|
||||
hsCollapse(header);
|
||||
header.parents('.hsExpanded').each(function() {
|
||||
hsCollapse($(this).children(':header'));
|
||||
});
|
||||
}
|
||||
|
||||
// Collapse a header
|
||||
function hsCollapse(header) {
|
||||
// Ignore non collapsible entries
|
||||
if (!header.parent().hasClass(HS_CLASS)) return;
|
||||
|
||||
header.children('span[class="ellipsis"]').remove();
|
||||
header.append('<span class="ellipsis"> ' + HS_ICON_CLOSED + '</span>');
|
||||
header.parent().removeClass('hsExpanded').addClass('hsCollapsed');
|
||||
// header.nextAll().hide('fast');
|
||||
header.nextAll().hide();
|
||||
}
|
||||
|
||||
// Toggle a header
|
||||
function hsToggleCollapsing(header) {
|
||||
if (header.parent().hasClass('hsCollapsed'))
|
||||
hsExpand(header);
|
||||
else if (header.parent().hasClass('hsExpanded'))
|
||||
hsCollapse(header);
|
||||
}
|
||||
|
||||
// Expand all headers
|
||||
function hsExpandAll() {
|
||||
$('#content .hsCollapsed').each(function() {
|
||||
hsExpand2($(this).children(':header'), HS_SHOW_ALL_OPEN_DONE_TREES);
|
||||
});
|
||||
}
|
||||
|
||||
// Collapse all headers
|
||||
function hsCollapseAll() {
|
||||
$('#content .hsExpanded').each(function() {
|
||||
hsCollapse($(this).children(':header'));
|
||||
});
|
||||
}
|
||||
|
||||
// Collapse all visible headers
|
||||
function hsCollapseAllVisible() {
|
||||
$('#content .hsExpanded:visible').each(function() {
|
||||
hsCollapse($(this).children(':header'));
|
||||
});
|
||||
}
|
||||
|
||||
// Add click events to H3/H4/H5 headers which have contents.
|
||||
function hsInit() {
|
||||
for (var i = 3; i <= 5; i++) {
|
||||
$('#content .outline-' + i).each(function() {
|
||||
var header = $(this).children(':header');
|
||||
if (header.siblings().length > 0) {
|
||||
$(this).addClass(HS_CLASS);
|
||||
header.css({cursor: 'pointer'});
|
||||
header.click(function() {
|
||||
hsToggleCollapsing($(this)); });
|
||||
|
||||
// Allow to override global Collapse/Expand default on an entry
|
||||
// basis (see property `:HTML_CONTAINER_CLASS:')
|
||||
if (header.parent().hasClass('hsCollapsed')) {
|
||||
hsCollapse(header);
|
||||
} else if (header.parent().hasClass('hsExpanded')) {
|
||||
hsExpand(header);
|
||||
} else {
|
||||
hsSetDefaultVisibility(header);
|
||||
}
|
||||
}
|
||||
else {
|
||||
if (HS_ALWAYS_DISPLAY_ICON == true) {
|
||||
header.append('<span class="ellipsis"> ' + HS_ICON_EMPTY
|
||||
+ '</span>');
|
||||
}
|
||||
$(this).addClass('hsEmpty');
|
||||
}
|
||||
});
|
||||
}
|
||||
|
||||
// Add div to hold minitoc content (so it can be cleared without deleting the buttons)
|
||||
$('#minitoc').append($('<div id="minitoc-content"></div>'));
|
||||
|
||||
// Add buttons
|
||||
$('#minitoc').append($('<div class="buttons dontprint"></div>'));
|
||||
$('.buttons').append($('<span>' + HS_SHOW_ALL_TEXT + '</span>')
|
||||
.addClass('hsButton')
|
||||
.click(hsExpandAll));
|
||||
$('.buttons').append($('<span>' + HS_HIDE_ALL_TEXT + '</span>')
|
||||
.addClass('hsButton')
|
||||
.click(hsCollapseAll));
|
||||
}
|
||||
|
||||
// Returns true if a header is a DONE header
|
||||
function hsIsDoneHeader(header) {
|
||||
return $('span.done', header).length;
|
||||
}
|
||||
|
||||
// Sets the default visibility state to a header
|
||||
function hsSetDefaultVisibility(header) {
|
||||
if (HS_STARTUP_FOLDED) {
|
||||
hsCollapse(header);
|
||||
}
|
||||
else {
|
||||
if (!hsIsDoneHeader(header) | HS_SHOW_ALL_OPEN_DONE_TREES) {
|
||||
hsExpand(header);
|
||||
}
|
||||
else {
|
||||
hsCollapse(header);
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
// Expands an anchor, i.e. expand all parent headers
|
||||
function hsExpandAnchor(id) {
|
||||
// alert(id);
|
||||
if (id) {
|
||||
// alert($(id + '.hsNode').length);
|
||||
$(id).parents('.hsCollapsed').each(function() {
|
||||
hsExpand2($(this).children(':header'), true);
|
||||
});
|
||||
}
|
||||
}
|
||||
|
||||
// Search for next task to review, starting from beginning of current tab.
|
||||
// If BACKWARD is true, search in the reverse direction.
|
||||
function hsReviewTaskNext(backward) {
|
||||
// If no tasks to review at all, do nothing.
|
||||
if ($('.outline-2 span.todo').length == 0) return;
|
||||
|
||||
if ($('.hsReviewing').length == 0) { // reviewing is starting
|
||||
$('body').addClass('hsReviewing');
|
||||
$('.hsReviewPanel').addClass('hsReviewing');
|
||||
$('body').prepend('<div id="hsOverlay"></div>');
|
||||
hsAddReviewingPanels();
|
||||
|
||||
hsCollapseAll();
|
||||
// Get first task to review on each tab and expand it
|
||||
$('.outline-2').each(function(){
|
||||
var firstTodo = $(this).find('span.todo:first').parent().parent();
|
||||
firstTodo.addClass('hsReview');
|
||||
hsExpandParents($(firstTodo).children(':header'));
|
||||
});
|
||||
}
|
||||
else {
|
||||
// Get all todos
|
||||
var todosElements = $('.outline-2:visible span.todo').parent().parent();
|
||||
// alert(todosElements.length);
|
||||
var todos = jQuery.makeArray(todosElements);
|
||||
if (backward) {
|
||||
todos = todos.reverse();
|
||||
}
|
||||
|
||||
// Find current review item and review the next one
|
||||
var foundReview = false;
|
||||
var index;
|
||||
for (index = 0; index < todos.length; ++index) {
|
||||
var todo = todos[index];
|
||||
if (foundReview) {
|
||||
$(todo).addClass('hsReview');
|
||||
hsExpandParents($(todo).children(':header'));
|
||||
break;
|
||||
}
|
||||
if ($(todo).hasClass('hsReview')) {
|
||||
foundReview = true;
|
||||
if (index < todos.length - 1) {
|
||||
$(todo).removeClass('hsReview');
|
||||
hsCollapseParents($(todo).children(':header'));
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
// Update reviewing panel
|
||||
if (index < todos.length) {
|
||||
var reviewItem = index + 1;
|
||||
if (backward) {
|
||||
reviewItem = todos.length - index;
|
||||
}
|
||||
|
||||
$('.outline-2:visible .hsReviewingPanel .hsReviewItem').text(reviewItem);
|
||||
}
|
||||
}
|
||||
|
||||
// Scroll to the current review item
|
||||
$('html, body').animate({
|
||||
scrollTop: $(".hsReview:visible").offset().top
|
||||
}, 200);
|
||||
}
|
||||
|
||||
// go to previous task to review
|
||||
function hsReviewTaskPrev() {
|
||||
hsReviewTaskNext(true);
|
||||
}
|
||||
|
||||
// stop reviewing tasks
|
||||
function hsReviewTaskQuit() {
|
||||
$('body').removeClass('hsReviewing');
|
||||
$('.hsReviewPanel').removeClass('hsReviewing');
|
||||
$('.hsReview').removeClass('hsReview');
|
||||
$('#hsOverlay').remove();
|
||||
$('.hsReviewingPanel').remove();
|
||||
}
|
||||
|
||||
function hsHideTodoKeyword(kw) {
|
||||
$('span.' + kw).addClass('hsHidden').parent().parent().hide();
|
||||
}
|
||||
|
||||
function hsShowTodoKeyword(kw) {
|
||||
$('span.' + kw).removeClass('hsHidden').parent().parent().show();
|
||||
// XXX Show if parent is not collapsed!
|
||||
}
|
||||
|
||||
function hsAddReviewPanels() {
|
||||
$('.outline-2').each(function(e) {
|
||||
var nbItems = $(this).find('span.todo').length;
|
||||
if (nbItems > 0) {
|
||||
$(this).prepend('<div class="hsReviewPanel hsUnselectable" onclick="hsReviewTaskNext()">'
|
||||
+ 'Press r or click here<br>'
|
||||
+ 'to review ' + nbItems + ' tasks<br>'
|
||||
+ '(out of ' + nbReviewTotalTasks + ' tasks)</div>');
|
||||
}
|
||||
});
|
||||
}
|
||||
|
||||
function hsAddReviewingPanels() {
|
||||
$('.outline-2').each(function(e) {
|
||||
var nbItems = $(this).find('span.todo').length;
|
||||
if (nbItems > 0) {
|
||||
$(this).prepend('<div class="hsReviewingPanel hsUnselectable">Reviewing task <span class="hsReviewItem">1</span> / ' + nbItems + '<br>'
|
||||
+ '(out of ' + nbReviewTotalTasks + ' tasks)<br>'
|
||||
+ 'Shortcuts: '
|
||||
+ '<span class="hsReviewButton" onclick="hsReviewTaskNext()">r (next)</span> - '
|
||||
+ '<span class="hsReviewButton" onclick="hsReviewTaskPrev()">R (previous)</span>'
|
||||
+ '</div>');
|
||||
}
|
||||
else {
|
||||
$(this).prepend('<div class="hsReviewingPanel hsUnselectable">No task to review<br>'
|
||||
+ '(out of ' + nbReviewTotalTasks + ' tasks)<br>'
|
||||
+ 'Shortcuts: '
|
||||
+ '<span class="hsReviewButton" onclick="hsReviewTaskNext()">r (next)</span> - '
|
||||
+ '<span class="hsReviewButton" onclick="hsReviewTaskPrev()">R (previous)</span>'
|
||||
+ '</div>');
|
||||
}
|
||||
});
|
||||
}
|
||||
|
||||
var nbReviewTotalTasks;
|
||||
|
||||
$(document).ready(function() {
|
||||
nbReviewTotalTasks = $('.outline-2 span.todo').length;
|
||||
hsAddReviewPanels();
|
||||
});
|
||||
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
|
|
@ -1,9 +0,0 @@
|
|||
/**
|
||||
* jQuery.LocalScroll - Animated scrolling navigation, using anchors.
|
||||
* Copyright (c) 2007-2009 Ariel Flesler - aflesler(at)gmail(dot)com | http://flesler.blogspot.com
|
||||
* Dual licensed under MIT and GPL.
|
||||
* Date: 3/11/2009
|
||||
* @author Ariel Flesler
|
||||
* @version 1.2.7
|
||||
**/
|
||||
;(function($){var l=location.href.replace(/#.*/,'');var g=$.localScroll=function(a){$('body').localScroll(a)};g.defaults={duration:1e3,axis:'y',event:'click',stop:true,target:window,reset:true};g.hash=function(a){if(location.hash){a=$.extend({},g.defaults,a);a.hash=false;if(a.reset){var e=a.duration;delete a.duration;$(a.target).scrollTo(0,a);a.duration=e}i(0,location,a)}};$.fn.localScroll=function(b){b=$.extend({},g.defaults,b);return b.lazy?this.bind(b.event,function(a){var e=$([a.target,a.target.parentNode]).filter(d)[0];if(e)i(a,e,b)}):this.find('a,area').filter(d).bind(b.event,function(a){i(a,this,b)}).end().end();function d(){return!!this.href&&!!this.hash&&this.href.replace(this.hash,'')==l&&(!b.filter||$(this).is(b.filter))}};function i(a,e,b){var d=e.hash.slice(1),f=document.getElementById(d)||document.getElementsByName(d)[0];if(!f)return;if(a)a.preventDefault();var h=$(b.target);if(b.lock&&h.is(':animated')||b.onBefore&&b.onBefore.call(b,a,f,h)===false)return;if(b.stop)h.stop(true);if(b.hash){var j=f.id==d?'id':'name',k=$('<a> </a>').attr(j,d).css({position:'absolute',top:$(window).scrollTop(),left:$(window).scrollLeft()});f[j]='';$('body').prepend(k);location=e.hash;k.remove();f[j]=d}h.scrollTo(f,b).trigger('notify.serialScroll',[f])}})(jQuery);
|
||||
|
|
@ -1,7 +0,0 @@
|
|||
/**
|
||||
* Copyright (c) 2007-2012 Ariel Flesler - aflesler(at)gmail(dot)com | http://flesler.blogspot.com
|
||||
* Dual licensed under MIT and GPL.
|
||||
* @author Ariel Flesler
|
||||
* @version 1.4.3.1
|
||||
*/
|
||||
;(function($){var h=$.scrollTo=function(a,b,c){$(window).scrollTo(a,b,c)};h.defaults={axis:'xy',duration:parseFloat($.fn.jquery)>=1.3?0:1,limit:true};h.window=function(a){return $(window)._scrollable()};$.fn._scrollable=function(){return this.map(function(){var a=this,isWin=!a.nodeName||$.inArray(a.nodeName.toLowerCase(),['iframe','#document','html','body'])!=-1;if(!isWin)return a;var b=(a.contentWindow||a).document||a.ownerDocument||a;return/webkit/i.test(navigator.userAgent)||b.compatMode=='BackCompat'?b.body:b.documentElement})};$.fn.scrollTo=function(e,f,g){if(typeof f=='object'){g=f;f=0}if(typeof g=='function')g={onAfter:g};if(e=='max')e=9e9;g=$.extend({},h.defaults,g);f=f||g.duration;g.queue=g.queue&&g.axis.length>1;if(g.queue)f/=2;g.offset=both(g.offset);g.over=both(g.over);return this._scrollable().each(function(){if(e==null)return;var d=this,$elem=$(d),targ=e,toff,attr={},win=$elem.is('html,body');switch(typeof targ){case'number':case'string':if(/^([+-]=)?\d+(\.\d+)?(px|%)?$/.test(targ)){targ=both(targ);break}targ=$(targ,this);if(!targ.length)return;case'object':if(targ.is||targ.style)toff=(targ=$(targ)).offset()}$.each(g.axis.split(''),function(i,a){var b=a=='x'?'Left':'Top',pos=b.toLowerCase(),key='scroll'+b,old=d[key],max=h.max(d,a);if(toff){attr[key]=toff[pos]+(win?0:old-$elem.offset()[pos]);if(g.margin){attr[key]-=parseInt(targ.css('margin'+b))||0;attr[key]-=parseInt(targ.css('border'+b+'Width'))||0}attr[key]+=g.offset[pos]||0;if(g.over[pos])attr[key]+=targ[a=='x'?'width':'height']()*g.over[pos]}else{var c=targ[pos];attr[key]=c.slice&&c.slice(-1)=='%'?parseFloat(c)/100*max:c}if(g.limit&&/^\d+$/.test(attr[key]))attr[key]=attr[key]<=0?0:Math.min(attr[key],max);if(!i&&g.queue){if(old!=attr[key])animate(g.onAfterFirst);delete attr[key]}});animate(g.onAfter);function animate(a){$elem.animate(attr,f,g.easing,a&&function(){a.call(this,e,g)})}}).end()};h.max=function(a,b){var c=b=='x'?'Width':'Height',scroll='scroll'+c;if(!$(a).is('html,body'))return a[scroll]-$(a)[c.toLowerCase()]();var d='client'+c,html=a.ownerDocument.documentElement,body=a.ownerDocument.body;return Math.max(html[scroll],body[scroll])-Math.min(html[d],body[d])};function both(a){return typeof a=='object'?a:{top:a,left:a}}})(jQuery);
|
||||
File diff suppressed because one or more lines are too long
|
|
@ -1 +0,0 @@
|
|||
!function(a,b){"use strict";function c(c,g){var h=this;h.$el=a(c),h.el=c,h.id=e++,h.$window=a(b),h.$document=a(document),h.$el.bind("destroyed",a.proxy(h.teardown,h)),h.$clonedHeader=null,h.$originalHeader=null,h.isSticky=!1,h.hasBeenSticky=!1,h.leftOffset=null,h.topOffset=null,h.init=function(){h.$el.each(function(){var b=a(this);b.css("padding",0),h.$originalHeader=a("thead:first",this),h.$clonedHeader=h.$originalHeader.clone(),b.trigger("clonedHeader."+d,[h.$clonedHeader]),h.$clonedHeader.addClass("tableFloatingHeader"),h.$clonedHeader.css("display","none"),h.$originalHeader.addClass("tableFloatingHeaderOriginal"),h.$originalHeader.after(h.$clonedHeader),h.$printStyle=a('<style type="text/css" media="print">.tableFloatingHeader{display:none !important;}.tableFloatingHeaderOriginal{position:static !important;}</style>'),a("head").append(h.$printStyle)}),h.setOptions(g),h.updateWidth(),h.toggleHeaders(),h.bind()},h.destroy=function(){h.$el.unbind("destroyed",h.teardown),h.teardown()},h.teardown=function(){h.isSticky&&h.$originalHeader.css("position","static"),a.removeData(h.el,"plugin_"+d),h.unbind(),h.$clonedHeader.remove(),h.$originalHeader.removeClass("tableFloatingHeaderOriginal"),h.$originalHeader.css("visibility","visible"),h.$printStyle.remove(),h.el=null,h.$el=null},h.bind=function(){h.$scrollableArea.on("scroll."+d,h.toggleHeaders),h.isWindowScrolling||(h.$window.on("scroll."+d+h.id,h.setPositionValues),h.$window.on("resize."+d+h.id,h.toggleHeaders)),h.$scrollableArea.on("resize."+d,h.toggleHeaders),h.$scrollableArea.on("resize."+d,h.updateWidth)},h.unbind=function(){h.$scrollableArea.off("."+d,h.toggleHeaders),h.isWindowScrolling||(h.$window.off("."+d+h.id,h.setPositionValues),h.$window.off("."+d+h.id,h.toggleHeaders)),h.$scrollableArea.off("."+d,h.updateWidth)},h.toggleHeaders=function(){h.$el&&h.$el.each(function(){var b,c=a(this),d=h.isWindowScrolling?isNaN(h.options.fixedOffset)?h.options.fixedOffset.outerHeight():h.options.fixedOffset:h.$scrollableArea.offset().top+(isNaN(h.options.fixedOffset)?0:h.options.fixedOffset),e=c.offset(),f=h.$scrollableArea.scrollTop()+d,g=h.$scrollableArea.scrollLeft(),i=h.isWindowScrolling?f>e.top:d>e.top,j=(h.isWindowScrolling?f:0)<e.top+c.height()-h.$clonedHeader.height()-(h.isWindowScrolling?0:d);i&&j?(b=e.left-g+h.options.leftOffset,h.$originalHeader.css({position:"fixed","margin-top":h.options.marginTop,left:b,"z-index":3}),h.leftOffset=b,h.topOffset=d,h.$clonedHeader.css("display",""),h.isSticky||(h.isSticky=!0,h.updateWidth()),h.setPositionValues()):h.isSticky&&(h.$originalHeader.css("position","static"),h.$clonedHeader.css("display","none"),h.isSticky=!1,h.resetWidth(a("td,th",h.$clonedHeader),a("td,th",h.$originalHeader)))})},h.setPositionValues=function(){var a=h.$window.scrollTop(),b=h.$window.scrollLeft();!h.isSticky||0>a||a+h.$window.height()>h.$document.height()||0>b||b+h.$window.width()>h.$document.width()||h.$originalHeader.css({top:h.topOffset-(h.isWindowScrolling?0:a),left:h.leftOffset-(h.isWindowScrolling?0:b)})},h.updateWidth=function(){if(h.isSticky){h.$originalHeaderCells||(h.$originalHeaderCells=a("th,td",h.$originalHeader)),h.$clonedHeaderCells||(h.$clonedHeaderCells=a("th,td",h.$clonedHeader));var b=h.getWidth(h.$clonedHeaderCells);h.setWidth(b,h.$clonedHeaderCells,h.$originalHeaderCells),h.$originalHeader.css("width",h.$clonedHeader.width())}},h.getWidth=function(c){var d=[];return c.each(function(c){var e,f=a(this);if("border-box"===f.css("box-sizing"))e=f[0].getBoundingClientRect().width;else{var g=a("th",h.$originalHeader);if("collapse"===g.css("border-collapse"))if(b.getComputedStyle)e=parseFloat(b.getComputedStyle(this,null).width);else{var i=parseFloat(f.css("padding-left")),j=parseFloat(f.css("padding-right")),k=parseFloat(f.css("border-width"));e=f.outerWidth()-i-j-k}else e=f.width()}d[c]=e}),d},h.setWidth=function(a,b,c){b.each(function(b){var d=a[b];c.eq(b).css({"min-width":d,"max-width":d})})},h.resetWidth=function(b,c){b.each(function(b){var d=a(this);c.eq(b).css({"min-width":d.css("min-width"),"max-width":d.css("max-width")})})},h.setOptions=function(c){h.options=a.extend({},f,c),h.$scrollableArea=a(h.options.scrollableArea),h.isWindowScrolling=h.$scrollableArea[0]===b},h.updateOptions=function(a){h.setOptions(a),h.unbind(),h.bind(),h.updateWidth(),h.toggleHeaders()},h.init()}var d="stickyTableHeaders",e=0,f={fixedOffset:0,leftOffset:0,marginTop:0,scrollableArea:b};a.fn[d]=function(b){return this.each(function(){var e=a.data(this,"plugin_"+d);e?"string"==typeof b?e[b].apply(e):e.updateOptions(b):"destroy"!==b&&a.data(this,"plugin_"+d,new c(this,b))})}}(jQuery,window);
|
||||
|
|
@ -1,20 +0,0 @@
|
|||
Copyright (c) 2011 Jonas Mosbech
|
||||
|
||||
Permission is hereby granted, free of charge, to any person obtaining
|
||||
a copy of this software and associated documentation files (the
|
||||
"Software"), to deal in the Software without restriction, including
|
||||
without limitation the rights to use, copy, modify, merge, publish,
|
||||
distribute, sublicense, and/or sell copies of the Software, and to
|
||||
permit persons to whom the Software is furnished to do so, subject to
|
||||
the following conditions:
|
||||
|
||||
The above copyright notice and this permission notice shall be
|
||||
included in all copies or substantial portions of the Software.
|
||||
|
||||
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
|
||||
EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
|
||||
MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
|
||||
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
|
||||
LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
|
||||
OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
|
||||
WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
|
||||
|
|
@ -24,6 +24,7 @@
|
|||
|
||||
;; From MELPA
|
||||
(require 'dash)
|
||||
(require 'dash-functional)
|
||||
(require 's)
|
||||
|
||||
;; org-ql
|
||||
|
|
|
|||
|
|
@ -1,9 +1,7 @@
|
|||
;;; helm-org-ql.el --- Helm support for org-ql -*- lexical-binding: t; -*-
|
||||
;;; helm-org-ql.el --- Helm commands for org-ql -*- lexical-binding: t; -*-
|
||||
|
||||
;; Author: Adam Porter <adam@alphapapa.net>
|
||||
;; URL: https://github.com/alphapapa/org-ql
|
||||
;; Version: 0.6.2
|
||||
;; Package-Requires: ((emacs "26.1") (compat "29.1.4.5") (dash "2.18.1") (s "1.12.0") (helm-org "1.0") (org-ql "0.6-pre"))
|
||||
|
||||
;;; Commentary:
|
||||
|
||||
|
|
@ -30,29 +28,31 @@
|
|||
|
||||
;;; Code:
|
||||
|
||||
;;;; Requirements
|
||||
(eval-and-compile
|
||||
|
||||
(require 'cl-lib)
|
||||
(require 'org)
|
||||
|
||||
(require 'compat)
|
||||
(require 'dash)
|
||||
(require 's)
|
||||
|
||||
(require 'helm)
|
||||
(require 'helm-org)
|
||||
|
||||
(require 'org-ql)
|
||||
(require 'org-ql-search)
|
||||
|
||||
(declare-function org-ql--normalize-query "org-ql" t t)
|
||||
|
||||
;;;; Compatibility
|
||||
|
||||
(defalias 'helm-org-ql--show-entry
|
||||
(if (version< org-version "9.6")
|
||||
'org-show-entry
|
||||
'org-fold-show-entry))
|
||||
;; Declare Helm functions since Helm may not be installed.
|
||||
(declare-function helm "ext:helm")
|
||||
(declare-function helm-run-after-exit "ext:helm")
|
||||
(declare-function helm-window "ext:helm-lib")
|
||||
(declare-function helm-buffer-get "ext:helm-lib")
|
||||
(declare-function helm-make-source "ext:helm-source")
|
||||
(declare-function helm-org-goto-marker "ext:helm-org")
|
||||
|
||||
;; Silence byte-compiler about variables.
|
||||
(defvar helm-map)
|
||||
(defvar helm-pattern)
|
||||
(defvar helm-input-idle-delay)
|
||||
|
||||
(when (require 'helm nil 'noerror)
|
||||
|
||||
;; Requirements.
|
||||
(require 'helm-org)
|
||||
|
||||
;;;; Variables
|
||||
|
||||
|
|
@ -65,7 +65,7 @@
|
|||
"Keymap for `helm-org-ql' sessions.
|
||||
Based on `helm-map'.")
|
||||
|
||||
(defvar helm-org-ql-views-source
|
||||
(defvar helm-source-org-ql-views
|
||||
(helm-make-source "Org QL Views" 'helm-source-sync
|
||||
:candidates (lambda ()
|
||||
(->> org-ql-views
|
||||
|
|
@ -74,15 +74,16 @@ Based on `helm-map'.")
|
|||
:action (list (cons "Show view" #'org-ql-view)))
|
||||
"Helm source for `org-ql-views'.")
|
||||
|
||||
(with-no-warnings
|
||||
;; Silence compiler warning: "‘make-variable-buffer-local’ not called at toplevel"
|
||||
(defvar-local helm-org-ql-buffers-files nil
|
||||
"Used for `helm-org-ql-save'.")
|
||||
"Used for `helm-org-ql-save'."))
|
||||
|
||||
;;;; Customization
|
||||
|
||||
(defgroup helm-org-ql nil
|
||||
"Options for `helm-org-ql'."
|
||||
:group 'org-ql
|
||||
:group 'helm)
|
||||
:group 'org-ql)
|
||||
|
||||
(defcustom helm-org-ql-reverse-paths t
|
||||
"Whether to reverse Org outline paths in `helm-org-ql' results."
|
||||
|
|
@ -108,11 +109,9 @@ Based on `helm-map'.")
|
|||
Interactively, search the current buffer. Note that this command
|
||||
only accepts non-sexp, \"plain\" queries.
|
||||
|
||||
NAME is passed to `helm-org-ql-source', which see.
|
||||
|
||||
NOTE: Atoms in the query are turned into strings where
|
||||
appropriate, which makes it unnecessary to type quotation marks
|
||||
around words that are intended to be searched for as independent
|
||||
around words that are intended to be searched for as indepenent
|
||||
strings.
|
||||
|
||||
All query tokens are wrapped in the operator BOOLEAN (default
|
||||
|
|
@ -161,7 +160,7 @@ Is transformed into this query:
|
|||
;; it to go to the previous heading. I don't know why it does that.
|
||||
(switch-to-buffer (marker-buffer marker))
|
||||
(goto-char marker)
|
||||
(helm-org-ql--show-entry))
|
||||
(org-show-entry))
|
||||
|
||||
(defun helm-org-ql-show-marker-indirect (marker)
|
||||
"Show heading at MARKER with `org-tree-to-indirect-buffer'."
|
||||
|
|
@ -174,24 +173,23 @@ Is transformed into this query:
|
|||
(interactive)
|
||||
(let ((buffers-files (with-current-buffer (helm-buffer-get)
|
||||
helm-org-ql-buffers-files))
|
||||
(query (org-ql--query-string-to-sexp helm-pattern)))
|
||||
(query (org-ql--plain-query helm-pattern)))
|
||||
(helm-run-after-exit #'org-ql-search buffers-files query)))
|
||||
|
||||
;;;###autoload
|
||||
(defun helm-org-ql-views ()
|
||||
"Show an `org-ql' view selected with Helm."
|
||||
(interactive)
|
||||
(helm :sources helm-org-ql-views-source))
|
||||
(helm :sources helm-source-org-ql-views))
|
||||
|
||||
;;;; Functions
|
||||
|
||||
;;;###autoload
|
||||
(cl-defun helm-org-ql-source (buffers-files &key (name "helm-org-ql"))
|
||||
"Return Helm source named NAME to search BUFFERS-FILES with `helm-org-ql'."
|
||||
"Return Helm source named NAME that searches BUFFERS-FILES with `helm-org-ql'."
|
||||
;; Expansion of `helm-build-sync-source' macro.
|
||||
(helm-make-source name 'helm-source-sync
|
||||
:candidates (lambda ()
|
||||
(let* ((query (org-ql--query-string-to-sexp helm-pattern))
|
||||
(let* ((query (org-ql--plain-query helm-pattern))
|
||||
(window-width (window-width (helm-window))))
|
||||
(when query
|
||||
(with-current-buffer (helm-buffer-get)
|
||||
|
|
@ -211,7 +209,7 @@ Is transformed into this query:
|
|||
(defun helm-org-ql--heading (window-width)
|
||||
"Return string for Helm for heading at point.
|
||||
WINDOW-WIDTH should be the width of the Helm window."
|
||||
(font-lock-ensure (pos-bol) (pos-eol))
|
||||
(font-lock-ensure (point-at-bol) (point-at-eol))
|
||||
;; TODO: It would be better to avoid calculating the prefix and width
|
||||
;; at each heading, but there's no easy way to do that once in each
|
||||
;; buffer, unless we manually called `org-ql' in each buffer, which
|
||||
|
|
@ -226,7 +224,7 @@ WINDOW-WIDTH should be the width of the Helm window."
|
|||
(path (if helm-org-ql-reverse-paths
|
||||
(concat heading "\\" (s-join "\\" (nreverse path)))
|
||||
(concat (s-join "/" path) "/" heading))))
|
||||
(cons (concat prefix path) (point-marker))))
|
||||
(cons (concat prefix path) (point-marker))))))
|
||||
|
||||
;;;; Footer
|
||||
|
||||
|
|
|
|||
|
|
@ -1,4 +1,4 @@
|
|||
#!/bin/bash
|
||||
#!/bin/sh
|
||||
|
||||
# * Commit parameters
|
||||
# Unused now, but good for future reference. See man 5 githooks.
|
||||
|
|
@ -14,9 +14,4 @@ read local_ref local_sha remote_ref remote_sha
|
|||
# cause remote code to be downloaded and executed (i.e. what would
|
||||
# happen by installing packages). It can be done manually when needed.
|
||||
|
||||
# Only run when pushing master.
|
||||
|
||||
if [[ $local_ref = refs/heads/master ]]
|
||||
then
|
||||
make sandbox=.sandbox test
|
||||
fi
|
||||
|
|
|
|||
BIN
images/dont-tread-on-emacs-150.png
Normal file
BIN
images/dont-tread-on-emacs-150.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 5.5 KiB |
Binary file not shown.
|
Before Width: | Height: | Size: 92 KiB |
305
makem.sh
305
makem.sh
|
|
@ -3,11 +3,11 @@
|
|||
# * makem.sh --- Script to aid building and testing Emacs Lisp packages
|
||||
|
||||
# URL: https://github.com/alphapapa/makem.sh
|
||||
# Version: 0.7.1
|
||||
# Version: 0.2
|
||||
|
||||
# * Commentary:
|
||||
|
||||
# makem.sh is a script that helps to build, lint, and test Emacs Lisp
|
||||
# makem.sh is a script helps to build, lint, and test Emacs Lisp
|
||||
# packages. It aims to make linting and testing as simple as possible
|
||||
# without requiring per-package configuration.
|
||||
|
||||
|
|
@ -79,8 +79,7 @@ Rules:
|
|||
Options:
|
||||
-d, --debug Print debug info.
|
||||
-h, --help I need somebody!
|
||||
-v, --verbose Increase verbosity, up to -vvv.
|
||||
--no-color Disable color output.
|
||||
-v, --verbose Increase verbosity, up to -vv.
|
||||
|
||||
--debug-load-path Print load-path from inside Emacs.
|
||||
|
||||
|
|
@ -89,8 +88,7 @@ Options:
|
|||
-e, --exclude FILE Exclude FILE from linting and testing.
|
||||
-f, --file FILE Check FILE in addition to discovered files.
|
||||
|
||||
-c, --compile-batch Batch-compile files (instead of separately; quicker, but
|
||||
may hide problems).
|
||||
--no-color Disable color output.
|
||||
-C, --no-compile Don't compile files automatically.
|
||||
|
||||
Sandbox options:
|
||||
|
|
@ -112,12 +110,6 @@ Source files are automatically discovered from git, or may be
|
|||
specified with options. Package dependencies are discovered from
|
||||
"Package-Requires" headers in source files, from -pkg.el files, and
|
||||
from a Cask file.
|
||||
|
||||
Checkdoc's spell checker may not recognize some words, causing the
|
||||
`lint-checkdoc' rule to fail. Custom words can be added in file-local
|
||||
or directory-local variables using the variable
|
||||
`ispell-buffer-session-localwords', which should be set to a list of
|
||||
strings.
|
||||
EOF
|
||||
}
|
||||
|
||||
|
|
@ -142,27 +134,6 @@ EOF
|
|||
echo $file
|
||||
}
|
||||
|
||||
function elisp-elint-file {
|
||||
local file=$(mktemp)
|
||||
cat >$file <<EOF
|
||||
(require 'cl-lib)
|
||||
(require 'elint)
|
||||
(defun makem-elint-file (file)
|
||||
(let ((errors 0))
|
||||
(cl-letf (((symbol-function 'orig-message) (symbol-function 'message))
|
||||
((symbol-function 'message) (symbol-function 'ignore))
|
||||
((symbol-function 'elint-output)
|
||||
(lambda (string)
|
||||
(cl-incf errors)
|
||||
(orig-message "%s" string))))
|
||||
(elint-file file)
|
||||
;; NOTE: \`errors' is not actually the number of errors, because
|
||||
;; it's incremented for non-error header strings as well.
|
||||
(kill-emacs errors))))
|
||||
EOF
|
||||
echo "$file"
|
||||
}
|
||||
|
||||
function elisp-checkdoc-file {
|
||||
# Since checkdoc doesn't have a batch function that exits non-zero
|
||||
# when errors are found, we make one.
|
||||
|
|
@ -181,9 +152,7 @@ function elisp-checkdoc-file {
|
|||
": " text)))
|
||||
(message msg)
|
||||
(setq makem-checkdoc-errors-p t)
|
||||
;; Return nil because we *are* generating a buffered list of errors.
|
||||
nil))))
|
||||
(put 'ispell-buffer-session-localwords 'safe-local-variable #'list-of-strings-p)
|
||||
(list text start end unfixable)))))
|
||||
(mapcar #'checkdoc-file files)
|
||||
(when makem-checkdoc-errors-p
|
||||
(kill-emacs 1))))
|
||||
|
|
@ -194,51 +163,6 @@ EOF
|
|||
echo $file
|
||||
}
|
||||
|
||||
function elisp-byte-compile-file {
|
||||
# This seems to be the only way to make byte-compilation signal
|
||||
# errors for warnings AND display all warnings rather than only
|
||||
# the first one.
|
||||
local file=$(mktemp)
|
||||
# TODO: Add file to $paths_temp in other elisp- functions.
|
||||
paths_temp+=("$file")
|
||||
|
||||
cat >"$file" <<EOF
|
||||
(defun makem-batch-byte-compile (&rest args)
|
||||
""
|
||||
(let ((num-errors 0)
|
||||
(num-warnings 0))
|
||||
;; NOTE: Only accepts files as args, not directories.
|
||||
(dolist (file command-line-args-left)
|
||||
(pcase-let ((\`(,errors ,warnings) (makem-byte-compile-file file)))
|
||||
(cl-incf num-errors errors)
|
||||
(cl-incf num-warnings warnings)))
|
||||
(zerop num-errors)))
|
||||
|
||||
(defun makem-byte-compile-file (filename &optional load)
|
||||
"Call \`byte-compile-warn', returning the number of errors and the number of warnings."
|
||||
(let ((num-warnings 0)
|
||||
(num-errors 0))
|
||||
(cl-letf (((symbol-function 'byte-compile-warn)
|
||||
(lambda (format &rest args)
|
||||
;; Copied from \`byte-compile-warn'.
|
||||
(cl-incf num-warnings)
|
||||
(setq format (apply #'format-message format args))
|
||||
(byte-compile-log-warning format t :warning)))
|
||||
((symbol-function 'byte-compile-report-error)
|
||||
(lambda (error-info &optional fill &rest args)
|
||||
(cl-incf num-errors)
|
||||
;; Copied from \`byte-compile-report-error'.
|
||||
(setq byte-compiler-error-flag t)
|
||||
(byte-compile-log-warning
|
||||
(if (stringp error-info) error-info
|
||||
(error-message-string error-info))
|
||||
fill :error))))
|
||||
(byte-compile-file filename load))
|
||||
(list num-errors num-warnings)))
|
||||
EOF
|
||||
echo "$file"
|
||||
}
|
||||
|
||||
function elisp-check-declare-file {
|
||||
# Since check-declare doesn't have a batch function that exits
|
||||
# non-zero when errors are found, we make one.
|
||||
|
|
@ -274,23 +198,20 @@ Exits non-zero if mis-indented lines are found. Checks files in
|
|||
(let ((errors-p))
|
||||
(cl-labels ((lint-file (file)
|
||||
(find-file file)
|
||||
(let ((tick (buffer-modified-tick)))
|
||||
(let ((inhibit-message t))
|
||||
(indent-region (point-min) (point-max)))
|
||||
(when buffer-undo-list
|
||||
(when (/= tick (buffer-modified-tick))
|
||||
;; Indentation changed: warn for each line.
|
||||
(dolist (line (undo-lines buffer-undo-list))
|
||||
(message "%s:%s: Indentation mismatch" (buffer-name) line))
|
||||
(setf errors-p t)))
|
||||
(undo-pos (entry)
|
||||
(cl-typecase (car entry)
|
||||
(number (car entry))
|
||||
(string (abs (cdr entry)))))
|
||||
(setf errors-p t))))
|
||||
(undo-lines (undo-list)
|
||||
;; Return list of lines changed in UNDO-LIST.
|
||||
(nreverse (cl-loop for elt in undo-list
|
||||
for pos = (undo-pos elt)
|
||||
when pos
|
||||
collect (line-number-at-pos pos)))))
|
||||
when (and (consp elt)
|
||||
(numberp (car elt)))
|
||||
collect (line-number-at-pos (car elt))))))
|
||||
(mapc #'lint-file (mapcar #'expand-file-name command-line-args-left))
|
||||
(when errors-p
|
||||
(kill-emacs 1)))))
|
||||
|
|
@ -307,7 +228,9 @@ function elisp-package-initialize-file {
|
|||
(setq package-archives (list (cons "gnu" "https://elpa.gnu.org/packages/")
|
||||
(cons "melpa" "https://melpa.org/packages/")
|
||||
(cons "melpa-stable" "https://stable.melpa.org/packages/")))
|
||||
$elisp_org_package_archive
|
||||
(package-initialize)
|
||||
(setq load-prefer-newer t)
|
||||
EOF
|
||||
echo $file
|
||||
}
|
||||
|
|
@ -320,7 +243,6 @@ function run_emacs {
|
|||
local emacs_command=(
|
||||
"${emacs_command[@]}"
|
||||
-Q
|
||||
--eval "(setq load-prefer-newer t)"
|
||||
"${args_debug[@]}"
|
||||
"${args_sandbox[@]}"
|
||||
-l $package_initialize_file
|
||||
|
|
@ -362,59 +284,13 @@ function batch-byte-compile {
|
|||
[[ $compile_error_on_warn ]] && local error_on_warn=(--eval "(setq byte-compile-error-on-warn t)")
|
||||
|
||||
run_emacs \
|
||||
--load "$(elisp-byte-compile-file)" \
|
||||
"${error_on_warn[@]}" \
|
||||
--eval "(unless (makem-batch-byte-compile) (kill-emacs 1))" \
|
||||
--funcall batch-byte-compile \
|
||||
"$@"
|
||||
}
|
||||
|
||||
function byte-compile-file {
|
||||
debug "byte-compile: ERROR-ON-WARN:$compile_error_on_warn"
|
||||
local file="$1"
|
||||
|
||||
[[ $compile_error_on_warn ]] && local error_on_warn=(--eval "(setq byte-compile-error-on-warn t)")
|
||||
|
||||
# FIXME: Why is the line starting with "&& verbose 3" not indented properly? Emacs insists on indenting it back a level.
|
||||
run_emacs \
|
||||
--load "$(elisp-byte-compile-file)" \
|
||||
"${error_on_warn[@]}" \
|
||||
--eval "(pcase-let ((\`(,num-errors ,num-warnings) (makem-byte-compile-file \"$file\"))) (when (or (and byte-compile-error-on-warn (not (zerop num-warnings))) (not (zerop num-errors))) (kill-emacs 1)))" \
|
||||
&& verbose 3 "Compiling $file finished without errors." \
|
||||
|| { verbose 3 "Compiling file failed: $file"; return 1; }
|
||||
}
|
||||
|
||||
# ** Files
|
||||
|
||||
function submodules {
|
||||
# Echo a list of submodules's paths relative to the repo root.
|
||||
# TODO: Parse with bash regexp instead of cut.
|
||||
git submodule status | awk '{print $2}'
|
||||
}
|
||||
|
||||
function project-root {
|
||||
# Echo the root of the project (or superproject, if running from
|
||||
# within a submodule).
|
||||
root_dir=$(git rev-parse --show-superproject-working-tree)
|
||||
[[ $root_dir ]] || root_dir=$(git rev-parse --show-toplevel)
|
||||
[[ $root_dir ]] || error "Can't find repo root."
|
||||
|
||||
echo "$root_dir"
|
||||
}
|
||||
|
||||
function files-project {
|
||||
# Echo a list of files in project; or with $1, files in it
|
||||
# matching that pattern with "git ls-files". Excludes submodules.
|
||||
[[ $1 ]] && pattern="/$1" || pattern="."
|
||||
|
||||
local excludes
|
||||
for submodule in $(submodules)
|
||||
do
|
||||
excludes+=(":!:$submodule")
|
||||
done
|
||||
|
||||
git ls-files -- "$pattern" "${excludes[@]}"
|
||||
}
|
||||
|
||||
function dirs-project {
|
||||
# Echo list of directories to be used in load path.
|
||||
files-project-feature | dirnames
|
||||
|
|
@ -423,7 +299,7 @@ function dirs-project {
|
|||
|
||||
function files-project-elisp {
|
||||
# Echo list of Elisp files in project.
|
||||
files-project 2>/dev/null \
|
||||
git ls-files 2>/dev/null \
|
||||
| egrep "\.el$" \
|
||||
| filter-files-exclude-default \
|
||||
| filter-files-exclude-args
|
||||
|
|
@ -432,13 +308,13 @@ function files-project-elisp {
|
|||
function files-project-feature {
|
||||
# Echo list of Elisp files that are not tests and provide a feature.
|
||||
files-project-elisp \
|
||||
| grep -E -v "$test_files_regexp" \
|
||||
| egrep -v "$test_files_regexp" \
|
||||
| filter-files-feature
|
||||
}
|
||||
|
||||
function files-project-test {
|
||||
# Echo list of Elisp test files.
|
||||
files-project-elisp | grep -E "$test_files_regexp"
|
||||
files-project-elisp | egrep "$test_files_regexp"
|
||||
}
|
||||
|
||||
function dirnames {
|
||||
|
|
@ -451,7 +327,7 @@ function dirnames {
|
|||
|
||||
function filter-files-exclude-default {
|
||||
# Filter out paths (STDIN) which should be excluded by default.
|
||||
grep -E -v "(/\.cask/|-autoloads\.el|\.dir-locals)"
|
||||
egrep -v "(/\.cask/|-autoloads.el|.dir-locals)"
|
||||
}
|
||||
|
||||
function filter-files-exclude-args {
|
||||
|
|
@ -477,7 +353,7 @@ function filter-files-feature {
|
|||
# Read paths on STDIN and echo ones that (provide 'a-feature).
|
||||
while read path
|
||||
do
|
||||
grep -E "^\\(provide '" "$path" &>/dev/null \
|
||||
egrep "^\\(provide '" "$path" &>/dev/null \
|
||||
&& echo "$path"
|
||||
done
|
||||
}
|
||||
|
|
@ -486,8 +362,7 @@ function args-load-files {
|
|||
# For file in $@, echo "--load $file".
|
||||
for file in "$@"
|
||||
do
|
||||
sans_extension=${file%%.el}
|
||||
printf -- '--load %q ' "$sans_extension"
|
||||
printf -- '--load %q ' "$file"
|
||||
done
|
||||
}
|
||||
|
||||
|
|
@ -524,8 +399,9 @@ function ert-tests-p {
|
|||
}
|
||||
|
||||
function package-main-file {
|
||||
# Echo the package's main file.
|
||||
file_pkg=$(files-project "*-pkg.el" 2>/dev/null)
|
||||
# Echo the package's main file. Helpful for setting package-lint-main-file.
|
||||
|
||||
file_pkg=$(git ls-files ./*-pkg.el 2>/dev/null)
|
||||
|
||||
if [[ $file_pkg ]]
|
||||
then
|
||||
|
|
@ -546,25 +422,24 @@ function package-main-file {
|
|||
function dependencies {
|
||||
# Echo list of package dependencies.
|
||||
|
||||
# Search package headers. Use -a so grep won't think that an Elisp file containing
|
||||
# control characters (rare, but sometimes necessary) is binary and refuse to search it.
|
||||
grep -E -a -i '^;; Package-Requires: ' $(files-project-feature) $(files-project-test) \
|
||||
| grep -E -o '\([^([:space:]][^)]*\)' \
|
||||
| grep -E -o '^[^[:space:])]+' \
|
||||
# Search package headers.
|
||||
egrep -i '^;; Package-Requires: ' $(files-project-feature) $(files-project-test) \
|
||||
| egrep -o '\([^([:space:]][^)]*\)' \
|
||||
| egrep -o '^[^[:space:])]+' \
|
||||
| sed -r 's/\(//g' \
|
||||
| grep -E -v '^emacs$' # Ignore Emacs version requirement.
|
||||
| egrep -v '^emacs$' # Ignore Emacs version requirement.
|
||||
|
||||
# Search Cask file.
|
||||
if [[ -r Cask ]]
|
||||
then
|
||||
grep -E '\(depends-on "[^"]+"' Cask \
|
||||
egrep '\(depends-on "[^"]+"' Cask \
|
||||
| sed -r -e 's/\(depends-on "([^"]+)".*/\1/g'
|
||||
fi
|
||||
|
||||
# Search -pkg.el file.
|
||||
if [[ $(files-project "*-pkg.el" 2>/dev/null) ]]
|
||||
if [[ $(git ls-files ./*-pkg.el 2>/dev/null) ]]
|
||||
then
|
||||
sed -nr 's/.*\(([-[:alnum:]]+)[[:blank:]]+"[.[:digit:]]+"\).*/\1/p' $(files-project- -- -pkg.el 2>/dev/null)
|
||||
sed -nr 's/.*\(([-[:alnum:]]+)[[:blank:]]+"[.[:digit:]]+"\).*/\1/p' $(git ls-files ./*-pkg.el 2>/dev/null)
|
||||
fi
|
||||
}
|
||||
|
||||
|
|
@ -606,8 +481,6 @@ function sandbox {
|
|||
args_sandbox=(
|
||||
--title "makem.sh: $(basename $(pwd)) (sandbox: $sandbox_dir)"
|
||||
--eval "(setq user-emacs-directory (file-truename \"$sandbox_dir\"))"
|
||||
--load package
|
||||
--eval "(setq package-user-dir (expand-file-name \"elpa\" user-emacs-directory))"
|
||||
--eval "(setq user-init-file (file-truename \"$init_file\"))"
|
||||
)
|
||||
|
||||
|
|
@ -617,9 +490,6 @@ function sandbox {
|
|||
local deps=($(dependencies))
|
||||
debug "Installing dependencies: ${deps[@]}"
|
||||
|
||||
# Ensure built-in packages get upgraded to newer versions from ELPA.
|
||||
args_sandbox_package_install+=(--eval "(setq package-install-upgrade-built-in t)")
|
||||
|
||||
for package in "${deps[@]}"
|
||||
do
|
||||
args_sandbox_package_install+=(--eval "(package-install '$package)")
|
||||
|
|
@ -773,8 +643,7 @@ function verbose {
|
|||
if [[ $verbose -ge $1 ]]
|
||||
then
|
||||
[[ $1 -eq 1 ]] && local color_name=blue
|
||||
[[ $1 -eq 2 ]] && local color_name=cyan
|
||||
[[ $1 -ge 3 ]] && local color_name=white
|
||||
[[ $1 -ge 2 ]] && local color_name=cyan
|
||||
|
||||
shift
|
||||
log_color $color_name "$@" >&2
|
||||
|
|
@ -814,54 +683,16 @@ function all {
|
|||
tests
|
||||
}
|
||||
|
||||
function compile-batch {
|
||||
[[ $compile ]] || return 0
|
||||
unset compile # Only compile once.
|
||||
|
||||
verbose 1 "Compiling..."
|
||||
verbose 2 "Batch-compiling files..."
|
||||
debug "Byte-compile files: ${files_project_byte_compile[@]}"
|
||||
|
||||
batch-byte-compile "${files_project_byte_compile[@]}"
|
||||
}
|
||||
|
||||
function compile-each {
|
||||
[[ $compile ]] || return 0
|
||||
unset compile # Only compile once.
|
||||
|
||||
verbose 1 "Compiling..."
|
||||
debug "Byte-compile files: ${files_project_byte_compile[@]}"
|
||||
|
||||
local compile_errors
|
||||
for file in "${files_project_byte_compile[@]}"
|
||||
do
|
||||
verbose 2 "Compiling file: $file..."
|
||||
byte-compile-file "$file" \
|
||||
|| compile_errors=t
|
||||
done
|
||||
|
||||
[[ ! $compile_errors ]]
|
||||
}
|
||||
|
||||
function compile {
|
||||
if [[ $compile = batch ]]
|
||||
then
|
||||
compile-batch "$@"
|
||||
else
|
||||
compile-each "$@"
|
||||
fi
|
||||
local status=$?
|
||||
[[ $compile ]] || return 0
|
||||
unset compile # Only compile once.
|
||||
|
||||
if [[ $compile_error_on_warn ]]
|
||||
then
|
||||
# Linting: just return status code, because lint rule will print messages.
|
||||
[[ $status = 0 ]]
|
||||
else
|
||||
# Not linting: print messages here.
|
||||
[[ $status = 0 ]] \
|
||||
verbose 1 "Compiling..."
|
||||
debug "Byte-compile files: ${files_project_byte_compile[@]}"
|
||||
|
||||
batch-byte-compile "${files_project_byte_compile[@]}" \
|
||||
&& success "Compiling finished without errors." \
|
||||
|| error "Compiling failed."
|
||||
fi
|
||||
|| error "Compilation failed."
|
||||
}
|
||||
|
||||
function batch {
|
||||
|
|
@ -876,15 +707,12 @@ function batch {
|
|||
|
||||
function interactive {
|
||||
# Run Emacs interactively. Most useful with --sandbox and --install-deps.
|
||||
local load_file_args=$(args-load-files "${files_project_feature[@]}" "${files_project_test[@]}")
|
||||
verbose 1 "Running Emacs interactively..."
|
||||
verbose 2 "Loading files: ${load_file_args//--load /}"
|
||||
|
||||
[[ $compile ]] && compile
|
||||
verbose 2 "Loading files:" "${files_project_feature[@]}" "${files_project_test[@]}"
|
||||
|
||||
unset arg_batch
|
||||
run_emacs \
|
||||
$load_file_args \
|
||||
$(args-load-files "${files_project_feature[@]}" "${files_project_test[@]}") \
|
||||
--eval "(load user-init-file)" \
|
||||
"${args_batch_interactive[@]}"
|
||||
arg_batch="--batch"
|
||||
|
|
@ -896,9 +724,6 @@ function lint {
|
|||
lint-checkdoc
|
||||
lint-compile
|
||||
lint-declare
|
||||
# NOTE: Elint doesn't seem very useful at the moment. See comment
|
||||
# in lint-elint function.
|
||||
# lint-elint
|
||||
lint-indent
|
||||
lint-package
|
||||
lint-regexps
|
||||
|
|
@ -921,7 +746,7 @@ function lint-compile {
|
|||
verbose 1 "Linting compilation..."
|
||||
|
||||
compile_error_on_warn=true
|
||||
compile "${files_project_byte_compile[@]}" \
|
||||
batch-byte-compile "${files_project_byte_compile[@]}" \
|
||||
&& success "Linting compilation finished without errors." \
|
||||
|| error "Linting compilation failed."
|
||||
unset compile_error_on_warn
|
||||
|
|
@ -955,28 +780,6 @@ function lint-elsa {
|
|||
|| error "Linting with Elsa failed."
|
||||
}
|
||||
|
||||
function lint-elint {
|
||||
# NOTE: Elint gives a lot of spurious warnings, apparently because it doesn't load files
|
||||
# that are `require'd, so its output isn't very useful. But in case it's improved in
|
||||
# the future, and since this wrapper code already works, we might as well leave it in.
|
||||
verbose 1 "Linting with Elint..."
|
||||
|
||||
local errors=0
|
||||
for file in "${files_project_feature[@]}"
|
||||
do
|
||||
verbose 2 "Linting with Elint: $file..."
|
||||
run_emacs \
|
||||
--load "$(elisp-elint-file)" \
|
||||
--eval "(makem-elint-file \"$file\")" \
|
||||
&& verbose 3 "Linting with Elint found no errors." \
|
||||
|| { error "Linting with Elint failed: $file"; ((errors++)) ; }
|
||||
done
|
||||
|
||||
[[ $errors = 0 ]] \
|
||||
&& success "Linting with Elint finished without errors." \
|
||||
|| error "Linting with Elint failed."
|
||||
}
|
||||
|
||||
function lint-indent {
|
||||
verbose 1 "Linting indentation..."
|
||||
|
||||
|
|
@ -1048,8 +851,7 @@ function test-buttercup {
|
|||
|
||||
run_emacs \
|
||||
$(args-load-files "${files_project_test[@]}") \
|
||||
--load "$buttercup_file" \
|
||||
--eval "(progn (setq backtrace-on-error-noninteractive nil) (buttercup-run))" \
|
||||
-f buttercup-run \
|
||||
&& success "Buttercup tests finished without errors." \
|
||||
|| error "Buttercup tests failed."
|
||||
}
|
||||
|
|
@ -1077,7 +879,6 @@ errors=0
|
|||
verbose=0
|
||||
compile=true
|
||||
arg_batch="--batch"
|
||||
compile=each
|
||||
|
||||
# MAYBE: Disable color if not outputting to a terminal. (OTOH, the
|
||||
# colorized output is helpful in CI logs, and I don't know if,
|
||||
|
|
@ -1123,15 +924,21 @@ args_package_archives=(
|
|||
--eval "(add-to-list 'package-archives '(\"melpa\" . \"https://melpa.org/packages/\") t)"
|
||||
)
|
||||
|
||||
args_org_package_archives=(
|
||||
--eval "(add-to-list 'package-archives '(\"org\" . \"https://orgmode.org/elpa/\") t)"
|
||||
)
|
||||
|
||||
args_package_init=(
|
||||
--eval "(package-initialize)"
|
||||
)
|
||||
|
||||
elisp_org_package_archive="(add-to-list 'package-archives '(\"org\" . \"https://orgmode.org/elpa/\") t)"
|
||||
|
||||
# * Args
|
||||
|
||||
args=$(getopt -n "$0" \
|
||||
-o dhce:E:i:s::vf:C \
|
||||
-l compile-batch,exclude:,emacs:,install-deps,install-linters,debug,debug-load-path,help,install:,verbose,file:,no-color,no-compile,sandbox:: \
|
||||
-o dhe:E:i:s::vf:CO \
|
||||
-l exclude:,emacs:,install-deps,install-linters,debug,debug-load-path,help,install:,verbose,file:,no-color,no-compile,no-org-repo,sandbox:: \
|
||||
-- "$@") \
|
||||
|| { usage; exit 1; }
|
||||
eval set -- "$args"
|
||||
|
|
@ -1158,10 +965,6 @@ do
|
|||
usage
|
||||
exit
|
||||
;;
|
||||
-c|--compile-batch)
|
||||
debug "Compiling files in batch mode"
|
||||
compile=batch
|
||||
;;
|
||||
-E|--emacs)
|
||||
shift
|
||||
emacs_command=($1)
|
||||
|
|
@ -1195,6 +998,9 @@ do
|
|||
shift
|
||||
args_files+=("$1")
|
||||
;;
|
||||
-O|--no-org-repo)
|
||||
unset elisp_org_package_archive
|
||||
;;
|
||||
--no-color)
|
||||
unset color
|
||||
;;
|
||||
|
|
@ -1223,9 +1029,6 @@ paths_temp+=("$package_initialize_file")
|
|||
|
||||
trap cleanup EXIT INT TERM
|
||||
|
||||
# Change to project root directory first.
|
||||
cd "$(project-root)"
|
||||
|
||||
# Discover project files.
|
||||
files_project_feature=($(files-project-feature))
|
||||
files_project_test=($(files-project-test))
|
||||
|
|
|
|||
|
|
@ -1,402 +0,0 @@
|
|||
;;; org-ql-completing-read.el --- Completing read of Org entries using org-ql -*- lexical-binding: t; -*-
|
||||
|
||||
;; Copyright (C) 2022-2023 Adam Porter
|
||||
|
||||
;; Author: Adam Porter <adam@alphapapa.net>
|
||||
|
||||
;; This program is free software; you can redistribute it and/or modify
|
||||
;; it under the terms of the GNU General Public License as published by
|
||||
;; the Free Software Foundation, either version 3 of the License, or
|
||||
;; (at your option) any later version.
|
||||
|
||||
;; This program is distributed in the hope that it will be useful,
|
||||
;; but WITHOUT ANY WARRANTY; without even the implied warranty of
|
||||
;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
||||
;; GNU General Public License for more details.
|
||||
|
||||
;; You should have received a copy of the GNU General Public License
|
||||
;; along with this program. If not, see <https://www.gnu.org/licenses/>.
|
||||
|
||||
;;; Commentary:
|
||||
|
||||
;; This library provides completing-read of Org entries using `org-ql'
|
||||
;; search.
|
||||
|
||||
;;; Code:
|
||||
|
||||
(require 'org-ql)
|
||||
|
||||
(declare-function org-ql-search "org-ql-search")
|
||||
(declare-function org-ql--normalize-query "org-ql" t t)
|
||||
|
||||
;;;; Variables
|
||||
|
||||
(defvar-keymap org-ql-completing-read-map
|
||||
:doc "Active during `org-ql-completing-read' sessions."
|
||||
"C-c C-e" #'org-ql-completing-read-export)
|
||||
|
||||
;; `embark-collect' doesn't work for `org-ql-completing-read', so remap
|
||||
;; it to `embark-export' (which `keymap-set', et al doesn't allow).
|
||||
(define-key org-ql-completing-read-map [remap embark-collect] 'embark-export)
|
||||
|
||||
;;;; Customization
|
||||
|
||||
(defgroup org-ql-completing-read nil
|
||||
"Completing-read of Org entries using `org-ql' search."
|
||||
:group 'org-ql)
|
||||
|
||||
(defcustom org-ql-completing-read-reverse-paths t
|
||||
"Whether to reverse Org outline paths in `org-ql-completing-read' results."
|
||||
:type 'boolean)
|
||||
|
||||
(defcustom org-ql-completing-read-snippet-function #'org-ql-completing-read--snippet-simple
|
||||
;; TODO(v0.9): Performance of completion annotations seems to be
|
||||
;; much improved now (whether due to changes in Emacs, Vertico, or
|
||||
;; both, I don't know). It may be reasonable to make the context
|
||||
;; snippet the default now.
|
||||
"Function used to annotate results in `org-ql-completing-read'.
|
||||
Function is called at entry beginning. (When set to
|
||||
`org-ql-completing-read--snippet-regexp', it is called with a
|
||||
regexp matching plain query tokens.)"
|
||||
:type '(choice (function-item :tag "Show context around search terms" org-ql-completing-read--snippet-regexp)
|
||||
(function-item :tag "Show first N characters" org-ql-completing-read--snippet-simple)
|
||||
(function :tag "Custom function")))
|
||||
|
||||
(defcustom org-ql-completing-read-snippet-length 51
|
||||
"Size of snippets of entry content to include in completion annotations.
|
||||
Only used when `org-ql-completing-read-snippet-function' is set
|
||||
to `org-ql-completing-read--snippet-regexp'."
|
||||
:type 'integer)
|
||||
|
||||
(defcustom org-ql-completing-read-snippet-minimum-token-length 3
|
||||
"Query tokens shorter than this many characters are ignored.
|
||||
That is, they are not included when gathering entry snippets.
|
||||
This avoids too-small tokens causing performance problems."
|
||||
:type 'integer)
|
||||
|
||||
(defcustom org-ql-completing-read-snippet-prefix nil
|
||||
"String prepended to snippets.
|
||||
For an experience like `org-rifle', use a newline."
|
||||
:type '(choice (const :tag "None (shown on same line)" nil)
|
||||
(const :tag "New line (shown under heading)" "\n")
|
||||
string))
|
||||
|
||||
(defface org-ql-completing-read-snippet '((t (:inherit font-lock-comment-face)))
|
||||
"Snippets.")
|
||||
|
||||
(defvar org-ql-completing-read-input-regexp nil
|
||||
"Current regexp for `org-ql-completing-read' input.
|
||||
To be used in, e.g. annotation functions.")
|
||||
|
||||
;;;; Functions
|
||||
|
||||
(defun org-ql-completing-read-action ()
|
||||
"Default action for `org-ql-completing-read'.
|
||||
Returns (STRING . MARKER) cons for entry at point."
|
||||
(font-lock-ensure (pos-bol) (pos-eol))
|
||||
(cons (org-link-display-format (org-entry-get nil "ITEM")) (point-marker)))
|
||||
|
||||
(defun org-ql-completing-read-snippet (marker)
|
||||
"Return snippet for entry at MARKER.
|
||||
Returns value returned by function
|
||||
`org-ql-completing-read-snippet-function' or
|
||||
`org-ql-completing-read--snippet-simple', whichever returns a
|
||||
value, or nil."
|
||||
(pcase (while-no-input
|
||||
;; Using `while-no-input' here doesn't make it as
|
||||
;; responsive as, e.g. Helm while typing, but it seems to
|
||||
;; help a little when using the org-rifle-style snippets.
|
||||
(org-with-point-at marker
|
||||
(or (funcall org-ql-completing-read-snippet-function
|
||||
org-ql-completing-read-input-regexp)
|
||||
(org-ql-completing-read--snippet-simple))))
|
||||
(`t ;; Interrupted: return nil (which can be concatted).
|
||||
nil)
|
||||
(else (propertize (concat " " else)
|
||||
'face 'org-ql-completing-read-snippet))))
|
||||
|
||||
(defun org-ql-completing-read-path (marker)
|
||||
"Return formatted outline path for entry at MARKER."
|
||||
(org-with-point-at marker
|
||||
(let ((path (thread-first (org-get-outline-path nil t)
|
||||
(org-format-outline-path (window-width) nil " ")
|
||||
(org-split-string " "))))
|
||||
(if org-ql-completing-read-reverse-paths
|
||||
(concat "\\" (string-join (reverse path) "\\"))
|
||||
(concat "/" (string-join path "/"))))))
|
||||
|
||||
;;;;; Completing read
|
||||
|
||||
(defun org-ql-completing-read-export ()
|
||||
"Show `org-ql-view' buffer for current `org-ql-completing-read'-based search."
|
||||
(interactive)
|
||||
(user-error "Not in an `org-ql-completing-read' session"))
|
||||
|
||||
;;;###autoload
|
||||
(cl-defun org-ql-completing-read
|
||||
(buffers-files &key query-prefix query-filter narrowp
|
||||
(action #'org-ql-completing-read-action)
|
||||
;; FIXME: Unused argument.
|
||||
;; (annotate #'org-ql-completing-read-snippet)
|
||||
(snippet #'org-ql-completing-read-snippet)
|
||||
(path #'org-ql-completing-read-path)
|
||||
(action-filter #'list)
|
||||
(prompt "Find entry: "))
|
||||
"Return marker at entry in BUFFERS-FILES selected with `org-ql'.
|
||||
PROMPT is shown to the user.
|
||||
|
||||
NARROWP is passed to `org-ql-select', which see.
|
||||
|
||||
QUERY-PREFIX may be a string to prepend to the query entered by
|
||||
the user (e.g. use \"heading:\" to only search headings, easily
|
||||
creating a custom command that saves the user from having to type
|
||||
it).
|
||||
|
||||
QUERY-FILTER may be a function through which the query the user
|
||||
types is filtered before execution (e.g. it could replace spaces
|
||||
with commas to turn multiple tokens, which would normally be
|
||||
treated as multiple predicates, into multiple arguments to a
|
||||
single predicate)."
|
||||
(declare (indent defun))
|
||||
;; Emacs's completion API is not always easy to understand, especially when using "programmed
|
||||
;; completion." This code was made possible by the example Clemens Radermacher shared at
|
||||
;; <https://github.com/radian-software/selectrum/issues/114#issuecomment-744041532>.
|
||||
|
||||
;; NOTE: I don't usually leave commented-out debugging code, but due to the incredibly tedious
|
||||
;; complexity of the "Programmed Completion" API and the time spent trying to get this reasonably
|
||||
;; close to "correct," I'm leaving it in, because I will undoubtedly have to go through this
|
||||
;; process again.
|
||||
|
||||
;; (message "ORG-QL-COMPLETING-READ: Starts.")
|
||||
(let ((table (make-hash-table :test #'equal))
|
||||
(disambiguations (make-hash-table :test #'equal))
|
||||
(window-width (window-width))
|
||||
last-input org-outline-path-cache query-tokens)
|
||||
(cl-labels (;; (debug-message
|
||||
;; (f &rest args) (apply #'message (concat "ORG-QL-COMPLETING-READ: " f) args))
|
||||
(action ()
|
||||
(font-lock-ensure (pos-bol) (pos-eol))
|
||||
;; This function needs to handle multiple candidates per
|
||||
;; call, so we loop over a list of values by default.
|
||||
(pcase-dolist (`(,string . ,marker) (funcall action-filter (funcall action)))
|
||||
(when string
|
||||
(if (string-empty-p string)
|
||||
;; A heading's string can be empty, but we can't use one because it
|
||||
;; wouldn't be useful to the user; and if one is found, it's very
|
||||
;; likely to indicate an unnoticed mistake or corruption in the
|
||||
;; file: so display a warning and don't record it as a candidate.
|
||||
(display-warning 'org-ql-completing-read (format-message "Empty heading at %S" marker))
|
||||
(when (gethash string table)
|
||||
;; Disambiguate string (even adding the path isn't enough, because that could
|
||||
;; also be duplicated).
|
||||
(if-let ((suffix (gethash string disambiguations)))
|
||||
(setf string (format "%s <%s>" string (cl-incf suffix)))
|
||||
(setf string (format "%s <%s>" string (puthash string 2 disambiguations)))))
|
||||
(puthash (propertize string 'org-marker marker) marker table)))))
|
||||
(path (marker)
|
||||
(org-with-point-at marker
|
||||
(let* ((path (thread-first (org-get-outline-path nil t)
|
||||
(org-format-outline-path window-width nil " ")
|
||||
(org-split-string " ")))
|
||||
(formatted-path (if org-ql-completing-read-reverse-paths
|
||||
(concat "\\" (string-join (reverse path) "\\"))
|
||||
(concat "/" (string-join path "/")))))
|
||||
formatted-path)))
|
||||
(todo (marker)
|
||||
(if-let (it (org-entry-get marker "TODO"))
|
||||
(concat (propertize it 'face (org-get-todo-face it)) " ")
|
||||
""))
|
||||
(affix (completions)
|
||||
;; (debug-message "AFFIX:%S" completions)
|
||||
(cl-loop for completion in completions
|
||||
for marker = (get-text-property 0 'org-marker completion)
|
||||
for prefix = (todo marker)
|
||||
for suffix = (concat (funcall path marker) " " (funcall snippet marker))
|
||||
collect (list completion prefix suffix)))
|
||||
(annotate (candidate)
|
||||
;; (debug-message "ANNOTATE:%S" candidate)
|
||||
(while-no-input
|
||||
;; Using `while-no-input' here doesn't make it as responsive as,
|
||||
;; e.g. Helm while typing, but it seems to help a little when using the
|
||||
;; org-rifle-style snippets.
|
||||
(or (funcall snippet (get-text-property 0 'org-marker candidate)) "")))
|
||||
(group (candidate transform)
|
||||
(pcase transform
|
||||
(`nil (buffer-name (marker-buffer (get-text-property 0 'org-marker candidate))))
|
||||
(_ candidate)))
|
||||
(try (string _collection _pred point &optional _metadata)
|
||||
;; (debug-message "TRY: STRING:%S" string)
|
||||
(cons string point))
|
||||
(all (string table pred _point)
|
||||
;; (debug-message "all: STRING:%S" string)
|
||||
;; (debug-message "all-completions RETURNS: %S" (all-completions string table pred))
|
||||
(all-completions string table pred))
|
||||
(collection (input _pred flag)
|
||||
(pcase flag
|
||||
('metadata (list 'metadata
|
||||
(cons 'category 'org-heading)
|
||||
(cons 'group-function #'group)
|
||||
(cons 'affixation-function #'affix)
|
||||
(cons 'annotation-function #'annotate)
|
||||
(cons 'display-sort-function
|
||||
(lambda (strings)
|
||||
(let ((quoted-tokens (mapcar #'regexp-quote query-tokens)))
|
||||
(sort strings
|
||||
(lambda (a b)
|
||||
(cl-labels ((matches
|
||||
(s) (cl-loop for token in quoted-tokens
|
||||
count (string-match-p token s))))
|
||||
(> (matches a) (matches b))))))))))
|
||||
(`t
|
||||
;; (debug-message "COLLECTION:t INPUT:%S KEYS:%S"
|
||||
;; input (hash-table-keys table))
|
||||
;; It's not ideal to call `run-query' unconditionally here, but due to
|
||||
;; the complexity of the "Programmed Completion" API, it's basically
|
||||
;; necessary, and org-ql's caching should make it nearly free.
|
||||
(run-query input)
|
||||
(hash-table-keys table))
|
||||
('lambda
|
||||
;; (debug-message "COLLECTION:lambda INPUT:%S KEYS:%S"
|
||||
;; input (hash-table-keys table))
|
||||
(if (not (hash-table-empty-p table))
|
||||
(when (gethash input table)
|
||||
t)
|
||||
(run-query input)
|
||||
(when (gethash input table)
|
||||
;; (debug-message "COLLECTION:lambda INPUT:%S FOUND" input)
|
||||
t)))
|
||||
(`nil
|
||||
;; (debug-message "COLLECTION:nil INPUT:%S" input)
|
||||
(if (not (hash-table-empty-p table))
|
||||
(when (gethash input table)
|
||||
t)
|
||||
(run-query input)
|
||||
;; (debug-message "COLLECTION:nil INPUT:%S KEYS:%S"
|
||||
;; input (hash-table-keys table))
|
||||
(cond ((hash-table-empty-p table)
|
||||
nil)
|
||||
((gethash input table)
|
||||
t)
|
||||
(t
|
||||
;; FIXME: "it should return the longest common prefix
|
||||
;; substring of all matches otherwise"...but there's no
|
||||
;; function to compute that? At least returning an empty
|
||||
;; string doesn't seem to break anything.
|
||||
input))))
|
||||
(`(boundaries . ,suffix)
|
||||
;; (debug-message "COLLECTION:boundaries INPUT:%S SUFFIX:%S KEYS:%S"
|
||||
;; input suffix (hash-table-keys table))
|
||||
;; FIXME: This is unlikely to be correct, but I'm not even sure if it
|
||||
;; can be correct in this case since the input (e.g. "todo: foo")
|
||||
;; usually won't match a completion candidate directly.
|
||||
`(boundaries 0 . ,(length suffix)))))
|
||||
(run-query (input)
|
||||
;; (debug-message "RUN-QUERY:%S" input)
|
||||
(when query-prefix
|
||||
(setf input (concat query-prefix input)))
|
||||
(unless (or (string-empty-p input)
|
||||
(equal last-input input))
|
||||
;; (debug-message "RUN-QUERY:%S RUNNING" input)
|
||||
(setf last-input input)
|
||||
;; Clear hash table each time the user changes the input.
|
||||
(clrhash table)
|
||||
(clrhash disambiguations)
|
||||
(when query-filter
|
||||
(setf input (funcall query-filter input)))
|
||||
(setf query-tokens
|
||||
;; Remove any tokens that specify predicates or are too short.
|
||||
(--select (not (or (string-match-p (rx bos (1+ (not (any ":"))) ":") it)
|
||||
(< (length it) org-ql-completing-read-snippet-minimum-token-length)))
|
||||
(split-string input nil t (rx blank)))
|
||||
org-ql-completing-read-input-regexp
|
||||
(when query-tokens
|
||||
;; Limiting each context word to 15 characters prevents
|
||||
;; excessively long, non-word strings from ending up in
|
||||
;; snippets, which can adversely affect performance.
|
||||
(rx-to-string `(seq (optional (repeat 1 3 (repeat 1 15 (not space)) (0+ space)))
|
||||
bow (or ,@query-tokens) (0+ (not space))
|
||||
(optional (repeat 1 3 (0+ space) (repeat 1 15 (not space))))))))
|
||||
(org-ql-select buffers-files (org-ql--query-string-to-sexp input)
|
||||
:narrow narrowp
|
||||
:action #'action))))
|
||||
(unless (listp buffers-files)
|
||||
;; Since we map across this argument, we ensure it's a list.
|
||||
(setf buffers-files (list buffers-files)))
|
||||
;; NOTE: It seems that the `completing-read' machinery can call, abort, and re-call the
|
||||
;; collection function while the user is typing, which can interrupt the machinery Org uses to
|
||||
;; prepare an Org buffer when an Org file is loaded. This results in, e.g. the buffer being
|
||||
;; left in fundamental-mode, unprepared to be used as an Org buffer, which breaks many things
|
||||
;; and is very confusing for the user. Ideally, of course, we would solve this in
|
||||
;; `org-ql-select', and we already attempt to, but that function is called by the
|
||||
;; `completing-read' machinery, which interrupts it, so we must work around this problem by
|
||||
;; ensuring all of the BUFFERS-FILES are loaded and initialized before calling
|
||||
;; `completing-read'.
|
||||
(mapc #'org-ql--ensure-buffer buffers-files)
|
||||
(let* ((completion-styles '(org-ql-completing-read))
|
||||
(completion-styles-alist (cons (list 'org-ql-completing-read #'try #'all "Org QL Find")
|
||||
completion-styles-alist))
|
||||
(selected
|
||||
(minibuffer-with-setup-hook
|
||||
(lambda ()
|
||||
(use-local-map (make-composed-keymap org-ql-completing-read-map (current-local-map))))
|
||||
(cl-letf* (((symbol-function 'org-ql-completing-read-export)
|
||||
(lambda ()
|
||||
(interactive)
|
||||
(run-at-time 0 nil
|
||||
#'org-ql-search
|
||||
buffers-files
|
||||
(minibuffer-contents-no-properties))
|
||||
(if (fboundp 'minibuffer-quit-recursive-edit)
|
||||
(minibuffer-quit-recursive-edit)
|
||||
(abort-recursive-edit))))
|
||||
((symbol-function 'embark-export)
|
||||
(symbol-function 'org-ql-completing-read-export)))
|
||||
(completing-read prompt #'collection nil t)))))
|
||||
;; (debug-message "SELECTED:%S KEYS:%S" selected (hash-table-keys table))
|
||||
(or (gethash selected table)
|
||||
;; If there are completions in the table, but none of them exactly match the user input
|
||||
;; (e.g. a heading "foo" that matches a query "todo:"), `completing-read' will not
|
||||
;; select it automatically, so we return it ourselves. But note that this is not
|
||||
;; necessarily correct. For example, if the user types "todo:" and gets a list of
|
||||
;; completions ("foo" "bar"), and then changes the input to "ba" and presses RET
|
||||
;; immediately (without getting a new list of completions), the table will include "foo"
|
||||
;; and "bar", and we will return "foo"'s value rather than the first match for the query
|
||||
;; "ba", because `completing-read' will not cause the COLLECTION function to run a new
|
||||
;; query for the new input.
|
||||
(car (hash-table-values table))
|
||||
(user-error "No results for input"))))))
|
||||
|
||||
(defun org-ql-completing-read--snippet-simple (&optional _input-regexp)
|
||||
"Return a snippet of the current entry.
|
||||
Returns up to `org-ql-completing-read-snippet-length' characters."
|
||||
(save-excursion
|
||||
(org-end-of-meta-data t)
|
||||
(unless (org-at-heading-p)
|
||||
(let ((end (min (+ (point) org-ql-completing-read-snippet-length)
|
||||
(org-entry-end-position))))
|
||||
(concat org-ql-completing-read-snippet-prefix
|
||||
(truncate-string-to-width
|
||||
(replace-regexp-in-string "\n" " " (buffer-substring (point) end)
|
||||
t t)
|
||||
50 nil nil t))))))
|
||||
|
||||
(defun org-ql-completing-read--snippet-regexp (&optional input-regexp)
|
||||
"Return a snippet of the current entry's matches for INPUT-REGEXP."
|
||||
;; REGEXP may be nil if there are no qualifying tokens in the query.
|
||||
(when input-regexp
|
||||
(save-excursion
|
||||
(org-end-of-meta-data t)
|
||||
(unless (org-at-heading-p)
|
||||
(let* ((end (org-entry-end-position))
|
||||
(snippets (cl-loop while (re-search-forward input-regexp end t)
|
||||
concat (match-string 0) concat "…"
|
||||
do (goto-char (match-end 0)))))
|
||||
(unless (string-empty-p snippets)
|
||||
(concat org-ql-completing-read-snippet-prefix
|
||||
(replace-regexp-in-string (rx (1+ "\n")) " " snippets t t))))))))
|
||||
|
||||
;;;; Footer
|
||||
|
||||
(provide 'org-ql-completing-read)
|
||||
|
||||
;;; org-ql-completing-read.el ends here
|
||||
233
org-ql-find.el
233
org-ql-find.el
|
|
@ -1,233 +0,0 @@
|
|||
;;; org-ql-find.el --- Find headings with completion using org-ql -*- lexical-binding: t; -*-
|
||||
|
||||
;; Copyright (C) 2022-2023 Adam Porter
|
||||
|
||||
;; Author: Adam Porter <adam@alphapapa.net>
|
||||
|
||||
;; This program is free software; you can redistribute it and/or modify
|
||||
;; it under the terms of the GNU General Public License as published by
|
||||
;; the Free Software Foundation, either version 3 of the License, or
|
||||
;; (at your option) any later version.
|
||||
|
||||
;; This program is distributed in the hope that it will be useful,
|
||||
;; but WITHOUT ANY WARRANTY; without even the implied warranty of
|
||||
;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
||||
;; GNU General Public License for more details.
|
||||
|
||||
;; You should have received a copy of the GNU General Public License
|
||||
;; along with this program. If not, see <https://www.gnu.org/licenses/>.
|
||||
|
||||
;;; Commentary:
|
||||
|
||||
;; This library provides a way to quickly find and go to Org entries
|
||||
;; selected with Emacs's built-in completions API (so it works with
|
||||
;; packages that extend it, like Vertico, Marginalia, etc). It works
|
||||
;; like `helm-org-ql' but does not require Helm.
|
||||
|
||||
;;; Code:
|
||||
|
||||
(require 'cl-lib)
|
||||
|
||||
(require 'org)
|
||||
(require 'org-ql)
|
||||
(require 'org-ql-search)
|
||||
(require 'org-ql-completing-read)
|
||||
|
||||
(declare-function org-ql--normalize-query "org-ql" t t)
|
||||
|
||||
;;;; Customization
|
||||
|
||||
(defgroup org-ql-find nil
|
||||
"Options for `org-ql-find'."
|
||||
:group 'org-ql)
|
||||
|
||||
(defcustom org-ql-find-goto-hook '(org-show-entry org-reveal)
|
||||
"Functions called when selecting an entry."
|
||||
;; TODO: Add common choices, including `org-tree-to-indirect-buffer'.
|
||||
:type 'hook)
|
||||
|
||||
(defcustom org-ql-find-display-buffer-action '(display-buffer-same-window)
|
||||
"Display buffer action list for `org-ql-find'.
|
||||
See function `display-buffer'."
|
||||
:type 'sexp)
|
||||
|
||||
;;;; Commands
|
||||
|
||||
;;;###autoload
|
||||
(cl-defun org-ql-find (buffers-files &key query-prefix query-filter widen
|
||||
(prompt "Find entry: "))
|
||||
"Go to an Org entry in BUFFERS-FILES selected by searching entries with `org-ql'.
|
||||
Interactively, search the buffers and files relevant to the
|
||||
current buffer (i.e. in `org-agenda-mode', the value of
|
||||
`org-ql-view-buffers-files' or `org-agenda-contributing-files';
|
||||
in `org-mode', that buffer).
|
||||
|
||||
With one or more universal prefix arguments, WIDEN buffers before
|
||||
searching (otherwise, respect any narrowing). With two universal
|
||||
prefix arguments, select multiple buffers to search with
|
||||
completion and PROMPT.
|
||||
|
||||
QUERY-PREFIX may be a string to prepend to the query (e.g. use
|
||||
\"heading:\" to only search headings, easily creating a custom
|
||||
command that saves the user from having to type it).
|
||||
|
||||
QUERY-FILTER may be a function through which the query the user
|
||||
types is filtered before execution (e.g. it could replace spaces
|
||||
with commas to turn multiple tokens, which would normally be
|
||||
treated as multiple predicates, into multiple arguments to a
|
||||
single predicate)."
|
||||
(interactive (list (org-ql-find--buffers
|
||||
:read-buffer-p (equal '(16) current-prefix-arg))
|
||||
:widen current-prefix-arg))
|
||||
(let ((marker (save-restriction
|
||||
(when (and widen (equal (current-buffer) buffers-files))
|
||||
(widen))
|
||||
(org-ql-completing-read buffers-files
|
||||
:narrowp (not widen)
|
||||
:query-prefix query-prefix
|
||||
:query-filter query-filter
|
||||
:prompt prompt))))
|
||||
(set-buffer (or (buffer-base-buffer (marker-buffer marker))
|
||||
(marker-buffer marker)))
|
||||
(pop-to-buffer (current-buffer) org-ql-find-display-buffer-action)
|
||||
(without-restriction
|
||||
(goto-char marker)
|
||||
(run-hook-with-args 'org-ql-find-goto-hook))
|
||||
(when (equal (current-buffer) (marker-buffer marker))
|
||||
;; Ensure point is still within visible portion of buffer. (If
|
||||
;; `org-tree-to-indirect-buffer' is used in `org-ql-find-goto-hook',
|
||||
;; the buffer will have been changed and it won't matter; otherwise,
|
||||
;; the buffer could have been narrowed to a region excluding the
|
||||
;; selected entry.)
|
||||
(let ((end-of-subtree (org-with-point-at marker
|
||||
(org-end-of-subtree 'invisible-ok))))
|
||||
(unless (and (<= (point-min) marker)
|
||||
(>= (point-max) end-of-subtree))
|
||||
(widen)
|
||||
(goto-char marker))))))
|
||||
|
||||
;;;###autoload
|
||||
(defun org-ql-refile (marker)
|
||||
"Refile current entry to MARKER (interactively, one selected with `org-ql').
|
||||
Interactive completion uses files listed in `org-refile-targets',
|
||||
which see (but only the files are used)."
|
||||
(interactive (let ((buffers-files (delete-dups
|
||||
;; Always include the current buffer.
|
||||
(cons (current-buffer)
|
||||
(cl-loop for (files-spec . _candidate-spec) in org-refile-targets
|
||||
append (cl-typecase files-spec
|
||||
(null (list (current-buffer)))
|
||||
(symbol (pcase (funcall files-spec)
|
||||
((and (pred stringp) file) (list file))
|
||||
((and (pred listp) files) files)))
|
||||
(list files-spec)))))))
|
||||
(list (org-ql-completing-read buffers-files :prompt "Refile to: "))))
|
||||
(let ((buffer (or (buffer-base-buffer (marker-buffer marker))
|
||||
(marker-buffer marker))))
|
||||
(org-refile nil nil
|
||||
;; The RFLOC argument:
|
||||
(list
|
||||
;; Name
|
||||
(org-with-point-at marker
|
||||
(nth 4 (org-heading-components)))
|
||||
;; File
|
||||
(buffer-file-name buffer)
|
||||
;; nil
|
||||
nil
|
||||
;; Position
|
||||
marker))))
|
||||
|
||||
;;;###autoload
|
||||
(defun org-ql-find-in-agenda ()
|
||||
"Call `org-ql-find' on `org-agenda-files'."
|
||||
(interactive)
|
||||
(org-ql-find (org-agenda-files)))
|
||||
|
||||
;;;###autoload
|
||||
(defun org-ql-find-in-org-directory ()
|
||||
"Call `org-ql-find' on files in `org-directory'."
|
||||
(interactive)
|
||||
(org-ql-find (org-ql-search-directories-files)))
|
||||
|
||||
;;;###autoload
|
||||
(defun org-ql-find-path (buffers-files)
|
||||
"Call `org-ql-find' to search outline paths in BUFFERS-FILES.
|
||||
Interactively, search the buffers and files relevant to the
|
||||
current buffer (i.e. in `org-agenda-mode', the value of
|
||||
`org-ql-view-buffers-files' or `org-agenda-contributing-files';
|
||||
in `org-mode', that buffer). With universal prefix, select
|
||||
multiple buffers to search with completion and PROMPT."
|
||||
(interactive (list (org-ql-find--buffers)))
|
||||
(let ((org-ql-default-predicate 'outline-path))
|
||||
(org-ql-find buffers-files)))
|
||||
|
||||
;;;###autoload
|
||||
(cl-defun org-ql-open-link (buffers-files &key query-prefix query-filter
|
||||
(prompt "Open link: "))
|
||||
"Open a link selected with `org-ql-completing-read'.
|
||||
Links found in entries matching the input query are offered as
|
||||
candidates, and the selected one is opened with
|
||||
`org-open-at-point'. Arguments BUFFERS-FILES, QUERY-FILTER,
|
||||
QUERY-PREFIX, and PROMPT are passed to `org-ql-completing-read',
|
||||
which see.
|
||||
|
||||
Interactively, search the buffers and files relevant to the
|
||||
current buffer (i.e. in `org-agenda-mode', the value of
|
||||
`org-ql-view-buffers-files' or `org-agenda-contributing-files';
|
||||
in `org-mode', that buffer). With universal prefix, select
|
||||
multiple buffers to search with completion and PROMPT."
|
||||
(interactive (list (org-ql-find--buffers)))
|
||||
(let* ((marker (org-ql-completing-read buffers-files
|
||||
:query-prefix query-prefix
|
||||
:query-filter query-filter
|
||||
:prompt prompt
|
||||
:action-filter #'identity
|
||||
:action (lambda ()
|
||||
(save-excursion
|
||||
(cl-loop with limit = (org-entry-end-position)
|
||||
while (re-search-forward org-link-any-re limit t)
|
||||
for link = (string-trim (match-string 0))
|
||||
do (progn
|
||||
(set-text-properties 0 (length link) '(face org-link) link)
|
||||
(setf link (org-link-display-format link)))
|
||||
collect (cons link (copy-marker (match-beginning 0))))))
|
||||
:snippet (lambda (&rest _)
|
||||
"")
|
||||
:path (lambda (marker)
|
||||
(org-with-point-at marker
|
||||
(let* ((path (thread-first (org-get-outline-path t t)
|
||||
(org-format-outline-path (window-width) nil " ")
|
||||
(org-split-string " ")))
|
||||
(formatted-path (if org-ql-completing-read-reverse-paths
|
||||
(concat "\\" (string-join (reverse path) "\\"))
|
||||
(concat "/" (string-join path "/")))))
|
||||
formatted-path))))))
|
||||
(org-with-point-at marker
|
||||
(org-open-at-point))))
|
||||
|
||||
;;;; Functions
|
||||
|
||||
(cl-defun org-ql-find--buffers (&key read-buffer-p)
|
||||
"Return buffer or list of buffers to search in.
|
||||
In a mode derived from `org-agenda-mode', return the value of
|
||||
`org-ql-view-buffers-files' or `org-agenda-contributing-files'.
|
||||
In a mode derived from `org-mode', return the current buffer. If
|
||||
READ-BUFFER-P, read a list of buffers in `org-mode' with
|
||||
completion. To be used in `org-ql-find' commands' interactive
|
||||
forms."
|
||||
(if read-buffer-p
|
||||
(mapcar #'get-buffer
|
||||
(completing-read-multiple
|
||||
"Buffers: "
|
||||
(cl-loop for buffer in (buffer-list)
|
||||
when (eq 'org-mode (buffer-local-value 'major-mode buffer))
|
||||
collect (buffer-name buffer))
|
||||
nil t))
|
||||
(cond ((derived-mode-p 'org-agenda-mode) (or org-ql-view-buffers-files
|
||||
org-agenda-contributing-files))
|
||||
((derived-mode-p 'org-mode) (current-buffer))
|
||||
(t (user-error "This is not an Org-related buffer: %S" (current-buffer))))))
|
||||
|
||||
(provide 'org-ql-find)
|
||||
|
||||
;;; org-ql-find.el ends here
|
||||
139
org-ql-search.el
139
org-ql-search.el
|
|
@ -1,7 +1,5 @@
|
|||
;;; org-ql-search.el --- Search commands for org-ql -*- lexical-binding: t; -*-
|
||||
|
||||
;; Copyright (C) 2019-2023 Adam Porter
|
||||
|
||||
;; Author: Adam Porter <adam@alphapapa.net>
|
||||
;; Url: https://github.com/alphapapa/org-ql
|
||||
|
||||
|
|
@ -40,40 +38,10 @@
|
|||
(require 'org-ql)
|
||||
(require 'org-ql-view)
|
||||
|
||||
(declare-function org-ql--normalize-query "org-ql" t t)
|
||||
|
||||
;;;; Compatibility
|
||||
|
||||
(defalias 'org-ql-search--link-heading-search-string
|
||||
(cond ((fboundp 'org-link--normalize-string) #'org-link--normalize-string)
|
||||
((fboundp 'org-link-heading-search-string) #'org-link-heading-search-string)
|
||||
((fboundp 'org-make-org-heading-search-string) #'org-make-org-heading-search-string)
|
||||
(t (error "org-ql: Unable to define alias `org-ql-search--link-heading-search-string'. This may affect links in dynamic blocks. Please report this as a bug"))))
|
||||
|
||||
(defalias 'org-ql-search--org-make-link-string
|
||||
(cond ((fboundp 'org-link-make-string) #'org-link-make-string)
|
||||
((fboundp 'org-make-link-string) #'org-make-link-string)
|
||||
(t (error "org-ql: Unable to define alias `org-ql-search--org-make-link-string'. Please report this as a bug"))))
|
||||
|
||||
(defalias 'org-ql-search--org-link-store-props
|
||||
(cond ((fboundp 'org-link-store-props) #'org-link-store-props)
|
||||
((fboundp 'org-store-link-props) #'org-store-link-props)
|
||||
(t (error "org-ql: Unable to define alias `org-ql-search--org-link-store-props'. Please report this as a bug"))))
|
||||
|
||||
(defalias 'org-ql--org-hide-archived-subtrees
|
||||
(if (version<= "9.6" org-version)
|
||||
'org-fold-hide-archived-subtrees
|
||||
'org-hide-archived-subtrees))
|
||||
|
||||
(defalias 'org-ql--org-show-context
|
||||
(if (version<= "9.6" org-version)
|
||||
'org-fold-show-context
|
||||
'org-show-context))
|
||||
|
||||
;;;; Variables
|
||||
|
||||
(defvar org-ql-block-header nil
|
||||
"Optional string overriding default header in `org-ql-block' agenda blocks.")
|
||||
"An optional string to override the default header in `org-ql-block' agenda blocks.")
|
||||
|
||||
;;;; Customization
|
||||
|
||||
|
|
@ -107,8 +75,8 @@ directories, etc, which would make it slow to list the
|
|||
The tree will show the lines where the query matches, and any
|
||||
other context defined in `org-show-context-detail', which see.
|
||||
|
||||
QUERY is an `org-ql' query in either sexp or string form (see
|
||||
Info node `(org-ql)Queries').
|
||||
QUERY is an `org-ql' query sexp (quoted, since this is a
|
||||
function). BUFFER defaults to the current buffer.
|
||||
|
||||
When KEEP-PREVIOUS is non-nil (interactively, with prefix), the
|
||||
outline is not reset to the overview state before finding
|
||||
|
|
@ -116,7 +84,7 @@ matches, which allows stacking calls to this command.
|
|||
|
||||
Runs `org-occur-hook' after making the sparse tree."
|
||||
;; Code based on `org-occur'.
|
||||
(interactive (list (read-string "Query: ")
|
||||
(interactive (list (read-minibuffer "Query: ")
|
||||
:keep-previous current-prefix-arg))
|
||||
(with-current-buffer buffer
|
||||
(unless keep-previous
|
||||
|
|
@ -124,24 +92,14 @@ Runs `org-occur-hook' after making the sparse tree."
|
|||
;; we remove existing `org-occur' highlights, just in case.
|
||||
(org-remove-occur-highlights nil nil t)
|
||||
(org-overview))
|
||||
(let ((num-results 0)
|
||||
(query (pcase-exhaustive query
|
||||
((and (pred stringp)
|
||||
(rx bos (0+ blank) (or "(" "\"")))
|
||||
;; Read sexp query from string.
|
||||
(read query))
|
||||
((pred stringp)
|
||||
;; Parse string query into sexp query.
|
||||
(org-ql--query-string-to-sexp query))
|
||||
((pred listp)
|
||||
;; Sexp query.
|
||||
query))))
|
||||
(let ((num-results 0))
|
||||
;; FIXME: Accept plain queries as well.
|
||||
(org-ql-select buffer query
|
||||
:action (lambda ()
|
||||
(org-ql--org-show-context 'occur-tree)
|
||||
(org-show-context 'occur-tree)
|
||||
(cl-incf num-results)))
|
||||
(unless org-sparse-tree-open-archived-trees
|
||||
(org-ql--org-hide-archived-subtrees (point-min) (point-max)))
|
||||
(org-hide-archived-subtrees (point-min) (point-max)))
|
||||
(run-hooks 'org-occur-hook)
|
||||
(unless (get-buffer-window buffer)
|
||||
(pop-to-buffer buffer))
|
||||
|
|
@ -186,7 +144,7 @@ necessary."
|
|||
(interactive (list (org-ql-view--complete-buffers-files)
|
||||
(read-string "Query: " (when org-ql-view-query
|
||||
(format "%S" org-ql-view-query)))
|
||||
:narrow (or org-ql-view-narrow (equal current-prefix-arg '(4)))
|
||||
:narrow (or org-ql-view-narrow (eq current-prefix-arg '(4)))
|
||||
:super-groups (org-ql-view--complete-super-groups)
|
||||
:sort (org-ql-view--complete-sort)))
|
||||
;; NOTE: Using `with-temp-buffer' is a hack to work around the fact that `make-local-variable'
|
||||
|
|
@ -200,7 +158,7 @@ necessary."
|
|||
;; Read sexp query.
|
||||
(read query)
|
||||
;; Parse non-sexp query into sexp query.
|
||||
(org-ql--query-string-to-sexp query)))
|
||||
(org-ql--plain-query query)))
|
||||
(list query)))
|
||||
(results (org-ql-select buffers-files query
|
||||
:action 'element-with-markers
|
||||
|
|
@ -222,28 +180,23 @@ necessary."
|
|||
(symbol (symbol-value super-groups))
|
||||
(list super-groups))))
|
||||
(setf strings (org-super-agenda--group-items strings))))
|
||||
(org-ql-view--display :buffer buffer :header header :strings strings))))
|
||||
(org-ql-view--display :buffer buffer :header header
|
||||
:string (s-join "\n" strings)))))
|
||||
|
||||
;;;###autoload
|
||||
(defun org-ql-search-block (args)
|
||||
"Insert items for ARGS into current buffer.
|
||||
Intended to be used as a user-defined function in
|
||||
`org-agenda-custom-commands'. ARGS corresponds to the `match'
|
||||
item in the custom command form. It should be a list of
|
||||
arguments which may be applied to `org-ql-select', which see, but
|
||||
not including its BUFFERS-FILES argument (which is supplied
|
||||
through the Agenda). An additional `:header' keyword argument
|
||||
may be supplied as a string, like that supplied to
|
||||
`org-ql-view--display'.
|
||||
(defun org-ql-search-block (query)
|
||||
"Insert items for QUERY into current buffer.
|
||||
QUERY should be an `org-ql' query form. Intended to be used as a
|
||||
user-defined function in `org-agenda-custom-commands'. QUERY
|
||||
corresponds to the `match' item in the custom command form.
|
||||
|
||||
Like other agenda block commands, it searches files returned by
|
||||
function `org-agenda-files'. Inserts a newline after the block.
|
||||
|
||||
If `org-ql-block-header' is non-nil, it is used as the header
|
||||
string for the block, otherwise the header is formed
|
||||
string for the block, otherwise a the header is formed
|
||||
automatically from the query."
|
||||
(pcase-let ((`(,query . ,(map :header :sort)) args)
|
||||
(narrow-p) (old-beg) (old-end))
|
||||
(let (narrow-p old-beg old-end)
|
||||
(when-let* ((from (pcase org-agenda-restrict
|
||||
('nil (org-agenda-files nil 'ifmode))
|
||||
(_ (prog1 org-agenda-restrict
|
||||
|
|
@ -254,7 +207,7 @@ automatically from the query."
|
|||
(narrow-to-region org-agenda-restrict-begin org-agenda-restrict-end))))))
|
||||
(items (org-ql-select from query
|
||||
:action 'element-with-markers
|
||||
:narrow narrow-p :sort sort)))
|
||||
:narrow narrow-p)))
|
||||
(when narrow-p
|
||||
;; Restore buffer's previous restrictions.
|
||||
(with-current-buffer from
|
||||
|
|
@ -264,25 +217,16 @@ automatically from the query."
|
|||
;; FIXME: `org-agenda--insert-overriding-header' is from an Org version newer than
|
||||
;; I'm using. Should probably declare it as a minimum Org version after upgrading.
|
||||
;; (org-agenda--insert-overriding-header (or org-ql-block-header (org-ql-agenda--header-line-format from query)))
|
||||
;; FIXME: Should we really use `org-ql-block-header' AND `header', or just one of them?
|
||||
(insert (org-add-props (or org-ql-block-header header
|
||||
(org-ql-view--header-line-format
|
||||
(insert (org-add-props (or org-ql-block-header (org-ql-view--header-line-format
|
||||
:buffers-files from :query query))
|
||||
nil 'face 'org-agenda-structure) "\n")
|
||||
;; Calling `org-agenda-finalize' should be unnecessary, because in a "series" agenda,
|
||||
;; `org-agenda-multi' is bound non-nil, in which case `org-agenda-finalize' does nothing.
|
||||
;; But we do call `org-agenda-finalize-entries', which allows `org-super-agenda' to work.
|
||||
;; However, `org-agenda-finalize-entries' sorts entries with `org-entries-lessp', which
|
||||
;; overrides the sorting `org-ql' has already done, so we rebind `org-entries-lessp' to
|
||||
;; prevent it from affecting sort order. (Ideally we would let `org-entries-lessp'
|
||||
;; handle sorting, but that's not possible, because we can't add the `type' text property
|
||||
;; it uses to sort entries, because the design of org-ql and org-agenda is fundamentally
|
||||
;; different. So we have to do the sorting ourselves.)
|
||||
(cl-letf (((symbol-function 'org-entries-lessp) #'ignore))
|
||||
(->> items
|
||||
(-map #'org-ql-view--format-element)
|
||||
org-agenda-finalize-entries
|
||||
insert))
|
||||
insert)
|
||||
(insert "\n"))))
|
||||
|
||||
;;;###autoload
|
||||
|
|
@ -302,7 +246,7 @@ Valid parameters include:
|
|||
form.
|
||||
|
||||
:columns A list of columns, including `heading', `todo',
|
||||
`property',`priority',`deadline',`scheduled',`closed'.
|
||||
`property', `priority', `deadline', `scheduled'.
|
||||
Each column may also be specified as a list with the
|
||||
second element being a header string. For example,
|
||||
to abbreviate the priority column: (priority \"P\").
|
||||
|
|
@ -324,15 +268,12 @@ Valid parameters include:
|
|||
:ts-format Optional format string used to format
|
||||
timestamp-based columns.
|
||||
|
||||
For example, an org-ql dynamic block header could look like
|
||||
this (must be a single line in the Org buffer):
|
||||
For example, an org-ql dynamic block header could look like:
|
||||
|
||||
#+BEGIN: org-ql :query (todo \"UNDERWAY\")
|
||||
:columns (priority todo heading) :sort (priority date)
|
||||
:ts-format \"%Y-%m-%d %H:%M\""
|
||||
#+BEGIN: org-ql :query (todo \"UNDERWAY\") :columns (priority todo heading) :sort (priority date) :ts-format \"%Y-%m-%d %H:%M\""
|
||||
(-let* (((&plist :query :columns :sort :ts-format :take) params)
|
||||
(query (cl-etypecase query
|
||||
(string (org-ql--query-string-to-sexp query))
|
||||
(string (org-ql--plain-query query))
|
||||
(list ;; SAFETY: Query is in sexp form: ask for confirmation, because it could contain arbitrary code.
|
||||
(org-ql--ask-unsafe-query query)
|
||||
query)))
|
||||
|
|
@ -344,9 +285,9 @@ this (must be a single line in the Org buffer):
|
|||
(list (cons 'todo (lambda (element)
|
||||
(org-element-property :todo-keyword element)))
|
||||
(cons 'heading (lambda (element)
|
||||
(let ((normalized-heading
|
||||
(org-ql-search--link-heading-search-string (org-element-property :raw-value element))))
|
||||
(org-ql-search--org-make-link-string normalized-heading (org-link-display-format normalized-heading)))))
|
||||
(org-make-link-string (org-element-property :raw-value element)
|
||||
(org-link-display-format
|
||||
(org-element-property :raw-value element)))))
|
||||
(cons 'priority (lambda (element)
|
||||
(--when-let (org-element-property :priority element)
|
||||
(char-to-string it))))
|
||||
|
|
@ -356,22 +297,18 @@ this (must be a single line in the Org buffer):
|
|||
(cons 'scheduled (lambda (element)
|
||||
(--when-let (org-element-property :scheduled element)
|
||||
(ts-format ts-format (ts-parse-org-element it)))))
|
||||
(cons 'closed (lambda (element)
|
||||
(--when-let (org-element-property :closed element)
|
||||
(ts-format ts-format (ts-parse-org-element it)))))
|
||||
(cons 'property (lambda (element property)
|
||||
(org-element-property (intern (concat ":" (upcase property))) element)))))
|
||||
(elements (org-ql-query :from (current-buffer)
|
||||
:where query
|
||||
:select '(org-ql-view--resolve-element-properties
|
||||
(org-element-headline-parser (line-end-position)))
|
||||
:select '(org-element-headline-parser (line-end-position))
|
||||
:order-by sort)))
|
||||
(when take
|
||||
(setf elements (cl-etypecase take
|
||||
((and integer (satisfies cl-minusp)) (-take-last (abs take) elements))
|
||||
(integer (-take take elements)))))
|
||||
(cl-labels ((format-element (element)
|
||||
(string-join (cl-loop for column in columns
|
||||
(cl-labels ((format-element
|
||||
(element) (string-join (cl-loop for column in columns
|
||||
collect (or (pcase-exhaustive column
|
||||
((pred symbolp)
|
||||
(funcall (alist-get column format-fns) element))
|
||||
|
|
@ -396,19 +333,13 @@ this (must be a single line in the Org buffer):
|
|||
|
||||
;;;; Functions
|
||||
|
||||
(defvar org-ql-search-directories-files-error
|
||||
;; Workaround to silence byte-compiler which thinks having this string in an
|
||||
;; argument's default value form is a too-long docstring.
|
||||
"No DIRECTORIES given, and `org-directory' doesn't exist")
|
||||
|
||||
(cl-defun org-ql-search-directories-files
|
||||
(&key (directories
|
||||
(if (file-exists-p org-directory)
|
||||
(&key (directories (if (file-exists-p org-directory)
|
||||
(list org-directory)
|
||||
(user-error org-ql-search-directories-files-error)))
|
||||
(user-error "Org-ql-search-directories-files: No DIRECTORIES given, and `org-directory' doesn't exist")))
|
||||
(recurse org-ql-search-directories-files-recursive)
|
||||
(regexp org-ql-search-directories-files-regexp))
|
||||
"Return list of matching files in DIRECTORIES.
|
||||
"Return list of matching files in DIRECTORIES, a list of directory paths.
|
||||
When RECURSE is non-nil, recurse into subdirectories. When
|
||||
REGEXP is non-nil, only return files that match REGEXP."
|
||||
(let ((files (->> directories
|
||||
|
|
|
|||
192
org-ql-view.el
192
org-ql-view.el
|
|
@ -1,7 +1,5 @@
|
|||
;;; org-ql-view.el --- Agenda-like view based on org-ql -*- lexical-binding: t; -*-
|
||||
|
||||
;; Copyright (C) 2019-2023 Adam Porter
|
||||
|
||||
;; Author: Adam Porter <adam@alphapapa.net>
|
||||
;; Url: https://github.com/alphapapa/org-ql
|
||||
|
||||
|
|
@ -42,10 +40,6 @@
|
|||
|
||||
(require 'org-ql)
|
||||
|
||||
(declare-function org-ql-search "org-ql-search" t)
|
||||
(declare-function org-ql-search--org-link-store-props "org-ql-search" t)
|
||||
(declare-function org-ql--normalize-query "org-ql" t t)
|
||||
|
||||
(require 'dash)
|
||||
(require 's)
|
||||
(require 'org-super-agenda)
|
||||
|
|
@ -57,18 +51,7 @@
|
|||
(defface org-ql-view-due-date
|
||||
'((t (:slant italic :weight bold)))
|
||||
"Face for due dates in `org-ql-view' views."
|
||||
:group 'org-ql-view)
|
||||
|
||||
(defface org-ql-view-query nil
|
||||
"View query in header line.
|
||||
This face is added to the formatted query after font-lock faces
|
||||
are applied to it. It may be used, e.g. to reduce the height so
|
||||
more of it is visible."
|
||||
:group 'org-ql-view)
|
||||
|
||||
(defface org-ql-view-title '((t :weight bold))
|
||||
"View title in header line."
|
||||
:group 'org-ql-view)
|
||||
:group 'org-ql)
|
||||
|
||||
;;;; Variables
|
||||
|
||||
|
|
@ -144,13 +127,13 @@ See info node `(elisp)Cyclic Window Ordering'."
|
|||
(deadline auto)
|
||||
(scheduled :to today)
|
||||
(ts-active :on today)))
|
||||
:sort '(todo priority date)
|
||||
:sort '(date priority todo)
|
||||
:super-groups 'org-super-agenda-groups
|
||||
:title "Agenda-like"))
|
||||
(cons "Overview: NEXT tasks"
|
||||
(list :buffers-files #'org-agenda-files
|
||||
:query '(todo "NEXT")
|
||||
:sort '(date priority)
|
||||
:sort '(priority date)
|
||||
:super-groups 'org-super-agenda-groups
|
||||
:title "Overview: NEXT tasks"))
|
||||
(cons "Calendar: Today"
|
||||
|
|
@ -201,7 +184,7 @@ See info node `(elisp)Cyclic Window Ordering'."
|
|||
(ancestors (done)))
|
||||
:title (propertize "Review: Dangling tasks"
|
||||
'help-echo "Tasks whose ancestor is done")
|
||||
:sort '(todo priority date)
|
||||
:sort '(date priority todo)
|
||||
:super-groups '((:auto-parent t))))
|
||||
(cons (propertize "Review: Stale tasks"
|
||||
'help-echo "Tasks without a timestamp in the past 2 weeks")
|
||||
|
|
@ -210,7 +193,7 @@ See info node `(elisp)Cyclic Window Ordering'."
|
|||
(not (ts :from -14)))
|
||||
:title (propertize "Review: Stale tasks"
|
||||
'help-echo "Tasks without a timestamp in the past 2 weeks")
|
||||
:sort '(todo priority date)
|
||||
:sort '(date priority todo)
|
||||
:super-groups '((:auto-parent t))))
|
||||
(cons (propertize "Review: Stuck projects"
|
||||
'help-echo "Tasks with sub-tasks but no NEXT sub-tasks")
|
||||
|
|
@ -220,7 +203,7 @@ See info node `(elisp)Cyclic Window Ordering'."
|
|||
(not (descendants (todo "NEXT"))))
|
||||
:title (propertize "Review: Stuck projects"
|
||||
'help-echo "Tasks with sub-tasks but no NEXT sub-tasks")
|
||||
:sort '(date priority)
|
||||
:sort '(priority date)
|
||||
:super-groups 'org-super-agenda-groups)))
|
||||
"Alist of `org-ql-view' commands."
|
||||
:type
|
||||
|
|
@ -242,19 +225,12 @@ See info node `(elisp)Cyclic Window Ordering'."
|
|||
(const todo)
|
||||
(const priority)
|
||||
(const random)
|
||||
(const reverse)
|
||||
(function :tag "Custom comparator"))))
|
||||
((const :tag "Group-by" :super-groups)
|
||||
(choice (variable-item :tag "Default org-super-agenda groups" org-super-agenda-groups)
|
||||
(sexp :tag "org-super-agenda grouping expression")
|
||||
(variable :tag "Variable holding org-super-agenda grouping expression"))))))))
|
||||
|
||||
(defcustom org-ql-view-relative-deadline-prefix "due "
|
||||
;; TODO(v0.9): Add one for scheduled, too.
|
||||
"Prefix for relative deadlines.
|
||||
Relative deadlines are, e.g. \"in 5d\", \"5d ago\"."
|
||||
:type 'string)
|
||||
|
||||
;;;; Commands
|
||||
|
||||
;;;###autoload
|
||||
|
|
@ -301,13 +277,12 @@ TYPE may be `ts', `ts-active', `ts-inactive', `clocked', or
|
|||
`(,type :from ,(- num-days) :to 0)))))
|
||||
(org-ql-search files query
|
||||
:title "Recent items"
|
||||
:sort '(todo priority date)
|
||||
:sort '(date priority todo)
|
||||
:super-groups groups)))
|
||||
|
||||
;;;###autoload
|
||||
(cl-defun org-ql-view-sidebar (&key (slot org-ql-view-list-slot))
|
||||
"Show `org-ql-view' view list sidebar.
|
||||
SLOT is passed to `display-buffer-in-side-window', which see."
|
||||
"Show `org-ql-view' view list sidebar."
|
||||
;; TODO: Update sidebar when `org-ql-views' changes.
|
||||
(interactive)
|
||||
(select-window
|
||||
|
|
@ -322,10 +297,10 @@ SLOT is passed to `display-buffer-in-side-window', which see."
|
|||
(defun org-ql-view-switch ()
|
||||
"Switch to view at point."
|
||||
(interactive)
|
||||
(let ((key (buffer-substring-no-properties (pos-bol) (pos-eol))))
|
||||
(let ((key (buffer-substring-no-properties (point-at-bol) (point-at-eol))))
|
||||
(unless (string-empty-p key)
|
||||
(ov-clear :org-ql-view-selected)
|
||||
(ov (pos-bol) (1+ (pos-eol)) :org-ql-view-selected t
|
||||
(ov (point-at-bol) (1+ (point-at-eol)) :org-ql-view-selected t
|
||||
'face '(:weight bold :inherit highlight))
|
||||
(org-ql-view key))))
|
||||
|
||||
|
|
@ -372,8 +347,7 @@ update search arguments."
|
|||
(yes-or-no-p (format "Overwrite view \"%s\"?" name)))
|
||||
(setf (map-elt org-ql-views name nil #'equal) plist)
|
||||
(customize-set-variable 'org-ql-views org-ql-views)
|
||||
(customize-mark-to-save 'org-ql-views)
|
||||
(custom-save-all))))
|
||||
(customize-mark-to-save 'org-ql-views))))
|
||||
|
||||
(defun org-ql-view-delete ()
|
||||
"Delete current view (with confirmation)."
|
||||
|
|
@ -383,13 +357,12 @@ update search arguments."
|
|||
(--remove (equal (car it) org-ql-view-title)
|
||||
org-ql-views))
|
||||
(customize-set-variable 'org-ql-views org-ql-views)
|
||||
(customize-mark-to-save 'org-ql-views)
|
||||
(custom-save-all)))
|
||||
(customize-mark-to-save 'org-ql-views)))
|
||||
|
||||
(defun org-ql-view-customize ()
|
||||
"Customize view at point in `org-ql-view-sidebar' buffer."
|
||||
(interactive)
|
||||
(let ((key (buffer-substring-no-properties (pos-bol) (pos-eol))))
|
||||
(let ((key (buffer-substring-no-properties (point-at-bol) (point-at-eol))))
|
||||
(customize-option 'org-ql-views)
|
||||
(search-forward (concat "Name: " key))))
|
||||
|
||||
|
|
@ -426,7 +399,7 @@ update search arguments."
|
|||
|
||||
(defvar bookmark-make-record-function)
|
||||
|
||||
(cl-defun org-ql-view--display (&key (buffer org-ql-view-buffer) header strings)
|
||||
(cl-defun org-ql-view--display (&key (buffer org-ql-view-buffer) header string)
|
||||
"Display STRING in `org-ql-view' BUFFER.
|
||||
|
||||
BUFFER may be a buffer, or a string naming a buffer, which is
|
||||
|
|
@ -464,9 +437,7 @@ subsequent refreshing of the buffer: `org-ql-view-buffers-files',
|
|||
;; Clear buffer, insert entries, etc.
|
||||
(let ((inhibit-read-only t))
|
||||
(erase-buffer)
|
||||
(dolist (string strings)
|
||||
(insert string "\n"))
|
||||
(insert "\n")
|
||||
(insert string "\n")
|
||||
(pop-to-buffer (current-buffer) org-ql-view-display-buffer-action)
|
||||
(org-agenda-finalize)
|
||||
(goto-char (point-min))))))
|
||||
|
|
@ -476,8 +447,7 @@ subsequent refreshing of the buffer: `org-ql-view-buffers-files',
|
|||
If TITLE, prepend it to the header."
|
||||
(let* ((title (if title
|
||||
(concat (propertize "View:" 'face 'transient-argument)
|
||||
(propertize title 'face 'org-ql-view-title)
|
||||
" ")
|
||||
title " ")
|
||||
""))
|
||||
(query-formatted (when query
|
||||
(org-ql-view--format-query query)))
|
||||
|
|
@ -496,7 +466,6 @@ If TITLE, prepend it to the header."
|
|||
(org-ql-view--font-lock-string 'emacs-lisp-mode)
|
||||
(s-truncate available-width))
|
||||
'help-echo buffers-files-formatted))))
|
||||
(add-face-text-property 0 (length query-propertized) 'org-ql-view-query 'append query-propertized)
|
||||
(concat title
|
||||
(when query (propertize "Query:" 'face 'transient-argument))
|
||||
(when query query-propertized)
|
||||
|
|
@ -528,22 +497,6 @@ with human-readable strings."
|
|||
(font-lock-ensure)
|
||||
(buffer-string))))
|
||||
|
||||
(defun org-ql-view--font-lock-as-org (s)
|
||||
"Return string S font-locked as in `org-mode'."
|
||||
;; This works like `org-fontify-like-in-org-mode', but uses a single
|
||||
;; buffer instead of a new one every time.
|
||||
;; TODO(C): Submit these improvements upstream.
|
||||
(let ((buffer (or (get-buffer " *org-ql-view--font-lock-as-org*")
|
||||
(with-current-buffer (get-buffer-create " *org-ql-view--font-lock-as-org*")
|
||||
(buffer-disable-undo)
|
||||
(org-mode)
|
||||
(current-buffer)))))
|
||||
(with-current-buffer buffer
|
||||
(insert s)
|
||||
(font-lock-ensure)
|
||||
(prog1 (buffer-string)
|
||||
(erase-buffer)))))
|
||||
|
||||
(defun org-ql-view--buffer (&optional name)
|
||||
"Return `org-ql-view' buffer, creating it if necessary.
|
||||
If NAME is non-nil, return buffer by that name instead of using
|
||||
|
|
@ -573,20 +526,18 @@ dates in the past, and negative for dates in the future."
|
|||
|
||||
(defun org-ql-view-bookmark-make-record ()
|
||||
"Return a bookmark record for the current Org QL View buffer."
|
||||
(cl-labels ((file-nameize (b-f)
|
||||
(abbreviate-file-name
|
||||
(cl-typecase b-f
|
||||
(cl-labels ((file-nameize
|
||||
(b-f) (cl-typecase b-f
|
||||
(string b-f)
|
||||
(buffer (or (buffer-file-name b-f)
|
||||
(when (buffer-base-buffer b-f)
|
||||
(buffer-file-name (buffer-base-buffer b-f)))))
|
||||
(t (user-error "Only file-backed buffers can be bookmarked by Org QL View: %s" b-f))))))
|
||||
(t (user-error "Only file-backed buffers can be bookmarked by Org QL View: %s" b-f)))))
|
||||
(-let* ((plist (org-ql-view--plist (current-buffer)))
|
||||
((&plist :buffers-files) plist))
|
||||
;; Replace buffers with their filenames, and signal error if any are not file-backed.
|
||||
(setf plist (plist-put plist :buffers-files
|
||||
(cl-etypecase buffers-files
|
||||
(symbol buffers-files)
|
||||
(string buffers-files)
|
||||
(buffer (file-nameize buffers-files))
|
||||
(list (mapcar #'file-nameize buffers-files)))))
|
||||
|
|
@ -646,7 +597,6 @@ The optional, second argument is temporarily _IGNORED for
|
|||
purposes of compatibility with changes in Org 9.4."
|
||||
(require 'url-parse)
|
||||
(require 'url-util)
|
||||
(declare-function url-path-and-query "url-parse")
|
||||
(when (version<= "9.3" (org-version))
|
||||
;; Org 9.3+ makes a backward-incompatible change to link escaping.
|
||||
;; I don't think it would be a good idea to try to guess whether
|
||||
|
|
@ -661,7 +611,7 @@ purposes of compatibility with changes in Org 9.4."
|
|||
(query (url-unhex-string query))
|
||||
(params (when params (url-parse-query-string params)))
|
||||
;; `url-parse-query-string' returns "improper" alists, which makes this awkward.
|
||||
(sort (when-let* ((stored-string (car (alist-get "sort" params nil nil #'string=)))
|
||||
(sort (when-let* ((stored-string (alist-get "sort" params nil nil #'string=))
|
||||
(read-value (read stored-string)))
|
||||
;; Ensure the value is either a symbol or list of symbols (which excludes lambdas).
|
||||
(unless (or (symbolp read-value) (cl-every #'symbolp read-value))
|
||||
|
|
@ -669,19 +619,17 @@ purposes of compatibility with changes in Org 9.4."
|
|||
read-value))
|
||||
read-value))
|
||||
(org-super-agenda-allow-unsafe-groups nil) ; Disallow unsafe group selectors.
|
||||
(groups (--when-let (car (alist-get "super-groups" params nil nil #'string=))
|
||||
(groups (--when-let (alist-get "super-groups" params nil nil #'string=)
|
||||
(read it)))
|
||||
(title (--when-let (car (alist-get "title" params nil nil #'string=))
|
||||
(title (--when-let (alist-get "title" params nil nil #'string=)
|
||||
(read it)))
|
||||
(buffers-files (--if-let (car (alist-get "buffers-files" params nil nil #'string=))
|
||||
(buffers-files (--if-let (alist-get "buffers-files" params nil nil #'string=)
|
||||
(org-ql-view--expand-buffers-files (read it))
|
||||
(current-buffer))))
|
||||
(unless (or (bufferp buffers-files)
|
||||
(stringp buffers-files)
|
||||
(cl-every #'stringp buffers-files))
|
||||
(error "CAUTION: Link not opened because unsafe buffers-files parameter detected: %s" buffers-files))
|
||||
(unless (or (stringp title) (null title))
|
||||
(error "CAUTION: Link not opened because unsafe title parameter detected: %S" title))
|
||||
(when (or (listp query)
|
||||
(string-match (rx bol (0+ space) "(") query))
|
||||
;; SAFETY: Query is in sexp form: ask for confirmation, because it could contain arbitrary code.
|
||||
|
|
@ -705,21 +653,19 @@ When opened, the link searches the buffer it's opened from."
|
|||
nil t nil nil "file link is in")
|
||||
("file link is in" nil)
|
||||
("files currently searched" buffers-files)))
|
||||
(strings-or-file-buffers-p (thing)
|
||||
(cl-etypecase thing
|
||||
(strings-or-file-buffers-p
|
||||
(thing) (cl-etypecase thing
|
||||
(list (cl-every #'strings-or-file-buffers-p thing))
|
||||
(string thing)
|
||||
(buffer (or (buffer-file-name thing)
|
||||
;; TODO: Should indirect buffers be allowed? Maybe not, since their
|
||||
;; narrowing isn't preserved. On the other hand, it's possible to
|
||||
;; accidentally make a search view for an indirect buffer that's
|
||||
;; since been widened, and forcing the user to manually change that
|
||||
;; would be awkward, and trying to communicate the problem would be
|
||||
;; difficult, so maybe it's okay to allow it.
|
||||
;; TODO: Should indirect buffers be allowed? Maybe not, since their narrowing isn't preserved.
|
||||
;; On the other hand, it's possible to accidentally make a search view for an indirect buffer
|
||||
;; that's since been widened, and forcing the user to manually change that would be awkward,
|
||||
;; and trying to communicate the problem would be difficult, so maybe it's okay to allow it.
|
||||
(when (buffer-base-buffer thing)
|
||||
(buffer-file-name (buffer-base-buffer thing))))))))
|
||||
(unless (strings-or-file-buffers-p org-ql-view-buffers-files)
|
||||
(user-error "%s" "Views that search non-file-backed buffers can't be linked to"))
|
||||
(user-error "Views that search non-file-backed buffers can't be linked to"))
|
||||
(let* ((query-string (--if-let (org-ql--query-sexp-to-string org-ql-view-query)
|
||||
it (org-ql-view--format-query org-ql-view-query)))
|
||||
(buffers-files (prompt-for (org-ql-view--contract-buffers-files org-ql-view-buffers-files)))
|
||||
|
|
@ -735,7 +681,8 @@ When opened, the link searches the buffer it's opened from."
|
|||
"?" (url-build-query-string (delete nil params))))
|
||||
(url (url-recreate-url (url-parse-make-urlobj "org-ql-search" nil nil nil nil
|
||||
filename))))
|
||||
(org-ql-search--org-link-store-props
|
||||
;; FIXME: "Warning: ‘org-store-link-props’ is an obsolete function (as of Org 9.3); use ‘org-link-store-props’ instead"
|
||||
(org-store-link-props
|
||||
:type "org-ql-search"
|
||||
:link url
|
||||
:description (concat "org-ql-search: " org-ql-view-title))))
|
||||
|
|
@ -750,8 +697,6 @@ When opened, the link searches the buffer it's opened from."
|
|||
;; Transient manual is written very well, not everything is covered in
|
||||
;; it, so I'm having to try to imitate examples from `magit-transient'.
|
||||
|
||||
(require 'eieio-core)
|
||||
|
||||
(require 'transient)
|
||||
|
||||
(defclass org-ql-view--variable (transient-variable)
|
||||
|
|
@ -766,7 +711,7 @@ When opened, the link searches the buffer it's opened from."
|
|||
(unless (or value transient--prefix)
|
||||
(message "Unset %s" variable))))
|
||||
|
||||
(transient-define-prefix org-ql-view-dispatch ()
|
||||
(define-transient-command org-ql-view-dispatch ()
|
||||
"Show Org QL View dispatcher."
|
||||
[["Edit"
|
||||
("t" org-ql-view--transient-title)
|
||||
|
|
@ -801,7 +746,7 @@ When opened, the link searches the buffer it's opened from."
|
|||
org-ql-view--format-query
|
||||
(org-ql-view--font-lock-string 'emacs-lisp-mode)))))
|
||||
|
||||
(transient-define-infix org-ql-view--transient-title ()
|
||||
(define-infix-command org-ql-view--transient-title ()
|
||||
;; TODO: Add an asterisk or something when the view has been modified but not saved.
|
||||
:description (lambda () (org-ql-view--format-transient-key-value "Title" org-ql-view-title))
|
||||
:class 'org-ql-view--variable
|
||||
|
|
@ -814,7 +759,7 @@ When opened, the link searches the buffer it's opened from."
|
|||
(format "%s" org-ql-view-title))
|
||||
history)))
|
||||
|
||||
(transient-define-infix org-ql-view--transient-query ()
|
||||
(define-infix-command org-ql-view--transient-query ()
|
||||
:description (lambda () (org-ql-view--format-transient-lisp-argument "Query" org-ql-view-query))
|
||||
:class 'org-ql-view--variable
|
||||
:argument ""
|
||||
|
|
@ -830,9 +775,9 @@ When opened, the link searches the buffer it's opened from."
|
|||
;; Read sexp query.
|
||||
(read query)
|
||||
;; Parse non-sexp query into sexp query.
|
||||
(org-ql--query-string-to-sexp query)))))
|
||||
(org-ql--plain-query query)))))
|
||||
|
||||
(transient-define-infix org-ql-view--transient-in ()
|
||||
(define-infix-command org-ql-view--transient-in ()
|
||||
:description (lambda () (org-ql-view--format-transient-lisp-argument "In buffers/files" org-ql-view-buffers-files))
|
||||
:class 'org-ql-view--variable
|
||||
:argument ""
|
||||
|
|
@ -843,7 +788,7 @@ When opened, the link searches the buffer it's opened from."
|
|||
;; argument, but it gives the same result.
|
||||
(org-ql-view--complete-buffers-files)))
|
||||
|
||||
(transient-define-infix org-ql-view--transient-super-groups ()
|
||||
(define-infix-command org-ql-view--transient-super-groups ()
|
||||
:description (lambda ()
|
||||
(org-ql-view--format-transient-lisp-argument "Group by" org-ql-view-super-groups))
|
||||
:class 'org-ql-view--variable
|
||||
|
|
@ -854,7 +799,7 @@ When opened, the link searches the buffer it's opened from."
|
|||
;; FIXME: Figure out how to integrate initial-input and history.
|
||||
(org-ql-view--complete-super-groups)))
|
||||
|
||||
(transient-define-infix org-ql-view--transient-sort ()
|
||||
(define-infix-command org-ql-view--transient-sort ()
|
||||
:description
|
||||
(lambda ()
|
||||
(org-ql-view--format-transient-lisp-argument "Sort by" (or org-ql-view-sort 'buffer-order)))
|
||||
|
|
@ -868,20 +813,6 @@ When opened, the link searches the buffer it's opened from."
|
|||
|
||||
;;;; Faces/properties
|
||||
|
||||
(defalias 'org-ql-view--resolve-element-properties
|
||||
;; It would be preferable to define this as an inline function, but
|
||||
;; that would mean that users would have to recompile org-ql when
|
||||
;; upgrading to Org 9.7 or else get weird errors.
|
||||
;; TODO(someday): Define `org-ql-view--resolve-element-properties' as inline.
|
||||
(if (version<= "9.7" org-version)
|
||||
(lambda (node)
|
||||
"Resolve NODE's properties using `org-element-properties-resolve'."
|
||||
;; Silence warnings about `org-element-properties-resolve'
|
||||
;; being unresolved on earlier Org versions.
|
||||
(with-no-warnings
|
||||
(org-element-properties-resolve node 'force-undefer)))
|
||||
#'identity))
|
||||
|
||||
(defun org-ql-view--format-element (element)
|
||||
;; This essentially needs to do what `org-agenda-format-item' does,
|
||||
;; which is a lot. We are a long way from that, but it's a start.
|
||||
|
|
@ -891,7 +822,6 @@ returned by `org-element-parse-buffer'. If ELEMENT is nil,
|
|||
return an empty string."
|
||||
(if (not element)
|
||||
""
|
||||
(setf element (org-ql-view--resolve-element-properties element))
|
||||
(let* ((properties (cadr element))
|
||||
;; Remove the :parent property, which so bloats the size of
|
||||
;; the properties list that it makes it essentially
|
||||
|
|
@ -913,15 +843,10 @@ return an empty string."
|
|||
;; Adding the relative due date property should probably be done explicitly and separately
|
||||
;; (which would also make it easier to do it independently of faces, etc).
|
||||
(title (--> (org-ql-view--add-faces element)
|
||||
(org-element-property :raw-value it)))
|
||||
;; TODO(B): Needs refactoring. A function like `org-ql-view--add-faces'
|
||||
;; should return a list of faces to be added.
|
||||
(title-faces (get-text-property 0 'face title))
|
||||
(title (org-ql-view--font-lock-as-org title))
|
||||
(_ (add-face-text-property 0 (length title) title-faces t title))
|
||||
(org-element-property :raw-value it)
|
||||
(org-link-display-format it)))
|
||||
(todo-keyword (-some--> (org-element-property :todo-keyword element)
|
||||
(org-ql-view--add-todo-face
|
||||
(substring-no-properties it))))
|
||||
(org-ql-view--add-todo-face it)))
|
||||
(tag-list (if org-use-tag-inheritance
|
||||
;; MAYBE: Use our own variable instead of `org-use-tag-inheritance'.
|
||||
(if-let ((marker (or (org-element-property :org-hd-marker element)
|
||||
|
|
@ -934,7 +859,8 @@ return an empty string."
|
|||
(not type))
|
||||
append type)))
|
||||
;; No marker found
|
||||
(display-warning 'org-ql (format "No marker found for item: %s" title))
|
||||
;; TODO: Use `display-warning' with `org-ql' as the type.
|
||||
(warn "No marker found for item: %s" title)
|
||||
(org-element-property :tags element))
|
||||
(org-element-property :tags element)))
|
||||
(tag-string (when tag-list
|
||||
|
|
@ -942,21 +868,12 @@ return an empty string."
|
|||
(s-join ":" it)
|
||||
(s-wrap it ":")
|
||||
(org-add-props it nil 'face 'org-tag))))
|
||||
(category (or (org-element-property :CATEGORY element)
|
||||
(when-let ((marker (or (org-element-property :org-hd-marker element)
|
||||
(org-element-property :org-marker element))))
|
||||
(org-with-point-at marker
|
||||
(or (org-get-category)
|
||||
(when buffer-file-name
|
||||
(file-name-sans-extension
|
||||
(file-name-nondirectory buffer-file-name))))))
|
||||
""))
|
||||
;; (category (org-element-property :category element))
|
||||
(priority-string (-some->> (org-element-property :priority element)
|
||||
(char-to-string)
|
||||
(format "[#%s]")
|
||||
(org-ql-view--add-priority-face)))
|
||||
(habit-property (org-with-point-at (or (org-element-property :org-hd-marker element)
|
||||
(org-element-property :org-marker element))
|
||||
(habit-property (org-with-point-at (org-element-property :begin element)
|
||||
(when (org-is-habit-p)
|
||||
(org-habit-parse-todo))))
|
||||
(due-string (pcase (org-element-property :relative-due-date element)
|
||||
|
|
@ -970,7 +887,6 @@ return an empty string."
|
|||
(concat " " it)
|
||||
(org-add-props it properties
|
||||
'org-agenda-type 'search
|
||||
'org-category category
|
||||
'todo-state todo-keyword
|
||||
'tags tag-list
|
||||
'org-habit-p habit-property)))))
|
||||
|
|
@ -1056,9 +972,7 @@ property."
|
|||
(deadline-day-number (org-time-string-to-absolute
|
||||
(org-element-timestamp-interpreter deadline-date 'ignore)))
|
||||
(difference-days (- today-day-number deadline-day-number))
|
||||
(relative-due-date (org-add-props
|
||||
(concat org-ql-view-relative-deadline-prefix
|
||||
(org-ql-view--format-relative-date difference-days)) nil
|
||||
(relative-due-date (org-add-props (org-ql-view--format-relative-date difference-days) nil
|
||||
'help-echo (org-element-property :raw-value deadline-date)))
|
||||
;; FIXME: Unused for now: (todo-keyword (org-element-property :todo-keyword element))
|
||||
;; FIXME: Unused for now: (done-p (member todo-keyword org-done-keywords))
|
||||
|
|
@ -1092,8 +1006,6 @@ property."
|
|||
;; These functions are somewhat regrettable because of the need to keep them
|
||||
;; in sync, but it seems worth it to provide users with the flexibility.
|
||||
|
||||
(declare-function org-ql-search-directories-files "org-ql-search" t)
|
||||
|
||||
(defun org-ql-view--contract-buffers-files (buffers-files)
|
||||
"Return BUFFERS-FILES in its \"contracted\" form.
|
||||
The contracted form is \"org-agenda-files\" if BUFFERS-FILES
|
||||
|
|
@ -1103,8 +1015,8 @@ the variable), \"org-directory\" if it matches the value of
|
|||
current buffer. Otherwise BUFFERS-FILES is returned unchanged."
|
||||
;; Used in `org-ql-view--complete-buffers-files' and
|
||||
;; `org-ql-view--header-line-format'.
|
||||
(cl-labels ((expand-files (list)
|
||||
(--map (cl-typecase it
|
||||
(cl-labels ((expand-files
|
||||
(list) (--map (cl-typecase it
|
||||
(string (expand-file-name it))
|
||||
(otherwise it))
|
||||
list)))
|
||||
|
|
@ -1129,8 +1041,8 @@ current buffer. Otherwise BUFFERS-FILES is returned unchanged."
|
|||
|
||||
(defun org-ql-view--complete-buffers-files ()
|
||||
"Return value for `org-ql-view-buffers-files' using completion."
|
||||
(cl-labels ((initial-input ()
|
||||
(when org-ql-view-buffers-files
|
||||
(cl-labels ((initial-input
|
||||
() (when org-ql-view-buffers-files
|
||||
(org-ql-view--contract-buffers-files
|
||||
org-ql-view-buffers-files))))
|
||||
(if (and org-ql-view-buffers-files
|
||||
|
|
@ -1186,8 +1098,6 @@ The counterpart to `org-ql-view--contract-buffers-files'."
|
|||
"date"
|
||||
"deadline"
|
||||
"priority"
|
||||
"random"
|
||||
"reverse"
|
||||
"scheduled"
|
||||
"todo")
|
||||
nil nil (when org-ql-view-sort
|
||||
|
|
|
|||
1430
org-ql.info
1430
org-ql.info
File diff suppressed because it is too large
Load diff
|
|
@ -1,10 +0,0 @@
|
|||
* Alpha
|
||||
|
||||
Let us link to: [[id:74d357ac-fb9c-40d1-a63f-eca8a227321d][Bravo [a phrase in brackets]]].
|
||||
|
||||
* Bravo [a phrase in brackets]
|
||||
:PROPERTIES:
|
||||
:ID: 74d357ac-fb9c-40d1-a63f-eca8a227321d
|
||||
:END:
|
||||
|
||||
* Charlie
|
||||
|
|
@ -1,29 +0,0 @@
|
|||
#+title: org-ql test data for ~src~ predicate
|
||||
|
||||
* Alpha
|
||||
|
||||
#+begin_src elisp
|
||||
(message "foo")
|
||||
#+end_src
|
||||
|
||||
#+begin_src python
|
||||
print("foo")
|
||||
#+end_src
|
||||
|
||||
#+begin_src js
|
||||
console.log("foo")
|
||||
#+end_src
|
||||
|
||||
* Bravo
|
||||
|
||||
#+begin_src elisp
|
||||
(message "bar")
|
||||
#+end_src
|
||||
|
||||
#+begin_src python
|
||||
print("bar")
|
||||
#+end_src
|
||||
|
||||
* Charlie
|
||||
|
||||
This entry has no source block.
|
||||
|
|
@ -1,29 +0,0 @@
|
|||
#+title: Timestamp-specific tests
|
||||
|
||||
/Timestamps in this file are active ones./
|
||||
|
||||
* Single-timestamp ranges
|
||||
|
||||
** Single-timestamp, without repeater
|
||||
<2024-06-25 Tue 08:00-09:00>
|
||||
|
||||
** Single-timestamp, with repeater (deadline)
|
||||
DEADLINE: <2024-06-25 Tue 08:00-09:00 ++7d>
|
||||
|
||||
* Multi-timestamp ranges
|
||||
|
||||
/Not sure that it would make sense to use repeaters for this kind of range./
|
||||
|
||||
** Multi-timestamp, without repeater
|
||||
<2024-06-25 Tue 08:00>--<2024-06-26 Wed 08:00>
|
||||
|
||||
* Day-of-week abbreviations
|
||||
|
||||
** French
|
||||
|
||||
<2024-07-12 ven.>
|
||||
|
||||
* Canary
|
||||
|
||||
/This entry should never be matched./
|
||||
|
||||
|
|
@ -37,13 +37,13 @@ DEADLINE: <2017-08-27 Sun -2m>
|
|||
Just waiting on that callback from NASA...
|
||||
|
||||
** TODO Practice leaping tall buildings in a single bound :personal:
|
||||
SCHEDULED: <2017-07-05 Wed .+2d/3d>
|
||||
SCHEDULED: <2017-07-05 Wed +2d>
|
||||
:PROPERTIES:
|
||||
:STYLE: habit
|
||||
:END:
|
||||
|
||||
** TODO [#B] Renew membership in supervillain club
|
||||
DEADLINE: <2017-07-10 Mon 23:59 -1w>
|
||||
DEADLINE: <2017-07-10 Mon -1w>
|
||||
|
||||
** DONE [#B] Learn universal sign language
|
||||
CLOSED: [2017-07-05 Wed 03:02]
|
||||
|
|
@ -89,7 +89,7 @@ Gotta buy one first, though. [[https://example.com/][This one]] looks suitable.
|
|||
:END:
|
||||
|
||||
** CHECK /r/emacs :website:Emacs:
|
||||
DEADLINE: <2017-07-05 Wed .+1w>
|
||||
DEADLINE: <2017-07-05 Wed +1w>
|
||||
|
||||
+ [[http://reddit.com/r/emacs][Link to /r/emacs]]
|
||||
|
||||
|
|
|
|||
1143
tests/test-org-ql.el
1143
tests/test-org-ql.el
File diff suppressed because it is too large
Load diff
Loading…
Add table
Add a link
Reference in a new issue