daniel/emacs-conf
1
2
Fork 0
Code Issues 7 Pull Requests Projects Releases Wiki Activity

update packages and add valign

Browse Source
This commit is contained in:
Daniel Weschke
2026-04-05 20:00:27 +02:00
parent b062fb98e3
commit 03fb00e374
640 changed files with 109768 additions and 39311 deletions
Download Patch File Download Diff File Expand all files Collapse all files

361
lisp/org-roam/org-roam.info
View File

@@ -1,7 +1,8 @@
This is org-roam.info, produced by makeinfo version 7.2 from
This is org-roam.info, produced by makeinfo version 7.3 from
org-roam.texi.
Copyright (C) 2020-2025 Jethro Kuan <jethrokuan95@gmail.com>
Copyright (C) 2020-2026 Jethro Kuan <jethrokuan95@gmail.com> and
the Org-roam contributors
You can redistribute this document and/or modify it under the terms
of the GNU General Public License as published by the Free Software
@@ -24,9 +25,10 @@ File: org-roam.info, Node: Top, Next: Introduction, Up: (dir)
Org-roam User Manual
********************
This manual is for Org-roam version 2.3.1.
This manual is for Org-roam version 2.3.1-devel.
Copyright (C) 2020-2025 Jethro Kuan <jethrokuan95@gmail.com>
Copyright (C) 2020-2026 Jethro Kuan <jethrokuan95@gmail.com> and
the Org-roam contributors
You can redistribute this document and/or modify it under the terms
of the GNU General Public License as published by the Free Software
@@ -415,9 +417,6 @@ the Org-roam library. Add the following code to your ‘.emacs’:
You now have Org-roam installed. However, you don't necessarily have
the dependencies that it requires. These include:
• dash
• f
• s
• org
• emacsql
• magit-section
@@ -603,8 +602,7 @@ Node selection is achieved via the ‘completing-read’ interface,
typically through ‘org-roam-node-read’. The presentation of these nodes
are governed by ‘org-roam-node-display-template’.
• Variable: org-roam-node-display-template
-- Variable: org-roam-node-display-template
Configures display formatting for Org-roam node.
Patterns of form "${field-name:length}" are interpolated based on
@@ -700,8 +698,7 @@ Org-roam takes special care of additionally trying to process these
links. Use ‘org-roam-db-extra-links-elements’ to specify which
additional Org AST element types to consider.
• Variable: org-roam-db-extra-links-elements
-- Variable: org-roam-db-extra-links-elements
The list of Org element types to include for parsing by Org-roam.
By default, when parsing Org's AST, links within keywords and
@@ -714,8 +711,7 @@ within property drawers. For example, we would not want ‘ROAM_REFS’
links to be self-referential. Hence, to exclude specific keys, we use
‘org-roam-db-extra-links-exclude-keys’.
• Variable: org-roam-db-extra-links-exclude-keys
-- Variable: org-roam-db-extra-links-exclude-keys
Keys to ignore when mapping over links.
The car of the association list is the Org element type (e.g.
@@ -737,8 +733,7 @@ using the interactive commands.
can be a slow operation. You can disable the automatic updating of the
database by setting ‘org-roam-db-update-on-save’ to ‘nil’.
• Variable: org-roam-db-update-on-save
-- Variable: org-roam-db-update-on-save
If t, update the Org-roam database upon saving the file. Disable
this if your files are large and updating the database is slow.
@@ -764,15 +759,13 @@ references etc.). There are two main commands to use here:
To bring up a buffer that tracks the current node at point, call ‘M-x
org-roam-buffer-toggle’.
• Function: org-roam-buffer-toggle
-- Function: org-roam-buffer-toggle
Toggle display of the ‘org-roam-buffer’.
To bring up a buffer that's dedicated for a specific node, call ‘M-x
org-roam-buffer-display-dedicated’.
• Function: org-roam-buffer-display-dedicated
-- Function: org-roam-buffer-display-dedicated
Launch node dedicated Org-roam buffer without visiting the node
itself.
@@ -945,13 +938,11 @@ node:
Alternatively, Org-roam provides some functions to add or remove
aliases.
• Function: org-roam-alias-add alias
-- Function: org-roam-alias-add alias
Add ALIAS to the node at point. When called interactively, prompt
for the alias to add.
• Function: org-roam-alias-remove
-- Function: org-roam-alias-remove
Remove an alias from the node at point.

@@ -1001,13 +992,11 @@ has a citation key and a URL at the same time.
Org-roam also provides some functions to add or remove refs.
• Function: org-roam-ref-add ref
-- Function: org-roam-ref-add ref
Add REF to the node at point. When called interactively, prompt
for the ref to add.
• Function: org-roam-ref-remove
-- Function: org-roam-ref-remove
Remove a ref from the node at point.

@@ -1035,9 +1024,9 @@ File: org-roam.info, Node: Using the Cached Information, Up: Citations
9.1 Using the Cached Information
================================
It is common to use take reference notes for academic papers. To
designate the node to be the canonical node for the academic paper, we
can use its unique citation key:
It is common to take notes on academic reference meterial. To designate
a node as the canonical node for a particular reference, we can use its
unique citation key:
* Probabilistic Robotics
:PROPERTIES:
@@ -1127,8 +1116,7 @@ choice.
(setq org-roam-completion-everywhere t)
• Variable: org-roam-completion-everywhere
-- Variable: org-roam-completion-everywhere
When non-nil, provide link completion matching outside of Org links.

@@ -1199,10 +1187,11 @@ the elements of the template are similar to ‘org-capture’ templates.
6. ‘:target’ is a compulsory specification in the Org-roam capture
template. The first element of the list indicates the type of the
target, the second element indicates the location of the captured
node, and the rest of the elements indicate prefilled template that
will be inserted and the position of the point will be adjusted
for. The latter behavior varies from type to type of the capture
target.
node (note the target location undergoes Org template expansion
like the body elements), and the rest of the elements indicate
prefilled template that will be inserted and the position of the
point will be adjusted for. The latter behavior varies from type
to type of the capture target.
7. ‘:unnarrowed t’ tells org-capture to show the contents for the
whole file, rather than narrowing to just the entry. This is part
of the Org-capture templates.
@@ -1416,14 +1405,14 @@ following additional configurations:
1. Add option '-c' to 'emacsclient' in the script, and start emacs
from command line with 'emacs -daemon'
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
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
1. Add '(server-start)' in .emacs (in this case you do not need option
2. Add '(server-start)' in .emacs (in this case you do not need option
'-c' for 'emacsclient' in the script, and you do not need to start
emacs with 'emacs -daemon'
@@ -1529,8 +1518,7 @@ org-roam-protocol::.
The entry point to graph creation is ‘org-roam-graph’.
• Function: org-roam-graph & optional arg node
-- Function: org-roam-graph & optional arg node
Build and display a graph for NODE. ARG may be any of the following
values:
@@ -1538,8 +1526,7 @@ values:
• ‘integer’ an integer argument ‘N’ will show the graph for the
connected components to node up to ‘N’ steps away.
• User Option: org-roam-graph-executable
-- User Option: org-roam-graph-executable
Path to the graphing executable (in this case, Graphviz). Set this
if Org-roam is unable to find the Graphviz executable on your
system.
@@ -1547,8 +1534,7 @@ values:
You may also choose to use ‘neato’ in place of ‘dot’, which
generates a more compact graph layout.
• User Option: org-roam-graph-viewer
-- User Option: org-roam-graph-viewer
Org-roam defaults to using Firefox (located on PATH) to view the
SVG, but you may choose to set it to:
@@ -1581,23 +1567,19 @@ Org-roam supports some of them. See
<https://graphviz.gitlab.io/_pages/doc/info/attrs.html> for customizable
options.
• User Option: org-roam-graph-filetype
-- User Option: org-roam-graph-filetype
The file type to generate for graphs. This defaults to ‘"svg"’.
• User Option: org-roam-graph-extra-config
-- User Option: org-roam-graph-extra-config
Extra options passed to graphviz for the digraph (The "G"
attributes). Example: ‘'~(("rankdir" . "LR"))’
• User Option: org-roam-graph-node-extra-config
-- User Option: org-roam-graph-node-extra-config
An alist of options to style the nodes. The car of the alist node
type such as ‘"id"’, or ‘"http"’. The cdr of the list is another
alist of Graphviz node options (the "N" attributes).
• User Option: org-roam-graph-edge-extra-config
-- User Option: org-roam-graph-edge-extra-config
Extra options for edges in the graphviz output (The "E"
attributes). Example: ‘'(("dir" . "back"))’
@@ -1623,13 +1605,11 @@ File: org-roam.info, Node: Configuration, Next: Usage, Up: org-roam-dailies
For ‘org-roam-dailies’ to work, you need to define two variables:
• Variable: ‘org-roam-dailies-directory’
-- Variable: org-roam-dailies-directory
Path to daily-notes. This path is relative to
‘org-roam-directory’.
• Variable: ‘org-roam-dailies-capture-templates’
-- Variable: org-roam-dailies-capture-templates
Capture templates for daily-notes in Org-roam.
Here is a sane default configuration:
@@ -1652,34 +1632,29 @@ File: org-roam.info, Node: Usage, Prev: Configuration, Up: org-roam-dailies
‘org-roam-dailies’ provides these interactive functions:
• Function: ‘org-roam-dailies-capture-today’ &optional goto
-- Function: org-roam-dailies-capture-today &optional goto
Create an entry in the daily note for today.
When ‘goto’ is non-nil, go to the note without creating an entry.
• Function: ‘org-roam-dailies-goto-today’
-- Function: org-roam-dailies-goto-today
Find the daily note for today, creating it if necessary.
There are variants of those commands for ‘-yesterday’ and
‘-tomorrow’:
• Function: ‘org-roam-dailies-capture-yesterday’ n &optional goto
-- Function: org-roam-dailies-capture-yesterday n &optional goto
Create an entry in the daily note for yesterday.
With numeric argument ‘n’, use the daily note ‘n’ days in the past.
• Function: ‘org-roam-dailies-goto-yesterday’
-- Function: org-roam-dailies-goto-yesterday
With numeric argument N, use the daily-note N days in the future.
There are also commands which allow you to use Emacs’s ‘calendar’ to
find the date
• Function: ‘org-roam-dailies-capture-date’
-- Function: org-roam-dailies-capture-date
Create an entry in the daily note for a date using the calendar.
Prefer past dates, unless ‘prefer-future’ is non-nil.
@@ -1687,23 +1662,19 @@ find the date
With a 'C-u' prefix or when ‘goto’ is non-nil, go the note without
creating an entry.
• Function: ‘org-roam-dailies-goto-date’
-- Function: org-roam-dailies-goto-date
Find the daily note for a date using the calendar, creating it if
necessary.
Prefer past dates, unless ‘prefer-future’ is non-nil.
• Function: ‘org-roam-dailies-find-directory’
-- Function: org-roam-dailies-find-directory
Find and open ‘org-roam-dailies-directory’.
• Function: ‘org-roam-dailies-goto-previous-note’
-- Function: org-roam-dailies-goto-previous-note
When in an daily-note, find the previous one.
• Function: ‘org-roam-dailies-goto-next-note’
-- Function: org-roam-dailies-goto-next-note
When in an daily-note, find the next one.

@@ -2260,14 +2231,12 @@ 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’:
• Function: org-roam-node-at-point &optional assert
-- Function: org-roam-node-at-point &optional assert
Return the node at point. If ASSERT, throw an error if there is no
node at point.
• Function: org-roam-node-read &optional initial-input filter-fn
sort-fn require-match
-- Function: org-roam-node-read &optional initial-input filter-fn
sort-fn require-match
Read and return an 'org-roam-node'. INITIAL-INPUT is the initial
minibuffer prompt value. FILTER-FN is a function to filter out
nodes: it takes a single argument (an ‘org-roam-node’), and when
@@ -2305,9 +2274,7 @@ the user experience, and sometimes it is desirable to use Org-roam's
capturing system instead. The exposed function to be used in extensions
is ‘org-roam-capture-’:
• Function: org-roam-capture- &key goto keys node info props
templates
-- Function: org-roam-capture- &key goto keys node info props templates
Main entry point. GOTO and KEYS correspond to 'org-capture'
arguments. INFO is a plist for filling up Org-roam's capture
templates. NODE is an 'org-roam-node' construct containing
@@ -2391,103 +2358,147 @@ File: org-roam.info, Node: Function Index, Next: Variable Index, Prev: Comman
Appendix C Function Index
*************************
[index]
* Menu:
* org-roam-alias-add: Titles and Aliases. (line 25)
* org-roam-alias-remove: Titles and Aliases. (line 29)
* org-roam-buffer-display-dedicated: The Org-roam Buffer. (line 28)
* org-roam-buffer-toggle: The Org-roam Buffer. (line 22)
* org-roam-capture-: Extending the Capture System.
(line 11)
* org-roam-dailies-capture-date: Usage. (line 30)
* org-roam-dailies-capture-today: Usage. (line 8)
* org-roam-dailies-capture-yesterday: Usage. (line 19)
* org-roam-dailies-find-directory: Usage. (line 44)
* org-roam-dailies-goto-date: Usage. (line 38)
* org-roam-dailies-goto-next-note: Usage. (line 50)
* org-roam-dailies-goto-previous-note: Usage. (line 47)
* org-roam-dailies-goto-today: Usage. (line 13)
* org-roam-dailies-goto-yesterday: Usage. (line 24)
* org-roam-graph: org-roam-graph. (line 14)
* org-roam-node-at-point: Accessing and Modifying Nodes.
(line 10)
* org-roam-node-read: Accessing and Modifying Nodes.
(line 14)
* org-roam-ref-add: Refs. (line 30)
* org-roam-ref-remove: Refs. (line 34)

File: org-roam.info, Node: Variable Index, Prev: Function Index, Up: Top
Appendix D Variable Index
*************************
Emacs 30.1 (Org mode 9.7.29)
[index]
* Menu:
* org-roam-completion-everywhere: Completing anywhere. (line 18)
* org-roam-dailies-capture-templates: Configuration. (line 12)
* org-roam-dailies-directory: Configuration. (line 8)
* org-roam-db-extra-links-elements: What to cache. (line 34)
* org-roam-db-extra-links-exclude-keys: What to cache. (line 47)
* org-roam-db-update-on-save: When to cache. (line 15)
* org-roam-graph-edge-extra-config: Graph Options. (line 23)
* org-roam-graph-executable: org-roam-graph. (line 22)
* org-roam-graph-extra-config: Graph Options. (line 14)
* org-roam-graph-filetype: Graph Options. (line 11)
* org-roam-graph-node-extra-config: Graph Options. (line 18)
* org-roam-graph-viewer: org-roam-graph. (line 30)
* org-roam-node-display-template: Customizing Node Completions.
(line 10)
Emacs 30.2.50 (Org mode 9.7.39)

Tag Table:
Node: Top754
Node: Introduction4247
Ref: Introduction-Footnote-16382
Node: Target Audience6491
Node: A Brief Introduction to the Zettelkasten Method8365
Node: Installation11501
Node: Installing from MELPA11830
Node: Installing from Source12839
Node: Getting Started15739
Node: The Org-roam Node16031
Node: Links between Nodes16844
Node: Setting up Org-roam17247
Node: Creating and Linking Nodes18852
Node: Customizing Node Completions20566
Node: Customizing Node Caching22751
Node: How to cache22987
Node: What to cache23284
Node: When to cache25416
Node: The Org-roam Buffer26188
Node: Navigating the Org-roam Buffer27645
Node: Configuring what is displayed in the buffer28358
Node: Configuring the Org-roam buffer display30167
Node: Styling the Org-roam buffer31665
Node: Node Properties31877
Node: Standard Org properties32096
Node: Titles and Aliases32441
Node: Tags33436
Node: Refs34096
Node: Citations35298
Node: Using the Cached Information35864
Node: Completion37011
Node: Completing within Link Brackets37806
Node: Completing anywhere38256
Node: Encryption39036
Node: The Templating System39792
Node: Template Walkthrough40507
Node: Org-roam Template Expansion42327
Node: Extensions44193
Node: org-roam-protocol44429
Node: Installation (1)44891
Node: Linux45726
Node: Mac OS47248
Ref: Testing org-protocol49985
Node: Windows50994
Node: The roam-node protocol51737
Node: The roam-ref protocol52124
Node: org-roam-graph53302
Node: Graph Options55203
Node: org-roam-dailies56225
Node: Configuration56512
Node: Usage57327
Node: org-roam-export59146
Node: Performance Optimization59664
Node: Garbage Collection59870
Node: The Org-mode Ecosystem60664
Node: Browsing History with winner-mode61161
Node: Versioning Notes62032
Node: Full-text search with Deft62823
Node: Org-journal63574
Node: Org-download64386
Node: mathpixel64903
Node: Org-noter / Interleave65480
Node: Bibliography65872
Node: Spaced Repetition66629
Node: FAQ67285
Node: How do I have more than one Org-roam directory?67753
Node: How do I create a note whose title already matches one of the candidates?69324
Node: How can I stop Org-roam from creating IDs everywhere?70225
Node: How do I migrate from Roam Research?70917
Node: How to migrate from Org-roam v1?71414
Node: How do I publish my notes with an Internet-friendly graph?72804
Node: Configure org-mode for publishing74159
Node: Overriding the default link creation function75637
Node: Copying the generated file to the export directory76309
Node: Developer's Guide to Org-roam77280
Node: Org-roam's Design Principle77552
Node: Building Extensions and Advanced Customization of Org-roam79534
Node: Accessing the Database80788
Node: Accessing and Modifying Nodes81517
Node: Extending the Capture System83385
Node: Appendix84921
Node: Note-taking Workflows85108
Node: Ecosystem86353
Node: Keystroke Index86470
Node: Command Index86621
Node: Function Index86774
Node: Variable Index86928
Node: Top789
Node: Introduction4323
Ref: Introduction-Footnote-16458
Node: Target Audience6567
Node: A Brief Introduction to the Zettelkasten Method8441
Node: Installation11577
Node: Installing from MELPA11906
Node: Installing from Source12915
Node: Getting Started15785
Node: The Org-roam Node16077
Node: Links between Nodes16890
Node: Setting up Org-roam17293
Node: Creating and Linking Nodes18898
Node: Customizing Node Completions20612
Node: Customizing Node Caching22793
Node: How to cache23029
Node: What to cache23326
Node: When to cache25450
Node: The Org-roam Buffer26218
Node: Navigating the Org-roam Buffer27667
Node: Configuring what is displayed in the buffer28380
Node: Configuring the Org-roam buffer display30189
Node: Styling the Org-roam buffer31687
Node: Node Properties31899
Node: Standard Org properties32118
Node: Titles and Aliases32463
Node: Tags33450
Node: Refs34110
Node: Citations35304
Node: Using the Cached Information35870
Node: Completion37013
Node: Completing within Link Brackets37808
Node: Completing anywhere38258
Node: Encryption39034
Node: The Templating System39790
Node: Template Walkthrough40505
Node: Org-roam Template Expansion42413
Node: Extensions44279
Node: org-roam-protocol44515
Node: Installation (1)44977
Node: Linux45812
Node: Mac OS47334
Ref: Testing org-protocol50101
Node: Windows51110
Node: The roam-node protocol51853
Node: The roam-ref protocol52240
Node: org-roam-graph53418
Node: Graph Options55307
Node: org-roam-dailies56313
Node: Configuration56600
Node: Usage57395
Node: org-roam-export59124
Node: Performance Optimization59642
Node: Garbage Collection59848
Node: The Org-mode Ecosystem60642
Node: Browsing History with winner-mode61139
Node: Versioning Notes62010
Node: Full-text search with Deft62801
Node: Org-journal63552
Node: Org-download64364
Node: mathpixel64881
Node: Org-noter / Interleave65458
Node: Bibliography65850
Node: Spaced Repetition66607
Node: FAQ67263
Node: How do I have more than one Org-roam directory?67731
Node: How do I create a note whose title already matches one of the candidates?69302
Node: How can I stop Org-roam from creating IDs everywhere?70203
Node: How do I migrate from Roam Research?70895
Node: How to migrate from Org-roam v1?71392
Node: How do I publish my notes with an Internet-friendly graph?72782
Node: Configure org-mode for publishing74137
Node: Overriding the default link creation function75615
Node: Copying the generated file to the export directory76287
Node: Developer's Guide to Org-roam77258
Node: Org-roam's Design Principle77530
Node: Building Extensions and Advanced Customization of Org-roam79512
Node: Accessing the Database80766
Node: Accessing and Modifying Nodes81495
Node: Extending the Capture System83360
Node: Appendix84887
Node: Note-taking Workflows85074
Node: Ecosystem86319
Node: Keystroke Index86436
Node: Command Index86587
Node: Function Index86740
Node: Variable Index88518

End Tag Table