add more 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 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.
85
86 #+tblname: table-1
87 #+caption: A simple table.
88 | x |
89 | 1 |
90 | 2 |
91
92 Or you can refer to an org-mode label as in Table ref:table-3.
93
94 #+label: table-3
95 #+caption: A simple table.
96 | x |
97 | 1 |
98 | 2 |
99
100 You can also refer to an org-ref label link as in Table ref:tab-ydata.
101
102 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.
103
104 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.
105
106 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.
107
108 **** Miscellaneous ref links  label:sec-misc
109 org-ref also provides a pageref, nameref and eqref link.
110
111 Note for eqref, you must use a LaTeX label like this:
112
113 \begin{equation}
114 e^x = 4 \label{eq:1}
115 \end{equation}
116
117 Then you can refer to Eq. eqref:eq:1 in your documents.
118
119 *** Some other links
120 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.
121
122 ** org-ref customization of helm-bibtex
123 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.
124
125 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.
126
127 ** Some basic org-ref utilities
128 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.
129
130 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:
131
132 1. adds a comma if needed in the first line of the entry
133 2. makes sure the doi field is an actual doi, and not a url.
134 3. fixes bad year entries
135 4. fixes empty pages
136 5. Escapes & to \&
137 6. generate a key according to your setup
138 7. Runs your hook functions
139 8. sorts the fields in the entry
140 9. checks the buffer for non-ascii characters.
141
142 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.
143
144 #+BEGIN_SRC emacs-lisp
145 (add-hook 'org-ref-clean-bibtex-entry-hook 'jmax-replace-nonascii)
146 #+END_SRC
147
148 #+RESULTS:
149 | jmax-title-case-article | jmax-replace-nonascii |
150
151 org-ref-extract-bibtex-entries will create a bibtex file from the citations in the current buffer.
152
153 ** LaTeX export
154 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:
155
156 #+BEGIN_SRC emacs-lisp
157 (setq org-latex-pdf-process
158       '("pdflatex -interaction nonstopmode -output-directory %o %f"
159         "bibtex %b"
160         "pdflatex -interaction nonstopmode -output-directory %o %f"
161         "pdflatex -interaction nonstopmode -output-directory %o %f")
162 #+END_SRC
163
164 ** Other exports
165 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.
166
167 * Other libraries in org-ref
168 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.
169
170 ** doi-utils
171 This library adds two extremely useful tools for getting bibtex entries and pdf files of journal manuscripts. Add this to your emacs setup:
172 #+BEGIN_SRC emacs-lisp
173 (require 'doi-utils)
174 #+END_SRC
175
176 The provides two important commands:
177
178 - doi-utils-add-bibtex-entry-from-doi
179 This will prompt you for a DOI, and a bibtex file, and then try to get the bibtex entry, and pdf of the article.
180
181
182 - doi-utils-add-entry-from-crossref-query
183 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.
184
185 ** jmax-bibtex
186 These are functions I use often in bibtex files.
187
188 *** Generate new bibtex files with adapted journal names
189 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:
190
191 #+BEGIN_SRC emacs-lisp
192 (add-to-list 'jmax-bibtex-journal-abbreviations
193   '("JIR" "Journal of Irreproducible Research" "J. Irrep. Res."))
194 #+END_SRC
195
196 - jmax-bibtex-generate-longtitles :: Generate a bib file with long titles as
197      defined in `jmax-bibtex-journal-abbreviations'
198 - jmax-bibtex-generate-shorttitles :: Generate a bib file with short titles as
199      defined in `jmax-bibtex-journal-abbreviations'
200
201 *** Modifying bibtex entries
202
203 - jmax-stringify-journal-name :: replace a journal name with a string in
204      `jmax-bibtex-journal-abbreviations'
205 - jmax-set-journal-string :: in a bibtex entry run this to replace the journal
206      with a string selected interactively.
207
208 - jmax-title-case-article :: title case the title in an article entry.
209 - jmax-sentence-case-article :: sentence case the title in an article entry.
210
211 - jmax-replace-nonascii :: replace nonascii characters in a bibtex
212      entry. Replacements are in `jmax-nonascii-latex-replacements'. This
213      function is a hook function in org-ref-clean-bibtex-entry.
214
215 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.
216
217 #+BEGIN_SRC emacs-lisp
218 (add-to-list 'jmax-nonascii-latex-replacements
219   '("æ" . "{\\\\ae}"))
220 #+END_SRC
221
222 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:
223
224 #+BEGIN_SRC emacs-lisp
225 (bibtex-map-entries 'jmax-title-case-article)
226 #+END_SRC
227
228
229 *** Bibtex entry navigation
230 - jmax-bibtex-next-entry :: bound to M-n
231 - jmax-bibtex-previous-entry :: bound to M-p
232
233 *** Hydra menus for bibtex entries and files
234 - Functions to act on a bibtex entry or file
235   - jmax-bibtex-hydra/body :: gives a hydra menu to a lot of useful functions
236        like opening the pdf, or the entry in a browser, or searching in a
237        variety of scientific search engines.
238   - jmax-bibtex-new-entry/body :: gives a hydra menu to add new bibtex entries.
239   - jmax-bibtex-file/body :: gives a hydra menu of actions for the bibtex file.
240
241 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.
242 You can do that like this before you require jmax-bibtex:
243
244 #+BEGIN_SRC emacs-lisp
245 (setq jmax-bibtex-hydra-key-binding "\C-cj")
246 #+END_SRC
247
248 Or this if you like key-chord:
249
250 #+BEGIN_SRC emacs-lisp
251 (key-chord-define-global "jj" 'jmax-bibtex-hydra/body)
252 #+END_SRC
253
254 ** isbn
255 #+BEGIN_SRC emacs-lisp
256 (require 'isbn)
257 #+END_SRC
258
259 This library provides some functions to get bibtex entries for books from their ISBN.
260
261 - isbn-to-bibtex
262
263 ** pubmed
264 #+BEGIN_SRC emacs-lisp
265 (require 'pubmed)
266 #+END_SRC
267
268 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.
269
270 pmcid:PMC3498956
271
272 pmid:23162369
273
274 nihmsid:NIHMS395714
275
276 Also, you can retrieve a bibtex entry for a PMID with
277
278 - pubmed-insert-bibtex-from-pmid
279
280 ** arxiv
281 #+BEGIN_SRC emacs-lisp
282 (require 'arxiv)
283 #+END_SRC
284
285 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:
286
287 - arxiv-add-bibtex-entry
288 - arxiv-get-pdf
289
290 ** sci-id
291 #+BEGIN_SRC emacs-lisp
292 (require 'sci-id)
293 #+END_SRC
294
295 This package just defines two new org-mode links for http://www.orcid.org, and http://www.researcherid.com. Here are two examples:
296
297 orcid:0000-0003-2625-9232
298
299 researcherid:A-2363-2010
300
301 * Appendix
302 ** Customizing org-ref
303    :PROPERTIES:
304    :ID:       32B558A3-7B48-4581-982B-082017B0AEE8
305    :END:
306 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")]].
307
308 Here is my minimal setup:
309 #+BEGIN_SRC emacs-lisp
310 (setq reftex-default-bibliography '("~/Dropbox/bibliography/references.bib"))
311
312 (setq org-ref-bibliography-notes "~/Dropbox/bibliography/notes.org"
313       org-ref-default-bibliography '("~/Dropbox/bibliography/references.bib")
314       org-ref-pdf-directory "~/Dropbox/bibliography/bibtex-pdfs/")
315 #+END_SRC
316
317 For jmax-bibtex I like:
318
319 #+BEGIN_SRC emacs-lisp
320 (setq jmax-bibtex-hydra-key-chord "jj")
321 #+END_SRC
322
323 ** Other things org-ref supports
324 *** org-completion
325 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:
326
327 - bibliography
328 - bibliographystyle
329 - all cite types
330 - ref
331
332 *** Storing org-links to labels
333     :PROPERTIES:
334     :ID:       AD9663C7-1369-413F-842A-157916D4BB75
335     :CUSTOM_ID: sec-store-links
336     :END:
337 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.
338
339
340 * References
341 bibliographystyle:unsrtnat
342 # <<bibliography link>>
343 bibliography:org-ref.bib