Switch to recommended form of GPLv3 permissions notice.
[bpt/emacs.git] / lisp / textmodes / refbib.el
CommitLineData
6594deb0
ER
1;;; refbib.el --- convert refer-style references to ones usable by Latex bib
2
f2e3589a 3;; Copyright (C) 1989, 2001, 2002, 2003, 2004, 2005,
12dc447f 4;; 2006, 2007, 2008 Free Software Foundation, Inc.
9750e079 5
56c586a8 6;; Author: Henry Kautz <kautz@research.att.com>
e3854e65 7;; Maintainer: FSF
56c586a8 8;; Keywords: bib, tex
e5167999 9
a2535589
JA
10;; This file is part of GNU Emacs.
11
1fecc8fe 12;; GNU Emacs is free software: you can redistribute it and/or modify
a2535589 13;; it under the terms of the GNU General Public License as published by
1fecc8fe
GM
14;; the Free Software Foundation, either version 3 of the License, or
15;; (at your option) any later version.
a2535589
JA
16
17;; GNU Emacs is distributed in the hope that it will be useful,
18;; but WITHOUT ANY WARRANTY; without even the implied warranty of
19;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
20;; GNU General Public License for more details.
21
22;; You should have received a copy of the GNU General Public License
1fecc8fe 23;; along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>.
a2535589 24
e5167999
ER
25;;; Commentary:
26
a2535589
JA
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*.
31
e5167999
ER
32;;; Change Log:
33
b578f267
EN
34;; HISTORY
35;; 9/88, created H.Kautz
36;; modified 1/19/89, allow books with editor but no author;
37;; added %O ordering field;
5181ff9f 38;; appended invalid multiple fields, instead of
b578f267
EN
39;; discarding;
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
43;; or a proceedings
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 capitalize-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
e5167999
ER
56
57;;; Code:
58
a2535589
JA
59;**********************************************************
60; User Parameters
61
d1ebc62e
SE
62(defgroup refbib nil
63 "Convert refer-style references to ones usable by Latex bib."
64 :prefix "r2b-"
65 :group 'wp)
66
67(defcustom r2b-trace-on nil
68 "*Non-nil means trace conversion."
69 :type 'boolean
70 :group 'refbib)
71
72(defcustom r2b-journal-abbrevs
db95369b 73 '(
d1ebc62e 74 )
db95369b 75 "Abbreviation list for journal names.
a2535589
JA
76If the car of an element matches a journal name exactly, it is replaced by
77the cadr when output. Braces must be included if replacement is a
78{string}, but not if replacement is a bibtex abbreviation. The cadr
db95369b 79may be eliminated if is exactly the same as the car.
a2535589 80 Because titles are capitalized before matching, the abbreviation
db95369b 81for the journal name should be listed as beginning with a capital
a2535589
JA
82letter, even if it really doesn't.
83 For example, a value of '((\"Aij\" \"{Artificial Intelligence}\")
a4e104bf 84\(\"Ijcai81\" \"ijcai7\")) would expand Aij to the text string
db95369b 85\"Artificial Intelligence\", but would replace Ijcai81 with the
d1ebc62e
SE
86BibTeX macro \"ijcai7\"."
87 :type '(repeat (list string string))
88 :group 'refbib)
89
db95369b
JB
90(defcustom r2b-booktitle-abbrevs
91 '(
d1ebc62e
SE
92 )
93 "Abbreviation list for book and proceedings names.
94If the car of an element matches a title or booktitle exactly, it is
95replaced by the cadr when output. Braces must be included if
96replacement is a {string}, but not if replacement is a bibtex
97abbreviation. The cadr may be eliminated if is exactly the same as
98the car.
a2535589
JA
99 Because titles are capitalized before matching, the abbreviated title
100should be listed as beginning with a capital letter, even if it doesn't.
101 For example, a value of '((\"Aij\" \"{Artificial Intelligence}\")
a4e104bf 102\(\"Ijcai81\" \"ijcai7\")) would expand Aij to the text string
db95369b 103\"Artificial Intelligence\", but would replace Ijcai81 with the
d1ebc62e
SE
104BibTeX macro \"ijcai7\"."
105 :type '(repeat (list string string))
106 :group 'refbib)
a2535589 107
d1ebc62e
SE
108(defcustom r2b-proceedings-list
109 '()
110 "Assoc list of books or journals which are really conference proceedings,
14c5b721
JB
111but whose name and whose abbrev expansion (as defined in `r2b-journal-abbrevs'
112and `r2b-booktitle-abbrevs') does not contain the words \"conference\" or
113\"proceedings\". (Those cases are handled automatically.)
a2535589 114The entry must match the given data exactly.
db95369b 115 Because titles are capitalized before matching, the items in this list
a2535589
JA
116should begin with a capital letter.
117 For example, suppose the title \"Ijcai81\" is used for the proceedings of
7635fc7c 118a conference, and its expansion is the BibTeX macro \"ijcai7\". Then
14c5b721 119`r2b-proceedings-list' should be '((\"Ijcai81\") ...). If instead its
a2535589 120expansion were \"Proceedings of the Seventh International Conference
14c5b721 121on Artificial Intelligence\", then you would NOT need to include Ijcai81
d1ebc62e
SE
122in `r2b-proceedings-list' (although it wouldn't cause an error)."
123 :type '(repeat (list string string))
124 :group 'refbib)
a2535589
JA
125
126(defvar r2b-additional-stop-words
d1ebc62e
SE
127 "Some\\|What"
128 "Words not to be used to build the citation key.
e9dac1e1 129This is in addition to the `r2b-capitalize-title-stop-words'.")
a2535589 130
d1ebc62e
SE
131(defcustom r2b-delimit-with-quote t
132 "*If true, then use \" to delimit fields, otherwise use braces."
133 :type 'boolean
134 :group 'refbib)
a2535589
JA
135
136;**********************************************************
137; Utility Functions
138
e9dac1e1 139(defvar r2b-capitalize-title-stop-words
a2535589
JA
140 (concat
141 "the\\|and\\|of\\|is\\|a\\|an\\|of\\|for\\|in\\|to\\|in\\|on\\|at\\|"
142 "by\\|with\\|that\\|its")
e9dac1e1 143 "Words not to be capitalized in a title (unless the first word).")
a2535589 144
e9dac1e1
RS
145(defvar r2b-capitalize-title-stop-regexp
146 (concat "\\(" r2b-capitalize-title-stop-words "\\)\\(\\b\\|'\\)"))
a2535589 147
e9dac1e1 148(defun r2b-capitalize-title-region (begin end)
14c5b721 149 "Like `capitalize-region', but don't capitalize stop words, except the first."
a2535589
JA
150 (interactive "r")
151 (let ((case-fold-search nil) (orig-syntax-table (syntax-table)))
152 (unwind-protect
153 (save-restriction
154 (set-syntax-table text-mode-syntax-table)
155 (narrow-to-region begin end)
156 (goto-char (point-min))
157 (if (looking-at "[A-Z][a-z]*[A-Z]")
158 (forward-word 1)
159 (capitalize-word 1))
160 (while (re-search-forward "\\<" nil t)
161 (if (looking-at "[A-Z][a-z]*[A-Z]")
162 (forward-word 1)
163 (if (let ((case-fold-search t))
e9dac1e1 164 (looking-at r2b-capitalize-title-stop-regexp))
a2535589
JA
165 (downcase-word 1)
166 (capitalize-word 1)))
167 ))
168 (set-syntax-table orig-syntax-table))))
169
170
e9dac1e1
RS
171(defun r2b-capitalize-title (s)
172 "Like `capitalize', but don't capitalize stop words, except the first."
a2535589
JA
173 (save-excursion
174 (set-buffer (get-buffer-create "$$$Scratch$$$"))
175 (erase-buffer)
176 (insert s)
e9dac1e1 177 (r2b-capitalize-title-region (point-min) (point-max))
a2535589
JA
178 (buffer-string)))
179
180;*********************************************************
181(defun r2b-reset ()
14c5b721 182 "Unbind defvars, for debugging."
a2535589
JA
183 (interactive)
184 (makunbound 'r2b-journal-abbrevs)
185 (makunbound 'r2b-booktitle-abbrevs)
186 (makunbound 'r2b-proceedings-list)
e9dac1e1
RS
187 (makunbound 'r2b-capitalize-title-stop-words)
188 (makunbound 'r2b-capitalize-title-stop-regexp)
a2535589 189 (makunbound 'r2b-additional-stop-words)
14c5b721 190 (makunbound 'r2b-stop-regexp))
a2535589
JA
191
192(defvar r2b-stop-regexp
db95369b 193 (concat "\\`\\(\\("
e9dac1e1 194 r2b-additional-stop-words "\\|" r2b-capitalize-title-stop-words
a2535589
JA
195 "\\)\\('\\w*\\)?\\W+\\)*\\([A-Z0-9]+\\)"))
196
197
198(defun r2b-trace (&rest args)
199 (if r2b-trace-on
200 (progn
201 (apply (function message) args)
14c5b721 202 (sit-for 0))))
a2535589
JA
203
204(defun r2b-match (exp)
14c5b721 205 "Returns string matched in current buffer."
a2535589
JA
206 (buffer-substring (match-beginning exp) (match-end exp)))
207
d1ebc62e
SE
208(defcustom r2b-out-buf-name "*Out*"
209 "*Name of buffer for output from refer-to-bibtex."
210 :type 'string
211 :group 'refbib)
212
213(defcustom r2b-log-name "*Log*"
214 "*Name of buffer for logs errors from refer-to-bibtex."
215 :type 'string
216 :group 'refbib)
217
a2535589
JA
218(defvar r2b-in-buf nil)
219(defvar r2b-out-buf nil)
220(defvar r2b-log nil)
221
222(defvar r2b-error-found nil)
223
0c86715d
DN
224(defvar r2b-variables) (defvar r2bv-address) (defvar r2bv-annote)
225(defvar r2bv-author) (defvar r2bv-booktitle) (defvar r2bv-date)
226(defvar r2bv-decade) (defvar r2bv-editor) (defvar r2bv-entry-kind)
227(defvar r2bv-institution) (defvar r2bv-journal) (defvar r2bv-keywords)
228(defvar r2bv-kn) (defvar r2bv-month) (defvar r2bv-note)
229(defvar r2bv-number) (defvar r2bv-ordering) (defvar r2bv-organization)
230(defvar r2bv-pages) (defvar r2bv-primary-author) (defvar r2bv-publisher)
231(defvar r2bv-school) (defvar r2bv-title) (defvar r2bv-title-first-word)
232(defvar r2bv-tr) (defvar r2bv-type) (defvar r2bv-volume)
233(defvar r2bv-where) (defvar r2bv-year)
177a0809 234
a2535589 235(setq r2b-variables '(
177a0809
JB
236 r2b-error-found
237 r2bv-author
238 r2bv-primary-author
239 r2bv-date
240 r2bv-year
241 r2bv-decade
242 r2bv-month
243 r2bv-title
244 r2bv-title-first-word
245 r2bv-editor
246 r2bv-annote
247 r2bv-tr
248 r2bv-address
249 r2bv-institution
250 r2bv-keywords
251 r2bv-booktitle
252 r2bv-journal
253 r2bv-volume
254 r2bv-number
255 r2bv-pages
256 r2bv-booktitle
257 r2bv-kn
258 r2bv-publisher
259 r2bv-organization
260 r2bv-school
261 r2bv-type
262 r2bv-where
263 r2bv-note
264 r2bv-ordering
265 ))
a2535589
JA
266
267(defun r2b-clear-variables ()
14c5b721 268 "Set all global vars used by r2b to nil."
a2535589
JA
269 (let ((vars r2b-variables))
270 (while vars
271 (set (car vars) nil)
14c5b721 272 (setq vars (cdr vars)))))
a2535589
JA
273
274(defun r2b-warning (&rest args)
275 (setq r2b-error-found t)
276 (princ (apply (function format) args) r2b-log)
277 (princ "\n" r2b-log)
278 (princ "\n" r2b-out-buf)
279 (princ "% " r2b-out-buf)
14c5b721 280 (princ (apply (function format) args) r2b-out-buf))
a2535589
JA
281
282(defun r2b-get-field (var field &optional unique required capitalize)
283 "Set VAR to string value of FIELD, if any. If none, VAR is set to
284nil. If multiple fields appear, then separate values with the
285'\\nand\\t\\t', unless UNIQUE is non-nil, in which case log a warning
286and just concatenate the values. Trim off leading blanks and tabs on
287first line, and trailing blanks and tabs of every line. Log a warning
288and set VAR to the empty string if REQUIRED is true. Capitalize as a
289title if CAPITALIZE is true. Returns value of VAR."
290 (let (item val (not-past-end t))
291 (r2b-trace "snarfing %s" field)
292 (goto-char (point-min))
293 (while (and not-past-end
db95369b 294 (re-search-forward
a2535589
JA
295 (concat "^" field "\\b[ \t]*\\(.*[^ \t\n]\\)[ \t]*") nil t))
296 (setq item (r2b-match 1))
297 (while (and (setq not-past-end (zerop (forward-line 1)))
298 (not (looking-at "[ \t]*$\\|%")))
299 (looking-at "\\(.*[^ \t\n]\\)[ \t]*$")
300 (setq item (concat item "\n" (r2b-match 1)))
301 )
302 (if (null val)
303 (setq val item)
304 (if unique
305 (progn
5181ff9f 306 (r2b-warning "*Invalid multiple field %s %s" field item)
a2535589
JA
307 (setq val (concat val "\n" item))
308 )
309 (setq val (concat val "\n\t\tand " item))
310 )
311 )
312 )
313 (if (and val capitalize)
e9dac1e1 314 (setq val (r2b-capitalize-title val)))
a2535589
JA
315 (set var val)
316 (if (and (null val) required)
317 (r2b-require var))
318 ))
319
320(defun r2b-set-match (var n regexp string )
14c5b721 321 "Set VAR to the Nth subpattern in REGEXP matched by STRING, or nil if none."
a2535589
JA
322 (set var
323 (if (and (stringp string) (string-match regexp string))
324 (substring string (match-beginning n) (match-end n))
325 nil)
326 )
327 )
328
329(defvar r2b-month-abbrevs
330 '(("jan") ("feb") ("mar") ("apr") ("may") ("jun") ("jul") ("aug")
331 ("sep") ("oct") ("nov") ("dec")))
332
333(defun r2b-convert-month ()
14c5b721 334 "Try to convert `r2bv-month' to a standard 3 letter name."
a2535589
JA
335 (if r2bv-month
336 (let ((months r2b-month-abbrevs))
337 (if (string-match "[^0-9]" r2bv-month)
338 (progn
db95369b 339 (while (and months (not (string-match (car (car months))
a2535589
JA
340 r2bv-month)))
341 (setq months (cdr months)))
342 (if months
343 (setq r2bv-month (car (car months)))))
344 (progn
345 (setq months (car (read-from-string r2bv-month)))
346 (if (and (numberp months)
347 (> months 0)
348 (< months 13))
349 (setq r2bv-month (car (nth months r2b-month-abbrevs)))
350 (progn
351 (r2b-warning "* Ridiculous month")
352 (setq r2bv-month nil))
353 ))
354 ))
355 )
356 )
357
358(defun r2b-snarf-input ()
14c5b721 359 "Parse buffer into global variables."
a2535589
JA
360 (let ((case-fold-search t))
361 (r2b-trace "snarfing...")
362 (sit-for 0)
363 (set-buffer r2b-in-buf)
364 (goto-char (point-min))
365 (princ " " r2b-log)
366 (princ (buffer-substring (point) (progn (end-of-line) (point))) r2b-log)
367 (terpri r2b-log)
368
369 (r2b-get-field 'r2bv-author "%A")
370 (r2b-get-field 'r2bv-editor "%E")
371 (cond
372 (r2bv-author
373 (r2b-set-match 'r2bv-primary-author 1
374 "\\b\\(\\w+\\)[ \t]*\\($\\|,\\)" r2bv-author)
375 )
376 (r2bv-editor
377 (r2b-set-match 'r2bv-primary-author 1
378 "\\b\\(\\w+\\)[ \t]*\\($\\|,\\)" r2bv-editor)
379 )
380 (t
381 (setq r2bv-primary-author "")
382 )
383 )
384
385 (r2b-get-field 'r2bv-date "%D" t t)
386 (r2b-set-match 'r2bv-year 0 "[12][0-9][0-9][0-9]" r2bv-date)
387 (and (null r2bv-year)
388 (r2b-set-match 'r2bv-year 1 "[^0-9]\\([0-9][0-9]\\)$" r2bv-date)
389 (setq r2bv-year (concat "19" r2bv-year)))
390 (r2b-set-match 'r2bv-decade 1 "..\\(..\\)" r2bv-year)
391 (r2b-set-match 'r2bv-month 0
392 "[0-9]+/\\|[a-zA-Z]+" r2bv-date)
393 (if (and (stringp r2bv-month) (string-match "\\(.*\\)/$" r2bv-month))
394 (setq r2bv-month (substring r2bv-month 0 (match-end 1))))
395 (r2b-convert-month)
396
397 (r2b-get-field 'r2bv-title "%T" t t t)
398 (r2b-set-match 'r2bv-title-first-word 4
399 r2b-stop-regexp
400 r2bv-title)
db95369b 401
a2535589
JA
402 (r2b-get-field 'r2bv-annote "%X" t )
403 (r2b-get-field 'r2bv-tr "%R" t)
404 (r2b-get-field 'r2bv-address "%C" t)
405 (r2b-get-field 'r2bv-institution "%I" t)
406 (r2b-get-field 'r2bv-keywords "%K")
407 (r2b-get-field 'r2bv-booktitle "%B" t nil t)
408 (r2b-get-field 'r2bv-journal "%J" t nil t)
409 (r2b-get-field 'r2bv-volume "%V" t)
410 (r2b-get-field 'r2bv-number "%N" t)
411 (r2b-get-field 'r2bv-pages "%P" t)
412 (r2b-get-field 'r2bv-where "%W" t)
413 (r2b-get-field 'r2bv-ordering "%O" t)
414 )
415 )
416
417
418(defun r2b-put-field (field data &optional abbrevs)
14c5b721 419 "Print bibtex FIELD = {DATA} if DATA not null; precede
a2535589 420with a comma and newline; if ABBREVS list is given, then
14c5b721 421try to replace the {DATA} with an abbreviation."
a2535589
JA
422 (if data
423 (let (match nodelim multi-line index)
424 (cond
425 ((and abbrevs (setq match (assoc data abbrevs)))
426 (if (null (cdr match))
427 (setq data (car match))
428 (setq data (car (cdr match))))
429 (setq nodelim t))
430 ((and (not (equal data ""))
431 (not (string-match "[^0-9]" data)))
432 (setq nodelim t))
433 (t
434 (setq index 0)
435 (while (string-match "[\\~^]" data index)
436 (setq data (concat (substring data 0 (match-beginning 0))
437 "\\verb+"
438 (substring data (match-beginning 0) (match-end 0))
439 "+"
440 (substring data (match-end 0))))
441 (setq index (+ (match-end 0) 7)))
442 (setq index 0)
443 (while (string-match "[$&%#_{}]" data index)
444 (setq data (concat (substring data 0 (match-beginning 0))
445 "\\"
446 (substring data (match-beginning 0))))
447 (setq index (+ (match-end 0) 1)))
448 (setq index 0)
449 (if r2b-delimit-with-quote
450 (while (string-match "\"" data index)
451 (setq data (concat (substring data 0 (match-beginning 0))
452 "{\"}"
453 (substring data (match-end 0))))
454 (setq index (+ (match-end 0) 2))))
455 ))
456 (princ ", \n ")
457 (princ field)
458 (princ " =\t")
db95369b 459 (if (not nodelim)
a2535589
JA
460 (if r2b-delimit-with-quote
461 (princ "\"")
462 (princ "{")))
463 (string-match ".*" data)
464 (if (> (match-end 0) 59)
465 (princ "\n"))
466 (princ data)
db95369b 467 (if (not nodelim)
a2535589
JA
468 (if r2b-delimit-with-quote
469 (princ "\"")
470 (princ "}")))
471 )
472 ))
473
474
475(defun r2b-require (vars)
14c5b721 476 "If any of VARS is null, set to empty string and log error."
db95369b 477 (cond
a2535589
JA
478 ((null vars))
479 ((listp vars) (r2b-require (car vars)) (r2b-require (cdr vars)))
480 (t
481 (if (null (symbol-value vars))
482 (progn
483 (r2b-warning "*Missing value for field %s" vars)
484 (set vars "")
485 )))
486 )
487 )
488
489
490(defmacro r2b-moveq (new old)
14c5b721 491 "Set NEW to OLD and set OLD to nil."
a2535589
JA
492 (list 'progn (list 'setq new old) (list 'setq old 'nil)))
493
494(defun r2b-isa-proceedings (name)
14c5b721 495 "Return t if NAME is the name of proceedings."
a2535589
JA
496 (and
497 name
498 (or
499 (string-match "proceedings\\|conference" name)
500 (assoc name r2b-proceedings-list)
501 (let ((match (assoc name r2b-booktitle-abbrevs)))
502 (and match
503 (string-match "proceedings\\|conference" (car (cdr match)))))
504 )))
505
506(defun r2b-isa-university (name)
14c5b721
JB
507 "Return t if NAME is a university or similar organization,
508but not a publisher."
db95369b 509 (and
a2535589
JA
510 name
511 (string-match "university" name)
512 (not (string-match "press" name))
513
514 ))
515
516(defun r2b-barf-output ()
14c5b721 517 "Generate bibtex based on global variables."
a2535589
JA
518 (let ((standard-output r2b-out-buf) (case-fold-search t) match)
519
520 (r2b-trace "...barfing")
521 (sit-for 0)
522 (set-buffer r2b-out-buf)
523
524 (setq r2bv-kn (concat r2bv-primary-author r2bv-decade
525 r2bv-title-first-word))
db95369b 526
a2535589 527 (setq r2bv-entry-kind
db95369b 528 (cond
a2535589
JA
529 ((r2b-isa-proceedings r2bv-journal)
530 (r2b-moveq r2bv-booktitle r2bv-journal)
531 (if (r2b-isa-university r2bv-institution)
532 (r2b-moveq r2bv-organization r2bv-institution)
533 (r2b-moveq r2bv-publisher r2bv-institution))
534 (r2b-moveq r2bv-note r2bv-tr)
535 (r2b-require 'r2bv-author)
536 'inproceedings)
537 ((r2b-isa-proceedings r2bv-booktitle)
538 (if (r2b-isa-university r2bv-institution)
539 (r2b-moveq r2bv-organization r2bv-institution)
540 (r2b-moveq r2bv-publisher r2bv-institution))
541 (r2b-moveq r2bv-note r2bv-tr)
542 (r2b-require 'r2bv-author)
543 'inproceedings)
544 ((and r2bv-tr (string-match "phd" r2bv-tr))
545 (r2b-moveq r2bv-school r2bv-institution)
546 (r2b-require 'r2bv-school )
547 (r2b-require 'r2bv-author)
548 'phdthesis)
549 ((and r2bv-tr (string-match "master" r2bv-tr))
550 (r2b-moveq r2bv-school r2bv-institution)
551 (r2b-require 'r2bv-school )
552 (r2b-require 'r2bv-author)
553 'mastersthesis)
554 ((and r2bv-tr (string-match "draft\\|unpublish" r2bv-tr))
555 (r2b-moveq r2bv-note r2bv-institution)
556 (r2b-require 'r2bv-author)
557 'unpublished)
558 (r2bv-journal
559 (r2b-require 'r2bv-author)
560 'article)
561 (r2bv-booktitle
562 (r2b-moveq r2bv-publisher r2bv-institution)
563 (r2b-moveq r2bv-note r2bv-tr)
564 (r2b-require 'r2bv-publisher)
565 (r2b-require 'r2bv-author)
566 'incollection)
567 ((and r2bv-author
568 (null r2bv-editor)
569 (string-match "\\`personal communication\\'" r2bv-title))
570 'misc)
571 ((r2b-isa-proceedings r2bv-title)
572 (if (r2b-isa-university r2bv-institution)
573 (r2b-moveq r2bv-organization r2bv-institution)
574 (r2b-moveq r2bv-publisher r2bv-institution))
575 (r2b-moveq r2bv-note r2bv-tr)
576 'proceedings)
577 ((or r2bv-editor
578 (and r2bv-author
db95369b 579 (or
a2535589
JA
580 (null r2bv-tr)
581 (string-match "\\bisbn\\b" r2bv-tr))))
582 (r2b-moveq r2bv-publisher r2bv-institution)
583 (r2b-moveq r2bv-note r2bv-tr)
584 (r2b-require 'r2bv-publisher)
585 (if (null r2bv-editor)
586 (r2b-require 'r2bv-author))
587 'book)
588 (r2bv-tr
589 (r2b-require 'r2bv-institution)
db95369b
JB
590 (if (string-match
591 "\\`\\(\\(.\\|\n\\)+\\)[ \t\n]+\\([^ \t\n]\\)+\\'"
a2535589
JA
592 r2bv-tr)
593 (progn
594 (setq r2bv-type (substring r2bv-tr 0 (match-end 1)))
db95369b 595 (setq r2bv-number (substring r2bv-tr
a2535589
JA
596 (match-beginning 3)))
597 (setq r2bv-tr nil))
598 (r2b-moveq r2bv-number r2bv-tr))
599 (r2b-require 'r2bv-author)
600 'techreport)
601 (r2bv-institution
602 (r2b-moveq r2bv-organization r2bv-institution)
603 'manual)
604 (t
605 'misc)
606 ))
607
608 (r2b-require '( r2bv-year))
609
610 (if r2b-error-found
611 (princ "\n% Warning -- Errors During Conversion Next Entry\n"))
612
613 (princ "\n@")
614 (princ r2bv-entry-kind)
615 (princ "( ")
616 (princ r2bv-kn)
617
618 (r2b-put-field "author" r2bv-author )
619 (r2b-put-field "title" r2bv-title r2b-booktitle-abbrevs)
620 (r2b-put-field "year" r2bv-year )
621
622 (r2b-put-field "month" r2bv-month r2b-month-abbrevs)
623 (r2b-put-field "journal" r2bv-journal r2b-journal-abbrevs)
624 (r2b-put-field "volume" r2bv-volume)
625 (r2b-put-field "type" r2bv-type)
626 (r2b-put-field "number" r2bv-number)
627 (r2b-put-field "booktitle" r2bv-booktitle r2b-booktitle-abbrevs)
628 (r2b-put-field "editor" r2bv-editor)
629 (r2b-put-field "publisher" r2bv-publisher)
630 (r2b-put-field "institution" r2bv-institution)
631 (r2b-put-field "organization" r2bv-organization)
632 (r2b-put-field "school" r2bv-school)
633 (r2b-put-field "pages" r2bv-pages)
634 (r2b-put-field "address" r2bv-address)
635 (r2b-put-field "note" r2bv-note)
636 (r2b-put-field "keywords" r2bv-keywords)
637 (r2b-put-field "where" r2bv-where)
638 (r2b-put-field "ordering" r2bv-ordering)
639 (r2b-put-field "annote" r2bv-annote)
640
641 (princ " )\n")
642 )
643 )
644
645
177a0809
JB
646(defun r2b-convert-record (output)
647 "Transform current bib entry and append to buffer OUTPUT.
648Do `\\[r2b-help]' for more info."
db95369b 649 (interactive
a2535589
JA
650 (list (read-string "Output to buffer: " r2b-out-buf-name)))
651 (let (rec-end rec-begin not-done)
177a0809
JB
652 (setq r2b-out-buf-name output)
653 (setq r2b-out-buf (get-buffer-create output))
a2535589
JA
654 (setq r2b-in-buf (current-buffer))
655 (set-buffer r2b-out-buf)
656 (goto-char (point-max))
657 (setq r2b-log (get-buffer-create r2b-log-name))
658 (set-buffer r2b-log)
659 (goto-char (point-max))
660 (set-buffer r2b-in-buf)
661 (setq not-done (re-search-forward "[^ \t\n]" nil t))
662 (if not-done
663 (progn
664 (re-search-backward "^[ \t]*$" nil 2)
665 (re-search-forward "^%")
666 (beginning-of-line nil)
667 (setq rec-begin (point))
668 (re-search-forward "^[ \t]*$" nil 2)
669 (setq rec-end (point))
670 (narrow-to-region rec-begin rec-end)
671 (r2b-clear-variables)
672 (r2b-snarf-input)
673 (r2b-barf-output)
674 (set-buffer r2b-in-buf)
675 (widen)
676 (goto-char rec-end)
677 t)
678 nil
679 )
680 ))
db95369b
JB
681
682
177a0809 683(defun r2b-convert-buffer (output)
1fc4747e 684 "Transform current buffer and append to buffer OUTPUT.
177a0809 685Do `\\[r2b-help]' for more info."
db95369b 686 (interactive
a2535589
JA
687 (list (read-string "Output to buffer: " r2b-out-buf-name)))
688 (save-excursion
689 (setq r2b-log (get-buffer-create r2b-log-name))
690 (set-buffer r2b-log)
691 (erase-buffer))
692 (widen)
693 (goto-char (point-min))
694 (message "Working, please be patient...")
695 (sit-for 0)
177a0809 696 (while (r2b-convert-record output) t)
db95369b 697 (message "Done, results in %s, errors in %s"
a2535589
JA
698 r2b-out-buf-name r2b-log-name)
699 )
700
a2535589
JA
701(defvar r2b-help-message
702" Refer to Bibtex Bibliography Conversion
703
704A refer-style database is of the form:
705
706%A Joe Blow
707%T Great Thoughts I've Thought
708%D 1977
709etc.
710
711This utility converts these kind of databases to bibtex form, for
712users of TeX and LaTex. Instructions:
7131. Visit the file containing the refer-style database.
7142. The command
715 M-x r2b-convert-buffer
7635fc7c 716 converts the entire buffer, appending its output by default in a
a2535589
JA
717 buffer named *Out*, and logging progress and errors in a buffer
718 named *Log*. The original file is never modified.
719 Note that results are appended to *Out*, so if that buffer
720 buffer already exists and contains material you don't want to
721 save, you should kill it first.
7223. Switch to the buffer *Out* and save it as a named file.
7234. To convert a single refer-style entry, simply position the cursor
724 at the entry and enter
725 M-x r2b-convert-record
726 Again output is appended to *Out* and errors are logged in *Log*.
727
728This utility is very robust and pretty smart about determining the
729type of the entry. It includes facilities for expanding refer macros
730to text, or substituting bibtex macros. Do M-x describe-variable on
731 r2b-journal-abbrevs
732 r2b-booktitle-abbrevs
733 r2b-proceedings-list
734for information on these features.
735
56c586a8
ER
736Please send bug reports and suggestions to
737 Henry Kautz
738 kautz@research.att.com
739 allegra!kautz")
a2535589
JA
740
741
742(defun r2b-help ()
1fc4747e 743 "Print help describing the `refbib' package."
a2535589
JA
744 (interactive)
745 (with-output-to-temp-buffer "*Help*"
6d94c1b4
KH
746 (princ r2b-help-message)
747 (save-excursion
748 (set-buffer standard-output)
749 (help-mode))))
a2535589 750
1fc4747e 751(provide 'refbib)
49116ac0 752(provide 'refer-to-bibtex)
6594deb0 753
cbee283d 754;; arch-tag: 664afee2-6e76-4408-ba56-981d8a179586
6594deb0 755;;; refbib.el ends here