Skip to content

Refs

Refs are unique identifiers for nodes. These keys allow references to the key to show up in the Org-roam buffer. For example, a node for a website may use the URL as the ref, and a node for a paper may use an Org-ref citation key.

To add a ref, add to the “ROAM_REFS” property as follows:

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

With the above example, if another node links to https://www.google.com/, it will show up as a “reference backlink”.

These keys also come in useful for when taking website notes, using the roam-ref protocol (see org-roam-protocol).

You may assign multiple refs to a single node, for example when you want multiple papers in a series to share the same note, or an article 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

Add REF to the node at point. When called interactively, prompt for the ref to add.

Function: org-roam-ref-remove

Remove a ref from the node at point.