Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Changes in org-dblock-write:org-ql #184

Closed
wants to merge 5 commits into from
Closed

Changes in org-dblock-write:org-ql #184

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
87e7e95
Changes in org-dblock-write:org-ql
balaramadurai Jan 25, 2021
5baa0d6
Changed link and description of the dblock
balaramadurai Jan 26, 2021
35d305b
Changing the README.org for the PR#184
balaramadurai Jan 26, 2021
f15d0dc
:link option and file name options
balaramadurai Jan 29, 2021
c79b026
file name added to element list
balaramadurai Jan 29, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 2 additions & 1 deletion README.org
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -464,6 +464,7 @@ It would be expanded to:

Org QL provides a dynamic block that lists entries in the current document matching a query. In the header, these parameters are supported:

+ ~:file~: Any file that works in other org-ql queries, like `org-agenda-files'. Default value: current-buffer
+ ~:query~: An Org QL query expression in either sexp or non-sexp form.
+ ~:columns~ A list of columns, including ~heading~, ~todo~, ~property~, ~priority~, ~deadline~, ~scheduled~.
- 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")~.
Expand All @@ -479,7 +480,7 @@ For example, this dynamic block shows the first seven headings that are to-do it
# NOTE: These results are edited manually because the Org links don't display well in the Info manual.

#+BEGIN_SRC org
,#+BEGIN: org-ql :query "todo: priority:A,B" :columns (todo (priority "P") ((property "agenda-group") "Group") deadline heading) :sort (deadline priority) :take 7 :ts-format "%Y-%m-%d %H:%M"
,#+BEGIN: org-ql :query "todo: priority:A,B" :columns (todo (priority "P") ((property "agenda-group") "Group") deadline heading) :sort (deadline priority) :take 7 :ts-format "%Y-%m-%d %H:%M" :file org-agenda-files
| Todo | P | Group | Deadline | Heading |
|------+---+-------+------------------+---------------------------------------|
| TODO | A | | 2017-07-07 00:00 | Take over the world |
Expand Down
35 changes: 28 additions & 7 deletions org-ql-search.el
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -242,6 +242,9 @@ automatically from the query."
"Insert content for org-ql dynamic block at point according to PARAMS.
Valid parameters include:

:file Any file that works in other org-ql queries, like `org-agenda-files'.
Default value: current-buffer

:query An Org QL query expression in either sexp or string
form.

Expand All @@ -265,32 +268,50 @@ Valid parameters include:
positive number) or the end (a negative number) of
the results.

:link set this to non-nil for org-links to be there. If you leave this out or to nil, then no links in the headings.

:ts-format Optional format string used to format
timestamp-based columns.

For example, an org-ql dynamic block header could look like:

#+BEGIN: org-ql :query (todo \"UNDERWAY\") :columns (priority todo heading) :sort (priority date) :ts-format \"%Y-%m-%d %H:%M\""
(-let* (((&plist :query :columns :sort :ts-format :take) params)
#+BEGIN: org-ql :file org-agenda-files :query (todo \"UNDERWAY\") :columns (priority todo heading) :sort (priority date) :link t :ts-format \"%Y-%m-%d %H:%M\""
(-let* (((&plist :query :columns :sort :ts-format :take :link :file) 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"))))
(file (or file (current-buffer)))
;; 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)
(org-make-link-string (org-element-property :raw-value element)
(org-link-display-format
(org-element-property :raw-value element)))))
(--when-let (org-element-property :raw-value element)
(if (not link) it
(let ((search
(org-link-heading-search-string it)))
(org-link-make-string
(format "file:%s::%s" (org-element-property :file element) search)
;; Prune statistics cookies. Replace
;; links with their description, or
;; a plain link if there is none.
(org-trim
(org-link-display-format
(replace-regexp-in-string
"\\[[0-9]*\\(?:%\\|/[0-9]*\\)\\]" ""
it))))
)))))
(cons 'priority (lambda (element)
(--when-let (org-element-property :priority element)
(char-to-string it))))
(cons 'closed (lambda (element)
(--when-let (org-element-property :closed element)
(ts-format ts-format (ts-parse-org-element it)))))
(cons 'deadline (lambda (element)
(--when-let (org-element-property :deadline element)
(ts-format ts-format (ts-parse-org-element it)))))
Expand All @@ -299,9 +320,9 @@ For example, an org-ql dynamic block header could look like:
(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)
(elements (org-ql-query :from file
:where query
:select '(org-element-headline-parser (line-end-position))
:select 'element-with-markers
:order-by sort)))
(when take
(setf elements (cl-etypecase take
Expand Down
11 changes: 7 additions & 4 deletions org-ql.el
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -519,8 +519,10 @@ from within ELEMENT's buffer."
;; time? I don't know, but for now, it seems that we have to use `copy-marker'.
(let* ((marker (copy-marker (org-element-property :begin element)))
(properties (--> (cadr element)
(plist-put it :org-marker marker)
(plist-put it :org-hd-marker marker))))
(plist-put it :file buffer-file-name)
(plist-put it :org-marker marker)
(plist-put it :org-hd-marker marker)
)))
(setf (cadr element) properties)
element))

Expand Down Expand Up @@ -611,7 +613,8 @@ respectively."
(rx-to-string `(seq bol (group (zero-or-more (any " ")))
"#+begin_src"
(one-or-more (any " "))
,(or lang `(1+ (not (any " \n \f "))))
,(or lang `(1+ (not (any " \n \f
"))))
(zero-or-more (any " "))
(group (or (seq (zero-or-more (not (any "\n\":")))
"\""
Expand All @@ -620,7 +623,7 @@ respectively."
(zero-or-more (not (any "\n\":"))))
(zero-or-more (not (any "\n\":")))))
(group (zero-or-more (not (any "\n")))) "\n"
(63 (group (*\? (not (any ""))) "\n"))
(63 (group (*\? (not (any ""))) "\n"))
(zero-or-more (any " "))
"#+end_src")
t))
Expand Down