4. Exportable links to LaTeX
5. Utility functions for dealing with bibtex files and org-files
+Some additional features include
+1. Get minibuffer messages for the cite/ref/label link under point
+
+With helm integration (default) you can:
+
+1. C-c ] to insert a citation link
+ in helm-bibtex
+ - Enter to insert or append citation(s)
+ - C-u Enter to insert an alternative cite link
+ - C-u C-u Enter to replace the citation at point
+2. C-u C-c ] to insert a ref link with helm completion
+3. C-u C-u C-c ] to insert a label with completion
+4. M-x org-ref to get a helm completion buffer with link checks, utilities and export options
+
** Header
#+BEGIN_SRC emacs-lisp :tangle org-ref.el
;;; org-ref.el --- setup bibliography, cite, ref and label org-mode links.
(require 'reftex-cite)
(require 'dash)
(require 'helm)
+(require 'helm-config)
(require 'helm-bibtex)
#+END_SRC
(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."
+ "Function that runs when you click on a cite link. The function must take no arguments. You may also use `org-ref-cite-onclick-minibuffer-menu' if you do not like helm. If you like `hydra', consider using `org-ref-cite-hydra'."
: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"
(kbd org-ref-insert-cite-key)
org-ref-insert-cite-function)
-(when org-ref-show-citation-on-enter
- (setq org-ref-message-timer
- (run-with-idle-timer 0.5 t 'org-ref-link-message)))
-
-(defun org-ref-show-link-messages ()
- "Turn on link messages. You will see a message in the
-minibuffer when on a cite, ref or label link."
- (interactive)
- (setq org-ref-message-timer
- (run-with-idle-timer 0.5 t 'org-ref-link-message))
- )
-(defun org-ref-cancel-link-messages ()
- "Stop showing messages in minibuffer when on a link."
- (interactive)
- (cancel-timer org-ref-message-timer))
-
-;; this approach caused the selected region to not be highlighted any more.
-; (add-hook 'post-command-hook 'org-ref-link-message))
-; (remove-hook 'post-command-hook 'org-ref-link-message))
-
(add-hook 'org-mode-hook 'org-mode-reftex-setup)
(eval-after-load 'reftex-vars
(org-ref-define-citation-link "citez" ?z)
#+END_SRC
+** Messages for link at cursor
+Here we setup code that shows you a context message for the element under the cursor when emacs is idle.
+#+BEGIN_SRC emacs-lisp :tangle org-ref.el
+(defvar org-ref-message-timer nil
+ "Variable to store the link message timer in.")
+
+
+(defun org-ref-show-link-messages ()
+ "Turn on link messages. You will see a message in the
+minibuffer when on a cite, ref or label link."
+ (interactive)
+ (or org-ref-message-timer
+ (setq org-ref-message-timer
+ (run-with-idle-timer 0.5 t 'org-ref-link-message))))
+
+
+(defun org-ref-cancel-link-messages ()
+ "Stop showing messages in minibuffer when on a link."
+ (interactive)
+ (cancel-timer org-ref-message-timer)
+ (setq org-ref-message-timer nil))
+
+
+(when org-ref-show-citation-on-enter
+ (org-ref-show-link-messages))
+
+;; this approach caused the selected region to not be highlighted any more.
+; (add-hook 'post-command-hook 'org-ref-link-message))
+; (remove-hook 'post-command-hook 'org-ref-link-message))
+#+END_SRC
+
+** Messages for context under mouse pointer
+Sometimes, when reading a document, I actually use the mouse more than the cursor. This code enables the mouse cursor to trigger a message in the minibuffer about what is under the cursor. I run this on a timer.
+
+The basic idea here is to get the mouse position, and if we can determine there is a character that (point) can move to, we move (point) and run the org-ref-link-message function. Since this runs on a timer, we store the last mouse position, and only run the function when the mouse has moved to avoid getting messages every time the timer runs.
+
+#+BEGIN_SRC emacs-lisp :tangle org-ref.el
+(defvar org-ref-last-mouse-pos nil
+ "Stores last mouse position for use in `org-ref-mouse-message'.")
+
+(defun org-ref-can-move-p ()
+ "See if a character is under the mouse. If so return the position for `goto-char'."
+ (let* ((line (cddr org-ref-last-mouse-pos))
+ (col (cadr org-ref-last-mouse-pos)))
+ (save-excursion
+ (goto-char (window-start))
+ (forward-line line)
+ (if
+ (> (- (line-end-position) (line-beginning-position)) col)
+ (progn (forward-char col) (point))
+ nil))))
+
+
+(defun org-ref-mouse-message ()
+ "Display message for link under mouse cursor"
+ (interactive)
+ (when (not (equal (mouse-position) org-ref-last-mouse-pos))
+ (setq org-ref-last-mouse-pos (mouse-position))
+ (let ((p (org-ref-can-move-p)))
+ (when p
+ (save-excursion
+ (goto-char p)
+ (org-ref-link-message))))))
+
+
+(defvar org-ref-message-timer-mouse nil
+ "Store mouse timer.")
+
+
+(defvar org-ref-mouse-message-interval 0.5
+ "How often to run the mouse message timer in seconds")
+
+
+(defun org-ref-mouse-messages-on ()
+ "Turn on mouse messages."
+ (interactive)
+ (or org-ref-message-timer-mouse
+ (setq org-ref-message-timer-mouse
+ (run-at-time "0.5 sec"
+ org-ref-mouse-message-interval
+ 'org-ref-mouse-message))))
+
+
+(defun org-ref-mouse-messages-off ()
+ "Turn off mouse messages"
+ (interactive)
+ (cancel-timer org-ref-message-timer-mouse)
+ (setq org-ref-message-timer-mouse nil)
+ (message "Mouse messages are off"))
+#+END_SRC
+
+#+RESULTS:
+: org-ref-mouse-messages-off
+
+** Color-coded links
+Here we make the org-ref links a different color.
+
+citations are green
+refs are blue
+labels are black
+
+mailto:john
+
+cite:sokalski-2012-optim-ta,zhang-2011-spatial-tio2,li-2012-heter-ceram,li-2013-photoc
+
+cite*:sokalski-2012-optim-ta,zhang-2011-spatial-tio2,li-2012-heter-ceram,li-2013-photoc
+
+citenum:sokalski-2012-optim-ta,zhang-2011-spatial-tio2,li-2012-heter-ceram,li-2013-photoc
+
+ref:test
+
+label:test
+
+#+BEGIN_SRC emacs-lisp :tangle org-ref.el
+(defcustom org-ref-colorize-links
+ t
+ "When non-nil, change colors of links"
+ :group 'org-ref)
+
+
+(defcustom org-ref-cite-color
+ "forest green"
+ "Color of cite like links"
+ :group 'org-ref)
+
+
+(defcustom org-ref-ref-color
+ "dark red"
+ "Color of ref like links"
+ :group 'org-ref)
+
+
+(defcustom org-ref-label-color
+ "dark magenta"
+ "Color of label links"
+ :group 'org-ref)
+
+
+(defvar org-ref-cite-re nil
+ "regexp for cite links")
+
+
+(setq org-ref-cite-re
+ (concat "\\(" (mapconcat
+ (lambda (x)
+ (replace-regexp-in-string "\*" "\\\\*" x)
+ )
+ org-ref-cite-types "\\|") "\\)"
+ ":\\([a-zA-Z0-9-_:]*,?\\)*"))
+
+
+(setq org-ref-label-re
+ "label:\\([a-zA-Z0-9-_:]*,?\\)*")
+
+
+(setq org-ref-ref-re
+ "ref:\\([a-zA-Z0-9-_:]*,?\\)*")
+
+
+(defface org-ref-cite-face
+ `((t (:inherit org-link :foreground ,org-ref-cite-color)))
+ "Color for cite-like links in org-ref.")
+
+
+(defface org-ref-label-face
+ `((t (:inherit org-link :foreground ,org-ref-label-color)))
+ "Color for ref links in org-ref.")
+
+
+(defface org-ref-ref-face
+ `((t (:inherit org-link :foreground ,org-ref-ref-color)))
+ "Face for ref links in org-ref.")
+
+
+(defun org-ref-colorize-links ()
+ "Colorize org-ref links."
+ (hi-lock-mode 1)
+ (highlight-regexp org-ref-cite-re 'org-ref-cite-face)
+ (highlight-regexp org-ref-label-re 'org-ref-label-face)
+ (highlight-regexp org-ref-ref-re 'org-ref-ref-face))
+
+
+(when org-ref-colorize-links
+ (add-hook 'org-mode-hook 'org-ref-colorize-links))
+#+END_SRC
+
+#+RESULTS:
+
+
* Links
Most of this library is the creation of functional links to help with references and citations.
** General utilities
#+BEGIN_SRC emacs-lisp :tangle org-ref.el
(defun org-ref-get-bibtex-keys ()
- "return a list of unique keys in the buffer."
+ "Return a list of unique keys in the buffer."
(let ((keys '()))
(org-element-map (org-element-parse-buffer) 'link
(lambda (link)
(key
(org-ref-split-and-strip-string (plist-get plist ':path)))
(when (not (-contains? keys key))
- (setq keys (append keys (list key)))))))))
+ (setq keys (append keys (list key))))))))
+ ;; set with-affiliated to get keys in captions
+ nil nil nil t)
;; Sort keys alphabetically
(setq keys (cl-sort keys 'string-lessp :key 'downcase))
keys))
#+BEGIN_SRC emacs-lisp :tangle org-ref.el
(defun org-ref-count-labels (label)
"Counts number of matches for label in the document"
- (+ (count-matches (format "label:%s\\b[^-:]" label) (point-min) (point-max) t)
+ (+ (count-matches (format "label:%s\\b[^-:]" label) (point-min) (point-max))
;; 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)
+ (count-matches (format "^#\\+tblname:\\s-*%s\\b[^-:]" label) (point-min) (point-max))
+ (count-matches (format "\\label{%s}" label) (point-min) (point-max))
;; this is the org-format #+label:
- (count-matches (format "^#\\+label:\\s-*%s\\b[^-:]" label) (point-min) (point-max) t)
+ (count-matches (format "^#\\+label:\\s-*%s\\b[^-:]" label) (point-min) (point-max))
(let ((custom-id-count 0))
(org-map-entries
(lambda ()
- (when (string= label (org-entry-get (point) "CUSTOM_ID"))
+ (when (string= label (org-entry-get (point) "CUSTOM_ID"))
(setq custom-id-count (+ 1 custom-id-count)))))
custom-id-count)))
"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" (org-ref-count-labels label))))
+ (let ((count (org-ref-count-labels label)))
+ (message (format "%s occurence%s"
+ count
+ (if (or (= count 0)
+ (> count 1))
+ "s"
+ ""))
+ (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-ref-get-org-labels ()
- "find #+LABEL: labels"
+ "Return a list of #+LABEL: labels."
(save-excursion
(goto-char (point-min))
(let ((matches '()))
#+BEGIN_SRC emacs-lisp :tangle org-ref.el
(defun org-ref-get-custom-ids ()
- "return a list of custom_id properties in the buffer"
+ "Return a list of custom_id properties in the buffer."
(let ((results '()) custom_id)
(org-map-entries
(lambda ()
#+BEGIN_SRC emacs-lisp :tangle org-ref.el
(defun org-ref-get-tblnames ()
+ "Return list of table names in the buffer."
(org-element-map (org-element-parse-buffer 'element) 'table
(lambda (table)
(org-element-property :name table))))
#+BEGIN_SRC emacs-lisp :tangle org-ref.el
(defun org-ref-get-labels ()
- "returns a list of labels in the buffer that you can make a ref link to. this is used to auto-complete ref links."
+ "Returns a list of labels in the buffer that you can make a ref link to.
+This is used to auto-complete ref links and in helm menus."
(save-excursion
(save-restriction
(widen)
(goto-char (point-min))
(let ((matches '()))
- (while (re-search-forward "label:\\([a-zA-z0-9:-]*\\)" (point-max) t)
+ ;; these are the label:stuff kinds
+ (while (re-search-forward "[^#+]label:\\([a-zA-z0-9:-]*\\)" (point-max) t)
(add-to-list 'matches (match-string-no-properties 1) t))
- (append matches (org-ref-get-org-labels) (org-ref-get-latex-labels) (org-ref-get-tblnames) (org-ref-get-custom-ids))))))
+ (append matches
+ (org-ref-get-org-labels)
+ (org-ref-get-latex-labels)
+ (org-ref-get-tblnames)
+ (org-ref-get-custom-ids))))))
#+END_SRC
-Let us make a helm function to insert a label link. This will help you enter unique labels.
+Let us make a helm function to insert a label link. This will help you enter unique labels by showing matching labels until they are all gone and you are left with a unique one. If you are on a link, it means you want to replace it.
#+BEGIN_SRC emacs-lisp :tangle org-ref.el
(defun org-ref-helm-insert-label-link ()
- "Insert a label link. helm just shows you what labels already exist."
+ "Insert a label link. helm just shows you what labels already exist.
+If you are on a label link, replace it."
(interactive)
(let* ((labels (org-ref-get-labels))
(cb (current-buffer)))
(helm :sources `(((name . "Existing labels")
(candidates . ,labels)
+ ;; default action is to open to the label
(action . (lambda (label)
;; unfortunately I do not have markers here
- (org-open-link-from-string (format "ref:%s" label)))))
+ (org-open-link-from-string (format "ref:%s" label))))
+ ;; if you select a label, replace current one
+ (action . (lambda (label)
+ (switch-to-buffer ,cb)
+ (cond
+ ;; no prefix or on a link
+ ((equal helm-current-prefix-arg nil)
+ (let* ((object (org-element-context))
+ (last-char (save-excursion
+ (goto-char (org-element-property :end object))
+ (backward-char)
+ (if (looking-at " ")
+ " "
+ ""))))
+ (when (-contains? '("label")
+ (org-element-property :type object))
+ ;; we are on a link, so replace it.
+ (setf
+ (buffer-substring
+ (org-element-property :begin object)
+ (org-element-property :end object))
+ (concat
+ (replace-regexp-in-string
+ (org-element-property :path object)
+ label
+ (org-element-property :raw-link object))
+ last-char)))))
+ ;; no prefix options defined
+ ))))
+ ;; no matching selection creates a new label
((name . "Create new label")
(dummy)
+ ;; default action creates a new label, or replaces old one
(action . (lambda (label)
(switch-to-buffer ,cb)
- (insert
- (concat
- "label:"
- (or label
- helm-pattern))))))))))
-#+END_SRC
-
-Now we create the completion function. This works from the org-machinery, e.g. if you type C-c C-l to insert a link, and use completion by pressing tab.
+ (let* ((object (org-element-context))
+ (last-char (save-excursion
+ (goto-char (org-element-property :end object))
+ (backward-char)
+ (if (looking-at " ")
+ " "
+ ""))))
+ (if (-contains? '("label")
+ (org-element-property :type object))
+ ;; we are on a link, so replace it.
+ (setf
+ (buffer-substring
+ (org-element-property :begin object)
+ (org-element-property :end object))
+ (concat
+ (replace-regexp-in-string
+ (org-element-property :path object)
+ helm-pattern
+ (org-element-property :raw-link object))
+ last-char))
+ ;; new link
+ (insert
+ (concat
+ "label:"
+ (or label
+ helm-pattern))))))))))))
+#+END_SRC
+
+Now we create a completion function. This works from the org-machinery, e.g. if you type C-c C-l to insert a link, and use completion by pressing tab.
#+BEGIN_SRC emacs-lisp :tangle org-ref.el
(defun org-ref-complete-link (&optional arg)
#+BEGIN_SRC emacs-lisp :tangle org-ref.el
(defun org-ref-helm-insert-ref-link ()
"Helm menu to insert ref links to labels in the document.
-Use C-u to insert a different kind of ref link."
+If you are on link, replace with newly selected label.
+Use C-u to insert a different kind of ref link.
+Use C-u C-u to insert a [[#custom-id]] link
+"
(interactive)
(let* ((labels (org-ref-get-labels))
- (contexts (mapcar 'org-ref-get-label-context labels))
+ (bs (buffer-string))
+ (contexts (with-temp-buffer
+ (insert bs)
+ (mapcar 'org-ref-get-label-context labels)))
(cb (current-buffer)))
- (helm :sources `(((name . "Available labels to ref")
+ (helm :input (thing-at-point 'word)
+ :sources `(((name . "Available labels to ref")
(candidates . ,(loop for label in labels
for context in contexts
-;; we do some kludgy adding spaces and bars to make it "easier" to see in helm.
+ ;; we do some kludgy adding spaces
+ ;; and bars to make it "easier" to
+ ;; see in helm.
collect (cons (concat
label "\n"
(mapconcat
(split-string context "\n")
"\n"
) "\n\n") label)))
+ ;; default action to replace or insert ref link.
(action . (lambda (label)
(switch-to-buffer ,cb)
- (insert
- (concat
- (if helm-current-prefix-arg
- (helm :sources '((name . "Ref link types")
- (candidates . ("ref" "eqref" "pageref" "nameref"))
- (action . (lambda (x) x))))
- "ref")
- ":" label)))))))))
+
+ (cond
+ ;; no prefix or on a link
+ ((equal helm-current-prefix-arg nil)
+ (let* ((object (org-element-context))
+ (last-char (save-excursion
+ (goto-char (org-element-property :end object))
+ (backward-char)
+ (if (looking-at " ")
+ " "
+ ""))))
+ (if (-contains? '("ref" "eqref" "pageref" "nameref")
+ (org-element-property :type object))
+ ;; we are on a link, so replace it.
+ (setf
+ (buffer-substring
+ (org-element-property :begin object)
+ (org-element-property :end object))
+ (concat
+ (replace-regexp-in-string
+ (org-element-property :path object)
+ label
+ (org-element-property :raw-link object))
+ last-char))
+ ;; insert a new link
+ (insert
+ (concat
+ "ref:" label))
+ )))
+ ;; one prefix, alternate ref link
+ ((equal helm-current-prefix-arg '(4))
+ (insert
+ (concat
+ (helm :sources '((name . "Ref link types")
+ (candidates . ("ref" "eqref" "pageref" "nameref"))
+ (action . (lambda (x) x))))
+ ":" label)))
+ ;; two prefixes, insert section custom-id link
+ ((equal helm-current-prefix-arg '(16))
+ (insert
+ (format "[[#%s]]" label)))
+ ))
+ ))))))
#+END_SRC
#+RESULTS:
#+BEGIN_SRC emacs-lisp :tangle org-ref.el
(defun org-ref-key-in-file-p (key filename)
"determine if the key is in the file"
- (interactive "skey: \nsFile: ")
(save-current-buffer
(let ((bibtex-files (list filename)))
+ ;; This is something I am trying because when the bibtex file is open, and
+ ;; you have added to it, the only way I find to get the update to update
+ ;; is to close it and reopen it. or to save it and revert it.
+ (when (get-file-buffer filename)
+ (set-buffer (get-file-buffer filename))
+ (save-buffer)
+ (revert-buffer t t))
(bibtex-search-entry key t))))
#+END_SRC
(catch 'done
(let ((url (bibtex-autokey-get-field "url")))
(when url
- (browse-url url)
+ (browse-url (s-trim url))
(throw 'done nil)))
(let ((doi (bibtex-autokey-get-field "doi")))
(when doi
(if (string-match "^http" doi)
(browse-url doi)
- (browse-url (format "http://dx.doi.org/%s" doi)))
+ (browse-url (format "http://dx.doi.org/%s" (s-trim doi))))
(throw 'done nil))))))))
;; bibtex format
(concat "\\" ,type (when desc (org-ref-format-citation-description desc)) "{"
(mapconcat (lambda (key) key) (org-ref-split-and-strip-string keyword) ",")
- "}"))))))
+ "}")))
+ ;; for markdown we generate pandoc citations
+ ((eq format 'md)
+ (cond
+ (desc ;; pre and or post text
+ (let* ((text (split-string desc "::"))
+ (pre (car text))
+ (post (cadr text)))
+ (concat
+ (format "[@%s," keyword)
+ (when pre (format " %s" pre))
+ (when post (format ", %s" post))
+ "]")))
+ (t
+ (format "[%s]"
+ (mapconcat
+ (lambda (key) (concat "@" key))
+ (org-ref-split-and-strip-string keyword)
+ "; "))))))))
#+END_SRC
*************** TODO document how to get the cookies
*************** END
-
-#+BEGIN_SRC python :tangle upload_bibtex_citeulike.py
+# :tangle upload_bibtex_citeulike.py
+#+BEGIN_SRC python
#!python
import pickle, requests, sys
(org-element-map (org-element-parse-buffer) '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 (-contains? org-ref-cite-types (plist-get plist :type))
+ (dolist (key (org-ref-split-and-strip-string (plist-get plist :path)))
(when (not (index key bibtex-keys))
- (setq bad-citations (append bad-citations
- `(,(format "%s [[elisp:(progn (switch-to-buffer-other-frame \"%s\")(goto-char %s))][not found here]]\n"
- key (buffer-name)(plist-get plist ':begin)))))
- ))))))
+ (message-box "%s" link)
+ (setq
+ bad-citations
+ (append
+ bad-citations
+ `(,(format "%s [[elisp:(progn (switch-to-buffer-other-frame \"%s\")(goto-char %s))][not found here]]\n"
+ key
+ (buffer-name)
+ (plist-get plist :begin)))))
+ )))))
+ ;; set with-affilates to t to get citations in a caption
+ nil nil nil t)
(if bad-citations
(progn
(org-element-map (org-element-parse-buffer) 'link
(lambda (link)
(let ((plist (nth 1 link)))
- (when (-contains? org-ref-cite-types (plist-get plist ':type))
- (dolist (key (org-ref-split-and-strip-string (plist-get plist ':path)) )
+ (when (-contains? org-ref-cite-types (plist-get plist :type))
+ (dolist (key (org-ref-split-and-strip-string (plist-get plist :path)) )
(when (not (index key bibtex-keys))
- (goto-char (plist-get plist ':begin))
+ (goto-char (plist-get plist :begin))
(re-search-forward key)
(push (cons key (point-marker)) bad-citations)))
- ))))
+ )))
+ ;; add with-affiliates to get cites in caption
+ nil nil nil t)
(goto-char cp)
bad-citations))
-;; It seems I forgot I already defined this earlier!
-;; (defun org-ref-get-labels ()
-;; "Returns a list of known labels in the org document. These include label links, latex labels, label tags, and table names. The list contains all labels, not just unique ones.
-;; "
-;; (let ((cp (point))
-;; (labels '()))
-;; (goto-char (point-min))
-;; (while (re-search-forward "[^#+]label:\\(.*\\)\\s-" nil t)
-;; (push (match-string 1) labels))
-
-;; (goto-char (point-min))
-;; (while (re-search-forward "\\label{\\(.*\\)}\\s-?" nil t)
-;; (push (match-string 1) labels))
-
-;; (goto-char (point-min))
-;; (while (re-search-forward "^#\\+label:\\s-*\\(.*\\)" nil t)
-;; (push (match-string 1) labels))
-
-;; (goto-char (point-min))
-;; (while (re-search-forward "^#\\+tblname:\\s-*\\(.*\\)" nil t)
-;; (push (match-string 1) labels))
-;; ;; check for CUSTOM_ID
-;; (org-map-entries
-;; (lambda ()
-;; (when (org-entry-get (point) "CUSTOM_ID")
-;; (push (org-entry-get (point) "CUSTOM_ID") labels))))
-;; ;; return to original place
-;; (goto-char cp)
-;; labels))
-
(defun org-ref-bad-ref-candidates ()
"Returns a list of conses (ref . marker) where ref is a ref link that does not point to anything (i.e. a label)."
(progn
(forward-line 4)
(point)))))
-
- ;; maybe we have a CUSTOM-ID
- (org-map-entries
- (lambda () (when (string=
- label
- (org-entry-get (point) "CUSTOM_ID"))
- (throw 'result (org-get-heading)))))
- (beep)
(throw 'result "!!! NO CONTEXT FOUND !!!"))))
;; message some context about the label we are referring to
((string= type "ref")
- (message (org-ref-get-label-context
- (org-element-property :path object))))
+ (message "%scount: %s"
+ (org-ref-get-label-context
+ (org-element-property :path object))
+ (org-ref-count-labels
+ (org-element-property :path object))))
((string= type "eqref")
- (message (org-ref-get-label-context
- (org-element-property :path object))))
+ (message "%scount: %s"
+ (org-ref-get-label-context
+ (org-element-property :path object))
+ (org-ref-count-labels
+ (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
- (when (> count 1) (beep))
(message (concat
(number-to-string count)
" occurence"
(> count 1))
"s")))))
+ ((string= type "custom-id")
+ (save-excursion
+ (org-open-link-from-string
+ (format "[[#%s]]" (org-element-property :path object)))
+ (message "%s" (org-get-heading))))
+
;; check if the bibliography files exist.
((string= type "bibliography")
(let* ((bibfile)
(link-string (org-element-property :path object))
(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)))
+ ;; make sure we are in link and not before the :
+ (when (> link-string-beginning (point))
+ (goto-char link-string-beginning))
+
;; now if we have comma separated bibliographies
;; we find the one clicked on. we want to
;; search forward to next comma from point
(save-excursion
- (goto-char link-string-beginning)
(if (search-forward "," link-string-end 1 1)
(setq key-end (- (match-end 0) 1)) ; we found a match
(setq key-end (point)))) ; no comma found so take the point
+
;; and backward to previous comma from point
(save-excursion
- (goto-char link-string-beginning)
(if (search-backward "," link-string-beginning 1 1)
(setq key-beginning (+ (match-beginning 0) 1)) ; we found a match
(setq key-beginning (point)))) ; no match found
(buffer-substring key-beginning key-end)))
(if (file-exists-p bibfile)
(message "%s exists." bibfile)
- (beep)
(message "!!! %s NOT FOUND !!!" bibfile))))
)))))
#+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.
+Let us add keywords as a searchable field.
+#+BEGIN_SRC emacs-lisp
+(setq helm-bibtex-additional-search-fields '(keywords))
+#+END_SRC
+
+Next, we are going to add keywords to the helm interface. This modifies the helm-bibtex function to add our keywords.
+#+BEGIN_SRC emacs-lisp
+(defun helm-bibtex-candidates-formatter (candidates source)
+ "Formats BibTeX entries for display in results list."
+ (cl-loop
+ with width = (with-helm-window (window-width))
+ for entry in candidates
+ for entry = (cdr entry)
+ for entry-key = (helm-bibtex-get-value entry 'entry-key)
+ for fields = (--map (helm-bibtex-clean-string
+ (helm-bibtex-get-value entry it " "))
+ '(author title year has-pdf has-note entry-type))
+ for fields = (-update-at 0 'helm-bibtex-shorten-authors fields)
+ for fields = (append fields
+ (list (or (helm-bibtex-get-value entry 'keywords)
+ "" )))
+ collect
+ (cons (s-format "$0 $1 $2 $3 $4$5 $6" 'elt
+ (-zip-with (lambda (f w) (truncate-string-to-width f w 0 ?\s))
+ fields (list 36 (- width 85) 4 1 1 7 7)))
+ entry-key)))
+
+#+END_SRC
+
+Next, we add some functions to add keywords to a bibtex entry using a helm interface, and a new action to add keywords to entries from helm-bibtex.
+#+BEGIN_SRC emacs-lisp
+;; adapted from bibtex-utils.el
+;; these are candidates for selecting keywords/tags
+(defun org-ref-bibtex-keywords ()
+ "Get keywords defined in current bibtex file.
+These are in the keywords field, and are comma or semicolon separated."
+ (save-excursion
+ (goto-char (point-min))
+ (let (keywords kstring)
+ (while (re-search-forward "^\\s-*keywords.*{\\([^}]+\\)}" nil t)
+ ;; TWS - remove newlines/multiple spaces:
+ (setq kstring (replace-regexp-in-string "[ \t\n]+" " " (match-string 1)))
+ (mapc
+ (lambda (v)
+ (add-to-list 'keywords v t))
+ (split-string kstring "\\(,\\|;\\)[ \n]*\\|{\\|}" t)))
+ keywords)))
+
+
+(defun org-ref-set-bibtex-keywords (keywords)
+ "Add KEYWORDS to a bibtex entry.
+If KEYWORDS is a list, it is converted to a comma-separated string. The KEYWORDS are added to the beginning of the field. Otherwise KEYWORDS should be a string."
+ (interactive "sKeywords: ")
+ (bibtex-set-field
+ "keywords"
+ (concat
+ (if (listp keywords)
+ (mapconcat 'identity keywords ", ")
+ keywords)
+ (when (not (string= "" (bibtex-autokey-get-field "keywords")))
+ (concat ", " (bibtex-autokey-get-field "keywords")))))
+ (save-buffer))
+
+
+(defun helm-tag-bibtex-entry ()
+ "Helm interface to add keywords to a bibtex entry.
+Run this with the point in a bibtex entry."
+ (interactive)
+ (let ((keyword-source `((name . "Existing keywords")
+ (candidates . ,(org-ref-bibtex-keywords))
+ (action . (lambda (candidate)
+ (org-ref-set-bibtex-keywords
+ (mapconcat
+ 'identity
+ (helm-marked-candidates)
+ ", "))))))
+ (fallback-source `((name . "Add new keywords")
+ (dummy)
+ (action . (lambda (candidate)
+ (org-ref-set-bibtex-keywords helm-pattern)
+ )))))
+ (helm :sources '(keyword-source fallback-source))))
+
+
+(defun org-ref-helm-tag-entries (candidates)
+ "Set tags on selected bibtex entries from helm-bibtex.
+User is prompted for tags. This function is called from `helm-bibtex'."
+ (let ((keywords (read-input "Keywords (comma separated): ")))
+ (loop for key in (helm-marked-candidates)
+ do
+ (save-window-excursion
+ (helm-bibtex-show-entry key)
+ (bibtex-set-field
+ "keywords"
+ (concat
+ keywords
+ ", " (bibtex-autokey-get-field "keywords")))
+ (save-buffer)))))
+#+END_SRC
+
+Next, adapt the helm-bibtex source with these features:
+
1. Make the default action to insert selected keys.
2. Make open entry second action
+3. Add some features for adding keywords to bibtex entries.
+
#+BEGIN_SRC emacs-lisp :tangle org-ref.el
(setq helm-source-bibtex
'((name . "BibTeX entries")
("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 formatted 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)
+ ("Add keywords to entries" . org-ref-helm-tag-entries)
))))
#+END_SRC
C-u C-u will change the key at point to the selected keys.
"
- (let* ((object (org-element-context)))
+ (let* ((object (org-element-context))
+ (last-char (save-excursion
+ (goto-char (org-element-property :end object))
+ (backward-char)
+ (if (looking-at " ")
+ " "
+ ""))))
(cond
;; case where we are in a link
((and (equal (org-element-type object) 'link)
(replace-regexp-in-string
(car (org-ref-get-bibtex-key-and-file)) ; key
(mapconcat 'identity keys ",") ; new keys
- (org-element-property :raw-link object)
- )
+ (org-element-property :raw-link object))
;; replace space at end to avoid collapsing into next word.
- " ")))
+ last-char))
+ ;; and we want to go to the end of the new link
+ (goto-char
+ (org-element-property :end (org-element-context))))
(t
(message "Not found"))))
(-contains?
org-ref-cite-types
(org-element-property :type (org-element-context)))))
- ;;(message-box "at end of a link")
- ;; (goto-char (org-element-property :end object))
(while (looking-back " ") (backward-char))
(insert (concat "," (mapconcat 'identity keys ","))))
(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)))
+(defun org-ref-helm-insert-cite-link (arg)
+ "org-ref function to use helm-bibtex to insert a citation link.
+With one prefix arg, insert a ref link.
+With two prefix args, insert a label link."
+ (interactive "P")
+ (cond
+ ((equal arg nil)
+ (let ((helm-bibtex-bibliography (org-ref-find-bibliography)))
+ (helm-bibtex)))
+ ((equal arg '(4))
+ (org-ref-helm-insert-ref-link))
+ ((equal arg '(16))
+ (org-ref-helm-insert-label-link))))
(require 'helm-bibtex)
helm-bibtex-fallback-options))
(setq helm-bibtex-fallback-options
- (-insert-at 1 '("Open Web of Science" . (lambda () (browse-url "http://apps.webofknowledge.com")))
- helm-bibtex-fallback-options))
+ (-insert-at 1 '("WOS" . "http://gateway.webofknowledge.com/gateway/Gateway.cgi?topic=%s&GWVersion=2&SrcApp=WEB&SrcAuth=HSB&DestApp=UA&DestLinkType=GeneralSearchSummary") helm-bibtex-fallback-options))
#+END_SRC
** A helm click menu
(insert-file-contents bibfile)
(bibtex-search-entry key)
(org-ref-bib-citation)))
- (beep)
"!!! No entry found !!!" )))
+
(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."
#+RESULTS:
: org-ref-cite-click-helm
+** A hydra click interface
+I like hydra a lot. Here we define a hydra menu you might like for the link click action.
+
+#+BEGIN_SRC emacs-lisp :tangle org-ref.el
+(when (featurep 'hydra)
+ (require 'hydra)
+ (setq hydra-is-helpful t)
+
+ (defhydra org-ref-cite-hydra (:color blue)
+ "
+_p_: Open pdf _w_: WOS _g_: Google Scholar _K_: Copy citation to clipboard
+_u_: Open url _r_: WOS related _P_: Pubmed _k_: Copy key to clipboard
+_n_: Open notes _c_: WOS citing _C_: Crossref _f_: Copy bibtex entry to file
+_o_: Open entry _e_: Email entry and pdf
+"
+ ("o" org-ref-open-citation-at-point nil)
+ ("p" org-ref-open-pdf-at-point nil)
+ ("n" org-ref-open-notes-at-point nil)
+ ("u" org-ref-open-url-at-point nil)
+ ("w" org-ref-wos-at-point nil)
+ ("r" org-ref-wos-related-at-point nil)
+ ("c" org-ref-wos-citing-at-point nil)
+ ("g" org-ref-google-scholar-at-point nil)
+ ("P" org-ref-pubmed-at-point nil)
+ ("C" org-ref-crossref-at-point nil)
+ ("K" org-ref-copy-entry-as-summary nil)
+ ("k" (progn
+ (kill-new
+ (car (org-ref-get-bibtex-key-and-file)))) nil)
+ ("f" org-ref-copy-entry-at-point-to-file nil)
+
+ ("e" (save-excursion
+ (org-ref-open-citation-at-point)
+ (email-bibtex-entry)) nil)))
+#+END_SRC
+
* End of code
#+BEGIN_SRC emacs-lisp :tangle org-ref.el
(provide 'org-ref)
projects / org-ref.git / blobdiff