1 ;;; bib-mode.el --- bib-mode, major mode for editing bib files.
3 ;; Copyright (C) 1989 Free Software Foundation, Inc.
8 ;; This file is part of GNU Emacs.
10 ;; GNU Emacs is free software; you can redistribute it and/or modify
11 ;; it under the terms of the GNU General Public License as published by
12 ;; the Free Software Foundation; either version 2, or (at your option)
15 ;; GNU Emacs is distributed in the hope that it will be useful,
16 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
17 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
18 ;; GNU General Public License for more details.
20 ;; You should have received a copy of the GNU General Public License
21 ;; along with GNU Emacs; see the file COPYING. If not, write to
22 ;; the Free Software Foundation, 675 Mass Ave, Cambridge, MA 02139, USA.
26 ;; GNU Emacs code to help maintain databases compatible with (troff)
27 ;; refer and lookbib. The file bib-file should be set to your
28 ;; bibliography file. Keys are automagically inserted as you type,
29 ;; and appropriate keys are presented for various kinds of entries.
33 (defvar bib-file "~/my-bibliography.bib"
34 "Default name of file used by `addbib'.")
36 (defvar unread-bib-file "~/to-be-read.bib"
37 "Default name of file used by `unread-bib' in Bib mode.")
39 (defvar bib-mode-map (copy-keymap text-mode-map))
40 (define-key bib-mode-map "\C-M" 'return-key-bib)
41 (define-key bib-mode-map "\C-c\C-u" 'unread-bib)
42 (define-key bib-mode-map "\C-c\C-@" 'mark-bib)
43 (define-key bib-mode-map "\e`" 'abbrev-mode)
44 (defvar bib-mode-abbrev-table nil
45 "Abbrev table used in Bib mode")
48 "Set up editor to add to troff bibliography file specified
49 by global variable `bib-file'. See description of `bib-mode'."
52 (goto-char (point-max))
57 "Mode for editing `lookbib' style bibliographies.
58 Hit RETURN to get next % field key.
59 If you want to ignore this field, just hit RETURN again.
60 Use `text-mode' to turn this feature off.
62 journal papers: A* T D J V N P K W X
63 articles in books & proceedings: A* T D B E* I C P K W X
64 tech reports: A* T D R I C K W X
65 books: A* T D I C K W X
69 A uthor T itle D ate J ournal
70 V olume N umber P age K eywords
71 B in book or proceedings E ditor C ity & state
72 I nstitution, school, or publisher
73 R eport number or 'phd thesis' or 'masters thesis' or 'draft' or
74 'unnumbered' or 'unpublished'
75 W here can be found locally (login name, or ailib, etc.)
76 X comments (not used in indexing)
78 \\[unread-bib] appends current entry to a different file (for example,
79 a file of papers to be read in the future), given by the value of the
80 variable `unread-bib-file'.
81 \\[mark-bib] marks current or previous entry.
82 Abbreviations are saved in `bib-mode-abbrev-table'.
83 Hook can be stored in `bib-mode-hook'.
84 Field keys given by variable `bib-assoc'.
91 (use-local-map bib-mode-map)
92 (setq mode-name "Bib")
93 (setq major-mode 'bib-mode)
94 (define-abbrev-table 'bib-mode-abbrev-table ())
95 (setq local-abbrev-table bib-mode-abbrev-table)
97 (run-hooks 'bib-mode-hook)
100 (defconst bib-assoc '(
123 "Describes bibliographic database format. A line beginning with
124 the car of an entry is followed by one beginning with the cdr.
127 (defun bib-find-key (slots)
132 (progn (previous-line 1) (bib-find-key bib-assoc))))
133 ((looking-at (car (car slots)))
135 (t (bib-find-key (cdr slots)))
139 (defvar bib-auto-capitalize t
140 "*True to automatically capitalize appropriate fields in Bib mode.")
142 (defconst bib-capitalized-fields "%[AETCBIJR]")
144 (defun return-key-bib ()
145 "Magic when user hits return, used by `bib-mode'."
148 (let (empty new-key beg-current end-current)
150 (setq empty (looking-at "%. $"))
158 (setq end-current (point))
160 (setq beg-current (point))
161 (setq new-key (bib-find-key bib-assoc))
162 (if (and (not empty) bib-auto-capitalize
163 (looking-at bib-capitalized-fields))
165 (capitalize-title-region (+ (point) 3) end-current)))
166 (goto-char beg-current)
171 (insert-string new-key))
175 "Set mark at beginning of current or previous bib entry, point at end."
177 (beginning-of-line nil)
178 (if (looking-at "^ *$") (re-search-backward "[^ \n]" nil 2))
179 (re-search-backward "^ *$" nil 2)
180 (re-search-forward "^%")
181 (beginning-of-line nil)
183 (re-search-forward "^ *$" nil 2)
185 (beginning-of-line nil))
188 "Append current or previous entry to file of unread papers
189 named by variable `unread-bib-file'."
192 (if (get-file-buffer unread-bib-file)
193 (append-to-buffer (get-file-buffer unread-bib-file) (mark) (point))
194 (append-to-file (mark) (point) unread-bib-file)))
197 (defvar capitalize-title-stop-words
199 "the\\|and\\|of\\|is\\|a\\|an\\|of\\|for\\|in\\|to\\|in\\|on\\|at\\|"
200 "by\\|with\\|that\\|its")
201 "Words not to be capitalized in a title (unless they're the first word
204 (defvar capitalize-title-stop-regexp
205 (concat "\\(" capitalize-title-stop-words "\\)\\(\\b\\|'\\)"))
207 (defun capitalize-title-region (begin end)
208 "Like `capitalize-region', but don't capitalize stop words, except the first."
210 (let ((case-fold-search nil) (orig-syntax-table (syntax-table)))
213 (set-syntax-table text-mode-syntax-table)
214 (narrow-to-region begin end)
215 (goto-char (point-min))
216 (if (looking-at "[A-Z][a-z]*[A-Z]")
219 (while (re-search-forward "\\<" nil t)
220 (if (looking-at "[A-Z][a-z]*[A-Z]")
222 (if (let ((case-fold-search t))
223 (looking-at capitalize-title-stop-regexp))
225 (capitalize-word 1)))
227 (set-syntax-table orig-syntax-table))))
230 (defun capitalize-title (s)
231 "Like `capitalize', but don't capitalize stop words, except the first."
233 (set-buffer (get-buffer-create "$$$Scratch$$$"))
236 (capitalize-title-region (point-min) (point-max))
241 ;;; bib-mode.el ends here