1 #+TITLE: Org-ref - The best reference handling for org-mode
7 This document is an experiment at creating a literate program to provide similar features as reftex for org-mode referencing. These features include:
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
15 Some additional features include
16 1. Get minibuffer messages for the cite/ref/label link under point
18 With helm integration (default) you can:
20 1. C-c ] to insert a citation link
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
30 #+BEGIN_SRC emacs-lisp :tangle org-ref.el
31 ;;; org-ref.el --- cite and cross-reference in org-mode
33 ;; Copyright(C) 2014 John Kitchin
35 ;; Author: John Kitchin <jkitchin@andrew.cmu.edu>
36 ;; URL: https://github.com/jkitchin/org-ref
38 ;; Keywords: org-mode, cite, ref, label
39 ;; Package-Requires: ((dash) (helm) (helm-bibtex))
41 ;; This file is not currently part of GNU Emacs.
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.
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.
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.
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.
70 The only external require is reftex-cite
72 #+BEGIN_SRC emacs-lisp :tangle org-ref.el
73 (require 'reftex-cite)
76 (require 'helm-config)
77 (require 'helm-bibtex)
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.
84 #+BEGIN_SRC emacs-lisp :tangle org-ref.el
86 "customization group for org-ref")
88 (defcustom org-ref-bibliography-notes
90 "filename to where you will put all your notes about an entry in
91 the default bibliography."
95 (defcustom org-ref-default-bibliography
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)
101 (defcustom org-ref-pdf-directory
103 "directory where pdfs are stored by key. put a trailing / in"
107 (defcustom org-ref-default-citation-link
109 "The default type of citation link to use"
113 (defcustom org-ref-insert-cite-key
115 "Keyboard shortcut to insert a citation."
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>.")
122 ("book" . "%a, %t, %u (%y).")
124 ("proceedings" . "%e, %t in %S, %u (%y).")
126 ("inproceedings" . "%a, %t, %p, in %b, edited by %e, %u (%y)"))
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."
132 (defcustom org-ref-open-notes-function
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"
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'."
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."
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'."
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"
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.
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*"
183 "citeauthor" "citeauthor*"
184 "citeyear" "citeyear*"
185 "Citet" "Citep" "Citealt" "Citealp" "Citeauthor"
187 ;; http://ctan.mirrorcatalogs.com/macros/latex/contrib/biblatex/doc/biblatex.pdf
189 "parencite" "Parencite"
190 "footcite" "footcitetext"
191 "textcite" "Textcite"
192 "smartcite" "Smartcite"
193 "cite*" "parencite*" "supercite"
194 "autocite" "Autocite" "autocite*" "Autocite*"
196 "citetitle" "citetitle*"
197 "citedate" "citedate*"
199 "fullcite" "footfullcite"
200 ;; "volcite" "Volcite" cannot support the syntax
201 "notecite" "Notecite"
202 "pnotecite" "Pnotecite"
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
212 "List of citation types known in org-ref"
213 :type '(repeat :tag "List of citation types" string)
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."
226 #+BEGIN_SRC emacs-lisp :tangle org-ref.el
227 (defvar org-ref-bibliography-files
229 "variable to hold bibliography files to be searched")
232 ** org-mode / reftex setup
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.
236 #+BEGIN_SRC emacs-lisp :tangle org-ref.el
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.
247 (make-local-variable 'reftex-cite-format)
248 (setq reftex-cite-format 'org))
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)
255 (add-hook 'org-mode-hook 'org-mode-reftex-setup)
257 (eval-after-load 'reftex-vars
259 (add-to-list 'reftex-cite-format-builtin
260 '(org "Org-mode citation"
261 ((?\C-m . "cite:%l") ; default
262 (?d . ",%l") ; for appending
268 (?h . "citeauthor:%l")
269 (?H . "citeauthor*:%l")
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.
278 #+BEGIN_SRC emacs-lisp :tangle no
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"))))
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)
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.")
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."
301 (or org-ref-message-timer
302 (setq org-ref-message-timer
303 (run-with-idle-timer 0.5 t 'org-ref-link-message))))
306 (defun org-ref-cancel-link-messages ()
307 "Stop showing messages in minibuffer when on a link."
309 (cancel-timer org-ref-message-timer)
310 (setq org-ref-message-timer nil))
313 (when org-ref-show-citation-on-enter
314 (org-ref-show-link-messages))
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))
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.
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.
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'.")
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)))
335 (goto-char (window-start))
338 (> (- (line-end-position) (line-beginning-position)) col)
339 (progn (forward-char col) (point))
343 (defun org-ref-mouse-message ()
344 "Display message for link under mouse cursor"
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)))
352 (org-ref-link-message))))))
355 (defvar org-ref-message-timer-mouse nil
356 "Store mouse timer.")
359 (defvar org-ref-mouse-message-interval 0.5
360 "How often to run the mouse message timer in seconds")
363 (defun org-ref-mouse-messages-on ()
364 "Turn on mouse messages."
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))))
373 (defun org-ref-mouse-messages-off ()
374 "Turn off mouse messages"
376 (cancel-timer org-ref-message-timer-mouse)
377 (setq org-ref-message-timer-mouse nil)
378 (message "Mouse messages are off"))
382 : org-ref-mouse-messages-off
385 Here we make the org-ref links a different color.
393 cite:sokalski-2012-optim-ta,zhang-2011-spatial-tio2,li-2012-heter-ceram,li-2013-photoc
395 cite*:sokalski-2012-optim-ta,zhang-2011-spatial-tio2,li-2012-heter-ceram,li-2013-photoc
397 citenum:sokalski-2012-optim-ta,zhang-2011-spatial-tio2,li-2012-heter-ceram,li-2013-photoc
403 #+BEGIN_SRC emacs-lisp :tangle org-ref.el
404 (defcustom org-ref-colorize-links
406 "When non-nil, change colors of links"
410 (defcustom org-ref-cite-color
412 "Color of cite like links"
416 (defcustom org-ref-ref-color
418 "Color of ref like links"
422 (defcustom org-ref-label-color
424 "Color of label links"
428 (defvar org-ref-cite-re nil
429 "regexp for cite links")
432 (setq org-ref-cite-re
433 (concat "\\(" (mapconcat
435 (replace-regexp-in-string "\*" "\\\\*" x)
437 org-ref-cite-types "\\|") "\\)"
438 ":\\([a-zA-Z0-9-_:]*,?\\)*"))
441 (setq org-ref-label-re
442 "label:\\([a-zA-Z0-9-_:]*,?\\)*")
446 "ref:\\([a-zA-Z0-9-_:]*,?\\)*")
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.")
454 (defface org-ref-label-face
455 `((t (:inherit org-link :foreground ,org-ref-label-color)))
456 "Color for ref links in org-ref.")
459 (defface org-ref-ref-face
460 `((t (:inherit org-link :foreground ,org-ref-ref-color)))
461 "Face for ref links in org-ref.")
464 (defun org-ref-colorize-links ()
465 "Colorize org-ref links."
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))
472 (when org-ref-colorize-links
473 (add-hook 'org-mode-hook 'org-ref-colorize-links))
480 Most of this library is the creation of functional links to help with references and citations.
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.
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)))
493 It is helpful to make the previous function operate on a list of strings here.
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 ",")))
501 ** bibliography and bibliographystyle
502 *** An html bibliography
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.
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"
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)))
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.
521 In the format, the following percent escapes will be expanded.
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)
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
535 %B booktitle, abbreviated %T title, abbreviated
540 Usually, only %l is needed. The other stuff is mainly for the echo area
541 display, and for (setq reftex-comment-citations t).
543 %< as a special operator kills punctuation and space around it after the
544 string has been formatted.
546 A pair of square brackets indicates an optional argument, and RefTeX
547 will prompt for the values of these arguments.
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
554 (unless (stringp format) (setq format "\\cite{%l}"))
556 (if (and reftex-comment-citations
557 (string-match "%l" reftex-cite-comment-format))
558 (error "reftex-cite-comment-format contains invalid %%l"))
561 "\\(\\`\\|[^%]\\)\\(\\(%\\([0-9]*\\)\\([a-zA-Z]\\)\\)[.,;: ]*\\)"
563 (let ((n (string-to-number (match-string 4 format)))
564 (l (string-to-char (match-string 5 format)))
570 (org-ref-reftex-get-bib-field "&key" entry)
571 (if reftex-comment-citations
572 reftex-cite-comment-format
574 ((= l ?a) (reftex-format-names
575 (reftex-get-bib-names "author" entry)
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)
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)
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)))))
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))
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'"
626 (let ((org-ref-bibliography-files (org-ref-find-bibliography))
627 (file) (entry) (bibtex-entry) (entry-type) (format))
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))
633 (message "%s not found in %s" key (file-truename file))))))
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)))
642 (setq entry (org-ref-reftex-format-citation bibtex-entry format))
644 (bibtex-narrow-to-entry)
645 (setq entry (buffer-string)))))
650 : org-ref-reftex-format-citation
652 Here is how to use the function. You call it with point in an entry in a bibtex file.
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"))
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>.
661 I am not sure why full author names are not used.
663 This code provides some functions to generate a simple sorted bibliography in html. First we get all the keys in the buffer.
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."
669 (org-element-map (org-element-parse-buffer) 'link
671 (let ((plist (nth 1 link)))
672 (when (-contains? org-ref-cite-types (plist-get plist ':type))
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
680 ;; Sort keys alphabetically
681 (setq keys (cl-sort keys 'string-lessp :key 'downcase))
685 This function gets the html for one entry.
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"
691 (format "<li><a id=\"%s\">[%s] %s</a></li>" key key (org-ref-get-bibtex-entry-citation key)))
694 Now, we map over the whole list of keys, and the whole bibliography, formatted as an unordered list.
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)))
701 (concat "<h1>Bibliography</h1>
703 (mapconcat (lambda (x) (org-ref-get-bibtex-entry-html x)) keys "\n")
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.
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.
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))
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))
723 (message "%s not found in %s" key (file-truename file))))))
726 (insert-file-contents file)
727 (bibtex-search-entry key nil 0)
728 (setq entry (bibtex-parse-entry))
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))
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)))
749 (concat "* Bibliography
751 (mapconcat (lambda (x) (org-ref-get-bibtex-entry-org x)) keys "\n")
755 *** An ascii bibliography
757 This function gets the html for one entry.
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"
763 (format "[%s] %s" key (org-ref-get-bibtex-entry-citation key)))
766 Now, we map over the whole list of keys, and the whole bibliography, formatted as an unordered list.
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)))
777 (mapconcat (lambda (x) (org-ref-get-bibtex-entry-ascii x)) keys "\n")
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.
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
795 ;; object is the link you clicked on
796 (object (org-element-context))
797 (link-string-beginning)
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)))
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) ","))
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
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
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
830 (lambda (keyword desc format)
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))
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 ","))
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.
847 \input{project-description.bbl}
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.
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
862 ;; object is the link you clicked on
863 (object (org-element-context))
865 (link-string-beginning)
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)))
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) ","))
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
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
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
898 (lambda (keyword desc format)
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))
904 ;; write out the latex bibliography command
906 ; (format "{\\setbox0\\vbox{\\bibliography{%s}}}"
907 ; (replace-regexp-in-string "\\.bib" "" (mapconcat 'identity
908 ; (mapcar 'expand-file-name
909 ; (split-string keyword ","))
912 (format "\\nobibliography{%s}"
913 (replace-regexp-in-string "\\.bib" "" (mapconcat 'identity
914 (mapcar 'expand-file-name
915 (split-string keyword ","))
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)
926 ((eq format 'org) (org-ref-get-org-bibliography))
927 ((eq format 'html) (org-ref-get-html-bibliography))
929 ;; write out the biblatex bibliography command
930 "\\printbibliography"))
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, ...
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)
942 ;; write out the latex bibliography command
943 (format "\\bibliographystyle{%s}" keyword)))))
946 *** Completion for bibliography link
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)))
953 (defun org-ref-insert-bibliography-link ()
954 "insert a bibliography with completion"
956 (insert (org-bibliography-complete-link)))
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
971 ;; object is the link you clicked on
972 (object (org-element-context))
974 (link-string-beginning)
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)))
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) ","))
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
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
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
1007 (lambda (keyword desc format)
1009 ((eq format 'html) (format "")); no output for html
1011 ;; write out the latex addbibresource command
1012 (format "\\addbibresource{%s}" keyword)))))
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.
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"
1023 (save-excursion (widen)
1024 (let* ((c-b (buffer-name))
1027 (org-element-map (org-element-parse-buffer) 'link
1029 "create a link for to the figure"
1031 (and (string= (org-element-property :type link) "file")
1033 "[^.]*\\.\\(png\\|jpg\\|eps\\|pdf\\)$"
1034 (org-element-property :path link)))
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)))
1043 "[[elisp:(progn (switch-to-buffer \"%s\")(widen)(goto-char %s))][figure %s: %s]] %s\n"
1044 c-b start counter (or name "") caption)
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)
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))))))
1059 'org-ref-list-of-figures ; on click
1060 (lambda (keyword desc format)
1063 (format "\\listoffigures")))))
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"
1074 (let* ((c-b (buffer-name))
1077 (org-element-map (org-element-parse-buffer 'element) 'table
1079 "create a link for to the table"
1081 (let ((start (org-element-property :begin table))
1082 (name (org-element-property :name table))
1083 (caption (caaar (org-element-property :caption table))))
1086 "[[elisp:(progn (switch-to-buffer \"%s\")(widen)(goto-char %s))][table %s: %s]] %s\n"
1087 c-b start counter (or name "") caption)
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)
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))))))
1102 'org-ref-list-of-tables
1103 (lambda (keyword desc format)
1106 (format "\\listoftables")))))
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.
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))
1125 (when (string= label (org-entry-get (point) "CUSTOM_ID"))
1126 (setq custom-id-count (+ 1 custom-id-count)))))
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"
1140 (org-ref-count-labels label))))
1141 (lambda (keyword desc format)
1143 ((eq format 'html) (format "(<label>%s</label>)" path))
1145 (format "\\label{%s}" keyword)))))
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.
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
1159 :link (concat "ref:" (org-element-property :path object))))
1161 ;; Store link on table
1162 (when (equal (org-element-type object) 'table)
1163 (org-store-link-props
1165 :link (concat "ref:" (org-element-property :name object))))
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
1173 ; :link (concat "ref:" (org-entry-get (point) "CUSTOM_ID"))))
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
1180 :link (concat "ref:" (org-element-property :name object))))
1183 (add-hook 'org-store-link-functions 'org-label-store-link)
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.
1189 At the moment, ref links are not usable for section links. You need [[#CUSTOM_ID]] type links.
1191 #+BEGIN_SRC emacs-lisp :tangle org-ref.el
1195 "on clicking goto the label. Navigate back with C-c &"
1196 (org-mark-ring-push)
1197 ;; next search from beginning of the buffer
1199 ;; it is possible you would not find the label if narrowing is in effect
1206 (goto-char (point-min))
1207 (re-search-forward (format "label:%s\\b" label) nil t))
1211 (goto-char (point-min))
1212 (re-search-forward (format "\\label{%s}" label) nil t))
1214 ;; #+label: name org-definition
1216 (goto-char (point-min))
1217 (re-search-forward (format "^#\\+label:\\s-*\\(%s\\)\\b" label) nil t))
1221 (goto-char (point-min))
1222 (re-search-forward (format "^#\\+tblname:\\s-*\\(%s\\)\\b" label) nil t))
1224 ;; Commented out because these ref links do not actually translate correctly in LaTeX.
1225 ;; you need [[#label]] links.
1228 ; (goto-char (point-min))
1229 ; (re-search-forward (format ":CUSTOM_ID:\s-*\\(%s\\)" label) nil t))
1231 ;; we did not find anything, so go back to where we came
1232 (org-mark-ring-goto)
1233 (error "%s not found" label))
1235 (message "go back with (org-mark-ring-goto) `C-c &`"))
1237 (lambda (keyword desc format)
1239 ((eq format 'html) (format "(<ref>%s</ref>)" path))
1241 (format "\\ref{%s}" keyword)))))
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.
1246 #+BEGIN_SRC emacs-lisp :tangle org-ref.el
1247 (defun org-ref-get-org-labels ()
1248 "Return a list of #+LABEL: labels."
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))
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)
1263 (let ((custom_id (org-entry-get (point) "CUSTOM_ID")))
1264 (when (not (null custom_id))
1265 (setq results (append results (list custom_id)))))))
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 ()
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))
1280 Finally, we get the table names.
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
1287 (org-element-property :name table))))
1290 Now, we can put all the labels together which will give us a list of candidates.
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."
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))
1305 (org-ref-get-org-labels)
1306 (org-ref-get-latex-labels)
1307 (org-ref-get-tblnames)
1308 (org-ref-get-custom-ids))))))
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."
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)
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))
1335 (if (looking-at " ")
1338 (when (-contains? '("label")
1339 (org-element-property :type object))
1340 ;; we are on a link, so replace it.
1343 (org-element-property :begin object)
1344 (org-element-property :end object))
1346 (replace-regexp-in-string
1347 (org-element-property :path object)
1349 (org-element-property :raw-link object))
1351 ;; no prefix options defined
1353 ;; no matching selection creates a new label
1354 ((name . "Create new label")
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))
1363 (if (looking-at " ")
1366 (if (-contains? '("label")
1367 (org-element-property :type object))
1368 ;; we are on a link, so replace it.
1371 (org-element-property :begin object)
1372 (org-element-property :end object))
1374 (replace-regexp-in-string
1375 (org-element-property :path object)
1377 (org-element-property :raw-link object))
1384 helm-pattern))))))))))))
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.
1389 #+BEGIN_SRC emacs-lisp :tangle org-ref.el
1390 (defun org-ref-complete-link (&optional arg)
1391 "Completion function for ref links"
1393 (setq label (completing-read "label: " (org-ref-get-labels)))
1394 (format "ref:%s" label)))
1397 Alternatively, you may want to just call a function that inserts a link with completion:
1399 #+BEGIN_SRC emacs-lisp :tangle org-ref.el
1400 (defun org-ref-insert-ref-link ()
1402 (insert (org-ref-complete-link)))
1405 Another alternative ref insertion is to use helm.
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
1415 (let* ((labels (org-ref-get-labels))
1416 (bs (buffer-string))
1417 (contexts (with-temp-buffer
1419 (mapcar 'org-ref-get-label-context labels)))
1420 (cb (current-buffer)))
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
1429 collect (cons (concat
1434 (split-string context "\n")
1437 ;; default action to replace or insert ref link.
1438 (action . (lambda (label)
1439 (switch-to-buffer ,cb)
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))
1448 (if (looking-at " ")
1451 (if (-contains? '("ref" "eqref" "pageref" "nameref")
1452 (org-element-property :type object))
1453 ;; we are on a link, so replace it.
1456 (org-element-property :begin object)
1457 (org-element-property :end object))
1459 (replace-regexp-in-string
1460 (org-element-property :path object)
1462 (org-element-property :raw-link object))
1464 ;; insert a new link
1469 ;; one prefix, alternate ref link
1470 ((equal helm-current-prefix-arg '(4))
1473 (helm :sources '((name . "Ref link types")
1474 (candidates . ("ref" "eqref" "pageref" "nameref"))
1475 (action . (lambda (x) x))))
1477 ;; two prefixes, insert section custom-id link
1478 ((equal helm-current-prefix-arg '(16))
1480 (format "[[#%s]]" label)))
1486 : org-ref-helm-insert-ref-link
1490 This refers to the page of a label in LaTeX.
1492 #+BEGIN_SRC emacs-lisp :tangle org-ref.el
1496 "on clicking goto the label. Navigate back with C-c &"
1497 (org-mark-ring-push)
1498 ;; next search from beginning of the buffer
1504 (goto-char (point-min))
1505 (re-search-forward (format "label:%s\\b" label) nil t))
1509 (goto-char (point-min))
1510 (re-search-forward (format "\\label{%s}" label) nil t))
1512 ;; #+label: name org-definition
1514 (goto-char (point-min))
1515 (re-search-forward (format "^#\\+label:\\s-*\\(%s\\)\\b" label) nil t))
1519 (goto-char (point-min))
1520 (re-search-forward (format "^#\\+tblname:\\s-*\\(%s\\)\\b" label) nil t))
1522 ;; Commented out because these ref links do not actually translate correctly in LaTeX.
1523 ;; you need [[#label]] links.
1526 ; (goto-char (point-min))
1527 ; (re-search-forward (format ":CUSTOM_ID:\s-*\\(%s\\)" label) nil t))
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 &`"))
1534 (lambda (keyword desc format)
1536 ((eq format 'html) (format "(<pageref>%s</pageref>)" path))
1538 (format "\\pageref{%s}" keyword)))))
1541 #+BEGIN_SRC emacs-lisp :tangle org-ref.el
1542 (defun org-pageref-complete-link (&optional arg)
1543 "Completion function for ref links"
1545 (setq label (completing-read "label: " (org-ref-get-labels)))
1546 (format "ref:%s" label)))
1549 Alternatively, you may want to just call a function that inserts a link with completion:
1551 #+BEGIN_SRC emacs-lisp :tangle org-ref.el
1552 (defun org-pageref-insert-ref-link ()
1554 (insert (org-pageref-complete-link)))
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.
1561 #+BEGIN_SRC emacs-lisp :tangle org-ref.el
1565 "on clicking goto the label. Navigate back with C-c &"
1566 (org-mark-ring-push)
1567 ;; next search from beginning of the buffer
1573 (goto-char (point-min))
1574 (re-search-forward (format "\\label{%s}" label) nil t))
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 &`"))
1581 (lambda (keyword desc format)
1583 ((eq format 'html) (format "(<nameref>%s</nameref>)" path))
1585 (format "\\nameref{%s}" keyword)))))
1589 This is just the LaTeX ref for equations. On export, the reference is enclosed in parentheses.
1591 #+BEGIN_SRC emacs-lisp :tangle org-ref.el
1595 "on clicking goto the label. Navigate back with C-c &"
1596 (org-mark-ring-push)
1597 ;; next search from beginning of the buffer
1599 (goto-char (point-min))
1602 ;; search forward for the first match
1604 (re-search-forward (format "label:%s" label) nil t)
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 &`"))
1613 (lambda (keyword desc format)
1615 ((eq format 'html) (format "(<eqref>%s</eqref>)" path))
1617 (format "\\eqref{%s}" keyword)))))
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.
1623 *** Implementing the click actions of cite
1625 **** Getting the key we clicked on
1626 The first thing we need is to get the bibtex key we clicked on.
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."
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.
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))
1647 (if (not (org-element-property :contents-begin object))
1648 ;; this means no description in the link
1650 ;; we need the link path start and end
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)))
1657 ;; The key is the text between commas, or the link boundaries
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
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)
1671 ;; link with description. assume only one key
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.
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
1686 falling back to what the user has set in org-ref-default-bibliography
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))
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))
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))
1717 ;; we did not find anything. use defaults
1718 (setq org-ref-bibliography-files org-ref-default-bibliography)))
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)
1725 **** Finding the bibliography file a key is in
1726 Now, we can see if an entry is in a file.
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))
1739 (revert-buffer t t))
1740 (bibtex-search-entry key t))))
1743 Finally, we want to know which file the key is in.
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"
1749 (let ((org-ref-bibliography-files (org-ref-find-bibliography))
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)))))
1760 **** convenience functions to act on citation at point
1762 :ID: af0b2a82-a7c9-4c08-9dac-09f93abc4a92
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.
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"
1770 (let* ((results (org-ref-get-bibtex-key-and-file))
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))))
1778 (defun org-ref-open-url-at-point ()
1779 "open the url for bibtex key under point."
1781 (let* ((results (org-ref-get-bibtex-key-and-file))
1783 (bibfile (cdr results)))
1786 (insert-file-contents bibfile)
1787 (bibtex-search-entry key)
1788 ;; I like this better than bibtex-url which does not always find
1791 (let ((url (bibtex-autokey-get-field "url")))
1793 (browse-url (s-trim url))
1796 (let ((doi (bibtex-autokey-get-field "doi")))
1798 (if (string-match "^http" doi)
1800 (browse-url (format "http://dx.doi.org/%s" (s-trim doi))))
1801 (throw 'done nil))))))))
1804 (defun org-ref-open-notes-at-point ()
1805 "open the notes for bibtex key under point."
1807 (let* ((results (org-ref-get-bibtex-key-and-file))
1809 (bibfile (cdr results)))
1812 (insert-file-contents bibfile)
1813 (bibtex-search-entry key)
1814 (org-ref-open-bibtex-notes)))))
1817 (defun org-ref-citation-at-point ()
1818 "give message of current citation at point"
1820 (let* ((cb (current-buffer))
1821 (results (org-ref-get-bibtex-key-and-file))
1823 (bibfile (cdr results)))
1824 (message "%s" (progn
1826 (insert-file-contents bibfile)
1827 (bibtex-search-entry key)
1828 (org-ref-bib-citation))))))
1831 (defun org-ref-open-citation-at-point ()
1832 "open bibtex file to key at point"
1834 (let* ((cb (current-buffer))
1835 (results (org-ref-get-bibtex-key-and-file))
1837 (bibfile (cdr results)))
1839 (bibtex-search-entry key)))
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.
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.")
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.")
1858 (defun org-ref-copy-entry-as-summary ()
1859 "Copy the bibtex entry for the citation at point as a summary."
1861 (save-window-excursion
1862 (org-ref-open-citation-at-point)
1863 (kill-new (org-ref-bib-citation))))
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."
1870 (let ((new-file (ido-completing-read
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))
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)
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"))
1892 (defun org-ref-get-doi-at-point ()
1893 "Get doi for key at point."
1895 (let* ((results (org-ref-get-bibtex-key-and-file))
1897 (bibfile (cdr results))
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)))))
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."
1912 (doi-utils-wos (org-ref-get-doi-at-point)))
1915 (defun org-ref-wos-citing-at-point ()
1916 "open the doi in wos citing articles for bibtex key under point."
1918 (doi-utils-wos-citing (org-ref-get-doi-at-point)))
1921 (defun org-ref-wos-related-at-point ()
1922 "open the doi in wos related articles for bibtex key under point."
1924 (doi-utils-wos-related (org-ref-get-doi-at-point)))
1927 (defun org-ref-google-scholar-at-point ()
1928 "open the doi in google scholar for bibtex key under point."
1930 (doi-utils-google-scholar (org-ref-get-doi-at-point)))
1933 (defun org-ref-pubmed-at-point ()
1934 "open the doi in pubmed for bibtex key under point."
1936 (doi-utils-pubmed (org-ref-get-doi-at-point)))
1939 (defun org-ref-crossref-at-point ()
1940 "open the doi in crossref for bibtex key under point."
1942 (doi-utils-crossref (org-ref-get-doi-at-point)))
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."
1949 (let* ((results (org-ref-get-bibtex-key-and-file))
1951 (pdf-file (format (concat org-ref-pdf-directory "%s.pdf") key))
1952 (bibfile (cdr results))
1953 (url (save-excursion
1955 (insert-file-contents bibfile)
1956 (bibtex-search-entry key)
1957 (bibtex-autokey-get-field "url"))))
1958 (doi (save-excursion
1960 (insert-file-contents bibfile)
1961 (bibtex-search-entry key)
1962 ;; I like this better than bibtex-url which does not always find
1964 (bibtex-autokey-get-field "doi")))))
1966 (when (string= "" doi) (setq doi nil))
1967 (when (string= "" url) (setq url nil))
1968 (setq org-ref-cite-menu-funcs '())
1974 'org-ref-cite-menu-funcs
1975 '("o" "pen" org-ref-open-citation-at-point)))
1978 (when (file-exists-p pdf-file)
1980 'org-ref-cite-menu-funcs
1981 `("p" "df" ,org-ref-open-pdf-function) t))
1985 'org-ref-cite-menu-funcs
1986 '("n" "otes" org-ref-open-notes-at-point) t)
1991 'org-ref-cite-menu-funcs
1992 '("u" "rl" org-ref-open-url-at-point) t))
1997 'org-ref-cite-menu-funcs
1998 '("w" "os" org-ref-wos-at-point) t)
2001 'org-ref-cite-menu-funcs
2002 '("c" "iting" org-ref-wos-citing-at-point) t)
2005 'org-ref-cite-menu-funcs
2006 '("r" "elated" org-ref-wos-related-at-point) t)
2009 'org-ref-cite-menu-funcs
2010 '("g" "oogle scholar" org-ref-google-scholar-at-point) t)
2013 'org-ref-cite-menu-funcs
2014 '("P" "ubmed" org-ref-pubmed-at-point) t))
2016 ;; add user functions
2017 (dolist (tup org-ref-user-cite-menu-funcs)
2019 'org-ref-cite-menu-funcs
2024 'org-ref-cite-menu-funcs
2025 '("q" "uit" (lambda ())) t)
2027 ;; now we make a menu
2028 ;; construct menu string as a message
2031 (let* ((results (org-ref-get-bibtex-key-and-file))
2033 (bibfile (cdr results)))
2036 (insert-file-contents bibfile)
2037 (bibtex-search-entry key)
2038 (org-ref-bib-citation))))
2042 (concat "[" (elt tup 0) "]"
2044 org-ref-cite-menu-funcs "")))
2046 (let* ((input (read-char-exclusive))
2048 (char-to-string input) org-ref-cite-menu-funcs)))
2049 ;; now run the function (2nd element in choice)
2058 : org-ref-cite-onclick-minibuffer-menu
2060 *** A function to format a cite link
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.
2064 #+BEGIN_SRC emacs-lisp :tangle no
2065 ;(defun org-ref-cite-link-format (keyword desc format)
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) ",")
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.
2077 #+BEGIN_SRC emacs-lisp :tangle no
2080 ; 'org-ref-cite-onclick-minibuffer-menu
2081 ; 'org-ref-cite-link-format)
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.
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)
2095 (let ((bibtex-files (org-ref-find-bibliography)))
2096 (bibtex-global-key-alist))))))
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.
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)
2108 (format "[[#%s][%s]]" key key))
2109 (org-ref-split-and-strip-string keyword) ","))
2116 (org-ref-split-and-strip-string keyword) ",") "]"))
2121 (format "<a href=\"#%s\">%s</a>" key key))
2122 (org-ref-split-and-strip-string keyword) ","))
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) ""))
2130 (concat "\\" ,type (when desc (org-ref-format-citation-description desc)) "{"
2131 (mapconcat (lambda (key) key) (org-ref-split-and-strip-string keyword) ",")
2133 ;; for markdown we generate pandoc citations
2136 (desc ;; pre and or post text
2137 (let* ((text (split-string desc "::"))
2141 (format "[@%s," keyword)
2142 (when pre (format " %s" pre))
2143 (when post (format ", %s" post))
2148 (lambda (key) (concat "@" key))
2149 (org-ref-split-and-strip-string keyword)
2155 We create the links by mapping the function onto the list of defined link types.
2157 #+BEGIN_SRC emacs-lisp :tangle org-ref.el
2159 (defun org-ref-format-citation-description (desc)
2160 "Return formatted citation description. If the cite link has a
2161 description, it is optional text for the citation command. You
2162 can specify pre and post text by separating these with ::, for
2163 example [[cite:key][pre text::post text]]."
2166 ((string-match "::" desc)
2167 (format "[%s][%s]" (car (setq results (split-string desc "::"))) (cadr results)))
2168 (t (format "[%s]" desc))))
2171 (defun org-ref-define-citation-link (type &optional key)
2172 "Add a citation link of TYPE for org-ref.
2173 With optional KEY, set the reftex binding. For example:
2174 (org-ref-define-citation-link \"citez\" ?z) will create a new citez link, with reftex key of z,
2175 and the completion function."
2176 (interactive "sCitation Type: \ncKey: ")
2178 ;; create the formatting function
2179 (eval `(org-ref-make-format-function ,type))
2184 org-ref-cite-onclick-function
2185 (quote ,(intern (format "org-ref-format-%s" type)))))
2187 ;; create the completion function
2188 (eval `(org-ref-make-completion-function ,type))
2190 ;; store new type so it works with adding citations, which checks
2191 ;; for existence in this list
2192 (add-to-list 'org-ref-cite-types type)
2194 ;; and finally if a key is specified, we modify the reftex menu
2196 (setf (nth 2 (assoc 'org reftex-cite-format-builtin))
2197 (append (nth 2 (assoc 'org reftex-cite-format-builtin))
2198 `((,key . ,(concat type ":%l")))))))
2200 ;; create all the link types and their completion functions
2201 (mapcar 'org-ref-define-citation-link org-ref-cite-types)
2206 *** org-ref-insert-cite-link
2207 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.
2209 #+BEGIN_SRC emacs-lisp :tangle org-ref.el
2211 (defun org-ref-insert-cite-link (alternative-cite)
2212 "Insert a default citation link using reftex. If you are on a link, it
2213 appends to the end of the link, otherwise, a new link is
2214 inserted. Use a prefix arg to get a menu of citation types."
2216 (org-ref-find-bibliography)
2217 (let* ((object (org-element-context))
2218 (link-string-beginning (org-element-property :begin object))
2219 (link-string-end (org-element-property :end object))
2220 (path (org-element-property :path object)))
2222 (if (not alternative-cite)
2225 ;; case where we are in a link
2226 ((and (equal (org-element-type object) 'link)
2227 (-contains? org-ref-cite-types (org-element-property :type object)))
2228 (goto-char link-string-end)
2229 ;; sometimes there are spaces at the end of the link
2230 ;; this code moves point pack until no spaces are there
2231 (while (looking-back " ") (backward-char))
2232 (insert (concat "," (mapconcat 'identity (reftex-citation t ?a) ","))))
2234 ;; We are next to a link, and we want to append
2237 (and (equal (org-element-type (org-element-context)) 'link)
2238 (-contains? org-ref-cite-types (org-element-property :type (org-element-context)))))
2239 (while (looking-back " ") (backward-char))
2240 (insert (concat "," (mapconcat 'identity (reftex-citation t ?a) ","))))
2242 ;; insert fresh link
2245 (concat org-ref-default-citation-link
2247 (mapconcat 'identity (reftex-citation t) ",")))))
2249 ;; you pressed a C-u so we run this code
2250 (reftex-citation))))
2252 cite:zhou-2004-first-lda-u,paier-2006-errat,boes-2015-estim-bulk
2256 : org-ref-insert-cite-link
2258 *** Completion in cite links
2259 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.
2261 #+BEGIN_SRC emacs-lisp :tangle no
2262 (defun org-cite-complete-link (&optional arg)
2263 "Completion function for cite links"
2265 org-ref-default-citation-link
2268 (let ((bibtex-files (org-ref-find-bibliography)))
2269 (bibtex-global-key-alist)))))
2272 Alternatively, you may shortcut the org-machinery with this command. You will be prompted for a citation type, and then offered key completion.
2274 #+BEGIN_SRC emacs-lisp :tangle org-ref.el
2276 (defun org-ref-insert-cite-with-completion (type)
2277 "Insert a cite link with completion"
2278 (interactive (list (ido-completing-read "Type: " org-ref-cite-types)))
2279 (insert (funcall (intern (format "org-%s-complete-link" type)))))
2282 ** Storing links to a bibtex entry
2283 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.
2285 #+BEGIN_SRC emacs-lisp :tangle org-ref.el
2287 (defun org-ref-store-bibtex-entry-link ()
2288 "Save a citation link to the current bibtex entry. Saves in the default link type."
2290 (let ((link (concat org-ref-default-citation-link
2293 (bibtex-beginning-of-entry)
2294 (reftex-get-bib-field "=key=" (bibtex-parse-entry))))))
2295 (message "saved %s" link)
2296 (push (list link) org-stored-links)
2297 (car org-stored-links)))
2301 org-ref minimally supports index entries. To make an index in a file, you should put in the LaTeX header these lines
2304 #+LATEX_HEADER: \usepackage{makeidx}
2305 #+LATEX_HEADER: \makeindex
2308 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.
2311 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.
2316 [[index:hello!Sam@\textsl{Sam}]]
2317 [[index:Lin@\textbf{Lin}]]
2318 [[index:Joe|textit]]
2319 [[index:Lin@\textbf{Lin}]]
2320 [[index:Peter|see {hello}]]
2321 [[index:Jen|seealso{Jenny}]]
2323 index:encodings!input!cp850
2325 #+BEGIN_SRC emacs-lisp :tangle org-ref.el
2331 (lambda (path desc format)
2334 (format "\\index{%s}" path)))))
2336 ;; this will generate a temporary index of entries in the file.
2340 (let ((*index-links* '())
2341 (*initial-letters* '()))
2344 (org-element-map (org-element-parse-buffer) 'link
2346 (let ((type (nth 0 link))
2347 (plist (nth 1 link)))
2349 (when (equal (plist-get plist ':type) "index")
2352 (cons (plist-get plist :path)
2354 "[[elisp:(progn (switch-to-buffer \"%s\") (goto-char %s))][%s]]"
2356 (plist-get plist :begin) ;; position of link
2357 ;; grab a description
2359 (goto-char (plist-get plist :begin))
2360 (if (thing-at-point 'sentence)
2362 (replace-regexp-in-string
2363 "\n" "" (thing-at-point 'sentence))
2364 ;; or call it a link
2368 (setq *index-links* (cl-sort *index-links* 'string-lessp :key 'car))
2370 ;; now first letters
2371 (dolist (link *index-links*)
2372 (add-to-list '*initial-letters* (substring (car link) 0 1) t))
2374 ;; now create the index
2375 (switch-to-buffer (get-buffer-create "*index*"))
2378 (insert "#+TITLE: Index\n\n")
2379 (dolist (letter *initial-letters*)
2380 (insert (format "* %s\n" (upcase letter)))
2381 ;; now process the links
2384 (string= letter (substring (car (car *index-links*)) 0 1)))
2385 (let ((link (pop *index-links*)))
2386 (insert (format "%s %s\n\n" (car link) (cdr link))))))
2387 (switch-to-buffer "*index*")))
2389 (lambda (path desc format)
2392 (format "\\printindex")))))
2396 | 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*)) |
2397 | lambda | (path desc format) | (cond ((eq format (quote latex)) (format \printindex))) |
2400 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.
2402 #+LATEX_HEADER: \usepackage{glossaries}
2403 #+LATEX_HEADER: \makeglossaries
2405 And at the end of the document put \makeglossaries.
2407 #+BEGIN_SRC emacs-lisp :tangle org-ref.el
2410 nil ;; no follow action
2411 (lambda (path desc format)
2414 (format "\\newglossaryentry{%s}{%s}" path desc)))))
2420 nil ;; no follow action
2421 (lambda (path desc format)
2424 (format "\\gls{%s}" path)))))
2429 nil ;; no follow action
2430 (lambda (path desc format)
2433 (format "\\glspl{%s}" path)))))
2438 nil ;; no follow action
2439 (lambda (path desc format)
2442 (format "\\Gls{%s}" path)))))
2447 nil ;; no follow action
2448 (lambda (path desc format)
2451 (format "\\Glspl{%s}" path)))))
2455 ** create simple text citation from bibtex entry
2457 #+BEGIN_SRC emacs-lisp :tangle org-ref.el
2458 (defun org-ref-bib-citation ()
2459 "From a bibtex entry, create and return a simple citation string.
2460 This assumes you are in an article."
2462 (bibtex-beginning-of-entry)
2463 (let* ((cb (current-buffer))
2464 (bibtex-expand-strings t)
2465 (entry (loop for (key . value) in (bibtex-parse-entry t)
2466 collect (cons (downcase key) value)))
2467 (title (replace-regexp-in-string "\n\\|\t\\|\s+" " " (reftex-get-bib-field "title" entry)))
2468 (year (reftex-get-bib-field "year" entry))
2469 (author (replace-regexp-in-string "\n\\|\t\\|\s+" " " (reftex-get-bib-field "author" entry)))
2470 (key (reftex-get-bib-field "=key=" entry))
2471 (journal (reftex-get-bib-field "journal" entry))
2472 (volume (reftex-get-bib-field "volume" entry))
2473 (pages (reftex-get-bib-field "pages" entry))
2474 (doi (reftex-get-bib-field "doi" entry))
2475 (url (reftex-get-bib-field "url" entry))
2477 ;;authors, "title", Journal, vol(iss):pages (year).
2478 (format "%s, \"%s\", %s, %s:%s (%s)"
2479 author title journal volume pages year)))
2483 : org-ref-bib-citation
2486 #+BEGIN_SRC emacs-lisp :tangle org-ref.el
2487 (defun org-ref-bib-html-citation ()
2488 "from a bibtex entry, create and return a simple citation with html links."
2490 (bibtex-beginning-of-entry)
2491 (let* ((cb (current-buffer))
2492 (bibtex-expand-strings t)
2493 (entry (loop for (key . value) in (bibtex-parse-entry t)
2494 collect (cons (downcase key) value)))
2495 (title (replace-regexp-in-string "\n\\|\t\\|\s+" " " (reftex-get-bib-field "title" entry)))
2496 (year (reftex-get-bib-field "year" entry))
2497 (author (replace-regexp-in-string "\n\\|\t\\|\s+" " " (reftex-get-bib-field "author" entry)))
2498 (key (reftex-get-bib-field "=key=" entry))
2499 (journal (reftex-get-bib-field "journal" entry))
2500 (volume (reftex-get-bib-field "volume" entry))
2501 (pages (reftex-get-bib-field "pages" entry))
2502 (doi (reftex-get-bib-field "doi" entry))
2503 (url (reftex-get-bib-field "url" entry))
2505 ;;authors, "title", Journal, vol(iss):pages (year).
2506 (concat (format "%s, \"%s\", %s, %s:%s (%s)."
2507 author title journal volume pages year)
2508 (when url (format " <a href=\"%s\">link</a>" url))
2509 (when doi (format " <a href=\"http://dx.doi.org/%s\">doi</a>" doi)))
2513 ** open pdf from bibtex
2514 We bind this to a key here: [[*key%20bindings%20for%20utilities][key bindings for utilities]].
2515 #+BEGIN_SRC emacs-lisp :tangle org-ref.el
2517 (defun org-ref-open-bibtex-pdf ()
2518 "open pdf for a bibtex entry, if it exists. assumes point is in
2519 the entry of interest in the bibfile. but does not check that."
2522 (bibtex-beginning-of-entry)
2523 (let* ((bibtex-expand-strings t)
2524 (entry (bibtex-parse-entry t))
2525 (key (reftex-get-bib-field "=key=" entry))
2526 (pdf (format (concat org-ref-pdf-directory "%s.pdf") key)))
2528 (if (file-exists-p pdf)
2529 (org-open-link-from-string (format "[[file:%s]]" pdf))
2533 ** open notes from bibtex
2534 We bind this to a key here [[*key%20bindings%20for%20utilities][key bindings for utilities]].
2536 #+BEGIN_SRC emacs-lisp :tangle org-ref.el
2537 (defun org-ref-open-bibtex-notes ()
2538 "from a bibtex entry, open the notes if they exist, and create a heading if they do not.
2540 I never did figure out how to use reftex to make this happen
2541 non-interactively. the reftex-format-citation function did not
2542 work perfectly; there were carriage returns in the strings, and
2543 it did not put the key where it needed to be. so, below I replace
2544 the carriage returns and extra spaces with a single space and
2545 construct the heading by hand."
2548 (bibtex-beginning-of-entry)
2549 (let* ((cb (current-buffer))
2550 (bibtex-expand-strings t)
2551 (entry (loop for (key . value) in (bibtex-parse-entry t)
2552 collect (cons (downcase key) value)))
2553 (title (replace-regexp-in-string "\n\\|\t\\|\s+" " " (reftex-get-bib-field "title" entry)))
2554 (year (reftex-get-bib-field "year" entry))
2555 (author (replace-regexp-in-string "\n\\|\t\\|\s+" " " (reftex-get-bib-field "author" entry)))
2556 (key (reftex-get-bib-field "=key=" entry))
2557 (journal (reftex-get-bib-field "journal" entry))
2558 (volume (reftex-get-bib-field "volume" entry))
2559 (pages (reftex-get-bib-field "pages" entry))
2560 (doi (reftex-get-bib-field "doi" entry))
2561 (url (reftex-get-bib-field "url" entry))
2564 ;; save key to clipboard to make saving pdf later easier by pasting.
2567 (kill-ring-save (point-min) (point-max)))
2569 ;; now look for entry in the notes file
2570 (if org-ref-bibliography-notes
2571 (find-file-other-window org-ref-bibliography-notes)
2572 (error "org-ref-bib-bibliography-notes is not set to anything"))
2574 (goto-char (point-min))
2575 ;; put new entry in notes if we don't find it.
2576 (if (re-search-forward (format ":Custom_ID: %s$" key) nil 'end)
2577 (funcall org-ref-open-notes-function)
2578 ;; no entry found, so add one
2579 (insert (format "\n** TODO %s - %s" year title))
2591 [[cite:%s]] [[file:%s/%s.pdf][pdf]]\n\n"
2592 key author journal year volume pages doi url key org-ref-pdf-directory key))
2596 #+BEGIN_SRC emacs-lisp :tangle org-ref.el
2597 (defun org-ref-open-notes-from-reftex ()
2598 "Call reftex, and open notes for selected entry."
2600 (let ((bibtex-key )))
2602 ;; now look for entry in the notes file
2603 (if org-ref-bibliography-notes
2604 (find-file-other-window org-ref-bibliography-notes)
2605 (error "org-ref-bib-bibliography-notes is not set to anything"))
2607 (goto-char (point-min))
2609 (re-search-forward (format
2611 (first (reftex-citation t)) nil 'end))
2612 (funcall org-ref-open-notes-function))
2615 ** open url in browser from bibtex
2617 We bind this to a key here [[*key%20bindings%20for%20utilities][key bindings for utilities]].
2619 + 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.
2621 #+BEGIN_SRC emacs-lisp :tangle org-ref.el
2622 (defun org-ref-open-in-browser ()
2623 "Open the bibtex entry at point in a browser using the url field or doi field"
2626 (bibtex-beginning-of-entry)
2628 (let ((url (bibtex-autokey-get-field "url")))
2633 (let ((doi (bibtex-autokey-get-field "doi")))
2635 (if (string-match "^http" doi)
2637 (browse-url (format "http://dx.doi.org/%s" doi)))
2639 (message "No url or doi found"))))
2643 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.
2645 *** function to upload bibtex to citeulike
2647 #+BEGIN_SRC emacs-lisp :tangle org-ref.el
2648 (defun org-ref-upload-bibtex-entry-to-citeulike ()
2649 "with point in a bibtex entry get bibtex string and submit to citeulike.
2651 Relies on the python script /upload_bibtex_citeulike.py being in the user directory."
2653 (message "uploading to citeulike")
2655 (bibtex-narrow-to-entry)
2656 (let ((startpos (point-min))
2657 (endpos (point-max))
2658 (bibtex-string (buffer-string))
2659 (script (concat "python " starter-kit-dir "/upload_bibtex_citeulike.py&")))
2660 (with-temp-buffer (insert bibtex-string)
2661 (shell-command-on-region (point-min) (point-max) script t nil nil t)))))
2664 *** The upload script
2665 Here is the python script for uploading.
2667 *************** TODO document how to get the cookies
2670 # :tangle upload_bibtex_citeulike.py
2673 import pickle, requests, sys
2676 with open('c:/Users/jkitchin/Dropbox/blogofile-jkitchin.github.com/_blog/cookies.pckl', 'rb') as f:
2677 cookies = pickle.load(f)
2679 url = 'http://www.citeulike.org/profile/jkitchin/import_do'
2681 bibtex = sys.stdin.read()
2683 data = {'pasted':bibtex,
2685 'tag_parsing':'simple',
2686 'strip_brackets':'no',
2687 'update_id':'bib-key',
2688 'btn_bibtex':'Import BibTeX file ...'}
2690 headers = {'content-type': 'multipart/form-data',
2691 'User-Agent':'jkitchin/johnrkitchin@gmail.com bibtexupload'}
2693 r = requests.post(url, headers=headers, data=data, cookies=cookies, files={})
2697 ** Build a pdf from a bibtex file
2698 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.
2700 #+BEGIN_SRC emacs-lisp :tangle org-ref.el
2701 (defun org-ref-build-full-bibliography ()
2702 "build pdf of all bibtex entries, and open it."
2704 (let* ((bibfile (file-name-nondirectory (buffer-file-name)))
2705 (bib-base (file-name-sans-extension bibfile))
2706 (texfile (concat bib-base ".tex"))
2707 (pdffile (concat bib-base ".pdf")))
2710 (insert (format "\\documentclass[12pt]{article}
2711 \\usepackage[version=3]{mhchem}
2713 \\usepackage[numbers]{natbib}
2714 \\usepackage[colorlinks=true, linkcolor=blue, urlcolor=blue, pdfstartview=FitH]{hyperref}
2718 \\bibliographystyle{unsrtnat}
2720 \\end{document}" bib-base))
2722 (shell-command (concat "pdflatex " bib-base))
2723 (shell-command (concat "bibtex " bib-base))
2724 (shell-command (concat "pdflatex " bib-base))
2725 (shell-command (concat "pdflatex " bib-base))
2726 (kill-buffer texfile)
2727 (org-open-file pdffile)
2731 ** Extract bibtex entries cited in an org-file
2732 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.
2734 #+BEGIN_SRC emacs-lisp :tangle org-ref.el
2735 (defun org-ref-extract-bibtex-entries ()
2736 "extract the bibtex entries referred to by cite links in the current buffer into a src block at the bottom of the current buffer.
2738 If no bibliography is in the buffer the `reftex-default-bibliography' is used."
2740 (let* ((temporary-file-directory (file-name-directory (buffer-file-name)))
2741 (tempname (make-temp-file "extract-bib"))
2742 (contents (buffer-string))
2743 (cb (current-buffer))
2744 basename texfile bibfile results)
2746 ;; open tempfile and insert org-buffer contents
2747 (find-file tempname)
2749 (setq basename (file-name-sans-extension
2750 (file-name-nondirectory buffer-file-name))
2751 texfile (concat tempname ".tex")
2752 bibfile (concat tempname ".bib"))
2754 ;; see if we have a bibliography, and insert the default one if not.
2756 (goto-char (point-min))
2757 (unless (re-search-forward "^bibliography:" (point-max) 'end)
2758 (insert (format "\nbibliography:%s"
2759 (mapconcat 'identity reftex-default-bibliography ",")))))
2762 ;; get a latex file and extract the references
2763 (org-latex-export-to-latex)
2766 (reftex-create-bibtex-file bibfile)
2768 ;; save results of the references
2769 (setq results (buffer-string))
2771 ;; kill buffers. these are named by basename, not full path
2772 (kill-buffer (concat basename ".bib"))
2773 (kill-buffer (concat basename ".tex"))
2774 (kill-buffer basename)
2776 (delete-file bibfile)
2777 (delete-file texfile)
2778 (delete-file tempname)
2780 ;; Now back to the original org buffer and insert the results
2781 (switch-to-buffer cb)
2782 (when (not (string= "" results))
2784 (goto-char (point-max))
2786 (org-insert-heading)
2787 (insert (format " Bibtex entries
2789 ,#+BEGIN_SRC text :tangle %s
2791 ,#+END_SRC" (concat (file-name-sans-extension (file-name-nondirectory (buffer-file-name))) ".bib") results))))))
2794 ** Find bad cite links
2796 :ID: 8515E800-EDA0-4B2A-85FD-55B6FF849203
2798 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.
2800 #+BEGIN_SRC emacs-lisp :tangle org-ref.el
2803 (defun index (substring list)
2804 "return the index of string in a list of strings"
2807 (dolist (arg list i)
2808 (if (string-match (concat "^" substring "$") arg)
2813 ;; return counter if found, otherwise return nil
2817 (defun org-ref-find-bad-citations ()
2818 "Create a list of citation keys in an org-file that do not have a bibtex entry in the known bibtex files.
2820 Makes a new buffer with clickable links."
2822 ;; generate the list of bibtex-keys and cited keys
2823 (let* ((bibtex-files (org-ref-find-bibliography))
2824 (bibtex-file-path (mapconcat (lambda (x) (file-name-directory (file-truename x))) bibtex-files ":"))
2825 (bibtex-keys (mapcar (lambda (x) (car x)) (bibtex-global-key-alist)))
2826 (bad-citations '()))
2828 (org-element-map (org-element-parse-buffer) 'link
2830 (let ((plist (nth 1 link)))
2831 (when (-contains? org-ref-cite-types (plist-get plist :type))
2832 (dolist (key (org-ref-split-and-strip-string (plist-get plist :path)))
2833 (when (not (index key bibtex-keys))
2834 (message-box "%s" link)
2839 `(,(format "%s [[elisp:(progn (switch-to-buffer-other-frame \"%s\")(goto-char %s))][not found here]]\n"
2842 (plist-get plist :begin)))))
2844 ;; set with-affilates to t to get citations in a caption
2849 (switch-to-buffer-other-window "*Missing citations*")
2852 (insert "* List of bad cite links\n")
2853 (insert (mapconcat 'identity bad-citations ""))
2854 ;(setq buffer-read-only t)
2855 (use-local-map (copy-keymap org-mode-map))
2856 (local-set-key "q" #'(lambda () (interactive) (kill-buffer))))
2858 (when (get-buffer "*Missing citations*")
2859 (kill-buffer "*Missing citations*"))
2860 (message "No bad cite links found"))))
2863 ** helm interface to org-ref
2864 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.
2866 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.
2868 #+BEGIN_SRC emacs-lisp :tangle org-ref.el
2869 (defun org-ref-bad-cite-candidates ()
2870 "Returns a list of conses (key . marker) where key does not exist in the known bibliography files, and marker points to the key."
2871 (let* ((cp (point)) ; save to return to later
2872 (bibtex-files (org-ref-find-bibliography))
2873 (bibtex-file-path (mapconcat
2875 (file-name-directory (file-truename x)))
2877 (bibtex-keys (mapcar (lambda (x) (car x))
2878 (bibtex-global-key-alist)))
2879 (bad-citations '()))
2881 (org-element-map (org-element-parse-buffer) 'link
2883 (let ((plist (nth 1 link)))
2884 (when (-contains? org-ref-cite-types (plist-get plist :type))
2885 (dolist (key (org-ref-split-and-strip-string (plist-get plist :path)) )
2886 (when (not (index key bibtex-keys))
2887 (goto-char (plist-get plist :begin))
2888 (re-search-forward key)
2889 (push (cons key (point-marker)) bad-citations)))
2891 ;; add with-affiliates to get cites in caption
2897 (defun org-ref-bad-ref-candidates ()
2898 "Returns a list of conses (ref . marker) where ref is a ref link that does not point to anything (i.e. a label)."
2899 ;; first get a list of legitimate labels
2901 (labels (org-ref-get-labels))
2903 ;; now loop over ref links
2904 (goto-char (point-min))
2905 (org-element-map (org-element-parse-buffer) 'link
2907 (let ((plist (nth 1 link)))
2908 (when (or (equal (plist-get plist ':type) "ref")
2909 (equal (plist-get plist ':type) "eqref")
2910 (equal (plist-get plist ':type) "pageref")
2911 (equal (plist-get plist ':type) "nameref"))
2912 (unless (-contains? labels (plist-get plist :path))
2913 (goto-char (plist-get plist :begin))
2916 (cons (plist-get plist :path)
2917 (point-marker))))))))
2922 (defun org-ref-bad-label-candidates ()
2923 "Return a list of labels where label is multiply defined."
2924 (let ((labels (org-ref-get-labels))
2925 (multiple-labels '()))
2926 (when (not (= (length labels)
2927 (length (-uniq labels))))
2928 (dolist (label labels)
2929 (when (> (-count (lambda (a)
2932 ;; this is a multiply defined label.
2934 (goto-char (point-min))
2935 (while (re-search-forward
2936 (format "[^#+]label:%s\\s-" label) nil t)
2937 (push (cons label (point-marker)) multiple-labels))
2939 (goto-char (point-min))
2940 (while (re-search-forward
2941 (format "\\label{%s}\\s-?" label) nil t)
2942 (push (cons label (point-marker)) multiple-labels))
2944 (goto-char (point-min))
2945 (while (re-search-forward
2946 (format "^#\\+label:\\s-*%s" label) nil t)
2947 (push (cons label (point-marker)) multiple-labels))
2949 (goto-char (point-min))
2950 (while (re-search-forward
2951 (format "^#\\+tblname:\\s-*%s" label) nil t)
2952 (push (cons label (point-marker)) multiple-labels))
2958 : org-ref-bad-label-candidates
2960 Now, we have a functions for candidates, we can make helm sources for each one, and then run a helm command to view them.
2962 #+BEGIN_SRC emacs-lisp :tangle org-ref.el
2965 "Opens a helm interface to actions for org-ref.
2966 Shows bad citations, ref links and labels"
2968 (let ((cb (current-buffer))
2969 (bad-citations (org-ref-bad-cite-candidates))
2970 (bad-refs (org-ref-bad-ref-candidates))
2971 (bad-labels (org-ref-bad-label-candidates)))
2973 (helm :sources `(((name . "Bad citations")
2974 (candidates . ,bad-citations)
2975 (action . (lambda (marker)
2976 (switch-to-buffer (marker-buffer marker))
2977 (goto-char marker))))
2979 ((name . "Bad Labels")
2980 (candidates . ,bad-labels)
2981 (action . (lambda (marker)
2982 (switch-to-buffer (marker-buffer marker))
2983 (goto-char marker))))
2985 ((name . "Bad ref links")
2986 (candidates . ,bad-refs)
2987 (action . (lambda (marker)
2988 (switch-to-buffer (marker-buffer marker))
2989 (goto-char marker))))
2991 ((name . "Utilities")
2992 (candidates . (("Check buffer again" . org-ref)
2993 ("Insert citation" . helm-bibtex)
2994 ("Insert label link" . org-ref-helm-insert-label-link)
2995 ("Insert ref link" . org-ref-helm-insert-ref-link)
2996 ("List of figures" . org-ref-list-of-figures)
2997 ("List of tables" . org-ref-list-of-tables)
2998 ("Table of contents" . nil)
3000 (action . (lambda (x)
3001 (switch-to-buffer ,cb)
3004 ((name . "Export functions")
3005 (candidates . (("Extract cited entries" . org-ref-extract-bibtex-entries)
3006 ("Export to html and open" . (lambda () (org-open-file (org-html-export-to-html))))
3007 ("Export to pdf and open" . (lambda ()
3008 (org-open-file (org-latex-export-to-pdf))))
3009 ("Export to manuscript pdf and open" . ox-manuscript-export-and-build-and-open)
3010 ("Export submission manuscript pdf and open" . ox-manuscript-build-submission-manuscript-and-open)
3013 (action . (lambda (x)
3014 (switch-to-buffer ,cb)
3020 ** Finding non-ascii characters
3021 I like my bibtex files to be 100% ascii. This function finds the non-ascii characters so you can replace them.
3023 #+BEGIN_SRC emacs-lisp :tangle org-ref.el
3024 (defun org-ref-find-non-ascii-characters ()
3025 "finds non-ascii characters in the buffer. Useful for cleaning up bibtex files"
3027 (occur "[^[:ascii:]]"))
3030 ** Resort a bibtex entry
3031 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.
3033 #+BEGIN_SRC emacs-lisp :tangle org-ref.el
3034 (defun org-ref-sort-bibtex-entry ()
3035 "sort fields of entry in standard order and downcase them"
3037 (bibtex-beginning-of-entry)
3038 (let* ((master '("author" "title" "journal" "volume" "number" "pages" "year" "doi" "url"))
3039 (entry (bibtex-parse-entry))
3042 (type (cdr (assoc "=type=" entry)))
3043 (key (cdr (assoc "=key=" entry))))
3045 ;; these are the fields we want to order that are in this entry
3046 (setq entry-fields (mapcar (lambda (x) (car x)) entry))
3047 ;; we do not want to reenter these fields
3048 (setq entry-fields (remove "=key=" entry-fields))
3049 (setq entry-fields (remove "=type=" entry-fields))
3051 ;;these are the other fields in the entry
3052 (setq other-fields (remove-if-not (lambda(x) (not (member x master))) entry-fields))
3055 ;; right now we only resort articles
3056 ((string= (downcase type) "article")
3059 (concat "@article{" key ",\n"
3062 (when (member field entry-fields)
3063 (format "%s = %s," (downcase field) (cdr (assoc field entry))))) master "\n")
3066 (format "%s = %s," (downcase field) (cdr (assoc field entry)))) other-fields "\n")
3068 (bibtex-find-entry key)
3070 (bibtex-clean-entry)
3074 ** Clean a bibtex entry
3075 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.
3076 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.
3077 #+BEGIN_SRC emacs-lisp :tangle org-ref.el
3078 (defun org-ref-clean-bibtex-entry(&optional keep-key)
3079 "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"
3081 (bibtex-beginning-of-entry)
3083 ;; some entries do not have a key or comma in first line. We check and add it, if needed.
3084 (unless (string-match ",$" (thing-at-point 'line))
3088 ;; check for empty pages, and put eid or article id in its place
3089 (let ((entry (bibtex-parse-entry))
3090 (pages (bibtex-autokey-get-field "pages"))
3091 (year (bibtex-autokey-get-field "year"))
3092 (doi (bibtex-autokey-get-field "doi"))
3093 ;; The Journal of Chemical Physics uses eid
3094 (eid (bibtex-autokey-get-field "eid")))
3096 ;; replace http://dx.doi.org/ in doi. some journals put that in,
3097 ;; but we only want the doi.
3098 (when (string-match "^http://dx.doi.org/" doi)
3099 (bibtex-beginning-of-entry)
3100 (goto-char (car (cdr (bibtex-search-forward-field "doi" t))))
3102 (bibtex-make-field "doi")
3104 (insert (replace-regexp-in-string "^http://dx.doi.org/" "" doi)))
3106 ;; asap articles often set year to 0, which messes up key
3107 ;; generation. fix that.
3108 (when (string= "0" year)
3109 (bibtex-beginning-of-entry)
3110 (goto-char (car (cdr (bibtex-search-forward-field "year" t))))
3112 (bibtex-make-field "year")
3114 (insert (read-string "Enter year: ")))
3116 ;; fix pages if they are empty if there is an eid to put there.
3117 (when (string= "-" pages)
3119 (bibtex-beginning-of-entry)
3120 ;; this seems like a clunky way to set the pages field.But I
3121 ;; cannot find a better way.
3122 (goto-char (car (cdr (bibtex-search-forward-field "pages" t))))
3124 (bibtex-make-field "pages")
3128 ;; replace naked & with \&
3130 (bibtex-narrow-to-entry)
3131 (bibtex-beginning-of-entry)
3132 (message "checking &")
3133 (replace-regexp " & " " \\\\& ")
3136 ;; generate a key, and if it duplicates an existing key, edit it.
3138 (let ((key (bibtex-generate-autokey)))
3140 ;; first we delete the existing key
3141 (bibtex-beginning-of-entry)
3142 (re-search-forward bibtex-entry-maybe-empty-head)
3143 (if (match-beginning bibtex-key-in-head)
3144 (delete-region (match-beginning bibtex-key-in-head)
3145 (match-end bibtex-key-in-head)))
3146 ;; check if the key is in the buffer
3147 (when (save-excursion
3148 (bibtex-search-entry key))
3150 (bibtex-search-entry key)
3151 (bibtex-copy-entry-as-kill)
3152 (switch-to-buffer-other-window "*duplicate entry*")
3154 (setq key (bibtex-read-key "Duplicate Key found, edit: " key)))
3157 (kill-new key))) ;; save key for pasting
3159 ;; run hooks. each of these operates on the entry with no arguments.
3160 ;; this did not work like i thought, it gives a symbolp error.
3161 ;; (run-hooks org-ref-clean-bibtex-entry-hook)
3166 org-ref-clean-bibtex-entry-hook)
3168 ;; sort fields within entry
3169 (org-ref-sort-bibtex-entry)
3170 ;; check for non-ascii characters
3171 (occur "[^[:ascii:]]")
3176 : org-ref-clean-bibtex-entry
3178 ** Sort the entries in a citation link by year
3179 I prefer citations in chronological order within a grouping. These functions sort the link under the cursor by year.
3181 #+BEGIN_SRC emacs-lisp :tangle org-ref.el
3182 (defun org-ref-get-citation-year (key)
3183 "get the year of an entry with key. Returns year as a string."
3184 (let* ((results (org-ref-get-bibtex-key-and-file key))
3185 (bibfile (cdr results)))
3187 (insert-file-contents bibfile)
3188 (bibtex-search-entry key nil 0)
3189 (prog1 (reftex-get-bib-field "year" (bibtex-parse-entry t))
3192 (defun org-ref-sort-citation-link ()
3193 "Replace link at point with sorted link by year."
3195 (let* ((object (org-element-context))
3196 (type (org-element-property :type object))
3197 (begin (org-element-property :begin object))
3198 (end (org-element-property :end object))
3199 (link-string (org-element-property :path object))
3201 (setq keys (org-ref-split-and-strip-string link-string))
3202 (setq years (mapcar 'org-ref-get-citation-year keys))
3203 (setq data (mapcar* (lambda (a b) `(,a . ,b)) years keys))
3204 (setq data (cl-sort data (lambda (x y) (< (string-to-int (car x)) (string-to-int (car y))))))
3205 ;; now get the keys separated by commas
3206 (setq keys (mapconcat (lambda (x) (cdr x)) data ","))
3207 ;; and replace the link with the sorted keys
3208 (cl--set-buffer-substring begin end (concat type ":" keys))))
3211 ** Sort entries in citation links with shift-arrow keys
3212 Sometimes it may be helpful to manually change the order of citations. These functions define shift-arrow functions.
3213 #+BEGIN_SRC emacs-lisp :tangle org-ref.el
3214 (defun org-ref-swap-keys (i j keys)
3215 "Swap the KEYS in a list with index I and J."
3216 (let ((tempi (nth i keys)))
3217 (setf (nth i keys) (nth j keys))
3218 (setf (nth j keys) tempi))
3222 (defun org-ref-swap-citation-link (direction)
3223 "move citation at point in direction +1 is to the right, -1 to the left"
3225 (let* ((object (org-element-context))
3226 (type (org-element-property :type object))
3227 (begin (org-element-property :begin object))
3228 (end (org-element-property :end object))
3229 (link-string (org-element-property :path object))
3231 ;; We only want this to work on citation links
3232 (when (-contains? org-ref-cite-types type)
3233 (setq key (org-ref-get-bibtex-key-under-cursor))
3234 (setq keys (org-ref-split-and-strip-string link-string))
3235 (setq i (index key keys)) ;; defined in org-ref
3236 (if (> direction 0) ;; shift right
3237 (org-ref-swap-keys i (+ i 1) keys)
3238 (org-ref-swap-keys i (- i 1) keys))
3239 (setq keys (mapconcat 'identity keys ","))
3240 ;; and replace the link with the sorted keys
3241 (cl--set-buffer-substring begin end (concat type ":" keys " "))
3242 ;; now go forward to key so we can move with the key
3243 (re-search-forward key)
3244 (goto-char (match-beginning 0)))))
3246 ;; add hooks to make it work
3247 (add-hook 'org-shiftright-hook (lambda () (org-ref-swap-citation-link 1)))
3248 (add-hook 'org-shiftleft-hook (lambda () (org-ref-swap-citation-link -1)))
3251 ** Lightweight messages about links
3252 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.
3254 #+BEGIN_SRC emacs-lisp :tangle org-ref.el
3255 (defun org-ref-get-label-context (label)
3256 "Return a string of context around a label."
3259 (goto-char (point-min))
3260 (when (re-search-forward
3261 (format "label:%s\\b" label) nil t)
3262 (throw 'result (buffer-substring
3271 (goto-char (point-min))
3272 (when (re-search-forward
3273 (format "\\label{%s}" label) nil t)
3274 (throw 'result (buffer-substring
3283 (goto-char (point-min))
3284 (when (re-search-forward
3285 (format "^#\\+label:\\s-*\\(%s\\)\\b" label) nil t)
3286 (throw 'result (buffer-substring
3295 (goto-char (point-min))
3296 (when (re-search-forward
3297 (format "^#\\+tblname:\\s-*\\(%s\\)\\b" label) nil t)
3298 (throw 'result (buffer-substring
3306 (throw 'result "!!! NO CONTEXT FOUND !!!"))))
3309 (defun org-ref-link-message ()
3310 "Print a minibuffer message about the link that point is on."
3312 (when (eq major-mode 'org-mode)
3313 (let* ((object (org-element-context))
3314 (type (org-element-property :type object)))
3318 ((-contains? org-ref-cite-types type)
3319 (message (org-ref-get-citation-string-at-point)))
3321 ;; message some context about the label we are referring to
3322 ((string= type "ref")
3323 (message "%scount: %s"
3324 (org-ref-get-label-context
3325 (org-element-property :path object))
3326 (org-ref-count-labels
3327 (org-element-property :path object))))
3329 ((string= type "eqref")
3330 (message "%scount: %s"
3331 (org-ref-get-label-context
3332 (org-element-property :path object))
3333 (org-ref-count-labels
3334 (org-element-property :path object))))
3336 ;; message the count
3337 ((string= type "label")
3338 (let ((count (org-ref-count-labels
3339 (org-element-property :path object))))
3340 ;; get plurality on occurrence correct
3342 (number-to-string count)
3344 (when (or (= count 0)
3348 ((string= type "custom-id")
3350 (org-open-link-from-string
3351 (format "[[#%s]]" (org-element-property :path object)))
3352 (message "%s" (org-get-heading))))
3354 ;; check if the bibliography files exist.
3355 ((string= type "bibliography")
3357 ;; object is the link you clicked on
3358 (object (org-element-context))
3359 (link-string (org-element-property :path object))
3360 (link-string-beginning)
3363 (goto-char (org-element-property :begin object))
3364 (search-forward link-string nil nil 1)
3365 (setq link-string-beginning (match-beginning 0))
3366 (setq link-string-end (match-end 0)))
3368 ;; make sure we are in link and not before the :
3369 (when (> link-string-beginning (point))
3370 (goto-char link-string-beginning))
3372 ;; now if we have comma separated bibliographies
3373 ;; we find the one clicked on. we want to
3374 ;; search forward to next comma from point
3376 (if (search-forward "," link-string-end 1 1)
3377 (setq key-end (- (match-end 0) 1)) ; we found a match
3378 (setq key-end (point)))) ; no comma found so take the point
3380 ;; and backward to previous comma from point
3382 (if (search-backward "," link-string-beginning 1 1)
3383 (setq key-beginning (+ (match-beginning 0) 1)) ; we found a match
3384 (setq key-beginning (point)))) ; no match found
3385 ;; save the key we clicked on.
3387 (org-ref-strip-string
3388 (buffer-substring key-beginning key-end)))
3389 (if (file-exists-p bibfile)
3390 (message "%s exists." bibfile)
3391 (message "!!! %s NOT FOUND !!!" bibfile))))
3396 I like convenience. Here are some aliases for faster typing.
3398 #+BEGIN_SRC emacs-lisp :tangle org-ref.el
3399 (defalias 'oro 'org-ref-open-citation-at-point)
3400 (defalias 'orc 'org-ref-citation-at-point)
3401 (defalias 'orp 'org-ref-open-pdf-at-point)
3402 (defalias 'oru 'org-ref-open-url-at-point)
3403 (defalias 'orn 'org-ref-open-notes-at-point)
3404 (defalias 'ornr 'org-ref-open-notes-from-reftex)
3406 (defalias 'orib 'org-ref-insert-bibliography-link)
3407 (defalias 'oric 'org-ref-insert-cite-link)
3408 (defalias 'orir 'org-ref-insert-ref-link)
3409 (defalias 'orsl 'org-ref-store-bibtex-entry-link)
3411 (defalias 'orcb 'org-ref-clean-bibtex-entry)
3414 [[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.
3416 Let us add keywords as a searchable field.
3417 #+BEGIN_SRC emacs-lisp
3418 (setq helm-bibtex-additional-search-fields '(keywords))
3421 Next, we are going to add keywords to the helm interface. This modifies the helm-bibtex function to add our keywords.
3422 #+BEGIN_SRC emacs-lisp
3423 (defun helm-bibtex-candidates-formatter (candidates source)
3424 "Formats BibTeX entries for display in results list."
3426 with width = (with-helm-window (window-width))
3427 for entry in candidates
3428 for entry = (cdr entry)
3429 for entry-key = (helm-bibtex-get-value entry 'entry-key)
3430 for fields = (--map (helm-bibtex-clean-string
3431 (helm-bibtex-get-value entry it " "))
3432 '(author title year has-pdf has-note entry-type))
3433 for fields = (-update-at 0 'helm-bibtex-shorten-authors fields)
3434 for fields = (append fields
3435 (list (or (helm-bibtex-get-value entry 'keywords)
3438 (cons (s-format "$0 $1 $2 $3 $4$5 $6" 'elt
3439 (-zip-with (lambda (f w) (truncate-string-to-width f w 0 ?\s))
3440 fields (list 36 (- width 85) 4 1 1 7 7)))
3445 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.
3446 #+BEGIN_SRC emacs-lisp
3447 ;; adapted from bibtex-utils.el
3448 ;; these are candidates for selecting keywords/tags
3449 (defun org-ref-bibtex-keywords ()
3450 "Get keywords defined in current bibtex file.
3451 These are in the keywords field, and are comma or semicolon separated."
3453 (goto-char (point-min))
3454 (let (keywords kstring)
3455 (while (re-search-forward "^\\s-*keywords.*{\\([^}]+\\)}" nil t)
3456 ;; TWS - remove newlines/multiple spaces:
3457 (setq kstring (replace-regexp-in-string "[ \t\n]+" " " (match-string 1)))
3460 (add-to-list 'keywords v t))
3461 (split-string kstring "\\(,\\|;\\)[ \n]*\\|{\\|}" t)))
3465 (defun org-ref-set-bibtex-keywords (keywords &optional arg)
3466 "Add KEYWORDS to a bibtex entry.
3467 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."
3468 (interactive "sKeywords: \nP")
3473 (if (listp keywords)
3474 (mapconcat 'identity keywords ", ")
3476 ;; else concatentate
3478 (if (listp keywords)
3479 (mapconcat 'identity keywords ", ")
3481 (when (not (string= "" (bibtex-autokey-get-field "keywords")))
3482 (concat ", " (bibtex-autokey-get-field "keywords"))))))
3486 (defun helm-tag-bibtex-entry ()
3487 "Helm interface to add keywords to a bibtex entry.
3488 Run this with the point in a bibtex entry."
3490 (let ((keyword-source `((name . "Existing keywords")
3491 (candidates . ,(org-ref-bibtex-keywords))
3492 (action . (lambda (candidate)
3493 (org-ref-set-bibtex-keywords
3496 (helm-marked-candidates)
3498 (fallback-source `((name . "Add new keywords")
3500 (action . (lambda (candidate)
3501 (org-ref-set-bibtex-keywords helm-pattern)
3503 (helm :sources '(keyword-source fallback-source))))
3506 (defun org-ref-helm-tag-entries (candidates)
3507 "Set tags on selected bibtex entries from helm-bibtex.
3508 User is prompted for tags. This function is called from `helm-bibtex'."
3509 (let ((keywords (read-input "Keywords (comma separated): ")))
3510 (loop for key in (helm-marked-candidates)
3512 (save-window-excursion
3513 (helm-bibtex-show-entry key)
3518 ", " (bibtex-autokey-get-field "keywords")))
3522 Next, adapt the helm-bibtex source with these features:
3524 1. Make the default action to insert selected keys.
3525 2. Make open entry second action
3526 3. Add some features for adding keywords to bibtex entries.
3528 #+BEGIN_SRC emacs-lisp :tangle org-ref.el
3529 (setq helm-source-bibtex
3530 '((name . "BibTeX entries")
3531 (init . helm-bibtex-init)
3532 (candidates . helm-bibtex-candidates)
3533 (filtered-candidate-transformer . helm-bibtex-candidates-formatter)
3534 (action . (("Insert citation" . helm-bibtex-insert-citation)
3535 ("Show entry" . helm-bibtex-show-entry)
3536 ("Open PDF file (if present)" . helm-bibtex-open-pdf)
3537 ("Open URL or DOI in browser" . helm-bibtex-open-url-or-doi)
3538 ("Insert formatted reference" . helm-bibtex-insert-reference)
3539 ("Insert BibTeX key" . helm-bibtex-insert-key)
3540 ("Insert BibTeX entry" . helm-bibtex-insert-bibtex)
3541 ("Attach PDF to email" . helm-bibtex-add-PDF-attachment)
3542 ("Edit notes" . helm-bibtex-edit-notes)
3543 ("Add keywords to entries" . org-ref-helm-tag-entries)
3547 Now, let us define a function that inserts the cite links:
3548 #+BEGIN_SRC emacs-lisp :tangle org-ref.el
3549 (defun helm-bibtex-format-org-ref (keys)
3550 "Insert selected KEYS as cite link. Append KEYS if you are on a link.
3551 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.
3553 In the helm-bibtex buffer, C-u will give you a helm menu to select a new link type for the selected entries.
3555 C-u C-u will change the key at point to the selected keys.
3557 (let* ((object (org-element-context))
3558 (last-char (save-excursion
3559 (goto-char (org-element-property :end object))
3561 (if (looking-at " ")
3565 ;; case where we are in a link
3566 ((and (equal (org-element-type object) 'link)
3569 (org-element-property :type object)))
3571 ;; no prefix. append keys
3572 ((equal helm-current-prefix-arg nil)
3573 (goto-char (org-element-property :end object))
3574 (while (looking-back " ") (backward-char))
3575 (insert (concat "," (mapconcat 'identity keys ","))))
3576 ;; double prefix, replace key at point
3577 ((equal helm-current-prefix-arg '(16))
3578 (setf (buffer-substring
3579 (org-element-property :begin object)
3580 (org-element-property :end object))
3582 (replace-regexp-in-string
3583 (car (org-ref-get-bibtex-key-and-file)) ; key
3584 (mapconcat 'identity keys ",") ; new keys
3585 (org-element-property :raw-link object))
3586 ;; replace space at end to avoid collapsing into next word.
3588 ;; and we want to go to the end of the new link
3590 (org-element-property :end (org-element-context))))
3592 (message "Not found"))))
3594 ;; We are next to a link, and we want to append
3595 ;; next to a link means one character back is on a link.
3598 (and (equal (org-element-type (org-element-context)) 'link)
3601 (org-element-property :type (org-element-context)))))
3602 (while (looking-back " ") (backward-char))
3603 (insert (concat "," (mapconcat 'identity keys ","))))
3605 ;; insert fresh link
3607 ;;(message-box "fresh link")
3609 (concat (if (equal helm-current-prefix-arg '(4))
3610 (helm :sources `((name . "link types")
3611 (candidates . ,org-ref-cite-types)
3612 (action . (lambda (x) x))))
3613 org-ref-default-citation-link)
3615 (s-join "," keys))))))
3616 ;; return empty string for helm
3619 (setq helm-bibtex-format-citation-functions
3620 '((org-mode . helm-bibtex-format-org-ref)))
3623 (defun org-ref-helm-insert-cite-link (arg)
3624 "org-ref function to use helm-bibtex to insert a citation link.
3625 With one prefix arg, insert a ref link.
3626 With two prefix args, insert a label link."
3630 (let ((helm-bibtex-bibliography (org-ref-find-bibliography)))
3633 (org-ref-helm-insert-ref-link))
3635 (org-ref-helm-insert-label-link))))
3637 (require 'helm-bibtex)
3639 ;; add our own fallback entries where we want them. These appear in reverse order of adding in the menu
3640 (setq helm-bibtex-fallback-options
3641 (-insert-at 1 '("Crossref" . "http://search.crossref.org/?q=%s") helm-bibtex-fallback-options))
3643 (setq helm-bibtex-fallback-options
3646 '("Scopus" . "http://www.scopus.com/scopus/search/submit/xadvanced.url?searchfield=TITLE-ABS-KEY(%s)")
3647 helm-bibtex-fallback-options))
3649 (setq helm-bibtex-fallback-options
3650 (-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))
3653 ** A helm click menu
3654 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.
3655 #+BEGIN_SRC emacs-lisp :tangle org-ref.el
3656 (defun org-ref-get-citation-string-at-point ()
3657 "Get a string of a formatted citation"
3658 (let* ((results (org-ref-get-bibtex-key-and-file))
3660 (bibfile (cdr results)))
3664 (insert-file-contents bibfile)
3665 (bibtex-search-entry key)
3666 (org-ref-bib-citation)))
3667 "!!! No entry found !!!" )))
3670 (defun org-ref-cite-candidates ()
3671 "Generate the list of possible candidates for click actions on a cite link.
3672 Checks for pdf and doi, and add appropriate functions."
3673 (let* ((results (org-ref-get-bibtex-key-and-file))
3675 (pdf-file (format (concat org-ref-pdf-directory "%s.pdf") key))
3676 (bibfile (cdr results))
3677 (url (save-excursion
3679 (insert-file-contents bibfile)
3680 (bibtex-search-entry key)
3681 (bibtex-autokey-get-field "url"))))
3682 (doi (save-excursion
3684 (insert-file-contents bibfile)
3685 (bibtex-search-entry key)
3686 ;; I like this better than bibtex-url which does not always find
3688 (bibtex-autokey-get-field "doi"))))
3689 (candidates `(("Quit" . org-ref-citation-at-point)
3690 ("Open bibtex entry" . org-ref-open-citation-at-point))))
3691 ;; for some reason, when there is no doi or url, they are returned as "". I
3692 ;; prefer nil so we correct this here.
3693 (when (string= doi "") (setq doi nil))
3694 (when (string= url "") (setq url nil))
3696 ;; Conditional pdf functions
3697 (if (file-exists-p pdf-file)
3700 '("Open pdf" . org-ref-open-pdf-at-point)
3704 '("Try to get pdf" . (lambda ()
3705 (save-window-excursion
3706 (org-ref-open-citation-at-point)
3707 (bibtex-beginning-of-entry)
3708 (doi-utils-get-bibtex-entry-pdf))))
3714 '("Open notes" . org-ref-open-notes-at-point)
3717 ;; conditional url and doi functions
3721 '("Open in browser" . org-ref-open-url-at-point)
3726 (add-to-list 'candidates x t))
3727 `(("WOS" . org-ref-wos-at-point)
3728 ("Related articles in WOS" . org-ref-wos-related-at-point)
3729 ("Citing articles in WOS" . org-ref-wos-citing-at-point)
3730 ("Google Scholar" . org-ref-google-scholar-at-point)
3731 ("Pubmed" . org-ref-pubmed-at-point)
3732 ("Crossref" . org-ref-crossref-at-point)
3737 '("Copy formatted citation to clipboard" . org-ref-copy-entry-as-summary)
3742 '("Copy key to clipboard" . (lambda ()
3744 (car (org-ref-get-bibtex-key-and-file)))))
3749 '("Copy bibtex entry to file" . org-ref-copy-entry-at-point-to-file)
3754 '("Email bibtex entry and pdf" . (lambda ()
3756 (org-ref-open-citation-at-point)
3757 (email-bibtex-entry))))
3759 ;; finally return a numbered list of the candidates
3761 for cell in candidates
3762 collect (cons (format "%2s. %s" i (car cell))
3766 (defvar org-ref-helm-user-candidates '()
3767 "List of user-defined candidates to act when clicking on a cite link.
3768 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.
3771 ;; example of adding your own function
3773 'org-ref-helm-user-candidates
3774 '("Example" . (lambda () (message-box "You did it!")))
3777 (defun org-ref-cite-click-helm (key)
3779 1. get name and candidates before entering helm because we need the org-buffer.
3780 2. switch back to the org buffer before evaluating the action. most of them need the point and buffer."
3782 (let ((name (org-ref-get-citation-string-at-point))
3783 (candidates (org-ref-cite-candidates))
3784 (cb (current-buffer)))
3786 (helm :sources `(((name . ,name)
3787 (candidates . ,candidates)
3788 (action . (lambda (f)
3789 (switch-to-buffer cb)
3791 ((name . "User functions")
3792 (candidates . ,org-ref-helm-user-candidates)
3793 (action . (lambda (f)
3794 (switch-to-buffer cb)
3800 : org-ref-cite-click-helm
3802 ** A hydra click interface
3803 I like hydra a lot. Here we define a hydra menu you might like for the link click action.
3805 #+BEGIN_SRC emacs-lisp :tangle org-ref.el
3806 (when (featurep 'hydra)
3808 (setq hydra-is-helpful t)
3810 (defhydra org-ref-cite-hydra (:color blue)
3812 _p_: Open pdf _w_: WOS _g_: Google Scholar _K_: Copy citation to clipboard
3813 _u_: Open url _r_: WOS related _P_: Pubmed _k_: Copy key to clipboard
3814 _n_: Open notes _c_: WOS citing _C_: Crossref _f_: Copy bibtex entry to file
3815 _o_: Open entry _e_: Email entry and pdf
3817 ("o" org-ref-open-citation-at-point nil)
3818 ("p" org-ref-open-pdf-at-point nil)
3819 ("n" org-ref-open-notes-at-point nil)
3820 ("u" org-ref-open-url-at-point nil)
3821 ("w" org-ref-wos-at-point nil)
3822 ("r" org-ref-wos-related-at-point nil)
3823 ("c" org-ref-wos-citing-at-point nil)
3824 ("g" org-ref-google-scholar-at-point nil)
3825 ("P" org-ref-pubmed-at-point nil)
3826 ("C" org-ref-crossref-at-point nil)
3827 ("K" org-ref-copy-entry-as-summary nil)
3830 (car (org-ref-get-bibtex-key-and-file)))) nil)
3831 ("f" org-ref-copy-entry-at-point-to-file nil)
3833 ("e" (save-excursion
3834 (org-ref-open-citation-at-point)
3835 (email-bibtex-entry)) nil)))
3839 #+BEGIN_SRC emacs-lisp :tangle org-ref.el
3842 ;;; org-ref.el ends here
3846 This code will tangle the elisp code out to org-ref.el and load it.
3848 [[elisp:(progn (org-babel-tangle) (load-file "org-ref.el"))]]
3850 Alternatively you may use:
3852 [[elisp:(org-babel-load-file "org-ref.org")]]