awesome-emacs/org-roam
1
0
Fork 0
mirror of https://github.com/org-roam/org-roam synced 2025-08-19 13:43:31 -05:00
Code Issues Packages Projects Releases Wiki Activity

Deploying to gh-pages from @ 4f6eb285bf 🚀

Browse Source
This commit is contained in:
zaeph
2020-11-10 13:32:22 +00:00
parent c86f58190d
commit 59d12f1864
14 changed files with 699 additions and 53 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
manual/A-Brief-Introduction-to-the-Zettelkasten-Method.html
View File

@@ -102,7 +102,7 @@ links.
<strong>fleeting notes</strong>: they are simple reminders of information or ideas that will
need to be processed later on, or trashed. This is typically accomplished using
<code>org-capture</code> (see <a href="http://www.gnu.org/software/emacs/manual/html_node/org/capture.html#capture">(org)capture</a>), or using Org-roam&rsquo;s daily notes
functionality (see <a href="Daily-Notes.html#Daily-Notes">Daily Notes</a>). This provides a central inbox for collecting
functionality (see <a href="Daily_002dnotes.html#Daily_002dnotes">Daily-notes</a>). This provides a central inbox for collecting
thoughts, to be processed later into permanent notes.
</p>
<p>Permanent notes are further split into two categories: <strong>literature notes</strong> and

121
manual/Capturing-and-finding-daily_002dnotes.html Normal file
View File

@@ -0,0 +1,121 @@
<!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>Capturing and finding daily-notes (Org-roam User Manual)</title>
<meta name="description" content="Capturing and finding daily-notes (Org-roam User Manual)">
<meta name="keywords" content="Capturing and finding daily-notes (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="Daily_002dnotes.html#Daily_002dnotes" rel="up" title="Daily-notes">
<link href="Navigation.html#Navigation" rel="next" title="Navigation">
<link href="Configuration.html#Configuration" rel="prev" title="Configuration">
<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="Capturing-and-finding-daily_002dnotes"></a>
<div class="header">
<p>
Next: <a href="Navigation.html#Navigation" accesskey="n" rel="next">Navigation</a>, Previous: <a href="Configuration.html#Configuration" accesskey="p" rel="prev">Configuration</a>, Up: <a href="Daily_002dnotes.html#Daily_002dnotes" accesskey="u" rel="up">Daily-notes</a> &nbsp; [<a href="index.html#SEC_Contents" title="Table of contents" rel="contents">Contents</a>]</p>
</div>
<hr>
<a name="Capturing-and-finding-daily_002dnotes-1"></a>
<h3 class="section">15.2 Capturing and finding daily-notes</h3>
<ul>
<li> Function: <code>org-roam-dailies-capture-today</code> &amp;optional goto
<p>Create an entry in the daily note for today.
</p>
<p>When <code>goto</code> is non-nil, go the note without creating an entry.
</p>
</li><li> Function: <code>org-roam-dailies-find-today</code>
<p>Find the daily note for today, creating it if necessary.
</p></li></ul>
<p>There are variants of those commands for <code>-yesterday</code> and <code>-tomorrow</code>:
</p>
<ul>
<li> Function: <code>org-roam-dailies-capture-yesterday</code> n &amp;optional goto
<p>Create an entry in the daily note for yesteday.
</p>
<p>With numeric argument <code>n</code>, use the daily note <code>n</code> days in the past.
</p>
</li><li> Function: <code>org-roam-dailies-find-yesterday</code>
<p>With numeric argument N, use the daily-note N days in the future.
</p></li></ul>
<p>There are also commands which allow you to use Emacs’s <code>calendar</code> to find the date
</p>
<ul>
<li> Function: <code>org-roam-dailies-capture-date</code>
<p>Create an entry in the daily note for a date using the calendar.
</p>
<p>Prefer past dates, unless <code>prefer-future</code> is non-nil.
</p>
<p>With a &rsquo;C-u&rsquo; prefix or when <code>goto</code> is non-nil, go the note without
creating an entry.
</p>
</li><li> Function: <code>org-roam-dailies-find-date</code>
<p>Find the daily note for a date using the calendar, creating it if necessary.
</p>
<p>Prefer past dates, unless <code>prefer-future</code> is non-nil.
</p></li></ul>
</body>
</html>

131
manual/Configuration.html Normal file
View File

@@ -0,0 +1,131 @@
<!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>Configuration (Org-roam User Manual)</title>
<meta name="description" content="Configuration (Org-roam User Manual)">
<meta name="keywords" content="Configuration (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="Daily_002dnotes.html#Daily_002dnotes" rel="up" title="Daily-notes">
<link href="Capturing-and-finding-daily_002dnotes.html#Capturing-and-finding-daily_002dnotes" rel="next" title="Capturing and finding daily-notes">
<link href="Daily_002dnotes.html#Daily_002dnotes" rel="prev" title="Daily-notes">
<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="Configuration"></a>
<div class="header">
<p>
Next: <a href="Capturing-and-finding-daily_002dnotes.html#Capturing-and-finding-daily_002dnotes" accesskey="n" rel="next">Capturing and finding daily-notes</a>, Up: <a href="Daily_002dnotes.html#Daily_002dnotes" accesskey="u" rel="up">Daily-notes</a> &nbsp; [<a href="index.html#SEC_Contents" title="Table of contents" rel="contents">Contents</a>]</p>
</div>
<hr>
<a name="Configuration-1"></a>
<h3 class="section">15.1 Configuration</h3>
<p>For <code>org-roam-dailies</code> to work, you need to define two variables:
</p>
<ul>
<li> Variable: <code>org-roam-dailies-directory</code>
<p>Path to daily-notes.
</p>
</li><li> Variable: <code>org-roam-dailies-capture-templates</code>
<p>Capture templates for daily-notes in Org-roam.
</p></li></ul>
<p>Here is a sane default configuration:
</p>
<div class="lisp">
<pre class="lisp">(setq org-roam-dailies-directory &quot;daily/&quot;)
(setq org-roam-dailies-capture-templates
'((&quot;d&quot; &quot;default&quot; entry
#'org-roam-capture--get-point
&quot;* %?&quot;
:file-name &quot;daily/%&lt;%Y-%m-%d&gt;&quot;
:head &quot;#+title: %&lt;%Y-%m-%d&gt;\n\n&quot;)))
</pre></div>
<p>Make sure that <code>org-roam-dailies-directory</code> appears in <code>:file-name</code> for your
notes to be recognized as daily-notes. You can have different templates
placing their notes in different directories, but the one in
<code>org-roam-dailies-directory</code> will be considered as the main one in commands.
</p>
<p>See <a href="The-Templating-System.html#The-Templating-System">The Templating System</a> for creating new
templates. <code>org-roam-dailies</code> provides an extra <code>:olp</code> option which allows
specifying the outline-path to a heading:
</p>
<div class="lisp">
<pre class="lisp">(setq org-roam-dailies-capture-templates
'((&quot;l&quot; &quot;lab&quot; entry
#'org-roam-capture--get-point
&quot;* %?&quot;
:file-name &quot;daily/%&lt;%Y-%m-%d&gt;&quot;
:head &quot;#+title: %&lt;%Y-%m-%d&gt;\n\n* Lab notes\n* Journal&quot;
:olp (&quot;Journal&quot;))
(&quot;j&quot; &quot;journal&quot; entry
#'org-roam-capture--get-point
&quot;* %?&quot;
:file-name &quot;daily/%&lt;%Y-%m-%d&gt;&quot;
:head &quot;#+title: %&lt;%Y-%m-%d&gt;\n\n* Lab notes\n* Journal&quot;
:olp (&quot;Lab notes&quot;))))
</pre></div>
<p>The template <code>l</code> will put its notes under the heading ‘Lab notes’, and the
template <code>j</code> will put its notes under the heading ‘Journal’. When you use
<code>:olp</code>, make sure that the headings are present in <code>:head</code>.
</p>
</body>
</html>

26
manual/Daily-Notes.html → manual/Daily_002dnotes.html
View File

@@ -15,17 +15,17 @@ 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>Daily Notes (Org-roam User Manual)</title>
<title>Daily-notes (Org-roam User Manual)</title>
<meta name="description" content="Daily Notes (Org-roam User Manual)">
<meta name="keywords" content="Daily Notes (Org-roam User Manual)">
<meta name="description" content="Daily-notes (Org-roam User Manual)">
<meta name="keywords" content="Daily-notes (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="Diagnosing-and-Repairing-Files.html#Diagnosing-and-Repairing-Files" rel="next" title="Diagnosing and Repairing Files">
<link href="Configuration.html#Configuration" rel="next" title="Configuration">
<link href="The-roam_002dref-protocol.html#The-roam_002dref-protocol" rel="prev" title="The roam-ref protocol">
<style type="text/css">
<!--
@@ -60,14 +60,26 @@ ul.no-bullet {list-style: none}
</head>
<body lang="en">
<a name="Daily-Notes"></a>
<a name="Daily_002dnotes"></a>
<div class="header">
<p>
Next: <a href="Diagnosing-and-Repairing-Files.html#Diagnosing-and-Repairing-Files" accesskey="n" rel="next">Diagnosing and Repairing Files</a>, Previous: <a href="Roam-Protocol.html#Roam-Protocol" accesskey="p" rel="prev">Roam Protocol</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="TODO-Daily-Notes"></a>
<h2 class="chapter">15 <strong>TODO</strong> Daily Notes</h2>
<a name="Daily_002dnotes-1"></a>
<h2 class="chapter">15 Daily-notes</h2>
<p>Org-roam provides journaling capabilities akin to
<a href="Org_002djournal.html#Org_002djournal">Org-journal</a> with <code>org-roam-dailies</code>.
</p>
<table class="menu" border="0" cellspacing="0">
<tr><td align="left" valign="top">&bull; <a href="Configuration.html#Configuration" accesskey="1">Configuration</a>:</td><td>&nbsp;&nbsp;</td><td align="left" valign="top">
</td></tr>
<tr><td align="left" valign="top">&bull; <a href="Capturing-and-finding-daily_002dnotes.html#Capturing-and-finding-daily_002dnotes" accesskey="2">Capturing and finding daily-notes</a>:</td><td>&nbsp;&nbsp;</td><td align="left" valign="top">
</td></tr>
<tr><td align="left" valign="top">&bull; <a href="Navigation.html#Navigation" accesskey="3">Navigation</a>:</td><td>&nbsp;&nbsp;</td><td align="left" valign="top">
</td></tr>
</table>

4
manual/Diagnosing-and-Repairing-Files.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#Top" rel="up" title="Top">
<link href="Finding-Unlinked-References.html#Finding-Unlinked-References" rel="next" title="Finding Unlinked References">
<link href="Daily-Notes.html#Daily-Notes" rel="prev" title="Daily Notes">
<link href="Navigation.html#Navigation" rel="prev" title="Navigation">
<style type="text/css">
<!--
a.summary-letter {text-decoration: none}
@@ -63,7 +63,7 @@ ul.no-bullet {list-style: none}
<a name="Diagnosing-and-Repairing-Files"></a>
<div class="header">
<p>
Next: <a href="Finding-Unlinked-References.html#Finding-Unlinked-References" accesskey="n" rel="next">Finding Unlinked References</a>, Previous: <a href="Daily-Notes.html#Daily-Notes" accesskey="p" rel="prev">Daily Notes</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="Finding-Unlinked-References.html#Finding-Unlinked-References" accesskey="n" rel="next">Finding Unlinked References</a>, Previous: <a href="Daily_002dnotes.html#Daily_002dnotes" accesskey="p" rel="prev">Daily-notes</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="Diagnosing-and-Repairing-Files-1"></a>

2
manual/How-do-I-create-a-note-whose-title-already-matches-one-of-the-candidates_003f.html
View File

@@ -83,7 +83,7 @@ are the solutions:
</p></dd>
</dl>
<p>Emacs 28.0.50 (Org mode 9.4)
<p>Emacs 27.1.50 (Org mode 9.4)
</p>

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

@@ -114,7 +114,7 @@ Next: <a href="Post_002dInstallation-Tasks.html#Post_002dInstallation-Tasks" acc
<div class="lisp">
<pre class="lisp">(require 'info)
(add-to-list 'Info-default-directory-list
&quot;/path/to/my/info/files&quot;)
&quot;/path/to/my/info/files&quot;)
</pre></div>
<p>You can also use one of the default locations, such as:

92
manual/Navigation.html Normal file
View File

@@ -0,0 +1,92 @@
<!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>Navigation (Org-roam User Manual)</title>
<meta name="description" content="Navigation (Org-roam User Manual)">
<meta name="keywords" content="Navigation (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="Daily_002dnotes.html#Daily_002dnotes" rel="up" title="Daily-notes">
<link href="Diagnosing-and-Repairing-Files.html#Diagnosing-and-Repairing-Files" rel="next" title="Diagnosing and Repairing Files">
<link href="Capturing-and-finding-daily_002dnotes.html#Capturing-and-finding-daily_002dnotes" rel="prev" title="Capturing and finding daily-notes">
<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="Navigation"></a>
<div class="header">
<p>
Previous: <a href="Capturing-and-finding-daily_002dnotes.html#Capturing-and-finding-daily_002dnotes" accesskey="p" rel="prev">Capturing and finding daily-notes</a>, Up: <a href="Daily_002dnotes.html#Daily_002dnotes" accesskey="u" rel="up">Daily-notes</a> &nbsp; [<a href="index.html#SEC_Contents" title="Table of contents" rel="contents">Contents</a>]</p>
</div>
<hr>
<a name="Navigation-1"></a>
<h3 class="section">15.3 Navigation</h3>
<p>You can navigate between daily-notes:
</p>
<ul>
<li> Function: <code>org-roam-dailies-find-directory</code>
<p>Find and open <code>org-roam-dailies-directory</code>.
</p>
</li><li> Function: <code>org-roam-dailies-find-previous-note</code>
<p>When in an daily-note, find the previous one.
</p>
</li><li> Function: <code>org-roam-dailies-find-next-note</code>
<p>When in an daily-note, find the next one.
</p></li></ul>
</body>
</html>

11
manual/Org_002djournal.html
View File

@@ -69,10 +69,11 @@ Next: <a href="Note_002dtaking-Add_002dons.html#Note_002dtaking-Add_002dons" acc
<a name="Org_002djournal-1"></a>
<h4 class="subsection">19.2.4 Org-journal</h4>
<p><a href="https://github.com/bastibe/org-journal">Org-journal</a> is a more
powerful alternative to the simple function <code>org-roam-dailies-today</code>. It
provides better journaling capabilities, and a nice calendar interface
to see all dated entries.
<p><a href="https://github.com/bastibe/org-journal">Org-journal</a> provides journaling
capabilities to Org-mode. A lot of its functionalities have been incorporated
into Org-roam under the name <code>org-roam-dailies</code>. It remains a good tool if
you want to isolate your verbose journal entries from the ideas you would
write on a scratchpad.
</p>
<div class="lisp">
<pre class="lisp">(use-package org-journal
@@ -81,7 +82,7 @@ to see all dated entries.
:custom
(org-journal-date-prefix &quot;#+title: &quot;)
(org-journal-file-format &quot;%Y-%m-%d.org&quot;)
(org-journal-dir &quot;/path/to/org-roam-files/&quot;)
(org-journal-dir &quot;/path/to/journal/files/&quot;)
(org-journal-date-format &quot;%A, %d %B %Y&quot;))
</pre></div>

2
manual/Roam-Protocol.html
View File

@@ -63,7 +63,7 @@ ul.no-bullet {list-style: none}
<a name="Roam-Protocol"></a>
<div class="header">
<p>
Next: <a href="Daily-Notes.html#Daily-Notes" accesskey="n" rel="next">Daily Notes</a>, Previous: <a href="Org_002droam-Completion-System.html#Org_002droam-Completion-System" accesskey="p" rel="prev">Org-roam Completion System</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="Daily_002dnotes.html#Daily_002dnotes" accesskey="n" rel="next">Daily-notes</a>, Previous: <a href="Org_002droam-Completion-System.html#Org_002droam-Completion-System" accesskey="p" rel="prev">Org-roam Completion System</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="Roam-Protocol-1"></a>

12
manual/The-roam_002dref-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="Roam-Protocol.html#Roam-Protocol" rel="up" title="Roam Protocol">
<link href="Daily-Notes.html#Daily-Notes" rel="next" title="Daily Notes">
<link href="Daily_002dnotes.html#Daily_002dnotes" rel="next" title="Daily-notes">
<link href="The-roam_002dfile-protocol.html#The-roam_002dfile-protocol" rel="prev" title="The roam-file protocol">
<style type="text/css">
<!--
@@ -77,10 +77,12 @@ Previous: <a href="The-roam_002dfile-protocol.html#The-roam_002dfile-protocol" a
</p>
<div class="example">
<pre class="example">javascript:location.href =
'org-protocol://roam-ref?template=r&amp;ref='
+ encodeURIComponent(location.href)
+ '&amp;title='
+ encodeURIComponent(document.title)
'org-protocol://roam-ref?template=r&amp;ref='
+ encodeURIComponent(location.href)
+ '&amp;title='
+ encodeURIComponent(document.title)
+ '&amp;body='
+ encodeURIComponent(window.getSelection())
</pre></div>
<p>or as a keybinding in <code>qutebrowser</code> in , using the <code>config.py</code> file (see

19
manual/index.html
View File

@@ -118,7 +118,12 @@ ul.no-bullet {list-style: none}
<li><a name="toc-The-roam_002dfile-protocol-1" href="The-roam_002dfile-protocol.html#The-roam_002dfile-protocol">14.3 The roam-file protocol</a></li>
<li><a name="toc-The-roam_002dref-protocol-1" href="The-roam_002dref-protocol.html#The-roam_002dref-protocol">14.4 The roam-ref protocol</a></li>
</ul></li>
<li><a name="toc-TODO-Daily-Notes" href="Daily-Notes.html#Daily-Notes">15 <strong>TODO</strong> Daily Notes</a></li>
<li><a name="toc-Daily_002dnotes-1" href="Daily_002dnotes.html#Daily_002dnotes">15 Daily-notes</a>
<ul class="no-bullet">
<li><a name="toc-Configuration-1" href="Configuration.html#Configuration">15.1 Configuration</a></li>
<li><a name="toc-Capturing-and-finding-daily_002dnotes-1" href="Capturing-and-finding-daily_002dnotes.html#Capturing-and-finding-daily_002dnotes">15.2 Capturing and finding daily-notes</a></li>
<li><a name="toc-Navigation-1" href="Navigation.html#Navigation">15.3 Navigation</a></li>
</ul></li>
<li><a name="toc-Diagnosing-and-Repairing-Files-1" href="Diagnosing-and-Repairing-Files.html#Diagnosing-and-Repairing-Files">16 Diagnosing and Repairing Files</a></li>
<li><a name="toc-Finding-Unlinked-References-1" href="Finding-Unlinked-References.html#Finding-Unlinked-References">17 Finding Unlinked References</a></li>
<li><a name="toc-Performance-Optimization-1" href="Performance-Optimization.html#Performance-Optimization">18 Performance Optimization</a>
@@ -210,7 +215,7 @@ General Public License for more details.
</td></tr>
<tr><td align="left" valign="top">&bull; <a href="Roam-Protocol.html#Roam-Protocol">Roam Protocol</a>:</td><td>&nbsp;&nbsp;</td><td align="left" valign="top">
</td></tr>
<tr><td align="left" valign="top">&bull; <a href="Daily-Notes.html#Daily-Notes">Daily Notes</a>:</td><td>&nbsp;&nbsp;</td><td align="left" valign="top">
<tr><td align="left" valign="top">&bull; <a href="Daily_002dnotes.html#Daily_002dnotes">Daily-notes</a>:</td><td>&nbsp;&nbsp;</td><td align="left" valign="top">
</td></tr>
<tr><td align="left" valign="top">&bull; <a href="Diagnosing-and-Repairing-Files.html#Diagnosing-and-Repairing-Files">Diagnosing and Repairing Files</a>:</td><td>&nbsp;&nbsp;</td><td align="left" valign="top">
</td></tr>
@@ -294,6 +299,16 @@ Roam Protocol
</td></tr>
<tr><th colspan="3" align="left" valign="top"><pre class="menu-comment">
Daily-notes
</pre></th></tr><tr><td align="left" valign="top">&bull; <a href="Configuration.html#Configuration">Configuration</a>:</td><td>&nbsp;&nbsp;</td><td align="left" valign="top">
</td></tr>
<tr><td align="left" valign="top">&bull; <a href="Capturing-and-finding-daily_002dnotes.html#Capturing-and-finding-daily_002dnotes">Capturing and finding daily-notes</a>:</td><td>&nbsp;&nbsp;</td><td align="left" valign="top">
</td></tr>
<tr><td align="left" valign="top">&bull; <a href="Navigation.html#Navigation">Navigation</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">
Performance Optimization
</pre></th></tr><tr><td align="left" valign="top">&bull; <a href="Profiling-Key-Operations.html#Profiling-Key-Operations">Profiling Key Operations</a>:</td><td>&nbsp;&nbsp;</td><td align="left" valign="top">

142
org-roam.org
View File

@@ -123,7 +123,7 @@ 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
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
@@ -993,11 +993,13 @@ This protocol finds or creates a new note with a given ~roam_key~ (see [[*Anatom
To use this, create the following [[https://en.wikipedia.org/wiki/Bookmarklet][bookmarklet]] in your browser:
#+BEGIN_SRC javascript
javascript:location.href =
'org-protocol://roam-ref?template=r&ref='
+ encodeURIComponent(location.href)
+ '&title='
+ encodeURIComponent(document.title)
javascript:location.href =
'org-protocol://roam-ref?template=r&ref='
+ encodeURIComponent(location.href)
+ '&title='
+ encodeURIComponent(document.title)
+ '&body='
+ encodeURIComponent(window.getSelection())
#+END_SRC
or as a keybinding in ~qutebrowser~ in , using the ~config.py~ file (see
@@ -1011,7 +1013,122 @@ where ~template~ is the template key for a template in
~org-roam-capture-ref-templates~ (see [[*The Templating System][The Templating System]]). These templates
should contain a ~#+roam_key: ${ref}~ in it.
* TODO Daily Notes
* Daily-notes
Org-roam provides journaling capabilities akin to
[[#org-journal][Org-journal]] with ~org-roam-dailies~.
** Configuration
For ~org-roam-dailies~ to work, you need to define two variables:
- Variable: ~org-roam-dailies-directory~
Path to daily-notes.
- Variable: ~org-roam-dailies-capture-templates~
Capture templates for daily-notes in Org-roam.
Here is a sane default configuration:
#+begin_src emacs-lisp
(setq org-roam-dailies-directory "daily/")
(setq org-roam-dailies-capture-templates
'(("d" "default" entry
#'org-roam-capture--get-point
"* %?"
:file-name "daily/%<%Y-%m-%d>"
:head "#+title: %<%Y-%m-%d>\n\n")))
#+end_src
Make sure that ~org-roam-dailies-directory~ appears in ~:file-name~ for your
notes to be recognized as daily-notes. You can have different templates
placing their notes in different directories, but the one in
~org-roam-dailies-directory~ will be considered as the main one in commands.
See [[*The Templating System][The Templating System]] for creating new
templates. ~org-roam-dailies~ provides an extra ~:olp~ option which allows
specifying the outline-path to a heading:
#+begin_src emacs-lisp
(setq org-roam-dailies-capture-templates
'(("l" "lab" entry
#'org-roam-capture--get-point
"* %?"
:file-name "daily/%<%Y-%m-%d>"
:head "#+title: %<%Y-%m-%d>\n\n* Lab notes\n* Journal"
:olp ("Journal"))
("j" "journal" entry
#'org-roam-capture--get-point
"* %?"
:file-name "daily/%<%Y-%m-%d>"
:head "#+title: %<%Y-%m-%d>\n\n* Lab notes\n* Journal"
:olp ("Lab notes"))))
#+end_src
The template ~l~ will put its notes under the heading ‘Lab notes’, and the
template ~j~ will put its notes under the heading ‘Journal’. When you use
~:olp~, make sure that the headings are present in ~:head~.
** Capturing and finding daily-notes
- Function: ~org-roam-dailies-capture-today~ &optional goto
Create an entry in the daily note for today.
When ~goto~ is non-nil, go the note without creating an entry.
- Function: ~org-roam-dailies-find-today~
Find the daily note for today, creating it if necessary.
There are variants of those commands for ~-yesterday~ and ~-tomorrow~:
- Function: ~org-roam-dailies-capture-yesterday~ n &optional goto
Create an entry in the daily note for yesteday.
With numeric argument ~n~, use the daily note ~n~ days in the past.
- Function: ~org-roam-dailies-find-yesterday~
With numeric argument N, use the daily-note N days in the future.
There are also commands which allow you to use Emacs’s ~calendar~ to find the date
- Function: ~org-roam-dailies-capture-date~
Create an entry in the daily note for a date using the calendar.
Prefer past dates, unless ~prefer-future~ is non-nil.
With a 'C-u' prefix or when ~goto~ is non-nil, go the note without
creating an entry.
- Function: ~org-roam-dailies-find-date~
Find the daily note for a date using the calendar, creating it if necessary.
Prefer past dates, unless ~prefer-future~ is non-nil.
** Navigation
You can navigate between daily-notes:
- Function: ~org-roam-dailies-find-directory~
Find and open ~org-roam-dailies-directory~.
- Function: ~org-roam-dailies-find-previous-note~
When in an daily-note, find the previous one.
- Function: ~org-roam-dailies-find-next-note~
When in an daily-note, find the next one.
* Diagnosing and Repairing Files
@@ -1198,10 +1315,11 @@ that uses an external search engine and indexer.
:CUSTOM_ID: org-journal
:END:
[[https://github.com/bastibe/org-journal][Org-journal]] is a more
powerful alternative to the simple function ~org-roam-dailies-today~. It
provides better journaling capabilities, and a nice calendar interface
to see all dated entries.
[[https://github.com/bastibe/org-journal][Org-journal]] provides journaling
capabilities to Org-mode. A lot of its functionalities have been incorporated
into Org-roam under the name ~org-roam-dailies~. It remains a good tool if
you want to isolate your verbose journal entries from the ideas you would
write on a scratchpad.
#+BEGIN_SRC emacs-lisp
(use-package org-journal
@@ -1210,7 +1328,7 @@ to see all dated entries.
:custom
(org-journal-date-prefix "#+title: ")
(org-journal-file-format "%Y-%m-%d.org")
(org-journal-dir "/path/to/org-roam-files/")
(org-journal-dir "/path/to/journal/files/")
(org-journal-date-format "%A, %d %B %Y"))
#+END_SRC

186
org-roam.texi
View File

@@ -78,7 +78,7 @@ General Public License for more details.
* Graphing::
* Org-roam Completion System::
* Roam Protocol::
* Daily Notes::
* Daily-notes::
* Diagnosing and Repairing Files::
* Finding Unlinked References::
* Performance Optimization::
@@ -129,6 +129,12 @@ Roam Protocol
* The roam-file protocol::
* The roam-ref protocol::
Daily-notes
* Configuration::
* Capturing and finding daily-notes::
* Navigation::
Performance Optimization
* Profiling Key Operations::
@@ -260,7 +266,7 @@ A slip-box requires a method of quickly capturing ideas. These are called
@strong{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
@code{org-capture} (see @ref{capture,,,org,}), or using Org-roam's daily notes
functionality (see @ref{Daily Notes}). This provides a central inbox for collecting
functionality (see @ref{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: @strong{literature notes} and
@@ -402,7 +408,7 @@ Where @code{/path/to/my/info/files} is the location where you keep info files. T
@lisp
(require 'info)
(add-to-list 'Info-default-directory-list
"/path/to/my/info/files")
"/path/to/my/info/files")
@end lisp
You can also use one of the default locations, such as:
@@ -1329,10 +1335,12 @@ To use this, create the following @uref{https://en.wikipedia.org/wiki/Bookmarkle
@example
javascript:location.href =
'org-protocol://roam-ref?template=r&ref='
+ encodeURIComponent(location.href)
+ '&title='
+ encodeURIComponent(document.title)
'org-protocol://roam-ref?template=r&ref='
+ encodeURIComponent(location.href)
+ '&title='
+ encodeURIComponent(document.title)
+ '&body='
+ encodeURIComponent(window.getSelection())
@end example
or as a keybinding in @code{qutebrowser} in , using the @code{config.py} file (see
@@ -1346,8 +1354,153 @@ where @code{template} is the template key for a template in
@code{org-roam-capture-ref-templates} (see @ref{The Templating System}). These templates
should contain a @code{#+roam_key: $@{ref@}} in it.
@node Daily Notes
@chapter @strong{TODO} Daily Notes
@node Daily-notes
@chapter Daily-notes
Org-roam provides journaling capabilities akin to
@ref{Org-journal} with @code{org-roam-dailies}.
@menu
* Configuration::
* Capturing and finding daily-notes::
* Navigation::
@end menu
@node Configuration
@section Configuration
For @code{org-roam-dailies} to work, you need to define two variables:
@itemize
@item
Variable: @code{org-roam-dailies-directory}
Path to daily-notes.
@item
Variable: @code{org-roam-dailies-capture-templates}
Capture templates for daily-notes in Org-roam.
@end itemize
Here is a sane default configuration:
@lisp
(setq org-roam-dailies-directory "daily/")
(setq org-roam-dailies-capture-templates
'(("d" "default" entry
#'org-roam-capture--get-point
"* %?"
:file-name "daily/%<%Y-%m-%d>"
:head "#+title: %<%Y-%m-%d>\n\n")))
@end lisp
Make sure that @code{org-roam-dailies-directory} appears in @code{:file-name} for your
notes to be recognized as daily-notes. You can have different templates
placing their notes in different directories, but the one in
@code{org-roam-dailies-directory} will be considered as the main one in commands.
See @ref{The Templating System} for creating new
templates. @code{org-roam-dailies} provides an extra @code{:olp} option which allows
specifying the outline-path to a heading:
@lisp
(setq org-roam-dailies-capture-templates
'(("l" "lab" entry
#'org-roam-capture--get-point
"* %?"
:file-name "daily/%<%Y-%m-%d>"
:head "#+title: %<%Y-%m-%d>\n\n* Lab notes\n* Journal"
:olp ("Journal"))
("j" "journal" entry
#'org-roam-capture--get-point
"* %?"
:file-name "daily/%<%Y-%m-%d>"
:head "#+title: %<%Y-%m-%d>\n\n* Lab notes\n* Journal"
:olp ("Lab notes"))))
@end lisp
The template @code{l} will put its notes under the heading ‘Lab notes’, and the
template @code{j} will put its notes under the heading ‘Journal’. When you use
@code{:olp}, make sure that the headings are present in @code{:head}.
@node Capturing and finding daily-notes
@section Capturing and finding daily-notes
@itemize
@item
Function: @code{org-roam-dailies-capture-today} &optional goto
Create an entry in the daily note for today.
When @code{goto} is non-nil, go the note without creating an entry.
@item
Function: @code{org-roam-dailies-find-today}
Find the daily note for today, creating it if necessary.
@end itemize
There are variants of those commands for @code{-yesterday} and @code{-tomorrow}:
@itemize
@item
Function: @code{org-roam-dailies-capture-yesterday} n &optional goto
Create an entry in the daily note for yesteday.
With numeric argument @code{n}, use the daily note @code{n} days in the past.
@item
Function: @code{org-roam-dailies-find-yesterday}
With numeric argument N, use the daily-note N days in the future.
@end itemize
There are also commands which allow you to use Emacs’s @code{calendar} to find the date
@itemize
@item
Function: @code{org-roam-dailies-capture-date}
Create an entry in the daily note for a date using the calendar.
Prefer past dates, unless @code{prefer-future} is non-nil.
With a 'C-u' prefix or when @code{goto} is non-nil, go the note without
creating an entry.
@item
Function: @code{org-roam-dailies-find-date}
Find the daily note for a date using the calendar, creating it if necessary.
Prefer past dates, unless @code{prefer-future} is non-nil.
@end itemize
@node Navigation
@section Navigation
You can navigate between daily-notes:
@itemize
@item
Function: @code{org-roam-dailies-find-directory}
Find and open @code{org-roam-dailies-directory}.
@item
Function: @code{org-roam-dailies-find-previous-note}
When in an daily-note, find the previous one.
@item
Function: @code{org-roam-dailies-find-next-note}
When in an daily-note, find the next one.
@end itemize
@node Diagnosing and Repairing Files
@chapter Diagnosing and Repairing Files
@@ -1567,10 +1720,11 @@ that uses an external search engine and indexer.
@node Org-journal
@subsection Org-journal
@uref{https://github.com/bastibe/org-journal, Org-journal} is a more
powerful alternative to the simple function @code{org-roam-dailies-today}. It
provides better journaling capabilities, and a nice calendar interface
to see all dated entries.
@uref{https://github.com/bastibe/org-journal, Org-journal} provides journaling
capabilities to Org-mode. A lot of its functionalities have been incorporated
into Org-roam under the name @code{org-roam-dailies}. It remains a good tool if
you want to isolate your verbose journal entries from the ideas you would
write on a scratchpad.
@lisp
(use-package org-journal
@@ -1579,7 +1733,7 @@ to see all dated entries.
:custom
(org-journal-date-prefix "#+title: ")
(org-journal-file-format "%Y-%m-%d.org")
(org-journal-dir "/path/to/org-roam-files/")
(org-journal-dir "/path/to/journal/files/")
(org-journal-date-format "%A, %d %B %Y"))
@end lisp
@@ -1708,5 +1862,5 @@ call @code{ivy-immediate-done}, typically bound to @code{C-M-j}. Alternatively,
Org-roam should provide a selectable ``[?] bar'' candidate at the top of the candidate list.
@end table
Emacs 28.0.50 (Org mode 9.4)
@bye
Emacs 27.1.50 (Org mode 9.4)
@bye