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

Deploying to gh-pages from @ d1e3a5d9be 🚀

Browse Source
This commit is contained in:
jethrokuan
2021-07-23 11:19:59 +00:00
parent 80387ade65
commit e1ed4b00c4
3 changed files with 42 additions and 27 deletions
Download Patch File Download Diff File Expand all files Collapse all files

26
manual.html
View File

@@ -862,22 +862,19 @@ other notes (backlinks, reference links, unlinked references etc.). There are
two main functions to use here:
</p>
<ul>
<li> <code>org-roam-buffer</code>: Launch an Org-roam buffer for the current node at point.
</li><li> <code>org-roam-buffer-toggle</code>: Launch an Org-roam buffer that tracks the node
<li> <code>org-roam-buffer-toggle</code>: 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.
</li><li> <code>org-roam-buffer-display-dedicated</code>: Launch an Org-roam buffer for a
specific node without visiting its file. Unlike <code>org-roam-buffer-toggle</code> you
can have multiple such buffers and their content won&rsquo;t be automatically
replaced with a new node at point.
</li></ul>
<p>Use <code>org-roam-buffer-toggle</code> when you want wish for the Org-roam buffer to
buffer, call <code>M-x org-roam-buffer</code>.
</p>
<dl>
<dt id="index-org_002droam_002dbuffer">Function: <strong>org-roam-buffer</strong></dt>
<dd>
<p>Launch an Org-roam buffer for the current node at point.
</p></dd></dl>
<p>To bring up a buffer that tracks the current node at point, call <code>M-x
org-roam-buffer-toggle</code>.
</p>
@@ -887,6 +884,15 @@ org-roam-buffer-toggle</code>.
<p>Toggle display of the <code>org-roam-buffer</code>.
</p></dd></dl>
<p>To bring up a buffer that&rsquo;s dedicated for a specific node, call <code>M-x
org-roam-buffer-display-dedicated</code>.
</p>
<dl>
<dt id="index-org_002droam_002dbuffer_002ddisplay_002ddedicated">Function: <strong>org-roam-buffer-display-dedicated</strong></dt>
<dd>
<p>Launch node dedicated Org-roam buffer without visiting the node itself.
</p></dd></dl>
<table class="menu" border="0" cellspacing="0">
<tr><td align="left" valign="top">&bull; <a href="#Navigating-the-Org_002droam-Buffer" accesskey="1">Navigating the Org-roam Buffer</a></td><td>&nbsp;&nbsp;</td><td align="left" valign="top">
</td></tr>
@@ -2429,7 +2435,7 @@ Next: <a href="#Variable-Index" accesskey="n" rel="next">Variable Index</a>, Pre
<tr><th id="Function-Index_fn_letter-O">O</th><td></td><td></td></tr>
<tr><td></td><td valign="top"><a href="#index-org_002droam_002dalias_002dadd"><code>org-roam-alias-add</code></a>:</td><td>&nbsp;</td><td valign="top"><a href="#Titles-and-Aliases">Titles and Aliases</a></td></tr>
<tr><td></td><td valign="top"><a href="#index-org_002droam_002dalias_002dremove"><code>org-roam-alias-remove</code></a>:</td><td>&nbsp;</td><td valign="top"><a href="#Titles-and-Aliases">Titles and Aliases</a></td></tr>
<tr><td></td><td valign="top"><a href="#index-org_002droam_002dbuffer"><code>org-roam-buffer</code></a>:</td><td>&nbsp;</td><td valign="top"><a href="#The-Org_002droam-Buffer">The Org-roam Buffer</a></td></tr>
<tr><td></td><td valign="top"><a href="#index-org_002droam_002dbuffer_002ddisplay_002ddedicated"><code>org-roam-buffer-display-dedicated</code></a>:</td><td>&nbsp;</td><td valign="top"><a href="#The-Org_002droam-Buffer">The Org-roam Buffer</a></td></tr>
<tr><td></td><td valign="top"><a href="#index-org_002droam_002dbuffer_002dtoggle"><code>org-roam-buffer-toggle</code></a>:</td><td>&nbsp;</td><td valign="top"><a href="#The-Org_002droam-Buffer">The Org-roam Buffer</a></td></tr>
<tr><td></td><td valign="top"><a href="#index-org_002droam_002dcapture_002d"><code>org-roam-capture-</code></a>:</td><td>&nbsp;</td><td valign="top"><a href="#Extending-the-Capture-System">Extending the Capture System</a></td></tr>
<tr><td></td><td valign="top"><a href="#index-org_002droam_002ddailies_002dcapture_002ddate"><code><code>org-roam-dailies-capture-date</code></code></a>:</td><td>&nbsp;</td><td valign="top"><a href="#Usage">Usage</a></td></tr>

21
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
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::