org-ref.org

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