Mercurial > emacs
annotate lisp/textmodes/reftex-vars.el @ 26340:f1ae5b57d9db
Changed the mail addess of the maintainer.
author | Francesco Potortì <pot@gnu.org> |
---|---|
date | Wed, 03 Nov 1999 23:13:10 +0000 |
parents | 8ae20ae6b8d2 |
children | 489a5439b988 |
rev | line source |
---|---|
25280 | 1 ;;; reftex-vars.el - Configuration variables for RefTeX |
25804
8ae20ae6b8d2
(reftex-section-levels): Function allowed as cdr.
Carsten Dominik <dominik@science.uva.nl>
parents:
25280
diff
changeset
|
2 ;;; Version: 4.6 |
25280 | 3 ;;; |
4 ;;; See main file reftex.el for licensing information | |
5 | |
6 (provide 'reftex-vars) | |
7 | |
8 ;; Define the two constants which are needed during compilation | |
9 | |
10 (eval-and-compile | |
11 (defconst reftex-label-alist-builtin | |
12 '( | |
13 ;; Some aliases, mostly for backward compatibility | |
14 (Sideways "Alias for -->rotating" (rotating)) | |
15 (AMSTeX "amsmath with eqref macro" | |
16 ((nil ?e nil "~\\eqref{%s}") | |
17 amsmath)) | |
18 | |
19 ;; Individual package defaults | |
20 (amsmath "AMS-LaTeX math environments" | |
21 (("align" ?e nil nil eqnarray-like) | |
22 ("gather" ?e nil nil eqnarray-like) | |
23 ("multline" ?e nil nil t) | |
24 ("flalign" ?e nil nil eqnarray-like) | |
25 ("alignat" ?e nil nil alignat-like) | |
26 ("xalignat" ?e nil nil alignat-like) | |
27 ("xxalignat" ?e nil nil alignat-like) | |
28 ("subequations" ?e nil nil t))) | |
29 | |
30 (endnotes "The \\endnote macro" | |
31 (("\\endnote[]{}" ?N "en:" "~\\ref{%s}" 2 | |
32 (regexp "endnotes?" "notes?" "Anmerkung\\(en\\)?" "Anm\\.")))) | |
33 | |
34 (fancybox "The Beqnarray environment" | |
35 (("Beqnarray" ?e nil nil eqnarray-like))) | |
36 | |
37 (floatfig "The floatingfigure environment" | |
38 (("floatingfigure" ?f nil nil caption))) | |
39 | |
40 (longtable "The longtable environment" | |
41 (("longtable" ?t nil nil caption))) | |
42 | |
43 (picinpar "The figwindow and tabwindow environments" | |
44 (("figwindow" ?f nil nil 1) | |
45 ("tabwindow" ?f nil nil 1))) | |
46 | |
47 (rotating "Sidewaysfigure and table" | |
48 (("sidewaysfigure" ?f nil nil caption) | |
49 ("sidewaystable" ?t nil nil caption))) | |
50 | |
51 (sidecap "CSfigure and SCtable" | |
52 (("SCfigure" ?f nil nil caption) | |
53 ("SCtable" ?t nil nil caption))) | |
54 | |
55 (subfigure "Subfigure environments/macro" | |
56 (("subfigure" ?f nil nil caption) | |
57 ("subfigure*" ?f nil nil caption) | |
58 ("\\subfigure[]{}" ?f nil nil 1))) | |
59 | |
60 (supertab "Supertabular environment" | |
61 (("supertabular" ?t nil nil "\\tablecaption{"))) | |
62 | |
63 (wrapfig "The wrapfigure environment" | |
64 (("wrapfigure" ?f nil nil caption))) | |
65 | |
66 ;; The LaTeX core stuff | |
67 (LaTeX "LaTeX default environments" | |
68 (("section" ?s "%S" "~\\ref{%s}" (nil . t) | |
69 (regexp "parts?" "chapters?" "chap\\." "sections?" "sect?\\." | |
70 "paragraphs?" "par\\." | |
71 "\\\\S" "\247" "Teile?" "Kapitel" "Kap\\." "Abschnitte?" | |
72 "appendi\\(x\\|ces\\)" "App\\." "Anh\"?ange?" "Anh\\.")) | |
73 | |
74 ("enumerate" ?i "item:" "~\\ref{%s}" item | |
75 (regexp "items?" "Punkte?")) | |
76 | |
77 ("equation" ?e "eq:" "~(\\ref{%s})" t | |
78 (regexp "equations?" "eqs?\\." "eqn\\." "Gleichung\\(en\\)?" "Gl\\.")) | |
79 ("eqnarray" ?e "eq:" nil eqnarray-like) | |
80 | |
81 ("figure" ?f "fig:" "~\\ref{%s}" caption | |
82 (regexp "figure?[sn]?" "figs?\\." "Abbildung\\(en\\)?" "Abb\\.")) | |
83 ("figure*" ?f nil nil caption) | |
84 | |
85 ("table" ?t "tab:" "~\\ref{%s}" caption | |
86 (regexp "tables?" "tab\\." "Tabellen?")) | |
87 ("table*" ?t nil nil caption) | |
88 | |
89 ("\\footnote[]{}" ?n "fn:" "~\\ref{%s}" 2 | |
90 (regexp "footnotes?" "Fussnoten?")) | |
91 | |
92 ("any" ?\ " " "~\\ref{%s}" nil) | |
93 | |
94 ;; The label macro is hard coded, but it *could* be defined like this: | |
95 ;;("\\label{*}" nil nil nil nil) | |
96 )) | |
97 | |
98 ) | |
99 "The default label environment descriptions. | |
100 Lower-case symbols correspond to a style file of the same name in the LaTeX | |
101 distribution. Mixed-case symbols are convenience aliases.") | |
102 | |
103 (defconst reftex-cite-format-builtin | |
104 '((default "Default macro \\cite{%l}" | |
105 "\\cite{%l}") | |
106 (natbib "The Natbib package" | |
107 ((?\C-m . "\\cite{%l}") | |
108 (?t . "\\citet{%l}") | |
109 (?T . "\\citet*{%l}") | |
110 (?p . "\\citep{%l}") | |
111 (?P . "\\citep*{%l}") | |
112 (?e . "\\citep[e.g.][]{%l}") | |
113 (?s . "\\citep[see][]{%l}") | |
114 (?a . "\\citeauthor{%l}") | |
115 (?A . "\\citeauthor*{%l}") | |
116 (?y . "\\citeyear{%l}"))) | |
117 (harvard "The Harvard package" | |
118 ((?\C-m . "\\cite{%l}") | |
119 (?p . "\\cite{%l}") | |
120 (?t . "\\citeasnoun{%l}") | |
121 (?n . "\\citeasnoun{%l}") | |
122 (?s . "\\possessivecite{%l}") | |
123 (?e . "\\citeaffixed{%l}{?}") | |
124 (?y . "\\citeyear{%l}") | |
125 (?a . "\\citename{%l}"))) | |
126 (chicago "The Chicago package" | |
127 ((?\C-m . "\\cite{%l}") | |
128 (?t . "\\citeN{%l}") | |
129 (?T . "\\shortciteN{%l}") | |
130 (?p . "\\cite{%l}") | |
131 (?P . "\\shortcite{%l}") | |
132 (?a . "\\citeA{%l}") | |
133 (?A . "\\shortciteA{%l}") | |
134 (?y . "\\citeyear{%l}"))) | |
135 (astron "The Astron package" | |
136 ((?\C-m . "\\cite{%l}") | |
137 (?p . "\\cite{%l}" ) | |
138 (?t . "%2a (\\cite{%l})"))) | |
139 (author-year "Do-it-yourself Author-year" | |
140 ((?\C-m . "\\cite{%l}") | |
141 (?t . "%2a (%y)\\nocite{%l}") | |
142 (?p . "(%2a %y\\nocite{%l})"))) | |
143 (locally "Full info in parenthesis" | |
144 "(%2a %y, %j %v, %P, %e: %b, %u, %s %<)") | |
145 ) | |
146 "Builtin versions of the citation format. | |
147 The following conventions are valid for all alist entries: | |
148 `?\C-m' should always point to a straight \\cite{%l} macro. | |
149 `?t' should point to a textual citation (citation as a noun). | |
150 `?p' should point to a parenthetical citation.") | |
151 | |
152 (defconst reftex-index-macros-builtin | |
153 '((default "Default \\index and \\glossary macros" | |
154 (("\\index{*}" "idx" ?i "" nil) | |
155 ("\\glossary{*}" "glo" ?g "" nil))) | |
156 (multind "The multind.sty package" | |
157 (("\\index{}{*}" 1 ?i "" nil))) | |
158 (index "The index.sty package" | |
159 (("\\index[]{*}" 1 ?i "" nil) | |
160 ("\\index*[]{*}" 1 ?I "" nil))) | |
161 (Index-Shortcut "index.sty with \\shortindexingon" | |
162 (("\\index[]{*}" 1 ?i "" nil) | |
163 ("\\index*[]{*}" 1 ?I "" nil) | |
164 ("^[]{*}" 1 ?^ "" texmathp) | |
165 ("_[]{*}" 1 ?_ "" texmathp)))) | |
166 "Builtin stuff for reftex-index-macros. | |
167 Lower-case symbols correspond to a style file of the same name in the LaTeX | |
168 distribution. Mixed-case symbols are convenience aliases.") | |
169 ) | |
170 | |
171 ;; Configuration Variables and User Options for RefTeX ------------------ | |
172 | |
173 (defgroup reftex nil | |
174 "LaTeX label and citation support." | |
175 :tag "RefTeX" | |
176 :link '(url-link :tag "Home Page" | |
177 "http://strw.leidenuniv.nl/~dominik/Tools/") | |
178 :link '(emacs-commentary-link :tag "Commentary in reftex.el" "reftex.el") | |
179 :link '(custom-manual "(reftex)Top") | |
180 :prefix "reftex-" | |
181 :group 'tex) | |
182 | |
183 ;; Table of contents configuration -------------------------------------- | |
184 | |
185 (defgroup reftex-table-of-contents-browser nil | |
186 "A multifile table of contents browser." | |
187 :group 'reftex) | |
188 | |
189 (defcustom reftex-toc-keep-other-windows t | |
190 "*Non-nil means, split the selected window to display the *toc* buffer. | |
191 This helps to keep the window configuration, but makes the *toc* small. | |
192 When nil, all other windows except the selected one will be deleted, so | |
193 that the *toc* window fills half the frame." | |
194 :group 'reftex-table-of-contents-browser | |
195 :type 'boolean) | |
196 | |
197 (defcustom reftex-toc-include-file-boundaries nil | |
198 "*Non-nil means, include file boundaries in *toc* buffer. | |
199 This flag can be toggled from within the *toc* buffer with the `F' key." | |
200 :group 'reftex-table-of-contents-browser | |
201 :type 'boolean) | |
202 | |
203 (defcustom reftex-toc-include-labels nil | |
204 "*Non-nil means, include labels in *toc* buffer. | |
205 This flag can be toggled from within the *toc* buffer with the `l' key." | |
206 :group 'reftex-table-of-contents-browser | |
207 :type 'boolean) | |
208 | |
209 (defcustom reftex-toc-include-index-entries nil | |
210 "*Non-nil means, include index entries in *toc* buffer. | |
211 This flag can be toggled from within the *toc* buffer with the `i' key." | |
212 :group 'reftex-table-of-contents-browser | |
213 :type 'boolean) | |
214 | |
215 (defcustom reftex-toc-include-context nil | |
216 "*Non-nil means, include context with labels in the *toc* buffer. | |
217 Context will only be shown when labels are visible as well. | |
218 This flag can be toggled from within the *toc* buffer with the `c' key." | |
219 :group 'reftex-table-of-contents-browser | |
220 :type 'boolean) | |
221 | |
222 (defcustom reftex-toc-follow-mode nil | |
223 "*Non-nil means, point in *toc* buffer will cause other window to follow. | |
224 The other window will show the corresponding part of the document. | |
225 This flag can be toggled from within the *toc* buffer with the `f' key." | |
226 :group 'reftex-table-of-contents-browser | |
227 :type 'boolean) | |
228 | |
229 (defcustom reftex-revisit-to-follow nil | |
230 "*Non-nil means, follow-mode will revisit files if necessary. | |
231 When nil, follow-mode will be suspended for stuff in unvisited files." | |
232 :group 'reftex-table-of-contents-browser | |
233 :group 'reftex-referencing-labels | |
234 :type 'boolean) | |
235 | |
236 (defcustom reftex-toc-mode-hook nil | |
237 "Mode hook for reftex-toc-mode." | |
238 :group 'reftex-table-of-contents-browser | |
239 :type 'hook) | |
240 | |
241 ;; Label Support Configuration | |
242 | |
243 (defgroup reftex-label-support nil | |
244 "Support for creation, insertion and referencing of labels in LaTeX." | |
245 :group 'reftex) | |
246 | |
247 (defgroup reftex-defining-label-environments nil | |
248 "Definition of environments and macros to do with label." | |
249 :group 'reftex-label-support) | |
250 | |
251 (defcustom reftex-default-label-alist-entries | |
252 '(amsmath endnotes fancybox floatfig longtable picinpar | |
253 rotating sidecap subfigure supertab wrapfig LaTeX) | |
254 "Default label alist specifications. LaTeX should always be the last entry. | |
255 The value of this variable is a list of symbols with associations in the | |
256 constant `reftex-label-alist-builtin'. Check that constant for a full list | |
257 of options." | |
258 :group 'reftex-defining-label-environments | |
259 :set 'reftex-set-dirty | |
260 :type `(set | |
261 :indent 4 | |
262 :inline t | |
263 :greedy t | |
264 ,@(mapcar | |
265 (lambda (x) | |
266 (list 'const :tag (concat (symbol-name (nth 0 x)) | |
267 ": " (nth 1 x)) | |
268 (nth 0 x))) | |
269 reftex-label-alist-builtin))) | |
270 | |
271 (defcustom reftex-label-alist nil | |
272 "Alist with information on environments for \\label-\\ref use. | |
273 | |
274 This docstring is easier to understand after reading the configuration | |
275 examples in `reftex.el'. Looking at the builtin defaults in the constant | |
276 `reftex-label-alist-builtin' may also be instructive. | |
277 | |
278 Set this variable to define additions and changes to the default. The only | |
279 things you MUST NOT change is that `?s' is the type indicator for section | |
280 labels, and SPC for the `any' label type. These are hard-coded at other | |
281 places in the code. | |
282 | |
283 The value of the variable must be a list of items. Each item is a list | |
284 itself and has the following structure: | |
285 | |
286 (ENV-OR-MACRO TYPE-KEY LABEL-PREFIX REFERENCE-FORMAT CONTEXT-METHOD | |
287 (MAGIC-WORD ... )) | |
288 | |
289 Each list entry describes either an environment carrying a counter for use | |
290 with \\label and \\ref, or a LaTeX macro defining a label as (or inside) | |
291 one of its arguments. The elements of each list entry are: | |
292 | |
293 ENV-OR-MACRO | |
294 Name of the environment (like \"table\") or macro (like \"\\\\myfig\"). | |
295 For macros, indicate the macro arguments for best results, as in | |
296 \"\\\\myfig[]{}{}{*}{}\". Use square brackets for optional arguments, | |
297 a star to mark the label argument, if any. The macro does not have to | |
298 have a label argument - you could also use \\label{..} inside one of | |
299 its arguments. | |
300 Special names: `section' for section labels, `any' to define a group | |
301 which contains all labels. | |
302 | |
303 This may also be a function to do local parsing and identify point | |
304 to be in a a non-standard label environment. The function must take | |
305 an argument BOUND and limit backward searches to this value. It | |
306 should return either nil or a cons cell (FUNCTION . POSITION) with | |
307 the function symbol and the position where the special environment | |
308 starts. See the Info documentation for an example. | |
309 | |
310 Finally this may also be nil if the entry is only meant to change | |
311 some settings associated with the type indicator character (see below). | |
312 | |
313 TYPE-KEY | |
314 Type indicator character, like `?t', must be a printable ASCII character. | |
315 The type indicator is a single character which defines a label type. | |
316 Any label inside the environment or macro is assumed to belong to this | |
317 type. The same character may occur several times in this list, to cover | |
318 cases in which different environments carry the same label type (like | |
319 `equation' and `eqnarray'). | |
320 If the type indicator is nil and the macro has a label argument {*}, | |
321 the macro defines neutral labels just like \label. In this case | |
322 the reminder of this entry is ignored. | |
323 | |
324 LABEL-PREFIX | |
325 Label prefix string, like \"tab:\". | |
326 The prefix is a short string used as the start of a label. It may be the | |
327 empty string. The prefix may contain the following `%' escapes: | |
328 %f Current file name with directory and extension stripped. | |
329 %F Current file name relative to directory of master file. | |
330 %u User login name, on systems which support this. | |
331 %S A section prefix derived with variable `reftex-section-prefixes'. | |
332 | |
333 Example: In a file `intro.tex', \"eq:%f:\" will become \"eq:intro:\"). | |
334 | |
335 REFERENCE-FORMAT | |
336 Format string for reference insert in buffer. `%s' will be replaced by | |
337 the label. | |
338 When the format starts with `~', the `~' will only be inserted if | |
339 there is not already a whitespace before point. | |
340 | |
341 CONTEXT-METHOD | |
342 Indication on how to find the short context. | |
343 - If nil, use the text following the \\label{...} macro. | |
344 - If t, use | |
345 - the section heading for section labels. | |
346 - text following the \\begin{...} statement of environments. | |
347 (not a good choice for environments like eqnarray or enumerate, | |
348 where one has several labels in a single environment). | |
349 - text after the macro name (starting with the first arg) for macros. | |
350 - If an integer, use the nth argument of the macro. As a special case, | |
351 1000 means to get text after the last macro argument. | |
352 - If a string, use as regexp to search *backward* from the label. Context | |
353 is then the text following the end of the match. E.g. putting this to | |
354 \"\\\\\\\\caption[[{]\" will use the caption in a figure or table | |
355 environment. | |
356 \"\\\\\\\\begin{eqnarray}\\\\|\\\\\\\\\\\\\\\\\" works for eqnarrays. | |
357 - If any of `caption', `item', `eqnarray-like', `alignat-like', this | |
358 symbol will internally be translated into an appropriate regexp | |
359 (see also the variable `reftex-default-context-regexps'). | |
360 - If a function, call this function with the name of the environment/macro | |
361 as argument. On call, point will be just after the \\label macro. The | |
362 function is expected to return a suitable context string. It should | |
363 throw an exception (error) when failing to find context. | |
364 As an example, here is a function returning the 10 chars following | |
365 the label macro as context: | |
366 | |
367 (defun my-context-function (env-or-mac) | |
368 (if (> (point-max) (+ 10 (point))) | |
369 (buffer-substring (point) (+ 10 (point))) | |
370 (error \"Buffer too small\"))) | |
371 | |
372 Label context is used in two ways by RefTeX: For display in the label | |
373 menu, and to derive a label string. If you want to use a different | |
374 method for each of these, specify them as a dotted pair. | |
375 E.g. `(nil . t)' uses the text after the label (nil) for display, and | |
376 text from the default position (t) to derive a label string. This is | |
377 actually used for section labels. | |
378 | |
379 MAGIC-WORDS | |
380 List of magic words which identify a reference to be of this type. | |
381 If the word before point is equal to one of these words when calling | |
382 `reftex-reference', the label list offered will be automatically | |
383 restricted to labels of the correct type. | |
384 If the first element of this wordlist is the symbol `regexp', the | |
385 strings are interpreted as regular expressions. RefTeX will add | |
386 a \"\\\\W\" to the beginning and other stuff to the end of the regexp. | |
387 | |
388 If the type indicator characters of two or more entries are the same, RefTeX | |
389 will use | |
390 - the first non-nil format and prefix | |
391 - the magic words of all involved entries. | |
392 | |
393 Any list entry may also be a symbol. If that has an association in | |
394 `reftex-label-alist-builtin', the cddr of that association is spliced into the | |
395 list. However, builtin defaults should normally be set with the variable | |
396 `reftex-default-label-alist-entries." | |
397 :group 'reftex-defining-label-environments | |
398 :set 'reftex-set-dirty | |
399 :type | |
400 `(repeat | |
401 (choice :tag "Package or Detailed " | |
402 :value ("" ?a nil nil nil nil) | |
403 (list :tag "Detailed Entry" | |
404 :value ("" ?a nil nil nil nil) | |
405 (choice :tag "Environment or \\macro " | |
406 (const :tag "Ignore, just use typekey" nil) | |
407 (string "") | |
408 (symbol :tag "Special parser" my-parser)) | |
409 (choice :tag "Type specification " | |
410 (const :tag "unspecified, like in \\label" nil) | |
411 (character :tag "Char " ?a)) | |
412 (choice :tag "Label prefix string " | |
413 (const :tag "Default" nil) | |
414 (string :tag "String" "lab:")) | |
415 (choice :tag "Label reference format" | |
416 (const :tag "Default" nil) | |
417 (string :tag "String" "~\\ref{%s}")) | |
418 (choice :tag "Context method " | |
419 (const :tag "Default position" t) | |
420 (const :tag "After label" nil) | |
421 (number :tag "Macro arg nr" 1) | |
422 (regexp :tag "Regexp" "") | |
423 (const :tag "Caption in float" caption) | |
424 (const :tag "Item in list" item) | |
425 (const :tag "Eqnarray-like" eqnarray-like) | |
426 (const :tag "Alignat-like" alignat-like) | |
427 (symbol :tag "Function" my-func)) | |
428 (repeat :tag "Magic words" :extra-offset 2 (string))) | |
429 (choice | |
430 :tag "Package" | |
431 :value AMSTeX | |
432 ,@(mapcar | |
433 (lambda (x) | |
434 (list 'const :tag (concat (symbol-name (nth 0 x))) | |
435 (nth 0 x))) | |
436 reftex-label-alist-builtin))))) | |
437 | |
25804
8ae20ae6b8d2
(reftex-section-levels): Function allowed as cdr.
Carsten Dominik <dominik@science.uva.nl>
parents:
25280
diff
changeset
|
438 (defcustom reftex-max-section-depth 12 |
8ae20ae6b8d2
(reftex-section-levels): Function allowed as cdr.
Carsten Dominik <dominik@science.uva.nl>
parents:
25280
diff
changeset
|
439 "Maximum depth of section levels in document structure. |
8ae20ae6b8d2
(reftex-section-levels): Function allowed as cdr.
Carsten Dominik <dominik@science.uva.nl>
parents:
25280
diff
changeset
|
440 Standard LaTeX needs default is 7, but there are packages for which this |
8ae20ae6b8d2
(reftex-section-levels): Function allowed as cdr.
Carsten Dominik <dominik@science.uva.nl>
parents:
25280
diff
changeset
|
441 needs to be larger." |
8ae20ae6b8d2
(reftex-section-levels): Function allowed as cdr.
Carsten Dominik <dominik@science.uva.nl>
parents:
25280
diff
changeset
|
442 :group 'reftex-defining-label-environments |
8ae20ae6b8d2
(reftex-section-levels): Function allowed as cdr.
Carsten Dominik <dominik@science.uva.nl>
parents:
25280
diff
changeset
|
443 :type 'integer) |
8ae20ae6b8d2
(reftex-section-levels): Function allowed as cdr.
Carsten Dominik <dominik@science.uva.nl>
parents:
25280
diff
changeset
|
444 |
25280 | 445 ;; LaTeX section commands and level numbers |
446 (defcustom reftex-section-levels | |
447 '( | |
448 ("part" . 0) | |
449 ("chapter" . 1) | |
450 ("section" . 2) | |
451 ("subsection" . 3) | |
452 ("subsubsection" . 4) | |
453 ("paragraph" . 5) | |
454 ("subparagraph" . 6) | |
455 ("subsubparagraph" . 7) | |
456 ("addchap" . -1) ; KOMA-Script | |
457 ("addsec" . -2) ; KOMA-Script | |
458 ;;; ("minisec" . -7) ; KOMA-Script | |
459 ) | |
460 "Commands and levels used for defining sections in the document. | |
461 This is an alist with each element like (COMMAND-NAME . LEVEL). | |
462 The car of each cons cell is the name of the section macro (without | |
463 the backslash). The cdr is a number indicating its level. A negative | |
464 level means the same level as the positive value, but the section will | |
25804
8ae20ae6b8d2
(reftex-section-levels): Function allowed as cdr.
Carsten Dominik <dominik@science.uva.nl>
parents:
25280
diff
changeset
|
465 never get a number. The cdr may also be a function which will be called |
8ae20ae6b8d2
(reftex-section-levels): Function allowed as cdr.
Carsten Dominik <dominik@science.uva.nl>
parents:
25280
diff
changeset
|
466 to after the section-re matched to determine the level." |
25280 | 467 :group 'reftex-defining-label-environments |
468 :set 'reftex-set-dirty | |
469 :type '(repeat | |
470 (cons (string :tag "sectioning macro" "") | |
25804
8ae20ae6b8d2
(reftex-section-levels): Function allowed as cdr.
Carsten Dominik <dominik@science.uva.nl>
parents:
25280
diff
changeset
|
471 (choice |
8ae20ae6b8d2
(reftex-section-levels): Function allowed as cdr.
Carsten Dominik <dominik@science.uva.nl>
parents:
25280
diff
changeset
|
472 (number :tag "level " 0) |
8ae20ae6b8d2
(reftex-section-levels): Function allowed as cdr.
Carsten Dominik <dominik@science.uva.nl>
parents:
25280
diff
changeset
|
473 (symbol :tag "function " my-level-func))))) |
25280 | 474 |
475 (defcustom reftex-section-prefixes '((0 . "part:") (1 . "cha:") (t . "sec:")) | |
476 "Prefixes for section labels. | |
477 When the label prefix given in an entry in `reftex-label-alist' contains `%S', | |
478 this list is used to determine the correct prefix string depending on the | |
479 current section level. | |
480 The list is an alist, with each entry of the form (KEY . PREFIX) | |
481 Possible keys are sectioning macro names like `chapter', section levels | |
482 (as given in `reftex-section-levels'), and t for the default." | |
483 :group 'reftex-defining-label-environments | |
484 :type '(repeat | |
485 (cons :value (0 . "") | |
486 (choice | |
487 (string :tag "macro name") | |
488 (integer :tag "section level") | |
489 (const :tag "default" t)) | |
490 (string :tag "Prefix")))) | |
491 | |
492 (defcustom reftex-default-context-regexps | |
493 '((caption . "\\\\\\(rot\\)?caption\\*?[[{]") | |
494 (item . "\\\\item\\(\\[[^]]*\\]\\)?") | |
495 (eqnarray-like . "\\\\begin{%s}\\|\\\\\\\\") | |
496 (alignat-like . "\\\\begin{%s}{[0-9]*}\\|\\\\\\\\")) | |
497 "Alist with default regular expressions for finding context. | |
498 The form (format regexp (regexp-quote environment)) is used to calculate | |
499 the final regular expression - so %s will be replaced with the environment | |
500 or macro." | |
501 :group 'reftex-defining-label-environments | |
502 :type '(repeat (cons (symbol) (regexp)))) | |
503 | |
504 (defcustom reftex-special-environment-functions nil | |
505 "List of functions to be called when trying to figure out current environment. | |
506 These are special functions to detect \"environments\" which do not | |
507 start with \\begin and end with \\end. Some LaTeX packages seem to | |
508 use such non-standard ways to set up environment-like constructs. The | |
509 purpose of each function in this list is to detect if point is | |
510 currently inside such a special \"environment\". If the environment | |
511 carries a label, you must also set up an entry for it in | |
512 `reftex-label-alist'. | |
513 | |
514 The function should check if point is currently in the special | |
515 environment it was written to detect. If so, the function must return | |
516 a cons cell (NAME . POSITION). NAME is the name of the environment | |
517 detected and POSITION is the buffer position where the environment | |
518 starts. The function must return nil on failure to detect the | |
519 environment. | |
520 | |
521 The function must take an argument BOUND. If non-nil, BOUND is a | |
522 boundary for backwards searches which should be observed. | |
523 | |
524 Here is an example. The LaTeX package linguex.sty defines list macros | |
525 `\\ex.', `\\a.', etc for lists which are terminated by `\\z.' or an empty | |
526 line. | |
527 | |
528 \\ex. \\label{ex:12} Some text in an exotic language ... | |
529 \\a. \\label{ex:13} more stuff | |
530 \\b. \\label{ex:14} still more stuff | |
531 | |
532 ... more text after the empty line terminating all lists | |
533 | |
534 And here is the setup for RefTeX: | |
535 | |
536 1. Define a dummy environment for this in `reftex-label-alist'. Dummy means, | |
537 make up an environment name even though it is not used with \\begin and | |
538 \\end. Here we use \"linguex\" as this name. | |
539 | |
540 (setq reftex-label-alist | |
541 '((\"linguex\" ?x \"ex:\" \"~\\\\ref{%s}\" nil (\"Example\" \"Ex.\")))) | |
542 | |
543 2. Write a function to detect the list macros and the determinators as well. | |
544 | |
545 (defun my-detect-linguex-list (bound) | |
546 (let ((pos (point)) p1) | |
547 (save-excursion | |
548 ;; Search for any of the linguex item macros at the beginning of a line | |
549 (if (re-search-backward | |
550 \"^[ \\t]*\\\\(\\\\\\\\\\\\(ex\\\\|a\\\\|b\\\\|c\\\\|d\\\\|e\\\\|f\\\\)g?\\\\.\\\\)\" bound t) | |
551 (progn | |
552 (setq p1 (match-beginning 1)) | |
553 ;; Make sure no empty line or \\z. is between us and the item macro | |
554 (if (re-search-forward \"\\n[ \\t]*\\n\\\\|\\\\\\\\z\\\\.\" pos t) | |
555 ;; Return nil because list was already closed | |
556 nil | |
557 ;; OK, we got it | |
558 (cons \"linguex\" p1))) | |
559 ;; Return nil for not found | |
560 nil)))) | |
561 | |
562 3. Tell RefTeX to use this function | |
563 | |
564 (setq reftex-special-environment-functions '(my-detect-linguex-list)) | |
565 " | |
566 :group 'reftex-defining-label-environments | |
567 :type 'hook) | |
568 | |
569 ;; Label insertion | |
570 | |
571 (defgroup reftex-making-and-inserting-labels nil | |
572 "Options on how to create new labels." | |
573 :group 'reftex-label-support) | |
574 | |
575 (defcustom reftex-insert-label-flags '("s" "sft") | |
576 "Flags governing label insertion. First flag DERIVE, second flag PROMPT. | |
577 | |
578 If DERIVE is t, RefTeX will try to derive a sensible label from context. | |
579 A section label for example will be derived from the section heading. | |
580 The conversion of the context to a legal label is governed by the | |
581 specifications given in `reftex-derive-label-parameters'. | |
582 If RefTeX fails to derive a label, it will prompt the user. | |
583 If DERIVE is nil, the label generated will consist of the prefix and a | |
584 unique number, like `eq:23'. | |
585 | |
586 If PROMPT is t, the user will be prompted for a label string. The prompt will | |
587 already contain the prefix, and (if DERIVE is t) a default label derived from | |
588 context. When PROMPT is nil, the default label will be inserted without | |
589 query. | |
590 | |
591 So the combination of DERIVE and PROMPT controls label insertion. Here is a | |
592 table describing all four possibilities: | |
593 | |
594 DERIVE PROMPT ACTION | |
595 ------------------------------------------------------------------------- | |
596 nil nil Insert simple label, like eq:22 or sec:13. No query. | |
597 nil t Prompt for label. | |
598 t nil Derive a label from context and insert without query. | |
599 t t Derive a label from context and prompt for confirmation. | |
600 | |
601 Each flag may be set to t, nil, or a string of label type letters | |
602 indicating the label types for which it should be true. The strings work | |
603 like character classes. | |
604 Thus, the combination may be set differently for each label type. The | |
605 default settings \"s\" and \"sft\" mean: Derive section labels from headings | |
606 (with confirmation). Prompt for figure and table labels. Use simple labels | |
607 without confirmation for everything else. | |
608 The available label types are: s (section), f (figure), t (table), i (item), | |
609 e (equation), n (footnote), N (endnote), plus any definitions in | |
610 `reftex-label-alist'." | |
611 :group 'reftex-making-and-inserting-labels | |
612 :type '(list (choice :tag "Derive label from context" | |
613 (const :tag "always" t) | |
614 (const :tag "never" nil) | |
615 (string :tag "selected label types" "")) | |
616 (choice :tag "Prompt for label string " | |
617 :entry-format " %b %v" | |
618 (const :tag "always" t) | |
619 (const :tag "never" nil) | |
620 (string :tag "selected label types" "")))) | |
621 | |
622 (defcustom reftex-string-to-label-function 'reftex-string-to-label | |
623 "Function to turn an arbitrary string into a legal label. | |
624 RefTeX's default function uses the variable `reftex-derive-label-parameters'." | |
625 :group 'reftex-making-and-inserting-labels | |
626 :type 'symbol) | |
627 | |
628 (defcustom reftex-translate-to-ascii-function 'reftex-latin1-to-ascii | |
629 "Filter function which will process a context string before it is used | |
630 to derive a label from it. The intended application is to convert ISO or | |
631 Mule characters into something legal in labels. The default function | |
632 removes the accents from Latin-1 characters. X-Symbol (>=2.6) sets this | |
633 variable to the much more general `x-symbol-translate-to-ascii'." | |
634 :group 'reftex-making-and-inserting-labels | |
635 :type 'symbol) | |
636 | |
637 (defcustom reftex-derive-label-parameters '(3 20 t 1 "-" | |
638 ("the" "on" "in" "off" "a" "for" "by" "of" "and" "is" "to") t) | |
639 "Parameters for converting a string into a label. | |
640 This variable is a list of the following items. | |
641 | |
642 NWORDS Number of words to use. | |
643 MAXCHAR Maximum number of characters in a label string. | |
644 ILLEGAL nil: Throw away any words containing characters illegal in labels. | |
645 t: Throw away only the illegal characters, not the whole word. | |
646 ABBREV nil: Never abbreviate words. | |
647 t: Always abbreviate words (see `reftex-abbrev-parameters'). | |
648 not t and not nil: Abbreviate words if necessary to shorten | |
649 label string below MAXCHAR. | |
650 SEPARATOR String separating different words in the label. | |
651 IGNOREWORDS List of words which should not be part of labels. | |
652 DOWNCASE t: Downcase words before using them." | |
653 :group 'reftex-making-and-inserting-labels | |
654 :type '(list (integer :tag "Number of words " 3) | |
655 (integer :tag "Maximum label length " 20) | |
656 (choice :tag "Illegal characters in words" | |
657 (const :tag "throw away entire word" nil) | |
658 (const :tag "throw away single chars" t)) | |
659 (choice :tag "Abbreviate words " | |
660 (const :tag "never" nil) | |
661 (const :tag "always" t) | |
662 (const :tag "when label is too long" 1)) | |
663 (string :tag "Separator between words " "-") | |
664 (repeat :tag "Ignore words" | |
665 :entry-format " %i %d %v" | |
666 (string :tag "")) | |
667 (option (boolean :tag "Downcase words ")))) | |
668 | |
669 (defcustom reftex-label-illegal-re "[^-a-zA-Z0-9_+=:;,.]" | |
670 "Regexp matching characters not legal in labels." | |
671 :group 'reftex-making-and-inserting-labels | |
672 :type '(regexp :tag "Regular Expression")) | |
673 | |
674 (defcustom reftex-abbrev-parameters '(4 2 "^aeiou" "aeiou") | |
675 "Parameters for abbreviation of words. | |
676 This variable is a list of the following items. | |
677 | |
678 MIN-CHARS Minimum number of characters remaining after abbreviation. | |
679 MIN-KILL Minimum number of characters to remove when abbreviating words. | |
680 BEFORE Character class before abbrev point in word. | |
681 AFTER Character class after abbrev point in word." | |
682 :group 'reftex-making-and-inserting-labels | |
683 :type '(list | |
684 (integer :tag "Minimum chars per word" 4) | |
685 (integer :tag "Shorten by at least " 2) | |
686 (string :tag "cut before char class " "^saeiou") | |
687 (string :tag "cut after char class " "aeiou"))) | |
688 | |
689 (defcustom reftex-format-label-function nil | |
690 "Function which produces the string to insert as a label definition. | |
691 Normally should be nil, unless you want to do something fancy. | |
692 The function will be called with two arguments, the LABEL and the DEFAULT | |
693 FORMAT, which usually is `\label{%s}'. The function should return the | |
694 string to insert into the buffer." | |
695 :group 'reftex-making-and-inserting-labels | |
696 :type 'function) | |
697 | |
698 ;; Label referencing | |
699 | |
700 (defgroup reftex-referencing-labels nil | |
701 "Options on how to reference labels." | |
702 :group 'reftex-label-support) | |
703 | |
704 (eval-and-compile | |
705 (defconst reftex-tmp | |
706 '((const :tag "on" t) | |
707 (const :tag "off" nil) | |
708 (string :tag "Selected label types")))) | |
709 | |
710 (defcustom reftex-label-menu-flags '(t t nil nil nil nil t nil) | |
711 "List of flags governing the label menu makeup. | |
712 The flags are: | |
713 | |
714 TABLE-OF-CONTENTS Show the labels embedded in a table of context. | |
715 SECTION-NUMBERS Include section numbers (like 4.1.3) in table of contents. | |
716 COUNTERS Show counters. This just numbers the labels in the menu. | |
717 NO-CONTEXT Non-nil means do NOT show the short context. | |
718 FOLLOW Follow full context in other window. | |
719 SHOW-COMMENTED Show labels from regions which are commented out. | |
720 MATCH-IN-TOC Obsolete flag. | |
721 SHOW FILES Show begin and end of included files. | |
722 | |
723 Each of these flags can be set to t or nil, or to a string of type letters | |
724 indicating the label types for which it should be true. These strings work | |
725 like character classes in regular expressions. Thus, setting one of the | |
726 flags to \"sf\" makes the flag true for section and figure labels, nil | |
727 for everything else. Setting it to \"^sf\" makes it the other way round. | |
728 The available label types are: s (section), f (figure), t (table), i (item), | |
729 e (equation), n (footnote), plus any definitions in `reftex-label-alist'. | |
730 | |
731 Most options can also be switched from the label menu itself - so if you | |
732 decide here to not have a table of contents in the label menu, you can still | |
733 get one interactively during selection from the label menu." | |
734 :group 'reftex-referencing-labels | |
735 :type | |
736 `(list | |
737 (choice :tag "Embed in table of contents " ,@reftex-tmp) | |
738 (choice :tag "Show section numbers " ,@reftex-tmp) | |
739 (choice :tag "Show individual counters " ,@reftex-tmp) | |
740 (choice :tag "Hide short context " ,@reftex-tmp) | |
741 (choice :tag "Follow context in other window " ,@reftex-tmp) | |
742 (choice :tag "Show commented labels " ,@reftex-tmp) | |
743 (choice :tag "Obsolete flag, Don't use. " ,@reftex-tmp) | |
744 (choice :tag "Show begin/end of included files" ,@reftex-tmp))) | |
745 | |
746 (defcustom reftex-multiref-punctuation '((?, . ", ") (?- . "--") (?+ . " and ")) | |
747 "Punctuation strings for multiple references. | |
748 When marking is used in the selection buffer to select several references, | |
749 this variable associates the 3 marking characters `,-+' with prefix strings | |
750 to be inserted into the buffer before the corresponding \ref macro. | |
751 This is used to string together whole reference sets, like | |
752 `eqs. 1,2,3-5,6 and 7' in a single call to `reftex-reference'. See manual." | |
753 :group 'reftex-referencing-labels | |
754 :type '(repeat (cons (character) (string)))) | |
755 | |
756 (defcustom reftex-vref-is-default nil | |
757 "*Non-nil means, the varioref macro \\vref is used as default. | |
758 In the selection buffer, the `v' key toggles the reference macro between | |
759 `\\ref' and `\\vref'. The value of this variable determines the default | |
760 which is active when entering the selection process. | |
761 Instead of nil or t, this may also be a string of type letters indicating | |
762 the label types for which it should be true." | |
763 :group 'reftex-referencing-labels | |
764 :type `(choice :tag "\\vref is default macro" ,@reftex-tmp)) | |
765 | |
766 (defcustom reftex-fref-is-default nil | |
767 "*Non-nil means, the fancyref macro \\fref is used as default. | |
768 In the selection buffer, the `V' key toggles the reference macro between | |
769 `\\ref', `\\fref' and `\\Fref'. The value of this variable determines | |
770 the default which is active when entering the selection process. | |
771 Instead of nil or t, this may also be a string of type letters indicating | |
772 the label types for which it should be true." | |
773 :group 'reftex-referencing-labels | |
774 :type `(choice :tag "\\fref is default macro" ,@reftex-tmp)) | |
775 | |
776 (defcustom reftex-level-indent 2 | |
777 "*Number of spaces to be used for indentation per section level." | |
778 :group 'reftex-referencing-labels | |
779 :type 'integer) | |
780 | |
781 (defcustom reftex-guess-label-type t | |
782 "*Non-nil means, `reftex-reference' will try to guess the label type. | |
783 To do that, RefTeX will look at the word before the cursor and compare it with | |
784 the words given in `reftex-label-alist'. When it finds a match, RefTeX will | |
785 immediately offer the correct label menu - otherwise it will prompt you for | |
786 a label type. If you set this variable to nil, RefTeX will always prompt." | |
787 :group 'reftex-referencing-labels | |
788 :type 'boolean) | |
789 | |
790 (defcustom reftex-format-ref-function nil | |
791 "Function which produces the string to insert as a reference. | |
792 Normally should be nil, because the format to insert a reference can | |
793 already be specified in `reftex-label-alist'. | |
794 This hook also is used by the special commands to insert `\vref' and `\fref' | |
795 references, so even if you set this, your setting will be ignored by | |
796 the special commands. | |
797 The function will be called with two arguments, the LABEL and the DEFAULT | |
798 FORMAT, which normally is `~\ref{%s}'. The function should return the | |
799 string to insert into the buffer." | |
800 :group 'reftex-referencing-labels | |
801 :type 'function) | |
802 | |
803 (defcustom reftex-select-label-mode-hook nil | |
804 "Mode hook for reftex-select-label-mode." | |
805 :group 'reftex-referencing-labels | |
806 :type 'hook) | |
807 | |
808 ;; BibteX citation configuration ---------------------------------------- | |
809 | |
810 (defgroup reftex-citation-support nil | |
811 "Support for referencing bibliographic data with BibTeX." | |
812 :group 'reftex) | |
813 | |
814 (defvar reftex-bibfile-ignore-list nil) ; compatibility | |
815 (defcustom reftex-bibfile-ignore-regexps nil | |
816 "*List of regular expressions to exclude files in \\bibliography{..}. | |
817 File names matched by these regexps will not be parsed by RefTeX. | |
818 Intended for files which contain only `@string' macro definitions and the | |
819 like, which are ignored by RefTeX anyway." | |
820 :group 'reftex-citation-support | |
821 :set 'reftex-set-dirty | |
822 :type '(repeat (regexp))) | |
823 | |
824 (defcustom reftex-default-bibliography nil | |
825 "*List of BibTeX database files which should be used if none are specified. | |
826 When `reftex-citation' is called from a document which has neither a | |
827 `\bibliography{..}' statement nor a `thebibliography' environment, | |
828 RefTeX will scan these files instead. Intended for using `reftex-citation' | |
829 in non-LaTeX files. The files will be searched along the BIBINPUTS or TEXBIB | |
830 path." | |
831 :group 'reftex-citation-support | |
832 :type '(repeat (file))) | |
833 | |
834 (defcustom reftex-sort-bibtex-matches 'reverse-year | |
835 "*Sorting of the entries found in BibTeX databases by reftex-citation. | |
836 Possible values: | |
837 nil Do not sort entries. | |
838 'author Sort entries by author name. | |
839 'year Sort entries by increasing year. | |
840 'reverse-year Sort entries by decreasing year." | |
841 :group 'reftex-citation-support | |
842 :type '(choice (const :tag "not" nil) | |
843 (const :tag "by author" author) | |
844 (const :tag "by year" year) | |
845 (const :tag "by year, reversed" reverse-year))) | |
846 | |
847 (defcustom reftex-cite-format 'default | |
848 "*The format of citations to be inserted into the buffer. | |
849 It can be a string or an alist or a symbol. In the simplest case this | |
850 is just the string \"\\cite{%l}\", which is also the default. See the | |
851 definition of `reftex-cite-format-builtin' for more complex examples. | |
852 | |
853 If `reftex-cite-format' is a string, it will be used as the format. | |
854 In the format, the following percent escapes will be expanded. | |
855 | |
856 %l The BibTeX label of the citation. | |
857 %a List of author names, see also `reftex-cite-punctuation. | |
858 %2a Like %a, but abbreviate more than 2 authors like Jones et al. | |
859 %A First author name only. | |
860 %e Works like %a, but on list of editor names. (%2e and %E work a well) | |
861 | |
862 It is also possible to access all other BibTeX database fields: | |
863 %b booktitle %c chapter %d edition %h howpublished | |
864 %i institution %j journal %k key %m month | |
865 %n number %o organization %p pages %P first page | |
866 %r address %s school %u publisher %t title | |
867 %v volume %y year | |
868 %B booktitle, abbreviated %T title, abbreviated | |
869 | |
870 Usually, only %l is needed. The other stuff is mainly for the echo area | |
871 display, and for (setq reftex-comment-citations t). | |
872 | |
873 %< as a special operator kills punctuation and space around it after the | |
874 string has been formatted. | |
875 | |
876 Beware that all this only works with BibTeX database files. When | |
877 citations are made from the \\bibitems in an explicit thebibliography | |
878 environment, only %l is available. | |
879 | |
880 If `reftex-cite-format' is an alist of characters and strings, the user | |
881 will be prompted for a character to select one of the possible format | |
882 strings. | |
883 In order to configure this variable, you can either set | |
884 `reftex-cite-format' directly yourself or set it to the SYMBOL of one of | |
885 the predefined styles. The predefined symbols are those which have an | |
886 association in the constant `reftex-cite-format-builtin'. | |
887 E.g.: (setq reftex-cite-format 'natbib)" | |
888 :group 'reftex-citation-support | |
889 :type | |
890 `(choice | |
891 :format "%{%t%}: \n%[Value Menu%] %v" | |
892 (radio :tag "Symbolic Builtins" | |
893 :indent 4 | |
894 :value default | |
895 ,@(mapcar | |
896 (lambda (x) | |
897 (list 'const :tag (concat (symbol-name (nth 0 x)) | |
898 ": " (nth 1 x)) | |
899 (nth 0 x))) | |
900 reftex-cite-format-builtin)) | |
901 (string :tag "format string" "\\cite{%l}") | |
902 (repeat :tag "key-ed format strings" | |
903 :value ((?\r . "\\cite{%l}") | |
904 (?t . "\\cite{%l}") (?p . "\\cite{%l}")) | |
905 (cons (character :tag "Key character" ?\r) | |
906 (string :tag "Format string" ""))))) | |
907 | |
908 (defcustom reftex-comment-citations nil | |
909 "*Non-nil means add a comment for each citation describing the full entry. | |
910 The comment is formatted according to `reftex-cite-comment-format'." | |
911 :group 'reftex-citation-support | |
912 :type 'boolean) | |
913 | |
914 (defcustom reftex-cite-comment-format | |
915 "%% %2a %y, %j %v, %P, %b, %e, %u, %s %<\n" | |
916 "Citation format used for commented citations. Must NOT contain %l. | |
917 See the variable `reftex-cite-format' for possible percent escapes." | |
918 :group 'reftex-citation-support | |
919 :type 'string) | |
920 | |
921 (defcustom reftex-cite-view-format "%2a %y, %T, %B, %j %v:%P, %s %<" | |
922 "Citation format used to display citation info in the message area. | |
923 Must NOT contain %l. See the variable `reftex-cite-format' for | |
924 possible percent escapes." | |
925 :group 'reftex-citation-support | |
926 :group 'reftex-viewing-cross-references | |
927 :type 'string) | |
928 | |
929 (defcustom reftex-cite-punctuation '(", " " \\& " " {\\it et al.}") | |
930 "Punctuation for formatting of name lists in citations. | |
931 This is a list of 3 strings. | |
932 1. normal names separator, like \", \" in Jones, Brown and Miller | |
933 2. final names separator, like \" and \" in Jones, Brown and Miller | |
934 3. The \"et al\" string, like \" {\\it et al.}\" in Jones {\\it et al.}" | |
935 :group 'reftex-citation-support | |
936 :type '(list | |
937 (string :tag "Separator for names ") | |
938 (string :tag "Separator for last name in list") | |
939 (string :tag "string used as et al. "))) | |
940 | |
941 (defcustom reftex-format-cite-function nil | |
942 "Function which produces the string to insert as a citation. | |
943 Normally should be nil, because the format to insert a reference can | |
944 already be specified in `reftex-cite-format'. | |
945 The function will be called with two arguments, the CITATION KEY and the | |
946 DEFAULT FORMAT, which is taken from `reftex-cite-format'. The function | |
947 should return the string to insert into the buffer." | |
948 :group 'reftex-citation-support | |
949 :type 'function) | |
950 | |
951 (defcustom reftex-select-bib-mode-hook nil | |
952 "Mode hook for reftex-select-bib-mode." | |
953 :group 'reftex-citation-support | |
954 :type 'hook) | |
955 | |
956 ;; Index Support Configuration | |
957 | |
958 (defgroup reftex-index-support nil | |
959 "Support for viewing and editing the index." | |
960 :group 'reftex) | |
961 | |
962 (defcustom reftex-support-index t | |
963 "*Non-nil means, index entries are parsed as well. | |
964 Index support is resource intensive and the internal structure holding the | |
965 parsed information can become quite big. Therefore it can be turned off. | |
966 When this is nil and you execute a command which requires index support, | |
967 you will be asked for confirmation to turn it on and rescan the document." | |
968 :group 'reftex-index-support | |
969 :type 'boolean) | |
970 | |
971 (defcustom reftex-index-special-chars '("!" "|" "@" "\"" "\\") | |
972 "Special characters in index entries. The value is a list of five strings. | |
973 These correspond to the makeindex keywords LEVEL ENCAP ACTUAL QUOTE ESCAPE." | |
974 :group 'reftex-index-support | |
975 :type '(list | |
976 (string :tag "LEVEL separator") | |
977 (string :tag "ENCAP char ") | |
978 (string :tag "ACTUAL char ") | |
979 (string :tag "QUOTE char ") | |
980 (string :tag "ESCAPE char "))) | |
981 | |
982 (defcustom reftex-index-macros nil | |
983 "Macros which define index entries. The structure is | |
984 | |
985 (MACRO INDEX-TAG KEY PREFIX EXCLUDE) | |
986 | |
987 MACRO is the macro. Arguments should be denoted by empty braces like | |
988 \\index[]{*}. Use square brackets to denote optional arguments. The star | |
989 marks where the index key is. | |
990 | |
991 INDEX-TAG is a short name of the index. \"idx\" and \"glo\" are | |
992 reserved for the default index and the glossary. Other indices can be | |
993 defined as well. If this is an integer, the Nth argument of the macro | |
994 holds the index tag. | |
995 | |
996 KEY is a character which is used to identify the macro for input with | |
997 \\[reftex-index]. ?i, ?I, and ?g are reserved for default index and glossary. | |
998 | |
999 PREFIX can be a prefix which is added to the KEY part of the index entry. | |
1000 If you have a macro \\newcommand{\\molec}[1]{#1\\index{Molecules!#1}}, this | |
1001 prefix should be \"Molecules!\". See the manual for details. | |
1002 | |
1003 EXCLUDE can be a function. If this function exists and returns a non-nil | |
1004 value, the index entry at point is ignored. This was implemented to support | |
1005 the (deprecated) `^' and `_' shortcuts in the LaTeX2e `index' package. | |
1006 | |
1007 The final entry may also be a symbol if this entry has a association | |
1008 in the variable `reftex-index-macros-builtin' to specify the main | |
1009 indexing package you are using. Legal values are currently | |
1010 default The LaTeX default - unnecessary to specify this one | |
1011 multind The multind.sty package | |
1012 index The index.sty package | |
1013 index-shortcut The index.sty packages with the ^ and _ shortcuts. | |
1014 Should not be used - only for old documents. | |
1015 Note that AUCTeX sets these things internally for RefTeX as well, so | |
1016 with a sufficiently new version of AUCTeX, you should not set the | |
1017 package here." | |
1018 :group 'reftex-index-support | |
1019 :set 'reftex-set-dirty | |
1020 :type `(list | |
1021 (repeat | |
1022 :inline t | |
1023 (list :value ("" "idx" ?a "" nil) | |
1024 (string :tag "Macro with args") | |
1025 (choice :tag "Index Tag " | |
1026 (string) | |
1027 (integer :tag "Macro arg Nr" :value 1)) | |
1028 (character :tag "Access Key ") | |
1029 (string :tag "Key Prefix ") | |
1030 (symbol :tag "Exclusion hook "))) | |
1031 (option | |
1032 :tag "Package:" | |
1033 (choice :tag "Package" | |
1034 :value index | |
1035 ,@(mapcar | |
1036 (lambda (x) | |
1037 (list 'const :tag (concat (symbol-name (nth 0 x)) | |
1038 ": " (nth 1 x)) | |
1039 (nth 0 x))) | |
1040 reftex-index-macros-builtin))))) | |
1041 | |
1042 (defcustom reftex-index-default-macro '(?i "idx" t) | |
1043 "The default index macro for \\[reftex-index-selection-or-word]. | |
1044 This is a list with (MACRO-KEY DEFAULT-TAG REPEAT-WORD). | |
1045 | |
1046 MACRO-KEY: Character identifying an index macro - see `reftex-index-macros'. | |
1047 DEFAULT-TAG: This is the tag to be used if the macro requires a TAG argument. | |
1048 When this is nil and a TAG is needed, RefTeX will ask for it. | |
1049 When this is the empty string and the TAG argument of the index | |
1050 macro is optional, the TAG argument will be omitted. | |
1051 REPEAT-WORD: Non-nil means, the index macro does not typeset the entry in | |
1052 the text, so that the text has to be repeated outside the index | |
1053 macro." | |
1054 :group 'reftex-index-support | |
1055 :type '(list | |
1056 (character :tag "Character identifying default macro") | |
1057 (choice :tag "Default index tag " | |
1058 (const nil) | |
1059 (string)) | |
1060 (boolean :tag "Word needs to be repeated "))) | |
1061 | |
1062 (defcustom reftex-index-default-tag "idx" | |
1063 "Default index tag. | |
1064 When working with multiple indexes, RefTeX queries for an index tag when | |
1065 creating index entries or displaying a specific index. This variable controls | |
1066 the default offered for these queries. The default can be selected with RET | |
1067 during selection or completion. Legal values of this variable are: | |
1068 | |
1069 nil Do not provide a default index | |
1070 \"tag\" The default index tag given as a string, e.g. \"idx\". | |
1071 last The last used index tag will be offered as default." | |
1072 :group 'reftex-index-support | |
1073 :type '(choice | |
1074 (const :tag "no default" nil) | |
1075 (const :tag "last used " 'last) | |
1076 (string :tag "index tag " "idx"))) | |
1077 | |
1078 (defcustom reftex-index-math-format "$%s$" | |
1079 "Format of index entries when copied from inside math mode. | |
1080 When `reftex-index-selection-or-word' is executed inside TeX math mode, | |
1081 the index key copied from the buffer is processed with this format string | |
1082 through the `format' function. This can be used to add the math delimiters | |
1083 (e.g. `$') to the string. | |
1084 Requires the `texmathp.el' library which is part of AUCTeX." | |
1085 :group 'reftex-index-support | |
1086 :type 'string) | |
1087 | |
1088 (defcustom reftex-index-section-letters "ABCDEFGHIJKLMNOPQRSTUVWXYZ" | |
1089 "The letters which denote sections in the index. | |
1090 Usually these are all capital letters. Don't use any downcase letters. | |
1091 Order is not significant, the index will be sorted by whatever the sort | |
1092 function thinks is correct. | |
1093 In addition to these letters, RefTeX will create a group `!' which | |
1094 contains all entries sorted below the lowest specified letter. | |
1095 In the index buffer, pressing any of these capital letters or `!' will jump | |
1096 to that section." | |
1097 :group 'reftex-index-support | |
1098 :type '(string :tag "Capital letters")) | |
1099 | |
1100 (defcustom reftex-index-include-context nil | |
1101 "*Non-nil means, display the index definition context in the index buffer. | |
1102 This flag may also be toggled from the index buffer with the `c' key." | |
1103 :group 'reftex-index-support | |
1104 :type 'boolean) | |
1105 | |
1106 (defcustom reftex-index-follow-mode nil | |
1107 "*Non-nil means, point in *Index* buffer will cause other window to follow. | |
1108 The other window will show the corresponding part of the document. | |
1109 This flag can be toggled from within the *Index* buffer with the `f' key." | |
1110 :group 'reftex-table-of-contents-browser | |
1111 :type 'boolean) | |
1112 | |
1113 ;; Viewing Cross References | |
1114 | |
1115 (defgroup reftex-viewing-cross-references nil | |
1116 "Displaying cross references and citations." | |
1117 :group 'reftex) | |
1118 | |
1119 (defcustom reftex-view-crossref-extra nil | |
1120 "Macros which can be used for the display of cross references. | |
1121 This is used when `reftex-view-crossref' is called with point in an | |
1122 argument of a macro. Note that crossref viewing for citations, | |
1123 references (both ways) and index entries is hard-coded. This variable | |
1124 is only to configure additional structures for which crossreference | |
1125 viewing can be useful. Each entry has the structure | |
1126 | |
1127 (MACRO-RE SEARCH-RE HIGHLIGHT). | |
1128 | |
1129 MACRO-RE is matched against the macro. SEARCH-RE is the regexp used | |
1130 to search for cross references. `%s' in this regexp is replaced with | |
1131 with the macro argument at point. HIGHLIGHT is an integer indicating | |
1132 which subgroup of the match should be highlighted." | |
1133 :group 'reftex-viewing-cross-references | |
1134 :type '(repeat (group (regexp :tag "Macro Regexp ") | |
1135 (string :tag "Search Regexp ") | |
1136 (integer :tag "Highlight Group")))) | |
1137 | |
1138 (defcustom reftex-auto-view-crossref t | |
1139 "*Non-nil means, initially turn automatic viewing of crossref info on. | |
1140 Automatic viewing of crossref info normally uses the echo area. | |
1141 Whenever point is on the argument of a \\ref or \\cite macro, and no | |
1142 other message is being displayed, the echo area will display | |
1143 information about that cross reference. You can also set the variable | |
1144 to the symbol `window'. In this case a small temporary window is | |
1145 used for the display. | |
1146 This feature can be turned on and of from the menu | |
1147 (Ref->Options)." | |
1148 :group 'reftex-viewing-cross-references | |
1149 :type '(choice (const :tag "off" nil) | |
1150 (const :tag "in Echo Area" t) | |
1151 (const :tag "in Other Window" window))) | |
1152 | |
1153 (defcustom reftex-idle-time 1.2 | |
1154 "*Time (secs) Emacs has to be idle before automatic crossref display is done." | |
1155 :group 'reftex-viewing-cross-references | |
1156 :type 'number) | |
1157 | |
1158 (defcustom reftex-revisit-to-echo nil | |
1159 "*Non-nil means, automatic citation display will revisit files if necessary. | |
1160 When nil, citation display in echo area will only be active for cached | |
1161 entries and for BibTeX database files with live associated buffers." | |
1162 :group 'reftex-viewing-cross-references | |
1163 :type 'boolean) | |
1164 | |
1165 (defcustom reftex-cache-cite-echo t | |
1166 "*Non-nil means, the information displayed in the echo area for cite macros | |
1167 is cached and even saved along with the parsing information. The cache | |
1168 survives document scans. In order to clear it, use M-x reftex-reset-mode." | |
1169 :group 'reftex-viewing-cross-references | |
1170 :type 'boolean) | |
1171 | |
1172 (defcustom reftex-display-copied-context-hook nil | |
1173 "Normal Hook which is run before context is displayed anywhere. Designed | |
1174 for X-Symbol, but may have other uses as well." | |
1175 :group 'reftex-viewing-cross-references | |
1176 :group 'reftex-referencing-labels | |
1177 :type 'hook) | |
1178 | |
1179 ;; Finding Files -------------------------------------------------------- | |
1180 | |
1181 (defgroup reftex-finding-files nil | |
1182 "Finding files on search paths." | |
1183 :group 'reftex) | |
1184 | |
1185 (defcustom reftex-texpath-environment-variables '("TEXINPUTS") | |
1186 "*List of specifications how to retrieve the search path for TeX files. | |
1187 Several entries are possible. | |
1188 - If an element is the name of an environment variable, its content is used. | |
1189 - If an element starts with an exclamation mark, it is used as a command | |
1190 to retrieve the path. A typical command with the kpathsearch library would | |
1191 be `!kpsewhich -show-path=.tex'. | |
1192 - Otherwise the element itself is interpreted as a path. | |
1193 Multiple directories can be separated by the system dependent `path-separator'. | |
1194 Directories ending in `//' or `!!' will be expanded recursively. | |
1195 See also `reftex-use-external-file-finders'." | |
1196 :group 'reftex-finding-files | |
1197 :set 'reftex-set-dirty | |
1198 :type '(repeat (string :tag "Specification"))) | |
1199 | |
1200 (defcustom reftex-bibpath-environment-variables '("BIBINPUTS" "TEXBIB") | |
1201 "*List of specifications how to retrieve search path for .bib database files. | |
1202 Several entries are possible. | |
1203 - If an element is the name of an environment variable, its content is used. | |
1204 - If an element starts with an exclamation mark, it is used as a command | |
1205 to retrieve the path. A typical command with the kpathsearch library would | |
1206 be `!kpsewhich -show-path=.bib'. | |
1207 - Otherwise the element itself is interpreted as a path. | |
1208 Multiple directories can be separated by the system dependent `path-separator'. | |
1209 Directories ending in `//' or `!!' will be expanded recursively. | |
1210 See also `reftex-use-external-file-finders'." | |
1211 :group 'reftex-citation-support | |
1212 :group 'reftex-finding-files | |
1213 :set 'reftex-set-dirty | |
1214 :type '(repeat (string :tag "Specification"))) | |
1215 | |
1216 (defcustom reftex-file-extensions '(("tex" . (".tex" ".ltx")) | |
1217 ("bib" . (".bib"))) | |
1218 "*Association list with file extensions for different file types. | |
1219 This is a list of items, each item is like: (TYPE . (DEF-EXT OTHER-EXT ...)) | |
1220 | |
1221 TYPE: File type like \"bib\" or \"tex\". | |
1222 DEF-EXT: The default extension for that file type, like \".tex\" or \".bib\". | |
1223 OTHER-EXT: Any number of other legal extensions for this file type. | |
1224 | |
1225 When a files is searched and it does not have any of the legal extensions, | |
1226 we try the default extension first, and then the naked file name." | |
1227 :group 'reftex-finding-files | |
1228 :type '(repeat (cons (string :tag "File type") | |
1229 (repeat (string :tag "Extension"))))) | |
1230 | |
1231 (defcustom reftex-search-unrecursed-path-first t | |
1232 "*Non-nil means, search all specified directories before trying recursion. | |
1233 Thus, in a path \".//:/tex/\", search first \"./\", then \"/tex/\" and then | |
1234 all subdirectories of \"./\". If this option is nil, the subdirectories of | |
1235 \"./\" are searched before \"/tex/\". This is mainly for speed - most of the | |
1236 time the recursive path is for the system files and not for the user files. | |
1237 Set this to nil if the default makes RefTeX finding files with equal names | |
1238 in wrong sequence." | |
1239 :group 'reftex-finding-files | |
1240 :type 'boolean) | |
1241 | |
1242 (defcustom reftex-use-external-file-finders nil | |
1243 "*Non-nil means, use external programs to find files. | |
1244 Normally, RefTeX searches the paths given in the environment variables | |
1245 TEXINPUTS and BIBINPUTS to find TeX files and BibTeX database files. | |
1246 With this option turned on, it calls an external program specified in the | |
1247 option `reftex-external-file-finders' instead. As a side effect, | |
1248 the variables `reftex-texpath-environment-variables' and | |
1249 `reftex-bibpath-environment-variables' will be ignored." | |
1250 :group 'reftex-finding-files | |
1251 :type 'boolean) | |
1252 | |
1253 (defcustom reftex-external-file-finders '(("tex" . "kpsewhich -format=.tex %f") | |
1254 ("bib" . "kpsewhich -format=.bib %f")) | |
1255 "*Association list with external programs to call for finding files. | |
1256 Each entry is a cons cell (TYPE . PROGRAM). | |
1257 TYPE is either \"tex\" or \"bib\". PROGRAM is the external program to use with | |
1258 any arguments. %f will be replaced by the name of the file to be found. | |
1259 Note that these commands will be executed directly, not via a shell. | |
1260 Only relevant when `reftex-use-external-file-finders' is non-nil." | |
1261 :group 'reftex-finding-files | |
1262 :type '(repeat (cons (string :tag "File type") | |
1263 (string :tag "Program ")))) | |
1264 | |
1265 ;; Tuning the parser ---------------------------------------------------- | |
1266 | |
1267 (defgroup reftex-optimizations-for-large-documents nil | |
1268 "Configuration of parser speed and memory usage." | |
1269 :group 'reftex) | |
1270 | |
1271 (defcustom reftex-keep-temporary-buffers 1 | |
1272 "*Non-nil means, keep buffers created for parsing and lookup. | |
1273 RefTeX sometimes needs to visit files related to the current document. | |
1274 We distinguish files visited for | |
1275 PARSING: Parts of a multifile document loaded when (re)-parsing the document. | |
1276 LOOKUP: BibTeX database files and TeX files loaded to find a reference, | |
1277 to display label context, etc. | |
1278 The created buffers can be kept for later use, or be thrown away immediately | |
1279 after use, depending on the value of this variable: | |
1280 | |
1281 nil Throw away as much as possible. | |
1282 t Keep everything. | |
1283 1 Throw away buffers created for parsing, but keep the ones created | |
1284 for lookup. | |
1285 | |
1286 If a buffer is to be kept, the file is visited normally (which is potentially | |
1287 slow but will happen only once). | |
1288 If a buffer is to be thrown away, the initialization of the buffer depends | |
1289 upon the variable `reftex-initialize-temporary-buffers'." | |
1290 :group 'reftex-optimizations-for-large-documents | |
1291 :type '(choice | |
1292 (const :tag "Throw away everything" nil) | |
1293 (const :tag "Keep everything" t) | |
1294 (const :tag "Keep lookup buffers only" 1))) | |
1295 | |
1296 (defcustom reftex-initialize-temporary-buffers nil | |
1297 "*Non-nil means do initializations even when visiting file temporarily. | |
1298 When nil, RefTeX may turn off find-file hooks and other stuff to briefly | |
1299 visit a file. | |
1300 When t, the full default initializations are done (find-file-hook etc.). | |
1301 Instead of t or nil, this variable may also be a list of hook functions to | |
1302 do a minimal initialization." | |
1303 :group 'reftex-optimizations-for-large-documents | |
1304 :type '(choice | |
1305 (const :tag "Read files literally" nil) | |
1306 (const :tag "Fully initialize buffers" t) | |
1307 (repeat :tag "Hook functions" :value (nil) | |
1308 (function-item)))) | |
1309 | |
1310 (defcustom reftex-no-include-regexps '("\\.pstex_t\\'") | |
1311 "*List of regular expressions to exclude certain input files from parsing. | |
1312 If the name of a file included via \\include or \\input is matched by any | |
1313 of the regular expressions in this list, that file is not parsed by RefTeX." | |
1314 :group 'reftex-optimizations-for-large-documents | |
1315 :type '(repeat (regexp))) | |
1316 | |
1317 (defcustom reftex-enable-partial-scans nil | |
1318 "*Non-nil means, re-parse only 1 file when asked to re-parse. | |
1319 Re-parsing is normally requested with a `C-u' prefix to many RefTeX commands, | |
1320 or with the `r' key in menus. When this option is t in a multifile document, | |
1321 we will only parse the current buffer, or the file associated with the label | |
1322 or section heading near point in a menu. Requesting re-parsing of an entire | |
1323 multifile document then requires a `C-u C-u' prefix or the capital `R' key | |
1324 in menus." | |
1325 :group 'reftex-optimizations-for-large-documents | |
1326 :type 'boolean) | |
1327 | |
1328 (defcustom reftex-allow-automatic-rescan t | |
1329 "*Non-nil means, RefTeX may rescan the document when this seems necessary. | |
1330 Currently this applies only to rescanning after label insertion, when | |
1331 the new label cannot be inserted correctly into the internal label | |
1332 list." | |
1333 :group 'reftex-optimizations-for-large-documents | |
1334 :type 'boolean) | |
1335 | |
1336 (defcustom reftex-save-parse-info nil | |
1337 "*Non-nil means, save information gathered with parsing in a file. | |
1338 The file MASTER.rel in the same directory as MASTER.tex is used to save the | |
1339 information. When this variable is t, | |
1340 - accessing the parsing information for the first time in an editing session | |
1341 will read that file (if available) instead of parsing the document. | |
1342 - exiting Emacs or killing a buffer in reftex-mode will cause a new version | |
1343 of the file to be written." | |
1344 :group 'reftex-optimizations-for-large-documents | |
1345 :type 'boolean) | |
1346 | |
1347 (defcustom reftex-use-multiple-selection-buffers nil | |
1348 "*Non-nil means use a separate selection buffer for each label type. | |
1349 These buffers are kept from one selection to the next and need not to be | |
1350 created for each use - so the menu generally comes up faster. The | |
1351 selection buffers will be erased (and therefore updated) automatically | |
1352 when new labels in its category are added. See the variable | |
1353 `reftex-auto-update-selection-buffers'." | |
1354 :group 'reftex-optimizations-for-large-documents | |
1355 :group 'reftex-referencing-labels | |
1356 :type 'boolean) | |
1357 | |
1358 (defcustom reftex-auto-update-selection-buffers t | |
1359 "*Non-nil means, selection buffers will be updated automatically. | |
1360 When a new label is defined with `reftex-label', all selection buffers | |
1361 associated with that label category are emptied, in order to force an | |
1362 update upon next use. When nil, the buffers are left alone and have to be | |
1363 updated by hand, with the `g' key from the label selection process. | |
1364 The value of this variable will only have any effect when | |
1365 `reftex-use-multiple-selection-buffers' is non-nil." | |
1366 :group 'reftex-optimizations-for-large-documents | |
1367 :group 'reftex-referencing-labels | |
1368 :type 'boolean) | |
1369 | |
1370 ;; Fontification and Faces ---------------------------------------------- | |
1371 | |
1372 (defgroup reftex-fontification-configurations nil | |
1373 "Options concerning the faces used in RefTeX." | |
1374 :group 'reftex) | |
1375 | |
1376 (defcustom reftex-use-fonts t | |
1377 "*Non-nil means, use fonts in *toc* and selection buffers. | |
1378 Font-lock must be loaded as well to actually get fontified display. | |
1379 When changing this option, a rescan may be necessary to activate the change." | |
1380 :group 'reftex-fontification-configurations | |
1381 :type 'boolean) | |
1382 | |
1383 (defcustom reftex-refontify-context 1 | |
1384 "*Non-nil means, re-fontify the context in the label menu with font-lock. | |
1385 This slightly slows down the creation of the label menu. It is only necessary | |
1386 when you definitely want the context fontified. | |
1387 | |
1388 This option may have 3 different values: | |
1389 nil Never refontify. | |
1390 t Always refontify. | |
1391 1 Refontify when absolutely necessary, e.g. when old versions of X-Symbol. | |
1392 The option is ignored when `reftex-use-fonts' is nil." | |
1393 :group 'reftex-fontification-configurations | |
1394 :group 'reftex-referencing-labels | |
1395 :type '(choice | |
1396 (const :tag "Never" nil) | |
1397 (const :tag "Always" t) | |
1398 (const :tag "When necessary" 1))) | |
1399 | |
1400 (defcustom reftex-highlight-selection 'cursor | |
1401 "*Non-nil mean, highlight selected text in selection and *toc* buffers. | |
1402 Normally, the text near the cursor is the selected text, and it is | |
1403 highlighted. This is the entry most keys in the selction and *toc* | |
1404 buffers act on. However, if you mainly use the mouse to select an | |
1405 item, you may find it nice to have mouse-triggered highlighting | |
1406 instead or as well. The variable may have one of these values: | |
1407 | |
1408 nil No highlighting. | |
1409 cursor Highlighting is cursor driven. | |
1410 mouse Highlighting is mouse driven. | |
1411 both Both cursor and mouse trigger highlighting. | |
1412 | |
1413 Changing this variable requires to rebuild the selection and *toc* buffers | |
1414 to become effective (keys `g' or `r')." | |
1415 :group 'reftex-fontification-configurations | |
1416 :type '(choice | |
1417 (const :tag "Never" nil) | |
1418 (const :tag "Cursor driven" cursor) | |
1419 (const :tag "Mouse driven" mouse) | |
1420 (const :tag "Mouse and Cursor driven." both))) | |
1421 | |
1422 (defcustom reftex-cursor-selected-face 'highlight | |
1423 "Face name to highlight cursor selected item in toc and selection buffers. | |
1424 See also the variable `reftex-highlight-selection'." | |
1425 :group 'reftex-fontification-configurations | |
1426 :type 'symbol) | |
1427 (defcustom reftex-mouse-selected-face 'secondary-selection | |
1428 "Face name to highlight mouse selected item in toc and selection buffers. | |
1429 See also the variable `reftex-highlight-selection'." | |
1430 :group 'reftex-fontification-configurations | |
1431 :type 'symbol) | |
1432 (defcustom reftex-file-boundary-face 'font-lock-comment-face | |
1433 "Face name for file boundaries in selection buffer." | |
1434 :group 'reftex-fontification-configurations | |
1435 :type 'symbol) | |
1436 (defcustom reftex-label-face 'font-lock-constant-face | |
1437 "Face name for labels in selection buffer." | |
1438 :group 'reftex-fontification-configurations | |
1439 :type 'symbol) | |
1440 (defcustom reftex-section-heading-face 'font-lock-function-name-face | |
1441 "Face name for section headings in toc and selection buffers." | |
1442 :group 'reftex-fontification-configurations | |
1443 :type 'symbol) | |
1444 (defcustom reftex-toc-header-face 'font-lock-comment-face | |
1445 "Face name for the header of a toc buffer." | |
1446 :group 'reftex-fontification-configurations | |
1447 :type 'symbol) | |
1448 (defcustom reftex-bib-author-face 'font-lock-keyword-face | |
1449 "Face name for author names in bib selection buffer." | |
1450 :group 'reftex-fontification-configurations | |
1451 :type 'symbol) | |
1452 (defcustom reftex-bib-year-face 'font-lock-comment-face | |
1453 "Face name for year in bib selection buffer." | |
1454 :group 'reftex-fontification-configurations | |
1455 :type 'symbol) | |
1456 (defcustom reftex-bib-title-face 'font-lock-function-name-face | |
1457 "Face name for article title in bib selection buffer." | |
1458 :group 'reftex-fontification-configurations | |
1459 :type 'symbol) | |
1460 (defcustom reftex-bib-extra-face 'font-lock-comment-face | |
1461 "Face name for bibliographic information in bib selection buffer." | |
1462 :group 'reftex-fontification-configurations | |
1463 :type 'symbol) | |
1464 (defcustom reftex-select-mark-face 'bold | |
1465 "Face name for marked entries in the selection buffers." | |
1466 :group 'reftex-fontification-configurations | |
1467 :type 'symbol) | |
1468 (defcustom reftex-index-header-face 'font-lock-comment-face | |
1469 "Face name for the header of an index buffer." | |
1470 :group 'reftex-fontification-configurations | |
1471 :type 'symbol) | |
1472 (defcustom reftex-index-section-face 'font-lock-function-name-face | |
1473 "Face name for the start of a new letter section in the index." | |
1474 :group 'reftex-fontification-configurations | |
1475 :type 'symbol) | |
1476 (defcustom reftex-index-tag-face 'font-lock-keyword-face | |
1477 "Face name for index names (for multiple indices)." | |
1478 :group 'reftex-fontification-configurations | |
1479 :type 'symbol) | |
1480 (defcustom reftex-index-face 'font-lock-constant-face | |
1481 "Face name for index entries." | |
1482 :group 'reftex-fontification-configurations | |
1483 :type 'symbol) | |
1484 | |
1485 (defcustom reftex-pre-refontification-functions nil | |
1486 "X-Symbol specific hook. | |
1487 Functions get two arguments, the buffer from where the command started and a | |
1488 symbol indicating in what context the hook is called." | |
1489 :group 'reftex-fontification-configurations | |
1490 :type 'hook) | |
1491 | |
1492 ;; Miscellaneous configurations ----------------------------------------- | |
1493 | |
1494 (defgroup reftex-miscellaneous-configurations nil | |
1495 "Collection of further configurations." | |
1496 :group 'reftex) | |
1497 | |
1498 (defcustom reftex-extra-bindings nil | |
1499 "Non-nil means, make additional key bindings on startup. | |
1500 These extra bindings are located in the users `C-c letter' map." | |
1501 :group 'reftex-miscellaneous-configurations | |
1502 :type 'boolean) | |
1503 | |
1504 (defcustom reftex-plug-into-AUCTeX nil | |
1505 "*Plug-in flags for AUCTeX interface. | |
1506 This variable is a list of 4 boolean flags. When a flag is non-nil, | |
1507 RefTeX will | |
1508 | |
1509 - supply labels in new sections and environments (flag 1) | |
1510 - supply arguments for macros like `\\label'. (flag 2) | |
1511 - supply arguments for macros like `\\ref'. (flag 3) | |
1512 - supply arguments for macros like `\\cite'. (flag 4) | |
1513 - supply arguments for macros like `\\index'. (flag 5) | |
1514 | |
1515 You may also set the variable itself to t or nil in order to turn all | |
1516 plug-ins on or off, respectively. | |
1517 \\<LaTeX-mode-map>Supplying labels in new sections and environments applies when creating | |
1518 sections with \\[LaTeX-section] and environments with \\[LaTeX-environment]. | |
1519 Supplying macro arguments applies when you insert such a macro interactively | |
1520 with \\[TeX-insert-macro]. | |
1521 See the AUCTeX documentation for more information. | |
1522 RefTeX uses `fset' to take over the function calls. Changing the variable | |
1523 may require a restart of Emacs in order to become effective." | |
1524 :group 'reftex-miscellaneous-configurations | |
1525 :group 'LaTeX | |
1526 :type '(choice | |
1527 (const :tag "No plug-ins" nil) | |
1528 (const :tag "All possible plug-ins" t) | |
1529 (list | |
1530 :tag "Individual choice" | |
1531 :value (t t t t t) | |
1532 (boolean :tag "supply label in new sections and environments") | |
1533 (boolean :tag "supply argument for macros like `\\label' ") | |
1534 (boolean :tag "supply argument for macros like `\\ref' ") | |
1535 (boolean :tag "supply argument for macros like `\\cite' ") | |
1536 (boolean :tag "supply argument for macros like `\\index' ") | |
1537 ))) | |
1538 | |
1539 (defcustom reftex-allow-detached-macro-args nil | |
1540 "*Non-nil means, allow arguments of macros to be detached by whitespace. | |
1541 When this is t, `aaa' will be considered as argument of \\bb in the following | |
1542 construct: \\bbb [xxx] {aaa}." | |
1543 :group 'reftex-miscellaneous-configurations | |
1544 :type 'boolean) | |
1545 | |
1546 | |
1547 (defcustom reftex-load-hook nil | |
1548 "Hook which is being run when loading reftex.el." | |
1549 :group 'reftex-miscellaneous-configurations | |
1550 :type 'hook) | |
1551 | |
1552 (defcustom reftex-mode-hook nil | |
1553 "Hook which is being run when turning on RefTeX mode." | |
1554 :group 'reftex-miscellaneous-configurations | |
1555 :type 'hook) | |
1556 | |
1557 ;;; reftex-vars.el ends here |