(require 'dash)
(require 'helm)
(require 'helm-bibtex)
+(require 'org)
+(require 'cl-lib)
#+END_SRC
** Custom variables
(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
+(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
(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))))))
(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))))))
(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
(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)))
(format "[%s]"
(mapconcat
(lambda (key) (concat "@" key))
- (org-ref-split-and-strip-string keyword) ","
+ (org-ref-split-and-strip-string keyword)
"; "))))))))
#+END_SRC
(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))
(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))
(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))
*************** 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
(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)))))
projects / org-ref.git / blobdiff