X-Git-Url: https://git.donarmstrong.com/?a=blobdiff_plain;f=org-ref.org;h=6124b7f7ce3399ecc7ad14012b203f0b854e2a5f;hb=e15d6b6fd62ef1ce8f807ef6f7b0f957cf9092a5;hp=b232f529d778ff96d8b6cb97fe1120bda7a0b21a;hpb=28479ce09ce37e969b09898207f6187b0efc91e9;p=org-ref.git diff --git a/org-ref.org b/org-ref.org index b232f52..6124b7f 100644 --- a/org-ref.org +++ b/org-ref.org @@ -67,6 +67,8 @@ The only external require is reftex-cite (require 'dash) (require 'helm) (require 'helm-bibtex) +(require 'org) +(require 'cl-lib) #+END_SRC ** Custom variables @@ -280,22 +282,28 @@ You can define a new citation link like this: ** 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.") -(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)) - ) + (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)) + (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)) @@ -335,25 +343,124 @@ The basic idea here is to get the mouse position, and if we can determine there (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) - (setq org-ref-message-timer-mouse - (run-at-time "0.5 sec" org-ref-mouse-message-interval 'org-ref-mouse-message))) + (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)) + (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 +(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 + "black" + "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.") + + +(when org-ref-colorize-links + (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)) +#+END_SRC + +#+RESULTS: + + * Links Most of this library is the creation of functional links to help with references and citations. ** General utilities @@ -505,7 +612,7 @@ environment, only %l is available." (file) (entry) (bibtex-entry) (entry-type) (format)) (setq file (catch 'result - (loop for file in org-ref-bibliography-files do + (cl-loop for file in org-ref-bibliography-files do (if (org-ref-key-in-file-p key (file-truename file)) (throw 'result file) (message "%s not found in %s" key (file-truename file)))))) @@ -595,7 +702,7 @@ First, we get the string for a single entry. (file) (entry) (bibtex-entry) (entry-type) (format)) (setq file (catch 'result - (loop for file in org-ref-bibliography-files do + (cl-loop for file in org-ref-bibliography-files do (if (org-ref-key-in-file-p key (file-truename file)) (throw 'result file) (message "%s not found in %s" key (file-truename file)))))) @@ -1299,7 +1406,7 @@ Use C-u C-u to insert a [[#custom-id]] link (helm :input (thing-at-point 'word) :sources `(((name . "Available labels to ref") - (candidates . ,(loop for label in labels + (candidates . ,(cl-loop for label in labels for context in contexts ;; we do some kludgy adding spaces ;; and bars to make it "easier" to @@ -1623,7 +1730,7 @@ Finally, we want to know which file the key is in. (unless key (setq key (org-ref-get-bibtex-key-under-cursor))) (setq file (catch 'result - (loop for file in org-ref-bibliography-files do + (cl-loop for file in org-ref-bibliography-files do (if (org-ref-key-in-file-p key (file-truename file)) (throw 'result file))))) (cons key file))) @@ -2324,7 +2431,7 @@ This assumes you are in an article." (bibtex-beginning-of-entry) (let* ((cb (current-buffer)) (bibtex-expand-strings t) - (entry (loop for (key . value) in (bibtex-parse-entry t) + (entry (cl-loop for (key . value) in (bibtex-parse-entry t) collect (cons (downcase key) value))) (title (replace-regexp-in-string "\n\\|\t\\|\s+" " " (reftex-get-bib-field "title" entry))) (year (reftex-get-bib-field "year" entry)) @@ -2352,7 +2459,7 @@ This assumes you are in an article." (bibtex-beginning-of-entry) (let* ((cb (current-buffer)) (bibtex-expand-strings t) - (entry (loop for (key . value) in (bibtex-parse-entry t) + (entry (cl-loop for (key . value) in (bibtex-parse-entry t) collect (cons (downcase key) value))) (title (replace-regexp-in-string "\n\\|\t\\|\s+" " " (reftex-get-bib-field "title" entry))) (year (reftex-get-bib-field "year" entry)) @@ -2409,7 +2516,7 @@ construct the heading by hand." (bibtex-beginning-of-entry) (let* ((cb (current-buffer)) (bibtex-expand-strings t) - (entry (loop for (key . value) in (bibtex-parse-entry t) + (entry (cl-loop for (key . value) in (bibtex-parse-entry t) collect (cons (downcase key) value))) (title (replace-regexp-in-string "\n\\|\t\\|\s+" " " (reftex-get-bib-field "title" entry))) (year (reftex-get-bib-field "year" entry)) @@ -2528,8 +2635,8 @@ Here is the python script for uploading. *************** 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 @@ -3506,7 +3613,7 @@ Checks for pdf and doi, and add appropriate functions." (email-bibtex-entry)))) t) ;; finally return a numbered list of the candidates - (loop for i from 0 + (cl-loop for i from 0 for cell in candidates collect (cons (format "%2s. %s" i (car cell)) (cdr cell)))))