awesome-emacs/org-roam
1
0
Fork 0
mirror of https://github.com/org-roam/org-roam synced 2025-09-28 16:50:58 -05:00
Code Issues Packages Projects Releases Wiki Activity

(feat): formalize node dedicated buffers (#1622)

Browse Source 
This adds the whole new section in `org-roam-mode.el` for node dedicated
buffers, with a new global command `org-roam-buffer-display-dedicated`,
which supersedes `org-roam-buffer` command.

Along the way this also refactors the code for the persistent buffers to
clean it up, make it more clear in what it does, improve its robustness,
and to make it play nice with the dedicated buffers.
This commit is contained in:
Wetlize
2021-07-23 14:19:30 +03:00
committed by GitHub
parent 8e89bad945
commit d1e3a5d9be
5 changed files with 153 additions and 98 deletions
Download Patch File Download Diff File Expand all files Collapse all files

21
doc/org-roam.org
View File

@@ -447,19 +447,15 @@ Org-roam provides (see [[id:70083bfd-d1e3-42b9-bf83-5b05708791c0][Completion]]).
Org-roam provides the Org-roam buffer: an interface to view relationships with
other notes (backlinks, reference links, unlinked references etc.). There are
two main functions to use here:
two main commands to use here:
- ~org-roam-buffer~: Launch an Org-roam buffer for the current node at point.
- ~org-roam-buffer-toggle~: Launch an Org-roam buffer that tracks the node
currently at point. This means that the content of the buffer changes as the
point is moved, if necessary.
Use ~org-roam-buffer-toggle~ when you want wish for the Org-roam buffer to
buffer, call ~M-x org-roam-buffer~.
- Function: org-roam-buffer
Launch an Org-roam buffer for the current node at point.
- ~org-roam-buffer-display-dedicated~: Launch an Org-roam buffer for a specific
node without visiting its file. Unlike ~org-roam-buffer-toggle~ you can have
multiple such buffers and their content won't be automatically replaced with a
new node at point.
To bring up a buffer that tracks the current node at point, call ~M-x
org-roam-buffer-toggle~.
@@ -468,6 +464,13 @@ org-roam-buffer-toggle~.
Toggle display of the ~org-roam-buffer~.
To bring up a buffer that's dedicated for a specific node, call ~M-x
org-roam-buffer-display-dedicated~.
- Function: org-roam-buffer-display-dedicated
Launch node dedicated Org-roam buffer without visiting the node itself.
** Navigating the Org-roam Buffer
The Org-roam buffer uses ~magit-section~, making the typical ~magit-section~

22
doc/org-roam.texi
View File

@@ -716,23 +716,21 @@ other notes (backlinks, reference links, unlinked references etc.). There are
two main functions to use here:
@itemize
@item
@code{org-roam-buffer}: Launch an Org-roam buffer for the current node at point.
@item
@code{org-roam-buffer-toggle}: Launch an Org-roam buffer that tracks the node
currently at point. This means that the content of the buffer changes as the
point is moved, if necessary.
@item
@code{org-roam-buffer-display-dedicated}: Launch an Org-roam buffer for a
specific node without visiting its file. Unlike @code{org-roam-buffer-toggle} you
can have multiple such buffers and their content won't be automatically
replaced with a new node at point.
@end itemize
Use @code{org-roam-buffer-toggle} when you want wish for the Org-roam buffer to
buffer, call @code{M-x org-roam-buffer}.
@defun org-roam-buffer
Launch an Org-roam buffer for the current node at point.
@end defun
To bring up a buffer that tracks the current node at point, call @code{M-x
org-roam-buffer-toggle}.
@@ -741,6 +739,14 @@ org-roam-buffer-toggle}.
Toggle display of the @code{org-roam-buffer}.
@end defun
To bring up a buffer that's dedicated for a specific node, call @code{M-x
org-roam-buffer-display-dedicated}.
@defun org-roam-buffer-display-dedicated
Launch node dedicated Org-roam buffer without visiting the node itself.
@end defun
@menu
* Navigating the Org-roam Buffer::
* Configuring what is displayed in the buffer::