1 ;;; reftex-vars.el --- configuration variables for RefTeX
3 ;; Copyright (C) 1997-1999, 2001-2012 Free Software Foundation, Inc.
5 ;; Author: Carsten Dominik <dominik@science.uva.nl>
6 ;; Maintainer: auctex-devel@gnu.org
10 ;; This file is part of GNU Emacs.
12 ;; GNU Emacs is free software: you can redistribute it and/or modify
13 ;; it under the terms of the GNU General Public License as published by
14 ;; the Free Software Foundation, either version 3 of the License, or
15 ;; (at your option) any later version.
17 ;; GNU Emacs is distributed in the hope that it will be useful,
18 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
19 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
20 ;; GNU General Public License for more details.
22 ;; You should have received a copy of the GNU General Public License
23 ;; along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>.
28 (defvar reftex-tables-dirty
)
29 (eval-when-compile (require 'cl
))
31 (defun reftex-set-dirty (symbol value
)
32 (setq reftex-tables-dirty t
)
35 ;; Define the two constants which are needed during compilation
38 (defconst reftex-label-alist-builtin
40 ;; Some aliases, mostly for backward compatibility
41 (Sideways "Alias for -->rotating" (rotating))
42 (AMSTeX "amsmath with eqref macro"
43 ((nil ?e nil
"~\\eqref{%s}")
46 ;; Individual package defaults
47 (amsmath "AMS-LaTeX math environments"
48 (("align" ?e nil nil eqnarray-like
)
49 ("gather" ?e nil nil eqnarray-like
)
50 ("multline" ?e nil nil t
)
51 ("flalign" ?e nil nil eqnarray-like
)
52 ("alignat" ?e nil nil alignat-like
)
53 ("xalignat" ?e nil nil alignat-like
)
54 ("xxalignat" ?e nil nil alignat-like
)
55 ("subequations" ?e nil nil t
)))
57 (endnotes "The \\endnote macro"
58 (("\\endnote[]{}" ?N
"en:" "~\\ref{%s}" 2
59 (regexp "endnotes?" "notes?" "Anmerkung\\(en\\)?" "Anm\\."))))
61 (fancybox "The Beqnarray environment"
62 (("Beqnarray" ?e nil nil eqnarray-like
)))
64 (floatfig "The floatingfigure environment"
65 (("floatingfigure" ?f nil nil caption
)))
67 (longtable "The longtable environment"
68 (("longtable" ?t nil nil caption
)))
70 (picinpar "The figwindow and tabwindow environments"
71 (("figwindow" ?f nil nil
1)
72 ("tabwindow" ?f nil nil
1)))
74 (rotating "Sidewaysfigure and table"
75 (("sidewaysfigure" ?f nil nil caption
)
76 ("sidewaystable" ?t nil nil caption
)))
78 (sidecap "CSfigure and SCtable"
79 (("SCfigure" ?f nil nil caption
)
80 ("SCtable" ?t nil nil caption
)))
82 (subfigure "Subfigure environments/macro"
83 (("subfigure" ?f nil nil caption
)
84 ("subfigure*" ?f nil nil caption
)
85 ("\\subfigure[]{}" ?f nil nil
1)))
87 (supertab "Supertabular environment"
88 (("supertabular" ?t nil nil
"\\tablecaption{")))
90 (wrapfig "The wrapfigure environment"
91 (("wrapfigure" ?f nil nil caption
)))
93 ;; The LaTeX core stuff
94 (LaTeX "LaTeX default environments"
95 (("section" ?s
"%S" "~\\ref{%s}" (nil . t
)
96 (regexp "parts?" "chapters?" "chap\\." "sections?" "sect?\\."
97 "paragraphs?" "par\\."
98 "\\\\S" "\247" "Teile?" "Kapitel" "Kap\\." "Abschnitte?"
99 "appendi\\(x\\|ces\\)" "App\\." "Anh\"?ange?" "Anh\\."))
101 ("enumerate" ?i
"item:" "~\\ref{%s}" item
102 (regexp "items?" "Punkte?"))
104 ("equation" ?e
"eq:" "~(\\ref{%s})" t
105 (regexp "equations?" "eqs?\\." "eqn\\." "Gleichung\\(en\\)?" "Gl\\."))
106 ("eqnarray" ?e
"eq:" nil eqnarray-like
)
108 ("figure" ?f
"fig:" "~\\ref{%s}" caption
109 (regexp "figure?[sn]?" "figs?\\." "Abbildung\\(en\\)?" "Abb\\."))
110 ("figure*" ?f nil nil caption
)
112 ("table" ?t
"tab:" "~\\ref{%s}" caption
113 (regexp "tables?" "tab\\." "Tabellen?"))
114 ("table*" ?t nil nil caption
)
116 ("\\footnote[]{}" ?n
"fn:" "~\\ref{%s}" 2
117 (regexp "footnotes?" "Fussnoten?"))
119 ("any" ?\
" " "~\\ref{%s}" nil
)
121 ;; The label macro is hard coded, but it *could* be defined like this:
122 ;;("\\label{*}" nil nil nil nil)
125 (ctable "The ctable package"
126 (("\\ctable[]{}{}{}" ?t
"tab:" "\\ref{%s}" 1 ("table" "Tabelle"))))
128 (listings "The listings package"
129 (("lstlisting" ?l
"lst:" "~\\ref{%s}" nil
(regexp "[Ll]isting"))))
131 (minted "The minted package"
132 (("minted" ?l
"lst:" "~\\ref{%s}" nil
(regexp "[Ll]isting")))))
133 "The default label environment descriptions.
134 Lower-case symbols correspond to a style file of the same name in the LaTeX
135 distribution. Mixed-case symbols are convenience aliases.")
137 (defconst reftex-cite-format-builtin
138 '((default "Default macro \\cite{%l}"
140 (natbib "The Natbib package"
141 ((?\C-m .
"\\cite[][]{%l}")
142 (?t .
"\\citet[][]{%l}")
143 (?T .
"\\citet*[][]{%l}")
144 (?p .
"\\citep[][]{%l}")
145 (?P .
"\\citep*[][]{%l}")
146 (?e .
"\\citep[e.g.][]{%l}")
147 (?s .
"\\citep[see][]{%l}")
148 (?a .
"\\citeauthor{%l}")
149 (?A .
"\\citeauthor*{%l}")
150 (?y .
"\\citeyear{%l}")
151 (?n .
"\\nocite{%l}")))
152 (amsrefs "The AMSRefs package"
153 ((?\C-m .
"\\cite{%l}")
157 (?T .
"\\ocites{%l}")
159 (?Y .
"\\ycites{%l}")
160 (?a .
"\\citeauthor{%l}")
161 (?A .
"\\citeauthory{%l}")
162 (?f .
"\\fullcite{%l}")
163 (?F .
"\\fullocite{%l}")
164 (?n .
"\\nocite{%l}")))
165 (jurabib "The Jurabib package"
166 ((?\C-m .
"\\cite{%l}")
167 (?c .
"\\cite[][]{%l}")
170 (?e .
"\\citep[e.g.][]{%l}")
171 (?s .
"\\citep[see][]{%l}")
172 (?u .
"\\fullcite{%l}")
173 (?i .
"\\citetitle{%l}")
174 (?a .
"\\citeauthor{%l}")
175 (?e .
"\\citefield{}{%l}")
176 (?y .
"\\citeyear{%l}")
177 (?f .
"\\footcite{%l}")
178 (?F .
"\\footcite[][]{%l}")
179 (?l .
"\\footfullcite{%l}")))
180 (bibentry "The Bibentry package"
182 (harvard "The Harvard package"
183 ((?\C-m .
"\\cite[]{%l}")
184 (?p .
"\\cite[]{%l}")
185 (?t .
"\\citeasnoun{%l}")
186 (?n .
"\\citeasnoun{%l}")
187 (?s .
"\\possessivecite{%l}")
188 (?e .
"\\citeaffixed{%l}{?}")
189 (?y .
"\\citeyear{%l}")
190 (?a .
"\\citename{%l}")))
191 (chicago "The Chicago package"
192 ((?\C-m .
"\\cite[]{%l}")
193 (?t .
"\\citeN[]{%l}")
194 (?T .
"\\shortciteN{%l}")
195 (?p .
"\\cite[]{%l}")
196 (?P .
"\\shortcite{%l}")
198 (?A .
"\\shortciteA{%l}")
199 (?y .
"\\citeyear{%l}")))
200 (astron "The Astron package"
201 ((?\C-m .
"\\cite[]{%l}")
202 (?p .
"\\cite[]{%l}" )
203 (?t .
"%2a (\\cite{%l})")))
204 (author-year "Do-it-yourself Author-year"
205 ((?\C-m .
"\\cite{%l}")
206 (?t .
"%2a (%y)\\nocite{%l}")
207 (?p .
"(%2a %y\\nocite{%l})")))
208 (locally "Full info in parenthesis"
209 "(%2a %y, %j %v, %P, %e: %b, %u, %s %<)")
211 "Builtin versions of the citation format.
212 The following conventions are valid for all alist entries:
213 `?\C-m' should always point to a straight \\cite{%l} macro.
214 `?t' should point to a textual citation (citation as a noun).
215 `?p' should point to a parenthetical citation.")
217 (defconst reftex-index-macros-builtin
218 '((default "Default \\index and \\glossary macros"
219 (("\\index{*}" "idx" ?i
"" nil t
)
220 ("\\glossary{*}" "glo" ?g
"" nil t
)))
221 (multind "The multind.sty package"
222 (("\\index{}{*}" 1 ?i
"" nil t
)))
223 (index "The index.sty package"
224 (("\\index[]{*}" 1 ?i
"" nil t
)
225 ("\\index*[]{*}" 1 ?I
"" nil nil
)))
226 (Index-Shortcut "index.sty with \\shortindexingon"
227 (("\\index[]{*}" 1 ?i
"" nil t
)
228 ("\\index*[]{*}" 1 ?I
"" nil nil
)
229 ("^[]{*}" 1 ?^
"" texmathp t
)
230 ("_[]{*}" 1 ?_
"" texmathp nil
))))
231 "Builtin stuff for `reftex-index-macros'.
232 Lower-case symbols correspond to a style file of the same name in the LaTeX
233 distribution. Mixed-case symbols are convenience aliases.")
236 ;; Configuration Variables and User Options for RefTeX ------------------
239 "LaTeX label and citation support."
241 :link
'(url-link :tag
"Home Page"
242 "http://staff.science.uva.nl/~dominik/Tools/reftex/")
243 :link
'(emacs-commentary-link :tag
"Commentary in reftex.el" "reftex.el")
244 :link
'(custom-manual "(reftex)Top")
249 ;; Table of contents configuration --------------------------------------
251 (defgroup reftex-table-of-contents-browser nil
252 "A multifile table of contents browser."
255 (defcustom reftex-include-file-commands
'("include" "input")
256 "LaTeX commands which input another file.
257 The file name is expected after the command, either in braces or separated
259 :group
'reftex-table-of-contents-browser
260 :type
'(repeat string
))
262 (defcustom reftex-max-section-depth
12
263 "Maximum depth of section levels in document structure.
264 Standard LaTeX needs default is 7, but there are packages for which this
266 :group
'reftex-table-of-contents-browser
269 ;; LaTeX section commands and level numbers
270 (defcustom reftex-section-levels
276 ("subsubsection" .
4)
279 ("addchap" . -
1) ; KOMA-Script
280 ("addsec" . -
2) ; KOMA-Script
281 ;;; ("minisec" . -7) ; KOMA-Script
283 "Commands and levels used for defining sections in the document.
284 This is an alist with each element like (COMMAND-NAME . LEVEL).
285 The car of each cons cell is the name of the section macro (without
286 the backslash). The cdr is a number indicating its level. A negative
287 level means the same level as the positive value, but the section will
288 never get a number. The cdr may also be a function which will be called
289 to after the section-re matched to determine the level.
290 This list is also used for promotion and demotion of sectioning commands.
291 If you are using a document class which has several sets of sectioning
292 commands, promotion only works correctly if this list is sorted first
293 by set, then within each set by level. The promotion commands always
294 select the nearest entry with the correct new level."
295 :group
'reftex-table-of-contents-browser
296 :set
'reftex-set-dirty
298 (cons (string :tag
"sectioning macro" "")
300 (number :tag
"level " 0)
301 (symbol :tag
"function " my-level-func
)))))
303 (defcustom reftex-toc-max-level
100
304 "The maximum level of toc entries which will be included in the TOC.
305 Section headings with a bigger level will be ignored. In RefTeX, chapters
306 are level 1, sections are level 2 etc.
307 This variable can be changed from within the *toc* buffer with the `t' key."
308 :group
'reftex-table-of-contents-browser
311 (defcustom reftex-part-resets-chapter nil
312 "Non-nil means, \\part is like any other sectioning command.
313 This means, part numbers will be included in the numbering of chapters, and
314 chapter counters will be reset for each part.
315 When nil (the default), parts are special, do not reset the chapter counter
316 and also do not show up in chapter numbers."
317 :group
'reftex-table-of-contents-browser
321 (defcustom reftex-auto-recenter-toc
'frame
322 "Non-nil means, turn automatic recentering of *TOC* window on.
323 When active, the *TOC* window will always show the section you
324 are currently working in. Recentering happens whenever Emacs is idle for
325 more than `reftex-idle-time' seconds.
327 Value t means, turn on immediately when RefTeX gets started. Then,
328 recentering will work for any TOC window created during the session.
330 Value 'frame (the default) means, turn automatic recentering on only while the
331 dedicated TOC frame does exist, and do the recentering only in that frame. So
332 when creating that frame (with \"d\" key in an ordinary TOC window), the
333 automatic recentering is turned on. When the frame gets destroyed, automatic
334 recentering is turned off again.
336 This feature can be turned on and off from the menu
338 :group
'reftex-table-of-contents-browser
340 (const :tag
"never" nil
)
341 (const :tag
"always" t
)
342 (const :tag
"in dedicated frame only" frame
)))
344 (defcustom reftex-toc-split-windows-horizontally nil
345 "Non-nil means, create TOC window by splitting window horizontally."
346 :group
'reftex-table-of-contents-browser
349 (defcustom reftex-toc-split-windows-fraction
.3
350 "Fraction of the width or height of the frame to be used for TOC window.
351 See also `reftex-toc-split-windows-horizontally'."
352 :group
'reftex-table-of-contents-browser
355 (defvar reftex-toc-split-windows-horizontally-fraction
0.5
356 "This variable is obsolete, use `reftex-toc-split-windows-fraction' instead.")
358 (defcustom reftex-toc-keep-other-windows t
359 "Non-nil means, split the selected window to display the *toc* buffer.
360 This helps to keep the window configuration, but makes the *toc* small.
361 When nil, all other windows except the selected one will be deleted, so
362 that the *toc* window fills half the frame."
363 :group
'reftex-table-of-contents-browser
366 (defcustom reftex-toc-include-file-boundaries nil
367 "Non-nil means, include file boundaries in *toc* buffer.
368 This flag can be toggled from within the *toc* buffer with the `F' key."
369 :group
'reftex-table-of-contents-browser
372 (defcustom reftex-toc-include-labels nil
373 "Non-nil means, include labels in *toc* buffer.
374 This flag can be toggled from within the *toc* buffer with the `l' key."
375 :group
'reftex-table-of-contents-browser
378 (defcustom reftex-toc-include-index-entries nil
379 "Non-nil means, include index entries in *toc* buffer.
380 This flag can be toggled from within the *toc* buffer with the `i' key."
381 :group
'reftex-table-of-contents-browser
384 (defcustom reftex-toc-confirm-promotion
2
385 "Non-nil means, promotion/demotion commands first prompt for confirmation.
386 When nil, the command is executed immediately. When this is an integer
387 N, ask for confirmation only if N or more section commands are going to be
389 :group
'reftex-table-of-contents-browser
391 (const :tag
"Never" nil
)
392 (const :tag
"Always" t
)
393 (number :tag
"When more than N sections" :value
2)))
395 (defcustom reftex-toc-include-context nil
396 "Non-nil means, include context with labels in the *toc* buffer.
397 Context will only be shown when labels are visible as well.
398 This flag can be toggled from within the *toc* buffer with the `c' key."
399 :group
'reftex-table-of-contents-browser
402 (defcustom reftex-toc-follow-mode nil
403 "Non-nil means, point in *toc* buffer will cause other window to follow.
404 The other window will show the corresponding part of the document.
405 This flag can be toggled from within the *toc* buffer with the `f' key."
406 :group
'reftex-table-of-contents-browser
409 (defcustom reftex-revisit-to-follow nil
410 "Non-nil means, follow-mode will revisit files if necessary.
411 When nil, follow-mode will be suspended for stuff in unvisited files."
412 :group
'reftex-table-of-contents-browser
413 :group
'reftex-referencing-labels
416 (defcustom reftex-toc-mode-hook nil
417 "Mode hook for `reftex-toc-mode'."
418 :group
'reftex-table-of-contents-browser
421 ;; Label Support Configuration
423 (defgroup reftex-label-support nil
424 "Support for creation, insertion and referencing of labels in LaTeX."
427 (defgroup reftex-defining-label-environments nil
428 "Definition of environments and macros to do with label."
429 :group
'reftex-label-support
)
431 (defcustom reftex-default-label-alist-entries
432 '(amsmath endnotes fancybox floatfig longtable picinpar
433 rotating sidecap subfigure supertab wrapfig LaTeX
)
434 "Default label alist specifications. LaTeX should always be the last entry.
435 The value of this variable is a list of symbols with associations in the
436 constant `reftex-label-alist-builtin'. Check that constant for a full list
438 :group
'reftex-defining-label-environments
439 :set
'reftex-set-dirty
446 (list 'const
:tag
(concat (symbol-name (nth 0 x
))
449 reftex-label-alist-builtin
)))
451 (defcustom reftex-label-alist nil
452 "Alist with information on environments for \\label-\\ref use.
454 This docstring is easier to understand after reading the configuration
455 examples in `reftex.el'. Looking at the builtin defaults in the constant
456 `reftex-label-alist-builtin' may also be instructive.
458 Set this variable to define additions and changes to the default. The only
459 things you MUST NOT change is that `?s' is the type indicator for section
460 labels, and SPC for the `any' label type. These are hard-coded at other
463 The value of the variable must be a list of items. Each item is a list
464 itself and has the following structure:
466 (ENV-OR-MACRO TYPE-KEY LABEL-PREFIX REFERENCE-FORMAT CONTEXT-METHOD
467 (MAGIC-WORD ... ) TOC-LEVEL)
469 Each list entry describes either an environment carrying a counter for use
470 with \\label and \\ref, or a LaTeX macro defining a label as (or inside)
471 one of its arguments. The elements of each list entry are:
474 Name of the environment (like \"table\") or macro (like \"\\\\myfig\").
475 For macros, indicate the macro arguments for best results, as in
476 \"\\\\myfig[]{}{}{*}{}\". Use square brackets for optional arguments,
477 a star to mark the label argument, if any. The macro does not have to
478 have a label argument - you could also use \\label{..} inside one of
480 Special names: `section' for section labels, `any' to define a group
481 which contains all labels.
483 This may also be a function to do local parsing and identify point
484 to be in a non-standard label environment. The function must take
485 an argument BOUND and limit backward searches to this value. It
486 should return either nil or a cons cell (FUNCTION . POSITION) with
487 the function symbol and the position where the special environment
488 starts. See the Info documentation for an example.
490 Finally this may also be nil if the entry is only meant to change
491 some settings associated with the type indicator character (see below).
494 Type indicator character, like `?t', must be a printable ASCII character.
495 The type indicator is a single character which defines a label type.
496 Any label inside the environment or macro is assumed to belong to this
497 type. The same character may occur several times in this list, to cover
498 cases in which different environments carry the same label type (like
499 `equation' and `eqnarray').
500 If the type indicator is nil and the macro has a label argument {*},
501 the macro defines neutral labels just like \\label. In this case
502 the reminder of this entry is ignored.
505 Label prefix string, like \"tab:\".
506 The prefix is a short string used as the start of a label. It may be the
507 empty string. The prefix may contain the following `%' escapes:
508 %f Current file name with directory and extension stripped.
509 %F Current file name relative to directory of master file.
510 %m Master file name, directory and extension stripped.
511 %M Directory name (without path) where master file is located.
512 %u User login name, on systems which support this.
513 %S A section prefix derived with variable `reftex-section-prefixes'.
515 Example: In a file `intro.tex', \"eq:%f:\" will become \"eq:intro:\").
518 Format string for reference insert in buffer. `%s' will be replaced by
520 When the format starts with `~', the `~' will only be inserted if
521 there is not already a whitespace before point.
524 Indication on how to find the short context.
525 - If nil, use the text following the \\label{...} macro.
527 - the section heading for section labels.
528 - text following the \\begin{...} statement of environments.
529 (not a good choice for environments like eqnarray or enumerate,
530 where one has several labels in a single environment).
531 - text after the macro name (starting with the first arg) for macros.
532 - If an integer, use the nth argument of the macro. As a special case,
533 1000 means to get text after the last macro argument.
534 - If a string, use as regexp to search *backward* from the label. Context
535 is then the text following the end of the match. E.g. putting this to
536 \"\\\\\\\\caption[[{]\" will use the caption in a figure or table
538 \"\\\\\\\\begin{eqnarray}\\\\|\\\\\\\\\\\\\\\\\" works for eqnarrays.
539 - If any of `caption', `item', `eqnarray-like', `alignat-like', this
540 symbol will internally be translated into an appropriate regexp
541 (see also the variable `reftex-default-context-regexps').
542 - If a function, call this function with the name of the environment/macro
543 as argument. On call, point will be just after the \\label macro. The
544 function is expected to return a suitable context string. It should
545 throw an exception (error) when failing to find context.
546 As an example, here is a function returning the 10 chars following
547 the label macro as context:
549 (defun my-context-function (env-or-mac)
550 (if (> (point-max) (+ 10 (point)))
551 (buffer-substring (point) (+ 10 (point)))
552 (error \"Buffer too small\")))
554 Label context is used in two ways by RefTeX: For display in the label
555 menu, and to derive a label string. If you want to use a different
556 method for each of these, specify them as a dotted pair.
557 E.g. `(nil . t)' uses the text after the label (nil) for display, and
558 text from the default position (t) to derive a label string. This is
559 actually used for section labels.
562 List of magic words which identify a reference to be of this type.
563 If the word before point is equal to one of these words when calling
564 `reftex-reference', the label list offered will be automatically
565 restricted to labels of the correct type.
566 If the first element of this wordlist is the symbol `regexp', the
567 strings are interpreted as regular expressions. RefTeX will add
568 a \"\\\\W\" to the beginning and other stuff to the end of the regexp.
571 The integer level at which this environment should be added to the
572 table of contents. See also `reftex-section-levels'. A positive
573 value will number the entries mixed with the sectioning commands of
574 the same level. A negative value will make unnumbered entries.
575 Useful only for theorem-like environments, will be ignored for macros.
576 When omitted or nil, no TOC entries will be made.
578 If the type indicator characters of two or more entries are the same, RefTeX
580 - the first non-nil format and prefix
581 - the magic words of all involved entries.
583 Any list entry may also be a symbol. If that has an association in
584 `reftex-label-alist-builtin', the cddr of that association is spliced into the
585 list. However, builtin defaults should normally be set with the variable
586 `reftex-default-label-alist-entries."
587 :group
'reftex-defining-label-environments
588 :set
'reftex-set-dirty
591 (choice :tag
"Package or Detailed "
592 :value
("" ?a nil nil nil nil
)
593 (list :tag
"Detailed Entry"
594 :value
("" ?a nil nil nil nil
)
595 (choice :tag
"Environment or \\macro "
596 (const :tag
"Ignore, just use typekey" nil
)
598 (symbol :tag
"Special parser" my-parser
))
599 (choice :tag
"Type specification "
600 (const :tag
"unspecified, like in \\label" nil
)
601 (character :tag
"Char " ?a
))
602 (choice :tag
"Label prefix string "
603 (const :tag
"Default" nil
)
604 (string :tag
"String" "lab:"))
605 (choice :tag
"Label reference format"
606 (const :tag
"Default" nil
)
607 (string :tag
"String" "~\\ref{%s}"))
608 (choice :tag
"Context method "
609 (const :tag
"Default position" t
)
610 (const :tag
"After label" nil
)
611 (number :tag
"Macro arg nr" 1)
612 (regexp :tag
"Regexp" "")
613 (const :tag
"Caption in float" caption
)
614 (const :tag
"Item in list" item
)
615 (const :tag
"Eqnarray-like" eqnarray-like
)
616 (const :tag
"Alignat-like" alignat-like
)
617 (symbol :tag
"Function" my-func
))
618 (repeat :tag
"Magic words" :extra-offset
2 (string))
619 (option (choice :tag
"Make TOC entry "
620 (const :tag
"No entry" nil
)
621 (integer :tag
"Level" :value -
3))))
627 (list 'const
:tag
(concat (symbol-name (nth 0 x
)))
629 reftex-label-alist-builtin
)))))
631 (defcustom reftex-section-prefixes
'((0 .
"part:") (1 .
"cha:") (t .
"sec:"))
632 "Prefixes for section labels.
633 When the label prefix given in an entry in `reftex-label-alist' contains `%S',
634 this list is used to determine the correct prefix string depending on the
635 current section level.
636 The list is an alist, with each entry of the form (KEY . PREFIX)
637 Possible keys are sectioning macro names like `chapter', section levels
638 \(as given in `reftex-section-levels'), and t for the default."
639 :group
'reftex-defining-label-environments
641 (cons :value
(0 .
"")
643 (string :tag
"macro name")
644 (integer :tag
"section level")
645 (const :tag
"default" t
))
646 (string :tag
"Prefix"))))
648 (defcustom reftex-default-context-regexps
649 '((caption .
"\\\\\\(rot\\)?caption\\*?[[{]")
650 (item .
"\\\\item\\(\\[[^]]*\\]\\)?")
651 (eqnarray-like .
"\\\\begin{%s}\\|\\\\\\\\")
652 (alignat-like .
"\\\\begin{%s}{[0-9]*}\\|\\\\\\\\"))
653 "Alist with default regular expressions for finding context.
654 The form (format regexp (regexp-quote environment)) is used to calculate
655 the final regular expression - so %s will be replaced with the environment
657 :group
'reftex-defining-label-environments
658 :type
'(repeat (cons (symbol) (regexp))))
660 (defcustom reftex-trust-label-prefix nil
661 "Non-nil means, trust the label prefix when determining label type.
662 It is customary to use special label prefixes to distinguish different label
663 types. The label prefixes have no syntactic meaning in LaTeX (unless
664 special packages like fancyref are being used). RefTeX can and by
665 default does parse around each label to detect the correct label type,
666 but this process can be slow when a document contains thousands of
667 labels. If you use label prefixes consistently, you may speed up
668 document parsing by setting this variable to a non-nil value. RefTeX
669 will then compare the label prefix with the prefixes found in
670 `reftex-label-alist' and derive the correct label type in this way.
671 Possible values for this option are:
673 t This means to trust any label prefixes found.
674 regexp If a regexp, only prefixes matched by the regexp are trusted.
675 list List of accepted prefixes, as strings. The colon is part of
676 the prefix, e.g. (\"fn:\" \"eqn:\" \"item:\").
677 nil Never trust a label prefix.
679 The only disadvantage of using this feature is that the label context
680 displayed in the label selection buffer along with each label is
681 simply some text after the label definition. This is no problem if you
682 place labels keeping this in mind (e.g. *before* the equation, *at
683 the beginning* of a fig/tab caption ...). Anyway, it is probably best
684 to use the regexp or the list value types to fine-tune this feature.
685 For example, if your document contains thousands of footnotes with
686 labels fn:xxx, you may want to set this variable to the value \"^fn:$\" or
687 \(\"fn:\"). Then RefTeX will still do extensive parsing for any
688 non-footnote labels."
689 :group
'reftex-defining-label-environments
691 (const :tag
"Always" t
)
692 (const :tag
"Never" nil
)
695 (string :tag
"prefix (with colon)"))))
697 (defcustom reftex-special-environment-functions nil
698 "List of functions to be called when trying to figure out current environment.
699 These are special functions to detect \"environments\" which do not
700 start with \\begin and end with \\end. Some LaTeX packages seem to
701 use such non-standard ways to set up environment-like constructs. The
702 purpose of each function in this list is to detect if point is
703 currently inside such a special \"environment\". If the environment
704 carries a label, you must also set up an entry for it in
705 `reftex-label-alist'.
707 The function should check if point is currently in the special
708 environment it was written to detect. If so, the function must return
709 a cons cell (NAME . POSITION). NAME is the name of the environment
710 detected and POSITION is the buffer position where the environment
711 starts. The function must return nil on failure to detect the
714 The function must take an argument BOUND. If non-nil, BOUND is a
715 boundary for backwards searches which should be observed.
717 Here is an example. The LaTeX package linguex.sty defines list macros
718 `\\ex.', `\\a.', etc for lists which are terminated by `\\z.' or an empty
721 \\ex. \\label{ex:12} Some text in an exotic language ...
722 \\a. \\label{ex:13} more stuff
723 \\b. \\label{ex:14} still more stuff
725 ... more text after the empty line terminating all lists
727 And here is the setup for RefTeX:
729 1. Define a dummy environment for this in `reftex-label-alist'. Dummy means,
730 make up an environment name even though it is not used with \\begin and
731 \\end. Here we use \"linguex\" as this name.
733 (setq reftex-label-alist
734 '((\"linguex\" ?x \"ex:\" \"~\\\\ref{%s}\" nil (\"Example\" \"Ex.\"))))
736 2. Write a function to detect the list macros and the determinators as well.
738 (defun my-detect-linguex-list (bound)
739 (let ((pos (point)) p1)
741 ;; Search for any of the linguex item macros at the beginning of a line
742 (if (re-search-backward
743 \"^[ \\t]*\\\\(\\\\\\\\\\\\(ex\\\\|a\\\\|b\\\\|c\\\\|d\\\\|e\\\\|f\\\\)g?\\\\.\\\\)\" bound t)
745 (setq p1 (match-beginning 1))
746 ;; Make sure no empty line or \\z. is between us and the item macro
747 (if (re-search-forward \"\\n[ \\t]*\\n\\\\|\\\\\\\\z\\\\.\" pos t)
748 ;; Return nil because list was already closed
751 (cons \"linguex\" p1)))
752 ;; Return nil for not found
755 3. Tell RefTeX to use this function
757 (setq reftex-special-environment-functions '(my-detect-linguex-list))
759 :group
'reftex-defining-label-environments
764 (defgroup reftex-making-and-inserting-labels nil
765 "Options on how to create new labels."
766 :group
'reftex-label-support
)
768 (defcustom reftex-insert-label-flags
'("s" "sft")
769 "Flags governing label insertion. First flag DERIVE, second flag PROMPT.
771 If DERIVE is t, RefTeX will try to derive a sensible label from context.
772 A section label for example will be derived from the section heading.
773 The conversion of the context to a valid label is governed by the
774 specifications given in `reftex-derive-label-parameters'.
775 If RefTeX fails to derive a label, it will prompt the user.
776 If DERIVE is nil, the label generated will consist of the prefix and a
777 unique number, like `eq:23'.
779 If PROMPT is t, the user will be prompted for a label string. The prompt will
780 already contain the prefix, and (if DERIVE is t) a default label derived from
781 context. When PROMPT is nil, the default label will be inserted without
784 So the combination of DERIVE and PROMPT controls label insertion. Here is a
785 table describing all four possibilities:
788 -------------------------------------------------------------------------
789 nil nil Insert simple label, like eq:22 or sec:13. No query.
790 nil t Prompt for label.
791 t nil Derive a label from context and insert without query.
792 t t Derive a label from context and prompt for confirmation.
794 Each flag may be set to t, nil, or a string of label type letters
795 indicating the label types for which it should be true. The strings work
796 like character classes.
797 Thus, the combination may be set differently for each label type. The
798 default settings \"s\" and \"sft\" mean: Derive section labels from headings
799 \(with confirmation). Prompt for figure and table labels. Use simple labels
800 without confirmation for everything else.
801 The available label types are: s (section), f (figure), t (table), i (item),
802 e (equation), n (footnote), N (endnote), plus any definitions in
803 `reftex-label-alist'."
804 :group
'reftex-making-and-inserting-labels
805 :type
'(list (choice :tag
"Derive label from context"
806 (const :tag
"always" t
)
807 (const :tag
"never" nil
)
808 (string :tag
"selected label types" ""))
809 (choice :tag
"Prompt for label string "
810 :entry-format
" %b %v"
811 (const :tag
"always" t
)
812 (const :tag
"never" nil
)
813 (string :tag
"selected label types" ""))))
815 (defcustom reftex-string-to-label-function
'reftex-string-to-label
816 "Function to turn an arbitrary string into a valid label.
817 RefTeX's default function uses the variable `reftex-derive-label-parameters'."
818 :group
'reftex-making-and-inserting-labels
821 (defcustom reftex-translate-to-ascii-function
'reftex-latin1-to-ascii
822 "Filter function which will process a context string before it is used
823 to derive a label from it. The intended application is to convert ISO or
824 Mule characters into something valid in labels. The default function
825 removes the accents from Latin-1 characters. X-Symbol (>=2.6) sets this
826 variable to the much more general `x-symbol-translate-to-ascii'."
827 :group
'reftex-making-and-inserting-labels
830 (defcustom reftex-derive-label-parameters
'(3 20 t
1 "-"
831 ("the" "on" "in" "off" "a" "for" "by" "of" "and" "is" "to") t
)
832 "Parameters for converting a string into a label.
833 This variable is a list of the following items.
835 NWORDS Number of words to use.
836 MAXCHAR Maximum number of characters in a label string.
837 INVALID nil: Throw away any words containing characters invalid in labels.
838 t: Throw away only the invalid characters, not the whole word.
839 ABBREV nil: Never abbreviate words.
840 t: Always abbreviate words (see `reftex-abbrev-parameters').
841 not t and not nil: Abbreviate words if necessary to shorten
842 label string below MAXCHAR.
843 SEPARATOR String separating different words in the label.
844 IGNOREWORDS List of words which should not be part of labels.
845 DOWNCASE t: Downcase words before using them."
846 :group
'reftex-making-and-inserting-labels
847 :type
'(list (integer :tag
"Number of words " 3)
848 (integer :tag
"Maximum label length " 20)
849 (choice :tag
"Invalid characters in words"
850 (const :tag
"throw away entire word" nil
)
851 (const :tag
"throw away single chars" t
))
852 (choice :tag
"Abbreviate words "
853 (const :tag
"never" nil
)
854 (const :tag
"always" t
)
855 (const :tag
"when label is too long" 1))
856 (string :tag
"Separator between words " "-")
857 (repeat :tag
"Ignore words"
858 :entry-format
" %i %d %v"
860 (option (boolean :tag
"Downcase words "))))
862 (defcustom reftex-label-illegal-re
"[^-a-zA-Z0-9_+=:;,.]"
863 "Regexp matching characters not valid in labels."
864 :group
'reftex-making-and-inserting-labels
865 :type
'(regexp :tag
"Regular Expression"))
867 (defcustom reftex-abbrev-parameters
'(4 2 "^aeiou" "aeiou")
868 "Parameters for abbreviation of words.
869 This variable is a list of the following items.
871 MIN-CHARS Minimum number of characters remaining after abbreviation.
872 MIN-KILL Minimum number of characters to remove when abbreviating words.
873 BEFORE Character class before abbrev point in word.
874 AFTER Character class after abbrev point in word."
875 :group
'reftex-making-and-inserting-labels
877 (integer :tag
"Minimum chars per word" 4)
878 (integer :tag
"Shorten by at least " 2)
879 (string :tag
"cut before char class " "^saeiou")
880 (string :tag
"cut after char class " "aeiou")))
882 (defcustom reftex-format-label-function nil
883 "Function which produces the string to insert as a label definition.
884 Normally should be nil, unless you want to do something fancy.
885 The function will be called with two arguments, the LABEL and the DEFAULT
886 FORMAT, which usually is `\\label{%s}'. The function should return the
887 string to insert into the buffer."
888 :group
'reftex-making-and-inserting-labels
893 (defgroup reftex-referencing-labels nil
894 "Options on how to reference labels."
895 :group
'reftex-label-support
)
899 '((const :tag
"on" t
)
900 (const :tag
"off" nil
)
901 (string :tag
"Selected label types"))))
903 (defcustom reftex-label-menu-flags
'(t t nil nil nil nil t nil
)
904 "List of flags governing the label menu makeup.
907 TABLE-OF-CONTENTS Show the labels embedded in a table of context.
908 SECTION-NUMBERS Include section numbers (like 4.1.3) in table of contents.
909 COUNTERS Show counters. This just numbers the labels in the menu.
910 NO-CONTEXT Non-nil means do NOT show the short context.
911 FOLLOW Follow full context in other window.
912 SHOW-COMMENTED Show labels from regions which are commented out.
913 MATCH-IN-TOC Obsolete flag.
914 SHOW FILES Show begin and end of included files.
916 Each of these flags can be set to t or nil, or to a string of type letters
917 indicating the label types for which it should be true. These strings work
918 like character classes in regular expressions. Thus, setting one of the
919 flags to \"sf\" makes the flag true for section and figure labels, nil
920 for everything else. Setting it to \"^sf\" makes it the other way round.
921 The available label types are: s (section), f (figure), t (table), i (item),
922 e (equation), n (footnote), plus any definitions in `reftex-label-alist'.
924 Most options can also be switched from the label menu itself - so if you
925 decide here to not have a table of contents in the label menu, you can still
926 get one interactively during selection from the label menu."
927 :group
'reftex-referencing-labels
930 (choice :tag
"Embed in table of contents " ,@reftex-tmp
)
931 (choice :tag
"Show section numbers " ,@reftex-tmp
)
932 (choice :tag
"Show individual counters " ,@reftex-tmp
)
933 (choice :tag
"Hide short context " ,@reftex-tmp
)
934 (choice :tag
"Follow context in other window " ,@reftex-tmp
)
935 (choice :tag
"Show commented labels " ,@reftex-tmp
)
936 (choice :tag
"Obsolete flag, Don't use. " ,@reftex-tmp
)
937 (choice :tag
"Show begin/end of included files" ,@reftex-tmp
)))
939 (defcustom reftex-multiref-punctuation
'((?
, .
", ") (?- .
"--") (?
+ .
" and "))
940 "Punctuation strings for multiple references.
941 When marking is used in the selection buffer to select several references,
942 this variable associates the 3 marking characters `,-+' with prefix strings
943 to be inserted into the buffer before the corresponding \\ref macro.
944 This is used to string together whole reference sets, like
945 `eqs. 1,2,3-5,6 and 7' in a single call to `reftex-reference'. See manual."
946 :group
'reftex-referencing-labels
947 :type
'(repeat (cons (character) (string))))
949 (defcustom reftex-vref-is-default nil
950 "Non-nil means, the varioref macro \\vref is used as default.
951 In the selection buffer, the `v' key toggles the reference macro between
952 `\\ref' and `\\vref'. The value of this variable determines the default
953 which is active when entering the selection process.
954 Instead of nil or t, this may also be a string of type letters indicating
955 the label types for which it should be true."
956 :group
'reftex-referencing-labels
957 :type
`(choice :tag
"\\vref is default macro" ,@reftex-tmp
))
958 ;;;###autoload(put 'reftex-vref-is-default 'safe-local-variable (lambda (x) (or (stringp x) (symbolp x))))
960 (defcustom reftex-fref-is-default nil
961 "Non-nil means, the fancyref macro \\fref is used as default.
962 In the selection buffer, the `V' key toggles the reference macro between
963 `\\ref', `\\fref' and `\\Fref'. The value of this variable determines
964 the default which is active when entering the selection process.
965 Instead of nil or t, this may also be a string of type letters indicating
966 the label types for which it should be true."
967 :group
'reftex-referencing-labels
968 :type
`(choice :tag
"\\fref is default macro" ,@reftex-tmp
))
969 ;;;###autoload(put 'reftex-fref-is-default 'safe-local-variable (lambda (x) (or (stringp x) (symbolp x))))
971 (defcustom reftex-level-indent
2
972 "Number of spaces to be used for indentation per section level."
973 :group
'reftex-referencing-labels
975 ;;;###autoload(put 'reftex-level-indent 'safe-local-variable 'integerp)
977 (defcustom reftex-guess-label-type t
978 "Non-nil means, `reftex-reference' will try to guess the label type.
979 To do that, RefTeX will look at the word before the cursor and compare it with
980 the words given in `reftex-label-alist'. When it finds a match, RefTeX will
981 immediately offer the correct label menu - otherwise it will prompt you for
982 a label type. If you set this variable to nil, RefTeX will always prompt."
983 :group
'reftex-referencing-labels
985 ;;;###autoload(put 'reftex-guess-label-type 'safe-local-variable (lambda (x) (memq x '(nil t))))
987 (defcustom reftex-format-ref-function nil
988 "Function which produces the string to insert as a reference.
989 Normally should be nil, because the format to insert a reference can
990 already be specified in `reftex-label-alist'.
991 This hook also is used by the special commands to insert `\\vref' and `\\fref'
992 references, so even if you set this, your setting will be ignored by
993 the special commands.
994 The function will be called with two arguments, the LABEL and the DEFAULT
995 FORMAT, which normally is `~\\ref{%s}'. The function should return the
996 string to insert into the buffer."
997 :group
'reftex-referencing-labels
1000 (defcustom reftex-select-label-mode-hook nil
1001 "Mode hook for reftex-select-label-mode."
1002 :group
'reftex-referencing-labels
1005 ;; BibteX citation configuration ----------------------------------------
1007 (defgroup reftex-citation-support nil
1008 "Support for referencing bibliographic data with BibTeX."
1011 (defcustom reftex-bibliography-commands
'("bibliography" "nobibliography")
1012 "LaTeX commands which specify the BibTeX databases to use with the document."
1013 :group
'reftex-citation-support
1014 :type
'(repeat string
))
1017 (defvar reftex-bibfile-ignore-list nil
) ; compatibility
1018 (defcustom reftex-bibfile-ignore-regexps nil
1019 "List of regular expressions to exclude files in \\bibliography{..}.
1020 File names matched by these regexps will not be parsed by RefTeX.
1021 Intended for files which contain only `@string' macro definitions and the
1022 like, which are ignored by RefTeX anyway."
1023 :group
'reftex-citation-support
1024 :set
'reftex-set-dirty
1025 :type
'(repeat (regexp)))
1027 (defcustom reftex-default-bibliography nil
1028 "List of BibTeX database files which should be used if none are specified.
1029 When `reftex-citation' is called from a document which has neither a
1030 `\\bibliography{..}' statement nor a `thebibliography' environment,
1031 RefTeX will scan these files instead. Intended for using `reftex-citation'
1032 in non-LaTeX files. The files will be searched along the BIBINPUTS or TEXBIB
1034 :group
'reftex-citation-support
1035 :type
'(repeat (file)))
1037 (defcustom reftex-sort-bibtex-matches
'reverse-year
1038 "Sorting of the entries found in BibTeX databases by reftex-citation.
1040 nil Do not sort entries.
1041 'author Sort entries by author name.
1042 'year Sort entries by increasing year.
1043 'reverse-year Sort entries by decreasing year."
1044 :group
'reftex-citation-support
1045 :type
'(choice (const :tag
"not" nil
)
1046 (const :tag
"by author" author
)
1047 (const :tag
"by year" year
)
1048 (const :tag
"by year, reversed" reverse-year
)))
1050 (defcustom reftex-cite-format
'default
1051 "The format of citations to be inserted into the buffer.
1052 It can be a string or an alist or a symbol. In the simplest case this
1053 is just the string \"\\cite{%l}\", which is also the default. See the
1054 definition of `reftex-cite-format-builtin' for more complex examples.
1056 If `reftex-cite-format' is a string, it will be used as the format.
1057 In the format, the following percent escapes will be expanded.
1059 %l The BibTeX label of the citation.
1060 %a List of author names, see also `reftex-cite-punctuation'.
1061 %2a Like %a, but abbreviate more than 2 authors like Jones et al.
1062 %A First author name only.
1063 %e Works like %a, but on list of editor names. (%2e and %E work a well)
1065 It is also possible to access all other BibTeX database fields:
1066 %b booktitle %c chapter %d edition %h howpublished
1067 %i institution %j journal %k key %m month
1068 %n number %o organization %p pages %P first page
1069 %r address %s school %u publisher %t title
1071 %B booktitle, abbreviated %T title, abbreviated
1073 Usually, only %l is needed. The other stuff is mainly for the echo area
1074 display, and for (setq reftex-comment-citations t).
1076 %< as a special operator kills punctuation and space around it after the
1077 string has been formatted.
1079 A pair of square brackets indicates an optional argument, and RefTeX
1080 will prompt for the values of these arguments.
1082 Beware that all this only works with BibTeX database files. When
1083 citations are made from the \\bibitems in an explicit thebibliography
1084 environment, only %l is available.
1086 If `reftex-cite-format' is an alist of characters and strings, the user
1087 will be prompted for a character to select one of the possible format
1089 In order to configure this variable, you can either set
1090 `reftex-cite-format' directly yourself or set it to the SYMBOL of one of
1091 the predefined styles. The predefined symbols are those which have an
1092 association in the constant `reftex-cite-format-builtin'.
1093 E.g.: (setq reftex-cite-format 'natbib)"
1094 :group
'reftex-citation-support
1097 :format
"%{%t%}: \n%[Value Menu%] %v"
1098 (radio :tag
"Symbolic Builtins"
1103 (list 'const
:tag
(concat (symbol-name (nth 0 x
))
1106 reftex-cite-format-builtin
))
1107 (string :tag
"format string" "\\cite{%l}")
1108 (repeat :tag
"key-ed format strings"
1109 :value
((?
\r .
"\\cite{%l}")
1110 (?t .
"\\cite{%l}") (?p .
"\\cite{%l}"))
1111 (cons (character :tag
"Key character" ?
\r)
1112 (string :tag
"Format string" "")))))
1114 (defcustom reftex-cite-prompt-optional-args
'maybe
1115 "Non-nil means, prompt for empty optional arguments in cite macros.
1116 When an entry in `reftex-cite-format' ist given with square brackets to
1117 indicate optional arguments (for example \\cite[][]{%l}), RefTeX can
1118 prompt for values. Possible values are:
1120 nil Never prompt for optional arguments
1122 maybe Prompt only if `reftex-citation' was called with C-u prefix arg
1124 Unnecessary empty optional arguments are removed before insertion into
1125 the buffer. See `reftex-cite-cleanup-optional-args'."
1126 :group
'reftex-citation-support
1128 (const :tag
"Always" t
)
1129 (const :tag
"When called with prefix arg" maybe
)
1130 (const :tag
"Never" nil
)))
1132 (defcustom reftex-cite-cleanup-optional-args t
1133 "Non-nil means, remove unnecessary empty optional arguments in cite macros.
1134 The cite macros provided by some packages (for example
1135 natbib) allow specifying two optional arguments, one for a prefix to
1136 the citation, and a second for a postfix. When only one optional
1137 argument is given, it is interpreted as postfix. When this option is
1138 t, RefTeX removes unnecessary empty optional arguments from the cite
1139 macro before insertion. For example, it will change
1140 \\cite[][]{Jones} -> \\cite{Jones}
1141 \\cite[][Chapter 1]{Jones} -> \\cite[Chapter 1]{Jones}
1142 \\cite[see][]{Jones} -> \\cite[see][]{Jones}
1143 \\cite[see][Chapter 1]{Jones} -> \\cite{Jones}
1144 Is is possible that other packages have other conventions about which
1145 optional argument is interpreted how - that is why this cleaning up
1147 :group
'reftex-citation-support
1150 (defcustom reftex-comment-citations nil
1151 "Non-nil means add a comment for each citation describing the full entry.
1152 The comment is formatted according to `reftex-cite-comment-format'."
1153 :group
'reftex-citation-support
1156 (defcustom reftex-cite-comment-format
1157 "%% %2a %y, %j %v, %P, %b, %e, %u, %s %<\n"
1158 "Citation format used for commented citations. Must NOT contain %l.
1159 See the variable `reftex-cite-format' for possible percent escapes."
1160 :group
'reftex-citation-support
1163 (defcustom reftex-cite-view-format
"%2a %y, %T, %B, %j %v:%P, %s %<"
1164 "Citation format used to display citation info in the message area.
1165 Must NOT contain %l. See the variable `reftex-cite-format' for
1166 possible percent escapes."
1167 :group
'reftex-citation-support
1168 :group
'reftex-viewing-cross-references
1171 (defcustom reftex-cite-punctuation
'(", " " \\& " " {\\it et al.}")
1172 "Punctuation for formatting of name lists in citations.
1173 This is a list of 3 strings.
1174 1. Normal names separator, like \", \" in Jones, Brown and Miller
1175 2. Final names separator, like \" and \" in Jones, Brown and Miller
1176 3. The \"et al\" string, like \" {\\it et al.}\" in Jones {\\it et al.}"
1177 :group
'reftex-citation-support
1179 (string :tag
"Separator for names ")
1180 (string :tag
"Separator for last name in list")
1181 (string :tag
"string used as et al. ")))
1183 (defcustom reftex-format-cite-function nil
1184 "Function which produces the string to insert as a citation.
1185 Normally should be nil, because the format to insert a reference can
1186 already be specified in `reftex-cite-format'.
1187 The function will be called with two arguments, the CITATION KEY and the
1188 DEFAULT FORMAT, which is taken from `reftex-cite-format'. The function
1189 should return the string to insert into the buffer."
1190 :group
'reftex-citation-support
1193 (defcustom reftex-select-bib-mode-hook nil
1194 "Mode hook for reftex-select-bib-mode."
1195 :group
'reftex-citation-support
1198 ;; Index Support Configuration
1200 (defgroup reftex-index-support nil
1201 "Support for viewing and editing the index."
1204 (defcustom reftex-support-index t
1205 "Non-nil means, index entries are parsed as well.
1206 Index support is resource intensive and the internal structure holding the
1207 parsed information can become quite big. Therefore it can be turned off.
1208 When this is nil and you execute a command which requires index support,
1209 you will be asked for confirmation to turn it on and rescan the document."
1210 :group
'reftex-index-support
1213 (defcustom reftex-index-special-chars
'("!" "|" "@" "\"" "\\")
1214 "Special characters in index entries. The value is a list of five strings.
1215 These correspond to the makeindex keywords LEVEL ENCAP ACTUAL QUOTE ESCAPE."
1216 :group
'reftex-index-support
1218 (string :tag
"LEVEL separator")
1219 (string :tag
"ENCAP char ")
1220 (string :tag
"ACTUAL char ")
1221 (string :tag
"QUOTE char ")
1222 (string :tag
"ESCAPE char ")))
1224 (defcustom reftex-index-macros nil
1225 "Macros which define index entries. The structure is
1227 \(MACRO INDEX-TAG KEY PREFIX EXCLUDE REPEAT)
1229 MACRO is the macro. Arguments should be denoted by empty braces like
1230 \\index[]{*}. Use square brackets to denote optional arguments. The star
1231 marks where the index key is.
1233 INDEX-TAG is a short name of the index. \"idx\" and \"glo\" are
1234 reserved for the default index and the glossary. Other indices can be
1235 defined as well. If this is an integer, the Nth argument of the macro
1236 holds the index tag.
1238 KEY is a character which is used to identify the macro for input with
1239 \\[reftex-index]. ?i, ?I, and ?g are reserved for default index and glossary.
1241 PREFIX can be a prefix which is added to the KEY part of the index entry.
1242 If you have a macro \\newcommand{\\molec}[1]{#1\\index{Molecules!#1}}, this
1243 prefix should be \"Molecules!\". See the manual for details.
1245 EXCLUDE can be a function. If this function exists and returns a non-nil
1246 value, the index entry at point is ignored. This was implemented to support
1247 the (deprecated) `^' and `_' shortcuts in the LaTeX2e `index' package.
1249 REPEAT, if non-nil, means the index macro does not typeset the entry in
1250 the text, so that the text has to be repeated outside the index macro.
1251 Needed for `reftex-index-selection-or-word' and for indexing from the
1254 The final entry may also be a symbol if this entry has a association
1255 in the variable `reftex-index-macros-builtin' to specify the main
1256 indexing package you are using. Valid values are currently
1257 default The LaTeX default - unnecessary to specify this one
1258 multind The multind.sty package
1259 index The index.sty package
1260 index-shortcut The index.sty packages with the ^ and _ shortcuts.
1261 Should not be used - only for old documents.
1262 Note that AUCTeX sets these things internally for RefTeX as well, so
1263 with a sufficiently new version of AUCTeX, you should not set the
1265 :group
'reftex-index-support
1266 :set
'reftex-set-dirty
1270 (list :value
("" "idx" ?a
"" nil
)
1271 (string :tag
"Macro with args")
1272 (choice :tag
"Index Tag "
1274 (integer :tag
"Macro arg Nr" :value
1))
1275 (character :tag
"Access Key ")
1276 (string :tag
"Key Prefix ")
1277 (symbol :tag
"Exclusion hook ")
1278 (boolean :tag
"Repeat Outside ")))
1281 (choice :tag
"Package"
1285 (list 'const
:tag
(concat (symbol-name (nth 0 x
))
1288 reftex-index-macros-builtin
)))))
1290 (defcustom reftex-index-default-macro
'(?i
"idx")
1291 "The default index macro for \\[reftex-index-selection-or-word].
1292 This is a list with (MACRO-KEY DEFAULT-TAG).
1294 MACRO-KEY: Character identifying an index macro - see `reftex-index-macros'.
1295 DEFAULT-TAG: This is the tag to be used if the macro requires a TAG argument.
1296 When this is nil and a TAG is needed, RefTeX will ask for it.
1297 When this is the empty string and the TAG argument of the index
1298 macro is optional, the TAG argument will be omitted."
1299 :group
'reftex-index-support
1301 (character :tag
"Character identifying default macro")
1302 (choice :tag
"Default index tag "
1306 (defcustom reftex-index-default-tag
"idx"
1308 When working with multiple indexes, RefTeX queries for an index tag when
1309 creating index entries or displaying a specific index. This variable controls
1310 the default offered for these queries. The default can be selected with RET
1311 during selection or completion. Valid values of this variable are:
1313 nil Do not provide a default index
1314 \"tag\" The default index tag given as a string, e.g. \"idx\".
1315 last The last used index tag will be offered as default."
1316 :group
'reftex-index-support
1318 (const :tag
"no default" nil
)
1319 (const :tag
"last used " 'last
)
1320 (string :tag
"index tag " "idx")))
1322 (defcustom reftex-index-math-format
"$%s$"
1323 "Format of index entries when copied from inside math mode.
1324 When `reftex-index-selection-or-word' is executed inside TeX math mode,
1325 the index key copied from the buffer is processed with this format string
1326 through the `format' function. This can be used to add the math delimiters
1327 \(e.g. `$') to the string.
1328 Requires the `texmathp.el' library which is part of AUCTeX."
1329 :group
'reftex-index-support
1332 (defcustom reftex-index-phrase-file-extension
".rip"
1333 "File extension for the index phrase file.
1334 This extension will be added to the base name of the master file."
1335 :group
'reftex-index-support
1338 (defcustom reftex-index-phrases-logical-and-regexp
" *&& *"
1339 "Regexp matching the `and' operator for index arguments in phrases file.
1340 When several index arguments in a phrase line are separated by this
1341 operator, each part will generate an index macro. So each match of
1342 the search phrase will produce *several* different index entries.
1344 Note: make sure this does no match things which are not separators.
1345 This logical `and' has higher priority than the logical `or' specified in
1346 `reftex-index-phrases-logical-or-regexp'."
1347 :group
'reftex-index-support
1350 (defcustom reftex-index-phrases-logical-or-regexp
" *|| *"
1351 "Regexp matching the `or' operator for index arguments in phrases file.
1352 When several index arguments in a phrase line are separated by this
1353 operator, the user will be asked to select one of them at each match
1354 of the search phrase. The first index arg will be the default - a
1355 number key 1-9 must be pressed to switch to another.
1357 Note: make sure this does no match things which are not separators.
1358 The logical `and' specified in `reftex-index-phrases-logical-or-regexp'
1359 has higher priority than this logical `or'."
1360 :group
'reftex-index-support
1363 (defcustom reftex-index-phrases-search-whole-words t
1364 "Non-nil means phrases search will look for whole words, not subwords.
1365 This works by requiring word boundaries at the beginning and end of
1366 the search string. When the search phrase already has a non-word-char
1367 at one of these points, no word boundary is required there."
1368 :group
'reftex-index-support
1371 (defcustom reftex-index-phrases-case-fold-search t
1372 "Non-nil means, searching for index phrases will ignore case."
1373 :group
'reftex-index-support
1376 (defcustom reftex-index-verify-function nil
1377 "A function which is called at each match during global indexing.
1378 If the function returns nil, the current match is skipped."
1379 :group
'reftex-index-support
1381 (const :tag
"No verification" nil
)
1384 (defcustom reftex-index-phrases-skip-indexed-matches nil
1385 "Non-nil means, skip matches which appear to be indexed already.
1386 When doing global indexing from the phrases buffer, searches for some
1387 phrases may match at places where that phrase was already indexed. In
1388 particular when indexing an already processed document again, this
1389 will even be the norm. When this variable is non-nil, RefTeX checks if
1390 the match is inside an index macro argument, or if an index macro is directly
1391 before or after the phrase. If that is the case, that match will
1393 :group
'reftex-index-support
1396 (defcustom reftex-index-phrases-wrap-long-lines nil
1397 "Non-nil means, when indexing from the phrases buffer, wrap lines.
1398 Inserting indexing commands in a line makes the line longer - often
1399 so long that it does not fit onto the screen. When this variable is
1400 non-nil, newlines will be added as necessary before and/or after the
1401 indexing command to keep lines short. However, the matched text
1402 phrase and its index command will always end up on a single line."
1403 :group
'reftex-index-support
1406 (defcustom reftex-index-phrases-sort-prefers-entry nil
1407 "Non-nil means when sorting phrase lines, the explicit index entry is used.
1408 Phrase lines in the phrases buffer contain a search phrase, and
1409 sorting is normally based on these. Some phrase lines also have
1410 an explicit index argument specified. When this variable is non-nil,
1411 the index argument will be used for sorting."
1412 :group
'reftex-index-support
1415 (defcustom reftex-index-phrases-sort-in-blocks t
1416 "Non-nil means, empty and comment lines separate phrase buffer into blocks.
1417 Sorting will then preserve blocks, so that lines are re-arranged only
1419 :group
'reftex-index-support
1422 (defcustom reftex-index-section-letters
"ABCDEFGHIJKLMNOPQRSTUVWXYZ"
1423 "The letters which denote sections in the index.
1424 Usually these are all capital letters. Don't use any downcase letters.
1425 Order is not significant, the index will be sorted by whatever the sort
1426 function thinks is correct.
1427 In addition to these letters, RefTeX will create a group `!' which
1428 contains all entries sorted below the lowest specified letter.
1429 In the index buffer, pressing any of these capital letters or `!' will jump
1431 :group
'reftex-index-support
1432 :type
'(string :tag
"Capital letters"))
1434 (defcustom reftex-index-include-context nil
1435 "Non-nil means, display the index definition context in the index buffer.
1436 This flag may also be toggled from the index buffer with the `c' key."
1437 :group
'reftex-index-support
1440 (defcustom reftex-index-follow-mode nil
1441 "Non-nil means, point in *Index* buffer will cause other window to follow.
1442 The other window will show the corresponding part of the document.
1443 This flag can be toggled from within the *Index* buffer with the `f' key."
1444 :group
'reftex-table-of-contents-browser
1447 ;; Viewing Cross References
1449 (defgroup reftex-viewing-cross-references nil
1450 "Displaying cross references and citations."
1453 (defcustom reftex-view-crossref-extra nil
1454 "Macros which can be used for the display of cross references.
1455 This is used when `reftex-view-crossref' is called with point in an
1456 argument of a macro. Note that crossref viewing for citations,
1457 references (both ways) and index entries is hard-coded. This variable
1458 is only to configure additional structures for which crossreference
1459 viewing can be useful. Each entry has the structure
1461 \(MACRO-RE SEARCH-RE HIGHLIGHT).
1463 MACRO-RE is matched against the macro. SEARCH-RE is the regexp used
1464 to search for cross references. `%s' in this regexp is replaced with
1465 with the macro argument at point. HIGHLIGHT is an integer indicating
1466 which subgroup of the match should be highlighted."
1467 :group
'reftex-viewing-cross-references
1468 :type
'(repeat (group (regexp :tag
"Macro Regexp ")
1469 (string :tag
"Search Regexp ")
1470 (integer :tag
"Highlight Group"))))
1472 (defcustom reftex-auto-view-crossref t
1473 "Non-nil means, initially turn automatic viewing of crossref info on.
1474 Automatic viewing of crossref info normally uses the echo area.
1475 Whenever point is idle for more than `reftex-idle-time' seconds on the
1476 argument of a \\ref or \\cite macro, and no other message is being
1477 displayed, the echo area will display information about that cross
1478 reference. You can also set the variable to the symbol `window'. In
1479 this case a small temporary window is used for the display.
1480 This feature can be turned on and off from the menu
1482 :group
'reftex-viewing-cross-references
1483 :type
'(choice (const :tag
"off" nil
)
1484 (const :tag
"in Echo Area" t
)
1485 (const :tag
"in Other Window" window
)))
1487 (defcustom reftex-idle-time
1.2
1488 "Time (secs) Emacs has to be idle before automatic crossref display is done.
1489 Applies also to toc recentering."
1490 :group
'reftex-viewing-cross-references
1493 (defcustom reftex-revisit-to-echo nil
1494 "Non-nil means, automatic citation display will revisit files if necessary.
1495 When nil, citation display in echo area will only be active for cached
1496 entries and for BibTeX database files with live associated buffers."
1497 :group
'reftex-viewing-cross-references
1500 (defcustom reftex-cache-cite-echo t
1501 "Non-nil means, the information displayed in the echo area for cite macros
1502 is cached and even saved along with the parsing information. The cache
1503 survives document scans. In order to clear it, use M-x reftex-reset-mode."
1504 :group
'reftex-viewing-cross-references
1507 (defcustom reftex-display-copied-context-hook nil
1508 "Normal Hook which is run before context is displayed anywhere. Designed
1509 for X-Symbol, but may have other uses as well."
1510 :group
'reftex-viewing-cross-references
1511 :group
'reftex-referencing-labels
1514 ;; Finding Files --------------------------------------------------------
1516 (defgroup reftex-finding-files nil
1517 "Finding files on search paths."
1520 (defcustom reftex-texpath-environment-variables
'("TEXINPUTS")
1521 "List of specifications how to retrieve the search path for TeX files.
1522 Several entries are possible.
1523 - If an element is the name of an environment variable, its content is used.
1524 - If an element starts with an exclamation mark, it is used as a command
1525 to retrieve the path. A typical command with the kpathsearch library would
1526 be `!kpsewhich -show-path=.tex'.
1527 - Otherwise the element itself is interpreted as a path.
1528 Multiple directories can be separated by the system dependent `path-separator'.
1529 Directories ending in `//' or `!!' will be expanded recursively.
1530 See also `reftex-use-external-file-finders'."
1531 :group
'reftex-finding-files
1532 :set
'reftex-set-dirty
1533 :type
'(repeat (string :tag
"Specification")))
1535 (defcustom reftex-bibpath-environment-variables
'("BIBINPUTS" "TEXBIB")
1536 "List of specifications how to retrieve search path for .bib database files.
1537 Several entries are possible.
1538 - If an element is the name of an environment variable, its content is used.
1539 - If an element starts with an exclamation mark, it is used as a command
1540 to retrieve the path. A typical command with the kpathsearch library would
1541 be `!kpsewhich -show-path=.bib'.
1542 - Otherwise the element itself is interpreted as a path.
1543 Multiple directories can be separated by the system dependent `path-separator'.
1544 Directories ending in `//' or `!!' will be expanded recursively.
1545 See also `reftex-use-external-file-finders'."
1546 :group
'reftex-citation-support
1547 :group
'reftex-finding-files
1548 :set
'reftex-set-dirty
1549 :type
'(repeat (string :tag
"Specification")))
1551 (defcustom reftex-file-extensions
'(("tex" .
(".tex" ".ltx"))
1553 "Association list with file extensions for different file types.
1554 This is a list of items, each item is like: (TYPE . (DEF-EXT OTHER-EXT ...))
1556 TYPE: File type like \"bib\" or \"tex\".
1557 DEF-EXT: The default extension for that file type, like \".tex\" or \".bib\".
1558 OTHER-EXT: Any number of other valid extensions for this file type.
1560 When a files is searched and it does not have any of the legal extensions,
1561 we try the default extension first, and then the naked file name.
1563 If you are using AUCTeX, you also need to add new extensions to
1564 TeX-file-extensions."
1565 :group
'reftex-finding-files
1566 :type
'(repeat (cons (string :tag
"File type")
1567 (repeat (string :tag
"Extension")))))
1569 (defcustom reftex-try-all-extensions nil
1570 "Non-nil means, try all extensions listed in `reftex-file-extensions'.
1571 When searching for a file, LaTeX uses only the default extension. However,
1572 if you are working with a noweb system that produces the .tex files from
1573 some other file, and you want RefTeX to scan the web file instead of the
1574 tex file, you need to set this option. You also need to make the noweb
1575 extension the default extension, i.e. the first in the list in
1576 `reftex-file-extensions'.
1577 Note that if you are using external file finders, this option has no effect."
1578 :group
'reftex-finding-files
1581 (defcustom reftex-search-unrecursed-path-first t
1582 "Non-nil means, search all specified directories before trying recursion.
1583 Thus, in a path \".//:/tex/\", search first \"./\", then \"/tex/\" and then
1584 all subdirectories of \"./\". If this option is nil, the subdirectories of
1585 \"./\" are searched before \"/tex/\". This is mainly for speed - most of the
1586 time the recursive path is for the system files and not for the user files.
1587 Set this to nil if the default makes RefTeX finding files with equal names
1589 :group
'reftex-finding-files
1592 (defcustom reftex-use-external-file-finders nil
1593 "Non-nil means, use external programs to find files.
1594 Normally, RefTeX searches the paths given in the environment variables
1595 TEXINPUTS and BIBINPUTS to find TeX files and BibTeX database files.
1596 With this option turned on, it calls an external program specified in the
1597 option `reftex-external-file-finders' instead. As a side effect,
1598 the variables `reftex-texpath-environment-variables' and
1599 `reftex-bibpath-environment-variables' will be ignored."
1600 :group
'reftex-finding-files
1603 (defcustom reftex-external-file-finders
'(("tex" .
"kpsewhich -format=.tex %f")
1604 ("bib" .
"kpsewhich -format=.bib %f"))
1605 "Association list with external programs to call for finding files.
1606 Each entry is a cons cell (TYPE . PROGRAM).
1607 TYPE is either \"tex\" or \"bib\". PROGRAM is the external program to use with
1608 any arguments. %f will be replaced by the name of the file to be found.
1609 Note that these commands will be executed directly, not via a shell.
1610 Only relevant when `reftex-use-external-file-finders' is non-nil."
1611 :group
'reftex-finding-files
1612 :type
'(repeat (cons (string :tag
"File type")
1613 (string :tag
"Program "))))
1615 ;; Tuning the parser ----------------------------------------------------
1617 (defgroup reftex-optimizations-for-large-documents nil
1618 "Configuration of parser speed and memory usage."
1621 (defcustom reftex-keep-temporary-buffers
1
1622 "Non-nil means, keep buffers created for parsing and lookup.
1623 RefTeX sometimes needs to visit files related to the current document.
1624 We distinguish files visited for
1625 PARSING: Parts of a multifile document loaded when (re)-parsing the document.
1626 LOOKUP: BibTeX database files and TeX files loaded to find a reference,
1627 to display label context, etc.
1628 The created buffers can be kept for later use, or be thrown away immediately
1629 after use, depending on the value of this variable:
1631 nil Throw away as much as possible.
1633 1 Throw away buffers created for parsing, but keep the ones created
1636 If a buffer is to be kept, the file is visited normally (which is potentially
1637 slow but will happen only once).
1638 If a buffer is to be thrown away, the initialization of the buffer depends
1639 upon the variable `reftex-initialize-temporary-buffers'."
1640 :group
'reftex-optimizations-for-large-documents
1642 (const :tag
"Throw away everything" nil
)
1643 (const :tag
"Keep everything" t
)
1644 (const :tag
"Keep lookup buffers only" 1)))
1646 (defcustom reftex-initialize-temporary-buffers nil
1647 "Non-nil means do initializations even when visiting file temporarily.
1648 When nil, RefTeX may turn off find-file hooks and other stuff to briefly
1650 When t, the full default initializations are done (find-file-hook etc.).
1651 Instead of t or nil, this variable may also be a list of hook functions to
1652 do a minimal initialization."
1653 :group
'reftex-optimizations-for-large-documents
1655 (const :tag
"Read files literally" nil
)
1656 (const :tag
"Fully initialize buffers" t
)
1657 (repeat :tag
"Hook functions" :value
(nil)
1660 (defcustom reftex-no-include-regexps
'("\\.pstex_t\\'")
1661 "List of regular expressions to exclude certain input files from parsing.
1662 If the name of a file included via \\include or \\input is matched by any
1663 of the regular expressions in this list, that file is not parsed by RefTeX."
1664 :group
'reftex-optimizations-for-large-documents
1665 :type
'(repeat (regexp)))
1667 (defcustom reftex-enable-partial-scans nil
1668 "Non-nil means, re-parse only 1 file when asked to re-parse.
1669 Re-parsing is normally requested with a `C-u' prefix to many RefTeX commands,
1670 or with the `r' key in menus. When this option is t in a multifile document,
1671 we will only parse the current buffer, or the file associated with the label
1672 or section heading near point in a menu. Requesting re-parsing of an entire
1673 multifile document then requires a `C-u C-u' prefix or the capital `R' key
1675 :group
'reftex-optimizations-for-large-documents
1678 (defcustom reftex-allow-automatic-rescan t
1679 "Non-nil means, RefTeX may rescan the document when this seems necessary.
1680 Currently this applies only to rescanning after label insertion, when
1681 the new label cannot be inserted correctly into the internal label
1683 :group
'reftex-optimizations-for-large-documents
1686 (defcustom reftex-save-parse-info nil
1687 "Non-nil means, save information gathered with parsing in a file.
1688 The file MASTER.rel in the same directory as MASTER.tex is used to save the
1689 information. When this variable is t,
1690 - accessing the parsing information for the first time in an editing session
1691 will read that file (if available) instead of parsing the document.
1692 - exiting Emacs or killing a buffer in reftex-mode will cause a new version
1693 of the file to be written."
1694 :group
'reftex-optimizations-for-large-documents
1697 (defcustom reftex-parse-file-extension
".rel"
1698 "File extension for the file in which parser information is stored.
1699 This extension is added to the base name of the master file."
1700 :group
'reftex-optimizations-for-large-documents
1703 (defcustom reftex-use-multiple-selection-buffers nil
1704 "Non-nil means use a separate selection buffer for each label type.
1705 These buffers are kept from one selection to the next and need not to be
1706 created for each use - so the menu generally comes up faster. The
1707 selection buffers will be erased (and therefore updated) automatically
1708 when new labels in its category are added. See the variable
1709 `reftex-auto-update-selection-buffers'."
1710 :group
'reftex-optimizations-for-large-documents
1711 :group
'reftex-referencing-labels
1714 (defcustom reftex-auto-update-selection-buffers t
1715 "Non-nil means, selection buffers will be updated automatically.
1716 When a new label is defined with `reftex-label', all selection buffers
1717 associated with that label category are emptied, in order to force an
1718 update upon next use. When nil, the buffers are left alone and have to be
1719 updated by hand, with the `g' key from the label selection process.
1720 The value of this variable will only have any effect when
1721 `reftex-use-multiple-selection-buffers' is non-nil."
1722 :group
'reftex-optimizations-for-large-documents
1723 :group
'reftex-referencing-labels
1726 ;; Fontification and Faces ----------------------------------------------
1728 (defgroup reftex-fontification-configurations nil
1729 "Options concerning the faces used in RefTeX."
1730 :link
'(custom-group-link :tag
"Font Lock Faces group" font-lock-faces
)
1733 (defcustom reftex-use-fonts t
1734 "Non-nil means, use fonts in *toc* and selection buffers.
1735 Font-lock must be loaded as well to actually get fontified display.
1736 When changing this option, a rescan may be necessary to activate the change."
1737 :group
'reftex-fontification-configurations
1740 (defcustom reftex-refontify-context
1
1741 "Non-nil means, re-fontify the context in the label menu with font-lock.
1742 This slightly slows down the creation of the label menu. It is only necessary
1743 when you definitely want the context fontified.
1745 This option may have 3 different values:
1746 nil Never refontify.
1748 1 Refontify when absolutely necessary, e.g. when old versions of X-Symbol.
1749 The option is ignored when `reftex-use-fonts' is nil."
1750 :group
'reftex-fontification-configurations
1751 :group
'reftex-referencing-labels
1753 (const :tag
"Never" nil
)
1754 (const :tag
"Always" t
)
1755 (const :tag
"When necessary" 1)))
1757 (defcustom reftex-highlight-selection
'cursor
1758 "Non-nil mean, highlight selected text in selection and *toc* buffers.
1759 Normally, the text near the cursor is the selected text, and it is
1760 highlighted. This is the entry most keys in the selection and *toc*
1761 buffers act on. However, if you mainly use the mouse to select an
1762 item, you may find it nice to have mouse-triggered highlighting
1763 instead or as well. The variable may have one of these values:
1765 nil No highlighting.
1766 cursor Highlighting is cursor driven.
1767 mouse Highlighting is mouse driven.
1768 both Both cursor and mouse trigger highlighting.
1770 Changing this variable requires to rebuild the selection and *toc* buffers
1771 to become effective (keys `g' or `r')."
1772 :group
'reftex-fontification-configurations
1774 (const :tag
"Never" nil
)
1775 (const :tag
"Cursor driven" cursor
)
1776 (const :tag
"Mouse driven" mouse
)
1777 (const :tag
"Mouse and Cursor driven." both
)))
1779 (defcustom reftex-cursor-selected-face
'highlight
1780 "Face name to highlight cursor selected item in toc and selection buffers.
1781 See also the variable `reftex-highlight-selection'."
1782 :group
'reftex-fontification-configurations
1784 (defcustom reftex-mouse-selected-face
'secondary-selection
1785 "Face name to highlight mouse selected item in toc and selection buffers.
1786 See also the variable `reftex-highlight-selection'."
1787 :group
'reftex-fontification-configurations
1789 (defcustom reftex-file-boundary-face
'font-lock-comment-face
1790 "Face name for file boundaries in selection buffer."
1791 :group
'reftex-fontification-configurations
1793 (defcustom reftex-label-face
'font-lock-constant-face
1794 "Face name for labels in selection buffer."
1795 :group
'reftex-fontification-configurations
1797 (defcustom reftex-section-heading-face
'font-lock-function-name-face
1798 "Face name for section headings in toc and selection buffers."
1799 :group
'reftex-fontification-configurations
1801 (defcustom reftex-toc-header-face
'font-lock-comment-face
1802 "Face name for the header of a toc buffer."
1803 :group
'reftex-fontification-configurations
1805 (defcustom reftex-bib-author-face
'font-lock-keyword-face
1806 "Face name for author names in bib selection buffer."
1807 :group
'reftex-fontification-configurations
1809 (defcustom reftex-bib-year-face
'font-lock-comment-face
1810 "Face name for year in bib selection buffer."
1811 :group
'reftex-fontification-configurations
1813 (defcustom reftex-bib-title-face
'font-lock-function-name-face
1814 "Face name for article title in bib selection buffer."
1815 :group
'reftex-fontification-configurations
1817 (defcustom reftex-bib-extra-face
'font-lock-comment-face
1818 "Face name for bibliographic information in bib selection buffer."
1819 :group
'reftex-fontification-configurations
1821 (defcustom reftex-select-mark-face
'bold
1822 "Face name for marked entries in the selection buffers."
1823 :group
'reftex-fontification-configurations
1825 (defcustom reftex-index-header-face
'font-lock-comment-face
1826 "Face name for the header of an index buffer."
1827 :group
'reftex-fontification-configurations
1829 (defcustom reftex-index-section-face
'font-lock-function-name-face
1830 "Face name for the start of a new letter section in the index."
1831 :group
'reftex-fontification-configurations
1833 (defcustom reftex-index-tag-face
'font-lock-keyword-face
1834 "Face name for index names (for multiple indices)."
1835 :group
'reftex-fontification-configurations
1837 (defcustom reftex-index-face
'font-lock-constant-face
1838 "Face name for index entries."
1839 :group
'reftex-fontification-configurations
1842 (defcustom reftex-pre-refontification-functions nil
1843 "X-Symbol specific hook.
1844 Functions get two arguments, the buffer from where the command started and a
1845 symbol indicating in what context the hook is called."
1846 :group
'reftex-fontification-configurations
1849 ;; Miscellaneous configurations -----------------------------------------
1851 (defgroup reftex-miscellaneous-configurations nil
1852 "Collection of further configurations."
1855 (defcustom reftex-extra-bindings nil
1856 "Non-nil means, make additional key bindings on startup.
1857 These extra bindings are located in the
1858 `reftex-extra-bindings-map' map, bound to
1859 `reftex-extra-bindings-prefix'."
1860 :group
'reftex-miscellaneous-configurations
1863 ;; below, default is C-c C-y because it is free in LaTeX mode.
1864 (defcustom reftex-extra-bindings-prefix
"\C-c\C-y"
1865 "When `reftex-extra-bindings' is set to non-nil, use extra
1866 bindings with this prefix bound to `reftex-extra-bindings-map'."
1867 :group
'reftex-miscellaneous-configurations
1870 (defcustom reftex-plug-into-AUCTeX nil
1871 "Plug-in flags for AUCTeX interface.
1872 This variable is a list of 4 boolean flags. When a flag is non-nil,
1875 - supply labels in new sections and environments (flag 1)
1876 - supply arguments for macros like `\\label'. (flag 2)
1877 - supply arguments for macros like `\\ref'. (flag 3)
1878 - supply arguments for macros like `\\cite'. (flag 4)
1879 - supply arguments for macros like `\\index'. (flag 5)
1881 You may also set the variable itself to t or nil in order to turn all
1882 plug-ins on or off, respectively.
1883 \\<LaTeX-mode-map>Supplying labels in new sections and environments applies when creating
1884 sections with \\[LaTeX-section] and environments with \\[LaTeX-environment].
1885 Supplying macro arguments applies when you insert such a macro interactively
1886 with \\[TeX-insert-macro].
1887 See the AUCTeX documentation for more information.
1888 RefTeX uses `fset' to take over the function calls. Changing the variable
1889 may require a restart of Emacs in order to become effective."
1890 :group
'reftex-miscellaneous-configurations
1893 (const :tag
"No plug-ins" nil
)
1894 (const :tag
"All possible plug-ins" t
)
1896 :tag
"Individual choice"
1898 (boolean :tag
"supply label in new sections and environments")
1899 (boolean :tag
"supply argument for macros like `\\label' ")
1900 (boolean :tag
"supply argument for macros like `\\ref' ")
1901 (boolean :tag
"supply argument for macros like `\\cite' ")
1902 (boolean :tag
"supply argument for macros like `\\index' ")
1905 (defcustom reftex-allow-detached-macro-args nil
1906 "Non-nil means, allow arguments of macros to be detached by whitespace.
1907 When this is t, `aaa' will be considered as argument of \\bb in the following
1908 construct: \\bbb [xxx] {aaa}."
1909 :group
'reftex-miscellaneous-configurations
1913 (defcustom reftex-load-hook nil
1914 "Hook which is being run when loading reftex.el."
1915 :group
'reftex-miscellaneous-configurations
1918 (defcustom reftex-mode-hook nil
1919 "Hook which is being run when turning on RefTeX mode."
1920 :group
'reftex-miscellaneous-configurations
1924 (provide 'reftex-vars
)
1926 ;;; reftex-vars.el ends here
HCoop / bpt / emacs.git / blob