From d7f0b06e05f730feff67bdd3d0ae105b054b3baf Mon Sep 17 00:00:00 2001 From: jethrokuan Date: Mon, 11 Oct 2021 16:54:06 +0000 Subject: [PATCH] =?UTF-8?q?Deploying=20to=20gh-pages=20from=20=20@=204af5f?= =?UTF-8?q?f662e1487e8e4e590457c636003f95512cb=20=F0=9F=9A=80?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- manual.html | 120 +++++++++++++++++++++++--------------------------- org-roam.org | 33 +++++++------- org-roam.texi | 61 ++++++++++++------------- 3 files changed, 102 insertions(+), 112 deletions(-) diff --git a/manual.html b/manual.html index c1e9e8c..4d73cc3 100644 --- a/manual.html +++ b/manual.html @@ -113,8 +113,6 @@ General Public License for more details. • FAQ   -• Migrating from Org-roam v1   - • Developer's Guide to Org-roam   • Appendix   @@ -127,8 +125,6 @@ General Public License for more details. • Variable Index   -• Bibliography   - 
 
 
— The Detailed Node Listing —
@@ -281,12 +277,14 @@ FAQ
• 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 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
@@ -970,10 +968,10 @@ keybindings available. Here are several of the more useful ones:
 
  •  M-{N}: magit-section-show-level-{N}-all
 
 
  •  n: magit-section-forward
-
    • 
-
    -<TAB>: magit-section-toggle
-
    
 
 
    org-roam-buffer-visit-thing is a placeholder command, that is replaced by
@@ -1208,7 +1206,7 @@ Next: , Previous: <
 
 
    Since version 9.5, Org has first-class support for citations. Org-roam supports
 the caching of both these in-built citations (of form [cite:@key]) and org-ref
-citations (of form (NO_ITEM_DATA:key)).
+citations (of form cite:key).
 
    
 
    Org-roam attempts to load both the org-ref and org-cite package when
 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 
    
 
    
-Next: , Previous: , Up: Top   [Index]
    
+Next: , Previous: , Up: Top   [Index]
    
 
    
 
    18 FAQ
    
 
 
-
-
-
+
    
 
    • 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?  
 
    
 
    
 
 
    
 
    
 
    
-Next: , Up: FAQ   [Index]
    
+Next: , Up: FAQ   [Index]
    
 
    
 
    18.1 How do I have more than one Org-roam directory?
    
 
@@ -2214,22 +2214,11 @@ Org-roam files. Remember to run org-roam-db-sync from a file within
 that directory, at least once.
 
    
 
    
-
    
-
    
-Next: , Previous: , Up: FAQ   [Index]
    
-
    
-
    18.2 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 in the repository.
-
    
-
    
 
    
 
    
-Next: , Previous: , Up: FAQ   [Index]
    
+Next: , Previous: , Up: FAQ   [Index]
    
 
    
-
    18.3 How do I create a note whose title already matches one of the candidates?
    
+
    18.2 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
 “bar” when “barricade” already exists.
@@ -2248,9 +2237,9 @@ the candidate list.
 
    
 
    
 
    
-Previous: , Up: FAQ   [Index]
    
+Next: , Previous: , Up: FAQ   [Index]
    
 
    
-
    18.4 How can I stop Org-roam from creating IDs everywhere?
    
+
    18.3 How can I stop Org-roam from creating IDs everywhere?
    
 
 
    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
@@ -2259,26 +2248,38 @@ have set for org-id-link-to-org-use-id: setting it to 'create
 is a popular option.
 
    
 
    
-
    
+
    
 
    
-Next: , Previous: , Up: Top   [Index]
    
+Next: , Previous: , Up: FAQ   [Index]
    
 
    
-
    19 Migrating from Org-roam v1
    
+
    18.4 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 in the repository.
+
    
+
    
+
    
+
    
+Previous: , Up: FAQ   [Index]
    
+
    
+
    18.5 How to migrate from Org-roam v1?
    
 
 
    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
 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
-notes to v2, you may use the migration script provided in this gist, or this
-gist, the latter being better tested. This blog post provides a good overview of
-what’s new in v2 and how to migrate.
+
    It is still desirable to migrate notes collected in v1 to v2.
+To migrate your v1 notes to v2, use ‘M-x org-roam-migrate-wizard’.
+This blog post
+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:
 
    
 
      
-
    •  Add IDs to all existing notes. These are located in top-level property
-drawers (Although note that in v2, not all files need to have IDs)
+
    •  Add IDs to all existing notes.
+These are located in top-level property drawers
+(Although note that in v2, not all files need to have IDs).
 
 
    •  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)
 
 
    •  Replace #+ROAM_ALIAS into the ROAM_ALIASES property
 
-
    •  Move #+ROAM_TAGS into the #+FILETAGS property for file-level nodes, and
-the ROAM_TAGS property for headline nodes
+
    •  Move #+ROAM_TAGS into the #+FILETAGS property for file-level nodes,
+and the ROAM_TAGS property for headline nodes
 
 
    •  Replace existing file links with ID links.
 
    
@@ -2295,9 +2296,9 @@ the ROAM_TAGS property for headline nodes
 
    
 
    
 
    
-Next: , Previous: , Up: Top   [Index]
    
+Next: , Previous: , Up: Top   [Index]
    
 
    
-
    20 Developer’s Guide to Org-roam
    
+
    19 Developer’s Guide to Org-roam
    
 
 
    
 
    • Org-roam's Design Principle  
@@ -2311,7 +2312,7 @@ Next: , Previous: 
 Next: , Up: Developer's Guide to Org-roam   [Index]
    
 
-
    20.1 Org-roam’s Design Principle
    
+
    19.1 Org-roam’s Design Principle
    
 
 
    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
@@ -2356,7 +2357,7 @@ queries on their Org files.
 
    
 Previous: , Up: Developer's Guide to Org-roam   [Index]
    
 
-
    20.2 Building Extensions and Advanced Customization of Org-roam
    
+
    19.2 Building Extensions and Advanced Customization of Org-roam
    
 
 
    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
@@ -2395,7 +2396,7 @@ load when support is available.
 
    
 Next: , Up: Building Extensions and Advanced Customization of Org-roam   [Index]
    
 
-
    20.2.1 Accessing the Database
    
+
    19.2.1 Accessing the Database
    
 
 
    Access to the database is provided singularly by org-roam-db-query, for
 example:
@@ -2415,7 +2416,7 @@ that extensions/customizations are robust to change, extensions should only use
 
    
 Next: , Previous: , Up: Building Extensions and Advanced Customization of Org-roam   [Index]
    
 
-
    20.2.2 Accessing and Modifying Nodes
    
+
    19.2.2 Accessing and Modifying Nodes
    
 
 
    The node interface is cleanly defined using cl-defstruct. The primary
 method to access nodes is org-roam-node-at-point and org-roam-node-read:
@@ -2464,7 +2465,7 @@ making it available for use in capture templates.
 
    
 Previous: , Up: Building Extensions and Advanced Customization of Org-roam   [Index]
    
 
-
    20.2.3 Extending the Capture System
    
+
    19.2.3 Extending the Capture System
    
 
 
    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
@@ -2501,7 +2502,7 @@ When GOTO is non-nil, go the note without creating an entry."
 
    
 Next: , Previous: , Up: Top   [Index]
    
 
-
    21 Appendix
    
+
    20 Appendix
    
 
 
    
 
    • Note-taking Workflows  
@@ -2515,7 +2516,7 @@ Next: , P
 
    
 Next: , Up: Appendix   [Index]
    
 
-
    21.1 Note-taking Workflows
    
+
    20.1 Note-taking Workflows
    
 
 
    
 
-
    
-
    
-
    
-Previous: , Up: Top   [Index]
    
-
    
-
    E Bibliography
    
-
-
    NO_ITEM_DATA:key
-
    
-
    Emacs 28.0.50 (Org mode 9.5)
+
    Emacs 28.0.50 (Org mode N/A)
 
    
 
    
 
    Footnotes
    
diff --git a/org-roam.org b/org-roam.org
index 14f425a..66b2133 100644
--- a/org-roam.org
+++ b/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
 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?
 
 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~
 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.
 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.
 
-It is still desirable to migrate notes collected in v1 to v2. To migrate your v1
-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
-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
-what's new in v2 and how to migrate.
+It is still desirable to migrate notes collected in v1 to v2.
+To migrate your v1 notes to v2, use =M-x org-roam-migrate-wizard=.
+[[https://d12frosted.io/posts/2021-06-11-path-to-org-roam-v2.html][This blog post]]
+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
-   drawers (Although note that in v2, not all files need to have IDs)
+1. Add IDs to all existing notes.
+   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.
 3. Replace ~#+ROAM_KEY~ into the ~ROAM_REFS~ property
 4. Replace ~#+ROAM_ALIAS~ into the ~ROAM_ALIASES~ property
-5. Move ~#+ROAM_TAGS~ into the ~#+FILETAGS~ property for file-level nodes, and
-   the ~ROAM_TAGS~ property for headline nodes
+5. Move ~#+ROAM_TAGS~ into the ~#+FILETAGS~ property for file-level nodes,
+   and the ~ROAM_TAGS~ property for headline nodes
 6. Replace existing file links with ID links.
 
 * Developer's Guide to Org-roam
diff --git a/org-roam.texi b/org-roam.texi
index 2da1c1a..8e86005 100644
--- a/org-roam.texi
+++ b/org-roam.texi
@@ -80,14 +80,12 @@ General Public License for more details.
 * Performance Optimization::
 * The Org-mode Ecosystem::
 * FAQ::
-* Migrating from Org-roam v1::
 * Developer's Guide to Org-roam::
 * Appendix::
 * Keystroke Index::
 * Command Index::
 * Function Index::
 * Variable Index::
-* Bibliography: Bibliography (1). 
 
 @detailmenu
 --- The Detailed Node Listing ---
@@ -182,9 +180,10 @@ The Org-mode Ecosystem
 FAQ
 
 * 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 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
 
@@ -800,9 +799,10 @@ keybindings available. Here are several of the more useful ones:
 
 @item
 @code{n}: @code{magit-section-forward}
-@end itemize
--@code{}: @code{magit-section-toggle}
-@itemize
+
+@item
+@code{}: @code{magit-section-toggle}
+
 @item
 @code{}: @code{org-roam-buffer-visit-thing}
 @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
 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
 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
 * 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 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
 
 @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
 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?
 @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}
 is a popular option.
 
-@node Migrating from Org-roam v1
-@chapter Migrating from Org-roam v1
+@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 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.
 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.
 
-It is still desirable to migrate notes collected in v1 to v2. To migrate your v1
-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
-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
-what's new in v2 and how to migrate.
+It is still desirable to migrate notes collected in v1 to v2.
+To migrate your v1 notes to v2, use @samp{M-x org-roam-migrate-wizard}.
+@uref{https://d12frosted.io/posts/2021-06-11-path-to-org-roam-v2.html, This blog post}
+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
 @item
-Add IDs to all existing notes. These are located in top-level property
-drawers (Although note that in v2, not all files need to have IDs)
+Add IDs to all existing notes.
+These are located in top-level property drawers
+(Although note that in v2, not all files need to have IDs).
 
 @item
 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
 
 @item
-Move @code{#+ROAM_TAGS} into the @code{#+FILETAGS} property for file-level nodes, and
-the @code{ROAM_TAGS} property for headline nodes
+Move @code{#+ROAM_TAGS} into the @code{#+FILETAGS} property for file-level nodes,
+and the @code{ROAM_TAGS} property for headline nodes
 
 @item
 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
 
-@node Bibliography (1)
-@chapter Bibliography
-
-NO@math{_ITEM}@math{_DATA}:key
-
-Emacs 28.0.50 (Org mode 9.5)
+Emacs 28.0.50 (Org mode N/A)
 @bye