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

Deploying to gh-pages from @ 340215a16a 🚀

Browse Source
This commit is contained in:
jethrokuan
2021-08-29 11:33:45 +00:00
parent 15671bd38f
commit 1c730b7d64
3 changed files with 248 additions and 68 deletions
Download Patch File Download Diff File Expand all files Collapse all files

195
manual.html
View File

@@ -93,7 +93,9 @@ General Public License for more details.
</td></tr>
<tr><td align="left" valign="top">&bull; <a href="#Node-Properties" accesskey="8">Node Properties</a></td><td>&nbsp;&nbsp;</td><td align="left" valign="top">
</td></tr>
<tr><td align="left" valign="top">&bull; <a href="#Completion" accesskey="9">Completion</a></td><td>&nbsp;&nbsp;</td><td align="left" valign="top">
<tr><td align="left" valign="top">&bull; <a href="#Citations" accesskey="9">Citations</a></td><td>&nbsp;&nbsp;</td><td align="left" valign="top">
</td></tr>
<tr><td align="left" valign="top">&bull; <a href="#Completion">Completion</a></td><td>&nbsp;&nbsp;</td><td align="left" valign="top">
</td></tr>
<tr><td align="left" valign="top">&bull; <a href="#Encryption">Encryption</a></td><td>&nbsp;&nbsp;</td><td align="left" valign="top">
</td></tr>
@@ -125,6 +127,8 @@ General Public License for more details.
</td></tr>
<tr><td align="left" valign="top">&bull; <a href="#Variable-Index" rel="index">Variable Index</a></td><td>&nbsp;&nbsp;</td><td align="left" valign="top">
</td></tr>
<tr><td align="left" valign="top">&bull; <a href="#Bibliography-_00281_0029">Bibliography</a></td><td>&nbsp;&nbsp;</td><td align="left" valign="top">
</td></tr>
<tr><th colspan="3" align="left" valign="top"><pre class="menu-comment">
</pre></th></tr><tr><th colspan="3" align="left" valign="top"><pre class="menu-comment">&mdash; The Detailed Node Listing &mdash;
@@ -189,6 +193,12 @@ Node Properties
</td></tr>
<tr><th colspan="3" align="left" valign="top"><pre class="menu-comment">
Citations
</pre></th></tr><tr><td align="left" valign="top">&bull; <a href="#Using-the-Cached-Information">Using the Cached Information</a></td><td>&nbsp;&nbsp;</td><td align="left" valign="top">
</td></tr>
<tr><th colspan="3" align="left" valign="top"><pre class="menu-comment">
Completion
</pre></th></tr><tr><td align="left" valign="top">&bull; <a href="#Completing-within-Link-Brackets">Completing within Link Brackets</a></td><td>&nbsp;&nbsp;</td><td align="left" valign="top">
@@ -361,7 +371,7 @@ Next: <a href="#A-Brief-Introduction-to-the-Zettelkasten-Method" accesskey="n" r
<p>Org-roam is a tool that will appear unfriendly to anyone unfamiliar with Emacs
and Org-mode, but it is also extremely powerful to those willing to put effort
inn mastering the intricacies. Org-roam stands on the shoulders of giants. Emacs
in mastering the intricacies. Org-roam stands on the shoulders of giants. Emacs
was first created in 1976, and remains the tool of choice for many for editing
text and designing textual interfaces. The malleability of Emacs allowed the
creation of Org-mode, an all-purpose plain-text system for maintaining TODO
@@ -777,8 +787,8 @@ for notes. This variable needs to be set before any calls to Org-roam functions.
inside <code>org-roam-directory</code>: Org-roam does not resolve symbolic links.
</p>
<p>Next, we setup Org-roam to run functions on file changes to maintain cache
consistency. This is achieved by running <code>M-x org-roam-db-autosync-mode~</code>.
To ensure that Org-roam is available on startup, place this in your Emacs
consistency. This is achieved by running <code>M-x org-roam-db-autosync-mode</code>. To
ensure that Org-roam is available on startup, place this in your Emacs
configuration:
</p>
<div class="lisp">
@@ -1052,7 +1062,7 @@ Previous: <a href="#Configuring-the-Org_002droam-buffer-display" accesskey="p" r
<hr>
<span id="Node-Properties"></span><div class="header">
<p>
Next: <a href="#Completion" accesskey="n" rel="next">Completion</a>, Previous: <a href="#The-Org_002droam-Buffer" accesskey="p" rel="prev">The Org-roam Buffer</a>, Up: <a href="#Top" accesskey="u" rel="up">Top</a> &nbsp; [<a href="#Keystroke-Index" title="Index" rel="index">Index</a>]</p>
Next: <a href="#Citations" accesskey="n" rel="next">Citations</a>, Previous: <a href="#The-Org_002droam-Buffer" accesskey="p" rel="prev">The Org-roam Buffer</a>, Up: <a href="#Top" accesskey="u" rel="up">Top</a> &nbsp; [<a href="#Keystroke-Index" title="Index" rel="index">Index</a>]</p>
</div>
<span id="Node-Properties-1"></span><h2 class="chapter">8 Node Properties</h2>
@@ -1189,12 +1199,70 @@ ref to add.
<p>Remove a ref from the node at point.
</p></dd></dl>
<hr>
<span id="Citations"></span><div class="header">
<p>
Next: <a href="#Completion" accesskey="n" rel="next">Completion</a>, Previous: <a href="#Node-Properties" accesskey="p" rel="prev">Node Properties</a>, Up: <a href="#Top" accesskey="u" rel="up">Top</a> &nbsp; [<a href="#Keystroke-Index" title="Index" rel="index">Index</a>]</p>
</div>
<span id="Citations-1"></span><h2 class="chapter">9 Citations</h2>
<p>Since version 9.5, Org has first-class support for citations. Org-roam supports
the caching of both these in-built citations (of form <code>[cite:@key]</code>) and <a href="https://github.com/jkitchin/org-ref">org-ref</a>
citations (of form (NO<em>_ITEM</em><em>_DATA</em>:key)).
</p>
<p>Org-roam attempts to load both the <code>org-ref</code> and <code>org-cite</code> package when
indexing files, so no further setup from the user is required for citation
support.
</p>
<table class="menu" border="0" cellspacing="0">
<tr><td align="left" valign="top">&bull; <a href="#Using-the-Cached-Information" accesskey="1">Using the Cached Information</a></td><td>&nbsp;&nbsp;</td><td align="left" valign="top">
</td></tr>
</table>
<hr>
<span id="Using-the-Cached-Information"></span><div class="header">
<p>
Up: <a href="#Citations" accesskey="u" rel="up">Citations</a> &nbsp; [<a href="#Keystroke-Index" title="Index" rel="index">Index</a>]</p>
</div>
<span id="Using-the-Cached-Information-1"></span><h3 class="section">9.1 Using the Cached Information</h3>
<p>It is common to use take reference notes for academic papers. To designate the
node to be the canonical node for the academic paper, we can use its unique
citation key:
</p>
<div class="example">
<pre class="example">* Probabilistic Robotics
:PROPERTIES:
:ID: 51b7b82c-bbb4-4822-875a-ed548cffda10
:ROAM_REFS: @thrun2005probabilistic
:END:
</pre></div>
<p>for <code>org-cite</code>, or:
</p>
<div class="example">
<pre class="example">* Probabilistic Robotics
:PROPERTIES:
:ID: 51b7b82c-bbb4-4822-875a-ed548cffda10
:ROAM_REFS: cite:thrun2005probabilistic
:END:
</pre></div>
<p>for <code>org-ref</code>.
</p>
<p>When another node has a citation for that key, we can see it using the
<code>Reflinks</code> section of the Org-roam buffer.
</p>
<p>Extension developers may be interested in retrieving the citations within their
notes. This information can be found within the <code>citation</code> table of the Org-roam
database.
</p>
<hr>
<span id="Completion"></span><div class="header">
<p>
Next: <a href="#Encryption" accesskey="n" rel="next">Encryption</a>, Previous: <a href="#Node-Properties" accesskey="p" rel="prev">Node Properties</a>, Up: <a href="#Top" accesskey="u" rel="up">Top</a> &nbsp; [<a href="#Keystroke-Index" title="Index" rel="index">Index</a>]</p>
Next: <a href="#Encryption" accesskey="n" rel="next">Encryption</a>, Previous: <a href="#Citations" accesskey="p" rel="prev">Citations</a>, Up: <a href="#Top" accesskey="u" rel="up">Top</a> &nbsp; [<a href="#Keystroke-Index" title="Index" rel="index">Index</a>]</p>
</div>
<span id="Completion-1"></span><h2 class="chapter">9 Completion</h2>
<span id="Completion-1"></span><h2 class="chapter">10 Completion</h2>
<p>Completions for Org-roam are provided via <code>completion-at-point</code>. Org-roam
currently provides completions in two scenarios:
@@ -1225,7 +1293,7 @@ popularity is <a href="https://github.com/oantolin/orderless">orderless</a>.
<p>
Next: <a href="#Completing-anywhere" accesskey="n" rel="next">Completing anywhere</a>, Up: <a href="#Completion" accesskey="u" rel="up">Completion</a> &nbsp; [<a href="#Keystroke-Index" title="Index" rel="index">Index</a>]</p>
</div>
<span id="Completing-within-Link-Brackets-1"></span><h3 class="section">9.1 Completing within Link Brackets</h3>
<span id="Completing-within-Link-Brackets-1"></span><h3 class="section">10.1 Completing within Link Brackets</h3>
<p>Completions within link brackets are provided by
<code>org-roam-complete-link-at-point</code>.
@@ -1239,7 +1307,7 @@ of choice.
<p>
Previous: <a href="#Completing-within-Link-Brackets" accesskey="p" rel="prev">Completing within Link Brackets</a>, Up: <a href="#Completion" accesskey="u" rel="up">Completion</a> &nbsp; [<a href="#Keystroke-Index" title="Index" rel="index">Index</a>]</p>
</div>
<span id="Completing-anywhere-1"></span><h3 class="section">9.2 Completing anywhere</h3>
<span id="Completing-anywhere-1"></span><h3 class="section">10.2 Completing anywhere</h3>
<p>The same completions can be triggered anywhere for the symbol at point if not
within a bracketed link. This is provided by <code>org-roam-complete-everywhere</code>.
@@ -1265,7 +1333,7 @@ to <code>t</code>:
<p>
Next: <a href="#Org_002droam-Protocol" accesskey="n" rel="next">Org-roam Protocol</a>, Previous: <a href="#Completion" accesskey="p" rel="prev">Completion</a>, Up: <a href="#Top" accesskey="u" rel="up">Top</a> &nbsp; [<a href="#Keystroke-Index" title="Index" rel="index">Index</a>]</p>
</div>
<span id="Encryption-1"></span><h2 class="chapter">10 Encryption</h2>
<span id="Encryption-1"></span><h2 class="chapter">11 Encryption</h2>
<p>Emacs has support for creating and editing encrypted gpg files, and Org-roam need
not provide additional tooling. To create encrypted files, simply add the <code>.gpg</code>
@@ -1287,7 +1355,7 @@ should also ensure the database is encrypted.
<p>
Next: <a href="#The-Templating-System" accesskey="n" rel="next">The Templating System</a>, Previous: <a href="#Encryption" accesskey="p" rel="prev">Encryption</a>, Up: <a href="#Top" accesskey="u" rel="up">Top</a> &nbsp; [<a href="#Keystroke-Index" title="Index" rel="index">Index</a>]</p>
</div>
<span id="Org_002droam-Protocol-1"></span><h2 class="chapter">11 Org-roam Protocol</h2>
<span id="Org_002droam-Protocol-1"></span><h2 class="chapter">12 Org-roam Protocol</h2>
<p>Org-roam provides extensions for capturing content from external applications
such as the browser, via <code>org-protocol</code>. Org-roam extends <code>org-protocol</code> with 2
@@ -1307,7 +1375,7 @@ protocols: the <code>roam-node</code> and <code>roam-ref</code> protocols.
<p>
Next: <a href="#The-roam_002dnode-protocol" accesskey="n" rel="next">The roam-node protocol</a>, Up: <a href="#Org_002droam-Protocol" accesskey="u" rel="up">Org-roam Protocol</a> &nbsp; [<a href="#Keystroke-Index" title="Index" rel="index">Index</a>]</p>
</div>
<span id="Installation-2"></span><h3 class="section">11.1 Installation</h3>
<span id="Installation-2"></span><h3 class="section">12.1 Installation</h3>
<p>To enable Org-roam&rsquo;s protocol extensions, simply add the following to your init
file:
@@ -1333,7 +1401,7 @@ file:
<p>
Next: <a href="#Mac-OS" accesskey="n" rel="next">Mac OS</a>, Up: <a href="#Installation-_00281_0029" accesskey="u" rel="up">Installation (1)</a> &nbsp; [<a href="#Keystroke-Index" title="Index" rel="index">Index</a>]</p>
</div>
<span id="Linux-1"></span><h4 class="subsection">11.1.1 Linux</h4>
<span id="Linux-1"></span><h4 class="subsection">12.1.1 Linux</h4>
<p>For Linux users, create a desktop application in
<code>~/.local/share/applications/org-protocol.desktop</code>:
@@ -1380,7 +1448,7 @@ make the new policy take effect.
<p>
Next: <a href="#Windows" accesskey="n" rel="next">Windows</a>, Previous: <a href="#Linux" accesskey="p" rel="prev">Linux</a>, Up: <a href="#Installation-_00281_0029" accesskey="u" rel="up">Installation (1)</a> &nbsp; [<a href="#Keystroke-Index" title="Index" rel="index">Index</a>]</p>
</div>
<span id="Mac-OS-1"></span><h4 class="subsection">11.1.2 Mac OS</h4>
<span id="Mac-OS-1"></span><h4 class="subsection">12.1.2 Mac OS</h4>
<p>For Mac OS, we need to create our own application.
</p>
@@ -1449,7 +1517,7 @@ the default handler instead, run:
<p>
Previous: <a href="#Mac-OS" accesskey="p" rel="prev">Mac OS</a>, Up: <a href="#Installation-_00281_0029" accesskey="u" rel="up">Installation (1)</a> &nbsp; [<a href="#Keystroke-Index" title="Index" rel="index">Index</a>]</p>
</div>
<span id="Windows-1"></span><h4 class="subsection">11.1.3 Windows</h4>
<span id="Windows-1"></span><h4 class="subsection">12.1.3 Windows</h4>
<p>For Windows, create a temporary <code>org-protocol.reg</code> file:
</p>
@@ -1480,7 +1548,7 @@ file.
<p>
Next: <a href="#The-roam_002dref-protocol" accesskey="n" rel="next">The roam-ref protocol</a>, Previous: <a href="#Installation-_00281_0029" accesskey="p" rel="prev">Installation (1)</a>, Up: <a href="#Org_002droam-Protocol" accesskey="u" rel="up">Org-roam Protocol</a> &nbsp; [<a href="#Keystroke-Index" title="Index" rel="index">Index</a>]</p>
</div>
<span id="The-roam_002dnode-protocol-1"></span><h3 class="section">11.2 The roam-node protocol</h3>
<span id="The-roam_002dnode-protocol-1"></span><h3 class="section">12.2 The roam-node protocol</h3>
<p>The roam-node protocol opens the node with ID specified by the <code>node</code> key (e.g.
<code>org-protocol://roam-node?node=node-id</code>). <code>org-roam-graph</code> uses this to make the
@@ -1491,7 +1559,7 @@ graph navigable.
<p>
Previous: <a href="#The-roam_002dnode-protocol" accesskey="p" rel="prev">The roam-node protocol</a>, Up: <a href="#Org_002droam-Protocol" accesskey="u" rel="up">Org-roam Protocol</a> &nbsp; [<a href="#Keystroke-Index" title="Index" rel="index">Index</a>]</p>
</div>
<span id="The-roam_002dref-protocol-1"></span><h3 class="section">11.3 The roam-ref protocol</h3>
<span id="The-roam_002dref-protocol-1"></span><h3 class="section">12.3 The roam-ref protocol</h3>
<p>This protocol finds or creates a new note with a given <code>ROAM_REFS</code>:
</p>
@@ -1524,7 +1592,7 @@ Previous: <a href="#The-roam_002dnode-protocol" accesskey="p" rel="prev">The roa
<p>
Next: <a href="#Graphing" accesskey="n" rel="next">Graphing</a>, Previous: <a href="#Org_002droam-Protocol" accesskey="p" rel="prev">Org-roam Protocol</a>, Up: <a href="#Top" accesskey="u" rel="up">Top</a> &nbsp; [<a href="#Keystroke-Index" title="Index" rel="index">Index</a>]</p>
</div>
<span id="The-Templating-System-1"></span><h2 class="chapter">12 The Templating System</h2>
<span id="The-Templating-System-1"></span><h2 class="chapter">13 The Templating System</h2>
<p>Org-roam extends the <code>org-capture</code> system, providing a smoother note-taking
experience. However, these extensions mean Org-roam capture templates are
@@ -1547,7 +1615,7 @@ will be no prompt for template selection.
<p>
Next: <a href="#Org_002droam-Template-Expansion" accesskey="n" rel="next">Org-roam Template Expansion</a>, Up: <a href="#The-Templating-System" accesskey="u" rel="up">The Templating System</a> &nbsp; [<a href="#Keystroke-Index" title="Index" rel="index">Index</a>]</p>
</div>
<span id="Template-Walkthrough-1"></span><h3 class="section">12.1 Template Walkthrough</h3>
<span id="Template-Walkthrough-1"></span><h3 class="section">13.1 Template Walkthrough</h3>
<p>To demonstrate the additions made to org-capture templates. Here, we explain
the default template, reproduced below. You will find some most of the elements
@@ -1575,12 +1643,12 @@ here.
</li><li> <code>&quot;%?&quot;</code> is the template inserted on each call to <code>org-roam-capture-</code>.
This template means don&rsquo;t insert any content, but place the cursor here.
</li><li> <code>:target</code> is a compulsory specification in the Org-roam capture
template. The first element of the list indicates the type of the
target, the second element indicates the location of the captured
node, and the rest of the elements indicate prefilled template that
will be inserted and the position of the point will be adjusted for.
The latter behavior various from type to type of the capture target.
</li><li> <code>:target</code> is a compulsory specification in the Org-roam capture template. The
first element of the list indicates the type of the target, the second
element indicates the location of the captured node, and the rest of the
elements indicate prefilled template that will be inserted and the position
of the point will be adjusted for. The latter behavior various from type to
type of the capture target.
</li><li> <code>:unnarrowed t</code> tells org-capture to show the contents for the whole file,
rather than narrowing to just the entry. This is part of the Org-capture
@@ -1595,7 +1663,7 @@ customization options.
<p>
Previous: <a href="#Template-Walkthrough" accesskey="p" rel="prev">Template Walkthrough</a>, Up: <a href="#The-Templating-System" accesskey="u" rel="up">The Templating System</a> &nbsp; [<a href="#Keystroke-Index" title="Index" rel="index">Index</a>]</p>
</div>
<span id="Org_002droam-Template-Expansion-1"></span><h3 class="section">12.2 Org-roam Template Expansion</h3>
<span id="Org_002droam-Template-Expansion-1"></span><h3 class="section">13.2 Org-roam Template Expansion</h3>
<p>Org-roam&rsquo;s template definitions also extend org-capture&rsquo;s template syntax, to
allow prefilling of strings. We have seen a glimpse of this in <a href="#Template-Walkthrough">Template
@@ -1642,7 +1710,7 @@ minibuffer completion.
<p>
Next: <a href="#Org_002droam-Dailies" accesskey="n" rel="next">Org-roam Dailies</a>, Previous: <a href="#The-Templating-System" accesskey="p" rel="prev">The Templating System</a>, Up: <a href="#Top" accesskey="u" rel="up">Top</a> &nbsp; [<a href="#Keystroke-Index" title="Index" rel="index">Index</a>]</p>
</div>
<span id="Graphing-1"></span><h2 class="chapter">13 Graphing</h2>
<span id="Graphing-1"></span><h2 class="chapter">14 Graphing</h2>
<p>Org-roam provides basic graphing capabilities to explore interconnections
between notes, in <code>org-roam-graph</code>. This is done by performing SQL queries and
@@ -1709,7 +1777,7 @@ the second option to set the browser and network file path:
<p>
Up: <a href="#Graphing" accesskey="u" rel="up">Graphing</a> &nbsp; [<a href="#Keystroke-Index" title="Index" rel="index">Index</a>]</p>
</div>
<span id="Graph-Options-1"></span><h3 class="section">13.1 Graph Options</h3>
<span id="Graph-Options-1"></span><h3 class="section">14.1 Graph Options</h3>
<p>Graphviz provides many options for customizing the graph output, and Org-roam
supports some of them. See <a href="https://graphviz.gitlab.io/_pages/doc/info/attrs.html">https://graphviz.gitlab.io/_pages/doc/info/attrs.html</a>
@@ -1748,7 +1816,7 @@ Example: <code>'((&quot;dir&quot; . &quot;back&quot;))</code>
<p>
Next: <a href="#Performance-Optimization" accesskey="n" rel="next">Performance Optimization</a>, Previous: <a href="#Graphing" accesskey="p" rel="prev">Graphing</a>, Up: <a href="#Top" accesskey="u" rel="up">Top</a> &nbsp; [<a href="#Keystroke-Index" title="Index" rel="index">Index</a>]</p>
</div>
<span id="Org_002droam-Dailies-1"></span><h2 class="chapter">14 Org-roam Dailies</h2>
<span id="Org_002droam-Dailies-1"></span><h2 class="chapter">15 Org-roam Dailies</h2>
<p>Org-roam provides journaling capabilities akin to
Org-journal with <code>org-roam-dailies</code>.
@@ -1765,7 +1833,7 @@ Org-journal with <code>org-roam-dailies</code>.
<p>
Next: <a href="#Usage" accesskey="n" rel="next">Usage</a>, Up: <a href="#Org_002droam-Dailies" accesskey="u" rel="up">Org-roam Dailies</a> &nbsp; [<a href="#Keystroke-Index" title="Index" rel="index">Index</a>]</p>
</div>
<span id="Configuration-1"></span><h3 class="section">14.1 Configuration</h3>
<span id="Configuration-1"></span><h3 class="section">15.1 Configuration</h3>
<p>For <code>org-roam-dailies</code> to work, you need to define two variables:
</p>
@@ -1800,7 +1868,7 @@ Next: <a href="#Usage" accesskey="n" rel="next">Usage</a>, Up: <a href="#Org_002
<p>
Previous: <a href="#Configuration" accesskey="p" rel="prev">Configuration</a>, Up: <a href="#Org_002droam-Dailies" accesskey="u" rel="up">Org-roam Dailies</a> &nbsp; [<a href="#Keystroke-Index" title="Index" rel="index">Index</a>]</p>
</div>
<span id="Usage-1"></span><h3 class="section">14.2 Usage</h3>
<span id="Usage-1"></span><h3 class="section">15.2 Usage</h3>
<p><code>org-roam-dailies</code> provides these interactive functions:
</p>
@@ -1878,7 +1946,7 @@ creating an entry.
<p>
Next: <a href="#The-Org_002dmode-Ecosystem" accesskey="n" rel="next">The Org-mode Ecosystem</a>, Previous: <a href="#Org_002droam-Dailies" accesskey="p" rel="prev">Org-roam Dailies</a>, Up: <a href="#Top" accesskey="u" rel="up">Top</a> &nbsp; [<a href="#Keystroke-Index" title="Index" rel="index">Index</a>]</p>
</div>
<span id="Performance-Optimization-1"></span><h2 class="chapter">15 Performance Optimization</h2>
<span id="Performance-Optimization-1"></span><h2 class="chapter">16 Performance Optimization</h2>
<table class="menu" border="0" cellspacing="0">
<tr><td align="left" valign="top">&bull; <a href="#Garbage-Collection" accesskey="1">Garbage Collection</a></td><td>&nbsp;&nbsp;</td><td align="left" valign="top">
@@ -1890,7 +1958,7 @@ Next: <a href="#The-Org_002dmode-Ecosystem" accesskey="n" rel="next">The Org-mod
<p>
Up: <a href="#Performance-Optimization" accesskey="u" rel="up">Performance Optimization</a> &nbsp; [<a href="#Keystroke-Index" title="Index" rel="index">Index</a>]</p>
</div>
<span id="Garbage-Collection-1"></span><h3 class="section">15.1 Garbage Collection</h3>
<span id="Garbage-Collection-1"></span><h3 class="section">16.1 Garbage Collection</h3>
<p>During the cache-build process, Org-roam generates a lot of in-memory
data-structures (such as the Org file&rsquo;s AST), which are discarded after use.
@@ -1910,7 +1978,7 @@ operations. To reduce the number of garbage collection processes, one may set
<p>
Next: <a href="#FAQ" accesskey="n" rel="next">FAQ</a>, Previous: <a href="#Performance-Optimization" accesskey="p" rel="prev">Performance Optimization</a>, Up: <a href="#Top" accesskey="u" rel="up">Top</a> &nbsp; [<a href="#Keystroke-Index" title="Index" rel="index">Index</a>]</p>
</div>
<span id="The-Org_002dmode-Ecosystem-1"></span><h2 class="chapter">16 The Org-mode Ecosystem</h2>
<span id="The-Org_002dmode-Ecosystem-1"></span><h2 class="chapter">17 The Org-mode Ecosystem</h2>
<p>Because Org-roam is built on top of Org-mode, it benefits from the vast number
of packages already available.
@@ -1941,7 +2009,7 @@ of packages already available.
<p>
Next: <a href="#Versioning-Notes" accesskey="n" rel="next">Versioning Notes</a>, Up: <a href="#The-Org_002dmode-Ecosystem" accesskey="u" rel="up">The Org-mode Ecosystem</a> &nbsp; [<a href="#Keystroke-Index" title="Index" rel="index">Index</a>]</p>
</div>
<span id="Browsing-History-with-winner_002dmode-1"></span><h3 class="section">16.1 Browsing History with winner-mode</h3>
<span id="Browsing-History-with-winner_002dmode-1"></span><h3 class="section">17.1 Browsing History with winner-mode</h3>
<p><code>winner-mode</code> is a global minor mode that allows one to undo and redo changes in
the window configuration. It is included with GNU Emacs since version 20.
@@ -1964,7 +2032,7 @@ interactive functions:
<p>
Next: <a href="#Full_002dtext-search-with-Deft" accesskey="n" rel="next">Full-text search with Deft</a>, Previous: <a href="#Browsing-History-with-winner_002dmode" accesskey="p" rel="prev">Browsing History with winner-mode</a>, Up: <a href="#The-Org_002dmode-Ecosystem" accesskey="u" rel="up">The Org-mode Ecosystem</a> &nbsp; [<a href="#Keystroke-Index" title="Index" rel="index">Index</a>]</p>
</div>
<span id="Versioning-Notes-1"></span><h3 class="section">16.2 Versioning Notes</h3>
<span id="Versioning-Notes-1"></span><h3 class="section">17.2 Versioning Notes</h3>
<p>Since Org-roam notes are just plain text, it is trivial to track changes in your
notes database using version control systems such as <a href="https://git-scm.com/">Git</a>. Simply initialize
@@ -1980,7 +2048,7 @@ versions of a tracked Org-roam note.
<p>
Next: <a href="#Org_002djournal" accesskey="n" rel="next">Org-journal</a>, Previous: <a href="#Versioning-Notes" accesskey="p" rel="prev">Versioning Notes</a>, Up: <a href="#The-Org_002dmode-Ecosystem" accesskey="u" rel="up">The Org-mode Ecosystem</a> &nbsp; [<a href="#Keystroke-Index" title="Index" rel="index">Index</a>]</p>
</div>
<span id="Full_002dtext-search-with-Deft-1"></span><h3 class="section">16.3 Full-text search with Deft</h3>
<span id="Full_002dtext-search-with-Deft-1"></span><h3 class="section">17.3 Full-text search with Deft</h3>
<p><a href="https://jblevins.org/projects/deft/">Deft</a> provides a nice interface for browsing and filtering org-roam notes.
</p>
@@ -2004,7 +2072,7 @@ Next: <a href="#Org_002djournal" accesskey="n" rel="next">Org-journal</a>, Previ
<p>
Next: <a href="#Org_002ddownload" accesskey="n" rel="next">Org-download</a>, Previous: <a href="#Full_002dtext-search-with-Deft" accesskey="p" rel="prev">Full-text search with Deft</a>, Up: <a href="#The-Org_002dmode-Ecosystem" accesskey="u" rel="up">The Org-mode Ecosystem</a> &nbsp; [<a href="#Keystroke-Index" title="Index" rel="index">Index</a>]</p>
</div>
<span id="Org_002djournal-1"></span><h3 class="section">16.4 Org-journal</h3>
<span id="Org_002djournal-1"></span><h3 class="section">17.4 Org-journal</h3>
<p><a href="https://github.com/bastibe/org-journal">Org-journal</a> provides journaling capabilities to Org-mode. A lot of its
functionalities have been incorporated into Org-roam under the name
@@ -2027,7 +2095,7 @@ journal entries from the ideas you would write on a scratchpad.
<p>
Next: <a href="#mathpixel" accesskey="n" rel="next">mathpixel</a>, Previous: <a href="#Org_002djournal" accesskey="p" rel="prev">Org-journal</a>, Up: <a href="#The-Org_002dmode-Ecosystem" accesskey="u" rel="up">The Org-mode Ecosystem</a> &nbsp; [<a href="#Keystroke-Index" title="Index" rel="index">Index</a>]</p>
</div>
<span id="Org_002ddownload-1"></span><h3 class="section">16.5 Org-download</h3>
<span id="Org_002ddownload-1"></span><h3 class="section">17.5 Org-download</h3>
<p><a href="https://github.com/abo-abo/org-download">Org-download</a> lets you screenshot and yank images from the web into your notes:
</p>
@@ -2049,7 +2117,7 @@ Next: <a href="#mathpixel" accesskey="n" rel="next">mathpixel</a>, Previous: <a
<p>
Next: <a href="#Org_002dnoter-_002f-Interleave" accesskey="n" rel="next">Org-noter / Interleave</a>, Previous: <a href="#Org_002ddownload" accesskey="p" rel="prev">Org-download</a>, Up: <a href="#The-Org_002dmode-Ecosystem" accesskey="u" rel="up">The Org-mode Ecosystem</a> &nbsp; [<a href="#Keystroke-Index" title="Index" rel="index">Index</a>]</p>
</div>
<span id="mathpix_002eel"></span><h3 class="section">16.6 mathpix.el</h3>
<span id="mathpix_002eel"></span><h3 class="section">17.6 mathpix.el</h3>
<p><a href="https://github.com/jethrokuan/mathpix.el">mathpix.el</a> uses <a href="https://mathpix.com/">Mathpix&rsquo;s</a> API to convert clips into latex equations:
</p>
@@ -2071,7 +2139,7 @@ Next: <a href="#Org_002dnoter-_002f-Interleave" accesskey="n" rel="next">Org-not
<p>
Next: <a href="#Bibliography" accesskey="n" rel="next">Bibliography</a>, Previous: <a href="#mathpixel" accesskey="p" rel="prev">mathpixel</a>, Up: <a href="#The-Org_002dmode-Ecosystem" accesskey="u" rel="up">The Org-mode Ecosystem</a> &nbsp; [<a href="#Keystroke-Index" title="Index" rel="index">Index</a>]</p>
</div>
<span id="Org_002dnoter-_002f-Interleave-1"></span><h3 class="section">16.7 Org-noter / Interleave</h3>
<span id="Org_002dnoter-_002f-Interleave-1"></span><h3 class="section">17.7 Org-noter / Interleave</h3>
<p><a href="https://github.com/weirdNox/org-noter">Org-noter</a> and <a href="https://github.com/rudolfochrist/interleave">Interleave</a> are both projects that allow synchronised annotation of
documents (PDF, EPUB etc.) within Org-mode.
@@ -2081,7 +2149,7 @@ documents (PDF, EPUB etc.) within Org-mode.
<p>
Next: <a href="#Spaced-Repetition" accesskey="n" rel="next">Spaced Repetition</a>, Previous: <a href="#Org_002dnoter-_002f-Interleave" accesskey="p" rel="prev">Org-noter / Interleave</a>, Up: <a href="#The-Org_002dmode-Ecosystem" accesskey="u" rel="up">The Org-mode Ecosystem</a> &nbsp; [<a href="#Keystroke-Index" title="Index" rel="index">Index</a>]</p>
</div>
<span id="Bibliography-1"></span><h3 class="section">16.8 Bibliography</h3>
<span id="Bibliography-1"></span><h3 class="section">17.8 Bibliography</h3>
<p><a href="https://github.com/org-roam/org-roam-bibtex">org-roam-bibtex</a> offers tight integration between <a href="https://github.com/jkitchin/org-ref">org-ref</a>, <a href="https://github.com/tmalsburg/helm-bibtex">helm-bibtex</a> and
<code>org-roam</code>. This helps you manage your bibliographic notes under <code>org-roam</code>.
@@ -2095,7 +2163,7 @@ file with the right <code>ROAM_REFS</code>.
<p>
Previous: <a href="#Bibliography" accesskey="p" rel="prev">Bibliography</a>, Up: <a href="#The-Org_002dmode-Ecosystem" accesskey="u" rel="up">The Org-mode Ecosystem</a> &nbsp; [<a href="#Keystroke-Index" title="Index" rel="index">Index</a>]</p>
</div>
<span id="Spaced-Repetition-1"></span><h3 class="section">16.9 Spaced Repetition</h3>
<span id="Spaced-Repetition-1"></span><h3 class="section">17.9 Spaced Repetition</h3>
<p><a href="https://www.leonrische.me/fc/index.html">Org-fc</a> is a spaced repetition system that scales well with a large number of
files. Other alternatives include <a href="https://orgmode.org/worg/org-contrib/org-drill.html">org-drill</a>, and <a href="https://github.com/abo-abo/pamparam">pamparam</a>.
@@ -2108,7 +2176,7 @@ Org-mode, and sync your cards to Anki via <a href="https://github.com/FooSoft/an
<p>
Next: <a href="#Migrating-from-Org_002droam-v1" accesskey="n" rel="next">Migrating from Org-roam v1</a>, Previous: <a href="#The-Org_002dmode-Ecosystem" accesskey="p" rel="prev">The Org-mode Ecosystem</a>, Up: <a href="#Top" accesskey="u" rel="up">Top</a> &nbsp; [<a href="#Keystroke-Index" title="Index" rel="index">Index</a>]</p>
</div>
<span id="FAQ-1"></span><h2 class="chapter">17 FAQ</h2>
<span id="FAQ-1"></span><h2 class="chapter">18 FAQ</h2>
<table class="menu" border="0" cellspacing="0">
<tr><td align="left" valign="top">&bull; <a href="#How-do-I-have-more-than-one-Org_002droam-directory_003f" accesskey="1">How do I have more than one Org-roam directory?</a></td><td>&nbsp;&nbsp;</td><td align="left" valign="top">
@@ -2126,7 +2194,7 @@ Next: <a href="#Migrating-from-Org_002droam-v1" accesskey="n" rel="next">Migrati
<p>
Next: <a href="#How-do-I-migrate-from-Roam-Research_003f" accesskey="n" rel="next">How do I migrate from Roam Research?</a>, Up: <a href="#FAQ" accesskey="u" rel="up">FAQ</a> &nbsp; [<a href="#Keystroke-Index" title="Index" rel="index">Index</a>]</p>
</div>
<span id="How-do-I-have-more-than-one-Org_002droam-directory_003f-1"></span><h3 class="section">17.1 How do I have more than one Org-roam directory?</h3>
<span id="How-do-I-have-more-than-one-Org_002droam-directory_003f-1"></span><h3 class="section">18.1 How do I have more than one Org-roam directory?</h3>
<p>Emacs supports directory-local variables, allowing the value of
<code>org-roam-directory</code> to be different in different directories. It does this by
@@ -2150,7 +2218,7 @@ that directory, at least once.
<p>
Next: <a href="#How-do-I-create-a-note-whose-title-already-matches-one-of-the-candidates_003f" accesskey="n" rel="next">How do I create a note whose title already matches one of the candidates?</a>, Previous: <a href="#How-do-I-have-more-than-one-Org_002droam-directory_003f" accesskey="p" rel="prev">How do I have more than one Org-roam directory?</a>, Up: <a href="#FAQ" accesskey="u" rel="up">FAQ</a> &nbsp; [<a href="#Keystroke-Index" title="Index" rel="index">Index</a>]</p>
</div>
<span id="How-do-I-migrate-from-Roam-Research_003f-1"></span><h3 class="section">17.2 How do I migrate from Roam Research?</h3>
<span id="How-do-I-migrate-from-Roam-Research_003f-1"></span><h3 class="section">18.2 How do I migrate from Roam Research?</h3>
<p>Fabio has produced a command-line tool that converts markdown files exported
from Roam Research into Org-roam compatible markdown. More instructions are
@@ -2161,7 +2229,7 @@ provided <a href="https://github.com/fabioberger/roam-migration">in the reposito
<p>
Next: <a href="#How-can-I-stop-Org_002droam-from-creating-IDs-everywhere_003f" accesskey="n" rel="next">How can I stop Org-roam from creating IDs everywhere?</a>, Previous: <a href="#How-do-I-migrate-from-Roam-Research_003f" accesskey="p" rel="prev">How do I migrate from Roam Research?</a>, Up: <a href="#FAQ" accesskey="u" rel="up">FAQ</a> &nbsp; [<a href="#Keystroke-Index" title="Index" rel="index">Index</a>]</p>
</div>
<span id="How-do-I-create-a-note-whose-title-already-matches-one-of-the-candidates_003f-1"></span><h3 class="section">17.3 How do I create a note whose title already matches one of the candidates?</h3>
<span id="How-do-I-create-a-note-whose-title-already-matches-one-of-the-candidates_003f-1"></span><h3 class="section">18.3 How do I create a note whose title already matches one of the candidates?</h3>
<p>This situation arises when, for example, one would like to create a note titled
&ldquo;bar&rdquo; when &ldquo;barricade&rdquo; already exists.
@@ -2182,7 +2250,7 @@ the candidate list.
<p>
Previous: <a href="#How-do-I-create-a-note-whose-title-already-matches-one-of-the-candidates_003f" accesskey="p" rel="prev">How do I create a note whose title already matches one of the candidates?</a>, Up: <a href="#FAQ" accesskey="u" rel="up">FAQ</a> &nbsp; [<a href="#Keystroke-Index" title="Index" rel="index">Index</a>]</p>
</div>
<span id="How-can-I-stop-Org_002droam-from-creating-IDs-everywhere_003f-1"></span><h3 class="section">17.4 How can I stop Org-roam from creating IDs everywhere?</h3>
<span id="How-can-I-stop-Org_002droam-from-creating-IDs-everywhere_003f-1"></span><h3 class="section">18.4 How can I stop Org-roam from creating IDs everywhere?</h3>
<p>Other than the interactive commands that Org-roam provides, Org-roam does not
create IDs everywhere. If you are noticing that IDs are being created even when
@@ -2195,7 +2263,7 @@ is a popular option.
<p>
Next: <a href="#Developer_0027s-Guide-to-Org_002droam" accesskey="n" rel="next">Developer's Guide to Org-roam</a>, Previous: <a href="#FAQ" accesskey="p" rel="prev">FAQ</a>, Up: <a href="#Top" accesskey="u" rel="up">Top</a> &nbsp; [<a href="#Keystroke-Index" title="Index" rel="index">Index</a>]</p>
</div>
<span id="Migrating-from-Org_002droam-v1-1"></span><h2 class="chapter">18 Migrating from Org-roam v1</h2>
<span id="Migrating-from-Org_002droam-v1-1"></span><h2 class="chapter">19 Migrating from Org-roam v1</h2>
<p>Those coming from Org-roam v1 will do well treating v2 as entirely new software.
V2 has a smaller core and fewer moving parts, while retaining the bulk of its
@@ -2229,7 +2297,7 @@ the <code>ROAM_TAGS</code> property for headline nodes
<p>
Next: <a href="#Appendix" accesskey="n" rel="next">Appendix</a>, Previous: <a href="#Migrating-from-Org_002droam-v1" accesskey="p" rel="prev">Migrating from Org-roam v1</a>, Up: <a href="#Top" accesskey="u" rel="up">Top</a> &nbsp; [<a href="#Keystroke-Index" title="Index" rel="index">Index</a>]</p>
</div>
<span id="Developer_0027s-Guide-to-Org_002droam-1"></span><h2 class="chapter">19 Developer&rsquo;s Guide to Org-roam</h2>
<span id="Developer_0027s-Guide-to-Org_002droam-1"></span><h2 class="chapter">20 Developer&rsquo;s Guide to Org-roam</h2>
<table class="menu" border="0" cellspacing="0">
<tr><td align="left" valign="top">&bull; <a href="#Org_002droam_0027s-Design-Principle" accesskey="1">Org-roam's Design Principle</a></td><td>&nbsp;&nbsp;</td><td align="left" valign="top">
@@ -2243,7 +2311,7 @@ Next: <a href="#Appendix" accesskey="n" rel="next">Appendix</a>, Previous: <a hr
<p>
Next: <a href="#Building-Extensions-and-Advanced-Customization-of-Org_002droam" accesskey="n" rel="next">Building Extensions and Advanced Customization of Org-roam</a>, Up: <a href="#Developer_0027s-Guide-to-Org_002droam" accesskey="u" rel="up">Developer's Guide to Org-roam</a> &nbsp; [<a href="#Keystroke-Index" title="Index" rel="index">Index</a>]</p>
</div>
<span id="Org_002droam_0027s-Design-Principle-1"></span><h3 class="section">19.1 Org-roam&rsquo;s Design Principle</h3>
<span id="Org_002droam_0027s-Design-Principle-1"></span><h3 class="section">20.1 Org-roam&rsquo;s Design Principle</h3>
<p>Org-roam is primarily motivated by the need for a dual representation. We
(humans) love operating in a plain-text environment. The syntax rules of
@@ -2288,7 +2356,7 @@ queries on their Org files.
<p>
Previous: <a href="#Org_002droam_0027s-Design-Principle" accesskey="p" rel="prev">Org-roam's Design Principle</a>, Up: <a href="#Developer_0027s-Guide-to-Org_002droam" accesskey="u" rel="up">Developer's Guide to Org-roam</a> &nbsp; [<a href="#Keystroke-Index" title="Index" rel="index">Index</a>]</p>
</div>
<span id="Building-Extensions-and-Advanced-Customization-of-Org_002droam-1"></span><h3 class="section">19.2 Building Extensions and Advanced Customization of Org-roam</h3>
<span id="Building-Extensions-and-Advanced-Customization-of-Org_002droam-1"></span><h3 class="section">20.2 Building Extensions and Advanced Customization of Org-roam</h3>
<p>Because Org-roam&rsquo;s core functionality is small, it is possible and sometimes
desirable to build extensions on top of it. These extensions may one or more of
@@ -2327,7 +2395,7 @@ load when support is available.
<p>
Next: <a href="#Accessing-and-Modifying-Nodes" accesskey="n" rel="next">Accessing and Modifying Nodes</a>, Up: <a href="#Building-Extensions-and-Advanced-Customization-of-Org_002droam" accesskey="u" rel="up">Building Extensions and Advanced Customization of Org-roam</a> &nbsp; [<a href="#Keystroke-Index" title="Index" rel="index">Index</a>]</p>
</div>
<span id="Accessing-the-Database-1"></span><h4 class="subsection">19.2.1 Accessing the Database</h4>
<span id="Accessing-the-Database-1"></span><h4 class="subsection">20.2.1 Accessing the Database</h4>
<p>Access to the database is provided singularly by <code>org-roam-db-query</code>, for
example:
@@ -2347,7 +2415,7 @@ that extensions/customizations are robust to change, extensions should only use
<p>
Next: <a href="#Extending-the-Capture-System" accesskey="n" rel="next">Extending the Capture System</a>, Previous: <a href="#Accessing-the-Database" accesskey="p" rel="prev">Accessing the Database</a>, Up: <a href="#Building-Extensions-and-Advanced-Customization-of-Org_002droam" accesskey="u" rel="up">Building Extensions and Advanced Customization of Org-roam</a> &nbsp; [<a href="#Keystroke-Index" title="Index" rel="index">Index</a>]</p>
</div>
<span id="Accessing-and-Modifying-Nodes-1"></span><h4 class="subsection">19.2.2 Accessing and Modifying Nodes</h4>
<span id="Accessing-and-Modifying-Nodes-1"></span><h4 class="subsection">20.2.2 Accessing and Modifying Nodes</h4>
<p>The node interface is cleanly defined using <code>cl-defstruct</code>. The primary
method to access nodes is <code>org-roam-node-at-point</code> and <code>org-roam-node-read</code>:
@@ -2396,7 +2464,7 @@ making it available for use in capture templates.
<p>
Previous: <a href="#Accessing-and-Modifying-Nodes" accesskey="p" rel="prev">Accessing and Modifying Nodes</a>, Up: <a href="#Building-Extensions-and-Advanced-Customization-of-Org_002droam" accesskey="u" rel="up">Building Extensions and Advanced Customization of Org-roam</a> &nbsp; [<a href="#Keystroke-Index" title="Index" rel="index">Index</a>]</p>
</div>
<span id="Extending-the-Capture-System-1"></span><h4 class="subsection">19.2.3 Extending the Capture System</h4>
<span id="Extending-the-Capture-System-1"></span><h4 class="subsection">20.2.3 Extending the Capture System</h4>
<p>Org-roam applies some patching over Org&rsquo;s capture system to smooth out the user
experience, and sometimes it is desirable to use Org-roam&rsquo;s capturing system
@@ -2433,7 +2501,7 @@ When GOTO is non-nil, go the note without creating an entry.&quot;
<p>
Next: <a href="#Keystroke-Index" accesskey="n" rel="next">Keystroke Index</a>, Previous: <a href="#Developer_0027s-Guide-to-Org_002droam" accesskey="p" rel="prev">Developer's Guide to Org-roam</a>, Up: <a href="#Top" accesskey="u" rel="up">Top</a> &nbsp; [<a href="#Keystroke-Index" title="Index" rel="index">Index</a>]</p>
</div>
<span id="Appendix-1"></span><h2 class="chapter">20 Appendix</h2>
<span id="Appendix-1"></span><h2 class="chapter">21 Appendix</h2>
<table class="menu" border="0" cellspacing="0">
<tr><td align="left" valign="top">&bull; <a href="#Note_002dtaking-Workflows" accesskey="1">Note-taking Workflows</a></td><td>&nbsp;&nbsp;</td><td align="left" valign="top">
@@ -2447,7 +2515,7 @@ Next: <a href="#Keystroke-Index" accesskey="n" rel="next">Keystroke Index</a>, P
<p>
Next: <a href="#Ecosystem" accesskey="n" rel="next">Ecosystem</a>, Up: <a href="#Appendix" accesskey="u" rel="up">Appendix</a> &nbsp; [<a href="#Keystroke-Index" title="Index" rel="index">Index</a>]</p>
</div>
<span id="Note_002dtaking-Workflows-1"></span><h3 class="section">20.1 Note-taking Workflows</h3>
<span id="Note_002dtaking-Workflows-1"></span><h3 class="section">21.1 Note-taking Workflows</h3>
<ul>
<li> Books<ul>
@@ -2480,7 +2548,7 @@ Next: <a href="#Ecosystem" accesskey="n" rel="next">Ecosystem</a>, Up: <a href="
<p>
Previous: <a href="#Note_002dtaking-Workflows" accesskey="p" rel="prev">Note-taking Workflows</a>, Up: <a href="#Appendix" accesskey="u" rel="up">Appendix</a> &nbsp; [<a href="#Keystroke-Index" title="Index" rel="index">Index</a>]</p>
</div>
<span id="Ecosystem-1"></span><h3 class="section">20.2 Ecosystem</h3>
<span id="Ecosystem-1"></span><h3 class="section">21.2 Ecosystem</h3>
<hr>
<span id="Keystroke-Index"></span><div class="header">
@@ -2540,7 +2608,7 @@ Next: <a href="#Variable-Index" accesskey="n" rel="next">Variable Index</a>, Pre
<hr>
<span id="Variable-Index"></span><div class="header">
<p>
Previous: <a href="#Function-Index" accesskey="p" rel="prev">Function Index</a>, Up: <a href="#Top" accesskey="u" rel="up">Top</a> &nbsp; [<a href="#Keystroke-Index" title="Index" rel="index">Index</a>]</p>
Next: <a href="#Bibliography-_00281_0029" accesskey="n" rel="next">Bibliography (1)</a>, Previous: <a href="#Function-Index" accesskey="p" rel="prev">Function Index</a>, Up: <a href="#Top" accesskey="u" rel="up">Top</a> &nbsp; [<a href="#Keystroke-Index" title="Index" rel="index">Index</a>]</p>
</div>
<span id="Variable-Index-1"></span><h2 class="appendix">Appendix D Variable Index</h2>
@@ -2567,6 +2635,15 @@ Previous: <a href="#Function-Index" accesskey="p" rel="prev">Function Index</a>,
&nbsp;
</td></tr></table>
<hr>
<span id="Bibliography-_00281_0029"></span><div class="header">
<p>
Previous: <a href="#Variable-Index" accesskey="p" rel="prev">Variable Index</a>, Up: <a href="#Top" accesskey="u" rel="up">Top</a> &nbsp; [<a href="#Keystroke-Index" title="Index" rel="index">Index</a>]</p>
</div>
<span id="Bibliography-2"></span><h2 class="chapter">E Bibliography</h2>
<p>NO<em>_ITEM</em><em>_DATA</em>:key
</p>
<p>Emacs 28.0.50 (Org mode 9.5)
</p><div class="footnote">
<hr>

43
org-roam.org
View File

@@ -646,6 +646,49 @@ Org-roam also provides some functions to add or remove refs.
Remove a ref from the node at point.
* Citations
Since version 9.5, Org has first-class support for citations. Org-roam supports
the caching of both these in-built citations (of form ~[cite:@key]~) and [[https://github.com/jkitchin/org-ref][org-ref]]
citations (of form cite:key).
Org-roam attempts to load both the ~org-ref~ and ~org-cite~ package when
indexing files, so no further setup from the user is required for citation
support.
** Using the Cached Information
It is common to use take reference notes for academic papers. To designate the
node to be the canonical node for the academic paper, we can use its unique
citation key:
#+begin_src org
,* Probabilistic Robotics
:PROPERTIES:
:ID: 51b7b82c-bbb4-4822-875a-ed548cffda10
:ROAM_REFS: @thrun2005probabilistic
:END:
#+end_src
for ~org-cite~, or:
#+begin_src org
,* Probabilistic Robotics
:PROPERTIES:
:ID: 51b7b82c-bbb4-4822-875a-ed548cffda10
:ROAM_REFS: cite:thrun2005probabilistic
:END:
#+end_src
for ~org-ref~.
When another node has a citation for that key, we can see it using the
~Reflinks~ section of the Org-roam buffer.
Extension developers may be interested in retrieving the citations within their
notes. This information can be found within the ~citation~ table of the Org-roam
database.
* Completion
Completions for Org-roam are provided via ~completion-at-point~. Org-roam

78
org-roam.texi
View File

@@ -70,6 +70,7 @@ General Public License for more details.
* Customizing Node Caching::
* The Org-roam Buffer::
* Node Properties::
* Citations::
* Completion::
* Encryption::
* Org-roam Protocol::
@@ -86,6 +87,7 @@ General Public License for more details.
* Command Index::
* Function Index::
* Variable Index::
* Bibliography: Bibliography (1).
@detailmenu
--- The Detailed Node Listing ---
@@ -126,6 +128,10 @@ Node Properties
* Tags::
* Refs::
Citations
* Using the Cached Information::
Completion
* Completing within Link Brackets::
@@ -250,7 +256,7 @@ available to Emacs.
Org-roam is a tool that will appear unfriendly to anyone unfamiliar with Emacs
and Org-mode, but it is also extremely powerful to those willing to put effort
inn mastering the intricacies. Org-roam stands on the shoulders of giants. Emacs
in mastering the intricacies. Org-roam stands on the shoulders of giants. Emacs
was first created in 1976, and remains the tool of choice for many for editing
text and designing textual interfaces. The malleability of Emacs allowed the
creation of Org-mode, an all-purpose plain-text system for maintaining TODO
@@ -637,8 +643,8 @@ The @code{file-truename} function is only necessary when you use symbolic links
inside @code{org-roam-directory}: Org-roam does not resolve symbolic links.
Next, we setup Org-roam to run functions on file changes to maintain cache
consistency. This is achieved by running @code{M-x org-roam-db-autosync-mode~}.
To ensure that Org-roam is available on startup, place this in your Emacs
consistency. This is achieved by running @code{M-x org-roam-db-autosync-mode}. To
ensure that Org-roam is available on startup, place this in your Emacs
configuration:
@lisp
@@ -995,6 +1001,55 @@ ref to add.
Remove a ref from the node at point.
@end defun
@node Citations
@chapter Citations
Since version 9.5, Org has first-class support for citations. Org-roam supports
the caching of both these in-built citations (of form @code{[cite:@@key]}) and @uref{https://github.com/jkitchin/org-ref, org-ref}
citations (of form (NO@math{_ITEM}@math{_DATA}:key)).
Org-roam attempts to load both the @code{org-ref} and @code{org-cite} package when
indexing files, so no further setup from the user is required for citation
support.
@menu
* Using the Cached Information::
@end menu
@node Using the Cached Information
@section Using the Cached Information
It is common to use take reference notes for academic papers. To designate the
node to be the canonical node for the academic paper, we can use its unique
citation key:
@example
* Probabilistic Robotics
:PROPERTIES:
:ID: 51b7b82c-bbb4-4822-875a-ed548cffda10
:ROAM_REFS: @@thrun2005probabilistic
:END:
@end example
for @code{org-cite}, or:
@example
* Probabilistic Robotics
:PROPERTIES:
:ID: 51b7b82c-bbb4-4822-875a-ed548cffda10
:ROAM_REFS: cite:thrun2005probabilistic
:END:
@end example
for @code{org-ref}.
When another node has a citation for that key, we can see it using the
@code{Reflinks} section of the Org-roam buffer.
Extension developers may be interested in retrieving the citations within their
notes. This information can be found within the @code{citation} table of the Org-roam
database.
@node Completion
@chapter Completion
@@ -1331,12 +1386,12 @@ here.
This template means don't insert any content, but place the cursor here.
@item
@code{:target} is a compulsory specification in the Org-roam capture
template. The first element of the list indicates the type of the
target, the second element indicates the location of the captured
node, and the rest of the elements indicate prefilled template that
will be inserted and the position of the point will be adjusted for.
The latter behavior various from type to type of the capture target.
@code{:target} is a compulsory specification in the Org-roam capture template. The
first element of the list indicates the type of the target, the second
element indicates the location of the captured node, and the rest of the
elements indicate prefilled template that will be inserted and the position
of the point will be adjusted for. The latter behavior various from type to
type of the capture target.
@item
@code{:unnarrowed t} tells org-capture to show the contents for the whole file,
@@ -2121,5 +2176,10 @@ When GOTO is non-nil, go the note without creating an entry."
@printindex vr
@node Bibliography (1)
@chapter Bibliography
NO@math{_ITEM}@math{_DATA}:key
Emacs 28.0.50 (Org mode 9.5)
@bye