README.org

   1 #+TITLE: org-ref: citations, cross-references, indexes, glossaries and bibtex utilities for org-mode
   2
   3 #+BEGIN_HTML
   4 <a href="https://travis-ci.org/jkitchin/org-ref"><img src="https://travis-ci.org/jkitchin/org-ref.svg?branch=master"></a>
   5 #+END_HTML
   6
   7 See http://www.youtube.com/watch?v=Zya8SfmCtFA and https://www.youtube.com/watch?v=JyvpSVl4_dg for examples of org-ref in action.
   8
   9 [[./org-ref.org]] contains all documentation and installation instructions.
  10
  11 [[./doi-utils.org]] contains functions for downloading bibtex entries from  a DOI, and redefines the org-mode doi link so it has more functionality.
  12
  13 [[./jmax-bibtex.el]] contains some utility functions:
  14
  15 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.
  16
  17 2. Bind M-n/M-p to next/previous bibtex entry.
  18
  19 3. Sentence/title casing the title of a bibtex entry
  20
  21 4. Function to replace non-ascii characters in bibtex entries
  22
  23 5. Functions to replace journal names with @string entries, and corresponding short/long names.
  24
  25 * Installation
  26 We are slowly moving towards getting org-ref in MELPA. Until then, here are some directions that will probably help install org-ref.
  27
  28 You should clone this repository somewhere.
  29
  30 You should set these variables. Here is an example of how mine are set in an init.el file.
  31 #+BEGIN_SRC emacs-lisp
  32 (setq reftex-default-bibliography '("~/Dropbox/bibliography/references.bib"))
  33
  34 ;; see org-ref for use of these variables
  35 (setq org-ref-bibliography-notes "~/Dropbox/bibliography/notes.org"
  36       org-ref-default-bibliography '("~/Dropbox/bibliography/references.bib")
  37       org-ref-pdf-directory "~/Dropbox/bibliography/bibtex-pdfs/")
  38 #+END_SRC
  39
  40 You may want to set some convenient keys for working in your bibtex file:
  41
  42 #+BEGIN_SRC emacs-lisp
  43 (global-set-key [f10] 'org-ref-open-bibtex-notes)
  44 (global-set-key [f11] 'org-ref-open-bibtex-pdf)
  45 (global-set-key [f12] 'org-ref-open-in-browser)
  46 #+END_SRC
  47
  48  Change into the directory you cloned org-ref into and run this command to generate the elisp files.
  49 #+BEGIN_SRC sh
  50 make tangled
  51 #+END_SRC
  52
  53 Add the directory you cloned org-ref into to your load-path, and require the features you want.
  54 #+BEGIN_SRC emacs-lisp
  55 (add-to-list 'load-path "path-to-org-ref")
  56 ;; make sure you have dash, helm, helm-bibtex, ebib, s, f, hydra and key-chord
  57 ;; in your load-path
  58 (require 'org-ref)
  59 (require 'doi-utils)
  60 (require 'jmax-bibtex)
  61 (require 'pubmed)
  62 #+END_SRC
  63
  64 Please report errors here:  [[https://github.com/jkitchin/org-ref/issues][issue]]s
  65
  66 * Contributors
  67 I would like to thank the following [[https://github.com/jkitchin/org-ref/graphs/contributors][contributors]] to org-ref
  68
  69 - https://github.com/divinenephron
  70 - https://github.com/OlafMerkert
  71 - https://github.com/prtkm
  72
  73 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]].