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 @ b2594b84ae 🚀

Browse Source
This commit is contained in:
jethrokuan
2020-05-31 06:23:57 +00:00
parent 1a65214505
commit 8aa5327fc7
43 changed files with 308 additions and 103 deletions
Download Patch File Download Diff File Expand all files Collapse all files

110
manual/A-Brief-Introduction-to-the-Zettelkasten-Method.html Normal file
View File

@@ -0,0 +1,110 @@
<!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>A Brief Introduction to the Zettelkasten Method (Org-roam User Manual)</title>
<meta name="description" content="A Brief Introduction to the Zettelkasten Method (Org-roam User Manual)">
<meta name="keywords" content="A Brief Introduction to the Zettelkasten Method (Org-roam User Manual)">
<meta name="resource-type" content="document">
<meta name="distribution" content="global">
<meta name="Generator" content="makeinfo">
<link href="index.html#Top" rel="start" title="Top">
<link href="index.html#SEC_Contents" rel="contents" title="Table of Contents">
<link href="index.html#Top" rel="up" title="Top">
<link href="Installation.html#Installation" rel="next" title="Installation">
<link href="Introduction.html#Introduction" rel="prev" 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>
<link rel="stylesheet" type="text/css" href="assets/page.css">
</head>
<body lang="en">
<a name="A-Brief-Introduction-to-the-Zettelkasten-Method"></a>
<div class="header">
<p>
Next: <a href="Installation.html#Installation" accesskey="n" rel="next">Installation</a>, Previous: <a href="Introduction.html#Introduction" accesskey="p" rel="prev">Introduction</a>, Up: <a href="index.html#Top" accesskey="u" rel="up">Top</a> &nbsp; [<a href="index.html#SEC_Contents" title="Table of contents" rel="contents">Contents</a>]</p>
</div>
<hr>
<a name="A-Brief-Introduction-to-the-Zettelkasten-Method-1"></a>
<h2 class="chapter">2 A Brief Introduction to the Zettelkasten Method</h2>
<p>Org-roam provides utilities for maintaining a digital slip-box. This section
aims to provide a brief introduction to the &ldquo;slip-box&rdquo;, or &ldquo;Zettelkasten&rdquo;
method. By providing some background on the method, we hope that the design
decisions of Org-roam will become clear, and that will aid in using Org-roam
appropriately. In this section we will also introduce terms commonly used within
the Zettelkasten community, which will also commonly appear in the Org-roam
forums and channels of discussion.
</p>
<p>The Zettelkasten method of note-taking is designed to increase research
productivity: in particular, it acts as a research partner, where conversations
with it may produce new and surprising lines of thought. This method is
attributed to German sociologist Niklas Luhmann, who using the method had
produced volumes of written works.
</p>
<p>In its paper form, the slip-box is simply a box of cards. These cards are small,
and often only large enough to fit a single concept. The size limitation
encourages ideas to be broken down into individual concepts. These ideas are
explicitly linked together, using an indexing system. Enforcing the breakdown of
ideas encourages tangential exploration of ideas, increasing the surface for
thought. Making linking explicit between notes also encourages one to think
about the connections between concepts, which forms a large part of research.
</p>
<p>Org-roam is the slip-box, digitalized in Org-mode. Every zettel (card) is a
plain-text, Org-mode file. These files are often placed in the same directory.
In the same way one would maintain a paper slip-box, Org-roam makes it easy to
create new zettels, pre-filling boilerplate content using a powerful templating
system. Org-roam also facilitates the linking of zettels using Org-mode <code>file:</code>
links.
</p>
<hr>
<div class="header">
<p>
Next: <a href="Installation.html#Installation" accesskey="n" rel="next">Installation</a>, Previous: <a href="Introduction.html#Introduction" accesskey="p" rel="prev">Introduction</a>, Up: <a href="index.html#Top" accesskey="u" rel="up">Top</a> &nbsp; [<a href="index.html#SEC_Contents" title="Table of contents" rel="contents">Contents</a>]</p>
</div>
</body>
</html>

2
manual/Anatomy-of-an-Org_002droam-File.html
View File

@@ -67,7 +67,7 @@ Next: <a href="The-Templating-System.html#The-Templating-System" accesskey="n" r
</div> </div>
<hr> <hr>
<a name="Anatomy-of-an-Org_002droam-File-1"></a> <a name="Anatomy-of-an-Org_002droam-File-1"></a>
<h2 class="chapter">4 Anatomy of an Org-roam File</h2> <h2 class="chapter">5 Anatomy of an Org-roam File</h2>
<p>The bulk of Org-roam&rsquo;s functionality is built on top of vanilla <p>The bulk of Org-roam&rsquo;s functionality is built on top of vanilla
Org-mode. However, to support additional functionality, Org-roam adds Org-mode. However, to support additional functionality, Org-roam adds

2
manual/Appendix.html
View File

@@ -67,7 +67,7 @@ Next: <a href="FAQ.html#FAQ" accesskey="n" rel="next">FAQ</a>, Previous: <a href
</div> </div>
<hr> <hr>
<a name="Appendix-1"></a> <a name="Appendix-1"></a>
<h2 class="chapter">13 Appendix</h2> <h2 class="chapter">14 Appendix</h2>
<table class="menu" border="0" cellspacing="0"> <table class="menu" border="0" cellspacing="0">
<tr><td align="left" valign="top">&bull; <a href="Note_002dtaking-Workflows.html#Note_002dtaking-Workflows" accesskey="1">Note-taking Workflows</a>:</td><td>&nbsp;&nbsp;</td><td align="left" valign="top"> <tr><td align="left" valign="top">&bull; <a href="Note_002dtaking-Workflows.html#Note_002dtaking-Workflows" accesskey="1">Note-taking Workflows</a>:</td><td>&nbsp;&nbsp;</td><td align="left" valign="top">

2
manual/Concepts-and-Configuration.html
View File

@@ -67,7 +67,7 @@ Next: <a href="Navigating-Around.html#Navigating-Around" accesskey="n" rel="next
</div> </div>
<hr> <hr>
<a name="Concepts-and-Configuration-1"></a> <a name="Concepts-and-Configuration-1"></a>
<h2 class="chapter">6 Concepts and Configuration</h2> <h2 class="chapter">7 Concepts and Configuration</h2>
<p>The number of configuration options is deliberately kept small, to keep <p>The number of configuration options is deliberately kept small, to keep
the Org-roam codebase manageable. However, we attempt to accommodate as the Org-roam codebase manageable. However, we attempt to accommodate as

2
manual/Deft.html
View File

@@ -67,7 +67,7 @@ Next: <a href="Org_002djournal.html#Org_002djournal" accesskey="n" rel="next">Or
</div> </div>
<hr> <hr>
<a name="Deft-1"></a> <a name="Deft-1"></a>
<h4 class="subsection">13.2.1 Deft</h4> <h4 class="subsection">14.2.1 Deft</h4>
<p><a href="https://jblevins.org/projects/deft/">Deft</a> provides a nice interface <p><a href="https://jblevins.org/projects/deft/">Deft</a> provides a nice interface
for browsing and filtering org-roam notes. for browsing and filtering org-roam notes.

2
manual/Diagnosing-and-Repairing-Files.html
View File

@@ -67,7 +67,7 @@ Next: <a href="Appendix.html#Appendix" accesskey="n" rel="next">Appendix</a>, Pr
</div> </div>
<hr> <hr>
<a name="Diagnosing-and-Repairing-Files-1"></a> <a name="Diagnosing-and-Repairing-Files-1"></a>
<h2 class="chapter">12 Diagnosing and Repairing Files</h2> <h2 class="chapter">13 Diagnosing and Repairing Files</h2>
<p>Org-roam provides a utility for diagnosing and repairing problematic files via <p>Org-roam provides a utility for diagnosing and repairing problematic files via
&lsquo;<samp>org-roam-doctor</samp>&rsquo;. By default, &lsquo;<samp>org-roam-doctor</samp>&rsquo; runs the check across all Org-roam &lsquo;<samp>org-roam-doctor</samp>&rsquo;. By default, &lsquo;<samp>org-roam-doctor</samp>&rsquo; runs the check across all Org-roam

2
manual/Directories-and-Files.html
View File

@@ -67,7 +67,7 @@ Next: <a href="The-Org_002droam-Buffer.html#The-Org_002droam-Buffer" accesskey="
</div> </div>
<hr> <hr>
<a name="Directories-and-Files-1"></a> <a name="Directories-and-Files-1"></a>
<h3 class="section">6.1 Directories and Files</h3> <h3 class="section">7.1 Directories and Files</h3>
<p>This section concerns the placement and creation of files. <p>This section concerns the placement and creation of files.
</p> </p>

2
manual/Ecosystem.html
View File

@@ -67,7 +67,7 @@ Previous: <a href="Note_002dtaking-Workflows.html#Note_002dtaking-Workflows" acc
</div> </div>
<hr> <hr>
<a name="Ecosystem-1"></a> <a name="Ecosystem-1"></a>
<h3 class="section">13.2 Ecosystem</h3> <h3 class="section">14.2 Ecosystem</h3>
<p>A number of packages work well combined with Org-Roam: <p>A number of packages work well combined with Org-Roam:
</p> </p>

2
manual/Encryption.html
View File

@@ -67,7 +67,7 @@ Next: <a href="Graphing.html#Graphing" accesskey="n" rel="next">Graphing</a>, Pr
</div> </div>
<hr> <hr>
<a name="Encryption-1"></a> <a name="Encryption-1"></a>
<h2 class="chapter">8 Encryption</h2> <h2 class="chapter">9 Encryption</h2>
<p>One may wish to keep private, encrypted files. Org-roam supports encryption (via <p>One may wish to keep private, encrypted files. Org-roam supports encryption (via
GPG), which can be enabled for all new files by setting &lsquo;<samp>org-roam-encrypt-files</samp>&rsquo; GPG), which can be enabled for all new files by setting &lsquo;<samp>org-roam-encrypt-files</samp>&rsquo;

2
manual/Excluding-Nodes-and-Edges.html
View File

@@ -67,7 +67,7 @@ Previous: <a href="Graph-Options.html#Graph-Options" accesskey="p" rel="prev">Gr
</div> </div>
<hr> <hr>
<a name="Excluding-Nodes-and-Edges-1"></a> <a name="Excluding-Nodes-and-Edges-1"></a>
<h3 class="section">9.2 Excluding Nodes and Edges</h3> <h3 class="section">10.2 Excluding Nodes and Edges</h3>
<p>One may want to exclude certain files to declutter the graph. <p>One may want to exclude certain files to declutter the graph.
</p> </p>

2
manual/FAQ.html
View File

@@ -67,7 +67,7 @@ Previous: <a href="Appendix.html#Appendix" accesskey="p" rel="prev">Appendix</a>
</div> </div>
<hr> <hr>
<a name="FAQ-1"></a> <a name="FAQ-1"></a>
<h2 class="chapter">14 FAQ</h2> <h2 class="chapter">15 FAQ</h2>
<table class="menu" border="0" cellspacing="0"> <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.html#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"> <tr><td align="left" valign="top">&bull; <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" accesskey="1">How do I have more than one Org-roam directory?</a>:</td><td>&nbsp;&nbsp;</td><td align="left" valign="top">

2
manual/File-Refs.html
View File

@@ -67,7 +67,7 @@ Previous: <a href="Tags.html#Tags" accesskey="p" rel="prev">Tags</a>, Up: <a hre
</div> </div>
<hr> <hr>
<a name="File-Refs-1"></a> <a name="File-Refs-1"></a>
<h3 class="section">4.3 File Refs</h3> <h3 class="section">5.3 File Refs</h3>
<p>Refs are unique identifiers for files. Each note can only have 1 ref. <p>Refs are unique identifiers for files. Each note can only have 1 ref.
For example, a note for a website may contain a ref: For example, a note for a website may contain a ref:

2
manual/Getting-Started.html
View File

@@ -67,7 +67,7 @@ Next: <a href="Anatomy-of-an-Org_002droam-File.html#Anatomy-of-an-Org_002droam-F
</div> </div>
<hr> <hr>
<a name="Getting-Started-1"></a> <a name="Getting-Started-1"></a>
<h2 class="chapter">3 Getting Started</h2> <h2 class="chapter">4 Getting Started</h2>
<p>This short tutorial describes the essential commands used in Org-roam, to help <p>This short tutorial describes the essential commands used in Org-roam, to help
you get started. you get started.

2
manual/Graph-Options.html
View File

@@ -67,7 +67,7 @@ Next: <a href="Excluding-Nodes-and-Edges.html#Excluding-Nodes-and-Edges" accessk
</div> </div>
<hr> <hr>
<a name="Graph-Options-1"></a> <a name="Graph-Options-1"></a>
<h3 class="section">9.1 Graph Options</h3> <h3 class="section">10.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> for customizable options. <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> for customizable options.
</p> </p>

2
manual/Graphing.html
View File

@@ -67,7 +67,7 @@ Next: <a href="Org_002droam-Completion-System.html#Org_002droam-Completion-Syste
</div> </div>
<hr> <hr>
<a name="Graphing-1"></a> <a name="Graphing-1"></a>
<h2 class="chapter">9 Graphing</h2> <h2 class="chapter">10 Graphing</h2>
<p>Org-roam provides graphing capabilities to explore interconnections between <p>Org-roam provides graphing capabilities to explore interconnections between
notes. This is done by performing SQL queries and generating images using notes. This is done by performing SQL queries and generating images using

2
manual/How-do-I-have-more-than-one-Org_002droam-directory_003f.html
View File

@@ -66,7 +66,7 @@ Up: <a href="FAQ.html#FAQ" accesskey="u" rel="up">FAQ</a> &nbsp; [<a href="index
</div> </div>
<hr> <hr>
<a name="How-do-I-have-more-than-one-Org_002droam-directory_003f-1"></a> <a name="How-do-I-have-more-than-one-Org_002droam-directory_003f-1"></a>
<h3 class="section">14.1 How do I have more than one Org-roam directory?</h3> <h3 class="section">15.1 How do I have more than one Org-roam directory?</h3>
<p>Emacs supports directory-local variables, allowing the value of <p>Emacs supports directory-local variables, allowing the value of
&lsquo;<samp>org-roam-directory</samp>&rsquo; to be different in different directories. It does this by &lsquo;<samp>org-roam-directory</samp>&rsquo; to be different in different directories. It does this by

2
manual/Index-File.html
View File

@@ -67,7 +67,7 @@ Up: <a href="Navigating-Around.html#Navigating-Around" accesskey="u" rel="up">Na
</div> </div>
<hr> <hr>
<a name="Index-File-1"></a> <a name="Index-File-1"></a>
<h3 class="section">7.1 Index File</h3> <h3 class="section">8.1 Index File</h3>
<p>As your collection grows, you might want to create an index where you keep links <p>As your collection grows, you might want to create an index where you keep links
to your main files. to your main files.

2
manual/Installation-_00281_0029.html
View File

@@ -67,7 +67,7 @@ Next: <a href="The-roam_002dfile-protocol.html#The-roam_002dfile-protocol" acces
</div> </div>
<hr> <hr>
<a name="Installation-2"></a> <a name="Installation-2"></a>
<h3 class="section">11.2 Installation</h3> <h3 class="section">12.2 Installation</h3>
<p>To enable Org-roam&rsquo;s protocol extensions, you have to add the following to your init file: <p>To enable Org-roam&rsquo;s protocol extensions, you have to add the following to your init file:
</p> </p>

6
manual/Installation.html
View File

@@ -26,7 +26,7 @@ General Public License for more details.
<link href="index.html#SEC_Contents" rel="contents" title="Table of Contents"> <link href="index.html#SEC_Contents" rel="contents" title="Table of Contents">
<link href="index.html#Top" rel="up" title="Top"> <link href="index.html#Top" rel="up" title="Top">
<link href="Installing-from-MELPA.html#Installing-from-MELPA" rel="next" title="Installing from MELPA"> <link href="Installing-from-MELPA.html#Installing-from-MELPA" rel="next" title="Installing from MELPA">
<link href="Introduction.html#Introduction" rel="prev" title="Introduction"> <link href="A-Brief-Introduction-to-the-Zettelkasten-Method.html#A-Brief-Introduction-to-the-Zettelkasten-Method" rel="prev" title="A Brief Introduction to the Zettelkasten Method">
<style type="text/css"> <style type="text/css">
<!-- <!--
a.summary-letter {text-decoration: none} a.summary-letter {text-decoration: none}
@@ -63,11 +63,11 @@ ul.no-bullet {list-style: none}
<a name="Installation"></a> <a name="Installation"></a>
<div class="header"> <div class="header">
<p> <p>
Next: <a href="Getting-Started.html#Getting-Started" accesskey="n" rel="next">Getting Started</a>, Previous: <a href="Introduction.html#Introduction" accesskey="p" rel="prev">Introduction</a>, Up: <a href="index.html#Top" accesskey="u" rel="up">Top</a> &nbsp; [<a href="index.html#SEC_Contents" title="Table of contents" rel="contents">Contents</a>]</p> Next: <a href="Getting-Started.html#Getting-Started" accesskey="n" rel="next">Getting Started</a>, Previous: <a href="A-Brief-Introduction-to-the-Zettelkasten-Method.html#A-Brief-Introduction-to-the-Zettelkasten-Method" accesskey="p" rel="prev">A Brief Introduction to the Zettelkasten Method</a>, Up: <a href="index.html#Top" accesskey="u" rel="up">Top</a> &nbsp; [<a href="index.html#SEC_Contents" title="Table of contents" rel="contents">Contents</a>]</p>
</div> </div>
<hr> <hr>
<a name="Installation-1"></a> <a name="Installation-1"></a>
<h2 class="chapter">2 Installation</h2> <h2 class="chapter">3 Installation</h2>
<p>Org-roam can be installed using Emacs&rsquo; package manager or manually from its <p>Org-roam can be installed using Emacs&rsquo; package manager or manually from its
development repository. development repository.

14
manual/Installing-from-MELPA.html
View File

@@ -67,9 +67,12 @@ Next: <a href="Installing-from-the-Git-Repository.html#Installing-from-the-Git-R
</div> </div>
<hr> <hr>
<a name="Installing-from-MELPA-1"></a> <a name="Installing-from-MELPA-1"></a>
<h3 class="section">2.1 Installing from MELPA</h3> <h3 class="section">3.1 Installing from MELPA</h3>
<p>Org-roam is available from Melpa and Melpa-Stable. If you haven&rsquo;t used Emacs&rsquo; package manager before, you may familiarize yourself with it by reading the documentation in the Emacs manual, see <a href="https://www.gnu.org/software/emacs/manual/html_node/emacs/Packages.html#Packages">(emacs)Packages</a>. Then, add one of the archives to &lsquo;<samp>package-archives</samp>&rsquo;: <p>Org-roam is available from Melpa and Melpa-Stable. If you haven&rsquo;t used Emacs&rsquo;
package manager before, you may familiarize yourself with it by reading the
documentation in the Emacs manual, see <a href="https://www.gnu.org/software/emacs/manual/html_node/emacs/Packages.html#Packages">(emacs)Packages</a>. Then, add one of the
archives to &lsquo;<samp>package-archives</samp>&rsquo;:
</p> </p>
<ul> <ul>
<li> To use Melpa: <li> To use Melpa:
@@ -91,6 +94,13 @@ Next: <a href="Installing-from-the-Git-Repository.html#Installing-from-the-Git-R
'(&quot;melpa-stable&quot; . &quot;http://stable.melpa.org/packages/&quot;) t) '(&quot;melpa-stable&quot; . &quot;http://stable.melpa.org/packages/&quot;) t)
</pre></div> </pre></div>
<p>Org-roam also depends on a recent version of Org, which can be obtained in Org&rsquo;s
package repository (see <a href="http://www.gnu.org/software/emacs/manual/html_node/org/Installation.html#Installation">(org)Installation</a>). To use Org&rsquo;s ELPA archive:
</p>
<div class="lisp">
<pre class="lisp">(add-to-list 'package-archives '(&quot;org&quot; . &quot;https://orgmode.org/elpa/&quot;) t)
</pre></div>
<p>Once you have added your preferred archive, you need to update the <p>Once you have added your preferred archive, you need to update the
local package list using: local package list using:
</p> </p>

2
manual/Installing-from-the-Git-Repository.html
View File

@@ -67,7 +67,7 @@ Next: <a href="Post_002dInstallation-Tasks.html#Post_002dInstallation-Tasks" acc
</div> </div>
<hr> <hr>
<a name="TODO-Installing-from-the-Git-Repository"></a> <a name="TODO-Installing-from-the-Git-Repository"></a>
<h3 class="section">2.2 <strong>TODO</strong> Installing from the Git Repository</h3> <h3 class="section">3.2 <strong>TODO</strong> Installing from the Git Repository</h3>

6
manual/Introduction.html
View File

@@ -25,7 +25,7 @@ General Public License for more details.
<link href="index.html#Top" rel="start" title="Top"> <link href="index.html#Top" rel="start" title="Top">
<link href="index.html#SEC_Contents" rel="contents" title="Table of Contents"> <link href="index.html#SEC_Contents" rel="contents" title="Table of Contents">
<link href="index.html#Top" rel="up" title="Top"> <link href="index.html#Top" rel="up" title="Top">
<link href="Installation.html#Installation" rel="next" title="Installation"> <link href="A-Brief-Introduction-to-the-Zettelkasten-Method.html#A-Brief-Introduction-to-the-Zettelkasten-Method" rel="next" title="A Brief Introduction to the Zettelkasten Method">
<link href="index.html#Top" rel="prev" title="Top"> <link href="index.html#Top" rel="prev" title="Top">
<style type="text/css"> <style type="text/css">
<!-- <!--
@@ -63,7 +63,7 @@ ul.no-bullet {list-style: none}
<a name="Introduction"></a> <a name="Introduction"></a>
<div class="header"> <div class="header">
<p> <p>
Next: <a href="Installation.html#Installation" accesskey="n" rel="next">Installation</a>, Previous: <a href="index.html#Top" accesskey="p" rel="prev">Top</a>, Up: <a href="index.html#Top" accesskey="u" rel="up">Top</a> &nbsp; [<a href="index.html#SEC_Contents" title="Table of contents" rel="contents">Contents</a>]</p> Next: <a href="A-Brief-Introduction-to-the-Zettelkasten-Method.html#A-Brief-Introduction-to-the-Zettelkasten-Method" accesskey="n" rel="next">A Brief Introduction to the Zettelkasten Method</a>, Previous: <a href="index.html#Top" accesskey="p" rel="prev">Top</a>, Up: <a href="index.html#Top" accesskey="u" rel="up">Top</a> &nbsp; [<a href="index.html#SEC_Contents" title="Table of contents" rel="contents">Contents</a>]</p>
</div> </div>
<hr> <hr>
<a name="Introduction-1"></a> <a name="Introduction-1"></a>
@@ -107,7 +107,7 @@ to further introduce features enabled by the Emacs ecosystem.
<hr> <hr>
<div class="header"> <div class="header">
<p> <p>
Next: <a href="Installation.html#Installation" accesskey="n" rel="next">Installation</a>, Previous: <a href="index.html#Top" accesskey="p" rel="prev">Top</a>, Up: <a href="index.html#Top" accesskey="u" rel="up">Top</a> &nbsp; [<a href="index.html#SEC_Contents" title="Table of contents" rel="contents">Contents</a>]</p> Next: <a href="A-Brief-Introduction-to-the-Zettelkasten-Method.html#A-Brief-Introduction-to-the-Zettelkasten-Method" accesskey="n" rel="next">A Brief Introduction to the Zettelkasten Method</a>, Previous: <a href="index.html#Top" accesskey="p" rel="prev">Top</a>, Up: <a href="index.html#Top" accesskey="u" rel="up">Top</a> &nbsp; [<a href="index.html#SEC_Contents" title="Table of contents" rel="contents">Contents</a>]</p>
</div> </div>

2
manual/Navigating-Around.html
View File

@@ -67,7 +67,7 @@ Next: <a href="Encryption.html#Encryption" accesskey="n" rel="next">Encryption</
</div> </div>
<hr> <hr>
<a name="Navigating-Around-1"></a> <a name="Navigating-Around-1"></a>
<h2 class="chapter">7 Navigating Around</h2> <h2 class="chapter">8 Navigating Around</h2>
<table class="menu" border="0" cellspacing="0"> <table class="menu" border="0" cellspacing="0">
<tr><td align="left" valign="top">&bull; <a href="Index-File.html#Index-File" accesskey="1">Index File</a>:</td><td>&nbsp;&nbsp;</td><td align="left" valign="top"> <tr><td align="left" valign="top">&bull; <a href="Index-File.html#Index-File" accesskey="1">Index File</a>:</td><td>&nbsp;&nbsp;</td><td align="left" valign="top">

2
manual/Note_002dtaking-Add_002dons.html
View File

@@ -67,7 +67,7 @@ Previous: <a href="Org_002djournal.html#Org_002djournal" accesskey="p" rel="prev
</div> </div>
<hr> <hr>
<a name="Note_002dtaking-Add_002dons-1"></a> <a name="Note_002dtaking-Add_002dons-1"></a>
<h4 class="subsection">13.2.3 Note-taking Add-ons</h4> <h4 class="subsection">14.2.3 Note-taking Add-ons</h4>
<p>These are some plugins that make note-taking in Org-mode more enjoyable. <p>These are some plugins that make note-taking in Org-mode more enjoyable.
</p> </p>

2
manual/Note_002dtaking-Workflows.html
View File

@@ -67,7 +67,7 @@ Next: <a href="Ecosystem.html#Ecosystem" accesskey="n" rel="next">Ecosystem</a>,
</div> </div>
<hr> <hr>
<a name="Note_002dtaking-Workflows-1"></a> <a name="Note_002dtaking-Workflows-1"></a>
<h3 class="section">13.1 Note-taking Workflows</h3> <h3 class="section">14.1 Note-taking Workflows</h3>
<dl compact="compact"> <dl compact="compact">
<dt>Books</dt> <dt>Books</dt>

2
manual/Org_002djournal.html
View File

@@ -67,7 +67,7 @@ Next: <a href="Note_002dtaking-Add_002dons.html#Note_002dtaking-Add_002dons" acc
</div> </div>
<hr> <hr>
<a name="Org_002djournal-1"></a> <a name="Org_002djournal-1"></a>
<h4 class="subsection">13.2.2 Org-journal</h4> <h4 class="subsection">14.2.2 Org-journal</h4>
<p><a href="https://github.com/bastibe/org-journal">Org-journal</a> is a more <p><a href="https://github.com/bastibe/org-journal">Org-journal</a> is a more
powerful alternative to the simple function &lsquo;<samp>org-roam-dailies-today</samp>&rsquo;. It powerful alternative to the simple function &lsquo;<samp>org-roam-dailies-today</samp>&rsquo;. It

2
manual/Org_002droam-Completion-System.html
View File

@@ -67,7 +67,7 @@ Next: <a href="Roam-Protocol.html#Roam-Protocol" accesskey="n" rel="next">Roam P
</div> </div>
<hr> <hr>
<a name="Org_002droam-Completion-System-1"></a> <a name="Org_002droam-Completion-System-1"></a>
<h2 class="chapter">10 Org-roam Completion System</h2> <h2 class="chapter">11 Org-roam Completion System</h2>
<p>Org-roam offers completion when choosing note titles etc. The completion <p>Org-roam offers completion when choosing note titles etc. The completion
system is configurable. The default setting, system is configurable. The default setting,

2
manual/Org_002droam-Files.html
View File

@@ -67,7 +67,7 @@ Previous: <a href="Org_002droam-Links.html#Org_002droam-Links" accesskey="p" rel
</div> </div>
<hr> <hr>
<a name="Org_002droam-Files-1"></a> <a name="Org_002droam-Files-1"></a>
<h3 class="section">6.4 Org-roam Files</h3> <h3 class="section">7.4 Org-roam Files</h3>
<p>Org-roam files are created and prefilled using Org-roam&rsquo;s templating <p>Org-roam files are created and prefilled using Org-roam&rsquo;s templating
system. The templating system is customizable (see <a href="The-Templating-System.html#The-Templating-System">The Templating System</a>). system. The templating system is customizable (see <a href="The-Templating-System.html#The-Templating-System">The Templating System</a>).

2
manual/Org_002droam-Links.html
View File

@@ -67,7 +67,7 @@ Next: <a href="Org_002droam-Files.html#Org_002droam-Files" accesskey="n" rel="ne
</div> </div>
<hr> <hr>
<a name="Org_002droam-Links-1"></a> <a name="Org_002droam-Links-1"></a>
<h3 class="section">6.3 Org-roam Links</h3> <h3 class="section">7.3 Org-roam Links</h3>
<p>Org-roam links are regular &lsquo;<samp>file:</samp>&rsquo; links in Org-mode. By default, links are <p>Org-roam links are regular &lsquo;<samp>file:</samp>&rsquo; links in Org-mode. By default, links are
inserted with the title as the link description with &lsquo;<samp>org-roam-insert</samp>&rsquo;. inserted with the title as the link description with &lsquo;<samp>org-roam-insert</samp>&rsquo;.

2
manual/Org_002droam-Template-Expansion.html
View File

@@ -67,7 +67,7 @@ Previous: <a href="Template-Walkthrough.html#Template-Walkthrough" accesskey="p"
</div> </div>
<hr> <hr>
<a name="Org_002droam-Template-Expansion-1"></a> <a name="Org_002droam-Template-Expansion-1"></a>
<h3 class="section">5.2 Org-roam Template Expansion</h3> <h3 class="section">6.2 Org-roam Template Expansion</h3>
<p>Org-roam&rsquo;s template definitions also extend org-capture&rsquo;s template syntax, to <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.html#Template-Walkthrough">Template allow prefilling of strings. We have seen a glimpse of this in <a href="Template-Walkthrough.html#Template-Walkthrough">Template

2
manual/Post_002dInstallation-Tasks.html
View File

@@ -67,7 +67,7 @@ Previous: <a href="Installing-from-the-Git-Repository.html#Installing-from-the-G
</div> </div>
<hr> <hr>
<a name="Post_002dInstallation-Tasks-1"></a> <a name="Post_002dInstallation-Tasks-1"></a>
<h3 class="section">2.3 Post-Installation Tasks</h3> <h3 class="section">3.3 Post-Installation Tasks</h3>
<p>Org-roam uses <code>emacsql-sqlite3</code>, which requires <code>sqlite3</code> to be located on <p>Org-roam uses <code>emacsql-sqlite3</code>, which requires <code>sqlite3</code> to be located on
<code>exec-path</code>. Please ensure that <code>sqlite3</code> is installed appropriately on your <code>exec-path</code>. Please ensure that <code>sqlite3</code> is installed appropriately on your

2
manual/Roam-Protocol.html
View File

@@ -67,7 +67,7 @@ Next: <a href="Diagnosing-and-Repairing-Files.html#Diagnosing-and-Repairing-File
</div> </div>
<hr> <hr>
<a name="Roam-Protocol-1"></a> <a name="Roam-Protocol-1"></a>
<h2 class="chapter">11 Roam Protocol</h2> <h2 class="chapter">12 Roam Protocol</h2>
<table class="menu" border="0" cellspacing="0"> <table class="menu" border="0" cellspacing="0">
<tr><td align="left" valign="top">&bull; <a href="_005f.html#g_t_005f" accesskey="1">_</a>:</td><td>&nbsp;&nbsp;</td><td align="left" valign="top"> <tr><td align="left" valign="top">&bull; <a href="_005f.html#g_t_005f" accesskey="1">_</a>:</td><td>&nbsp;&nbsp;</td><td align="left" valign="top">

2
manual/Tags.html
View File

@@ -67,7 +67,7 @@ Next: <a href="File-Refs.html#File-Refs" accesskey="n" rel="next">File Refs</a>,
</div> </div>
<hr> <hr>
<a name="Tags-1"></a> <a name="Tags-1"></a>
<h3 class="section">4.2 Tags</h3> <h3 class="section">5.2 Tags</h3>
<p>Tags are used as meta-data for files: they facilitate interactions with notes <p>Tags are used as meta-data for files: they facilitate interactions with notes
where titles are insufficient. For example, tags allow for categorization of where titles are insufficient. For example, tags allow for categorization of

2
manual/Template-Walkthrough.html
View File

@@ -67,7 +67,7 @@ Next: <a href="Org_002droam-Template-Expansion.html#Org_002droam-Template-Expans
</div> </div>
<hr> <hr>
<a name="Template-Walkthrough-1"></a> <a name="Template-Walkthrough-1"></a>
<h3 class="section">5.1 Template Walkthrough</h3> <h3 class="section">6.1 Template Walkthrough</h3>
<p>To demonstrate the additions made to org-capture templates. Here, we walkthrough <p>To demonstrate the additions made to org-capture templates. Here, we walkthrough
the default template, reproduced below. the default template, reproduced below.

2
manual/The-Org_002droam-Buffer.html
View File

@@ -67,7 +67,7 @@ Next: <a href="Org_002droam-Links.html#Org_002droam-Links" accesskey="n" rel="ne
</div> </div>
<hr> <hr>
<a name="The-Org_002droam-Buffer-1"></a> <a name="The-Org_002droam-Buffer-1"></a>
<h3 class="section">6.2 The Org-roam Buffer</h3> <h3 class="section">7.2 The Org-roam Buffer</h3>
<p>The Org-roam buffer displays backlinks for the currently active Org-roam note. <p>The Org-roam buffer displays backlinks for the currently active Org-roam note.
</p> </p>

2
manual/The-Templating-System.html
View File

@@ -67,7 +67,7 @@ Next: <a href="Concepts-and-Configuration.html#Concepts-and-Configuration" acces
</div> </div>
<hr> <hr>
<a name="The-Templating-System-1"></a> <a name="The-Templating-System-1"></a>
<h2 class="chapter">5 The Templating System</h2> <h2 class="chapter">6 The Templating System</h2>
<p>Rather than creating blank files on &lsquo;<samp>org-roam-insert</samp>&rsquo; and &lsquo;<samp>org-roam-find-file</samp>&rsquo;, it <p>Rather than creating blank files on &lsquo;<samp>org-roam-insert</samp>&rsquo; and &lsquo;<samp>org-roam-find-file</samp>&rsquo;, it
may be desirable to prefill the file with templated content. This may include: may be desirable to prefill the file with templated content. This may include:

2
manual/The-roam_002dfile-protocol.html
View File

@@ -67,7 +67,7 @@ Next: <a href="The-roam_002dref-Protocol.html#The-roam_002dref-Protocol" accessk
</div> </div>
<hr> <hr>
<a name="The-roam_002dfile-protocol-1"></a> <a name="The-roam_002dfile-protocol-1"></a>
<h3 class="section">11.3 The &lsquo;<samp>roam-file</samp>&rsquo; protocol</h3> <h3 class="section">12.3 The &lsquo;<samp>roam-file</samp>&rsquo; protocol</h3>
<p>This is a simple protocol that opens the path specified by the &lsquo;<samp>file</samp>&rsquo; <p>This is a simple protocol that opens the path specified by the &lsquo;<samp>file</samp>&rsquo;
key (e.g. &lsquo;<samp>org-protocol://roam-file?file=/tmp/file.org</samp>&rsquo;). This is used key (e.g. &lsquo;<samp>org-protocol://roam-file?file=/tmp/file.org</samp>&rsquo;). This is used

2
manual/The-roam_002dref-Protocol.html
View File

@@ -67,7 +67,7 @@ Previous: <a href="The-roam_002dfile-protocol.html#The-roam_002dfile-protocol" a
</div> </div>
<hr> <hr>
<a name="The-roam_002dref-Protocol-1"></a> <a name="The-roam_002dref-Protocol-1"></a>
<h3 class="section">11.4 The &lsquo;<samp>roam-ref</samp>&rsquo; Protocol</h3> <h3 class="section">12.4 The &lsquo;<samp>roam-ref</samp>&rsquo; Protocol</h3>
<p>This protocol finds or creates a new note with a given &lsquo;<samp>ROAM_KEY</samp>&rsquo; (see <a href="Anatomy-of-an-Org_002droam-File.html#Anatomy-of-an-Org_002droam-File">Anatomy of an Org-roam File</a>): <p>This protocol finds or creates a new note with a given &lsquo;<samp>ROAM_KEY</samp>&rsquo; (see <a href="Anatomy-of-an-Org_002droam-File.html#Anatomy-of-an-Org_002droam-File">Anatomy of an Org-roam File</a>):
</p> </p>

2
manual/Titles.html
View File

@@ -67,7 +67,7 @@ Next: <a href="Tags.html#Tags" accesskey="n" rel="next">Tags</a>, Up: <a href="A
</div> </div>
<hr> <hr>
<a name="Titles-1"></a> <a name="Titles-1"></a>
<h3 class="section">4.1 Titles</h3> <h3 class="section">5.1 Titles</h3>
<p>To easily find a note, a title needs to be prescribed to a note. A note can have <p>To easily find a note, a title needs to be prescribed to a note. A note can have
many titles: this allows a note to be referred to by different names, which is many titles: this allows a note to be referred to by different names, which is

2
manual/_005f.html
View File

@@ -67,7 +67,7 @@ Next: <a href="Installation-_00281_0029.html#Installation-_00281_0029" accesskey
</div> </div>
<hr> <hr>
<a name="g_t_005f-_003aignore_003a"></a> <a name="g_t_005f-_003aignore_003a"></a>
<h3 class="section">11.1 _ :ignore:</h3> <h3 class="section">12.1 _ :ignore:</h3>
<p>Org-roam extending &lsquo;<samp>org-protocol</samp>&rsquo; with 2 protocols: the &lsquo;<samp>roam-file</samp>&rsquo; <p>Org-roam extending &lsquo;<samp>org-protocol</samp>&rsquo; with 2 protocols: the &lsquo;<samp>roam-file</samp>&rsquo;
and &lsquo;<samp>roam-ref</samp>&rsquo; protocol. and &lsquo;<samp>roam-ref</samp>&rsquo; protocol.

95
manual/index.html
View File

@@ -71,58 +71,59 @@ ul.no-bullet {list-style: none}
<ul class="no-bullet"> <ul class="no-bullet">
<li><a name="toc-Introduction-1" href="Introduction.html#Introduction">1 Introduction</a></li> <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> <li><a name="toc-A-Brief-Introduction-to-the-Zettelkasten-Method-1" href="A-Brief-Introduction-to-the-Zettelkasten-Method.html#A-Brief-Introduction-to-the-Zettelkasten-Method">2 A Brief Introduction to the Zettelkasten Method</a></li>
<li><a name="toc-Installation-1" href="Installation.html#Installation">3 Installation</a>
<ul class="no-bullet"> <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-Installing-from-MELPA-1" href="Installing-from-MELPA.html#Installing-from-MELPA">3.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-Installing-from-the-Git-Repository" href="Installing-from-the-Git-Repository.html#Installing-from-the-Git-Repository">3.2 <strong>TODO</strong> Installing from the Git Repository</a></li>
<li><a name="toc-Post_002dInstallation-Tasks-1" href="Post_002dInstallation-Tasks.html#Post_002dInstallation-Tasks">2.3 Post-Installation Tasks</a></li> <li><a name="toc-Post_002dInstallation-Tasks-1" href="Post_002dInstallation-Tasks.html#Post_002dInstallation-Tasks">3.3 Post-Installation Tasks</a></li>
</ul></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-Getting-Started-1" href="Getting-Started.html#Getting-Started">4 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> <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">5 Anatomy of an Org-roam File</a>
<ul class="no-bullet"> <ul class="no-bullet">
<li><a name="toc-Titles-1" href="Titles.html#Titles">4.1 Titles</a></li> <li><a name="toc-Titles-1" href="Titles.html#Titles">5.1 Titles</a></li>
<li><a name="toc-Tags-1" href="Tags.html#Tags">4.2 Tags</a></li> <li><a name="toc-Tags-1" href="Tags.html#Tags">5.2 Tags</a></li>
<li><a name="toc-File-Refs-1" href="File-Refs.html#File-Refs">4.3 File Refs</a></li> <li><a name="toc-File-Refs-1" href="File-Refs.html#File-Refs">5.3 File Refs</a></li>
</ul></li> </ul></li>
<li><a name="toc-The-Templating-System-1" href="The-Templating-System.html#The-Templating-System">5 The Templating System</a> <li><a name="toc-The-Templating-System-1" href="The-Templating-System.html#The-Templating-System">6 The Templating System</a>
<ul class="no-bullet"> <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-Template-Walkthrough-1" href="Template-Walkthrough.html#Template-Walkthrough">6.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> <li><a name="toc-Org_002droam-Template-Expansion-1" href="Org_002droam-Template-Expansion.html#Org_002droam-Template-Expansion">6.2 Org-roam Template Expansion</a></li>
</ul></li> </ul></li>
<li><a name="toc-Concepts-and-Configuration-1" href="Concepts-and-Configuration.html#Concepts-and-Configuration">6 Concepts and Configuration</a> <li><a name="toc-Concepts-and-Configuration-1" href="Concepts-and-Configuration.html#Concepts-and-Configuration">7 Concepts and Configuration</a>
<ul class="no-bullet"> <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-Directories-and-Files-1" href="Directories-and-Files.html#Directories-and-Files">7.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-The-Org_002droam-Buffer-1" href="The-Org_002droam-Buffer.html#The-Org_002droam-Buffer">7.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-Links-1" href="Org_002droam-Links.html#Org_002droam-Links">7.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> <li><a name="toc-Org_002droam-Files-1" href="Org_002droam-Files.html#Org_002droam-Files">7.4 Org-roam Files</a></li>
</ul></li> </ul></li>
<li><a name="toc-Navigating-Around-1" href="Navigating-Around.html#Navigating-Around">7 Navigating Around</a> <li><a name="toc-Navigating-Around-1" href="Navigating-Around.html#Navigating-Around">8 Navigating Around</a>
<ul class="no-bullet"> <ul class="no-bullet">
<li><a name="toc-Index-File-1" href="Index-File.html#Index-File">7.1 Index File</a></li> <li><a name="toc-Index-File-1" href="Index-File.html#Index-File">8.1 Index File</a></li>
</ul></li> </ul></li>
<li><a name="toc-Encryption-1" href="Encryption.html#Encryption">8 Encryption</a></li> <li><a name="toc-Encryption-1" href="Encryption.html#Encryption">9 Encryption</a></li>
<li><a name="toc-Graphing-1" href="Graphing.html#Graphing">9 Graphing</a> <li><a name="toc-Graphing-1" href="Graphing.html#Graphing">10 Graphing</a>
<ul class="no-bullet"> <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-Graph-Options-1" href="Graph-Options.html#Graph-Options">10.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> <li><a name="toc-Excluding-Nodes-and-Edges-1" href="Excluding-Nodes-and-Edges.html#Excluding-Nodes-and-Edges">10.2 Excluding Nodes and Edges</a></li>
</ul></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-Org_002droam-Completion-System-1" href="Org_002droam-Completion-System.html#Org_002droam-Completion-System">11 Org-roam Completion System</a></li>
<li><a name="toc-Roam-Protocol-1" href="Roam-Protocol.html#Roam-Protocol">11 Roam Protocol</a> <li><a name="toc-Roam-Protocol-1" href="Roam-Protocol.html#Roam-Protocol">12 Roam Protocol</a>
<ul class="no-bullet"> <ul class="no-bullet">
<li><a name="toc-_005f-_003aignore_003a" href="_005f.html#g_t_005f">11.1 _ :ignore:</a></li> <li><a name="toc-_005f-_003aignore_003a" href="_005f.html#g_t_005f">12.1 _ :ignore:</a></li>
<li><a name="toc-Installation-2" href="Installation-_00281_0029.html#Installation-_00281_0029">11.2 Installation</a></li> <li><a name="toc-Installation-2" href="Installation-_00281_0029.html#Installation-_00281_0029">12.2 Installation</a></li>
<li><a name="toc-The-roam_002dfile-protocol-1" href="The-roam_002dfile-protocol.html#The-roam_002dfile-protocol">11.3 The &lsquo;<samp>roam-file</samp>&rsquo; protocol</a></li> <li><a name="toc-The-roam_002dfile-protocol-1" href="The-roam_002dfile-protocol.html#The-roam_002dfile-protocol">12.3 The &lsquo;<samp>roam-file</samp>&rsquo; protocol</a></li>
<li><a name="toc-The-roam_002dref-Protocol-1" href="The-roam_002dref-Protocol.html#The-roam_002dref-Protocol">11.4 The &lsquo;<samp>roam-ref</samp>&rsquo; Protocol</a></li> <li><a name="toc-The-roam_002dref-Protocol-1" href="The-roam_002dref-Protocol.html#The-roam_002dref-Protocol">12.4 The &lsquo;<samp>roam-ref</samp>&rsquo; Protocol</a></li>
</ul></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-Diagnosing-and-Repairing-Files-1" href="Diagnosing-and-Repairing-Files.html#Diagnosing-and-Repairing-Files">13 Diagnosing and Repairing Files</a></li>
<li><a name="toc-Appendix-1" href="Appendix.html#Appendix">13 Appendix</a> <li><a name="toc-Appendix-1" href="Appendix.html#Appendix">14 Appendix</a>
<ul class="no-bullet"> <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-Note_002dtaking-Workflows-1" href="Note_002dtaking-Workflows.html#Note_002dtaking-Workflows">14.1 Note-taking Workflows</a></li>
<li><a name="toc-Ecosystem-1" href="Ecosystem.html#Ecosystem">13.2 Ecosystem</a> <li><a name="toc-Ecosystem-1" href="Ecosystem.html#Ecosystem">14.2 Ecosystem</a>
<ul class="no-bullet"> <ul class="no-bullet">
<li><a name="toc-Deft-1" href="Deft.html#Deft">13.2.1 Deft</a></li> <li><a name="toc-Deft-1" href="Deft.html#Deft">14.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-Org_002djournal-1" href="Org_002djournal.html#Org_002djournal">14.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> <li><a name="toc-Note_002dtaking-Add_002dons-1" href="Note_002dtaking-Add_002dons.html#Note_002dtaking-Add_002dons">14.2.3 Note-taking Add-ons</a>
<ul class="no-bullet"> <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-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-mathpix_002eel" href="mathpixel.html#mathpixel">mathpix.el</a></li>
@@ -132,9 +133,9 @@ ul.no-bullet {list-style: none}
</ul></li> </ul></li>
</ul></li> </ul></li>
</ul></li> </ul></li>
<li><a name="toc-FAQ-1" href="FAQ.html#FAQ">14 FAQ</a> <li><a name="toc-FAQ-1" href="FAQ.html#FAQ">15 FAQ</a>
<ul class="no-bullet"> <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> <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">15.1 How do I have more than one Org-roam directory?</a></li>
</ul></li> </ul></li>
</ul> </ul>
</div> </div>
@@ -169,21 +170,23 @@ General Public License for more details.
<table class="menu" border="0" cellspacing="0"> <table class="menu" border="0" cellspacing="0">
<tr><td align="left" valign="top">&bull; <a href="Introduction.html#Introduction" accesskey="1">Introduction</a>:</td><td>&nbsp;&nbsp;</td><td align="left" valign="top"> <tr><td align="left" valign="top">&bull; <a href="Introduction.html#Introduction" accesskey="1">Introduction</a>:</td><td>&nbsp;&nbsp;</td><td align="left" valign="top">
</td></tr> </td></tr>
<tr><td align="left" valign="top">&bull; <a href="Installation.html#Installation" accesskey="2">Installation</a>:</td><td>&nbsp;&nbsp;</td><td align="left" valign="top"> <tr><td align="left" valign="top">&bull; <a href="A-Brief-Introduction-to-the-Zettelkasten-Method.html#A-Brief-Introduction-to-the-Zettelkasten-Method" accesskey="2">A Brief Introduction to the Zettelkasten Method</a>:</td><td>&nbsp;&nbsp;</td><td align="left" valign="top">
</td></tr> </td></tr>
<tr><td align="left" valign="top">&bull; <a href="Getting-Started.html#Getting-Started" accesskey="3">Getting Started</a>:</td><td>&nbsp;&nbsp;</td><td align="left" valign="top"> <tr><td align="left" valign="top">&bull; <a href="Installation.html#Installation" accesskey="3">Installation</a>:</td><td>&nbsp;&nbsp;</td><td align="left" valign="top">
</td></tr> </td></tr>
<tr><td align="left" valign="top">&bull; <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>&nbsp;&nbsp;</td><td align="left" valign="top"> <tr><td align="left" valign="top">&bull; <a href="Getting-Started.html#Getting-Started" accesskey="4">Getting Started</a>:</td><td>&nbsp;&nbsp;</td><td align="left" valign="top">
</td></tr> </td></tr>
<tr><td align="left" valign="top">&bull; <a href="The-Templating-System.html#The-Templating-System" accesskey="5">The Templating System</a>:</td><td>&nbsp;&nbsp;</td><td align="left" valign="top"> <tr><td align="left" valign="top">&bull; <a href="Anatomy-of-an-Org_002droam-File.html#Anatomy-of-an-Org_002droam-File" accesskey="5">Anatomy of an Org-roam File</a>:</td><td>&nbsp;&nbsp;</td><td align="left" valign="top">
</td></tr> </td></tr>
<tr><td align="left" valign="top">&bull; <a href="Concepts-and-Configuration.html#Concepts-and-Configuration" accesskey="6">Concepts and Configuration</a>:</td><td>&nbsp;&nbsp;</td><td align="left" valign="top"> <tr><td align="left" valign="top">&bull; <a href="The-Templating-System.html#The-Templating-System" accesskey="6">The Templating System</a>:</td><td>&nbsp;&nbsp;</td><td align="left" valign="top">
</td></tr> </td></tr>
<tr><td align="left" valign="top">&bull; <a href="Navigating-Around.html#Navigating-Around" accesskey="7">Navigating Around</a>:</td><td>&nbsp;&nbsp;</td><td align="left" valign="top"> <tr><td align="left" valign="top">&bull; <a href="Concepts-and-Configuration.html#Concepts-and-Configuration" accesskey="7">Concepts and Configuration</a>:</td><td>&nbsp;&nbsp;</td><td align="left" valign="top">
</td></tr> </td></tr>
<tr><td align="left" valign="top">&bull; <a href="Encryption.html#Encryption" accesskey="8">Encryption</a>:</td><td>&nbsp;&nbsp;</td><td align="left" valign="top"> <tr><td align="left" valign="top">&bull; <a href="Navigating-Around.html#Navigating-Around" accesskey="8">Navigating Around</a>:</td><td>&nbsp;&nbsp;</td><td align="left" valign="top">
</td></tr> </td></tr>
<tr><td align="left" valign="top">&bull; <a href="Graphing.html#Graphing" accesskey="9">Graphing</a>:</td><td>&nbsp;&nbsp;</td><td align="left" valign="top"> <tr><td align="left" valign="top">&bull; <a href="Encryption.html#Encryption" accesskey="9">Encryption</a>:</td><td>&nbsp;&nbsp;</td><td align="left" valign="top">
</td></tr>
<tr><td align="left" valign="top">&bull; <a href="Graphing.html#Graphing">Graphing</a>:</td><td>&nbsp;&nbsp;</td><td align="left" valign="top">
</td></tr> </td></tr>
<tr><td align="left" valign="top">&bull; <a href="Org_002droam-Completion-System.html#Org_002droam-Completion-System">Org-roam Completion System</a>:</td><td>&nbsp;&nbsp;</td><td align="left" valign="top"> <tr><td align="left" valign="top">&bull; <a href="Org_002droam-Completion-System.html#Org_002droam-Completion-System">Org-roam Completion System</a>:</td><td>&nbsp;&nbsp;</td><td align="left" valign="top">
</td></tr> </td></tr>

63
org-roam.org
View File

@@ -56,6 +56,51 @@ Org-roam provides several benefits over other tooling:
- Leverages the Org-mode ecosystem :: Over the years, Emacs and Org-mode has developed into a mature system for plain-text organization. Building upon Org-mode already puts Org-roam light-years ahead of many other solutions. - Leverages the Org-mode ecosystem :: Over the years, Emacs and Org-mode has developed into a mature system for plain-text organization. Building upon Org-mode already puts Org-roam light-years ahead of many other solutions.
- Built on Emacs :: Emacs is also a fantastic interface for editing text, and we can inherit many of the powerful text-navigation and editing packages available to Emacs. - Built on Emacs :: Emacs is also a fantastic interface for editing text, and we can inherit many of the powerful text-navigation and editing packages available to Emacs.
* A Brief Introduction to the Zettelkasten Method
Org-roam provides utilities for maintaining a digital slip-box. This section
aims to provide a brief introduction to the "slip-box", or "Zettelkasten"
method. By providing some background on the method, we hope that the design
decisions of Org-roam will become clear, and that will aid in using Org-roam
appropriately. In this section we will also introduce terms commonly used within
the Zettelkasten community, which will also commonly appear in the Org-roam
forums and channels of discussion.
The Zettelkasten method of note-taking is designed to increase research
productivity: in particular, it acts as a research partner, where conversations
with it may produce new and surprising lines of thought. This method is
attributed to German sociologist Niklas Luhmann, who using the method had
produced volumes of written works.
In its paper form, the slip-box is simply a box of cards. These cards are small
-- often only large enough to fit a single concept. The size limitation
encourages ideas to be broken down into individual concepts. These ideas are
explicitly linked together. The breakdown of ideas encourages tangential
exploration of ideas, increasing the surface for thought. Making linking
explicit between notes also encourages one to think about the connections
between concepts.
Org-roam is the slip-box, digitalized in Org-mode. Every zettel (card) is a
plain-text, Org-mode file. These files are often placed in the same directory.
In the same way one would maintain a paper slip-box, Org-roam makes it easy to
create new zettels, pre-filling boilerplate content using a powerful templating
system. Org-roam also facilitates the linking of zettels using Org-mode ~file:~
links.
A slip-box requires a method of quickly capturing ideas. These are called
*fleeting notes*: they are simple reminders of information or ideas that will
need to be processed later on, or trashed. This is typically accomplished using
~org-capture~ (see info:org#capture), or using Org-roam's daily notes
functionality (see [[*Daily Notes][Daily Notes]]). This provides a central inbox for collecting
thoughts, to be processed later into permanent notes.
Permanent notes are further split into two categories: *literature notes* and
*concept notes*. Literature notes can be brief annotations on a particular
source (e.g. book, website or paper), that you'd like to access later on.
Concept notes require much more care in authoring: they need to be
self-explanatory and detailed. Org-roam's templating system supports the
addition of different templates to facilitate the creation of these notes.
* Installation * Installation
Org-roam can be installed using Emacs' package manager or manually from its Org-roam can be installed using Emacs' package manager or manually from its
@@ -486,7 +531,6 @@ number of password prompts, you may wish to cache the password.
- Variable: org-roam-encrypt-files - Variable: org-roam-encrypt-files
Whether to encrypt new files. If true, create files with .org.gpg extension. Whether to encrypt new files. If true, create files with .org.gpg extension.
* Graphing * Graphing
Org-roam provides graphing capabilities to explore interconnections between Org-roam provides graphing capabilities to explore interconnections between
@@ -740,6 +784,8 @@ where =template= is the template key for a template in
=org-roam-capture-ref-templates= (see [[*The Templating System][The Templating System]]). These templates =org-roam-capture-ref-templates= (see [[*The Templating System][The Templating System]]). These templates
should contain a =#+ROAM_KEY: ${ref}= in it. should contain a =#+ROAM_KEY: ${ref}= in it.
* TODO Daily Notes
* Diagnosing and Repairing Files * Diagnosing and Repairing Files
Org-roam provides a utility for diagnosing and repairing problematic files via Org-roam provides a utility for diagnosing and repairing problematic files via
@@ -771,7 +817,6 @@ checker, to perform autofixes for the errors. For each error detected,
=org-roam-doctor= will move the point to the current error, and pop-up a help =org-roam-doctor= will move the point to the current error, and pop-up a help
window displaying the error message, as well as the list of actions that can be window displaying the error message, as well as the list of actions that can be
taken provided in =:actions=. taken provided in =:actions=.
* _ Copying * _ Copying
:PROPERTIES: :PROPERTIES:
:COPYING: t :COPYING: t
@@ -896,8 +941,7 @@ These are some plugins that make note-taking in Org-mode more enjoyable.
:CUSTOM_ID: org-download :CUSTOM_ID: org-download
:END: :END:
[[https://github.com/abo-abo/org-download][Org-download]] lets you [[https://github.com/abo-abo/org-download][Org-download]] lets you screenshot and yank images from the web into your notes:
screenshot and yank images from the web into your notes:
#+CAPTION: org-download #+CAPTION: org-download
[[file:images/org-download.gif]] [[file:images/org-download.gif]]
@@ -916,9 +960,7 @@ screenshot and yank images from the web into your notes:
:CUSTOM_ID: mathpix.el :CUSTOM_ID: mathpix.el
:END: :END:
[[https://github.com/jethrokuan/mathpix.el][mathpix.el]] uses [[https://github.com/jethrokuan/mathpix.el][mathpix.el]] uses [[https://mathpix.com/][Mathpix's]] API to convert clips into latex equations:
[[https://mathpix.com/][Mathpix's]] API to convert clips into latex
equations:
#+CAPTION: mathpix #+CAPTION: mathpix
[[file:images/mathpix.gif]] [[file:images/mathpix.gif]]
@@ -959,11 +1001,8 @@ tight integration between
:CUSTOM_ID: spaced-repetition :CUSTOM_ID: spaced-repetition
:END: :END:
[[https://github.com/l3kn/org-fc/][Org-fc]] is a spaced repetition [[https://github.com/l3kn/org-fc/][Org-fc]] is a spaced repetition system that scales well with a large number of
system that scales well with a large number of files. Other alternatives files. Other alternatives include [[https://orgmode.org/worg/org-contrib/org-drill.html][org-drill]], and [[https://github.com/abo-abo/pamparam][pamparam]].
include
[[https://orgmode.org/worg/org-contrib/org-drill.html][org-drill]], and
[[https://github.com/abo-abo/pamparam][pamparam]].
* FAQ * FAQ
** How do I have more than one Org-roam directory? ** How do I have more than one Org-roam directory?

45
org-roam.texi
View File

@@ -65,6 +65,7 @@ General Public License for more details.
@menu @menu
* Introduction:: * Introduction::
* A Brief Introduction to the Zettelkasten Method::
* Installation:: * Installation::
* Getting Started:: * Getting Started::
* Anatomy of an Org-roam File:: * Anatomy of an Org-roam File::
@@ -174,6 +175,38 @@ Over the years, Emacs and Org-mode has developed into a mature system for plain-
Emacs is also a fantastic interface for editing text, and we can inherit many of the powerful text-navigation and editing packages available to Emacs. Emacs is also a fantastic interface for editing text, and we can inherit many of the powerful text-navigation and editing packages available to Emacs.
@end table @end table
@node A Brief Introduction to the Zettelkasten Method
@chapter A Brief Introduction to the Zettelkasten Method
Org-roam provides utilities for maintaining a digital slip-box. This section
aims to provide a brief introduction to the ``slip-box'', or ``Zettelkasten''
method. By providing some background on the method, we hope that the design
decisions of Org-roam will become clear, and that will aid in using Org-roam
appropriately. In this section we will also introduce terms commonly used within
the Zettelkasten community, which will also commonly appear in the Org-roam
forums and channels of discussion.
The Zettelkasten method of note-taking is designed to increase research
productivity: in particular, it acts as a research partner, where conversations
with it may produce new and surprising lines of thought. This method is
attributed to German sociologist Niklas Luhmann, who using the method had
produced volumes of written works.
In its paper form, the slip-box is simply a box of cards. These cards are small,
and often only large enough to fit a single concept. The size limitation
encourages ideas to be broken down into individual concepts. These ideas are
explicitly linked together, using an indexing system. Enforcing the breakdown of
ideas encourages tangential exploration of ideas, increasing the surface for
thought. Making linking explicit between notes also encourages one to think
about the connections between concepts, which forms a large part of research.
Org-roam is the slip-box, digitalized in Org-mode. Every zettel (card) is a
plain-text, Org-mode file. These files are often placed in the same directory.
In the same way one would maintain a paper slip-box, Org-roam makes it easy to
create new zettels, pre-filling boilerplate content using a powerful templating
system. Org-roam also facilitates the linking of zettels using Org-mode @code{file:}
links.
@node Installation @node Installation
@chapter Installation @chapter Installation
@@ -189,7 +222,10 @@ development repository.
@node Installing from MELPA @node Installing from MELPA
@section Installing from MELPA @section Installing from MELPA
Org-roam is available from Melpa and Melpa-Stable. If you haven't used Emacs' package manager before, you may familiarize yourself with it by reading the documentation in the Emacs manual, see @ref{Packages,,,emacs,}. Then, add one of the archives to @samp{package-archives}: Org-roam is available from Melpa and Melpa-Stable. If you haven't used Emacs'
package manager before, you may familiarize yourself with it by reading the
documentation in the Emacs manual, see @ref{Packages,,,emacs,}. Then, add one of the
archives to @samp{package-archives}:
@itemize @itemize
@item @item
@@ -213,6 +249,13 @@ To use Melpa-Stable:
'("melpa-stable" . "http://stable.melpa.org/packages/") t) '("melpa-stable" . "http://stable.melpa.org/packages/") t)
@end lisp @end lisp
Org-roam also depends on a recent version of Org, which can be obtained in Org's
package repository (see @ref{Installation,,,org,}). To use Org's ELPA archive:
@lisp
(add-to-list 'package-archives '("org" . "https://orgmode.org/elpa/") t)
@end lisp
Once you have added your preferred archive, you need to update the Once you have added your preferred archive, you need to update the
local package list using: local package list using: