org-ref: citations, cross-references, indexes, glossaries and bibtex utilities for org-mode

Introduction to org-ref on YouTube.

Screenshots

Here are some annotated images of basic insertion of citations in org-mode.

The links in org-ref are functional. They do things when your cursor is on them, or you click on them, and sometimes when the mouse hovers over them.

Here is an example of a menu of actions you get when you click on a cite link.

org-ref can analyze your org-file and tell you about it, for example if there are bad citations, multiply defined labels, bad reference links, missing bibliography files, etc… You can select each one and it will jump to the location to help you fix it.

Installation

Package installation via Melpa

org-ref has been added to Melpa.

(add-to-list 'package-archives
	     '("melpa" . "http://melpa.org/packages/") t)

Then, you should be able to do M-x package-list-packages, find org-ref and install it.

Installation via github

Clone this repo, add it to your load-path, and require org-ref.

git clone git@github.com:jkitchin/org-ref.git

Configuration

You should set these variables. Here is an example of how mine are set in an init.el file.

(setq reftex-default-bibliography '("~/Dropbox/bibliography/references.bib"))

;; see org-ref for use of these variables
(setq org-ref-bibliography-notes "~/Dropbox/bibliography/notes.org"
      org-ref-default-bibliography '("~/Dropbox/bibliography/references.bib")
      org-ref-pdf-directory "~/Dropbox/bibliography/bibtex-pdfs/")

You may want to set some convenient keys for working in your bibtex file. These commands operate on the citation key at point.

If you use helm-bibtex as the citation key completion method you should set these variables too.

(setq helm-bibtex-bibliography "~/Dropbox/bibliography/references.bib")
(setq helm-bibtex-library-path "~/Dropbox/bibliography/bibtex-pdfs")

;; open pdf with system pdf viewer (works on mac)
(setq helm-bibtex-pdf-open-function
  (lambda (fpath)
    (start-process "open" "*open*" "open" fpath)))

;; alternative
;; (setq helm-bibtex-pdf-open-function 'org-open-file)

(setq helm-bibtex-notes-path "~/Dropbox/bibliography/helm-bibtex-notes")

There are alternative citation key completion methods.

org-ref-helm-cite: An alternative to helm-bibtex
org-ref-ivy-bibtex: Uses ivy for key completion
org-ref-reftex: Uses reftex and org-mode for completion (no longer developed)

Finally, add this to your init.el files.

(require 'org-ref)

Go forth and citate.

Some other useful libraries in org-ref

Note many of these have been renamed with an org-ref prefix.

doi-utils: Download bibtex entries and PDFs from doi and crossref queries.
org-ref-pdf: Add drag-n-drop PDF to create bibtex entries
org-ref-url-utils: Add drag-n-drop urls to create bibtex entries
org-ref-bibtex: Utility functions for bibtex
org-ref-latex: org-ref-like features in LaTeX.
org-ref-arxiv: arxiv links, add bibtex entries from arxiv.org.
org-ref-pubmed: pubmed links, add bibtex entries from PMID.
org-ref-isbn: Add bibtex entries from a book ISBN
org-ref-wos: WebOfKnowledge links and queries
org-ref-scopus: Scopus links and queries
x2bib: Convert bibliography formats to and from bibtex
nist-webbook: Links to NIST Webbook resources

Errors and issues

Please report errors here: issues.

Contributors

I would like to thank the contributors to org-ref, and everyone who has filed an issue, or asked about org-ref on the org-mode Mailing list.

mhlr / org-ref