brabalan / org-ref

org-mode modules for citations, cross-references, bibliographies in org-mode and useful bibtex tools to go with it.

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

See http://www.youtube.com/watch?v=Zya8SfmCtFA and https://www.youtube.com/watch?v=JyvpSVl4_dg for examples of org-ref in action.

./org-ref.org contains all documentation and installation instructions.

Installation

We are slowly moving towards getting org-ref in MELPA. Until then, here are some directions that will probably help install org-ref.

You should clone this repository somewhere.

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/")

The following helm-bibtex configuration is useful

;; *** helm-bibtex

(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")

You may want to set some convenient keys for working in your bibtex file:

(global-set-key [f10] 'org-ref-open-bibtex-notes)
(global-set-key [f11] 'org-ref-open-bibtex-pdf)
(global-set-key [f12] 'org-ref-open-in-browser)

Add the directory you cloned org-ref into to your load-path, and require the features you want.

(add-to-list 'load-path "path-to-org-ref")
;; make sure you have dash, helm, helm-bibtex, ebib, s, f, hydra and key-chord
;; in your load-path
(require 'org-ref)

;; optional but very useful libraries in org-ref
(require 'doi-utils)
(require 'jmax-bibtex)
(require 'pubmed)
(require 'arxiv)
(require 'sci-id)

Please report errors here: issues.

Contributors

I would like to thank the following contributors to org-ref

• https://github.com/divinenephron
• https://github.com/OlafMerkert
• https://github.com/prtkm

And everyone who has filed an issue, or asked about org-ref on the org-mode Mailing list.