Citar-org-node

This package integrates org-node with the popular bibliographic management package, citar.

Org-node associates nodes to bibliographic references using the “ROAM_REFS” property (stored in org-mode’s property drawers). With citar-org-node-mode, citar will become aware of org-node nodes with a corresponding bibliographic reference. Such nodes will become the associated “note” for that reference. Additionally, references can have multiple notes.

If you would like to see a certain feature not already present in the package or discover a bug, please open an issue in the project page or reach out to the package author’s email: [email protected].

Table of contents

• Installation
• Usage
  • Options

Installation

This package is currently not available in any package archives. You should download this repository locally then add it to your load path.

Alternatively, if you an Emacs version of at least 29.1, you can use package-vc-install:

(unless (package-installed-p 'citar-org-node)
  (package-vc-install '(citar-org-node :url "https://github.com/krisbalintona/citar-org-node.git"
                                       :rev :newest)))

;; Or with use-package:
(use-package citar-org-node
  :vc ( :url "https://github.com/krisbalintona/citar-org-node.git"
        :rev :newest))

Usage

Enable citar-org-node-mode and simply use citar as normal! Citar will be aware of your nodes associated with bibliographic references (via the ROAM_REFS property).

Citar-org-node offers several useful commands. To see them, do C-h a citar-org-node- RET, or M-x apropos-command citar-org-node- RET.

Below is a sample configuration for new users to get started:

(use-package citar-org-node
  :vc ( :url "https://github.com/krisbalintona/citar-org-node.git"
        :rev :newest)
  :after (:any citar org-node)
  :bind ( :map org-mode-map
          ("C-c b a" . citar-org-node-add-refs)
          ("C-c b o" . citar-org-node-open-resource))
  :config
  (citar-org-node-mode 1))

Org-node has changed the internal representation of citations across its versions, requiring different handling for other versions. This is likely the cause of any problems citar-org-node has discovering notes associated with bibliographic references. If you discover such problems, please open a GitHub issue.

Options

The most notable user options are:

citar-org-node-new-node-title-template

The citar formatting template for titles of newly created nodes.

citar-org-node-fallback-org-capture-template-key

Key used in the org-capture menu for the fallback template when creating a new note.

To see all user options available, do C-h u citar-org-node- RET, or M-x apropos-user-option citar-org-node- RET.