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
;;; Commentary:
;;
-;; Lisp code to setup bibliography cite, ref and label org-mode links.
-;; also sets up reftex for org-mode. The links are clickable and do
-;; things that are useful. You should really read org-ref.org for details.
+;; Lisp code to setup bibliography cite, ref and label org-mode links. also
+;; sets up reftex and helm for org-mode citations. The links are clickable and
+;; do things that are useful. You should really read org-ref.org for details.
;;
-;; Package-Requires: ((dash))
+;; Package-Requires: ((dash) (helm) (helm-bibtex))
#+END_SRC
** requires
#+BEGIN_SRC emacs-lisp :tangle org-ref.el
(require 'reftex-cite)
(require 'dash)
+(require 'helm)
+(require 'helm-bibtex)
#+END_SRC
** Custom variables
;;(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"
+:type 'function
+:group 'org-ref)
+
+
+(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
+ :group 'org-ref)
+
+
+(defcustom org-ref-insert-cite-function
+ 'org-ref-helm-insert-cite-link
+ "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."
+ :type 'function
+ :group 'org-ref)
+
+
+(defcustom org-ref-cite-onclick-function
+ 'org-ref-cite-click-helm
+ "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."
+ :type 'function
+ :group 'org-ref)
+
+(defcustom org-ref-show-citation-on-enter t
+ "If non-nil add a hook function to show the citation summary in
+ the minibuffer just by putting the cursor in a link"
+ :group 'org-ref)
+
#+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.
)
(make-local-variable 'reftex-cite-format)
(setq reftex-cite-format 'org)
- (define-key org-mode-map (kbd org-ref-insert-cite-key) 'org-ref-insert-cite-link))
+ (define-key org-mode-map (kbd org-ref-insert-cite-key) org-ref-insert-cite-function))
(add-hook 'org-mode-hook 'org-mode-reftex-setup)
)))))
#+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
(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)
(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))))))
(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
"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)))))))))
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)))
(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))))))
#+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)))
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
=============
"
;; 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
;; 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
((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.
;; 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
;; 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
((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
(split-string keyword ","))
",")))
- ))))
+ ))))
#+END_SRC
#+BEGIN_SRC emacs-lisp :tangle org-ref.el
#+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)
;; 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
;; 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
(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)
(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)
(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)
(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)
*************** END
#+BEGIN_SRC emacs-lisp :tangle org-ref.el
+
+(defun org-ref-count-labels (label)
+ (+ (count-matches (format "label:%s\\b[^-:]" label) (point-min) (point-max) t)
+ ;; for tblname, it is not enough to get word boundary
+ ;; tab-little and tab-little-2 match then.
+ (count-matches (format "^#\\+tblname:\\s-*%s\\b[^-:]" label) (point-min) (point-max) t)
+ (count-matches (format "\\label{%s}\\b" label) (point-min) (point-max) t)
+ ;; this is the org-format #+label:
+ (count-matches (format "^#\\+label:\\s-*%s\\b[^-:]" label) (point-min) (point-max) t)))
+
(org-add-link-type
"label"
(lambda (label)
"on clicking count the number of label tags used in the buffer. A number greater than one means multiple labels!"
- (message (format "%s occurences"
- (+ (count-matches (format "label:%s\\b[^-:]" label) (point-min) (point-max) t)
- ;; for tblname, it is not enough to get word boundary
- ;; tab-little and tab-little-2 match then.
- (count-matches (format "^#\\+tblname:\\s-*%s\\b[^-:]" label) (point-min) (point-max) t)
- (count-matches (format "\\label{%s}\\b" label) (point-min) (point-max) t)
- ;; this is the org-format #+label:
- (count-matches (format "^#\\+label:\\s-*%s\\b[^-:]" label) (point-min) (point-max) t)))))
+ (message (format "%s occurences" (org-ref-count-labels label))))
(lambda (keyword desc format)
(cond
((eq format 'html) (format "(<label>%s</label>)" path))
#+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"
#+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.
(unless
(or
;; our label links
- (progn
+ (progn
(goto-char (point-min))
(re-search-forward (format "label:%s\\b" label) nil t))
(progn
(goto-char (point-min))
(re-search-forward (format "^#\\+label:\\s-*\\(%s\\)\\b" label) nil t))
-
+
;; org tblname
(progn
(goto-char (point-min))
(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)))))))
#+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
(unless
(or
;; our label links
- (progn
+ (progn
(goto-char (point-min))
(re-search-forward (format "label:%s\\b" label) nil t))
(progn
(goto-char (point-min))
(re-search-forward (format "^#\\+label:\\s-*\\(%s\\)\\b" label) nil t))
-
+
;; org tblname
(progn
(goto-char (point-min))
** 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"
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.
;; 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))
(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))
(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)))
#+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)
(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
(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)
**** 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)
(let* ((results (org-ref-get-bibtex-key-and-file))
(key (car results))
- (bibfile (cdr results)))
+ (bibfile (cdr results))
+ doi)
(save-excursion
(with-temp-buffer
(insert-file-contents bibfile)
(bibtex-search-entry key)
- (bibtex-autokey-get-field "doi")
+ (setq doi (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 ()
(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)))
(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
(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)
(add-to-list
'org-ref-cite-menu-funcs
'("q" "uit" (lambda ())) t)
-
+
;; now we make a menu
;; construct menu string as a message
(message
;; now run the function (2nd element in choice)
(when choice
(funcall
- (elt
+ (elt
choice
2))))))
#+END_SRC
#+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
(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) ","))
-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)
(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
+ org-ref-cite-onclick-function
(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)
;; 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
(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
(reftex-citation)))
)
#+END_SRC
+cite:zhou-2004-first-lda-u,paier-2006-errat,boes-2015-estim-bulk
+
#+RESULTS:
: org-ref-insert-cite-link
#+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
(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))))))
;; 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
;; 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))
** 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
(format "\\Glspl{%s}" path)))))
#+END_SRC
-#+RESULTS:
-| Glspl | nil | (lambda (path desc format) (cond ((eq format (quote latex)) (format \Glspl{%s} path)))) |
-| Gls | nil | (lambda (path desc format) (cond ((eq format (quote latex)) (format \Gls{%s} path)))) |
-| glspl | nil | (lambda (path desc format) (cond ((eq format (quote latex)) (format \glspl{%s} path)))) |
-| gls | nil | (lambda (path desc format) (cond ((eq format (quote latex)) (format \gls{%s} path)))) |
-| newglossaryentry | nil | (lambda (path desc format) (cond ((eq format (quote latex)) (format \newglossaryentry{%s}{%s} path desc)))) |
-| google | (lambda (link-string) (browse-url (format http://www.google.com/search?q=%s (url-hexify-string link-string)))) | nil |
-| ResearcherID | (lambda (link-string) (browse-url (format http://www.researcherid.com/rid/%s link-string))) | nil |
-| orcid | (lambda (link-string) (browse-url (format http://orcid.org/%s link-string))) | nil |
-| message | org-mac-message-open | nil |
-| mac-outlook | org-mac-outlook-message-open | nil |
-| skim | org-mac-skim-open | nil |
-| addressbook | org-mac-addressbook-item-open | nil |
-| x-together-item | org-mac-together-item-open | nil |
-| ans | (lambda (path) (let* ((fields (split-string path ::)) (label (nth 0 fields)) (data (nth 1 fields)) (data-file (format %s-%s.dat tq-userid label))) (let ((temp-file data-file) (temp-buffer (get-buffer-create (generate-new-buffer-name *temp file*)))) (unwind-protect (prog1 (save-current-buffer (set-buffer temp-buffer) (insert data)) (save-current-buffer (set-buffer temp-buffer) (write-region nil nil temp-file nil 0))) (and (buffer-name temp-buffer) (kill-buffer temp-buffer)))) (mygit (format git add %s data-file)) (mygit (format git commit -m "%s" data-file)) (mygit git push origin master))) | nil |
-| mc | (lambda (link) (org-entry-put (point) ANSWER link) (save-restriction (save-excursion (org-narrow-to-subtree) (goto-char (point-max)) (if (bolp) nil (insert \n)) (insert (format # you chose %s link))))) | nil |
-| exercise | (lambda (arg) (tq-check-internet) (tq-get-assignment arg)) | nil |
-| solution | (lambda (label) (tq-check-internet) (let ((default-directory (file-name-as-directory (expand-file-name tq-root-directory)))) (if (file-exists-p solutions) nil (make-directory solutions)) (let ((default-directory (file-name-as-directory (expand-file-name solutions)))) (if (file-exists-p label) (progn (find-file (concat label / label .org)) (tq-update)) (mygit (format git clone %s@%s:solutions/%s tq-current-course tq-git-server label)) (find-file (concat label / label .org)))))) | nil |
-| assignment | (lambda (arg) (tq-check-internet) (tq-get-assignment arg)) | nil |
-| doi | doi-link-menu | nil |
-| bibentry | org-ref-cite-onclick-minibuffer-menu | org-ref-format-bibentry |
-| Autocites | org-ref-cite-onclick-minibuffer-menu | org-ref-format-Autocites |
-| autocites | org-ref-cite-onclick-minibuffer-menu | org-ref-format-autocites |
-| supercites | org-ref-cite-onclick-minibuffer-menu | org-ref-format-supercites |
-| Textcites | org-ref-cite-onclick-minibuffer-menu | org-ref-format-Textcites |
-| textcites | org-ref-cite-onclick-minibuffer-menu | org-ref-format-textcites |
-| Smartcites | org-ref-cite-onclick-minibuffer-menu | org-ref-format-Smartcites |
-| smartcites | org-ref-cite-onclick-minibuffer-menu | org-ref-format-smartcites |
-| footcitetexts | org-ref-cite-onclick-minibuffer-menu | org-ref-format-footcitetexts |
-| footcites | org-ref-cite-onclick-minibuffer-menu | org-ref-format-footcites |
-| Parencites | org-ref-cite-onclick-minibuffer-menu | org-ref-format-Parencites |
-| parencites | org-ref-cite-onclick-minibuffer-menu | org-ref-format-parencites |
-| Cites | org-ref-cite-onclick-minibuffer-menu | org-ref-format-Cites |
-| cites | org-ref-cite-onclick-minibuffer-menu | org-ref-format-cites |
-| fnotecite | org-ref-cite-onclick-minibuffer-menu | org-ref-format-fnotecite |
-| Pnotecite | org-ref-cite-onclick-minibuffer-menu | org-ref-format-Pnotecite |
-| pnotecite | org-ref-cite-onclick-minibuffer-menu | org-ref-format-pnotecite |
-| Notecite | org-ref-cite-onclick-minibuffer-menu | org-ref-format-Notecite |
-| notecite | org-ref-cite-onclick-minibuffer-menu | org-ref-format-notecite |
-| footfullcite | org-ref-cite-onclick-minibuffer-menu | org-ref-format-footfullcite |
-| fullcite | org-ref-cite-onclick-minibuffer-menu | org-ref-format-fullcite |
-| citeurl | org-ref-cite-onclick-minibuffer-menu | org-ref-format-citeurl |
-| citedate* | org-ref-cite-onclick-minibuffer-menu | org-ref-format-citedate* |
-| citedate | org-ref-cite-onclick-minibuffer-menu | org-ref-format-citedate |
-| citetitle* | org-ref-cite-onclick-minibuffer-menu | org-ref-format-citetitle* |
-| citetitle | org-ref-cite-onclick-minibuffer-menu | org-ref-format-citetitle |
-| Citeauthor* | org-ref-cite-onclick-minibuffer-menu | org-ref-format-Citeauthor* |
-| Autocite* | org-ref-cite-onclick-minibuffer-menu | org-ref-format-Autocite* |
-| autocite* | org-ref-cite-onclick-minibuffer-menu | org-ref-format-autocite* |
-| Autocite | org-ref-cite-onclick-minibuffer-menu | org-ref-format-Autocite |
-| autocite | org-ref-cite-onclick-minibuffer-menu | org-ref-format-autocite |
-| supercite | org-ref-cite-onclick-minibuffer-menu | org-ref-format-supercite |
-| parencite* | org-ref-cite-onclick-minibuffer-menu | org-ref-format-parencite* |
-| cite* | org-ref-cite-onclick-minibuffer-menu | org-ref-format-cite* |
-| Smartcite | org-ref-cite-onclick-minibuffer-menu | org-ref-format-Smartcite |
-| smartcite | org-ref-cite-onclick-minibuffer-menu | org-ref-format-smartcite |
-| Textcite | org-ref-cite-onclick-minibuffer-menu | org-ref-format-Textcite |
-| textcite | org-ref-cite-onclick-minibuffer-menu | org-ref-format-textcite |
-| footcitetext | org-ref-cite-onclick-minibuffer-menu | org-ref-format-footcitetext |
-| footcite | org-ref-cite-onclick-minibuffer-menu | org-ref-format-footcite |
-| Parencite | org-ref-cite-onclick-minibuffer-menu | org-ref-format-Parencite |
-| parencite | org-ref-cite-onclick-minibuffer-menu | org-ref-format-parencite |
-| Cite | org-ref-cite-onclick-minibuffer-menu | org-ref-format-Cite |
-| Citeauthor | org-ref-cite-onclick-minibuffer-menu | org-ref-format-Citeauthor |
-| Citealp | org-ref-cite-onclick-minibuffer-menu | org-ref-format-Citealp |
-| Citealt | org-ref-cite-onclick-minibuffer-menu | org-ref-format-Citealt |
-| Citep | org-ref-cite-onclick-minibuffer-menu | org-ref-format-Citep |
-| Citet | org-ref-cite-onclick-minibuffer-menu | org-ref-format-Citet |
-| citeyear* | org-ref-cite-onclick-minibuffer-menu | org-ref-format-citeyear* |
-| citeyear | org-ref-cite-onclick-minibuffer-menu | org-ref-format-citeyear |
-| citeauthor* | org-ref-cite-onclick-minibuffer-menu | org-ref-format-citeauthor* |
-| citeauthor | org-ref-cite-onclick-minibuffer-menu | org-ref-format-citeauthor |
-| citetext | org-ref-cite-onclick-minibuffer-menu | org-ref-format-citetext |
-| citenum | org-ref-cite-onclick-minibuffer-menu | org-ref-format-citenum |
-| citealp* | org-ref-cite-onclick-minibuffer-menu | org-ref-format-citealp* |
-| citealp | org-ref-cite-onclick-minibuffer-menu | org-ref-format-citealp |
-| citealt* | org-ref-cite-onclick-minibuffer-menu | org-ref-format-citealt* |
-| citealt | org-ref-cite-onclick-minibuffer-menu | org-ref-format-citealt |
-| citep* | org-ref-cite-onclick-minibuffer-menu | org-ref-format-citep* |
-| citep | org-ref-cite-onclick-minibuffer-menu | org-ref-format-citep |
-| citet* | org-ref-cite-onclick-minibuffer-menu | org-ref-format-citet* |
-| citet | org-ref-cite-onclick-minibuffer-menu | org-ref-format-citet |
-| nocite | org-ref-cite-onclick-minibuffer-menu | org-ref-format-nocite |
-| cite | org-ref-cite-onclick-minibuffer-menu | org-ref-format-cite |
-| eqref | (lambda (label) on clicking goto the label. Navigate back with C-c & (org-mark-ring-push) (widen) (goto-char (point-min)) (if (or (re-search-forward (format label:%s label) nil t) (re-search-forward (format \label{%s} label) nil t) (re-search-forward (format ^#\+label:\s-*\(%s\)\b label) nil t)) nil (org-mark-ring-goto) (error %s not found label)) (message go back with (org-mark-ring-goto) `C-c &`)) | (lambda (keyword desc format) (cond ((eq format (quote html)) (format (<eqref>%s</eqref>) path)) ((eq format (quote latex)) (format \eqref{%s} keyword)))) |
-| nameref | (lambda (label) on clicking goto the label. Navigate back with C-c & (org-mark-ring-push) (widen) (if (or (progn (goto-char (point-min)) (re-search-forward (format \label{%s} label) nil t))) nil (org-mark-ring-goto) (error %s not found label)) (message go back with (org-mark-ring-goto) `C-c &`)) | (lambda (keyword desc format) (cond ((eq format (quote html)) (format (<nameref>%s</nameref>) path)) ((eq format (quote latex)) (format \nameref{%s} keyword)))) |
-| pageref | (lambda (label) on clicking goto the label. Navigate back with C-c & (org-mark-ring-push) (widen) (if (or (progn (goto-char (point-min)) (re-search-forward (format label:%s\b label) nil t)) (progn (goto-char (point-min)) (re-search-forward (format \label{%s} label) nil t)) (progn (goto-char (point-min)) (re-search-forward (format ^#\+label:\s-*\(%s\)\b label) nil t)) (progn (goto-char (point-min)) (re-search-forward (format ^#\+tblname:\s-*\(%s\)\b label) nil t))) nil (org-mark-ring-goto) (error %s not found label)) (message go back with (org-mark-ring-goto) `C-c &`)) | (lambda (keyword desc format) (cond ((eq format (quote html)) (format (<pageref>%s</pageref>) path)) ((eq format (quote latex)) (format \pageref{%s} keyword)))) |
-| ref | (lambda (label) on clicking goto the label. Navigate back with C-c & (org-mark-ring-push) (widen) (if (or (progn (goto-char (point-min)) (re-search-forward (format label:%s\b label) nil t)) (progn (goto-char (point-min)) (re-search-forward (format \label{%s} label) nil t)) (progn (goto-char (point-min)) (re-search-forward (format ^#\+label:\s-*\(%s\)\b label) nil t)) (progn (goto-char (point-min)) (re-search-forward (format ^#\+tblname:\s-*\(%s\)\b label) nil t))) nil (org-mark-ring-goto) (error %s not found label)) (org-show-entry) (message go back with (org-mark-ring-goto) `C-c &`)) | (lambda (keyword desc format) (cond ((eq format (quote html)) (format (<ref>%s</ref>) path)) ((eq format (quote latex)) (format \ref{%s} keyword)))) |
-| label | (lambda (label) on clicking count the number of label tags used in the buffer. A number greater than one means multiple labels! (message (format %s occurences (+ (count-matches (format label:%s\b[^-:] label) (point-min) (point-max) t) (count-matches (format ^#\+tblname:\s-*%s\b[^-:] label) (point-min) (point-max) t) (count-matches (format \label{%s}\b label) (point-min) (point-max) t) (count-matches (format ^#\+label:\s-*%s\b[^-:] label) (point-min) (point-max) t))))) | (lambda (keyword desc format) (cond ((eq format (quote html)) (format (<label>%s</label>) path)) ((eq format (quote latex)) (format \label{%s} keyword)))) |
-| list-of-tables | org-ref-list-of-tables | (lambda (keyword desc format) (cond ((eq format (quote latex)) (format \listoftables)))) |
-| list-of-figures | org-ref-list-of-figures | (lambda (keyword desc format) (cond ((eq format (quote latex)) (format \listoffigures)))) |
-| addbibresource | (lambda (link-string) (let* ((bibfile) (object (org-element-context)) (link-string-beginning) (link-string-end)) (save-excursion (goto-char (org-element-property :begin object)) (search-forward link-string nil nil 1) (setq link-string-beginning (match-beginning 0)) (setq link-string-end (match-end 0))) (set (make-local-variable (quote reftex-default-addbibresource)) (split-string (org-element-property :path object) ,)) (save-excursion (if (search-forward , link-string-end 1 1) (setq key-end (- (match-end 0) 1)) (setq key-end (point)))) (save-excursion (if (search-backward , link-string-beginning 1 1) (setq key-beginning (+ (match-beginning 0) 1)) (setq key-beginning (point)))) (setq bibfile (org-ref-strip-string (buffer-substring key-beginning key-end))) (find-file bibfile))) | (lambda (keyword desc format) (cond ((eq format (quote html)) (format )) ((eq format (quote latex)) (format \addbibresource{%s} keyword)))) |
-| bibliographystyle | (lambda (arg) (message Nothing implemented for clicking here.)) | (lambda (keyword desc format) (cond ((eq format (quote latex)) (format \bibliographystyle{%s} keyword)))) |
-| printbibliography | (lambda (arg) (message Nothing implemented for clicking here.)) | (lambda (keyword desc format) (cond ((eq format (quote org)) (org-ref-get-org-bibliography)) ((eq format (quote html)) (org-ref-get-html-bibliography)) ((eq format (quote latex)) \printbibliography))) |
-| nobibliography | (lambda (link-string) (let* ((bibfile) (object (org-element-context)) (link-string-beginning) (link-string-end)) (save-excursion (goto-char (org-element-property :begin object)) (search-forward link-string nil nil 1) (setq link-string-beginning (match-beginning 0)) (setq link-string-end (match-end 0))) (set (make-local-variable (quote reftex-default-bibliography)) (split-string (org-element-property :path object) ,)) (save-excursion (if (search-forward , link-string-end 1 1) (setq key-end (- (match-end 0) 1)) (setq key-end (point)))) (save-excursion (if (search-backward , link-string-beginning 1 1) (setq key-beginning (+ (match-beginning 0) 1)) (setq key-beginning (point)))) (setq bibfile (org-ref-strip-string (buffer-substring key-beginning key-end))) (find-file bibfile))) | (lambda (keyword desc format) (cond ((eq format (quote org)) (org-ref-get-org-bibliography)) ((eq format (quote ascii)) (org-ref-get-ascii-bibliography)) ((eq format (quote html)) (org-ref-get-html-bibliography)) ((eq format (quote latex)) (format \nobibliography{%s} (replace-regexp-in-string \.bib (mapconcat (quote identity) (mapcar (quote expand-file-name) (split-string keyword ,)) ,)))))) |
-| bibliography | (lambda (link-string) (let* ((bibfile) (object (org-element-context)) (link-string-beginning) (link-string-end)) (save-excursion (goto-char (org-element-property :begin object)) (search-forward link-string nil nil 1) (setq link-string-beginning (match-beginning 0)) (setq link-string-end (match-end 0))) (set (make-local-variable (quote reftex-default-bibliography)) (split-string (org-element-property :path object) ,)) (save-excursion (if (search-forward , link-string-end 1 1) (setq key-end (- (match-end 0) 1)) (setq key-end (point)))) (save-excursion (if (search-backward , link-string-beginning 1 1) (setq key-beginning (+ (match-beginning 0) 1)) (setq key-beginning (point)))) (setq bibfile (org-ref-strip-string (buffer-substring key-beginning key-end))) (find-file bibfile))) | (lambda (keyword desc format) (cond ((eq format (quote org)) (org-ref-get-org-bibliography)) ((eq format (quote ascii)) (org-ref-get-ascii-bibliography)) ((eq format (quote html)) (org-ref-get-html-bibliography)) ((eq format (quote latex)) (format \bibliography{%s} (replace-regexp-in-string \.bib (mapconcat (quote identity) (mapcar (quote expand-file-name) (split-string keyword ,)) ,)))))) |
-| rmail | org-rmail-open | nil |
-| mhe | org-mhe-open | nil |
-| irc | org-irc-visit | nil |
-| info | org-info-open | nil |
-| gnus | org-gnus-open | nil |
-| docview | org-docview-open | org-docview-export |
-| bibtex | org-bibtex-open | nil |
-| bbdb | org-bbdb-open | org-bbdb-export |
-| pydoc | (lambda (link-string) (shell-command (format python -m pydoc %s link-string))) | nil |
-| index | (lambda (path) (tq-index) (occur path)) | nil |
-| attachfile | (lambda (link-string) (org-open-file link-string)) | (lambda (keyword desc format) (cond ((eq format (quote html)) (format )) ((eq format (quote latex)) (format \attachfile{%s} keyword)))) |
-| msx | org-msx-open | nil |
-| id | org-id-open | nil |
-| file+emacs | org-open-file-with-emacs | nil |
-| file+sys | org-open-file-with-system | nil |
-
* Utilities
#+BEGIN_SRC emacs-lisp :tangle org-ref.el
(defun org-ref-bib-citation ()
- "from a bibtex entry, create and return a simple citation string."
+ "From a bibtex entry, create and return a simple citation string.
+This assumes you are in an article."
(bibtex-beginning-of-entry)
(let* ((cb (current-buffer))
(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:
(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))
#+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
(shell-command (concat "pdflatex " bib-base))
(kill-buffer texfile)
(org-open-file pdffile)
- ))
+ ))
#+END_SRC
** Extract bibtex entries cited in an org-file
(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)
(found nil))
(dolist (arg list i)
(if (string-match (concat "^" substring "$") arg)
- (progn
+ (progn
(setq found t)
(return i)))
(setq i (+ i 1)))
(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))
#+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 ()
(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)
(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))
;; 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)
;; 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.
(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.
(save-excursion
(funcall x))))
org-ref-clean-bibtex-entry-hook)
-
+
;; sort fields within entry
(org-ref-sort-bibtex-entry)
;; check for non-ascii characters
(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
(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))
(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
(add-hook 'org-shiftright-hook (lambda () (org-ref-swap-citation-link 1)))
(add-hook 'org-shiftleft-hook (lambda () (org-ref-swap-citation-link -1)))
#+END_SRC
+
+** Lightweight messages about links
+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 add it to a hook that updates after every command, including cursor movements.
+
+ref:test citep:test label:rett
+
+#+BEGIN_SRC emacs-lisp :tangle org-ref.el
+(defun org-ref-get-label-context (label)
+ "Return a string of context around a label."
+ (save-excursion
+ (catch 'result
+ (goto-char (point-min))
+ (when (re-search-forward
+ (format "label:%s\\b" label) nil t)
+ (throw 'result (buffer-substring
+ (progn
+ (previous-line)
+ (beginning-of-line)
+ (point))
+ (progn
+ (forward-line 4)
+ (point)))))
+
+ (goto-char (point-min))
+ (when (re-search-forward
+ (format "\\label{%s}" label) nil t)
+ (throw 'result (buffer-substring
+ (progn
+ (previous-line)
+ (beginning-of-line)
+ (point))
+ (progn
+ (forward-line 4)
+ (point)))))
+
+ (goto-char (point-min))
+ (when (re-search-forward
+ (format "^#\\+label:\\s-*\\(%s\\)\\b" label) nil t)
+ (throw 'result (buffer-substring
+ (progn
+ (previous-line)
+ (beginning-of-line)
+ (point))
+ (progn
+ (forward-line 4)
+ (point)))))
+
+ (goto-char (point-min))
+ (when (re-search-forward
+ (format "^#\\+tblname:\\s-*\\(%s\\)\\b" label) nil t)
+ (throw 'result (buffer-substring
+ (progn
+ (previous-line)
+ (beginning-of-line)
+ (point))
+ (progn
+ (forward-line 4)
+ (point))))))))
+
+
+(defun org-ref-link-message ()
+ "Print a minibuffer message about the link that point is on."
+ (interactive)
+ (let* ((object (org-element-context))
+ (type (org-element-property :type object)))
+
+ (cond
+ ;; cite links
+ ((-contains? org-ref-cite-types type)
+ (message (org-ref-get-citation-string-at-point)))
+
+ ;; message some context about the label we are referring to
+ ((string= type "ref")
+ (message (org-ref-get-label-context
+ (org-element-property :path object))))
+
+ ((string= type "eqref")
+ (message (org-ref-get-label-context
+ (org-element-property :path object))))
+
+ ;; message the count
+ ((string= type "label")
+ (let ((count (org-ref-count-labels
+ (org-element-property :path object))))
+ ;; get plurality on occurrence correct
+ (message (concat
+ (number-to-string count)
+ " occurence"
+ (when (or (= count 0)
+ (> count 1))
+ "s"))))))))
+
+
+(when org-ref-show-citation-on-enter
+ (add-hook 'post-command-hook 'org-ref-link-message))
+#+END_SRC
+
* Aliases
I like convenience. Here are some aliases for faster typing.
(defalias 'orcb 'org-ref-clean-bibtex-entry)
#+END_SRC
+* Helm interface
+[[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.
+
+1. Make the default action to insert selected keys.
+2. Make open entry second action
+#+BEGIN_SRC emacs-lisp :tangle org-ref.el
+(setq helm-source-bibtex
+ '((name . "BibTeX entries")
+ (init . helm-bibtex-init)
+ (candidates . helm-bibtex-candidates)
+ (filtered-candidate-transformer . helm-bibtex-candidates-formatter)
+ (action . (("Insert citation" . helm-bibtex-insert-citation)
+ ("Show entry" . helm-bibtex-show-entry)
+ ("Open PDF file (if present)" . helm-bibtex-open-pdf)
+ ("Open URL or DOI in browser" . helm-bibtex-open-url-or-doi)
+ ("Insert reference" . helm-bibtex-insert-reference)
+ ("Insert BibTeX key" . helm-bibtex-insert-key)
+ ("Insert BibTeX entry" . helm-bibtex-insert-bibtex)
+ ("Attach PDF to email" . helm-bibtex-add-PDF-attachment)
+ ("Edit notes" . helm-bibtex-edit-notes)
+ ))))
+#+END_SRC
+
+Now, let us define a function that inserts the cite links:
+#+BEGIN_SRC emacs-lisp :tangle org-ref.el
+(defun helm-bibtex-format-org-ref (keys)
+ "Insert selected KEYS as cite link. Append KEYS if you are on a link.
+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."
+ (let* ((object (org-element-context)))
+ (cond
+ ;; case where we are in a link
+ ((and (equal (org-element-type object) 'link)
+ (-contains?
+ org-ref-cite-types
+ (org-element-property :type object)))
+ (goto-char (org-element-property :end object))
+ ;; 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))
+ (insert (concat "," (mapconcat 'identity keys ","))))
+
+ ;; We are next to a link, and we want to append
+ ((save-excursion
+ (backward-char)
+ (and (equal (org-element-type (org-element-context)) 'link)
+ (-contains?
+ org-ref-cite-types
+ (org-element-property :type (org-element-context)))))
+ (goto-char (org-element-property :end object))
+ (while (looking-back " ") (backward-char))
+ (insert (concat "," (mapconcat 'identity keys ","))))
+
+ ;; insert fresh link
+ (t
+ (insert
+ (concat (if helm-current-prefix-arg
+ (ido-completing-read "Type: " org-ref-cite-types)
+ org-ref-default-citation-link)
+ ":"
+ (s-join "," keys))))))
+;; return empty string for helm
+"")
+
+(setq helm-bibtex-format-citation-functions
+ '((org-mode . helm-bibtex-format-org-ref)))
+
+(defun org-ref-helm-insert-cite-link ()
+ "org-ref function to use helm on the bibliography defined in the org-file."
+ (interactive)
+ (let ((helm-bibtex-bibliography (org-ref-find-bibliography)))
+ (helm-bibtex)))
+
+(require 'helm-bibtex)
+#+END_SRC
+
+** A helm click menu
+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.
+#+BEGIN_SRC emacs-lisp :tangle org-ref.el
+(defun org-ref-get-citation-string-at-point ()
+ "Get a string of a formatted citation"
+ (interactive)
+ (let* ((results (org-ref-get-bibtex-key-and-file))
+ (key (car results))
+ (bibfile (cdr results)))
+ (save-excursion
+ (with-temp-buffer
+ (insert-file-contents bibfile)
+ (bibtex-search-entry key)
+ (org-ref-bib-citation)))))
+
+(defun org-ref-cite-candidates ()
+ "Generate the list of possible candidates for click actions on a cite link.
+Checks for pdf and doi, and add appropriate functions."
+ (interactive)
+ (let* ((results (org-ref-get-bibtex-key-and-file))
+ (key (car results))
+ (pdf-file (format (concat org-ref-pdf-directory "%s.pdf") key))
+ (bibfile (cdr results))
+ (url (save-excursion
+ (with-temp-buffer
+ (insert-file-contents bibfile)
+ (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
+ (bibtex-autokey-get-field "doi"))))
+ (candidates `(("Quit" . org-ref-citation-at-point)
+ ("Open bibtex entry" . org-ref-open-citation-at-point))))
+ ;; for some reason, when there is no doi or url, they are returned as "". I
+ ;; prefer nil so we correct this here.
+ (when (string= doi "") (setq doi nil))
+ (when (string= url "") (setq url nil))
+
+ ;; Conditional pdf functions
+ (if (file-exists-p pdf-file)
+ (add-to-list
+ 'candidates
+ '("Open pdf" . org-ref-open-pdf-at-point)
+ t)
+ (add-to-list
+ 'candidates
+ '("Try to get pdf" . (lambda ()
+ (save-window-excursion
+ (org-ref-open-citation-at-point)
+ (bibtex-beginning-of-entry)
+ (doi-utils-get-bibtex-entry-pdf))))
+ t))
+
+
+ (add-to-list
+ 'candidates
+ '("Open notes" . org-ref-open-notes-at-point)
+ t)
+
+ ;; conditional url and doi functions
+ (when (or url doi)
+ (add-to-list
+ 'candidates
+ '("Open in browser" . org-ref-open-url-at-point)
+ t))
+
+ (when doi
+ (mapc (lambda (x)
+ (add-to-list 'candidates x t))
+ `(("WOS" . org-ref-wos-at-point)
+ ("Related articles in WOS" . org-ref-wos-related-at-point)
+ ("Citing articles in WOS" . org-ref-wos-citing-at-point)
+ ("Google Scholar" . org-ref-google-scholar-at-point)
+ ("Pubmed" . org-ref-pubmed-at-point)
+ ("Crossref" . org-ref-crossref-at-point)
+ )))
+
+ (add-to-list
+ 'candidates
+ '("Copy formatted citation to clipboard" . org-ref-copy-entry-as-summary)
+ t)
+
+ (add-to-list
+ 'candidates
+ '("Copy key to clipboard" . (lambda ()
+ (kill-new
+ (car (org-ref-get-bibtex-key-and-file)))))
+ t)
+
+ (add-to-list
+ 'candidates
+ '("Copy bibtex entry to file" . org-ref-copy-entry-at-point-to-file)
+ t)
+
+ (add-to-list
+ 'candidates
+ '("Email bibtex entry and pdf" . (lambda ()
+ (save-excursion
+ (org-ref-open-citation-at-point)
+ (email-bibtex-entry))))
+ t)
+ ;; finally return a numbered list of the candidates
+ (loop for i from 0
+ for cell in candidates
+ collect (cons (format "%2s. %s" i (car cell))
+ (cdr cell)))))
+
+
+(defvar org-ref-helm-user-candidates '()
+ "List of user-defined candidates to act when clicking on a cite link.
+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.
+")
+
+;; example of adding your own function
+(add-to-list
+ 'org-ref-helm-user-candidates
+ '("Example" . (lambda () (message-box "You did it!")))
+ t)
+
+(defun org-ref-cite-click-helm (key)
+ "subtle points.
+1. get name and candidates before entering helm because we need the org-buffer.
+2. switch back to the org buffer before evaluating the action. most of them need the point and buffer."
+ (interactive)
+ (let ((name (org-ref-get-citation-string-at-point))
+ (candidates (org-ref-cite-candidates))
+ (cb (current-buffer)))
+
+ (helm :sources `(((name . ,name)
+ (candidates . ,candidates)
+ (action . (lambda (f)
+ (switch-to-buffer cb)
+ (funcall f))))
+ ((name . "User functions")
+ (candidates . ,org-ref-helm-user-candidates)
+ (action . (lambda (f)
+ (switch-to-buffer cb)
+ (funcall f))))
+ ))))
+#+END_SRC
+
+#+RESULTS:
+: org-ref-cite-click-helm
+
* End of code
#+BEGIN_SRC emacs-lisp :tangle org-ref.el
(provide 'org-ref)
Alternatively you may use:
[[elisp:(org-babel-load-file "org-ref.org")]]
-
-
-
projects / org-ref.git / blobdiff