]> git.donarmstrong.com Git - org-ref.git/blobdiff - org-ref.org
add hydra menu
[org-ref.git] / org-ref.org
index b419e08178d53c97588d1f1f4e8c111db9d88549..b581877e7fc172825c8963415bd522d9cbe6c4fe 100644 (file)
@@ -66,6 +66,7 @@ The only external require is reftex-cite
 (require 'reftex-cite)
 (require 'dash)
 (require 'helm)
+(require 'helm-config)
 (require 'helm-bibtex)
 #+END_SRC
 
@@ -280,22 +281,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))
@@ -365,6 +372,95 @@ The basic idea here is to get the mouse position, and if we can determine there
 #+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
+  "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
@@ -1617,9 +1713,15 @@ 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)
   "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
 
@@ -2539,8 +2641,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
 
@@ -3426,6 +3528,7 @@ This code provides a helm interface to things you can do when you click on a cit
            (org-ref-bib-citation)))
       "!!! 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."
@@ -3559,6 +3662,42 @@ This is a list of cons cells '((\"description\" . action)). The action function
 #+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
+(defhydra org-ref-cite-hydra (:color blue)
+  "
+_p_: Open pdf     _w_: WOS          _g_: Google Scholar _s_: 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)
+  ("s" 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
+
+#+RESULTS:
+: org-ref-cite-hydra/body
+
+cite:oberhofer-2013-first
 * End of code
 #+BEGIN_SRC emacs-lisp :tangle org-ref.el
 (provide 'org-ref)