(feat): allow a custom heading for a backlinks section (#2333)

Allow the user to set a custom heading for a backlinks section in the org-roam buffer
This commit is contained in:
Tor Egil Hoftun Kvæstad
2024-07-03 20:56:42 +02:00
committed by GitHub
parent 94b826d759
commit 6644cb27a9
2 changed files with 7 additions and 3 deletions

View File

@ -2,6 +2,7 @@
## TBD ## TBD
### Breaking ### Breaking
### Added ### Added
- [#2333](https://github.com/org-roam/org-roam/pull/2333) buffer: allow a custom heading for a backlink section
- [#2449](https://github.com/org-roam/org-roam/pull/2449) extract rg-command builder function from unlinked-references - [#2449](https://github.com/org-roam/org-roam/pull/2449) extract rg-command builder function from unlinked-references
### Removed ### Removed
### Fixed ### Fixed

View File

@ -514,17 +514,20 @@ Sorts by title."
(string< (org-roam-node-title (org-roam-backlink-source-node a)) (string< (org-roam-node-title (org-roam-backlink-source-node a))
(org-roam-node-title (org-roam-backlink-source-node b)))) (org-roam-node-title (org-roam-backlink-source-node b))))
(cl-defun org-roam-backlinks-section (node &key (unique nil) (show-backlink-p nil)) (cl-defun org-roam-backlinks-section (node &key (unique nil) (show-backlink-p nil)
(section-heading "Backlinks:"))
"The backlinks section for NODE. "The backlinks section for NODE.
When UNIQUE is nil, show all positions where references are found. When UNIQUE is nil, show all positions where references are found.
When UNIQUE is t, limit to unique sources. When UNIQUE is t, limit to unique sources.
When SHOW-BACKLINK-P is not null, only show backlinks for which When SHOW-BACKLINK-P is not null, only show backlinks for which
this predicate is not nil." this predicate is not nil.
SECTION-HEADING is the string used as a heading for the backlink section."
(when-let ((backlinks (seq-sort #'org-roam-backlinks-sort (org-roam-backlinks-get node :unique unique)))) (when-let ((backlinks (seq-sort #'org-roam-backlinks-sort (org-roam-backlinks-get node :unique unique))))
(magit-insert-section (org-roam-backlinks) (magit-insert-section (org-roam-backlinks)
(magit-insert-heading "Backlinks:") (magit-insert-heading section-heading)
(dolist (backlink backlinks) (dolist (backlink backlinks)
(when (or (null show-backlink-p) (when (or (null show-backlink-p)
(and (not (null show-backlink-p)) (and (not (null show-backlink-p))