jiri/org-ql
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions
org-ql/examples.org
Adam Porter 7cb80552ba Docs: Update/add examples
2019-08-13 22:19:47 -05:00

4.6 KiB
Raw Blame History

org-ql examples

Contents

Stored views command

This defines a simple list of stored views and a command to easily access them with completion, which may be more convenient than defining a command for each view.

  (defun org-ql-view (&optional view)
    "Choose and display a stored `org-ql' view."
    (interactive (list (completing-read "View: " (mapcar #'car org-ql-views))))
    (funcall (alist-get view org-ql-views nil nil #'string=)))

  (setq org-ql-views
        (list (cons "Stuck Projects" (lambda ()
                                       (org-ql-agenda (org-agenda-files)
                                         (and (todo)
                                              (not (todo "TO-WATCH" "TO-READ" "MAYBE" "SOMEDAY"))
                                              (children)
                                              (not (children (todo)))
                                              (not (habit)))
                                         :title "Stuck Projects"
                                         :sort (priority date)
                                         :super-groups ((:name "Home" :tag "home")
                                                        (:tag ("Emacs" "computer") :order 100)
                                                        (:auto-parent t)
                                                        (:todo "WAITING")
                                                        (:auto-category t)))))))

Show entries with timestamps in the last N days 

  (cl-defun org-ql-agenda-last-days (days &optional (type 'ts))
    "Show entries from previous DAYS days with timestamps of TYPE.
  TYPE may be `ts', `ts-active', `ts-inactive', `clocked',
  `closed', `deadline', `planning', or `scheduled'."
    (interactive (list (read-number "Days: ")
                       (->> '(ts ts-active ts-inactive clocked closed deadline planning scheduled)
                            (completing-read "Timestamp type: ")
                            intern)))
    (let ((from (->> (ts-now)
                     (ts-adjust 'day (* -1 days))
                     (ts-apply :hour 0 :minute 0 :second 0)
                     ;; Formatting isn't required, but it looks better in the header than a struct.
                     ts-format)))
      (org-ql-search (org-agenda-files)
        `(,type :from ,from :to ,(ts-now)))))

  ;; Show entries with any timestamp from last 7 days:
  (org-ql-agenda-last-days 7)

  ;; Show entries clocked in last 7 days:
  (org-ql-agenda-last-days 30 'clocked)

  ;; Show entries closed in last 7 days:
  (org-ql-agenda-last-days 30 'closed)

Stuck projects block agenda

Reddit user emptymatrix shared this example of replacing a traditional org-stuck-projects view like:

  (setq org-stuck-projects
        '("+@project/-DONE" ("NEXT") nil "SCHEDULED:"))

With this org-ql-block agenda view, like:

  (setq org-agenda-custom-commands
        '(("s" "Stuck Projects"
           ((org-ql-block '(and (tags "@project")
                                (not (done))
                                (not (descendants (todo "NEXT")))
                                (not (descendants (scheduled)))))))))

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.

  (--map (list (org-element-property :raw-value it)
               (org-timestamp-format (org-element-property :deadline it) "%c"))
         (org-ql (org-agenda-files)
           (and (not (done))
                (tags "bills")
                (deadline <=))
           :sort deadline))
  ;;=> (("Electric bill" "Thu 23 Aug 2018 12:00:00 AM CDT")
  ;;    ("Rent" "Sat 01 Sep 2018 08:00:00 PM CDT"))

This could also be put in a script, which could use desktop notifications to remind of bills coming due: org-bills-due.el.