add index and glossary docs.
[org-ref.git] / org-ref.org
1 #+TITLE: The org-ref manual
2 #+AUTHOR: John Kitchin
3 #+DATE: 2015-03-15 Sun
4 #+OPTIONS: toc:nil ^:{}
5 #+LATEX_HEADER: \usepackage{natbib}
6 \maketitle
7 \tableofcontents
8
9 * Introduction to org-ref
10 Org-ref is a library for org-mode cite:Dominik201408 that provides rich support for citations, labels and cross-references in org-mode. org-ref is especially suitable for org-mode documents destined for LaTeX export and scientific publication. org-ref is also extremely useful for research documents and notes. org-ref bundles several other libraries that provide functions to create and modify bibtex entries from a variety of sources, but most notably from a DOI.
11
12 The basic idea of org-ref is that it defines a convenient interface to insert citations from a reference database (e.g. from a bibtex file(s)), and a  set of functional org-mode links for citations, cross-references and labels that export properly to LaTeX, and that provide clickable functionality to the user. org-ref interfaces with helm-bibtex to facilitate citation entry, and it can also use reftex.
13
14 org-ref provides a fairly large number of utilities for finding bad citations, extracting bibtex entries from citations in an org-file, and functions for interacting with bibtex entries. We find these utilities indispensable in scientific writing.
15
16 org-ref is [[id:32B558A3-7B48-4581-982B-082017B0AEE8][customizable]].
17
18 org-ref has been in development since sometime in 2013. It was written to aid in the preparation of scientific manuscripts.  We have published a lot of scientific articles with it so far  cite:hallenbeck-2013-effec-o2,mehta-2014-ident-poten,xu-2014-relat,xu-2014-probin-cover,miller-2014-simul-temper,curnan-2014-effec-concen,boes-2015-estim-bulk,xu-2015-linear-respon,xu-2015-relat. Be sure to check out the supporting information files for each of these. The org source for the supporting information is usually embedded in the supporting information.
19
20 There has been a lot of recent discussion on the org-mode mailing list about a citation syntax for org-mode. It is not clear what the impact of this on org-ref will be. The new syntax will more cleanly support pre/post text, and it will be separate from the links used in org-ref. It is not clear if the new syntax will support all of the citation types, especially those in biblatex, that are supported in org-ref. The new citations are likely to be clickable, and could share functionality with org-ref. The new citation syntax will not cover labels and cross-references though, so these links from org-ref will still exist. We anticipate a long life for org-ref.
21
22 ** Basic usage of org-ref
23
24 *** Bibliography links
25 org-ref provides a bibliography link to specify which bibtex files to use in the document. You should use the filename with extension, and separate filenames by commas. This link is clickable; clicking on a filename will open the file. Also, if your cursor is on a filename, you will see a minibuffer message about whether the file exists or not. On export, the bibliography will appear at the position where the link is defined. Usually this link goes near the end of your document, e.g. like [[bibliography link][here]].
26
27 There is also a nobibliography link, which is useful for specifying a bibliography file, but not listing a bibliography in the exported document.
28
29 There is also a bibliographystyle link that specifies the style. This link does nothing but export to a LaTeX command.
30
31 If you use biblatex, then you use an addbibresource link. biblatex support is not very well tested by me, because we do not use it.
32
33 *** Citations
34     :PROPERTIES:
35     :CUSTOM_ID: citations
36     :END:
37 org-ref uses the [[bibliography link]] to determine which bibtex files to get citations from, and falls back to the bibtex files defined in the variable  reftex-default-bibliography or org-ref-default-bibliography if no bibliography link is found.
38
39 For simple citation needs, org-ref is simple to use. At the point you want to insert a citation, you select the "Org -> org-ref -> Insert citation" menu (or use the key-binding C-c ] by default), select the reference(s) you want in the helm-bibtex buffer and press enter. The citation will be inserted automatically into your org-file. You "select" an entry by using the arrow keys to move up and down to the entry you want. You can narrow the selection by typing a pattern to match, e.g. author name, title words, year, keyword, etc... You can select multiple entries by pressing C-spc to mark enties in the helm-bibtex buffer.
40
41 If the cursor is on a citation key, you should see a message in the minibuffer that summarizes which citation it refers to. If you click on a key, you should see a helm selection buffer with some actions to choose, including opening the bibtex entry, opening/getting a pdf for the entry, searching the entry in Web of Science, etc...
42
43 The default citation type is [[id:32B558A3-7B48-4581-982B-082017B0AEE8][customizable]], and set to "cite". If you want another type of citation type, then type C-u before pressing enter in the helm-bibtex selection buffer. You will be prompted for the type of citation you actually want.
44
45 Here is a list of supported citation types. You can customize this if you want. If you do not know what all these types are, you probably do not need them. The default cite is what you need. See http://ctan.unixbrain.com/macros/latex/contrib/natbib/natnotes.pdf
46  for the cite commands supported in bibtex, and http://ctan.mirrorcatalogs.com/macros/latex/contrib/biblatex/doc/biblatex.pdf
47  for the commands supported in biblatex. For most scientific journals, only bibtex is supported.
48
49 #+BEGIN_SRC emacs-lisp
50 org-ref-cite-types
51 #+END_SRC
52
53 #+RESULTS:
54 | cite | nocite | citet | citet* | citep | citep* | citealt | citealt* | citealp | citealp* | citenum | citetext | citeauthor | citeauthor* | citeyear | citeyear* | Citet | Citep | Citealt | Citealp | Citeauthor | Cite | parencite | Parencite | footcite | footcitetext | textcite | Textcite | smartcite | Smartcite | cite* | parencite* | supercite | autocite | Autocite | autocite* | Autocite* | Citeauthor* | citetitle | citetitle* | citedate | citedate* | citeurl | fullcite | footfullcite | notecite | Notecite | pnotecite | Pnotecite | fnotecite | cites | Cites | parencites | Parencites | footcites | footcitetexts | smartcites | Smartcites | textcites | Textcites | supercites | autocites | Autocites | bibentry |
55
56 If the cursor is on a citation, or at the end of the citation, and you add another citation, it will be appended to the current citation.
57
58 If you want to /replace/ an existing key in a citation, put the cursor on the key, run the insert citation command, and type C-u C-u before pressing enter in the helm-bibtex selection buffer. The key will be replaced. Of course, you can just delete it yourself, and add a new key.
59
60 Finally, if you do not like the order of the keys in a citation, you can put your cursor on a key and use shift-arrows (left or right) to move the key around. Alternatively, you can run the command org-ref-sort-citation-link which will sort the keys by year, oldest to newest.
61
62 org-ref has basic support for pre/post text in citations. We have very little need for this in scientific publishing; we write pre text before the citation, and post text after it. However, you can get pre/post text by using a description in a cite link, with pre/post text separated by ::. For example, [[cite:Dominik201408][See page 20::, for example]]. It is a little awkward to see this because you cannot see the key. It is a low priority to find a fix for this, because it is not common in scientific publishing and you can always fall back to the old-fashioned LaTeX: \cite[See page 20][, for example]{Dominik201408}.
63
64 You may want to bind a hydra menu to a key-binding or key-chord. For example:
65
66 #+BEGIN_SRC emacs-lisp
67 (key-chord-define-global "kk" 'org-ref-cite-hydra/body)
68 #+END_SRC
69
70 This will allow you to quickly press kk while on a cite link to access functions that can act on the link.
71
72 *** label links
73 LaTeX uses labels to define places you can refer to. These can be labels in the captions of figures and tables, or labels in sections. We illustrate some uses here.
74
75 label links are "functional" if you put your cursor on the link, you will get a message in the minibuffer showing you the number of occurrences of that label in the buffer. That number should be one! It is most preferable to put a label link into a caption like this.
76 #+caption: Another simple table. label:tab-ydata
77 | y |
78 | 4 |
79 | 5 |
80
81 org-ref can help you insert unique labels with the command elisp:org-ref-helm-insert-label-link. This will show you the existing labels, and insert your new label as a link. There is no default key-binding for this.
82
83 *** ref links
84     :PROPERTIES:
85     :ID:       290260A1-F07C-4852-B4B3-CEE3E768AA3B
86     :END:
87 A ref link refers to a label of some sort. For example, you can refer to a table name, e.g. Table ref:table-1. You have to provide the context before the ref link, e.g. Table, Figure, Equation, Section, ....
88
89 #+tblname: table-1
90 #+caption: A simple table.
91 | x |
92 | 1 |
93 | 2 |
94
95 Or you can refer to an org-mode label as in Table ref:table-3.
96
97 #+label: table-3
98 #+caption: Another simple table.
99 | y |
100 |---|
101 | 3 |
102 | 2 |
103
104 You can also refer to an org-ref label link as in Table ref:tab-ydata.
105
106 To help you insert ref links, use the "Org->org-ref->Insert ref" menu, or run the command elisp:org-ref-helm-insert-ref-link. There is no default key-binding for this.
107
108 ref links are functional. If you put the cursor on a ref link, you will get a little message in the minibuffer with some context of the corresponding label. If you click on the ref link, the cursor will jump to the label.
109
110 A brief note about references to a section. This only works if you put a label in the org-mode headline. Otherwise, you must use a CUSTOM_ID and a CUSTOM_ID link. For example section [[#citations]] has a CUSTOM_ID of citations. Section ref:sec-misc has a label link in the headline. That works, but is not too pretty.
111
112 **** Miscellaneous ref links  label:sec-misc
113 org-ref also provides these links:
114
115 - pageref :: The page a label is on
116 - nameref :: The name of a section a label is in
117 - eqref :: Puts the equation number in parentheses
118
119 Note for eqref, you must use a LaTeX label like this:
120
121 \begin{equation}
122 e^x = 4 \label{eq:1}
123 \end{equation}
124
125 Then you can refer to Eq. eqref:eq:1 in your documents.
126
127 *** Some other links
128 org-ref provides clickable links for a list-of-tables:nil and list-of-figures:nil. These export as listoftables and listoffigures LaTeX commands, and they are clickable links that open a mini table of contents with links to the tables and figures in the buffer. There are also interactive commands for this: elisp:org-ref-list-of-tables and elisp:org-ref-list-of-figures.
129
130 ** org-ref customization of helm-bibtex
131 org-ref adds a few new features to helm-bibtex. First, we add keywords as a searchable field. Second, org-ref modifies the helm-bibtex search buffer to include the keywords. Since keywords now can have a central role in searching, we add some functionality to add keywords from the helm-bibtex buffer as a new action.
132
133 We change the order of the actions in helm-bibtex to suit our work flow, and add some new actions. We define a format function for org-mode that is compatible with the usage defined in section [[#citations]]. Finally, we add some new fallback options for additional scientific search engines.
134
135 ** Some basic org-ref utilities
136 The command org-ref does a lot for you automatically. It will check the buffer for errors, e.g. multiply-defined labels, bad citations or ref links, and provide easy access to a few commands through a helm buffer.
137
138 org-ref-clean-bibtex-entry will sort the fields of a bibtex entry, clean it, and give it a bibtex key. This function does a lot of cleaning:
139
140 1. adds a comma if needed in the first line of the entry
141 2. makes sure the doi field is an actual doi, and not a url.
142 3. fixes bad year entries
143 4. fixes empty pages
144 5. Escapes & to \&
145 6. generate a key according to your setup
146 7. Runs your hook functions
147 8. sorts the fields in the entry
148 9. checks the buffer for non-ascii characters.
149
150 This function has a hook org-ref-clean-bibtex-entry-hook, which you can add functions to of your own. Each function must work on a bibtex entry at point.
151
152 #+BEGIN_SRC emacs-lisp
153 (add-hook 'org-ref-clean-bibtex-entry-hook 'jmax-replace-nonascii)
154 #+END_SRC
155
156 #+RESULTS:
157 | jmax-title-case-article | jmax-replace-nonascii |
158
159 org-ref-extract-bibtex-entries will create a bibtex file from the citations in the current buffer.
160
161 ** LaTeX export
162 All org-ref links are designed to export to the corresponding LaTeX commands for citations, labels, refs and the bibliography/bibliography style. Once you have the LaTeX file, you have to build it, using the appropriate latex and bibtex commands. You can have org-mode do this for you with a setup like:
163
164 #+BEGIN_SRC emacs-lisp
165 (setq org-latex-pdf-process
166       '("pdflatex -interaction nonstopmode -output-directory %o %f"
167         "bibtex %b"
168         "pdflatex -interaction nonstopmode -output-directory %o %f"
169         "pdflatex -interaction nonstopmode -output-directory %o %f")
170 #+END_SRC
171
172 ** Other exports
173 There is some basic support for HTML and ascii export. Not all bibtex entry types are supported, but basic support exists for articles and books. For a markdown export, the cite links are exported as Pandoc style links.
174
175 * Other libraries in org-ref
176 These are mostly functions for adding entries to bibtex files, modifying entries or for operating on bibtex files. Some new org-mode links are defined.
177
178 ** doi-utils
179 This library adds two extremely useful tools for getting bibtex entries and pdf files of journal manuscripts. Add this to your emacs setup:
180 #+BEGIN_SRC emacs-lisp
181 (require 'doi-utils)
182 #+END_SRC
183
184 The provides two important commands:
185
186 - doi-utils-add-bibtex-entry-from-doi
187 This will prompt you for a DOI, and a bibtex file, and then try to get the bibtex entry, and pdf of the article.
188
189
190 - doi-utils-add-entry-from-crossref-query
191 This will prompt you for a query string, which is usually the title of an article, or a free-form text citation of an article. Then you will get a helm buffer of matching items, which you can choose from to insert a new bibtex entry into a bibtex file.
192
193 ** jmax-bibtex
194 These are functions I use often in bibtex files.
195
196 *** Generate new bibtex files with adapted journal names
197 The variable jmax-bibtex-journal-abbreviations contains a mapping of a short string to a full journal title, and an abbreviated journal title. We can use these to create new versions of a bibtex file with full or abbreviated journal titles. You can add new strings like this:
198
199 #+BEGIN_SRC emacs-lisp
200 (add-to-list 'jmax-bibtex-journal-abbreviations
201   '("JIR" "Journal of Irreproducible Research" "J. Irrep. Res."))
202 #+END_SRC
203
204 - jmax-bibtex-generate-longtitles :: Generate a bib file with long titles as
205      defined in `jmax-bibtex-journal-abbreviations'
206 - jmax-bibtex-generate-shorttitles :: Generate a bib file with short titles as
207      defined in `jmax-bibtex-journal-abbreviations'
208
209 *** Modifying bibtex entries
210
211 - jmax-stringify-journal-name :: replace a journal name with a string in
212      `jmax-bibtex-journal-abbreviations'
213 - jmax-set-journal-string :: in a bibtex entry run this to replace the journal
214      with a string selected interactively.
215
216 - jmax-title-case-article :: title case the title in an article entry.
217 - jmax-sentence-case-article :: sentence case the title in an article entry.
218
219 - jmax-replace-nonascii :: replace nonascii characters in a bibtex
220      entry. Replacements are in `jmax-nonascii-latex-replacements'. This
221      function is a hook function in org-ref-clean-bibtex-entry.
222
223 The non-ascii characters are looked up in a list of cons cells. You can add your own non-ascii replacements like this. Note backslashes must be escaped doubly, so one \ is \\\\ in the cons cell.
224
225 #+BEGIN_SRC emacs-lisp
226 (add-to-list 'jmax-nonascii-latex-replacements
227   '("æ" . "{\\\\ae}"))
228 #+END_SRC
229
230 These functions are compatible with bibtex-map-entries, so it is possible to conveniently apply them to all the entries in a file like this:
231
232 #+BEGIN_SRC emacs-lisp
233 (bibtex-map-entries 'jmax-title-case-article)
234 #+END_SRC
235
236
237 *** Bibtex entry navigation
238 - jmax-bibtex-next-entry :: bound to M-n
239 - jmax-bibtex-previous-entry :: bound to M-p
240
241 *** Hydra menus for bibtex entries and files
242 - Functions to act on a bibtex entry or file
243   - jmax-bibtex-hydra/body :: gives a hydra menu to a lot of useful functions
244        like opening the pdf, or the entry in a browser, or searching in a
245        variety of scientific search engines.
246   - jmax-bibtex-new-entry/body :: gives a hydra menu to add new bibtex entries.
247   - jmax-bibtex-file/body :: gives a hydra menu of actions for the bibtex file.
248
249 You will want to bind the hydra menus to a key. You only need to bind the first one, as the second and third can be accessed from the first hydra.
250 You can do that like this before you require jmax-bibtex:
251
252 #+BEGIN_SRC emacs-lisp
253 (setq jmax-bibtex-hydra-key-binding "\C-cj")
254 #+END_SRC
255
256 Or this if you like key-chord:
257
258 #+BEGIN_SRC emacs-lisp
259 (key-chord-define-global "jj" 'jmax-bibtex-hydra/body)
260 #+END_SRC
261
262 ** isbn
263 #+BEGIN_SRC emacs-lisp
264 (require 'isbn)
265 #+END_SRC
266
267 This library provides some functions to get bibtex entries for books from their ISBN.
268
269 - isbn-to-bibtex
270
271 ** pubmed
272 #+BEGIN_SRC emacs-lisp
273 (require 'pubmed)
274 #+END_SRC
275
276 This library provides a number of new org-mode links to Pubmed entries. See http://www.ncbi.nlm.nih.gov/pmc/about/public-access-info/#p3 for details of these identifiers.
277
278 pmcid:PMC3498956
279
280 pmid:23162369
281
282 nihmsid:NIHMS395714
283
284 Also, you can retrieve a bibtex entry for a PMID with
285
286 - pubmed-insert-bibtex-from-pmid
287
288 ** arxiv
289 #+BEGIN_SRC emacs-lisp
290 (require 'arxiv)
291 #+END_SRC
292
293 This library provides an org-mode link to http://arxiv.org entries:  arxiv:cond-mat/0410285, and a function to get a bibtex entry and pdfs for arxiv entries:
294
295 - arxiv-add-bibtex-entry
296 - arxiv-get-pdf
297
298 ** sci-id
299 #+BEGIN_SRC emacs-lisp
300 (require 'sci-id)
301 #+END_SRC
302
303 This package just defines two new org-mode links for http://www.orcid.org, and http://www.researcherid.com. Here are two examples:
304
305 orcid:0000-0003-2625-9232
306
307 researcherid:A-2363-2010
308
309 ** x2bib
310 #+BEGIN_SRC emacs-lisp
311 (require 'x2bib)
312 #+END_SRC
313
314 If you find you need to convert some bibliographies in some format into bibtex, this library is a starting point. This code is mostly wrappers around the command line utilities at http://sourceforge.net/p/bibutils/home/Bibutils. I thankfully have not had to use this often, but it is here when I need it again.
315
316 - ris2bib :: Convert an RIS file to a bibtex file.
317 - medxml2bib :: Convert Pubmed XML to bibtex.
318 - clean-entries :: Map over a converted bibtex file and "clean it".
319
320 * Appendix
321 ** Customizing org-ref
322    :PROPERTIES:
323    :ID:       32B558A3-7B48-4581-982B-082017B0AEE8
324    :END:
325 You will probably want to customize a few variables before using org-ref extensively. One way to do this is through the Emacs customization interface: [[elisp:(customize-group "org-ref")]].
326
327 Here is my minimal setup:
328 #+BEGIN_SRC emacs-lisp
329 (setq reftex-default-bibliography '("~/Dropbox/bibliography/references.bib"))
330
331 (setq org-ref-bibliography-notes "~/Dropbox/bibliography/notes.org"
332       org-ref-default-bibliography '("~/Dropbox/bibliography/references.bib")
333       org-ref-pdf-directory "~/Dropbox/bibliography/bibtex-pdfs/")
334 #+END_SRC
335
336 For jmax-bibtex I like:
337
338 #+BEGIN_SRC emacs-lisp
339 (setq jmax-bibtex-hydra-key-chord "jj")
340 #+END_SRC
341
342 ** Other things org-ref supports
343 *** org-completion
344 Most org-ref links support org-mode completion. You can type C-c C-l to insert a link. You will get completion of the link type, type some characters and press tab. When you select the type, press tab to see the completion options. This works for the following link types:
345
346 - bibliography
347 - bibliographystyle
348 - all cite types
349 - ref
350
351 *** Storing org-links to labels
352     :PROPERTIES:
353     :ID:       AD9663C7-1369-413F-842A-157916D4BB75
354     :CUSTOM_ID: sec-store-links
355     :END:
356 If you are on a label link, or on a table name, or on an org-mode label you can "store" a link to it by typing C-c l. Then you can insert the corresponding ref link with C-c C-l. This will insert a ref link or custom_id link as needed. This usually works, but it is not used by me too often, so it is not tested too deeply.
357
358 *** Storing links to bibtex entries
359 If you have a bibtex file open, you type C-c C-l with your cursor in a bibtex entry to store a link to that entry. In an org-buffer if you then type C-c l, you can enter a cite link.
360
361 *** Indexes
362 org-ref provides links to support making an index in LaTeX. (http://en.wikibooks.org/wiki/LaTeX/Indexing).
363
364 - index :: creates an index entry.
365 - printindex :: Generates a temporary index of clickable entries. Exports to the LaTeX command.
366
367 You will have to incorporate running makeindex into your PDF build command.
368
369 *** Glossaries
370 See http://en.wikibooks.org/wiki/LaTeX/Glossary.
371
372 - newglossaryentry
373 - gls
374 - glspl
375 - Gsl
376 - Glspl
377
378 You will need to incorporate running the command makeglossaries into your PDF build command.
379
380 * References
381 bibliographystyle:unsrtnat
382 # <<bibliography link>>
383 bibliography:org-ref.bib