You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Once these products arrive, take them and a pen with you to the local cafe, if it's a quiet noontime hour (otherwise a library, better in the afternoon).
103
+
Once these presents have arrived, take them and a pen to the local café or library. (If you're noise-sensitive, keep in mind that cafés are only quiet in the morning.)
103
104
104
-
Then have a warm coffee, lean back, and read https://zettelkasten.de/introduction/.
105
+
Then lean back, have a warm coffee, and read https://zettelkasten.de/introduction/.
Copy file name to clipboardExpand all lines: org-node.org
+14-12Lines changed: 14 additions & 12 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -6,8 +6,9 @@
6
6
#+TEXINFO_DIR_TITLE: Org-Node: (org-node).
7
7
#+TEXINFO_DIR_DESC: Link org-id entries into a network.
8
8
9
-
This is the manual for org-node. The [[https://github.com/meedstrom/org-node][README]] is separate, but you should not need it anymore.
9
+
This is the instruction manual for org-node. The [[https://github.com/meedstrom/org-node][README]] is separate, but you should not need it anymore.
10
10
11
+
* Setup
11
12
** Installation
12
13
13
14
Assuming your package manager gets recipes from [[https://melpa.org/#/getting-started][MELPA]], add the following initfile snippet.
@@ -72,13 +73,13 @@ To see a list of all commands, enter an Org buffer and type ~M-o n <f1>~.
72
73
73
74
To browse config options, type ~M-x customize-group RET org-node RET~ (or ~M-o n x o~).
74
75
75
-
** Backlinks
76
+
* Backlinks
76
77
77
78
Backlinks are the butter on the bread that is your notes. If you've ever seen a "What links here" section on some webpage, that's exactly what it is.
78
79
79
80
You do not have to create backlinks yourself, they are autogenerated. The following sections outline two basic ways this can work.
80
81
81
-
*** Backlink solution 1: displayed in a separate window
82
+
** Backlink solution 1: displayed in a separate window
82
83
- Solution 1A: Reuse the org-roam buffer ::
83
84
84
85
You can use the org-roam buffer without the rest of org-roam! Enable the following mode.
@@ -107,7 +108,7 @@ You do not have to create backlinks yourself, they are autogenerated. The follo
107
108
#+end_src
108
109
109
110
110
-
*** Backlink solution 2: Print inside the file
111
+
** Backlink solution 2: printed inside the file
111
112
I rarely have the screen space to display a backlink buffer. Because it needs my active involvement to keep visible, I go long periods seeing no backlinks.
112
113
113
114
A complementary solution, which can also stand alone, is to have the backlinks /written into/ the file, on an Org property line or in a drawer.
@@ -179,6 +180,7 @@ A difference between org-node-context (solution 1) and org-node-backlink-mode (s
179
180
180
181
Finally, lines that contain no Org link such as =[[id:1234][Title]]= are *deleted*, which would mean *destroying any other info within.* Same if a backlink is stale and no longer valid.
181
182
183
+
* Misc
182
184
** Org-capture
183
185
184
186
You may have heard that org-roam has a set of meta-capture templates: the =org-roam-capture-templates=.
@@ -466,8 +468,8 @@ You don't need software for that basic idea, only to make it extra convenient to
466
468
467
469
Thus, fundamentally, any "journal" or "dailies" software are just operating on a sorted series to navigate through. A node sequence. You could have sequences for, let's say, historical events, Star Trek episodes, your school curriculum...
468
470
469
-
** Appendix
470
-
*** Appendix I: Rosetta stone
471
+
* Appendix
472
+
** Appendix I: Rosetta stone
471
473
472
474
API cheatsheet between org-roam and org-node.
473
475
@@ -503,7 +505,7 @@ API cheatsheet between org-roam and org-node.
503
505
| Get =ROAM_EXCLUDE= | | =(org-mem-entry-property "ROAM_EXCLUDE" NODE)= |
504
506
| Ensure fresh data | =(org-roam-db-sync)= | =(org-node-cache-ensure t t)= |
505
507
506
-
*** Appendix II: How to rollback
508
+
** Appendix II: How to rollback
507
509
:PROPERTIES:
508
510
:CUSTOM_ID: appendix-ii-how-to-rollback
509
511
:END:
@@ -554,15 +556,15 @@ With [[https://github.com/radian-software/straight.el][Straight]]:
Org-roam shipped the optional =(require 'org-roam-export)=, a patch to fix =id:= links in HTML export.
560
562
561
563
Good news, upstream fixed the root of the issue in 5e9953fa0! Update Org to 9.7+ (comes with Emacs 30), then set this.
562
564
563
565
: (setq org-html-prefer-user-labels t)
564
566
565
-
*** Appendix IV: What are =ROAM_REFS=?
567
+
** Appendix IV: What are =ROAM_REFS=?
566
568
:PROPERTIES:
567
569
:CUSTOM_ID: appendix-iv-what-are-roam_refs
568
570
:END:
@@ -592,10 +594,10 @@ For performance reasons, not just any string of text is accepted -- it must have
592
594
593
595
Org-roam calls such backlinks /reflinks/. In my view, adding a new word for such a similar concept just increases the air of mystery. That's why in org-node's context buffer, they're just called "ref backlinks" -- as opposed to "ID backlinks".
594
596
595
-
**** What's it actually used for?
597
+
*** What's it actually used for?
596
598
597
599
People often use it to write notes about a specific web-page or PDF file, and call it a ref-node for that resource.
598
600
599
-
**** Citations
601
+
*** Citations
600
602
601
603
As a special case, citation keys such as "@ioannidis2005" also work in =ROAM_REFS=, corresponding to Org citations like =[cite:@ioannidis2005]=.
Copy file name to clipboardExpand all lines: org-node.texi
+71-36Lines changed: 71 additions & 36 deletions
Original file line number
Diff line number
Diff line change
@@ -21,14 +21,35 @@
21
21
@nodeTop
22
22
@top org-node
23
23
24
-
This is the manual for org-node. The @uref{https://github.com/meedstrom/org-node, README} is separate@comma{} but you should not need it anymore.
24
+
This is the instruction manual for org-node. The @uref{https://github.com/meedstrom/org-node, README} is separate@comma{} but you should not need it anymore.
25
25
26
26
@end ifnottex
27
27
28
28
@menu
29
+
* Setup::
30
+
* Backlinks::
31
+
* Misc::
32
+
* Appendix::
33
+
34
+
@detailmenu
35
+
--- The Detailed Node Listing ---
36
+
37
+
Setup
38
+
29
39
* Installation::
30
40
* Quick start::
31
-
* Backlinks::
41
+
42
+
Installation
43
+
44
+
* An update broke things?::
45
+
46
+
Backlinks
47
+
48
+
* Backlink solution 1 displayed in a separate window::
49
+
* Backlink solution 2 printed inside the file::
50
+
51
+
Misc
52
+
32
53
* Org-capture::
33
54
* Exclude uninteresting nodes::
34
55
* Missing completions?::
@@ -42,19 +63,6 @@ This is the manual for org-node. The @uref{https://github.com/meedstrom/org-nod
42
63
* Limitation Org-ref::
43
64
* Toolbox::
44
65
* Experimental Node sequences::
45
-
* Appendix::
46
-
47
-
@detailmenu
48
-
--- The Detailed Node Listing ---
49
-
50
-
Installation
51
-
52
-
* An update broke things?::
53
-
54
-
Backlinks
55
-
56
-
* Backlink solution 1 displayed in a separate window::
57
-
* Backlink solution 2 Print inside the file::
58
66
59
67
Sort completions
60
68
@@ -83,8 +91,16 @@ Appendix IV: What are @samp{ROAM_REFS}?
83
91
@end detailmenu
84
92
@end menu
85
93
94
+
@nodeSetup
95
+
@chapter Setup
96
+
97
+
@menu
98
+
* Installation::
99
+
* Quick start::
100
+
@end menu
101
+
86
102
@nodeInstallation
87
-
@chapter Installation
103
+
@section Installation
88
104
89
105
Assuming your package manager gets recipes from @uref{https://melpa.org/#/getting-started, MELPA}@comma{} add the following initfile snippet.
90
106
@@ -133,12 +149,12 @@ If you're coming here from @strong{org-roam}@comma{} try this instead:
133
149
@end menu
134
150
135
151
@nodeAnupdatebrokethings?
136
-
@section An update broke things?
152
+
@subsection An update broke things?
137
153
138
154
See at the end of this readme: @ref{AppendixIIHowtorollback, , Howtorollback}
139
155
140
156
@nodeQuickstart
141
-
@chapter Quick start
157
+
@section Quick start
142
158
143
159
If you're new to these concepts@comma{} fear not. The main things for day-to-day operation are two commands:
144
160
@@ -172,7 +188,7 @@ You do not have to create backlinks yourself@comma{} they are autogenerated. Th
172
188
173
189
@menu
174
190
* Backlink solution 1 displayed in a separate window::
175
-
* Backlink solution 2 Print inside the file::
191
+
* Backlink solution 2 printed inside the file::
176
192
@end menu
177
193
178
194
@nodeBacklinksolution1displayedinaseparatewindow
@@ -207,8 +223,8 @@ If you like it@comma{} consider binding it to an easily typed key@comma{} such a
207
223
@end lisp
208
224
@end table
209
225
210
-
@nodeBacklinksolution2Printinsidethefile
211
-
@section Backlink solution 2: Print inside the file
226
+
@nodeBacklinksolution2printedinsidethefile
227
+
@section Backlink solution 2: printed inside the file
212
228
213
229
I rarely have the screen space to display a backlink buffer. Because it needs my active involvement to keep visible@comma{} I go long periods seeing no backlinks.
214
230
@@ -293,8 +309,27 @@ Running aforementioned command @strong{may re-sort your backlinks and re-format
293
309
Finally@comma{} lines that contain no Org link such as @samp{[[id:1234][Title]]} are @strong{deleted}@comma{} which would mean @strong{destroying any other info within.} Same if a backlink is stale and no longer valid.
294
310
@end table
295
311
312
+
@nodeMisc
313
+
@chapter Misc
314
+
315
+
@menu
316
+
* Org-capture::
317
+
* Exclude uninteresting nodes::
318
+
* Missing completions?::
319
+
* Completion-at-point::
320
+
* Customize appearance::
321
+
* Sort completions::
322
+
* Grep::
323
+
* Let org-open-at-point detect refs::
324
+
* Limitation TRAMP::
325
+
* Limitation Unique titles::
326
+
* Limitation Org-ref::
327
+
* Toolbox::
328
+
* Experimental Node sequences::
329
+
@end menu
330
+
296
331
@nodeOrg-capture
297
-
@chapter Org-capture
332
+
@section Org-capture
298
333
299
334
You may have heard that org-roam has a set of meta-capture templates: the @samp{org-roam-capture-templates}.
300
335
@@ -338,7 +373,7 @@ That last optional functionality may only confuse you more if I try to describe
338
373
For deeper hacking@comma{} see @uref{https://github.com/meedstrom/org-node/wiki/Capture, wiki}.
339
374
340
375
@nodeExcludeuninterestingnodes
341
-
@chapter Exclude uninteresting nodes
376
+
@section Exclude uninteresting nodes
342
377
343
378
One user had over a thousand project-nodes@comma{} but only just began to do a knowledge base@comma{} and wished to avoid seeing the project nodes.
344
379
@@ -360,7 +395,7 @@ Or you could go with a whitelist approach@comma{} to show only nodes from a cert
360
395
@end lisp
361
396
362
397
@nodeMissingcompletions?
363
-
@chapter Missing completions?
398
+
@section Missing completions?
364
399
365
400
Since @uref{https://github.com/meedstrom/org-mem, org-mem} only looks at saved files on disk@comma{} new notes only "appear" after save. So it can make for a smoother experience to enable @samp{auto-save-visited-mode}.
366
401
@@ -374,7 +409,7 @@ That is also the usage that I test most -- I've had the following config for yea
374
409
FWIW@comma{} org-node used to try to be smarter and also cache notes in unsaved buffers@comma{} but that quickly became difficult to reason about@comma{} especially wrt. deciding whether to update a backlink or not.
375
410
376
411
@nodeCompletion-at-point
377
-
@chapter Completion-at-point
412
+
@section Completion-at-point
378
413
379
414
A global minor mode to complete words at point into known node titles:
380
415
@@ -384,7 +419,7 @@ A global minor mode to complete words at point into known node titles:
384
419
@end lisp
385
420
386
421
@nodeCustomizeappearance
387
-
@chapter Customize appearance
422
+
@section Customize appearance
388
423
389
424
(Analogue to @samp{org-roam-node-display-template}@comma{} for those of you who know what that is)
390
425
@@ -401,7 +436,7 @@ A related option is @samp{org-node-alter-candidates}@comma{} which lets you matc
401
436
@end lisp
402
437
403
438
@nodeSortcompletions
404
-
@chapter Sort completions
439
+
@section Sort completions
405
440
406
441
A useful way to sort completions is to base it on a @samp{:TIME_MODIFIED:} property under each of your ID-nodes.
407
442
@@ -425,7 +460,7 @@ Then to start actually sorting nodes by their @samp{:TIME_MODIFIED:} values:
425
460
@end menu
426
461
427
462
@nodeBonusLiningupproperties
428
-
@section Bonus: Lining up properties
463
+
@subsection Bonus: Lining up properties
429
464
430
465
I want to see @samp{:TIME_CREATED:} right above @samp{:TIME_MODIFIED:}.
431
466
@@ -448,7 +483,7 @@ So I re-sort the entire properties drawer on save:
448
483
@end lisp
449
484
450
485
@nodeGrep
451
-
@chapter Grep
486
+
@section Grep
452
487
453
488
If you have Ripgrep installed on the computer@comma{} and @uref{https://github.com/minad/consult, Consult} installed on Emacs@comma{} you can use this command to grep across all your Org files at any time.
454
489
@@ -473,7 +508,7 @@ Type @code{C-c C-c} to apply the changes
473
508
@end enumerate
474
509
475
510
@nodeLetorg-open-at-pointdetectrefs
476
-
@chapter Let org-open-at-point detect refs
511
+
@section Let org-open-at-point detect refs
477
512
478
513
(For background@comma{} see @ref{AppendixIVWhatare@samp{ROAM_REFS}?, , WhatareROAM@math{_REFS}?} at the end of this README@.)
479
514
@@ -487,14 +522,14 @@ Wouldn't it be nice if@comma{} clicking on that link@comma{} you automatically v
487
522
@end lisp
488
523
489
524
@nodeLimitationTRAMP
490
-
@chapter Limitation: TRAMP
525
+
@section Limitation: TRAMP
491
526
492
527
Working with files over TRAMP is unsupported@comma{} because org-mem works in parallel subprocesses which do not inherit your TRAMP setup.
493
528
494
529
The best way to change this is to @uref{https://github.com/meedstrom/org-mem/issues, fileanissue} to show you care :-)
495
530
496
531
@nodeLimitationUniquetitles
497
-
@chapter Limitation: Unique titles
532
+
@section Limitation: Unique titles
498
533
499
534
If two ID-nodes exist with the same title@comma{} one of them disappears from minibuffer completions.
500
535
@@ -511,7 +546,7 @@ This lets you match against the node outline path and not only the title@comma{}
511
546
NB: for users of @samp{org-node-complete-at-point-mode}@comma{} this workaround won't help those completions. With some luck you'll link to the wrong one of two homonymous nodes@comma{} but it's worth being aware. (@uref{https://github.com/meedstrom/org-node/issues/62, #62})
512
547
513
548
@nodeLimitationOrg-ref
514
-
@chapter Limitation: Org-ref
549
+
@section Limitation: Org-ref
515
550
516
551
Org-node supports the Org 9.5 @@citations@comma{} but not fully the aftermarket @uref{https://github.com/jkitchin/org-ref, org-ref} &citations that emulate @LaTeX{} look-and-feel.
517
552
@@ -530,7 +565,7 @@ Contribute to @uref{https://github.com/meedstrom/org-mem, org-mem}@comma{} see f
530
565
@end itemize
531
566
532
567
@nodeToolbox
533
-
@chapter Toolbox
568
+
@section Toolbox
534
569
535
570
(Note that you can view this same list of commands in Emacs. Assuming that @samp{M-on} was where you bound @samp{org-node-org-prefix-map}@comma{} type @samp{M-on<f1>}.)
536
571
@@ -676,7 +711,7 @@ Rarer commands for org-node-backlink-mode:
676
711
@end itemize
677
712
678
713
@nodeExperimentalNodesequences
679
-
@chapter Experimental: Node sequences
714
+
@section Experimental: Node sequences
680
715
681
716
Do you already know about "daily-notes"? Then get started as follows:
0 commit comments