X-Git-Url: https://git.donarmstrong.com/?p=org-ref.git;a=blobdiff_plain;f=jmax-bibtex.el;h=9927fefe8e187676583ecc8c10469fd5b589510e;hp=e560e540c609191d1efc0bbff04a1246e9027b97;hb=a646c41c18b7dd968d596dc64df3a0cb8ab98225;hpb=6dc413f2df948835cd041f52f1ca9327ac188a67 diff --git a/jmax-bibtex.el b/jmax-bibtex.el index e560e54..9927fef 100644 --- a/jmax-bibtex.el +++ b/jmax-bibtex.el @@ -1,9 +1,48 @@ ;;; jmax-bibtex.el --- jmax-bibtex utilities ;;; Commentary: -;; Requires: s.el, dash.el, org-ref.el, doi-utils.el +;; Requires: s.el, dash.el, org-ref.el, doi-utils.el, key-chord.el +;; +;; jmax-bibtex-generate-longtitles +;; jmax-bibtex-generate-shorttitles +;; jmax-stringify-journal-name :: replace a journal name with a string in `jmax-bibtex-journal-abbreviations' +;; jmax-set-journal-string :: in a bibtex entry run this to replace the journal with a string +;; +;; jmax-replace-nonascii :: replace nonascii characters in a bibtex entry +;; +;; jmax-title-case-article +;; jmax-sentence-case-article +;; +;; jmax-bibtex-next-entry :: bound to M-n +;; jmax-bibtex-previous-entry :: bound to M-p +;; +;; Functions to act on an entry +;; jmax-bibtex-hydra/body gives a hydra menu to a lot of useful functions. +;; jmax-bibtex-new-entry/body gives a hydra menu to add new bibtex entries. + +(require 'hydra) +(require 'key-chord) ;;; Code: +(defgroup jmax-bibtex nil + "Customization group for jmax-bibtex.") + + +(defcustom jmax-bibtex-hydra-key-chord + nil + "key-chord to run `jmax-bibtex-hydra'. +I like \"jj\"" + :type 'string + :group 'jmax-bibtex) + + +(defcustom jmax-bibtex-hydra-key-binding + nil + "key-binding to run `jmax-bibtex-hydra'. +I like \C-cj." + :type 'string + :group 'jmax-bibtex) + (defvar jmax-bibtex-journal-abbreviations '(("ACAT" "ACS Catalysis" "ACS Catal.") @@ -177,6 +216,8 @@ This is defined in `jmax-bibtex-journal-abbreviations'." ("ņ" . "{\\\\c{n}}") ("å" . "{\\\\aa}") ("ö" . "{\\\\\"o}") + ("Á" . "{\\\\'A}") + ("á" . "{\\\\'a}") ("í" . "{\\\\'i}") ("ó" . "{\\\\'o}") ("ó" . "{\\\\'o}") @@ -197,15 +238,19 @@ This is defined in `jmax-bibtex-journal-abbreviations'." ("⇌" . "$\\\\leftrightharpoons$") ("×" . "$\\\\times$") ("°" . "$\\\\deg$") + ("ş" . "{\\\\c{s}}") + ("ı" . "i") ; I think this is a turkish i ;; I think these are non-ascii spaces. there seems to be more than one. (" " . " ") (" " . " ") ("–" . "-") ("−" . "-") ("–" . "-") + ("—" . "-") ("‘" . "'") ("’" . "'") ("“" . "\"") + ("’" . "'") ("”" . "\""))) (defun jmax-replace-nonascii () @@ -218,7 +263,8 @@ This is defined in `jmax-bibtex-journal-abbreviations'." (dolist (char (mapcar (lambda (x) (car x)) jmax-nonascii-latex-replacements)) (while (re-search-forward char nil t) (replace-match (cdr (assoc char jmax-nonascii-latex-replacements)))) - (goto-char (point-min))))) + (goto-char (point-min)))) + (save-buffer)) (add-hook 'org-ref-clean-bibtex-entry-hook 'jmax-replace-nonascii) @@ -366,7 +412,7 @@ N is a prefix argument. If it is numeric, jump that many entries back." (defun jmax-bibtex-entry-doi () - "get doi from entry at point" + "Get doi from entry at point." (interactive) (save-excursion (bibtex-beginning-of-entry) @@ -374,57 +420,153 @@ N is a prefix argument. If it is numeric, jump that many entries back." (defun jmax-bibtex-wos () - "Open bibtex entry in Web Of Science if there is a DOI" + "Open bibtex entry in Web Of Science if there is a DOI." (interactive) (doi-utils-wos (jmax-bibtex-entry-doi))) (defun jmax-bibtex-wos-citing () - "Open citing articles for bibtex entry in Web Of Science if there is a DOI" + "Open citing articles for bibtex entry in Web Of Science if there is a DOI." (interactive) (doi-utils-wos-citing (jmax-bibtex-entry-doi))) (defun jmax-bibtex-wos-related () - "Open related articles for bibtex entry in Web Of Science if there is a DOI" + "Open related articles for bibtex entry in Web Of Science if there is a DOI." (interactive) (doi-utils-wos-related (jmax-bibtex-entry-doi))) (defun jmax-bibtex-wos-citing () - "Open citing articles for bibtex entry in Web Of Science if there is a DOI" + "Open citing articles for bibtex entry in Web Of Science if there is a DOI." (interactive) (doi-utils-wos-citing (jmax-bibtex-entry-doi))) (defun jmax-bibtex-crossref () + "Open the bibtex entry in Crossref by its doi." (interactive) (doi-utils-crossref (jmax-bibtex-entry-doi))) (defun jmax-bibtex-google-scholar () + "Open the bibtex entry at point in google-scholar by its doi." (interactive) (doi-utils-google-scholar (jmax-bibtex-entry-doi))) (defun jmax-bibtex-pubmed () + "Open the bibtex entry at point in Pubmed by its doi." (interactive) (doi-utils-pubmed (jmax-bibtex-entry-doi))) (defun jmax-bibtex-pdf (doi) - "thin wrapper to get `jmax-bibtex' to open pdf" + "Open the pdf for the bibtex entry at point. +Thin wrapper to get `jmax-bibtex' to open pdf, because it calls +functions with a DOI argument." (interactive) (org-ref-open-bibtex-pdf)) +;; hydra menu for actions on bibtex entries +(defhydra jmax-bibtex-hydra (:color blue) + " +_p_: Open pdf _y_: Copy key _n_: New entry _w_: WOS +_u_: Open url _f_: Copy formatted entry _o_: Copy entry _c_: WOS citing +_r_: Refile entry _k_: Add keywords _d_: delete entry _r_: WOS related +_e_: Email entry _K_: Edit keywords _L_: clean entry _P_: Pubmed +_U_: Update entry _N_: Open notes _R_: Crossref _g_: Google Scholar +_q_: quit +" + ("p" org-ref-open-bibtex-pdf) + ("P" jmax-bibtex-pubmed) + ("w" jmax-bibtex-wos) + ("c" jmax-bibtex-wos-citing) + ("r" jmax-bibtex-wos-related) + ("R" jmax-bibtex-crossref) + ("g" jmax-bibtex-google-scholar) + ("n" jmax-bibtex-new-entry/body) + ("N" org-ref-open-bibtex-notes) + ("o" bibtex-copy-entry-as-kill) + ("d" bibtex-kill-entry) + ("L" org-ref-clean-bibtex-entry) + ("y" (kill-new (bibtex-autokey-get-field "=key="))) + ("f" bibtex-copy-summary-as-kill) + ("k" helm-tag-bibtex-entry) + ("K" (lambda () + (interactive) + (org-ref-set-bibtex-keywords + (read-input "Keywords: " + (bibtex-autokey-get-field "keywords")) + t))) + ("u" org-ref-open-in-browser) + ("r" (lambda () (interactive) + (bibtex-beginning-of-entry) + (bibtex-kill-entry) + (find-file (ido-completing-read + "Bibtex file: " + (f-entries "." (lambda (f) (f-ext? f "bib"))))) + (goto-char (point-max)) + (bibtex-yank) + (save-buffer) + (kill-buffer))) + ("e" email-bibtex-entry) + ("U" (doi-utils-update-bibtex-entry-from-doi (jmax-bibtex-entry-doi))) + ("q" nil "quit") + ("f" jmax-bibtex-file/body "File functions") + ("a" jmax-replace-nonascii "Replace non-ascii")) + +;; create key-chord and key binding for hydra +(when jmax-bibtex-hydra-key-chord + (key-chord-define-global + jmax-bibtex-hydra-key-chord + 'jmax-bibtex-hydra/body)) + + +(when jmax-bibtex-hydra-key-binding + (global-set-key jmax-bibtex-hydra-key-binding 'jmax-bibtex-hydra/body)) + + +;; A hydra for adding new bibtex entries. +(defhydra jmax-bibtex-new-entry (:color blue) + "New Bibtex entry:" + ("a" bibtex-Article "Article") + ("b" bibtex-Book "Book") + ("i" bibtex-InBook "In book") + ("l" bibtex-Booklet "Booklet") + ("P" bibtex-Proceedings "Proceedings") + ("p" bibtex-InProceedings "In proceedings") + ("m" bibtex-Misc "Misc.") + ("M" bibtex-Manual "Manual") + ("T" bibtex-PhdThesis "PhD Thesis") + ("t" bibtex-MastersThesis "MS Thesis") + ("R" bibtex-TechReport "Report") + ("u" bibtex-Unpublished "unpublished") + ("c" bibtex-InCollection "Article in collection") + ("q" nil "quit")) + +;; a hydra menu of functions to act on a bibtex file. +(defhydra jmax-bibtex-file (:color blue) + "Bibtex file functions: " + ("v" bibtex-validate "Validate entries") + ("s" bibtex-sort-buffer "Sort entries") + ("r" bibtex-reformat "Reformat entries") + ("c" bibtex-count-entries "Count entries") + ("p" org-ref-build-full-bibliography "PDF bibliography")) + (defvar jmax-bibtex-menu-funcs '() - "Functions to run in doi menu. Each entry is a list of (key menu-name function). -The function must take one argument, the doi.") + "Functions to run in doi menu. +Each entry is a list of (key menu-name function). The function +must take one argument, the doi. This is somewhat deprecated, as +I prefer the hydra interfaces above.") (setq jmax-bibtex-menu-funcs '(("p" "df" jmax-bibtex-pdf) + ("C" "opy" (lambda (doi) + (kill-new (org-ref-bib-citation)) + (bury-buffer))) ("w" "os" doi-utils-wos) ("c" "iting articles" doi-utils-wos-citing) ("r" "elated articles" doi-utils-wos-related) @@ -434,7 +576,7 @@ The function must take one argument, the doi.") (defun jmax-bibtex () "Menu command to run in a bibtex entry. -Functions from `jmax-bibtex-menu-funcs'. They all rely on the +Functions from `jmax-bibtex-menu-funcs'. They all rely on the entry having a doi." (interactive)