[ < ] [ > ]   [ << ] [ Up ] [ >> ]         [Top] [Contents] [Index] [ ? ]

8. Options, Keymaps, Hooks

Here is a complete list of RefTeX's configuration variables. All variables have customize support - so if you are not familiar with Emacs Lisp (and even if you are) you might find it more comfortable to use customize to look at and change these variables. M-x reftex-customize will get you there.

8.1 Table of Contents  
8.2 Defining Label Environments  
8.3 Creating Labels  
8.4 Referencing Labels  
8.5 Creating Citations  
8.6 Index Support  
8.7 Viewing Cross-References  
8.8 Finding Files  
8.9 Optimizations  
8.10 Fontification  
8.11 Miscellaneous  

[ < ] [ > ]   [ << ] [ Up ] [ >> ]         [Top] [Contents] [Index] [ ? ]

8.1 Table of Contents

User Option: reftex-include-file-commands
List of LaTeX commands which input another file. The file name is expected after the command, either in braces or separated by whitespace.

User Option: reftex-max-section-depth
Maximum depth of section levels in document structure. Standard LaTeX needs 7, default is 12.

User Option: reftex-section-levels
Commands and levels used for defining sections in the document. The car of each cons cell is the name of the section macro. The cdr is a number indicating its level. A negative level means the same as the positive value, but the section will never get a number. The cdr may also be a function which then has to return the level. This list is also used for promotion and demption of sectioning commands. If you are using a document class which has several sets of sectioning commands, promotion only works correctly if this list is sorted first by set, then within each set by level. The promotion commands always select the nearest entry with the correct new level.

User Option: reftex-toc-max-level
The maximum level of toc entries which will be included in the TOC. Section headings with a bigger level will be ignored. In RefTeX, chapters are level 1, sections level 2 etc. This variable can be changed from within the `*toc*' buffer with the t key.

User Option: reftex-part-resets-chapter
Non-nil means, \part is like any other sectioning command. This means, part numbers will be included in the numbering of chapters, and chapter counters will be reset for each part. When nil (the default), parts are special, do not reset the chapter counter and also do not show up in chapter numbers.

User Option: reftex-auto-recenter-toc
Non-nil means, turn automatic recentering of `*TOC*' window on. When active, the `*TOC*' window will always show the section you are currently working in. Recentering happens whenever Emacs is idle for more than reftex-idle-time seconds.

Value t means, turn on immediately when RefTeX gets started. Then, recentering will work for any toc window created during the session.

Value frame (the default) means, turn automatic recentering on only while the dedicated TOC frame does exist, and do the recentering only in that frame. So when creating that frame (with d key in an ordinary TOC window), the automatic recentering is turned on. When the frame gets destroyed, automatic recentering is turned off again.

This feature can be turned on and off from the menu (Ref->Options).

User Option: reftex-toc-split-windows-horizontally
Non-nil means, create TOC window by splitting window horizontally. The default is to split vertically.

User Option: reftex-toc-split-windows-fraction
Fraction of the width or height of the frame to be used for TOC window.

User Option: reftex-toc-keep-other-windows
Non-nil means, split the selected window to display the `*toc*' buffer. This helps to keep the window configuration, but makes the `*toc*' small. When nil, all other windows except the selected one will be deleted, so that the `*toc*' window fills half the frame.

User Option: reftex-toc-include-file-boundaries
Non-nil means, include file boundaries in `*toc*' buffer. This flag can be toggled from within the `*toc*' buffer with the i key.

User Option: reftex-toc-include-labels
Non-nil means, include labels in `*toc*' buffer. This flag can be toggled from within the `*toc*' buffer with the l key.

User Option: reftex-toc-include-index-entries
Non-nil means, include index entries in `*toc*' buffer. This flag can be toggled from within the `*toc*' buffer with the i key.

User Option: reftex-toc-include-context
Non-nil means, include context with labels in the `*toc*' buffer. Context will only be shown if the labels are visible as well. This flag can be toggled from within the `*toc*' buffer with the c key.

User Option: reftex-toc-follow-mode
Non-nil means, point in `*toc*' buffer (the table-of-contents buffer) will cause other window to follow. The other window will show the corresponding part of the document. This flag can be toggled from within the `*toc*' buffer with the f key.

Normal Hook: reftex-toc-mode-hook
Normal hook which is run when a `*toc*' buffer is created.

Keymap: reftex-toc-map
The keymap which is active in the `*toc*' buffer. (see section 2. Table of Contents).

[ < ] [ > ]   [ << ] [ Up ] [ >> ]         [Top] [Contents] [Index] [ ? ]

8.2 Defining Label Environments

User Option: reftex-default-label-alist-entries
Default label alist specifications. It is a list of symbols with associations in the constant reftex-label-alist-builtin. LaTeX should always be the last entry.

User Option: reftex-label-alist
Set this variable to define additions and changes to the defaults in reftex-default-label-alist-entries. The only things you must not change is that ?s is the type indicator for section labels, and SPC for the any label type. These are hard-coded at other places in the code.

The value of the variable must be a list of items. Each item is a list itself and has the following structure:

 (env-or-macro  type-key  label-prefix  reference-format
    context-method  (magic-word ... )  toc-level)

Each list entry describes either an environment carrying a counter for use with \label and \ref, or a LaTeX macro defining a label as (or inside) one of its arguments. The elements of each list entry are:

Name of the environment (like `table') or macro (like `\myfig'). For macros, indicate the arguments, as in `\myfig[]{}{}{*}{}'. Use square brackets for optional arguments, a star to mark the label argument, if any. The macro does not have to have a label argument - you could also use `\label{...}' inside one of its arguments.

Special names: section for section labels, any to define a group which contains all labels.

This may also be a function to do local parsing and identify point to be in a non-standard label environment. The function must take an argument bound and limit backward searches to this value. It should return either nil or a cons cell (function . position) with the function symbol and the position where the special environment starts. See the Info documentation for an example.

Finally this may also be nil if the entry is only meant to change some settings associated with the type indicator character (see below).

Type indicator character, like ?t, must be a printable ASCII character. The type indicator is a single character which defines a label type. Any label inside the environment or macro is assumed to belong to this type. The same character may occur several times in this list, to cover cases in which different environments carry the same label type (like equation and eqnarray). If the type indicator is nil and the macro has a label argument `{*}', the macro defines neutral labels just like \label. In this case the reminder of this entry is ignored.

Label prefix string, like `tab:'. The prefix is a short string used as the start of a label. It may be the empty string. The prefix may contain the following `%' escapes:

%f Current file name, directory and extension stripped.
%F Current file name relative to master file directory.
%u User login name, on systems which support this.
%S A section prefix derived with variable reftex-section-prefixes.

Example: In a file `intro.tex', `eq:%f:' will become `eq:intro:'.

Format string for reference insert in buffer. `%s' will be replaced by the label. When the format starts with `~', this `~' will only be inserted when the character before point is not a whitespace.

Indication on how to find the short context.
  • If nil, use the text following the `\label{...}' macro.
  • If t, use
    • the section heading for section labels.
    • text following the `\begin{...}' statement of environments (not a good choice for environments like eqnarray or enumerate, where one has several labels in a single environment).
    • text after the macro name (starting with the first arg) for macros.
  • If an integer, use the nth argument of the macro. As a special case, 1000 means to get text after the last macro argument.
  • If a string, use as regexp to search backward from the label. Context is then the text following the end of the match. E.g. putting this to `\\caption[[{]' will use the caption in a figure or table environment. `\\begin{eqnarray}\|\\\\' works for eqnarrays.
  • If any of caption, item, eqnarray-like, alignat-like, this symbol will internally be translated into an appropriate regexp (see also the variable reftex-default-context-regexps).
  • If a function, call this function with the name of the environment/macro as argument. On call, point will be just after the \label macro. The function is expected to return a suitable context string. It should throw an exception (error) when failing to find context. As an example, here is a function returning the 10 chars following the label macro as context:

    (defun my-context-function (env-or-mac)
       (if (> (point-max) (+ 10 (point)))
           (buffer-substring (point) (+ 10 (point)))
         (error "Buffer too small")))

Label context is used in two ways by RefTeX: For display in the label menu, and to derive a label string. If you want to use a different method for each of these, specify them as a dotted pair. E.g. (nil . t) uses the text after the label (nil) for display, and text from the default position (t) to derive a label string. This is actually used for section labels.

List of magic words which identify a reference to be of this type. If the word before point is equal to one of these words when calling reftex-reference, the label list offered will be automatically restricted to labels of the correct type. If the first element of this word--list is the symbol `regexp', the strings are interpreted as regular expressions.

The integer level at which this environment should be added to the table of contents. See also reftex-section-levels. A positive value will number the entries mixed with the sectioning commands of the same level. A negative value will make unnumbered entries. Useful only for theorem-like environments which structure the document. Will be ignored for macros. When omitted or nil, no TOC entries will be made.

If the type indicator characters of two or more entries are the same, RefTeX will use

Any list entry may also be a symbol. If that has an association in reftex-label-alist-builtin, the cddr of that association is spliced into the list. However, builtin defaults should normally be set with the variable reftex-default-label-alist-entries.

User Option: reftex-section-prefixes
Prefixes for section labels. When the label prefix given in an entry in reftex-label-alist contains `%S', this list is used to determine the correct prefix string depending on the current section level. The list is an alist, with each entry of the form (key . prefix). Possible keys are sectioning macro names like `chapter', integer section levels (as given in reftex-section-levels), and t for the default.

User Option: reftex-default-context-regexps
Alist with default regular expressions for finding context. The emacs lisp form (format regexp (regexp-quote environment)) is used to calculate the final regular expression - so `%s' will be replaced with the environment or macro.

[ < ] [ > ]   [ << ] [ Up ] [ >> ]         [Top] [Contents] [Index] [ ? ]

8.3 Creating Labels

User Option: reftex-insert-label-flags
Flags governing label insertion. The value has the form

(derive prompt)

If deriveis t, RefTeX will try to derive a sensible label from context. A section label for example will be derived from the section heading. The conversion of the context to a legal label is governed by the specifications given in reftex-derive-label-parameters. If derive is nil, the default label will consist of the prefix and a unique number, like `eq:23'.

If prompt is t, the user will be prompted for a label string. When prompt is nil, the default label will be inserted without query.

So the combination of derive and prompt controls label insertion. Here is a table describing all four possibilities:

derive prompt action
nil    nil    Insert simple label, like `eq:22' or `sec:13'. No query.
nil    t      Prompt for label.
t      nil    Derive a label from context and insert. No query.
t      t      Derive a label from context, prompt for confirmation.

Each flag may be set to t, nil, or a string of label type letters indicating the label types for which it should be true. Thus, the combination may be set differently for each label type. The default settings `"s"' and `"sft"' mean: Derive section labels from headings (with confirmation). Prompt for figure and table labels. Use simple labels without confirmation for everything else.

The available label types are: s (section), f (figure), t (table), i (item), e (equation), n (footnote), N (endnote) plus any definitions in reftex-label-alist.

Hook: reftex-format-label-function
If non-nil, should be a function which produces the string to insert as a label definition. The function will be called with two arguments, the label and the default-format (usually `\label{%s}'). It should return the string to insert into the buffer.

Hook: reftex-string-to-label-function
Function to turn an arbitrary string into a legal label. RefTeX's default function uses the variable reftex-derive-label-parameters.

Hook: reftex-translate-to-ascii-function
Filter function which will process a context string before it is used to derive a label from it. The intended application is to convert ISO or Mule characters into something legal in labels. The default function reftex-latin1-to-ascii removes the accents from Latin-1 characters. X-Symbol (>=2.6) sets this variable to the much more general x-symbol-translate-to-ascii.

User Option: reftex-derive-label-parameters
Parameters for converting a string into a label. This variable is a list of the following items:
Number of words to use.
Maximum number of characters in a label string.
nil: Throw away any words containing characters illegal in labels.
t: Throw away only the illegal characters, not the whole word.
nil: Never abbreviate words.
t: Always abbreviate words (see reftex-abbrev-parameters).
1: Abbreviate words if necessary to shorten label string.
String separating different words in the label.
List of words which should not be part of labels.
t: Downcase words before putting them into the label.

User Option: reftex-label-illegal-re
Regexp matching characters not legal in labels.

User Option: reftex-abbrev-parameters
Parameters for abbreviation of words. A list of four parameters.
Minimum number of characters remaining after abbreviation.
Minimum number of characters to remove when abbreviating words.
Character class before abbrev point in word.
Character class after abbrev point in word.

[ < ] [ > ]   [ << ] [ Up ] [ >> ]         [Top] [Contents] [Index] [ ? ]

8.4 Referencing Labels

User Option: reftex-label-menu-flags
List of flags governing the label menu makeup. The flags are:
Show the labels embedded in a table of context.
Include section numbers (like 4.1.3) in table of contents.
Show counters. This just numbers the labels in the menu.
Non-nil means do not show the short context.
Follow full context in other window.
Show labels from regions which are commented out.
Obsolete flag.
Show begin and end of included files.

Each of these flags can be set to t or nil, or to a string of type letters indicating the label types for which it should be true. These strings work like character classes in regular expressions. Thus, setting one of the flags to `"sf"' makes the flag true for section and figure labels, nil for everything else. Setting it to `"^sf"' makes it the other way round.

The available label types are: s (section), f (figure), t (table), i (item), e (equation), n (footnote), plus any definitions in reftex-label-alist.

Most options can also be switched from the label menu itself - so if you decide here to not have a table of contents in the label menu, you can still get one interactively during selection from the label menu.

User Option: reftex-multiref-punctuation
Punctuation strings for multiple references. When marking is used in the selection buffer to select several references, this variable associates the 3 marking characters `,-+' with prefix strings to be inserted into the buffer before the corresponding \ref macro. This is used to string together whole reference sets, like `eqs. 1,2,3-5,6 and 7' in a single call to reftex-reference.

User Option: reftex-vref-is-default
Non-nil means, the varioref macro \vref is used as default. In the selection buffer, the v key toggles the reference macro between \ref and \vref. The value of this variable determines the default which is active when entering the selection process. Instead of nil or t, this may also be a string of type letters indicating the label types for which it should be true.

User Option: reftex-fref-is-default
Non-nil means, the fancyref macro \fref is used as default. In the selection buffer, the V key toggles the reference macro between \ref, \fref and \Fref. The value of this variable determines the default which is active when entering the selection process. Instead of nil or t, this may also be a string of type letters indicating the label types for which it should be true.

Hook: reftex-format-ref-function
If non-nil, should be a function which produces the string to insert as a reference. Note that the insertion format can also be changed with reftex-label-alist. This hook also is used by the special commands to insert \vref and \fref references, so even if you set this, your setting will be ignored by the special commands. The function will be called with two arguments, the label and the default-format (usually `~\ref{%s}'). It should return the string to insert into the buffer.

User Option: reftex-level-indent
Number of spaces to be used for indentation per section level.

User Option: reftex-guess-label-type
Non-nil means, reftex-reference will try to guess the label type. To do that, RefTeX will look at the word before the cursor and compare it with the magic words given in reftex-label-alist. When it finds a match, RefTeX will immediately offer the correct label menu - otherwise it will prompt you for a label type. If you set this variable to nil, RefTeX will always prompt for a label type.

Normal Hook: reftex-display-copied-context-hook
Normal Hook which is run before context is displayed anywhere. Designed for X-Symbol, but may have other uses as well.

Hook: reftex-pre-refontification-functions
X-Symbol specific hook. Probably not useful for other purposes. The functions get two arguments, the buffer from where the command started and a symbol indicating in what context the hook is called.

Normal Hook: reftex-select-label-mode-hook
Normal hook which is run when a selection buffer enters reftex-select-label-mode.

Keymap: reftex-select-label-map
The keymap which is active in the labels selection process (see section 3.2 Referencing Labels).

[ < ] [ > ]   [ << ] [ Up ] [ >> ]         [Top] [Contents] [Index] [ ? ]

8.5 Creating Citations

User Option: reftex-bibliography-commands
LaTeX commands which specify the BibTeX databases to use with the document.

User Option: reftex-bibfile-ignore-regexps
List of regular expressions to exclude files in \\bibliography{..}. File names matched by any of these regexps will not be parsed. Intended for files which contain only @string macro definitions and the like, which are ignored by RefTeX anyway.

User Option: reftex-default-bibliography
List of BibTeX database files which should be used if none are specified. When reftex-citation is called from a document with neither a `\bibliography{...}' statement nor a thebibliography environment, RefTeX will scan these files instead. Intended for using reftex-citation in non-LaTeX files. The files will be searched along the BIBINPUTS or TEXBIB path.

User Option: reftex-sort-bibtex-matches
Sorting of the entries found in BibTeX databases by reftex-citation. Possible values:
nil          Do not sort entries.
author       Sort entries by author name.
year         Sort entries by increasing year.
reverse-year Sort entries by decreasing year.

User Option: reftex-cite-format
The format of citations to be inserted into the buffer. It can be a string, an alist or a symbol. In the simplest case this is just the string `\cite{%l}', which is also the default. See the definition of reftex-cite-format-builtin for more complex examples.

If reftex-cite-format is a string, it will be used as the format. In the format, the following percent escapes will be expanded.

The BibTeX label of the citation.
List of author names, see also reftex-cite-punctuation.
Like %a, but abbreviate more than 2 authors like Jones et al.
First author name only.
Works like `%a', but on list of editor names. (`%2e' and `%E' work a well).

It is also possible to access all other BibTeX database fields:

%b booktitle     %c chapter        %d edition    %h howpublished
%i institution   %j journal        %k key        %m month
%n number        %o organization   %p pages      %P first page
%r address       %s school         %u publisher  %t title
%v volume        %y year
%B booktitle, abbreviated          %T title, abbreviated

Usually, only `%l' is needed. The other stuff is mainly for the echo area display, and for (setq reftex-comment-citations t).

`%<' as a special operator kills punctuation and space around it after the string has been formatted.

Beware that all this only works with BibTeX database files. When citations are made from the \bibitems in an explicit thebibliography environment, only `%l' is available.

If reftex-cite-format is an alist of characters and strings, the user will be prompted for a character to select one of the possible format strings.

In order to configure this variable, you can either set reftex-cite-format directly yourself or set it to the symbol of one of the predefined styles. The predefined symbols are those which have an association in the constant reftex-cite-format-builtin) E.g.: (setq reftex-cite-format 'natbib).

Hook: reftex-format-cite-function

If non-nil, should be a function which produces the string to insert as a citation. Note that the citation format can also be changed with the variable reftex-cite-format. The function will be called with two arguments, the citation-key and the default-format (taken from reftex-cite-format). It should return the string to insert into the buffer.

User Option: reftex-comment-citations
Non-nil means add a comment for each citation describing the full entry. The comment is formatted according to reftex-cite-comment-format.

User Option: reftex-cite-comment-format
Citation format used for commented citations. Must not contain `%l'. See the variable reftex-cite-format for possible percent escapes.

User Option: reftex-cite-punctuation
Punctuation for formatting of name lists in citations. This is a list of 3 strings.
  1. normal names separator, like `, ' in Jones, Brown and Miller
  2. final names separator, like ` and ' in Jones, Brown and Miller
  3. The `et al.' string, like ` {\it et al.}' in Jones {\it et al.}

Normal Hook: reftex-select-bib-mode-hook
Normal hook which is run when a selection buffer enters reftex-select-bib-mode.

Keymap: reftex-select-bib-map
The keymap which is active in the citation-key selection process (see section 4.1 Creating Citations).

[ < ] [ > ]   [ << ] [ Up ] [ >> ]         [Top] [Contents] [Index] [ ? ]

8.6 Index Support

User Option: reftex-support-index
Non-nil means, index entries are parsed as well. Index support is resource intensive and the internal structure holding the parsed information can become quite big. Therefore it can be turned off. When this is nil and you execute a command which requires index support, you will be asked for confirmation to turn it on and rescan the document.

User Option: reftex-index-special-chars
List of special characters in index entries, given as strings. These correspond to the MakeIndex keywords (level encap actual quote escape).

User Option: reftex-index-macros
List of macros which define index entries. The structure of each entry is
(macro index-tag key prefix exclude repeat)

macro is the macro. Arguments should be denoted by empty braces, as for example in `\index[]{*}'. Use square brackets to denote optional arguments. The star marks where the index key is.

index-tag is a short name of the index. `idx' and `glo' are reserved for the default index and the glossary. Other indices can be defined as well. If this is an integer, the Nth argument of the macro holds the index tag.

key is a character which is used to identify the macro for input with reftex-index. `?i', `?I', and `?g' are reserved for default index and glossary.

prefix can be a prefix which is added to the key part of the index entry. If you have a macro \newcommand{\molec}[1]{#1\index{Molecules!#1}, this prefix should be `Molecules!'.

exclude can be a function. If this function exists and returns a non-nil value, the index entry at point is ignored. This was implemented to support the (deprecated) `^' and `_' shortcuts in the LaTeX2e index package.

repeat, if non-nil, means the index macro does not typeset the entry in the text, so that the text has to be repeated outside the index macro. Needed for reftex-index-selection-or-word and for indexing from the phrase buffer.

The final entry may also be a symbol. It must have an association in the variable reftex-index-macros-builtin to specify the main indexing package you are using. Legal values are currently

default         The LaTeX default - unnecessary to specify this one
multind         The multind.sty package
index           The index.sty package
index-shortcut  The index.sty packages with the ^ and _ shortcuts.
                Should not be used - only for old documents
Note that AUCTeX sets these things internally for RefTeX as well, so with a sufficiently new version of AUCTeX, you should not set the package here.

User Option: reftex-index-default-macro
The default index macro for reftex-index-selection-or-word. This is a list with (macro-key default-tag).

macro-key is a character identifying an index macro - see reftex-index-macros.

default-tag is the tag to be used if the macro requires a tag argument. When this is nil and a tag is needed, RefTeX will ask for it. When this is the empty string and the TAG argument of the index macro is optional, the TAG argument will be omitted.

User Option: reftex-index-default-tag
Default index tag. When working with multiple indexes, RefTeX queries for an index tag when creating index entries or displaying a specific index. This variable controls the default offered for these queries. The default can be selected with RET during selection or completion. Legal values of this variable are:
nil        Do not provide a default index
"tag"      The default index tag given as a string, e.g. "idx"
last       The last used index tag will be offered as default

User Option: reftex-index-math-format
Format of index entries when copied from inside math mode. When reftex-index-selection-or-word is executed inside TeX math mode, the index key copied from the buffer is processed with this format string through the format function. This can be used to add the math delimiters (e.g. `$') to the string. Requires the `texmathp.el' library which is part of AUCTeX.

User Option: reftex-index-phrase-file-extension
File extension for the index phrase file. This extension will be added to the base name of the master file.

User Option: reftex-index-phrases-logical-and-regexp
Regexp matching the `and' operator for index arguments in phrases file. When several index arguments in a phrase line are separated by this operator, each part will generate an index macro. So each match of the search phrase will produce several different index entries. Make sure this does no match things which are not separators. This logical `and' has higher priority than the logical `or' specified in reftex-index-phrases-logical-or-regexp.

User Option: reftex-index-phrases-logical-or-regexp
Regexp matching the `or' operator for index arguments in phrases file. When several index arguments in a phrase line are separated by this operator, the user will be asked to select one of them at each match of the search phrase. The first index arg will be the default. A number key 1--9 must be pressed to switch to another. Make sure this does no match things which are not separators. The logical `and' specified in reftex-index-phrases-logical-or-regexp has higher priority than this logical `or'.

User Option: reftex-index-phrases-search-whole-words
Non-nil means phrases search will look for whole words, not subwords. This works by requiring word boundaries at the beginning and end of the search string. When the search phrase already has a non-word-char at one of these points, no word boundary is required there.

User Option: reftex-index-phrases-case-fold-search
Non-nil means, searching for index phrases will ignore case.

User Option: reftex-index-verify-function
A function which is called at each match during global indexing. If the function returns nil, the current match is skipped.

User Option: reftex-index-phrases-skip-indexed-matches
Non-nil means, skip matches which appear to be indexed already. When doing global indexing from the phrases buffer, searches for some phrases may match at places where that phrase was already indexed. In particular when indexing an already processed document again, this will even be the norm. When this variable is non-nil, RefTeX checks if the match is an index macro argument, or if an index macro is directly before or after the phrase. If that is the case, that match will be ignored.

User Option: reftex-index-phrases-wrap-long-lines
Non-nil means, when indexing from the phrases buffer, wrap lines. Inserting indexing commands in a line makes the line longer - often so long that it does not fit onto the screen. When this variable is non-nil, newlines will be added as necessary before and/or after the indexing command to keep lines short. However, the matched text phrase and its index command will always end up on a single line.

User Option: reftex-index-phrases-sort-prefers-entry
Non-nil means when sorting phrase lines, the explicit index entry is used. Phrase lines in the phrases buffer contain a search phrase, and sorting is normally based on these. Some phrase lines also have an explicit index argument specified. When this variable is non-nil, the index argument will be used for sorting.

User Option: reftex-index-phrases-sort-in-blocks
Non-nil means, empty and comment lines separate phrase buffer into blocks. Sorting will then preserve blocks, so that lines are re-arranged only within blocks.

User Option: reftex-index-phrases-map
Keymap for the Index Phrases buffer.

User Option: reftex-index-phrases-mode-hook
Normal hook which is run when a buffer is put into reftex-index-phrases-mode.

User Option: reftex-index-section-letters
The letters which denote sections in the index. Usually these are all capital letters. Don't use any downcase letters. Order is not significant, the index will be sorted by whatever the sort function thinks is correct. In addition to these letters, RefTeX will create a group `!' which contains all entries sorted below the lowest specified letter. In the `*Index*' buffer, pressing any of these capital letters or ! will jump to that section.

User Option: reftex-index-include-context
Non-nil means, display the index definition context in the `*Index*' buffer. This flag may also be toggled from the `*Index*' buffer with the c key.

User Option: reftex-index-follow-mode
Non-nil means, point in `*Index*' buffer will cause other window to follow. The other window will show the corresponding part of the document. This flag can be toggled from within the `*Index*' buffer with the f key.

Keymap: reftex-index-map
The keymap which is active in the `*Index*' buffer (see section 5. Index Support).

[ < ] [ > ]   [ << ] [ Up ] [ >> ]         [Top] [Contents] [Index] [ ? ]

8.7 Viewing Cross-References

User Option: reftex-view-crossref-extra
Macros which can be used for the display of cross references. This is used when `reftex-view-crossref' is called with point in an argument of a macro. Note that crossref viewing for citations, references (both ways) and index entries is hard-coded. This variable is only to configure additional structures for which crossreference viewing can be useful. Each entry has the structure
(macro-re search-re highlight).
macro-re is matched against the macro. search-re is the regexp used to search for cross references. `%s' in this regexp is replaced with the macro argument at point. highlight is an integer indicating which subgroup of the match should be highlighted.

User Option: reftex-auto-view-crossref
Non-nil means, initially turn automatic viewing of crossref info on. Automatic viewing of crossref info normally uses the echo area. Whenever point is idle for more than reftex-idle-time seconds on the argument of a \ref or \cite macro, and no other message is being displayed, the echo area will display information about that cross reference. You can also set the variable to the symbol window. In this case a small temporary window is used for the display. This feature can be turned on and off from the menu (Ref->Options).

User Option: reftex-idle-time
Time (secs) Emacs has to be idle before automatic crossref display or toc recentering is done.

User Option: reftex-cite-view-format
Citation format used to display citation info in the message area. See the variable reftex-cite-format for possible percent escapes.

User Option: reftex-revisit-to-echo
Non-nil means, automatic citation display will revisit files if necessary. When nil, citation display in echo area will only be active for cached echo strings (see reftex-cache-cite-echo), or for BibTeX database files which are already visited by a live associated buffers.

User Option: reftex-cache-cite-echo
Non-nil means, the information displayed in the echo area for cite macros (see variable reftex-auto-view-crossref) is cached and saved along with the parsing information. The cache survives document scans. In order to clear it, use M-x reftex-reset-mode.

[ < ] [ > ]   [ << ] [ Up ] [ >> ]         [Top] [Contents] [Index] [ ? ]

8.8 Finding Files

User Option: reftex-texpath-environment-variables
List of specifications how to retrieve the search path for TeX files. Several entries are possible. Multiple directories can be separated by the system dependent path-separator. Directories ending in `//' or `!!' will be expanded recursively. See also reftex-use-external-file-finders.

User Option: reftex-bibpath-environment-variables
List of specifications how to retrieve the search path for BibTeX files. Several entries are possible. Multiple directories can be separated by the system dependent path-separator. Directories ending in `//' or `!!' will be expanded recursively. See also reftex-use-external-file-finders.

User Option: reftex-file-extensions
Association list with file extensions for different file types. This is a list of items, each item is like: (type . (def-ext other-ext ...))
type:       File type like "bib" or "tex".
def-ext:    The default extension for that file type, like ".tex" or ".bib".
other-ext:  Any number of other legal extensions for this file type.
When a files is searched and it does not have any of the legal extensions, we try the default extension first, and then the naked file name.

User Option: reftex-search-unrecursed-path-first
Non-nil means, search all specified directories before trying recursion. Thus, in a path `.//:/tex/', search first `./', then `/tex/', and then all subdirectories of `./'. If this option is nil, the subdirectories of `./' are searched before `/tex/'. This is mainly for speed - most of the time the recursive path is for the system files and not for the user files. Set this to nil if the default makes RefTeX finding files with equal names in wrong sequence.

User Option: reftex-use-external-file-finders
Non-nil means, use external programs to find files. Normally, RefTeX searches the paths given in the environment variables TEXINPUTS and BIBINPUTS to find TeX files and BibTeX database files. With this option turned on, it calls an external program specified in the option reftex-external-file-finders instead. As a side effect, the variables reftex-texpath-environment-variables and reftex-bibpath-environment-variables will be ignored.

User Option: reftex-external-file-finders
Association list with external programs to call for finding files. Each entry is a cons cell (type . program). type is either "tex" or "bib". program is a string containing the external program to use with any arguments. %f will be replaced by the name of the file to be found. Note that these commands will be executed directly, not via a shell. Only relevant when reftex-use-external-file-finders is non-nil.

[ < ] [ > ]   [ << ] [ Up ] [ >> ]         [Top] [Contents] [Index] [ ? ]

8.9 Optimizations

User Option: reftex-keep-temporary-buffers
Non-nil means, keep buffers created for parsing and lookup. RefTeX sometimes needs to visit files related to the current document. We distinguish files visited for
Parts of a multifile document loaded when (re)-parsing the document.
BibTeX database files and TeX files loaded to find a reference, to display label context, etc.
The created buffers can be kept for later use, or be thrown away immediately after use, depending on the value of this variable:

Throw away as much as possible.
Keep everything.
Throw away buffers created for parsing, but keep the ones created for lookup.

If a buffer is to be kept, the file is visited normally (which is potentially slow but will happen only once). If a buffer is to be thrown away, the initialization of the buffer depends upon the variable reftex-initialize-temporary-buffers.

User Option: reftex-initialize-temporary-buffers
Non-nil means do initializations even when visiting file temporarily. When nil, RefTeX may turn off find-file hooks and other stuff to briefly visit a file. When t, the full default initializations are done (find-file-hook etc.). Instead of t or nil, this variable may also be a list of hook functions to do a minimal initialization.

User Option: reftex-no-include-regexps
List of regular expressions to exclude certain input files from parsing. If the name of a file included via \include or \input is matched by any of the regular expressions in this list, that file is not parsed by RefTeX.

User Option: reftex-enable-partial-scans
Non-nil means, re-parse only 1 file when asked to re-parse. Re-parsing is normally requested with a C-u prefix to many RefTeX commands, or with the r key in menus. When this option is t in a multifile document, we will only parse the current buffer, or the file associated with the label or section heading near point in a menu. Requesting re-parsing of an entire multifile document then requires a C-u C-u prefix or the capital R key in menus.

User Option: reftex-save-parse-info
Non-nil means, save information gathered with parsing in files. The file `MASTER.rel' in the same directory as `MASTER.tex' is used to save the information. When this variable is t,

User Option: reftex-parse-file-extension
File extension for the file in which parser information is stored. This extension is added to the base name of the master file.

User Option: reftex-allow-automatic-rescan
Non-nil means, RefTeX may rescan the document when this seems necessary. Applies (currently) only in rare cases, when a new label cannot be placed with certainty into the internal label list.

User Option: reftex-use-multiple-selection-buffers
Non-nil means use a separate selection buffer for each label type. These buffers are kept from one selection to the next and need not to be created for each use - so the menu generally comes up faster. The selection buffers will be erased (and therefore updated) automatically when new labels in its category are added. See the variable reftex-auto-update-selection-buffers.

User Option: reftex-auto-update-selection-buffers
Non-nil means, selection buffers will be updated automatically. When a new label is defined with reftex-label, all selection buffers associated with that label category are emptied, in order to force an update upon next use. When nil, the buffers are left alone and have to be updated by hand, with the g key from the label selection process. The value of this variable will only have any effect when reftex-use-multiple-selection-buffers is non-nil.

[ < ] [ > ]   [ << ] [ Up ] [ >> ]         [Top] [Contents] [Index] [ ? ]

8.10 Fontification

User Option: reftex-use-fonts
Non-nil means, use fonts in label menu and on-the-fly help. Font-lock must be loaded as well to actually get fontified display. After changing this option, a rescan may be necessary to activate it.

User Option: reftex-refontify-context
Non-nil means, re-fontify the context in the label menu with font-lock. This slightly slows down the creation of the label menu. It is only necessary when you definitely want the context fontified.

This option may have 3 different values:

Never refontify.
Always refontify.
Refontify when necessary, e.g. with old versions of the x-symbol package.
The option is ignored when reftex-use-fonts is nil.

User Option: reftex-highlight-selection
Non-nil means, highlight selected text in selection and `*toc*' buffers. Normally, the text near the cursor is the selected text, and it is highlighted. This is the entry most keys in the selection and `*toc*' buffers act on. However, if you mainly use the mouse to select an item, you may find it nice to have mouse-triggered highlighting instead or as well. The variable may have one of these values:

nil      No highlighting.
cursor   Highlighting is cursor driven.
mouse    Highlighting is mouse driven.
both     Both cursor and mouse trigger highlighting.

Changing this variable requires to rebuild the selection and *toc* buffers to become effective (keys g or r).

User Option: reftex-cursor-selected-face
Face name to highlight cursor selected item in toc and selection buffers. See also the variable reftex-highlight-selection.
User Option: reftex-mouse-selected-face
Face name to highlight mouse selected item in toc and selection buffers. See also the variable reftex-highlight-selection.
User Option: reftex-file-boundary-face
Face name for file boundaries in selection buffer.
User Option: reftex-label-face
Face name for labels in selection buffer.
User Option: reftex-section-heading-face
Face name for section headings in toc and selection buffers.
User Option: reftex-toc-header-face
Face name for the header of a toc buffer.
User Option: reftex-bib-author-face
Face name for author names in bib selection buffer.
User Option: reftex-bib-year-face
Face name for year in bib selection buffer.
User Option: reftex-bib-title-face
Face name for article title in bib selection buffer.
User Option: reftex-bib-extra-face
Face name for bibliographic information in bib selection buffer.
User Option: reftex-select-mark-face
Face name for marked entries in the selection buffers.
User Option: reftex-index-header-face
Face name for the header of an index buffer.
User Option: reftex-index-section-face
Face name for the start of a new letter section in the index.
User Option: reftex-index-tag-face
Face name for index names (for multiple indices).
User Option: reftex-index-face
Face name for index entries.

[ < ] [ > ]   [ << ] [ Up ] [ >> ]         [Top] [Contents] [Index] [ ? ]

8.11 Miscellaneous

User Option: reftex-extra-bindings
Non-nil means, make additional key bindings on startup. These extra bindings are located in the users `C-c letter' map. See section 6.2 Default Key Bindings.

User Option: reftex-plug-into-AUCTeX
Plug-in flags for AUCTeX interface. This variable is a list of 5 boolean flags. When a flag is non-nil, RefTeX will

- supply labels in new sections and environments  (flag 1)
- supply arguments for macros like \label         (flag 2)
- supply arguments for macros like \ref           (flag 3)
- supply arguments for macros like \cite          (flag 4)
- supply arguments for macros like \index         (flag 5)

You may also set the variable itself to t or nil in order to turn all options on or off, respectively.
Supplying labels in new sections and environments applies when creating sections with C-c C-s and environments with C-c C-e.
Supplying macro arguments applies when you insert such a macro interactively with C-c RET.
See the AUCTeX documentation for more information.

User Option: reftex-revisit-to-follow
Non-nil means, follow-mode will revisit files if necessary. When nil, follow-mode will be suspended for stuff in unvisited files.

User Option: reftex-allow-detached-macro-args
Non-nil means, allow arguments of macros to be detached by whitespace. When this is t, the `aaa' in `\bbb [xxx] {aaa}' will be considered an argument of \bb. Note that this will be the case even if \bb is defined with zero or one argument.

[ < ] [ > ]   [ << ] [ Up ] [ >> ]         [Top] [Contents] [Index] [ ? ]

8.12 Keymaps and Hooks

RefTeX has the usual general keymap and load-- and mode-hook.

Keymap: reftex-mode-map
The keymap for RefTeX mode.

Normal Hook: reftex-load-hook
Normal hook which is being run when loading `reftex.el'.

Normal Hook: reftex-mode-hook
Normal hook which is being run when turning on RefTeX mode.

Furthermore, the 4 modes used for referencing labels, creating citations, the table of contents buffer and the phrases buffer have their own keymaps and mode hooks. See the respective sections. There are many more hooks which are described in the relevant sections about options for a specific part of RefTeX.

[ << ] [ >> ]           [Top] [Contents] [Index] [ ? ]

This document was generated by XEmacs Webmaster on October, 2 2007 using texi2html