Skip to content

Commit 10ea878

Browse files
committed
docs:
1 parent 5d643ec commit 10ea878

File tree

3 files changed

+91
-53
lines changed

3 files changed

+91
-53
lines changed

README.org

Lines changed: 6 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -84,7 +84,7 @@ Go to the manual and close this tab.
8484
- in a web browser: [[https://github.com/meedstrom/org-node/blob/main/org-node.org]]
8585
- or in Emacs after installation: [[info:org-node]]
8686

87-
* Advice: Start with a paper Zettelkasten
87+
* Advice: Start with paper
8888

8989
Many people on forums say that you should do *a paper slip-box first* before going digital.
9090

@@ -94,11 +94,12 @@ So let me try to bootstrap you:
9494

9595
[[file:README_5745.jpg]]
9696

97-
If you are currently in the EU, you can order the pictured paper slips and box here:
97+
If you are inside the EU, you can order the pictured box and paper slips here:
9898

9999
- https://www.123ink.se/HAN-kortlada-A6-svart-HA-976-13-i23800-t76314.html
100-
- https://www.123ink.se/Papper-Fotopapper/Kopieringspapper/A6/80-gram-p165367.html
100+
- https://www.123ink.se/123inkt-Kopieringspapper-A6-80g-vit-123ink-2-000-ark-3kg-i69137-t165367.html
101+
- weirdly rare product
101102

102-
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.)
103104

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

org-node.org

Lines changed: 14 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -6,8 +6,9 @@
66
#+TEXINFO_DIR_TITLE: Org-Node: (org-node).
77
#+TEXINFO_DIR_DESC: Link org-id entries into a network.
88

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

11+
* Setup
1112
** Installation
1213

1314
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>~.
7273

7374
To browse config options, type ~M-x customize-group RET org-node RET~ (or ~M-o n x o~).
7475

75-
** Backlinks
76+
* Backlinks
7677

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

7980
You do not have to create backlinks yourself, they are autogenerated. The following sections outline two basic ways this can work.
8081

81-
*** Backlink solution 1: displayed in a separate window
82+
** Backlink solution 1: displayed in a separate window
8283
- Solution 1A: Reuse the org-roam buffer ::
8384

8485
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
107108
#+end_src
108109

109110

110-
*** Backlink solution 2: Print inside the file
111+
** Backlink solution 2: printed inside the file
111112
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.
112113

113114
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
179180

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

183+
* Misc
182184
** Org-capture
183185

184186
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
466468

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

469-
** Appendix
470-
*** Appendix I: Rosetta stone
471+
* Appendix
472+
** Appendix I: Rosetta stone
471473

472474
API cheatsheet between org-roam and org-node.
473475

@@ -503,7 +505,7 @@ API cheatsheet between org-roam and org-node.
503505
| Get =ROAM_EXCLUDE= | | =(org-mem-entry-property "ROAM_EXCLUDE" NODE)= |
504506
| Ensure fresh data | =(org-roam-db-sync)= | =(org-node-cache-ensure t t)= |
505507

506-
*** Appendix II: How to rollback
508+
** Appendix II: How to rollback
507509
:PROPERTIES:
508510
:CUSTOM_ID: appendix-ii-how-to-rollback
509511
:END:
@@ -554,15 +556,15 @@ With [[https://github.com/radian-software/straight.el][Straight]]:
554556
:straight (org-node :type git :host github :repo "meedstrom/org-node"
555557
:branch "v1.6"))
556558
#+end_src
557-
*** Appendix III: Random tips
558-
**** Fix export to HTML
559+
** Appendix III: Random tips
560+
*** Fix export to HTML
559561
Org-roam shipped the optional =(require 'org-roam-export)=, a patch to fix =id:= links in HTML export.
560562

561563
Good news, upstream fixed the root of the issue in 5e9953fa0! Update Org to 9.7+ (comes with Emacs 30), then set this.
562564

563565
: (setq org-html-prefer-user-labels t)
564566

565-
*** Appendix IV: What are =ROAM_REFS=?
567+
** Appendix IV: What are =ROAM_REFS=?
566568
:PROPERTIES:
567569
:CUSTOM_ID: appendix-iv-what-are-roam_refs
568570
:END:
@@ -592,10 +594,10 @@ For performance reasons, not just any string of text is accepted -- it must have
592594

593595
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".
594596

595-
**** What's it actually used for?
597+
*** What's it actually used for?
596598

597599
People often use it to write notes about a specific web-page or PDF file, and call it a ref-node for that resource.
598600

599-
**** Citations
601+
*** Citations
600602

601603
As a special case, citation keys such as "@ioannidis2005" also work in =ROAM_REFS=, corresponding to Org citations like =[cite:@ioannidis2005]=.

org-node.texi

Lines changed: 71 additions & 36 deletions
Original file line numberDiff line numberDiff line change
@@ -21,14 +21,35 @@
2121
@node Top
2222
@top org-node
2323

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

2626
@end ifnottex
2727

2828
@menu
29+
* Setup::
30+
* Backlinks::
31+
* Misc::
32+
* Appendix::
33+
34+
@detailmenu
35+
--- The Detailed Node Listing ---
36+
37+
Setup
38+
2939
* Installation::
3040
* 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+
3253
* Org-capture::
3354
* Exclude uninteresting nodes::
3455
* Missing completions?::
@@ -42,19 +63,6 @@ This is the manual for org-node. The @uref{https://github.com/meedstrom/org-nod
4263
* Limitation Org-ref::
4364
* Toolbox::
4465
* 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::
5866
5967
Sort completions
6068
@@ -83,8 +91,16 @@ Appendix IV: What are @samp{ROAM_REFS}?
8391
@end detailmenu
8492
@end menu
8593

94+
@node Setup
95+
@chapter Setup
96+
97+
@menu
98+
* Installation::
99+
* Quick start::
100+
@end menu
101+
86102
@node Installation
87-
@chapter Installation
103+
@section Installation
88104

89105
Assuming your package manager gets recipes from @uref{https://melpa.org/#/getting-started, MELPA}@comma{} add the following initfile snippet.
90106

@@ -133,12 +149,12 @@ If you're coming here from @strong{org-roam}@comma{} try this instead:
133149
@end menu
134150

135151
@node An update broke things?
136-
@section An update broke things?
152+
@subsection An update broke things?
137153

138154
See at the end of this readme: @ref{Appendix II How to rollback, , How to rollback}
139155

140156
@node Quick start
141-
@chapter Quick start
157+
@section Quick start
142158

143159
If you're new to these concepts@comma{} fear not. The main things for day-to-day operation are two commands:
144160

@@ -172,7 +188,7 @@ You do not have to create backlinks yourself@comma{} they are autogenerated. Th
172188

173189
@menu
174190
* Backlink solution 1 displayed in a separate window::
175-
* Backlink solution 2 Print inside the file::
191+
* Backlink solution 2 printed inside the file::
176192
@end menu
177193

178194
@node Backlink solution 1 displayed in a separate window
@@ -207,8 +223,8 @@ If you like it@comma{} consider binding it to an easily typed key@comma{} such a
207223
@end lisp
208224
@end table
209225

210-
@node Backlink solution 2 Print inside the file
211-
@section Backlink solution 2: Print inside the file
226+
@node Backlink solution 2 printed inside the file
227+
@section Backlink solution 2: printed inside the file
212228

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

@@ -293,8 +309,27 @@ Running aforementioned command @strong{may re-sort your backlinks and re-format
293309
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.
294310
@end table
295311

312+
@node Misc
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+
296331
@node Org-capture
297-
@chapter Org-capture
332+
@section Org-capture
298333

299334
You may have heard that org-roam has a set of meta-capture templates: the @samp{org-roam-capture-templates}.
300335

@@ -338,7 +373,7 @@ That last optional functionality may only confuse you more if I try to describe
338373
For deeper hacking@comma{} see @uref{https://github.com/meedstrom/org-node/wiki/Capture, wiki}.
339374

340375
@node Exclude uninteresting nodes
341-
@chapter Exclude uninteresting nodes
376+
@section Exclude uninteresting nodes
342377

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

@@ -360,7 +395,7 @@ Or you could go with a whitelist approach@comma{} to show only nodes from a cert
360395
@end lisp
361396

362397
@node Missing completions?
363-
@chapter Missing completions?
398+
@section Missing completions?
364399

365400
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}.
366401

@@ -374,7 +409,7 @@ That is also the usage that I test most -- I've had the following config for yea
374409
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.
375410

376411
@node Completion-at-point
377-
@chapter Completion-at-point
412+
@section Completion-at-point
378413

379414
A global minor mode to complete words at point into known node titles:
380415

@@ -384,7 +419,7 @@ A global minor mode to complete words at point into known node titles:
384419
@end lisp
385420

386421
@node Customize appearance
387-
@chapter Customize appearance
422+
@section Customize appearance
388423

389424
(Analogue to @samp{org-roam-node-display-template}@comma{} for those of you who know what that is)
390425

@@ -401,7 +436,7 @@ A related option is @samp{org-node-alter-candidates}@comma{} which lets you matc
401436
@end lisp
402437

403438
@node Sort completions
404-
@chapter Sort completions
439+
@section Sort completions
405440

406441
A useful way to sort completions is to base it on a @samp{:TIME_MODIFIED:} property under each of your ID-nodes.
407442

@@ -425,7 +460,7 @@ Then to start actually sorting nodes by their @samp{:TIME_MODIFIED:} values:
425460
@end menu
426461

427462
@node Bonus Lining up properties
428-
@section Bonus: Lining up properties
463+
@subsection Bonus: Lining up properties
429464

430465
I want to see @samp{:TIME_CREATED:} right above @samp{:TIME_MODIFIED:}.
431466

@@ -448,7 +483,7 @@ So I re-sort the entire properties drawer on save:
448483
@end lisp
449484

450485
@node Grep
451-
@chapter Grep
486+
@section Grep
452487

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

@@ -473,7 +508,7 @@ Type @code{C-c C-c} to apply the changes
473508
@end enumerate
474509

475510
@node Let org-open-at-point detect refs
476-
@chapter Let org-open-at-point detect refs
511+
@section Let org-open-at-point detect refs
477512

478513
(For background@comma{} see @ref{Appendix IV What are @samp{ROAM_REFS}?, , What are ROAM@math{_REFS}?} at the end of this README@.)
479514

@@ -487,14 +522,14 @@ Wouldn't it be nice if@comma{} clicking on that link@comma{} you automatically v
487522
@end lisp
488523

489524
@node Limitation TRAMP
490-
@chapter Limitation: TRAMP
525+
@section Limitation: TRAMP
491526

492527
Working with files over TRAMP is unsupported@comma{} because org-mem works in parallel subprocesses which do not inherit your TRAMP setup.
493528

494529
The best way to change this is to @uref{https://github.com/meedstrom/org-mem/issues, file an issue} to show you care :-)
495530

496531
@node Limitation Unique titles
497-
@chapter Limitation: Unique titles
532+
@section Limitation: Unique titles
498533

499534
If two ID-nodes exist with the same title@comma{} one of them disappears from minibuffer completions.
500535

@@ -511,7 +546,7 @@ This lets you match against the node outline path and not only the title@comma{}
511546
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})
512547

513548
@node Limitation Org-ref
514-
@chapter Limitation: Org-ref
549+
@section Limitation: Org-ref
515550

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

@@ -530,7 +565,7 @@ Contribute to @uref{https://github.com/meedstrom/org-mem, org-mem}@comma{} see f
530565
@end itemize
531566

532567
@node Toolbox
533-
@chapter Toolbox
568+
@section Toolbox
534569

535570
(Note that you can view this same list of commands in Emacs. Assuming that @samp{M-o n} was where you bound @samp{org-node-org-prefix-map}@comma{} type @samp{M-o n <f1>}.)
536571

@@ -676,7 +711,7 @@ Rarer commands for org-node-backlink-mode:
676711
@end itemize
677712

678713
@node Experimental Node sequences
679-
@chapter Experimental: Node sequences
714+
@section Experimental: Node sequences
680715

681716
Do you already know about "daily-notes"? Then get started as follows:
682717

@@ -698,7 +733,7 @@ Tip: Consider binding a shorter key @code{M-o s}
698733
@end menu
699734

700735
@node What are node seqs?
701-
@section What are node seqs?
736+
@subsection What are node seqs?
702737

703738
It's easiest to explain node sequences if we use "daily-notes" (aka "dailies") as an example.
704739

0 commit comments

Comments
 (0)