X-Git-Url: https://git.donarmstrong.com/?p=org-ref.git;a=blobdiff_plain;f=org-ref.org;h=44aa74b7541844d857924bc3f64cd1fd6476c44c;hp=c1cebb2676be63d352c1244071429f7b435e6c07;hb=076d9bffd0ed994a5a7452799f72ea8ce8553537;hpb=a049a93ecdd9983b343f26ba3d9a6f0da8721347 diff --git a/org-ref.org b/org-ref.org index c1cebb2..44aa74b 100644 --- a/org-ref.org +++ b/org-ref.org @@ -242,26 +242,6 @@ We setup reftex here. We use a custom insert cite link function defined here: [[ (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 @@ -297,6 +277,100 @@ You can define a new citation link like this: (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 + * Links Most of this library is the creation of functional links to help with references and citations. ** General utilities @@ -1944,7 +2018,25 @@ We will want to generate formatting functions for each citation type. The reason ;; 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 @@ -2453,8 +2545,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 @@ -3320,8 +3412,7 @@ With two prefix args, insert a label link." 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