awesome-emacs/org-roam
1
0
Fork 0
mirror of https://github.com/org-roam/org-roam synced 2025-08-01 12:17:21 -05:00
Code Issues Packages Projects Releases Wiki Activity

(docs): document org-roam-buffer-window-parameters (#1180)

Browse Source 
also remove documentation on deprecated variable ~org-roam-buffer-no-delete-other-windows~
This commit is contained in:
Jethro Kuan
2020-10-10 22:28:29 +08:00
committed by GitHub
parent 82bd6c6cda
commit 02fda3adb1
2 changed files with 14 additions and 4 deletions
Download Patch File Download Diff File Expand all files Collapse all files

9
doc/org-roam.org
View File

@ -600,10 +600,15 @@ The Org-roam buffer displays backlinks for the currently active Org-roam note.
Height of ~org-roam-buffer~. Has an effect only if ~org-roam-buffer-position~ is
~'top~ or ~'bottom~.
- User Option: org-roam-buffer-no-delete-other-windows
- User Option: org-roam-buffer-window-parameters
The ~no-delete-window~ parameter for the org-roam buffer. Setting it to ~'t~ prevents the window from being deleted when calling ~delete-other-windows~.
Additional window parameters for the org-roam-buffer side window.
For example one can prevent the window from being deleted when calling
~delete-other-windows~, by setting it with the following:
~(setq org-roam-buffer-window-parameters '((no-other-window . t)))~
** Org-roam Files
Org-roam files are created and prefilled using Org-roam's templating

9
doc/org-roam.texi
View File

@ -842,9 +842,14 @@ Height of @code{org-roam-buffer}. Has an effect only if @code{org-roam-buffer-po
@code{'top} or @code{'bottom}.
@item
User Option: org-roam-buffer-no-delete-other-windows
User Option: org-roam-buffer-window-parameters
The @code{no-delete-window} parameter for the org-roam buffer. Setting it to @code{'t} prevents the window from being deleted when calling @code{delete-other-windows}.
Additional window parameters for the org-roam-buffer side window.
For example one can prevent the window from being deleted when calling
@code{delete-other-windows}, by setting it with the following:
@code{(setq org-roam-buffer-window-parameters '((no-other-window . t)))}
@end itemize
@node Org-roam Files