jmax-bibtex.el

   1 ;;; jmax-bibtex.el --- jmax-bibtex utilities
   2
   3 ;;; Commentary:
   4 ;; Requires: s.el, dash.el, org-ref.el, doi-utils.el
   5
   6 ;;; Code:
   7
   8 (defvar jmax-bibtex-journal-abbreviations
   9   '(("ACAT" "ACS Catalysis" "ACS Catal.")
  10     ("AM" "Acta Materialia" "Acta Mater.")
  11     ("AMM" "Acta Metallurgica et Materialia" "Acta Metall. Mater.")
  12     ("AMiner" "American Mineralogist" "Am. Mineral.")
  13     ("AngC" "Angewandte Chemie-International Edition" "Angew. Chem. Int. Edit.")
  14     ("APLM" "APL Materials" "APL Mat.")
  15     ("ACBE" "Applied Catalysis B: Environmental" "Appl. Catal. B-Environ.")
  16     ("APL" "Applied Physics Letters" "Appl. Phys. Lett.")
  17     ("ASS" "Applied Surface Science" "Appl. Surf. Sci.")
  18     ("CL" "Catalysis Letters" "Catal. Lett.")
  19     ("CST" "Catalysis Science & Technology" "Catal. Sci. Technol.")
  20     ("CT" "Catalysis Today" "Catal. Today")
  21     ("CPL" "Chemical Physics Letters" "Chem. Phys. Lett")
  22     ("CR" "Chemical Reviews" "Chem. Rev.")
  23     ("CSR" "Chemical Society Reviews" "Chem. Soc. Rev.")
  24     ("CSR" "Chemical Society Reviews" "Chem. Soc. Rev.")
  25     ("CM" "Chemistry of Materials" "Chem. Mater.")
  26     ("CSA" "Colloids and Surfaces, A: Physicochemical and Engineering Aspects" "Colloids Surf., A")
  27     ("CPMS" "Computational Materials Science" "Comp. Mater. Sci.")
  28     ("CPC" "Computer Physics Communications" "Comput. Phys. Commun.")
  29     ("CGD" "Crystal Growth \\& Design" "Cryst. Growth Des.")
  30     ("CEC" "CrystEngComm" "CrystEngComm")
  31     ("ECST" "ECS Transactions" "ECS Trans.")
  32     ("EES" "Energy \\& Environmental Science" "Energy Environ. Sci.")
  33     ("HPR" "High Pressure Research" "High Pressure Res.")
  34     ("IC" "Inorganic Chemistry" "Inorg. Chem.")
  35     ("IECR" "Industrial \\& Engineering Chemistry Research" "Ind. Eng. Chem. Res.")
  36     ("JJAP" "Japanese Journal of Applied Physics" "Jpn. J. Appl. Phys.")
  37     ("JMatR" "Journal of  Materials Research" "J. Mater. Res.")
  38     ("JALC" "Journal of Alloys and Compounds" "J. Alloy Compd.")
  39     ("JAC" "Journal of Applied Crystallography" "J. Appl. Crystallogr.")
  40     ("JAP" "Journal of Applied Physics" "J. Appl. Phys.")
  41     ("JC" "Journal of Catalysis" "J. Catal.")
  42     ("JCP" "Journal of Chemical Physics" "J. Chem. Phys.")
  43     ("JCC" "Journal of Computational Chemistry" "J. Comput. Chem.")
  44     ("JCG" "Journal of Crystal Growth" "J. Crys. Growth")
  45     ("JMC" "Journal of Materials Chemistry" "J. Mater. Chem.")
  46     ("JMC" "Journal of Materials Chemistry" "J. Mater. Chem.")
  47     ("JMSL" "Journal of Materials Science Letters" "J. Mater. Sci. Lett.")
  48     ("JMS" "Journal of Membrane Science" "J. Memb. Sci.")
  49     ("JPE" "Journal of Phase Equilibria" "J. Phase Equilib.")
  50     ("JPCS" "Journal of Physics and Chemistry of Solids" "J. Phys. Chem. Solids")
  51     ("JPCM" "Journal of Physics: Condensed Matter" "J. Phys.: Condens. Matter")
  52     ("JSSC" "Journal of Solid State Chemistry" "J. Solid State Chem.")
  53     ("JACerS" "Journal of the American Ceramic Society" "J. Am. Ceram. Soc.")
  54     ("JACS" "Journal of the American Chemical Society" "J. Am. Chem. Soc.")
  55     ("JES" "Journal of The Electrochemical Society" "J. Electrochem. Soc.")
  56     ("JEaC" "Journal of Electroanalytical Chemistry" "J. Electroanal. Chem.")
  57     ("JMS" "Journal of Membrane Science" "J. Memb. Sci.")
  58     ("JVST" "Journal of Vacuum Science \\& Technology A" "J. Vac. Sci. Technol. A")
  59     ("ML" "Materials Letters" "Mater. Lett.")
  60     ("MSE-BS" "Materials Science and Engineering B" "Mat. Sci. Eng. B-Solid")
  61     ("MOLSIM" "Molecular Simulation" "Mol. Sim.")
  62     ("Nature" "Nature" "Nature")
  63     ("NM" "Nature Materials" "Nat. Mater.")
  64     ("PML" "Philosophical Magazine Letters" "Phil. Mag. Lett.")
  65     ("PMA" "Philosophical Magazine A" "Phil. Mag. A")
  66     ("PA" "Physica A: Statistical Mechanics and its Applications" "Physica A")
  67     ("PB" "Physica B-Condensed Matter" "Physica B")
  68     ("PCCP" "Physical Chemistry Chemical Physics" "Phys. Chem. Chem. Phys.")
  69     ("PSSB" "physica status solidi (b)" "Phys. Status Solidi B")
  70     ("PRA" "Physical Review A" "Phys. Rev. A")
  71     ("PRB" "Physical Review B" "Phys. Rev. B")
  72     ("PRL" "Physical Review Letters" "Phys. Rev. Lett.")
  73     ("PCM" "Physics and Chemistry of Minerals" "Phys. Chem. Miner.")
  74     ("PSurfSci" "Progress in Surface Science" "Prog. Surf. Sci.")
  75     ("Science" "Science" "Science")
  76     ("SABC" "Sensors and Actuators B: Chemical" "Sensor. Actuat. B-Chem.")
  77     ("SS" "Surface Science" "Surf. Sci.")
  78     ("EPJB" "The European Physical Journal B" "Eur. Phys. J. B")
  79     ("JPC" "The Journal of Physical Chemistry" "J. Phys. Chem.")
  80     ("JPCB" "The Journal of Physical Chemistry B" "J. Phys. Chem. B")
  81     ("JPCC" "The Journal of Physical Chemistry C" "J. Phys. Chem. C")
  82     ("JPCL" "The Journal of Physical Chemistry Letters" "J. Phys. Chem. Lett.")
  83     ("JCP" "The Journal of Chemical Physics" "J. Chem. Phys.")
  84     ("MSMSE" "Modelling and Simulation in Materials Science and Engineering" "Modell. Simul. Mater. Sci. Eng.")
  85     ("TSF" "Thin Solid Films" "Thin Solid Films")
  86     ("TC" "Topics in Catalysis" "Top. Catal.")
  87     ("WR" "Water Research" "Water Res."))
  88   "List of (string journal-full-name journal-abbreviation).  Find abbreviations at http://cassi.cas.org/search.jsp.")
  89
  90
  91 (defun jmax-bibtex-generate-longtitles ()
  92   "Generate longtitles.bib which are @string definitions.
  93 The full journal names are in `jmax-bibtex-journal-abbreviations'."
  94   (interactive)
  95   (with-temp-file "longtitles.bib"
  96     (dolist (row jmax-bibtex-journal-abbreviations)
  97       (insert (format "@string{%s=\"%s\"}\n"
  98                       (nth 0 row)
  99                       (nth 1 row))))))
 100
 101
 102 (defun jmax-bibtex-generate-shorttitles ()
 103     "Generate shorttitles.bib which are @string definitions.
 104 The abbreviated journal names in `jmax-bibtex-journal-abbreviations'."
 105   (interactive)
 106   (with-temp-file "shorttitles.bib"
 107     (dolist (row jmax-bibtex-journal-abbreviations)
 108       (insert (format "@string{%s=\"%s\"}\n"
 109                       (nth 0 row)
 110                       (nth 2 row))))))
 111
 112
 113 (defun jmax-stringify-journal-name (&optional key start end)
 114   "Replace journal name in a bibtex entry with a string.
 115 The strings are defined in
 116 `jmax-bibtex-journal-abbreviations'.  The optional arguments KEY,
 117 START and END allow you to use this with `bibtex-map-entries'"
 118   (interactive)
 119   (bibtex-beginning-of-entry)
 120   (when
 121       (string= "article"
 122                (downcase
 123                 (cdr (assoc "=type=" (bibtex-parse-entry)))))
 124     (let* ((full-names (mapcar
 125                         (lambda (row)
 126                           (cons  (nth 1 row) (nth 0 row)))
 127                         jmax-bibtex-journal-abbreviations))
 128            (abbrev-names (mapcar
 129                           (lambda (row)
 130                             (cons  (nth 2 row) (nth 0 row)))
 131                           jmax-bibtex-journal-abbreviations))
 132            (journal (s-trim (bibtex-autokey-get-field "journal")))
 133            (bstring (or
 134                      (cdr (assoc journal full-names))
 135                      (cdr (assoc journal abbrev-names)))))
 136       (when bstring
 137         (bibtex-set-field "journal" bstring t)
 138         (bibtex-fill-entry)))))
 139
 140 (defun jmax-set-journal-string (full-journal-name)
 141   "Set a bibtex journal name to the string that represents FULL-JOURNAL-NAME.
 142 This is defined in `jmax-bibtex-journal-abbreviations'."
 143   (interactive (list
 144                 (ido-completing-read
 145                  "Journal: "
 146                  (mapcar
 147                   (lambda (x)
 148                     (nth 1 x))
 149                   jmax-bibtex-journal-abbreviations))))
 150   ;; construct data alist for the string lookup.
 151   (let ((alist (mapcar
 152                 (lambda (x)
 153                   (cons (nth 1 x) (nth 0 x)))
 154                 jmax-bibtex-journal-abbreviations)))
 155     (bibtex-set-field "journal" (cdr (assoc full-journal-name alist)) t)
 156     (bibtex-fill-entry)
 157     (bibtex-clean-entry)))
 158
 159 ;; see https://github.com/fxcoudert/tools/blob/master/doi2bib for more replacements
 160 (defvar jmax-nonascii-latex-replacements
 161   '()
 162   "Cons list of non-ascii characters and their LaTeX representations.")
 163
 164 (setq jmax-nonascii-latex-replacements
 165       '(("í" . "{\\\\'i}")
 166         ("æ" . "{\\\\ae}")
 167         ("ć" . "{\\\\'c}")
 168         ("é" . "{\\\\'e}")
 169         ("ä" . "{\\\\\"a}")
 170         ("è" . "{\\\\`e}")
 171         ("à" . "{\\\\`a}")
 172         ("á" . "{\\\\'a}")
 173         ("ø" . "{\\\\o}")
 174         ("ë" . "{\\\\\"e}")
 175         ("ü" . "{\\\\\"u}")
 176         ("ñ" . "{\\\\~n}")
 177         ("ņ" . "{\\\\c{n}}")
 178         ("å" . "{\\\\aa}")
 179         ("ö" . "{\\\\\"o}")
 180         ("í" . "{\\\\'i}")
 181         ("ó" . "{\\\\'o}")
 182         ("ó" . "{\\\\'o}")
 183         ("ú" .  "{\\\\'u}")
 184         ("ú" . "{\\\\'u}")
 185         ("š" . "{\\\\v{s}}")
 186         ("İ" . "{\\\\.I}")
 187         ("ğ" . "{\\\\u{g}}")
 188         ("δ" . "$\\\\delta$")
 189         ("ç" . "{\\\\c{c}}")
 190         ("ß" . "{\\\\ss}")
 191         ("≤" . "$\\\\le$")
 192         ("<" . "$\\\\lt$")
 193         ("θ" . "$\\\\theta$")
 194         ("μ" . "$\\\\mu$")
 195         ("→" . "$\\\\rightarrow$")
 196         ("⇌" . "$\\\\leftrightharpoons$")
 197         ("×" . "$\\\\times$")
 198         ("°" . "$\\\\deg$")
 199         ;; I think these are non-ascii spaces. there seems to be more than one.
 200         (" " . " ")
 201         (" " . " ")
 202         ("–" . "-")
 203         ("−" . "-")
 204         ("–" . "-")
 205         ("‘" . "'")
 206         ("’" . "'")
 207         ("“" . "\"")
 208         ("”" . "\"")))
 209
 210 (defun jmax-replace-nonascii ()
 211   "Hook function to replace non-ascii characters in a bibtex entry."
 212
 213   (interactive)
 214   (save-restriction
 215     (bibtex-narrow-to-entry)
 216     (goto-char (point-min))
 217     (dolist (char (mapcar (lambda (x) (car x)) jmax-nonascii-latex-replacements))
 218       (while (re-search-forward char nil t)
 219         (replace-match (cdr (assoc char jmax-nonascii-latex-replacements))))
 220       (goto-char (point-min)))))
 221
 222 (add-hook 'org-ref-clean-bibtex-entry-hook 'jmax-replace-nonascii)
 223
 224
 225 (defvar jmax-lower-case-words
 226   '("a" "an" "on" "and" "for"
 227     "the" "of" "in")
 228   "List of words to keep lowercase when changing case in a title.")
 229
 230
 231 (defun jmax-title-case-article (&optional key start end)
 232   "Convert a bibtex entry article title to title-case.
 233 The arguments KEY, START and END are optional, and are only there
 234 so you can use this function with `bibtex-map-entries' to change
 235 all the title entries in articles."
 236   (interactive)
 237   (bibtex-beginning-of-entry)
 238
 239   (let* ((title (bibtex-autokey-get-field "title"))
 240          (words (split-string title))
 241          (start 0))
 242     (when
 243         (string= "article" (downcase (cdr (assoc "=type=" (bibtex-parse-entry)))))
 244       (setq words (mapcar
 245                    (lambda (word)
 246                      (if (or
 247                           ;; match words containing {} or \ which are probably
 248                           ;; LaTeX or protected words
 249                           (string-match "\\$\\|{\\|}\\|\\\\" word)
 250                           ;; these words should not be capitalized, unless they
 251                           ;; are the first word
 252                           (-contains? jmax-lower-case-words (s-downcase word)))
 253                          word
 254                        (s-capitalize word)))
 255                    words))
 256
 257       ;; Check if first word should be capitalized
 258       (when (-contains? jmax-lower-case-words (car words))
 259         (setf (car words) (s-capitalize (car words))))
 260
 261       (setq title (mapconcat 'identity words " "))
 262
 263       ;; Capitalize letters after a dash
 264       (while
 265           (string-match "[a-zA-Z]-\\([a-z]\\)" title start)
 266         (let ((char (substring title (match-beginning 1) (match-end 1))))
 267           (setf (substring title (match-beginning 1) (match-end 1))
 268                 (format "%s" (upcase char)))
 269           (setq start (match-end 1))))
 270
 271       ;; this is defined in doi-utils
 272       (bibtex-set-field
 273        "title"
 274        title)
 275       (bibtex-fill-entry))))
 276
 277 (add-hook 'org-ref-clean-bibtex-entry-hook 'jmax-title-case-article)
 278
 279
 280 (defun jmax-sentence-case-article (&optional key start end)
 281   "Convert a bibtex entry article title to sentence-case.
 282 The arguments KEY, START and END are optional, and are only there
 283 so you can use this function with `bibtex-map-entries' to change
 284 all the title entries in articles."
 285   (interactive)
 286   (bibtex-beginning-of-entry)
 287
 288   (let* ((title (bibtex-autokey-get-field "title"))
 289          (words (split-string title))
 290          (start 0))
 291     (when
 292         (string= "article" (downcase (cdr (assoc "=type=" (bibtex-parse-entry)))))
 293       (setq words (mapcar
 294                    (lambda (word)
 295                      (if
 296                          ;; match words containing {} or \ which are probably
 297                          ;; LaTeX or protected words
 298                          (string-match "\\$\\|{\\|}\\|\\\\" word)
 299                          word
 300                        (s-downcase word)))
 301                    words))
 302
 303       ;; capitalize first word
 304       (setf (car words) (s-capitalize (car words)))
 305
 306       ;; join the words
 307       (setq title (mapconcat 'identity words " "))
 308
 309       ;; capitalize a word after a :, eg. a subtitle, and protect it
 310       (while
 311           (string-match "[a-z]:\\s-+\\([A-Z]\\)" title start)
 312         (let ((char (substring title (match-beginning 1) (match-end 1))))
 313           (setf (substring title (match-beginning 1) (match-end 1))
 314 ;;              (format "{%s}" (upcase char)))
 315                 (format "%s" (upcase char)))
 316           (setq start (match-end 1))))
 317
 318       ;; this is defined in doi-utils
 319       (bibtex-set-field
 320        "title" title)
 321
 322       ;; clean and refill entry so it looks nice
 323       (bibtex-clean-entry)
 324       (bibtex-fill-entry))))
 325
 326
 327
 328
 329 (defun jmax-bibtex-next-entry (&optional n)
 330   "Jump to the beginning of the next bibtex entry.
 331 N is a prefix argument.  If it is numeric, jump that many entries
 332 forward.  Negative numbers do nothing."
 333   (interactive "P")
 334   ;; Note if we start at the beginning of an entry, nothing
 335   ;; happens. We need to move forward a char, and call again.
 336   (when (= (point) (save-excursion
 337                      (bibtex-beginning-of-entry)))
 338     (forward-char)
 339     (jmax-bibtex-next-entry))
 340
 341   ;; search forward for an entry
 342   (when
 343       (re-search-forward bibtex-entry-head nil t (and (numberp n) n))
 344     ;; go to beginning of the entry
 345     (bibtex-beginning-of-entry)))
 346
 347
 348 (defun jmax-bibtex-previous-entry (&optional n)
 349   "Jump to beginning of the previous bibtex entry.
 350 N is a prefix argument.  If it is numeric, jump that many entries back."
 351   (interactive "P")
 352   (bibtex-beginning-of-entry)
 353  (when
 354      (re-search-backward bibtex-entry-head nil t (and (numberp n) n))
 355    (bibtex-beginning-of-entry)))
 356
 357
 358 (defun jmax-bibtex-mode-keys ()
 359   "Modify keymaps used by `bibtex-mode'."
 360   (local-set-key (kbd "M-n") 'jmax-bibtex-next-entry)
 361   (local-set-key (kbd "M-p") 'jmax-bibtex-previous-entry))
 362
 363 ;; add to bibtex-mode-hook
 364 (add-hook 'bibtex-mode-hook 'jmax-bibtex-mode-keys)
 365
 366
 367 (defun jmax-bibtex-entry-doi ()
 368   "get doi from entry at point"
 369   (interactive)
 370   (save-excursion
 371     (bibtex-beginning-of-entry)
 372     (reftex-get-bib-field "doi" (bibtex-parse-entry t))))
 373
 374
 375 (defun jmax-bibtex-wos ()
 376   "Open bibtex entry in Web Of Science if there is a DOI"
 377   (interactive)
 378   (doi-utils-wos (jmax-bibtex-entry-doi)))
 379
 380
 381 (defun jmax-bibtex-wos-citing ()
 382   "Open citing articles for bibtex entry in Web Of Science if there is a DOI"
 383   (interactive)
 384   (doi-utils-wos-citing (jmax-bibtex-entry-doi)))
 385
 386
 387 (defun jmax-bibtex-wos-related ()
 388   "Open related articles for bibtex entry in Web Of Science if there is a DOI"
 389   (interactive)
 390   (doi-utils-wos-related (jmax-bibtex-entry-doi)))
 391
 392
 393 (defun jmax-bibtex-wos-citing ()
 394   "Open citing articles for bibtex entry in Web Of Science if there is a DOI"
 395   (interactive)
 396   (doi-utils-wos-citing (jmax-bibtex-entry-doi)))
 397
 398
 399 (defun jmax-bibtex-crossref ()
 400   (interactive)
 401   (doi-utils-crossref (jmax-bibtex-entry-doi)))
 402
 403
 404 (defun jmax-bibtex-google-scholar ()
 405   (interactive)
 406   (doi-utils-google-scholar (jmax-bibtex-entry-doi)))
 407
 408
 409 (defun jmax-bibtex-pubmed ()
 410   (interactive)
 411   (doi-utils-pubmed (jmax-bibtex-entry-doi)))
 412
 413
 414 (defun jmax-bibtex-pdf (doi)
 415   "thin wrapper to get `jmax-bibtex' to open pdf"
 416   (interactive)
 417   (org-ref-open-bibtex-pdf))
 418
 419
 420
 421 (defvar jmax-bibtex-menu-funcs '()
 422  "Functions to run in doi menu. Each entry is a list of (key menu-name function).
 423 The function must take one argument, the doi.")
 424
 425 (setq jmax-bibtex-menu-funcs
 426       '(("p" "df" jmax-bibtex-pdf)
 427         ("w" "os" doi-utils-wos)
 428         ("c" "iting articles" doi-utils-wos-citing)
 429         ("r" "elated articles" doi-utils-wos-related)
 430         ("s" "Google Scholar" doi-utils-google-scholar)
 431         ("P" "Pubmed" doi-utils-pubmed)
 432         ("f" "CrossRef" doi-utils-crossref)))
 433
 434 (defun jmax-bibtex ()
 435   "Menu command to run in a bibtex entry.
 436 Functions from `jmax-bibtex-menu-funcs'. They all rely on the
 437 entry having a doi."
 438
 439   (interactive)
 440   ;; construct menu string as a message
 441   (message
 442    (concat
 443     (mapconcat
 444      (lambda (tup)
 445        (concat "[" (elt tup 0) "]"
 446                (elt tup 1) " "))
 447      jmax-bibtex-menu-funcs "") ": "))
 448   (let* ((input (read-char-exclusive))
 449          (choice (assoc
 450                   (char-to-string input) jmax-bibtex-menu-funcs)))
 451     (when choice
 452       (funcall
 453        (elt
 454         choice
 455         2)
 456        (jmax-bibtex-entry-doi)
 457        ))))
 458
 459 (defalias 'jb 'jmax-bibtex)
 460
 461 (provide 'jmax-bibtex)
 462
 463 ;;; jmax-bibtex.el ends here