| blob | 27c829f307562c2eb2d21a5bd2815bf868999c7b |
1 ;;; reftex-vars.el --- configuration variables for RefTeX
3 ;; Copyright (C) 1997-1999, 2001-2014 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 )))
131 "The default label environment descriptions.
132 Lower-case symbols correspond to a style file of the same name in the LaTeX
209 "ConTeXt bib module"
213 )
214 "Builtin versions of the citation format.
215 The following conventions are valid for all alist entries:
217 `?t' should point to a textual citation (citation as a noun).
234 "Builtin stuff for `reftex-index-macros'.
235 Lower-case symbols correspond to a style file of the same name in the LaTeX
237 )
239 ;; Configuration Variables and User Options for RefTeX ------------------
242 "LaTeX label and citation support."
252 ;; Table of contents configuration --------------------------------------
255 "A multifile table of contents browser."
259 "LaTeX commands which input another file.
260 The file name is expected after the command, either in braces or separated
261 by whitespace."
266 "Maximum depth of section levels in document structure.
267 The default in standard LaTeX is 7, but there are packages for
268 which this needs to be larger."
272 ;; LaTeX section commands and level numbers
274 '(
284 ;;; ("minisec" . -7) ; KOMA-Script
285 )
286 "Commands and levels used for defining sections in the document.
287 This is an alist with each element like (COMMAND-NAME . LEVEL).
288 The car of each cons cell is the name of the section macro (without
289 the backslash). The cdr is a number indicating its level. A negative
290 level means the same level as the positive value, but the section will
291 never get a number. The cdr may also be a function which will be called
292 to after the section-re matched to determine the level.
293 This list is also used for promotion and demotion of sectioning commands.
294 If you are using a document class which has several sets of sectioning
295 commands, promotion only works correctly if this list is sorted first
296 by set, then within each set by level. The promotion commands always
297 select the nearest entry with the correct new level."
307 "The maximum level of toc entries which will be included in the TOC.
308 Section headings with a bigger level will be ignored. In RefTeX, chapters
309 are level 1, sections are level 2 etc.
310 This variable can be changed from within the *toc* buffer with the `t' key."
316 This means, part numbers will be included in the numbering of chapters, and
317 chapter counters will be reset for each part.
318 When nil (the default), parts are special, do not reset the chapter counter
319 and also do not show up in chapter numbers."
325 "Non-nil means, turn automatic recentering of *TOC* window on.
326 When active, the *TOC* window will always show the section you
327 are currently working in. Recentering happens whenever Emacs is idle for
328 more than `reftex-idle-time' seconds.
330 Value t means, turn on immediately when RefTeX gets started. Then,
331 recentering will work for any TOC window created during the session.
333 Value 'frame (the default) means, turn automatic recentering on only while the
334 dedicated TOC frame does exist, and do the recentering only in that frame. So
335 when creating that frame (with `d' key in an ordinary TOC window), the
336 automatic recentering is turned on. When the frame gets destroyed, automatic
337 recentering is turned off again.
339 This feature can be turned on and off from the menu
340 \(Ref->Options)."
348 "Non-nil means, create TOC window by splitting window horizontally."
353 "Fraction of the width or height of the frame to be used for TOC window.
354 See also `reftex-toc-split-windows-horizontally'."
362 "Non-nil means, split the selected window to display the *toc* buffer.
363 This helps to keep the window configuration, but makes the *toc* small.
364 When nil, all other windows except the selected one will be deleted, so
365 that the *toc* window fills half the frame."
370 "Non-nil means, include file boundaries in *toc* buffer.
371 This flag can be toggled from within the *toc* buffer with the `F' key."
376 "Non-nil means, include labels in *toc* buffer.
377 This flag can be toggled from within the *toc* buffer with the `l' key."
382 "Non-nil means, include index entries in *toc* buffer.
383 This flag can be toggled from within the *toc* buffer with the `i' key."
388 "Non-nil means, promotion/demotion commands first prompt for confirmation.
389 If nil, the command is executed immediately. If this is an integer N,
390 ask for confirmation only if N or more section commands are going to be
391 changed."
399 "Non-nil means, include context with labels in the *toc* buffer.
400 Context will only be shown when labels are visible as well.
401 This flag can be toggled from within the *toc* buffer with the `c' key."
406 "Non-nil means, point in *toc* buffer will cause other window to follow.
407 The other window will show the corresponding part of the document.
408 This flag can be toggled from within the *toc* buffer with the `f' key."
413 "Non-nil means, follow-mode will revisit files if necessary.
414 If nil, follow-mode will be suspended for stuff in unvisited files."
420 "Mode hook for `reftex-toc-mode'."
424 ;; Label Support Configuration
427 "Support for creation, insertion and referencing of labels in LaTeX."
431 "Definition of environments and macros to do with label."
436 rotating sidecap subfigure supertab wrapfig
437 listings minted ctable LaTeX)
438 "Default label alist specifications. LaTeX should always be the last entry.
439 The value of this variable is a list of symbols with associations in the
440 constant `reftex-label-alist-builtin'. Check that constant for a full list
441 of options."
446 :inline t
447 :greedy t
453 reftex-label-alist-builtin)))
458 This doc string is easier to understand after reading the configuration
459 examples in the manual. Looking at the builtin defaults in the constant
460 `reftex-label-alist-builtin' may also be instructive.
462 Set this variable to define additions and changes to the default. The only
463 things you MUST NOT change is that `?s' is the type indicator for section
464 labels, and SPC for the `any' label type. These are hard-coded at other
465 places in the code.
467 The value of the variable must be a list of items. Each item is a list
468 itself and has the following structure:
470 (ENV-OR-MACRO TYPE-KEY LABEL-PREFIX REFERENCE-FORMAT CONTEXT-METHOD
471 (MAGIC-WORD ... ) TOC-LEVEL)
473 Each list entry describes either an environment carrying a counter for use
475 one of its arguments. The elements of each list entry are:
477 ENV-OR-MACRO
479 For macros, indicate the macro arguments for best results, as in
481 a star to mark the label argument, if any. The macro does not have to
483 its arguments.
484 Special names: `section' for section labels, `any' to define a group
485 which contains all labels.
487 This may also be a function to do local parsing and identify point to
488 be in a non-standard label environment. The function must take an
489 argument BOUND and limit backward searches to this value. It should
490 return either nil or the position where the special environment starts.
491 See the Info documentation for an example.
493 Finally this may also be nil if the entry is only meant to change
494 some settings associated with the type indicator character (see below).
496 TYPE-KEY
497 Type indicator character, like `?t', must be a printable ASCII character.
498 The type indicator is a single character which defines a label type.
499 Any label inside the environment or macro is assumed to belong to this
500 type. The same character may occur several times in this list, to cover
501 cases in which different environments carry the same label type (like
502 `equation' and `eqnarray').
503 If the type indicator is nil and the macro has a label argument {*},
505 the remainder of this entry is ignored.
507 LABEL-PREFIX
509 The prefix is a short string used as the start of a label. It may be the
510 empty string. The prefix may contain the following `%' escapes:
511 %f Current file name with directory and extension stripped.
512 %F Current file name relative to directory of master file.
513 %m Master file name, directory and extension stripped.
514 %M Directory name (without path) where master file is located.
515 %u User login name, on systems which support this.
516 %S A section prefix derived with variable `reftex-section-prefixes'.
520 REFERENCE-FORMAT
521 Format string for reference insertion in buffer. `%s' will be replaced
522 by the label.
523 When the format starts with `~', the `~' will only be inserted if
524 there is not already a whitespace before point.
526 CONTEXT-METHOD
527 Indication on how to find the short context.
529 - If t, use
530 - the section heading for section labels.
532 (not a good choice for environments like eqnarray or enumerate,
533 where one has several labels in a single environment).
534 - text after the macro name (starting with the first arg) for macros.
535 - If an integer, use the nth argument of the macro. As a special case,
536 1000 means to get text after the last macro argument.
537 - If a string, use as regexp to search *backward* from the label. Context
538 is then the text following the end of the match. E.g. setting this to
540 environment.
542 - If any of `caption', `item', `eqnarray-like', `alignat-like', this
543 symbol will internally be translated into an appropriate regexp
544 (see also the variable `reftex-default-context-regexps').
545 - If a function, call this function with the name of the environment/macro
547 function is expected to return a suitable context string. It should
548 throw an exception (error) when failing to find context.
549 As an example, here is a function returning the 10 chars following
550 the label macro as context:
552 (defun my-context-function (env-or-mac)
553 (if (> (point-max) (+ 10 (point)))
554 (buffer-substring (point) (+ 10 (point)))
557 Label context is used in two ways by RefTeX: For display in the label
558 menu, and to derive a label string. If you want to use a different
559 method for each of these, specify them as a dotted pair.
560 E.g. `(nil . t)' uses the text after the label (nil) for display, and
561 text from the default position (t) to derive a label string. This is
562 actually used for section labels.
564 MAGIC-WORDS
565 List of magic words which identify a reference to be of this type.
566 If the word before point is equal to one of these words when calling
567 `reftex-reference', the label list offered will be automatically
568 restricted to labels of the correct type.
569 If the first element of this wordlist is the symbol `regexp', the
570 strings are interpreted as regular expressions. RefTeX will add
573 TOC-LEVEL
574 The integer level at which this environment should be added to the
575 table of contents. See also `reftex-section-levels'. A positive
576 value will number the entries mixed with the sectioning commands of
577 the same level. A negative value will make unnumbered entries.
578 Useful only for theorem-like environments, will be ignored for macros.
579 When omitted or nil, no TOC entries will be made.
581 If the type indicator characters of two or more entries are the same, RefTeX
582 will use
583 - the first non-nil format and prefix
584 - the magic words of all involved entries.
586 Any list entry may also be a symbol. If that has an association in
587 `reftex-label-alist-builtin', the cddr of that association is spliced into the
588 list. However, builtin defaults should normally be set with the variable
589 `reftex-default-label-alist-entries'."
592 :type
627 :value AMSTeX
632 reftex-label-alist-builtin)))))
635 "Prefixes for section labels.
636 When the label prefix given in an entry in `reftex-label-alist' contains `%S',
637 this list is used to determine the correct prefix string depending on the
638 current section level.
639 The list is an alist, with each entry of the form (KEY . PREFIX)
640 Possible keys are sectioning macro names like `chapter', section levels
641 \(as given in `reftex-section-levels'), and t for the default."
656 "Alist with default regular expressions for finding context.
657 The form (format regexp (regexp-quote environment)) is used to calculate
658 the final regular expression - so %s will be replaced with the environment
659 or macro."
664 "Non-nil means, trust the label prefix when determining label type.
665 It is customary to use special label prefixes to distinguish different label
666 types. The label prefixes have no syntactic meaning in LaTeX (unless
667 special packages like fancyref are being used). RefTeX can and by
668 default does parse around each label to detect the correct label type,
669 but this process can be slow when a document contains thousands of
670 labels. If you use label prefixes consistently, you may speed up
671 document parsing by setting this variable to a non-nil value. RefTeX
672 will then compare the label prefix with the prefixes found in
673 `reftex-label-alist' and derive the correct label type in this way.
674 Possible values for this option are:
676 t This means to trust any label prefixes found.
677 regexp If a regexp, only prefixes matched by the regexp are trusted.
678 list List of accepted prefixes, as strings. The colon is part of
680 nil Never trust a label prefix.
682 The only disadvantage of using this feature is that the label context
683 displayed in the label selection buffer along with each label is
684 simply some text after the label definition. This is no problem if you
685 place labels keeping this in mind (e.g. *before* the equation, *at
686 the beginning* of a fig/tab caption ...). Anyway, it is probably best
687 to use the regexp or the list value types to fine-tune this feature.
688 For example, if your document contains thousands of footnotes with
691 non-footnote labels."
701 "List of functions to be called when trying to figure out current environment.
704 use such non-standard ways to set up environment-like constructs. The
705 purpose of each function in this list is to detect if point is
707 carries a label, you must also set up an entry for it in
708 `reftex-label-alist'.
710 The function should check if point is currently in the special
711 environment it was written to detect. If so, the function must return
712 a cons cell (NAME . POSITION). NAME is the name of the environment
713 detected and POSITION is the buffer position where the environment
714 starts. The function must return nil on failure to detect the
715 environment.
717 The function must take an argument BOUND. If non-nil, BOUND is a
718 boundary for backwards searches which should be observed.
720 Here is an example. The LaTeX package linguex.sty defines list macros
722 line.
728 ... more text after the empty line terminating all lists
730 And here is the setup for RefTeX:
732 1. Define a dummy environment for this in `reftex-label-alist'. Dummy means,
736 (setq reftex-label-alist
739 2. Write a function to detect the list macros and the determinators as well.
741 (defun my-detect-linguex-list (bound)
742 (let ((pos (point)) p1)
743 (save-excursion
744 ;; Search for any of the linguex item macros at the beginning of a line
745 (if (re-search-backward
747 (progn
748 (setq p1 (match-beginning 1))
751 ;; Return nil because list was already closed
752 nil
753 ;; OK, we got it
755 ;; Return nil for not found
756 nil))))
758 3. Tell RefTeX to use this function
760 (setq reftex-special-environment-functions '(my-detect-linguex-list))"
764 ;; Label insertion
767 "Options on how to create new labels."
771 "Flags governing label insertion. First flag DERIVE, second flag PROMPT.
773 If DERIVE is t, RefTeX will try to derive a sensible label from context.
774 A section label for example will be derived from the section heading.
775 The conversion of the context to a valid label is governed by the
776 specifications given in `reftex-derive-label-parameters'.
777 If RefTeX fails to derive a label, it will prompt the user.
778 If DERIVE is nil, the label generated will consist of the prefix and a
779 unique number, like `eq:23'.
781 If PROMPT is t, the user will be prompted for a label string. The prompt will
782 already contain the prefix, and (if DERIVE is t) a default label derived from
783 context. When PROMPT is nil, the default label will be inserted without
784 query.
786 So the combination of DERIVE and PROMPT controls label insertion. Here is a
787 table describing all four possibilities:
789 DERIVE PROMPT ACTION
790 -------------------------------------------------------------------------
791 nil nil Insert simple label, like eq:22 or sec:13. No query.
792 nil t Prompt for label.
793 t nil Derive a label from context and insert without query.
794 t t Derive a label from context and prompt for confirmation.
796 Each flag may be set to t, nil, or a string of label type letters
797 indicating the label types for which it should be true. The strings work
798 like character classes.
799 Thus, the combination may be set differently for each label type. The
801 \(with confirmation). Prompt for figure and table labels. Use simple labels
802 without confirmation for everything else.
803 The available label types are: s (section), f (figure), t (table), i (item),
804 e (equation), n (footnote), N (endnote), plus any definitions in
805 `reftex-label-alist'."
818 "Function to turn an arbitrary string into a valid label.
819 RefTeX's default function uses the variable `reftex-derive-label-parameters'."
824 "Filter function to convert a string to ASCII.
825 The function is used to process a context string before it is
826 used to derive a label from it. The intended application is to
827 convert ISO or Mule characters into something valid in labels.
828 The default function removes the accents from Latin-1 characters.
829 X-Symbol (>=2.6) sets this variable to the much more general
830 `x-symbol-translate-to-ascii'."
836 "Parameters for converting a string into a label.
837 This variable is a list of the following items.
839 NWORDS Number of words to use.
840 MAXCHAR Maximum number of characters in a label string.
841 INVALID nil: Throw away any words containing characters invalid in labels.
842 t: Throw away only the invalid characters, not the whole word.
843 ABBREV nil: Never abbreviate words.
844 t: Always abbreviate words (see `reftex-abbrev-parameters').
845 not t and not nil: Abbreviate words if necessary to shorten
846 label string below MAXCHAR.
847 SEPARATOR String separating different words in the label.
848 IGNOREWORDS List of words which should not be part of labels.
849 DOWNCASE t: Downcase words before using them."
869 ;; keyvals [..., label = {foo}, ...] forms used by ctable,
870 ;; listings, minted, ...
874 keyval style [..., label = {...}, ...] label definitions. It is
875 assumed that the regexp group 1 matches the label text, so you
878 When changed from Lisp, make sure to call
879 `reftex-compile-variables' afterwards to make the change
880 effective."
890 "List of macros and environments to be ignored when searching for labels.
891 The purpose is to ignore environments and macros that use keyval
892 style label=foo arguments, but the label has a different meaning
894 ignored.
896 E.g., TikZ defines several macros/environments where [label=foo]
897 defines the label to be printed at some node or edge, but it's
898 not a label used for referencing.
900 Note that this feature is only supported if you are using AUCTeX
901 and the functions `TeX-current-macro' and
902 `LaTeX-current-environment' are bound. Also note that this
903 feature might slow down the reftex parsing process for large TeX
904 files."
910 "Regexp matching characters not valid in labels."
915 "Parameters for abbreviation of words.
916 This variable is a list of the following items.
918 MIN-CHARS Minimum number of characters remaining after abbreviation.
919 MIN-KILL Minimum number of characters to remove when abbreviating words.
920 BEFORE Character class before abbrev point in word.
921 AFTER Character class after abbrev point in word."
930 "Function which produces the string to insert as a label definition.
931 Normally should be nil, unless you want to do something fancy.
932 The function will be called with two arguments, the LABEL and the DEFAULT
934 string to insert into the buffer."
938 ;; Label referencing
941 "Options on how to reference labels."
951 "List of flags governing the label menu makeup.
952 The flags are:
954 TABLE-OF-CONTENTS Show the labels embedded in a table of context.
955 SECTION-NUMBERS Include section numbers (like 4.1.3) in table of contents.
956 COUNTERS Show counters. This just numbers the labels in the menu.
957 NO-CONTEXT Non-nil means do NOT show the short context.
958 FOLLOW Follow full context in other window.
959 SHOW-COMMENTED Show labels from regions which are commented out.
960 MATCH-IN-TOC Obsolete flag.
961 SHOW FILES Show begin and end of included files.
963 Each of these flags can be set to t or nil, or to a string of type letters
964 indicating the label types for which it should be true. These strings work
965 like character classes in regular expressions. Thus, setting one of the
968 The available label types are: s (section), f (figure), t (table), i (item),
969 e (equation), n (footnote), plus any definitions in `reftex-label-alist'.
971 Most options can also be switched from the label menu itself - so if you
972 decide here to not have a table of contents in the label menu, you can still
973 get one interactively during selection from the label menu."
975 :type
987 "Punctuation strings for multiple references.
988 When marking is used in the selection buffer to select several references,
989 this variable associates the 3 marking characters `,-+' with prefix strings
991 This is used to string together whole reference sets, like
992 `eqs. 1,2,3-5,6 and 7' in a single call to `reftex-reference'. See manual."
1007 "Alist of reference styles.
1008 Each element is a list of the style name, the name of the LaTeX
1009 package associated with the style or t for any package, and an
1010 alist of macros where the first entry of each item is the
1011 reference macro and the second a key for selecting the macro when
1012 the macro type is being prompted for. (See also
1013 `reftex-ref-macro-prompt'.) The keys, represented as characters,
1014 have to be unique."
1026 "If non-nil, `reftex-reference' prompts for the reference macro."
1032 "Non-nil means, the varioref reference style is used as default.
1033 The value of this variable determines the default which is active
1034 when entering the selection process. Instead of nil or t, this
1035 may also be a string of type letters indicating the label types
1036 for which it should be true.
1038 This variable is obsolete, use `reftex-ref-style-default-list'
1039 instead."
1042 ;;;###autoload(put 'reftex-vref-is-default 'safe-local-variable (lambda (x) (or (stringp x) (symbolp x))))
1045 "Non-nil means, the fancyref reference style is used as default.
1046 The value of this variable determines the default which is active
1047 when entering the selection process. Instead of nil or t, this
1048 may also be a string of type letters indicating the label types
1049 for which it should be true.
1051 This variable is obsolete, use `reftex-ref-style-default-list'
1052 instead."
1055 ;;;###autoload(put 'reftex-fref-is-default 'safe-local-variable (lambda (x) (or (stringp x) (symbolp x))))
1058 "List of reference styles to be activated by default.
1059 The order is significant and controls the order in which macros
1060 can be cycled in the buffer for selecting a label. The entries
1061 in the list have to match the respective reference style names
1062 used in the variable `reftex-ref-style-alist'."
1066 reftex-ref-style-alist)))
1068 ;; Compatibility with obsolete variables.
1075 "Number of spaces to be used for indentation per section level."
1078 ;;;###autoload(put 'reftex-level-indent 'safe-local-variable 'integerp)
1081 "Non-nil means, `reftex-reference' will try to guess the label type.
1082 To do that, RefTeX will look at the word before the cursor and compare it with
1083 the words given in `reftex-label-alist'. When it finds a match, RefTeX will
1084 immediately offer the correct label menu - otherwise it will prompt you for
1085 a label type. If you set this variable to nil, RefTeX will always prompt."
1088 ;;;###autoload(put 'reftex-guess-label-type 'safe-local-variable (lambda (x) (memq x '(nil t))))
1091 "Function which produces the string to insert as a reference.
1092 Normally should be nil, because the format to insert a reference
1093 can already be specified in `reftex-label-alist'.
1095 This hook also is used by the special commands to insert
1097 your setting will be ignored by the special commands.
1099 The function will be called with three arguments, the LABEL, the
1101 STYLE. The function should return the string to insert into the
1102 buffer."
1107 "Mode hook for `reftex-select-label-mode'."
1111 ;; BibteX citation configuration ----------------------------------------
1114 "Support for referencing bibliographic data with BibTeX."
1119 "LaTeX commands which specify the BibTeX databases to use with the document."
1127 File names matched by these regexps will not be parsed by RefTeX.
1128 Intended for files which contain only `@string' macro definitions and the
1129 like, which are ignored by RefTeX anyway."
1135 "List of BibTeX database files which should be used if none are specified.
1136 When `reftex-citation' is called from a document which has neither a
1138 RefTeX will scan these files instead. Intended for using `reftex-citation'
1139 in non-LaTeX files. The files will be searched along the BIBINPUTS or TEXBIB
1140 path."
1145 "Sorting of the entries found in BibTeX databases by reftex-citation.
1146 Possible values:
1147 nil Do not sort entries.
1148 'author Sort entries by author name.
1149 'year Sort entries by increasing year.
1150 'reverse-year Sort entries by decreasing year."
1158 "The format of citations to be inserted into the buffer.
1159 It can be a string or an alist or a symbol. In the simplest case this
1161 definition of `reftex-cite-format-builtin' for more complex examples.
1163 If `reftex-cite-format' is a string, it will be used as the format.
1164 In the format, the following percent escapes will be expanded.
1166 %l The BibTeX label of the citation.
1167 %a List of author names, see also `reftex-cite-punctuation'.
1168 %2a Like %a, but abbreviate more than 2 authors like Jones et al.
1169 %A First author name only.
1170 %e Works like %a, but on list of editor names. (%2e and %E work a well)
1172 It is also possible to access all other BibTeX database fields:
1173 %b booktitle %c chapter %d edition %h howpublished
1174 %i institution %j journal %k key %m month
1175 %n number %N note %o organization %p pages
1176 %P first page %r address %s school %u publisher
1177 %U url %t title %v volume %y year
1178 %B booktitle, abbreviated %T title, abbreviated
1180 Usually, only %l is needed. The other stuff is mainly for the echo area
1181 display, and for (setq reftex-comment-citations t).
1183 %< as a special operator kills punctuation and space around it after the
1184 string has been formatted.
1186 A pair of square brackets indicates an optional argument, and RefTeX
1187 will prompt for the values of these arguments.
1189 Beware that all this only works with BibTeX database files. When
1191 environment, only %l is available.
1193 If `reftex-cite-format' is an alist of characters and strings, the user
1194 will be prompted for a character to select one of the possible format
1195 strings.
1196 In order to configure this variable, you can either set
1197 `reftex-cite-format' directly yourself or set it to the SYMBOL of one of
1198 the predefined styles. The predefined symbols are those which have an
1199 association in the constant `reftex-cite-format-builtin'.
1200 E.g.: (setq reftex-cite-format 'natbib)"
1202 :type
1207 :value default
1213 reftex-cite-format-builtin))
1222 "Non-nil means, prompt for empty optional arguments in cite macros.
1223 When an entry in `reftex-cite-format' is given with square brackets to
1225 prompt for values. Possible values are:
1227 nil Never prompt for optional arguments
1228 t Always prompt
1229 maybe Prompt only if `reftex-citation' was called with C-u prefix arg
1231 Unnecessary empty optional arguments are removed before insertion into
1232 the buffer. See `reftex-cite-cleanup-optional-args'."
1240 "Non-nil means, remove unnecessary empty optional arguments in cite macros.
1241 The cite macros provided by some packages (for example
1242 natbib) allow specifying two optional arguments, one for a prefix to
1243 the citation, and a second for a postfix. When only one optional
1244 argument is given, it is interpreted as postfix. When this option is
1245 t, RefTeX removes unnecessary empty optional arguments from the cite
1246 macro before insertion. For example, it will change
1251 Is is possible that other packages have other conventions about which
1252 optional argument is interpreted how - that is why this cleaning up
1253 can be turned off."
1258 "Non-nil means add a comment for each citation describing the full entry.
1259 The comment is formatted according to `reftex-cite-comment-format'."
1265 "Citation format used for commented citations. Must NOT contain %l.
1266 See the variable `reftex-cite-format' for possible percent escapes."
1271 "Citation format used to display citation info in the message area.
1272 Must NOT contain %l. See the variable `reftex-cite-format' for
1273 possible percent escapes."
1279 "Punctuation for formatting of name lists in citations.
1280 This is a list of 3 strings.
1291 "Function which produces the string to insert as a citation.
1292 Normally should be nil, because the format to insert a reference can
1293 already be specified in `reftex-cite-format'.
1294 The function will be called with two arguments, the CITATION KEY and the
1295 DEFAULT FORMAT, which is taken from `reftex-cite-format'. The function
1296 should return the string to insert into the buffer."
1301 "Mode hook for reftex-select-bib-mode."
1312 "Header to insert in BibTeX files generated by RefTeX."
1318 "Footer to insert in BibTeX files generated by RefTeX."
1323 ;; Index Support Configuration
1326 "Support for viewing and editing the index."
1330 "Non-nil means, index entries are parsed as well.
1331 Index support is resource intensive and the internal structure holding the
1332 parsed information can become quite big. Therefore it can be turned off.
1333 When this is nil and you execute a command which requires index support,
1334 you will be asked for confirmation to turn it on and rescan the document."
1339 "Special characters in index entries. The value is a list of five strings.
1340 These correspond to the makeindex keywords LEVEL ENCAP ACTUAL QUOTE ESCAPE."
1350 "Macros which define index entries.
1352 The structure is
1354 \(MACRO INDEX-TAG KEY PREFIX EXCLUDE REPEAT)
1356 MACRO is the macro. Arguments should be denoted by empty braces like
1358 marks where the index key is.
1361 reserved for the default index and the glossary. Other indices can be
1362 defined as well. If this is an integer, the Nth argument of the macro
1363 holds the index tag.
1365 KEY is a character which is used to identify the macro for input with
1368 PREFIX can be a prefix which is added to the KEY part of the index entry.
1372 EXCLUDE can be a function. If this function exists and returns a non-nil
1373 value, the index entry at point is ignored. This was implemented to support
1374 the (deprecated) `^' and `_' shortcuts in the LaTeX2e `index' package.
1376 REPEAT, if non-nil, means the index macro does not typeset the entry in
1377 the text, so that the text has to be repeated outside the index macro.
1378 Needed for `reftex-index-selection-or-word' and for indexing from the
1379 phrase buffer.
1381 The final entry may also be a symbol if this entry has a association
1382 in the variable `reftex-index-macros-builtin' to specify the main
1383 indexing package you are using. Valid values are currently
1384 default The LaTeX default - unnecessary to specify this one
1385 multind The multind.sty package
1386 index The index.sty package
1387 index-shortcut The index.sty packages with the ^ and _ shortcuts.
1388 Should not be used - only for old documents.
1389 Note that AUCTeX sets these things internally for RefTeX as well, so
1390 with a sufficiently new version of AUCTeX, you should not set the
1391 package here."
1396 :inline t
1409 :value index
1415 reftex-index-macros-builtin)))))
1419 This is a list with (MACRO-KEY DEFAULT-TAG).
1421 MACRO-KEY: Character identifying an index macro - see `reftex-index-macros'.
1422 DEFAULT-TAG: This is the tag to be used if the macro requires a TAG argument.
1423 When this is nil and a TAG is needed, RefTeX will ask for it.
1424 When this is the empty string and the TAG argument of the index
1425 macro is optional, the TAG argument will be omitted."
1434 "Default index tag.
1435 When working with multiple indexes, RefTeX queries for an index tag when
1436 creating index entries or displaying a specific index. This variable controls
1437 the default offered for these queries. The default can be selected with RET
1438 during selection or completion. Valid values of this variable are:
1440 nil Do not provide a default index
1442 last The last used index tag will be offered as default."
1450 "Format of index entries when copied from inside math mode.
1451 When `reftex-index-selection-or-word' is executed inside TeX math mode,
1452 the index key copied from the buffer is processed with this format string
1453 through the `format' function. This can be used to add the math delimiters
1454 \(e.g. `$') to the string.
1455 Requires the `texmathp.el' library which is part of AUCTeX."
1460 "File extension for the index phrase file.
1461 This extension will be added to the base name of the master file."
1466 "Regexp matching the `and' operator for index arguments in phrases file.
1467 When several index arguments in a phrase line are separated by this
1468 operator, each part will generate an index macro. So each match of
1469 the search phrase will produce *several* different index entries.
1471 Note: make sure this does no match things which are not separators.
1472 This logical `and' has higher priority than the logical `or' specified in
1473 `reftex-index-phrases-logical-or-regexp'."
1478 "Regexp matching the `or' operator for index arguments in phrases file.
1479 When several index arguments in a phrase line are separated by this
1480 operator, the user will be asked to select one of them at each match
1481 of the search phrase. The first index arg will be the default - a
1482 number key 1-9 must be pressed to switch to another.
1484 Note: make sure this does no match things which are not separators.
1485 The logical `and' specified in `reftex-index-phrases-logical-or-regexp'
1486 has higher priority than this logical `or'."
1491 "Non-nil means phrases search will look for whole words, not subwords.
1492 This works by requiring word boundaries at the beginning and end of
1493 the search string. When the search phrase already has a non-word-char
1494 at one of these points, no word boundary is required there."
1499 "Non-nil means, searching for index phrases will ignore case."
1504 "A function which is called at each match during global indexing.
1505 If the function returns nil, the current match is skipped."
1512 "Non-nil means, skip matches which appear to be indexed already.
1513 When doing global indexing from the phrases buffer, searches for some
1514 phrases may match at places where that phrase was already indexed. In
1515 particular when indexing an already processed document again, this
1516 will even be the norm. When this variable is non-nil, RefTeX checks if
1517 the match is inside an index macro argument, or if an index macro is directly
1518 before or after the phrase. If that is the case, that match will
1519 be ignored."
1524 "Non-nil means, when indexing from the phrases buffer, wrap lines.
1525 Inserting indexing commands in a line makes the line longer - often
1526 so long that it does not fit onto the screen. When this variable is
1527 non-nil, newlines will be added as necessary before and/or after the
1528 indexing command to keep lines short. However, the matched text
1529 phrase and its index command will always end up on a single line."
1534 "Non-nil means when sorting phrase lines, the explicit index entry is used.
1535 Phrase lines in the phrases buffer contain a search phrase, and
1536 sorting is normally based on these. Some phrase lines also have
1537 an explicit index argument specified. When this variable is non-nil,
1538 the index argument will be used for sorting."
1543 "Non-nil means, empty and comment lines separate phrase buffer into blocks.
1544 Sorting will then preserve blocks, so that lines are re-arranged only
1545 within blocks."
1550 "The letters which denote sections in the index.
1551 Usually these are all capital letters. Don't use any downcase letters.
1552 Order is not significant, the index will be sorted by whatever the sort
1553 function thinks is correct.
1554 In addition to these letters, RefTeX will create a group `!' which
1555 contains all entries sorted below the lowest specified letter.
1556 In the index buffer, pressing any of these capital letters or `!' will jump
1557 to that section."
1562 "Non-nil means, display the index definition context in the index buffer.
1563 This flag may also be toggled from the index buffer with the `c' key."
1568 "Non-nil means, point in *Index* buffer will cause other window to follow.
1569 The other window will show the corresponding part of the document.
1570 This flag can be toggled from within the *Index* buffer with the `f' key."
1574 ;; Viewing Cross References
1577 "Displaying cross references and citations."
1581 "Macros which can be used for the display of cross references.
1582 This is used when `reftex-view-crossref' is called with point in an
1583 argument of a macro. Note that crossref viewing for citations,
1584 references (both ways) and index entries is hard-coded. This variable
1585 is only to configure additional structures for which cross-reference
1586 viewing can be useful. Each entry has the structure
1588 \(MACRO-RE SEARCH-RE HIGHLIGHT).
1590 MACRO-RE is matched against the macro. SEARCH-RE is the regexp used
1591 to search for cross references. `%s' in this regexp is replaced with
1592 with the macro argument at point. HIGHLIGHT is an integer indicating
1593 which subgroup of the match should be highlighted."
1600 "Non-nil means, initially turn automatic viewing of crossref info on.
1601 Automatic viewing of crossref info normally uses the echo area.
1602 Whenever point is idle for more than `reftex-idle-time' seconds on the
1604 displayed, the echo area will display information about that cross
1605 reference. You can also set the variable to the symbol `window'. In
1606 this case a small temporary window is used for the display.
1607 This feature can be turned on and off from the menu
1608 \(Ref->Options)."
1615 "Time (secs) Emacs has to be idle before automatic crossref display is done.
1616 Applies also to toc recentering."
1621 "Non-nil means, automatic citation display will revisit files if necessary.
1622 When nil, citation display in echo area will only be active for cached
1623 entries and for BibTeX database files with live associated buffers."
1628 "Non-nil means, echoed information for cite macros is cached.
1629 The information displayed in the echo area for cite macros is
1630 cached and even saved along with the parsing information. The
1631 cache survives document scans. In order to clear it, use M-x
1632 reftex-reset-mode <RET>."
1637 "Normal hook which is run before context is displayed anywhere.
1638 Designed for X-Symbol, but may have other uses as well."
1643 ;; Finding Files --------------------------------------------------------
1646 "Finding files on search paths."
1650 "List of specifications how to retrieve the search path for TeX files.
1651 Several entries are possible.
1652 - If an element is the name of an environment variable, its content is used.
1653 - If an element starts with an exclamation mark, it is used as a command
1654 to retrieve the path. A typical command with the kpathsearch library would
1655 be `!kpsewhich -show-path=.tex'.
1656 - Otherwise the element itself is interpreted as a path.
1657 Multiple directories can be separated by the system dependent `path-separator'.
1658 Directories ending in `//' or `!!' will be expanded recursively.
1659 See also `reftex-use-external-file-finders'."
1665 "List of specifications how to retrieve search path for .bib database files.
1666 Several entries are possible.
1667 - If an element is the name of an environment variable, its content is used.
1668 - If an element starts with an exclamation mark, it is used as a command
1669 to retrieve the path. A typical command with the kpathsearch library would
1670 be `!kpsewhich -show-path=.bib'.
1671 - Otherwise the element itself is interpreted as a path.
1672 Multiple directories can be separated by the system dependent `path-separator'.
1673 Directories ending in `//' or `!!' will be expanded recursively.
1674 See also `reftex-use-external-file-finders'."
1682 "Association list with file extensions for different file types.
1683 This is a list of items, each item is like: (TYPE . (DEF-EXT OTHER-EXT ...))
1687 OTHER-EXT: Any number of other valid extensions for this file type.
1689 When a files is searched and it does not have any of the legal extensions,
1690 we try the default extension first, and then the naked file name.
1692 If you are using AUCTeX, you also need to add new extensions to
1693 TeX-file-extensions."
1699 "Non-nil means, try all extensions listed in `reftex-file-extensions'.
1700 When searching for a file, LaTeX uses only the default extension. However,
1701 if you are working with a noweb system that produces the .tex files from
1702 some other file, and you want RefTeX to scan the web file instead of the
1703 tex file, you need to set this option. You also need to make the noweb
1704 extension the default extension, i.e. the first in the list in
1705 `reftex-file-extensions'.
1706 Note that if you are using external file finders, this option has no effect."
1711 "Non-nil means, search all specified directories before trying recursion.
1715 time the recursive path is for the system files and not for the user files.
1716 Set this to nil if the default makes RefTeX finding files with equal names
1717 in wrong sequence."
1722 "Non-nil means, use external programs to find files.
1723 Normally, RefTeX searches the paths given in the environment variables
1724 TEXINPUTS and BIBINPUTS to find TeX files and BibTeX database files.
1725 With this option turned on, it calls an external program specified in the
1726 option `reftex-external-file-finders' instead. As a side effect,
1727 the variables `reftex-texpath-environment-variables' and
1728 `reftex-bibpath-environment-variables' will be ignored."
1734 "Association list with external programs to call for finding files.
1735 Each entry is a cons cell (TYPE . PROGRAM).
1737 any arguments. %f will be replaced by the name of the file to be found.
1738 Note that these commands will be executed directly, not via a shell.
1739 Only relevant when `reftex-use-external-file-finders' is non-nil."
1744 ;; Tuning the parser ----------------------------------------------------
1747 "Configuration of parser speed and memory usage."
1751 "Non-nil means, keep buffers created for parsing and lookup.
1752 RefTeX sometimes needs to visit files related to the current document.
1753 We distinguish files visited for
1754 PARSING: Parts of a multifile document loaded when (re)-parsing the document.
1755 LOOKUP: BibTeX database files and TeX files loaded to find a reference,
1756 to display label context, etc.
1757 The created buffers can be kept for later use, or be thrown away immediately
1758 after use, depending on the value of this variable:
1760 nil Throw away as much as possible.
1761 t Keep everything.
1762 1 Throw away buffers created for parsing, but keep the ones created
1763 for lookup.
1765 If a buffer is to be kept, the file is visited normally (which is potentially
1766 slow but will happen only once).
1767 If a buffer is to be thrown away, the initialization of the buffer depends
1768 upon the variable `reftex-initialize-temporary-buffers'."
1776 "Non-nil means do initializations even when visiting file temporarily.
1777 When nil, RefTeX may turn off find-file hooks and other stuff to briefly
1778 visit a file.
1779 When t, the full default initializations are done (find-file-hook etc.).
1780 Instead of t or nil, this variable may also be a list of hook functions to
1781 do a minimal initialization."
1790 "List of regular expressions to exclude certain input files from parsing.
1792 of the regular expressions in this list, that file is not parsed by RefTeX."
1797 "Non-nil means, re-parse only 1 file when asked to re-parse.
1798 Re-parsing is normally requested with a `C-u' prefix to many RefTeX commands,
1799 or with the `r' key in menus. When this option is t in a multifile document,
1800 we will only parse the current buffer, or the file associated with the label
1801 or section heading near point in a menu. Requesting re-parsing of an entire
1802 multifile document then requires a `C-u C-u' prefix or the capital `R' key
1803 in menus."
1808 "Non-nil means, RefTeX may rescan the document when this seems necessary.
1809 Currently this applies only to rescanning after label insertion, when
1810 the new label cannot be inserted correctly into the internal label
1811 list."
1816 "Non-nil means, save information gathered with parsing in a file.
1817 The file MASTER.rel in the same directory as MASTER.tex is used to save the
1818 information. When this variable is t,
1819 - accessing the parsing information for the first time in an editing session
1820 will read that file (if available) instead of parsing the document.
1821 - exiting Emacs or killing a buffer in `reftex-mode' will cause a new version
1822 of the file to be written."
1827 "File extension for the file in which parser information is stored.
1828 This extension is added to the base name of the master file."
1833 "Non-nil means use a separate selection buffer for each label type.
1834 These buffers are kept from one selection to the next and need not to be
1835 created for each use - so the menu generally comes up faster. The
1836 selection buffers will be erased (and therefore updated) automatically
1837 when new labels in its category are added. See the variable
1838 `reftex-auto-update-selection-buffers'."
1844 "Non-nil means, selection buffers will be updated automatically.
1845 When a new label is defined with `reftex-label', all selection buffers
1846 associated with that label category are emptied, in order to force an
1847 update upon next use. When nil, the buffers are left alone and have to be
1848 updated by hand, with the `g' key from the label selection process.
1849 The value of this variable will only have any effect when
1850 `reftex-use-multiple-selection-buffers' is non-nil."
1855 ;; Fontification and Faces ----------------------------------------------
1858 "Options concerning the faces used in RefTeX."
1863 "Non-nil means, use fonts in *toc* and selection buffers.
1864 Font-lock must be loaded as well to actually get fontified display.
1865 When changing this option, a rescan may be necessary to activate the change."
1870 "Non-nil means, re-fontify the context in the label menu with font-lock.
1871 This slightly slows down the creation of the label menu. It is only necessary
1872 when you definitely want the context fontified.
1874 This option may have 3 different values:
1875 nil Never refontify.
1876 t Always refontify.
1877 1 Refontify when absolutely necessary, e.g. when old versions of X-Symbol.
1878 The option is ignored when `reftex-use-fonts' is nil."
1887 "Non-nil mean, highlight selected text in selection and *toc* buffers.
1888 Normally, the text near the cursor is the selected text, and it is
1889 highlighted. This is the entry most keys in the selection and *toc*
1890 buffers act on. However, if you mainly use the mouse to select an
1891 item, you may find it nice to have mouse-triggered highlighting
1892 instead or as well. The variable may have one of these values:
1894 nil No highlighting.
1895 cursor Highlighting is cursor driven.
1896 mouse Highlighting is mouse driven.
1897 both Both cursor and mouse trigger highlighting.
1899 Changing this variable requires to rebuild the selection and *toc* buffers
1900 to become effective (keys `g' or `r')."
1909 "Face name to highlight cursor selected item in toc and selection buffers.
1910 See also the variable `reftex-highlight-selection'."
1914 "Face name to highlight mouse selected item in toc and selection buffers.
1915 See also the variable `reftex-highlight-selection'."
1919 "Face name for file boundaries in selection buffer."
1923 "Face name for labels in selection buffer."
1927 "Face name for section headings in toc and selection buffers."
1931 "Face name for the header of a toc buffer."
1935 "Face name for author names in bib selection buffer."
1939 "Face name for year in bib selection buffer."
1943 "Face name for article title in bib selection buffer."
1947 "Face name for bibliographic information in bib selection buffer."
1951 "Face name for marked entries in the selection buffers."
1955 "Face name for the header of an index buffer."
1959 "Face name for the start of a new letter section in the index."
1963 "Face name for index names (for multiple indices)."
1967 "Face name for index entries."
1972 "X-Symbol specific hook.
1973 Functions get two arguments, the buffer from where the command started and a
1974 symbol indicating in what context the hook is called."
1978 ;; Miscellaneous configurations -----------------------------------------
1981 "Collection of further configurations."
1985 "Non-nil means, make additional key bindings on startup.
1986 These extra bindings are located in the users `C-c letter' map."
1991 "Plug-in flags for AUCTeX interface.
1992 This variable is a list of 5 boolean flags. When a flag is non-nil,
1993 RefTeX will
1995 - supply labels in new sections and environments (flag 1)
2001 You may also set the variable itself to t or nil in order to turn all
2002 plug-ins on or off, respectively.
2005 Supplying macro arguments applies when you insert such a macro interactively
2007 See the AUCTeX documentation for more information.
2008 RefTeX uses `fset' to take over the function calls. Changing the variable
2009 may require a restart of Emacs in order to become effective."
2025 "Non-nil means, allow arguments of macros to be detached by whitespace.
2033 "Hook which is being run when loading reftex.el."
2038 "Hook which is being run when turning on RefTeX mode."
2045 ;;; reftex-vars.el ends here