README.org

   1 # -*- org-edit-src-content-indentation: 0; -*-
   2 #+TITLE: org-ref: citations, cross-references, indexes, glossaries and bibtex utilities for org-mode
   3
   4 #+BEGIN_HTML
   5 <a href="https://travis-ci.org/jkitchin/org-ref"><img src="https://travis-ci.org/jkitchin/org-ref.svg?branch=master"></a>
   6 #+END_HTML
   7
   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.
   9
  10 [[./org-ref.org]] contains all documentation and installation instructions.
  11
  12
  13 * Installation
  14 We are slowly moving towards getting org-ref in MELPA. Until then, here are some directions that will probably help install org-ref.
  15
  16 You should clone this repository somewhere.
  17
  18 You should set these variables. Here is an example of how mine are set in an init.el file.
  19 #+BEGIN_SRC emacs-lisp
  20 (setq reftex-default-bibliography '("~/Dropbox/bibliography/references.bib"))
  21
  22 ;; see org-ref for use of these variables
  23 (setq org-ref-bibliography-notes "~/Dropbox/bibliography/notes.org"
  24       org-ref-default-bibliography '("~/Dropbox/bibliography/references.bib")
  25       org-ref-pdf-directory "~/Dropbox/bibliography/bibtex-pdfs/")
  26 #+END_SRC
  27
  28 You may want to set some convenient keys for working in your bibtex file:
  29
  30 #+BEGIN_SRC emacs-lisp
  31 (global-set-key [f10] 'org-ref-open-bibtex-notes)
  32 (global-set-key [f11] 'org-ref-open-bibtex-pdf)
  33 (global-set-key [f12] 'org-ref-open-in-browser)
  34 #+END_SRC
  35
  36 Add the directory you cloned org-ref into to your load-path, and require the features you want.
  37 #+BEGIN_SRC emacs-lisp
  38 (add-to-list 'load-path "path-to-org-ref")
  39 ;; make sure you have dash, helm, helm-bibtex, ebib, s, f, hydra and key-chord
  40 ;; in your load-path
  41 (require 'org-ref)
  42
  43 ;; optional but very useful libraries in org-ref
  44 (require 'doi-utils)
  45 (require 'jmax-bibtex)
  46 (require 'pubmed)
  47 (require 'arxiv)
  48 (require 'sci-id)
  49 #+END_SRC
  50
  51 Please report errors here:  [[https://github.com/jkitchin/org-ref/issues][issue]]s.
  52
  53 * Contributors
  54 I would like to thank the following [[https://github.com/jkitchin/org-ref/graphs/contributors][contributors]] to org-ref
  55
  56 - https://github.com/divinenephron
  57 - https://github.com/OlafMerkert
  58 - https://github.com/prtkm
  59
  60 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]].