1 # -*- org-edit-src-content-indentation: 0; -*-
2 #+TITLE: org-ref: citations, cross-references, indexes, glossaries and bibtex utilities for org-mode
5 <a href="https://travis-ci.org/jkitchin/org-ref"><img src="https://travis-ci.org/jkitchin/org-ref.svg?branch=master"></a>
8 See http://www.youtube.com/watch?v=Zya8SfmCtFA and https://www.youtube.com/watch?v=JyvpSVl4_dg for examples of org-ref in action.
10 [[./org-ref.org]] contains all documentation and installation instructions.
12 [[./doi-utils.org]] contains functions for downloading bibtex entries from a DOI, and redefines the org-mode doi link so it has more functionality.
14 [[./jmax-bibtex.el]] contains some utility functions:
16 1. jmax-bibtex runs a menu command with actions to run on a bibtex entry including looking up the doi for the entry in a variety of places, e.g. web of science related/citing articles, Google Scholar, Pubmed, and crossref, or opening a PDF associated with the entry.
18 2. Bind M-n/M-p to next/previous bibtex entry.
20 3. Sentence/title casing the title of a bibtex entry
22 4. Function to replace non-ascii characters in bibtex entries
24 5. Functions to replace journal names with @string entries, and corresponding short/long names.
27 We are slowly moving towards getting org-ref in MELPA. Until then, here are some directions that will probably help install org-ref.
29 You should clone this repository somewhere.
31 You should set these variables. Here is an example of how mine are set in an init.el file.
32 #+BEGIN_SRC emacs-lisp
33 (setq reftex-default-bibliography '("~/Dropbox/bibliography/references.bib"))
35 ;; see org-ref for use of these variables
36 (setq org-ref-bibliography-notes "~/Dropbox/bibliography/notes.org"
37 org-ref-default-bibliography '("~/Dropbox/bibliography/references.bib")
38 org-ref-pdf-directory "~/Dropbox/bibliography/bibtex-pdfs/")
41 You may want to set some convenient keys for working in your bibtex file:
43 #+BEGIN_SRC emacs-lisp
44 (global-set-key [f10] 'org-ref-open-bibtex-notes)
45 (global-set-key [f11] 'org-ref-open-bibtex-pdf)
46 (global-set-key [f12] 'org-ref-open-in-browser)
49 Change into the directory you cloned org-ref into and run this command to generate the elisp files.
54 Add the directory you cloned org-ref into to your load-path, and require the features you want.
55 #+BEGIN_SRC emacs-lisp
56 (add-to-list 'load-path "path-to-org-ref")
57 ;; make sure you have dash, helm, helm-bibtex, ebib, s, f, hydra and key-chord
61 (require 'jmax-bibtex)
65 Please report errors here: [[https://github.com/jkitchin/org-ref/issues][issue]]s
68 I would like to thank the following [[https://github.com/jkitchin/org-ref/graphs/contributors][contributors]] to org-ref
70 - https://github.com/divinenephron
71 - https://github.com/OlafMerkert
72 - https://github.com/prtkm
74 And everyone who has filed an [[https://github.com/jkitchin/org-ref/issues][issue]], or asked about org-ref on the [[http://orgmode.org/community.html][org-mode Mailing list]].