From 3d7d77e0c23d8c70b545cb058f06b5bcab81c11d Mon Sep 17 00:00:00 2001 From: jethrokuan Date: Sun, 27 Sep 2020 07:22:27 +0000 Subject: [PATCH] =?UTF-8?q?Deploying=20to=20gh-pages=20from=20=20@=202f403?= =?UTF-8?q?4cebcd9bbf1261890fbec7f778e5bcf3003=20=F0=9F=9A=80?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- manual/Appendix.html | 2 +- ...Browsing-History-with-winner_002dmode.html | 8 +- manual/Diagnosing-and-Repairing-Files.html | 4 +- manual/Ecosystem.html | 2 +- manual/Excluding-Nodes-and-Edges.html | 2 +- manual/FAQ.html | 2 +- manual/File-Refs.html | 8 +- manual/Finding-Unlinked-References.html | 87 ++++++++ ...l_002dtext-search-interface-with-Deft.html | 62 +++--- manual/Garbage-Collection.html | 4 +- manual/Graphing.html | 8 +- ...-than-one-Org_002droam-directory_003f.html | 6 +- ...-do-I-migrate-from-Roam-Research_003f.html | 2 +- manual/Installing-from-Apt.html | 2 +- manual/Installing-from-MELPA.html | 16 +- .../Installing-from-the-Git-Repository.html | 2 +- manual/Note_002dtaking-Add_002dons.html | 2 +- manual/Note_002dtaking-Workflows.html | 2 +- manual/Org_002ddownload.html | 12 +- manual/Org_002djournal.html | 18 +- manual/Org_002droam-Completion-System.html | 4 +- manual/Org_002droam-Template-Expansion.html | 10 +- manual/Performance-Optimization.html | 6 +- manual/Post_002dInstallation-Tasks.html | 4 +- manual/Profiling-Key-Operations.html | 2 +- manual/Template-Walkthrough.html | 10 +- manual/The-roam_002dref-protocol.html | 2 +- manual/Titles.html | 6 +- manual/Versioning-Notes.html | 2 +- manual/index.html | 31 +-- manual/mathpixel.html | 12 +- org-roam.org | 14 ++ org-roam.texi | 201 ++++++++++-------- 33 files changed, 337 insertions(+), 218 deletions(-) create mode 100644 manual/Finding-Unlinked-References.html diff --git a/manual/Appendix.html b/manual/Appendix.html index 6c67251..ea34dcf 100644 --- a/manual/Appendix.html +++ b/manual/Appendix.html @@ -67,7 +67,7 @@ Next: , Previous:
-

18 Appendix

+

19 Appendix

• Note-taking Workflows:   diff --git a/manual/Browsing-History-with-winner_002dmode.html b/manual/Browsing-History-with-winner_002dmode.html index 85f4c08..50c2afe 100644 --- a/manual/Browsing-History-with-winner_002dmode.html +++ b/manual/Browsing-History-with-winner_002dmode.html @@ -67,16 +67,16 @@ Next: -

18.2.1 Browsing History with winner-mode

+

19.2.1 Browsing History with winner-mode

winner-mode is a global minor mode that allows one to undo and redo changes in the window configuration. It is included with GNU Emacs since version 20.

winner-mode can be used as a simple version of browser history for Org-roam. Each click through org-roam links (from both Org files and the backlinks buffer) causes changes in window configuration, which can be undone and redone using winner-mode. To use winner-mode, simply enable it, and bind the appropriate interactive functions:

-
  (winner-mode +1)
-  (define-key winner-mode-map (kbd "<M-left>") #'winner-undo)
-  (define-key winner-mode-map (kbd "<M-right>") #'winner-redo)
+
(winner-mode +1)
+(define-key winner-mode-map (kbd "<M-left>") #'winner-undo)
+(define-key winner-mode-map (kbd "<M-right>") #'winner-redo)
diff --git a/manual/Diagnosing-and-Repairing-Files.html b/manual/Diagnosing-and-Repairing-Files.html index 3302929..292dd02 100644 --- a/manual/Diagnosing-and-Repairing-Files.html +++ b/manual/Diagnosing-and-Repairing-Files.html @@ -25,7 +25,7 @@ General Public License for more details. - + + + + + + + + +
+

+Next: , Previous: , Up: Top   [Contents]

+
+
+ +

17 Finding Unlinked References

+ +

Unlinked references are occurrences of strings of text that exactly match the +title or alias of an existing note in the Org-roam database. Org-roam provides +facilities for discovering these unlinked references, so one may decide whether +to convert them into links. +

+

To use this feature, simply call M-x org-roam-unlinked-references from within +an Org-roam note. Org-roam uses ripgrep, specifically a clever PCRE regex to +find occurrences of the title or aliases of the currently open note in all +Org-roam files. This thus requires a version of ripgrep that is compiled with +PCRE support. +

+ + + + + diff --git a/manual/Full_002dtext-search-interface-with-Deft.html b/manual/Full_002dtext-search-interface-with-Deft.html index 8d91fb5..b429d7b 100644 --- a/manual/Full_002dtext-search-interface-with-Deft.html +++ b/manual/Full_002dtext-search-interface-with-Deft.html @@ -67,20 +67,20 @@ Next: -

18.2.3 Full-text search interface with Deft

+

19.2.3 Full-text search interface with Deft

Deft provides a nice interface for browsing and filtering org-roam notes.

-
  (use-package deft
-    :after org
-    :bind
-    ("C-c n d" . deft)
-    :custom
-    (deft-recursive t)
-    (deft-use-filter-string-for-filename t)
-    (deft-default-extension "org")
-    (deft-directory "/path/to/org-roam-files/"))
+
(use-package deft
+  :after org
+  :bind
+  ("C-c n d" . deft)
+  :custom
+  (deft-recursive t)
+  (deft-use-filter-string-for-filename t)
+  (deft-default-extension "org")
+  (deft-directory "/path/to/org-roam-files/"))

If the title of the Org file is not the first line, you might not get @@ -89,29 +89,29 @@ functionality. Here I’m using el-patch:

-
  (use-package el-patch
-    :straight (:host github
-                     :repo "raxod502/el-patch"
-                     :branch "develop"))
+
(use-package el-patch
+  :straight (:host github
+                   :repo "raxod502/el-patch"
+                   :branch "develop"))
 
-  (eval-when-compile
-    (require 'el-patch))
+(eval-when-compile
+  (require 'el-patch))
 
-  (use-package deft
-    ;; same as above...
-    :config/el-patch
-    (defun deft-parse-title (file contents)
-      "Parse the given FILE and CONTENTS and determine the title.
-  If `deft-use-filename-as-title' is nil, the title is taken to
-  be the first non-empty line of the FILE.  Else the base name of the FILE is
-  used as title."
-      (el-patch-swap (if deft-use-filename-as-title
-                         (deft-base-filename file)
-                       (let ((begin (string-match "^.+$" contents)))
-                         (if begin
-                             (funcall deft-parse-title-function
-                                      (substring contents begin (match-end 0))))))
-                     (org-roam--get-title-or-slug file))))
+(use-package deft
+  ;; same as above...
+  :config/el-patch
+  (defun deft-parse-title (file contents)
+    "Parse the given FILE and CONTENTS and determine the title.
+If `deft-use-filename-as-title' is nil, the title is taken to
+be the first non-empty line of the FILE.  Else the base name of the FILE is
+used as title."
+    (el-patch-swap (if deft-use-filename-as-title
+                       (deft-base-filename file)
+                     (let ((begin (string-match "^.+$" contents)))
+                       (if begin
+                           (funcall deft-parse-title-function
+                                    (substring contents begin (match-end 0))))))
+                   (org-roam--get-title-or-slug file))))

The Deft interface can slow down quickly when the number of files get diff --git a/manual/Garbage-Collection.html b/manual/Garbage-Collection.html index 33bccfd..3abe9e1 100644 --- a/manual/Garbage-Collection.html +++ b/manual/Garbage-Collection.html @@ -67,7 +67,7 @@ Previous:

-

17.2 Garbage Collection

+

18.2 Garbage Collection

During the cache-build process, Org-roam generates a lot of in-memory data-structures (such as the Org file’s AST), which are discarded after use. These structures are garbage collected at regular intervals (see (elisp)info:elisp#Garbage Collection). @@ -78,7 +78,7 @@ operations. To reduce the number of garbage collection processes, one may set org-roam-db-gc-threshold to a high value (such as most-positive-fixnum):

-
  (setq org-roam-db-gc-threshold most-positive-fixnum)
+
(setq org-roam-db-gc-threshold most-positive-fixnum)
diff --git a/manual/Graphing.html b/manual/Graphing.html index a4736a7..d4c481a 100644 --- a/manual/Graphing.html +++ b/manual/Graphing.html @@ -112,10 +112,10 @@ compact graph layout.

If you are using WSL2 and would like to open the graph in Windows, you can use the second option to set the browser and network file path:

-
  (setq org-roam-graph-viewer
-      (lambda (file)
-        (let ((org-roam-graph-viewer "/mnt/c/Program Files/Mozilla Firefox/firefox.exe"))
-          (org-roam-graph--open (concat "file://///wsl$/Ubuntu" file)))))
+
(setq org-roam-graph-viewer
+    (lambda (file)
+      (let ((org-roam-graph-viewer "/mnt/c/Program Files/Mozilla Firefox/firefox.exe"))
+        (org-roam-graph--open (concat "file://///wsl$/Ubuntu" file)))))
diff --git a/manual/How-do-I-have-more-than-one-Org_002droam-directory_003f.html b/manual/How-do-I-have-more-than-one-Org_002droam-directory_003f.html index c3189c0..12fbc18 100644 --- a/manual/How-do-I-have-more-than-one-Org_002droam-directory_003f.html +++ b/manual/How-do-I-have-more-than-one-Org_002droam-directory_003f.html @@ -67,7 +67,7 @@ Next: -

19.1 How do I have more than one Org-roam directory?

+

20.1 How do I have more than one Org-roam directory?

Emacs supports directory-local variables, allowing the value of org-roam-directory to be different in different directories. It does this by @@ -78,8 +78,8 @@ variable using directory-local variables. This is what .dir-locals.el

-
    ((nil . ((org-roam-directory . ".")
-             (org-roam-db-location . "./org-roam.db"))))
+
((nil . ((org-roam-directory . ".")
+         (org-roam-db-location . "./org-roam.db"))))

All files within that directory will be treated as their own separate diff --git a/manual/How-do-I-migrate-from-Roam-Research_003f.html b/manual/How-do-I-migrate-from-Roam-Research_003f.html index 2a9ff95..ae1baf6 100644 --- a/manual/How-do-I-migrate-from-Roam-Research_003f.html +++ b/manual/How-do-I-migrate-from-Roam-Research_003f.html @@ -66,7 +66,7 @@ Previous: -

19.2 How do I migrate from Roam Research?

+

20.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.

diff --git a/manual/Installing-from-Apt.html b/manual/Installing-from-Apt.html index 87dc913..49f5a74 100644 --- a/manual/Installing-from-Apt.html +++ b/manual/Installing-from-Apt.html @@ -73,7 +73,7 @@ Next: -
  apt-get install elpa-org-roam
+
apt-get install elpa-org-roam
 

 
 
Org-roam will then be autoloaded into Emacs.
diff --git a/manual/Installing-from-MELPA.html b/manual/Installing-from-MELPA.html
index adaa4e7..96ddf67 100644
--- a/manual/Installing-from-MELPA.html
+++ b/manual/Installing-from-MELPA.html
@@ -79,9 +79,9 @@ archives to ‘package-archives’:
 
 
 

-
  (require 'package)
-  (add-to-list 'package-archives
-               '("melpa" . "http://melpa.org/packages/") t)
+
(require 'package)
+(add-to-list 'package-archives
+             '("melpa" . "http://melpa.org/packages/") t)
 

 
 
    
@@ -89,9 +89,9 @@ archives to ‘package-archives’:
 

 
 

-
  (require 'package)
-  (add-to-list 'package-archives
-               '("melpa-stable" . "http://stable.melpa.org/packages/") t)
+
(require 'package)
+(add-to-list 'package-archives
+             '("melpa-stable" . "http://stable.melpa.org/packages/") t)
 

 
 
Org-roam also depends on a recent version of Org, which can be obtained in Org’s
@@ -105,14 +105,14 @@ package repository (see 
-
  M-x package-refresh-contents RET
+
M-x package-refresh-contents RET
 

 
 
Once you have done that, you can install Org-roam and its dependencies
 using:
 

 

-
  M-x package-install RET org-roam RET
+
M-x package-install RET org-roam RET
 

 
 
Now see Post-Installation Tasks.
diff --git a/manual/Installing-from-the-Git-Repository.html b/manual/Installing-from-the-Git-Repository.html
index c2e2a7f..39dfcaf 100644
--- a/manual/Installing-from-the-Git-Repository.html
+++ b/manual/Installing-from-the-Git-Repository.html
@@ -114,7 +114,7 @@ Next: 
 
(require 'info)
 (add-to-list 'Info-default-directory-list
-             "/path/to/my/info/files")
+         "/path/to/my/info/files")
 

 
 
You can also use one of the default locations, such as:
diff --git a/manual/Note_002dtaking-Add_002dons.html b/manual/Note_002dtaking-Add_002dons.html
index 5e41430..18afbdc 100644
--- a/manual/Note_002dtaking-Add_002dons.html
+++ b/manual/Note_002dtaking-Add_002dons.html
@@ -67,7 +67,7 @@ Previous: 
-
18.2.5 Note-taking Add-ons

+
19.2.5 Note-taking Add-ons

 
 
These are some plugins that make note-taking in Org-mode more enjoyable.
 

diff --git a/manual/Note_002dtaking-Workflows.html b/manual/Note_002dtaking-Workflows.html
index 0fb485e..878cc6e 100644
--- a/manual/Note_002dtaking-Workflows.html
+++ b/manual/Note_002dtaking-Workflows.html
@@ -67,7 +67,7 @@ Next: ,
 
 

 
-
18.1 Note-taking Workflows

+
19.1 Note-taking Workflows

 
 

 
Books

diff --git a/manual/Org_002ddownload.html b/manual/Org_002ddownload.html
index 53b2434..5af55f5 100644
--- a/manual/Org_002ddownload.html
+++ b/manual/Org_002ddownload.html
@@ -76,12 +76,12 @@ Next: ,
 
 
Figure: org-download

 

-
  (use-package org-download
-    :after org
-    :bind
-    (:map org-mode-map
-          (("s-Y" . org-download-screenshot)
-           ("s-y" . org-download-yank))))
+
(use-package org-download
+  :after org
+  :bind
+  (:map org-mode-map
+        (("s-Y" . org-download-screenshot)
+         ("s-y" . org-download-yank))))
 

 
 
diff --git a/manual/Org_002djournal.html b/manual/Org_002djournal.html
index 499621e..468a7f4 100644
--- a/manual/Org_002djournal.html
+++ b/manual/Org_002djournal.html
@@ -67,7 +67,7 @@ Next: 
 

 
-
18.2.4 Org-journal

+
19.2.4 Org-journal

 
 
Org-journal is a more
 powerful alternative to the simple function org-roam-dailies-today. It
@@ -75,14 +75,14 @@ provides better journaling capabilities, and a nice calendar interface
 to see all dated entries.
 

 

-
  (use-package org-journal
-    :bind
-    ("C-c n j" . org-journal-new-entry)
-    :custom
-    (org-journal-date-prefix "#+title: ")
-    (org-journal-file-format "%Y-%m-%d.org")
-    (org-journal-dir "/path/to/org-roam-files/")
-    (org-journal-date-format "%A, %d %B %Y"))
+
(use-package org-journal
+  :bind
+  ("C-c n j" . org-journal-new-entry)
+  :custom
+  (org-journal-date-prefix "#+title: ")
+  (org-journal-file-format "%Y-%m-%d.org")
+  (org-journal-dir "/path/to/org-roam-files/")
+  (org-journal-date-format "%A, %d %B %Y"))
 

 
 
diff --git a/manual/Org_002droam-Completion-System.html b/manual/Org_002droam-Completion-System.html
index a8fb0dc..2a16c11 100644
--- a/manual/Org_002droam-Completion-System.html
+++ b/manual/Org_002droam-Completion-System.html
@@ -74,7 +74,7 @@ its interactive commands. The default setting uses Emacs’ standard
 completing-read mechanism.
 

 

-
  (setq org-roam-completion-system 'default)
+
(setq org-roam-completion-system 'default)
 

 
 
If you have installed Helm or Ivy, and have their modes enabled, under the
@@ -84,7 +84,7 @@ its interactive commands. The default setting uses Emacs’ standard
 commands, set:
 

 

-
  (setq org-roam-completion-system 'helm)
+
(setq org-roam-completion-system 'helm)
 

 
 
Other options include 'ido, and 'ivy.
diff --git a/manual/Org_002droam-Template-Expansion.html b/manual/Org_002droam-Template-Expansion.html
index 12edbb0..738e0ee 100644
--- a/manual/Org_002droam-Template-Expansion.html
+++ b/manual/Org_002droam-Template-Expansion.html
@@ -96,11 +96,11 @@ advantage of org-mode’s %(EXP) template expansion to call 
 

-
  ("d" "default" plain (function org-roam--capture-get-point)
-       "%?"
-       :file-name "%(format-time-string \"%Y-%m-%d--%H-%M-%SZ--${slug}\" (current-time) t)"
-       :head "#+title: ${title}\n"
-       :unnarrowed t)
+
("d" "default" plain (function org-roam--capture-get-point)
+     "%?"
+     :file-name "%(format-time-string \"%Y-%m-%d--%H-%M-%SZ--${slug}\" (current-time) t)"
+     :head "#+title: ${title}\n"
+     :unnarrowed t)
 

 
 
diff --git a/manual/Performance-Optimization.html b/manual/Performance-Optimization.html
index ede903e..6eed3c3 100644
--- a/manual/Performance-Optimization.html
+++ b/manual/Performance-Optimization.html
@@ -26,7 +26,7 @@ General Public License for more details.
 
 
 
-
+