You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardexpand all lines: README.org
+13-11
Original file line number
Diff line number
Diff line change
@@ -244,29 +244,30 @@ Arguments are listed next to predicate names, where applicable.
244
244
245
245
*** Date/time predicates
246
246
247
-
All of these predicates take optional keyword arguments ~:from~, ~:to:~, and ~:on~:
247
+
These predicates take optional keyword arguments:
248
248
249
-
+ If ~:from~, return non-nil if entry has a timestamp on or after ~:from~.
250
-
+ If ~:to~, return non-nil if entry has a timestamp on or before ~:to~.
251
-
+ If ~:on~, return non-nil if entry has a timestamp on date ~:on~.
249
+
+ ~:from~: Match entries whose timestamp is on or after timestamp ~:from~.
250
+
+ ~:to~: Match entries whose timestamp is on or before timestamp ~:to~.
251
+
+ ~:on~: Match entries whose timestamp is on date ~:on~.
252
+
+ ~:with-time~: If unspecified, match timestamps with or without times (i.e. HH:MM). If nil, match timestamps without times. If t, match timestamps with times.
252
253
253
-
Argument values should be either a number of days (positive to look forward, or negative to look backward), a ~ts~ struct, or a string parseable by ~parse-time-string~ (the string may omit the time value).
254
+
Timestamp/date arguments should be either a number of days (positive to look forward, or negative to look backward), a string parseable by ~parse-time-string~ (the string may omit the time value), or a ~ts~ struct.
254
255
255
256
+ *Predicates*
256
-
- =ts= :: Return non-nil if current entry has a timestamp in given period. If no arguments are specified, return non-nil if entry has any timestamp.
257
+
- =ts= :: Return non-nil if current entry has a timestamp in given period. Without arguments, return non-nil if entry has a timestamp.
257
258
- =ts-active=, =ts-a= :: Like =ts=, but only matches active timestamps.
258
259
- =ts-inactive=, =ts-i= :: Like =ts=, but only matches inactive timestamps.
259
260
260
261
The following predicates, in addition to the keyword arguments, can also take a single argument, a number, which looks backward or forward a number of days. The number can be negative to invert the direction.
261
262
262
263
+ *Backward-looking*
263
-
- =clocked= :: Return non-nil if current entry was clocked in given period. If no arguments are specified, return non-nil if entry was clocked at any time. Note: Clock entries are expected to be clocked out. Currently clocked entries (i.e. with unclosed timestamp ranges) are ignored.
264
-
- =closed= :: Return non-nil if current entry was closed in given period. If no arguments are specified, return non-nil if entry was closed at any time.
264
+
- =clocked= :: Return non-nil if current entry was clocked in given period. Without arguments, return non-nil if entry was ever clocked. Note: Clock entries are expected to be clocked out. Currently clocked entries (i.e. with unclosed timestamp ranges) are ignored.
265
+
- =closed= :: Return non-nil if current entry was closed in given period. Without arguments, return non-nil if entry is closed.
265
266
266
267
+ *Forward-looking*
267
-
- =deadline= :: Return non-nil if current entry has deadline in given period. If argument is =auto=, return non-nil if entry has deadline within =org-deadline-warning-days=. If no arguments are specified, return non-nil if entry has any deadline.
268
-
- =planning= :: Return non-nil if current entry has planning timestamp in given period (i.e. its deadline, scheduled, or closed timestamp). If no arguments are specified, return non-nil if entry is scheduled at any time.
269
-
- =scheduled= :: Return non-nil if current entry is scheduled in given period. If no arguments are specified, return non-nil if entry is scheduled at any time.
268
+
- =deadline= :: Return non-nil if current entry has deadline in given period. If argument is =auto=, return non-nil if entry has deadline within =org-deadline-warning-days=. Without arguments, return non-nil if entry has any deadline.
269
+
- =planning= :: Return non-nil if current entry has planning timestamp (i.e. its deadline, scheduled, or closed timestamp) in given period. Without arguments, return non-nil if entry has any planning timestamp.
270
+
- =scheduled= :: Return non-nil if current entry is scheduled in given period. Without arguments, return non-nil if entry is scheduled.
270
271
271
272
** Functions / Macros
272
273
:PROPERTIES:
@@ -523,6 +524,7 @@ Simple links may also be written manually in either sexp or non-sexp form, like:
523
524
+ Macro =org-ql-defpred=, used to define search predicates. (See [[file:examples/defpred.org][tutorial]].)
524
525
+ Predicate ~effort~.
525
526
+ Predicate ~heading-regexp~, which matches regular expressions against heading text (alias: ~h*~).
527
+
+ Timestamp-related predicates now accept an optional ~:with-time~ argument, which allows matching timestamps with or without times (i.e. HH:MM).
526
528
527
529
*Changed*
528
530
+ Helm support (including the command =helm-org-ql=) has been moved to a separate package, =helm-org-ql=.
0 commit comments