| blob | 53357342c5144b4f4fa15eddb9f7267d97435ed2 |
1 ;;; reftex-vars.el --- configuration variables for RefTeX
2 ;; Copyright (c) 1997, 1998, 1999, 2003 Free Software Foundation, Inc.
4 ;; Author: Carsten Dominik <dominik@science.uva.nl>
5 ;; Version: 4.21
7 ;; This file is part of GNU Emacs.
9 ;; GNU Emacs is free software; you can redistribute it and/or modify
10 ;; it under the terms of the GNU General Public License as published by
11 ;; the Free Software Foundation; either version 2, or (at your option)
12 ;; any later version.
14 ;; GNU Emacs is distributed in the hope that it will be useful,
15 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
16 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE See the
17 ;; GNU General Public License for more details.
19 ;; You should have received a copy of the GNU General Public License
20 ;; along with GNU Emacs; see the file COPYING If not, write to the
21 ;; Free Software Foundation, Inc., 59 Temple Place - Suite 330,
22 ;; Boston, MA 02111-1307, USA.
24 ;;; Commentary:
26 ;;; Code:
34 ;; Define the two constants which are needed during compilation
38 '(
39 ;; Some aliases, mostly for backward compatibility
43 amsmath))
45 ;; Individual package defaults
92 ;; The LaTeX core stuff
120 ;; The label macro is hard coded, but it *could* be defined like this:
121 ;;("\\label{*}" nil nil nil nil)
122 ))
124 )
125 "The default label environment descriptions.
126 Lower-case symbols correspond to a style file of the same name in the LaTeX
187 )
188 "Builtin versions of the citation format.
189 The following conventions are valid for all alist entries:
191 `?t' should point to a textual citation (citation as a noun).
208 "Builtin stuff for reftex-index-macros.
209 Lower-case symbols correspond to a style file of the same name in the LaTeX
211 )
213 ;; Configuration Variables and User Options for RefTeX ------------------
216 "LaTeX label and citation support."
226 ;; Table of contents configuration --------------------------------------
229 "A multifile table of contents browser."
233 "LaTeX commands which input another file.
234 The file name is expected after the command, either in braces or separated
235 by whitespace."
240 "Maximum depth of section levels in document structure.
241 Standard LaTeX needs default is 7, but there are packages for which this
242 needs to be larger."
246 ;; LaTeX section commands and level numbers
248 '(
258 ;;; ("minisec" . -7) ; KOMA-Script
259 )
260 "Commands and levels used for defining sections in the document.
261 This is an alist with each element like (COMMAND-NAME . LEVEL).
262 The car of each cons cell is the name of the section macro (without
263 the backslash). The cdr is a number indicating its level. A negative
264 level means the same level as the positive value, but the section will
265 never get a number. The cdr may also be a function which will be called
266 to after the section-re matched to determine the level.
267 This list is also used for promotion and demption of sectioning commands.
268 If you are using a document class which has several sets of sectioning
269 commands, promotion only works correctly if this list is sorted first
270 by set, then within each set by level. The promotion commands always
271 select the nearest entry with the correct new level."
281 "*The maximum level of toc entries which will be included in the TOC.
282 Section headings with a bigger level will be ignored. In RefTeX, chapters
283 are level 1, sections are level 2 etc.
284 This variable can be changed from within the *toc* buffer with the `t' key."
290 This means, part numbers will be included in the numbering of chapters, and
291 chapter counters will be reset for each part.
292 When nil (the default), parts are special, do not reset the chapter counter
293 and also do not show up in chapter numbers."
299 "*Non-nil means, turn automatic recentering of *TOC* window on.
300 When active, the *TOC* window will always show the section you
301 are currently working in. Recentering happens whenever Emacs is idle for
302 more than `reftex-idle-time' seconds.
304 Value t means, turn on immediately when RefTeX gets started. Then,
305 recentering will work for any toc window created during the session.
307 Value 'frame (the default) means, turn automatic recentering on only while the
308 dedicated TOC frame does exist, and do the recentering only in that frame. So
310 automatic recentering is turned on. When the frame gets destroyed, automatic
311 recentering is turned off again.
313 This feature can be turned on and off from the menu
314 \(Ref->Options)."
322 "*Non-nil means, create TOC window by splitting window horizontally."
327 "*Fraction of the width or height of the frame to be used for TOC window.
328 See also `reftex-toc-split-windows-horizontally'."
336 "*Non-nil means, split the selected window to display the *toc* buffer.
337 This helps to keep the window configuration, but makes the *toc* small.
338 When nil, all other windows except the selected one will be deleted, so
339 that the *toc* window fills half the frame."
344 "*Non-nil means, include file boundaries in *toc* buffer.
345 This flag can be toggled from within the *toc* buffer with the `F' key."
350 "*Non-nil means, include labels in *toc* buffer.
351 This flag can be toggled from within the *toc* buffer with the `l' key."
356 "*Non-nil means, include index entries in *toc* buffer.
357 This flag can be toggled from within the *toc* buffer with the `i' key."
362 "*Non-nil means, promotion/demotion commands first prompt for confirmation.
363 When nil, the command is executed immediately. When this is an integer
364 N, ask for confirmation only if N or more section commands are going to be
365 changed."
373 "*Non-nil means, include context with labels in the *toc* buffer.
374 Context will only be shown when labels are visible as well.
375 This flag can be toggled from within the *toc* buffer with the `c' key."
380 "*Non-nil means, point in *toc* buffer will cause other window to follow.
381 The other window will show the corresponding part of the document.
382 This flag can be toggled from within the *toc* buffer with the `f' key."
387 "*Non-nil means, follow-mode will revisit files if necessary.
388 When nil, follow-mode will be suspended for stuff in unvisited files."
394 "Mode hook for reftex-toc-mode."
398 ;; Label Support Configuration
401 "Support for creation, insertion and referencing of labels in LaTeX."
405 "Definition of environments and macros to do with label."
410 rotating sidecap subfigure supertab wrapfig LaTeX)
411 "Default label alist specifications. LaTeX should always be the last entry.
412 The value of this variable is a list of symbols with associations in the
413 constant `reftex-label-alist-builtin'. Check that constant for a full list
414 of options."
419 :inline t
420 :greedy t
426 reftex-label-alist-builtin)))
431 This docstring is easier to understand after reading the configuration
432 examples in `reftex.el'. Looking at the builtin defaults in the constant
433 `reftex-label-alist-builtin' may also be instructive.
435 Set this variable to define additions and changes to the default. The only
436 things you MUST NOT change is that `?s' is the type indicator for section
437 labels, and SPC for the `any' label type. These are hard-coded at other
438 places in the code.
440 The value of the variable must be a list of items. Each item is a list
441 itself and has the following structure:
443 (ENV-OR-MACRO TYPE-KEY LABEL-PREFIX REFERENCE-FORMAT CONTEXT-METHOD
444 (MAGIC-WORD ... ) TOC-LEVEL)
446 Each list entry describes either an environment carrying a counter for use
448 one of its arguments. The elements of each list entry are:
450 ENV-OR-MACRO
452 For macros, indicate the macro arguments for best results, as in
454 a star to mark the label argument, if any. The macro does not have to
456 its arguments.
457 Special names: `section' for section labels, `any' to define a group
458 which contains all labels.
460 This may also be a function to do local parsing and identify point
461 to be in a non-standard label environment. The function must take
462 an argument BOUND and limit backward searches to this value. It
463 should return either nil or a cons cell (FUNCTION . POSITION) with
464 the function symbol and the position where the special environment
465 starts. See the Info documentation for an example.
467 Finally this may also be nil if the entry is only meant to change
468 some settings associated with the type indicator character (see below).
470 TYPE-KEY
471 Type indicator character, like `?t', must be a printable ASCII character.
472 The type indicator is a single character which defines a label type.
473 Any label inside the environment or macro is assumed to belong to this
474 type. The same character may occur several times in this list, to cover
475 cases in which different environments carry the same label type (like
476 `equation' and `eqnarray').
477 If the type indicator is nil and the macro has a label argument {*},
479 the reminder of this entry is ignored.
481 LABEL-PREFIX
483 The prefix is a short string used as the start of a label. It may be the
484 empty string. The prefix may contain the following `%' escapes:
485 %f Current file name with directory and extension stripped.
486 %F Current file name relative to directory of master file.
487 %u User login name, on systems which support this.
488 %S A section prefix derived with variable `reftex-section-prefixes'.
492 REFERENCE-FORMAT
493 Format string for reference insert in buffer. `%s' will be replaced by
494 the label.
495 When the format starts with `~', the `~' will only be inserted if
496 there is not already a whitespace before point.
498 CONTEXT-METHOD
499 Indication on how to find the short context.
501 - If t, use
502 - the section heading for section labels.
504 (not a good choice for environments like eqnarray or enumerate,
505 where one has several labels in a single environment).
506 - text after the macro name (starting with the first arg) for macros.
507 - If an integer, use the nth argument of the macro. As a special case,
508 1000 means to get text after the last macro argument.
509 - If a string, use as regexp to search *backward* from the label. Context
510 is then the text following the end of the match. E.g. putting this to
512 environment.
514 - If any of `caption', `item', `eqnarray-like', `alignat-like', this
515 symbol will internally be translated into an appropriate regexp
516 (see also the variable `reftex-default-context-regexps').
517 - If a function, call this function with the name of the environment/macro
519 function is expected to return a suitable context string. It should
520 throw an exception (error) when failing to find context.
521 As an example, here is a function returning the 10 chars following
522 the label macro as context:
524 (defun my-context-function (env-or-mac)
525 (if (> (point-max) (+ 10 (point)))
526 (buffer-substring (point) (+ 10 (point)))
529 Label context is used in two ways by RefTeX: For display in the label
530 menu, and to derive a label string. If you want to use a different
531 method for each of these, specify them as a dotted pair.
532 E.g. `(nil . t)' uses the text after the label (nil) for display, and
533 text from the default position (t) to derive a label string. This is
534 actually used for section labels.
536 MAGIC-WORDS
537 List of magic words which identify a reference to be of this type.
538 If the word before point is equal to one of these words when calling
539 `reftex-reference', the label list offered will be automatically
540 restricted to labels of the correct type.
541 If the first element of this wordlist is the symbol `regexp', the
542 strings are interpreted as regular expressions. RefTeX will add
545 TOC-LEVEL
546 The integer level at which this environment should be added to the
547 table of contents. See also `reftex-section-levels'. A positive
548 value will number the entries mixed with the sectioning commands of
549 the same level. A negative value will make unnumbered entries.
550 Useful only for theorem-like environments, will be ignored for macros.
551 When omitted or nil, no TOC entries will be made.
553 If the type indicator characters of two or more entries are the same, RefTeX
554 will use
555 - the first non-nil format and prefix
556 - the magic words of all involved entries.
558 Any list entry may also be a symbol. If that has an association in
559 `reftex-label-alist-builtin', the cddr of that association is spliced into the
560 list. However, builtin defaults should normally be set with the variable
561 `reftex-default-label-alist-entries."
564 :type
599 :value AMSTeX
604 reftex-label-alist-builtin)))))
607 "Prefixes for section labels.
608 When the label prefix given in an entry in `reftex-label-alist' contains `%S',
609 this list is used to determine the correct prefix string depending on the
610 current section level.
611 The list is an alist, with each entry of the form (KEY . PREFIX)
612 Possible keys are sectioning macro names like `chapter', section levels
613 \(as given in `reftex-section-levels'), and t for the default."
628 "Alist with default regular expressions for finding context.
629 The form (format regexp (regexp-quote environment)) is used to calculate
630 the final regular expression - so %s will be replaced with the environment
631 or macro."
636 "List of functions to be called when trying to figure out current environment.
639 use such non-standard ways to set up environment-like constructs. The
640 purpose of each function in this list is to detect if point is
642 carries a label, you must also set up an entry for it in
643 `reftex-label-alist'.
645 The function should check if point is currently in the special
646 environment it was written to detect. If so, the function must return
647 a cons cell (NAME . POSITION). NAME is the name of the environment
648 detected and POSITION is the buffer position where the environment
649 starts. The function must return nil on failure to detect the
650 environment.
652 The function must take an argument BOUND. If non-nil, BOUND is a
653 boundary for backwards searches which should be observed.
655 Here is an example. The LaTeX package linguex.sty defines list macros
657 line.
663 ... more text after the empty line terminating all lists
665 And here is the setup for RefTeX:
667 1. Define a dummy environment for this in `reftex-label-alist'. Dummy means,
671 (setq reftex-label-alist
674 2. Write a function to detect the list macros and the determinators as well.
676 (defun my-detect-linguex-list (bound)
677 (let ((pos (point)) p1)
678 (save-excursion
679 ;; Search for any of the linguex item macros at the beginning of a line
680 (if (re-search-backward
682 (progn
683 (setq p1 (match-beginning 1))
686 ;; Return nil because list was already closed
687 nil
688 ;; OK, we got it
690 ;; Return nil for not found
691 nil))))
693 3. Tell RefTeX to use this function
695 (setq reftex-special-environment-functions '(my-detect-linguex-list))
696 "
700 ;; Label insertion
703 "Options on how to create new labels."
707 "Flags governing label insertion. First flag DERIVE, second flag PROMPT.
709 If DERIVE is t, RefTeX will try to derive a sensible label from context.
710 A section label for example will be derived from the section heading.
711 The conversion of the context to a legal label is governed by the
712 specifications given in `reftex-derive-label-parameters'.
713 If RefTeX fails to derive a label, it will prompt the user.
714 If DERIVE is nil, the label generated will consist of the prefix and a
715 unique number, like `eq:23'.
717 If PROMPT is t, the user will be prompted for a label string. The prompt will
718 already contain the prefix, and (if DERIVE is t) a default label derived from
719 context. When PROMPT is nil, the default label will be inserted without
720 query.
722 So the combination of DERIVE and PROMPT controls label insertion. Here is a
723 table describing all four possibilities:
725 DERIVE PROMPT ACTION
726 -------------------------------------------------------------------------
727 nil nil Insert simple label, like eq:22 or sec:13. No query.
728 nil t Prompt for label.
729 t nil Derive a label from context and insert without query.
730 t t Derive a label from context and prompt for confirmation.
732 Each flag may be set to t, nil, or a string of label type letters
733 indicating the label types for which it should be true. The strings work
734 like character classes.
735 Thus, the combination may be set differently for each label type. The
737 \(with confirmation). Prompt for figure and table labels. Use simple labels
738 without confirmation for everything else.
739 The available label types are: s (section), f (figure), t (table), i (item),
740 e (equation), n (footnote), N (endnote), plus any definitions in
741 `reftex-label-alist'."
754 "Function to turn an arbitrary string into a legal label.
755 RefTeX's default function uses the variable `reftex-derive-label-parameters'."
760 "Filter function which will process a context string before it is used
761 to derive a label from it. The intended application is to convert ISO or
762 Mule characters into something legal in labels. The default function
763 removes the accents from Latin-1 characters. X-Symbol (>=2.6) sets this
764 variable to the much more general `x-symbol-translate-to-ascii'."
770 "Parameters for converting a string into a label.
771 This variable is a list of the following items.
773 NWORDS Number of words to use.
774 MAXCHAR Maximum number of characters in a label string.
775 ILLEGAL nil: Throw away any words containing characters illegal in labels.
776 t: Throw away only the illegal characters, not the whole word.
777 ABBREV nil: Never abbreviate words.
778 t: Always abbreviate words (see `reftex-abbrev-parameters').
779 not t and not nil: Abbreviate words if necessary to shorten
780 label string below MAXCHAR.
781 SEPARATOR String separating different words in the label.
782 IGNOREWORDS List of words which should not be part of labels.
783 DOWNCASE t: Downcase words before using them."
801 "Regexp matching characters not legal in labels."
806 "Parameters for abbreviation of words.
807 This variable is a list of the following items.
809 MIN-CHARS Minimum number of characters remaining after abbreviation.
810 MIN-KILL Minimum number of characters to remove when abbreviating words.
811 BEFORE Character class before abbrev point in word.
812 AFTER Character class after abbrev point in word."
821 "Function which produces the string to insert as a label definition.
822 Normally should be nil, unless you want to do something fancy.
823 The function will be called with two arguments, the LABEL and the DEFAULT
825 string to insert into the buffer."
829 ;; Label referencing
832 "Options on how to reference labels."
842 "List of flags governing the label menu makeup.
843 The flags are:
845 TABLE-OF-CONTENTS Show the labels embedded in a table of context.
846 SECTION-NUMBERS Include section numbers (like 4.1.3) in table of contents.
847 COUNTERS Show counters. This just numbers the labels in the menu.
848 NO-CONTEXT Non-nil means do NOT show the short context.
849 FOLLOW Follow full context in other window.
850 SHOW-COMMENTED Show labels from regions which are commented out.
851 MATCH-IN-TOC Obsolete flag.
852 SHOW FILES Show begin and end of included files.
854 Each of these flags can be set to t or nil, or to a string of type letters
855 indicating the label types for which it should be true. These strings work
856 like character classes in regular expressions. Thus, setting one of the
859 The available label types are: s (section), f (figure), t (table), i (item),
860 e (equation), n (footnote), plus any definitions in `reftex-label-alist'.
862 Most options can also be switched from the label menu itself - so if you
863 decide here to not have a table of contents in the label menu, you can still
864 get one interactively during selection from the label menu."
866 :type
878 "Punctuation strings for multiple references.
879 When marking is used in the selection buffer to select several references,
880 this variable associates the 3 marking characters `,-+' with prefix strings
882 This is used to string together whole reference sets, like
883 `eqs. 1,2,3-5,6 and 7' in a single call to `reftex-reference'. See manual."
889 In the selection buffer, the `v' key toggles the reference macro between
891 which is active when entering the selection process.
892 Instead of nil or t, this may also be a string of type letters indicating
893 the label types for which it should be true."
899 In the selection buffer, the `V' key toggles the reference macro between
901 the default which is active when entering the selection process.
902 Instead of nil or t, this may also be a string of type letters indicating
903 the label types for which it should be true."
908 "*Number of spaces to be used for indentation per section level."
913 "*Non-nil means, `reftex-reference' will try to guess the label type.
914 To do that, RefTeX will look at the word before the cursor and compare it with
915 the words given in `reftex-label-alist'. When it finds a match, RefTeX will
916 immediately offer the correct label menu - otherwise it will prompt you for
917 a label type. If you set this variable to nil, RefTeX will always prompt."
922 "Function which produces the string to insert as a reference.
923 Normally should be nil, because the format to insert a reference can
924 already be specified in `reftex-label-alist'.
926 references, so even if you set this, your setting will be ignored by
927 the special commands.
928 The function will be called with two arguments, the LABEL and the DEFAULT
930 string to insert into the buffer."
935 "Mode hook for reftex-select-label-mode."
939 ;; BibteX citation configuration ----------------------------------------
942 "Support for referencing bibliographic data with BibTeX."
946 "LaTeX commands which specify the BibTeX databases to use with the document."
954 File names matched by these regexps will not be parsed by RefTeX.
955 Intended for files which contain only `@string' macro definitions and the
956 like, which are ignored by RefTeX anyway."
962 "*List of BibTeX database files which should be used if none are specified.
963 When `reftex-citation' is called from a document which has neither a
965 RefTeX will scan these files instead. Intended for using `reftex-citation'
966 in non-LaTeX files. The files will be searched along the BIBINPUTS or TEXBIB
967 path."
972 "*Sorting of the entries found in BibTeX databases by reftex-citation.
973 Possible values:
974 nil Do not sort entries.
975 'author Sort entries by author name.
976 'year Sort entries by increasing year.
977 'reverse-year Sort entries by decreasing year."
985 "*The format of citations to be inserted into the buffer.
986 It can be a string or an alist or a symbol. In the simplest case this
988 definition of `reftex-cite-format-builtin' for more complex examples.
990 If `reftex-cite-format' is a string, it will be used as the format.
991 In the format, the following percent escapes will be expanded.
993 %l The BibTeX label of the citation.
994 %a List of author names, see also `reftex-cite-punctuation'.
995 %2a Like %a, but abbreviate more than 2 authors like Jones et al.
996 %A First author name only.
997 %e Works like %a, but on list of editor names. (%2e and %E work a well)
999 It is also possible to access all other BibTeX database fields:
1000 %b booktitle %c chapter %d edition %h howpublished
1001 %i institution %j journal %k key %m month
1002 %n number %o organization %p pages %P first page
1003 %r address %s school %u publisher %t title
1004 %v volume %y year
1005 %B booktitle, abbreviated %T title, abbreviated
1007 Usually, only %l is needed. The other stuff is mainly for the echo area
1008 display, and for (setq reftex-comment-citations t).
1010 %< as a special operator kills punctuation and space around it after the
1011 string has been formatted.
1013 Beware that all this only works with BibTeX database files. When
1015 environment, only %l is available.
1017 If `reftex-cite-format' is an alist of characters and strings, the user
1018 will be prompted for a character to select one of the possible format
1019 strings.
1020 In order to configure this variable, you can either set
1021 `reftex-cite-format' directly yourself or set it to the SYMBOL of one of
1022 the predefined styles. The predefined symbols are those which have an
1023 association in the constant `reftex-cite-format-builtin'.
1024 E.g.: (setq reftex-cite-format 'natbib)"
1026 :type
1031 :value default
1037 reftex-cite-format-builtin))
1046 "*Non-nil means add a comment for each citation describing the full entry.
1047 The comment is formatted according to `reftex-cite-comment-format'."
1053 "Citation format used for commented citations. Must NOT contain %l.
1054 See the variable `reftex-cite-format' for possible percent escapes."
1059 "Citation format used to display citation info in the message area.
1060 Must NOT contain %l. See the variable `reftex-cite-format' for
1061 possible percent escapes."
1067 "Punctuation for formatting of name lists in citations.
1068 This is a list of 3 strings.
1079 "Function which produces the string to insert as a citation.
1080 Normally should be nil, because the format to insert a reference can
1081 already be specified in `reftex-cite-format'.
1082 The function will be called with two arguments, the CITATION KEY and the
1083 DEFAULT FORMAT, which is taken from `reftex-cite-format'. The function
1084 should return the string to insert into the buffer."
1089 "Mode hook for reftex-select-bib-mode."
1093 ;; Index Support Configuration
1096 "Support for viewing and editing the index."
1100 "*Non-nil means, index entries are parsed as well.
1101 Index support is resource intensive and the internal structure holding the
1102 parsed information can become quite big. Therefore it can be turned off.
1103 When this is nil and you execute a command which requires index support,
1104 you will be asked for confirmation to turn it on and rescan the document."
1109 "Special characters in index entries. The value is a list of five strings.
1110 These correspond to the makeindex keywords LEVEL ENCAP ACTUAL QUOTE ESCAPE."
1120 "Macros which define index entries. The structure is
1122 \(MACRO INDEX-TAG KEY PREFIX EXCLUDE REPEAT)
1124 MACRO is the macro. Arguments should be denoted by empty braces like
1126 marks where the index key is.
1129 reserved for the default index and the glossary. Other indices can be
1130 defined as well. If this is an integer, the Nth argument of the macro
1131 holds the index tag.
1133 KEY is a character which is used to identify the macro for input with
1136 PREFIX can be a prefix which is added to the KEY part of the index entry.
1140 EXCLUDE can be a function. If this function exists and returns a non-nil
1141 value, the index entry at point is ignored. This was implemented to support
1142 the (deprecated) `^' and `_' shortcuts in the LaTeX2e `index' package.
1144 REPEAT, if non-nil, means the index macro does not typeset the entry in
1145 the text, so that the text has to be repeated outside the index macro.
1146 Needed for `reftex-index-selection-or-word' and for indexing from the
1147 phrase buffer.
1149 The final entry may also be a symbol if this entry has a association
1150 in the variable `reftex-index-macros-builtin' to specify the main
1151 indexing package you are using. Legal values are currently
1152 default The LaTeX default - unnecessary to specify this one
1153 multind The multind.sty package
1154 index The index.sty package
1155 index-shortcut The index.sty packages with the ^ and _ shortcuts.
1156 Should not be used - only for old documents.
1157 Note that AUCTeX sets these things internally for RefTeX as well, so
1158 with a sufficiently new version of AUCTeX, you should not set the
1159 package here."
1164 :inline t
1177 :value index
1183 reftex-index-macros-builtin)))))
1187 This is a list with (MACRO-KEY DEFAULT-TAG).
1189 MACRO-KEY: Character identifying an index macro - see `reftex-index-macros'.
1190 DEFAULT-TAG: This is the tag to be used if the macro requires a TAG argument.
1191 When this is nil and a TAG is needed, RefTeX will ask for it.
1192 When this is the empty string and the TAG argument of the index
1193 macro is optional, the TAG argument will be omitted."
1202 "Default index tag.
1203 When working with multiple indexes, RefTeX queries for an index tag when
1204 creating index entries or displaying a specific index. This variable controls
1205 the default offered for these queries. The default can be selected with RET
1206 during selection or completion. Legal values of this variable are:
1208 nil Do not provide a default index
1210 last The last used index tag will be offered as default."
1218 "Format of index entries when copied from inside math mode.
1219 When `reftex-index-selection-or-word' is executed inside TeX math mode,
1220 the index key copied from the buffer is processed with this format string
1221 through the `format' function. This can be used to add the math delimiters
1222 \(e.g. `$') to the string.
1223 Requires the `texmathp.el' library which is part of AUCTeX."
1228 "File extension for the index phrase file.
1229 This extension will be added to the base name of the master file."
1234 "Regexp matching the `and' operator for index arguments in phrases file.
1235 When several index arguments in a phrase line are separated by this
1236 operator, each part will generate an index macro. So each match of
1237 the search phrase will produce *several* different index entries.
1239 Note: make sure this does no match things which are not separators.
1240 This logical `and' has higher priority than the logical `or' specified in
1241 `reftex-index-phrases-logical-or-regexp'."
1246 "Regexp matching the `or' operator for index arguments in phrases file.
1247 When several index arguments in a phrase line are separated by this
1248 operator, the user will be asked to select one of them at each match
1249 of the search phrase. The first index arg will be the default - a
1250 number key 1-9 must be pressed to switch to another.
1252 Note: make sure this does no match things which are not separators.
1253 The logical `and' specified in `reftex-index-phrases-logical-or-regexp'
1254 has higher priority than this logical `or'."
1259 "*Non-nil means phrases search will look for whole words, not subwords.
1260 This works by requiring word boundaries at the beginning and end of
1261 the search string. When the search phrase already has a non-word-char
1262 at one of these points, no word boundary is required there."
1267 "*Non-nil means, searching for index phrases will ignore case."
1272 "A function which is called at each match during global indexing.
1273 If the function returns nil, the current match is skipped."
1280 "*Non-nil means, skip matches which appear to be indexed already.
1281 When doing global indexing from the phrases buffer, searches for some
1282 phrases may match at places where that phrase was already indexed. In
1283 particular when indexing an already processed document again, this
1284 will even be the norm. When this variable is non-nil, RefTeX checks if
1285 the match is inside an index macro argument, or if an index macro is directly
1286 before or after the phrase. If that is the case, that match will
1287 be ignored."
1292 "*Non-nil means, when indexing from the phrases buffer, wrap lines.
1293 Inserting indexing commands in a line makes the line longer - often
1294 so long that it does not fit onto the screen. When this variable is
1295 non-nil, newlines will be added as necessary before and/or after the
1296 indexing command to keep lines short. However, the matched text
1300 "*Non-nil means when sorting phrase lines, the explicit index entry is used.
1301 Phrase lines in the phrases buffer contain a search phrase, and
1302 sorting is normally based on these. Some phrase lines also have
1303 an explicit index argument specified. When this variable is non-nil,
1304 the index argument will be used for sorting."
1309 "*Non-nil means, empty and comment lines separate phrase buffer into blocks.
1310 Sorting will then preserve blocks, so that lines are re-arranged only
1311 within blocks."
1316 "The letters which denote sections in the index.
1317 Usually these are all capital letters. Don't use any downcase letters.
1318 Order is not significant, the index will be sorted by whatever the sort
1319 function thinks is correct.
1320 In addition to these letters, RefTeX will create a group `!' which
1321 contains all entries sorted below the lowest specified letter.
1322 In the index buffer, pressing any of these capital letters or `!' will jump
1323 to that section."
1328 "*Non-nil means, display the index definition context in the index buffer.
1329 This flag may also be toggled from the index buffer with the `c' key."
1334 "*Non-nil means, point in *Index* buffer will cause other window to follow.
1335 The other window will show the corresponding part of the document.
1336 This flag can be toggled from within the *Index* buffer with the `f' key."
1340 ;; Viewing Cross References
1343 "Displaying cross references and citations."
1347 "Macros which can be used for the display of cross references.
1348 This is used when `reftex-view-crossref' is called with point in an
1349 argument of a macro. Note that crossref viewing for citations,
1350 references (both ways) and index entries is hard-coded. This variable
1351 is only to configure additional structures for which crossreference
1352 viewing can be useful. Each entry has the structure
1354 \(MACRO-RE SEARCH-RE HIGHLIGHT).
1356 MACRO-RE is matched against the macro. SEARCH-RE is the regexp used
1357 to search for cross references. `%s' in this regexp is replaced with
1358 with the macro argument at point. HIGHLIGHT is an integer indicating
1359 which subgroup of the match should be highlighted."
1366 "*Non-nil means, initially turn automatic viewing of crossref info on.
1367 Automatic viewing of crossref info normally uses the echo area.
1368 Whenever point is idle for more than `reftex-idle-time' seconds on the
1370 displayed, the echo area will display information about that cross
1371 reference. You can also set the variable to the symbol `window'. In
1372 this case a small temporary window is used for the display.
1373 This feature can be turned on and off from the menu
1374 \(Ref->Options)."
1381 "*Time (secs) Emacs has to be idle before automatic crossref display is done.
1382 Applies also to toc recentering."
1387 "*Non-nil means, automatic citation display will revisit files if necessary.
1388 When nil, citation display in echo area will only be active for cached
1389 entries and for BibTeX database files with live associated buffers."
1394 "*Non-nil means, the information displayed in the echo area for cite macros
1395 is cached and even saved along with the parsing information. The cache
1396 survives document scans. In order to clear it, use M-x reftex-reset-mode."
1401 "Normal Hook which is run before context is displayed anywhere. Designed
1402 for X-Symbol, but may have other uses as well."
1407 ;; Finding Files --------------------------------------------------------
1410 "Finding files on search paths."
1414 "*List of specifications how to retrieve the search path for TeX files.
1415 Several entries are possible.
1416 - If an element is the name of an environment variable, its content is used.
1417 - If an element starts with an exclamation mark, it is used as a command
1418 to retrieve the path. A typical command with the kpathsearch library would
1419 be `!kpsewhich -show-path=.tex'.
1420 - Otherwise the element itself is interpreted as a path.
1421 Multiple directories can be separated by the system dependent `path-separator'.
1422 Directories ending in `//' or `!!' will be expanded recursively.
1423 See also `reftex-use-external-file-finders'."
1429 "*List of specifications how to retrieve search path for .bib database files.
1430 Several entries are possible.
1431 - If an element is the name of an environment variable, its content is used.
1432 - If an element starts with an exclamation mark, it is used as a command
1433 to retrieve the path. A typical command with the kpathsearch library would
1434 be `!kpsewhich -show-path=.bib'.
1435 - Otherwise the element itself is interpreted as a path.
1436 Multiple directories can be separated by the system dependent `path-separator'.
1437 Directories ending in `//' or `!!' will be expanded recursively.
1438 See also `reftex-use-external-file-finders'."
1446 "*Association list with file extensions for different file types.
1447 This is a list of items, each item is like: (TYPE . (DEF-EXT OTHER-EXT ...))
1451 OTHER-EXT: Any number of other legal extensions for this file type.
1453 When a files is searched and it does not have any of the legal extensions,
1454 we try the default extension first, and then the naked file name.
1456 If you are using AUCTeX, you also need to add new extensions to
1457 TeX-file-extensions."
1463 "*Non-nil means, search all specified directories before trying recursion.
1467 time the recursive path is for the system files and not for the user files.
1468 Set this to nil if the default makes RefTeX finding files with equal names
1469 in wrong sequence."
1474 "*Non-nil means, use external programs to find files.
1475 Normally, RefTeX searches the paths given in the environment variables
1476 TEXINPUTS and BIBINPUTS to find TeX files and BibTeX database files.
1477 With this option turned on, it calls an external program specified in the
1478 option `reftex-external-file-finders' instead. As a side effect,
1479 the variables `reftex-texpath-environment-variables' and
1480 `reftex-bibpath-environment-variables' will be ignored."
1486 "*Association list with external programs to call for finding files.
1487 Each entry is a cons cell (TYPE . PROGRAM).
1489 any arguments. %f will be replaced by the name of the file to be found.
1490 Note that these commands will be executed directly, not via a shell.
1491 Only relevant when `reftex-use-external-file-finders' is non-nil."
1496 ;; Tuning the parser ----------------------------------------------------
1499 "Configuration of parser speed and memory usage."
1503 "*Non-nil means, keep buffers created for parsing and lookup.
1504 RefTeX sometimes needs to visit files related to the current document.
1505 We distinguish files visited for
1506 PARSING: Parts of a multifile document loaded when (re)-parsing the document.
1507 LOOKUP: BibTeX database files and TeX files loaded to find a reference,
1508 to display label context, etc.
1509 The created buffers can be kept for later use, or be thrown away immediately
1510 after use, depending on the value of this variable:
1512 nil Throw away as much as possible.
1513 t Keep everything.
1514 1 Throw away buffers created for parsing, but keep the ones created
1515 for lookup.
1517 If a buffer is to be kept, the file is visited normally (which is potentially
1518 slow but will happen only once).
1519 If a buffer is to be thrown away, the initialization of the buffer depends
1520 upon the variable `reftex-initialize-temporary-buffers'."
1528 "*Non-nil means do initializations even when visiting file temporarily.
1529 When nil, RefTeX may turn off find-file hooks and other stuff to briefly
1530 visit a file.
1531 When t, the full default initializations are done (find-file-hook etc.).
1532 Instead of t or nil, this variable may also be a list of hook functions to
1533 do a minimal initialization."
1542 "*List of regular expressions to exclude certain input files from parsing.
1544 of the regular expressions in this list, that file is not parsed by RefTeX."
1549 "*Non-nil means, re-parse only 1 file when asked to re-parse.
1550 Re-parsing is normally requested with a `C-u' prefix to many RefTeX commands,
1551 or with the `r' key in menus. When this option is t in a multifile document,
1552 we will only parse the current buffer, or the file associated with the label
1553 or section heading near point in a menu. Requesting re-parsing of an entire
1554 multifile document then requires a `C-u C-u' prefix or the capital `R' key
1555 in menus."
1560 "*Non-nil means, RefTeX may rescan the document when this seems necessary.
1561 Currently this applies only to rescanning after label insertion, when
1562 the new label cannot be inserted correctly into the internal label
1563 list."
1568 "*Non-nil means, save information gathered with parsing in a file.
1569 The file MASTER.rel in the same directory as MASTER.tex is used to save the
1570 information. When this variable is t,
1571 - accessing the parsing information for the first time in an editing session
1572 will read that file (if available) instead of parsing the document.
1573 - exiting Emacs or killing a buffer in reftex-mode will cause a new version
1574 of the file to be written."
1579 "*File extension for the file in which parser information is stored.
1580 This extension is added to the base name of the master file."
1585 "*Non-nil means use a separate selection buffer for each label type.
1586 These buffers are kept from one selection to the next and need not to be
1587 created for each use - so the menu generally comes up faster. The
1588 selection buffers will be erased (and therefore updated) automatically
1589 when new labels in its category are added. See the variable
1590 `reftex-auto-update-selection-buffers'."
1596 "*Non-nil means, selection buffers will be updated automatically.
1597 When a new label is defined with `reftex-label', all selection buffers
1598 associated with that label category are emptied, in order to force an
1599 update upon next use. When nil, the buffers are left alone and have to be
1600 updated by hand, with the `g' key from the label selection process.
1601 The value of this variable will only have any effect when
1602 `reftex-use-multiple-selection-buffers' is non-nil."
1607 ;; Fontification and Faces ----------------------------------------------
1610 "Options concerning the faces used in RefTeX."
1614 "*Non-nil means, use fonts in *toc* and selection buffers.
1615 Font-lock must be loaded as well to actually get fontified display.
1616 When changing this option, a rescan may be necessary to activate the change."
1621 "*Non-nil means, re-fontify the context in the label menu with font-lock.
1622 This slightly slows down the creation of the label menu. It is only necessary
1623 when you definitely want the context fontified.
1625 This option may have 3 different values:
1626 nil Never refontify.
1627 t Always refontify.
1628 1 Refontify when absolutely necessary, e.g. when old versions of X-Symbol.
1629 The option is ignored when `reftex-use-fonts' is nil."
1638 "*Non-nil mean, highlight selected text in selection and *toc* buffers.
1639 Normally, the text near the cursor is the selected text, and it is
1640 highlighted. This is the entry most keys in the selction and *toc*
1641 buffers act on. However, if you mainly use the mouse to select an
1642 item, you may find it nice to have mouse-triggered highlighting
1643 instead or as well. The variable may have one of these values:
1645 nil No highlighting.
1646 cursor Highlighting is cursor driven.
1647 mouse Highlighting is mouse driven.
1648 both Both cursor and mouse trigger highlighting.
1650 Changing this variable requires to rebuild the selection and *toc* buffers
1651 to become effective (keys `g' or `r')."
1660 "Face name to highlight cursor selected item in toc and selection buffers.
1661 See also the variable `reftex-highlight-selection'."
1665 "Face name to highlight mouse selected item in toc and selection buffers.
1666 See also the variable `reftex-highlight-selection'."
1670 "Face name for file boundaries in selection buffer."
1674 "Face name for labels in selection buffer."
1678 "Face name for section headings in toc and selection buffers."
1682 "Face name for the header of a toc buffer."
1686 "Face name for author names in bib selection buffer."
1690 "Face name for year in bib selection buffer."
1694 "Face name for article title in bib selection buffer."
1698 "Face name for bibliographic information in bib selection buffer."
1702 "Face name for marked entries in the selection buffers."
1706 "Face name for the header of an index buffer."
1710 "Face name for the start of a new letter section in the index."
1714 "Face name for index names (for multiple indices)."
1718 "Face name for index entries."
1723 "X-Symbol specific hook.
1724 Functions get two arguments, the buffer from where the command started and a
1725 symbol indicating in what context the hook is called."
1729 ;; Miscellaneous configurations -----------------------------------------
1732 "Collection of further configurations."
1736 "Non-nil means, make additional key bindings on startup.
1737 These extra bindings are located in the users `C-c letter' map."
1742 "*Plug-in flags for AUCTeX interface.
1743 This variable is a list of 4 boolean flags. When a flag is non-nil,
1744 RefTeX will
1746 - supply labels in new sections and environments (flag 1)
1752 You may also set the variable itself to t or nil in order to turn all
1753 plug-ins on or off, respectively.
1756 Supplying macro arguments applies when you insert such a macro interactively
1758 See the AUCTeX documentation for more information.
1759 RefTeX uses `fset' to take over the function calls. Changing the variable
1760 may require a restart of Emacs in order to become effective."
1774 )))
1777 "*Non-nil means, allow arguments of macros to be detached by whitespace.
1785 "Hook which is being run when loading reftex.el."
1790 "Hook which is being run when turning on RefTeX mode."
1797 ;;; arch-tag: 9591ea34-ef39-4431-90b7-c115eaf5e16f
1798 ;;; reftex-vars.el ends here