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