About

This Emacs package provides org-ref-prettify-mode. It displays your Org-Ref 3.0 citation links in a more friendly and readable format.

Without org-ref-prettify-mode	With org-ref-prettify-mode

Note only proper Org links (links in brackets) are supported. I.e., [[cite:…]] is “prettified” but cite:… is not.

Installation

Automatic

This package can be installed from MELPA (with M-x package-install or M-x list-packages).

Manual

For the manual installation, clone the repo, add the directory to load-path, and add an autoload for the minor mode:

(add-to-list 'load-path "/path/to/org-ref-prettify")
(autoload 'org-ref-prettify-mode "org-ref-prettify" nil t)

Usage

To test this mode, open an org buffer with citation links, and run M-x org-ref-prettify-mode. The links should be “prettified” as shown above. Run the same command again to disable this mode.

If you wish to enable the mode every time you open an org-mode file, you may do it with a setting like this:

(with-eval-after-load 'org
  (add-hook 'org-mode-hook 'org-ref-prettify-mode))

Editing citation links

If org-ref-prettify-mode is enabled, you cannot (and should not try to!) edit citation links directly. Instead, you can edit a link in the minibuffer using one of the following methods:

• moving the point to a link and pressing C-RET,
• right-clicking on a link with your mouse.

In the minibuffer, you can press TAB to switch between &key positions (if there are several keys) and the end of the current link.

Credits

This package could not have been developed without the collaboration of Vitus Schäfftlein, whose bug-reports and improvement suggestions were an invaluable source to improving the functionality of the package.