Org-roam

https://www.orgroam.com/manual.html
Admin
Org-roam is a tool for networked thought and non-hierarchical note-taking, implementing the...
Tokens:16,740
Snippets:139
Trust Score:9.1
Update:9 months ago
Show doc for...
Tokens:
Raw
### Example Org File with Nodes and IDs

Source: https://www.orgroam.com/manual.html/index

An example Org file demonstrating how to define properties, including an ID, for file and headline nodes. This illustrates the structure of an Org-roam node.

```org
:PROPERTIES:
:ID:       foo
:END:
#+title: Foo

* Bar
:PROPERTIES:
:ID:       bar
:END:

```

--------------------------------

### Compile and Install Org-roam Info Documentation

Source: https://www.orgroam.com/manual.html/index

Navigates to the 'doc' subdirectory of the Org-roam repository and compiles the .texi source file into an info file, installing it to a specified directory. Requires 'make'.

```bash
make infodir=/path/to/my/info/files install-info
```

--------------------------------

### Install Org-roam Info File

Source: https://www.orgroam.com/manual.html/index

Installs the compiled Org-roam info file into the appropriate directory, updating the 'dir' file for Emacs's Info system. This command is run after compiling the info file.

```bash
install-info /path/to/my/info/files/org-roam.info /path/to/my/info/files/dir
```

--------------------------------

### Clone Org-roam Repository

Source: https://www.orgroam.com/manual.html/index

Clones the Org-roam repository from GitHub to a specified local path. This is the first step in installing Org-roam from source.

```bash
git clone https://github.com/org-roam/org-roam.git /path/to/org/roam
```

--------------------------------

### Install Org-roam via Emacs Package Manager

Source: https://www.orgroam.com/manual.html/index

This Emacs Lisp command installs the Org-roam package and its dependencies using the built-in package manager. Ensure that the necessary package archives (like MELPA) have been added to your Emacs configuration first.

```emacs-lisp
M-x package-install RET org-roam RET
```

--------------------------------

### Register Org Protocol for Windows

Source: https://www.orgroam.com/manual.html/index

Creates a .reg file to register the org-protocol for Windows. This allows Emacsclient to handle 'org-protocol://' URLs, forwarding them to WSL or a native Emacs installation.

```reg
REGEDIT4

[HKEY_CLASSES_ROOT\org-protocol]
@="URL:Org Protocol"
"URL Protocol"=""
[HKEY_CLASSES_ROOT\org-protocol\shell]
[HKEY_CLASSES_ROOT\org-protocol\shell\open]
[HKEY_CLASSES_ROOT\org-protocol\shell\open\command]
@="""C:\\Windows\\System32\\wsl.exe"" emacsclient "%1""
```

```reg
@="""c:\\path\\to\\emacs\\bin\\emacsclientw.exe""  "%1""
```

--------------------------------

### Extend Org-roam Capture System

Source: https://www.orgroam.com/manual.html/index

Provides an example of extending the Org-roam capture system using the org-roam-capture- function. This function serves as the main entry point for capturing new notes, allowing customization of goto behavior, node creation, templates, and properties.

```emacs-lisp
(defun org-roam-dailies--capture (time &optional goto)
  "Capture an entry in a daily-note for TIME, creating it if necessary.

When GOTO is non-nil, go the note without creating an entry."
  (org-roam-capture- :goto (when goto '(4))
                     :node (org-roam-node-create)
                     :templates org-roam-dailies-capture-templates
                     :props (list :override-default-time time))
  (when goto (run-hooks 'org-roam-dailies-find-file-hook)))

```

--------------------------------

### Add Ref to Org-roam Node (Org Mode)

Source: https://www.orgroam.com/manual.html/index

Example of how to add a reference URL to a node titled 'Google' using Org-roam's properties.

```org
* Google
:PROPERTIES:
:ROAM_REFS: https://www.google.com/
:END:

```

--------------------------------

### Org-roam Encrypted Capture Template

Source: https://www.orgroam.com/manual.html/index

Example of an Org-roam capture template configured to create encrypted files by appending the '.gpg' extension. This ensures captured notes are stored securely.

```emacs-lisp
(setq org-roam-capture-templates '(("d" "default" plain "%?"
     :target (file+head "${slug}.org.gpg"
                        "#+title: ${title}\n")
     :unnarrowed t)))


```

--------------------------------

### Configure Emacs Info Default Directory List

Source: https://www.orgroam.com/manual.html/index

Adds a custom directory to Emacs's Info-default-directory-list if Org-roam's info files are installed in a non-default location. Requires the 'info' library.

```emacs-lisp
(require 'info)
(add-to-list 'Info-default-directory-list
             "/path/to/my/info/files")
```

--------------------------------

### Configure Deft for Full-Text Search in Org-roam

Source: https://www.orgroam.com/manual.html/index

This Emacs Lisp code configures the Deft package for efficient full-text searching within Org-roam notes. It sets Deft to recursively search the Org-roam directory and use the filename as a filter string. Ensure Deft is installed and Org-roam is properly set up.

```emacs-lisp
(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 org-roam-directory))
```

--------------------------------

### Configure Org-roam Buffer Display in a Regular Window (Emacs Lisp)

Source: https://www.orgroam.com/manual.html/index

Configures the Org-roam buffer to display in a regular window to the right, occupying 33% of the window width. This setup allows for predictable navigation using RET and C-u RET.

```emacs-lisp
(add-to-list 'display-buffer-alist
             '("\\*org-roam\\*"
               (display-buffer-in-direction)
               (direction . right)
               (window-width . 0.33)
               (window-height . fit-window-to-buffer)))

```

--------------------------------

### Configure Org-roam Node Inclusion Function

Source: https://www.orgroam.com/manual.html/index

Sets a custom function to determine which nodes should be included in the Org-roam database. This example excludes all headlines tagged with `ATTACH` by checking the current node's tags.

```emacs-lisp
(setq org-roam-db-node-include-function
      (lambda ()
        (not (member "ATTACH" (org-get-tags)))))

```

--------------------------------

### Add Alias to Org-roam Node (Org Mode)

Source: https://www.orgroam.com/manual.html/index

Example of how to add an alias 'AI' to a node titled 'Artificial Intelligence' using Org-roam's properties.

```org
* Artificial Intelligence
:PROPERTIES:
:ROAM_ALIASES: AI
:END:

```

--------------------------------

### Filter Backlinks in Org-roam Buffer

Source: https://www.orgroam.com/manual.html/index

Configures the Org-roam buffer to filter backlinks based on a custom predicate function. This example excludes backlinks from nodes tagged with 'daily'.

```emacs-lisp
(defun my-org-roam-show-backlink-p (backlink)
  (not (member "daily" (org-roam-node-tags (org-roam-backlink-source-node backlink)))))

(setq org-roam-mode-sections
      '((org-roam-backlinks-section :unique t :show-backlink-p my-org-roam-show-backlink-p)
        org-roam-reflinks-section))
```

--------------------------------

### macOS: Alternative AppleScript for Emacs Mac Port

Source: https://www.orgroam.com/manual.html/index

This is an alternative AppleScript for macOS users of Emacs Mac Port, specifically when Emacs is started with the '--daemon' option. It modifies the emacsclient command to include the '-c' flag.

```applescript
on open location this_URL
    set EC to "/usr/local/bin/emacsclient -c --no-wait "
    set filePath to quoted form of this_URL
    do shell script EC & filePath & " &> /dev/null &"
    tell application "Emacs" to activate
end open location

```

--------------------------------

### Customize Org-roam Node Display Template

Source: https://www.orgroam.com/manual.html/index

Configures the display format for Org-roam nodes, allowing interpolation of node fields like title and tags. Supports length specifiers for alignment and trimming. Can also use closures for dynamic templates. This example shows how to align title and tags in a tabular format for vertical completion frameworks.

```emacs-lisp
(setq org-roam-node-display-template
      (concat "${title:*} "
              (propertize "${tags:10}" 'face 'org-tag)))
```

--------------------------------

### Add MELPA-Stable Package Archive to Emacs

Source: https://www.orgroam.com/manual.html/index

This Elisp code snippet adds the MELPA-Stable package archive to your Emacs configuration. It requires the 'package' library and appends a new archive entry for MELPA-Stable. This is an alternative to MELPA for installing packages.

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

--------------------------------

### Add MELPA Package Archive to Emacs

Source: https://www.orgroam.com/manual.html/index

This Elisp code snippet adds the MELPA package archive to your Emacs configuration. It requires the 'package' library and appends a new archive entry for MELPA. This is a prerequisite for installing packages from MELPA.

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

--------------------------------

### Linux: Configure Org-Protocol Desktop Entry and Chrome Policy

Source: https://www.orgroam.com/manual.html/index

This snippet demonstrates how to create a desktop entry for Org-Protocol on Linux and configure Chrome to automatically open links with the handler. It involves creating a .desktop file and a JSON policy file for Chrome.

```shell
[Desktop Entry]
Name=Org-Protocol
Exec=emacsclient %u
Icon=emacs-icon
Type=Application
Terminal=false
MimeType=x-scheme-handler/org-protocol

```

```shell
xdg-mime default org-protocol.desktop x-scheme-handler/org-protocol

```

```shell
sudo mkdir -p /etc/opt/chrome/policies/managed/
sudo tee /etc/opt/chrome/policies/managed/external_protocol_dialog.json >/dev/null <<'EOF'
{
  "ExternalProtocolDialogShowAlwaysOpenCheckbox": true
}
EOF
sudo chmod 644 /etc/opt/chrome/policies/managed/external_protocol_dialog.json

```

--------------------------------

### macOS: Test Org-Protocol Handler Registration

Source: https://www.orgroam.com/manual.html/index

This snippet shows how to test if the Org-Protocol handler is correctly set up and registered on macOS by opening a sample URL from the command line. It also includes a command for manually registering the handler if needed.

```shell
open org-protocol://roam-ref\?template=r\&ref=test\&title=this

```

```shell
/System/Library/Frameworks/CoreServices.framework/Versions/A/Frameworks/LaunchServices.framework/Versions/A/Support/lsregister -R  -f /Applications/OrgProtocolClient.app

```

--------------------------------

### Configure Qutebrowser Keybinding for roam-ref

Source: https://www.orgroam.com/manual.html/index

Configures a keybinding in qutebrowser to trigger the roam-ref protocol. This allows quick creation of notes referencing the current page.

```python
config.bind("<Ctrl-r>", "open javascript:location.href='org-protocol://roam-ref?template=r&ref='+encodeURIComponent(location.href)+'&title='+encodeURIComponent(document.title)")
```

--------------------------------

### Configure Org-mode for Publishing Org-roam Notes

Source: https://www.orgroam.com/manual.html/index

Sets up org-mode to publish org-roam notes as a project, including sitemap generation and custom publishing functions. It defines a project in `org-publish-project-alist` to handle the export process.

```emacs-lisp
(defun roam-sitemap (title list)
  (concat "#+OPTIONS: ^:nil author:nil html-postamble:nil\n"
          "#+SETUPFILE: ./simple_inline.theme\n"
          "#+TITLE: " title "\n\n"
          (org-list-to-org list) "\nfile:sitemap.svg"))

(setq my-publish-time 0)   ; see the next section for context
(defun roam-publication-wrapper (plist filename pubdir)
  (org-roam-graph)
  (org-html-publish-to-html plist filename pubdir)
  (setq my-publish-time (cadr (current-time))))

(setq org-publish-project-alist
  '(("roam"
     :base-directory "~/roam"
     :auto-sitemap t
     :sitemap-function roam-sitemap
     :sitemap-title "Roam notes"
     :publishing-function roam-publication-wrapper
     :publishing-directory "~/roam-export"
     :section-number nil
     :table-of-contents nil
     :style "<link rel=\"stylesheet\" href=\"../other/mystyle.cs\" type=\"text/css\">")))

```

--------------------------------

### Create and Insert Org-roam Node Link

Source: https://www.orgroam.com/manual.html/index

Provides functions to create new notes (nodes) and insert links to them. `org-roam-node-insert` creates a node if it doesn't exist and inserts a link at the cursor. `org-roam-node-find` creates or visits an existing node. `org-roam-capture` creates a node and restores window configuration.

```emacs-lisp
(org-roam-node-insert)
```

```emacs-lisp
(org-roam-node-find)
```

```emacs-lisp
(org-roam-capture)
```

--------------------------------

### Org-roam Default Capture Template Structure

Source: https://www.orgroam.com/manual.html/index

Demonstrates the structure of a default Org-roam capture template, highlighting key elements like the short key, description, target specification, and cursor positioning.

```emacs-lisp
(("d" "default" plain "%?"
  :target (file+head "%<%Y%m%d%H%M%S>-${slug}.org"
                     "#+title: ${title}\n")
  :unnarrowed t))
```

--------------------------------

### Configure Org-roam Daily Notes Directory and Capture Templates

Source: https://www.orgroam.com/manual.html/index

Sets the directory for daily notes and defines capture templates for creating new daily entries. The capture template includes a title and a date format.

```emacs-lisp
(setq org-roam-dailies-directory "daily/")

(setq org-roam-dailies-capture-templates
      '(("d" "default" entry
         "* %?"
         :target (file+head "%<%Y-%m-%d>.org"
                            "#+title: %<%Y-%m-%d>\n"))))
```

--------------------------------

### Configure Multiple Org-roam Directories with .dir-locals.el

Source: https://www.orgroam.com/manual.html/index

This configuration uses Emacs' directory-local variables to set different Org-roam directories and database locations for specific subdirectories. It requires absolute paths for `org-roam-directory` and `org-roam-db-location`. Ensure `org-roam-db-sync` is run at least once within the new directory.

```emacs-lisp
((nil . ((org-roam-directory . "/path/to/alt/org-roam-dir")
         (org-roam-db-location . "/path/to/alt/org-roam-dir/org-roam.db"))))
```

```emacs-lisp
((nil . ((eval . (setq-local
                  org-roam-directory (expand-file-name (locate-dominating-file
                                                        default-directory ".dir-locals.el"))))
         (eval . (setq-local
                  org-roam-db-location (expand-file-name "org-roam.db"
                                                         org-roam-directory))))))
```

--------------------------------

### Create Bookmarklet for roam-ref Protocol

Source: https://www.orgroam.com/manual.html/index

A JavaScript bookmarklet to create a new note with a given ROAM_REFS. It captures the current URL, title, and selection to populate the new note.

```javascript
javascript:location.href =
    'org-protocol://roam-ref?template=r&ref='
    + encodeURIComponent(location.href)
    + '&title='
    + encodeURIComponent(document.title)
    + '&body='
    + encodeURIComponent(window.getSelection())
```

--------------------------------

### macOS: Create Org-Protocol Application with AppleScript

Source: https://www.orgroam.com/manual.html/index

This snippet shows how to create a macOS application using AppleScript to handle the 'org-protocol' URL scheme. It includes the AppleScript code for opening URLs and instructions for saving and configuring the application.

```applescript
on open location this_URL
    set EC to "/usr/local/bin/emacsclient --no-wait "
    set filePath to quoted form of this_URL
    do shell script EC & filePath & " &> /dev/null &"
    tell application "Emacs" to activate
end open location

```

--------------------------------

### Require Org-roam Protocol Extension

Source: https://www.orgroam.com/manual.html/index

Shows how to load the 'org-roam-protocol' extension in your Emacs init file. This is necessary to enable Org-roam's integration with external applications via org-protocol.

```emacs-lisp
(require 'org-roam-protocol)
```

--------------------------------

### Configure mathpix.el for LaTeX Conversion in Emacs

Source: https://www.orgroam.com/manual.html/index

This Emacs Lisp configuration sets up the mathpix.el package to convert screenshots into LaTeX equations using the Mathpix API. It requires you to provide your Mathpix App ID and App Key. The screenshot function is bound to a key combination.

```emacs-lisp
(use-package mathpix.el
  :straight (:host github :repo "jethrokuan/mathpix.el")
  :custom ((mathpix-app-id "app-id")
           (mathpix-app-key "app-key"))
  :bind
  ("C-x m" . mathpix-screenshot))
```

--------------------------------

### macOS: Configure Chrome and LaunchServices for Org-Protocol

Source: https://www.orgroam.com/manual.html/index

This snippet provides shell commands for configuring Chrome and macOS LaunchServices to use a custom application as the default handler for the 'org-protocol' URL scheme. It includes commands for setting Chrome policies and updating LSHandlers.

```shell
defaults write com.google.Chrome ExternalProtocolDialogShowAlwaysOpenCheckbox -bool true

```

```shell
defaults write com.apple.LaunchServices/com.apple.launchservices.secure LSHandlers -array-add \
'{"LSHandlerPreferredVersions" = { "LSHandlerRoleAll" = "-"; }; LSHandlerRoleAll = "org.yourusername.OrgProtocol"; LSHandlerURLScheme = "org-protocol";}'

```

--------------------------------

### Configure Org-roam Buffer Sections

Source: https://www.orgroam.com/manual.html/index

Configures which sections are displayed in the Org-roam buffer. By default, backlinks and reference links are shown. Unlinked references can be included but may be slow to compute.

```emacs-lisp
(setq org-roam-mode-sections
      (list #'org-roam-backlinks-section
            #'org-roam-reflinks-section
            ;; #'org-roam-unlinked-references-section
            ))
```

--------------------------------

### Configure Org-download for Image Handling in Emacs

Source: https://www.orgroam.com/manual.html/index

This Emacs Lisp code configures the Org-download package, enabling screenshotting and yanking images from the web directly into Org-mode notes. It binds the screenshot and yank functions to specific key combinations within the Org mode map.

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

--------------------------------

### Configure Emacs Load Path and Require Org-roam

Source: https://www.orgroam.com/manual.html/index

Adds the cloned Org-roam directory to Emacs's load path and then requires the Org-roam library. This allows Emacs to find and load Org-roam.

```emacs-lisp
(add-to-list 'load-path "/path/to/org/roam")
(require 'org-roam)
```

--------------------------------

### Configure Org-roam Directory

Source: https://www.orgroam.com/manual.html/index

Sets the directory where Org-roam will store its notes. It's recommended to use `file-truename` if symbolic links are present within the directory, though this may incur a performance cost. This configuration must be done before using Org-roam functions.

```emacs-lisp
(make-directory "~/org-roam")
(setq org-roam-directory (file-truename "~/org-roam"))
```

--------------------------------

### Define Custom Org-roam Node Accessor

Source: https://www.orgroam.com/manual.html/index

Demonstrates how to define a custom accessor function for Org-roam nodes using `cl-defmethod`. This allows for custom data extraction or formatting that can then be referenced in node display templates or capture templates.

```emacs-lisp
(cl-defmethod org-roam-node-my-title ((node org-roam-node)) (concat "My " (org-roam-node-title node)))
```

--------------------------------

### Configure Winner-mode for Org-roam Link Navigation

Source: https://www.orgroam.com/manual.html/index

Enables `winner-mode` for undo/redo functionality in window configurations, acting as a browser history for Org-roam links. It binds Alt-Left and Alt-Right to `winner-undo` and `winner-redo` respectively.

```emacs-lisp
(winner-mode +1)
(define-key winner-mode-map (kbd "<M-left>") #'winner-undo)
(define-key winner-mode-map (kbd "<M-right>") #'winner-redo)
```

--------------------------------

### macOS: Configure Info.plist for Org-Protocol Handler

Source: https://www.orgroam.com/manual.html/index

This snippet illustrates how to modify the Info.plist file of a macOS application to register it as a handler for the 'org-protocol' URL scheme. It involves adding a CFBundleURLTypes entry.

```xml
<key>CFBundleURLTypes</key>
<array>
  <dict>
    <key>CFBundleURLName</key>
    <string>org-protocol handler</string>
    <key>CFBundleURLSchemes</key>
    <array>
      <string>org-protocol</string>
    </array>
  </dict>
</array>

```

--------------------------------

### Configure Org-roam Buffer Display in a Side Window (Emacs Lisp)

Source: https://www.orgroam.com/manual.html/index

Configures the Org-roam buffer to display in a dedicated side window on the right, using 33% of the window width. It prevents the side window from being deleted.

```emacs-lisp
(add-to-list 'display-buffer-alist
             '("\\*org-roam\\*"
               (display-buffer-in-side-window)
               (side . right)
               (slot . 0)
               (window-width . 0.33)
               (window-parameters . ((no-other-window . t)
                                     (no-delete-other-windows . t)))))

```

--------------------------------

### Configure Org-roam Graph Viewer for WSL2

Source: https://www.orgroam.com/manual.html/index

Sets a custom function for `org-roam-graph-viewer` to open graphs using Firefox on Windows when using WSL2. It handles the path conversion for network file access.

```emacs-lisp
(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)))))
```

--------------------------------

### Query Org-roam Database

Source: https://www.orgroam.com/manual.html/index

This snippet demonstrates how to query the Org-roam database using the `org-roam-db-query` function. It allows for SQL-like operations on the note data. Extensions should exclusively use `org-roam-db-query` for database access to ensure robustness against future Org-roam updates.

```emacs-lisp
(org-roam-db-query [:select * :from nodes])
```

--------------------------------

### Override Org-roam Default Link Builder for HTML Links

Source: https://www.orgroam.com/manual.html/index

Replaces the default org-protocol link creation with a function that generates links to the corresponding HTML files. This ensures that published notes link to their HTML versions instead of using local protocols.

```emacs-lisp
(defun org-roam-custom-link-builder (node)
  (let ((file (org-roam-node-file node)))
    (concat (file-name-base file) ".html")))

(setq org-roam-graph-link-builder 'org-roam-custom-link-builder)

```

--------------------------------

### org-protocol://roam-ref

Source: https://www.orgroam.com/manual.html/index

Finds or creates a new note with a given ROAM_REFS. Used for creating bookmarklets and keybindings.

```APIDOC
## GET /org-protocol/roam-ref

### Description
Finds or creates a new note with a given `ROAM_REFS`. This protocol is useful for creating bookmarklets and keybindings to capture information from other sources.

### Method
GET

### Endpoint
`/org-protocol/roam-ref`

### Parameters
#### Query Parameters
- **template** (string) - Optional - The template key for a template in `org-roam-capture-ref-templates`.
- **ref** (string) - Required - The reference URL to capture.
- **title** (string) - Required - The title of the page to capture.
- **body** (string) - Optional - The selected text content to capture.

### Request Example
```javascript
location.href = 'org-protocol://roam-ref?template=r&ref=' + encodeURIComponent(location.href) + '&title=' + encodeURIComponent(document.title) + '&body=' + encodeURIComponent(window.getSelection())
```

### Response
#### Success Response (200)
- **status** (string) - Indicates success or failure of the operation.

#### Response Example
```json
{
  "status": "success"
}
```
```

--------------------------------

### Enable Org-roam Completion Everywhere

Source: https://www.orgroam.com/manual.html/index

Configuration to enable Org-roam's link completion functionality outside of bracketed links. This setting allows for broader node linking suggestions.

```emacs-lisp
(setq org-roam-completion-everywhere t)

```

--------------------------------

### Org-roam Reference Node Properties

Source: https://www.orgroam.com/manual.html/index

Demonstrates how to designate a node as the canonical node for a particular reference using its unique citation key. Supports different citation formats for org-cite and org-ref.

```emacs-lisp
* Probabilistic Robotics
:PROPERTIES:
:ID:       51b7b82c-bbb4-4822-875a-ed548cffda10
:ROAM_REFS: @thrun2005probabilistic
:END:

```

```emacs-lisp
* Probabilistic Robotics
:PROPERTIES:
:ID:       51b7b82c-bbb4-4822-875a-ed548cffda10
:ROAM_REFS: [cite:@thrun2005probabilistic]
:END:

```

```emacs-lisp
* Probabilistic Robotics
:PROPERTIES:
:ID:       51b7b82c-bbb4-4822-875a-ed548cffda10
:ROAM_REFS: cite:thrun2005probabilistic
:END:

```

--------------------------------

### Manually Sync Org-roam Database

Source: https://www.orgroam.com/manual.html/index

Triggers a manual synchronization of the Org-roam database to build or update the cache. The initial build may take time, but subsequent syncs are usually faster as they only process modified files.

```emacs-lisp
(org-roam-db-sync)
```

--------------------------------

### Display Dedicated Org-roam Buffer

Source: https://www.orgroam.com/manual.html/index

Launches an Org-roam buffer dedicated to a specific node without opening the node's file. This allows for multiple dedicated buffers that do not automatically update.

```emacs-lisp
(defun org-roam-buffer-display-dedicated ())
```

--------------------------------

### Copy Generated Org-roam Graph to Publishing Directory

Source: https://www.orgroam.com/manual.html/index

Uses the `org-roam-graph-generation-hook` to copy the generated graph file (SVG) to the specified publishing directory. This hook ensures the graph is available alongside the published notes.

```emacs-lisp
(add-hook 'org-roam-graph-generation-hook
          (lambda (dot svg) (if (< (- (cadr (current-time)) my-publish-time) 5)
                                (progn (copy-file svg "~/roam-export/sitemap.svg" 't)
                                       (kill-buffer (file-name-nondirectory svg))
                                       (setq my-publish-time 0)))))

```

--------------------------------

### Enable Org-roam Export Overrides

Source: https://www.orgroam.com/manual.html/index

Requires the org-roam-export library to enhance Org-mode's default export capabilities for Org-roam files. This is necessary due to Org-roam's reliance on ID links, which Org's standard HTML export handles poorly.

```emacs-lisp
(require 'org-roam-export)
```

--------------------------------

### org-protocol://roam-node

Source: https://www.orgroam.com/manual.html/index

Opens a node with the specified ID. Used by org-roam-graph for navigation.

```APIDOC
## GET /org-protocol/roam-node

### Description
Opens the node with the ID specified by the `node` key.

### Method
GET

### Endpoint
`/org-protocol/roam-node`

### Parameters
#### Query Parameters
- **node** (string) - Required - The ID of the node to open.

### Response
#### Success Response (200)
- **status** (string) - Indicates success or failure of the operation.

#### Response Example
```json
{
  "status": "success"
}
```
```

--------------------------------

### Define Org-roam Node Namespace Property

Source: https://www.orgroam.com/manual.html/index

Defines a new 'namespace' property for org-roam-node structs using cl-defmethod. This allows custom namespace retrieval based on the node's file location, making it available for use in capture templates.

```emacs-lisp
(cl-defmethod org-roam-node-namespace ((node org-roam-node))
  "Return the namespace for NODE.
The namespace is the final directory of the file for the node."
  (file-name-nondirectory
   (directory-file-name
    (file-name-directory (org-roam-node-file node)))))

```

--------------------------------

### Enable Org-roam Autosync Mode

Source: https://www.orgroam.com/manual.html/index

Activates Org-roam's automatic database synchronization mode. This function should be included in your Emacs initialization to ensure Org-roam's cache is kept up-to-date upon Emacs startup.

```emacs-lisp
(org-roam-db-autosync-mode)
```

--------------------------------

### Enable Automatic Cache Synchronization

Source: https://www.orgroam.com/manual.html/index

Configures Org-roam to automatically update its cache when files change. This ensures cache consistency. It is recommended to add this to your Emacs configuration to enable it on startup.

```emacs-lisp
(setq find-file-visit-truename t)
```

--------------------------------

### Configure Unique Backlinks in Org-roam Buffer

Source: https://www.orgroam.com/manual.html/index

Configures the Org-roam buffer to display only unique backlinks. This setting is applied by passing the :unique t argument to the backlinks section function.

```emacs-lisp
(setq org-roam-mode-sections
      '((org-roam-backlinks-section :unique t)
        org-roam-reflinks-section))
```

--------------------------------

### Configure Org-journal for Journaling in Emacs

Source: https://www.orgroam.com/manual.html/index

This Emacs Lisp snippet configures the Org-journal package for creating journal entries. It sets a custom date prefix, file format, directory, and date format for new journal files. This is useful for maintaining a separate journal from general notes.

```emacs-lisp
(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/journal/files/")
  (org-journal-date-format "%A, %d %B %Y"))
```

--------------------------------

### Org-roam Node Structure Definition

Source: https://www.orgroam.com/manual.html/index

Defines the 'org-roam-node' structure, outlining the properties available for substitution within Org-roam templates. This includes file-related information, node hierarchy, and metadata.

```emacs-lisp
(cl-defstruct (org-roam-node (:constructor org-roam-node-create)
                             (:copier nil))
  "A heading or top level file with an assigned ID property."
  file file-hash file-atime file-mtime
  id level point todo priority scheduled deadline title properties olp
  tags aliases refs)
```

--------------------------------

### Toggle Org-roam Buffer

Source: https://www.orgroam.com/manual.html/index

Toggles the display of the Org-roam buffer. This command is used to show or hide the buffer that tracks the current node at point.

```emacs-lisp
(defun org-roam-buffer-toggle ())
```

--------------------------------

### Optimize Org-roam Garbage Collection Threshold

Source: https://www.orgroam.com/manual.html/index

Temporarily increases the garbage collection threshold during memory-intensive cache-building operations. Setting it to `most-positive-fixnum` can reduce the frequency of garbage collection.

```emacs-lisp
(setq org-roam-db-gc-threshold most-positive-fixnum)
```

--------------------------------

### Exclude Node from Org-roam Cache

Source: https://www.orgroam.com/manual.html/index

Shows how to exclude a specific Org-roam node from being cached in the SQLite database. This is achieved by setting the `:ROAM_EXCLUDE` property to a non-nil value for the desired headline.

```org
* Foo
  :PROPERTIES:
  :ID:       foo
  :ROAM_EXCLUDE: t
  :END:
```
Tokens:
Raw