org-ref.org

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