awesome-emacs/org-roam
1
0
Fork 0
mirror of https://github.com/org-roam/org-roam synced 2025-09-14 15:46:48 -05:00
Code Issues Packages Projects Releases Wiki Activity

Deploying to gh-pages from @ f390593cfb 🚀

Browse Source
This commit is contained in:
jethrokuan
2020-05-15 08:11:19 +00:00
parent 85bd6964c2
commit c45173fb30
20 changed files with 595 additions and 87 deletions
Download Patch File Download Diff File Expand all files Collapse all files

8
manual/Anatomy-of-an-Org_002droam-File.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#SEC_Contents" rel="contents" title="Table of Contents">
<link href="index.html#Top" rel="up" title="Top">
<link href="File-Aliases.html#File-Aliases" rel="next" title="File Aliases">
<link href="Titles.html#Titles" rel="next" title="Titles">
<link href="Getting-Started.html#Getting-Started" rel="prev" title="Getting Started">
<style type="text/css">
<!--
@@ -74,9 +74,11 @@ several Org-roam-specific keywords. These functionality are not crucial
to effective use of Org-roam.
</p>
<table class="menu" border="0" cellspacing="0">
<tr><td align="left" valign="top">&bull; <a href="File-Aliases.html#File-Aliases" accesskey="1">File Aliases</a>:</td><td>&nbsp;&nbsp;</td><td align="left" valign="top">
<tr><td align="left" valign="top">&bull; <a href="Titles.html#Titles" accesskey="1">Titles</a>:</td><td>&nbsp;&nbsp;</td><td align="left" valign="top">
</td></tr>
<tr><td align="left" valign="top">&bull; <a href="File-Refs.html#File-Refs" accesskey="2">File Refs</a>:</td><td>&nbsp;&nbsp;</td><td align="left" valign="top">
<tr><td align="left" valign="top">&bull; <a href="Tags.html#Tags" accesskey="2">Tags</a>:</td><td>&nbsp;&nbsp;</td><td align="left" valign="top">
</td></tr>
<tr><td align="left" valign="top">&bull; <a href="File-Refs.html#File-Refs" accesskey="3">File Refs</a>:</td><td>&nbsp;&nbsp;</td><td align="left" valign="top">
</td></tr>
</table>

2
manual/FAQ.html
View File

@@ -62,7 +62,7 @@ ul.no-bullet {list-style: none}
<a name="FAQ"></a>
<div class="header">
<p>
Previous: <a href="Appendix.html#Appendix" accesskey="p" rel="prev">Appendix</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="_005f-_00282_0029.html#g_t_005f-_00282_0029" accesskey="n" rel="next">_ (2)</a>, Previous: <a href="Appendix.html#Appendix" accesskey="p" rel="prev">Appendix</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="FAQ-1"></a>

6
manual/File-Refs.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="Anatomy-of-an-Org_002droam-File.html#Anatomy-of-an-Org_002droam-File" rel="up" title="Anatomy of an Org-roam File">
<link href="The-Templating-System.html#The-Templating-System" rel="next" title="The Templating System">
<link href="File-Aliases.html#File-Aliases" rel="prev" title="File Aliases">
<link href="Tags.html#Tags" rel="prev" title="Tags">
<style type="text/css">
<!--
a.summary-letter {text-decoration: none}
@@ -62,11 +62,11 @@ ul.no-bullet {list-style: none}
<a name="File-Refs"></a>
<div class="header">
<p>
Previous: <a href="File-Aliases.html#File-Aliases" accesskey="p" rel="prev">File Aliases</a>, Up: <a href="Anatomy-of-an-Org_002droam-File.html#Anatomy-of-an-Org_002droam-File" accesskey="u" rel="up">Anatomy of an Org-roam File</a> &nbsp; [<a href="index.html#SEC_Contents" title="Table of contents" rel="contents">Contents</a>]</p>
Previous: <a href="Tags.html#Tags" accesskey="p" rel="prev">Tags</a>, Up: <a href="Anatomy-of-an-Org_002droam-File.html#Anatomy-of-an-Org_002droam-File" accesskey="u" rel="up">Anatomy of an Org-roam File</a> &nbsp; [<a href="index.html#SEC_Contents" title="Table of contents" rel="contents">Contents</a>]</p>
</div>
<hr>
<a name="File-Refs-1"></a>
<h3 class="section">4.2 File Refs</h3>
<h3 class="section">4.3 File Refs</h3>
<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:

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

@@ -25,6 +25,7 @@ General Public License for more details.
<link href="index.html#Top" rel="start" title="Top">
<link href="index.html#SEC_Contents" rel="contents" title="Table of Contents">
<link href="FAQ.html#FAQ" rel="up" title="FAQ">
<link href="_005f-_00282_0029.html#g_t_005f-_00282_0029" rel="next" title="_ (2)">
<link href="FAQ.html#FAQ" rel="prev" title="FAQ">
<style type="text/css">
<!--
@@ -83,8 +84,7 @@ contain:
set of Org-roam files. Remember to run &lsquo;<samp>org-roam-db-build-cache</samp>&rsquo; from a
file within that directory, at least once.
</p>
<p>Emacs 28.0.50 (Org mode 9.4)
</p>
</body>

8
manual/Installation-_00281_0029.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="Roam-Protocol.html#Roam-Protocol" rel="up" title="Roam Protocol">
<link href="The-roam_002dfile-protocol.html#The-roam_002dfile-protocol" rel="next" title="The roam-file protocol">
<link href="Roam-Protocol.html#Roam-Protocol" rel="prev" title="Roam Protocol">
<link href="_005f-_00281_0029.html#g_t_005f-_00281_0029" rel="prev" title="_ (1)">
<style type="text/css">
<!--
a.summary-letter {text-decoration: none}
@@ -62,11 +62,11 @@ ul.no-bullet {list-style: none}
<a name="Installation-_00281_0029"></a>
<div class="header">
<p>
Next: <a href="The-roam_002dfile-protocol.html#The-roam_002dfile-protocol" accesskey="n" rel="next">The &lsquo;<samp>roam-file</samp>&rsquo; protocol</a>, Up: <a href="Roam-Protocol.html#Roam-Protocol" accesskey="u" rel="up">Roam Protocol</a> &nbsp; [<a href="index.html#SEC_Contents" title="Table of contents" rel="contents">Contents</a>]</p>
Next: <a href="The-roam_002dfile-protocol.html#The-roam_002dfile-protocol" accesskey="n" rel="next">The &lsquo;<samp>roam-file</samp>&rsquo; protocol</a>, Previous: <a href="_005f-_00281_0029.html#g_t_005f-_00281_0029" accesskey="p" rel="prev">_ (1)</a>, Up: <a href="Roam-Protocol.html#Roam-Protocol" accesskey="u" rel="up">Roam Protocol</a> &nbsp; [<a href="index.html#SEC_Contents" title="Table of contents" rel="contents">Contents</a>]</p>
</div>
<hr>
<a name="Installation-2"></a>
<h3 class="section">11.1 Installation</h3>
<h3 class="section">11.2 Installation</h3>
<p>To enable Org-roam&rsquo;s protocol extensions, you have to add the following to your init file:
</p>
@@ -187,7 +187,7 @@ the default handler instead, run:
<hr>
<div class="header">
<p>
Next: <a href="The-roam_002dfile-protocol.html#The-roam_002dfile-protocol" accesskey="n" rel="next">The &lsquo;<samp>roam-file</samp>&rsquo; protocol</a>, Up: <a href="Roam-Protocol.html#Roam-Protocol" accesskey="u" rel="up">Roam Protocol</a> &nbsp; [<a href="index.html#SEC_Contents" title="Table of contents" rel="contents">Contents</a>]</p>
Next: <a href="The-roam_002dfile-protocol.html#The-roam_002dfile-protocol" accesskey="n" rel="next">The &lsquo;<samp>roam-file</samp>&rsquo; protocol</a>, Previous: <a href="_005f-_00281_0029.html#g_t_005f-_00281_0029" accesskey="p" rel="prev">_ (1)</a>, Up: <a href="Roam-Protocol.html#Roam-Protocol" accesskey="u" rel="up">Roam Protocol</a> &nbsp; [<a href="index.html#SEC_Contents" title="Table of contents" rel="contents">Contents</a>]</p>
</div>

12
manual/Installation.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#SEC_Contents" rel="contents" title="Table of Contents">
<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="_005f.html#g_t_005f" rel="next" title="_">
<link href="Introduction.html#Introduction" rel="prev" title="Introduction">
<style type="text/css">
<!--
@@ -68,14 +68,14 @@ Next: <a href="Getting-Started.html#Getting-Started" accesskey="n" rel="next">Ge
<a name="Installation-1"></a>
<h2 class="chapter">2 Installation</h2>
<p>Org-roam can be installed using Emacs&rsquo; package manager or manually from its development repository.
</p>
<table class="menu" border="0" cellspacing="0">
<tr><td align="left" valign="top">&bull; <a href="Installing-from-MELPA.html#Installing-from-MELPA" accesskey="1">Installing from MELPA</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">
</td></tr>
<tr><td align="left" valign="top">&bull; <a href="Installing-from-the-Git-Repository.html#Installing-from-the-Git-Repository" accesskey="2">Installing from the Git Repository</a>:</td><td>&nbsp;&nbsp;</td><td align="left" valign="top">
<tr><td align="left" valign="top">&bull; <a href="Installing-from-MELPA.html#Installing-from-MELPA" accesskey="2">Installing from MELPA</a>:</td><td>&nbsp;&nbsp;</td><td align="left" valign="top">
</td></tr>
<tr><td align="left" valign="top">&bull; <a href="Post_002dInstallation-Tasks.html#Post_002dInstallation-Tasks" accesskey="3">Post-Installation Tasks</a>:</td><td>&nbsp;&nbsp;</td><td align="left" valign="top">
<tr><td align="left" valign="top">&bull; <a href="Installing-from-the-Git-Repository.html#Installing-from-the-Git-Repository" accesskey="3">Installing from the Git Repository</a>:</td><td>&nbsp;&nbsp;</td><td align="left" valign="top">
</td></tr>
<tr><td align="left" valign="top">&bull; <a href="Post_002dInstallation-Tasks.html#Post_002dInstallation-Tasks" accesskey="4">Post-Installation Tasks</a>:</td><td>&nbsp;&nbsp;</td><td align="left" valign="top">
</td></tr>
</table>

6
manual/Installing-from-MELPA.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="Installation.html#Installation" rel="up" title="Installation">
<link href="Installing-from-the-Git-Repository.html#Installing-from-the-Git-Repository" rel="next" title="Installing from the Git Repository">
<link href="Installation.html#Installation" rel="prev" title="Installation">
<link href="_005f.html#g_t_005f" rel="prev" title="_">
<style type="text/css">
<!--
a.summary-letter {text-decoration: none}
@@ -62,11 +62,11 @@ ul.no-bullet {list-style: none}
<a name="Installing-from-MELPA"></a>
<div class="header">
<p>
Next: <a href="Installing-from-the-Git-Repository.html#Installing-from-the-Git-Repository" accesskey="n" rel="next">Installing from the Git Repository</a>, Up: <a href="Installation.html#Installation" accesskey="u" rel="up">Installation</a> &nbsp; [<a href="index.html#SEC_Contents" title="Table of contents" rel="contents">Contents</a>]</p>
Next: <a href="Installing-from-the-Git-Repository.html#Installing-from-the-Git-Repository" accesskey="n" rel="next">Installing from the Git Repository</a>, Previous: <a href="_005f.html#g_t_005f" accesskey="p" rel="prev">_</a>, Up: <a href="Installation.html#Installation" accesskey="u" rel="up">Installation</a> &nbsp; [<a href="index.html#SEC_Contents" title="Table of contents" rel="contents">Contents</a>]</p>
</div>
<hr>
<a name="Installing-from-MELPA-1"></a>
<h3 class="section">2.1 Installing from MELPA</h3>
<h3 class="section">2.2 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 info:emacs#Packages. Then, add one of the archives to &lsquo;<samp>package-archives</samp>&rsquo;:
</p>

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

@@ -66,7 +66,7 @@ Next: <a href="Post_002dInstallation-Tasks.html#Post_002dInstallation-Tasks" acc
</div>
<hr>
<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">2.3 <strong>TODO</strong> Installing from the Git Repository</h3>

2
manual/Post_002dInstallation-Tasks.html
View File

@@ -66,7 +66,7 @@ Previous: <a href="Installing-from-the-Git-Repository.html#Installing-from-the-G
</div>
<hr>
<a name="TODO-Post_002dInstallation-Tasks"></a>
<h3 class="section">2.3 <strong>TODO</strong> Post-Installation Tasks</h3>
<h3 class="section">2.4 <strong>TODO</strong> Post-Installation Tasks</h3>

13
manual/Roam-Protocol.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#SEC_Contents" rel="contents" title="Table of Contents">
<link href="index.html#Top" rel="up" title="Top">
<link href="Installation-_00281_0029.html#Installation-_00281_0029" rel="next" title="Installation (1)">
<link href="_005f-_00281_0029.html#g_t_005f-_00281_0029" rel="next" title="_ (1)">
<link href="Org_002droam-Completion-System.html#Org_002droam-Completion-System" rel="prev" title="Org-roam Completion System">
<style type="text/css">
<!--
@@ -68,15 +68,14 @@ Next: <a href="Diagnosing-and-Repairing-Files.html#Diagnosing-and-Repairing-File
<a name="Roam-Protocol-1"></a>
<h2 class="chapter">11 Roam Protocol</h2>
<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.
</p>
<table class="menu" border="0" cellspacing="0">
<tr><td align="left" valign="top">&bull; <a href="Installation-_00281_0029.html#Installation-_00281_0029" accesskey="1">Installation</a>:</td><td>&nbsp;&nbsp;</td><td align="left" valign="top">
<tr><td align="left" valign="top">&bull; <a href="_005f-_00281_0029.html#g_t_005f-_00281_0029" accesskey="1">_</a>:</td><td>&nbsp;&nbsp;</td><td align="left" valign="top">
</td></tr>
<tr><td align="left" valign="top">&bull; <a href="The-roam_002dfile-protocol.html#The-roam_002dfile-protocol" accesskey="2">The &lsquo;<samp>roam-file</samp>&rsquo; protocol</a>:</td><td>&nbsp;&nbsp;</td><td align="left" valign="top">
<tr><td align="left" valign="top">&bull; <a href="Installation-_00281_0029.html#Installation-_00281_0029" accesskey="2">Installation</a>:</td><td>&nbsp;&nbsp;</td><td align="left" valign="top">
</td></tr>
<tr><td align="left" valign="top">&bull; <a href="The-roam_002dref-Protocol.html#The-roam_002dref-Protocol" accesskey="3">The &lsquo;<samp>roam-ref</samp>&rsquo; Protocol</a>:</td><td>&nbsp;&nbsp;</td><td align="left" valign="top">
<tr><td align="left" valign="top">&bull; <a href="The-roam_002dfile-protocol.html#The-roam_002dfile-protocol" accesskey="3">The &lsquo;<samp>roam-file</samp>&rsquo; protocol</a>:</td><td>&nbsp;&nbsp;</td><td align="left" valign="top">
</td></tr>
<tr><td align="left" valign="top">&bull; <a href="The-roam_002dref-Protocol.html#The-roam_002dref-Protocol" accesskey="4">The &lsquo;<samp>roam-ref</samp>&rsquo; Protocol</a>:</td><td>&nbsp;&nbsp;</td><td align="left" valign="top">
</td></tr>
</table>

105
manual/Tags.html Normal file
View File

@@ -0,0 +1,105 @@
<!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>Tags (Org-roam User Manual)</title>
<meta name="description" content="Tags (Org-roam User Manual)">
<meta name="keywords" content="Tags (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="Anatomy-of-an-Org_002droam-File.html#Anatomy-of-an-Org_002droam-File" rel="up" title="Anatomy of an Org-roam File">
<link href="File-Refs.html#File-Refs" rel="next" title="File Refs">
<link href="Titles.html#Titles" rel="prev" title="Titles">
<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">
<a name="Tags"></a>
<div class="header">
<p>
Next: <a href="File-Refs.html#File-Refs" accesskey="n" rel="next">File Refs</a>, Previous: <a href="Titles.html#Titles" accesskey="p" rel="prev">Titles</a>, Up: <a href="Anatomy-of-an-Org_002droam-File.html#Anatomy-of-an-Org_002droam-File" accesskey="u" rel="up">Anatomy of an Org-roam File</a> &nbsp; [<a href="index.html#SEC_Contents" title="Table of contents" rel="contents">Contents</a>]</p>
</div>
<hr>
<a name="Tags-1"></a>
<h3 class="section">4.2 Tags</h3>
<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
notes: differentiating between bibliographical and structure notes during interactive commands.
</p>
<p>Org-roam calls &lsquo;<samp>org-roam--extract-tags</samp>&rsquo; to extract tags from files. It uses the
variable &lsquo;<samp>org-roam-tag-sources</samp>&rsquo;, to control how tags are extracted. The tag
extraction methods supported are:
</p>
<ol>
<li> &lsquo;<samp>'prop</samp>&rsquo;: This extracts tags from the &lsquo;<samp>#+ROAM_TAGS</samp>&rsquo; property. Tags are space delimited, and can be multi-word using double quotes.
</li><li> &lsquo;<samp>'all-directories</samp>&rsquo;: All sub-directories relative to &lsquo;<samp>org-roam-directory</samp>&rsquo; are
extracted as tags. That is, if a file is located at relative path
&lsquo;<samp>foo/bar/file.org</samp>&rsquo;, the file will have tags &lsquo;<samp>foo</samp>&rsquo; and &lsquo;<samp>bar</samp>&rsquo;.
</li><li> &lsquo;<samp>'last-directory</samp>&rsquo;: Extracts the last directory relative to
&lsquo;<samp>org-roam-directory</samp>&rsquo; as the tag. That is, if a file is located at relative
path &lsquo;<samp>foo/bar/file.org</samp>&rsquo;, the file will have tag &lsquo;<samp>bar</samp>&rsquo;.
</li></ol>
<p>By default, only the &lsquo;<samp>'prop</samp>&rsquo; extraction method is enabled. To enable the other
extraction methods, you may modify &lsquo;<samp>org-roam-tag-sources</samp>&rsquo;:
</p>
<div class="lisp">
<pre class="lisp">(setq org-roam-tag-sources '(prop last-directory))
</pre></div>
<p>If you wish to add your own tag extraction method, you may push a symbol &lsquo;<samp>'foo</samp>&rsquo;
into &lsquo;<samp>org-roam-tag-sources</samp>&rsquo;, and define a &lsquo;<samp>org-roam--extract-tags-foo</samp>&rsquo; which
accepts the absolute file path as its argument. See
&lsquo;<samp>org-roam--extract-tags-prop</samp>&rsquo; for an example.
</p>
</body>
</html>

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

@@ -66,7 +66,7 @@ Next: <a href="The-roam_002dref-Protocol.html#The-roam_002dref-Protocol" accessk
</div>
<hr>
<a name="The-roam_002dfile-protocol-1"></a>
<h3 class="section">11.2 The &lsquo;<samp>roam-file</samp>&rsquo; protocol</h3>
<h3 class="section">11.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;
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

@@ -66,7 +66,7 @@ Previous: <a href="The-roam_002dfile-protocol.html#The-roam_002dfile-protocol" a
</div>
<hr>
<a name="The-roam_002dref-Protocol-1"></a>
<h3 class="section">11.3 The &lsquo;<samp>roam-ref</samp>&rsquo; Protocol</h3>
<h3 class="section">11.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>

118
manual/Titles.html Normal file
View File

@@ -0,0 +1,118 @@
<!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>Titles (Org-roam User Manual)</title>
<meta name="description" content="Titles (Org-roam User Manual)">
<meta name="keywords" content="Titles (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="Anatomy-of-an-Org_002droam-File.html#Anatomy-of-an-Org_002droam-File" rel="up" title="Anatomy of an Org-roam File">
<link href="Tags.html#Tags" rel="next" title="Tags">
<link href="Anatomy-of-an-Org_002droam-File.html#Anatomy-of-an-Org_002droam-File" rel="prev" title="Anatomy of an Org-roam File">
<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">
<a name="Titles"></a>
<div class="header">
<p>
Next: <a href="Tags.html#Tags" accesskey="n" rel="next">Tags</a>, Up: <a href="Anatomy-of-an-Org_002droam-File.html#Anatomy-of-an-Org_002droam-File" accesskey="u" rel="up">Anatomy of an Org-roam File</a> &nbsp; [<a href="index.html#SEC_Contents" title="Table of contents" rel="contents">Contents</a>]</p>
</div>
<hr>
<a name="Titles-1"></a>
<h3 class="section">4.1 Titles</h3>
<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
especially useful for topics or concepts with acronyms. For example, for a note
like &ldquo;World War 2&rdquo;, it may be desirable to also refer to it using the acronym
&ldquo;WWII&rdquo;.
</p>
<p>Org-roam calls &lsquo;<samp>org-roam--extract-titles</samp>&rsquo; to extract titles. It uses the
variable &lsquo;<samp>org-roam-title-sources</samp>&rsquo;, to control how the titles are extracted. The
title extraction methods supported are:
</p>
<ol>
<li> &lsquo;<samp>'title</samp>&rsquo;: This extracts the title using the file &lsquo;<samp>#+TITLE</samp>&rsquo; property
</li><li> &lsquo;<samp>'headline</samp>&rsquo;: This extracts the title from the first headline in the Org file
</li><li> &lsquo;<samp>'alias</samp>&rsquo;: This extracts a list of titles using the &lsquo;<samp>#ROAM_ALIAS</samp>&rsquo; property.
The aliases are space-delimited, and can be multi-worded using quotes
</li></ol>
<p>Take for example the following org file:
</p>
<div class="example">
<pre class="example">#+TITLE: World War 2
#+ROAM_ALIAS: &quot;WWII&quot; &quot;World War II&quot;
* Headline
</pre></div>
<table>
<thead><tr><th>Method</th><th>Titles</th></tr></thead>
<tr><td>&lsquo;<samp>'title</samp>&rsquo;</td><td>&rsquo;(&ldquo;World War 2&rdquo;)</td></tr>
<tr><td>&lsquo;<samp>'headline</samp>&rsquo;</td><td>&rsquo;(&ldquo;Headline&rdquo;)</td></tr>
<tr><td>&lsquo;<samp>'alias</samp>&rsquo;</td><td>&rsquo;(&ldquo;WWII&rdquo; &ldquo;World War II&rdquo;)</td></tr>
</table>
<p>One can freely control which extraction methods to use by customizing
&lsquo;<samp>org-roam-title-sources</samp>&rsquo;: see the doc-string for the variable for more
information. If all methods of title extraction return no results, the file-name
is used in place of the titles for completions.
</p>
<p>If you wish to add your own title extraction method, you may push a symbol
&lsquo;<samp>'foo</samp>&rsquo; into &lsquo;<samp>org-roam-title-sources</samp>&rsquo;, and define a
&lsquo;<samp>org-roam--extract-titles-foo</samp>&rsquo; which accepts no arguments. See
&lsquo;<samp>org-roam--extract-titles-title</samp>&rsquo; for an example.
</p>
</body>
</html>

30
manual/File-Aliases.html → manual/_005f-_00281_0029.html
View File

@@ -15,18 +15,18 @@ 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>File Aliases (Org-roam User Manual)</title>
<title>_ (1) (Org-roam User Manual)</title>
<meta name="description" content="File Aliases (Org-roam User Manual)">
<meta name="keywords" content="File Aliases (Org-roam User Manual)">
<meta name="description" content="_ (1) (Org-roam User Manual)">
<meta name="keywords" content="_ (1) (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="Anatomy-of-an-Org_002droam-File.html#Anatomy-of-an-Org_002droam-File" rel="up" title="Anatomy of an Org-roam File">
<link href="File-Refs.html#File-Refs" rel="next" title="File Refs">
<link href="Anatomy-of-an-Org_002droam-File.html#Anatomy-of-an-Org_002droam-File" rel="prev" title="Anatomy of an Org-roam File">
<link href="Roam-Protocol.html#Roam-Protocol" rel="up" title="Roam Protocol">
<link href="Installation-_00281_0029.html#Installation-_00281_0029" rel="next" title="Installation (1)">
<link href="Roam-Protocol.html#Roam-Protocol" rel="prev" title="Roam Protocol">
<style type="text/css">
<!--
a.summary-letter {text-decoration: none}
@@ -59,24 +59,18 @@ ul.no-bullet {list-style: none}
</head>
<body lang="en">
<a name="File-Aliases"></a>
<a name="g_t_005f-_00281_0029"></a>
<div class="header">
<p>
Next: <a href="File-Refs.html#File-Refs" accesskey="n" rel="next">File Refs</a>, Up: <a href="Anatomy-of-an-Org_002droam-File.html#Anatomy-of-an-Org_002droam-File" accesskey="u" rel="up">Anatomy of an Org-roam File</a> &nbsp; [<a href="index.html#SEC_Contents" title="Table of contents" rel="contents">Contents</a>]</p>
Next: <a href="Installation-_00281_0029.html#Installation-_00281_0029" accesskey="n" rel="next">Installation (1)</a>, Up: <a href="Roam-Protocol.html#Roam-Protocol" accesskey="u" rel="up">Roam Protocol</a> &nbsp; [<a href="index.html#SEC_Contents" title="Table of contents" rel="contents">Contents</a>]</p>
</div>
<hr>
<a name="File-Aliases-1"></a>
<h3 class="section">4.1 File Aliases</h3>
<a name="g_t_005f-_003aignore_003a-1"></a>
<h3 class="section">11.1 _ :ignore:</h3>
<p>Suppose you want a note to be referred to by different names (e.g.
&ldquo;World War 2&rdquo;, &ldquo;WWII&rdquo;). You may specify such aliases using the
&lsquo;<samp>#+ROAM_ALIAS</samp>&rsquo; attribute:
<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.
</p>
<div class="example">
<pre class="example">#+TITLE: World War 2
#+ROAM_ALIAS: &quot;WWII&quot; &quot;World War II&quot;
</pre></div>

75
manual/_005f-_00282_0029.html Normal file
View File

@@ -0,0 +1,75 @@
<!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>_ (2) (Org-roam User Manual)</title>
<meta name="description" content="_ (2) (Org-roam User Manual)">
<meta name="keywords" content="_ (2) (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="How-do-I-have-more-than-one-Org_002droam-directory_003f.html#How-do-I-have-more-than-one-Org_002droam-directory_003f" rel="prev" title="How do I have more than one Org-roam directory?">
<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">
<a name="g_t_005f-_00282_0029"></a>
<div class="header">
<p>
Previous: <a href="FAQ.html#FAQ" accesskey="p" rel="prev">FAQ</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="g_t_005f-_003aignore_003a-2"></a>
<h2 class="chapter">15 _ :ignore:</h2>
<p>Emacs 28.0.50 (Org mode 9.4)
</p>
</body>
</html>

77
manual/_005f.html Normal file
View File

@@ -0,0 +1,77 @@
<!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>_ (Org-roam User Manual)</title>
<meta name="description" content="_ (Org-roam User Manual)">
<meta name="keywords" content="_ (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="Installation.html#Installation" rel="up" title="Installation">
<link href="Installing-from-MELPA.html#Installing-from-MELPA" rel="next" title="Installing from MELPA">
<link href="Installation.html#Installation" rel="prev" title="Installation">
<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">
<a name="g_t_005f"></a>
<div class="header">
<p>
Next: <a href="Installing-from-MELPA.html#Installing-from-MELPA" accesskey="n" rel="next">Installing from MELPA</a>, Up: <a href="Installation.html#Installation" accesskey="u" rel="up">Installation</a> &nbsp; [<a href="index.html#SEC_Contents" title="Table of contents" rel="contents">Contents</a>]</p>
</div>
<hr>
<a name="g_t_005f-_003aignore_003a"></a>
<h3 class="section">2.1 _ :ignore:</h3>
<p>Org-roam can be installed using Emacs&rsquo; package manager or manually from its development repository.
</p>
</body>
</html>

41
manual/index.html
View File

@@ -72,15 +72,17 @@ ul.no-bullet {list-style: none}
<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>
<li><a name="toc-_005f-_003aignore_003a" href="_005f.html#g_t_005f">2.1 _ :ignore:</a></li>
<li><a name="toc-Installing-from-MELPA-1" href="Installing-from-MELPA.html#Installing-from-MELPA">2.2 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.3 <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.4 <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>
<li><a name="toc-Titles-1" href="Titles.html#Titles">4.1 Titles</a></li>
<li><a name="toc-Tags-1" href="Tags.html#Tags">4.2 Tags</a></li>
<li><a name="toc-File-Refs-1" href="File-Refs.html#File-Refs">4.3 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">
@@ -107,9 +109,10 @@ ul.no-bullet {list-style: none}
<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 &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.3 The &lsquo;<samp>roam-ref</samp>&rsquo; Protocol</a></li>
<li><a name="toc-_005f-_003aignore_003a-1" href="_005f-_00281_0029.html#g_t_005f-_00281_0029">11.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-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_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>
</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>
@@ -133,6 +136,7 @@ ul.no-bullet {list-style: none}
<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>
<li><a name="toc-_005f-_003aignore_003a-2" href="_005f-_00282_0029.html#g_t_005f-_00282_0029">15 _ :ignore:</a></li>
</ul>
</div>
@@ -152,10 +156,9 @@ Next: <a href="Introduction.html#Introduction" accesskey="n" rel="next">Introduc
<blockquote>
<p>Copyright (C) 2020-2020 Jethro Kuan &lt;jethrokuan95@gmail.com&gt;
</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>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
@@ -193,13 +196,17 @@ General Public License for more details.
</td></tr>
<tr><td align="left" valign="top">&bull; <a href="FAQ.html#FAQ">FAQ</a>:</td><td>&nbsp;&nbsp;</td><td align="left" valign="top">
</td></tr>
<tr><td align="left" valign="top">&bull; <a href="_005f-_00282_0029.html#g_t_005f-_00282_0029">_</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;
Installation
</pre></th></tr><tr><td align="left" valign="top">&bull; <a href="Installing-from-MELPA.html#Installing-from-MELPA">Installing from MELPA</a>:</td><td>&nbsp;&nbsp;</td><td align="left" valign="top">
</pre></th></tr><tr><td align="left" valign="top">&bull; <a href="_005f.html#g_t_005f">_</a>:</td><td>&nbsp;&nbsp;</td><td align="left" valign="top">
</td></tr>
<tr><td align="left" valign="top">&bull; <a href="Installing-from-MELPA.html#Installing-from-MELPA">Installing from MELPA</a>:</td><td>&nbsp;&nbsp;</td><td align="left" valign="top">
</td></tr>
<tr><td align="left" valign="top">&bull; <a href="Installing-from-the-Git-Repository.html#Installing-from-the-Git-Repository">Installing from the Git Repository</a>:</td><td>&nbsp;&nbsp;</td><td align="left" valign="top">
</td></tr>
@@ -209,7 +216,9 @@ Installation
Anatomy of an Org-roam File
</pre></th></tr><tr><td align="left" valign="top">&bull; <a href="File-Aliases.html#File-Aliases">File Aliases</a>:</td><td>&nbsp;&nbsp;</td><td align="left" valign="top">
</pre></th></tr><tr><td align="left" valign="top">&bull; <a href="Titles.html#Titles">Titles</a>:</td><td>&nbsp;&nbsp;</td><td align="left" valign="top">
</td></tr>
<tr><td align="left" valign="top">&bull; <a href="Tags.html#Tags">Tags</a>:</td><td>&nbsp;&nbsp;</td><td align="left" valign="top">
</td></tr>
<tr><td align="left" valign="top">&bull; <a href="File-Refs.html#File-Refs">File Refs</a>:</td><td>&nbsp;&nbsp;</td><td align="left" valign="top">
</td></tr>
@@ -251,7 +260,9 @@ Graphing
Roam Protocol
</pre></th></tr><tr><td align="left" valign="top">&bull; <a href="Installation-_00281_0029.html#Installation-_00281_0029">Installation</a>:</td><td>&nbsp;&nbsp;</td><td align="left" valign="top">
</pre></th></tr><tr><td align="left" valign="top">&bull; <a href="_005f-_00281_0029.html#g_t_005f-_00281_0029">_</a>:</td><td>&nbsp;&nbsp;</td><td align="left" valign="top">
</td></tr>
<tr><td align="left" valign="top">&bull; <a href="Installation-_00281_0029.html#Installation-_00281_0029">Installation</a>:</td><td>&nbsp;&nbsp;</td><td align="left" valign="top">
</td></tr>
<tr><td align="left" valign="top">&bull; <a href="The-roam_002dfile-protocol.html#The-roam_002dfile-protocol">The &lsquo;<samp>roam-file</samp>&rsquo; protocol</a>:</td><td>&nbsp;&nbsp;</td><td align="left" valign="top">
</td></tr>

45
org-roam.org
View File

@@ -19,10 +19,9 @@ This manual is for Org-roam version 1.1.1.
#+BEGIN_QUOTE
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.
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
@@ -174,7 +173,7 @@ Org-mode. However, to support additional functionality, Org-roam adds
several Org-roam-specific keywords. These functionality are not crucial
to effective use of Org-roam.
** File Titles
** Titles
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
@@ -211,6 +210,41 @@ One can freely control which extraction methods to use by customizing
information. If all methods of title extraction return no results, the file-name
is used in place of the titles for completions.
If you wish to add your own title extraction method, you may push a symbol
='foo= into =org-roam-title-sources=, and define a
=org-roam--extract-titles-foo= which accepts no arguments. See
=org-roam--extract-titles-title= for an example.
** Tags
Tags are used as meta-data for files: they facilitate interactions with notes
where titles are insufficient. For example, tags allow for categorization of
notes: differentiating between bibliographical and structure notes during interactive commands.
Org-roam calls =org-roam--extract-tags= to extract tags from files. It uses the
variable =org-roam-tag-sources=, to control how tags are extracted. The tag
extraction methods supported are:
1. ='prop=: This extracts tags from the =#+ROAM_TAGS= property. Tags are space delimited, and can be multi-word using double quotes.
2. ='all-directories=: All sub-directories relative to =org-roam-directory= are
extracted as tags. That is, if a file is located at relative path
=foo/bar/file.org=, the file will have tags =foo= and =bar=.
3. ='last-directory=: Extracts the last directory relative to
=org-roam-directory= as the tag. That is, if a file is located at relative
path =foo/bar/file.org=, the file will have tag =bar=.
By default, only the ='prop= extraction method is enabled. To enable the other
extraction methods, you may modify =org-roam-tag-sources=:
#+BEGIN_SRC emacs-lisp
(setq org-roam-tag-sources '(prop last-directory))
#+END_SRC
If you wish to add your own tag extraction method, you may push a symbol ='foo=
into =org-roam-tag-sources=, and define a =org-roam--extract-tags-foo= which
accepts the absolute file path as its argument. See
=org-roam--extract-tags-prop= for an example.
** File Refs
Refs are unique identifiers for files. Each note can only have 1 ref.
@@ -932,6 +966,7 @@ file within that directory, at least once.
* _ :ignore:
# Local Variables:
# eval: (refill-mode +1)
# before-save-hook: org-make-toc
# after-save-hook: (lambda nil (progn (require 'ox-texinfo nil t) (org-texinfo-export-to-info)))
# indent-tabs-mode: nil

124
org-roam.texi
View File

@@ -51,10 +51,9 @@ This manual is for Org-roam version 1.1.1.
@quotation
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.
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
@@ -79,19 +78,22 @@ General Public License for more details.
* Diagnosing and Repairing Files::
* Appendix::
* FAQ::
* _: _ (2).
@detailmenu
--- The Detailed Node Listing ---
Installation
* _::
* Installing from MELPA::
* Installing from the Git Repository::
* Post-Installation Tasks::
Anatomy of an Org-roam File
* File Aliases::
* Titles::
* Tags::
* File Refs::
The Templating System
@@ -117,6 +119,7 @@ Graphing
Roam Protocol
* _: _ (1).
* Installation: Installation (1).
* The @samp{roam-file} protocol::
* The @samp{roam-ref} Protocol::
@@ -176,14 +179,18 @@ Emacs is also a fantastic interface for editing text, and we can inherit many of
@node Installation
@chapter Installation
Org-roam can be installed using Emacs' package manager or manually from its development repository.
@menu
* _::
* Installing from MELPA::
* Installing from the Git Repository::
* Post-Installation Tasks::
@end menu
@node _
@section _ :ignore:
Org-roam can be installed using Emacs' package manager or manually from its development repository.
@node Installing from MELPA
@section Installing from MELPA
@@ -310,22 +317,100 @@ several Org-roam-specific keywords. These functionality are not crucial
to effective use of Org-roam.
@menu
* File Aliases::
* Titles::
* Tags::
* File Refs::
@end menu
@node File Aliases
@section File Aliases
@node Titles
@section Titles
Suppose you want a note to be referred to by different names (e.g.
``World War 2'', ``WWII''). You may specify such aliases using the
@samp{#+ROAM_ALIAS} attribute:
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
especially useful for topics or concepts with acronyms. For example, for a note
like ``World War 2'', it may be desirable to also refer to it using the acronym
``WWII''.
Org-roam calls @samp{org-roam--extract-titles} to extract titles. It uses the
variable @samp{org-roam-title-sources}, to control how the titles are extracted. The
title extraction methods supported are:
@enumerate
@item
@samp{'title}: This extracts the title using the file @samp{#+TITLE} property
@item
@samp{'headline}: This extracts the title from the first headline in the Org file
@item
@samp{'alias}: This extracts a list of titles using the @samp{#ROAM_ALIAS} property.
The aliases are space-delimited, and can be multi-worded using quotes
@end enumerate
Take for example the following org file:
@example
#+TITLE: World War 2
#+ROAM_ALIAS: "WWII" "World War II"
* Headline
@end example
@multitable {aaaaaaaaaaa} {aaaaaaaaaaaaaaaaaaaaaaaa}
@headitem Method
@tab Titles
@item @samp{'title}
@tab '(``World War 2'')
@item @samp{'headline}
@tab '(``Headline'')
@item @samp{'alias}
@tab '(``WWII'' ``World War II'')
@end multitable
One can freely control which extraction methods to use by customizing
@samp{org-roam-title-sources}: see the doc-string for the variable for more
information. If all methods of title extraction return no results, the file-name
is used in place of the titles for completions.
If you wish to add your own title extraction method, you may push a symbol
@samp{'foo} into @samp{org-roam-title-sources}, and define a
@samp{org-roam--extract-titles-foo} which accepts no arguments. See
@samp{org-roam--extract-titles-title} for an example.
@node Tags
@section Tags
Tags are used as meta-data for files: they facilitate interactions with notes
where titles are insufficient. For example, tags allow for categorization of
notes: differentiating between bibliographical and structure notes during interactive commands.
Org-roam calls @samp{org-roam--extract-tags} to extract tags from files. It uses the
variable @samp{org-roam-tag-sources}, to control how tags are extracted. The tag
extraction methods supported are:
@enumerate
@item
@samp{'prop}: This extracts tags from the @samp{#+ROAM_TAGS} property. Tags are space delimited, and can be multi-word using double quotes.
@item
@samp{'all-directories}: All sub-directories relative to @samp{org-roam-directory} are
extracted as tags. That is, if a file is located at relative path
@samp{foo/bar/file.org}, the file will have tags @samp{foo} and @samp{bar}.
@item
@samp{'last-directory}: Extracts the last directory relative to
@samp{org-roam-directory} as the tag. That is, if a file is located at relative
path @samp{foo/bar/file.org}, the file will have tag @samp{bar}.
@end enumerate
By default, only the @samp{'prop} extraction method is enabled. To enable the other
extraction methods, you may modify @samp{org-roam-tag-sources}:
@lisp
(setq org-roam-tag-sources '(prop last-directory))
@end lisp
If you wish to add your own tag extraction method, you may push a symbol @samp{'foo}
into @samp{org-roam-tag-sources}, and define a @samp{org-roam--extract-tags-foo} which
accepts the absolute file path as its argument. See
@samp{org-roam--extract-tags-prop} for an example.
@node File Refs
@section File Refs
@@ -754,15 +839,19 @@ Other options include @samp{'ido}, and @samp{'ivy}.
@node Roam Protocol
@chapter Roam Protocol
Org-roam extending @samp{org-protocol} with 2 protocols: the @samp{roam-file}
and @samp{roam-ref} protocol.
@menu
* _: _ (1).
* Installation: Installation (1).
* The @samp{roam-file} protocol::
* The @samp{roam-ref} Protocol::
@end menu
@node _ (1)
@section _ :ignore:
Org-roam extending @samp{org-protocol} with 2 protocols: the @samp{roam-file}
and @samp{roam-ref} protocol.
@node Installation (1)
@section Installation
@@ -1191,5 +1280,8 @@ All files within that directory will be treated as their own separate
set of Org-roam files. Remember to run @samp{org-roam-db-build-cache} from a
file within that directory, at least once.
@node _ (2)
@chapter _ :ignore:
Emacs 28.0.50 (Org mode 9.4)
@bye