mirror of
https://github.com/org-roam/org-roam
synced 2025-08-03 12:27:23 -05:00
299 lines
18 KiB
HTML
299 lines
18 KiB
HTML
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
|
|
<html>
|
|
<!-- Copyright (C) 2020-2020 Jethro Kuan <jethrokuan95@gmail.com>
|
|
|
|
You can redistribute this document and/or modify it under the terms
|
|
of the GNU General Public License as published by the Free Software
|
|
Foundation, either version 3 of the License, or (at your option) any
|
|
later version.
|
|
|
|
This document is distributed in the hope that it will be useful,
|
|
but WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
|
|
General Public License for more details.
|
|
-->
|
|
<!-- Created by GNU Texinfo 6.5, http://www.gnu.org/software/texinfo/ -->
|
|
<head>
|
|
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
|
|
<title>Top (Org-roam User Manual)</title>
|
|
|
|
<meta name="description" content="Top (Org-roam User Manual)">
|
|
<meta name="keywords" content="Top (Org-roam User Manual)">
|
|
<meta name="resource-type" content="document">
|
|
<meta name="distribution" content="global">
|
|
<meta name="Generator" content="makeinfo">
|
|
<link href="#Top" rel="start" title="Top">
|
|
<link href="#SEC_Contents" rel="contents" title="Table of Contents">
|
|
<link href="../dir/index.html" rel="up" title="(dir)">
|
|
<link href="Introduction.html#Introduction" rel="next" title="Introduction">
|
|
<style type="text/css">
|
|
<!--
|
|
a.summary-letter {text-decoration: none}
|
|
blockquote.indentedblock {margin-right: 0em}
|
|
blockquote.smallindentedblock {margin-right: 0em; font-size: smaller}
|
|
blockquote.smallquotation {font-size: smaller}
|
|
div.display {margin-left: 3.2em}
|
|
div.example {margin-left: 3.2em}
|
|
div.lisp {margin-left: 3.2em}
|
|
div.smalldisplay {margin-left: 3.2em}
|
|
div.smallexample {margin-left: 3.2em}
|
|
div.smalllisp {margin-left: 3.2em}
|
|
kbd {font-style: oblique}
|
|
pre.display {font-family: inherit}
|
|
pre.format {font-family: inherit}
|
|
pre.menu-comment {font-family: serif}
|
|
pre.menu-preformatted {font-family: serif}
|
|
pre.smalldisplay {font-family: inherit; font-size: smaller}
|
|
pre.smallexample {font-size: smaller}
|
|
pre.smallformat {font-family: inherit; font-size: smaller}
|
|
pre.smalllisp {font-size: smaller}
|
|
span.nolinebreak {white-space: nowrap}
|
|
span.roman {font-family: initial; font-weight: normal}
|
|
span.sansserif {font-family: sans-serif; font-weight: normal}
|
|
ul.no-bullet {list-style: none}
|
|
-->
|
|
</style>
|
|
|
|
|
|
</head>
|
|
|
|
<body lang="en">
|
|
<h1 class="settitle" align="center">Org-roam User Manual</h1>
|
|
|
|
|
|
|
|
|
|
<a name="SEC_Contents"></a>
|
|
<h2 class="contents-heading">Table of Contents</h2>
|
|
|
|
<div class="contents">
|
|
|
|
<ul class="no-bullet">
|
|
<li><a name="toc-Introduction-1" href="Introduction.html#Introduction">1 Introduction</a></li>
|
|
<li><a name="toc-Installation-1" href="Installation.html#Installation">2 Installation</a>
|
|
<ul class="no-bullet">
|
|
<li><a name="toc-Installing-from-MELPA-1" href="Installing-from-MELPA.html#Installing-from-MELPA">2.1 Installing from MELPA</a></li>
|
|
<li><a name="toc-TODO-Installing-from-the-Git-Repository" href="Installing-from-the-Git-Repository.html#Installing-from-the-Git-Repository">2.2 <strong>TODO</strong> Installing from the Git Repository</a></li>
|
|
<li><a name="toc-TODO-Post_002dInstallation-Tasks" href="Post_002dInstallation-Tasks.html#Post_002dInstallation-Tasks">2.3 <strong>TODO</strong> Post-Installation Tasks</a></li>
|
|
</ul></li>
|
|
<li><a name="toc-Getting-Started-1" href="Getting-Started.html#Getting-Started">3 Getting Started</a></li>
|
|
<li><a name="toc-Anatomy-of-an-Org_002droam-File-1" href="Anatomy-of-an-Org_002droam-File.html#Anatomy-of-an-Org_002droam-File">4 Anatomy of an Org-roam File</a>
|
|
<ul class="no-bullet">
|
|
<li><a name="toc-File-Aliases-1" href="File-Aliases.html#File-Aliases">4.1 File Aliases</a></li>
|
|
<li><a name="toc-File-Refs-1" href="File-Refs.html#File-Refs">4.2 File Refs</a></li>
|
|
</ul></li>
|
|
<li><a name="toc-The-Templating-System-1" href="The-Templating-System.html#The-Templating-System">5 The Templating System</a>
|
|
<ul class="no-bullet">
|
|
<li><a name="toc-Template-Walkthrough-1" href="Template-Walkthrough.html#Template-Walkthrough">5.1 Template Walkthrough</a></li>
|
|
<li><a name="toc-Org_002droam-Template-Expansion-1" href="Org_002droam-Template-Expansion.html#Org_002droam-Template-Expansion">5.2 Org-roam Template Expansion</a></li>
|
|
</ul></li>
|
|
<li><a name="toc-Concepts-and-Configuration-1" href="Concepts-and-Configuration.html#Concepts-and-Configuration">6 Concepts and Configuration</a>
|
|
<ul class="no-bullet">
|
|
<li><a name="toc-Directories-and-Files-1" href="Directories-and-Files.html#Directories-and-Files">6.1 Directories and Files</a></li>
|
|
<li><a name="toc-The-Org_002droam-Buffer-1" href="The-Org_002droam-Buffer.html#The-Org_002droam-Buffer">6.2 The Org-roam Buffer</a></li>
|
|
<li><a name="toc-Org_002droam-Links-1" href="Org_002droam-Links.html#Org_002droam-Links">6.3 Org-roam Links</a></li>
|
|
<li><a name="toc-Org_002droam-Files-1" href="Org_002droam-Files.html#Org_002droam-Files">6.4 Org-roam Files</a></li>
|
|
</ul></li>
|
|
<li><a name="toc-Navigating-Around-1" href="Navigating-Around.html#Navigating-Around">7 Navigating Around</a>
|
|
<ul class="no-bullet">
|
|
<li><a name="toc-Index-File-1" href="Index-File.html#Index-File">7.1 Index File</a></li>
|
|
</ul></li>
|
|
<li><a name="toc-Encryption-1" href="Encryption.html#Encryption">8 Encryption</a></li>
|
|
<li><a name="toc-Graphing-1" href="Graphing.html#Graphing">9 Graphing</a>
|
|
<ul class="no-bullet">
|
|
<li><a name="toc-Graph-Options-1" href="Graph-Options.html#Graph-Options">9.1 Graph Options</a></li>
|
|
<li><a name="toc-Excluding-Nodes-and-Edges-1" href="Excluding-Nodes-and-Edges.html#Excluding-Nodes-and-Edges">9.2 Excluding Nodes and Edges</a></li>
|
|
</ul></li>
|
|
<li><a name="toc-Org_002droam-Completion-System-1" href="Org_002droam-Completion-System.html#Org_002droam-Completion-System">10 Org-roam Completion System</a></li>
|
|
<li><a name="toc-Roam-Protocol-1" href="Roam-Protocol.html#Roam-Protocol">11 Roam Protocol</a>
|
|
<ul class="no-bullet">
|
|
<li><a name="toc-Installation-2" href="Installation-_00281_0029.html#Installation-_00281_0029">11.1 Installation</a></li>
|
|
<li><a name="toc-The-roam_002dfile-protocol-1" href="The-roam_002dfile-protocol.html#The-roam_002dfile-protocol">11.2 The ‘<samp>roam-file</samp>’ protocol</a></li>
|
|
<li><a name="toc-The-roam_002dref-Protocol-1" href="The-roam_002dref-Protocol.html#The-roam_002dref-Protocol">11.3 The ‘<samp>roam-ref</samp>’ Protocol</a></li>
|
|
</ul></li>
|
|
<li><a name="toc-Diagnosing-and-Repairing-Files-1" href="Diagnosing-and-Repairing-Files.html#Diagnosing-and-Repairing-Files">12 Diagnosing and Repairing Files</a></li>
|
|
<li><a name="toc-Appendix-1" href="Appendix.html#Appendix">13 Appendix</a>
|
|
<ul class="no-bullet">
|
|
<li><a name="toc-Note_002dtaking-Workflows-1" href="Note_002dtaking-Workflows.html#Note_002dtaking-Workflows">13.1 Note-taking Workflows</a></li>
|
|
<li><a name="toc-Ecosystem-1" href="Ecosystem.html#Ecosystem">13.2 Ecosystem</a>
|
|
<ul class="no-bullet">
|
|
<li><a name="toc-Deft-1" href="Deft.html#Deft">13.2.1 Deft</a></li>
|
|
<li><a name="toc-Org_002djournal-1" href="Org_002djournal.html#Org_002djournal">13.2.2 Org-journal</a></li>
|
|
<li><a name="toc-Note_002dtaking-Add_002dons-1" href="Note_002dtaking-Add_002dons.html#Note_002dtaking-Add_002dons">13.2.3 Note-taking Add-ons</a>
|
|
<ul class="no-bullet">
|
|
<li><a name="toc-Org_002ddownload-1" href="Org_002ddownload.html#Org_002ddownload">Org-download</a></li>
|
|
<li><a name="toc-mathpix_002eel" href="mathpixel.html#mathpixel">mathpix.el</a></li>
|
|
<li><a name="toc-Org_002dnoter-_002f-Interleave-1" href="Org_002dnoter-_002f-Interleave.html#Org_002dnoter-_002f-Interleave">Org-noter / Interleave</a></li>
|
|
<li><a name="toc-Bibliography-1" href="Bibliography.html#Bibliography">Bibliography</a></li>
|
|
<li><a name="toc-Spaced-Repetition-1" href="Spaced-Repetition.html#Spaced-Repetition">Spaced Repetition</a></li>
|
|
</ul></li>
|
|
</ul></li>
|
|
</ul></li>
|
|
<li><a name="toc-FAQ-1" href="FAQ.html#FAQ">14 FAQ</a>
|
|
<ul class="no-bullet">
|
|
<li><a name="toc-How-do-I-have-more-than-one-Org_002droam-directory_003f-1" href="How-do-I-have-more-than-one-Org_002droam-directory_003f.html#How-do-I-have-more-than-one-Org_002droam-directory_003f">14.1 How do I have more than one Org-roam directory?</a></li>
|
|
</ul></li>
|
|
</ul>
|
|
</div>
|
|
|
|
|
|
<a name="Top"></a>
|
|
<div class="header">
|
|
<p>
|
|
Next: <a href="Introduction.html#Introduction" accesskey="n" rel="next">Introduction</a>, Up: <a href="../dir/index.html" accesskey="u" rel="up">(dir)</a> [<a href="#SEC_Contents" title="Table of contents" rel="contents">Contents</a>]</p>
|
|
</div>
|
|
<hr>
|
|
<a name="Org_002droam-User-Manual"></a>
|
|
<h1 class="top">Org-roam User Manual</h1>
|
|
|
|
|
|
<p>This manual is for Org-roam version 1.1.1.
|
|
</p>
|
|
<blockquote>
|
|
<p>Copyright (C) 2020-2020 Jethro Kuan <jethrokuan95@gmail.com>
|
|
</p>
|
|
<p>You can redistribute this document and/or modify it under the terms
|
|
of the GNU General Public License as published by the Free Software
|
|
Foundation, either version 3 of the License, or (at your option) any
|
|
later version.
|
|
</p>
|
|
<p>This document is distributed in the hope that it will be useful,
|
|
but WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
|
|
General Public License for more details.
|
|
</p>
|
|
</blockquote>
|
|
|
|
<table class="menu" border="0" cellspacing="0">
|
|
<tr><td align="left" valign="top">• <a href="Introduction.html#Introduction" accesskey="1">Introduction</a>:</td><td> </td><td align="left" valign="top">
|
|
</td></tr>
|
|
<tr><td align="left" valign="top">• <a href="Installation.html#Installation" accesskey="2">Installation</a>:</td><td> </td><td align="left" valign="top">
|
|
</td></tr>
|
|
<tr><td align="left" valign="top">• <a href="Getting-Started.html#Getting-Started" accesskey="3">Getting Started</a>:</td><td> </td><td align="left" valign="top">
|
|
</td></tr>
|
|
<tr><td align="left" valign="top">• <a href="Anatomy-of-an-Org_002droam-File.html#Anatomy-of-an-Org_002droam-File" accesskey="4">Anatomy of an Org-roam File</a>:</td><td> </td><td align="left" valign="top">
|
|
</td></tr>
|
|
<tr><td align="left" valign="top">• <a href="The-Templating-System.html#The-Templating-System" accesskey="5">The Templating System</a>:</td><td> </td><td align="left" valign="top">
|
|
</td></tr>
|
|
<tr><td align="left" valign="top">• <a href="Concepts-and-Configuration.html#Concepts-and-Configuration" accesskey="6">Concepts and Configuration</a>:</td><td> </td><td align="left" valign="top">
|
|
</td></tr>
|
|
<tr><td align="left" valign="top">• <a href="Navigating-Around.html#Navigating-Around" accesskey="7">Navigating Around</a>:</td><td> </td><td align="left" valign="top">
|
|
</td></tr>
|
|
<tr><td align="left" valign="top">• <a href="Encryption.html#Encryption" accesskey="8">Encryption</a>:</td><td> </td><td align="left" valign="top">
|
|
</td></tr>
|
|
<tr><td align="left" valign="top">• <a href="Graphing.html#Graphing" accesskey="9">Graphing</a>:</td><td> </td><td align="left" valign="top">
|
|
</td></tr>
|
|
<tr><td align="left" valign="top">• <a href="Org_002droam-Completion-System.html#Org_002droam-Completion-System">Org-roam Completion System</a>:</td><td> </td><td align="left" valign="top">
|
|
</td></tr>
|
|
<tr><td align="left" valign="top">• <a href="Roam-Protocol.html#Roam-Protocol">Roam Protocol</a>:</td><td> </td><td align="left" valign="top">
|
|
</td></tr>
|
|
<tr><td align="left" valign="top">• <a href="Diagnosing-and-Repairing-Files.html#Diagnosing-and-Repairing-Files">Diagnosing and Repairing Files</a>:</td><td> </td><td align="left" valign="top">
|
|
</td></tr>
|
|
<tr><td align="left" valign="top">• <a href="Appendix.html#Appendix">Appendix</a>:</td><td> </td><td align="left" valign="top">
|
|
</td></tr>
|
|
<tr><td align="left" valign="top">• <a href="FAQ.html#FAQ">FAQ</a>:</td><td> </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">— The Detailed Node Listing —
|
|
|
|
Installation
|
|
|
|
</pre></th></tr><tr><td align="left" valign="top">• <a href="Installing-from-MELPA.html#Installing-from-MELPA">Installing from MELPA</a>:</td><td> </td><td align="left" valign="top">
|
|
</td></tr>
|
|
<tr><td align="left" valign="top">• <a href="Installing-from-the-Git-Repository.html#Installing-from-the-Git-Repository">Installing from the Git Repository</a>:</td><td> </td><td align="left" valign="top">
|
|
</td></tr>
|
|
<tr><td align="left" valign="top">• <a href="Post_002dInstallation-Tasks.html#Post_002dInstallation-Tasks">Post-Installation Tasks</a>:</td><td> </td><td align="left" valign="top">
|
|
</td></tr>
|
|
<tr><th colspan="3" align="left" valign="top"><pre class="menu-comment">
|
|
|
|
Anatomy of an Org-roam File
|
|
|
|
</pre></th></tr><tr><td align="left" valign="top">• <a href="File-Aliases.html#File-Aliases">File Aliases</a>:</td><td> </td><td align="left" valign="top">
|
|
</td></tr>
|
|
<tr><td align="left" valign="top">• <a href="File-Refs.html#File-Refs">File Refs</a>:</td><td> </td><td align="left" valign="top">
|
|
</td></tr>
|
|
<tr><th colspan="3" align="left" valign="top"><pre class="menu-comment">
|
|
|
|
The Templating System
|
|
|
|
</pre></th></tr><tr><td align="left" valign="top">• <a href="Template-Walkthrough.html#Template-Walkthrough">Template Walkthrough</a>:</td><td> </td><td align="left" valign="top">
|
|
</td></tr>
|
|
<tr><td align="left" valign="top">• <a href="Org_002droam-Template-Expansion.html#Org_002droam-Template-Expansion">Org-roam Template Expansion</a>:</td><td> </td><td align="left" valign="top">
|
|
</td></tr>
|
|
<tr><th colspan="3" align="left" valign="top"><pre class="menu-comment">
|
|
|
|
Concepts and Configuration
|
|
|
|
</pre></th></tr><tr><td align="left" valign="top">• <a href="Directories-and-Files.html#Directories-and-Files">Directories and Files</a>:</td><td> </td><td align="left" valign="top">
|
|
</td></tr>
|
|
<tr><td align="left" valign="top">• <a href="The-Org_002droam-Buffer.html#The-Org_002droam-Buffer">The Org-roam Buffer</a>:</td><td> </td><td align="left" valign="top">
|
|
</td></tr>
|
|
<tr><td align="left" valign="top">• <a href="Org_002droam-Links.html#Org_002droam-Links">Org-roam Links</a>:</td><td> </td><td align="left" valign="top">
|
|
</td></tr>
|
|
<tr><td align="left" valign="top">• <a href="Org_002droam-Files.html#Org_002droam-Files">Org-roam Files</a>:</td><td> </td><td align="left" valign="top">
|
|
</td></tr>
|
|
<tr><th colspan="3" align="left" valign="top"><pre class="menu-comment">
|
|
|
|
Navigating Around
|
|
|
|
</pre></th></tr><tr><td align="left" valign="top">• <a href="Index-File.html#Index-File">Index File</a>:</td><td> </td><td align="left" valign="top">
|
|
</td></tr>
|
|
<tr><th colspan="3" align="left" valign="top"><pre class="menu-comment">
|
|
|
|
Graphing
|
|
|
|
</pre></th></tr><tr><td align="left" valign="top">• <a href="Graph-Options.html#Graph-Options">Graph Options</a>:</td><td> </td><td align="left" valign="top">
|
|
</td></tr>
|
|
<tr><td align="left" valign="top">• <a href="Excluding-Nodes-and-Edges.html#Excluding-Nodes-and-Edges">Excluding Nodes and Edges</a>:</td><td> </td><td align="left" valign="top">
|
|
</td></tr>
|
|
<tr><th colspan="3" align="left" valign="top"><pre class="menu-comment">
|
|
|
|
Roam Protocol
|
|
|
|
</pre></th></tr><tr><td align="left" valign="top">• <a href="Installation-_00281_0029.html#Installation-_00281_0029">Installation</a>:</td><td> </td><td align="left" valign="top">
|
|
</td></tr>
|
|
<tr><td align="left" valign="top">• <a href="The-roam_002dfile-protocol.html#The-roam_002dfile-protocol">The ‘<samp>roam-file</samp>’ protocol</a>:</td><td> </td><td align="left" valign="top">
|
|
</td></tr>
|
|
<tr><td align="left" valign="top">• <a href="The-roam_002dref-Protocol.html#The-roam_002dref-Protocol">The ‘<samp>roam-ref</samp>’ Protocol</a>:</td><td> </td><td align="left" valign="top">
|
|
</td></tr>
|
|
<tr><th colspan="3" align="left" valign="top"><pre class="menu-comment">
|
|
|
|
Appendix
|
|
|
|
</pre></th></tr><tr><td align="left" valign="top">• <a href="Note_002dtaking-Workflows.html#Note_002dtaking-Workflows">Note-taking Workflows</a>:</td><td> </td><td align="left" valign="top">
|
|
</td></tr>
|
|
<tr><td align="left" valign="top">• <a href="Ecosystem.html#Ecosystem">Ecosystem</a>:</td><td> </td><td align="left" valign="top">
|
|
</td></tr>
|
|
<tr><th colspan="3" align="left" valign="top"><pre class="menu-comment">
|
|
|
|
Ecosystem
|
|
|
|
</pre></th></tr><tr><td align="left" valign="top">• <a href="Deft.html#Deft">Deft</a>:</td><td> </td><td align="left" valign="top">
|
|
</td></tr>
|
|
<tr><td align="left" valign="top">• <a href="Org_002djournal.html#Org_002djournal">Org-journal</a>:</td><td> </td><td align="left" valign="top">
|
|
</td></tr>
|
|
<tr><td align="left" valign="top">• <a href="Note_002dtaking-Add_002dons.html#Note_002dtaking-Add_002dons">Note-taking Add-ons</a>:</td><td> </td><td align="left" valign="top">
|
|
</td></tr>
|
|
<tr><th colspan="3" align="left" valign="top"><pre class="menu-comment">
|
|
|
|
|
|
FAQ
|
|
|
|
</pre></th></tr><tr><td align="left" valign="top">• <a href="How-do-I-have-more-than-one-Org_002droam-directory_003f.html#How-do-I-have-more-than-one-Org_002droam-directory_003f">How do I have more than one Org-roam directory?</a>:</td><td> </td><td align="left" valign="top">
|
|
</td></tr>
|
|
<tr><th colspan="3" align="left" valign="top"><pre class="menu-comment">
|
|
|
|
</pre></th></tr></table>
|
|
|
|
<hr>
|
|
<div class="header">
|
|
<p>
|
|
Next: <a href="Introduction.html#Introduction" accesskey="n" rel="next">Introduction</a>, Up: <a href="../dir/index.html" accesskey="u" rel="up">(dir)</a> [<a href="#SEC_Contents" title="Table of contents" rel="contents">Contents</a>]</p>
|
|
</div>
|
|
|
|
|
|
|
|
</body>
|
|
</html>
|