| blob | 7f050e9fd906157bbf8152cfd35f10b997563b0b |
1 ;;; reftex-vars.el --- configuration variables for RefTeX
3 ;; Copyright (C) 1997-1999, 2001-2015 Free Software Foundation, Inc.
5 ;; Author: Carsten Dominik <dominik@science.uva.nl>
6 ;; Maintainer: auctex-devel@gnu.org
8 ;; This file is part of GNU Emacs.
10 ;; GNU Emacs is free software: you can redistribute it and/or modify
11 ;; it under the terms of the GNU General Public License as published by
12 ;; the Free Software Foundation, either version 3 of the License, or
13 ;; (at your option) any later version.
15 ;; GNU Emacs is distributed in the hope that it will be useful,
16 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
17 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
18 ;; GNU General Public License for more details.
20 ;; You should have received a copy of the GNU General Public License
21 ;; along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>.
23 ;;; Commentary:
25 ;;; Code:
33 ;; Define the two constants which are needed during compilation
37 '(
38 ;; Some aliases, mostly for backward compatibility
42 amsmath))
44 ;; Individual package defaults
100 ;; The LaTeX core stuff
128 ;; The label macro is hard coded, but it *could* be defined like this:
129 ;;("\\label{*}" nil nil nil nil)
130 ))
132 ;; Texinfo
134 "The default label environment descriptions.
135 Lower-case symbols correspond to a style file of the same name in the LaTeX
212 "ConTeXt bib module"
216 )
217 "Builtin versions of the citation format.
218 The following conventions are valid for all alist entries:
220 `?t' should point to a textual citation (citation as a noun).
237 "Builtin stuff for `reftex-index-macros'.
238 Lower-case symbols correspond to a style file of the same name in the LaTeX
240 )
242 ;; Configuration Variables and User Options for RefTeX ------------------
245 "LaTeX label and citation support."
255 ;; Table of contents configuration --------------------------------------
258 "A multifile table of contents browser."
262 "LaTeX commands which input another file.
263 The file name is expected after the command, either in braces or separated
264 by whitespace."
270 "Maximum depth of section levels in document structure.
271 The default in standard LaTeX is 7, but there are packages for
272 which this needs to be larger."
276 ;; LaTeX section commands and level numbers
278 '(
288 ;;; ("minisec" . -7) ; KOMA-Script
289 )
290 "Commands and levels used for defining sections in the document.
291 This is an alist with each element like (COMMAND-NAME . LEVEL).
292 The car of each cons cell is the name of the section macro (without
293 the backslash). The cdr is a number indicating its level. A negative
294 level means the same level as the positive value, but the section will
295 never get a number. The cdr may also be a function which will be called
296 to after the section-re matched to determine the level.
297 This list is also used for promotion and demotion of sectioning commands.
298 If you are using a document class which has several sets of sectioning
299 commands, promotion only works correctly if this list is sorted first
300 by set, then within each set by level. The promotion commands always
301 select the nearest entry with the correct new level."
311 "The maximum level of toc entries which will be included in the TOC.
312 Section headings with a bigger level will be ignored. In RefTeX, chapters
313 are level 1, sections are level 2 etc.
314 This variable can be changed from within the *toc* buffer with the `t' key."
320 This means, part numbers will be included in the numbering of chapters, and
321 chapter counters will be reset for each part.
322 When nil (the default), parts are special, do not reset the chapter counter
323 and also do not show up in chapter numbers."
329 "Non-nil means, turn automatic recentering of *TOC* window on.
330 When active, the *TOC* window will always show the section you
331 are currently working in. Recentering happens whenever Emacs is idle for
332 more than `reftex-idle-time' seconds.
334 Value t means, turn on immediately when RefTeX gets started. Then,
335 recentering will work for any TOC window created during the session.
337 Value 'frame (the default) means, turn automatic recentering on only while the
338 dedicated TOC frame does exist, and do the recentering only in that frame. So
339 when creating that frame (with `d' key in an ordinary TOC window), the
340 automatic recentering is turned on. When the frame gets destroyed, automatic
341 recentering is turned off again.
343 This feature can be turned on and off from the menu
344 \(Ref->Options)."
352 "Non-nil means, create TOC window by splitting window horizontally."
357 "Fraction of the width or height of the frame to be used for TOC window.
358 See also `reftex-toc-split-windows-horizontally'."
366 "Non-nil means, split the selected window to display the *toc* buffer.
367 This helps to keep the window configuration, but makes the *toc* small.
368 When nil, all other windows except the selected one will be deleted, so
369 that the *toc* window fills half the frame."
374 "Non-nil means, include file boundaries in *toc* buffer.
375 This flag can be toggled from within the *toc* buffer with the `F' key."
380 "Non-nil means, include labels in *toc* buffer.
381 This flag can be toggled from within the *toc* buffer with the `l' key."
386 "Non-nil means, include index entries in *toc* buffer.
387 This flag can be toggled from within the *toc* buffer with the `i' key."
392 "Non-nil means, promotion/demotion commands first prompt for confirmation.
393 If nil, the command is executed immediately. If this is an integer N,
394 ask for confirmation only if N or more section commands are going to be
395 changed."
403 "Non-nil means, include context with labels in the *toc* buffer.
404 Context will only be shown when labels are visible as well.
405 This flag can be toggled from within the *toc* buffer with the `c' key."
410 "Non-nil means, point in *toc* buffer will cause other window to follow.
411 The other window will show the corresponding part of the document.
412 This flag can be toggled from within the *toc* buffer with the `f' key."
417 "Non-nil means, follow-mode will revisit files if necessary.
418 If nil, follow-mode will be suspended for stuff in unvisited files."
424 "Mode hook for `reftex-toc-mode'."
428 ;; Label Support Configuration
431 "Support for creation, insertion and referencing of labels in LaTeX."
435 "Definition of environments and macros to do with label."
440 rotating sidecap subfigure supertab wrapfig
441 listings minted ctable LaTeX)
442 "Default label alist specifications. LaTeX should always be the last entry.
443 The value of this variable is a list of symbols with associations in the
444 constant `reftex-label-alist-builtin'. Check that constant for a full list
445 of options."
450 :inline t
451 :greedy t
457 reftex-label-alist-builtin)))
462 This doc string is easier to understand after reading the configuration
463 examples in the manual. Looking at the builtin defaults in the constant
464 `reftex-label-alist-builtin' may also be instructive.
466 Set this variable to define additions and changes to the default. The only
467 things you MUST NOT change is that `?s' is the type indicator for section
468 labels, and SPC for the `any' label type. These are hard-coded at other
469 places in the code.
471 The value of the variable must be a list of items. Each item is a list
472 itself and has the following structure:
474 (ENV-OR-MACRO TYPE-KEY LABEL-PREFIX REFERENCE-FORMAT CONTEXT-METHOD
475 (MAGIC-WORD ... ) TOC-LEVEL)
477 Each list entry describes either an environment carrying a counter for use
479 one of its arguments. The elements of each list entry are:
481 ENV-OR-MACRO
483 For macros, indicate the macro arguments for best results, as in
485 a star to mark the label argument, if any. The macro does not have to
487 its arguments.
488 Special names: `section' for section labels, `any' to define a group
489 which contains all labels.
491 This may also be a function to do local parsing and identify point to
492 be in a non-standard label environment. The function must take an
493 argument BOUND and limit backward searches to this value. It should
494 return either nil or the position where the special environment starts.
495 See the Info documentation for an example.
497 Finally this may also be nil if the entry is only meant to change
498 some settings associated with the type indicator character (see below).
500 TYPE-KEY
501 Type indicator character, like `?t', must be a printable ASCII character.
502 The type indicator is a single character which defines a label type.
503 Any label inside the environment or macro is assumed to belong to this
504 type. The same character may occur several times in this list, to cover
505 cases in which different environments carry the same label type (like
506 `equation' and `eqnarray').
507 If the type indicator is nil and the macro has a label argument {*},
509 the remainder of this entry is ignored.
511 LABEL-PREFIX
513 The prefix is a short string used as the start of a label. It may be the
514 empty string. The prefix may contain the following `%' escapes:
515 %f Current file name with directory and extension stripped.
516 %F Current file name relative to directory of master file.
517 %m Master file name, directory and extension stripped.
518 %M Directory name (without path) where master file is located.
519 %u User login name, on systems which support this.
520 %S A section prefix derived with variable `reftex-section-prefixes'.
524 REFERENCE-FORMAT
525 Format string for reference insertion in buffer. `%s' will be replaced
526 by the label.
527 When the format starts with `~', the `~' will only be inserted if
528 there is not already a whitespace before point.
530 CONTEXT-METHOD
531 Indication on how to find the short context.
533 - If t, use
534 - the section heading for section labels.
536 (not a good choice for environments like eqnarray or enumerate,
537 where one has several labels in a single environment).
538 - text after the macro name (starting with the first arg) for macros.
539 - If an integer, use the nth argument of the macro. As a special case,
540 1000 means to get text after the last macro argument.
541 - If a string, use as regexp to search *backward* from the label. Context
542 is then the text following the end of the match. E.g. setting this to
544 environment.
546 - If any of `caption', `item', `eqnarray-like', `alignat-like', this
547 symbol will internally be translated into an appropriate regexp
548 (see also the variable `reftex-default-context-regexps').
549 - If a function, call this function with the name of the environment/macro
551 function is expected to return a suitable context string. It should
552 throw an exception (error) when failing to find context.
553 As an example, here is a function returning the 10 chars following
554 the label macro as context:
556 (defun my-context-function (env-or-mac)
557 (if (> (point-max) (+ 10 (point)))
558 (buffer-substring (point) (+ 10 (point)))
561 Label context is used in two ways by RefTeX: For display in the label
562 menu, and to derive a label string. If you want to use a different
563 method for each of these, specify them as a dotted pair.
564 E.g. `(nil . t)' uses the text after the label (nil) for display, and
565 text from the default position (t) to derive a label string. This is
566 actually used for section labels.
568 MAGIC-WORDS
569 List of magic words which identify a reference to be of this type.
570 If the word before point is equal to one of these words when calling
571 `reftex-reference', the label list offered will be automatically
572 restricted to labels of the correct type.
573 If the first element of this wordlist is the symbol `regexp', the
574 strings are interpreted as regular expressions. RefTeX will add
577 TOC-LEVEL
578 The integer level at which this environment should be added to the
579 table of contents. See also `reftex-section-levels'. A positive
580 value will number the entries mixed with the sectioning commands of
581 the same level. A negative value will make unnumbered entries.
582 Useful only for theorem-like environments, will be ignored for macros.
583 When omitted or nil, no TOC entries will be made.
585 If the type indicator characters of two or more entries are the same, RefTeX
586 will use
587 - the first non-nil format and prefix
588 - the magic words of all involved entries.
590 Any list entry may also be a symbol. If that has an association in
591 `reftex-label-alist-builtin', the cddr of that association is spliced into the
592 list. However, builtin defaults should normally be set with the variable
593 `reftex-default-label-alist-entries'."
596 :type
631 :value AMSTeX
636 reftex-label-alist-builtin)))))
639 "Prefixes for section labels.
640 When the label prefix given in an entry in `reftex-label-alist' contains `%S',
641 this list is used to determine the correct prefix string depending on the
642 current section level.
643 The list is an alist, with each entry of the form (KEY . PREFIX)
644 Possible keys are sectioning macro names like `chapter', section levels
645 \(as given in `reftex-section-levels'), and t for the default."
660 "Alist with default regular expressions for finding context.
661 The form (format regexp (regexp-quote environment)) is used to calculate
662 the final regular expression - so %s will be replaced with the environment
663 or macro."
668 "Non-nil means, trust the label prefix when determining label type.
669 It is customary to use special label prefixes to distinguish different label
670 types. The label prefixes have no syntactic meaning in LaTeX (unless
671 special packages like fancyref are being used). RefTeX can and by
672 default does parse around each label to detect the correct label type,
673 but this process can be slow when a document contains thousands of
674 labels. If you use label prefixes consistently, you may speed up
675 document parsing by setting this variable to a non-nil value. RefTeX
676 will then compare the label prefix with the prefixes found in
677 `reftex-label-alist' and derive the correct label type in this way.
678 Possible values for this option are:
680 t This means to trust any label prefixes found.
681 regexp If a regexp, only prefixes matched by the regexp are trusted.
682 list List of accepted prefixes, as strings. The colon is part of
684 nil Never trust a label prefix.
686 The only disadvantage of using this feature is that the label context
687 displayed in the label selection buffer along with each label is
688 simply some text after the label definition. This is no problem if you
689 place labels keeping this in mind (e.g. *before* the equation, *at
690 the beginning* of a fig/tab caption ...). Anyway, it is probably best
691 to use the regexp or the list value types to fine-tune this feature.
692 For example, if your document contains thousands of footnotes with
695 non-footnote labels."
705 "List of functions to be called when trying to figure out current environment.
708 use such non-standard ways to set up environment-like constructs. The
709 purpose of each function in this list is to detect if point is
711 carries a label, you must also set up an entry for it in
712 `reftex-label-alist'.
714 The function should check if point is currently in the special
715 environment it was written to detect. If so, the function must return
716 a cons cell (NAME . POSITION). NAME is the name of the environment
717 detected and POSITION is the buffer position where the environment
718 starts. The function must return nil on failure to detect the
719 environment.
721 The function must take an argument BOUND. If non-nil, BOUND is a
722 boundary for backwards searches which should be observed.
724 Here is an example. The LaTeX package linguex.sty defines list macros
726 line.
732 ... more text after the empty line terminating all lists
734 And here is the setup for RefTeX:
736 1. Define a dummy environment for this in `reftex-label-alist'. Dummy means,
740 (setq reftex-label-alist
743 2. Write a function to detect the list macros and the determinators as well.
745 (defun my-detect-linguex-list (bound)
746 (let ((pos (point)) p1)
747 (save-excursion
748 ;; Search for any of the linguex item macros at the beginning of a line
749 (if (re-search-backward
751 (progn
752 (setq p1 (match-beginning 1))
755 ;; Return nil because list was already closed
756 nil
757 ;; OK, we got it
759 ;; Return nil for not found
760 nil))))
762 3. Tell RefTeX to use this function
764 (setq reftex-special-environment-functions '(my-detect-linguex-list))"
768 ;; Label insertion
771 "Options on how to create new labels."
775 "Flags governing label insertion. First flag DERIVE, second flag PROMPT.
777 If DERIVE is t, RefTeX will try to derive a sensible label from context.
778 A section label for example will be derived from the section heading.
779 The conversion of the context to a valid label is governed by the
780 specifications given in `reftex-derive-label-parameters'.
781 If RefTeX fails to derive a label, it will prompt the user.
782 If DERIVE is nil, the label generated will consist of the prefix and a
783 unique number, like `eq:23'.
785 If PROMPT is t, the user will be prompted for a label string. The prompt will
786 already contain the prefix, and (if DERIVE is t) a default label derived from
787 context. When PROMPT is nil, the default label will be inserted without
788 query.
790 So the combination of DERIVE and PROMPT controls label insertion. Here is a
791 table describing all four possibilities:
793 DERIVE PROMPT ACTION
794 -------------------------------------------------------------------------
795 nil nil Insert simple label, like eq:22 or sec:13. No query.
796 nil t Prompt for label.
797 t nil Derive a label from context and insert without query.
798 t t Derive a label from context and prompt for confirmation.
800 Each flag may be set to t, nil, or a string of label type letters
801 indicating the label types for which it should be true. The strings work
802 like character classes.
803 Thus, the combination may be set differently for each label type. The
805 \(with confirmation). Prompt for figure and table labels. Use simple labels
806 without confirmation for everything else.
807 The available label types are: s (section), f (figure), t (table), i (item),
808 e (equation), n (footnote), N (endnote), plus any definitions in
809 `reftex-label-alist'."
822 "Function to turn an arbitrary string into a valid label.
823 RefTeX's default function uses the variable `reftex-derive-label-parameters'."
828 "Filter function to convert a string to ASCII.
829 The function is used to process a context string before it is
830 used to derive a label from it. The intended application is to
831 convert ISO or Mule characters into something valid in labels.
832 The default function removes the accents from Latin-1 characters.
833 X-Symbol (>=2.6) sets this variable to the much more general
834 `x-symbol-translate-to-ascii'."
840 "Parameters for converting a string into a label.
841 This variable is a list of the following items.
843 NWORDS Number of words to use.
844 MAXCHAR Maximum number of characters in a label string.
845 INVALID nil: Throw away any words containing characters invalid in labels.
846 t: Throw away only the invalid characters, not the whole word.
847 ABBREV nil: Never abbreviate words.
848 t: Always abbreviate words (see `reftex-abbrev-parameters').
849 not t and not nil: Abbreviate words if necessary to shorten
850 label string below MAXCHAR.
851 SEPARATOR String separating different words in the label.
852 IGNOREWORDS List of words which should not be part of labels.
853 DOWNCASE t: Downcase words before using them."
871 ;; XEmacs 21.5 doesn't have explicitly numbered matching groups,
872 ;; so this list mustn't get any more items.
877 ;; keyvals [..., label = {foo}, ...] forms used by ctable,
878 ;; listings, minted, ...
882 keyval style [..., label = {...}, ...] label definitions. It is
883 assumed that the regexp group 1 matches the label text, so you
886 When changed from Lisp, make sure to call
887 `reftex-compile-variables' afterwards to make the change
888 effective."
898 "List of macros and environments to be ignored when searching for labels.
899 The purpose is to ignore environments and macros that use keyval
900 style label=foo arguments, but the label has a different meaning
902 ignored.
904 E.g., TikZ defines several macros/environments where [label=foo]
905 defines the label to be printed at some node or edge, but it's
906 not a label used for referencing.
908 Note that this feature is only supported if you are using AUCTeX
909 and the functions `TeX-current-macro' and
910 `LaTeX-current-environment' are bound. Also note that this
911 feature might slow down the reftex parsing process for large TeX
912 files."
918 "Regexp matching characters not valid in labels."
923 "Parameters for abbreviation of words.
924 This variable is a list of the following items.
926 MIN-CHARS Minimum number of characters remaining after abbreviation.
927 MIN-KILL Minimum number of characters to remove when abbreviating words.
928 BEFORE Character class before abbrev point in word.
929 AFTER Character class after abbrev point in word."
938 "Function which produces the string to insert as a label definition.
939 Normally should be nil, unless you want to do something fancy.
940 The function will be called with two arguments, the LABEL and the DEFAULT
942 string to insert into the buffer."
946 ;; Label referencing
949 "Options on how to reference labels."
959 "List of flags governing the label menu makeup.
960 The flags are:
962 TABLE-OF-CONTENTS Show the labels embedded in a table of context.
963 SECTION-NUMBERS Include section numbers (like 4.1.3) in table of contents.
964 COUNTERS Show counters. This just numbers the labels in the menu.
965 NO-CONTEXT Non-nil means do NOT show the short context.
966 FOLLOW Follow full context in other window.
967 SHOW-COMMENTED Show labels from regions which are commented out.
968 MATCH-IN-TOC Obsolete flag.
969 SHOW FILES Show begin and end of included files.
971 Each of these flags can be set to t or nil, or to a string of type letters
972 indicating the label types for which it should be true. These strings work
973 like character classes in regular expressions. Thus, setting one of the
976 The available label types are: s (section), f (figure), t (table), i (item),
977 e (equation), n (footnote), plus any definitions in `reftex-label-alist'.
979 Most options can also be switched from the label menu itself - so if you
980 decide here to not have a table of contents in the label menu, you can still
981 get one interactively during selection from the label menu."
983 :type
995 "Punctuation strings for multiple references.
996 When marking is used in the selection buffer to select several references,
997 this variable associates the 3 marking characters `,-+' with prefix strings
999 This is used to string together whole reference sets, like
1000 `eqs. 1,2,3-5,6 and 7' in a single call to `reftex-reference'. See manual."
1015 "Alist of reference styles.
1016 Each element is a list of the style name, the name of the LaTeX
1017 package associated with the style or t for any package, and an
1018 alist of macros where the first entry of each item is the
1019 reference macro and the second a key for selecting the macro when
1020 the macro type is being prompted for. (See also
1021 `reftex-ref-macro-prompt'.) The keys, represented as characters,
1022 have to be unique."
1034 "If non-nil, `reftex-reference' prompts for the reference macro."
1040 "Non-nil means, the varioref reference style is used as default.
1041 The value of this variable determines the default which is active
1042 when entering the selection process. Instead of nil or t, this
1043 may also be a string of type letters indicating the label types
1044 for which it should be true.
1046 This variable is obsolete, use `reftex-ref-style-default-list'
1047 instead."
1050 ;;;###autoload(put 'reftex-vref-is-default 'safe-local-variable (lambda (x) (or (stringp x) (symbolp x))))
1053 "Non-nil means, the fancyref reference style is used as default.
1054 The value of this variable determines the default which is active
1055 when entering the selection process. Instead of nil or t, this
1056 may also be a string of type letters indicating the label types
1057 for which it should be true.
1059 This variable is obsolete, use `reftex-ref-style-default-list'
1060 instead."
1063 ;;;###autoload(put 'reftex-fref-is-default 'safe-local-variable (lambda (x) (or (stringp x) (symbolp x))))
1066 "List of reference styles to be activated by default.
1067 The order is significant and controls the order in which macros
1068 can be cycled in the buffer for selecting a label. The entries
1069 in the list have to match the respective reference style names
1070 used in the variable `reftex-ref-style-alist'."
1074 reftex-ref-style-alist)))
1076 ;; Compatibility with obsolete variables.
1083 "Number of spaces to be used for indentation per section level."
1086 ;;;###autoload(put 'reftex-level-indent 'safe-local-variable 'integerp)
1089 "Non-nil means, `reftex-reference' will try to guess the label type.
1090 To do that, RefTeX will look at the word before the cursor and compare it with
1091 the words given in `reftex-label-alist'. When it finds a match, RefTeX will
1092 immediately offer the correct label menu - otherwise it will prompt you for
1093 a label type. If you set this variable to nil, RefTeX will always prompt."
1096 ;;;###autoload(put 'reftex-guess-label-type 'safe-local-variable (lambda (x) (memq x '(nil t))))
1099 "Function which produces the string to insert as a reference.
1100 Normally should be nil, because the format to insert a reference
1101 can already be specified in `reftex-label-alist'.
1103 This hook also is used by the special commands to insert
1105 your setting will be ignored by the special commands.
1107 The function will be called with three arguments, the LABEL, the
1109 STYLE. The function should return the string to insert into the
1110 buffer."
1115 "Mode hook for `reftex-select-label-mode'."
1119 ;; BibteX citation configuration ----------------------------------------
1122 "Support for referencing bibliographic data with BibTeX."
1127 "LaTeX commands which specify the BibTeX databases to use with the document."
1135 File names matched by these regexps will not be parsed by RefTeX.
1136 Intended for files which contain only `@string' macro definitions and the
1137 like, which are ignored by RefTeX anyway."
1143 "List of BibTeX database files which should be used if none are specified.
1144 When `reftex-citation' is called from a document which has neither a
1146 RefTeX will scan these files instead. Intended for using `reftex-citation'
1147 in non-LaTeX files. The files will be searched along the BIBINPUTS or TEXBIB
1148 path."
1153 "Sorting of the entries found in BibTeX databases by reftex-citation.
1154 Possible values:
1155 nil Do not sort entries.
1156 'author Sort entries by author name.
1157 'year Sort entries by increasing year.
1158 'reverse-year Sort entries by decreasing year."
1166 "The format of citations to be inserted into the buffer.
1167 It can be a string or an alist or a symbol. In the simplest case this
1169 definition of `reftex-cite-format-builtin' for more complex examples.
1171 If `reftex-cite-format' is a string, it will be used as the format.
1172 In the format, the following percent escapes will be expanded.
1174 %l The BibTeX label of the citation.
1175 %a List of author names, see also `reftex-cite-punctuation'.
1176 %2a Like %a, but abbreviate more than 2 authors like Jones et al.
1177 %A First author name only.
1178 %e Works like %a, but on list of editor names. (%2e and %E work a well)
1180 It is also possible to access all other BibTeX database fields:
1181 %b booktitle %c chapter %d edition %h howpublished
1182 %i institution %j journal %k key %m month
1183 %n number %N note %o organization %p pages
1184 %P first page %r address %s school %u publisher
1185 %U url %t title %v volume %y year
1186 %B booktitle, abbreviated %T title, abbreviated
1188 Usually, only %l is needed. The other stuff is mainly for the echo area
1189 display, and for (setq reftex-comment-citations t).
1191 %< as a special operator kills punctuation and space around it after the
1192 string has been formatted.
1194 A pair of square brackets indicates an optional argument, and RefTeX
1195 will prompt for the values of these arguments.
1197 Beware that all this only works with BibTeX database files. When
1199 environment, only %l is available.
1201 If `reftex-cite-format' is an alist of characters and strings, the user
1202 will be prompted for a character to select one of the possible format
1203 strings.
1204 In order to configure this variable, you can either set
1205 `reftex-cite-format' directly yourself or set it to the SYMBOL of one of
1206 the predefined styles. The predefined symbols are those which have an
1207 association in the constant `reftex-cite-format-builtin'.
1208 E.g.: (setq reftex-cite-format 'natbib)"
1210 :type
1215 :value default
1221 reftex-cite-format-builtin))
1230 "Non-nil means, prompt for empty optional arguments in cite macros.
1231 When an entry in `reftex-cite-format' is given with square brackets to
1233 prompt for values. Possible values are:
1235 nil Never prompt for optional arguments
1236 t Always prompt
1237 maybe Prompt only if `reftex-citation' was called with C-u prefix arg
1239 Unnecessary empty optional arguments are removed before insertion into
1240 the buffer. See `reftex-cite-cleanup-optional-args'."
1248 "Non-nil means, remove unnecessary empty optional arguments in cite macros.
1249 The cite macros provided by some packages (for example
1250 natbib) allow specifying two optional arguments, one for a prefix to
1251 the citation, and a second for a postfix. When only one optional
1252 argument is given, it is interpreted as postfix. When this option is
1253 t, RefTeX removes unnecessary empty optional arguments from the cite
1254 macro before insertion. For example, it will change
1259 Is is possible that other packages have other conventions about which
1260 optional argument is interpreted how - that is why this cleaning up
1261 can be turned off."
1266 "Non-nil means add a comment for each citation describing the full entry.
1267 The comment is formatted according to `reftex-cite-comment-format'."
1273 "Citation format used for commented citations. Must NOT contain %l.
1274 See the variable `reftex-cite-format' for possible percent escapes."
1279 "Citation format used to display citation info in the message area.
1280 Must NOT contain %l. See the variable `reftex-cite-format' for
1281 possible percent escapes."
1287 "Punctuation for formatting of name lists in citations.
1288 This is a list of 3 strings.
1299 "Function which produces the string to insert as a citation.
1300 Normally should be nil, because the format to insert a reference can
1301 already be specified in `reftex-cite-format'.
1302 The function will be called with two arguments, the CITATION KEY and the
1303 DEFAULT FORMAT, which is taken from `reftex-cite-format'. The function
1304 should return the string to insert into the buffer."
1309 "Mode hook for reftex-select-bib-mode."
1320 "Header to insert in BibTeX files generated by RefTeX."
1326 "Footer to insert in BibTeX files generated by RefTeX."
1331 ;; Index Support Configuration
1334 "Support for viewing and editing the index."
1338 "Non-nil means, index entries are parsed as well.
1339 Index support is resource intensive and the internal structure holding the
1340 parsed information can become quite big. Therefore it can be turned off.
1341 When this is nil and you execute a command which requires index support,
1342 you will be asked for confirmation to turn it on and rescan the document."
1347 "Special characters in index entries. The value is a list of five strings.
1348 These correspond to the makeindex keywords LEVEL ENCAP ACTUAL QUOTE ESCAPE."
1358 "Macros which define index entries.
1360 The structure is
1362 \(MACRO INDEX-TAG KEY PREFIX EXCLUDE REPEAT)
1364 MACRO is the macro. Arguments should be denoted by empty braces like
1366 marks where the index key is.
1369 reserved for the default index and the glossary. Other indices can be
1370 defined as well. If this is an integer, the Nth argument of the macro
1371 holds the index tag.
1373 KEY is a character which is used to identify the macro for input with
1376 PREFIX can be a prefix which is added to the KEY part of the index entry.
1380 EXCLUDE can be a function. If this function exists and returns a non-nil
1381 value, the index entry at point is ignored. This was implemented to support
1382 the (deprecated) `^' and `_' shortcuts in the LaTeX2e `index' package.
1384 REPEAT, if non-nil, means the index macro does not typeset the entry in
1385 the text, so that the text has to be repeated outside the index macro.
1386 Needed for `reftex-index-selection-or-word' and for indexing from the
1387 phrase buffer.
1389 The final entry may also be a symbol if this entry has a association
1390 in the variable `reftex-index-macros-builtin' to specify the main
1391 indexing package you are using. Valid values are currently
1392 default The LaTeX default - unnecessary to specify this one
1393 multind The multind.sty package
1394 index The index.sty package
1395 index-shortcut The index.sty packages with the ^ and _ shortcuts.
1396 Should not be used - only for old documents.
1397 Note that AUCTeX sets these things internally for RefTeX as well, so
1398 with a sufficiently new version of AUCTeX, you should not set the
1399 package here."
1404 :inline t
1417 :value index
1423 reftex-index-macros-builtin)))))
1427 This is a list with (MACRO-KEY DEFAULT-TAG).
1429 MACRO-KEY: Character identifying an index macro - see `reftex-index-macros'.
1430 DEFAULT-TAG: This is the tag to be used if the macro requires a TAG argument.
1431 When this is nil and a TAG is needed, RefTeX will ask for it.
1432 When this is the empty string and the TAG argument of the index
1433 macro is optional, the TAG argument will be omitted."
1442 "Default index tag.
1443 When working with multiple indexes, RefTeX queries for an index tag when
1444 creating index entries or displaying a specific index. This variable controls
1445 the default offered for these queries. The default can be selected with RET
1446 during selection or completion. Valid values of this variable are:
1448 nil Do not provide a default index
1450 last The last used index tag will be offered as default."
1458 "Format of index entries when copied from inside math mode.
1459 When `reftex-index-selection-or-word' is executed inside TeX math mode,
1460 the index key copied from the buffer is processed with this format string
1461 through the `format' function. This can be used to add the math delimiters
1462 \(e.g. `$') to the string.
1463 Requires the `texmathp.el' library which is part of AUCTeX."
1468 "File extension for the index phrase file.
1469 This extension will be added to the base name of the master file."
1474 "Regexp matching the `and' operator for index arguments in phrases file.
1475 When several index arguments in a phrase line are separated by this
1476 operator, each part will generate an index macro. So each match of
1477 the search phrase will produce *several* different index entries.
1479 Note: make sure this does no match things which are not separators.
1480 This logical `and' has higher priority than the logical `or' specified in
1481 `reftex-index-phrases-logical-or-regexp'."
1486 "Regexp matching the `or' operator for index arguments in phrases file.
1487 When several index arguments in a phrase line are separated by this
1488 operator, the user will be asked to select one of them at each match
1489 of the search phrase. The first index arg will be the default - a
1490 number key 1-9 must be pressed to switch to another.
1492 Note: make sure this does no match things which are not separators.
1493 The logical `and' specified in `reftex-index-phrases-logical-or-regexp'
1494 has higher priority than this logical `or'."
1499 "Non-nil means phrases search will look for whole words, not subwords.
1500 This works by requiring word boundaries at the beginning and end of
1501 the search string. When the search phrase already has a non-word-char
1502 at one of these points, no word boundary is required there."
1507 "Non-nil means, searching for index phrases will ignore case."
1512 "A function which is called at each match during global indexing.
1513 If the function returns nil, the current match is skipped."
1520 "Non-nil means, skip matches which appear to be indexed already.
1521 When doing global indexing from the phrases buffer, searches for some
1522 phrases may match at places where that phrase was already indexed. In
1523 particular when indexing an already processed document again, this
1524 will even be the norm. When this variable is non-nil, RefTeX checks if
1525 the match is inside an index macro argument, or if an index macro is directly
1526 before or after the phrase. If that is the case, that match will
1527 be ignored."
1532 "Non-nil means, when indexing from the phrases buffer, wrap lines.
1533 Inserting indexing commands in a line makes the line longer - often
1534 so long that it does not fit onto the screen. When this variable is
1535 non-nil, newlines will be added as necessary before and/or after the
1536 indexing command to keep lines short. However, the matched text
1537 phrase and its index command will always end up on a single line."
1542 "Non-nil means when sorting phrase lines, the explicit index entry is used.
1543 Phrase lines in the phrases buffer contain a search phrase, and
1544 sorting is normally based on these. Some phrase lines also have
1545 an explicit index argument specified. When this variable is non-nil,
1546 the index argument will be used for sorting."
1551 "Non-nil means, empty and comment lines separate phrase buffer into blocks.
1552 Sorting will then preserve blocks, so that lines are re-arranged only
1553 within blocks."
1558 "The letters which denote sections in the index.
1559 Usually these are all capital letters. Don't use any downcase letters.
1560 Order is not significant, the index will be sorted by whatever the sort
1561 function thinks is correct.
1562 In addition to these letters, RefTeX will create a group `!' which
1563 contains all entries sorted below the lowest specified letter.
1564 In the index buffer, pressing any of these capital letters or `!' will jump
1565 to that section."
1570 "Non-nil means, display the index definition context in the index buffer.
1571 This flag may also be toggled from the index buffer with the `c' key."
1576 "Non-nil means, point in *Index* buffer will cause other window to follow.
1577 The other window will show the corresponding part of the document.
1578 This flag can be toggled from within the *Index* buffer with the `f' key."
1582 ;; Viewing Cross References
1585 "Displaying cross references and citations."
1589 "Macros which can be used for the display of cross references.
1590 This is used when `reftex-view-crossref' is called with point in an
1591 argument of a macro. Note that crossref viewing for citations,
1592 references (both ways) and index entries is hard-coded. This variable
1593 is only to configure additional structures for which cross-reference
1594 viewing can be useful. Each entry has the structure
1596 \(MACRO-RE SEARCH-RE HIGHLIGHT).
1598 MACRO-RE is matched against the macro. SEARCH-RE is the regexp used
1599 to search for cross references. `%s' in this regexp is replaced with
1600 with the macro argument at point. HIGHLIGHT is an integer indicating
1601 which subgroup of the match should be highlighted."
1608 "Non-nil means, initially turn automatic viewing of crossref info on.
1609 Automatic viewing of crossref info normally uses the echo area.
1610 Whenever point is idle for more than `reftex-idle-time' seconds on the
1612 displayed, the echo area will display information about that cross
1613 reference. You can also set the variable to the symbol `window'. In
1614 this case a small temporary window is used for the display.
1615 This feature can be turned on and off from the menu
1616 \(Ref->Options)."
1623 "Time (secs) Emacs has to be idle before automatic crossref display is done.
1624 Applies also to toc recentering."
1629 "Non-nil means, automatic citation display will revisit files if necessary.
1630 When nil, citation display in echo area will only be active for cached
1631 entries and for BibTeX database files with live associated buffers."
1636 "Non-nil means, echoed information for cite macros is cached.
1637 The information displayed in the echo area for cite macros is
1638 cached and even saved along with the parsing information. The
1639 cache survives document scans. In order to clear it, use M-x
1640 reftex-reset-mode <RET>."
1645 "Normal hook which is run before context is displayed anywhere.
1646 Designed for X-Symbol, but may have other uses as well."
1651 ;; Finding Files --------------------------------------------------------
1654 "Finding files on search paths."
1658 "List of specifications how to retrieve the search path for TeX files.
1659 Several entries are possible.
1660 - If an element is the name of an environment variable, its content is used.
1661 - If an element starts with an exclamation mark, it is used as a command
1662 to retrieve the path. A typical command with the kpathsearch library would
1663 be `!kpsewhich -show-path=.tex'.
1664 - Otherwise the element itself is interpreted as a path.
1665 Multiple directories can be separated by the system dependent `path-separator'.
1666 Directories ending in `//' or `!!' will be expanded recursively.
1667 See also `reftex-use-external-file-finders'."
1673 "List of specifications how to retrieve search path for .bib database files.
1674 Several entries are possible.
1675 - If an element is the name of an environment variable, its content is used.
1676 - If an element starts with an exclamation mark, it is used as a command
1677 to retrieve the path. A typical command with the kpathsearch library would
1678 be `!kpsewhich -show-path=.bib'.
1679 - Otherwise the element itself is interpreted as a path.
1680 Multiple directories can be separated by the system dependent `path-separator'.
1681 Directories ending in `//' or `!!' will be expanded recursively.
1682 See also `reftex-use-external-file-finders'."
1690 "Association list with file extensions for different file types.
1691 This is a list of items, each item is like: (TYPE . (DEF-EXT OTHER-EXT ...))
1695 OTHER-EXT: Any number of other valid extensions for this file type.
1697 When a files is searched and it does not have any of the legal extensions,
1698 we try the default extension first, and then the naked file name.
1700 If you are using AUCTeX, you also need to add new extensions to
1701 TeX-file-extensions."
1707 "Non-nil means, try all extensions listed in `reftex-file-extensions'.
1708 When searching for a file, LaTeX uses only the default extension. However,
1709 if you are working with a noweb system that produces the .tex files from
1710 some other file, and you want RefTeX to scan the web file instead of the
1711 tex file, you need to set this option. You also need to make the noweb
1712 extension the default extension, i.e. the first in the list in
1713 `reftex-file-extensions'.
1714 Note that if you are using external file finders, this option has no effect."
1719 "Non-nil means, search all specified directories before trying recursion.
1723 time the recursive path is for the system files and not for the user files.
1724 Set this to nil if the default makes RefTeX finding files with equal names
1725 in wrong sequence."
1730 "Non-nil means, use external programs to find files.
1731 Normally, RefTeX searches the paths given in the environment variables
1732 TEXINPUTS and BIBINPUTS to find TeX files and BibTeX database files.
1733 With this option turned on, it calls an external program specified in the
1734 option `reftex-external-file-finders' instead. As a side effect,
1735 the variables `reftex-texpath-environment-variables' and
1736 `reftex-bibpath-environment-variables' will be ignored."
1742 "Association list with external programs to call for finding files.
1743 Each entry is a cons cell (TYPE . PROGRAM).
1745 any arguments. %f will be replaced by the name of the file to be found.
1746 Note that these commands will be executed directly, not via a shell.
1747 Only relevant when `reftex-use-external-file-finders' is non-nil."
1752 ;; Tuning the parser ----------------------------------------------------
1755 "Configuration of parser speed and memory usage."
1759 "Non-nil means, keep buffers created for parsing and lookup.
1760 RefTeX sometimes needs to visit files related to the current document.
1761 We distinguish files visited for
1762 PARSING: Parts of a multifile document loaded when (re)-parsing the document.
1763 LOOKUP: BibTeX database files and TeX files loaded to find a reference,
1764 to display label context, etc.
1765 The created buffers can be kept for later use, or be thrown away immediately
1766 after use, depending on the value of this variable:
1768 nil Throw away as much as possible.
1769 t Keep everything.
1770 1 Throw away buffers created for parsing, but keep the ones created
1771 for lookup.
1773 If a buffer is to be kept, the file is visited normally (which is potentially
1774 slow but will happen only once).
1775 If a buffer is to be thrown away, the initialization of the buffer depends
1776 upon the variable `reftex-initialize-temporary-buffers'."
1784 "Non-nil means do initializations even when visiting file temporarily.
1785 When nil, RefTeX may turn off find-file hooks and other stuff to briefly
1786 visit a file.
1787 When t, the full default initializations are done (find-file-hook etc.).
1788 Instead of t or nil, this variable may also be a list of hook functions to
1789 do a minimal initialization."
1798 "List of regular expressions to exclude certain input files from parsing.
1800 of the regular expressions in this list, that file is not parsed by RefTeX."
1805 "Non-nil means, re-parse only 1 file when asked to re-parse.
1806 Re-parsing is normally requested with a `C-u' prefix to many RefTeX commands,
1807 or with the `r' key in menus. When this option is t in a multifile document,
1808 we will only parse the current buffer, or the file associated with the label
1809 or section heading near point in a menu. Requesting re-parsing of an entire
1810 multifile document then requires a `C-u C-u' prefix or the capital `R' key
1811 in menus."
1816 "Non-nil means, RefTeX may rescan the document when this seems necessary.
1817 Currently this applies only to rescanning after label insertion, when
1818 the new label cannot be inserted correctly into the internal label
1819 list."
1824 "Non-nil means, save information gathered with parsing in a file.
1825 The file MASTER.rel in the same directory as MASTER.tex is used to save the
1826 information. When this variable is t,
1827 - accessing the parsing information for the first time in an editing session
1828 will read that file (if available) instead of parsing the document.
1829 - exiting Emacs or killing a buffer in `reftex-mode' will cause a new version
1830 of the file to be written."
1835 "File extension for the file in which parser information is stored.
1836 This extension is added to the base name of the master file."
1841 "Non-nil means use a separate selection buffer for each label type.
1842 These buffers are kept from one selection to the next and need not to be
1843 created for each use - so the menu generally comes up faster. The
1844 selection buffers will be erased (and therefore updated) automatically
1845 when new labels in its category are added. See the variable
1846 `reftex-auto-update-selection-buffers'."
1852 "Non-nil means, selection buffers will be updated automatically.
1853 When a new label is defined with `reftex-label', all selection buffers
1854 associated with that label category are emptied, in order to force an
1855 update upon next use. When nil, the buffers are left alone and have to be
1856 updated by hand, with the `g' key from the label selection process.
1857 The value of this variable will only have any effect when
1858 `reftex-use-multiple-selection-buffers' is non-nil."
1863 ;; Fontification and Faces ----------------------------------------------
1866 "Options concerning the faces used in RefTeX."
1871 "Non-nil means, use fonts in *toc* and selection buffers.
1872 Font-lock must be loaded as well to actually get fontified display.
1873 When changing this option, a rescan may be necessary to activate the change."
1878 "Non-nil means, re-fontify the context in the label menu with font-lock.
1879 This slightly slows down the creation of the label menu. It is only necessary
1880 when you definitely want the context fontified.
1882 This option may have 3 different values:
1883 nil Never refontify.
1884 t Always refontify.
1885 1 Refontify when absolutely necessary, e.g. when old versions of X-Symbol.
1886 The option is ignored when `reftex-use-fonts' is nil."
1895 "Non-nil mean, highlight selected text in selection and *toc* buffers.
1896 Normally, the text near the cursor is the selected text, and it is
1897 highlighted. This is the entry most keys in the selection and *toc*
1898 buffers act on. However, if you mainly use the mouse to select an
1899 item, you may find it nice to have mouse-triggered highlighting
1900 instead or as well. The variable may have one of these values:
1902 nil No highlighting.
1903 cursor Highlighting is cursor driven.
1904 mouse Highlighting is mouse driven.
1905 both Both cursor and mouse trigger highlighting.
1907 Changing this variable requires to rebuild the selection and *toc* buffers
1908 to become effective (keys `g' or `r')."
1917 "Face name to highlight cursor selected item in toc and selection buffers.
1918 See also the variable `reftex-highlight-selection'."
1922 "Face name to highlight mouse selected item in toc and selection buffers.
1923 See also the variable `reftex-highlight-selection'."
1927 "Face name for file boundaries in selection buffer."
1931 "Face name for labels in selection buffer."
1935 "Face name for section headings in toc and selection buffers."
1939 "Face name for the header of a toc buffer."
1943 "Face name for author names in bib selection buffer."
1947 "Face name for year in bib selection buffer."
1951 "Face name for article title in bib selection buffer."
1955 "Face name for bibliographic information in bib selection buffer."
1959 "Face name for marked entries in the selection buffers."
1963 "Face name for the header of an index buffer."
1967 "Face name for the start of a new letter section in the index."
1971 "Face name for index names (for multiple indices)."
1975 "Face name for index entries."
1980 "X-Symbol specific hook.
1981 Functions get two arguments, the buffer from where the command started and a
1982 symbol indicating in what context the hook is called."
1986 ;; Miscellaneous configurations -----------------------------------------
1989 "Collection of further configurations."
1993 "Non-nil means, make additional key bindings on startup.
1994 These extra bindings are located in the users `C-c letter' map."
1999 "Plug-in flags for AUCTeX interface.
2000 This variable is a list of 5 boolean flags. When a flag is non-nil,
2001 RefTeX will
2003 - supply labels in new sections and environments (flag 1)
2009 You may also set the variable itself to t or nil in order to turn all
2010 plug-ins on or off, respectively.
2013 Supplying macro arguments applies when you insert such a macro interactively
2015 See the AUCTeX documentation for more information.
2016 RefTeX uses `fset' to take over the function calls. Changing the variable
2017 may require a restart of Emacs in order to become effective."
2033 "Non-nil means, allow arguments of macros to be detached by whitespace.
2041 "Hook which is being run when loading reftex.el."
2046 "Hook which is being run when turning on RefTeX mode."
2053 ;;; reftex-vars.el ends here