b04c1a13be61997ae722b404ad6ad1c950d9b1d4
[org-ref.git] / org-ref.org
1 #+TITLE: Org-ref - The best reference handling for org-mode
2 #+AUTHOR: John Kitchin
3 #+DATE: April 29, 2014
4
5 * Introduction
6
7 This document is an experiment at creating a literate program to provide similar features as reftex for org-mode referencing. These features include:
8
9 1. using completion to create links
10 2. storing links to places,
11 3. Clickable links that do useful things
12 4. Exportable links to LaTeX
13 5. Utility functions for dealing with bibtex files and org-files
14
15 ** Header
16 #+BEGIN_SRC emacs-lisp :tangle org-ref.el
17 ;;; org-ref.el --- setup bibliography, cite, ref and label org-mode links.
18
19 ;; Copyright(C) 2014 John Kitchin
20
21 ;; Author: John Kitchin <jkitchin@andrew.cmu.edu>
22 ;; This file is not currently part of GNU Emacs.
23
24 ;; This program is free software; you can redistribute it and/or
25 ;; modify it under the terms of the GNU General Public License as
26 ;; published by the Free Software Foundation; either version 2, or (at
27 ;; your option) any later version.
28
29 ;; This program is distributed in the hope that it will be useful, but
30 ;; WITHOUT ANY WARRANTY; without even the implied warranty of
31 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
32 ;; General Public License for more details.
33
34 ;; You should have received a copy of the GNU General Public License
35 ;; along with this program ; see the file COPYING.  If not, write to
36 ;; the Free Software Foundation, Inc., 59 Temple Place - Suite 330,
37 ;; Boston, MA 02111-1307, USA.
38
39 ;;; Commentary:
40 ;;
41 ;; Lisp code to setup bibliography cite, ref and label org-mode links.  also
42 ;; sets up reftex and helm for org-mode citations. The links are clickable and
43 ;; do things that are useful. You should really read org-ref.org for details.
44 ;;
45 ;; Package-Requires: ((dash) (helm) (helm-bibtex))
46 #+END_SRC
47
48 ** requires
49 The only external require is reftex-cite
50
51 #+BEGIN_SRC emacs-lisp  :tangle org-ref.el
52 (require 'reftex-cite)
53 (require 'dash)
54 (require 'helm)
55 (require 'helm-bibtex)
56 #+END_SRC
57
58 ** Custom variables
59 There are some variables needed later to tell this library where you store your pdf files, where your notes file is, and your default bibliography. This variable is similar to the reftex-default-bibliography. I do not remember why I made it separate.
60
61 #+BEGIN_SRC emacs-lisp  :tangle org-ref.el
62 (defgroup org-ref nil
63   "customization group for org-ref")
64
65 (defcustom org-ref-bibliography-notes
66   nil
67   "filename to where you will put all your notes about an entry in
68   the default bibliography."
69   :type 'file
70   :group 'org-ref)
71
72 (defcustom org-ref-default-bibliography
73   nil
74   "list of bibtex files to search for. You should use full-paths for each file."
75   :type '(repeat :tag "List of bibtex files" file)
76   :group 'org-ref)
77
78 (defcustom org-ref-pdf-directory
79   nil
80   "directory where pdfs are stored by key. put a trailing / in"
81   :type 'directory
82   :group 'org-ref)
83
84 (defcustom org-ref-default-citation-link
85   "cite"
86   "The default type of citation link to use"
87   :type 'string
88   :group 'org-ref)
89
90 (defcustom org-ref-insert-cite-key
91   "C-c ]"
92   "Keyboard shortcut to insert a citation."
93   :type 'string
94   :group 'org-ref)
95
96 (defcustom org-ref-bibliography-entry-format
97   '(("article" . "%a, %t, <i>%j</i>, <b>%v(%n)</b>, %p (%y). <a href=\"%U\">link</a>. <a href=\"http://dx.doi.org/%D\">doi</a>.")
98
99     ("book" . "%a, %t, %u (%y).")
100
101     ("proceedings" . "%e, %t in %S, %u (%y).")
102
103     ("inproceedings" . "%a, %t, %p, in %b, edited by %e, %u (%y)"))
104
105   "string to format an entry. Just the reference, no numbering at the beginning, etc... see the `org-ref-reftex-format-citation' docstring for the escape codes."
106   :type 'string
107   :group 'org-ref)
108
109 (defcustom org-ref-open-notes-function
110   (lambda ()
111     (org-show-entry)
112     (show-branches)
113     (show-children)
114     (org-cycle '(64))
115     ;;(org-tree-to-indirect-buffer)
116     (outline-previous-visible-heading 1)
117     (recenter-top-bottom 0))
118   "User-defined way to open a notes entry. This is excecuted after the entry is found, with the cursor at the beginning of the headline. The default setting fully expands the notes, and moves the headline to the top of the buffer"
119 :type 'function
120 :group 'org-ref)
121
122
123 (defcustom org-ref-open-pdf-function
124    'org-ref-open-pdf-at-point
125 "User-defined function to open a pdf from a link. The function must get the key at point, and derive a path to the pdf file, then open it. The default function is `org-ref-open-pdf-at-point'."
126   :type 'function
127   :group 'org-ref)
128
129
130 (defcustom org-ref-insert-cite-function
131   'org-ref-helm-insert-cite-link
132   "Function to call to insert citation links. The default is `org-ref-helm-insert-cite-link' which uses `helm-bibtex'. org-ref modifies helm-bibtex a little bit to give org-mode citations, and to reorder default actions. You may use `org-ref-insert-cite-link' if you like the reftex interface."
133  :type 'function
134  :group 'org-ref)
135
136
137 (defcustom org-ref-cite-onclick-function
138   'org-ref-cite-click-helm
139   "Function that runs when you click on a cite link. The function must take no arguments. You may also use `org-ref-cite-onclick-minibuffer-menu' if you do not like helm."
140  :type 'function
141  :group 'org-ref)
142
143 (defcustom org-ref-show-citation-on-enter t
144   "If non-nil add a hook function to show the citation summary in
145   the minibuffer just by putting the cursor in a link"
146  :group 'org-ref)
147
148 #+END_SRC
149
150 This next variable determines the citation types that are available in org-ref. Links for each one are automatically generated, and completion functions are automatically generated. Users may add to this list in their own init files.
151
152 #+BEGIN_SRC emacs-lisp  :tangle org-ref.el
153 (defcustom org-ref-cite-types
154   '("cite" "nocite" ;; the default latex cite commands
155     ;; natbib cite commands, http://ctan.unixbrain.com/macros/latex/contrib/natbib/natnotes.pdf
156     "citet" "citet*" "citep" "citep*"
157     "citealt" "citealt*" "citealp" "citealp*"
158     "citenum" "citetext"
159     "citeauthor" "citeauthor*"
160     "citeyear" "citeyear*"
161     "Citet" "Citep" "Citealt" "Citealp" "Citeauthor"
162     ;; biblatex commands
163     ;; http://ctan.mirrorcatalogs.com/macros/latex/contrib/biblatex/doc/biblatex.pdf
164     "Cite"
165     "parencite" "Parencite"
166     "footcite" "footcitetext"
167     "textcite" "Textcite"
168     "smartcite" "Smartcite"
169     "cite*" "parencite*" "supercite"
170     "autocite" "Autocite" "autocite*" "Autocite*"
171     "Citeauthor*"
172     "citetitle" "citetitle*"
173     "citedate" "citedate*"
174     "citeurl"
175     "fullcite" "footfullcite"
176     ;; "volcite" "Volcite" cannot support the syntax
177     "notecite" "Notecite"
178     "pnotecite" "Pnotecite"
179     "fnotecite"
180     ;; multicites. Very limited support for these.
181     "cites" "Cites" "parencites" "Parencites"
182     "footcites" "footcitetexts"
183     "smartcites" "Smartcites" "textcites" "Textcites"
184     "supercites" "autocites" "Autocites"
185     ;; for the bibentry package
186     "bibentry"
187     )
188   "List of citation types known in org-ref"
189   :type '(repeat :tag "List of citation types" string)
190   :group 'org-ref)
191 #+END_SRC
192
193 We need a hook variable to store user-defined bibtex entry cleaning functions
194 #+BEGIN_SRC emacs-lisp :tangle org-ref.el
195 (defcustom org-ref-clean-bibtex-entry-hook nil
196   "Hook that is run in org-ref-clean-bibtex-entry. The functions should take no arguments, and operate on the bibtex entry at point."
197   :group 'org-ref
198   :type 'hook)
199 #+END_SRC
200
201 ** Program variables
202 #+BEGIN_SRC emacs-lisp  :tangle org-ref.el
203 (defvar org-ref-bibliography-files
204   nil
205   "variable to hold bibliography files to be searched")
206 #+END_SRC
207
208 ** org-mode / reftex setup
209
210 We setup reftex here. We use a custom insert cite link function defined here: [[*org-ref-insert-cite-link][org-ref-insert-cite-link]]. We setup reftex to use our org citation format.
211
212 #+BEGIN_SRC emacs-lisp  :tangle org-ref.el
213 (require 'reftex)
214 (defun org-mode-reftex-setup ()
215     (and (buffer-file-name)
216          (file-exists-p (buffer-file-name))
217          (global-auto-revert-mode t)
218          ;; I do not remember why I put this next line in. It doesn't
219          ;; work for org-files. Nothing very bad happens, but it gives
220          ;; an annoying error. Commenting it out for now.
221          ;(reftex-parse-all
222          )
223     (make-local-variable 'reftex-cite-format)
224     (setq reftex-cite-format 'org))
225
226 ;; define key for inserting citations
227 (define-key org-mode-map
228   (kbd org-ref-insert-cite-key)
229   org-ref-insert-cite-function)
230
231 (when org-ref-show-citation-on-enter
232  (setq org-ref-message-timer
233        (run-with-idle-timer 0.5 t 'org-ref-link-message)))
234
235 (defun org-ref-show-link-messages ()
236   "Turn on link messages. You will see a message in the
237 minibuffer when on a cite, ref or label link."
238   (interactive)
239   (setq org-ref-message-timer
240         (run-with-idle-timer 0.5 t 'org-ref-link-message))
241   )
242 (defun org-ref-cancel-link-messages ()
243   "Stop showing messages in minibuffer when on a link."
244   (interactive)
245   (cancel-timer org-ref-message-timer))
246
247 ;; this approach caused the selected region to not be highlighted any more.
248 ; (add-hook 'post-command-hook 'org-ref-link-message))
249 ; (remove-hook 'post-command-hook 'org-ref-link-message))
250
251 (add-hook 'org-mode-hook 'org-mode-reftex-setup)
252
253 (eval-after-load 'reftex-vars
254   '(progn
255       (add-to-list 'reftex-cite-format-builtin
256                    '(org "Org-mode citation"
257                          ((?\C-m . "cite:%l")     ; default
258                           (?d . ",%l")            ; for appending
259                           (?a . "autocite:%l")
260                           (?t . "citet:%l")
261                           (?T . "citet*:%l")
262                           (?p . "citep:%l")
263                           (?P . "citep*:%l")
264                           (?h . "citeauthor:%l")
265                           (?H . "citeauthor*:%l")
266                           (?y . "citeyear:%l")
267                           (?x . "citetext:%l")
268                           (?n . "nocite:%l")
269                           )))))
270 #+END_SRC
271
272 You may want to add new formats to the reftex-cite-format-builtin variable. Here is an example of adding two new formats. Note that this does not create the links.
273
274 #+BEGIN_SRC emacs-lisp :tangle no
275 ;; add new format
276 (setf (nth 2 (assoc 'org reftex-cite-format-builtin))
277       (append (nth 2 (assoc 'org reftex-cite-format-builtin)) '((?W  . "textcite:%l")
278             (?z  . "newcite:%l"))))
279 #+END_SRC
280
281 You can define a new citation link like this:
282 #+BEGIN_SRC emacs-lisp :tangle no
283 (org-ref-define-citation-link "citez" ?z)
284 #+END_SRC
285
286 * Links
287 Most of this library is the creation of functional links to help with references and citations.
288 ** General utilities
289 We need several general utilities for this module. They are organized here. We frequently need to remove white space from the front and back of a string. Here we do that for a string.
290
291 #+BEGIN_SRC emacs-lisp :tangle org-ref.el
292 (defun org-ref-strip-string (string)
293   "strip leading and trailing whitespace from the string"
294   (replace-regexp-in-string
295    (concat search-whitespace-regexp "$" ) ""
296    (replace-regexp-in-string
297     (concat "^" search-whitespace-regexp ) "" string)))
298 #+END_SRC
299
300 It is helpful to make the previous function operate on a list of strings here.
301
302 #+BEGIN_SRC emacs-lisp :tangle org-ref.el
303 (defun org-ref-split-and-strip-string (string)
304   "split key-string and strip keys. Assumes the key-string is comma delimited"
305   (mapcar 'org-ref-strip-string (split-string string ",")))
306 #+END_SRC
307
308 ** bibliography and bibliographystyle
309 *** An html bibliography
310
311 Reftex is no longer being developed. I want a url and doi option for formatting, so I am modifying this [[file:emacs-24.3/lisp/textmodes/reftex-cite.el::(defun%20reftex-format-citation%20(entry%20format)][function]] from reftex-cite to provide that. We need to modify the reftex-get-bib-field code a bit to remove enclosing braces and quotes so we can make nice looking links.
312
313 #+BEGIN_SRC emacs-lisp :tangle org-ref.el
314 (defun org-ref-reftex-get-bib-field (field entry &optional format)
315   "similar to reftex-get-bib-field, but removes enclosing braces and quotes"
316   (let ((result))
317     (setq result (reftex-get-bib-field field entry format))
318     (when (and (not (string= result "")) (string= "{" (substring result 0 1)))
319       (setq result (substring result 1 -1)))
320     (when (and (not (string= result "")) (string= "\"" (substring result 0 1)))
321       (setq result (substring result 1 -1)))
322       result))
323
324 (defun org-ref-reftex-format-citation (entry format)
325   "return a formatted string for the bibtex entry (from bibtex-parse-entry) according
326 to the format argument. The format is a string with these percent escapes.
327
328 In the format, the following percent escapes will be expanded.
329
330 %l   The BibTeX label of the citation.
331 %a   List of author names, see also `reftex-cite-punctuation'.
332 %2a  Like %a, but abbreviate more than 2 authors like Jones et al.
333 %A   First author name only.
334 %e   Works like %a, but on list of editor names. (%2e and %E work a well)
335
336 It is also possible to access all other BibTeX database fields:
337 %b booktitle     %c chapter        %d edition    %h howpublished
338 %i institution   %j journal        %k key        %m month
339 %n number        %o organization   %p pages      %P first page
340 %r address       %s school         %u publisher  %t title
341 %v volume        %y year
342 %B booktitle, abbreviated          %T title, abbreviated
343 %U url
344 %D doi
345 %S series
346
347 Usually, only %l is needed.  The other stuff is mainly for the echo area
348 display, and for (setq reftex-comment-citations t).
349
350 %< as a special operator kills punctuation and space around it after the
351 string has been formatted.
352
353 A pair of square brackets indicates an optional argument, and RefTeX
354 will prompt for the values of these arguments.
355
356 Beware that all this only works with BibTeX database files.  When
357 citations are made from the \bibitems in an explicit thebibliography
358 environment, only %l is available."
359   ;; Format a citation from the info in the BibTeX ENTRY
360
361   (unless (stringp format) (setq format "\\cite{%l}"))
362
363   (if (and reftex-comment-citations
364            (string-match "%l" reftex-cite-comment-format))
365       (error "reftex-cite-comment-format contains invalid %%l"))
366
367   (while (string-match
368           "\\(\\`\\|[^%]\\)\\(\\(%\\([0-9]*\\)\\([a-zA-Z]\\)\\)[.,;: ]*\\)"
369           format)
370     (let ((n (string-to-number (match-string 4 format)))
371           (l (string-to-char (match-string 5 format)))
372           rpl b e)
373       (save-match-data
374         (setq rpl
375               (cond
376                ((= l ?l) (concat
377                           (org-ref-reftex-get-bib-field "&key" entry)
378                           (if reftex-comment-citations
379                               reftex-cite-comment-format
380                             "")))
381                ((= l ?a) (reftex-format-names
382                           (reftex-get-bib-names "author" entry)
383                           (or n 2)))
384                ((= l ?A) (car (reftex-get-bib-names "author" entry)))
385                ((= l ?b) (org-ref-reftex-get-bib-field "booktitle" entry "in: %s"))
386                ((= l ?B) (reftex-abbreviate-title
387                           (org-ref-reftex-get-bib-field "booktitle" entry "in: %s")))
388                ((= l ?c) (org-ref-reftex-get-bib-field "chapter" entry))
389                ((= l ?d) (org-ref-reftex-get-bib-field "edition" entry))
390                ((= l ?D) (org-ref-reftex-get-bib-field "doi" entry))
391                ((= l ?e) (reftex-format-names
392                           (reftex-get-bib-names "editor" entry)
393                           (or n 2)))
394                ((= l ?E) (car (reftex-get-bib-names "editor" entry)))
395                ((= l ?h) (org-ref-reftex-get-bib-field "howpublished" entry))
396                ((= l ?i) (org-ref-reftex-get-bib-field "institution" entry))
397                ((= l ?j) (org-ref-reftex-get-bib-field "journal" entry))
398                ((= l ?k) (org-ref-reftex-get-bib-field "key" entry))
399                ((= l ?m) (org-ref-reftex-get-bib-field "month" entry))
400                ((= l ?n) (org-ref-reftex-get-bib-field "number" entry))
401                ((= l ?o) (org-ref-reftex-get-bib-field "organization" entry))
402                ((= l ?p) (org-ref-reftex-get-bib-field "pages" entry))
403                ((= l ?P) (car (split-string
404                                (org-ref-reftex-get-bib-field "pages" entry)
405                                "[- .]+")))
406                ((= l ?s) (org-ref-reftex-get-bib-field "school" entry))
407                ((= l ?S) (org-ref-reftex-get-bib-field "series" entry))
408                ((= l ?u) (org-ref-reftex-get-bib-field "publisher" entry))
409                ((= l ?U) (org-ref-reftex-get-bib-field "url" entry))
410                ((= l ?r) (org-ref-reftex-get-bib-field "address" entry))
411                ;; strip enclosing brackets from title if they are there
412                ((= l ?t) (org-ref-reftex-get-bib-field "title" entry))
413                ((= l ?T) (reftex-abbreviate-title
414                           (org-ref-reftex-get-bib-field "title" entry)))
415                ((= l ?v) (org-ref-reftex-get-bib-field "volume" entry))
416                ((= l ?y) (org-ref-reftex-get-bib-field "year" entry)))))
417
418       (if (string= rpl "")
419           (setq b (match-beginning 2) e (match-end 2))
420         (setq b (match-beginning 3) e (match-end 3)))
421       (setq format (concat (substring format 0 b) rpl (substring format e)))))
422   (while (string-match "%%" format)
423     (setq format (replace-match "%" t t format)))
424   (while (string-match "[ ,.;:]*%<" format)
425     (setq format (replace-match "" t t format)))
426   ;; also replace carriage returns, tabs, and multiple whitespaces
427   (setq format (replace-regexp-in-string "\n\\|\t\\|\s+" " " format))
428   format)
429
430 (defun org-ref-get-bibtex-entry-citation (key)
431   "returns a string for the bibliography entry corresponding to key, and formatted according to the type in `org-ref-bibliography-entry-format'"
432
433   (let ((org-ref-bibliography-files (org-ref-find-bibliography))
434         (file) (entry) (bibtex-entry) (entry-type) (format))
435
436     (setq file (catch 'result
437                  (loop for file in org-ref-bibliography-files do
438                        (if (org-ref-key-in-file-p key (file-truename file))
439                            (throw 'result file)
440                          (message "%s not found in %s" key (file-truename file))))))
441
442     (with-temp-buffer
443       (insert-file-contents file)
444       (bibtex-search-entry key nil 0)
445       (setq bibtex-entry (bibtex-parse-entry))
446       (setq entry-type (downcase (cdr (assoc "=type=" bibtex-entry))))
447       (setq format (cdr (assoc entry-type org-ref-bibliography-entry-format)))
448       (if format
449           (setq entry  (org-ref-reftex-format-citation bibtex-entry format))
450         (save-restriction
451           (bibtex-narrow-to-entry)
452           (setq entry (buffer-string)))))
453     entry))
454 #+END_SRC
455
456 #+RESULTS:
457 : org-ref-reftex-format-citation
458
459 Here is how to use the function. You call it with point in an entry in a bibtex file.
460
461 #+BEGIN_SRC emacs-lisp :tangle no
462 (let((org-ref-bibliography-entry-format   "%a, %t, <i>%j</i>, <b>%v(%n)</b>, %p (%y). <a href=\"%U\">link</a>. <a href=\"http://dx.doi.org/%D\">doi</a>."))
463   (org-ref-get-bibtex-entry-citation  "armiento-2014-high"))
464 #+END_SRC
465 #+RESULTS:
466 : Armiento, Kozinsky, Hautier, , Fornari \& Ceder, High-throughput screening of perovskite alloys for  piezoelectric performance and thermodynamic  stability, <i>Phys. Rev. B</i>, <b>89()</b>, 134103 (2014). <a href="http://link.aps.org/doi/10.1103/PhysRevB.89.134103">link</a>. <a href="http://dx.doi.org/10.1103/PhysRevB.89.134103">doi</a>.
467
468 I am not sure why full author names are not used.
469
470 This code provides some functions to generate a simple sorted bibliography in html. First we get all the keys in the buffer.
471
472 #+BEGIN_SRC emacs-lisp :tangle org-ref.el
473 (defun org-ref-get-bibtex-keys ()
474   "return a list of unique keys in the buffer."
475   (let ((keys '()))
476     (org-element-map (org-element-parse-buffer) 'link
477       (lambda (link)
478         (let ((plist (nth 1 link)))
479           (when (-contains? org-ref-cite-types (plist-get plist ':type))
480             (dolist
481                 (key
482                  (org-ref-split-and-strip-string (plist-get plist ':path)))
483               (when (not (-contains? keys key))
484                 (setq keys (append keys (list key)))))))))
485     ;; Sort keys alphabetically
486     (setq keys (cl-sort keys 'string-lessp :key 'downcase))
487     keys))
488 #+END_SRC
489
490 This function gets the html for one entry.
491
492 #+BEGIN_SRC emacs-lisp :tangle org-ref.el
493 (defun org-ref-get-bibtex-entry-html (key)
494   "returns an html string for the bibliography entry corresponding to key"
495
496   (format "<li><a id=\"%s\">[%s] %s</a></li>" key key (org-ref-get-bibtex-entry-citation key)))
497 #+END_SRC
498
499 Now, we map over the whole list of keys, and the whole bibliography, formatted as an unordered list.
500
501 #+BEGIN_SRC emacs-lisp :tangle org-ref.el
502 (defun org-ref-get-html-bibliography ()
503   "Create an html bibliography when there are keys"
504   (let ((keys (org-ref-get-bibtex-keys)))
505     (when keys
506       (concat "<h1>Bibliography</h1>
507 <ul>"
508               (mapconcat (lambda (x) (org-ref-get-bibtex-entry-html x)) keys "\n")
509               "\n</ul>"))))
510 #+END_SRC
511
512 I do not have plans to make a numbered bibliography with numbered citations anytime soon. This will require changing the way the citation links are exported, and keeping track of the numbers.
513
514 *** An org bibliography
515 You can export an org-file to an org-file or org-buffer (org-org-epxort-as-org). In this case, it would be useful convert the cite links to links to custom_ids, and the bibliography link to a first-level heading Bibliography with org-bibtex like headings for each entry. This code should enable this. Right now, it does not appear to work for org export though.
516
517 First, we get the string for a single entry.
518 #+BEGIN_SRC emacs-lisp :tangle org-ref.el
519 (defun org-ref-get-bibtex-entry-org (key)
520   "returns an org string for the bibliography entry corresponding to key"
521   (let ((org-ref-bibliography-files (org-ref-find-bibliography))
522         (file) (entry) (bibtex-entry) (entry-type) (format))
523
524     (setq file (catch 'result
525                  (loop for file in org-ref-bibliography-files do
526                        (if (org-ref-key-in-file-p key (file-truename file))
527                            (throw 'result file)
528                          (message "%s not found in %s" key (file-truename file))))))
529
530     (with-temp-buffer
531       (insert-file-contents file)
532       (bibtex-search-entry key nil 0)
533       (setq entry (bibtex-parse-entry))
534       (format "** %s - %s
535   :PROPERTIES:
536   %s
537   :END:
538 " (org-ref-reftex-get-bib-field "author" entry)
539 (org-ref-reftex-get-bib-field "title" entry)
540 (concat "   :CUSTOM_ID: " (org-ref-reftex-get-bib-field "=key=" entry) "\n"
541         (mapconcat (lambda (element) (format "   :%s: %s"
542                                              (upcase (car element))
543                                              (cdr element)))
544                    entry
545                    "\n"))))))
546 #+END_SRC
547
548 Now, we loop over the keys, and combine all the entries into a bibliography.
549 #+BEGIN_SRC emacs-lisp :tangle org-ref.el
550 (defun org-ref-get-org-bibliography ()
551   "Create an org bibliography when there are keys"
552   (let ((keys (org-ref-get-bibtex-keys)))
553     (when keys
554       (concat "* Bibliography
555 "
556               (mapconcat (lambda (x) (org-ref-get-bibtex-entry-org x)) keys "\n")
557               "\n"))))
558 #+END_SRC
559
560 *** An ascii bibliography
561
562 This function gets the html for one entry.
563
564 #+BEGIN_SRC emacs-lisp :tangle org-ref.el
565 (defun org-ref-get-bibtex-entry-ascii (key)
566   "returns an ascii string for the bibliography entry corresponding to key"
567
568   (format "[%s] %s" key (org-ref-get-bibtex-entry-citation key)))
569 #+END_SRC
570
571 Now, we map over the whole list of keys, and the whole bibliography, formatted as an unordered list.
572
573 #+BEGIN_SRC emacs-lisp :tangle org-ref.el
574 (defun org-ref-get-ascii-bibliography ()
575   "Create an html bibliography when there are keys"
576   (let ((keys (org-ref-get-bibtex-keys)))
577     (when keys
578       (concat
579 "Bibliography
580 =============
581 "
582               (mapconcat (lambda (x) (org-ref-get-bibtex-entry-ascii x)) keys "\n")
583               "\n"))))
584 #+END_SRC
585
586
587 *** the links
588 We use a link for the bibliography so that we can click on it to open the bibliography file. The link may have more than one bibliography file in it, separated by commas. Clicking opens the file under the cursor. The bibliographies should be full filenames with the bib extension. Clicking on this link makes reftex-default-bibliography local and sets it to the list of files in the link. We need this to use reftex's searching capability.
589
590 #+BEGIN_SRC emacs-lisp :tangle org-ref.el
591 (org-add-link-type "bibliography"
592                    ;; this code is run on clicking. The bibliography
593                    ;; may contain multiple files. this code finds the
594                    ;; one you clicked on and opens it.
595                    (lambda (link-string)
596                        ;; get link-string boundaries
597                        ;; we have to go to the beginning of the line, and then search forward
598
599                      (let* ((bibfile)
600                             ;; object is the link you clicked on
601                             (object (org-element-context))
602                             (link-string-beginning)
603                             (link-string-end))
604
605                      (save-excursion
606                        (goto-char (org-element-property :begin object))
607                        (search-forward link-string nil nil 1)
608                        (setq link-string-beginning (match-beginning 0))
609                        (setq link-string-end (match-end 0)))
610
611                        ;; We set the reftex-default-bibliography
612                        ;; here. it should be a local variable only in
613                        ;; the current buffer. We need this for using
614                        ;; reftex to do citations.
615                        (set (make-local-variable 'reftex-default-bibliography)
616                             (split-string (org-element-property :path object) ","))
617
618                        ;; now if we have comma separated bibliographies
619                        ;; we find the one clicked on. we want to
620                        ;; search forward to next comma from point
621                        (save-excursion
622                          (if (search-forward "," link-string-end 1 1)
623                              (setq key-end (- (match-end 0) 1)) ; we found a match
624                            (setq key-end (point)))) ; no comma found so take the point
625                        ;; and backward to previous comma from point
626                        (save-excursion
627                          (if (search-backward "," link-string-beginning 1 1)
628                              (setq key-beginning (+ (match-beginning 0) 1)) ; we found a match
629                            (setq key-beginning (point)))) ; no match found
630                        ;; save the key we clicked on.
631                        (setq bibfile (org-ref-strip-string (buffer-substring key-beginning key-end)))
632                        (find-file bibfile))) ; open file on click
633
634                      ;; formatting code
635                    (lambda (keyword desc format)
636                      (cond
637                       ((eq format 'org) (org-ref-get-org-bibliography))
638                       ((eq format 'ascii) (org-ref-get-ascii-bibliography))
639                       ((eq format 'html) (org-ref-get-html-bibliography))
640                       ((eq format 'latex)
641                        ;; write out the latex bibliography command
642                        (format "\\bibliography{%s}" (replace-regexp-in-string  "\\.bib" "" (mapconcat 'identity
643                                                                                                       (mapcar 'expand-file-name
644                                                                                                               (split-string keyword ","))
645                                                                                                       ",")))))))
646
647 #+END_SRC
648
649 Believe it or not, sometimes it makes sense /not/ to include the bibliography in a document (e.g. when you are required to submit references as a separate file). To generate the references,  in another file, you must make a little tex file with these contents, and then compile it.
650
651 #+BEGIN_LaTeX
652   \input{project-description.bbl}
653 #+END_LaTeX
654
655 Here, we make a =nobibliography= link that acts like the bibliography, enables creation of the bbl file, but does not put an actual bibliography in the file.
656
657 #+BEGIN_SRC emacs-lisp :tangle org-ref.el
658 (org-add-link-type "nobibliography"
659                    ;; this code is run on clicking. The bibliography
660                    ;; may contain multiple files. this code finds the
661                    ;; one you clicked on and opens it.
662                    (lambda (link-string)
663                        ;; get link-string boundaries
664                        ;; we have to go to the beginning of the line, and then search forward
665
666                      (let* ((bibfile)
667                             ;; object is the link you clicked on
668                             (object (org-element-context))
669
670                             (link-string-beginning)
671                             (link-string-end))
672
673                      (save-excursion
674                        (goto-char (org-element-property :begin object))
675                        (search-forward link-string nil nil 1)
676                        (setq link-string-beginning (match-beginning 0))
677                        (setq link-string-end (match-end 0)))
678
679                        ;; We set the reftex-default-bibliography
680                        ;; here. it should be a local variable only in
681                        ;; the current buffer. We need this for using
682                        ;; reftex to do citations.
683                        (set (make-local-variable 'reftex-default-bibliography)
684                             (split-string (org-element-property :path object) ","))
685
686                        ;; now if we have comma separated bibliographies
687                        ;; we find the one clicked on. we want to
688                        ;; search forward to next comma from point
689                        (save-excursion
690                          (if (search-forward "," link-string-end 1 1)
691                              (setq key-end (- (match-end 0) 1)) ; we found a match
692                            (setq key-end (point)))) ; no comma found so take the point
693                        ;; and backward to previous comma from point
694                        (save-excursion
695                          (if (search-backward "," link-string-beginning 1 1)
696                              (setq key-beginning (+ (match-beginning 0) 1)) ; we found a match
697                            (setq key-beginning (point)))) ; no match found
698                        ;; save the key we clicked on.
699                        (setq bibfile (org-ref-strip-string (buffer-substring key-beginning key-end)))
700                        (find-file bibfile))) ; open file on click
701
702                      ;; formatting code
703                    (lambda (keyword desc format)
704                      (cond
705                       ((eq format 'org) (org-ref-get-org-bibliography))
706                       ((eq format 'ascii) (org-ref-get-ascii-bibliography))
707                       ((eq format 'html) (org-ref-get-html-bibliography))
708                       ((eq format 'latex)
709                        ;; write out the latex bibliography command
710
711 ;                      (format "{\\setbox0\\vbox{\\bibliography{%s}}}"
712 ;                              (replace-regexp-in-string  "\\.bib" "" (mapconcat 'identity
713 ;                                                                                (mapcar 'expand-file-name
714 ;                                                                                        (split-string keyword ","))
715 ;                                                                                ",")))
716
717                        (format "\\nobibliography{%s}"
718                                (replace-regexp-in-string  "\\.bib" "" (mapconcat 'identity
719                                                                                  (mapcar 'expand-file-name
720                                                                                          (split-string keyword ","))
721                                                                                  ",")))
722
723                        ))))
724 #+END_SRC
725
726 #+BEGIN_SRC emacs-lisp :tangle org-ref.el
727 (org-add-link-type "printbibliography"
728                    (lambda (arg) (message "Nothing implemented for clicking here."))
729                    (lambda (keyword desc format)
730                      (cond
731                       ((eq format 'org) (org-ref-get-org-bibliography))
732                       ((eq format 'html) (org-ref-get-html-bibliography))
733                       ((eq format 'latex)
734                        ;; write out the biblatex bibliography command
735                        "\\printbibliography"))
736 ))
737 #+END_SRC
738
739 We also create a bibliographystyle link. There is nothing to do on clicking here, and we create it for consistency. This sets the style for latex export, so use something appropriate there, e.g. unsrt, plain, plainnat, ...
740
741 #+BEGIN_SRC emacs-lisp :tangle org-ref.el
742 (org-add-link-type "bibliographystyle"
743                    (lambda (arg) (message "Nothing implemented for clicking here."))
744                    (lambda (keyword desc format)
745                      (cond
746                       ((eq format 'latex)
747                        ;; write out the latex bibliography command
748                        (format "\\bibliographystyle{%s}" keyword)))))
749 #+END_SRC
750
751 *** Completion for bibliography link
752 It would be nice
753
754 #+BEGIN_SRC emacs-lisp :tangle org-ref.el
755 (defun org-bibliography-complete-link (&optional arg)
756  (format "bibliography:%s" (read-file-name "enter file: " nil nil t)))
757
758 (defun org-ref-insert-bibliography-link ()
759   "insert a bibliography with completion"
760   (interactive)
761   (insert (org-bibliography-complete-link)))
762 #+END_SRC
763
764 ** addbibresource
765 This is apparently used for biblatex.
766 #+BEGIN_SRC emacs-lisp :tangle org-ref.el
767 (org-add-link-type "addbibresource"
768                    ;; this code is run on clicking. The addbibresource
769                    ;; may contain multiple files. this code finds the
770                    ;; one you clicked on and opens it.
771                    (lambda (link-string)
772                        ;; get link-string boundaries
773                        ;; we have to go to the beginning of the line, and then search forward
774
775                      (let* ((bibfile)
776                             ;; object is the link you clicked on
777                             (object (org-element-context))
778
779                             (link-string-beginning)
780                             (link-string-end))
781
782                      (save-excursion
783                        (goto-char (org-element-property :begin object))
784                        (search-forward link-string nil nil 1)
785                        (setq link-string-beginning (match-beginning 0))
786                        (setq link-string-end (match-end 0)))
787
788                        ;; We set the reftex-default-addbibresource
789                        ;; here. it should be a local variable only in
790                        ;; the current buffer. We need this for using
791                        ;; reftex to do citations.
792                        (set (make-local-variable 'reftex-default-addbibresource)
793                             (split-string (org-element-property :path object) ","))
794
795                        ;; now if we have comma separated bibliographies
796                        ;; we find the one clicked on. we want to
797                        ;; search forward to next comma from point
798                        (save-excursion
799                          (if (search-forward "," link-string-end 1 1)
800                              (setq key-end (- (match-end 0) 1)) ; we found a match
801                            (setq key-end (point)))) ; no comma found so take the point
802                        ;; and backward to previous comma from point
803                        (save-excursion
804                          (if (search-backward "," link-string-beginning 1 1)
805                              (setq key-beginning (+ (match-beginning 0) 1)) ; we found a match
806                            (setq key-beginning (point)))) ; no match found
807                        ;; save the key we clicked on.
808                        (setq bibfile (org-ref-strip-string (buffer-substring key-beginning key-end)))
809                        (find-file bibfile))) ; open file on click
810
811                      ;; formatting code
812                    (lambda (keyword desc format)
813                      (cond
814                       ((eq format 'html) (format "")); no output for html
815                       ((eq format 'latex)
816                          ;; write out the latex addbibresource command
817                        (format "\\addbibresource{%s}" keyword)))))
818 #+END_SRC
819
820 ** List of Figures
821
822 In long documents, a list of figures is not uncommon. Here we create a clickable link that generates a temporary buffer containing a list of figures in the document, and their captions. We make a function that can be called interactively, and define a link type that is rendered in LaTeX to create the list of figures.
823
824 #+BEGIN_SRC emacs-lisp :tangle org-ref.el
825 (defun org-ref-list-of-figures (&optional arg)
826   "Generate buffer with list of figures in them"
827   (interactive)
828   (save-excursion (widen)
829   (let* ((c-b (buffer-name))
830          (counter 0)
831          (list-of-figures
832           (org-element-map (org-element-parse-buffer) 'link
833             (lambda (link)
834               "create a link for to the figure"
835               (when
836                   (and (string= (org-element-property :type link) "file")
837                        (string-match-p
838                         "[^.]*\\.\\(png\\|jpg\\|eps\\|pdf\\)$"
839                         (org-element-property :path link)))
840                 (incf counter)
841
842                 (let* ((start (org-element-property :begin link))
843                        (parent (car (cdr (org-element-property :parent link))))
844                        (caption (caaar (plist-get parent :caption)))
845                        (name (plist-get parent :name)))
846                   (if caption
847                       (format
848                        "[[elisp:(progn (switch-to-buffer \"%s\")(widen)(goto-char %s))][figure %s: %s]] %s\n"
849                        c-b start counter (or name "") caption)
850                     (format
851                      "[[elisp:(progn (switch-to-buffer \"%s\")(widen)(goto-char %s))][figure %s: %s]]\n"
852                      c-b start counter (or name "")))))))))
853     (switch-to-buffer "*List of Figures*")
854     (setq buffer-read-only nil)
855     (org-mode)
856     (erase-buffer)
857     (insert (mapconcat 'identity list-of-figures ""))
858     (setq buffer-read-only t)
859     (use-local-map (copy-keymap org-mode-map))
860     (local-set-key "q" #'(lambda () (interactive) (kill-buffer))))))
861
862 (org-add-link-type
863  "list-of-figures"
864  'org-ref-list-of-figures ; on click
865  (lambda (keyword desc format)
866    (cond
867     ((eq format 'latex)
868      (format "\\listoffigures")))))
869 #+END_SRC
870
871 ** List of Tables
872
873 #+BEGIN_SRC emacs-lisp  :tangle org-ref.el
874 (defun org-ref-list-of-tables (&optional arg)
875   "Generate a buffer with a list of tables"
876   (interactive)
877   (save-excursion
878   (widen)
879   (let* ((c-b (buffer-name))
880          (counter 0)
881          (list-of-tables
882           (org-element-map (org-element-parse-buffer 'element) 'table
883             (lambda (table)
884               "create a link for to the table"
885               (incf counter)
886               (let ((start (org-element-property :begin table))
887                     (name  (org-element-property :name table))
888                     (caption (caaar (org-element-property :caption table))))
889                 (if caption
890                     (format
891                      "[[elisp:(progn (switch-to-buffer \"%s\")(widen)(goto-char %s))][table %s: %s]] %s\n"
892                      c-b start counter (or name "") caption)
893                   (format
894                    "[[elisp:(progn (switch-to-buffer \"%s\")(widen)(goto-char %s))][table %s: %s]]\n"
895                    c-b start counter (or name ""))))))))
896     (switch-to-buffer "*List of Tables*")
897     (setq buffer-read-only nil)
898     (org-mode)
899     (erase-buffer)
900     (insert (mapconcat 'identity list-of-tables ""))
901     (setq buffer-read-only t)
902     (use-local-map (copy-keymap org-mode-map))
903     (local-set-key "q" #'(lambda () (interactive) (kill-buffer))))))
904
905 (org-add-link-type
906  "list-of-tables"
907  'org-ref-list-of-tables
908  (lambda (keyword desc format)
909    (cond
910     ((eq format 'latex)
911      (format "\\listoftables")))))
912 #+END_SRC
913 ** label
914
915 The label link provides a way to create labels in org-mode. We make it clickable because we want to make sure labels are unique. This code will tell you how many instances of a label are found.  We search for label links, LaTeX labels, and org-mode format for labels, tblnames too.
916
917 #+BEGIN_SRC emacs-lisp  :tangle org-ref.el
918 (defun org-ref-count-labels (label)
919   "Counts number of matches for label in the document"
920   (+ (count-matches (format "label:%s\\b[^-:]" label) (point-min) (point-max) t)
921      ;; for tblname, it is not enough to get word boundary
922      ;; tab-little and tab-little-2 match then.
923      (count-matches (format "^#\\+tblname:\\s-*%s\\b[^-:]" label) (point-min) (point-max) t)
924      (count-matches (format "\\label{%s}\\b" label) (point-min) (point-max) t)
925      ;; this is the org-format #+label:
926      (count-matches (format "^#\\+label:\\s-*%s\\b[^-:]" label) (point-min) (point-max) t)
927      (let ((custom-id-count 0))
928        (org-map-entries
929         (lambda ()
930           (when (string= label  (org-entry-get (point) "CUSTOM_ID"))
931             (setq custom-id-count (+ 1 custom-id-count)))))
932        custom-id-count)))
933
934 (org-add-link-type
935  "label"
936  (lambda (label)
937    "on clicking count the number of label tags used in the buffer. A number greater than one means multiple labels!"
938    (message (format "%s occurences" (org-ref-count-labels label))))
939  (lambda (keyword desc format)
940    (cond
941     ((eq format 'html) (format "(<label>%s</label>)" path))
942     ((eq format 'latex)
943      (format "\\label{%s}" keyword)))))
944 #+END_SRC
945
946 We want to store links on labels, so you can put the cursor on the label, press C-c l, and later use C-c C-l to insert a link to the label. We also want to store links to tables with a table name, and for sections with CUSTOM_ID.
947
948 #+BEGIN_SRC emacs-lisp  :tangle org-ref.el
949 (defun org-label-store-link ()
950   "store a link to a label. The output will be a ref to that label"
951   ;; First we have to make sure we are on a label link.
952   (let* ((object (org-element-context)))
953     (when (and (equal (org-element-type object) 'link)
954                (equal (org-element-property :type object) "label"))
955       (org-store-link-props
956        :type "ref"
957        :link (concat "ref:" (org-element-property :path object))))
958
959     ;; Store link on table
960     (when (equal (org-element-type object) 'table)
961       (org-store-link-props
962        :type "ref"
963        :link (concat "ref:" (org-element-property :name object))))
964
965 ;; it turns out this does not work. you can already store a link to a heading with a CUSTOM_ID
966     ;; store link on heading with custom_id
967 ;    (when (and (equal (org-element-type object) 'headline)
968 ;              (org-entry-get (point) "CUSTOM_ID"))
969 ;      (org-store-link-props
970 ;       :type "ref"
971 ;       :link (concat "ref:" (org-entry-get (point) "CUSTOM_ID"))))
972
973     ;; and to #+label: lines
974     (when (and (equal (org-element-type object) 'paragraph)
975                (org-element-property :name object))
976       (org-store-link-props
977        :type "ref"
978        :link (concat "ref:" (org-element-property :name object))))
979 ))
980
981 (add-hook 'org-store-link-functions 'org-label-store-link)
982 #+END_SRC
983 ** ref
984
985 The ref link allows you make links to labels. Clicking on the link takes you to the label, and provides a mark to go back to.
986
987 At the moment, ref links are not usable for section links. You need [[#CUSTOM_ID]] type links.
988
989 #+BEGIN_SRC emacs-lisp  :tangle org-ref.el
990 (org-add-link-type
991  "ref"
992  (lambda (label)
993    "on clicking goto the label. Navigate back with C-c &"
994    (org-mark-ring-push)
995    ;; next search from beginning of the buffer
996
997    ;; it is possible you would not find the label if narrowing is in effect
998    (widen)
999
1000    (unless
1001        (or
1002         ;; our label links
1003         (progn
1004           (goto-char (point-min))
1005           (re-search-forward (format "label:%s\\b" label) nil t))
1006
1007         ;; a latex label
1008         (progn
1009           (goto-char (point-min))
1010           (re-search-forward (format "\\label{%s}" label) nil t))
1011
1012         ;; #+label: name  org-definition
1013         (progn
1014           (goto-char (point-min))
1015           (re-search-forward (format "^#\\+label:\\s-*\\(%s\\)\\b" label) nil t))
1016
1017         ;; org tblname
1018         (progn
1019           (goto-char (point-min))
1020           (re-search-forward (format "^#\\+tblname:\\s-*\\(%s\\)\\b" label) nil t))
1021
1022 ;; Commented out because these ref links do not actually translate correctly in LaTeX.
1023 ;; you need [[#label]] links.
1024         ;; CUSTOM_ID
1025 ;       (progn
1026 ;         (goto-char (point-min))
1027 ;         (re-search-forward (format ":CUSTOM_ID:\s-*\\(%s\\)" label) nil t))
1028         )
1029      ;; we did not find anything, so go back to where we came
1030      (org-mark-ring-goto)
1031      (error "%s not found" label))
1032    (org-show-entry)
1033    (message "go back with (org-mark-ring-goto) `C-c &`"))
1034  ;formatting
1035  (lambda (keyword desc format)
1036    (cond
1037     ((eq format 'html) (format "(<ref>%s</ref>)" path))
1038     ((eq format 'latex)
1039      (format "\\ref{%s}" keyword)))))
1040 #+END_SRC
1041
1042 It would be nice to use completion to enter a ref link, where a list of labels is provided. The following code searches the buffer for org and latex labels, custom_ids, and table names as potential items to make a ref link to.
1043
1044 #+BEGIN_SRC emacs-lisp :tangle org-ref.el
1045 (defun org-ref-get-org-labels ()
1046  "find #+LABEL: labels"
1047   (save-excursion
1048     (goto-char (point-min))
1049     (let ((matches '()))
1050       (while (re-search-forward "^#\\+label:\\s-+\\(.*\\)\\b" (point-max) t)
1051         (add-to-list 'matches (match-string-no-properties 1) t))
1052 matches)))
1053 #+END_SRC
1054
1055 #+BEGIN_SRC emacs-lisp :tangle org-ref.el
1056 (defun org-ref-get-custom-ids ()
1057  "return a list of custom_id properties in the buffer"
1058  (let ((results '()) custom_id)
1059    (org-map-entries
1060     (lambda ()
1061       (let ((custom_id (org-entry-get (point) "CUSTOM_ID")))
1062         (when (not (null custom_id))
1063           (setq results (append results (list custom_id)))))))
1064 results))
1065 #+END_SRC
1066
1067 Here we get a list of the labels defined as raw latex labels, e.g. \label{eqtre}.
1068 #+BEGIN_SRC emacs-lisp :tangle org-ref.el
1069 (defun org-ref-get-latex-labels ()
1070   (save-excursion
1071     (goto-char (point-min))
1072     (let ((matches '()))
1073       (while (re-search-forward "\\\\label{\\([a-zA-z0-9:-]*\\)}" (point-max) t)
1074         (add-to-list 'matches (match-string-no-properties 1) t))
1075 matches)))
1076 #+END_SRC
1077
1078 Finally, we get the table names.
1079
1080 #+BEGIN_SRC emacs-lisp :tangle org-ref.el
1081 (defun org-ref-get-tblnames ()
1082   (org-element-map (org-element-parse-buffer 'element) 'table
1083     (lambda (table)
1084       (org-element-property :name table))))
1085 #+END_SRC
1086
1087 Now, we can put all the labels together which will give us a list of candidates.
1088
1089 #+BEGIN_SRC emacs-lisp  :tangle org-ref.el
1090 (defun org-ref-get-labels ()
1091   "returns a list of labels in the buffer that you can make a ref link to. this is used to auto-complete ref links."
1092   (save-excursion
1093     (save-restriction
1094       (widen)
1095       (goto-char (point-min))
1096       (let ((matches '()))
1097         (while (re-search-forward "label:\\([a-zA-z0-9:-]*\\)" (point-max) t)
1098           (add-to-list 'matches (match-string-no-properties 1) t))
1099         (append matches (org-ref-get-org-labels) (org-ref-get-latex-labels) (org-ref-get-tblnames) (org-ref-get-custom-ids))))))
1100 #+END_SRC
1101
1102 Let us make a helm function to insert a label link. This will help you enter unique labels.
1103 #+BEGIN_SRC emacs-lisp :tangle org-ref.el
1104 (defun org-ref-helm-insert-label-link ()
1105   "Insert a label link. helm just shows you what labels already exist."
1106   (interactive)
1107   (let* ((labels (org-ref-get-labels))
1108          (cb (current-buffer)))
1109     (helm :sources `(((name . "Existing labels")
1110                       (candidates . ,labels)
1111                       (action . (lambda (label)
1112                                   ;; unfortunately I do not have markers here
1113                                   (org-open-link-from-string (format "ref:%s" label)))))
1114                      ((name . "Create new label")
1115                       (dummy)
1116                       (action .  (lambda (label)
1117                                    (switch-to-buffer ,cb)
1118                                    (insert
1119                                     (concat
1120                                      "label:"
1121                                      (or label
1122                                          helm-pattern))))))))))
1123 #+END_SRC
1124
1125 Now we create the completion function. This works from the org-machinery, e.g. if you type C-c C-l to insert a link, and use completion by pressing tab.
1126
1127 #+BEGIN_SRC emacs-lisp  :tangle org-ref.el
1128 (defun org-ref-complete-link (&optional arg)
1129   "Completion function for ref links"
1130   (let ((label))
1131     (setq label (completing-read "label: " (org-ref-get-labels)))
1132     (format "ref:%s" label)))
1133 #+END_SRC
1134
1135 Alternatively, you may want to just call a function that inserts a link with completion:
1136
1137 #+BEGIN_SRC emacs-lisp  :tangle org-ref.el
1138 (defun org-ref-insert-ref-link ()
1139  (interactive)
1140  (insert (org-ref-complete-link)))
1141 #+END_SRC
1142
1143 Another alternative ref insertion is to use helm.
1144
1145 #+BEGIN_SRC emacs-lisp :tangle org-ref.el
1146 (defun org-ref-helm-insert-ref-link ()
1147   "Helm menu to insert ref links to labels in the document.
1148 If you are on link, replace with newly selected label.
1149 Use C-u to insert a different kind of ref link.
1150 "
1151   (interactive)
1152   (let* ((labels (org-ref-get-labels))
1153          (contexts (mapcar 'org-ref-get-label-context labels))
1154          (cb (current-buffer)))
1155
1156     (helm :input (thing-at-point 'word)
1157           :sources `(((name . "Available labels to ref")
1158                       (candidates . ,(loop for label in labels
1159                                            for context in contexts
1160                                            ;; we do some kludgy adding spaces
1161                                            ;; and bars to make it "easier" to
1162                                            ;; see in helm.
1163                                            collect (cons (concat
1164                                                           label "\n"
1165                                                           (mapconcat
1166                                                            (lambda (x)
1167                                                              (concat "   |" x))
1168                                                            (split-string context "\n")
1169                                                            "\n"
1170                                                            ) "\n\n") label)))
1171                       (action . (lambda (label)
1172                                   (switch-to-buffer ,cb)
1173
1174                                   (cond
1175                                    ;;  no prefix or on a link
1176                                    ((equal helm-current-prefix-arg nil)
1177                                     (let* ((object (org-element-context))
1178                                            (last-char (save-excursion
1179                                                         (goto-char (org-element-property :end object))
1180                                                         (backward-char)
1181                                                         (if (looking-at " ")
1182                                                             " "
1183                                                           ""))))
1184                                       (if (-contains? '("ref" "eqref" "pageref" "nameref")
1185                                                       (org-element-property :type object))
1186                                           ;; we are on a link, so replace it.
1187                                           (setf
1188                                            (buffer-substring
1189                                             (org-element-property :begin object)
1190                                             (org-element-property :end object))
1191                                            (concat
1192                                             (replace-regexp-in-string
1193                                              (org-element-property :path object)
1194                                              label
1195                                              (org-element-property :raw-link object))
1196                                             last-char))
1197                                         ;; insert a new link
1198                                         (insert
1199                                          (concat
1200                                           "ref:" label))
1201                                         )))
1202                                    ;; one prefix, alternate ref link
1203                                    ((equal helm-current-prefix-arg '(4))
1204                                     (insert
1205                                      (concat
1206                                       (helm :sources '((name . "Ref link types")
1207                                                        (candidates . ("ref" "eqref" "pageref" "nameref"))
1208                                                        (action . (lambda (x) x))))
1209                                       ":" label)))
1210                                    ))))))))
1211
1212
1213
1214 #+END_SRC
1215
1216 #+RESULTS:
1217 : org-ref-helm-insert-ref-link
1218
1219 ** pageref
1220
1221 This refers to the page of a label in LaTeX.
1222
1223 #+BEGIN_SRC emacs-lisp  :tangle org-ref.el
1224 (org-add-link-type
1225  "pageref"
1226  (lambda (label)
1227    "on clicking goto the label. Navigate back with C-c &"
1228    (org-mark-ring-push)
1229    ;; next search from beginning of the buffer
1230    (widen)
1231    (unless
1232        (or
1233         ;; our label links
1234         (progn
1235           (goto-char (point-min))
1236           (re-search-forward (format "label:%s\\b" label) nil t))
1237
1238         ;; a latex label
1239         (progn
1240           (goto-char (point-min))
1241           (re-search-forward (format "\\label{%s}" label) nil t))
1242
1243         ;; #+label: name  org-definition
1244         (progn
1245           (goto-char (point-min))
1246           (re-search-forward (format "^#\\+label:\\s-*\\(%s\\)\\b" label) nil t))
1247
1248         ;; org tblname
1249         (progn
1250           (goto-char (point-min))
1251           (re-search-forward (format "^#\\+tblname:\\s-*\\(%s\\)\\b" label) nil t))
1252
1253 ;; Commented out because these ref links do not actually translate correctly in LaTeX.
1254 ;; you need [[#label]] links.
1255         ;; CUSTOM_ID
1256 ;       (progn
1257 ;         (goto-char (point-min))
1258 ;         (re-search-forward (format ":CUSTOM_ID:\s-*\\(%s\\)" label) nil t))
1259         )
1260      ;; we did not find anything, so go back to where we came
1261      (org-mark-ring-goto)
1262      (error "%s not found" label))
1263    (message "go back with (org-mark-ring-goto) `C-c &`"))
1264  ;formatting
1265  (lambda (keyword desc format)
1266    (cond
1267     ((eq format 'html) (format "(<pageref>%s</pageref>)" path))
1268     ((eq format 'latex)
1269      (format "\\pageref{%s}" keyword)))))
1270 #+END_SRC
1271
1272 #+BEGIN_SRC emacs-lisp  :tangle org-ref.el
1273 (defun org-pageref-complete-link (&optional arg)
1274   "Completion function for ref links"
1275   (let ((label))
1276     (setq label (completing-read "label: " (org-ref-get-labels)))
1277     (format "ref:%s" label)))
1278 #+END_SRC
1279
1280 Alternatively, you may want to just call a function that inserts a link with completion:
1281
1282 #+BEGIN_SRC emacs-lisp  :tangle org-ref.el
1283 (defun org-pageref-insert-ref-link ()
1284  (interactive)
1285  (insert (org-pageref-complete-link)))
1286 #+END_SRC
1287
1288 ** nameref
1289
1290 The nameref link allows you make links to the text of a section with a label. Clicking on the link takes you to the label, and provides a mark to go back to. This only works if you put a raw latex label in the headline.
1291
1292 #+BEGIN_SRC emacs-lisp  :tangle org-ref.el
1293 (org-add-link-type
1294  "nameref"
1295  (lambda (label)
1296    "on clicking goto the label. Navigate back with C-c &"
1297    (org-mark-ring-push)
1298    ;; next search from beginning of the buffer
1299    (widen)
1300    (unless
1301        (or
1302         ;; a latex label
1303         (progn
1304           (goto-char (point-min))
1305           (re-search-forward (format "\\label{%s}" label) nil t))
1306         )
1307      ;; we did not find anything, so go back to where we came
1308      (org-mark-ring-goto)
1309      (error "%s not found" label))
1310    (message "go back with (org-mark-ring-goto) `C-c &`"))
1311  ;formatting
1312  (lambda (keyword desc format)
1313    (cond
1314     ((eq format 'html) (format "(<nameref>%s</nameref>)" path))
1315     ((eq format 'latex)
1316      (format "\\nameref{%s}" keyword)))))
1317 #+END_SRC
1318
1319 ** eqref
1320 This is just the LaTeX ref for equations. On export, the reference is enclosed in parentheses.
1321
1322 #+BEGIN_SRC emacs-lisp  :tangle org-ref.el
1323 (org-add-link-type
1324  "eqref"
1325  (lambda (label)
1326    "on clicking goto the label. Navigate back with C-c &"
1327    (org-mark-ring-push)
1328    ;; next search from beginning of the buffer
1329    (widen)
1330    (goto-char (point-min))
1331    (unless
1332        (or
1333         ;; search forward for the first match
1334         ;; our label links
1335         (re-search-forward (format "label:%s" label) nil t)
1336         ;; a latex label
1337         (re-search-forward (format "\\label{%s}" label) nil t)
1338         ;; #+label: name  org-definition
1339         (re-search-forward (format "^#\\+label:\\s-*\\(%s\\)\\b" label) nil t))
1340      (org-mark-ring-goto)
1341      (error "%s not found" label))
1342    (message "go back with (org-mark-ring-goto) `C-c &`"))
1343  ;formatting
1344  (lambda (keyword desc format)
1345    (cond
1346     ((eq format 'html) (format "(<eqref>%s</eqref>)" path))
1347     ((eq format 'latex)
1348      (format "\\eqref{%s}" keyword)))))
1349 #+END_SRC
1350
1351 ** cite
1352 This is the main reason this library exists. We want the following behavior. A cite link should be able to contain multiple bibtex keys. You should be able to click on the link, and get a brief citation of the entry for that key, and a menu of options to open the bibtex file, open a pdf if you have it, open your notes on the entry, or open a url if it exists. You should be able to insert new references onto an existing cite link, or create new ones easily. The following code implements these features.
1353
1354 *** Implementing the click actions of cite
1355
1356 **** Getting the key we clicked on
1357 The first thing we need is to get the bibtex key we clicked on.
1358
1359 #+BEGIN_SRC emacs-lisp  :tangle org-ref.el
1360 (defun org-ref-get-bibtex-key-under-cursor ()
1361   "returns key under the bibtex cursor. We search forward from
1362 point to get a comma, or the end of the link, and then backwards
1363 to get a comma, or the beginning of the link. that delimits the
1364 keyword we clicked on. We also strip the text properties."
1365   (interactive)
1366   (let* ((object (org-element-context))
1367          (link-string (org-element-property :path object)))
1368     ;; you may click on the part before the citations. here we make
1369     ;; sure to move to the beginning so you get the first citation.
1370     (let ((cp (point)))
1371       (goto-char (org-element-property :begin object))
1372       (search-forward link-string (org-element-property :end object))
1373       (goto-char (match-beginning 0))
1374       ;; check if we clicked before the path and move as needed.
1375       (unless (< cp (point))
1376         (goto-char cp)))
1377
1378     (if (not (org-element-property :contents-begin object))
1379         ;; this means no description in the link
1380         (progn
1381           ;; we need the link path start and end
1382           (save-excursion
1383             (goto-char (org-element-property :begin object))
1384             (search-forward link-string nil nil 1)
1385             (setq link-string-beginning (match-beginning 0))
1386             (setq link-string-end (match-end 0)))
1387
1388           ;; The key is the text between commas, or the link boundaries
1389           (save-excursion
1390             (if (search-forward "," link-string-end t 1)
1391                 (setq key-end (- (match-end 0) 1)) ; we found a match
1392               (setq key-end link-string-end))) ; no comma found so take the end
1393           ;; and backward to previous comma from point which defines the start character
1394           (save-excursion
1395             (if (search-backward "," link-string-beginning 1 1)
1396                 (setq key-beginning (+ (match-beginning 0) 1)) ; we found a match
1397               (setq key-beginning link-string-beginning))) ; no match found
1398           ;; save the key we clicked on.
1399           (setq bibtex-key (org-ref-strip-string (buffer-substring key-beginning key-end)))
1400           (set-text-properties 0 (length bibtex-key) nil bibtex-key)
1401           bibtex-key)
1402       ;; link with description. assume only one key
1403       link-string)))
1404 #+END_SRC
1405
1406 We also need to find which bibliography file that key is in. For that, we need to know which bibliography files are referred to in the file. If none are specified with a bibliography link, we use the default bibliography. This function searches for a bibliography link, and then the LaTeX bibliography link. We also consider the addbibresource link which is used with biblatex.
1407
1408 **** Getting the bibliographies
1409 #+BEGIN_SRC emacs-lisp :tangle org-ref.el
1410 (defun org-ref-find-bibliography ()
1411   "find the bibliography in the buffer.
1412 This function sets and returns cite-bibliography-files, which is a list of files
1413 either from bibliography:f1.bib,f2.bib
1414 \bibliography{f1,f2}
1415 internal bibliographies
1416
1417 falling back to what the user has set in org-ref-default-bibliography
1418 "
1419   (interactive)
1420   (catch 'result
1421     (save-excursion
1422       (goto-char (point-min))
1423       ;;  look for a bibliography link
1424       (when (re-search-forward "\\<bibliography:\\([^\]\|\n]+\\)" nil t)
1425         (setq org-ref-bibliography-files
1426               (mapcar 'org-ref-strip-string (split-string (match-string 1) ",")))
1427         (throw 'result org-ref-bibliography-files))
1428
1429
1430       ;; we did not find a bibliography link. now look for \bibliography
1431       (goto-char (point-min))
1432       (when (re-search-forward "\\\\bibliography{\\([^}]+\\)}" nil t)
1433         ;; split, and add .bib to each file
1434         (setq org-ref-bibliography-files
1435               (mapcar (lambda (x) (concat x ".bib"))
1436                       (mapcar 'org-ref-strip-string
1437                               (split-string (match-string 1) ","))))
1438         (throw 'result org-ref-bibliography-files))
1439
1440       ;; no bibliography found. maybe we need a biblatex addbibresource
1441       (goto-char (point-min))
1442       ;;  look for a bibliography link
1443       (when (re-search-forward "addbibresource:\\([^\]\|\n]+\\)" nil t)
1444         (setq org-ref-bibliography-files
1445               (mapcar 'org-ref-strip-string (split-string (match-string 1) ",")))
1446         (throw 'result org-ref-bibliography-files))
1447
1448       ;; we did not find anything. use defaults
1449       (setq org-ref-bibliography-files org-ref-default-bibliography)))
1450
1451     ;; set reftex-default-bibliography so we can search
1452     (set (make-local-variable 'reftex-default-bibliography) org-ref-bibliography-files)
1453     org-ref-bibliography-files)
1454 #+END_SRC
1455
1456 **** Finding the bibliography file a key is in
1457 Now, we can see if an entry is in a file.
1458
1459 #+BEGIN_SRC emacs-lisp :tangle org-ref.el
1460 (defun org-ref-key-in-file-p (key filename)
1461   "determine if the key is in the file"
1462   (interactive "skey: \nsFile: ")
1463   (save-current-buffer
1464     (let ((bibtex-files (list filename)))
1465       (bibtex-search-entry key t))))
1466 #+END_SRC
1467
1468 Finally, we want to know which file the key is in.
1469
1470 #+BEGIN_SRC emacs-lisp :tangle org-ref.el
1471 (defun org-ref-get-bibtex-key-and-file (&optional key)
1472   "returns the bibtex key and file that it is in. If no key is provided, get one under point"
1473  (interactive)
1474  (let ((org-ref-bibliography-files (org-ref-find-bibliography))
1475        (file))
1476    (unless key
1477      (setq key (org-ref-get-bibtex-key-under-cursor)))
1478    (setq file     (catch 'result
1479                     (loop for file in org-ref-bibliography-files do
1480                           (if (org-ref-key-in-file-p key (file-truename file))
1481                               (throw 'result file)))))
1482    (cons key file)))
1483 #+END_SRC
1484
1485 **** convenience functions to act on citation at point
1486      :PROPERTIES:
1487      :ID:       af0b2a82-a7c9-4c08-9dac-09f93abc4a92
1488      :END:
1489 We need some convenience functions to open act on the citation at point. These will get the pdf, open the url, or open the notes.
1490
1491 #+BEGIN_SRC emacs-lisp :tangle org-ref.el
1492 (defun org-ref-open-pdf-at-point ()
1493   "open the pdf for bibtex key under point if it exists"
1494   (interactive)
1495   (let* ((results (org-ref-get-bibtex-key-and-file))
1496          (key (car results))
1497          (pdf-file (format (concat org-ref-pdf-directory "%s.pdf") key)))
1498     (if (file-exists-p pdf-file)
1499         (org-open-file pdf-file)
1500 (message "no pdf found for %s" key))))
1501
1502
1503 (defun org-ref-open-url-at-point ()
1504   "open the url for bibtex key under point."
1505   (interactive)
1506   (let* ((results (org-ref-get-bibtex-key-and-file))
1507          (key (car results))
1508          (bibfile (cdr results)))
1509     (save-excursion
1510       (with-temp-buffer
1511         (insert-file-contents bibfile)
1512         (bibtex-search-entry key)
1513         ;; I like this better than bibtex-url which does not always find
1514         ;; the urls
1515         (catch 'done
1516           (let ((url (bibtex-autokey-get-field "url")))
1517             (when  url
1518               (browse-url url)
1519               (throw 'done nil)))
1520
1521           (let ((doi (bibtex-autokey-get-field "doi")))
1522             (when doi
1523               (if (string-match "^http" doi)
1524                   (browse-url doi)
1525                 (browse-url (format "http://dx.doi.org/%s" doi)))
1526               (throw 'done nil))))))))
1527
1528
1529 (defun org-ref-open-notes-at-point ()
1530   "open the notes for bibtex key under point."
1531   (interactive)
1532   (let* ((results (org-ref-get-bibtex-key-and-file))
1533          (key (car results))
1534          (bibfile (cdr results)))
1535     (save-excursion
1536       (with-temp-buffer
1537         (insert-file-contents bibfile)
1538         (bibtex-search-entry key)
1539         (org-ref-open-bibtex-notes)))))
1540
1541
1542 (defun org-ref-citation-at-point ()
1543   "give message of current citation at point"
1544   (interactive)
1545   (let* ((cb (current-buffer))
1546         (results (org-ref-get-bibtex-key-and-file))
1547         (key (car results))
1548         (bibfile (cdr results)))
1549     (message "%s" (progn
1550                     (with-temp-buffer
1551                       (insert-file-contents bibfile)
1552                       (bibtex-search-entry key)
1553                       (org-ref-bib-citation))))))
1554
1555
1556 (defun org-ref-open-citation-at-point ()
1557   "open bibtex file to key at point"
1558   (interactive)
1559   (let* ((cb (current-buffer))
1560         (results (org-ref-get-bibtex-key-and-file))
1561         (key (car results))
1562         (bibfile (cdr results)))
1563     (find-file bibfile)
1564     (bibtex-search-entry key)))
1565 #+END_SRC
1566
1567 **** the actual minibuffer menu
1568 Now, we create the menu. This is a rewrite of the cite action. This makes the function extendable by users.
1569
1570 #+BEGIN_SRC emacs-lisp  :tangle org-ref.el
1571 (defvar org-ref-cite-menu-funcs '()
1572  "Functions to run on cite click menu. Each entry is a list of (key menu-name function).
1573 The function must take no arguments and work on the key at point. Do not modify this variable, it is set to empty in the menu click function, and functions are conditionally added to it.")
1574
1575
1576 (defvar org-ref-user-cite-menu-funcs
1577   '(("C" "rossref" org-ref-crossref-at-point)
1578     ("y" "Copy entry to file" org-ref-copy-entry-at-point-to-file)
1579     ("s" "Copy summary" org-ref-copy-entry-as-summary))
1580   "user-defined functions to run on bibtex key at point.")
1581
1582
1583 (defun org-ref-copy-entry-as-summary ()
1584   "Copy the bibtex entry for the citation at point as a summary."
1585   (interactive)
1586     (save-window-excursion
1587       (org-ref-open-citation-at-point)
1588       (kill-new (org-ref-bib-citation))))
1589
1590
1591 (defun org-ref-copy-entry-at-point-to-file ()
1592   "Copy the bibtex entry for the citation at point to NEW-FILE.
1593 Prompt for NEW-FILE includes bib files in org-ref-default-bibliography, and bib files in current working directory. You can also specify a new file."
1594   (interactive)
1595   (let ((new-file (ido-completing-read
1596                    "Copy to bibfile: "
1597                    (append org-ref-default-bibliography
1598                            (f-entries "." (lambda (f) (f-ext? f "bib"))))))
1599         (key (org-ref-get-bibtex-key-under-cursor)))
1600     (save-window-excursion
1601       (org-ref-open-citation-at-point)
1602       (bibtex-copy-entry-as-kill))
1603
1604     (let ((bibtex-files (list (file-truename new-file))))
1605       (if (assoc key (bibtex-global-key-alist))
1606           (message "That key already exists in %s" new-file)
1607         ;; add to file
1608         (save-window-excursion
1609           (find-file new-file)
1610           (goto-char (point-max))
1611           ;; make sure we are at the beginning of a line.
1612           (unless (looking-at "^") (insert "\n\n"))
1613           (bibtex-yank)
1614           (save-buffer))))))
1615
1616
1617 (defun org-ref-get-doi-at-point ()
1618   "Get doi for key at point."
1619   (interactive)
1620   (let* ((results (org-ref-get-bibtex-key-and-file))
1621          (key (car results))
1622          (bibfile (cdr results))
1623          doi)
1624     (save-excursion
1625       (with-temp-buffer
1626         (insert-file-contents bibfile)
1627         (bibtex-search-entry key)
1628         (setq doi (bibtex-autokey-get-field "doi"))
1629         ;; in case doi is a url, remove the url part.
1630         (replace-regexp-in-string "^http://dx.doi.org/" "" doi)))))
1631
1632
1633 ;; functions that operate on key at point for click menu
1634 (defun org-ref-wos-at-point ()
1635   "open the doi in wos for bibtex key under point."
1636   (interactive)
1637   (doi-utils-wos (org-ref-get-doi-at-point)))
1638
1639
1640 (defun org-ref-wos-citing-at-point ()
1641   "open the doi in wos citing articles for bibtex key under point."
1642   (interactive)
1643   (doi-utils-wos-citing (org-ref-get-doi-at-point)))
1644
1645
1646 (defun org-ref-wos-related-at-point ()
1647   "open the doi in wos related articles for bibtex key under point."
1648   (interactive)
1649   (doi-utils-wos-related (org-ref-get-doi-at-point)))
1650
1651
1652 (defun org-ref-google-scholar-at-point ()
1653   "open the doi in google scholar for bibtex key under point."
1654   (interactive)
1655   (doi-utils-google-scholar (org-ref-get-doi-at-point)))
1656
1657
1658 (defun org-ref-pubmed-at-point ()
1659   "open the doi in pubmed for bibtex key under point."
1660   (interactive)
1661   (doi-utils-pubmed (org-ref-get-doi-at-point)))
1662
1663
1664 (defun org-ref-crossref-at-point ()
1665   "open the doi in crossref for bibtex key under point."
1666   (interactive)
1667   (doi-utils-crossref (org-ref-get-doi-at-point)))
1668
1669
1670 (defun org-ref-cite-onclick-minibuffer-menu (&optional link-string)
1671   "action when a cite link is clicked on.
1672 Provides a menu of context sensitive actions. If the bibtex entry has a pdf, you get an option to open it. If there is a doi, you get a lot of options."
1673   (interactive)
1674   (let* ((results (org-ref-get-bibtex-key-and-file))
1675          (key (car results))
1676          (pdf-file (format (concat org-ref-pdf-directory "%s.pdf") key))
1677          (bibfile (cdr results))
1678          (url (save-excursion
1679                 (with-temp-buffer
1680                   (insert-file-contents bibfile)
1681                   (bibtex-search-entry key)
1682                   (bibtex-autokey-get-field "url"))))
1683          (doi (save-excursion
1684                 (with-temp-buffer
1685                   (insert-file-contents bibfile)
1686                   (bibtex-search-entry key)
1687                   ;; I like this better than bibtex-url which does not always find
1688                   ;; the urls
1689                   (bibtex-autokey-get-field "doi")))))
1690
1691     (when (string= "" doi) (setq doi nil))
1692     (when (string= "" url) (setq url nil))
1693     (setq org-ref-cite-menu-funcs '())
1694
1695     ;; open action
1696     (when
1697         bibfile
1698       (add-to-list
1699        'org-ref-cite-menu-funcs
1700        '("o" "pen" org-ref-open-citation-at-point)))
1701
1702     ;; pdf
1703     (when (file-exists-p pdf-file)
1704       (add-to-list
1705        'org-ref-cite-menu-funcs
1706        `("p" "df" ,org-ref-open-pdf-function) t))
1707
1708     ;; notes
1709     (add-to-list
1710      'org-ref-cite-menu-funcs
1711      '("n" "otes" org-ref-open-notes-at-point) t)
1712
1713     ;; url
1714     (when (or url doi)
1715       (add-to-list
1716        'org-ref-cite-menu-funcs
1717        '("u" "rl" org-ref-open-url-at-point) t))
1718
1719     ;; doi funcs
1720     (when doi
1721       (add-to-list
1722        'org-ref-cite-menu-funcs
1723        '("w" "os" org-ref-wos-at-point) t)
1724
1725       (add-to-list
1726        'org-ref-cite-menu-funcs
1727        '("c" "iting" org-ref-wos-citing-at-point) t)
1728
1729       (add-to-list
1730        'org-ref-cite-menu-funcs
1731        '("r" "elated" org-ref-wos-related-at-point) t)
1732
1733       (add-to-list
1734        'org-ref-cite-menu-funcs
1735        '("g" "oogle scholar" org-ref-google-scholar-at-point) t)
1736
1737       (add-to-list
1738        'org-ref-cite-menu-funcs
1739        '("P" "ubmed" org-ref-pubmed-at-point) t))
1740
1741     ;; add user functions
1742     (dolist (tup org-ref-user-cite-menu-funcs)
1743       (add-to-list
1744        'org-ref-cite-menu-funcs
1745        tup t))
1746
1747     ;; finally quit
1748     (add-to-list
1749      'org-ref-cite-menu-funcs
1750      '("q" "uit" (lambda ())) t)
1751
1752     ;; now we make a menu
1753     ;; construct menu string as a message
1754     (message
1755      (concat
1756       (let* ((results (org-ref-get-bibtex-key-and-file))
1757              (key (car results))
1758              (bibfile (cdr results)))
1759         (save-excursion
1760           (with-temp-buffer
1761             (insert-file-contents bibfile)
1762             (bibtex-search-entry key)
1763             (org-ref-bib-citation))))
1764       "\n"
1765       (mapconcat
1766        (lambda (tup)
1767          (concat "[" (elt tup 0) "]"
1768                  (elt tup 1) " "))
1769        org-ref-cite-menu-funcs "")))
1770     ;; get the input
1771     (let* ((input (read-char-exclusive))
1772            (choice (assoc
1773                     (char-to-string input) org-ref-cite-menu-funcs)))
1774       ;; now run the function (2nd element in choice)
1775       (when choice
1776         (funcall
1777          (elt
1778           choice
1779           2))))))
1780 #+END_SRC
1781
1782 #+RESULTS:
1783 : org-ref-cite-onclick-minibuffer-menu
1784
1785 *** A function to format a cite link
1786
1787 Next, we define a formatting function for the cite link. This is done so that the cite link definition is very short, and easy to change. You just need to specify the functions in the definition. This function is deprecated. The formatting is defined later automatically.
1788
1789 #+BEGIN_SRC emacs-lisp  :tangle no
1790 ;(defun org-ref-cite-link-format (keyword desc format)
1791 ;   (cond
1792 ;    ((eq format 'html) (mapconcat (lambda (key) (format "<a name=\"#%s\">%s</a>" key key) (org-ref-split-and-strip-string keyword) ",")))
1793 ;    ((eq format 'latex)
1794 ;     (concat "\\cite" (when desc (format "[%s]" desc)) "{"
1795 ;            (mapconcat (lambda (key) key) (org-ref-split-and-strip-string keyword) ",")
1796 ;            "}"))))
1797 #+END_SRC
1798
1799 *** The actual cite link
1800 Finally, we define the cite link. This is deprecated; the links are autogenerated later. This is here for memory.
1801
1802 #+BEGIN_SRC emacs-lisp :tangle no
1803 ;(org-add-link-type
1804 ; "cite"
1805 ; 'org-ref-cite-onclick-minibuffer-menu
1806 ; 'org-ref-cite-link-format)
1807 #+END_SRC
1808
1809 *** Automatic definition of the cite links
1810 There are many different kinds of citations in LaTeX, but they are all variants of a basic syntax of \citetype[optional text]{label1,label2}. Here we use lisp to generate the link definitions. We define a function that creates the code to create the link, and then we evaluate it. We also create the completion function for the new link, and add it to the list of known links.
1811
1812 #+BEGIN_SRC emacs-lisp :tangle org-ref.el
1813 (defmacro org-ref-make-completion-function (type)
1814   `(defun ,(intern (format "org-%s-complete-link" type)) (&optional arg)
1815      (interactive)
1816      (format "%s:%s"
1817              ,type
1818              (completing-read
1819               "bibtex key: "
1820               (let ((bibtex-files (org-ref-find-bibliography)))
1821                 (bibtex-global-key-alist))))))
1822 #+END_SRC
1823
1824 We will want to generate formatting functions for each citation type. The reason for doing this is so we can on the fly change the formatting later.
1825
1826 #+BEGIN_SRC emacs-lisp :tangle org-ref.el
1827 (defmacro org-ref-make-format-function (type)
1828   `(defun ,(intern (format "org-ref-format-%s" type)) (keyword desc format)
1829      (cond
1830       ((eq format 'org)
1831        (mapconcat
1832         (lambda (key)
1833           (format "[[#%s][%s]]" key key))
1834         (org-ref-split-and-strip-string keyword) ","))
1835
1836       ((eq format 'ascii)
1837        (concat "["
1838                (mapconcat
1839                 (lambda (key)
1840                   (format "%s" key))
1841                 (org-ref-split-and-strip-string keyword) ",") "]"))
1842
1843       ((eq format 'html)
1844        (mapconcat
1845         (lambda (key)
1846           (format "<a href=\"#%s\">%s</a>" key key))
1847         (org-ref-split-and-strip-string keyword) ","))
1848
1849       ((eq format 'latex)
1850        (if (string= (substring type -1) "s")
1851            ;; biblatex format for multicite commands, which all end in s. These are formated as \cites{key1}{key2}...
1852            (concat "\\" ,type (mapconcat (lambda (key) (format "{%s}"  key))
1853                                          (org-ref-split-and-strip-string keyword) ""))
1854          ;; bibtex format
1855        (concat "\\" ,type (when desc (org-ref-format-citation-description desc)) "{"
1856                (mapconcat (lambda (key) key) (org-ref-split-and-strip-string keyword) ",")
1857                "}"))))))
1858 #+END_SRC
1859
1860
1861
1862 We create the links by mapping the function onto the list of defined link types.
1863
1864 #+BEGIN_SRC emacs-lisp :tangle org-ref.el
1865 (defun org-ref-format-citation-description (desc)
1866   "return formatted citation description. if the cite link has a description, it is optional text for the citation command. You can specify pre and post text by separating these with ::."
1867   (interactive)
1868   (cond
1869    ((string-match "::" desc)
1870     (format "[%s][%s]" (car (setq results (split-string desc "::"))) (cadr results)))
1871    (t (format "[%s]" desc))))
1872
1873 (defun org-ref-define-citation-link (type &optional key)
1874   "add a citation link for org-ref. With optional key, set the reftex binding. For example:
1875 (org-ref-define-citation-link \"citez\" ?z) will create a new citez link, with reftex key of z,
1876 and the completion function."
1877   (interactive "sCitation Type: \ncKey: ")
1878
1879   ;; create the formatting function
1880   (eval `(org-ref-make-format-function ,type))
1881
1882   (eval-expression
1883    `(org-add-link-type
1884      ,type
1885      org-ref-cite-onclick-function
1886      (quote ,(intern (format "org-ref-format-%s" type)))))
1887
1888   ;; create the completion function
1889   (eval `(org-ref-make-completion-function ,type))
1890
1891   ;; store new type so it works with adding citations, which checks
1892   ;; for existence in this list
1893   (add-to-list 'org-ref-cite-types type)
1894
1895   ;; and finally if a key is specified, we modify the reftex menu
1896   (when key
1897     (setf (nth 2 (assoc 'org reftex-cite-format-builtin))
1898           (append (nth 2 (assoc 'org reftex-cite-format-builtin))
1899                   `((,key  . ,(concat type ":%l")))))))
1900
1901 ;; create all the link types and their completion functions
1902 (mapcar 'org-ref-define-citation-link org-ref-cite-types)
1903 #+END_SRC
1904
1905 *** org-ref-insert-cite-link
1906 We need a convenient method to insert links. In reftex you use the keystroke C-c ], which gives you a minibuffer to search the bibtex files from. This function is bound to that same keystroke here [[*org-mode%20/%20reftex%20setup][org-mode / reftex setup]]. This function will append to a cite link if you call it while on a link.
1907
1908 #+BEGIN_SRC emacs-lisp  :tangle org-ref.el
1909 (defun org-ref-insert-cite-link (alternative-cite)
1910   "Insert a default citation link using reftex. If you are on a link, it
1911 appends to the end of the link, otherwise, a new link is
1912 inserted. Use a prefix arg to get a menu of citation types."
1913   (interactive "P")
1914   (org-ref-find-bibliography)
1915   (let* ((object (org-element-context))
1916          (link-string-beginning (org-element-property :begin object))
1917          (link-string-end (org-element-property :end object))
1918          (path (org-element-property :path object)))
1919
1920     (if (not alternative-cite)
1921
1922         (cond
1923          ;; case where we are in a link
1924          ((and (equal (org-element-type object) 'link)
1925                (-contains? org-ref-cite-types (org-element-property :type object)))
1926           (goto-char link-string-end)
1927           ;; sometimes there are spaces at the end of the link
1928           ;; this code moves point pack until no spaces are there
1929           (while (looking-back " ") (backward-char))
1930           (insert (concat "," (mapconcat 'identity (reftex-citation t ?a) ","))))
1931
1932          ;; We are next to a link, and we want to append
1933          ((save-excursion
1934             (backward-char)
1935             (and (equal (org-element-type (org-element-context)) 'link)
1936                  (-contains? org-ref-cite-types (org-element-property :type (org-element-context)))))
1937           (while (looking-back " ") (backward-char))
1938           (insert (concat "," (mapconcat 'identity (reftex-citation t ?a) ","))))
1939
1940          ;; insert fresh link
1941          (t
1942           (insert
1943            (concat org-ref-default-citation-link
1944                    ":"
1945                    (mapconcat 'identity (reftex-citation t) ",")))))
1946
1947       ;; you pressed a C-u so we run this code
1948       (reftex-citation)))
1949   )
1950 #+END_SRC
1951 cite:zhou-2004-first-lda-u,paier-2006-errat,boes-2015-estim-bulk
1952
1953
1954 #+RESULTS:
1955 : org-ref-insert-cite-link
1956
1957 *** Completion in cite links
1958 If you know the specific bibtex key, you may like to use completion directly. You use this with the org-mode machinery and tab completion. Here is the prototypical completion function. These are now all created when the links are created.
1959
1960 #+BEGIN_SRC emacs-lisp  :tangle no
1961 (defun org-cite-complete-link (&optional arg)
1962   "Completion function for cite links"
1963   (format "%s:%s"
1964           org-ref-default-citation-link
1965           (completing-read
1966            "bibtex key: "
1967            (let ((bibtex-files (org-ref-find-bibliography)))
1968              (bibtex-global-key-alist)))))
1969 #+END_SRC
1970
1971 Alternatively, you may shortcut the org-machinery with this command. You will be prompted for a citation type, and then offered key completion.
1972
1973 #+BEGIN_SRC emacs-lisp :tangle org-ref.el
1974 (defun org-ref-insert-cite-with-completion (type)
1975   "Insert a cite link with completion"
1976   (interactive (list (ido-completing-read "Type: " org-ref-cite-types)))
1977   (insert (funcall (intern (format "org-%s-complete-link" type)))))
1978 #+END_SRC
1979
1980 ** Storing links to a bibtex entry
1981 org-mode already defines a store link function for bibtex entries. It does not store the link I want though, it only stores a brief citation of the entry. I want a citation link. Here is a function to do that.
1982
1983 #+BEGIN_SRC emacs-lisp :tangle org-ref.el
1984 (defun org-ref-store-bibtex-entry-link ()
1985   "Save a citation link to the current bibtex entry. Saves in the default link type."
1986   (interactive)
1987   (let ((link (concat org-ref-default-citation-link
1988                  ":"
1989                  (save-excursion
1990                    (bibtex-beginning-of-entry)
1991                    (reftex-get-bib-field "=key=" (bibtex-parse-entry))))))
1992     (message "saved %s" link)
1993     (push (list link) org-stored-links)
1994     (car org-stored-links)))
1995 #+END_SRC
1996
1997 ** Index entries
1998 org-ref minimally supports index entries. To make an index in a file, you should put in the LaTeX header these lines
1999
2000
2001 #+LATEX_HEADER: \usepackage{makeidx}
2002 #+LATEX_HEADER: \makeindex
2003
2004
2005 Finally, put \makeindex at the end of the document where you want the index to appear. You will need to run the makeindex program at an appropriate point in your LaTeX to pdf, or use ox-manuscript, which will do it for you.
2006
2007
2008 Use index links to create entries (see http://en.wikibooks.org/wiki/LaTeX/Indexing). Clicking on an index link runs occur on the buffer for the entry. The link exports to LaTeX. Some links may need to be enclosed in double brackets if they have spaces in them.
2009
2010
2011 index:hello
2012 index:hello!Peter
2013 [[index:hello!Sam@\textsl{Sam}]]
2014 [[index:Lin@\textbf{Lin}]]
2015 [[index:Joe|textit]]
2016 [[index:Lin@\textbf{Lin}]]
2017 [[index:Peter|see {hello}]]
2018 [[index:Jen|seealso{Jenny}]]
2019
2020 index:encodings!input!cp850
2021
2022 #+BEGIN_SRC emacs-lisp :tangle org-ref.el
2023 (org-add-link-type
2024  "index"
2025  (lambda (path)
2026    (occur path))
2027
2028  (lambda (path desc format)
2029    (cond
2030     ((eq format 'latex)
2031       (format "\\index{%s}" path)))))
2032
2033 ;; this will generate a temporary index of entries in the file.
2034 (org-add-link-type
2035  "printindex"
2036  (lambda (path)
2037    (let ((*index-links* '())
2038          (*initial-letters* '()))
2039
2040      ;; get links
2041      (org-element-map (org-element-parse-buffer) 'link
2042        (lambda (link)
2043          (let ((type (nth 0 link))
2044                (plist (nth 1 link)))
2045
2046            (when (equal (plist-get plist ':type) "index")
2047              (add-to-list
2048               '*index-links*
2049               (cons (plist-get plist :path)
2050                     (format
2051                      "[[elisp:(progn (switch-to-buffer \"%s\") (goto-char %s))][%s]]"
2052 (current-buffer)
2053                      (plist-get plist :begin)  ;; position of link
2054                      ;; grab a description
2055                      (save-excursion
2056                        (goto-char (plist-get plist :begin))
2057                        (if (thing-at-point 'sentence)
2058                            ;; get a sentence
2059                            (replace-regexp-in-string
2060                             "\n" "" (thing-at-point 'sentence))
2061                          ;; or call it a link
2062                          "link")))))))))
2063
2064      ;; sort the links
2065      (setq *index-links*  (cl-sort *index-links* 'string-lessp :key 'car))
2066
2067      ;; now first letters
2068      (dolist (link *index-links*)
2069        (add-to-list '*initial-letters* (substring (car link) 0 1) t))
2070
2071      ;; now create the index
2072      (switch-to-buffer (get-buffer-create "*index*"))
2073      (org-mode)
2074      (erase-buffer)
2075      (insert "#+TITLE: Index\n\n")
2076      (dolist (letter *initial-letters*)
2077        (insert (format "* %s\n" (upcase letter)))
2078        ;; now process the links
2079        (while (and
2080                ,*index-links*
2081                (string= letter (substring (car (car *index-links*)) 0 1)))
2082          (let ((link (pop *index-links*)))
2083            (insert (format "%s %s\n\n" (car link) (cdr link))))))
2084      (switch-to-buffer "*index*")))
2085  ;; formatting
2086  (lambda (path desc format)
2087    (cond
2088     ((eq format 'latex)
2089       (format "\\printindex")))))
2090 #+END_SRC
2091
2092 #+RESULTS:
2093 | lambda | (path)             | (let ((*index-links* (quote nil)) (*initial-letters* (quote nil))) (org-element-map (org-element-parse-buffer) (quote link) (lambda (link) (let ((type (nth 0 link)) (plist (nth 1 link))) (when (equal (plist-get plist (quote :type)) index) (add-to-list (quote *index-links*) (cons (plist-get plist :path) (format [[elisp:(progn (switch-to-buffer "%s") (goto-char %s))][%s]] (current-buffer) (plist-get plist :begin) (save-excursion (goto-char (plist-get plist :begin)) (if (thing-at-point (quote sentence)) (replace-regexp-in-string \n  (thing-at-point (quote sentence))) link))))))))) (setq *index-links* (cl-sort *index-links* (quote string-lessp) :key (quote car))) (dolist (link *index-links*) (add-to-list (quote *initial-letters*) (substring (car link) 0 1) t)) (switch-to-buffer (get-buffer-create *index*)) (org-mode) (erase-buffer) (insert #+TITLE: Index\n\n) (dolist (letter *initial-letters*) (insert (format * %s\n (upcase letter))) (while (and *index-links* (string= letter (substring (car (car *index-links*)) 0 1))) (let ((link (pop *index-links*))) (insert (format %s %s\n\n (car link) (cdr link)))))) (switch-to-buffer *index*)) |
2094 | lambda | (path desc format) | (cond ((eq format (quote latex)) (format \printindex)))                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        |
2095
2096 ** Glossary
2097 org-ref provides some minimal support for a glossary. See http://en.wikibooks.org/wiki/LaTeX/Glossary for details. You need to put these lines in the header.
2098
2099 #+LATEX_HEADER: \usepackage{glossaries}
2100 #+LATEX_HEADER: \makeglossaries
2101
2102 And at the end of the document put \makeglossaries.
2103
2104 #+BEGIN_SRC emacs-lisp :tangle org-ref.el
2105 (org-add-link-type
2106  "newglossaryentry"
2107  nil ;; no follow action
2108  (lambda (path desc format)
2109    (cond
2110     ((eq format 'latex)
2111      (format "\\newglossaryentry{%s}{%s}" path desc)))))
2112
2113
2114 ;; link to entry
2115 (org-add-link-type
2116  "gls"
2117   nil ;; no follow action
2118  (lambda (path desc format)
2119    (cond
2120     ((eq format 'latex)
2121      (format "\\gls{%s}" path)))))
2122
2123 ;; plural
2124 (org-add-link-type
2125  "glspl"
2126   nil ;; no follow action
2127  (lambda (path desc format)
2128    (cond
2129     ((eq format 'latex)
2130      (format "\\glspl{%s}" path)))))
2131
2132 ;; capitalized link
2133 (org-add-link-type
2134  "Gls"
2135   nil ;; no follow action
2136  (lambda (path desc format)
2137    (cond
2138     ((eq format 'latex)
2139      (format "\\Gls{%s}" path)))))
2140
2141 ;; capitalized link
2142 (org-add-link-type
2143  "Glspl"
2144   nil ;; no follow action
2145  (lambda (path desc format)
2146    (cond
2147     ((eq format 'latex)
2148      (format "\\Glspl{%s}" path)))))
2149 #+END_SRC
2150
2151 * Utilities
2152 ** create simple text citation from bibtex entry
2153
2154 #+BEGIN_SRC emacs-lisp :tangle org-ref.el
2155 (defun org-ref-bib-citation ()
2156   "From a bibtex entry, create and return a simple citation string.
2157 This assumes you are in an article."
2158
2159   (bibtex-beginning-of-entry)
2160   (let* ((cb (current-buffer))
2161          (bibtex-expand-strings t)
2162          (entry (loop for (key . value) in (bibtex-parse-entry t)
2163                       collect (cons (downcase key) value)))
2164          (title (replace-regexp-in-string "\n\\|\t\\|\s+" " " (reftex-get-bib-field "title" entry)))
2165          (year  (reftex-get-bib-field "year" entry))
2166          (author (replace-regexp-in-string "\n\\|\t\\|\s+" " " (reftex-get-bib-field "author" entry)))
2167          (key (reftex-get-bib-field "=key=" entry))
2168          (journal (reftex-get-bib-field "journal" entry))
2169          (volume (reftex-get-bib-field "volume" entry))
2170          (pages (reftex-get-bib-field "pages" entry))
2171          (doi (reftex-get-bib-field "doi" entry))
2172          (url (reftex-get-bib-field "url" entry))
2173          )
2174     ;;authors, "title", Journal, vol(iss):pages (year).
2175     (format "%s, \"%s\", %s, %s:%s (%s)"
2176             author title journal  volume pages year)))
2177 #+END_SRC
2178
2179 #+RESULTS:
2180 : org-ref-bib-citation
2181
2182
2183 #+BEGIN_SRC emacs-lisp :tangle org-ref.el
2184 (defun org-ref-bib-html-citation ()
2185   "from a bibtex entry, create and return a simple citation with html links."
2186
2187   (bibtex-beginning-of-entry)
2188   (let* ((cb (current-buffer))
2189          (bibtex-expand-strings t)
2190          (entry (loop for (key . value) in (bibtex-parse-entry t)
2191                       collect (cons (downcase key) value)))
2192          (title (replace-regexp-in-string "\n\\|\t\\|\s+" " " (reftex-get-bib-field "title" entry)))
2193          (year  (reftex-get-bib-field "year" entry))
2194          (author (replace-regexp-in-string "\n\\|\t\\|\s+" " " (reftex-get-bib-field "author" entry)))
2195          (key (reftex-get-bib-field "=key=" entry))
2196          (journal (reftex-get-bib-field "journal" entry))
2197          (volume (reftex-get-bib-field "volume" entry))
2198          (pages (reftex-get-bib-field "pages" entry))
2199          (doi (reftex-get-bib-field "doi" entry))
2200          (url (reftex-get-bib-field "url" entry))
2201          )
2202     ;;authors, "title", Journal, vol(iss):pages (year).
2203     (concat (format "%s, \"%s\", %s, %s:%s (%s)."
2204                     author title journal  volume pages year)
2205             (when url (format " <a href=\"%s\">link</a>" url))
2206             (when doi (format " <a href=\"http://dx.doi.org/%s\">doi</a>" doi)))
2207     ))
2208 #+END_SRC
2209
2210 ** open pdf from bibtex
2211 We bind this to a key here: [[*key%20bindings%20for%20utilities][key bindings for utilities]].
2212 #+BEGIN_SRC emacs-lisp :tangle org-ref.el
2213 (defun org-ref-open-bibtex-pdf ()
2214   "open pdf for a bibtex entry, if it exists. assumes point is in
2215 the entry of interest in the bibfile. but does not check that."
2216   (interactive)
2217   (save-excursion
2218     (bibtex-beginning-of-entry)
2219     (let* ((bibtex-expand-strings t)
2220            (entry (bibtex-parse-entry t))
2221            (key (reftex-get-bib-field "=key=" entry))
2222            (pdf (format (concat org-ref-pdf-directory "%s.pdf") key)))
2223       (message "%s" pdf)
2224       (if (file-exists-p pdf)
2225           (org-open-link-from-string (format "[[file:%s]]" pdf))
2226         (ding)))))
2227 #+END_SRC
2228
2229 ** open notes from bibtex
2230 We bind this to a key here [[*key%20bindings%20for%20utilities][key bindings for utilities]].
2231
2232 #+BEGIN_SRC emacs-lisp :tangle org-ref.el
2233 (defun org-ref-open-bibtex-notes ()
2234   "from a bibtex entry, open the notes if they exist, and create a heading if they do not.
2235
2236 I never did figure out how to use reftex to make this happen
2237 non-interactively. the reftex-format-citation function did not
2238 work perfectly; there were carriage returns in the strings, and
2239 it did not put the key where it needed to be. so, below I replace
2240 the carriage returns and extra spaces with a single space and
2241 construct the heading by hand."
2242   (interactive)
2243
2244   (bibtex-beginning-of-entry)
2245   (let* ((cb (current-buffer))
2246          (bibtex-expand-strings t)
2247          (entry (loop for (key . value) in (bibtex-parse-entry t)
2248                       collect (cons (downcase key) value)))
2249          (title (replace-regexp-in-string "\n\\|\t\\|\s+" " " (reftex-get-bib-field "title" entry)))
2250          (year  (reftex-get-bib-field "year" entry))
2251          (author (replace-regexp-in-string "\n\\|\t\\|\s+" " " (reftex-get-bib-field "author" entry)))
2252          (key (reftex-get-bib-field "=key=" entry))
2253          (journal (reftex-get-bib-field "journal" entry))
2254          (volume (reftex-get-bib-field "volume" entry))
2255          (pages (reftex-get-bib-field "pages" entry))
2256          (doi (reftex-get-bib-field "doi" entry))
2257          (url (reftex-get-bib-field "url" entry))
2258          )
2259
2260     ;; save key to clipboard to make saving pdf later easier by pasting.
2261     (with-temp-buffer
2262       (insert key)
2263       (kill-ring-save (point-min) (point-max)))
2264
2265     ;; now look for entry in the notes file
2266     (if  org-ref-bibliography-notes
2267         (find-file-other-window org-ref-bibliography-notes)
2268       (error "org-ref-bib-bibliography-notes is not set to anything"))
2269
2270     (goto-char (point-min))
2271     ;; put new entry in notes if we don't find it.
2272     (if (re-search-forward (format ":Custom_ID: %s$" key) nil 'end)
2273         (funcall org-ref-open-notes-function)
2274       ;; no entry found, so add one
2275       (insert (format "\n** TODO %s - %s" year title))
2276       (insert (format"
2277  :PROPERTIES:
2278   :Custom_ID: %s
2279   :AUTHOR: %s
2280   :JOURNAL: %s
2281   :YEAR: %s
2282   :VOLUME: %s
2283   :PAGES: %s
2284   :DOI: %s
2285   :URL: %s
2286  :END:
2287 [[cite:%s]] [[file:%s/%s.pdf][pdf]]\n\n"
2288 key author journal year volume pages doi url key org-ref-pdf-directory key))
2289 (save-buffer))))
2290 #+END_SRC
2291
2292 #+BEGIN_SRC emacs-lisp :tangle org-ref.el
2293 (defun org-ref-open-notes-from-reftex ()
2294   "Call reftex, and open notes for selected entry."
2295   (interactive)
2296   (let ((bibtex-key )))
2297
2298     ;; now look for entry in the notes file
2299     (if  org-ref-bibliography-notes
2300         (find-file-other-window org-ref-bibliography-notes)
2301       (error "org-ref-bib-bibliography-notes is not set to anything"))
2302
2303     (goto-char (point-min))
2304
2305     (re-search-forward (format
2306                         ":Custom_ID: %s$"
2307                         (first (reftex-citation t)) nil 'end))
2308     (funcall org-ref-open-notes-function))
2309 #+END_SRC
2310
2311 ** open url in browser from bibtex
2312
2313 We bind this to a key here [[*key%20bindings%20for%20utilities][key bindings for utilities]].
2314
2315 + This function may be duplicative of bibtex-url. But I think my function is better unless you do some complicated customization of bibtex-generate-url-list.
2316
2317 #+BEGIN_SRC emacs-lisp :tangle org-ref.el
2318 (defun org-ref-open-in-browser ()
2319   "Open the bibtex entry at point in a browser using the url field or doi field"
2320 (interactive)
2321 (save-excursion
2322   (bibtex-beginning-of-entry)
2323   (catch 'done
2324     (let ((url (bibtex-autokey-get-field "url")))
2325       (when  url
2326         (browse-url url)
2327         (throw 'done nil)))
2328
2329     (let ((doi (bibtex-autokey-get-field "doi")))
2330       (when doi
2331         (if (string-match "^http" doi)
2332             (browse-url doi)
2333           (browse-url (format "http://dx.doi.org/%s" doi)))
2334         (throw 'done nil)))
2335     (message "No url or doi found"))))
2336 #+END_SRC
2337
2338 ** citeulike
2339    I discovered you could upload a bibtex entry to citeulike using http requests. The upload is actually done by a [[*The%20upload%20script][python script]], because it was easy to write. Here is the emacs command to do this. It is not a fast operation, and  do not use it frequently.
2340
2341 *** function to upload bibtex to citeulike
2342
2343 #+BEGIN_SRC emacs-lisp :tangle org-ref.el
2344 (defun org-ref-upload-bibtex-entry-to-citeulike ()
2345   "with point in  a bibtex entry get bibtex string and submit to citeulike.
2346
2347 Relies on the python script /upload_bibtex_citeulike.py being in the user directory."
2348   (interactive)
2349   (message "uploading to citeulike")
2350   (save-restriction
2351     (bibtex-narrow-to-entry)
2352     (let ((startpos (point-min))
2353           (endpos (point-max))
2354           (bibtex-string (buffer-string))
2355           (script (concat "python " starter-kit-dir "/upload_bibtex_citeulike.py&")))
2356       (with-temp-buffer (insert bibtex-string)
2357                         (shell-command-on-region (point-min) (point-max) script t nil nil t)))))
2358 #+END_SRC
2359
2360 *** The upload script
2361 Here is the python script for uploading.
2362
2363 *************** TODO document how to get the cookies
2364 *************** END
2365
2366
2367 #+BEGIN_SRC python :tangle upload_bibtex_citeulike.py
2368 #!python
2369 import pickle, requests, sys
2370
2371 # reload cookies
2372 with open('c:/Users/jkitchin/Dropbox/blogofile-jkitchin.github.com/_blog/cookies.pckl', 'rb') as f:
2373     cookies = pickle.load(f)
2374
2375 url = 'http://www.citeulike.org/profile/jkitchin/import_do'
2376
2377 bibtex = sys.stdin.read()
2378
2379 data = {'pasted':bibtex,
2380         'to_read':2,
2381         'tag_parsing':'simple',
2382         'strip_brackets':'no',
2383         'update_id':'bib-key',
2384         'btn_bibtex':'Import BibTeX file ...'}
2385
2386 headers = {'content-type': 'multipart/form-data',
2387            'User-Agent':'jkitchin/johnrkitchin@gmail.com bibtexupload'}
2388
2389 r = requests.post(url, headers=headers, data=data, cookies=cookies, files={})
2390 print r
2391 #+END_SRC
2392
2393 ** Build a pdf from a bibtex file
2394    It is useful to have a pdf version of an entire bibliography to check it for formatting, spelling, or to share it. This function creates a pdf from a bibtex file. I only include the packages  I commonly use in my bitex files.
2395
2396 #+BEGIN_SRC emacs-lisp :tangle org-ref.el
2397 (defun org-ref-build-full-bibliography ()
2398   "build pdf of all bibtex entries, and open it."
2399   (interactive)
2400   (let* ((bibfile (file-name-nondirectory (buffer-file-name)))
2401         (bib-base (file-name-sans-extension bibfile))
2402         (texfile (concat bib-base ".tex"))
2403         (pdffile (concat bib-base ".pdf")))
2404     (find-file texfile)
2405     (erase-buffer)
2406     (insert (format "\\documentclass[12pt]{article}
2407 \\usepackage[version=3]{mhchem}
2408 \\usepackage{url}
2409 \\usepackage[numbers]{natbib}
2410 \\usepackage[colorlinks=true, linkcolor=blue, urlcolor=blue, pdfstartview=FitH]{hyperref}
2411 \\usepackage{doi}
2412 \\begin{document}
2413 \\nocite{*}
2414 \\bibliographystyle{unsrtnat}
2415 \\bibliography{%s}
2416 \\end{document}" bib-base))
2417     (save-buffer)
2418     (shell-command (concat "pdflatex " bib-base))
2419     (shell-command (concat "bibtex " bib-base))
2420     (shell-command (concat "pdflatex " bib-base))
2421     (shell-command (concat "pdflatex " bib-base))
2422     (kill-buffer texfile)
2423     (org-open-file pdffile)
2424     ))
2425 #+END_SRC
2426
2427 ** Extract bibtex entries cited in an org-file
2428 When you use your default bibliography file, and you want to send an org-file to a collaborator, you may need to include bibtex entries so the other person can see them. This function does that and puts the entries in a section at the end of the document that can be tangled to a bib-file.
2429
2430 #+BEGIN_SRC emacs-lisp  :tangle org-ref.el
2431 (defun org-ref-extract-bibtex-entries ()
2432   "extract the bibtex entries referred to by cite links in the current buffer into a src block at the bottom of the current buffer.
2433
2434 If no bibliography is in the buffer the `reftex-default-bibliography' is used."
2435   (interactive)
2436   (let* ((temporary-file-directory (file-name-directory (buffer-file-name)))
2437          (tempname (make-temp-file "extract-bib"))
2438          (contents (buffer-string))
2439          (cb (current-buffer))
2440          basename texfile bibfile results)
2441
2442     ;; open tempfile and insert org-buffer contents
2443     (find-file tempname)
2444     (insert contents)
2445     (setq basename (file-name-sans-extension
2446                     (file-name-nondirectory buffer-file-name))
2447           texfile (concat tempname ".tex")
2448           bibfile (concat tempname ".bib"))
2449
2450     ;; see if we have a bibliography, and insert the default one if not.
2451     (save-excursion
2452       (goto-char (point-min))
2453       (unless (re-search-forward "^bibliography:" (point-max) 'end)
2454         (insert (format "\nbibliography:%s"
2455                         (mapconcat 'identity reftex-default-bibliography ",")))))
2456     (save-buffer)
2457
2458     ;; get a latex file and extract the references
2459     (org-latex-export-to-latex)
2460     (find-file texfile)
2461     (reftex-parse-all)
2462     (reftex-create-bibtex-file bibfile)
2463     (save-buffer)
2464     ;; save results of the references
2465     (setq results (buffer-string))
2466
2467     ;; kill buffers. these are named by basename, not full path
2468     (kill-buffer (concat basename ".bib"))
2469     (kill-buffer (concat basename ".tex"))
2470     (kill-buffer basename)
2471
2472     (delete-file bibfile)
2473     (delete-file texfile)
2474     (delete-file tempname)
2475
2476     ;; Now back to the original org buffer and insert the results
2477     (switch-to-buffer cb)
2478     (when (not (string= "" results))
2479       (save-excursion
2480         (goto-char (point-max))
2481         (insert "\n\n")
2482         (org-insert-heading)
2483         (insert (format " Bibtex entries
2484
2485 ,#+BEGIN_SRC text :tangle %s
2486 %s
2487 ,#+END_SRC" (concat (file-name-sans-extension (file-name-nondirectory (buffer-file-name))) ".bib") results))))))
2488 #+END_SRC
2489
2490 ** Find bad cite links
2491    :PROPERTIES:
2492    :ID:       8515E800-EDA0-4B2A-85FD-55B6FF849203
2493    :END:
2494 Depending on how you enter citations, you may have citations with no corresponding bibtex entry. This function finds them and gives you a clickable table to navigate to them.
2495
2496 #+BEGIN_SRC emacs-lisp  :tangle org-ref.el
2497 (require 'cl)
2498
2499 (defun index (substring list)
2500   "return the index of string in a list of strings"
2501   (let ((i 0)
2502         (found nil))
2503     (dolist (arg list i)
2504       (if (string-match (concat "^" substring "$") arg)
2505           (progn
2506             (setq found t)
2507             (return i)))
2508       (setq i (+ i 1)))
2509     ;; return counter if found, otherwise return nil
2510     (if found i nil)))
2511
2512
2513 (defun org-ref-find-bad-citations ()
2514   "Create a list of citation keys in an org-file that do not have a bibtex entry in the known bibtex files.
2515
2516 Makes a new buffer with clickable links."
2517   (interactive)
2518   ;; generate the list of bibtex-keys and cited keys
2519   (let* ((bibtex-files (org-ref-find-bibliography))
2520          (bibtex-file-path (mapconcat (lambda (x) (file-name-directory (file-truename x))) bibtex-files ":"))
2521          (bibtex-keys (mapcar (lambda (x) (car x)) (bibtex-global-key-alist)))
2522          (bad-citations '()))
2523
2524     (org-element-map (org-element-parse-buffer) 'link
2525       (lambda (link)
2526         (let ((plist (nth 1 link)))
2527           (when (equal (plist-get plist ':type) "cite")
2528             (dolist (key (org-ref-split-and-strip-string (plist-get plist ':path)) )
2529               (when (not (index key bibtex-keys))
2530                 (setq bad-citations (append bad-citations
2531                                             `(,(format "%s [[elisp:(progn (switch-to-buffer-other-frame \"%s\")(goto-char %s))][not found here]]\n"
2532                                                        key (buffer-name)(plist-get plist ':begin)))))
2533                 ))))))
2534
2535     (if bad-citations
2536       (progn
2537         (switch-to-buffer-other-window "*Missing citations*")
2538         (org-mode)
2539         (erase-buffer)
2540         (insert "* List of bad cite links\n")
2541         (insert (mapconcat 'identity bad-citations ""))
2542                                         ;(setq buffer-read-only t)
2543         (use-local-map (copy-keymap org-mode-map))
2544         (local-set-key "q" #'(lambda () (interactive) (kill-buffer))))
2545
2546       (when (get-buffer "*Missing citations*")
2547           (kill-buffer "*Missing citations*"))
2548       (message "No bad cite links found"))))
2549 #+END_SRC
2550
2551 ** helm interface to org-ref
2552 In [[id:8515E800-EDA0-4B2A-85FD-55B6FF849203][Find bad cite links]] we wrote a function that finds bad links and creates a buffer of links to them.
2553
2554 Here we develop a similar idea, but instead of an org-buffer with links, we create helm sources for bad cite links, bad ref links, and multiple labels.
2555
2556 #+BEGIN_SRC emacs-lisp :tangle org-ref.el
2557 (defun org-ref-bad-cite-candidates ()
2558   "Returns a list of conses (key . marker) where key does not exist in the known bibliography files, and marker points to the key."
2559   (let* ((cp (point))                   ; save to return to later
2560          (bibtex-files (org-ref-find-bibliography))
2561          (bibtex-file-path (mapconcat
2562                             (lambda (x)
2563                               (file-name-directory (file-truename x)))
2564                             bibtex-files ":"))
2565          (bibtex-keys (mapcar (lambda (x) (car x))
2566                               (bibtex-global-key-alist)))
2567          (bad-citations '()))
2568
2569     (org-element-map (org-element-parse-buffer) 'link
2570       (lambda (link)
2571         (let ((plist (nth 1 link)))
2572           (when (-contains? org-ref-cite-types (plist-get plist ':type))
2573             (dolist (key (org-ref-split-and-strip-string (plist-get plist ':path)) )
2574               (when (not (index key bibtex-keys))
2575                 (goto-char (plist-get plist ':begin))
2576                 (re-search-forward key)
2577                 (push (cons key (point-marker)) bad-citations)))
2578               ))))
2579     (goto-char cp)
2580     bad-citations))
2581
2582 ;; It seems I forgot I already defined this earlier!
2583 ;; (defun org-ref-get-labels ()
2584 ;;   "Returns a list of known labels in the org document. These include label links, latex labels, label tags, and table names. The list contains all labels, not just unique ones.
2585 ;; "
2586 ;;   (let ((cp (point))
2587 ;;      (labels '()))
2588 ;;     (goto-char (point-min))
2589 ;;     (while (re-search-forward "[^#+]label:\\(.*\\)\\s-" nil t)
2590 ;;       (push  (match-string 1) labels))
2591
2592 ;;     (goto-char (point-min))
2593 ;;     (while (re-search-forward "\\label{\\(.*\\)}\\s-?" nil t)
2594 ;;       (push (match-string 1) labels))
2595
2596 ;;     (goto-char (point-min))
2597 ;;     (while (re-search-forward "^#\\+label:\\s-*\\(.*\\)" nil t)
2598 ;;       (push (match-string 1) labels))
2599
2600 ;;     (goto-char (point-min))
2601 ;;     (while (re-search-forward "^#\\+tblname:\\s-*\\(.*\\)" nil t)
2602 ;;       (push (match-string 1) labels))
2603 ;;     ;; check for CUSTOM_ID
2604 ;;     (org-map-entries
2605 ;;      (lambda ()
2606 ;;        (when (org-entry-get (point) "CUSTOM_ID")
2607 ;;       (push (org-entry-get (point) "CUSTOM_ID") labels))))
2608 ;;     ;; return to original place
2609 ;;     (goto-char cp)
2610 ;;     labels))
2611
2612
2613 (defun org-ref-bad-ref-candidates ()
2614   "Returns a list of conses (ref . marker) where ref is a ref link that does not point to anything (i.e. a label)."
2615   ;; first get a list of legitimate labels
2616   (let ((cp (point))
2617         (labels (org-ref-get-labels))
2618         (bad-refs '()))
2619     ;; now loop over ref links
2620     (goto-char (point-min))
2621     (org-element-map (org-element-parse-buffer) 'link
2622       (lambda (link)
2623         (let ((plist (nth 1 link)))
2624           (when (or  (equal (plist-get plist ':type) "ref")
2625                      (equal (plist-get plist ':type) "eqref")
2626                      (equal (plist-get plist ':type) "pageref")
2627                      (equal (plist-get plist ':type) "nameref"))
2628             (unless (-contains? labels (plist-get plist :path))
2629               (goto-char (plist-get plist :begin))
2630               (add-to-list
2631                'bad-refs
2632                (cons (plist-get plist :path)
2633                      (point-marker))))))))
2634     (goto-char cp)
2635     bad-refs))
2636
2637
2638 (defun org-ref-bad-label-candidates ()
2639   "Return a list of labels where label is multiply defined."
2640   (let ((labels (org-ref-get-labels))
2641         (multiple-labels '()))
2642     (when (not (= (length labels)
2643                   (length (-uniq labels))))
2644       (dolist (label labels)
2645         (when (> (-count (lambda (a)
2646                            (equal a label))
2647                          labels) 1)
2648           ;; this is a multiply defined label.
2649           (let ((cp (point)))
2650             (goto-char (point-min))
2651             (while (re-search-forward
2652                     (format  "[^#+]label:%s\\s-" label) nil t)
2653               (push (cons label (point-marker)) multiple-labels))
2654
2655             (goto-char (point-min))
2656             (while (re-search-forward
2657                     (format  "\\label{%s}\\s-?" label) nil t)
2658               (push (cons label (point-marker)) multiple-labels))
2659
2660             (goto-char (point-min))
2661             (while (re-search-forward
2662                     (format  "^#\\+label:\\s-*%s" label) nil t)
2663               (push (cons label (point-marker)) multiple-labels))
2664
2665             (goto-char (point-min))
2666             (while (re-search-forward
2667                     (format   "^#\\+tblname:\\s-*%s" label) nil t)
2668               (push (cons label (point-marker)) multiple-labels))
2669             (goto-char cp)))))
2670       multiple-labels))
2671 #+END_SRC
2672
2673 #+RESULTS:
2674 : org-ref-bad-label-candidates
2675
2676 Now, we have a functions for candidates, we can make helm sources for each one, and then run a helm command to view them.
2677
2678 #+BEGIN_SRC emacs-lisp :tangle org-ref.el
2679 (defun org-ref ()
2680   "Opens a helm interface to actions for org-ref.
2681 Shows bad citations, ref links and labels"
2682   (interactive)
2683   (let ((cb (current-buffer))
2684         (bad-citations (org-ref-bad-cite-candidates))
2685         (bad-refs (org-ref-bad-ref-candidates))
2686         (bad-labels (org-ref-bad-label-candidates)))
2687
2688     (helm :sources `(((name . "Bad citations")
2689                        (candidates . ,bad-citations)
2690                        (action . (lambda (marker)
2691                                    (switch-to-buffer (marker-buffer marker))
2692                                    (goto-char marker))))
2693                      ;;
2694                      ((name . "Bad Labels")
2695                       (candidates . ,bad-labels)
2696                       (action . (lambda (marker)
2697                                    (switch-to-buffer (marker-buffer marker))
2698                                    (goto-char marker))))
2699                      ;;
2700                      ((name . "Bad ref links")
2701                       (candidates . ,bad-refs)
2702                       (action . (lambda (marker)
2703                                           (switch-to-buffer (marker-buffer marker))
2704                                           (goto-char marker))))
2705                      ;;
2706                      ((name . "Utilities")
2707                       (candidates . (("Check buffer again" . org-ref)
2708                                      ("Insert citation" . helm-bibtex)
2709                                      ("Insert label link" . org-ref-helm-insert-label-link)
2710                                      ("Insert ref link" . org-ref-helm-insert-ref-link)
2711                                      ("List of figures" . org-ref-list-of-figures)
2712                                      ("List of tables" . org-ref-list-of-tables)
2713                                      ("Table of contents" . nil)
2714                                      ))
2715                       (action . (lambda (x)
2716                                   (switch-to-buffer ,cb)
2717                                   (funcall x))))
2718                      ;;
2719                      ((name . "Export functions")
2720                       (candidates . (("Extract cited entries" . org-ref-extract-bibtex-entries)
2721                                      ("Export to html and open" . (lambda () (org-open-file (org-html-export-to-html))))
2722                                      ("Export to pdf and open" . (lambda ()
2723                                                                    (org-open-file (org-latex-export-to-pdf))))
2724                                      ("Export to manuscript pdf and open" . ox-manuscript-export-and-build-and-open)
2725                                      ("Export submission manuscript pdf and open" . ox-manuscript-build-submission-manuscript-and-open)
2726
2727                                      ))
2728                       (action . (lambda (x)
2729                                   (switch-to-buffer ,cb)
2730                                   (funcall x))))
2731                       ))))
2732 #+END_SRC
2733
2734
2735 ** Finding non-ascii characters
2736 I like my bibtex files to be 100% ascii. This function finds the non-ascii characters so you can replace them.
2737
2738 #+BEGIN_SRC emacs-lisp :tangle org-ref.el
2739 (defun org-ref-find-non-ascii-characters ()
2740   "finds non-ascii characters in the buffer. Useful for cleaning up bibtex files"
2741   (interactive)
2742   (occur "[^[:ascii:]]"))
2743 #+END_SRC
2744
2745 ** Resort a bibtex entry
2746 I like neat and orderly bibtex entries.That means the fields are in a standard order that I like. This function reorders the fields in an entry for articles, and makes sure the fields are in lowercase.
2747
2748 #+BEGIN_SRC emacs-lisp :tangle org-ref.el
2749 (defun org-ref-sort-bibtex-entry ()
2750   "sort fields of entry in standard order and downcase them"
2751   (interactive)
2752   (bibtex-beginning-of-entry)
2753   (let* ((master '("author" "title" "journal" "volume" "number" "pages" "year" "doi" "url"))
2754          (entry (bibtex-parse-entry))
2755          (entry-fields)
2756          (other-fields)
2757          (type (cdr (assoc "=type=" entry)))
2758          (key (cdr (assoc "=key=" entry))))
2759
2760     ;; these are the fields we want to order that are in this entry
2761     (setq entry-fields (mapcar (lambda (x) (car x)) entry))
2762     ;; we do not want to reenter these fields
2763     (setq entry-fields (remove "=key=" entry-fields))
2764     (setq entry-fields (remove "=type=" entry-fields))
2765
2766     ;;these are the other fields in the entry
2767     (setq other-fields (remove-if-not (lambda(x) (not (member x master))) entry-fields))
2768
2769     (cond
2770      ;; right now we only resort articles
2771      ((string= (downcase type) "article")
2772       (bibtex-kill-entry)
2773       (insert
2774        (concat "@article{" key ",\n"
2775                (mapconcat
2776                 (lambda (field)
2777                   (when (member field entry-fields)
2778                     (format "%s = %s," (downcase field) (cdr (assoc field entry))))) master "\n")
2779                (mapconcat
2780                 (lambda (field)
2781                   (format "%s = %s," (downcase field) (cdr (assoc field entry)))) other-fields "\n")
2782                "\n}\n\n"))
2783       (bibtex-find-entry key)
2784       (bibtex-fill-entry)
2785       (bibtex-clean-entry)
2786        ))))
2787 #+END_SRC
2788
2789 ** Clean a bibtex entry
2790    I like neat and orderly bibtex entries. This code will eventually replace the key with my style key, clean the entry, and sort the fields in the order I like them.
2791 see [[file:emacs-24.3/lisp/textmodes/bibtex.el::bibtex-autokey-before-presentation-function]] for how to set a function that checks for uniqueness of the key.
2792 #+BEGIN_SRC emacs-lisp :tangle org-ref.el
2793 (defun org-ref-clean-bibtex-entry(&optional keep-key)
2794   "clean and replace the key in a bibtex function. When keep-key is t, do not replace it. You can use a prefix to specify the key should be kept"
2795   (interactive "P")
2796   (bibtex-beginning-of-entry)
2797 (end-of-line)
2798   ;; some entries do not have a key or comma in first line. We check and add it, if needed.
2799   (unless (string-match ",$" (thing-at-point 'line))
2800     (end-of-line)
2801     (insert ","))
2802
2803   ;; check for empty pages, and put eid or article id in its place
2804   (let ((entry (bibtex-parse-entry))
2805         (pages (bibtex-autokey-get-field "pages"))
2806         (year (bibtex-autokey-get-field "year"))
2807         (doi  (bibtex-autokey-get-field "doi"))
2808         ;; The Journal of Chemical Physics uses eid
2809         (eid (bibtex-autokey-get-field "eid")))
2810
2811     ;; replace http://dx.doi.org/ in doi. some journals put that in,
2812     ;; but we only want the doi.
2813     (when (string-match "^http://dx.doi.org/" doi)
2814       (bibtex-beginning-of-entry)
2815       (goto-char (car (cdr (bibtex-search-forward-field "doi" t))))
2816       (bibtex-kill-field)
2817       (bibtex-make-field "doi")
2818       (backward-char)
2819       (insert (replace-regexp-in-string "^http://dx.doi.org/" "" doi)))
2820
2821     ;; asap articles often set year to 0, which messes up key
2822     ;; generation. fix that.
2823     (when (string= "0" year)
2824       (bibtex-beginning-of-entry)
2825       (goto-char (car (cdr (bibtex-search-forward-field "year" t))))
2826       (bibtex-kill-field)
2827       (bibtex-make-field "year")
2828       (backward-char)
2829       (insert (read-string "Enter year: ")))
2830
2831     ;; fix pages if they are empty if there is an eid to put there.
2832     (when (string= "-" pages)
2833       (when eid
2834         (bibtex-beginning-of-entry)
2835         ;; this seems like a clunky way to set the pages field.But I
2836         ;; cannot find a better way.
2837         (goto-char (car (cdr (bibtex-search-forward-field "pages" t))))
2838         (bibtex-kill-field)
2839         (bibtex-make-field "pages")
2840         (backward-char)
2841         (insert eid)))
2842
2843     ;; replace naked & with \&
2844     (save-restriction
2845       (bibtex-narrow-to-entry)
2846       (bibtex-beginning-of-entry)
2847       (message "checking &")
2848       (replace-regexp " & " " \\\\& ")
2849       (widen))
2850
2851     ;; generate a key, and if it duplicates an existing key, edit it.
2852     (unless keep-key
2853       (let ((key (bibtex-generate-autokey)))
2854
2855         ;; first we delete the existing key
2856         (bibtex-beginning-of-entry)
2857         (re-search-forward bibtex-entry-maybe-empty-head)
2858         (if (match-beginning bibtex-key-in-head)
2859             (delete-region (match-beginning bibtex-key-in-head)
2860                            (match-end bibtex-key-in-head)))
2861         ;; check if the key is in the buffer
2862         (when (save-excursion
2863                 (bibtex-search-entry key))
2864           (save-excursion
2865             (bibtex-search-entry key)
2866             (bibtex-copy-entry-as-kill)
2867             (switch-to-buffer-other-window "*duplicate entry*")
2868             (bibtex-yank))
2869           (setq key (bibtex-read-key "Duplicate Key found, edit: " key)))
2870
2871         (insert key)
2872         (kill-new key))) ;; save key for pasting
2873
2874     ;; run hooks. each of these operates on the entry with no arguments.
2875     ;; this did not work like  i thought, it gives a symbolp error.
2876     ;; (run-hooks org-ref-clean-bibtex-entry-hook)
2877     (mapcar (lambda (x)
2878               (save-restriction
2879                 (save-excursion
2880                   (funcall x))))
2881             org-ref-clean-bibtex-entry-hook)
2882
2883     ;; sort fields within entry
2884     (org-ref-sort-bibtex-entry)
2885     ;; check for non-ascii characters
2886     (occur "[^[:ascii:]]")
2887     ))
2888 #+END_SRC
2889
2890 #+RESULTS:
2891 : org-ref-clean-bibtex-entry
2892
2893 ** Sort the entries in a citation link by year
2894 I prefer citations in chronological order within a grouping. These functions sort the link under the cursor by year.
2895
2896 #+BEGIN_SRC emacs-lisp :tangle org-ref.el
2897 (defun org-ref-get-citation-year (key)
2898   "get the year of an entry with key. Returns year as a string."
2899   (interactive)
2900   (let* ((results (org-ref-get-bibtex-key-and-file key))
2901          (bibfile (cdr results)))
2902     (with-temp-buffer
2903       (insert-file-contents bibfile)
2904       (bibtex-search-entry key nil 0)
2905       (prog1 (reftex-get-bib-field "year" (bibtex-parse-entry t))
2906         ))))
2907
2908 (defun org-ref-sort-citation-link ()
2909  "replace link at point with sorted link by year"
2910  (interactive)
2911  (let* ((object (org-element-context))
2912         (type (org-element-property :type object))
2913         (begin (org-element-property :begin object))
2914         (end (org-element-property :end object))
2915         (link-string (org-element-property :path object))
2916         keys years data)
2917   (setq keys (org-ref-split-and-strip-string link-string))
2918   (setq years (mapcar 'org-ref-get-citation-year keys))
2919   (setq data (mapcar* (lambda (a b) `(,a . ,b)) years keys))
2920   (setq data (cl-sort data (lambda (x y) (< (string-to-int (car x)) (string-to-int (car y))))))
2921   ;; now get the keys separated by commas
2922   (setq keys (mapconcat (lambda (x) (cdr x)) data ","))
2923   ;; and replace the link with the sorted keys
2924   (cl--set-buffer-substring begin end (concat type ":" keys))))
2925 #+END_SRC
2926
2927 ** Sort entries in citation links with shift-arrow keys
2928 Sometimes it may be helpful to manually change the order of citations. These functions define shift-arrow functions.
2929 #+BEGIN_SRC emacs-lisp :tangle org-ref.el
2930 (defun org-ref-swap-keys (i j keys)
2931  "swap the keys in a list with index i and j"
2932  (let ((tempi (nth i keys)))
2933    (setf (nth i keys) (nth j keys))
2934    (setf (nth j keys) tempi))
2935   keys)
2936
2937 (defun org-ref-swap-citation-link (direction)
2938  "move citation at point in direction +1 is to the right, -1 to the left"
2939  (interactive)
2940  (let* ((object (org-element-context))
2941         (type (org-element-property :type object))
2942         (begin (org-element-property :begin object))
2943         (end (org-element-property :end object))
2944         (link-string (org-element-property :path object))
2945         key keys i)
2946    ;;   We only want this to work on citation links
2947    (when (-contains? org-ref-cite-types type)
2948         (setq key (org-ref-get-bibtex-key-under-cursor))
2949         (setq keys (org-ref-split-and-strip-string link-string))
2950         (setq i (index key keys))  ;; defined in org-ref
2951         (if (> direction 0) ;; shift right
2952             (org-ref-swap-keys i (+ i 1) keys)
2953           (org-ref-swap-keys i (- i 1) keys))
2954         (setq keys (mapconcat 'identity keys ","))
2955         ;; and replace the link with the sorted keys
2956         (cl--set-buffer-substring begin end (concat type ":" keys " "))
2957         ;; now go forward to key so we can move with the key
2958         (re-search-forward key)
2959         (goto-char (match-beginning 0)))))
2960
2961 ;; add hooks to make it work
2962 (add-hook 'org-shiftright-hook (lambda () (org-ref-swap-citation-link 1)))
2963 (add-hook 'org-shiftleft-hook (lambda () (org-ref-swap-citation-link -1)))
2964 #+END_SRC
2965
2966 ** Lightweight messages about links
2967 To get a lighter weight message about the label, ref and cite links, we define a function that gives us the minibuffer message, without the menu. We run this in an idle timer.
2968
2969 #+BEGIN_SRC emacs-lisp :tangle org-ref.el
2970 (defun org-ref-get-label-context (label)
2971   "Return a string of context around a label."
2972   (save-excursion
2973     (catch 'result
2974       (goto-char (point-min))
2975       (when (re-search-forward
2976              (format "label:%s\\b" label) nil t)
2977         (throw 'result (buffer-substring
2978                         (progn
2979                           (previous-line)
2980                           (beginning-of-line)
2981                           (point))
2982                         (progn
2983                           (forward-line 4)
2984                           (point)))))
2985
2986       (goto-char (point-min))
2987       (when (re-search-forward
2988              (format "\\label{%s}" label) nil t)
2989         (throw 'result (buffer-substring
2990                         (progn
2991                           (previous-line)
2992                           (beginning-of-line)
2993                           (point))
2994                         (progn
2995                           (forward-line 4)
2996                           (point)))))
2997
2998       (goto-char (point-min))
2999       (when (re-search-forward
3000              (format "^#\\+label:\\s-*\\(%s\\)\\b" label) nil t)
3001         (throw 'result (buffer-substring
3002                         (progn
3003                           (previous-line)
3004                           (beginning-of-line)
3005                           (point))
3006                         (progn
3007                           (forward-line 4)
3008                           (point)))))
3009
3010       (goto-char (point-min))
3011       (when (re-search-forward
3012              (format "^#\\+tblname:\\s-*\\(%s\\)\\b" label) nil t)
3013         (throw 'result (buffer-substring
3014                         (progn
3015                           (previous-line)
3016                           (beginning-of-line)
3017                           (point))
3018                         (progn
3019                           (forward-line 4)
3020                           (point)))))
3021
3022       ;; maybe we have a CUSTOM-ID
3023       (org-map-entries
3024        (lambda () (when (string=
3025                          label
3026                          (org-entry-get (point) "CUSTOM_ID"))
3027                     (throw 'result (org-get-heading)))))
3028       (beep)
3029       (throw 'result "!!! NO CONTEXT FOUND !!!"))))
3030
3031
3032 (defun org-ref-link-message ()
3033   "Print a minibuffer message about the link that point is on."
3034   (interactive)
3035   (when (eq major-mode 'org-mode)
3036     (let* ((object (org-element-context))
3037            (type (org-element-property :type object)))
3038       (save-excursion
3039         (cond
3040          ;; cite links
3041          ((-contains? org-ref-cite-types type)
3042           (message (org-ref-get-citation-string-at-point)))
3043
3044          ;; message some context about the label we are referring to
3045          ((string= type "ref")
3046           (message (org-ref-get-label-context
3047                     (org-element-property :path object))))
3048
3049          ((string= type "eqref")
3050           (message (org-ref-get-label-context
3051                     (org-element-property :path object))))
3052
3053          ;; message the count
3054          ((string= type "label")
3055           (let ((count (org-ref-count-labels
3056                         (org-element-property :path object))))
3057             ;; get plurality on occurrence correct
3058             (when (> count 1) (beep))
3059             (message (concat
3060                       (number-to-string count)
3061                       " occurence"
3062                       (when (or (= count 0)
3063                                 (> count 1))
3064                         "s")))))
3065
3066          ;; check if the bibliography files exist.
3067          ((string= type "bibliography")
3068           (let* ((bibfile)
3069                  ;; object is the link you clicked on
3070                  (object (org-element-context))
3071                  (link-string (org-element-property :path object))
3072                  (link-string-beginning)
3073                  (link-string-end))
3074
3075             (save-excursion
3076               (goto-char (org-element-property :begin object))
3077               (search-forward link-string nil nil 1)
3078               (setq link-string-beginning (match-beginning 0))
3079               (setq link-string-end (match-end 0)))
3080
3081             ;; now if we have comma separated bibliographies
3082             ;; we find the one clicked on. we want to
3083             ;; search forward to next comma from point
3084             (save-excursion
3085               (goto-char link-string-beginning)
3086               (if (search-forward "," link-string-end 1 1)
3087                   (setq key-end (- (match-end 0) 1)) ; we found a match
3088                 (setq key-end (point)))) ; no comma found so take the point
3089             ;; and backward to previous comma from point
3090             (save-excursion
3091               (goto-char link-string-beginning)
3092               (if (search-backward "," link-string-beginning 1 1)
3093                   (setq key-beginning (+ (match-beginning 0) 1)) ; we found a match
3094                 (setq key-beginning (point)))) ; no match found
3095             ;; save the key we clicked on.
3096             (setq bibfile
3097                   (org-ref-strip-string
3098                    (buffer-substring key-beginning key-end)))
3099             (if (file-exists-p bibfile)
3100                 (message "%s exists." bibfile)
3101               (beep)
3102               (message "!!! %s NOT FOUND !!!" bibfile))))
3103          )))))
3104 #+END_SRC
3105
3106 * Aliases
3107 I like convenience. Here are some aliases for faster typing.
3108
3109 #+BEGIN_SRC emacs-lisp :tangle org-ref.el
3110 (defalias 'oro 'org-ref-open-citation-at-point)
3111 (defalias 'orc 'org-ref-citation-at-point)
3112 (defalias 'orp 'org-ref-open-pdf-at-point)
3113 (defalias 'oru 'org-ref-open-url-at-point)
3114 (defalias 'orn 'org-ref-open-notes-at-point)
3115 (defalias 'ornr 'org-ref-open-notes-from-reftex)
3116
3117 (defalias 'orib 'org-ref-insert-bibliography-link)
3118 (defalias 'oric 'org-ref-insert-cite-link)
3119 (defalias 'orir 'org-ref-insert-ref-link)
3120 (defalias 'orsl 'org-ref-store-bibtex-entry-link)
3121
3122 (defalias 'orcb 'org-ref-clean-bibtex-entry)
3123 #+END_SRC
3124 * Helm interface
3125 [[https://github.com/tmalsburg/helm-bibtex][helm-bibtex]] is a very cool interface to bibtex files. Out of the box though, it is not super convenient for org-ref. Here, we modify it to make it fit our workflow and extend it where needed.
3126
3127 1. Make the default action to insert selected keys.
3128 2. Make open entry second action
3129 #+BEGIN_SRC emacs-lisp :tangle org-ref.el
3130 (setq helm-source-bibtex
3131       '((name                                      . "BibTeX entries")
3132         (init                                      . helm-bibtex-init)
3133         (candidates                                . helm-bibtex-candidates)
3134         (filtered-candidate-transformer            . helm-bibtex-candidates-formatter)
3135         (action . (("Insert citation"              . helm-bibtex-insert-citation)
3136                    ("Show entry"                   . helm-bibtex-show-entry)
3137                    ("Open PDF file (if present)"   . helm-bibtex-open-pdf)
3138                    ("Open URL or DOI in browser"   . helm-bibtex-open-url-or-doi)
3139                    ("Insert reference"             . helm-bibtex-insert-reference)
3140                    ("Insert BibTeX key"            . helm-bibtex-insert-key)
3141                    ("Insert BibTeX entry"          . helm-bibtex-insert-bibtex)
3142                    ("Attach PDF to email"          . helm-bibtex-add-PDF-attachment)
3143                    ("Edit notes"                   . helm-bibtex-edit-notes)
3144                    ))))
3145 #+END_SRC
3146
3147 Now, let us define a function that inserts the cite links:
3148 #+BEGIN_SRC emacs-lisp :tangle org-ref.el
3149 (defun helm-bibtex-format-org-ref (keys)
3150   "Insert selected KEYS as cite link. Append KEYS if you are on a link.
3151 Technically, this function should return a string that is inserted by helm. This function does the insertion and gives helm an empty string to insert. This lets us handle appending to a link properly.
3152
3153 In the helm-bibtex buffer, C-u will give you a helm menu to select a new link type for the selected entries.
3154
3155 C-u C-u will change the key at point to the selected keys.
3156 "
3157   (let* ((object (org-element-context)))
3158     (cond
3159      ;; case where we are in a link
3160      ((and (equal (org-element-type object) 'link)
3161            (-contains?
3162             org-ref-cite-types
3163             (org-element-property :type object)))
3164       (cond
3165        ;; no prefix. append keys
3166        ((equal helm-current-prefix-arg nil)
3167         (goto-char (org-element-property :end object))
3168         (while (looking-back " ") (backward-char))
3169         (insert (concat "," (mapconcat 'identity keys ","))))
3170        ;; double prefix, replace key at point
3171        ((equal helm-current-prefix-arg '(16))
3172         (setf (buffer-substring
3173                (org-element-property :begin object)
3174                (org-element-property :end object))
3175               (concat
3176                (replace-regexp-in-string
3177                 (car (org-ref-get-bibtex-key-and-file)) ; key
3178                 (mapconcat 'identity keys ",")          ; new keys
3179                 (org-element-property :raw-link object)
3180                 )
3181                ;; replace space at end to avoid collapsing into next word.
3182                " ")))
3183        (t
3184         (message "Not found"))))
3185
3186      ;; We are next to a link, and we want to append
3187      ;; next to a link means one character back is on a link.
3188      ((save-excursion
3189         (backward-char)
3190         (and (equal (org-element-type (org-element-context)) 'link)
3191              (-contains?
3192               org-ref-cite-types
3193               (org-element-property :type (org-element-context)))))
3194       (while (looking-back " ") (backward-char))
3195       (insert (concat "," (mapconcat 'identity keys ","))))
3196
3197      ;; insert fresh link
3198      (t
3199       ;;(message-box "fresh link")
3200       (insert
3201        (concat (if (equal helm-current-prefix-arg '(4))
3202                    (helm :sources `((name . "link types")
3203                                     (candidates . ,org-ref-cite-types)
3204                                     (action . (lambda (x) x))))
3205                org-ref-default-citation-link)
3206                ":"
3207                (s-join "," keys))))))
3208   ;; return empty string for helm
3209   "")
3210
3211 (setq helm-bibtex-format-citation-functions
3212       '((org-mode . helm-bibtex-format-org-ref)))
3213
3214 (defun org-ref-helm-insert-cite-link ()
3215   "org-ref function to use helm on the bibliography defined in the org-file."
3216   (interactive)
3217   (let ((helm-bibtex-bibliography (org-ref-find-bibliography)))
3218     (helm-bibtex)))
3219
3220 (require 'helm-bibtex)
3221
3222 ;; add our own fallback entries where we want them. These appear in reverse order of adding in the menu
3223 (setq helm-bibtex-fallback-options
3224       (-insert-at 1 '("Crossref" . "http://search.crossref.org/?q=%s") helm-bibtex-fallback-options))
3225
3226 (setq helm-bibtex-fallback-options
3227       (-insert-at
3228        1
3229        '("Scopus" . "http://www.scopus.com/scopus/search/submit/xadvanced.url?searchfield=TITLE-ABS-KEY(%s)")
3230        helm-bibtex-fallback-options))
3231
3232 (setq helm-bibtex-fallback-options
3233       (-insert-at 1 '("Open Web of Science" . (lambda () (browse-url "http://apps.webofknowledge.com")))
3234                   helm-bibtex-fallback-options))
3235 #+END_SRC
3236
3237 ** A helm click menu
3238 This code provides a helm interface to things you can do when you click on a citation link. This is an alternative to the minibuffer menu.
3239 #+BEGIN_SRC emacs-lisp :tangle org-ref.el
3240 (defun org-ref-get-citation-string-at-point ()
3241   "Get a string of a formatted citation"
3242   (interactive)
3243   (let* ((results (org-ref-get-bibtex-key-and-file))
3244          (key (car results))
3245          (bibfile (cdr results)))
3246     (if bibfile
3247         (save-excursion
3248           (with-temp-buffer
3249             (insert-file-contents bibfile)
3250             (bibtex-search-entry key)
3251             (org-ref-bib-citation)))
3252       (beep)
3253       "!!! No entry found !!!" )))
3254
3255 (defun org-ref-cite-candidates ()
3256   "Generate the list of possible candidates for click actions on a cite link.
3257 Checks for pdf and doi, and add appropriate functions."
3258   (interactive)
3259   (let* ((results (org-ref-get-bibtex-key-and-file))
3260          (key (car results))
3261          (pdf-file (format (concat org-ref-pdf-directory "%s.pdf") key))
3262          (bibfile (cdr results))
3263          (url (save-excursion
3264                 (with-temp-buffer
3265                   (insert-file-contents bibfile)
3266                   (bibtex-search-entry key)
3267                   (bibtex-autokey-get-field "url"))))
3268          (doi (save-excursion
3269                 (with-temp-buffer
3270                   (insert-file-contents bibfile)
3271                   (bibtex-search-entry key)
3272                   ;; I like this better than bibtex-url which does not always find
3273                   ;; the urls
3274                   (bibtex-autokey-get-field "doi"))))
3275          (candidates `(("Quit" . org-ref-citation-at-point)
3276                        ("Open bibtex entry" . org-ref-open-citation-at-point))))
3277     ;; for some reason, when there is no doi or url, they are returned as "". I
3278     ;; prefer nil so we correct this here.
3279     (when (string= doi "") (setq doi nil))
3280     (when (string= url "") (setq url nil))
3281
3282     ;; Conditional pdf functions
3283     (if (file-exists-p pdf-file)
3284         (add-to-list
3285          'candidates
3286          '("Open pdf" . org-ref-open-pdf-at-point)
3287          t)
3288       (add-to-list
3289        'candidates
3290        '("Try to get pdf" . (lambda ()
3291                               (save-window-excursion
3292                                 (org-ref-open-citation-at-point)
3293                                 (bibtex-beginning-of-entry)
3294                                 (doi-utils-get-bibtex-entry-pdf))))
3295        t))
3296
3297
3298     (add-to-list
3299      'candidates
3300      '("Open notes" . org-ref-open-notes-at-point)
3301      t)
3302
3303     ;; conditional url and doi functions
3304     (when (or url doi)
3305       (add-to-list
3306        'candidates
3307        '("Open in browser" . org-ref-open-url-at-point)
3308        t))
3309
3310     (when doi
3311       (mapc (lambda (x)
3312               (add-to-list 'candidates x t))
3313             `(("WOS" . org-ref-wos-at-point)
3314               ("Related articles in WOS" . org-ref-wos-related-at-point)
3315               ("Citing articles in WOS" . org-ref-wos-citing-at-point)
3316               ("Google Scholar" . org-ref-google-scholar-at-point)
3317               ("Pubmed" . org-ref-pubmed-at-point)
3318               ("Crossref" . org-ref-crossref-at-point)
3319               )))
3320
3321     (add-to-list
3322      'candidates
3323      '("Copy formatted citation to clipboard" . org-ref-copy-entry-as-summary)
3324      t)
3325
3326     (add-to-list
3327      'candidates
3328      '("Copy key to clipboard" . (lambda ()
3329                                   (kill-new
3330                                    (car (org-ref-get-bibtex-key-and-file)))))
3331      t)
3332
3333     (add-to-list
3334      'candidates
3335      '("Copy bibtex entry to file" . org-ref-copy-entry-at-point-to-file)
3336      t)
3337
3338     (add-to-list
3339      'candidates
3340      '("Email bibtex entry and pdf" . (lambda ()
3341                   (save-excursion
3342                     (org-ref-open-citation-at-point)
3343                     (email-bibtex-entry))))
3344      t)
3345   ;; finally return a numbered list of the candidates
3346   (loop for i from 0
3347         for cell in candidates
3348         collect (cons (format "%2s. %s" i (car cell))
3349                       (cdr cell)))))
3350
3351
3352 (defvar org-ref-helm-user-candidates '()
3353   "List of user-defined candidates to act when clicking on a cite link.
3354 This is a list of cons cells '((\"description\" . action)). The action function should not take an argument, and should assume point is on the cite key of interest.
3355 ")
3356
3357 ;; example of adding your own function
3358 (add-to-list
3359  'org-ref-helm-user-candidates
3360  '("Example" . (lambda () (message-box "You did it!")))
3361  t)
3362
3363 (defun org-ref-cite-click-helm (key)
3364   "subtle points.
3365 1. get name and candidates before entering helm because we need the org-buffer.
3366 2. switch back to the org buffer before evaluating the action. most of them need the point and buffer."
3367   (interactive)
3368   (let ((name (org-ref-get-citation-string-at-point))
3369         (candidates (org-ref-cite-candidates))
3370         (cb (current-buffer)))
3371
3372     (helm :sources `(((name . ,name)
3373                       (candidates . ,candidates)
3374                       (action . (lambda (f)
3375                                   (switch-to-buffer cb)
3376                                   (funcall f))))
3377                      ((name . "User functions")
3378                       (candidates . ,org-ref-helm-user-candidates)
3379                       (action . (lambda (f)
3380                                   (switch-to-buffer cb)
3381                                   (funcall f))))
3382                      ))))
3383 #+END_SRC
3384
3385 #+RESULTS:
3386 : org-ref-cite-click-helm
3387
3388 * End of code
3389 #+BEGIN_SRC emacs-lisp :tangle org-ref.el
3390 (provide 'org-ref)
3391 #+END_SRC
3392
3393 * Build                                                            :noexport:
3394 This code will tangle the elisp code out to org-ref.el and load it.
3395
3396 [[elisp:(progn (org-babel-tangle) (load-file "org-ref.el"))]]
3397
3398 Alternatively you may use:
3399
3400 [[elisp:(org-babel-load-file "org-ref.org")]]