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

Added an option to not format headings as links #348

Open
wants to merge 4 commits into
base: master
Choose a base branch
from
Open

Added an option to not format headings as links #348

Changes from 1 commit
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
4e1d8f4
feat - Added an option to not format headings as links
OZoneGuy Apr 19, 2023
59e4a83
docs - Added option to the example query
OZoneGuy Apr 19, 2023
c632500
chore: undo white space changes
OZoneGuy Jan 7, 2024
1e1469b
refact: renamed property to `link`
OZoneGuy Jan 8, 2024
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
15 changes: 8 additions & 7 deletions org-ql-search.el
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -296,16 +296,17 @@ Valid parameters include:
:ts-format Optional format string used to format
timestamp-based columns.

:not-links Optional boolean. If non-nil, don't make headings
into links.
:link Optional flag. Defaults to `t`. When non-nil, links
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

+1 I was going to suggest this but see you already made that change.

are displayed as links, otherwise they are displayed
as plain text.

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\" :not-links t"
(-let* (((&plist :query :columns :sort :ts-format :take :not-links) params)
:ts-format \"%Y-%m-%d %H:%M\" :link t"
(-let* (((&plist :query :columns :sort :ts-format :take :link) 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.
Expand All @@ -321,9 +322,9 @@ this (must be a single line in the Org buffer):
(cons 'heading (lambda (element)
(let ((normalized-heading
(org-ql-search--link-heading-search-string (org-element-property :raw-value element))))
(if not-links
normalized-heading
(org-ql-search--org-make-link-string normalized-heading (org-link-display-format normalized-heading))))))
(pcase links
(t (org-ql-search--org-make-link-string normalized-heading (org-link-display-format normalized-heading)))
(nil normalized-heading)))))
(cons 'priority (lambda (element)
(--when-let (org-element-property :priority element)
(char-to-string it))))
Expand Down