Compare commits
No commits in common. "master" and "meta/logo" have entirely different histories.
63 changed files with 0 additions and 16655 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
|
||||
|
||||
81
.github/workflows/test.yml
vendored
81
.github/workflows/test.yml
vendored
|
|
@ -1,81 +0,0 @@
|
|||
# * test.yml --- Test Emacs packages using makem.sh on GitHub Actions
|
||||
|
||||
# URL: https://github.com/alphapapa/makem.sh
|
||||
# Version: 0.3
|
||||
|
||||
# * Commentary:
|
||||
|
||||
# Based on Steve Purcell's examples at
|
||||
# <https://github.com/purcell/setup-emacs/blob/master/.github/workflows/test.yml>,
|
||||
# <https://github.com/purcell/package-lint/blob/master/.github/workflows/test.yml>.
|
||||
|
||||
# * License:
|
||||
|
||||
# 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/>.
|
||||
|
||||
# * Code:
|
||||
|
||||
name: "CI"
|
||||
on:
|
||||
pull_request:
|
||||
push:
|
||||
# Comment out this section to enable testing of all branches.
|
||||
# branches:
|
||||
# - master
|
||||
|
||||
jobs:
|
||||
build:
|
||||
runs-on: ubuntu-latest
|
||||
strategy:
|
||||
fail-fast: false
|
||||
matrix:
|
||||
emacs_version:
|
||||
- 27.1
|
||||
- 27.2
|
||||
- 28.1
|
||||
- 28.2
|
||||
- 29.1
|
||||
- 29.2
|
||||
- 29.3
|
||||
- 29.4
|
||||
- snapshot
|
||||
steps:
|
||||
- uses: purcell/setup-emacs@master
|
||||
with:
|
||||
version: ${{ matrix.emacs_version }}
|
||||
|
||||
- uses: actions/checkout@v2
|
||||
|
||||
- name: Initialize sandbox
|
||||
run: |
|
||||
SANDBOX_DIR=$(mktemp -d) || exit 1
|
||||
echo "SANDBOX_DIR=$SANDBOX_DIR" >> $GITHUB_ENV
|
||||
./makem.sh -vv --sandbox=$SANDBOX_DIR --install-deps --install-linters
|
||||
|
||||
# The "all" rule is not used, because it treats compilation warnings
|
||||
# as failures, so linting and testing are run as separate steps.
|
||||
|
||||
- name: Lint
|
||||
# NOTE: Uncomment this line to treat lint failures as passing
|
||||
# so the job doesn't show failure.
|
||||
continue-on-error: true
|
||||
run: ./makem.sh -vv --sandbox=$SANDBOX_DIR lint
|
||||
|
||||
- name: Test
|
||||
if: always() # Run test even if linting fails.
|
||||
run: ./makem.sh -vv --sandbox=$SANDBOX_DIR test
|
||||
|
||||
# Local Variables:
|
||||
# eval: (outline-minor-mode)
|
||||
# End:
|
||||
11
.gitignore
vendored
11
.gitignore
vendored
|
|
@ -1,11 +0,0 @@
|
|||
*.elc
|
||||
.#*
|
||||
/scratch.el
|
||||
.cask
|
||||
/sandbox/
|
||||
/.sandbox/
|
||||
/scratch.org
|
||||
/scratch/
|
||||
/worktrees/
|
||||
/worktree/
|
||||
/NOTES.org
|
||||
674
LICENSE
674
LICENSE
|
|
@ -1,674 +0,0 @@
|
|||
GNU GENERAL PUBLIC LICENSE
|
||||
Version 3, 29 June 2007
|
||||
|
||||
Copyright (C) 2007 Free Software Foundation, Inc. <http://fsf.org/>
|
||||
Everyone is permitted to copy and distribute verbatim copies
|
||||
of this license document, but changing it is not allowed.
|
||||
|
||||
Preamble
|
||||
|
||||
The GNU General Public License is a free, copyleft license for
|
||||
software and other kinds of works.
|
||||
|
||||
The licenses for most software and other practical works are designed
|
||||
to take away your freedom to share and change the works. By contrast,
|
||||
the GNU General Public License is intended to guarantee your freedom to
|
||||
share and change all versions of a program--to make sure it remains free
|
||||
software for all its users. We, the Free Software Foundation, use the
|
||||
GNU General Public License for most of our software; it applies also to
|
||||
any other work released this way by its authors. You can apply it to
|
||||
your programs, too.
|
||||
|
||||
When we speak of free software, we are referring to freedom, not
|
||||
price. Our General Public Licenses are designed to make sure that you
|
||||
have the freedom to distribute copies of free software (and charge for
|
||||
them if you wish), that you receive source code or can get it if you
|
||||
want it, that you can change the software or use pieces of it in new
|
||||
free programs, and that you know you can do these things.
|
||||
|
||||
To protect your rights, we need to prevent others from denying you
|
||||
these rights or asking you to surrender the rights. Therefore, you have
|
||||
certain responsibilities if you distribute copies of the software, or if
|
||||
you modify it: responsibilities to respect the freedom of others.
|
||||
|
||||
For example, if you distribute copies of such a program, whether
|
||||
gratis or for a fee, you must pass on to the recipients the same
|
||||
freedoms that you received. You must make sure that they, too, receive
|
||||
or can get the source code. And you must show them these terms so they
|
||||
know their rights.
|
||||
|
||||
Developers that use the GNU GPL protect your rights with two steps:
|
||||
(1) assert copyright on the software, and (2) offer you this License
|
||||
giving you legal permission to copy, distribute and/or modify it.
|
||||
|
||||
For the developers' and authors' protection, the GPL clearly explains
|
||||
that there is no warranty for this free software. For both users' and
|
||||
authors' sake, the GPL requires that modified versions be marked as
|
||||
changed, so that their problems will not be attributed erroneously to
|
||||
authors of previous versions.
|
||||
|
||||
Some devices are designed to deny users access to install or run
|
||||
modified versions of the software inside them, although the manufacturer
|
||||
can do so. This is fundamentally incompatible with the aim of
|
||||
protecting users' freedom to change the software. The systematic
|
||||
pattern of such abuse occurs in the area of products for individuals to
|
||||
use, which is precisely where it is most unacceptable. Therefore, we
|
||||
have designed this version of the GPL to prohibit the practice for those
|
||||
products. If such problems arise substantially in other domains, we
|
||||
stand ready to extend this provision to those domains in future versions
|
||||
of the GPL, as needed to protect the freedom of users.
|
||||
|
||||
Finally, every program is threatened constantly by software patents.
|
||||
States should not allow patents to restrict development and use of
|
||||
software on general-purpose computers, but in those that do, we wish to
|
||||
avoid the special danger that patents applied to a free program could
|
||||
make it effectively proprietary. To prevent this, the GPL assures that
|
||||
patents cannot be used to render the program non-free.
|
||||
|
||||
The precise terms and conditions for copying, distribution and
|
||||
modification follow.
|
||||
|
||||
TERMS AND CONDITIONS
|
||||
|
||||
0. Definitions.
|
||||
|
||||
"This License" refers to version 3 of the GNU General Public License.
|
||||
|
||||
"Copyright" also means copyright-like laws that apply to other kinds of
|
||||
works, such as semiconductor masks.
|
||||
|
||||
"The Program" refers to any copyrightable work licensed under this
|
||||
License. Each licensee is addressed as "you". "Licensees" and
|
||||
"recipients" may be individuals or organizations.
|
||||
|
||||
To "modify" a work means to copy from or adapt all or part of the work
|
||||
in a fashion requiring copyright permission, other than the making of an
|
||||
exact copy. The resulting work is called a "modified version" of the
|
||||
earlier work or a work "based on" the earlier work.
|
||||
|
||||
A "covered work" means either the unmodified Program or a work based
|
||||
on the Program.
|
||||
|
||||
To "propagate" a work means to do anything with it that, without
|
||||
permission, would make you directly or secondarily liable for
|
||||
infringement under applicable copyright law, except executing it on a
|
||||
computer or modifying a private copy. Propagation includes copying,
|
||||
distribution (with or without modification), making available to the
|
||||
public, and in some countries other activities as well.
|
||||
|
||||
To "convey" a work means any kind of propagation that enables other
|
||||
parties to make or receive copies. Mere interaction with a user through
|
||||
a computer network, with no transfer of a copy, is not conveying.
|
||||
|
||||
An interactive user interface displays "Appropriate Legal Notices"
|
||||
to the extent that it includes a convenient and prominently visible
|
||||
feature that (1) displays an appropriate copyright notice, and (2)
|
||||
tells the user that there is no warranty for the work (except to the
|
||||
extent that warranties are provided), that licensees may convey the
|
||||
work under this License, and how to view a copy of this License. If
|
||||
the interface presents a list of user commands or options, such as a
|
||||
menu, a prominent item in the list meets this criterion.
|
||||
|
||||
1. Source Code.
|
||||
|
||||
The "source code" for a work means the preferred form of the work
|
||||
for making modifications to it. "Object code" means any non-source
|
||||
form of a work.
|
||||
|
||||
A "Standard Interface" means an interface that either is an official
|
||||
standard defined by a recognized standards body, or, in the case of
|
||||
interfaces specified for a particular programming language, one that
|
||||
is widely used among developers working in that language.
|
||||
|
||||
The "System Libraries" of an executable work include anything, other
|
||||
than the work as a whole, that (a) is included in the normal form of
|
||||
packaging a Major Component, but which is not part of that Major
|
||||
Component, and (b) serves only to enable use of the work with that
|
||||
Major Component, or to implement a Standard Interface for which an
|
||||
implementation is available to the public in source code form. A
|
||||
"Major Component", in this context, means a major essential component
|
||||
(kernel, window system, and so on) of the specific operating system
|
||||
(if any) on which the executable work runs, or a compiler used to
|
||||
produce the work, or an object code interpreter used to run it.
|
||||
|
||||
The "Corresponding Source" for a work in object code form means all
|
||||
the source code needed to generate, install, and (for an executable
|
||||
work) run the object code and to modify the work, including scripts to
|
||||
control those activities. However, it does not include the work's
|
||||
System Libraries, or general-purpose tools or generally available free
|
||||
programs which are used unmodified in performing those activities but
|
||||
which are not part of the work. For example, Corresponding Source
|
||||
includes interface definition files associated with source files for
|
||||
the work, and the source code for shared libraries and dynamically
|
||||
linked subprograms that the work is specifically designed to require,
|
||||
such as by intimate data communication or control flow between those
|
||||
subprograms and other parts of the work.
|
||||
|
||||
The Corresponding Source need not include anything that users
|
||||
can regenerate automatically from other parts of the Corresponding
|
||||
Source.
|
||||
|
||||
The Corresponding Source for a work in source code form is that
|
||||
same work.
|
||||
|
||||
2. Basic Permissions.
|
||||
|
||||
All rights granted under this License are granted for the term of
|
||||
copyright on the Program, and are irrevocable provided the stated
|
||||
conditions are met. This License explicitly affirms your unlimited
|
||||
permission to run the unmodified Program. The output from running a
|
||||
covered work is covered by this License only if the output, given its
|
||||
content, constitutes a covered work. This License acknowledges your
|
||||
rights of fair use or other equivalent, as provided by copyright law.
|
||||
|
||||
You may make, run and propagate covered works that you do not
|
||||
convey, without conditions so long as your license otherwise remains
|
||||
in force. You may convey covered works to others for the sole purpose
|
||||
of having them make modifications exclusively for you, or provide you
|
||||
with facilities for running those works, provided that you comply with
|
||||
the terms of this License in conveying all material for which you do
|
||||
not control copyright. Those thus making or running the covered works
|
||||
for you must do so exclusively on your behalf, under your direction
|
||||
and control, on terms that prohibit them from making any copies of
|
||||
your copyrighted material outside their relationship with you.
|
||||
|
||||
Conveying under any other circumstances is permitted solely under
|
||||
the conditions stated below. Sublicensing is not allowed; section 10
|
||||
makes it unnecessary.
|
||||
|
||||
3. Protecting Users' Legal Rights From Anti-Circumvention Law.
|
||||
|
||||
No covered work shall be deemed part of an effective technological
|
||||
measure under any applicable law fulfilling obligations under article
|
||||
11 of the WIPO copyright treaty adopted on 20 December 1996, or
|
||||
similar laws prohibiting or restricting circumvention of such
|
||||
measures.
|
||||
|
||||
When you convey a covered work, you waive any legal power to forbid
|
||||
circumvention of technological measures to the extent such circumvention
|
||||
is effected by exercising rights under this License with respect to
|
||||
the covered work, and you disclaim any intention to limit operation or
|
||||
modification of the work as a means of enforcing, against the work's
|
||||
users, your or third parties' legal rights to forbid circumvention of
|
||||
technological measures.
|
||||
|
||||
4. Conveying Verbatim Copies.
|
||||
|
||||
You may convey verbatim copies of the Program's source code as you
|
||||
receive it, in any medium, provided that you conspicuously and
|
||||
appropriately publish on each copy an appropriate copyright notice;
|
||||
keep intact all notices stating that this License and any
|
||||
non-permissive terms added in accord with section 7 apply to the code;
|
||||
keep intact all notices of the absence of any warranty; and give all
|
||||
recipients a copy of this License along with the Program.
|
||||
|
||||
You may charge any price or no price for each copy that you convey,
|
||||
and you may offer support or warranty protection for a fee.
|
||||
|
||||
5. Conveying Modified Source Versions.
|
||||
|
||||
You may convey a work based on the Program, or the modifications to
|
||||
produce it from the Program, in the form of source code under the
|
||||
terms of section 4, provided that you also meet all of these conditions:
|
||||
|
||||
a) The work must carry prominent notices stating that you modified
|
||||
it, and giving a relevant date.
|
||||
|
||||
b) The work must carry prominent notices stating that it is
|
||||
released under this License and any conditions added under section
|
||||
7. This requirement modifies the requirement in section 4 to
|
||||
"keep intact all notices".
|
||||
|
||||
c) You must license the entire work, as a whole, under this
|
||||
License to anyone who comes into possession of a copy. This
|
||||
License will therefore apply, along with any applicable section 7
|
||||
additional terms, to the whole of the work, and all its parts,
|
||||
regardless of how they are packaged. This License gives no
|
||||
permission to license the work in any other way, but it does not
|
||||
invalidate such permission if you have separately received it.
|
||||
|
||||
d) If the work has interactive user interfaces, each must display
|
||||
Appropriate Legal Notices; however, if the Program has interactive
|
||||
interfaces that do not display Appropriate Legal Notices, your
|
||||
work need not make them do so.
|
||||
|
||||
A compilation of a covered work with other separate and independent
|
||||
works, which are not by their nature extensions of the covered work,
|
||||
and which are not combined with it such as to form a larger program,
|
||||
in or on a volume of a storage or distribution medium, is called an
|
||||
"aggregate" if the compilation and its resulting copyright are not
|
||||
used to limit the access or legal rights of the compilation's users
|
||||
beyond what the individual works permit. Inclusion of a covered work
|
||||
in an aggregate does not cause this License to apply to the other
|
||||
parts of the aggregate.
|
||||
|
||||
6. Conveying Non-Source Forms.
|
||||
|
||||
You may convey a covered work in object code form under the terms
|
||||
of sections 4 and 5, provided that you also convey the
|
||||
machine-readable Corresponding Source under the terms of this License,
|
||||
in one of these ways:
|
||||
|
||||
a) Convey the object code in, or embodied in, a physical product
|
||||
(including a physical distribution medium), accompanied by the
|
||||
Corresponding Source fixed on a durable physical medium
|
||||
customarily used for software interchange.
|
||||
|
||||
b) Convey the object code in, or embodied in, a physical product
|
||||
(including a physical distribution medium), accompanied by a
|
||||
written offer, valid for at least three years and valid for as
|
||||
long as you offer spare parts or customer support for that product
|
||||
model, to give anyone who possesses the object code either (1) a
|
||||
copy of the Corresponding Source for all the software in the
|
||||
product that is covered by this License, on a durable physical
|
||||
medium customarily used for software interchange, for a price no
|
||||
more than your reasonable cost of physically performing this
|
||||
conveying of source, or (2) access to copy the
|
||||
Corresponding Source from a network server at no charge.
|
||||
|
||||
c) Convey individual copies of the object code with a copy of the
|
||||
written offer to provide the Corresponding Source. This
|
||||
alternative is allowed only occasionally and noncommercially, and
|
||||
only if you received the object code with such an offer, in accord
|
||||
with subsection 6b.
|
||||
|
||||
d) Convey the object code by offering access from a designated
|
||||
place (gratis or for a charge), and offer equivalent access to the
|
||||
Corresponding Source in the same way through the same place at no
|
||||
further charge. You need not require recipients to copy the
|
||||
Corresponding Source along with the object code. If the place to
|
||||
copy the object code is a network server, the Corresponding Source
|
||||
may be on a different server (operated by you or a third party)
|
||||
that supports equivalent copying facilities, provided you maintain
|
||||
clear directions next to the object code saying where to find the
|
||||
Corresponding Source. Regardless of what server hosts the
|
||||
Corresponding Source, you remain obligated to ensure that it is
|
||||
available for as long as needed to satisfy these requirements.
|
||||
|
||||
e) Convey the object code using peer-to-peer transmission, provided
|
||||
you inform other peers where the object code and Corresponding
|
||||
Source of the work are being offered to the general public at no
|
||||
charge under subsection 6d.
|
||||
|
||||
A separable portion of the object code, whose source code is excluded
|
||||
from the Corresponding Source as a System Library, need not be
|
||||
included in conveying the object code work.
|
||||
|
||||
A "User Product" is either (1) a "consumer product", which means any
|
||||
tangible personal property which is normally used for personal, family,
|
||||
or household purposes, or (2) anything designed or sold for incorporation
|
||||
into a dwelling. In determining whether a product is a consumer product,
|
||||
doubtful cases shall be resolved in favor of coverage. For a particular
|
||||
product received by a particular user, "normally used" refers to a
|
||||
typical or common use of that class of product, regardless of the status
|
||||
of the particular user or of the way in which the particular user
|
||||
actually uses, or expects or is expected to use, the product. A product
|
||||
is a consumer product regardless of whether the product has substantial
|
||||
commercial, industrial or non-consumer uses, unless such uses represent
|
||||
the only significant mode of use of the product.
|
||||
|
||||
"Installation Information" for a User Product means any methods,
|
||||
procedures, authorization keys, or other information required to install
|
||||
and execute modified versions of a covered work in that User Product from
|
||||
a modified version of its Corresponding Source. The information must
|
||||
suffice to ensure that the continued functioning of the modified object
|
||||
code is in no case prevented or interfered with solely because
|
||||
modification has been made.
|
||||
|
||||
If you convey an object code work under this section in, or with, or
|
||||
specifically for use in, a User Product, and the conveying occurs as
|
||||
part of a transaction in which the right of possession and use of the
|
||||
User Product is transferred to the recipient in perpetuity or for a
|
||||
fixed term (regardless of how the transaction is characterized), the
|
||||
Corresponding Source conveyed under this section must be accompanied
|
||||
by the Installation Information. But this requirement does not apply
|
||||
if neither you nor any third party retains the ability to install
|
||||
modified object code on the User Product (for example, the work has
|
||||
been installed in ROM).
|
||||
|
||||
The requirement to provide Installation Information does not include a
|
||||
requirement to continue to provide support service, warranty, or updates
|
||||
for a work that has been modified or installed by the recipient, or for
|
||||
the User Product in which it has been modified or installed. Access to a
|
||||
network may be denied when the modification itself materially and
|
||||
adversely affects the operation of the network or violates the rules and
|
||||
protocols for communication across the network.
|
||||
|
||||
Corresponding Source conveyed, and Installation Information provided,
|
||||
in accord with this section must be in a format that is publicly
|
||||
documented (and with an implementation available to the public in
|
||||
source code form), and must require no special password or key for
|
||||
unpacking, reading or copying.
|
||||
|
||||
7. Additional Terms.
|
||||
|
||||
"Additional permissions" are terms that supplement the terms of this
|
||||
License by making exceptions from one or more of its conditions.
|
||||
Additional permissions that are applicable to the entire Program shall
|
||||
be treated as though they were included in this License, to the extent
|
||||
that they are valid under applicable law. If additional permissions
|
||||
apply only to part of the Program, that part may be used separately
|
||||
under those permissions, but the entire Program remains governed by
|
||||
this License without regard to the additional permissions.
|
||||
|
||||
When you convey a copy of a covered work, you may at your option
|
||||
remove any additional permissions from that copy, or from any part of
|
||||
it. (Additional permissions may be written to require their own
|
||||
removal in certain cases when you modify the work.) You may place
|
||||
additional permissions on material, added by you to a covered work,
|
||||
for which you have or can give appropriate copyright permission.
|
||||
|
||||
Notwithstanding any other provision of this License, for material you
|
||||
add to a covered work, you may (if authorized by the copyright holders of
|
||||
that material) supplement the terms of this License with terms:
|
||||
|
||||
a) Disclaiming warranty or limiting liability differently from the
|
||||
terms of sections 15 and 16 of this License; or
|
||||
|
||||
b) Requiring preservation of specified reasonable legal notices or
|
||||
author attributions in that material or in the Appropriate Legal
|
||||
Notices displayed by works containing it; or
|
||||
|
||||
c) Prohibiting misrepresentation of the origin of that material, or
|
||||
requiring that modified versions of such material be marked in
|
||||
reasonable ways as different from the original version; or
|
||||
|
||||
d) Limiting the use for publicity purposes of names of licensors or
|
||||
authors of the material; or
|
||||
|
||||
e) Declining to grant rights under trademark law for use of some
|
||||
trade names, trademarks, or service marks; or
|
||||
|
||||
f) Requiring indemnification of licensors and authors of that
|
||||
material by anyone who conveys the material (or modified versions of
|
||||
it) with contractual assumptions of liability to the recipient, for
|
||||
any liability that these contractual assumptions directly impose on
|
||||
those licensors and authors.
|
||||
|
||||
All other non-permissive additional terms are considered "further
|
||||
restrictions" within the meaning of section 10. If the Program as you
|
||||
received it, or any part of it, contains a notice stating that it is
|
||||
governed by this License along with a term that is a further
|
||||
restriction, you may remove that term. If a license document contains
|
||||
a further restriction but permits relicensing or conveying under this
|
||||
License, you may add to a covered work material governed by the terms
|
||||
of that license document, provided that the further restriction does
|
||||
not survive such relicensing or conveying.
|
||||
|
||||
If you add terms to a covered work in accord with this section, you
|
||||
must place, in the relevant source files, a statement of the
|
||||
additional terms that apply to those files, or a notice indicating
|
||||
where to find the applicable terms.
|
||||
|
||||
Additional terms, permissive or non-permissive, may be stated in the
|
||||
form of a separately written license, or stated as exceptions;
|
||||
the above requirements apply either way.
|
||||
|
||||
8. Termination.
|
||||
|
||||
You may not propagate or modify a covered work except as expressly
|
||||
provided under this License. Any attempt otherwise to propagate or
|
||||
modify it is void, and will automatically terminate your rights under
|
||||
this License (including any patent licenses granted under the third
|
||||
paragraph of section 11).
|
||||
|
||||
However, if you cease all violation of this License, then your
|
||||
license from a particular copyright holder is reinstated (a)
|
||||
provisionally, unless and until the copyright holder explicitly and
|
||||
finally terminates your license, and (b) permanently, if the copyright
|
||||
holder fails to notify you of the violation by some reasonable means
|
||||
prior to 60 days after the cessation.
|
||||
|
||||
Moreover, your license from a particular copyright holder is
|
||||
reinstated permanently if the copyright holder notifies you of the
|
||||
violation by some reasonable means, this is the first time you have
|
||||
received notice of violation of this License (for any work) from that
|
||||
copyright holder, and you cure the violation prior to 30 days after
|
||||
your receipt of the notice.
|
||||
|
||||
Termination of your rights under this section does not terminate the
|
||||
licenses of parties who have received copies or rights from you under
|
||||
this License. If your rights have been terminated and not permanently
|
||||
reinstated, you do not qualify to receive new licenses for the same
|
||||
material under section 10.
|
||||
|
||||
9. Acceptance Not Required for Having Copies.
|
||||
|
||||
You are not required to accept this License in order to receive or
|
||||
run a copy of the Program. Ancillary propagation of a covered work
|
||||
occurring solely as a consequence of using peer-to-peer transmission
|
||||
to receive a copy likewise does not require acceptance. However,
|
||||
nothing other than this License grants you permission to propagate or
|
||||
modify any covered work. These actions infringe copyright if you do
|
||||
not accept this License. Therefore, by modifying or propagating a
|
||||
covered work, you indicate your acceptance of this License to do so.
|
||||
|
||||
10. Automatic Licensing of Downstream Recipients.
|
||||
|
||||
Each time you convey a covered work, the recipient automatically
|
||||
receives a license from the original licensors, to run, modify and
|
||||
propagate that work, subject to this License. You are not responsible
|
||||
for enforcing compliance by third parties with this License.
|
||||
|
||||
An "entity transaction" is a transaction transferring control of an
|
||||
organization, or substantially all assets of one, or subdividing an
|
||||
organization, or merging organizations. If propagation of a covered
|
||||
work results from an entity transaction, each party to that
|
||||
transaction who receives a copy of the work also receives whatever
|
||||
licenses to the work the party's predecessor in interest had or could
|
||||
give under the previous paragraph, plus a right to possession of the
|
||||
Corresponding Source of the work from the predecessor in interest, if
|
||||
the predecessor has it or can get it with reasonable efforts.
|
||||
|
||||
You may not impose any further restrictions on the exercise of the
|
||||
rights granted or affirmed under this License. For example, you may
|
||||
not impose a license fee, royalty, or other charge for exercise of
|
||||
rights granted under this License, and you may not initiate litigation
|
||||
(including a cross-claim or counterclaim in a lawsuit) alleging that
|
||||
any patent claim is infringed by making, using, selling, offering for
|
||||
sale, or importing the Program or any portion of it.
|
||||
|
||||
11. Patents.
|
||||
|
||||
A "contributor" is a copyright holder who authorizes use under this
|
||||
License of the Program or a work on which the Program is based. The
|
||||
work thus licensed is called the contributor's "contributor version".
|
||||
|
||||
A contributor's "essential patent claims" are all patent claims
|
||||
owned or controlled by the contributor, whether already acquired or
|
||||
hereafter acquired, that would be infringed by some manner, permitted
|
||||
by this License, of making, using, or selling its contributor version,
|
||||
but do not include claims that would be infringed only as a
|
||||
consequence of further modification of the contributor version. For
|
||||
purposes of this definition, "control" includes the right to grant
|
||||
patent sublicenses in a manner consistent with the requirements of
|
||||
this License.
|
||||
|
||||
Each contributor grants you a non-exclusive, worldwide, royalty-free
|
||||
patent license under the contributor's essential patent claims, to
|
||||
make, use, sell, offer for sale, import and otherwise run, modify and
|
||||
propagate the contents of its contributor version.
|
||||
|
||||
In the following three paragraphs, a "patent license" is any express
|
||||
agreement or commitment, however denominated, not to enforce a patent
|
||||
(such as an express permission to practice a patent or covenant not to
|
||||
sue for patent infringement). To "grant" such a patent license to a
|
||||
party means to make such an agreement or commitment not to enforce a
|
||||
patent against the party.
|
||||
|
||||
If you convey a covered work, knowingly relying on a patent license,
|
||||
and the Corresponding Source of the work is not available for anyone
|
||||
to copy, free of charge and under the terms of this License, through a
|
||||
publicly available network server or other readily accessible means,
|
||||
then you must either (1) cause the Corresponding Source to be so
|
||||
available, or (2) arrange to deprive yourself of the benefit of the
|
||||
patent license for this particular work, or (3) arrange, in a manner
|
||||
consistent with the requirements of this License, to extend the patent
|
||||
license to downstream recipients. "Knowingly relying" means you have
|
||||
actual knowledge that, but for the patent license, your conveying the
|
||||
covered work in a country, or your recipient's use of the covered work
|
||||
in a country, would infringe one or more identifiable patents in that
|
||||
country that you have reason to believe are valid.
|
||||
|
||||
If, pursuant to or in connection with a single transaction or
|
||||
arrangement, you convey, or propagate by procuring conveyance of, a
|
||||
covered work, and grant a patent license to some of the parties
|
||||
receiving the covered work authorizing them to use, propagate, modify
|
||||
or convey a specific copy of the covered work, then the patent license
|
||||
you grant is automatically extended to all recipients of the covered
|
||||
work and works based on it.
|
||||
|
||||
A patent license is "discriminatory" if it does not include within
|
||||
the scope of its coverage, prohibits the exercise of, or is
|
||||
conditioned on the non-exercise of one or more of the rights that are
|
||||
specifically granted under this License. You may not convey a covered
|
||||
work if you are a party to an arrangement with a third party that is
|
||||
in the business of distributing software, under which you make payment
|
||||
to the third party based on the extent of your activity of conveying
|
||||
the work, and under which the third party grants, to any of the
|
||||
parties who would receive the covered work from you, a discriminatory
|
||||
patent license (a) in connection with copies of the covered work
|
||||
conveyed by you (or copies made from those copies), or (b) primarily
|
||||
for and in connection with specific products or compilations that
|
||||
contain the covered work, unless you entered into that arrangement,
|
||||
or that patent license was granted, prior to 28 March 2007.
|
||||
|
||||
Nothing in this License shall be construed as excluding or limiting
|
||||
any implied license or other defenses to infringement that may
|
||||
otherwise be available to you under applicable patent law.
|
||||
|
||||
12. No Surrender of Others' Freedom.
|
||||
|
||||
If conditions are imposed on you (whether by court order, agreement or
|
||||
otherwise) that contradict the conditions of this License, they do not
|
||||
excuse you from the conditions of this License. If you cannot convey a
|
||||
covered work so as to satisfy simultaneously your obligations under this
|
||||
License and any other pertinent obligations, then as a consequence you may
|
||||
not convey it at all. For example, if you agree to terms that obligate you
|
||||
to collect a royalty for further conveying from those to whom you convey
|
||||
the Program, the only way you could satisfy both those terms and this
|
||||
License would be to refrain entirely from conveying the Program.
|
||||
|
||||
13. Use with the GNU Affero General Public License.
|
||||
|
||||
Notwithstanding any other provision of this License, you have
|
||||
permission to link or combine any covered work with a work licensed
|
||||
under version 3 of the GNU Affero General Public License into a single
|
||||
combined work, and to convey the resulting work. The terms of this
|
||||
License will continue to apply to the part which is the covered work,
|
||||
but the special requirements of the GNU Affero General Public License,
|
||||
section 13, concerning interaction through a network will apply to the
|
||||
combination as such.
|
||||
|
||||
14. Revised Versions of this License.
|
||||
|
||||
The Free Software Foundation may publish revised and/or new versions of
|
||||
the GNU General Public License from time to time. Such new versions will
|
||||
be similar in spirit to the present version, but may differ in detail to
|
||||
address new problems or concerns.
|
||||
|
||||
Each version is given a distinguishing version number. If the
|
||||
Program specifies that a certain numbered version of the GNU General
|
||||
Public License "or any later version" applies to it, you have the
|
||||
option of following the terms and conditions either of that numbered
|
||||
version or of any later version published by the Free Software
|
||||
Foundation. If the Program does not specify a version number of the
|
||||
GNU General Public License, you may choose any version ever published
|
||||
by the Free Software Foundation.
|
||||
|
||||
If the Program specifies that a proxy can decide which future
|
||||
versions of the GNU General Public License can be used, that proxy's
|
||||
public statement of acceptance of a version permanently authorizes you
|
||||
to choose that version for the Program.
|
||||
|
||||
Later license versions may give you additional or different
|
||||
permissions. However, no additional obligations are imposed on any
|
||||
author or copyright holder as a result of your choosing to follow a
|
||||
later version.
|
||||
|
||||
15. Disclaimer of Warranty.
|
||||
|
||||
THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY
|
||||
APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT
|
||||
HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY
|
||||
OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO,
|
||||
THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
|
||||
PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM
|
||||
IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF
|
||||
ALL NECESSARY SERVICING, REPAIR OR CORRECTION.
|
||||
|
||||
16. Limitation of Liability.
|
||||
|
||||
IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
|
||||
WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS
|
||||
THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY
|
||||
GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE
|
||||
USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF
|
||||
DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD
|
||||
PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS),
|
||||
EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF
|
||||
SUCH DAMAGES.
|
||||
|
||||
17. Interpretation of Sections 15 and 16.
|
||||
|
||||
If the disclaimer of warranty and limitation of liability provided
|
||||
above cannot be given local legal effect according to their terms,
|
||||
reviewing courts shall apply local law that most closely approximates
|
||||
an absolute waiver of all civil liability in connection with the
|
||||
Program, unless a warranty or assumption of liability accompanies a
|
||||
copy of the Program in return for a fee.
|
||||
|
||||
END OF TERMS AND CONDITIONS
|
||||
|
||||
How to Apply These Terms to Your New Programs
|
||||
|
||||
If you develop a new program, and you want it to be of the greatest
|
||||
possible use to the public, the best way to achieve this is to make it
|
||||
free software which everyone can redistribute and change under these terms.
|
||||
|
||||
To do so, attach the following notices to the program. It is safest
|
||||
to attach them to the start of each source file to most effectively
|
||||
state the exclusion of warranty; and each file should have at least
|
||||
the "copyright" line and a pointer to where the full notice is found.
|
||||
|
||||
<one line to give the program's name and a brief idea of what it does.>
|
||||
Copyright (C) <year> <name of author>
|
||||
|
||||
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 <http://www.gnu.org/licenses/>.
|
||||
|
||||
Also add information on how to contact you by electronic and paper mail.
|
||||
|
||||
If the program does terminal interaction, make it output a short
|
||||
notice like this when it starts in an interactive mode:
|
||||
|
||||
<program> Copyright (C) <year> <name of author>
|
||||
This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'.
|
||||
This is free software, and you are welcome to redistribute it
|
||||
under certain conditions; type `show c' for details.
|
||||
|
||||
The hypothetical commands `show w' and `show c' should show the appropriate
|
||||
parts of the General Public License. Of course, your program's commands
|
||||
might be different; for a GUI interface, you would use an "about box".
|
||||
|
||||
You should also get your employer (if you work as a programmer) or school,
|
||||
if any, to sign a "copyright disclaimer" for the program, if necessary.
|
||||
For more information on this, and how to apply and follow the GNU GPL, see
|
||||
<http://www.gnu.org/licenses/>.
|
||||
|
||||
The GNU General Public License does not permit incorporating your program
|
||||
into proprietary programs. If your program is a subroutine library, you
|
||||
may consider it more useful to permit linking proprietary applications with
|
||||
the library. If this is what you want to do, use the GNU Lesser General
|
||||
Public License instead of this License. But first, please read
|
||||
<http://www.gnu.org/philosophy/why-not-lgpl.html>.
|
||||
59
Makefile
59
Makefile
|
|
@ -1,59 +0,0 @@
|
|||
# * makem.sh/Makefile --- Script to aid building and testing Emacs Lisp packages
|
||||
|
||||
# URL: https://github.com/alphapapa/makem.sh
|
||||
# Version: 0.5
|
||||
|
||||
# * Arguments
|
||||
|
||||
# For consistency, we use only var=val options, not hyphen-prefixed options.
|
||||
|
||||
# NOTE: I don't like duplicating the arguments here and in makem.sh,
|
||||
# but I haven't been able to find a way to pass arguments which
|
||||
# conflict with Make's own arguments through Make to the script.
|
||||
# Using -- doesn't seem to do it.
|
||||
|
||||
ifdef install-deps
|
||||
INSTALL_DEPS = "--install-deps"
|
||||
endif
|
||||
ifdef install-linters
|
||||
INSTALL_LINTERS = "--install-linters"
|
||||
endif
|
||||
|
||||
ifdef sandbox
|
||||
ifeq ($(sandbox), t)
|
||||
SANDBOX = --sandbox
|
||||
else
|
||||
SANDBOX = --sandbox=$(sandbox)
|
||||
endif
|
||||
endif
|
||||
|
||||
ifdef debug
|
||||
DEBUG = "--debug"
|
||||
endif
|
||||
|
||||
# ** Verbosity
|
||||
|
||||
# Since the "-v" in "make -v" gets intercepted by Make itself, we have
|
||||
# to use a variable.
|
||||
|
||||
verbose = $(v)
|
||||
|
||||
ifneq (,$(findstring vvv,$(verbose)))
|
||||
VERBOSE = "-vvv"
|
||||
else ifneq (,$(findstring vv,$(verbose)))
|
||||
VERBOSE = "-vv"
|
||||
else ifneq (,$(findstring v,$(verbose)))
|
||||
VERBOSE = "-v"
|
||||
endif
|
||||
|
||||
# * Rules
|
||||
|
||||
# TODO: Handle cases in which "test" or "tests" are called and a
|
||||
# directory by that name exists, which can confuse Make.
|
||||
|
||||
%:
|
||||
@./makem.sh $(DEBUG) $(VERBOSE) $(SANDBOX) $(INSTALL_DEPS) $(INSTALL_LINTERS) $(@)
|
||||
|
||||
.DEFAULT: init
|
||||
init:
|
||||
@./makem.sh $(DEBUG) $(VERBOSE) $(SANDBOX) $(INSTALL_DEPS) $(INSTALL_LINTERS)
|
||||
1
NOTES
1
NOTES
|
|
@ -1 +0,0 @@
|
|||
Note: Notes are kept in the file "NOTES.org" in the "meta/notes" branch.
|
||||
1130
README.org
1130
README.org
File diff suppressed because it is too large
Load diff
BIN
dog-153497_960_720.png
Normal file
BIN
dog-153497_960_720.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 77 KiB |
|
Before Width: | Height: | Size: 11 KiB After Width: | Height: | Size: 11 KiB |
BIN
dog.xcf
Normal file
BIN
dog.xcf
Normal file
Binary file not shown.
257
examples.org
257
examples.org
|
|
@ -1,257 +0,0 @@
|
|||
#+TITLE: org-ql examples
|
||||
|
||||
* Contents
|
||||
:PROPERTIES:
|
||||
: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]]
|
||||
- [[#listing-bills-coming-due][Listing bills coming due]]
|
||||
- [[#music-database][Music database]]
|
||||
- [[#return-org-elements][Return Org elements]]
|
||||
- [[#set-tags-on-certain-entries][Set tags on certain entries]]
|
||||
- [[#show-entries-with-recent-timestamps][Show entries with recent timestamps]]
|
||||
- [[#stuck-projects-block-agenda][Stuck projects block agenda]]
|
||||
- [[#subproject-and-subtask-queries][Subproject and subtask queries]]
|
||||
- [[#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.
|
||||
|
||||
#+BEGIN_SRC elisp
|
||||
(org-ql-search (org-agenda-files)
|
||||
'(or (and (not (done))
|
||||
(or (habit)
|
||||
(deadline auto)
|
||||
(scheduled :to today)
|
||||
(ts-active :on today)))
|
||||
(closed :on today))
|
||||
:sort '(todo priority date))
|
||||
#+END_SRC
|
||||
|
||||
Another example, showing grouping with [[https://github.com/alphapapa/org-super-agenda][org-super-agenda]]:
|
||||
|
||||
#+BEGIN_SRC elisp
|
||||
(org-ql-search "~/src/emacs/org-super-agenda/test/test.org"
|
||||
'(and (or (ts-active :on today)
|
||||
(deadline auto)
|
||||
(scheduled :to today))
|
||||
(not (done)))
|
||||
:title "My Agenda View"
|
||||
;; The `org-super-agenda-groups' setting is used automatically when set, or it
|
||||
;; may be overriden by specifying it here:
|
||||
:super-groups '((:name "Bills"
|
||||
:tag "bills")
|
||||
(:todo ("SOMEDAY" "TO-READ" "CHECK" "TO-WATCH" "WATCHING")
|
||||
:order 7)
|
||||
(:name "Personal"
|
||||
:habit t
|
||||
:tag "personal"
|
||||
:order 3)
|
||||
(:todo "WAITING"
|
||||
:order 6)
|
||||
(:priority "A" :order 1)
|
||||
(:priority "B" :order 2)
|
||||
(:priority "C" :order 2)))
|
||||
#+END_SRC
|
||||
|
||||
Which displays this buffer:
|
||||
|
||||
[[images/screenshot.png]]
|
||||
|
||||
* Entries from the past week
|
||||
|
||||
Show entries that have any timestamp within the past week. Group by date using =org-super-agenda= with the =:auto-ts= group.
|
||||
|
||||
#+BEGIN_SRC elisp
|
||||
(org-ql-search (org-agenda-files)
|
||||
'(ts :from -7 :to today)
|
||||
:title "Recent Items"
|
||||
:sort '(todo priority date)
|
||||
:super-groups '((:auto-ts t)))
|
||||
#+END_SRC
|
||||
|
||||
* Find entries matching a certain =CUSTOM_ID=
|
||||
|
||||
Since queries can contain both built-in =org-ql= predicate expressions and arbitrary expressions, they can be combined in useful ways. This example uses the built-in =property= predicate to quickly locate entries that have the =CUSTOM_ID= property set, and then compares the value of that property to the string =issue=.
|
||||
|
||||
#+BEGIN_SRC elisp
|
||||
(org-ql-query
|
||||
:select #'org-get-heading
|
||||
:from "~/org/tickets.org"
|
||||
:where '(and (property "CUSTOM_ID")
|
||||
(string-match "issue" (org-entry-get (point) "CUSTOM_ID"))))
|
||||
#+END_SRC
|
||||
|
||||
Using the =property= predicate as the first clause of the two clauses joined with =and= allows =org-ql= to optimize the query by searching through the buffer directly to entries that set the =CUSTOM_ID= property, which is much faster than testing every entry in a buffer. Also, If the query were only the =string-match= call, it would signal an error on entries that didn't have the property set, because =org-entry-get= would return nil.
|
||||
|
||||
* Listing bills coming due
|
||||
|
||||
This uses the example in the readme file, but maps across the elements returned by ~org-ql~ to present a simple list of titles and deadlines.
|
||||
|
||||
#+BEGIN_SRC elisp
|
||||
(org-ql-query
|
||||
:select '(list (substring-no-properties (org-get-heading t t))
|
||||
(org-entry-get (point) "DEADLINE"))
|
||||
:from (org-agenda-files)
|
||||
:where '(and (not (done))
|
||||
(tags "bills")
|
||||
(deadline auto))
|
||||
:order-by 'deadline)
|
||||
;;=> (("Electric bill" "<2018-08-23 Thu +1m>")
|
||||
;; ("Rent" "<2018-09-01 Sat +1m>"))
|
||||
#+END_SRC
|
||||
|
||||
This could also be put in a script, which could use desktop notifications to remind of bills coming due: [[examples/org-bills-due.el][org-bills-due.el]].
|
||||
|
||||
* Music database
|
||||
|
||||
If you kept a database of music in an Org file, you could run a query like this to find tracks composed by Chopin that do not have their key recorded in the database.
|
||||
|
||||
#+BEGIN_SRC elisp
|
||||
(org-ql-search "~/org/music.org"
|
||||
'(and (property "genre" "classical")
|
||||
(property "composer" "Chopin")
|
||||
(not (property "key"))))
|
||||
#+END_SRC
|
||||
|
||||
* Return Org elements
|
||||
|
||||
Return a list of Org entry elements in the file =~/org/main.org= which have the =SOMEDAY= to-do keyword, are tagged =Emacs=, and have priority B or higher. =org-ql= is the macro version of =org-ql-select=; it does not require quoting the query sexp.
|
||||
|
||||
#+BEGIN_SRC elisp
|
||||
(org-ql "~/org/main.org"
|
||||
(and (todo "SOMEDAY")
|
||||
(tags "Emacs")
|
||||
(priority >= "B")))
|
||||
;;=> ((headline (:raw-value "org-board" :begin 1220270 :end 1220403 ...)) ...)
|
||||
#+END_SRC
|
||||
|
||||
* Set tags on certain entries
|
||||
|
||||
Set the tag =Emacs= on every entry in the inbox file that mentions =Emacs=. The bare-string query ="Emacs"= is equivalent to ~(regexp "Emacs")~.
|
||||
|
||||
#+BEGIN_SRC elisp
|
||||
(org-ql-select "~/org/inbox.org"
|
||||
"Emacs"
|
||||
:action '(org-toggle-tag "Emacs" 'on))
|
||||
#+END_SRC
|
||||
|
||||
* Show entries with recent timestamps
|
||||
|
||||
You can also access these views with the command ~org-ql-view~.
|
||||
|
||||
#+BEGIN_SRC elisp
|
||||
;; Show entries with any timestamp from last 7 days:
|
||||
(org-ql-view-recent-items 7)
|
||||
|
||||
;; Show entries clocked in last 30 days:
|
||||
(org-ql-view-recent-items 30 'clocked)
|
||||
|
||||
;; Show entries closed in last 30 days:
|
||||
(org-ql-view-recent-items 30 'closed)
|
||||
#+END_SRC
|
||||
|
||||
* Stuck projects block agenda
|
||||
|
||||
Reddit user =emptymatrix= [[https://www.reddit.com/r/emacs/comments/cnrt2d/orgqlblock_integrates_orgql_into_org_agenda/ewtqez8/][shared]] this example of replacing a traditional =org-stuck-projects= view like:
|
||||
|
||||
#+BEGIN_SRC elisp
|
||||
(setq org-stuck-projects
|
||||
'("+@project/-DONE" ("NEXT") nil "SCHEDULED:"))
|
||||
#+END_SRC
|
||||
|
||||
With this =org-ql-block= agenda view, like:
|
||||
|
||||
#+BEGIN_SRC elisp
|
||||
(setq org-agenda-custom-commands
|
||||
'(("s" "Stuck Projects"
|
||||
((org-ql-block '(and (tags "@project")
|
||||
(not (done))
|
||||
(not (descendants (todo "NEXT")))
|
||||
(not (descendants (scheduled))))
|
||||
((org-ql-block-header "Stuck Projects")))))))
|
||||
#+END_SRC
|
||||
|
||||
* Subproject and subtask queries
|
||||
|
||||
#+BEGIN_SRC elisp
|
||||
;; Search for subprojects.
|
||||
(org-ql-search (org-agenda-files)
|
||||
'(and (todo "PROJECT")
|
||||
(ancestors (todo "PROJECT"))))
|
||||
|
||||
;; Search for all subtasks of projects, grouped by parent heading.
|
||||
(org-ql-search (org-agenda-files)
|
||||
'(and (todo)
|
||||
(ancestors (todo "PROJECT")))
|
||||
:super-groups '((:auto-parent t)))
|
||||
|
||||
;; Search for direct top-level tasks of projects.
|
||||
(org-ql-search (org-agenda-files)
|
||||
'(and (todo)
|
||||
(parent (todo "PROJECT")))
|
||||
:super-groups '((:auto-parent t)))
|
||||
#+END_SRC
|
||||
|
||||
Of course, all of those presume using a =PROJECT= keyword to define projects. If one defines a project as any task which has an ancestor task, one could use queries like:
|
||||
|
||||
#+BEGIN_SRC elisp
|
||||
;; Search for all subtasks of top-level projects, grouped by parent heading.
|
||||
(org-ql-search (org-agenda-files)
|
||||
'(and (todo)
|
||||
(ancestors
|
||||
(and (todo)
|
||||
(not (parent)))))
|
||||
:super-groups '((:auto-parent t)))
|
||||
|
||||
;; Search for all subtasks of all projects, including subprojects, grouped by project.
|
||||
(org-ql-search (org-agenda-files)
|
||||
'(and (todo)
|
||||
(ancestors (todo)))
|
||||
:super-groups '((:auto-parent t)))
|
||||
#+END_SRC
|
||||
|
||||
Other interesting queries:
|
||||
|
||||
#+BEGIN_SRC elisp
|
||||
;; Subtasks of upcoming deadline items.
|
||||
(org-ql-search (org-agenda-files)
|
||||
'(and (todo)
|
||||
(ancestors
|
||||
(and (not (done))
|
||||
(deadline auto))))
|
||||
:super-groups '((:auto-parent t)))
|
||||
|
||||
;; TODO items whose ancestor is already DONE, and should therefore be
|
||||
;; either marked DONE or CANCELLED.
|
||||
(org-ql-search (org-agenda-files)
|
||||
'(and (todo)
|
||||
(ancestors (done)))
|
||||
:super-groups '((:auto-parent t)))
|
||||
#+END_SRC
|
||||
|
||||
* Task list for files in subdirectories
|
||||
|
||||
[[images/org-ql-search-snippet.png]]
|
||||
|
||||
* COMMENT Code :noexport:
|
||||
:PROPERTIES:
|
||||
:TOC: :ignore (this descendants)
|
||||
:END:
|
||||
|
||||
** File-local variables
|
||||
|
||||
# Local Variables:
|
||||
# eval: (require 'org-make-toc)
|
||||
# before-save-hook: org-make-toc
|
||||
# End:
|
||||
|
|
@ -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.
|
||||
|
|
@ -1,53 +0,0 @@
|
|||
;;; org-bills-due.el
|
||||
|
||||
;;;; Initialize package system
|
||||
|
||||
(require 'package)
|
||||
(setq package-archives '(("gnu" . "https://elpa.gnu.org/packages/")
|
||||
("melpa" . "https://melpa.org/packages/")))
|
||||
(package-initialize)
|
||||
|
||||
;; Set load-path, loading org-ql from ~/src/emacs/org-ql (adjust as necessary)
|
||||
(setq load-path (append (list "~/src/emacs/org-ql"
|
||||
"~/.emacs.d/load-path")
|
||||
load-path))
|
||||
|
||||
;;;; Load packages
|
||||
|
||||
;; Built-in
|
||||
(require 'cl-lib)
|
||||
(require 'subr-x)
|
||||
|
||||
(require 'org)
|
||||
(require 'org-habit)
|
||||
(require 'org-agenda)
|
||||
|
||||
;; From MELPA
|
||||
(require 'dash)
|
||||
(require 's)
|
||||
|
||||
;; org-ql
|
||||
(require 'org-ql)
|
||||
(require 'org-ql-agenda)
|
||||
|
||||
;;;; Main
|
||||
|
||||
(-if-let* ((header "Bills due within 3 days")
|
||||
(items (org-ql "~/org/main.org"
|
||||
(and (deadline 3)
|
||||
(tags "bills"))
|
||||
:action (org-get-heading 'no-tags 'no-todo)))
|
||||
(string (concat "<ul>"
|
||||
(s-join ""
|
||||
(--map (concat "<li>" it "</li>")
|
||||
items))
|
||||
"</ul>")))
|
||||
(progn
|
||||
;; Send notification
|
||||
(call-process "notify-send" nil 0 nil
|
||||
(format "<b>%s</b>" header)
|
||||
string)
|
||||
;; Also output to STDOUT
|
||||
(princ (format "%s:\n%s" header (s-join "\n" titles))))
|
||||
;; No bills due
|
||||
(kill-emacs 1))
|
||||
235
helm-org-ql.el
235
helm-org-ql.el
|
|
@ -1,235 +0,0 @@
|
|||
;;; helm-org-ql.el --- Helm support 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:
|
||||
|
||||
;; This library includes Helm commands for `org-ql'. Note that Helm
|
||||
;; is not declared as a package dependency, so this does not cause
|
||||
;; Helm to be installed. In the future, this file may have its own
|
||||
;; package recipe, which would allow it to be installed separately and
|
||||
;; declare a dependency on Helm.
|
||||
|
||||
;;; License:
|
||||
|
||||
;; 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/>.
|
||||
|
||||
;;; Code:
|
||||
|
||||
;;;; Requirements
|
||||
|
||||
(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))
|
||||
|
||||
;;;; Variables
|
||||
|
||||
(defvar helm-org-ql-map
|
||||
(let ((map (make-sparse-keymap))
|
||||
(mappings '("C-x C-s" helm-org-ql-save)))
|
||||
(cl-loop for (key fn) on mappings by #'cddr
|
||||
do (define-key map (kbd key) fn))
|
||||
(make-composed-keymap map helm-map))
|
||||
"Keymap for `helm-org-ql' sessions.
|
||||
Based on `helm-map'.")
|
||||
|
||||
(defvar helm-org-ql-views-source
|
||||
(helm-make-source "Org QL Views" 'helm-source-sync
|
||||
:candidates (lambda ()
|
||||
(->> org-ql-views
|
||||
(-map #'car)
|
||||
(-sort #'string<)))
|
||||
:action (list (cons "Show view" #'org-ql-view)))
|
||||
"Helm source for `org-ql-views'.")
|
||||
|
||||
(defvar-local helm-org-ql-buffers-files nil
|
||||
"Used for `helm-org-ql-save'.")
|
||||
|
||||
;;;; Customization
|
||||
|
||||
(defgroup helm-org-ql nil
|
||||
"Options for `helm-org-ql'."
|
||||
:group 'org-ql
|
||||
:group 'helm)
|
||||
|
||||
(defcustom helm-org-ql-reverse-paths t
|
||||
"Whether to reverse Org outline paths in `helm-org-ql' results."
|
||||
:type 'boolean)
|
||||
|
||||
(defcustom helm-org-ql-input-idle-delay 0.25
|
||||
"Seconds to wait after typing stops before running query."
|
||||
:type 'number)
|
||||
|
||||
(defcustom helm-org-ql-actions
|
||||
(list (cons "Show heading in source buffer" 'helm-org-ql-show-marker)
|
||||
(cons "Show heading in indirect buffer" 'helm-org-ql-show-marker-indirect))
|
||||
"Alist of actions for `helm-org-ql' commands."
|
||||
:type '(alist :key-type (string :tag "Description")
|
||||
:value-type (function :tag "Command")))
|
||||
|
||||
;;;; Commands
|
||||
|
||||
;;;###autoload
|
||||
(cl-defun helm-org-ql (buffers-files
|
||||
&key (boolean 'and) (name "helm-org-ql"))
|
||||
"Display results in BUFFERS-FILES for an `org-ql' non-sexp query using Helm.
|
||||
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
|
||||
strings.
|
||||
|
||||
All query tokens are wrapped in the operator BOOLEAN (default
|
||||
`and'; with prefix, `or').
|
||||
|
||||
For example, this raw input:
|
||||
|
||||
Emacs git
|
||||
|
||||
Is transformed into this query:
|
||||
|
||||
(and \"Emacs\" \"git\")
|
||||
|
||||
However, quoted strings remain quoted, so this input:
|
||||
|
||||
\"something else\" (tags \"funny\")
|
||||
|
||||
Is transformed into this query:
|
||||
|
||||
(and \"something else\" (tags \"funny\"))"
|
||||
(interactive (list (current-buffer)))
|
||||
(let ((boolean (if current-prefix-arg 'or boolean))
|
||||
(helm-input-idle-delay helm-org-ql-input-idle-delay))
|
||||
(helm :prompt (format "Query (boolean %s): " (-> boolean symbol-name upcase))
|
||||
:sources (helm-org-ql-source buffers-files :name name))))
|
||||
|
||||
;;;###autoload
|
||||
(defun helm-org-ql-agenda-files ()
|
||||
"Search agenda files with `helm-org-ql', which see."
|
||||
(interactive)
|
||||
(helm-org-ql (org-agenda-files) :name "Org Agenda Files"))
|
||||
|
||||
;;;###autoload
|
||||
(defun helm-org-ql-org-directory ()
|
||||
"Search Org files in `org-directory' with `helm-org-ql'."
|
||||
(interactive)
|
||||
(helm-org-ql (org-ql-search-directories-files)
|
||||
:name "Org Directory Files"))
|
||||
|
||||
(defun helm-org-ql-show-marker (marker)
|
||||
"Show heading at MARKER."
|
||||
(interactive)
|
||||
;; This function is necessary because `helm-org-goto-marker' calls
|
||||
;; `re-search-backward' to go backward to the start of a heading,
|
||||
;; which, when the marker is already at the desired heading, causes
|
||||
;; 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))
|
||||
|
||||
(defun helm-org-ql-show-marker-indirect (marker)
|
||||
"Show heading at MARKER with `org-tree-to-indirect-buffer'."
|
||||
(interactive)
|
||||
(helm-org-ql-show-marker marker)
|
||||
(org-tree-to-indirect-buffer))
|
||||
|
||||
(defun helm-org-ql-save ()
|
||||
"Show `helm-org-ql' search in an `org-ql-search' buffer."
|
||||
(interactive)
|
||||
(let ((buffers-files (with-current-buffer (helm-buffer-get)
|
||||
helm-org-ql-buffers-files))
|
||||
(query (org-ql--query-string-to-sexp 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))
|
||||
|
||||
;;;; 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'."
|
||||
;; 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))
|
||||
(window-width (window-width (helm-window))))
|
||||
(when query
|
||||
(with-current-buffer (helm-buffer-get)
|
||||
(setq helm-org-ql-buffers-files buffers-files))
|
||||
(ignore-errors
|
||||
;; Ignore errors that might be caused by partially typed queries.
|
||||
(org-ql-select buffers-files query
|
||||
:action `(helm-org-ql--heading ,window-width))))))
|
||||
:match #'identity
|
||||
:fuzzy-match nil
|
||||
:multimatch nil
|
||||
:nohighlight t
|
||||
:volatile t
|
||||
:keymap helm-org-ql-map
|
||||
:action helm-org-ql-actions))
|
||||
|
||||
(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))
|
||||
;; 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
|
||||
;; I'd prefer not to do. Maybe I should add a feature to `org-ql' to
|
||||
;; call a setup function in a buffer before running queries.
|
||||
(let* ((prefix (concat (buffer-name) ":"))
|
||||
(width (- window-width (length prefix)))
|
||||
(heading (org-get-heading t))
|
||||
(path (-> (org-get-outline-path)
|
||||
(org-format-outline-path width nil " ")
|
||||
(org-split-string " ")))
|
||||
(path (if helm-org-ql-reverse-paths
|
||||
(concat heading "\\" (s-join "\\" (nreverse path)))
|
||||
(concat (s-join "/" path) "/" heading))))
|
||||
(cons (concat prefix path) (point-marker))))
|
||||
|
||||
;;;; Footer
|
||||
|
||||
(provide 'helm-org-ql)
|
||||
|
||||
;;; helm-org-ql.el ends here
|
||||
|
|
@ -1,22 +0,0 @@
|
|||
#!/bin/bash
|
||||
|
||||
# * Commit parameters
|
||||
# Unused now, but good for future reference. See man 5 githooks.
|
||||
|
||||
remote="$1"
|
||||
url="$2"
|
||||
|
||||
read local_ref local_sha remote_ref remote_sha
|
||||
|
||||
# * Run tests
|
||||
|
||||
# Not using sandbox and auto-install, because "git push" shouldn't
|
||||
# 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
|
||||
|
|
@ -1,202 +0,0 @@
|
|||
#!/bin/bash
|
||||
|
||||
# NOTE: Run "setxkbmap us" before running. See https://github.com/jordansissel/xdotool/issues/49
|
||||
|
||||
# NOTE: <f1> should be bound to this function in the Emacs window, like this:
|
||||
|
||||
# (global-set-key [f1]
|
||||
# (defun gif-screencast-start-or-stop ()
|
||||
# (interactive)
|
||||
# (if gif-screencast-mode
|
||||
# (progn
|
||||
# (gif-screencast-stop)
|
||||
# (setq gc-cons-threshold gc-cons-threshold-original))
|
||||
# (setq gc-cons-threshold-original gc-cons-threshold)
|
||||
# (setq gc-cons-threshold (* 1024 1024 500))
|
||||
# (gif-screencast))))
|
||||
|
||||
# * Functions
|
||||
|
||||
function ensure_window_name {
|
||||
if ! [[ $(xdotool getwindowfocus getwindowname) = $1 ]]
|
||||
then
|
||||
echo "Wrong window!" >&2
|
||||
exit 1
|
||||
fi
|
||||
}
|
||||
|
||||
function key {
|
||||
xdotool key "$@"
|
||||
}
|
||||
|
||||
function input {
|
||||
raw_input "$@"
|
||||
|
||||
# Correct for Helm's input idle delay by sending extra commands to
|
||||
# make the screenshots be taken. Not sure why two are necessary,
|
||||
# but they seem to be.
|
||||
key ctrl+p
|
||||
sleep 0.26
|
||||
key ctrl+p
|
||||
}
|
||||
|
||||
function raw_input {
|
||||
xdotool type --delay 200 "$@"
|
||||
}
|
||||
|
||||
# * Script
|
||||
|
||||
# No matter what I try, xdotool is not working properly to focus/raise/select
|
||||
# a window. And for some bizarre reason, the "xdotool selectwindow" command
|
||||
# outputs a completely different window ID than "xdotool search" outputs. In
|
||||
# fact, the window ID it outputs does not even appear in the output of
|
||||
# "xprop" for that window. I have no idea where it's getting that ID.
|
||||
|
||||
# So rather than cleanly selecting the proper window in the script, we have to
|
||||
# do a hacky workaround by sleeping and checking the name of the active
|
||||
# window.
|
||||
|
||||
sleep 3
|
||||
ensure_window_name "data.org"
|
||||
|
||||
# Start gif-screencast
|
||||
key F1
|
||||
sleep 5
|
||||
|
||||
# M-x helm-org-ql RET
|
||||
key alt+x
|
||||
sleep 0.2
|
||||
raw_input "helm-org-ql"
|
||||
key ctrl+e
|
||||
sleep 0.5
|
||||
key Return
|
||||
sleep 0.5
|
||||
|
||||
# "Emacs"
|
||||
input Emacs
|
||||
sleep 1
|
||||
|
||||
# "tags:Emacs"
|
||||
key ctrl+a
|
||||
input 'tags:'
|
||||
sleep 1.5
|
||||
|
||||
# "tags&:Emacs,elisp"
|
||||
key Left
|
||||
input "&"
|
||||
key ctrl+e
|
||||
input ",elisp"
|
||||
sleep 2
|
||||
|
||||
# "universe"
|
||||
key ctrl+a ctrl+k
|
||||
input "universe"
|
||||
sleep 1
|
||||
|
||||
# "tags:universe,space"
|
||||
key ctrl+a
|
||||
input "tags:"
|
||||
key ctrl+e
|
||||
input ",space"
|
||||
sleep 1
|
||||
|
||||
# "tags&:universe,space"
|
||||
key ctrl+a Right Right Right Right
|
||||
input "&"
|
||||
sleep 2
|
||||
|
||||
# "deadline:"
|
||||
key ctrl+a ctrl+k
|
||||
input "deadline:"
|
||||
sleep 2
|
||||
|
||||
# "deadline:to=2017-07-06"
|
||||
input "to=2019-10-06"
|
||||
sleep 2
|
||||
|
||||
# "deadline:to=2017-07-07"
|
||||
key BackSpace
|
||||
sleep 0.5
|
||||
input "7"
|
||||
sleep 2
|
||||
|
||||
# "scheduled:"
|
||||
key ctrl+a ctrl+k
|
||||
input "scheduled:"
|
||||
sleep 2
|
||||
|
||||
# "scheduled:on=2017-07-04"
|
||||
input "on=2019-10-04"
|
||||
sleep 1
|
||||
|
||||
# "scheduled:on=2017-07-05"
|
||||
key BackSpace
|
||||
sleep 0.5
|
||||
input "5"
|
||||
sleep 2
|
||||
|
||||
# property:agenda-group
|
||||
key ctrl+a ctrl+k
|
||||
input "property:agenda-group"
|
||||
sleep 2
|
||||
|
||||
# property:agenda-group=plans
|
||||
input "=plans"
|
||||
sleep 2
|
||||
|
||||
# category:ambition
|
||||
key ctrl+a ctrl+k
|
||||
input "category:ambition"
|
||||
sleep 2
|
||||
|
||||
# ts-inactive:
|
||||
key ctrl+a ctrl+k
|
||||
input "ts-inactive:"
|
||||
sleep 2
|
||||
|
||||
# closed:
|
||||
key ctrl+a ctrl+k
|
||||
input "closed:"
|
||||
sleep 2
|
||||
|
||||
# Show match in persistent buffer
|
||||
key ctrl+j
|
||||
sleep 2
|
||||
|
||||
# closed:on=2017-07-04 (which is a day too early)
|
||||
input "on=2019-10-04"
|
||||
sleep 2
|
||||
|
||||
# closed:on=2017-07-05 (which is the closed date)
|
||||
key BackSpace
|
||||
input 5
|
||||
sleep 2
|
||||
|
||||
# done:
|
||||
key ctrl+a ctrl+k
|
||||
input "done:"
|
||||
sleep 2
|
||||
|
||||
# "todo:"
|
||||
key ctrl+a ctrl+k
|
||||
input "todo:"
|
||||
sleep 2
|
||||
|
||||
# "todo: priority:"
|
||||
input " priority:"
|
||||
sleep 1
|
||||
|
||||
# "todo: priority:A"
|
||||
input "A"
|
||||
sleep 1
|
||||
|
||||
# "todo: priority:A,B"
|
||||
input ",B"
|
||||
sleep 2
|
||||
|
||||
# Save to a view buffer
|
||||
key ctrl+x ctrl+s
|
||||
sleep 2
|
||||
|
||||
# Stop the screencast
|
||||
key F1
|
||||
|
|
@ -1,166 +0,0 @@
|
|||
#!/bin/bash
|
||||
|
||||
# NOTE: Run "setxkbmap us" before running. See https://github.com/jordansissel/xdotool/issues/49
|
||||
|
||||
# NOTE: <f1> should be bound to this function in the Emacs window, like this:
|
||||
|
||||
# (global-set-key [f1]
|
||||
# (defun gif-screencast-start-or-stop ()
|
||||
# (interactive)
|
||||
# (if gif-screencast-mode
|
||||
# (progn
|
||||
# (gif-screencast-stop)
|
||||
# (setq gc-cons-threshold gc-cons-threshold-original))
|
||||
# (setq gc-cons-threshold-original gc-cons-threshold)
|
||||
# (setq gc-cons-threshold (* 1024 1024 500))
|
||||
# (gif-screencast))))
|
||||
|
||||
# * Functions
|
||||
|
||||
function ensure_window_name {
|
||||
if ! [[ $(xdotool getwindowfocus getwindowname) = $1 ]]
|
||||
then
|
||||
echo "Wrong window!" >&2
|
||||
exit 1
|
||||
fi
|
||||
}
|
||||
|
||||
function key {
|
||||
xdotool key "$@"
|
||||
}
|
||||
|
||||
function input {
|
||||
raw_input "$@"
|
||||
|
||||
# Correct for Helm's input idle delay by sending extra commands to
|
||||
# make the screenshots be taken. Not sure why two are necessary,
|
||||
# but they seem to be.
|
||||
key ctrl+p
|
||||
sleep 0.26
|
||||
key ctrl+p
|
||||
}
|
||||
|
||||
function raw_input {
|
||||
xdotool type --delay 200 "$@"
|
||||
}
|
||||
|
||||
function view-dispatch {
|
||||
key v
|
||||
sleep 2
|
||||
}
|
||||
function view-refresh {
|
||||
key r
|
||||
sleep 2
|
||||
}
|
||||
|
||||
function clear-input {
|
||||
key ctrl+a ctrl+k
|
||||
sleep 0.5
|
||||
}
|
||||
function set-field {
|
||||
key $1
|
||||
shift
|
||||
sleep 1
|
||||
clear-input
|
||||
raw_input "$@"
|
||||
sleep 1
|
||||
key Return
|
||||
sleep 1
|
||||
}
|
||||
|
||||
function set-field-with-unique-completion {
|
||||
# "$@" should be a unique completion.
|
||||
key $1
|
||||
shift
|
||||
sleep 0.5
|
||||
clear-input
|
||||
key Tab
|
||||
sleep 0.5
|
||||
raw_input "$@"
|
||||
key Tab
|
||||
sleep 0.75
|
||||
key Return
|
||||
sleep 1
|
||||
}
|
||||
|
||||
function complete-in-steps {
|
||||
# Assumes input is clear.
|
||||
key Tab
|
||||
sleep 0.75
|
||||
key Tab
|
||||
sleep 0.75
|
||||
|
||||
for s in "$@"
|
||||
do
|
||||
raw_input "$s"
|
||||
key Tab
|
||||
sleep 0.75
|
||||
done
|
||||
sleep 1
|
||||
}
|
||||
|
||||
# * Script
|
||||
|
||||
# No matter what I try, xdotool is not working properly to focus/raise/select
|
||||
# a window. And for some bizarre reason, the "xdotool selectwindow" command
|
||||
# outputs a completely different window ID than "xdotool search" outputs. In
|
||||
# fact, the window ID it outputs does not even appear in the output of
|
||||
# "xprop" for that window. I have no idea where it's getting that ID.
|
||||
|
||||
# So rather than cleanly selecting the proper window in the script, we have to
|
||||
# do a hacky workaround by sleeping and checking the name of the active
|
||||
# window.
|
||||
|
||||
sleep 3
|
||||
ensure_window_name "data.org"
|
||||
|
||||
# Start gif-screencast
|
||||
key F1
|
||||
sleep 2
|
||||
|
||||
# M-x org-ql-view RET, TAB, Ov TAB, Ag TAB, RET
|
||||
key alt+x
|
||||
sleep 0.2
|
||||
raw_input "org-ql-view"
|
||||
sleep 1
|
||||
key Return
|
||||
sleep 1
|
||||
|
||||
complete-in-steps Ov Ag
|
||||
key Return
|
||||
sleep 2
|
||||
|
||||
# Edit view.
|
||||
view-dispatch
|
||||
set-field t "Space-related"
|
||||
set-field q "tags:space,spaceship"
|
||||
set-field-with-unique-completion g pri
|
||||
view-refresh
|
||||
|
||||
# Save query
|
||||
view-dispatch
|
||||
key ctrl+s
|
||||
sleep 1
|
||||
key Return
|
||||
sleep 2
|
||||
|
||||
# New query: Ambition
|
||||
view-dispatch
|
||||
set-field t Ambition
|
||||
set-field q "category:ambition"
|
||||
set-field s "priority"
|
||||
set-field g "parent"
|
||||
view-refresh
|
||||
|
||||
view-dispatch
|
||||
set-field t "Upcoming: ambition"
|
||||
set-field g ts
|
||||
view-refresh
|
||||
|
||||
# Save view.
|
||||
view-dispatch
|
||||
key ctrl+s
|
||||
sleep 0.75
|
||||
key Return
|
||||
|
||||
key F1
|
||||
Binary file not shown.
|
Before Width: | Height: | Size: 833 KiB |
Binary file not shown.
|
Before Width: | Height: | Size: 92 KiB |
Binary file not shown.
|
Before Width: | Height: | Size: 86 KiB |
Binary file not shown.
|
Before Width: | Height: | Size: 202 KiB |
Binary file not shown.
|
Before Width: | Height: | Size: 1.8 MiB |
Binary file not shown.
|
Before Width: | Height: | Size: 640 KiB |
Binary file not shown.
|
Before Width: | Height: | Size: 53 KiB |
|
|
@ -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
|
||||
426
org-ql-search.el
426
org-ql-search.el
|
|
@ -1,426 +0,0 @@
|
|||
;;; 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
|
||||
|
||||
;;; Commentary:
|
||||
|
||||
;; This library is part of the package `org-ql'; it's not a standalone
|
||||
;; library. It implements search commands for Org buffers.
|
||||
|
||||
;;; License:
|
||||
|
||||
;; 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/>.
|
||||
|
||||
;;; Code:
|
||||
|
||||
;;;; Requirements
|
||||
|
||||
(require 'cl-lib)
|
||||
|
||||
(require 'dash)
|
||||
(require 'f)
|
||||
(require 'map)
|
||||
(require 'org-super-agenda)
|
||||
(require 's)
|
||||
|
||||
(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.")
|
||||
|
||||
;;;; Customization
|
||||
|
||||
(defgroup org-ql-search nil
|
||||
"Options for `org-ql-search' commands."
|
||||
:group 'org-ql)
|
||||
|
||||
(defcustom org-ql-search-directories-files-regexp "\.org$"
|
||||
"Regular expression to match Org filenames in `org-directory'.
|
||||
Files matching this regexp will be searched. By default,
|
||||
\".org\" files are matched, but you may also select to include
|
||||
\".org_archive\" files, or use a custom regexp."
|
||||
:type '(radio (const :tag "Normal \".org\" files" :value "\.org$")
|
||||
(const :tag "Also include \".org_archive\" files" "\.org\\(_archive\\)?$")
|
||||
(string :tag "Custom regular expression")))
|
||||
|
||||
(defcustom org-ql-search-directories-files-recursive nil
|
||||
"Recurse into subdirectories by default in `org-ql-search-directories-files'.
|
||||
This should probably be disabled by default, because
|
||||
e.g. `org-directory' may include deeply nested directories of
|
||||
non-Org files, such as a \".git\" directory, Org attachments
|
||||
directories, etc, which would make it slow to list the
|
||||
`org-directory' files recursively."
|
||||
:type 'boolean)
|
||||
|
||||
;;;; Commands
|
||||
|
||||
;;;###autoload
|
||||
(cl-defun org-ql-sparse-tree (query &key keep-previous (buffer (current-buffer)))
|
||||
"Show a sparse tree for QUERY in BUFFER and return number of results.
|
||||
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').
|
||||
|
||||
When KEEP-PREVIOUS is non-nil (interactively, with prefix), the
|
||||
outline is not reset to the overview state before finding
|
||||
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: ")
|
||||
:keep-previous current-prefix-arg))
|
||||
(with-current-buffer buffer
|
||||
(unless keep-previous
|
||||
;; We don't do highlighting, because queries aren't regexps, but
|
||||
;; 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))))
|
||||
(org-ql-select buffer query
|
||||
:action (lambda ()
|
||||
(org-ql--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)))
|
||||
(run-hooks 'org-occur-hook)
|
||||
(unless (get-buffer-window buffer)
|
||||
(pop-to-buffer buffer))
|
||||
(message "%d matches" num-results)
|
||||
num-results)))
|
||||
|
||||
;;;###autoload
|
||||
(cl-defun org-ql-search (buffers-files query &key narrow super-groups sort title
|
||||
(buffer org-ql-view-buffer))
|
||||
"Search for QUERY with `org-ql'.
|
||||
Interactively, prompt for these variables:
|
||||
|
||||
BUFFERS-FILES: A list of buffers and/or files to search.
|
||||
Interactively, may also be:
|
||||
|
||||
- `buffer': search the current buffer
|
||||
- `all': search all Org buffers
|
||||
- `agenda': search buffers returned by the function `org-agenda-files'
|
||||
- `directory': search Org files in `org-directory'
|
||||
- A space-separated list of file or buffer names
|
||||
|
||||
QUERY: An `org-ql' query in either sexp or non-sexp form (see
|
||||
Info node `(org-ql)Queries').
|
||||
|
||||
SUPER-GROUPS: An `org-super-agenda' group set. See variable
|
||||
`org-super-agenda-groups' and Info node `(org-super-agenda)Group
|
||||
selectors'.
|
||||
|
||||
NARROW: When non-nil, don't widen buffers before
|
||||
searching. Interactively, with prefix, leave narrowed.
|
||||
|
||||
SORT: One or a list of `org-ql' sorting functions, like `date' or
|
||||
`priority' (see Info node `(org-ql)Listing / acting-on results').
|
||||
|
||||
TITLE: An optional string displayed in the header.
|
||||
|
||||
BUFFER: Optionally, a buffer or name of a buffer in which to
|
||||
display the results. By default, the value of
|
||||
`org-ql-view-buffer' is used, and a new buffer is created if
|
||||
necessary."
|
||||
(declare (indent defun))
|
||||
(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)))
|
||||
: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'
|
||||
;; does not work reliably from inside a `let' form when the target buffer is current on entry
|
||||
;; to or exit from the `let', even though `make-local-variable' is actually done in
|
||||
;; `org-ql-view--display'. So we do all this within a temp buffer, which works around it.
|
||||
(with-temp-buffer
|
||||
(let* ((query (cl-etypecase query
|
||||
(string (if (or (string-prefix-p "(" query)
|
||||
(string-prefix-p "\"" query))
|
||||
;; Read sexp query.
|
||||
(read query)
|
||||
;; Parse non-sexp query into sexp query.
|
||||
(org-ql--query-string-to-sexp query)))
|
||||
(list query)))
|
||||
(results (org-ql-select buffers-files query
|
||||
:action 'element-with-markers
|
||||
:narrow narrow
|
||||
:sort sort))
|
||||
(strings (-map #'org-ql-view--format-element results))
|
||||
(buffer (or buffer (format "%s %s*" org-ql-view-buffer-name-prefix (or title query))))
|
||||
(header (org-ql-view--header-line-format
|
||||
:buffers-files buffers-files :query query :title title))
|
||||
;; Bind variables for `org-ql-view--display' to set.
|
||||
(org-ql-view-buffers-files buffers-files)
|
||||
(org-ql-view-query query)
|
||||
(org-ql-view-sort sort)
|
||||
(org-ql-view-narrow narrow)
|
||||
(org-ql-view-super-groups super-groups)
|
||||
(org-ql-view-title title))
|
||||
(when super-groups
|
||||
(let ((org-super-agenda-groups (cl-etypecase super-groups
|
||||
(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))))
|
||||
|
||||
;;;###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'.
|
||||
|
||||
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
|
||||
automatically from the query."
|
||||
(pcase-let ((`(,query . ,(map :header :sort)) args)
|
||||
(narrow-p) (old-beg) (old-end))
|
||||
(when-let* ((from (pcase org-agenda-restrict
|
||||
('nil (org-agenda-files nil 'ifmode))
|
||||
(_ (prog1 org-agenda-restrict
|
||||
(with-current-buffer org-agenda-restrict
|
||||
;; Narrow the buffer; remember to widen it later.
|
||||
(setf old-beg (point-min) old-end (point-max)
|
||||
narrow-p t)
|
||||
(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)))
|
||||
(when narrow-p
|
||||
;; Restore buffer's previous restrictions.
|
||||
(with-current-buffer from
|
||||
(narrow-to-region old-beg old-end)))
|
||||
;; Not sure if calling the prepare function is necessary, but let's follow the pattern.
|
||||
(org-agenda-prepare)
|
||||
;; 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
|
||||
: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 "\n"))))
|
||||
|
||||
;;;###autoload
|
||||
(defalias 'org-ql-block 'org-ql-search-block)
|
||||
|
||||
;;;; Dynamic blocks
|
||||
|
||||
;; This section implements support for Org dynamic blocks. See Info node `(org)Dynamic blocks'.
|
||||
|
||||
(require 'org-table)
|
||||
|
||||
(cl-defun org-dblock-write:org-ql (params)
|
||||
"Insert content for org-ql dynamic block at point according to PARAMS.
|
||||
Valid parameters include:
|
||||
|
||||
:query An Org QL query expression in either sexp or string
|
||||
form.
|
||||
|
||||
:columns A list of columns, including `heading', `todo',
|
||||
`property',`priority',`deadline',`scheduled',`closed'.
|
||||
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').
|
||||
|
||||
:take Optionally take a number of results from the front (a
|
||||
positive number) or the end (a negative number) of
|
||||
the results.
|
||||
|
||||
: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):
|
||||
|
||||
#+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))
|
||||
(list ;; SAFETY: Query is in sexp form: ask for confirmation, because it could contain arbitrary code.
|
||||
(org-ql--ask-unsafe-query query)
|
||||
query)))
|
||||
(columns (or columns '(heading todo (priority "P"))))
|
||||
;; MAYBE: Custom column functions.
|
||||
(format-fns
|
||||
;; NOTE: Backquoting this alist prevents the lambdas from seeing
|
||||
;; the variable `ts-format', so we use `list' and `cons'.
|
||||
(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)))))
|
||||
(cons 'priority (lambda (element)
|
||||
(--when-let (org-element-property :priority element)
|
||||
(char-to-string it))))
|
||||
(cons 'deadline (lambda (element)
|
||||
(--when-let (org-element-property :deadline element)
|
||||
(ts-format ts-format (ts-parse-org-element it)))))
|
||||
(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)))
|
||||
: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
|
||||
collect (or (pcase-exhaustive column
|
||||
((pred symbolp)
|
||||
(funcall (alist-get column format-fns) element))
|
||||
(`((,column . ,args) ,_header)
|
||||
(apply (alist-get column format-fns) element args))
|
||||
(`(,column ,_header)
|
||||
(funcall (alist-get column format-fns) element)))
|
||||
""))
|
||||
" | ")))
|
||||
;; Table header
|
||||
(insert "| " (string-join (--map (pcase it
|
||||
((pred symbolp) (capitalize (symbol-name it)))
|
||||
(`(,_ ,name) name))
|
||||
columns)
|
||||
" | ")
|
||||
" |" "\n")
|
||||
(insert "|- \n") ; Separator hline
|
||||
(dolist (element elements)
|
||||
(insert "| " (format-element element) " |" "\n"))
|
||||
(delete-char -1)
|
||||
(org-table-align))))
|
||||
|
||||
;;;; 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)
|
||||
(list org-directory)
|
||||
(user-error org-ql-search-directories-files-error)))
|
||||
(recurse org-ql-search-directories-files-recursive)
|
||||
(regexp org-ql-search-directories-files-regexp))
|
||||
"Return list of matching files in DIRECTORIES.
|
||||
When RECURSE is non-nil, recurse into subdirectories. When
|
||||
REGEXP is non-nil, only return files that match REGEXP."
|
||||
(let ((files (->> directories
|
||||
(--map (f-files it nil recurse))
|
||||
-flatten)))
|
||||
(if regexp
|
||||
(--select (string-match regexp it)
|
||||
files)
|
||||
files)))
|
||||
|
||||
;;;; Footer
|
||||
|
||||
(provide 'org-ql-search)
|
||||
|
||||
;;; org-ql-search.el ends here
|
||||
1208
org-ql-view.el
1208
org-ql-view.el
File diff suppressed because it is too large
Load diff
2230
org-ql.info
2230
org-ql.info
File diff suppressed because it is too large
Load diff
|
|
@ -1,16 +0,0 @@
|
|||
# This file is currently used to test org-file-tags.
|
||||
|
||||
#+FILETAGS: :food:
|
||||
|
||||
* Fruit :fruit:
|
||||
|
||||
** Blueberry
|
||||
|
||||
** Strawberry
|
||||
|
||||
* Vegetable :vegetable:
|
||||
|
||||
** Broccoli
|
||||
|
||||
** Potato
|
||||
|
||||
|
|
@ -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./
|
||||
|
||||
126
tests/data.org
126
tests/data.org
|
|
@ -1,126 +0,0 @@
|
|||
#+TODO: TODO TODAY NEXT STARTED IN-PROGRESS UNDERWAY WAITING SOMEDAY MAYBE CHECK | DONE CANCELED
|
||||
|
||||
# Will try to open the agenda view as if it was [2017-07-05 Wed]
|
||||
|
||||
* TODO [#A] Take over the universe :universe:ambition:
|
||||
DEADLINE: <2017-07-15 Sat -1m>
|
||||
:PROPERTIES:
|
||||
:agenda-group: plans
|
||||
:CATEGORY: ambition
|
||||
:END:
|
||||
|
||||
** TODO [#A] Take over the world :world:
|
||||
DEADLINE: <2017-07-07 Fri>
|
||||
|
||||
I'd like to be finished with this before the weekend...
|
||||
|
||||
*** TODO [#A] Skype with president of Antarctica :world:meetings:
|
||||
SCHEDULED: <2017-07-04 Tue 21:00>
|
||||
|
||||
Not sure what his timezone is...
|
||||
|
||||
** TODO [#B] Take over Mars
|
||||
|
||||
*** TODO Visit Mars :space:travel:planet:
|
||||
DEADLINE: <2017-09-20 Wed -3m>
|
||||
|
||||
Ah, the red planet...
|
||||
|
||||
** TODO [#C] Take over the moon
|
||||
|
||||
*** WAITING Visit the moon :space:travel:
|
||||
DEADLINE: <2017-08-27 Sun -2m>
|
||||
:LOGBOOK:
|
||||
- State "WAITING" from [2017-07-24 Mon 19:01]
|
||||
:END:
|
||||
|
||||
Just waiting on that callback from NASA...
|
||||
|
||||
** TODO Practice leaping tall buildings in a single bound :personal:
|
||||
SCHEDULED: <2017-07-05 Wed .+2d/3d>
|
||||
:PROPERTIES:
|
||||
:STYLE: habit
|
||||
:END:
|
||||
|
||||
** TODO [#B] Renew membership in supervillain club
|
||||
DEADLINE: <2017-07-10 Mon 23:59 -1w>
|
||||
|
||||
** DONE [#B] Learn universal sign language
|
||||
CLOSED: [2017-07-05 Wed 03:02]
|
||||
:PROPERTIES:
|
||||
:ID: 729de245-75fa-43b4-845a-57af61109485
|
||||
:END:
|
||||
:LOGBOOK:
|
||||
- CLOSING NOTE [2017-07-05 Wed 03:02] \\
|
||||
All done!
|
||||
CLOCK: [2017-07-05 Wed 02:00]--[2017-07-05 Wed 03:02] => 1:02
|
||||
:END:
|
||||
|
||||
* TODO Order a pizza :food:dinner:
|
||||
SCHEDULED: <2017-07-05 Wed 18:00>
|
||||
:PROPERTIES:
|
||||
:Effort: 5
|
||||
:END:
|
||||
|
||||
* TODO [#C] Get haircut :personal:@town:
|
||||
SCHEDULED: <2017-07-05 Wed>
|
||||
|
||||
Should probably do this before I take over the world. Want to look my best. (Not that it will matter once I'm in charge.)
|
||||
|
||||
* TODO [#B] Internet :bills:
|
||||
DEADLINE: <2017-07-21 Fri -1m>
|
||||
|
||||
* TODO [#A] Spaceship lease :bills:spaceship:
|
||||
DEADLINE: <2017-08-01 Tue -1m>
|
||||
:PROPERTIES:
|
||||
:agenda-group: bills
|
||||
:END:
|
||||
|
||||
* TODO [#B] Fix flux capacitor :spaceship:shopping:@computer:
|
||||
SCHEDULED: <2017-07-05 Wed>
|
||||
|
||||
If I don't, the frobnicator will probably fall off halfway to Mars...
|
||||
|
||||
Gotta buy one first, though. [[https://example.com/][This one]] looks suitable.
|
||||
|
||||
* Recurring
|
||||
:PROPERTIES:
|
||||
:agenda-group: recurring
|
||||
:END:
|
||||
|
||||
** CHECK /r/emacs :website:Emacs:
|
||||
DEADLINE: <2017-07-05 Wed .+1w>
|
||||
|
||||
+ [[http://reddit.com/r/emacs][Link to /r/emacs]]
|
||||
|
||||
** TODO Shop for groceries :food:shopping:@town:
|
||||
SCHEDULED: <2017-07-05 Wed +1w>
|
||||
:PROPERTIES:
|
||||
:Effort: 30
|
||||
:END:
|
||||
|
||||
** Sunrise/sunset
|
||||
|
||||
%%(org-super-agenda--test-diary-sunrise)
|
||||
%%(org-super-agenda--test-diary-sunset)
|
||||
|
||||
* Ideas
|
||||
:PROPERTIES:
|
||||
:CATEGORY: ideas
|
||||
:END:
|
||||
|
||||
** SOMEDAY Rewrite Emacs in Common Lisp :Emacs:elisp:computers:software:programming:
|
||||
SCHEDULED: <2017-07-05 Wed>
|
||||
:LOGBOOK:
|
||||
- State "SOMEDAY" from "MAYBE" [2017-07-24 Mon 18:59]
|
||||
- State "MAYBE" from [2017-07-24 Mon 18:58]
|
||||
:END:
|
||||
|
||||
I mean, since no one has ever tried doing it before...
|
||||
|
||||
** SOMEDAY Write a symphony :music:
|
||||
:PROPERTIES:
|
||||
:agenda-group: plans
|
||||
:END:
|
||||
|
||||
I don't know when I'll get to this, so it's undated.
|
||||
2370
tests/test-org-ql.el
2370
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