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