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

Deploying to gh-pages from @ 0037daaf3e 🚀

Browse Source
This commit is contained in:
dustinfarris
2025-02-18 17:32:34 +00:00
parent 795f76df56
commit 0ad4a6c303
3 changed files with 11 additions and 118 deletions
Download Patch File Download Diff File Expand all files Collapse all files

43
manual.html
View File

@@ -343,7 +343,6 @@ dependencies that it requires. These include:
</li><li>s
</li><li>org
</li><li>emacsql
</li><li>emacsql-sqlite
</li><li>magit-section
</li></ul>
@@ -625,43 +624,9 @@ Next: <a href="#What-to-cache" accesskey="n" rel="next">What to cache</a>, Up: <
</div>
<h3 class="section" id="How-to-cache-1"><span>6.1 How to cache<a class="copiable-link" href="#How-to-cache-1"> &para;</a></span></h3>
<p>Org-roam uses a sqlite database to perform caching, but there are multiple Emacs
libraries that can be used. The default used by Org-roam is
<a class="uref" href="https://github.com/magit/emacsql/blob/main/emacsql-sqlite-builtin.el"><code class="code">emacs-sqlite-builtin</code></a>. Below the pros and cons of each package is used:
<p>Org-roam uses a SQLite database to perform caching. This integration is
managed by the <a class="uref" href="https://github.com/magit/emacsql">emacsql</a> library. It should &ldquo;just work&rdquo;.
</p>
<p><a class="uref" href="https://melpa.org/#/emacsql-sqlite-builtin"><strong class="strong"><strong class="strong">emacsql-sqlite-builtin</strong></strong></a>
</p>
<p><code class="code">emacsql-sqlite-builtin</code> uses the in-built SQLite support for Emacs 29 and
later. This is the default option if you are using a version of Emacs that
supports it.
</p>
<div class="example lisp">
<pre class="lisp-preformatted">(setq org-roam-database-connector 'sqlite-builtin)
</pre></div>
<p><a class="uref" href="https://github.com/cireu/emacsql-sqlite3"><strong class="strong"><strong class="strong">emacs-sqlite3</strong></strong></a>
</p>
<p><code class="code">emacs-sqlite3</code> uses the official sqlite3 binary that can be obtained from your
system&rsquo;s package manager. This is useful if you have issues producing the
<code class="code">sqlite3</code> binary required by the other packages. However, it is not recommended
because it has some compatibility issues with Emacs, but should work for most
regular cases. See <a class="uref" href="https://nullprogram.com/blog/2014/02/06/">Chris Wellon&rsquo;s blog post</a> for more information.
</p>
<p>To use <code class="code">emacsql-sqlite3</code>, ensure that the package is installed, and set:
</p>
<div class="example lisp">
<pre class="lisp-preformatted">(setq org-roam-database-connector 'sqlite3)
</pre></div>
<p><a class="uref" href="https://melpa.org/#/emacsql-sqlite-module"><strong class="strong"><strong class="strong">emacssql-sqlite-module</strong></strong></a> (previously emacsql-libsqlite3)
</p>
<p><code class="code">emacs-sqlite-module</code> is a relatively young package which uses an Emacs module that
exposes parts of the SQLite C API to Emacs Lisp.
</p>
<div class="example lisp">
<pre class="lisp-preformatted">(setq org-roam-database-connector 'sqlite-module)
</pre></div>
<hr>
</div>
<div class="section-level-extent" id="What-to-cache">
@@ -689,8 +654,8 @@ property to a non-nil value. For example:
<p>One can also set <code class="code">org-roam-db-node-include-function</code>. For example, to exclude
all headlines with the <code class="code">ATTACH</code> tag from the Org-roam database, one can set:
</p>
<div class="example">
<pre class="example-preformatted">(setq org-roam-db-node-include-function
<div class="example lisp">
<pre class="lisp-preformatted">(setq org-roam-db-node-include-function
(lambda ()
(not (member &quot;ATTACH&quot; (org-get-tags)))))
</pre></div>

42
org-roam.org
View File

@@ -224,7 +224,6 @@ dependencies that it requires. These include:
- s
- org
- emacsql
- emacsql-sqlite
- magit-section
You can install this manually as well, or get the latest version from MELPA. You
@@ -423,43 +422,8 @@ can set ~org-roam-node-display-template~ as such:
* Customizing Node Caching
** How to cache
Org-roam uses a sqlite database to perform caching, but there are multiple Emacs
libraries that can be used. The default used by Org-roam is
[[https://github.com/magit/emacsql/blob/main/emacsql-sqlite-builtin.el][~emacs-sqlite-builtin~]]. Below the pros and cons of each package is used:
[[https://melpa.org/#/emacsql-sqlite-builtin][**emacsql-sqlite-builtin**]]
~emacsql-sqlite-builtin~ uses the in-built SQLite support for Emacs 29 and
later. This is the default option if you are using a version of Emacs that
supports it.
#+begin_src emacs-lisp
(setq org-roam-database-connector 'sqlite-builtin)
#+end_src
[[https://github.com/cireu/emacsql-sqlite3][**emacs-sqlite3**]]
~emacs-sqlite3~ uses the official sqlite3 binary that can be obtained from your
system's package manager. This is useful if you have issues producing the
~sqlite3~ binary required by the other packages. However, it is not recommended
because it has some compatibility issues with Emacs, but should work for most
regular cases. See [[https://nullprogram.com/blog/2014/02/06/][Chris Wellon's blog post]] for more information.
To use ~emacsql-sqlite3~, ensure that the package is installed, and set:
#+begin_src emacs-lisp
(setq org-roam-database-connector 'sqlite3)
#+end_src
[[https://melpa.org/#/emacsql-sqlite-module][**emacssql-sqlite-module**]] (previously emacsql-libsqlite3)
~emacs-sqlite-module~ is a relatively young package which uses an Emacs module that
exposes parts of the SQLite C API to Emacs Lisp.
#+begin_src emacs-lisp
(setq org-roam-database-connector 'sqlite-module)
#+end_src
Org-roam uses a SQLite database to perform caching. This integration is
managed by the [[https://github.com/magit/emacsql][emacsql]] library. It should "just work".
** What to cache
@@ -481,7 +445,7 @@ property to a non-nil value. For example:
One can also set ~org-roam-db-node-include-function~. For example, to exclude
all headlines with the ~ATTACH~ tag from the Org-roam database, one can set:
#+begin_src org
#+begin_src emacs-lisp
(setq org-roam-db-node-include-function
(lambda ()
(not (member "ATTACH" (org-get-tags)))))

44
org-roam.texi
View File

@@ -441,8 +441,6 @@ org
@item
emacsql
@item
emacsql-sqlite
@item
magit-section
@end itemize
@@ -685,42 +683,8 @@ can set @code{org-roam-node-display-template} as such:
@node How to cache
@section How to cache
Org-roam uses a sqlite database to perform caching, but there are multiple Emacs
libraries that can be used. The default used by Org-roam is
@uref{https://github.com/magit/emacsql/blob/main/emacsql-sqlite-builtin.el, @code{emacs-sqlite-builtin}}. Below the pros and cons of each package is used:
@uref{https://melpa.org/#/emacsql-sqlite-builtin, @strong{@strong{emacsql-sqlite-builtin}}}
@code{emacsql-sqlite-builtin} uses the in-built SQLite support for Emacs 29 and
later. This is the default option if you are using a version of Emacs that
supports it.
@lisp
(setq org-roam-database-connector 'sqlite-builtin)
@end lisp
@uref{https://github.com/cireu/emacsql-sqlite3, @strong{@strong{emacs-sqlite3}}}
@code{emacs-sqlite3} uses the official sqlite3 binary that can be obtained from your
system's package manager. This is useful if you have issues producing the
@code{sqlite3} binary required by the other packages. However, it is not recommended
because it has some compatibility issues with Emacs, but should work for most
regular cases. See @uref{https://nullprogram.com/blog/2014/02/06/, Chris Wellon's blog post} for more information.
To use @code{emacsql-sqlite3}, ensure that the package is installed, and set:
@lisp
(setq org-roam-database-connector 'sqlite3)
@end lisp
@uref{https://melpa.org/#/emacsql-sqlite-module, @strong{@strong{emacssql-sqlite-module}}} (previously emacsql-libsqlite3)
@code{emacs-sqlite-module} is a relatively young package which uses an Emacs module that
exposes parts of the SQLite C API to Emacs Lisp.
@lisp
(setq org-roam-database-connector 'sqlite-module)
@end lisp
Org-roam uses a SQLite database to perform caching. This integration is
managed by the @uref{https://github.com/magit/emacsql, emacsql} library. It should ``just work''.
@node What to cache
@section What to cache
@@ -743,11 +707,11 @@ property to a non-nil value. For example:
One can also set @code{org-roam-db-node-include-function}. For example, to exclude
all headlines with the @code{ATTACH} tag from the Org-roam database, one can set:
@example
@lisp
(setq org-roam-db-node-include-function
(lambda ()
(not (member "ATTACH" (org-get-tags)))))
@end example
@end lisp
Org-roam relied on the obtained Org AST for the buffer to parse links. However,
links appearing in some places (e.g. within property drawers) are not considered