1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
|
;;; bib-mode.el --- major mode for editing bib files -*- lexical-binding: t -*-
;; Copyright (C) 1989, 2001-2021 Free Software Foundation, Inc.
;; Author: Henry Kautz
;; (according to authors.el)
;; Maintainer: emacs-devel@gnu.org
;; Keywords: bib
;; This file is part of GNU Emacs.
;; GNU Emacs is free software: you can redistribute it and/or modify
;; it under the terms of the GNU General Public License as published by
;; the Free Software Foundation, either version 3 of the License, or
;; (at your option) any later version.
;; GNU Emacs is distributed in the hope that it will be useful,
;; but WITHOUT ANY WARRANTY; without even the implied warranty of
;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
;; GNU General Public License for more details.
;; You should have received a copy of the GNU General Public License
;; along with GNU Emacs. If not, see <https://www.gnu.org/licenses/>.
;;; Commentary:
;; GNU Emacs code to help maintain databases compatible with (troff)
;; refer and lookbib. The file bib-file should be set to your
;; bibliography file. Keys are automagically inserted as you type,
;; and appropriate keys are presented for various kinds of entries.
;; FIXME: Fix the namespace use of this library.
;;; Code:
(defgroup bib nil
"Major mode for editing bib files."
:prefix "bib-"
:group 'external
:group 'text)
(defcustom bib-file "~/my-bibliography.bib"
"Default name of file used by `addbib'."
:type 'file)
(defcustom unread-bib-file "~/to-be-read.bib"
"Default name of file used by `unread-bib' in Bib mode."
:type 'file)
(defvar bib-mode-map
(let ((map (make-sparse-keymap)))
(set-keymap-parent map text-mode-map)
(define-key map "\C-M" #'return-key-bib)
(define-key map "\C-c\C-u" #'unread-bib)
(define-key map "\C-c\C-@" #'mark-bib)
(define-key map "\e`" #'abbrev-mode)
map))
(defun addbib ()
"Set up editor to add to troff bibliography file specified
by global variable `bib-file'. See description of `bib-mode'."
(interactive)
(find-file bib-file)
(goto-char (point-max))
(bib-mode)
)
(define-derived-mode bib-mode text-mode "Bib"
"Mode for editing `lookbib' style bibliographies.
Hit RETURN to get next % field key.
If you want to ignore this field, just hit RETURN again.
Use `text-mode' to turn this feature off.
journal papers: A* T D J V N P K W X
articles in books & proceedings: A* T D B E* I C P K W X
tech reports: A* T D R I C K W X
books: A* T D I C K W X
Fields:
A uthor T itle D ate J ournal
V olume N umber P age K eywords
B in book or proceedings E ditor C ity & state
I nstitution, school, or publisher
R eport number or `phd thesis' or `masters thesis' or `draft' or
`unnumbered' or `unpublished'
W here can be found locally (login name, or ailib, etc.)
X comments (not used in indexing)
\\[unread-bib] appends current entry to a different file (for example,
a file of papers to be read in the future), given by the value of the
variable `unread-bib-file'.
\\[mark-bib] marks current or previous entry.
Abbreviations are saved in `bib-mode-abbrev-table'.
Hook can be stored in `bib-mode-hook'.
Field keys given by variable `bib-assoc'.
Commands:
\\{bib-mode-map}"
(abbrev-mode 1))
(defconst bib-assoc
'((" *$" . "%A ")
("%A ." . "%A ")
("%A $" . "%T ")
("%T " . "%D ")
("%D " . "%J ")
("%J ." . "%V ")
("%V " . "%N ")
("%N " . "%P ")
("%P " . "%K ")
("%K " . "%W ")
("%W " . "%X ")
("%X " . "")
("%J $" . "%B ")
("%B ." . "%E ")
("%E ." . "%E ")
("%E $" . "%I ")
("%I " . "%C ")
("%C " . "%P ")
("%B $" . "%R ")
("%R " . "%I "))
"Describes bibliographic database format.
A line beginning with the car of an entry is followed by one beginning
with the cdr.")
(defun bib-find-key (slots)
(cond
((null slots)
(if (bobp)
""
(progn (forward-line -1) (bib-find-key bib-assoc))))
((looking-at (car (car slots)))
(cdr (car slots)))
(t (bib-find-key (cdr slots)))
))
(defcustom bib-auto-capitalize t
"True to automatically capitalize appropriate fields in Bib mode."
:type 'boolean)
(defconst bib-capitalized-fields "%[AETCBIJR]")
(defun return-key-bib ()
"Magic when user hits return, used by `bib-mode'."
(interactive)
(if (eolp)
(let (empty new-key beg-current end-current)
(beginning-of-line)
(setq empty (looking-at "%. $"))
(if (not empty)
(progn
(end-of-line)
(newline)
(forward-line -1)
))
(end-of-line)
(setq end-current (point))
(beginning-of-line)
(setq beg-current (point))
(setq new-key (bib-find-key bib-assoc))
(if (and (not empty) bib-auto-capitalize
(looking-at bib-capitalized-fields))
(save-excursion
(bib-capitalize-title-region (+ (point) 3) end-current)))
(goto-char beg-current)
(if empty
(kill-line nil)
(forward-line 1)
)
(insert new-key))
(newline)))
(defun mark-bib ()
"Set mark at beginning of current or previous bib entry, point at end."
(interactive)
(beginning-of-line nil)
(if (looking-at "^ *$") (re-search-backward "[^ \n]" nil 2))
(re-search-backward "^ *$" nil 2)
(re-search-forward "^%")
(beginning-of-line nil)
(push-mark)
(re-search-forward "^ *$" nil 2)
(forward-line 1)
(beginning-of-line nil))
(defun unread-bib ()
"Append current or previous entry to file of unread papers
named by variable `unread-bib-file'."
(interactive)
(mark-bib)
(if (get-file-buffer unread-bib-file)
(append-to-buffer (get-file-buffer unread-bib-file) (mark) (point))
(append-to-file (mark) (point) unread-bib-file)))
(defvar bib-capitalize-title-stop-words
(concat
"the\\|and\\|of\\|is\\|a\\|an\\|for\\|in\\|to\\|on\\|at\\|"
"by\\|with\\|that\\|its")
"Words not to be capitalized in a title (unless the first word).")
(defvar bib-capitalize-title-stop-regexp
(concat "\\(" bib-capitalize-title-stop-words "\\)\\(\\b\\|'\\)"))
(defun bib-capitalize-title-region (begin end)
"Like `capitalize-region', but don't capitalize stop words, except the first."
(interactive "r")
(let ((case-fold-search nil) (orig-syntax-table (syntax-table)))
(unwind-protect
(save-restriction
(set-syntax-table text-mode-syntax-table)
(narrow-to-region begin end)
(goto-char (point-min))
(if (looking-at "[A-Z][a-z]*[A-Z]")
(forward-word 1)
(capitalize-word 1))
(while (re-search-forward "\\<" nil t)
(if (looking-at "[A-Z][a-z]*[A-Z]")
(forward-word 1)
(if (let ((case-fold-search t))
(looking-at bib-capitalize-title-stop-regexp))
(downcase-word 1)
(capitalize-word 1)))
))
(set-syntax-table orig-syntax-table))))
(defun bib-capitalize-title (s)
"Like `capitalize', but don't capitalize stop words, except the first."
(with-current-buffer (get-buffer-create "$$$Scratch$$$")
(erase-buffer)
(insert s)
(bib-capitalize-title-region (point-min) (point-max))
(buffer-string)))
(provide 'bib-mode)
;;; bib-mode.el ends here
|
