From 0ad4a6c303cb13a2f2efacadd5a5f19204a48d10 Mon Sep 17 00:00:00 2001 From: dustinfarris Date: Tue, 18 Feb 2025 17:32:34 +0000 Subject: [PATCH] =?UTF-8?q?Deploying=20to=20gh-pages=20from=20=20@=200037d?= =?UTF-8?q?aaf3eb2d1c3a1c215efb4d38a32db140224=20=F0=9F=9A=80?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- manual.html | 43 ++++--------------------------------------- org-roam.org | 42 +++--------------------------------------- org-roam.texi | 44 ++++---------------------------------------- 3 files changed, 11 insertions(+), 118 deletions(-) diff --git a/manual.html b/manual.html index 9a4121d..c3fbdce 100644 --- a/manual.html +++ b/manual.html @@ -343,7 +343,6 @@ dependencies that it requires. These include:
  • s
  • org
  • emacsql -
  • emacsql-sqlite
  • magit-section
    • @@ -625,43 +624,9 @@ Next: , Up: <

    6.1 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 -emacs-sqlite-builtin. Below the pros and cons of each package is used: +

    Org-roam uses a SQLite database to perform caching. This integration is +managed by the emacsql library. It should “just work”.

    -

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

    -
    -
    (setq org-roam-database-connector 'sqlite-builtin)
-
    - -

    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 Chris Wellon’s blog post for more information. -

    -

    To use emacsql-sqlite3, ensure that the package is installed, and set: -

    -
    -
    (setq org-roam-database-connector 'sqlite3)
-
    - -

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

    -
    -
    (setq org-roam-database-connector 'sqlite-module)
-
    -
    @@ -689,8 +654,8 @@ 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:

    -
    -
    (setq org-roam-db-node-include-function
+
    
+
    (setq org-roam-db-node-include-function
       (lambda ()
         (not (member "ATTACH" (org-get-tags)))))
 
    
diff --git a/org-roam.org b/org-roam.org
index 9a268b6..34e1629 100644
--- a/org-roam.org
+++ b/org-roam.org
@@ -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)))))
diff --git a/org-roam.texi b/org-roam.texi
index dbf4f5f..d6b84e2 100644
--- a/org-roam.texi
+++ b/org-roam.texi
@@ -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