added docs
[org-ref.git] / README.org
1 #+TITLE: org-ref: citations, cross-references, indexes, glossaries and bibtex utilities for org-mode
2
3 [[./org-ref.org]] contains all documentation and installation instructions.
4
5 [[./doi-utils.org]] contains functions for downloading bibtex entries from  a DOI, and redefines the org-mode doi link so it has more functionality. 
6
7 [[./jmax-bibtex.el]] contains some utility functions:
8
9 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.
10
11 2. Bind M-n/M-p to next/previous bibtex entry.
12
13 3. Sentence/title casing the title of a bibtex entry
14
15 4. Function to replace non-ascii characters in bibtex entries
16
17 5. Functions to replace journal names with @string entries, and corresponding short/long names.
18
19 To install this, add the org-ref repo directory to your load-path, and 
20
21 #+BEGIN_SRC emacs-lisp
22 (add-to-list 'load-path "path-to-org-ref")
23 (require 'jmax-bibtex)
24 #+END_SRC