add copy key at point to file, copy summary to clipboard
authorJohn Kitchin <jkitchin@andrew.cmu.edu>
Wed, 21 Jan 2015 02:58:34 +0000 (21:58 -0500)
committerJohn Kitchin <jkitchin@andrew.cmu.edu>
Wed, 21 Jan 2015 02:58:34 +0000 (21:58 -0500)
org-ref.org

index fd9e3d6..334be13 100644 (file)
@@ -7,7 +7,7 @@
 This document is an experiment at creating a literate program to provide similar features as reftex for org-mode referencing. These features include:
 
 1. using completion to create links
-2. storing links to places, 
+2. storing links to places,
 3. Clickable links that do useful things
 4. Exportable links to LaTeX
 5. Utility functions for dealing with bibtex files and org-files
@@ -113,7 +113,13 @@ There are some variables needed later to tell this library where you store your
     ;;(org-tree-to-indirect-buffer)
     (outline-previous-visible-heading 1)
     (recenter-top-bottom 0))
-  "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") 
+  "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")
+
+
+(defcustom org-ref-open-pdf-function
+   'org-ref-open-pdf-at-point
+"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'."
+  :type 'function)
 #+END_SRC
 
 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.
@@ -214,7 +220,7 @@ We setup reftex here. We use a custom insert cite link function defined here: [[
                          )))))
 #+END_SRC
 
-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. 
+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.
 
 #+BEGIN_SRC emacs-lisp :tangle no
 ;; add new format
@@ -263,7 +269,7 @@ Reftex is no longer being developed. I want a url and doi option for formatting,
     (when (and (not (string= result "")) (string= "{" (substring result 0 1)))
       (setq result (substring result 1 -1)))
     (when (and (not (string= result "")) (string= "\"" (substring result 0 1)))
-      (setq result (substring result 1 -1)))    
+      (setq result (substring result 1 -1)))
       result))
 
 (defun org-ref-reftex-format-citation (entry format)
@@ -380,7 +386,7 @@ environment, only %l is available."
 
     (setq file (catch 'result
                 (loop for file in org-ref-bibliography-files do
-                      (if (org-ref-key-in-file-p key (file-truename file)) 
+                      (if (org-ref-key-in-file-p key (file-truename file))
                           (throw 'result file)
                         (message "%s not found in %s" key (file-truename file))))))
 
@@ -394,7 +400,7 @@ environment, only %l is available."
          (setq entry  (org-ref-reftex-format-citation bibtex-entry format))
        (save-restriction
          (bibtex-narrow-to-entry)
-         (setq entry (buffer-string)))))      
+         (setq entry (buffer-string)))))
     entry))
 #+END_SRC
 
@@ -419,11 +425,11 @@ This code provides some functions to generate a simple sorted bibliography in ht
   "return a list of unique keys in the buffer."
   (let ((keys '()))
     (org-element-map (org-element-parse-buffer) 'link
-      (lambda (link)       
-       (let ((plist (nth 1 link)))                          
+      (lambda (link)
+       (let ((plist (nth 1 link)))
          (when (-contains? org-ref-cite-types (plist-get plist ':type))
-           (dolist 
-               (key 
+           (dolist
+               (key
                 (org-ref-split-and-strip-string (plist-get plist ':path)))
              (when (not (-contains? keys key))
                (setq keys (append keys (list key)))))))))
@@ -443,7 +449,7 @@ This function gets the html for one entry.
 
 Now, we map over the whole list of keys, and the whole bibliography, formatted as an unordered list.
 
-#+BEGIN_SRC emacs-lisp :tangle org-ref.el 
+#+BEGIN_SRC emacs-lisp :tangle org-ref.el
 (defun org-ref-get-html-bibliography ()
   "Create an html bibliography when there are keys"
   (let ((keys (org-ref-get-bibtex-keys)))
@@ -468,7 +474,7 @@ First, we get the string for a single entry.
 
     (setq file (catch 'result
                 (loop for file in org-ref-bibliography-files do
-                      (if (org-ref-key-in-file-p key (file-truename file)) 
+                      (if (org-ref-key-in-file-p key (file-truename file))
                           (throw 'result file)
                         (message "%s not found in %s" key (file-truename file))))))
 
@@ -491,7 +497,7 @@ First, we get the string for a single entry.
 #+END_SRC
 
 Now, we loop over the keys, and combine all the entries into a bibliography.
-#+BEGIN_SRC emacs-lisp :tangle org-ref.el 
+#+BEGIN_SRC emacs-lisp :tangle org-ref.el
 (defun org-ref-get-org-bibliography ()
   "Create an org bibliography when there are keys"
   (let ((keys (org-ref-get-bibtex-keys)))
@@ -515,12 +521,12 @@ This function gets the html for one entry.
 
 Now, we map over the whole list of keys, and the whole bibliography, formatted as an unordered list.
 
-#+BEGIN_SRC emacs-lisp :tangle org-ref.el 
+#+BEGIN_SRC emacs-lisp :tangle org-ref.el
 (defun org-ref-get-ascii-bibliography ()
   "Create an html bibliography when there are keys"
   (let ((keys (org-ref-get-bibtex-keys)))
     (when keys
-      (concat 
+      (concat
 "Bibliography
 =============
 "
@@ -537,15 +543,15 @@ We use a link for the bibliography so that we can click on it to open the biblio
                   ;; this code is run on clicking. The bibliography
                   ;; may contain multiple files. this code finds the
                   ;; one you clicked on and opens it.
-                  (lambda (link-string)        
+                  (lambda (link-string)
                       ;; get link-string boundaries
                       ;; we have to go to the beginning of the line, and then search forward
-                      
+
                     (let* ((bibfile)
                            ;; object is the link you clicked on
                            (object (org-element-context))
-                           (link-string-beginning) 
+
+                           (link-string-beginning)
                            (link-string-end))
 
                     (save-excursion
@@ -558,7 +564,7 @@ We use a link for the bibliography so that we can click on it to open the biblio
                       ;; here. it should be a local variable only in
                       ;; the current buffer. We need this for using
                       ;; reftex to do citations.
-                      (set (make-local-variable 'reftex-default-bibliography) 
+                      (set (make-local-variable 'reftex-default-bibliography)
                            (split-string (org-element-property :path object) ","))
 
                       ;; now if we have comma separated bibliographies
@@ -584,12 +590,12 @@ We use a link for the bibliography so that we can click on it to open the biblio
                       ((eq format 'ascii) (org-ref-get-ascii-bibliography))
                      ((eq format 'html) (org-ref-get-html-bibliography))
                      ((eq format 'latex)
-                      ;; write out the latex bibliography command                     
+                      ;; write out the latex bibliography command
                       (format "\\bibliography{%s}" (replace-regexp-in-string  "\\.bib" "" (mapconcat 'identity
                                                                                                      (mapcar 'expand-file-name
                                                                                                              (split-string keyword ","))
                                                                                                      ",")))))))
-                                                                              
+
 #+END_SRC
 
 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.
@@ -605,15 +611,15 @@ Here, we make a =nobibliography= link that acts like the bibliography, enables c
                   ;; this code is run on clicking. The bibliography
                   ;; may contain multiple files. this code finds the
                   ;; one you clicked on and opens it.
-                  (lambda (link-string)        
+                  (lambda (link-string)
                       ;; get link-string boundaries
                       ;; we have to go to the beginning of the line, and then search forward
-                      
+
                     (let* ((bibfile)
                            ;; object is the link you clicked on
                            (object (org-element-context))
-                           (link-string-beginning) 
+
+                           (link-string-beginning)
                            (link-string-end))
 
                     (save-excursion
@@ -626,7 +632,7 @@ Here, we make a =nobibliography= link that acts like the bibliography, enables c
                       ;; here. it should be a local variable only in
                       ;; the current buffer. We need this for using
                       ;; reftex to do citations.
-                      (set (make-local-variable 'reftex-default-bibliography) 
+                      (set (make-local-variable 'reftex-default-bibliography)
                            (split-string (org-element-property :path object) ","))
 
                       ;; now if we have comma separated bibliographies
@@ -652,7 +658,7 @@ Here, we make a =nobibliography= link that acts like the bibliography, enables c
                       ((eq format 'ascii) (org-ref-get-ascii-bibliography))
                      ((eq format 'html) (org-ref-get-html-bibliography))
                      ((eq format 'latex)
-                      ;; write out the latex bibliography command                     
+                      ;; write out the latex bibliography command
 
 ;                     (format "{\\setbox0\\vbox{\\bibliography{%s}}}"
 ;                             (replace-regexp-in-string  "\\.bib" "" (mapconcat 'identity
@@ -666,7 +672,7 @@ Here, we make a =nobibliography= link that acts like the bibliography, enables c
                                                                                         (split-string keyword ","))
                                                                                 ",")))
 
-                      ))))                                                                            
+                      ))))
 #+END_SRC
 
 #+BEGIN_SRC emacs-lisp :tangle org-ref.el
@@ -695,7 +701,7 @@ We also create a bibliographystyle link. There is nothing to do on clicking here
 #+END_SRC
 
 *** Completion for bibliography link
-It would be nice 
+It would be nice
 
 #+BEGIN_SRC emacs-lisp :tangle org-ref.el
 (defun org-bibliography-complete-link (&optional arg)
@@ -714,15 +720,15 @@ This is apparently used for biblatex.
                   ;; this code is run on clicking. The addbibresource
                   ;; may contain multiple files. this code finds the
                   ;; one you clicked on and opens it.
-                  (lambda (link-string)        
+                  (lambda (link-string)
                       ;; get link-string boundaries
                       ;; we have to go to the beginning of the line, and then search forward
-                      
+
                     (let* ((bibfile)
                            ;; object is the link you clicked on
                            (object (org-element-context))
-                           (link-string-beginning) 
+
+                           (link-string-beginning)
                            (link-string-end))
 
                     (save-excursion
@@ -735,7 +741,7 @@ This is apparently used for biblatex.
                       ;; here. it should be a local variable only in
                       ;; the current buffer. We need this for using
                       ;; reftex to do citations.
-                      (set (make-local-variable 'reftex-default-addbibresource) 
+                      (set (make-local-variable 'reftex-default-addbibresource)
                            (split-string (org-element-property :path object) ","))
 
                       ;; now if we have comma separated bibliographies
@@ -774,27 +780,27 @@ In long documents, a list of figures is not uncommon. Here we create a clickable
   (save-excursion (widen)
   (let* ((c-b (buffer-name))
         (counter 0)
-        (list-of-figures 
+        (list-of-figures
          (org-element-map (org-element-parse-buffer) 'link
-           (lambda (link) 
+           (lambda (link)
              "create a link for to the figure"
-             (when 
+             (when
                  (and (string= (org-element-property :type link) "file")
-                      (string-match-p  
+                      (string-match-p
                        "[^.]*\\.\\(png\\|jpg\\|eps\\|pdf\\)$"
-                       (org-element-property :path link)))                   
+                       (org-element-property :path link)))
                (incf counter)
-               
+
                (let* ((start (org-element-property :begin link))
                       (parent (car (cdr (org-element-property :parent link))))
                       (caption (caaar (plist-get parent :caption)))
                       (name (plist-get parent :name)))
-                 (if caption 
-                     (format 
-                      "[[elisp:(progn (switch-to-buffer \"%s\")(widen)(goto-char %s))][figure %s: %s]] %s\n" 
+                 (if caption
+                     (format
+                      "[[elisp:(progn (switch-to-buffer \"%s\")(widen)(goto-char %s))][figure %s: %s]] %s\n"
                       c-b start counter (or name "") caption)
-                   (format 
-                    "[[elisp:(progn (switch-to-buffer \"%s\")(widen)(goto-char %s))][figure %s: %s]]\n" 
+                   (format
+                    "[[elisp:(progn (switch-to-buffer \"%s\")(widen)(goto-char %s))][figure %s: %s]]\n"
                     c-b start counter (or name "")))))))))
     (switch-to-buffer "*List of Figures*")
     (setq buffer-read-only nil)
@@ -805,7 +811,7 @@ In long documents, a list of figures is not uncommon. Here we create a clickable
     (use-local-map (copy-keymap org-mode-map))
     (local-set-key "q" #'(lambda () (interactive) (kill-buffer))))))
 
-(org-add-link-type 
+(org-add-link-type
  "list-of-figures"
  'org-ref-list-of-figures ; on click
  (lambda (keyword desc format)
@@ -824,20 +830,20 @@ In long documents, a list of figures is not uncommon. Here we create a clickable
   (widen)
   (let* ((c-b (buffer-name))
         (counter 0)
-        (list-of-tables 
+        (list-of-tables
          (org-element-map (org-element-parse-buffer 'element) 'table
-           (lambda (table) 
+           (lambda (table)
              "create a link for to the table"
              (incf counter)
              (let ((start (org-element-property :begin table))
                    (name  (org-element-property :name table))
                    (caption (caaar (org-element-property :caption table))))
-               (if caption 
-                   (format 
-                    "[[elisp:(progn (switch-to-buffer \"%s\")(widen)(goto-char %s))][table %s: %s]] %s\n" 
+               (if caption
+                   (format
+                    "[[elisp:(progn (switch-to-buffer \"%s\")(widen)(goto-char %s))][table %s: %s]] %s\n"
                     c-b start counter (or name "") caption)
-                 (format 
-                  "[[elisp:(progn (switch-to-buffer \"%s\")(widen)(goto-char %s))][table %s: %s]]\n" 
+                 (format
+                  "[[elisp:(progn (switch-to-buffer \"%s\")(widen)(goto-char %s))][table %s: %s]]\n"
                   c-b start counter (or name ""))))))))
     (switch-to-buffer "*List of Tables*")
     (setq buffer-read-only nil)
@@ -848,7 +854,7 @@ In long documents, a list of figures is not uncommon. Here we create a clickable
     (use-local-map (copy-keymap org-mode-map))
     (local-set-key "q" #'(lambda () (interactive) (kill-buffer))))))
 
-(org-add-link-type 
+(org-add-link-type
  "list-of-tables"
  'org-ref-list-of-tables
  (lambda (keyword desc format)
@@ -887,9 +893,9 @@ We want to store links on labels, so you can put the cursor on the label, press
 #+BEGIN_SRC emacs-lisp  :tangle org-ref.el
 (defun org-label-store-link ()
   "store a link to a label. The output will be a ref to that label"
-  ;; First we have to make sure we are on a label link. 
+  ;; First we have to make sure we are on a label link.
   (let* ((object (org-element-context)))
-    (when (and (equal (org-element-type object) 'link) 
+    (when (and (equal (org-element-type object) 'link)
                (equal (org-element-property :type object) "label"))
       (org-store-link-props
        :type "ref"
@@ -921,7 +927,7 @@ We want to store links on labels, so you can put the cursor on the label, press
 #+END_SRC
 ** ref
 
-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. 
+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.
 
 At the moment, ref links are not usable for section links. You need [[#CUSTOM_ID]] type links.
 
@@ -939,7 +945,7 @@ At the moment, ref links are not usable for section links. You need [[#CUSTOM_ID
    (unless
        (or
        ;; our label links
-       (progn 
+       (progn
          (goto-char (point-min))
          (re-search-forward (format "label:%s\\b" label) nil t))
 
@@ -952,7 +958,7 @@ At the moment, ref links are not usable for section links. You need [[#CUSTOM_ID
        (progn
          (goto-char (point-min))
          (re-search-forward (format "^#\\+label:\\s-*\\(%s\\)\\b" label) nil t))
-       
+
        ;; org tblname
        (progn
          (goto-char (point-min))
@@ -995,8 +1001,8 @@ matches)))
 (defun org-ref-get-custom-ids ()
  "return a list of custom_id properties in the buffer"
  (let ((results '()) custom_id)
-   (org-map-entries 
-    (lambda () 
+   (org-map-entries
+    (lambda ()
       (let ((custom_id (org-entry-get (point) "CUSTOM_ID")))
        (when (not (null custom_id))
          (setq results (append results (list custom_id)))))))
@@ -1019,7 +1025,7 @@ Finally, we get the table names.
 #+BEGIN_SRC emacs-lisp :tangle org-ref.el
 (defun org-ref-get-tblnames ()
   (org-element-map (org-element-parse-buffer 'element) 'table
-    (lambda (table) 
+    (lambda (table)
       (org-element-property :name table))))
 #+END_SRC
 
@@ -1071,7 +1077,7 @@ This refers to the page of a label in LaTeX.
    (unless
        (or
        ;; our label links
-       (progn 
+       (progn
          (goto-char (point-min))
          (re-search-forward (format "label:%s\\b" label) nil t))
 
@@ -1084,7 +1090,7 @@ This refers to the page of a label in LaTeX.
        (progn
          (goto-char (point-min))
          (re-search-forward (format "^#\\+label:\\s-*\\(%s\\)\\b" label) nil t))
-       
+
        ;; org tblname
        (progn
          (goto-char (point-min))
@@ -1158,7 +1164,7 @@ The nameref link allows you make links to the text of a section with a label. Cl
 
 ** eqref
 This is just the LaTeX ref for equations. On export, the reference is enclosed in parentheses.
+
 #+BEGIN_SRC emacs-lisp  :tangle org-ref.el
 (org-add-link-type
  "eqref"
@@ -1203,7 +1209,7 @@ point to get a comma, or the end of the link, and then backwards
 to get a comma, or the beginning of the link. that delimits the
 keyword we clicked on. We also strip the text properties."
   (interactive)
-  (let* ((object (org-element-context))         
+  (let* ((object (org-element-context))
         (link-string (org-element-property :path object)))
     ;; you may click on the part before the citations. here we make
     ;; sure to move to the beginning so you get the first citation.
@@ -1214,10 +1220,10 @@ keyword we clicked on. We also strip the text properties."
       ;; check if we clicked before the path and move as needed.
       (unless (< cp (point))
        (goto-char cp)))
-       
+
     (if (not (org-element-property :contents-begin object))
        ;; this means no description in the link
-       (progn    
+       (progn
          ;; we need the link path start and end
          (save-excursion
            (goto-char (org-element-property :begin object))
@@ -1266,14 +1272,14 @@ falling back to what the user has set in org-ref-default-bibliography
              (mapcar 'org-ref-strip-string (split-string (match-string 1) ",")))
        (throw 'result org-ref-bibliography-files))
 
-      
+
       ;; we did not find a bibliography link. now look for \bibliography
       (goto-char (point-min))
       (when (re-search-forward "\\\\bibliography{\\([^}]+\\)}" nil t)
        ;; split, and add .bib to each file
        (setq org-ref-bibliography-files
              (mapcar (lambda (x) (concat x ".bib"))
-                     (mapcar 'org-ref-strip-string 
+                     (mapcar 'org-ref-strip-string
                              (split-string (match-string 1) ","))))
        (throw 'result org-ref-bibliography-files))
 
@@ -1284,7 +1290,7 @@ falling back to what the user has set in org-ref-default-bibliography
        (setq org-ref-bibliography-files
              (mapcar 'org-ref-strip-string (split-string (match-string 1) ",")))
        (throw 'result org-ref-bibliography-files))
-         
+
       ;; we did not find anything. use defaults
       (setq org-ref-bibliography-files org-ref-default-bibliography)))
 
@@ -1294,7 +1300,7 @@ falling back to what the user has set in org-ref-default-bibliography
 #+END_SRC
 
 **** Finding the bibliography file a key is in
-Now, we can see if an entry is in a file. 
+Now, we can see if an entry is in a file.
 
 #+BEGIN_SRC emacs-lisp :tangle org-ref.el
 (defun org-ref-key-in-file-p (key filename)
@@ -1317,7 +1323,7 @@ Finally, we want to know which file the key is in.
      (setq key (org-ref-get-bibtex-key-under-cursor)))
    (setq file     (catch 'result
                    (loop for file in org-ref-bibliography-files do
-                         (if (org-ref-key-in-file-p key (file-truename file)) 
+                         (if (org-ref-key-in-file-p key (file-truename file))
                              (throw 'result file)))))
    (cons key file)))
 #+END_SRC
@@ -1385,7 +1391,7 @@ We need some convenience functions to open act on the citation at point. These w
   (let* ((cb (current-buffer))
        (results (org-ref-get-bibtex-key-and-file))
        (key (car results))
-       (bibfile (cdr results)))        
+       (bibfile (cdr results)))
     (message "%s" (progn
                    (with-temp-buffer
                       (insert-file-contents bibfile)
@@ -1406,18 +1412,54 @@ We need some convenience functions to open act on the citation at point. These w
 
 **** the actual minibuffer menu
 Now, we create the menu. This is a rewrite of the cite action. This makes the function extendable by users.
+
 #+BEGIN_SRC emacs-lisp  :tangle org-ref.el
 (defvar org-ref-cite-menu-funcs '()
- "Functions to run on cite click menu. Each entry is a list of (key menu-name function). 
+ "Functions to run on cite click menu. Each entry is a list of (key menu-name function).
 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.")
 
 
 (defvar org-ref-user-cite-menu-funcs
-  '(("C" "rossref" org-ref-crossref-at-point))
+  '(("C" "rossref" org-ref-crossref-at-point)
+    ("y" "Copy entry to file" org-ref-copy-entry-at-point-to-file)
+    ("s" "Copy summary" org-ref-copy-entry-as-summary))
   "user-defined functions to run on bibtex key at point.")
 
 
+(defun org-ref-copy-entry-as-summary ()
+  "Copy the bibtex entry for the citation at point as a summary."
+  (interactive)
+    (save-window-excursion
+      (org-ref-open-citation-at-point)
+      (kill-new (org-ref-bib-citation))))
+
+
+(defun org-ref-copy-entry-at-point-to-file ()
+  "Copy the bibtex entry for the citation at point to NEW-FILE.
+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."
+  (interactive)
+  (let ((new-file (ido-completing-read
+                  "Copy to bibfile: "
+                  (append org-ref-default-bibliography
+                          (f-entries "." (lambda (f) (f-ext? f "bib"))))))
+       (key (org-ref-get-bibtex-key-under-cursor)))
+    (save-window-excursion
+      (org-ref-open-citation-at-point)
+      (bibtex-copy-entry-as-kill))
+
+    (let ((bibtex-files (list (file-truename new-file))))
+      (if (assoc key (bibtex-global-key-alist))
+         (message "That key already exists in %s" new-file)
+       ;; add to file
+       (save-window-excursion
+         (find-file new-file)
+         (goto-char (point-max))
+          ;; make sure we are at the beginning of a line.
+         (unless (looking-at "^") (insert "\n\n"))
+         (bibtex-yank)
+         (save-buffer))))))
+
+
 (defun org-ref-get-doi-at-point ()
   "Get doi for key at point."
   (interactive)
@@ -1431,7 +1473,7 @@ The function must take no arguments and work on the key at point. Do not modify
        (bibtex-autokey-get-field "doi")
        ;; in case doi is a url, remove the url part.
        (replace-regexp-in-string "^http://dx.doi.org/" "" doi)))))
-  
+
 
 ;; functions that operate on key at point for click menu
 (defun org-ref-wos-at-point ()
@@ -1481,24 +1523,24 @@ Provides a menu of context sensitive actions. If the bibtex entry has a pdf, you
         (url (save-excursion
                (with-temp-buffer
                  (insert-file-contents bibfile)
-                 (bibtex-search-entry key)             
+                 (bibtex-search-entry key)
                  (bibtex-autokey-get-field "url"))))
         (doi (save-excursion
                (with-temp-buffer
                  (insert-file-contents bibfile)
                  (bibtex-search-entry key)
                  ;; I like this better than bibtex-url which does not always find
-                 ;; the urls             
+                 ;; the urls
                  (bibtex-autokey-get-field "doi")))))
 
     (when (string= "" doi) (setq doi nil))
     (when (string= "" url) (setq url nil))
     (setq org-ref-cite-menu-funcs '())
-        
+
     ;; open action
     (when
        bibfile
-      (add-to-list 
+      (add-to-list
        'org-ref-cite-menu-funcs
        '("o" "pen" org-ref-open-citation-at-point)))
 
@@ -1506,7 +1548,7 @@ Provides a menu of context sensitive actions. If the bibtex entry has a pdf, you
     (when (file-exists-p pdf-file)
       (add-to-list
        'org-ref-cite-menu-funcs
-       '("p" "df" org-ref-open-pdf-at-point) t))
+       `("p" "df" ,org-ref-open-pdf-function) t))
 
     ;; notes
     (add-to-list
@@ -1532,7 +1574,7 @@ Provides a menu of context sensitive actions. If the bibtex entry has a pdf, you
       (add-to-list
        'org-ref-cite-menu-funcs
        '("r" "elated" org-ref-wos-related-at-point) t)
-      
+
       (add-to-list
        'org-ref-cite-menu-funcs
        '("g" "oogle scholar" org-ref-google-scholar-at-point) t)
@@ -1551,7 +1593,7 @@ Provides a menu of context sensitive actions. If the bibtex entry has a pdf, you
     (add-to-list
      'org-ref-cite-menu-funcs
      '("q" "uit" (lambda ())) t)
-      
+
     ;; now we make a menu
     ;; construct menu string as a message
     (message
@@ -1577,7 +1619,7 @@ Provides a menu of context sensitive actions. If the bibtex entry has a pdf, you
       ;; now run the function (2nd element in choice)
       (when choice
        (funcall
-        (elt 
+        (elt
          choice
          2))))))
 #+END_SRC
@@ -1610,23 +1652,23 @@ Finally, we define the cite link. This is deprecated; the links are autogenerate
 #+END_SRC
 
 *** Automatic definition of the cite links
-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. 
+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.
 
-#+BEGIN_SRC emacs-lisp :tangle org-ref.el 
+#+BEGIN_SRC emacs-lisp :tangle org-ref.el
 (defmacro org-ref-make-completion-function (type)
   `(defun ,(intern (format "org-%s-complete-link" type)) (&optional arg)
      (interactive)
-     (format "%s:%s" 
+     (format "%s:%s"
             ,type
-            (completing-read 
-             "bibtex key: " 
+            (completing-read
+             "bibtex key: "
              (let ((bibtex-files (org-ref-find-bibliography)))
                (bibtex-global-key-alist))))))
 #+END_SRC
 
 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.
 
-#+BEGIN_SRC emacs-lisp :tangle org-ref.el 
+#+BEGIN_SRC emacs-lisp :tangle org-ref.el
 (defmacro org-ref-make-format-function (type)
   `(defun ,(intern (format "org-ref-format-%s" type)) (keyword desc format)
      (cond
@@ -1642,10 +1684,10 @@ We will want to generate formatting functions for each citation type. The reason
                (lambda (key)
                  (format "%s" key))
                (org-ref-split-and-strip-string keyword) ",") "]"))
-       
-      ((eq format 'html) 
-       (mapconcat 
-       (lambda (key) 
+
+      ((eq format 'html)
+       (mapconcat
+       (lambda (key)
          (format "<a href=\"#%s\">%s</a>" key key))
        (org-ref-split-and-strip-string keyword) ","))
 
@@ -1662,7 +1704,7 @@ We will want to generate formatting functions for each citation type. The reason
 
 
 
-We create the links by mapping the function onto the list of defined link types. 
+We create the links by mapping the function onto the list of defined link types.
 
 #+BEGIN_SRC emacs-lisp :tangle org-ref.el
 (defun org-ref-format-citation-description (desc)
@@ -1675,22 +1717,22 @@ We create the links by mapping the function onto the list of defined link types.
 
 (defun org-ref-define-citation-link (type &optional key)
   "add a citation link for org-ref. With optional key, set the reftex binding. For example:
-(org-ref-define-citation-link \"citez\" ?z) will create a new citez link, with reftex key of z, 
+(org-ref-define-citation-link \"citez\" ?z) will create a new citez link, with reftex key of z,
 and the completion function."
   (interactive "sCitation Type: \ncKey: ")
 
   ;; create the formatting function
   (eval `(org-ref-make-format-function ,type))
 
-  (eval-expression 
-   `(org-add-link-type 
+  (eval-expression
+   `(org-add-link-type
      ,type
      'org-ref-cite-onclick-minibuffer-menu
      (quote ,(intern (format "org-ref-format-%s" type)))))
 
   ;; create the completion function
   (eval `(org-ref-make-completion-function ,type))
-  
+
   ;; store new type so it works with adding citations, which checks
   ;; for existence in this list
   (add-to-list 'org-ref-cite-types type)
@@ -1698,7 +1740,7 @@ and the completion function."
   ;; and finally if a key is specified, we modify the reftex menu
   (when key
     (setf (nth 2 (assoc 'org reftex-cite-format-builtin))
-         (append (nth 2 (assoc 'org reftex-cite-format-builtin)) 
+         (append (nth 2 (assoc 'org reftex-cite-format-builtin))
                  `((,key  . ,(concat type ":%l")))))))
 
 ;; create all the link types and their completion functions
@@ -1718,33 +1760,33 @@ inserted. Use a prefix arg to get a menu of citation types."
   (let* ((object (org-element-context))
         (link-string-beginning (org-element-property :begin object))
         (link-string-end (org-element-property :end object))
-        (path (org-element-property :path object)))  
+        (path (org-element-property :path object)))
 
     (if (not alternative-cite)
-       
+
        (cond
         ;; case where we are in a link
-        ((and (equal (org-element-type object) 'link) 
+        ((and (equal (org-element-type object) 'link)
               (-contains? org-ref-cite-types (org-element-property :type object)))
          (goto-char link-string-end)
          ;; sometimes there are spaces at the end of the link
          ;; this code moves point pack until no spaces are there
-         (while (looking-back " ") (backward-char))  
+         (while (looking-back " ") (backward-char))
          (insert (concat "," (mapconcat 'identity (reftex-citation t ?a) ","))))
 
         ;; We are next to a link, and we want to append
-        ((save-excursion 
+        ((save-excursion
            (backward-char)
-           (and (equal (org-element-type (org-element-context)) 'link) 
+           (and (equal (org-element-type (org-element-context)) 'link)
                 (-contains? org-ref-cite-types (org-element-property :type (org-element-context)))))
-         (while (looking-back " ") (backward-char))  
+         (while (looking-back " ") (backward-char))
          (insert (concat "," (mapconcat 'identity (reftex-citation t ?a) ","))))
 
         ;; insert fresh link
-        (t 
-         (insert 
-          (concat org-ref-default-citation-link 
-                  ":" 
+        (t
+         (insert
+          (concat org-ref-default-citation-link
+                  ":"
                   (mapconcat 'identity (reftex-citation t) ",")))))
 
       ;; you pressed a C-u so we run this code
@@ -1761,10 +1803,10 @@ If you know the specific bibtex key, you may like to use completion directly. Yo
 #+BEGIN_SRC emacs-lisp  :tangle no
 (defun org-cite-complete-link (&optional arg)
   "Completion function for cite links"
-  (format "%s:%s" 
+  (format "%s:%s"
           org-ref-default-citation-link
-         (completing-read 
-          "bibtex key: " 
+         (completing-read
+          "bibtex key: "
           (let ((bibtex-files (org-ref-find-bibliography)))
             (bibtex-global-key-alist)))))
 #+END_SRC
@@ -1785,8 +1827,8 @@ org-mode already defines a store link function for bibtex entries. It does not s
 (defun org-ref-store-bibtex-entry-link ()
   "Save a citation link to the current bibtex entry. Saves in the default link type."
   (interactive)
-  (let ((link (concat org-ref-default-citation-link 
-                ":"   
+  (let ((link (concat org-ref-default-citation-link
+                ":"
                 (save-excursion
                   (bibtex-beginning-of-entry)
                   (reftex-get-bib-field "=key=" (bibtex-parse-entry))))))
@@ -1840,16 +1882,16 @@ index:encodings!input!cp850
 
      ;; get links
      (org-element-map (org-element-parse-buffer) 'link
-       (lambda (link)       
+       (lambda (link)
         (let ((type (nth 0 link))
               (plist (nth 1 link)))
-           
+
           (when (equal (plist-get plist ':type) "index")
             (add-to-list
-             '*index-links* 
+             '*index-links*
              (cons (plist-get plist :path)
                    (format
-                    "[[elisp:(progn (switch-to-buffer \"%s\") (goto-char %s))][%s]]"               
+                    "[[elisp:(progn (switch-to-buffer \"%s\") (goto-char %s))][%s]]"
 (current-buffer)
                     (plist-get plist :begin)  ;; position of link
                     ;; grab a description
@@ -1864,7 +1906,7 @@ index:encodings!input!cp850
 
      ;; sort the links
      (setq *index-links*  (cl-sort *index-links* 'string-lessp :key 'car))
-   
+
      ;; now first letters
      (dolist (link *index-links*)
        (add-to-list '*initial-letters* (substring (car link) 0 1) t))
@@ -1896,7 +1938,7 @@ index:encodings!input!cp850
 
 ** Glossary
 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.
+
 #+LATEX_HEADER: \usepackage{glossaries}
 #+LATEX_HEADER: \makeglossaries
 
@@ -2175,17 +2217,17 @@ construct the heading by hand."
     (with-temp-buffer
       (insert key)
       (kill-ring-save (point-min) (point-max)))
-    
+
     ;; now look for entry in the notes file
     (if  org-ref-bibliography-notes
        (find-file-other-window org-ref-bibliography-notes)
       (error "org-ref-bib-bibliography-notes is not set to anything"))
-    
+
     (goto-char (point-min))
     ;; put new entry in notes if we don't find it.
     (if (re-search-forward (format ":Custom_ID: %s$" key) nil 'end)
        (funcall org-ref-open-notes-function)
-      ;; no entry found, so add one    
+      ;; no entry found, so add one
       (insert (format "\n** TODO %s - %s" year title))
       (insert (format"
  :PROPERTIES:
@@ -2213,9 +2255,9 @@ key author journal year volume pages doi url key org-ref-pdf-directory key))
     (if  org-ref-bibliography-notes
        (find-file-other-window org-ref-bibliography-notes)
       (error "org-ref-bib-bibliography-notes is not set to anything"))
-    
+
     (goto-char (point-min))
-    
+
     (re-search-forward (format
                        ":Custom_ID: %s$"
                        (first (reftex-citation t)) nil 'end))
@@ -2272,7 +2314,7 @@ Relies on the python script /upload_bibtex_citeulike.py being in the user direct
 #+END_SRC
 
 *** The upload script
-Here is the python script for uploading. 
+Here is the python script for uploading.
 
 *************** TODO document how to get the cookies
 *************** END
@@ -2335,7 +2377,7 @@ print r
     (shell-command (concat "pdflatex " bib-base))
     (kill-buffer texfile)
     (org-open-file pdffile)
-    )) 
+    ))
 #+END_SRC
 
 ** Extract bibtex entries cited in an org-file
@@ -2352,20 +2394,20 @@ If no bibliography is in the buffer the `reftex-default-bibliography' is used."
          (contents (buffer-string))
          (cb (current-buffer))
         basename texfile bibfile results)
-    
+
     ;; open tempfile and insert org-buffer contents
     (find-file tempname)
     (insert contents)
-    (setq basename (file-name-sans-extension 
+    (setq basename (file-name-sans-extension
                    (file-name-nondirectory buffer-file-name))
          texfile (concat tempname ".tex")
          bibfile (concat tempname ".bib"))
-    
+
     ;; see if we have a bibliography, and insert the default one if not.
     (save-excursion
       (goto-char (point-min))
       (unless (re-search-forward "^bibliography:" (point-max) 'end)
-       (insert (format "\nbibliography:%s" 
+       (insert (format "\nbibliography:%s"
                        (mapconcat 'identity reftex-default-bibliography ",")))))
     (save-buffer)
 
@@ -2413,7 +2455,7 @@ Depending on how you enter citations, you may have citations with no correspondi
        (found nil))
     (dolist (arg list i)
       (if (string-match (concat "^" substring "$") arg)
-         (progn 
+         (progn
            (setq found t)
            (return i)))
       (setq i (+ i 1)))
@@ -2433,8 +2475,8 @@ Makes a new buffer with clickable links."
         (bad-citations '()))
 
     (org-element-map (org-element-parse-buffer) 'link
-      (lambda (link)       
-       (let ((plist (nth 1 link)))                          
+      (lambda (link)
+       (let ((plist (nth 1 link)))
          (when (equal (plist-get plist ':type) "cite")
            (dolist (key (org-ref-split-and-strip-string (plist-get plist ':path)) )
              (when (not (index key bibtex-keys))
@@ -2460,7 +2502,7 @@ Makes a new buffer with clickable links."
 #+END_SRC
 
 ** Finding non-ascii characters
-I like my bibtex files to be 100% ascii. This function finds the non-ascii characters so you can replace them. 
+I like my bibtex files to be 100% ascii. This function finds the non-ascii characters so you can replace them.
 
 #+BEGIN_SRC emacs-lisp :tangle org-ref.el
 (defun org-ref-find-non-ascii-characters ()
@@ -2495,16 +2537,16 @@ I like neat and orderly bibtex entries.That means the fields are in a standard o
 
     (cond
      ;; right now we only resort articles
-     ((string= (downcase type) "article") 
+     ((string= (downcase type) "article")
       (bibtex-kill-entry)
       (insert
-       (concat "@article{" key ",\n" 
-              (mapconcat  
-               (lambda (field) 
+       (concat "@article{" key ",\n"
+              (mapconcat
+               (lambda (field)
                  (when (member field entry-fields)
                    (format "%s = %s," (downcase field) (cdr (assoc field entry))))) master "\n")
-              (mapconcat 
-               (lambda (field) 
+              (mapconcat
+               (lambda (field)
                  (format "%s = %s," (downcase field) (cdr (assoc field entry)))) other-fields "\n")
               "\n}\n\n"))
       (bibtex-find-entry key)
@@ -2520,7 +2562,7 @@ see [[file:emacs-24.3/lisp/textmodes/bibtex.el::bibtex-autokey-before-presentati
 (defun org-ref-clean-bibtex-entry(&optional keep-key)
   "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"
   (interactive "P")
-  (bibtex-beginning-of-entry) 
+  (bibtex-beginning-of-entry)
 (end-of-line)
   ;; some entries do not have a key or comma in first line. We check and add it, if needed.
   (unless (string-match ",$" (thing-at-point 'line))
@@ -2547,7 +2589,7 @@ see [[file:emacs-24.3/lisp/textmodes/bibtex.el::bibtex-autokey-before-presentati
 
     ;; asap articles often set year to 0, which messes up key
     ;; generation. fix that.
-    (when (string= "0" year)  
+    (when (string= "0" year)
       (bibtex-beginning-of-entry)
       (goto-char (car (cdr (bibtex-search-forward-field "year" t))))
       (bibtex-kill-field)
@@ -2557,7 +2599,7 @@ see [[file:emacs-24.3/lisp/textmodes/bibtex.el::bibtex-autokey-before-presentati
 
     ;; fix pages if they are empty if there is an eid to put there.
     (when (string= "-" pages)
-      (when eid          
+      (when eid
        (bibtex-beginning-of-entry)
        ;; this seems like a clunky way to set the pages field.But I
        ;; cannot find a better way.
@@ -2596,7 +2638,7 @@ see [[file:emacs-24.3/lisp/textmodes/bibtex.el::bibtex-autokey-before-presentati
          (setq key (bibtex-read-key "Duplicate Key found, edit: " key)))
 
        (insert key)
-       (kill-new key))) ;; save key for pasting            
+       (kill-new key))) ;; save key for pasting
 
     ;; run hooks. each of these operates on the entry with no arguments.
     ;; this did not work like  i thought, it gives a symbolp error.
@@ -2606,7 +2648,7 @@ see [[file:emacs-24.3/lisp/textmodes/bibtex.el::bibtex-autokey-before-presentati
                (save-excursion
                  (funcall x))))
            org-ref-clean-bibtex-entry-hook)
-    
+
     ;; sort fields within entry
     (org-ref-sort-bibtex-entry)
     ;; check for non-ascii characters
@@ -2635,14 +2677,14 @@ I prefer citations in chronological order within a grouping. These functions sor
 (defun org-ref-sort-citation-link ()
  "replace link at point with sorted link by year"
  (interactive)
- (let* ((object (org-element-context))  
+ (let* ((object (org-element-context))
         (type (org-element-property :type object))
        (begin (org-element-property :begin object))
        (end (org-element-property :end object))
        (link-string (org-element-property :path object))
        keys years data)
   (setq keys (org-ref-split-and-strip-string link-string))
-  (setq years (mapcar 'org-ref-get-citation-year keys)) 
+  (setq years (mapcar 'org-ref-get-citation-year keys))
   (setq data (mapcar* (lambda (a b) `(,a . ,b)) years keys))
   (setq data (cl-sort data (lambda (x y) (< (string-to-int (car x)) (string-to-int (car y))))))
   ;; now get the keys separated by commas
@@ -2664,7 +2706,7 @@ Sometimes it may be helpful to manually change the order of citations. These fun
 (defun org-ref-swap-citation-link (direction)
  "move citation at point in direction +1 is to the right, -1 to the left"
  (interactive)
- (let* ((object (org-element-context))  
+ (let* ((object (org-element-context))
         (type (org-element-property :type object))
        (begin (org-element-property :begin object))
        (end (org-element-property :end object))
@@ -2677,12 +2719,12 @@ Sometimes it may be helpful to manually change the order of citations. These fun
         (setq i (index key keys))  ;; defined in org-ref
        (if (> direction 0) ;; shift right
            (org-ref-swap-keys i (+ i 1) keys)
-         (org-ref-swap-keys i (- i 1) keys))   
+         (org-ref-swap-keys i (- i 1) keys))
        (setq keys (mapconcat 'identity keys ","))
        ;; and replace the link with the sorted keys
        (cl--set-buffer-substring begin end (concat type ":" keys " "))
        ;; now go forward to key so we can move with the key
-       (re-search-forward key) 
+       (re-search-forward key)
        (goto-char (match-beginning 0)))))
 
 ;; add hooks to make it work
@@ -2720,6 +2762,3 @@ This code will tangle the elisp code out to org-ref.el and load it.
 Alternatively you may use:
 
 [[elisp:(org-babel-load-file "org-ref.org")]]
-
-
-