| blob | 01e8a1b4ddf05351de25e570fdba0355479045a6 |
1 ;;; reftex-vars.el --- configuration variables for RefTeX
2 ;; Copyright (c) 1997, 1998, 1999, 2003, 2004, 2005
3 ;; Free Software Foundation, Inc.
5 ;; Author: Carsten Dominik <dominik@science.uva.nl>
6 ;; Version: VERSIONTAG
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 2, or (at your option)
13 ;; 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; see the file COPYING If not, write to the
22 ;; Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
23 ;; Boston, MA 02110-1301, USA.
25 ;;; Commentary:
27 ;;; Code:
35 ;; Define the two constants which are needed during compilation
39 '(
40 ;; Some aliases, mostly for backward compatibility
44 amsmath))
46 ;; Individual package defaults
93 ;; The LaTeX core stuff
121 ;; The label macro is hard coded, but it *could* be defined like this:
122 ;;("\\label{*}" nil nil nil nil)
123 ))
125 )
126 "The default label environment descriptions.
127 Lower-case symbols correspond to a style file of the same name in the LaTeX
203 )
204 "Builtin versions of the citation format.
205 The following conventions are valid for all alist entries:
207 `?t' should point to a textual citation (citation as a noun).
224 "Builtin stuff for reftex-index-macros.
225 Lower-case symbols correspond to a style file of the same name in the LaTeX
227 )
229 ;; Configuration Variables and User Options for RefTeX ------------------
232 "LaTeX label and citation support."
242 ;; Table of contents configuration --------------------------------------
245 "A multifile table of contents browser."
249 "LaTeX commands which input another file.
250 The file name is expected after the command, either in braces or separated
251 by whitespace."
256 "Maximum depth of section levels in document structure.
257 Standard LaTeX needs default is 7, but there are packages for which this
258 needs to be larger."
262 ;; LaTeX section commands and level numbers
264 '(
274 ;;; ("minisec" . -7) ; KOMA-Script
275 )
276 "Commands and levels used for defining sections in the document.
277 This is an alist with each element like (COMMAND-NAME . LEVEL).
278 The car of each cons cell is the name of the section macro (without
279 the backslash). The cdr is a number indicating its level. A negative
280 level means the same level as the positive value, but the section will
281 never get a number. The cdr may also be a function which will be called
282 to after the section-re matched to determine the level.
283 This list is also used for promotion and demption of sectioning commands.
284 If you are using a document class which has several sets of sectioning
285 commands, promotion only works correctly if this list is sorted first
286 by set, then within each set by level. The promotion commands always
287 select the nearest entry with the correct new level."
297 "*The maximum level of toc entries which will be included in the TOC.
298 Section headings with a bigger level will be ignored. In RefTeX, chapters
299 are level 1, sections are level 2 etc.
300 This variable can be changed from within the *toc* buffer with the `t' key."
306 This means, part numbers will be included in the numbering of chapters, and
307 chapter counters will be reset for each part.
308 When nil (the default), parts are special, do not reset the chapter counter
309 and also do not show up in chapter numbers."
315 "*Non-nil means, turn automatic recentering of *TOC* window on.
316 When active, the *TOC* window will always show the section you
317 are currently working in. Recentering happens whenever Emacs is idle for
318 more than `reftex-idle-time' seconds.
320 Value t means, turn on immediately when RefTeX gets started. Then,
321 recentering will work for any toc window created during the session.
323 Value 'frame (the default) means, turn automatic recentering on only while the
324 dedicated TOC frame does exist, and do the recentering only in that frame. So
326 automatic recentering is turned on. When the frame gets destroyed, automatic
327 recentering is turned off again.
329 This feature can be turned on and off from the menu
330 \(Ref->Options)."
338 "*Non-nil means, create TOC window by splitting window horizontally."
343 "*Fraction of the width or height of the frame to be used for TOC window.
344 See also `reftex-toc-split-windows-horizontally'."
352 "*Non-nil means, split the selected window to display the *toc* buffer.
353 This helps to keep the window configuration, but makes the *toc* small.
354 When nil, all other windows except the selected one will be deleted, so
355 that the *toc* window fills half the frame."
360 "*Non-nil means, include file boundaries in *toc* buffer.
361 This flag can be toggled from within the *toc* buffer with the `F' key."
366 "*Non-nil means, include labels in *toc* buffer.
367 This flag can be toggled from within the *toc* buffer with the `l' key."
372 "*Non-nil means, include index entries in *toc* buffer.
373 This flag can be toggled from within the *toc* buffer with the `i' key."
378 "*Non-nil means, promotion/demotion commands first prompt for confirmation.
379 When nil, the command is executed immediately. When this is an integer
380 N, ask for confirmation only if N or more section commands are going to be
381 changed."
389 "*Non-nil means, include context with labels in the *toc* buffer.
390 Context will only be shown when labels are visible as well.
391 This flag can be toggled from within the *toc* buffer with the `c' key."
396 "*Non-nil means, point in *toc* buffer will cause other window to follow.
397 The other window will show the corresponding part of the document.
398 This flag can be toggled from within the *toc* buffer with the `f' key."
403 "*Non-nil means, follow-mode will revisit files if necessary.
404 When nil, follow-mode will be suspended for stuff in unvisited files."
410 "Mode hook for reftex-toc-mode."
414 ;; Label Support Configuration
417 "Support for creation, insertion and referencing of labels in LaTeX."
421 "Definition of environments and macros to do with label."
426 rotating sidecap subfigure supertab wrapfig LaTeX)
427 "Default label alist specifications. LaTeX should always be the last entry.
428 The value of this variable is a list of symbols with associations in the
429 constant `reftex-label-alist-builtin'. Check that constant for a full list
430 of options."
435 :inline t
436 :greedy t
442 reftex-label-alist-builtin)))
447 This docstring is easier to understand after reading the configuration
448 examples in `reftex.el'. Looking at the builtin defaults in the constant
449 `reftex-label-alist-builtin' may also be instructive.
451 Set this variable to define additions and changes to the default. The only
452 things you MUST NOT change is that `?s' is the type indicator for section
453 labels, and SPC for the `any' label type. These are hard-coded at other
454 places in the code.
456 The value of the variable must be a list of items. Each item is a list
457 itself and has the following structure:
459 (ENV-OR-MACRO TYPE-KEY LABEL-PREFIX REFERENCE-FORMAT CONTEXT-METHOD
460 (MAGIC-WORD ... ) TOC-LEVEL)
462 Each list entry describes either an environment carrying a counter for use
464 one of its arguments. The elements of each list entry are:
466 ENV-OR-MACRO
468 For macros, indicate the macro arguments for best results, as in
470 a star to mark the label argument, if any. The macro does not have to
472 its arguments.
473 Special names: `section' for section labels, `any' to define a group
474 which contains all labels.
476 This may also be a function to do local parsing and identify point
477 to be in a non-standard label environment. The function must take
478 an argument BOUND and limit backward searches to this value. It
479 should return either nil or a cons cell (FUNCTION . POSITION) with
480 the function symbol and the position where the special environment
481 starts. See the Info documentation for an example.
483 Finally this may also be nil if the entry is only meant to change
484 some settings associated with the type indicator character (see below).
486 TYPE-KEY
487 Type indicator character, like `?t', must be a printable ASCII character.
488 The type indicator is a single character which defines a label type.
489 Any label inside the environment or macro is assumed to belong to this
490 type. The same character may occur several times in this list, to cover
491 cases in which different environments carry the same label type (like
492 `equation' and `eqnarray').
493 If the type indicator is nil and the macro has a label argument {*},
495 the reminder of this entry is ignored.
497 LABEL-PREFIX
499 The prefix is a short string used as the start of a label. It may be the
500 empty string. The prefix may contain the following `%' escapes:
501 %f Current file name with directory and extension stripped.
502 %F Current file name relative to directory of master file.
503 %m Master file name, directory and extension stripped.
504 %M Directory name (without path) where master file is located.
505 %u User login name, on systems which support this.
506 %S A section prefix derived with variable `reftex-section-prefixes'.
510 REFERENCE-FORMAT
511 Format string for reference insert in buffer. `%s' will be replaced by
512 the label.
513 When the format starts with `~', the `~' will only be inserted if
514 there is not already a whitespace before point.
516 CONTEXT-METHOD
517 Indication on how to find the short context.
519 - If t, use
520 - the section heading for section labels.
522 (not a good choice for environments like eqnarray or enumerate,
523 where one has several labels in a single environment).
524 - text after the macro name (starting with the first arg) for macros.
525 - If an integer, use the nth argument of the macro. As a special case,
526 1000 means to get text after the last macro argument.
527 - If a string, use as regexp to search *backward* from the label. Context
528 is then the text following the end of the match. E.g. putting this to
530 environment.
532 - If any of `caption', `item', `eqnarray-like', `alignat-like', this
533 symbol will internally be translated into an appropriate regexp
534 (see also the variable `reftex-default-context-regexps').
535 - If a function, call this function with the name of the environment/macro
537 function is expected to return a suitable context string. It should
538 throw an exception (error) when failing to find context.
539 As an example, here is a function returning the 10 chars following
540 the label macro as context:
542 (defun my-context-function (env-or-mac)
543 (if (> (point-max) (+ 10 (point)))
544 (buffer-substring (point) (+ 10 (point)))
547 Label context is used in two ways by RefTeX: For display in the label
548 menu, and to derive a label string. If you want to use a different
549 method for each of these, specify them as a dotted pair.
550 E.g. `(nil . t)' uses the text after the label (nil) for display, and
551 text from the default position (t) to derive a label string. This is
552 actually used for section labels.
554 MAGIC-WORDS
555 List of magic words which identify a reference to be of this type.
556 If the word before point is equal to one of these words when calling
557 `reftex-reference', the label list offered will be automatically
558 restricted to labels of the correct type.
559 If the first element of this wordlist is the symbol `regexp', the
560 strings are interpreted as regular expressions. RefTeX will add
563 TOC-LEVEL
564 The integer level at which this environment should be added to the
565 table of contents. See also `reftex-section-levels'. A positive
566 value will number the entries mixed with the sectioning commands of
567 the same level. A negative value will make unnumbered entries.
568 Useful only for theorem-like environments, will be ignored for macros.
569 When omitted or nil, no TOC entries will be made.
571 If the type indicator characters of two or more entries are the same, RefTeX
572 will use
573 - the first non-nil format and prefix
574 - the magic words of all involved entries.
576 Any list entry may also be a symbol. If that has an association in
577 `reftex-label-alist-builtin', the cddr of that association is spliced into the
578 list. However, builtin defaults should normally be set with the variable
579 `reftex-default-label-alist-entries."
582 :type
617 :value AMSTeX
622 reftex-label-alist-builtin)))))
625 "Prefixes for section labels.
626 When the label prefix given in an entry in `reftex-label-alist' contains `%S',
627 this list is used to determine the correct prefix string depending on the
628 current section level.
629 The list is an alist, with each entry of the form (KEY . PREFIX)
630 Possible keys are sectioning macro names like `chapter', section levels
631 \(as given in `reftex-section-levels'), and t for the default."
646 "Alist with default regular expressions for finding context.
647 The form (format regexp (regexp-quote environment)) is used to calculate
648 the final regular expression - so %s will be replaced with the environment
649 or macro."
654 "Non-nil means, trust the label prefix when determining label type.
655 It is customary to use special label prefixes to distinguish different label
656 types. The label prefixes have no syntactic meaning in LaTeX (unless
657 special packages like fancyref are being used). RefTeX can and by
658 default does parse around each label to detect the correct label type,
659 but this process can be slow when a document contains thousands of
660 labels. If you use label prefixes consistently, you may speed up
661 document parsing by setting this variable to a non-nil value. RefTeX
662 will then compare the label prefix with the prefixes found in
663 `reftex-label-alist' and derive the correct label type in this way.
664 Possible values for this option are:
666 t This means to trust any label prefixes found.
667 regexp If a regexp, only prefixes matched by the regexp are trusted.
668 list List of accepted prefixes, as strings. The colon is part of
670 nil Never trust a label prefix.
672 The only disadvantage of using this feature is that the label context
673 displayed in the label selection buffer along with each label is
674 simply some text after the label definition. This is no problem if you
675 place labels keeping this in mind (e.g. *before* the equation, *at
676 the beginning* of a fig/tab caption ...). Anyway, it is probably best
677 to use the regexp or the list value types to fine-tune this feature.
678 For example, if your document contains thousands of footnotes with
681 non-footnote labels."
691 "List of functions to be called when trying to figure out current environment.
694 use such non-standard ways to set up environment-like constructs. The
695 purpose of each function in this list is to detect if point is
697 carries a label, you must also set up an entry for it in
698 `reftex-label-alist'.
700 The function should check if point is currently in the special
701 environment it was written to detect. If so, the function must return
702 a cons cell (NAME . POSITION). NAME is the name of the environment
703 detected and POSITION is the buffer position where the environment
704 starts. The function must return nil on failure to detect the
705 environment.
707 The function must take an argument BOUND. If non-nil, BOUND is a
708 boundary for backwards searches which should be observed.
710 Here is an example. The LaTeX package linguex.sty defines list macros
712 line.
718 ... more text after the empty line terminating all lists
720 And here is the setup for RefTeX:
722 1. Define a dummy environment for this in `reftex-label-alist'. Dummy means,
726 (setq reftex-label-alist
729 2. Write a function to detect the list macros and the determinators as well.
731 (defun my-detect-linguex-list (bound)
732 (let ((pos (point)) p1)
733 (save-excursion
734 ;; Search for any of the linguex item macros at the beginning of a line
735 (if (re-search-backward
737 (progn
738 (setq p1 (match-beginning 1))
741 ;; Return nil because list was already closed
742 nil
743 ;; OK, we got it
745 ;; Return nil for not found
746 nil))))
748 3. Tell RefTeX to use this function
750 (setq reftex-special-environment-functions '(my-detect-linguex-list))
751 "
755 ;; Label insertion
758 "Options on how to create new labels."
762 "Flags governing label insertion. First flag DERIVE, second flag PROMPT.
764 If DERIVE is t, RefTeX will try to derive a sensible label from context.
765 A section label for example will be derived from the section heading.
766 The conversion of the context to a valid label is governed by the
767 specifications given in `reftex-derive-label-parameters'.
768 If RefTeX fails to derive a label, it will prompt the user.
769 If DERIVE is nil, the label generated will consist of the prefix and a
770 unique number, like `eq:23'.
772 If PROMPT is t, the user will be prompted for a label string. The prompt will
773 already contain the prefix, and (if DERIVE is t) a default label derived from
774 context. When PROMPT is nil, the default label will be inserted without
775 query.
777 So the combination of DERIVE and PROMPT controls label insertion. Here is a
778 table describing all four possibilities:
780 DERIVE PROMPT ACTION
781 -------------------------------------------------------------------------
782 nil nil Insert simple label, like eq:22 or sec:13. No query.
783 nil t Prompt for label.
784 t nil Derive a label from context and insert without query.
785 t t Derive a label from context and prompt for confirmation.
787 Each flag may be set to t, nil, or a string of label type letters
788 indicating the label types for which it should be true. The strings work
789 like character classes.
790 Thus, the combination may be set differently for each label type. The
792 \(with confirmation). Prompt for figure and table labels. Use simple labels
793 without confirmation for everything else.
794 The available label types are: s (section), f (figure), t (table), i (item),
795 e (equation), n (footnote), N (endnote), plus any definitions in
796 `reftex-label-alist'."
809 "Function to turn an arbitrary string into a valid label.
810 RefTeX's default function uses the variable `reftex-derive-label-parameters'."
815 "Filter function which will process a context string before it is used
816 to derive a label from it. The intended application is to convert ISO or
817 Mule characters into something valid in labels. The default function
818 removes the accents from Latin-1 characters. X-Symbol (>=2.6) sets this
819 variable to the much more general `x-symbol-translate-to-ascii'."
825 "Parameters for converting a string into a label.
826 This variable is a list of the following items.
828 NWORDS Number of words to use.
829 MAXCHAR Maximum number of characters in a label string.
830 INVALID nil: Throw away any words containing characters invalid in labels.
831 t: Throw away only the invalid characters, not the whole word.
832 ABBREV nil: Never abbreviate words.
833 t: Always abbreviate words (see `reftex-abbrev-parameters').
834 not t and not nil: Abbreviate words if necessary to shorten
835 label string below MAXCHAR.
836 SEPARATOR String separating different words in the label.
837 IGNOREWORDS List of words which should not be part of labels.
838 DOWNCASE t: Downcase words before using them."
856 "Regexp matching characters not valid in labels."
861 "Parameters for abbreviation of words.
862 This variable is a list of the following items.
864 MIN-CHARS Minimum number of characters remaining after abbreviation.
865 MIN-KILL Minimum number of characters to remove when abbreviating words.
866 BEFORE Character class before abbrev point in word.
867 AFTER Character class after abbrev point in word."
876 "Function which produces the string to insert as a label definition.
877 Normally should be nil, unless you want to do something fancy.
878 The function will be called with two arguments, the LABEL and the DEFAULT
880 string to insert into the buffer."
884 ;; Label referencing
887 "Options on how to reference labels."
897 "List of flags governing the label menu makeup.
898 The flags are:
900 TABLE-OF-CONTENTS Show the labels embedded in a table of context.
901 SECTION-NUMBERS Include section numbers (like 4.1.3) in table of contents.
902 COUNTERS Show counters. This just numbers the labels in the menu.
903 NO-CONTEXT Non-nil means do NOT show the short context.
904 FOLLOW Follow full context in other window.
905 SHOW-COMMENTED Show labels from regions which are commented out.
906 MATCH-IN-TOC Obsolete flag.
907 SHOW FILES Show begin and end of included files.
909 Each of these flags can be set to t or nil, or to a string of type letters
910 indicating the label types for which it should be true. These strings work
911 like character classes in regular expressions. Thus, setting one of the
914 The available label types are: s (section), f (figure), t (table), i (item),
915 e (equation), n (footnote), plus any definitions in `reftex-label-alist'.
917 Most options can also be switched from the label menu itself - so if you
918 decide here to not have a table of contents in the label menu, you can still
919 get one interactively during selection from the label menu."
921 :type
933 "Punctuation strings for multiple references.
934 When marking is used in the selection buffer to select several references,
935 this variable associates the 3 marking characters `,-+' with prefix strings
937 This is used to string together whole reference sets, like
938 `eqs. 1,2,3-5,6 and 7' in a single call to `reftex-reference'. See manual."
944 In the selection buffer, the `v' key toggles the reference macro between
946 which is active when entering the selection process.
947 Instead of nil or t, this may also be a string of type letters indicating
948 the label types for which it should be true."
954 In the selection buffer, the `V' key toggles the reference macro between
956 the default which is active when entering the selection process.
957 Instead of nil or t, this may also be a string of type letters indicating
958 the label types for which it should be true."
963 "*Number of spaces to be used for indentation per section level."
968 "*Non-nil means, `reftex-reference' will try to guess the label type.
969 To do that, RefTeX will look at the word before the cursor and compare it with
970 the words given in `reftex-label-alist'. When it finds a match, RefTeX will
971 immediately offer the correct label menu - otherwise it will prompt you for
972 a label type. If you set this variable to nil, RefTeX will always prompt."
977 "Function which produces the string to insert as a reference.
978 Normally should be nil, because the format to insert a reference can
979 already be specified in `reftex-label-alist'.
981 references, so even if you set this, your setting will be ignored by
982 the special commands.
983 The function will be called with two arguments, the LABEL and the DEFAULT
985 string to insert into the buffer."
990 "Mode hook for reftex-select-label-mode."
994 ;; BibteX citation configuration ----------------------------------------
997 "Support for referencing bibliographic data with BibTeX."
1001 "LaTeX commands which specify the BibTeX databases to use with the document."
1009 File names matched by these regexps will not be parsed by RefTeX.
1010 Intended for files which contain only `@string' macro definitions and the
1011 like, which are ignored by RefTeX anyway."
1017 "*List of BibTeX database files which should be used if none are specified.
1018 When `reftex-citation' is called from a document which has neither a
1020 RefTeX will scan these files instead. Intended for using `reftex-citation'
1021 in non-LaTeX files. The files will be searched along the BIBINPUTS or TEXBIB
1022 path."
1027 "*Sorting of the entries found in BibTeX databases by reftex-citation.
1028 Possible values:
1029 nil Do not sort entries.
1030 'author Sort entries by author name.
1031 'year Sort entries by increasing year.
1032 'reverse-year Sort entries by decreasing year."
1040 "*The format of citations to be inserted into the buffer.
1041 It can be a string or an alist or a symbol. In the simplest case this
1043 definition of `reftex-cite-format-builtin' for more complex examples.
1045 If `reftex-cite-format' is a string, it will be used as the format.
1046 In the format, the following percent escapes will be expanded.
1048 %l The BibTeX label of the citation.
1049 %a List of author names, see also `reftex-cite-punctuation'.
1050 %2a Like %a, but abbreviate more than 2 authors like Jones et al.
1051 %A First author name only.
1052 %e Works like %a, but on list of editor names. (%2e and %E work a well)
1054 It is also possible to access all other BibTeX database fields:
1055 %b booktitle %c chapter %d edition %h howpublished
1056 %i institution %j journal %k key %m month
1057 %n number %o organization %p pages %P first page
1058 %r address %s school %u publisher %t title
1059 %v volume %y year
1060 %B booktitle, abbreviated %T title, abbreviated
1062 Usually, only %l is needed. The other stuff is mainly for the echo area
1063 display, and for (setq reftex-comment-citations t).
1065 %< as a special operator kills punctuation and space around it after the
1066 string has been formatted.
1068 A pair of square brackets indicates an optional argument, and RefTeX
1069 will prompt for the values of these arguments.
1071 Beware that all this only works with BibTeX database files. When
1073 environment, only %l is available.
1075 If `reftex-cite-format' is an alist of characters and strings, the user
1076 will be prompted for a character to select one of the possible format
1077 strings.
1078 In order to configure this variable, you can either set
1079 `reftex-cite-format' directly yourself or set it to the SYMBOL of one of
1080 the predefined styles. The predefined symbols are those which have an
1081 association in the constant `reftex-cite-format-builtin'.
1082 E.g.: (setq reftex-cite-format 'natbib)"
1084 :type
1089 :value default
1095 reftex-cite-format-builtin))
1104 "*Non-nil means, prompt for empty optional arguments in cite macros.
1105 When an entry in `reftex-cite-format' ist given with square brackets to
1107 prompt for values. Possible values are:
1109 nil Never prompt for optional arguments
1110 t Always prompt
1111 maybe Prompt only if `reftex-citation' was called with C-u prefix arg
1113 Unnecessary empty optional arguments are removed before insertion into
1114 the buffer. See `reftex-cite-cleanup-optional-args'."
1122 "*Non-nil means, remove unnecessary empty optional arguments in cite macros.
1123 The cite macros provided by some packages (for example
1124 natbib) allow specifying two optional arguments, one for a prefix to
1125 the citation, and a second for a postfix. When only one optional
1126 argument is given, it is interpreted as postfix. When this option is
1127 t, RefTeX removes unnecessary empty optional arguments from the cite
1128 macro before insertion. For example, it will change
1133 Is is possible that other packages have other conventions about which
1134 optional argument is interpreted how - that is why this cleaning up
1135 can be turned off."
1140 "*Non-nil means add a comment for each citation describing the full entry.
1141 The comment is formatted according to `reftex-cite-comment-format'."
1147 "Citation format used for commented citations. Must NOT contain %l.
1148 See the variable `reftex-cite-format' for possible percent escapes."
1153 "Citation format used to display citation info in the message area.
1154 Must NOT contain %l. See the variable `reftex-cite-format' for
1155 possible percent escapes."
1161 "Punctuation for formatting of name lists in citations.
1162 This is a list of 3 strings.
1173 "Function which produces the string to insert as a citation.
1174 Normally should be nil, because the format to insert a reference can
1175 already be specified in `reftex-cite-format'.
1176 The function will be called with two arguments, the CITATION KEY and the
1177 DEFAULT FORMAT, which is taken from `reftex-cite-format'. The function
1178 should return the string to insert into the buffer."
1183 "Mode hook for reftex-select-bib-mode."
1187 ;; Index Support Configuration
1190 "Support for viewing and editing the index."
1194 "*Non-nil means, index entries are parsed as well.
1195 Index support is resource intensive and the internal structure holding the
1196 parsed information can become quite big. Therefore it can be turned off.
1197 When this is nil and you execute a command which requires index support,
1198 you will be asked for confirmation to turn it on and rescan the document."
1203 "Special characters in index entries. The value is a list of five strings.
1204 These correspond to the makeindex keywords LEVEL ENCAP ACTUAL QUOTE ESCAPE."
1214 "Macros which define index entries. The structure is
1216 \(MACRO INDEX-TAG KEY PREFIX EXCLUDE REPEAT)
1218 MACRO is the macro. Arguments should be denoted by empty braces like
1220 marks where the index key is.
1223 reserved for the default index and the glossary. Other indices can be
1224 defined as well. If this is an integer, the Nth argument of the macro
1225 holds the index tag.
1227 KEY is a character which is used to identify the macro for input with
1230 PREFIX can be a prefix which is added to the KEY part of the index entry.
1234 EXCLUDE can be a function. If this function exists and returns a non-nil
1235 value, the index entry at point is ignored. This was implemented to support
1236 the (deprecated) `^' and `_' shortcuts in the LaTeX2e `index' package.
1238 REPEAT, if non-nil, means the index macro does not typeset the entry in
1239 the text, so that the text has to be repeated outside the index macro.
1240 Needed for `reftex-index-selection-or-word' and for indexing from the
1241 phrase buffer.
1243 The final entry may also be a symbol if this entry has a association
1244 in the variable `reftex-index-macros-builtin' to specify the main
1245 indexing package you are using. Valid values are currently
1246 default The LaTeX default - unnecessary to specify this one
1247 multind The multind.sty package
1248 index The index.sty package
1249 index-shortcut The index.sty packages with the ^ and _ shortcuts.
1250 Should not be used - only for old documents.
1251 Note that AUCTeX sets these things internally for RefTeX as well, so
1252 with a sufficiently new version of AUCTeX, you should not set the
1253 package here."
1258 :inline t
1271 :value index
1277 reftex-index-macros-builtin)))))
1281 This is a list with (MACRO-KEY DEFAULT-TAG).
1283 MACRO-KEY: Character identifying an index macro - see `reftex-index-macros'.
1284 DEFAULT-TAG: This is the tag to be used if the macro requires a TAG argument.
1285 When this is nil and a TAG is needed, RefTeX will ask for it.
1286 When this is the empty string and the TAG argument of the index
1287 macro is optional, the TAG argument will be omitted."
1296 "Default index tag.
1297 When working with multiple indexes, RefTeX queries for an index tag when
1298 creating index entries or displaying a specific index. This variable controls
1299 the default offered for these queries. The default can be selected with RET
1300 during selection or completion. Valid values of this variable are:
1302 nil Do not provide a default index
1304 last The last used index tag will be offered as default."
1312 "Format of index entries when copied from inside math mode.
1313 When `reftex-index-selection-or-word' is executed inside TeX math mode,
1314 the index key copied from the buffer is processed with this format string
1315 through the `format' function. This can be used to add the math delimiters
1316 \(e.g. `$') to the string.
1317 Requires the `texmathp.el' library which is part of AUCTeX."
1322 "File extension for the index phrase file.
1323 This extension will be added to the base name of the master file."
1328 "Regexp matching the `and' operator for index arguments in phrases file.
1329 When several index arguments in a phrase line are separated by this
1330 operator, each part will generate an index macro. So each match of
1331 the search phrase will produce *several* different index entries.
1333 Note: make sure this does no match things which are not separators.
1334 This logical `and' has higher priority than the logical `or' specified in
1335 `reftex-index-phrases-logical-or-regexp'."
1340 "Regexp matching the `or' operator for index arguments in phrases file.
1341 When several index arguments in a phrase line are separated by this
1342 operator, the user will be asked to select one of them at each match
1343 of the search phrase. The first index arg will be the default - a
1344 number key 1-9 must be pressed to switch to another.
1346 Note: make sure this does no match things which are not separators.
1347 The logical `and' specified in `reftex-index-phrases-logical-or-regexp'
1348 has higher priority than this logical `or'."
1353 "*Non-nil means phrases search will look for whole words, not subwords.
1354 This works by requiring word boundaries at the beginning and end of
1355 the search string. When the search phrase already has a non-word-char
1356 at one of these points, no word boundary is required there."
1361 "*Non-nil means, searching for index phrases will ignore case."
1366 "A function which is called at each match during global indexing.
1367 If the function returns nil, the current match is skipped."
1374 "*Non-nil means, skip matches which appear to be indexed already.
1375 When doing global indexing from the phrases buffer, searches for some
1376 phrases may match at places where that phrase was already indexed. In
1377 particular when indexing an already processed document again, this
1378 will even be the norm. When this variable is non-nil, RefTeX checks if
1379 the match is inside an index macro argument, or if an index macro is directly
1380 before or after the phrase. If that is the case, that match will
1381 be ignored."
1386 "*Non-nil means, when indexing from the phrases buffer, wrap lines.
1387 Inserting indexing commands in a line makes the line longer - often
1388 so long that it does not fit onto the screen. When this variable is
1389 non-nil, newlines will be added as necessary before and/or after the
1390 indexing command to keep lines short. However, the matched text
1391 phrase and its index command will always end up on a single line."
1396 "*Non-nil means when sorting phrase lines, the explicit index entry is used.
1397 Phrase lines in the phrases buffer contain a search phrase, and
1398 sorting is normally based on these. Some phrase lines also have
1399 an explicit index argument specified. When this variable is non-nil,
1400 the index argument will be used for sorting."
1405 "*Non-nil means, empty and comment lines separate phrase buffer into blocks.
1406 Sorting will then preserve blocks, so that lines are re-arranged only
1407 within blocks."
1412 "The letters which denote sections in the index.
1413 Usually these are all capital letters. Don't use any downcase letters.
1414 Order is not significant, the index will be sorted by whatever the sort
1415 function thinks is correct.
1416 In addition to these letters, RefTeX will create a group `!' which
1417 contains all entries sorted below the lowest specified letter.
1418 In the index buffer, pressing any of these capital letters or `!' will jump
1419 to that section."
1424 "*Non-nil means, display the index definition context in the index buffer.
1425 This flag may also be toggled from the index buffer with the `c' key."
1430 "*Non-nil means, point in *Index* buffer will cause other window to follow.
1431 The other window will show the corresponding part of the document.
1432 This flag can be toggled from within the *Index* buffer with the `f' key."
1436 ;; Viewing Cross References
1439 "Displaying cross references and citations."
1443 "Macros which can be used for the display of cross references.
1444 This is used when `reftex-view-crossref' is called with point in an
1445 argument of a macro. Note that crossref viewing for citations,
1446 references (both ways) and index entries is hard-coded. This variable
1447 is only to configure additional structures for which crossreference
1448 viewing can be useful. Each entry has the structure
1450 \(MACRO-RE SEARCH-RE HIGHLIGHT).
1452 MACRO-RE is matched against the macro. SEARCH-RE is the regexp used
1453 to search for cross references. `%s' in this regexp is replaced with
1454 with the macro argument at point. HIGHLIGHT is an integer indicating
1455 which subgroup of the match should be highlighted."
1462 "*Non-nil means, initially turn automatic viewing of crossref info on.
1463 Automatic viewing of crossref info normally uses the echo area.
1464 Whenever point is idle for more than `reftex-idle-time' seconds on the
1466 displayed, the echo area will display information about that cross
1467 reference. You can also set the variable to the symbol `window'. In
1468 this case a small temporary window is used for the display.
1469 This feature can be turned on and off from the menu
1470 \(Ref->Options)."
1477 "*Time (secs) Emacs has to be idle before automatic crossref display is done.
1478 Applies also to toc recentering."
1483 "*Non-nil means, automatic citation display will revisit files if necessary.
1484 When nil, citation display in echo area will only be active for cached
1485 entries and for BibTeX database files with live associated buffers."
1490 "*Non-nil means, the information displayed in the echo area for cite macros
1491 is cached and even saved along with the parsing information. The cache
1492 survives document scans. In order to clear it, use M-x reftex-reset-mode."
1497 "Normal Hook which is run before context is displayed anywhere. Designed
1498 for X-Symbol, but may have other uses as well."
1503 ;; Finding Files --------------------------------------------------------
1506 "Finding files on search paths."
1510 "*List of specifications how to retrieve the search path for TeX files.
1511 Several entries are possible.
1512 - If an element is the name of an environment variable, its content is used.
1513 - If an element starts with an exclamation mark, it is used as a command
1514 to retrieve the path. A typical command with the kpathsearch library would
1515 be `!kpsewhich -show-path=.tex'.
1516 - Otherwise the element itself is interpreted as a path.
1517 Multiple directories can be separated by the system dependent `path-separator'.
1518 Directories ending in `//' or `!!' will be expanded recursively.
1519 See also `reftex-use-external-file-finders'."
1525 "*List of specifications how to retrieve search path for .bib database files.
1526 Several entries are possible.
1527 - If an element is the name of an environment variable, its content is used.
1528 - If an element starts with an exclamation mark, it is used as a command
1529 to retrieve the path. A typical command with the kpathsearch library would
1530 be `!kpsewhich -show-path=.bib'.
1531 - Otherwise the element itself is interpreted as a path.
1532 Multiple directories can be separated by the system dependent `path-separator'.
1533 Directories ending in `//' or `!!' will be expanded recursively.
1534 See also `reftex-use-external-file-finders'."
1542 "*Association list with file extensions for different file types.
1543 This is a list of items, each item is like: (TYPE . (DEF-EXT OTHER-EXT ...))
1547 OTHER-EXT: Any number of other valid extensions for this file type.
1549 When a files is searched and it does not have any of the legal extensions,
1550 we try the default extension first, and then the naked file name.
1552 If you are using AUCTeX, you also need to add new extensions to
1553 TeX-file-extensions."
1559 "*Non-nil means, search all specified directories before trying recursion.
1563 time the recursive path is for the system files and not for the user files.
1564 Set this to nil if the default makes RefTeX finding files with equal names
1565 in wrong sequence."
1570 "*Non-nil means, use external programs to find files.
1571 Normally, RefTeX searches the paths given in the environment variables
1572 TEXINPUTS and BIBINPUTS to find TeX files and BibTeX database files.
1573 With this option turned on, it calls an external program specified in the
1574 option `reftex-external-file-finders' instead. As a side effect,
1575 the variables `reftex-texpath-environment-variables' and
1576 `reftex-bibpath-environment-variables' will be ignored."
1582 "*Association list with external programs to call for finding files.
1583 Each entry is a cons cell (TYPE . PROGRAM).
1585 any arguments. %f will be replaced by the name of the file to be found.
1586 Note that these commands will be executed directly, not via a shell.
1587 Only relevant when `reftex-use-external-file-finders' is non-nil."
1592 ;; Tuning the parser ----------------------------------------------------
1595 "Configuration of parser speed and memory usage."
1599 "*Non-nil means, keep buffers created for parsing and lookup.
1600 RefTeX sometimes needs to visit files related to the current document.
1601 We distinguish files visited for
1602 PARSING: Parts of a multifile document loaded when (re)-parsing the document.
1603 LOOKUP: BibTeX database files and TeX files loaded to find a reference,
1604 to display label context, etc.
1605 The created buffers can be kept for later use, or be thrown away immediately
1606 after use, depending on the value of this variable:
1608 nil Throw away as much as possible.
1609 t Keep everything.
1610 1 Throw away buffers created for parsing, but keep the ones created
1611 for lookup.
1613 If a buffer is to be kept, the file is visited normally (which is potentially
1614 slow but will happen only once).
1615 If a buffer is to be thrown away, the initialization of the buffer depends
1616 upon the variable `reftex-initialize-temporary-buffers'."
1624 "*Non-nil means do initializations even when visiting file temporarily.
1625 When nil, RefTeX may turn off find-file hooks and other stuff to briefly
1626 visit a file.
1627 When t, the full default initializations are done (find-file-hook etc.).
1628 Instead of t or nil, this variable may also be a list of hook functions to
1629 do a minimal initialization."
1638 "*List of regular expressions to exclude certain input files from parsing.
1640 of the regular expressions in this list, that file is not parsed by RefTeX."
1645 "*Non-nil means, re-parse only 1 file when asked to re-parse.
1646 Re-parsing is normally requested with a `C-u' prefix to many RefTeX commands,
1647 or with the `r' key in menus. When this option is t in a multifile document,
1648 we will only parse the current buffer, or the file associated with the label
1649 or section heading near point in a menu. Requesting re-parsing of an entire
1650 multifile document then requires a `C-u C-u' prefix or the capital `R' key
1651 in menus."
1656 "*Non-nil means, RefTeX may rescan the document when this seems necessary.
1657 Currently this applies only to rescanning after label insertion, when
1658 the new label cannot be inserted correctly into the internal label
1659 list."
1664 "*Non-nil means, save information gathered with parsing in a file.
1665 The file MASTER.rel in the same directory as MASTER.tex is used to save the
1666 information. When this variable is t,
1667 - accessing the parsing information for the first time in an editing session
1668 will read that file (if available) instead of parsing the document.
1669 - exiting Emacs or killing a buffer in reftex-mode will cause a new version
1670 of the file to be written."
1675 "*File extension for the file in which parser information is stored.
1676 This extension is added to the base name of the master file."
1681 "*Non-nil means use a separate selection buffer for each label type.
1682 These buffers are kept from one selection to the next and need not to be
1683 created for each use - so the menu generally comes up faster. The
1684 selection buffers will be erased (and therefore updated) automatically
1685 when new labels in its category are added. See the variable
1686 `reftex-auto-update-selection-buffers'."
1692 "*Non-nil means, selection buffers will be updated automatically.
1693 When a new label is defined with `reftex-label', all selection buffers
1694 associated with that label category are emptied, in order to force an
1695 update upon next use. When nil, the buffers are left alone and have to be
1696 updated by hand, with the `g' key from the label selection process.
1697 The value of this variable will only have any effect when
1698 `reftex-use-multiple-selection-buffers' is non-nil."
1703 ;; Fontification and Faces ----------------------------------------------
1706 "Options concerning the faces used in RefTeX."
1711 "*Non-nil means, use fonts in *toc* and selection buffers.
1712 Font-lock must be loaded as well to actually get fontified display.
1713 When changing this option, a rescan may be necessary to activate the change."
1718 "*Non-nil means, re-fontify the context in the label menu with font-lock.
1719 This slightly slows down the creation of the label menu. It is only necessary
1720 when you definitely want the context fontified.
1722 This option may have 3 different values:
1723 nil Never refontify.
1724 t Always refontify.
1725 1 Refontify when absolutely necessary, e.g. when old versions of X-Symbol.
1726 The option is ignored when `reftex-use-fonts' is nil."
1735 "*Non-nil mean, highlight selected text in selection and *toc* buffers.
1736 Normally, the text near the cursor is the selected text, and it is
1737 highlighted. This is the entry most keys in the selction and *toc*
1738 buffers act on. However, if you mainly use the mouse to select an
1739 item, you may find it nice to have mouse-triggered highlighting
1740 instead or as well. The variable may have one of these values:
1742 nil No highlighting.
1743 cursor Highlighting is cursor driven.
1744 mouse Highlighting is mouse driven.
1745 both Both cursor and mouse trigger highlighting.
1747 Changing this variable requires to rebuild the selection and *toc* buffers
1748 to become effective (keys `g' or `r')."
1757 "Face name to highlight cursor selected item in toc and selection buffers.
1758 See also the variable `reftex-highlight-selection'."
1762 "Face name to highlight mouse selected item in toc and selection buffers.
1763 See also the variable `reftex-highlight-selection'."
1767 "Face name for file boundaries in selection buffer."
1771 "Face name for labels in selection buffer."
1775 "Face name for section headings in toc and selection buffers."
1779 "Face name for the header of a toc buffer."
1783 "Face name for author names in bib selection buffer."
1787 "Face name for year in bib selection buffer."
1791 "Face name for article title in bib selection buffer."
1795 "Face name for bibliographic information in bib selection buffer."
1799 "Face name for marked entries in the selection buffers."
1803 "Face name for the header of an index buffer."
1807 "Face name for the start of a new letter section in the index."
1811 "Face name for index names (for multiple indices)."
1815 "Face name for index entries."
1820 "X-Symbol specific hook.
1821 Functions get two arguments, the buffer from where the command started and a
1822 symbol indicating in what context the hook is called."
1826 ;; Miscellaneous configurations -----------------------------------------
1829 "Collection of further configurations."
1833 "Non-nil means, make additional key bindings on startup.
1834 These extra bindings are located in the users `C-c letter' map."
1839 "*Plug-in flags for AUCTeX interface.
1840 This variable is a list of 4 boolean flags. When a flag is non-nil,
1841 RefTeX will
1843 - supply labels in new sections and environments (flag 1)
1849 You may also set the variable itself to t or nil in order to turn all
1850 plug-ins on or off, respectively.
1853 Supplying macro arguments applies when you insert such a macro interactively
1855 See the AUCTeX documentation for more information.
1856 RefTeX uses `fset' to take over the function calls. Changing the variable
1857 may require a restart of Emacs in order to become effective."
1871 )))
1874 "*Non-nil means, allow arguments of macros to be detached by whitespace.
1882 "Hook which is being run when loading reftex.el."
1887 "Hook which is being run when turning on RefTeX mode."
1894 ;;; arch-tag: 9591ea34-ef39-4431-90b7-c115eaf5e16f
1895 ;;; reftex-vars.el ends here