1 ;;; refbib.el --- convert refer-style references to ones usable by Latex bib
4 ;; Last-Modified: 16 Mar 1992
7 ;; Copyright (C) 1989 Free Software Foundation, Inc.
9 ;; This file is part of GNU Emacs.
11 ;; GNU Emacs is free software; you can redistribute it and/or modify
12 ;; it under the terms of the GNU General Public License as published by
13 ;; the Free Software Foundation; either version 2, or (at your option)
16 ;; GNU Emacs is distributed in the hope that it will be useful,
17 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
18 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
19 ;; GNU General Public License for more details.
21 ;; You should have received a copy of the GNU General Public License
22 ;; along with GNU Emacs; see the file COPYING. If not, write to
23 ;; the Free Software Foundation, 675 Mass Ave, Cambridge, MA 02139, USA.
27 ;; Use: from a buffer containing the refer-style bibliography,
28 ;; M-x r2b-convert-buffer
29 ;; Program will prompt for an output buffer name, and will log
30 ;; warnings during the conversion process in the buffer *Log*.
36 ; modified 1/19/89, allow books with editor but no author;
37 ; added %O ordering field;
38 ; appended illegal multiple fields, instead of
40 ; added rule, a tech report whose %R number
41 ; contains "ISBN" is really a book
42 ; added rule, anything with an editor is a book
44 ; added 'manual type, for items with institution
45 ; but no author or editor
46 ; fixed bug so trailing blanks are trimmed
47 ; added 'proceedings type
48 ; used "organization" field for proceedings
49 ; modified 2/16/89, updated help messages
50 ; modified 2/23/89, include capitalize stop words in r2b stop words,
51 ; fixed problems with contractions (e.g. it's),
52 ; caught multiple stop words in a row
53 ; modified 3/1/89, fixed capitialize-title for first words all caps
54 ; modified 3/15/89, allow use of " to delimit fields
55 ; modified 4/18/89, properly "quote" special characters on output
59 ;**********************************************************
62 (defvar r2b-trace-on nil "*trace conversion")
64 (defvar r2b-journal-abbrevs
67 " Abbreviation list for journal names.
68 If the car of an element matches a journal name exactly, it is replaced by
69 the cadr when output. Braces must be included if replacement is a
70 {string}, but not if replacement is a bibtex abbreviation. The cadr
71 may be eliminated if is exactly the same as the car.
72 Because titles are capitalized before matching, the abbreviation
73 for the journal name should be listed as beginning with a capital
74 letter, even if it really doesn't.
75 For example, a value of '((\"Aij\" \"{Artificial Intelligence}\")
76 (\"Ijcai81\" \"ijcai7\")) would expand Aij to the text string
77 \"Artificial Intelligence\", but would replace Ijcai81 with the
78 BibTeX macro \"ijcai7\".")
80 (defvar r2b-booktitle-abbrevs
83 " Abbreviation list for book and proceedings names. If the car of
84 an element matches a title or booktitle exactly, it is replaced by
85 the cadr when output. Braces must be included if replacement is
86 a {string}, but not if replacement is a bibtex abbreviation. The cadr
87 may be eliminated if is exactly the same as the car.
88 Because titles are capitalized before matching, the abbreviated title
89 should be listed as beginning with a capital letter, even if it doesn't.
90 For example, a value of '((\"Aij\" \"{Artificial Intelligence}\")
91 (\"Ijcai81\" \"ijcai7\")) would expand Aij to the text string
92 \"Artificial Intelligence\", but would replace Ijcai81 with the
93 BibTeX macro \"ijcai7\".")
95 (defvar r2b-proceedings-list
97 " Assoc list of books or journals which are really conference proceedings,
98 but whose name and whose abbrev expansion (as defined in `r2b-journal-abbrevs'
99 and `r2b-booktitle-abbrevs') does not contain the words \"conference\" or
100 \"proceedings\". (Those cases are handled automatically.)
101 The entry must match the given data exactly.
102 Because titles are capitalized before matching, the items in this list
103 should begin with a capital letter.
104 For example, suppose the title \"Ijcai81\" is used for the proceedings of
105 a conference, and it's expansion is the BibTeX macro \"ijcai7\". Then
106 `r2b-proceedings-list' should be '((\"Ijcai81\") ...). If instead its
107 expansion were \"Proceedings of the Seventh International Conference
108 on Artificial Intelligence\", then you would NOT need to include Ijcai81
109 in `r2b-proceedings-list' (although it wouldn't cause an error).")
111 (defvar r2b-additional-stop-words
113 "Words other than the `capitialize-title-stop-words'
114 which are not to be used to build the citation key")
117 (defvar r2b-delimit-with-quote
119 "*If true, then use \" to delimit fields, otherwise use braces")
121 ;**********************************************************
124 (defvar capitalize-title-stop-words
126 "the\\|and\\|of\\|is\\|a\\|an\\|of\\|for\\|in\\|to\\|in\\|on\\|at\\|"
127 "by\\|with\\|that\\|its")
128 "Words not to be capitialized in a title (unless they are the first
131 (defvar capitalize-title-stop-regexp
132 (concat "\\(" capitalize-title-stop-words "\\)\\(\\b\\|'\\)"))
134 (defun capitalize-title-region (begin end)
135 "Like `capitalize-region', but don't capitalize stop words, except the first."
137 (let ((case-fold-search nil) (orig-syntax-table (syntax-table)))
140 (set-syntax-table text-mode-syntax-table)
141 (narrow-to-region begin end)
142 (goto-char (point-min))
143 (if (looking-at "[A-Z][a-z]*[A-Z]")
146 (while (re-search-forward "\\<" nil t)
147 (if (looking-at "[A-Z][a-z]*[A-Z]")
149 (if (let ((case-fold-search t))
150 (looking-at capitalize-title-stop-regexp))
152 (capitalize-word 1)))
154 (set-syntax-table orig-syntax-table))))
157 (defun capitalize-title (s)
158 "Like capitalize, but don't capitalize stop words, except the first."
160 (set-buffer (get-buffer-create "$$$Scratch$$$"))
163 (capitalize-title-region (point-min) (point-max))
166 ;*********************************************************
168 "Unbind defvars, for debugging."
170 (makunbound 'r2b-journal-abbrevs)
171 (makunbound 'r2b-booktitle-abbrevs)
172 (makunbound 'r2b-proceedings-list)
173 (makunbound 'capitalize-title-stop-words)
174 (makunbound 'capitalize-title-stop-regexp)
175 (makunbound 'r2b-additional-stop-words)
176 (makunbound 'r2b-stop-regexp))
178 (defvar r2b-stop-regexp
180 r2b-additional-stop-words "\\|" capitalize-title-stop-words
181 "\\)\\('\\w*\\)?\\W+\\)*\\([A-Z0-9]+\\)"))
184 (defun r2b-trace (&rest args)
187 (apply (function message) args)
190 (defun r2b-match (exp)
191 "Returns string matched in current buffer."
192 (buffer-substring (match-beginning exp) (match-end exp)))
194 (defvar r2b-out-buf-name "*Out*" "*output from refer-to-bibtex" )
195 (defvar r2b-log-name "*Log*" "*logs errors from refer-to-bibtex" )
196 (defvar r2b-in-buf nil)
197 (defvar r2b-out-buf nil)
200 (defvar r2b-error-found nil)
202 (setq r2b-variables '(
211 r2bv-title-first-word
234 (defun r2b-clear-variables ()
235 "Set all global vars used by r2b to nil."
236 (let ((vars r2b-variables))
239 (setq vars (cdr vars)))))
241 (defun r2b-warning (&rest args)
242 (setq r2b-error-found t)
243 (princ (apply (function format) args) r2b-log)
245 (princ "\n" r2b-out-buf)
246 (princ "% " r2b-out-buf)
247 (princ (apply (function format) args) r2b-out-buf))
249 (defun r2b-get-field (var field &optional unique required capitalize)
250 "Set VAR to string value of FIELD, if any. If none, VAR is set to
251 nil. If multiple fields appear, then separate values with the
252 '\\nand\\t\\t', unless UNIQUE is non-nil, in which case log a warning
253 and just concatenate the values. Trim off leading blanks and tabs on
254 first line, and trailing blanks and tabs of every line. Log a warning
255 and set VAR to the empty string if REQUIRED is true. Capitalize as a
256 title if CAPITALIZE is true. Returns value of VAR."
257 (let (item val (not-past-end t))
258 (r2b-trace "snarfing %s" field)
259 (goto-char (point-min))
260 (while (and not-past-end
262 (concat "^" field "\\b[ \t]*\\(.*[^ \t\n]\\)[ \t]*") nil t))
263 (setq item (r2b-match 1))
264 (while (and (setq not-past-end (zerop (forward-line 1)))
265 (not (looking-at "[ \t]*$\\|%")))
266 (looking-at "\\(.*[^ \t\n]\\)[ \t]*$")
267 (setq item (concat item "\n" (r2b-match 1)))
273 (r2b-warning "*Illegal multiple field %s %s" field item)
274 (setq val (concat val "\n" item))
276 (setq val (concat val "\n\t\tand " item))
280 (if (and val capitalize)
281 (setq val (capitalize-title val)))
283 (if (and (null val) required)
287 (defun r2b-set-match (var n regexp string )
288 "Set VAR to the Nth subpattern in REGEXP matched by STRING, or nil if none."
290 (if (and (stringp string) (string-match regexp string))
291 (substring string (match-beginning n) (match-end n))
296 (defvar r2b-month-abbrevs
297 '(("jan") ("feb") ("mar") ("apr") ("may") ("jun") ("jul") ("aug")
298 ("sep") ("oct") ("nov") ("dec")))
300 (defun r2b-convert-month ()
301 "Try to convert `r2bv-month' to a standard 3 letter name."
303 (let ((months r2b-month-abbrevs))
304 (if (string-match "[^0-9]" r2bv-month)
306 (while (and months (not (string-match (car (car months))
308 (setq months (cdr months)))
310 (setq r2bv-month (car (car months)))))
312 (setq months (car (read-from-string r2bv-month)))
313 (if (and (numberp months)
316 (setq r2bv-month (car (nth months r2b-month-abbrevs)))
318 (r2b-warning "* Ridiculous month")
319 (setq r2bv-month nil))
325 (defun r2b-snarf-input ()
326 "Parse buffer into global variables."
327 (let ((case-fold-search t))
328 (r2b-trace "snarfing...")
330 (set-buffer r2b-in-buf)
331 (goto-char (point-min))
333 (princ (buffer-substring (point) (progn (end-of-line) (point))) r2b-log)
336 (r2b-get-field 'r2bv-author "%A")
337 (r2b-get-field 'r2bv-editor "%E")
340 (r2b-set-match 'r2bv-primary-author 1
341 "\\b\\(\\w+\\)[ \t]*\\($\\|,\\)" r2bv-author)
344 (r2b-set-match 'r2bv-primary-author 1
345 "\\b\\(\\w+\\)[ \t]*\\($\\|,\\)" r2bv-editor)
348 (setq r2bv-primary-author "")
352 (r2b-get-field 'r2bv-date "%D" t t)
353 (r2b-set-match 'r2bv-year 0 "[12][0-9][0-9][0-9]" r2bv-date)
354 (and (null r2bv-year)
355 (r2b-set-match 'r2bv-year 1 "[^0-9]\\([0-9][0-9]\\)$" r2bv-date)
356 (setq r2bv-year (concat "19" r2bv-year)))
357 (r2b-set-match 'r2bv-decade 1 "..\\(..\\)" r2bv-year)
358 (r2b-set-match 'r2bv-month 0
359 "[0-9]+/\\|[a-zA-Z]+" r2bv-date)
360 (if (and (stringp r2bv-month) (string-match "\\(.*\\)/$" r2bv-month))
361 (setq r2bv-month (substring r2bv-month 0 (match-end 1))))
364 (r2b-get-field 'r2bv-title "%T" t t t)
365 (r2b-set-match 'r2bv-title-first-word 4
369 (r2b-get-field 'r2bv-annote "%X" t )
370 (r2b-get-field 'r2bv-tr "%R" t)
371 (r2b-get-field 'r2bv-address "%C" t)
372 (r2b-get-field 'r2bv-institution "%I" t)
373 (r2b-get-field 'r2bv-keywords "%K")
374 (r2b-get-field 'r2bv-booktitle "%B" t nil t)
375 (r2b-get-field 'r2bv-journal "%J" t nil t)
376 (r2b-get-field 'r2bv-volume "%V" t)
377 (r2b-get-field 'r2bv-number "%N" t)
378 (r2b-get-field 'r2bv-pages "%P" t)
379 (r2b-get-field 'r2bv-where "%W" t)
380 (r2b-get-field 'r2bv-ordering "%O" t)
385 (defun r2b-put-field (field data &optional abbrevs)
386 "Print bibtex FIELD = {DATA} if DATA not null; precede
387 with a comma and newline; if ABBREVS list is given, then
388 try to replace the {DATA} with an abbreviation."
390 (let (match nodelim multi-line index)
392 ((and abbrevs (setq match (assoc data abbrevs)))
393 (if (null (cdr match))
394 (setq data (car match))
395 (setq data (car (cdr match))))
397 ((and (not (equal data ""))
398 (not (string-match "[^0-9]" data)))
402 (while (string-match "[\\~^]" data index)
403 (setq data (concat (substring data 0 (match-beginning 0))
405 (substring data (match-beginning 0) (match-end 0))
407 (substring data (match-end 0))))
408 (setq index (+ (match-end 0) 7)))
410 (while (string-match "[$&%#_{}]" data index)
411 (setq data (concat (substring data 0 (match-beginning 0))
413 (substring data (match-beginning 0))))
414 (setq index (+ (match-end 0) 1)))
416 (if r2b-delimit-with-quote
417 (while (string-match "\"" data index)
418 (setq data (concat (substring data 0 (match-beginning 0))
420 (substring data (match-end 0))))
421 (setq index (+ (match-end 0) 2))))
427 (if r2b-delimit-with-quote
430 (string-match ".*" data)
431 (if (> (match-end 0) 59)
435 (if r2b-delimit-with-quote
442 (defun r2b-require (vars)
443 "If any of VARS is null, set to empty string and log error."
446 ((listp vars) (r2b-require (car vars)) (r2b-require (cdr vars)))
448 (if (null (symbol-value vars))
450 (r2b-warning "*Missing value for field %s" vars)
457 (defmacro r2b-moveq (new old)
458 "Set NEW to OLD and set OLD to nil."
459 (list 'progn (list 'setq new old) (list 'setq old 'nil)))
461 (defun r2b-isa-proceedings (name)
462 "Return t if NAME is the name of proceedings."
466 (string-match "proceedings\\|conference" name)
467 (assoc name r2b-proceedings-list)
468 (let ((match (assoc name r2b-booktitle-abbrevs)))
470 (string-match "proceedings\\|conference" (car (cdr match)))))
473 (defun r2b-isa-university (name)
474 "Return t if NAME is a university or similar organization,
475 but not a publisher."
478 (string-match "university" name)
479 (not (string-match "press" name))
483 (defun r2b-barf-output ()
484 "Generate bibtex based on global variables."
485 (let ((standard-output r2b-out-buf) (case-fold-search t) match)
487 (r2b-trace "...barfing")
489 (set-buffer r2b-out-buf)
491 (setq r2bv-kn (concat r2bv-primary-author r2bv-decade
492 r2bv-title-first-word))
494 (setq r2bv-entry-kind
496 ((r2b-isa-proceedings r2bv-journal)
497 (r2b-moveq r2bv-booktitle r2bv-journal)
498 (if (r2b-isa-university r2bv-institution)
499 (r2b-moveq r2bv-organization r2bv-institution)
500 (r2b-moveq r2bv-publisher r2bv-institution))
501 (r2b-moveq r2bv-note r2bv-tr)
502 (r2b-require 'r2bv-author)
504 ((r2b-isa-proceedings r2bv-booktitle)
505 (if (r2b-isa-university r2bv-institution)
506 (r2b-moveq r2bv-organization r2bv-institution)
507 (r2b-moveq r2bv-publisher r2bv-institution))
508 (r2b-moveq r2bv-note r2bv-tr)
509 (r2b-require 'r2bv-author)
511 ((and r2bv-tr (string-match "phd" r2bv-tr))
512 (r2b-moveq r2bv-school r2bv-institution)
513 (r2b-require 'r2bv-school )
514 (r2b-require 'r2bv-author)
516 ((and r2bv-tr (string-match "master" r2bv-tr))
517 (r2b-moveq r2bv-school r2bv-institution)
518 (r2b-require 'r2bv-school )
519 (r2b-require 'r2bv-author)
521 ((and r2bv-tr (string-match "draft\\|unpublish" r2bv-tr))
522 (r2b-moveq r2bv-note r2bv-institution)
523 (r2b-require 'r2bv-author)
526 (r2b-require 'r2bv-author)
529 (r2b-moveq r2bv-publisher r2bv-institution)
530 (r2b-moveq r2bv-note r2bv-tr)
531 (r2b-require 'r2bv-publisher)
532 (r2b-require 'r2bv-author)
536 (string-match "\\`personal communication\\'" r2bv-title))
538 ((r2b-isa-proceedings r2bv-title)
539 (if (r2b-isa-university r2bv-institution)
540 (r2b-moveq r2bv-organization r2bv-institution)
541 (r2b-moveq r2bv-publisher r2bv-institution))
542 (r2b-moveq r2bv-note r2bv-tr)
548 (string-match "\\bisbn\\b" r2bv-tr))))
549 (r2b-moveq r2bv-publisher r2bv-institution)
550 (r2b-moveq r2bv-note r2bv-tr)
551 (r2b-require 'r2bv-publisher)
552 (if (null r2bv-editor)
553 (r2b-require 'r2bv-author))
556 (r2b-require 'r2bv-institution)
558 "\\`\\(\\(.\\|\n\\)+\\)[ \t\n]+\\([^ \t\n]\\)+\\'"
561 (setq r2bv-type (substring r2bv-tr 0 (match-end 1)))
562 (setq r2bv-number (substring r2bv-tr
563 (match-beginning 3)))
565 (r2b-moveq r2bv-number r2bv-tr))
566 (r2b-require 'r2bv-author)
569 (r2b-moveq r2bv-organization r2bv-institution)
575 (r2b-require '( r2bv-year))
578 (princ "\n% Warning -- Errors During Conversion Next Entry\n"))
581 (princ r2bv-entry-kind)
585 (r2b-put-field "author" r2bv-author )
586 (r2b-put-field "title" r2bv-title r2b-booktitle-abbrevs)
587 (r2b-put-field "year" r2bv-year )
589 (r2b-put-field "month" r2bv-month r2b-month-abbrevs)
590 (r2b-put-field "journal" r2bv-journal r2b-journal-abbrevs)
591 (r2b-put-field "volume" r2bv-volume)
592 (r2b-put-field "type" r2bv-type)
593 (r2b-put-field "number" r2bv-number)
594 (r2b-put-field "booktitle" r2bv-booktitle r2b-booktitle-abbrevs)
595 (r2b-put-field "editor" r2bv-editor)
596 (r2b-put-field "publisher" r2bv-publisher)
597 (r2b-put-field "institution" r2bv-institution)
598 (r2b-put-field "organization" r2bv-organization)
599 (r2b-put-field "school" r2bv-school)
600 (r2b-put-field "pages" r2bv-pages)
601 (r2b-put-field "address" r2bv-address)
602 (r2b-put-field "note" r2bv-note)
603 (r2b-put-field "keywords" r2bv-keywords)
604 (r2b-put-field "where" r2bv-where)
605 (r2b-put-field "ordering" r2bv-ordering)
606 (r2b-put-field "annote" r2bv-annote)
613 (defun r2b-convert-record (output-name)
614 "Transform current bib entry and append to buffer OUTPUT;
615 do \"M-x r2b-help\" for more info."
617 (list (read-string "Output to buffer: " r2b-out-buf-name)))
618 (let (rec-end rec-begin not-done)
619 (setq r2b-out-buf-name output-name)
620 (setq r2b-out-buf (get-buffer-create output-name))
621 (setq r2b-in-buf (current-buffer))
622 (set-buffer r2b-out-buf)
623 (goto-char (point-max))
624 (setq r2b-log (get-buffer-create r2b-log-name))
626 (goto-char (point-max))
627 (set-buffer r2b-in-buf)
628 (setq not-done (re-search-forward "[^ \t\n]" nil t))
631 (re-search-backward "^[ \t]*$" nil 2)
632 (re-search-forward "^%")
633 (beginning-of-line nil)
634 (setq rec-begin (point))
635 (re-search-forward "^[ \t]*$" nil 2)
636 (setq rec-end (point))
637 (narrow-to-region rec-begin rec-end)
638 (r2b-clear-variables)
641 (set-buffer r2b-in-buf)
650 (defun r2b-convert-buffer (output-name)
651 "Transform current buffer and append to buffer OUTPUT;
652 do \"M-x r2b-help\" for more info."
654 (list (read-string "Output to buffer: " r2b-out-buf-name)))
656 (setq r2b-log (get-buffer-create r2b-log-name))
660 (goto-char (point-min))
661 (message "Working, please be patient...")
663 (while (r2b-convert-record output-name) t)
664 (message "Done, results in %s, errors in %s"
665 r2b-out-buf-name r2b-log-name)
668 (defvar r2b-load-quietly nil "*Don't print help message when loaded")
670 (defvar r2b-help-message
671 " Refer to Bibtex Bibliography Conversion
673 A refer-style database is of the form:
676 %T Great Thoughts I've Thought
680 This utility converts these kind of databases to bibtex form, for
681 users of TeX and LaTex. Instructions:
682 1. Visit the file containing the refer-style database.
684 M-x r2b-convert-buffer
685 converts the entire buffer, appending it's output by default in a
686 buffer named *Out*, and logging progress and errors in a buffer
687 named *Log*. The original file is never modified.
688 Note that results are appended to *Out*, so if that buffer
689 buffer already exists and contains material you don't want to
690 save, you should kill it first.
691 3. Switch to the buffer *Out* and save it as a named file.
692 4. To convert a single refer-style entry, simply position the cursor
693 at the entry and enter
694 M-x r2b-convert-record
695 Again output is appended to *Out* and errors are logged in *Log*.
697 This utility is very robust and pretty smart about determining the
698 type of the entry. It includes facilities for expanding refer macros
699 to text, or substituting bibtex macros. Do M-x describe-variable on
701 r2b-booktitle-abbrevs
703 for information on these features.
705 If you don't want to see this help message when you load this utility,
706 then include the following line in your .emacs file:
707 (setq r2b-load-quietly t)
708 To see this message again, perform
713 "Print help message."
715 (with-output-to-temp-buffer "*Help*"
716 (princ r2b-help-message)))
718 (if (not r2b-load-quietly)
721 (message "r2b loaded")
723 (provide 'refer-to-bibtex)
725 ;;; refbib.el ends here