mirror of
https://github.com/org-roam/org-roam
synced 2025-08-17 13:33:31 -05:00
Deploying to gh-pages from @ 4af5ff662e
🚀
This commit is contained in:
120
manual.html
120
manual.html
@@ -113,8 +113,6 @@ General Public License for more details.
|
|||||||
</td></tr>
|
</td></tr>
|
||||||
<tr><td align="left" valign="top">• <a href="#FAQ">FAQ</a></td><td> </td><td align="left" valign="top">
|
<tr><td align="left" valign="top">• <a href="#FAQ">FAQ</a></td><td> </td><td align="left" valign="top">
|
||||||
</td></tr>
|
</td></tr>
|
||||||
<tr><td align="left" valign="top">• <a href="#Migrating-from-Org_002droam-v1">Migrating from Org-roam v1</a></td><td> </td><td align="left" valign="top">
|
|
||||||
</td></tr>
|
|
||||||
<tr><td align="left" valign="top">• <a href="#Developer_0027s-Guide-to-Org_002droam">Developer's Guide to Org-roam</a></td><td> </td><td align="left" valign="top">
|
<tr><td align="left" valign="top">• <a href="#Developer_0027s-Guide-to-Org_002droam">Developer's Guide to Org-roam</a></td><td> </td><td align="left" valign="top">
|
||||||
</td></tr>
|
</td></tr>
|
||||||
<tr><td align="left" valign="top">• <a href="#Appendix">Appendix</a></td><td> </td><td align="left" valign="top">
|
<tr><td align="left" valign="top">• <a href="#Appendix">Appendix</a></td><td> </td><td align="left" valign="top">
|
||||||
@@ -127,8 +125,6 @@ General Public License for more details.
|
|||||||
</td></tr>
|
</td></tr>
|
||||||
<tr><td align="left" valign="top">• <a href="#Variable-Index" rel="index">Variable Index</a></td><td> </td><td align="left" valign="top">
|
<tr><td align="left" valign="top">• <a href="#Variable-Index" rel="index">Variable Index</a></td><td> </td><td align="left" valign="top">
|
||||||
</td></tr>
|
</td></tr>
|
||||||
<tr><td align="left" valign="top">• <a href="#Bibliography-_00281_0029">Bibliography</a></td><td> </td><td align="left" valign="top">
|
|
||||||
</td></tr>
|
|
||||||
<tr><th colspan="3" align="left" valign="top"><pre class="menu-comment">
|
<tr><th colspan="3" align="left" valign="top"><pre class="menu-comment">
|
||||||
|
|
||||||
</pre></th></tr><tr><th colspan="3" align="left" valign="top"><pre class="menu-comment">— The Detailed Node Listing —
|
</pre></th></tr><tr><th colspan="3" align="left" valign="top"><pre class="menu-comment">— The Detailed Node Listing —
|
||||||
@@ -281,12 +277,14 @@ FAQ
|
|||||||
|
|
||||||
</pre></th></tr><tr><td align="left" valign="top">• <a href="#How-do-I-have-more-than-one-Org_002droam-directory_003f">How do I have more than one Org-roam directory?</a></td><td> </td><td align="left" valign="top">
|
</pre></th></tr><tr><td align="left" valign="top">• <a href="#How-do-I-have-more-than-one-Org_002droam-directory_003f">How do I have more than one Org-roam directory?</a></td><td> </td><td align="left" valign="top">
|
||||||
</td></tr>
|
</td></tr>
|
||||||
<tr><td align="left" valign="top">• <a href="#How-do-I-migrate-from-Roam-Research_003f">How do I migrate from Roam Research?</a></td><td> </td><td align="left" valign="top">
|
|
||||||
</td></tr>
|
|
||||||
<tr><td align="left" valign="top">• <a href="#How-do-I-create-a-note-whose-title-already-matches-one-of-the-candidates_003f">How do I create a note whose title already matches one of the candidates?</a></td><td> </td><td align="left" valign="top">
|
<tr><td align="left" valign="top">• <a href="#How-do-I-create-a-note-whose-title-already-matches-one-of-the-candidates_003f">How do I create a note whose title already matches one of the candidates?</a></td><td> </td><td align="left" valign="top">
|
||||||
</td></tr>
|
</td></tr>
|
||||||
<tr><td align="left" valign="top">• <a href="#How-can-I-stop-Org_002droam-from-creating-IDs-everywhere_003f">How can I stop Org-roam from creating IDs everywhere?</a></td><td> </td><td align="left" valign="top">
|
<tr><td align="left" valign="top">• <a href="#How-can-I-stop-Org_002droam-from-creating-IDs-everywhere_003f">How can I stop Org-roam from creating IDs everywhere?</a></td><td> </td><td align="left" valign="top">
|
||||||
</td></tr>
|
</td></tr>
|
||||||
|
<tr><td align="left" valign="top">• <a href="#How-do-I-migrate-from-Roam-Research_003f">How do I migrate from Roam Research?</a></td><td> </td><td align="left" valign="top">
|
||||||
|
</td></tr>
|
||||||
|
<tr><td align="left" valign="top">• <a href="#How-to-migrate-from-Org_002droam-v1_003f">How to migrate from Org-roam v1?</a></td><td> </td><td align="left" valign="top">
|
||||||
|
</td></tr>
|
||||||
<tr><th colspan="3" align="left" valign="top"><pre class="menu-comment">
|
<tr><th colspan="3" align="left" valign="top"><pre class="menu-comment">
|
||||||
|
|
||||||
Developer’s Guide to Org-roam
|
Developer’s Guide to Org-roam
|
||||||
@@ -970,10 +968,10 @@ keybindings available. Here are several of the more useful ones:
|
|||||||
<li> <code>M-{N}</code>: <code>magit-section-show-level-{N}-all</code>
|
<li> <code>M-{N}</code>: <code>magit-section-show-level-{N}-all</code>
|
||||||
|
|
||||||
</li><li> <code>n</code>: <code>magit-section-forward</code>
|
</li><li> <code>n</code>: <code>magit-section-forward</code>
|
||||||
</li></ul>
|
|
||||||
<p>-<code><TAB></code>: <code>magit-section-toggle</code>
|
</li><li> <code><TAB></code>: <code>magit-section-toggle</code>
|
||||||
</p><ul>
|
|
||||||
<li> <code><RET></code>: <code>org-roam-buffer-visit-thing</code>
|
</li><li> <code><RET></code>: <code>org-roam-buffer-visit-thing</code>
|
||||||
</li></ul>
|
</li></ul>
|
||||||
|
|
||||||
<p><code>org-roam-buffer-visit-thing</code> is a placeholder command, that is replaced by
|
<p><code>org-roam-buffer-visit-thing</code> is a placeholder command, that is replaced by
|
||||||
@@ -1208,7 +1206,7 @@ Next: <a href="#Completion" accesskey="n" rel="next">Completion</a>, Previous: <
|
|||||||
|
|
||||||
<p>Since version 9.5, Org has first-class support for citations. Org-roam supports
|
<p>Since version 9.5, Org has first-class support for citations. Org-roam supports
|
||||||
the caching of both these in-built citations (of form <code>[cite:@key]</code>) and <a href="https://github.com/jkitchin/org-ref">org-ref</a>
|
the caching of both these in-built citations (of form <code>[cite:@key]</code>) and <a href="https://github.com/jkitchin/org-ref">org-ref</a>
|
||||||
citations (of form (NO<em>_ITEM</em><em>_DATA</em>:key)).
|
citations (of form cite:key).
|
||||||
</p>
|
</p>
|
||||||
<p>Org-roam attempts to load both the <code>org-ref</code> and <code>org-cite</code> package when
|
<p>Org-roam attempts to load both the <code>org-ref</code> and <code>org-cite</code> package when
|
||||||
indexing files, so no further setup from the user is required for citation
|
indexing files, so no further setup from the user is required for citation
|
||||||
@@ -2174,25 +2172,27 @@ Org-mode, and sync your cards to Anki via <a href="https://github.com/FooSoft/an
|
|||||||
<hr>
|
<hr>
|
||||||
<span id="FAQ"></span><div class="header">
|
<span id="FAQ"></span><div class="header">
|
||||||
<p>
|
<p>
|
||||||
Next: <a href="#Migrating-from-Org_002droam-v1" accesskey="n" rel="next">Migrating from Org-roam v1</a>, Previous: <a href="#The-Org_002dmode-Ecosystem" accesskey="p" rel="prev">The Org-mode Ecosystem</a>, Up: <a href="#Top" accesskey="u" rel="up">Top</a> [<a href="#Keystroke-Index" title="Index" rel="index">Index</a>]</p>
|
Next: <a href="#Developer_0027s-Guide-to-Org_002droam" accesskey="n" rel="next">Developer's Guide to Org-roam</a>, Previous: <a href="#The-Org_002dmode-Ecosystem" accesskey="p" rel="prev">The Org-mode Ecosystem</a>, Up: <a href="#Top" accesskey="u" rel="up">Top</a> [<a href="#Keystroke-Index" title="Index" rel="index">Index</a>]</p>
|
||||||
</div>
|
</div>
|
||||||
<span id="FAQ-1"></span><h2 class="chapter">18 FAQ</h2>
|
<span id="FAQ-1"></span><h2 class="chapter">18 FAQ</h2>
|
||||||
|
|
||||||
<table class="menu" border="0" cellspacing="0">
|
<table class="menu" border="0" cellspacing="0">
|
||||||
<tr><td align="left" valign="top">• <a href="#How-do-I-have-more-than-one-Org_002droam-directory_003f" accesskey="1">How do I have more than one Org-roam directory?</a></td><td> </td><td align="left" valign="top">
|
<tr><td align="left" valign="top">• <a href="#How-do-I-have-more-than-one-Org_002droam-directory_003f" accesskey="1">How do I have more than one Org-roam directory?</a></td><td> </td><td align="left" valign="top">
|
||||||
</td></tr>
|
</td></tr>
|
||||||
<tr><td align="left" valign="top">• <a href="#How-do-I-migrate-from-Roam-Research_003f" accesskey="2">How do I migrate from Roam Research?</a></td><td> </td><td align="left" valign="top">
|
<tr><td align="left" valign="top">• <a href="#How-do-I-create-a-note-whose-title-already-matches-one-of-the-candidates_003f" accesskey="2">How do I create a note whose title already matches one of the candidates?</a></td><td> </td><td align="left" valign="top">
|
||||||
</td></tr>
|
</td></tr>
|
||||||
<tr><td align="left" valign="top">• <a href="#How-do-I-create-a-note-whose-title-already-matches-one-of-the-candidates_003f" accesskey="3">How do I create a note whose title already matches one of the candidates?</a></td><td> </td><td align="left" valign="top">
|
<tr><td align="left" valign="top">• <a href="#How-can-I-stop-Org_002droam-from-creating-IDs-everywhere_003f" accesskey="3">How can I stop Org-roam from creating IDs everywhere?</a></td><td> </td><td align="left" valign="top">
|
||||||
</td></tr>
|
</td></tr>
|
||||||
<tr><td align="left" valign="top">• <a href="#How-can-I-stop-Org_002droam-from-creating-IDs-everywhere_003f" accesskey="4">How can I stop Org-roam from creating IDs everywhere?</a></td><td> </td><td align="left" valign="top">
|
<tr><td align="left" valign="top">• <a href="#How-do-I-migrate-from-Roam-Research_003f" accesskey="4">How do I migrate from Roam Research?</a></td><td> </td><td align="left" valign="top">
|
||||||
|
</td></tr>
|
||||||
|
<tr><td align="left" valign="top">• <a href="#How-to-migrate-from-Org_002droam-v1_003f" accesskey="5">How to migrate from Org-roam v1?</a></td><td> </td><td align="left" valign="top">
|
||||||
</td></tr>
|
</td></tr>
|
||||||
</table>
|
</table>
|
||||||
|
|
||||||
<hr>
|
<hr>
|
||||||
<span id="How-do-I-have-more-than-one-Org_002droam-directory_003f"></span><div class="header">
|
<span id="How-do-I-have-more-than-one-Org_002droam-directory_003f"></span><div class="header">
|
||||||
<p>
|
<p>
|
||||||
Next: <a href="#How-do-I-migrate-from-Roam-Research_003f" accesskey="n" rel="next">How do I migrate from Roam Research?</a>, Up: <a href="#FAQ" accesskey="u" rel="up">FAQ</a> [<a href="#Keystroke-Index" title="Index" rel="index">Index</a>]</p>
|
Next: <a href="#How-do-I-create-a-note-whose-title-already-matches-one-of-the-candidates_003f" accesskey="n" rel="next">How do I create a note whose title already matches one of the candidates?</a>, Up: <a href="#FAQ" accesskey="u" rel="up">FAQ</a> [<a href="#Keystroke-Index" title="Index" rel="index">Index</a>]</p>
|
||||||
</div>
|
</div>
|
||||||
<span id="How-do-I-have-more-than-one-Org_002droam-directory_003f-1"></span><h3 class="section">18.1 How do I have more than one Org-roam directory?</h3>
|
<span id="How-do-I-have-more-than-one-Org_002droam-directory_003f-1"></span><h3 class="section">18.1 How do I have more than one Org-roam directory?</h3>
|
||||||
|
|
||||||
@@ -2214,22 +2214,11 @@ Org-roam files. Remember to run <code>org-roam-db-sync</code> from a file within
|
|||||||
that directory, at least once.
|
that directory, at least once.
|
||||||
</p>
|
</p>
|
||||||
<hr>
|
<hr>
|
||||||
<span id="How-do-I-migrate-from-Roam-Research_003f"></span><div class="header">
|
|
||||||
<p>
|
|
||||||
Next: <a href="#How-do-I-create-a-note-whose-title-already-matches-one-of-the-candidates_003f" accesskey="n" rel="next">How do I create a note whose title already matches one of the candidates?</a>, Previous: <a href="#How-do-I-have-more-than-one-Org_002droam-directory_003f" accesskey="p" rel="prev">How do I have more than one Org-roam directory?</a>, Up: <a href="#FAQ" accesskey="u" rel="up">FAQ</a> [<a href="#Keystroke-Index" title="Index" rel="index">Index</a>]</p>
|
|
||||||
</div>
|
|
||||||
<span id="How-do-I-migrate-from-Roam-Research_003f-1"></span><h3 class="section">18.2 How do I migrate from Roam Research?</h3>
|
|
||||||
|
|
||||||
<p>Fabio has produced a command-line tool that converts markdown files exported
|
|
||||||
from Roam Research into Org-roam compatible markdown. More instructions are
|
|
||||||
provided <a href="https://github.com/fabioberger/roam-migration">in the repository</a>.
|
|
||||||
</p>
|
|
||||||
<hr>
|
|
||||||
<span id="How-do-I-create-a-note-whose-title-already-matches-one-of-the-candidates_003f"></span><div class="header">
|
<span id="How-do-I-create-a-note-whose-title-already-matches-one-of-the-candidates_003f"></span><div class="header">
|
||||||
<p>
|
<p>
|
||||||
Next: <a href="#How-can-I-stop-Org_002droam-from-creating-IDs-everywhere_003f" accesskey="n" rel="next">How can I stop Org-roam from creating IDs everywhere?</a>, Previous: <a href="#How-do-I-migrate-from-Roam-Research_003f" accesskey="p" rel="prev">How do I migrate from Roam Research?</a>, Up: <a href="#FAQ" accesskey="u" rel="up">FAQ</a> [<a href="#Keystroke-Index" title="Index" rel="index">Index</a>]</p>
|
Next: <a href="#How-can-I-stop-Org_002droam-from-creating-IDs-everywhere_003f" accesskey="n" rel="next">How can I stop Org-roam from creating IDs everywhere?</a>, Previous: <a href="#How-do-I-have-more-than-one-Org_002droam-directory_003f" accesskey="p" rel="prev">How do I have more than one Org-roam directory?</a>, Up: <a href="#FAQ" accesskey="u" rel="up">FAQ</a> [<a href="#Keystroke-Index" title="Index" rel="index">Index</a>]</p>
|
||||||
</div>
|
</div>
|
||||||
<span id="How-do-I-create-a-note-whose-title-already-matches-one-of-the-candidates_003f-1"></span><h3 class="section">18.3 How do I create a note whose title already matches one of the candidates?</h3>
|
<span id="How-do-I-create-a-note-whose-title-already-matches-one-of-the-candidates_003f-1"></span><h3 class="section">18.2 How do I create a note whose title already matches one of the candidates?</h3>
|
||||||
|
|
||||||
<p>This situation arises when, for example, one would like to create a note titled
|
<p>This situation arises when, for example, one would like to create a note titled
|
||||||
“bar” when “barricade” already exists.
|
“bar” when “barricade” already exists.
|
||||||
@@ -2248,9 +2237,9 @@ the candidate list.
|
|||||||
<hr>
|
<hr>
|
||||||
<span id="How-can-I-stop-Org_002droam-from-creating-IDs-everywhere_003f"></span><div class="header">
|
<span id="How-can-I-stop-Org_002droam-from-creating-IDs-everywhere_003f"></span><div class="header">
|
||||||
<p>
|
<p>
|
||||||
Previous: <a href="#How-do-I-create-a-note-whose-title-already-matches-one-of-the-candidates_003f" accesskey="p" rel="prev">How do I create a note whose title already matches one of the candidates?</a>, Up: <a href="#FAQ" accesskey="u" rel="up">FAQ</a> [<a href="#Keystroke-Index" title="Index" rel="index">Index</a>]</p>
|
Next: <a href="#How-do-I-migrate-from-Roam-Research_003f" accesskey="n" rel="next">How do I migrate from Roam Research?</a>, Previous: <a href="#How-do-I-create-a-note-whose-title-already-matches-one-of-the-candidates_003f" accesskey="p" rel="prev">How do I create a note whose title already matches one of the candidates?</a>, Up: <a href="#FAQ" accesskey="u" rel="up">FAQ</a> [<a href="#Keystroke-Index" title="Index" rel="index">Index</a>]</p>
|
||||||
</div>
|
</div>
|
||||||
<span id="How-can-I-stop-Org_002droam-from-creating-IDs-everywhere_003f-1"></span><h3 class="section">18.4 How can I stop Org-roam from creating IDs everywhere?</h3>
|
<span id="How-can-I-stop-Org_002droam-from-creating-IDs-everywhere_003f-1"></span><h3 class="section">18.3 How can I stop Org-roam from creating IDs everywhere?</h3>
|
||||||
|
|
||||||
<p>Other than the interactive commands that Org-roam provides, Org-roam does not
|
<p>Other than the interactive commands that Org-roam provides, Org-roam does not
|
||||||
create IDs everywhere. If you are noticing that IDs are being created even when
|
create IDs everywhere. If you are noticing that IDs are being created even when
|
||||||
@@ -2259,26 +2248,38 @@ have set for <code>org-id-link-to-org-use-id</code>: setting it to <code>'create
|
|||||||
is a popular option.
|
is a popular option.
|
||||||
</p>
|
</p>
|
||||||
<hr>
|
<hr>
|
||||||
<span id="Migrating-from-Org_002droam-v1"></span><div class="header">
|
<span id="How-do-I-migrate-from-Roam-Research_003f"></span><div class="header">
|
||||||
<p>
|
<p>
|
||||||
Next: <a href="#Developer_0027s-Guide-to-Org_002droam" accesskey="n" rel="next">Developer's Guide to Org-roam</a>, Previous: <a href="#FAQ" accesskey="p" rel="prev">FAQ</a>, Up: <a href="#Top" accesskey="u" rel="up">Top</a> [<a href="#Keystroke-Index" title="Index" rel="index">Index</a>]</p>
|
Next: <a href="#How-to-migrate-from-Org_002droam-v1_003f" accesskey="n" rel="next">How to migrate from Org-roam v1?</a>, Previous: <a href="#How-can-I-stop-Org_002droam-from-creating-IDs-everywhere_003f" accesskey="p" rel="prev">How can I stop Org-roam from creating IDs everywhere?</a>, Up: <a href="#FAQ" accesskey="u" rel="up">FAQ</a> [<a href="#Keystroke-Index" title="Index" rel="index">Index</a>]</p>
|
||||||
</div>
|
</div>
|
||||||
<span id="Migrating-from-Org_002droam-v1-1"></span><h2 class="chapter">19 Migrating from Org-roam v1</h2>
|
<span id="How-do-I-migrate-from-Roam-Research_003f-1"></span><h3 class="section">18.4 How do I migrate from Roam Research?</h3>
|
||||||
|
|
||||||
|
<p>Fabio has produced a command-line tool that converts markdown files exported
|
||||||
|
from Roam Research into Org-roam compatible markdown. More instructions are
|
||||||
|
provided <a href="https://github.com/fabioberger/roam-migration">in the repository</a>.
|
||||||
|
</p>
|
||||||
|
<hr>
|
||||||
|
<span id="How-to-migrate-from-Org_002droam-v1_003f"></span><div class="header">
|
||||||
|
<p>
|
||||||
|
Previous: <a href="#How-do-I-migrate-from-Roam-Research_003f" accesskey="p" rel="prev">How do I migrate from Roam Research?</a>, Up: <a href="#FAQ" accesskey="u" rel="up">FAQ</a> [<a href="#Keystroke-Index" title="Index" rel="index">Index</a>]</p>
|
||||||
|
</div>
|
||||||
|
<span id="How-to-migrate-from-Org_002droam-v1_003f-1"></span><h3 class="section">18.5 How to migrate from Org-roam v1?</h3>
|
||||||
|
|
||||||
<p>Those coming from Org-roam v1 will do well treating v2 as entirely new software.
|
<p>Those coming from Org-roam v1 will do well treating v2 as entirely new software.
|
||||||
V2 has a smaller core and fewer moving parts, while retaining the bulk of its
|
V2 has a smaller core and fewer moving parts, while retaining the bulk of its
|
||||||
functionality. It is recommended to read the documentation above about nodes.
|
functionality. It is recommended to read the documentation above about nodes.
|
||||||
</p>
|
</p>
|
||||||
<p>It is still desirable to migrate notes collected in v1 to v2. To migrate your v1
|
<p>It is still desirable to migrate notes collected in v1 to v2.
|
||||||
notes to v2, you may use the migration script provided in <a href="https://gist.github.com/jethrokuan/02f41028fb4a6f81787dc420fb99b6e4">this gist</a>, or <a href="https://gist.github.com/jethrokuan/02f41028fb4a6f81787dc420fb99b6e4#gistcomment-3737019">this
|
To migrate your v1 notes to v2, use ‘<samp>M-x org-roam-migrate-wizard</samp>’.
|
||||||
gist</a>, the latter being better tested. <a href="https://d12frosted.io/posts/2021-06-11-path-to-org-roam-v2.html">This blog post</a> provides a good overview of
|
<a href="https://d12frosted.io/posts/2021-06-11-path-to-org-roam-v2.html">This blog post</a>
|
||||||
what’s new in v2 and how to migrate.
|
provides a good overview of what’s new in v2 and how to migrate.
|
||||||
</p>
|
</p>
|
||||||
<p>Simply put, to migrate notes from v1 to v2, one must:
|
<p>Essentially, to migrate notes from v1 to v2, one must:
|
||||||
</p>
|
</p>
|
||||||
<ul>
|
<ul>
|
||||||
<li> Add IDs to all existing notes. These are located in top-level property
|
<li> Add IDs to all existing notes.
|
||||||
drawers (Although note that in v2, not all files need to have IDs)
|
These are located in top-level property drawers
|
||||||
|
(Although note that in v2, not all files need to have IDs).
|
||||||
|
|
||||||
</li><li> Update the Org-roam database to conform to the new schema.
|
</li><li> Update the Org-roam database to conform to the new schema.
|
||||||
|
|
||||||
@@ -2286,8 +2287,8 @@ drawers (Although note that in v2, not all files need to have IDs)
|
|||||||
|
|
||||||
</li><li> Replace <code>#+ROAM_ALIAS</code> into the <code>ROAM_ALIASES</code> property
|
</li><li> Replace <code>#+ROAM_ALIAS</code> into the <code>ROAM_ALIASES</code> property
|
||||||
|
|
||||||
</li><li> Move <code>#+ROAM_TAGS</code> into the <code>#+FILETAGS</code> property for file-level nodes, and
|
</li><li> Move <code>#+ROAM_TAGS</code> into the <code>#+FILETAGS</code> property for file-level nodes,
|
||||||
the <code>ROAM_TAGS</code> property for headline nodes
|
and the <code>ROAM_TAGS</code> property for headline nodes
|
||||||
|
|
||||||
</li><li> Replace existing file links with ID links.
|
</li><li> Replace existing file links with ID links.
|
||||||
</li></ul>
|
</li></ul>
|
||||||
@@ -2295,9 +2296,9 @@ the <code>ROAM_TAGS</code> property for headline nodes
|
|||||||
<hr>
|
<hr>
|
||||||
<span id="Developer_0027s-Guide-to-Org_002droam"></span><div class="header">
|
<span id="Developer_0027s-Guide-to-Org_002droam"></span><div class="header">
|
||||||
<p>
|
<p>
|
||||||
Next: <a href="#Appendix" accesskey="n" rel="next">Appendix</a>, Previous: <a href="#Migrating-from-Org_002droam-v1" accesskey="p" rel="prev">Migrating from Org-roam v1</a>, Up: <a href="#Top" accesskey="u" rel="up">Top</a> [<a href="#Keystroke-Index" title="Index" rel="index">Index</a>]</p>
|
Next: <a href="#Appendix" accesskey="n" rel="next">Appendix</a>, Previous: <a href="#FAQ" accesskey="p" rel="prev">FAQ</a>, Up: <a href="#Top" accesskey="u" rel="up">Top</a> [<a href="#Keystroke-Index" title="Index" rel="index">Index</a>]</p>
|
||||||
</div>
|
</div>
|
||||||
<span id="Developer_0027s-Guide-to-Org_002droam-1"></span><h2 class="chapter">20 Developer’s Guide to Org-roam</h2>
|
<span id="Developer_0027s-Guide-to-Org_002droam-1"></span><h2 class="chapter">19 Developer’s Guide to Org-roam</h2>
|
||||||
|
|
||||||
<table class="menu" border="0" cellspacing="0">
|
<table class="menu" border="0" cellspacing="0">
|
||||||
<tr><td align="left" valign="top">• <a href="#Org_002droam_0027s-Design-Principle" accesskey="1">Org-roam's Design Principle</a></td><td> </td><td align="left" valign="top">
|
<tr><td align="left" valign="top">• <a href="#Org_002droam_0027s-Design-Principle" accesskey="1">Org-roam's Design Principle</a></td><td> </td><td align="left" valign="top">
|
||||||
@@ -2311,7 +2312,7 @@ Next: <a href="#Appendix" accesskey="n" rel="next">Appendix</a>, Previous: <a hr
|
|||||||
<p>
|
<p>
|
||||||
Next: <a href="#Building-Extensions-and-Advanced-Customization-of-Org_002droam" accesskey="n" rel="next">Building Extensions and Advanced Customization of Org-roam</a>, Up: <a href="#Developer_0027s-Guide-to-Org_002droam" accesskey="u" rel="up">Developer's Guide to Org-roam</a> [<a href="#Keystroke-Index" title="Index" rel="index">Index</a>]</p>
|
Next: <a href="#Building-Extensions-and-Advanced-Customization-of-Org_002droam" accesskey="n" rel="next">Building Extensions and Advanced Customization of Org-roam</a>, Up: <a href="#Developer_0027s-Guide-to-Org_002droam" accesskey="u" rel="up">Developer's Guide to Org-roam</a> [<a href="#Keystroke-Index" title="Index" rel="index">Index</a>]</p>
|
||||||
</div>
|
</div>
|
||||||
<span id="Org_002droam_0027s-Design-Principle-1"></span><h3 class="section">20.1 Org-roam’s Design Principle</h3>
|
<span id="Org_002droam_0027s-Design-Principle-1"></span><h3 class="section">19.1 Org-roam’s Design Principle</h3>
|
||||||
|
|
||||||
<p>Org-roam is primarily motivated by the need for a dual representation. We
|
<p>Org-roam is primarily motivated by the need for a dual representation. We
|
||||||
(humans) love operating in a plain-text environment. The syntax rules of
|
(humans) love operating in a plain-text environment. The syntax rules of
|
||||||
@@ -2356,7 +2357,7 @@ queries on their Org files.
|
|||||||
<p>
|
<p>
|
||||||
Previous: <a href="#Org_002droam_0027s-Design-Principle" accesskey="p" rel="prev">Org-roam's Design Principle</a>, Up: <a href="#Developer_0027s-Guide-to-Org_002droam" accesskey="u" rel="up">Developer's Guide to Org-roam</a> [<a href="#Keystroke-Index" title="Index" rel="index">Index</a>]</p>
|
Previous: <a href="#Org_002droam_0027s-Design-Principle" accesskey="p" rel="prev">Org-roam's Design Principle</a>, Up: <a href="#Developer_0027s-Guide-to-Org_002droam" accesskey="u" rel="up">Developer's Guide to Org-roam</a> [<a href="#Keystroke-Index" title="Index" rel="index">Index</a>]</p>
|
||||||
</div>
|
</div>
|
||||||
<span id="Building-Extensions-and-Advanced-Customization-of-Org_002droam-1"></span><h3 class="section">20.2 Building Extensions and Advanced Customization of Org-roam</h3>
|
<span id="Building-Extensions-and-Advanced-Customization-of-Org_002droam-1"></span><h3 class="section">19.2 Building Extensions and Advanced Customization of Org-roam</h3>
|
||||||
|
|
||||||
<p>Because Org-roam’s core functionality is small, it is possible and sometimes
|
<p>Because Org-roam’s core functionality is small, it is possible and sometimes
|
||||||
desirable to build extensions on top of it. These extensions may one or more of
|
desirable to build extensions on top of it. These extensions may one or more of
|
||||||
@@ -2395,7 +2396,7 @@ load when support is available.
|
|||||||
<p>
|
<p>
|
||||||
Next: <a href="#Accessing-and-Modifying-Nodes" accesskey="n" rel="next">Accessing and Modifying Nodes</a>, Up: <a href="#Building-Extensions-and-Advanced-Customization-of-Org_002droam" accesskey="u" rel="up">Building Extensions and Advanced Customization of Org-roam</a> [<a href="#Keystroke-Index" title="Index" rel="index">Index</a>]</p>
|
Next: <a href="#Accessing-and-Modifying-Nodes" accesskey="n" rel="next">Accessing and Modifying Nodes</a>, Up: <a href="#Building-Extensions-and-Advanced-Customization-of-Org_002droam" accesskey="u" rel="up">Building Extensions and Advanced Customization of Org-roam</a> [<a href="#Keystroke-Index" title="Index" rel="index">Index</a>]</p>
|
||||||
</div>
|
</div>
|
||||||
<span id="Accessing-the-Database-1"></span><h4 class="subsection">20.2.1 Accessing the Database</h4>
|
<span id="Accessing-the-Database-1"></span><h4 class="subsection">19.2.1 Accessing the Database</h4>
|
||||||
|
|
||||||
<p>Access to the database is provided singularly by <code>org-roam-db-query</code>, for
|
<p>Access to the database is provided singularly by <code>org-roam-db-query</code>, for
|
||||||
example:
|
example:
|
||||||
@@ -2415,7 +2416,7 @@ that extensions/customizations are robust to change, extensions should only use
|
|||||||
<p>
|
<p>
|
||||||
Next: <a href="#Extending-the-Capture-System" accesskey="n" rel="next">Extending the Capture System</a>, Previous: <a href="#Accessing-the-Database" accesskey="p" rel="prev">Accessing the Database</a>, Up: <a href="#Building-Extensions-and-Advanced-Customization-of-Org_002droam" accesskey="u" rel="up">Building Extensions and Advanced Customization of Org-roam</a> [<a href="#Keystroke-Index" title="Index" rel="index">Index</a>]</p>
|
Next: <a href="#Extending-the-Capture-System" accesskey="n" rel="next">Extending the Capture System</a>, Previous: <a href="#Accessing-the-Database" accesskey="p" rel="prev">Accessing the Database</a>, Up: <a href="#Building-Extensions-and-Advanced-Customization-of-Org_002droam" accesskey="u" rel="up">Building Extensions and Advanced Customization of Org-roam</a> [<a href="#Keystroke-Index" title="Index" rel="index">Index</a>]</p>
|
||||||
</div>
|
</div>
|
||||||
<span id="Accessing-and-Modifying-Nodes-1"></span><h4 class="subsection">20.2.2 Accessing and Modifying Nodes</h4>
|
<span id="Accessing-and-Modifying-Nodes-1"></span><h4 class="subsection">19.2.2 Accessing and Modifying Nodes</h4>
|
||||||
|
|
||||||
<p>The node interface is cleanly defined using <code>cl-defstruct</code>. The primary
|
<p>The node interface is cleanly defined using <code>cl-defstruct</code>. The primary
|
||||||
method to access nodes is <code>org-roam-node-at-point</code> and <code>org-roam-node-read</code>:
|
method to access nodes is <code>org-roam-node-at-point</code> and <code>org-roam-node-read</code>:
|
||||||
@@ -2464,7 +2465,7 @@ making it available for use in capture templates.
|
|||||||
<p>
|
<p>
|
||||||
Previous: <a href="#Accessing-and-Modifying-Nodes" accesskey="p" rel="prev">Accessing and Modifying Nodes</a>, Up: <a href="#Building-Extensions-and-Advanced-Customization-of-Org_002droam" accesskey="u" rel="up">Building Extensions and Advanced Customization of Org-roam</a> [<a href="#Keystroke-Index" title="Index" rel="index">Index</a>]</p>
|
Previous: <a href="#Accessing-and-Modifying-Nodes" accesskey="p" rel="prev">Accessing and Modifying Nodes</a>, Up: <a href="#Building-Extensions-and-Advanced-Customization-of-Org_002droam" accesskey="u" rel="up">Building Extensions and Advanced Customization of Org-roam</a> [<a href="#Keystroke-Index" title="Index" rel="index">Index</a>]</p>
|
||||||
</div>
|
</div>
|
||||||
<span id="Extending-the-Capture-System-1"></span><h4 class="subsection">20.2.3 Extending the Capture System</h4>
|
<span id="Extending-the-Capture-System-1"></span><h4 class="subsection">19.2.3 Extending the Capture System</h4>
|
||||||
|
|
||||||
<p>Org-roam applies some patching over Org’s capture system to smooth out the user
|
<p>Org-roam applies some patching over Org’s capture system to smooth out the user
|
||||||
experience, and sometimes it is desirable to use Org-roam’s capturing system
|
experience, and sometimes it is desirable to use Org-roam’s capturing system
|
||||||
@@ -2501,7 +2502,7 @@ When GOTO is non-nil, go the note without creating an entry."
|
|||||||
<p>
|
<p>
|
||||||
Next: <a href="#Keystroke-Index" accesskey="n" rel="next">Keystroke Index</a>, Previous: <a href="#Developer_0027s-Guide-to-Org_002droam" accesskey="p" rel="prev">Developer's Guide to Org-roam</a>, Up: <a href="#Top" accesskey="u" rel="up">Top</a> [<a href="#Keystroke-Index" title="Index" rel="index">Index</a>]</p>
|
Next: <a href="#Keystroke-Index" accesskey="n" rel="next">Keystroke Index</a>, Previous: <a href="#Developer_0027s-Guide-to-Org_002droam" accesskey="p" rel="prev">Developer's Guide to Org-roam</a>, Up: <a href="#Top" accesskey="u" rel="up">Top</a> [<a href="#Keystroke-Index" title="Index" rel="index">Index</a>]</p>
|
||||||
</div>
|
</div>
|
||||||
<span id="Appendix-1"></span><h2 class="chapter">21 Appendix</h2>
|
<span id="Appendix-1"></span><h2 class="chapter">20 Appendix</h2>
|
||||||
|
|
||||||
<table class="menu" border="0" cellspacing="0">
|
<table class="menu" border="0" cellspacing="0">
|
||||||
<tr><td align="left" valign="top">• <a href="#Note_002dtaking-Workflows" accesskey="1">Note-taking Workflows</a></td><td> </td><td align="left" valign="top">
|
<tr><td align="left" valign="top">• <a href="#Note_002dtaking-Workflows" accesskey="1">Note-taking Workflows</a></td><td> </td><td align="left" valign="top">
|
||||||
@@ -2515,7 +2516,7 @@ Next: <a href="#Keystroke-Index" accesskey="n" rel="next">Keystroke Index</a>, P
|
|||||||
<p>
|
<p>
|
||||||
Next: <a href="#Ecosystem" accesskey="n" rel="next">Ecosystem</a>, Up: <a href="#Appendix" accesskey="u" rel="up">Appendix</a> [<a href="#Keystroke-Index" title="Index" rel="index">Index</a>]</p>
|
Next: <a href="#Ecosystem" accesskey="n" rel="next">Ecosystem</a>, Up: <a href="#Appendix" accesskey="u" rel="up">Appendix</a> [<a href="#Keystroke-Index" title="Index" rel="index">Index</a>]</p>
|
||||||
</div>
|
</div>
|
||||||
<span id="Note_002dtaking-Workflows-1"></span><h3 class="section">21.1 Note-taking Workflows</h3>
|
<span id="Note_002dtaking-Workflows-1"></span><h3 class="section">20.1 Note-taking Workflows</h3>
|
||||||
|
|
||||||
<ul>
|
<ul>
|
||||||
<li> Books<ul>
|
<li> Books<ul>
|
||||||
@@ -2548,7 +2549,7 @@ Next: <a href="#Ecosystem" accesskey="n" rel="next">Ecosystem</a>, Up: <a href="
|
|||||||
<p>
|
<p>
|
||||||
Previous: <a href="#Note_002dtaking-Workflows" accesskey="p" rel="prev">Note-taking Workflows</a>, Up: <a href="#Appendix" accesskey="u" rel="up">Appendix</a> [<a href="#Keystroke-Index" title="Index" rel="index">Index</a>]</p>
|
Previous: <a href="#Note_002dtaking-Workflows" accesskey="p" rel="prev">Note-taking Workflows</a>, Up: <a href="#Appendix" accesskey="u" rel="up">Appendix</a> [<a href="#Keystroke-Index" title="Index" rel="index">Index</a>]</p>
|
||||||
</div>
|
</div>
|
||||||
<span id="Ecosystem-1"></span><h3 class="section">21.2 Ecosystem</h3>
|
<span id="Ecosystem-1"></span><h3 class="section">20.2 Ecosystem</h3>
|
||||||
|
|
||||||
<hr>
|
<hr>
|
||||||
<span id="Keystroke-Index"></span><div class="header">
|
<span id="Keystroke-Index"></span><div class="header">
|
||||||
@@ -2608,7 +2609,7 @@ Next: <a href="#Variable-Index" accesskey="n" rel="next">Variable Index</a>, Pre
|
|||||||
<hr>
|
<hr>
|
||||||
<span id="Variable-Index"></span><div class="header">
|
<span id="Variable-Index"></span><div class="header">
|
||||||
<p>
|
<p>
|
||||||
Next: <a href="#Bibliography-_00281_0029" accesskey="n" rel="next">Bibliography (1)</a>, Previous: <a href="#Function-Index" accesskey="p" rel="prev">Function Index</a>, Up: <a href="#Top" accesskey="u" rel="up">Top</a> [<a href="#Keystroke-Index" title="Index" rel="index">Index</a>]</p>
|
Previous: <a href="#Function-Index" accesskey="p" rel="prev">Function Index</a>, Up: <a href="#Top" accesskey="u" rel="up">Top</a> [<a href="#Keystroke-Index" title="Index" rel="index">Index</a>]</p>
|
||||||
</div>
|
</div>
|
||||||
<span id="Variable-Index-1"></span><h2 class="appendix">Appendix D Variable Index</h2>
|
<span id="Variable-Index-1"></span><h2 class="appendix">Appendix D Variable Index</h2>
|
||||||
|
|
||||||
@@ -2635,16 +2636,7 @@ Next: <a href="#Bibliography-_00281_0029" accesskey="n" rel="next">Bibliography
|
|||||||
|
|
||||||
</td></tr></table>
|
</td></tr></table>
|
||||||
|
|
||||||
<hr>
|
<p>Emacs 28.0.50 (Org mode N/A)
|
||||||
<span id="Bibliography-_00281_0029"></span><div class="header">
|
|
||||||
<p>
|
|
||||||
Previous: <a href="#Variable-Index" accesskey="p" rel="prev">Variable Index</a>, Up: <a href="#Top" accesskey="u" rel="up">Top</a> [<a href="#Keystroke-Index" title="Index" rel="index">Index</a>]</p>
|
|
||||||
</div>
|
|
||||||
<span id="Bibliography-2"></span><h2 class="chapter">E Bibliography</h2>
|
|
||||||
|
|
||||||
<p>NO<em>_ITEM</em><em>_DATA</em>:key
|
|
||||||
</p>
|
|
||||||
<p>Emacs 28.0.50 (Org mode 9.5)
|
|
||||||
</p><div class="footnote">
|
</p><div class="footnote">
|
||||||
<hr>
|
<hr>
|
||||||
<h4 class="footnotes-heading">Footnotes</h4>
|
<h4 class="footnotes-heading">Footnotes</h4>
|
||||||
|
33
org-roam.org
33
org-roam.org
@@ -1322,12 +1322,6 @@ All files within that directory will be treated as their own separate set of
|
|||||||
Org-roam files. Remember to run ~org-roam-db-sync~ from a file within
|
Org-roam files. Remember to run ~org-roam-db-sync~ from a file within
|
||||||
that directory, at least once.
|
that directory, at least once.
|
||||||
|
|
||||||
** How do I migrate from Roam Research?
|
|
||||||
|
|
||||||
Fabio has produced a command-line tool that converts markdown files exported
|
|
||||||
from Roam Research into Org-roam compatible markdown. More instructions are
|
|
||||||
provided [[https://github.com/fabioberger/roam-migration][in the repository]].
|
|
||||||
|
|
||||||
** How do I create a note whose title already matches one of the candidates?
|
** How do I create a note whose title already matches one of the candidates?
|
||||||
|
|
||||||
This situation arises when, for example, one would like to create a note titled
|
This situation arises when, for example, one would like to create a note titled
|
||||||
@@ -1348,26 +1342,33 @@ you don't want them to be (e.g. when tangling an Org file), check the value you
|
|||||||
have set for ~org-id-link-to-org-use-id~: setting it to ~'create-if-interactive~
|
have set for ~org-id-link-to-org-use-id~: setting it to ~'create-if-interactive~
|
||||||
is a popular option.
|
is a popular option.
|
||||||
|
|
||||||
* Migrating from Org-roam v1
|
** How do I migrate from Roam Research?
|
||||||
|
|
||||||
|
Fabio has produced a command-line tool that converts markdown files exported
|
||||||
|
from Roam Research into Org-roam compatible markdown. More instructions are
|
||||||
|
provided [[https://github.com/fabioberger/roam-migration][in the repository]].
|
||||||
|
|
||||||
|
** How to migrate from Org-roam v1?
|
||||||
|
|
||||||
Those coming from Org-roam v1 will do well treating v2 as entirely new software.
|
Those coming from Org-roam v1 will do well treating v2 as entirely new software.
|
||||||
V2 has a smaller core and fewer moving parts, while retaining the bulk of its
|
V2 has a smaller core and fewer moving parts, while retaining the bulk of its
|
||||||
functionality. It is recommended to read the documentation above about nodes.
|
functionality. It is recommended to read the documentation above about nodes.
|
||||||
|
|
||||||
It is still desirable to migrate notes collected in v1 to v2. To migrate your v1
|
It is still desirable to migrate notes collected in v1 to v2.
|
||||||
notes to v2, you may use the migration script provided in [[https://gist.github.com/jethrokuan/02f41028fb4a6f81787dc420fb99b6e4][this gist]], or [[https://gist.github.com/jethrokuan/02f41028fb4a6f81787dc420fb99b6e4#gistcomment-3737019][this
|
To migrate your v1 notes to v2, use =M-x org-roam-migrate-wizard=.
|
||||||
gist]], the latter being better tested. [[https://d12frosted.io/posts/2021-06-11-path-to-org-roam-v2.html][This blog post]] provides a good overview of
|
[[https://d12frosted.io/posts/2021-06-11-path-to-org-roam-v2.html][This blog post]]
|
||||||
what's new in v2 and how to migrate.
|
provides a good overview of what's new in v2 and how to migrate.
|
||||||
|
|
||||||
Simply put, to migrate notes from v1 to v2, one must:
|
Essentially, to migrate notes from v1 to v2, one must:
|
||||||
|
|
||||||
1. Add IDs to all existing notes. These are located in top-level property
|
1. Add IDs to all existing notes.
|
||||||
drawers (Although note that in v2, not all files need to have IDs)
|
These are located in top-level property drawers
|
||||||
|
(Although note that in v2, not all files need to have IDs).
|
||||||
2. Update the Org-roam database to conform to the new schema.
|
2. Update the Org-roam database to conform to the new schema.
|
||||||
3. Replace ~#+ROAM_KEY~ into the ~ROAM_REFS~ property
|
3. Replace ~#+ROAM_KEY~ into the ~ROAM_REFS~ property
|
||||||
4. Replace ~#+ROAM_ALIAS~ into the ~ROAM_ALIASES~ property
|
4. Replace ~#+ROAM_ALIAS~ into the ~ROAM_ALIASES~ property
|
||||||
5. Move ~#+ROAM_TAGS~ into the ~#+FILETAGS~ property for file-level nodes, and
|
5. Move ~#+ROAM_TAGS~ into the ~#+FILETAGS~ property for file-level nodes,
|
||||||
the ~ROAM_TAGS~ property for headline nodes
|
and the ~ROAM_TAGS~ property for headline nodes
|
||||||
6. Replace existing file links with ID links.
|
6. Replace existing file links with ID links.
|
||||||
|
|
||||||
* Developer's Guide to Org-roam
|
* Developer's Guide to Org-roam
|
||||||
|
@@ -80,14 +80,12 @@ General Public License for more details.
|
|||||||
* Performance Optimization::
|
* Performance Optimization::
|
||||||
* The Org-mode Ecosystem::
|
* The Org-mode Ecosystem::
|
||||||
* FAQ::
|
* FAQ::
|
||||||
* Migrating from Org-roam v1::
|
|
||||||
* Developer's Guide to Org-roam::
|
* Developer's Guide to Org-roam::
|
||||||
* Appendix::
|
* Appendix::
|
||||||
* Keystroke Index::
|
* Keystroke Index::
|
||||||
* Command Index::
|
* Command Index::
|
||||||
* Function Index::
|
* Function Index::
|
||||||
* Variable Index::
|
* Variable Index::
|
||||||
* Bibliography: Bibliography (1).
|
|
||||||
|
|
||||||
@detailmenu
|
@detailmenu
|
||||||
--- The Detailed Node Listing ---
|
--- The Detailed Node Listing ---
|
||||||
@@ -182,9 +180,10 @@ The Org-mode Ecosystem
|
|||||||
FAQ
|
FAQ
|
||||||
|
|
||||||
* How do I have more than one Org-roam directory?::
|
* How do I have more than one Org-roam directory?::
|
||||||
* How do I migrate from Roam Research?::
|
|
||||||
* How do I create a note whose title already matches one of the candidates?::
|
* How do I create a note whose title already matches one of the candidates?::
|
||||||
* How can I stop Org-roam from creating IDs everywhere?::
|
* How can I stop Org-roam from creating IDs everywhere?::
|
||||||
|
* How do I migrate from Roam Research?::
|
||||||
|
* How to migrate from Org-roam v1?::
|
||||||
|
|
||||||
Developer's Guide to Org-roam
|
Developer's Guide to Org-roam
|
||||||
|
|
||||||
@@ -800,9 +799,10 @@ keybindings available. Here are several of the more useful ones:
|
|||||||
|
|
||||||
@item
|
@item
|
||||||
@code{n}: @code{magit-section-forward}
|
@code{n}: @code{magit-section-forward}
|
||||||
@end itemize
|
|
||||||
-@code{<TAB>}: @code{magit-section-toggle}
|
@item
|
||||||
@itemize
|
@code{<TAB>}: @code{magit-section-toggle}
|
||||||
|
|
||||||
@item
|
@item
|
||||||
@code{<RET>}: @code{org-roam-buffer-visit-thing}
|
@code{<RET>}: @code{org-roam-buffer-visit-thing}
|
||||||
@end itemize
|
@end itemize
|
||||||
@@ -1006,7 +1006,7 @@ Remove a ref from the node at point.
|
|||||||
|
|
||||||
Since version 9.5, Org has first-class support for citations. Org-roam supports
|
Since version 9.5, Org has first-class support for citations. Org-roam supports
|
||||||
the caching of both these in-built citations (of form @code{[cite:@@key]}) and @uref{https://github.com/jkitchin/org-ref, org-ref}
|
the caching of both these in-built citations (of form @code{[cite:@@key]}) and @uref{https://github.com/jkitchin/org-ref, org-ref}
|
||||||
citations (of form (NO@math{_ITEM}@math{_DATA}:key)).
|
citations (of form cite:key).
|
||||||
|
|
||||||
Org-roam attempts to load both the @code{org-ref} and @code{org-cite} package when
|
Org-roam attempts to load both the @code{org-ref} and @code{org-cite} package when
|
||||||
indexing files, so no further setup from the user is required for citation
|
indexing files, so no further setup from the user is required for citation
|
||||||
@@ -1828,9 +1828,10 @@ Org-mode, and sync your cards to Anki via @uref{https://github.com/FooSoft/anki-
|
|||||||
|
|
||||||
@menu
|
@menu
|
||||||
* How do I have more than one Org-roam directory?::
|
* How do I have more than one Org-roam directory?::
|
||||||
* How do I migrate from Roam Research?::
|
|
||||||
* How do I create a note whose title already matches one of the candidates?::
|
* How do I create a note whose title already matches one of the candidates?::
|
||||||
* How can I stop Org-roam from creating IDs everywhere?::
|
* How can I stop Org-roam from creating IDs everywhere?::
|
||||||
|
* How do I migrate from Roam Research?::
|
||||||
|
* How to migrate from Org-roam v1?::
|
||||||
@end menu
|
@end menu
|
||||||
|
|
||||||
@node How do I have more than one Org-roam directory?
|
@node How do I have more than one Org-roam directory?
|
||||||
@@ -1853,13 +1854,6 @@ All files within that directory will be treated as their own separate set of
|
|||||||
Org-roam files. Remember to run @code{org-roam-db-sync} from a file within
|
Org-roam files. Remember to run @code{org-roam-db-sync} from a file within
|
||||||
that directory, at least once.
|
that directory, at least once.
|
||||||
|
|
||||||
@node How do I migrate from Roam Research?
|
|
||||||
@section How do I migrate from Roam Research?
|
|
||||||
|
|
||||||
Fabio has produced a command-line tool that converts markdown files exported
|
|
||||||
from Roam Research into Org-roam compatible markdown. More instructions are
|
|
||||||
provided @uref{https://github.com/fabioberger/roam-migration, in the repository}.
|
|
||||||
|
|
||||||
@node How do I create a note whose title already matches one of the candidates?
|
@node How do I create a note whose title already matches one of the candidates?
|
||||||
@section How do I create a note whose title already matches one of the candidates?
|
@section How do I create a note whose title already matches one of the candidates?
|
||||||
|
|
||||||
@@ -1888,24 +1882,32 @@ you don't want them to be (e.g. when tangling an Org file), check the value you
|
|||||||
have set for @code{org-id-link-to-org-use-id}: setting it to @code{'create-if-interactive}
|
have set for @code{org-id-link-to-org-use-id}: setting it to @code{'create-if-interactive}
|
||||||
is a popular option.
|
is a popular option.
|
||||||
|
|
||||||
@node Migrating from Org-roam v1
|
@node How do I migrate from Roam Research?
|
||||||
@chapter Migrating from Org-roam v1
|
@section How do I migrate from Roam Research?
|
||||||
|
|
||||||
|
Fabio has produced a command-line tool that converts markdown files exported
|
||||||
|
from Roam Research into Org-roam compatible markdown. More instructions are
|
||||||
|
provided @uref{https://github.com/fabioberger/roam-migration, in the repository}.
|
||||||
|
|
||||||
|
@node How to migrate from Org-roam v1?
|
||||||
|
@section How to migrate from Org-roam v1?
|
||||||
|
|
||||||
Those coming from Org-roam v1 will do well treating v2 as entirely new software.
|
Those coming from Org-roam v1 will do well treating v2 as entirely new software.
|
||||||
V2 has a smaller core and fewer moving parts, while retaining the bulk of its
|
V2 has a smaller core and fewer moving parts, while retaining the bulk of its
|
||||||
functionality. It is recommended to read the documentation above about nodes.
|
functionality. It is recommended to read the documentation above about nodes.
|
||||||
|
|
||||||
It is still desirable to migrate notes collected in v1 to v2. To migrate your v1
|
It is still desirable to migrate notes collected in v1 to v2.
|
||||||
notes to v2, you may use the migration script provided in @uref{https://gist.github.com/jethrokuan/02f41028fb4a6f81787dc420fb99b6e4, this gist}, or @uref{https://gist.github.com/jethrokuan/02f41028fb4a6f81787dc420fb99b6e4#gistcomment-3737019, this
|
To migrate your v1 notes to v2, use @samp{M-x org-roam-migrate-wizard}.
|
||||||
gist}, the latter being better tested. @uref{https://d12frosted.io/posts/2021-06-11-path-to-org-roam-v2.html, This blog post} provides a good overview of
|
@uref{https://d12frosted.io/posts/2021-06-11-path-to-org-roam-v2.html, This blog post}
|
||||||
what's new in v2 and how to migrate.
|
provides a good overview of what's new in v2 and how to migrate.
|
||||||
|
|
||||||
Simply put, to migrate notes from v1 to v2, one must:
|
Essentially, to migrate notes from v1 to v2, one must:
|
||||||
|
|
||||||
@itemize
|
@itemize
|
||||||
@item
|
@item
|
||||||
Add IDs to all existing notes. These are located in top-level property
|
Add IDs to all existing notes.
|
||||||
drawers (Although note that in v2, not all files need to have IDs)
|
These are located in top-level property drawers
|
||||||
|
(Although note that in v2, not all files need to have IDs).
|
||||||
|
|
||||||
@item
|
@item
|
||||||
Update the Org-roam database to conform to the new schema.
|
Update the Org-roam database to conform to the new schema.
|
||||||
@@ -1917,8 +1919,8 @@ Replace @code{#+ROAM_KEY} into the @code{ROAM_REFS} property
|
|||||||
Replace @code{#+ROAM_ALIAS} into the @code{ROAM_ALIASES} property
|
Replace @code{#+ROAM_ALIAS} into the @code{ROAM_ALIASES} property
|
||||||
|
|
||||||
@item
|
@item
|
||||||
Move @code{#+ROAM_TAGS} into the @code{#+FILETAGS} property for file-level nodes, and
|
Move @code{#+ROAM_TAGS} into the @code{#+FILETAGS} property for file-level nodes,
|
||||||
the @code{ROAM_TAGS} property for headline nodes
|
and the @code{ROAM_TAGS} property for headline nodes
|
||||||
|
|
||||||
@item
|
@item
|
||||||
Replace existing file links with ID links.
|
Replace existing file links with ID links.
|
||||||
@@ -2176,10 +2178,5 @@ When GOTO is non-nil, go the note without creating an entry."
|
|||||||
|
|
||||||
@printindex vr
|
@printindex vr
|
||||||
|
|
||||||
@node Bibliography (1)
|
Emacs 28.0.50 (Org mode N/A)
|
||||||
@chapter Bibliography
|
|
||||||
|
|
||||||
NO@math{_ITEM}@math{_DATA}:key
|
|
||||||
|
|
||||||
Emacs 28.0.50 (Org mode 9.5)
|
|
||||||
@bye
|
@bye
|
||||||
|
Reference in New Issue
Block a user