Org Roam Kasten

Org Roam Kasten (Ork) puts your zettel in the kasten. It is essentially a browser for your Org-roam notes, displaying one note at a time and allowing easy navigation.

This is currently experimental, use at your own risk. That being said, Ork is a read-only tool that should by itself not modify your files.

Installation and settings

Org Roam Kasten requires Org-roam v2.

The usual. Have the package in your load-path and

(require 'org-roam-kasten)

The most basic setting is for entry nodes. These are defined in ork-entry-tag-re by a regular expression to match tags of nodes that you wish to appear in the find minibuffer. The default behavior ("^@.+") pulls all nodes that have a tag beginning with @ (this is a rather arbitrary default that fit my usage when I first wrote the package; it may be changed in the future).

Ork doesn't make any visual modifications to the browser buffer. It is recommended to add relevant minor modes to org-roam-kasten-mode-hook according to your preferences.

Usage

The entry point to Ork is with ork-enter. This will open an org-roam-node-read (like find, but for finding existing nodes only) minibuffer with the entry nodes of your choice.

Choose a node. A special read-only buffer named *Zettelkasten* will open, displaying that node with point at the folded heading. Here TAB has a special behavior: when first press, it will unfold the heading. Afterwards it will navigate (i.e. move point) between the links in the node, with S-TAB for navigating backwards. Press ENT to follow the link at point, all within the *Zettelkasten* buffer.

The other default keybindings are in spirit of Emacs' Info mode:

• p / n: navigate to previous/next zettel at the same level
• [ / ]: navigate to previous/next "physical" zettel – previous/next heading in the Org file, and if there is no such, then previous/next in a neighboring file according to alphabetic order.
• l / r: move back/forward in history
• ^: navigate to parent zettel
• o: visit the node in a normal Org buffer
• SPACE: examine folgezettel in a special line in the buffer
• C-c l: store link to the displayed node with org-store-link (TODO: change this binding according to conventions)
• q: quit the window