\input texinfo  @c -*-texinfo-*-
@c %**start of header
@c $Id: reftex.texinfo,v 1.68 1998/08/10 13:07:32 dominik Exp dominik $
@setfilename reftex
@settitle RefTeX User Manual
@dircategory Editors
@direntry
* reftex: (reftex).	Support for LaTeX labels, references, and citations
                          with Emacs.
@end direntry
@synindex ky cp
@syncodeindex vr cp
@syncodeindex fn cp
@c %**end of header
@finalout


@ifinfo
This file documents @b{Ref@TeX{}}, a package to do labels, references and
citations for LaTeX documents with Emacs.@refill

This is edition 3.34 of the @b{Ref@TeX{}} User Manual for @b{Ref@TeX{}} 3.34

Copyright (c) 1997, 1998 Free Software Foundation, Inc.

Permission is granted to make and distribute verbatim
copies of this manual provided the copyright notice and
this permission notice are preserved on all copies.
     
@ignore
Permission is granted to process this file through TeX
and print the results, provided the printed document
carries a copying permission notice identical to this
one except for the removal of this paragraph (this
paragraph not being relevant to the printed manual).
     
@end ignore
Permission is granted to copy and distribute modified
versions of this manual under the conditions for
verbatim copying, provided that the entire resulting
derive work is distributed under the terms of a permission
notice identical to this one.
     
Permission is granted to copy and distribute
translations of this manual into another language,
under the above conditions for modified versions,
except that this permission notice may be stated in a
translation approved by the Free Software Foundation.
@end ifinfo

@titlepage
@title Ref@TeX{} User Manual
@subtitle Support for LaTeX labels, references, and citations with GNU Emacs
@subtitle Edition 3.34, June 1998

@author by Carsten Dominik
@page
Copyright @copyright{} 1997, 1998 Free Software Foundation, Inc.

@sp 2
This is edition 3.34 of the @cite{Ref@TeX{} User Manual} for @b{Ref@TeX{}}
version 3.34, June 1998.@refill

@sp 2

Permission is granted to make and distribute verbatim
copies of this manual provided the copyright notice and
this permission notice are preserved on all copies.
     
Permission is granted to copy and distribute modified
versions of this manual under the conditions for
verbatim copying, provided that the entire resulting
derive work is distributed under the terms of a permission
notice identical to this one.
     
Permission is granted to copy and distribute
translations of this manual into another language,
under the above conditions for modified versions,
except that this permission notice may be stated in a
translation approved by the Free Software Foundation.

@end titlepage
@page

@ifinfo
@node Top,,,(dir)

@b{Ref@TeX{}} is a package for managing Labels, References and Citations
with GNU Emacs.@refill

Don't be discouraged by the size of this manual, which covers @b{Ref@TeX{}}
in great depth.  All you need to know to use @b{Ref@TeX{}} can be
summarized on a single page (@pxref{RefTeX in a Nutshell}).  You can go
back later to other parts of this document when needed.@refill

@menu
* Introduction::                     Quick-Start information.

* Labels and References::            Creating and referencing labels.
* Citations::                        Creating Citations.
* Table of Contents::                A Tool to move around quickly.

* RefTeXs Menu::                     The Ref menu in the menubar.
* Keybindings::                      The default keybindings.
* Faces::                            Fontification of RefTeX's buffers.
* AUCTeX::                           Cooperation with AUCTeX.
* Multifile Documents::              Document spread over many files.
* Language Support::                 How to support other languages.
* Optimizations::                    When RefTeX is too slow.
* Problems and Work-Arounds::        First Aid.
* Imprint::                          Author, Web-site, Thanks

* Commands::                         Which are the available commands.
* Options::                          How to extend and configure RefTeX.
* Keymaps and Hooks::                For customization.
* Changes::                          A List of recent changes to RefTeX.

The Index

* Index::                            The full index.

Introduction

* Installation::                     How to install and activate RefTeX.
* RefTeX in a Nutshell::             A brief summary and quick guide.

Labels and References

* Creating Labels::
* Referencing Labels::
* Builtin Label Environments::       The environments RefTeX knows about.
* Defining Label Environments::        ... and environments it doesn't.
* Displaying Cross References::      View the label corresponding to a \ref.
* xr (LaTeX package)::               References to external documents.
* varioref (LaTeX package)::         How to create \vref instead of \ref.

Defining Label Environments

* Theorem and Axiom::                Defined with @code{\newenvironment}.
* Quick Equation::                   When a macro sets the label type.
* Figure Wrapper::                   When a macro argument is a label.
* Adding Magic Words::               Other words for other languages.
* Using \eqref::                     How to switch to this AMS-LaTeX macro.
* Putting it Together::              How to combine many entries.

Citations

* Creating Citations::               How to create them.
* Citation Styles::                  Natbib, Harvard, Chicago and CO.
* Displaying Citations::             View the corresponding database entry.
* Chapterbib and Bibunits::          Multiple bibliographies in a Document.
* Citations Outside LaTeX::          How to make citations in Emails etc.

AUCTeX

* AUCTeX-RefTeX Interface::          How both packages work together
* Style Files::                      AUCTeX's style files can support RefTeX
* Bib-Cite::                         Hypertext reading of a document

Options, Keymaps, Hooks

* Options (Defining Label Environments)::
* Options (Creating Labels)::
* Options (Referencing Labels)::
* Options (Creating Citations)::
* Options (Table of Contents)::
* Options (Viewing Cross References)::
* Options (Optimizations)::
* Options (Fontification)::
* Options (Misc)::

@end menu

@end ifinfo

@node Introduction, Labels and References, , Top
@chapter Introduction
@cindex Introduction

@b{Ref@TeX{}} is a specialized package for support of labels, references,
and citations in LaTeX.  @b{Ref@TeX{}} wraps itself round 3 LaTeX macros:
@code{\label}, @code{\ref}, and @code{\cite}.  Using these macros
usually requires looking up different parts of the document and
searching through BibTeX database files.  @b{Ref@TeX{}} automates these
time--consuming tasks almost entirely.  It also provides functions to
display the structure of a document and to move around in this structure
quickly.@refill

@iftex
Don't be discouraged by the size of this manual, which covers @b{Ref@TeX{}}
in great depth.  All you need to know to use @b{Ref@TeX{}} can be
summarized on a single page (@pxref{RefTeX in a Nutshell}).  You can go
back later to other parts of this document when needed.
@end iftex

@menu
* Installation::                     How to install and activate RefTeX.
* RefTeX in a Nutshell::             A brief summary and quick guide.
@end menu

@node Installation, RefTeX in a Nutshell, , Introduction
@section Installation
@cindex Installation

If you are using Emacs 20.2 and later or XEmacs 19.16 or 20.2 and
later, @b{Ref@TeX{}} is installed already.@refill

@section Entering @b{Ref@TeX{}} Mode

@findex turn-on-reftex
@findex reftex-mode
To turn @b{Ref@TeX{}} Mode on and off in a particular buffer, use
@kbd{M-x reftex-mode}.  To turn on @b{Ref@TeX{}} Mode for all LaTeX
files, add the following lines to your @file{.emacs} file:@refill

@example
(add-hook 'LaTeX-mode-hook 'turn-on-reftex)   ; with AUCTeX LaTeX mode
(add-hook 'latex-mode-hook 'turn-on-reftex)   ; with Emacs latex mode
@end example

@page
@node RefTeX in a Nutshell, , Installation, Introduction
@section @b{Ref@TeX{}} in a Nutshell
@cindex Quick-Start
@cindex Getting Started
@cindex RefTeX in a Nutshell
@cindex Nutshell, RefTeX in a

@enumerate
@item
@b{Labels and References}@* 
@b{Ref@TeX{}} distinguishes labels for different environments.  It knows
about all standard environments (and many others), and can be configured
to recognize any additional labeled environments you have defined
yourself (variable @var{reftex-label-alist}).@refill
@itemize @bullet
@item
@b{Creating Labels}@* 
Type @kbd{C-c (} (@code{reftex-label}) to insert a label at point.
@b{Ref@TeX{}} will either
@itemize @minus
@item
derive a label from context (default for section labels)
@item
prompt for a label string (default for figures and tables) or
@item
insert a simple label made of a prefix and a number (all other
environments).@refill
@end itemize
@noindent
Which labels are created how is configurable (variable
@var{reftex-insert-label-flags}).@refill

@item
@b{Referencing Labels}@* 
In order to make a reference, type @kbd{C-c )}
(@code{reftex-reference}).  This shows an outline of the document with
all labels of a certain type (figure, equation,...) and context of the
label definition.  Selecting a label inserts a @code{\ref@{LABEL@}}
macro into the original buffer.@refill
@end itemize

@item
@b{Citations}@* 
After typing @kbd{C-c [} (@code{reftex-citation}), @b{Ref@TeX{}} will
let you specify a regular expression to search in current BibTeX
database files (as specified in the @code{\bibliography} command) and
pull out a list of matches for you to choose from.  The list is
@emph{formatted} and sorted.  The selected article is referenced as
@samp{\cite@{KEY@}} (customizable with variable
@var{reftex-cite-format}).@refill

@item
@b{Viewing Cross References}@*
When no other message occupies the echo area and point is idle on the
argument of a @code{\ref} or @code{\cite} macro, the echo area will
display information about the citation/cross reference.@* 
With point on or anywhere before such a macro, press @kbd{C-c &}
(@code{reftex-view-crossref}), or click with @kbd{S-mouse-2} on the
macro argument.  This will display the corresponding label definition or
BibTeX database entry in another window.  @refill

@item
@b{Table of Contents}@* 
Typing @kbd{C-c =} (@code{reftex-toc}) will show a table of contents of
the document.  From that buffer, you can jump quickly to every part of
your document.@refill

@item
@b{Multifile Documents}@* Multifile Documents are fully
supported. @b{Ref@TeX{}} will provide cross referencing information from
all files which are part of the document, and even across document
borders (@file{xr.sty}).@refill

@item
@b{Document Parsing}@*
@b{Ref@TeX{}} needs to parse the document in order to find labels and
other information.  It does it automatically once, when you start
working with a document.  @b{Ref@TeX{}} updates its lists internally
when you make a new label with @code{reftex-label}.  To enforce
reparsing, call any of the commands described above with a raw @kbd{C-u}
prefix, or press the @kbd{r} key in the label selection buffer or the
table of contents buffer.@refill

@item
@b{Speed Issues}@*
Useful settings to make @b{Ref@TeX{}} faster for large
(multifile) documents include:@refill
@lisp
(setq reftex-enable-partial-scans t)
(setq reftex-save-parse-info t)
(setq reftex-use-multiple-selection-buffers t)
@end lisp
@end enumerate

@node Labels and References, Citations, Introduction, Top
@chapter Labels and References
@cindex Labels in LaTeX
@cindex References in LaTeX
@cindex Label category
@cindex Label environment
@cindex @code{\label}

LaTeX provides a powerful mechanism to deal with cross references in a
document.  When writing a document, any part of it can be marked with a
label, like @samp{\label@{mark@}}.  LaTeX records the current value of a
certain counter when a label is defined.  Later references to this label
(like @samp{\ref@{mark@}}) will produce the recorded value of the
counter.@refill

Labels can be used to mark sections, figures, tables, equations,
footnotes, items in enumerate lists etc.  LaTeX is context sensitive in
doing this: A label defined in a figure environment automatically
records the figure counter, not the section counter.@refill

Several different environments can share a common counter and therefore
a common label category.  E.g.  labels in both @code{equation} and
@code{eqnarray} environments record the value of the same counter - the
equation counter.@refill

@menu
* Creating Labels::
* Referencing Labels::
* Builtin Label Environments::       The environments RefTeX knows about.
* Defining Label Environments::        ... and environments it doesn't.
* Displaying Cross References::      View the label corresponding to a \ref.
* xr (LaTeX package)::               References to external documents.
* varioref (LaTeX package)::         How to create \vref instead of \ref.
@end menu

@node Creating Labels, Referencing Labels, , Labels and References
@section Creating Labels
@cindex Creating labels
@cindex Labels, creating
@cindex Labels, deriving from context
@kindex C-c (
@findex reftex-label

In order to create a label in a LaTeX document, press @kbd{C-c (}
(@code{reftex-label}).  Just like LaTeX, @b{Ref@TeX{}} is context sensitive
and will figure out the environment it currently is in and adapt the
label to that environment.  A label usually consists of a short prefix
indicating the type of the label and a unique mark.  @b{Ref@TeX{}} has
3 different modes to create this mark.@refill

@enumerate
@item
A label can be derived from context.  This means, @b{Ref@TeX{}} takes
the context of the label definition and construct a label from
that@footnote{Note that @b{Ref@TeX{}} will remove Mule characters from
the string before converting it to a label. @xref{Language Support} for
additional information.}.  This works best for section labels, where the
section heading is used to construct a label.  In fact, @b{Ref@TeX{}}'s
default settings use this method only for section labels.  You will be
asked to confirm the derived label, or edit it.@refill

@item
We may also use a simple unique number to identify a label.  This is
mostly useful for labels where it is difficult to come up with a very
good descriptive name.  @b{Ref@TeX{}}'s default settings use this method
for equations, enumerate items and footnotes.  The author of @b{Ref@TeX{}}
tends to write documents with many equations and finds it impossible
to come up with good names for each of them.  These simple labels are
inserted without query, and are therefore very fast.  Good descriptive
names are not really necessary as @b{Ref@TeX{}} will provide context to
reference a label (@pxref{Referencing Labels}).@refill

@item
The third method is to ask the user for a label.  This is most
useful for things which are easy to describe briefly and do not turn up
too frequently in a document.  @b{Ref@TeX{}} uses this for figures and
tables.  Of course, one can enter the label directly by typing the full
@samp{\label@{mark@}}.  The advantage of using @code{reftex-label}
anyway is that @b{Ref@TeX{}} will know that a new label has been defined.
It will then not be necessary to rescan the document in order to access
this label later.@refill
@end enumerate

If you want to change the way certain labels are created, check out the
variable @var{reftex-insert-label-flags} (@pxref{Options (Creating
Labels)}).@refill

If you are using AUCTeX to write your LaTeX documents, you can
set it up to delegate the creation of labels to
@b{Ref@TeX{}}. @xref{AUCTeX} for more information.

@page
@node Referencing Labels, Builtin Label Environments, Creating Labels, Labels and References
@section Referencing Labels
@cindex Referencing labels
@cindex Labels, referencing
@cindex Selection buffer, labels
@cindex Selection process
@cindex @code{\ref}
@kindex C-c )
@findex reftex-reference

Referencing Labels is really at the heart of @b{Ref@TeX{}}.  Press @kbd{C-c
)} in order to reference a label (reftex-reference).  This will start a
selection process and finally insert the complete @samp{\ref@{label@}}
into the buffer.@refill

First, @b{Ref@TeX{}} will determine the label category which is required.
Often that can be figured out from context.  For example, if you
write @samp{As shown in eq.} and the press @kbd{C-c )}, @b{Ref@TeX{}} knows
that an equation label is going to be referenced.  If it cannot figure
out what label category is needed, it will query for one.@refill

You will then be presented with a label selection menu.  This is a
special buffer which contains an outline of the document along with all
labels of the given label category.  In addition, next to the label
there will be one line of context of the label definition, which is some
text in the buffer near the label definition.  Usually this is
sufficient to identify the label.  If you are unsure about a certain
label, pressing @kbd{SPC} will show the label definition point in
another window.@refill

In order to reference a label, move to cursor to the correct label and
press @kbd{RET}.@* Here is a list of special commands available in the
selection buffer.  A summary of this information is always available
from the selection process by pressing @kbd{?}.@refill

@table @kbd
@item 0-9,-
Prefix argument.

@item b
Jump back to the position where you last left the selection buffer.
Normally this should get you back to the last referenced label.@refill

@item c
Toggle the display of the one-line label definition context in the
selection buffer.@refill

@item f
Toggle follow mode.  When follow mode is active, the other window will
always display the full context of the current label.  This is similar
to pressing @key{SPC} after each cursor motion.  Note that only context
in files already visited is shown.  @b{RefTeX} will not visit a file
just for follow mode.  See, however, the variable
@var{reftex-revisit-to-follow}.@refill

@item g
Update the menu.  This will rebuilt the menu from the internal label
list, but not reparse the document (see @kbd{r}).@refill

@item i
Toggle the display of the file borders of a multifile document in the
selection buffer.@refill

@item l
Use the last referenced label again.  This is equivalent to moving to
that label again and pressing @kbd{RET}.@refill

@item n
Go to next label.

@item p
Go to previous label.

@item q
Exit the selection process without inserting any reference into the
buffer.@refill

@item r
Reparse the document to update the information on all labels and rebuild
the menu.  If the variable @var{reftex-enable-partial-scans} is
non-@code{nil} and your document is a multifile document, this will
reparse only a a part of the document (the file the label at point was
defined in).@refill

@item R
Reparse the @emph{entire} document.

@item s
Switch the label category.  After prompting for another label category,
a menu for that category will be shown.@refill

@item t
Toggle the display of the table of contents in the selection buffer.@refill

@item v
Toggle between @code{\ref} and @code{\vref} macro for references.  The
@code{\vref} macro is defined in the @code{varioref} LaTeX package.
With this key you can force @b{Ref@TeX{}} to insert a @code{\vref} macro.  The
current state of this flag is displayed in the mode line of the
selection buffer.@refill

@item x
Reference a label from an external document.  With the LaTeX package
@code{xr} it is possible to reference labels defined in another
document.  This key will switch to the label menu of an external
document and let you select a label from there (@pxref{xr (LaTeX
package),,xr}).@refill

@item .
Show insertion point in another window.  This is the point from where you
called @code{reftex-reference}.@refill

@item TAB
Enter a label with completion.  This may also be a label which does not
yet exist in the document.

@item SPC
Show the surroundings of the definition of the current label in another
window.  See also the @kbd{f} key.@refill

@item RET
Insert a reference to the label at point into the buffer from which the
selection process was started.@refill

@item mouse-2
Clicking with mouse button 2 on a label will accept it like @key{RET}
would. See also variable @var{reftex-highlight-selection}, @ref{Options
(Misc)}.@refill

@item #
Toggle the display of a label counter in the selection buffer.@refill

@item %
Toggle the display of labels hidden in comments in the selection
buffers.  Sometimes, you may have commented out parts of your document.
If these parts contain label definitions, @b{Ref@TeX{}} can still display
and reference these labels.@refill

@item ?
Show a summary of the available keys.

@item C-c C-n
Goto next section heading (like outline mode).

@item C-c C-p
Goto previous section heading (like outline mode).

@end table

Several of these keys toggle certain settings.  The default value for
these flags can be preset by configuring the variable
@var{reftex-label-menu-flags} (@pxref{Options (Referencing Labels)}).
In order to define additional commands for the selection process, the
keymap @var{reftex-select-label-map} may be used.@refill

@node Builtin Label Environments, Defining Label Environments, Referencing Labels, Labels and References
@section Builtin Label Environments
@cindex Builtin label environments
@cindex Label environments, builtin
@cindex Environments, builtin
@vindex reftex-label-alist
@vindex reftex-label-alist-builtin

@b{Ref@TeX{}} needs to be aware of the environments which can be referenced
with a label (i.e. which carry their own counters).  By default, @b{Ref@TeX{}}
recognizes all labeled environments and macros discussed in @cite{The
LaTeX Companion by Goossens, Mittelbach & Samarin, Addison-Wesley
1994.}.  These are:@refill

@itemize @minus
@item
@cindex @code{figure}, LaTeX environment
@cindex @code{figure*}, LaTeX environment
@cindex @code{table}, LaTeX environment
@cindex @code{table*}, LaTeX environment
@cindex @code{equation}, LaTeX environment
@cindex @code{eqnarray}, LaTeX environment
@cindex @code{enumerate}, LaTeX environment
@cindex @code{\footnote}, LaTeX macro
@cindex LaTeX macro @code{footnote}
@cindex LaTeX core
@code{figure}, @code{figure*}, @code{table}, @code{table*}, @code{equation},
@code{eqnarray}, @code{enumerate}, the @code{\footnote} macro (this is
the LaTeX core stuff)@refill
@item
@cindex AMS-LaTeX
@cindex @code{amsmath}, LaTeX package
@cindex LaTeX packages, @code{amsmath}
@cindex @code{align}, AMS-LaTeX environment
@cindex @code{gather}, AMS-LaTeX environment
@cindex @code{multline}, AMS-LaTeX environment
@cindex @code{flalign}, AMS-LaTeX environment
@cindex @code{alignat}, AMS-LaTeX environment
@cindex @code{xalignat}, AMS-LaTeX environment
@cindex @code{xxalignat}, AMS-LaTeX environment
@cindex @code{subequations}, AMS-LaTeX environment
@code{align}, @code{gather}, @code{multline}, @code{flalign},
@code{alignat}, @code{xalignat}, @code{xxalignat}, @code{subequations}
(from AMS-LaTeX's @file{amsmath.sty} package)@refill
@item
@cindex @code{endnote}, LaTeX package
@cindex LaTeX packages, @code{endnote}
@cindex @code{\endnote}, LaTeX macro
the @code{\endnote} macro (from @file{endnotes.sty})
@item
@cindex @code{fancybox}, LaTeX package
@cindex LaTeX packages, @code{fancybox}
@cindex @code{Beqnarray}, LaTeX environment
@code{Beqnarray} (@file{fancybox.sty})
@item
@cindex @code{floatfig}, LaTeX package
@cindex LaTeX packages, @code{floatfig}
@cindex @code{floatingfig}, LaTeX environment
@code{floatingfig} (@file{floatfig.sty})
@item
@cindex @code{longtable}, LaTeX package
@cindex LaTeX packages, @code{longtable}
@cindex @code{longtable}, LaTeX environment
@code{longtable} (@file{longtable.sty})
@item
@cindex @code{picinpar}, LaTeX package
@cindex LaTeX packages, @code{picinpar}
@cindex @code{figwindow}, LaTeX environment
@cindex @code{tabwindow}, LaTeX environment
@code{figwindow}, @code{tabwindow} (@file{picinpar.sty})
@item
@cindex @code{sidecap}, LaTeX package
@cindex LaTeX packages, @code{sidecap}
@cindex @code{SCfigure}, LaTeX environment
@cindex @code{SCtable}, LaTeX environment
@code{SCfigure}, @code{SCtable} (@file{sidecap.sty})
@item
@cindex @code{rotating}, LaTeX package
@cindex LaTeX packages, @code{rotating}
@cindex @code{sidewaysfigure}, LaTeX environment
@cindex @code{sidewaystable}, LaTeX environment
@code{sidewaysfigure}, @code{sidewaystable} (@file{rotating.sty})
@item
@cindex @code{subfig}, LaTeX package
@cindex LaTeX packages, @code{subfigure}
@cindex @code{subfigure}, LaTeX environment
@cindex @code{subfigure*}, LaTeX environment
@code{subfigure}, @code{subfigure*}, the @code{\subfigure} macro
(@file{subfigure.sty})@refill
@item
@cindex @code{supertab}, LaTeX package
@cindex LaTeX packages, @code{supertab}
@cindex @code{supertabular}, LaTeX environment
@code{supertabular} (@file{supertab.sty})
@item
@cindex @code{wrapfig}, LaTeX package
@cindex LaTeX packages, @code{wrapfig}
@cindex @code{wrapfigure}, LaTeX environment
@code{wrapfigure} (@file{wrapfig.sty})
@end itemize

If you want to use other labeled environments, for example some defined
with @code{\newtheorem}, @b{Ref@TeX{}} needs to be configured to recognize them
(@pxref{Defining Label Environments}).@refill

@node Defining Label Environments, Displaying Cross References, Builtin Label Environments, Labels and References
@section Defining Label Environments
@cindex Label environments, defining
@vindex reftex-label-alist

@b{Ref@TeX{}} can be configured to recognize additional labeled
environments and macros.  This is done with the variable
@var{reftex-label-alist} (@pxref{Options (Defining Label
Environments)}).  If you are not familiar with Lisp, you should use the
@code{custom} library to configure this rather complex variable.  To do
this, use

@example
@kbd{M-x customize-variable @key{RET} reftex-label-alist @key{RET}}
@end example

Here we will discuss a few examples, in order to make things clearer.
It can also be instructive to look at the constant
@var{reftex-label-alist-builtin} which contains the entries for
all the builtin environments and macros (@pxref{Builtin Label
Environments}).@refill

@menu
* Theorem and Axiom::                Defined with @code{\newenvironment}.
* Quick Equation::                   When a macro sets the label type.
* Figure Wrapper::                   When a macro argument is a label.
* Adding Magic Words::               Other words for other languages.
* Using \eqref::                     How to switch to this AMS-LaTeX macro.
* Putting it Together::              How to combine many entries.
@end menu

@node Theorem and Axiom, Quick Equation, , Defining Label Environments
@subsection Theorem and Axiom Environments
@cindex @code{theorem}, newtheorem
@cindex @code{axiom}, newtheorem
@cindex @code{\newtheorem}

Suppose you are using @code{\newtheorem} in LaTeX in order to define two
new environments, @code{theorem} and @code{axiom}@refill

@example
\newtheorem@{axiom@}@{Axiom@}
\newtheorem@{theorem@}@{Theorem@}
@end example

@noindent
to be used like this:

@example
\begin@{axiom@}
\label@{ax:first@}
  ....
\end@{axiom@}
@end example

So we need to tell @b{Ref@TeX{}} that @code{theorem} and @code{axiom} are new
labeled environments which define their own label categories.  We can
either use Lisp to do this (e.g. in @file{.emacs}) or use the custom
library.  With lisp it would look like this

@lisp
(setq reftex-label-alist
   '(("axiom"   ?a "ax:"  "~\\ref@{%s@}" nil ("axiom"   "ax."))
     ("theorem" ?h "thr:" "~\\ref@{%s@}" t   ("theorem" "theor." "th."))))
@end lisp

The type indicator characters @code{?a} and @code{?h} are used for
prompts when @b{Ref@TeX{}} queries for a label type.  Note that @code{?h}
was chosen for @code{theorem} since @code{?t} is already taken by
@code{table}.  Note that also @code{?s}, @code{?f}, @code{?e},
@code{?i}, @code{?n} are already used for standard environments.@refill

@noindent
The labels for Axioms and Theorems will have the prefixes @samp{ax:} and
@samp{thr:}, respectively.  @xref{AUCTeX} for information on how
AUCTeX can use @b{Ref@TeX{}} to automatically create labels when a new
environment is inserted into a buffer.@refill

@noindent
The @samp{~\ref@{%s@}} is a format string indicating how to insert
references to these labels.@refill

@noindent
The next item indicates how to grab context of the label definition.@refill
@itemize @minus
@item
@code{t} means to get it from a default location (from the beginning of
a @code{\macro} or after the @code{\begin} statement).  @code{t} is
@emph{not} a good choice for eqnarray and similar environments.@refill
@item
@code{nil} means to use the text right after the label definition.@refill
@item
For more complex ways of getting context, see the variable
@var{reftex-label-alist} (@pxref{Options (Defining Label
Environments)}).@refill
@end itemize

The strings at the end of each entry are used to guess the correct label
type from the word before point when creating a reference.  E.g. if you
write: @samp{As we have shown in Theorem} and then press @kbd{C-c )},
@b{Ref@TeX{}} will know that you are looking for a theorem label and restrict
the menu to only these labels without even asking.@refill

To do the same configuration with @code{customize}, you need to click on
the @code{[INS]} button twice to create two templates and fill them in
like this:@refill

@example
Reftex Label Alist: [Hide]
[INS] [DEL] Package or Detailed   : [Value Menu] Detailed:
            Environment or \macro : [Value Menu] String: axiom
            Type specification    : [Value Menu] Char  : a
            Label prefix string   : [Value Menu] String: ax:
            Label reference format: [Value Menu] String: ~\ref@{%s@}
            Context method        : [Value Menu] After label
            Magic words:
              [INS] [DEL] String: axiom
              [INS] [DEL] String: ax.
              [INS]
[INS] [DEL] Package or Detailed   : [Value Menu] Detailed:
            Environment or \macro : [Value Menu] String: theorem
            Type specification    : [Value Menu] Char  : h
            Label prefix string   : [Value Menu] String: thr:
            Label reference format: [Value Menu] String: ~\ref@{%s@}
            Context method        : [Value Menu] Default position
            Magic words:
              [INS] [DEL] String: theorem
              [INS] [DEL] String: theor.
              [INS] [DEL] String: th.
              [INS]
@end example

Depending on how you would like the label insertion and selection for
the new environments to work, you might want to add the letters @samp{a}
and @samp{h} to some of the flags in the variables
@var{reftex-insert-label-flags} (@pxref{Options (Creating Labels)})
and @var{reftex-label-menu-flags} (@pxref{Options (Referencing
Labels)}).@refill


@node Quick Equation, Figure Wrapper, Theorem and Axiom , Defining Label Environments
@subsection Quick Equation Macro
@cindex Quick equation macro
@cindex Macros as environment wrappers

Suppose you would like to have a macro for quick equations.  It
could be defined like this:

@example
\newcommand@{\quickeq@}[1]@{\begin@{equation@} #1 \end@{equation@}@}
@end example

@noindent
and used like this:

@example
Einstein's equation is \quickeq@{E=mc^2 \label@{eq:einstein@}@}.
@end example

We need to tell @b{Ref@TeX{}} that any label defined in the argument of the
@code{\quickeq} is an equation label.  Here is how to do this with lisp:

@lisp
(setq reftex-label-alist '(("\\quickeq@{@}" ?e nil nil 1 nil)))
@end lisp

The first element in this list is now the macro with empty braces as an
@emph{image} of the macro arguments.  @code{?e} indicates that this is
an equation label, the different @code{nil} elements indicate to use the
default values for equations.  The @samp{1} as the fifth element
indicates that the context of the label definition should be the 1st
argument of the macro.@refill

Here is again how this would look in the customization buffer:

@example
Reftex Label Alist: [Hide]
[INS] [DEL] Package or Detailed   : [Value Menu] Detailed:
            Environment or \macro : [Value Menu] String: \quickeq@{@}
            Type specification    : [Value Menu] Char  : h
            Label prefix string   : [Value Menu] Default
            Label reference format: [Value Menu] Default
            Context method        : [Value Menu] Macro arg nr: 1
            Magic words:
              [INS]
@end example

@node Figure Wrapper, Adding Magic Words, Quick Equation, Defining Label Environments
@subsection Figure Wrapping Macro
@cindex Macros as environment wrappers
@cindex Figure wrapping macro

Suppose you want to make figures not directly with the figure
environment, but with a macro like

@example
\newcommand@{\myfig@}[5][tbp]@{%
  \begin@{figure@}[#1]
    \epsimp[#5]@{#2@}
    \caption@{#3@}
    \label@{#4@}
  \end@{figure@}@}
@end example

@noindent
which would be called like

@example
\myfig[htp]@{filename@}@{caption text@}@{label@}@{1@}
@end example

Now we need to tell @b{Ref@TeX{}} that the 4th argument of the
@code{\myfig} macro @emph{is itself} a figure label, and where to find
the context.@refill

@lisp
(setq reftex-label-alist
      '(("\\myfig[]@{@}@{@}@{*@}@{@}" ?f nil nil 3)))
@end lisp

The empty pairs of brackets indicate the different arguments of the
@code{\myfig} macro. The @samp{*} marks the label argument.  @code{?f}
indicates that this is a figure label which will be listed together with
labels from normal figure environments.  The @code{nil} entries for
prefix and reference format mean to use the defaults for figure labels.
The @samp{3} for the context method means to grab the 3rd macro argument
- the caption.@refill

As a side effect of this configuration, @code{reftex-label} will now
insert the required naked label (without the @code{\label} macro) when
point is directly after the opening parenthesis of a @code{\myfig} macro
argument.@refill

Again, here the configuration in the customization buffer:

@example
[INS] [DEL] Package or Detailed   : [Value Menu] Detailed:
            Environment or \macro : [Value Menu] String: \myfig[]@{@}@{@}@{*@}@{@}
            Type specification    : [Value Menu] Char  : f 
            Label prefix string   : [Value Menu] Default
            Label reference format: [Value Menu] Default
            Context method        : [Value Menu] Macro arg nr: 3
            Magic words:
              [INS]
@end example

@node Adding Magic Words, Using \eqref, Figure Wrapper, Defining Label Environments
@subsection Adding Magic Words
@cindex Magic words
@cindex German magic words
@cindex Label category

Sometimes you don't want to define a new label environment or macro, but
just change the information associated with a label category.  Maybe you
want to add some magic words, for another language.  Changing only the
information associated with a label category is done by giving
@code{nil} for the environment name and then specify the items you want
to define.  Here is an example which adds German magic words to all
predefined label categories.@refill

@lisp
(setq reftex-label-alist
  '((nil ?s nil nil nil ("Kapitel" "Kap." "Abschnitt" "Teil"))
    (nil ?e nil nil nil ("Gleichung" "Gl."))
    (nil ?t nil nil nil ("Tabelle"))
    (nil ?f nil nil nil ("Figur" "Abbildung" "Abb."))
    (nil ?n nil nil nil ("Anmerkung" "Anm."))
    (nil ?i nil nil nil ("Punkt"))))
@end lisp

@node Using \eqref, Putting it Together, Adding Magic Words, Defining Label Environments
@subsection Using @code{\eqref}
@cindex @code{\eqref}, AMS-LaTeX macro
@cindex AMS-LaTeX
@cindex Label category

Another case where one only wants to change the information associated
with the label category is to change the macro which is used for
referencing the label.  When working with the AMS-LaTeX stuff, you might
prefer the @code{\eqref} for doing equation references.  Here is how to
do this:

@lisp
(setq reftex-label-alist '((nil ?e nil "~\\eqref@{%s@}" nil nil)))
@end lisp

@b{Ref@TeX{}} has also a predefined symbol for this special purpose.  The
following is equivalent to the line above.@refill

@lisp
(setq reftex-label-alist '(AMSTeX))
@end lisp

Note that this is automatically done by the @file{amsmath.el} style file
of AUCTeX (@pxref{Style Files}) - so if you use AUCTeX,
this configuration will not be necessary.@refill

@node Putting it Together, , Using \eqref, Defining Label Environments
@subsection Putting it all together

When you have to put several entries into @var{reftex-label-alist}, just
put them after each other in a list, or create that many templates in
the customization buffer.  Here is a lisp example which uses several of
the entries described above:

@lisp
(setq reftex-label-alist
  '(("axiom"   ?a "ax:"  "~\\ref@{%s@}" nil ("axiom"   "ax."))
    ("theorem" ?h "thr:" "~\\ref@{%s@}" t   ("theorem" "theor." "th."))
    ("\\quickeq@{@}" ?e nil nil 1 nil)
    AMSTeX
    ("\\myfig[]@{@}@{@}@{*@}@{@}" ?f nil nil 3)))
@end lisp

@node Displaying Cross References, xr (LaTeX package), Defining Label Environments, Labels and References
@section Displaying Cross References
@findex reftex-view-crossref
@findex reftex-mouse-view-crossref
@cindex Cross references, displaying
@cindex Displaying cross references
@cindex Viewing cross references
@kindex C-c &

@b{Ref@TeX{}} can display the definition site of a label which is
referenced in the text.  With the cursor on or anywhere before a
@code{\ref} macro, type @kbd{C-c &}.  Or klick with @kbd{S-mouse-2} on
the argument of the macro.  @b{Ref@TeX{}} will then display the definition
of the label in another window.  This works also with references to
external labels (@pxref{xr (LaTeX package)}).@refill

@b{Ref@TeX{}} also uses the echo area to display short information about
the cross reference whenever the cursor is inside the argument of a
@code{\ref} macro.  Note that the information is only displayed if the
echo area is not occupied by a different message.  You can toggle this
feature from the menu @w{(@code{Ref->Options->Crossref Viewing})}, or
turn it off completely by configuring the variable
@var{reftex-auto-view-crossref}.@refill

See also @ref{Displaying Citations}.

@node xr (LaTeX package), varioref (LaTeX package), Displaying Cross References, Labels and References
@section @code{xr}: Cross-Document References
@cindex @code{xr}, LaTeX package
@cindex LaTeX packages, @code{xr}
@cindex @code{\externaldocument}
@cindex External documents
@cindex References to external documents
@cindex Cross-document references

The LaTeX package @code{xr} makes it possible to create references to
labels defined in external documents.  The preamble of a document using
@code{xr} will contain something like this:@refill

@example
\usepackage@{xr@}
\externaldocument[V1-]@{volume1@}
\externaldocument[V3-]@{volume3@}
@end example

@noindent
and we can make references to any labels defined in these
external documents by using the prefixes @samp{V1-} and @samp{V3-},
respectively.@refill

@b{Ref@TeX{}} can be used to create such references as well.  Start the
referencing process normally, by pressing @kbd{C-c )}.  Select a label
type if necessary.  When you see the label selection buffer, pressing
@kbd{x} will switch to the label selection buffer of one of the external
documents.  You may then select a label as before and @b{Ref@TeX{}} will
insert it along with the required prefix.@refill

For this kind of inter-document cross references, saving of parsing
information and the use of multiple selection buffers can mean a large
speed-up (@pxref{Optimizations}).@refill

@node varioref (LaTeX package), , xr (LaTeX package), Labels and References
@section @code{varioref}: Variable Page References
@cindex @code{varioref}, LaTeX package
@cindex @code{\vref}
@cindex LaTeX packages, @code{varioref}

@code{varioref} is a frequently used LaTeX package to create cross
references with page information.  When you want to make a reference
with the @code{\vref} macro, just press the @kbd{v} key in the selection
buffer to toggle between the @code{\ref} and @code{\vref}
(@pxref{Referencing Labels}).  The mode line of the selection buffer
shows the current status of this switch.  If you find that you almost
always use @code{\vref}, you may want to make it the default by
customizing the variable @var{reftex-vref-is-default}@refill

@node Citations, Table of Contents, Labels and References, Top
@chapter Citations
@cindex Citations
@cindex @code{\cite}

Citations in LaTeX are done with the @code{\cite} macro or variations of
it.  The argument of the macro is a citation key which identifies a piece
of literature in either a BibTeX database file or in an explicit
@code{thebibliography} environment in the document.  @b{Ref@TeX{}}'s support
for citations helps to select the correct key quickly.@refill

@menu
* Creating Citations::               How to create them.
* Citation Styles::                  Natbib, Harvard, Chicago and CO.
* Displaying Citations::             View the corresponding database entry.
* Chapterbib and Bibunits::          Multiple bibliographies in a Document.
* Citations Outside LaTeX::          How to make citations in Emails etc.
@end menu

@node Creating Citations, Citation Styles, , Citations
@section Creating Citations
@cindex Creating citations
@cindex Citations, creating
@findex reftex-citation
@kindex C-c [
@cindex Selection buffer, citations
@cindex Selection process

In order to create a citation, press @kbd{C-c [}.  @b{Ref@TeX{}} then
prompts for a regular expression which will be used to search through
the database and present the list of matches to choose from in a
selection process similar to that for selecting labels
(@pxref{Referencing Labels}).@refill

The regular expression uses an extended syntax: @samp{&&} defines a
logic @code{and} for regular expressions. For example
@samp{Einstein&&Bose} will match all articles which mention
Bose-Einstein condensation, or which are co-authored by Bose and
Einstein.  When entering the regular expression, you can complete on
known citation keys.@refill

@cindex @code{\bibliography}
@cindex @code{thebibliography}, LaTeX environment
@b{Ref@TeX{}} prefers to use BibTeX database files specified with a
@code{\bibliography} macro to collect its information.  However, if you
have an explicit @code{thebibliography} environment in your document, it
will be scanned instead.  Note that in this case the information
presented in the selection buffer will just be a copy of relevant
@code{\bibitems}, not the structured listing available with BibTeX
database files.@refill

In the selection buffer, the following keys provide special commands.  A
summary of this information is always available from the selection
process by pressing @kbd{?}.@refill

@table @kbd
@item 0-9,-
Prefix argument.

@item a
Accept all entries in the selection buffer and create @code{\cite}
macros referring to them.@refill

@item f
Toggle follow mode.  When follow mode is active, the other window will
always display the full database entry of the current article.  This is
equivalent to pressing SPC after each cursor motion.  With BibTeX
entries, follow mode can be rather slow.@refill

@item g
Start over with a new regular expression.  The full database will be
rescanned with the new expression (see also @kbd{r}).@refill

@item n
Go to next article.

@item p
Go to previous article.

@item q
Exit the selection process without inserting a citation into the
buffer.@refill

@item r
Refine the current selection with another regular expression.  This will
@emph{not} rescan the entire database, but just the already selected
entries.@refill

@item .
Show insertion point in another window.  This is the point from where you
called @code{reftex-citation}.@refill


@item TAB
Enter a citation key with completion.  This may also be a key which does
not yet exist.

@item SPC
Show the database entry corresponding to the article at point, in
another window.  See also the @kbd{f} key.@refill

@item RET
Insert a citation referencing the article at point into the buffer from
which the selection process was started.@refill

@item mouse-2
Clicking with mouse button 2 on a citation will accept it like @key{RET}
would.  See also variable @var{reftex-highlight-selection}, @ref{Options
(Misc)}.@refill

@item ?
Show a summary of the available keys.
@end table

In order to define additional commands for this selection process, the
keymap @var{reftex-select-bib-map} may be used.@refill

@node Citation Styles, Displaying Citations, Creating Citations, Citations
@section Citation Styles
@cindex Citation styles
@cindex Citation styles, @code{natbib}
@cindex Citation styles, @code{harvard}
@cindex Citation styles, @code{chicago}
@cindex @code{natbib}, citation style
@cindex @code{harvard}, citation style
@cindex @code{chicago}, citation style

The standard LaTeX macro @code{\cite} works well with numeric or simple
key citations.  To deal with the more complex task of author-year
citations as used in many natural sciences, a variety of packages has
been developed which define derived forms of the @code{\cite} macro.
@b{Ref@TeX{}} can be configured to produce these citation macros as well by
setting the variable @var{reftex-cite-format}.  For the most commonly
used packages (@code{natbib}, @code{harvard}, @code{chicago}) this may
be done from the menu, under @code{Ref->Options->Citations}.  Since there
are usually several macros to create the citations, executing
@code{reftex-citation} (@kbd{C-c [}) starts by prompting for the correct
macro.  For the Harvard style, this looks like this:

@example
SELECT A CITATION FORMAT

[^M]   \cite@{%l@}
[p]    \cite@{%l@}
[t]    \citeasnoun@{%l@}
[n]    \citeasnoun@{%l@}
[s]    \possessivecite@{%l@}
[e]    \citeaffixed@{%l@}@{?@}
[y]    \citeyear@{%l@}
[a]    \citename@{%l@}
@end example

Following the most generic of these packages, @code{natbib}, the builtin
citation packages always accept the @kbd{t} for a @emph{textual}
citation (like: @code{Jones et al. (1997) have shown...})  as well as 
the @kbd{p} key for a parenthetical citation (like: @code{As shown
earlier (Jones et al, 1997)}).@refill

To make one of these styles the default, customize the variable
@var{reftex-cite-format} or put into @file{.emacs}:

@lisp
(setq reftex-cite-format 'natbib)
@end lisp

You can also use AUCTeX style files to automatically set the
citation style based on the @code{usepackage} commands in a given
document.  @xref{Style Files} for information on how to set up the style
files correctly.@refill

@node Displaying Citations, Chapterbib and Bibunits, Citation Styles, Citations, Top
@section Displaying Citations
@cindex Displaying citations
@cindex Citations, displaying
@cindex Viewing citations
@kindex C-c &
@findex reftex-view-crossref
@findex reftex-mouse-view-crossref

@b{Ref@TeX{}} can display the full database entry for any citation key used
in the document.  With the cursor on or anywhere before a @code{\cite}
macro, type @kbd{C-c &}.  Or klick with @kbd{S-mouse-2} on the argument
of the macro.  @b{Ref@TeX{}} will show the full database entry in another
window.  If you press @kbd{C-c &} immediately again, @b{Ref@TeX{}} will
move to the next following citation key - so this can be used to display
the database entries for several keys in a single @code{\cite} macro, or
in subsequent macros.@refill

@b{Ref@TeX{}} also uses the echo area to display short information about
the citation whenever the cursor is inside the argument of a
@code{\cite} macro.  Note that the information is only displayed if the
echo area is not occupied by a different message.  You can toggle this
feature from the menu @w{(@code{Ref->Options->Crossref Viewing})}, or
turn it off completely by configuring the variable
@var{reftex-auto-view-crossref}.@refill

See also @ref{Displaying Cross References}.

@node Chapterbib and Bibunits, Citations Outside LaTeX, Displaying Citations, Citations
@section Chapterbib and Bibunits
@cindex @code{chapterbib}, LaTeX package
@cindex @code{bibunits}, LaTeX package
@cindex Bibliographies, multiple

@code{chapterbib} and @code{bibunits} are two LaTeX packages which
produce multiple bibliographies in a document.  This is no problem for
@b{Ref@TeX{}} as long as all bibliographies use the same BibTeX database
files.  If they do not, it is best to have each document part in a
separate file (as it is required for @code{chapterbib} anyway).  Then
@b{Ref@TeX{}} will still scan the locally relevant databases correctly.  If
you have multiple bibliographies within a @emph{single file}, this may
or may not be the case.

@node  Citations Outside LaTeX, , Chapterbib and Bibunits, Citations
@section Citations outside LaTeX
@cindex Citations outside LaTeX

The command @code{reftex-citation} can also be executed outside a LaTeX
buffer.  This can be useful to reference articles in Emails and other
documents.  The list of BibTeX files will in this case be taken from the
variable @var{reftex-default-bibliography}.  Setting the variable
@var{reftex-cite-format} to the symbol @code{'locally} does a decent job of
putting all relevant information about a citation directly into the
buffer.  Here is the lisp code to add the @kbd{C-c [} binding to the
mail buffer.  It also provides a local binding for
@var{reftex-cite-format}.@refill

@lisp
(add-hook
 'mail-setup-hook
 (lambda ()
   (define-key mail-mode-map "\C-c["
     (lambda ()
       (interactive)
       (require 'reftex)
       (let ((reftex-cite-format 'locally))
         (reftex-citation))))))
@end lisp
    

@node Table of Contents, RefTeXs Menu, Citations, Top
@chapter Table of Contents
@cindex @code{*toc*} buffer
@cindex Table of contents buffer
@findex reftex-toc
@kindex C-c =

When you press @kbd{C-c =}, @b{Ref@TeX{}} will pop up a buffer showing the
table of contents of the document.  With the cursor in any of the lines
denoting a section, simple key strokes will jump to that section or
perform other actions.  Here is a list of available special commands.  A
summary of this information is always available by pressing
@kbd{?}.@refill

@table @kbd

@item 0-9, -
Prefix argument.

@item f
Toggle follow mode.  When follow mode is active, the other window will
always show the section corresponding to the line in the @samp{*toc*}
buffer at point.  This is similar to pressing @key{SPC} after each
cursor motion.  The default for this flag can be set with the variable
@var{reftex-toc-follow-mode}.  Note that only context in files already
visited is shown.  @b{RefTeX} will not visit a file just for follow
mode.  See, however, the variable @var{reftex-revisit-to-follow}.@refill

@item g
Rebuild the @samp{*toc*} buffer.  This does @emph{not} rescan the
document.@refill

@item n
Goto next line.

@item p
Goto previous line.

@item q
Hide the @samp{*toc*} buffer, return to the position where
@code{reftex-toc} was last called.@refill

@item Q
Kill the @samp{*toc*} buffer, return to the position where
@code{reftex-toc} was last called.@refill

@item r
Reparse the LaTeX document and rebuild the @samp{*toc*} buffer.  When
@var{reftex-enable-partial-scans} is non-nil, rescan only the file this
section is defined in, not the entire document.@refill

@item R
Reparse the @emph{entire} LaTeX document and rebuild the @samp{*toc*}
buffer.@refill

@item x
Switch to the @samp{*toc*} buffer of an external document.  When the
current document is using the @code{xr} package (@pxref{xr (LaTeX
package)}), @b{Ref@TeX{}} will switch to one of the external
documents.@refill

@item .
Show calling point in another window.  This is the point from where
@code{reftex-toc} was last called.

@item SPC
Show the corresponding section in another window.  This command does
@emph{not} select that other window.@refill

@item TAB
Goto the section in another window.

@item RET
Go to the section and hide the @samp{*toc*} buffer.  This will restore
the window configuration before @code{reftex-toc} (@kbd{C-c =}) was
called.@refill

@item mouse-2
Clicking with mouse button 2 on a line has the same effect as @key{RET}.
See also variable @var{reftex-highlight-selection}, @ref{Options
(Misc)}.@refill
@end table

In order to define additional commands for the @samp{*toc*} buffer, the
keymap @var{reftex-toc-map} may be used.@refill

@iftex
@chapter All the Rest
@end iftex

@node RefTeXs Menu, Keybindings, Table of Contents, Top
@section @b{Ref@TeX{}}'s Menu
@cindex RefTeXs Menu
@cindex Menu, in the menu bar

@b{Ref@TeX{}} installs a @code{Ref} menu in the menu bar on systems which
support this.  From this menu you can access all of @b{Ref@TeX{}}'s
commands and some of its options.  Note, however, that setting options
in the menu is not permanent but applies only to the current editing
session.  To make permanent changes, use Emacs Lisp in @file{.emacs}, or
use @code{Customize}.

@node Keybindings, Faces, RefTeXs Menu, Top
@section Default Keybindings
@cindex Keybindings, summary

Here is a summary of the available keybindings.

@example
@kbd{C-c =}      @code{reftex-toc}
@kbd{C-c (}      @code{reftex-label}
@kbd{C-c )}      @code{reftex-reference}
@kbd{C-c [}      @code{reftex-citation}
@kbd{C-c &}      @code{reftex-view-crossref}
@kbd{S-mouse-2}  @code{reftex-mouse-view-crossref}
@end example

Note that the @kbd{S-mouse-2} binding is only provided if this key is
not already used by some other package.  @b{Ref@TeX{}} will not override an
existing binding to @kbd{S-mouse-2}.@refill

The above keys were chosen to avoid interfering with AUCTeX's
settings.  Personally, I also bind some functions in the @kbd{C-c
@key{letter}} map for easier access:@refill

@kindex C-c t
@kindex C-c l
@kindex C-c r
@kindex C-c c
@kindex C-c v
@kindex C-c s
@kindex C-c g
@example
@kbd{C-c t}    @code{reftex-toc}
@kbd{C-c l}    @code{reftex-label}
@kbd{C-c r}    @code{reftex-reference}
@kbd{C-c c}    @code{reftex-citation}
@kbd{C-c v}    @code{reftex-view-crossref}
@kbd{C-c s}    @code{reftex-search-document}
@kbd{C-c g}    @code{reftex-grep-document}
@end example

@noindent
If you want to copy these as well, set in your @file{.emacs} file:

@vindex reftex-extra-bindings
@lisp
(setq reftex-extra-bindings t)
@end lisp

Changing and adding to @b{Ref@TeX{}}'s keybindings is best done in the hook
@var{reftex-load-hook}.  For information on the keymaps
which should be used to add keys, see @ref{Keymaps and Hooks}.

@node Faces, AUCTeX, Keybindings, Top
@section Faces
@cindex Faces

@b{Ref@TeX{}} uses faces when available to structure the selection and
table of contents buffers.  It does not create its own faces, but uses
the ones defined in @file{font-lock.el}.  Therefore, @b{Ref@TeX{}} will
use faces only when @code{font-lock} is loaded.  This seems to be
reasonable because people who like faces will very likely have it
loaded.  If you wish to turn off fontification or change the involved
faces, see @ref{Options (Fontification)}.@refill

@node AUCTeX, Multifile Documents, Faces, Top
@section @w{AUC @TeX{}}
@cindex @code{AUCTeX}, Emacs package
@cindex Emacs packages, @code{AUCTeX}

AUCTeX is without doubt the best major mode for editing TeX and
LaTeX files with Emacs.  AUCTeX is part of the XEmacs
distribution.  It is also available from

@example
http://www.sunsite.auc.dk/auctex/
@end example


@menu
* AUCTeX-RefTeX Interface::          How both packages work together
* Style Files::                      AUCTeX's style files can support RefTeX
* Bib-Cite::                         Hypertext reading of a document
@end menu

@node AUCTeX-RefTeX Interface, Style Files, , AUCTeX
@subsection The AUC@TeX{}-@b{Ref@TeX{}} Interface

@b{Ref@TeX{}} contains code to interface with AUCTeX.  When this
interface is turned on, both packages will interact closely.  Instead of
using @b{Ref@TeX{}}'s commands directly, you can then also use them
indirectly as part of the AUCTeX
environment@footnote{@b{Ref@TeX{}} 3.23 and AUCTeX 9.9c will be
needed for all of this to work.  Parts of it work also with earlier
versions.}.  The interface is turned on with@refill

@lisp
(setq reftex-plug-into-AUCTeX t)
@end lisp

If you need finer control about which parts of the interface are used
and which not, customize this variable with @kbd{M-x customize-variable
@key{RET} reftex-plug-into-AUCTeX @key{RET}}.

The following list describes the individual parts of the interface.

@itemize @bullet
@item
@findex reftex-label
@vindex LaTeX-label-function
@b{Inserting Labels for New Sections and Environments}@* When a new
section is created with @kbd{C-c C-s}, or a new environment is inserted
with @kbd{C-c C-e}, AUCTeX normally prompts for a label to go
with it.  With @var{reftex-plug-into-AUCTeX} turned on,
@code{reftex-label} is called instead.  For example, if you type
@kbd{C-c C-e equation @key{RET}}, AUCTeX and @b{Ref@TeX{}} will
insert

@example
\begin@{equation@}
\label@{eq:1@}

\end@{equation@}
@end example

@noindent
without further prompts.

Similarly, when you type @kbd{C-c C-s section @key{RET}}, @b{Ref@TeX{}}
will offer its default label which is derived from the section title.

@item
@b{Notifying @b{Ref@TeX{}} about New Sections}@* When creating a new
section with @kbd{C-c C-s}, @b{Ref@TeX{}} be notified about it, so that
it does not have to rescan the buffer.@refill

@item
@findex reftex-arg-label
@findex TeX-arg-label, AUCTeX function
@findex reftex-arg-ref
@findex TeX-arg-ref, AUCTeX function
@findex reftex-arg-cite
@findex TeX-arg-cite, AUCTeX function
@b{Supplying Macro Arguments}@*
When you insert a macro interactively with @kbd{C-c @key{RET}}, @w{AUC
@TeX{}} normally prompts for macro arguments.  Internally, it uses the
functions @code{TeX-arg-label} and @code{TeX-arg-cite} to prompt for
arguments which are labels and citation keys.  When
@var{reftex-plug-into-AUCTeX} is turned on, @b{Ref@TeX{}} takes over
these functions@footnote{@code{fset} is used to do this, which is not
reversible.  However, @b{Ref@TeX{}} implements the old functionality
when you later decide to turn off the interface.} and supplies the macro
arguments with its own mechanisms.  For example, when you type @kbd{C-c
@key{RET} ref @key{RET}}, @b{Ref@TeX{}} will supply its label selection
process just as if you had typed @kbd{C-c )} (@pxref{Referencing
Labels}).@refill

@item
@b{Notifying AUCTeX about New Labels and Citations Keys}@*
@b{Ref@TeX{}} will add all newly created labels to AUCTeX's completion list.
@end itemize

@node Style Files, Bib-Cite, AUCTeX-RefTeX Interface, AUCTeX
@subsection Style Files
@cindex Style files, AUCTeX
Style files are Emacs Lisp files which are evaluated by AUCTeX in
association with the @code{\documentclass} and @code{\usepackage}
commands of a document.  Support for @b{Ref@TeX{}} in such a style file is
useful when the LaTeX style defines macros or environments connected
with labels and citations.  Before calling a @b{Ref@TeX{}} function the
style hook should always test for the availability of the function, so
that the style file will also work for people who do not use
@b{Ref@TeX{}}.@refill

Additions made with style files in the way described below remain local
to the current document.  For example, if one package uses AMSTeX, the
style file will make @b{Ref@TeX{}} switch over to @code{\eqref}, but this
will not affect other documents.@refill

@findex reftex-add-label-environments
@findex reftex-add-to-label-alist
A style hook may contain calls to
@code{reftex-add-label-environments}@footnote{This used to be the
function @code{reftex-add-to-label-alist} which is still available as an
alias for compatibility.}  which defines additions to
@var{reftex-label-alist}.  The argument taken by this function must have
the same format as @var{reftex-label-alist}.  The @file{amsmath.el}
style file of AUCTeX for example contains the following:@refill

@lisp
@group
(TeX-add-style-hook "amsmath"
   (lambda ()
     (if (fboundp 'reftex-add-label-environments)
         (reftex-add-label-environments '(AMSTeX)))))
@end group
@end lisp

@noindent
while a package @code{myprop} defining a @code{proposition} environment
with @code{\newtheorem} might use@refill

@lisp
@group
(TeX-add-style-hook "myprop"
   (lambda ()
     (LaTeX-add-environments '("proposition" LaTeX-env-label))
     (if (fboundp 'reftex-add-label-environments)
         (reftex-add-label-environments
          '(("proposition" ?p "prop:" "~\\ref@{%s@}" t
                           ("Proposition" "Prop.")))))))
@end group
@end lisp

@findex reftex-set-cite-format
Similarly, a style hook may contain a call to
@code{reftex-set-cite-format} to set the citation format.  The style
file @file{natbib.el} for the Natbib citation style does switch
@b{Ref@TeX{}}'s citation format like this:@refill

@lisp
(TeX-add-style-hook "natbib"
   (lambda ()
     (if (fboundp 'reftex-set-cite-format)
         (reftex-set-cite-format 'natbib))))
@end lisp

@findex reftex-add-section-levels
Finally, the hook may contain a call to @code{reftex-add-section-levels}
to define additional section statements.  For example, the FoilTeX class
has just two headers, @code{\foilhead} and @code{\rotatefoilhead}.  Here
is a style file @file{foils.el} that will inform @b{Ref@TeX{}} about these:

@lisp
(TeX-add-style-hook "foils"
   (lambda ()
     (if (fboundp 'reftex-add-section-levels)
         (reftex-add-section-levels
          '(("foilhead" . 3)
            ("rotatefoilhead" . 3))))))
@end lisp

@node Bib-Cite, , Style Files, AUCTeX
@subsection Bib-Cite
@cindex @code{bib-cite}, Emacs package
@cindex Emacs packages, @code{bib-cite}

Once you have written a document with labels, references and citations,
it can be nice to read it like a hypertext document.  @b{Ref@TeX{}} has
some support for that: @code{reftex-view-crossref} (bound to @kbd{C-c
&}), @code{reftex-mouse-view-crossref} (bound to @kbd{S-mouse-2}),
and @code{reftex-search-document}.@*
A somewhat fancier interface with mouse highlighting is provided (among
other things) by Peter S. Galbraith's @file{bib-cite.el}.  There is some
overlap in the functionalities of Bib-cite and @b{Ref@TeX{}}.  Bib-cite.el
comes bundled with AUCTeX.

Bib-cite version 3.06 and later can be configured so that bib-cite's
mouse functions use @b{Ref@TeX{}} for displaying references and citations.
This can be useful in particular when working with the LaTeX @code{xr}
package or with an explicit @code{thebibliography} environment (rather
than BibTeX).  Bib-cite cannot handle those, but @b{Ref@TeX{}} does.  To
make use of this feature, try@refill

@vindex bib-cite-use-reftex-view-crossref
@lisp
(setq bib-cite-use-reftex-view-crossref t)
@end lisp

@node Multifile Documents, Language Support, AUCTeX, Top
@section Multifile Documents
@cindex Multifile documents
@cindex Documents, spread over files

The following is relevant when working with documents spread over many
files:@refill

@itemize @bullet
@item
@b{Ref@TeX{}} has full support for multifile documents.  You can edit parts of
several (multifile) documents at the same time without conflicts.
@b{Ref@TeX{}} provides functions to run @code{grep}, @code{search} and
@code{query-replace} on all files which are part of a multifile
document.@refill

@item
@vindex tex-main-file
@vindex TeX-master
All files belonging to a multifile document should have a File Variable
(@var{TeX-master} for AUCTeX or @var{tex-main-file} for the
standard Emacs LaTeX mode) set to the name of the master file.  See the
documentation of your (La)TeX mode and @ref{File Variables,,,emacs, The
GNU Emacs Manual}.@refill

@item
The context of a label definition must be found in the same file as the
label itself in order to be processed correctly by @b{Ref@TeX{}}.  The only
exception is that section labels referring to a section statement
outside the current file can still use that section title as
context.@refill
@end itemize

@node Language Support, Optimizations, Multifile Documents, Top
@section Language Support
@cindex Language support

Some parts of @b{Ref@TeX{}} are language dependent.  The default
settings work well for English.  If you are writing in a different
language, the following hints may be useful:

@itemize @bullet
@item
The mechanism to derive a label from context includes the abbreviation
of words and omission of unimportant words.  These mechanisms may have
to be changed for other languages.  See the variables
@var{reftex-derive-label-parameters} and @var{reftex-abbrev-parameters}.

@item
@cindex Mule characters in labels
@cindex Labels, missing Mule characters
The regular expression @var{reftex-label-illegal-re} is used to remove
characters which are illegal in labels from a label string.  This
regular expression currently matches some ASCII characters and all Mule
characters@footnote{Note that the default regexp allows the single byte
representation of the European characters in ISO-8859-1.  So if you
disable the Mule features in Emacs there should be no problems for these
characters.}.  If you find out that your TeX and Emacs work well with
labels containing funny Mule characters, try this setting to make
@emph{all} Mule characters legal in labels:

@lisp
(setq reftex-label-illegal-re 
      "[][\000-\037 !\"#$%&'()*,/<=>?@@\\^`@{|@}~\177]")
@end lisp

Alternatively the hook @var{reftex-translate-to-ascii-function} can be
used to change Mule characters before the conversion to a label takes
place.

@item
When a label is referenced, @b{Ref@TeX{}} looks at the word before point
to guess which label type is required.  These @emph{magic words} are
different in every language.  For an example of how to add magic words,
see @ref{Adding Magic Words}.
@end itemize

@node Optimizations, Problems and Work-Arounds, Language Support, Top
@section Optimizations
@cindex Optimizations

Implementing the principle of least surprises, the default settings of
@b{Ref@TeX{}} ensure a safe ride for beginners and casual users.  However,
when using @b{Ref@TeX{}} for a large project and/or on a small computer,
there are ways to improve speed or memory usage.@refill

@itemize @bullet
@item
@b{Removing Lookup Buffers}@*
@cindex Removing lookup buffers
@b{Ref@TeX{}} will load other parts of a multifile document as well as BibTeX
database files for lookup purposes.  These buffers are kept, so that
subsequent use of the same files is fast.  If you can't afford keeping
these buffers around, and if you can live with a speed penalty, try

@vindex reftex-keep-temporary-buffers
@lisp
(setq reftex-keep-temporary-buffers nil)
@end lisp

@item
@b{Partial Document Scans}@*
@cindex Partial documents scans
@cindex Document scanning, partial
A @kbd{C-u} prefix on the major @b{Ref@TeX{}} commands @code{reftex-label}
(@kbd{C-u C-c (}), @code{reftex-reference} (@kbd{C-u C-c )}),
@code{reftex-citation} (@kbd{C-u C-c [}), @code{reftex-toc} (@kbd{C-u C-c
=}), and @code{reftex-view-crossref} (@kbd{C-u C-c &}) initiates
re-parsing of the entire document in order to update the parsing
information.  For a large document this can be unnecessary, in
particular if only one file has changed.  @b{Ref@TeX{}} can be configured
to do partial scans instead of full ones.  @kbd{C-u} re-parsing then
does apply only to the current buffer and files included from it.
Likewise, the @kbd{r} key in both the label selection buffer and the
table-of-contents buffer will only prompt scanning of the file in which
the label or section macro near the cursor was defined.  Re-parsing of
the entire document is still available by using @kbd{C-u C-u} as a
prefix, or the capital @kbd{R} key in the menus.  To use this feature,
try@refill

@vindex reftex-enable-partial-scans
@lisp
(setq reftex-enable-partial-scans t)
@end lisp

@item
@b{Saving Parser Information}@*
@cindex Saving parser information
@cindex Parse information, saving to a file
Even with partial scans enabled, @b{Ref@TeX{}} still has to make one full
scan, when you start working with a document.  To avoid this, parsing
information can be stored in a file.  The file @file{MASTER.rel} is used
for storing information about a document with master file
@file{MASTER.tex}.  It is written automatically when you kill a buffer
in @code{reftex-mode} or when you exit Emacs.  The information is
restored when you begin working with a document in a new editing
session.  To use this feature, put into @file{.emacs}:@refill

@vindex reftex-save-parse-info
@lisp
(setq reftex-save-parse-info t)
@end lisp

@item
@b{Automatic Document Scans}@*
@cindex Automatic document scans
@cindex Document scanning, automatic
At rare occasions, @b{Ref@TeX{}} will automatically rescan a part of the
document.  If this gets into your way, it can be turned off with

@vindex reftex-allow-automatic-rescan
@lisp
(setq reftex-allow-automatic-rescan nil)
@end lisp

@b{Ref@TeX{}} will then occasionally annotate new labels in the selection
buffer, saying that their position in the label list in uncertain.  A
manual document scan will fix this.@refill

@item
@b{Multiple Selection Buffers}@*
@cindex Multiple selection buffers
@cindex Selection buffers, multiple
Normally, the selection buffer @code{*RefTeX Select*} is re-created
newly for every selection process.  In documents with very many labels
this can take several seconds - in particular with context
refontification turned on.  @b{Ref@TeX{}} provides an option to create a
separate selection buffer for each label type and to keep this buffer
from one selection to the next.  These buffers are updated automatically
only when a new label has been added in the buffers category with
@code{reftex-label}.  Updating the buffer takes as long as recreating it
- so the time saving is limited to cases where no new labels of that
category have been added.  To turn on this feature, use@refill

@vindex reftex-use-multiple-selection-buffers
@lisp
(setq reftex-use-multiple-selection-buffers t)
@end lisp

@noindent
@cindex Selection buffers, updating
You can also inhibit the automatic updating entirely.  Then the
selection buffer will always pop up very fast, but may not contain the
most recently defined labels.  You can always update the buffer by hand,
with the @kbd{g} key.  To get this behavior, use instead@refill

@vindex reftex-auto-update-selection-buffers
@lisp
(setq reftex-use-multiple-selection-buffers t
      reftex-auto-update-selection-buffers nil)
@end lisp
@end itemize

@need 2000
@noindent
@b{As a summary}, here are the settings I recommend for heavy use of
@b{Ref@TeX{}} with large documents:

@lisp
@group
(setq reftex-enable-partial-scans t
      reftex-save-parse-info t
      reftex-use-multiple-selection-buffers t
      reftex-plug-into-AUCTeX t)
@end group
@end lisp

@node Problems and Work-Arounds, Imprint, Optimizations, Top
@section Problems and Work-arounds
@cindex Problems and work-arounds

@itemize @bullet
@item
@code{\input}, @code{\include}, @code{\bibliography} and @code{\section}
(etc.) statements have to be first on a line (except for white space).@refill

@item
Some people define abbreviations for environments, like @code{\be} for
@code{\begin@{equation@}}, and @code{\ee} for @code{\end@{equation@}}.
@b{Ref@TeX{}} cannot be configured to see these -- you will have to used
the full @code{\begin} and @code{\end} statements.

@item
@cindex Labels, commented out
@b{Ref@TeX{}} sees also labels in regions commented out and will refuse to
make duplicates of such a label.  This is considered to be a feature.@refill

@item
When using partial scans (@var{reftex-enable-partial-scans}), the section
numbers in the table of contents may eventually become wrong.  A full
scan will fix this.@refill

@item
The label environment definitions in @var{reftex-label-alist} are global
and apply to all documents.  If you need to make definitions local to a
document, because they would interfere with other settings in other
documents, you should use AUCTeX and set up style files with
calls to @code{reftex-add-label-environments},
@code{reftex-set-cite-format}, and @code{reftex-add-section-levels}.
Settings made with these functions remain local to the current
document. @xref{AUCTeX} for more information.@refill

@item
@cindex @code{x-symbol}, Emacs package
@cindex Emacs packages, @code{x-symbol}
@cindex @code{isotex}, Emacs package
@cindex Emacs packages, @code{isotex}
@cindex @code{iso-cvt}, Emacs package
@cindex Emacs packages, @code{iso-cvt}
When using packages which make the buffer representation of a file
different from its disk representation (e.g. x-symbol, isotex,
iso-cvt) you may find that @b{Ref@TeX{}}'s parsing information sometimes
reflects the disk state of a file.  This happens only in @emph{unvisited}
parts of a multifile document, because @b{Ref@TeX{}} visits these files
literally for speed reasons.  Then both short context and section
headings may look different from what you usually see on your screen.
In rare cases @code{reftex-toc} may have problems to jump to an affected
section heading.  There are three possible ways to deal with
this:@refill 
@itemize @minus
@item
@vindex reftex-keep-temporary-buffers
@code{(setq reftex-keep-temporary-buffers t)}@*
This implies that @b{Ref@TeX{}} will load all parts of a multifile
document into Emacs (i.e. there will be no temporary buffers).@refill
@item
@vindex reftex-initialize-temporary-buffers
@code{(setq reftex-initialize-temporary-buffers t)}@*
This means full initialization of temporary buffers.  It involves
a penalty when the same unvisited file is used for lookup often.@refill
@item
Set @code{reftex-initialize-temporary-buffers} to a list of hook
functions doing a minimal initialization.@refill
@end itemize
@vindex reftex-refontify-context
See also the variable @var{reftex-refontify-context}.

@item
@cindex @code{pf}, LaTeX package
@cindex LaTeX packages, @code{pf}
Some packages use an additional argument to a @code{\begin} macro
to specify a label.  E.g. Lamport's @file{pf.sty} uses both
@example
\step@{LABEL@}@{CLAIM@}   and      \begin@{step+@}@{LABEL@}
                                  CLAIM
                               \end@{step+@}
@end example

@noindent
We need to trick @b{Ref@TeX{}} into swallowing this:

@lisp
;; Configuration for Lamport's pf.sty
(setq reftex-label-alist
    '(("\\step@{*@}@{@}"       ?p "st:" "~\\stepref@{%s@}" 2 ("Step" "St."))
      ("\\begin@{step+@}@{*@}" ?p "st:" "~\\stepref@{%s@}" 1000)))
@end lisp

@noindent
The first line is just a normal configuration for a macro.  For the
@code{step+} environment we actually tell @b{Ref@TeX{}} to look for the
@emph{macro} @samp{\begin@{step+@}} and interpret the @emph{first}
argument (which really is a second argument to the macro @code{\begin})
as a label of type @code{?p}.  Argument count for this macro starts only
after the @samp{@{step+@}}, also when specifying how to get
context.@refill 

@item
@cindex Idle timer restart
@vindex reftex-use-itimer-in-xemacs
In XEmacs, idle timer restart does not work reliably after fast
keystrokes.  Therefore @b{Ref@TeX{}} currently uses the post command hook
to start the timer used for automatic crossref information.  When this
bug gets fixed, it will be possible to switch over to itimers with
@lisp
(setq reftex-use-itimer-in-xemacs t)
@end lisp

@item
@cindex Viper mode
@cindex Keybindings, problems with Viper mode
@findex viper-harness-minor-mode
With @i{Viper} mode prior to Vipers version 3.01, you need to protect
@b{Ref@TeX{}}'s keymaps with@refill

@lisp
(viper-harness-minor-mode "reftex")
@end lisp

@end itemize

@page
@node Imprint, Commands, Problems and Work-Arounds, Top
@section Imprint
@cindex Imprint
@cindex Maintainer
@cindex Acknowledgments
@cindex Thanks
@cindex Bug reports
@cindex @code{http}, @b{Ref@TeX{}} home page
@cindex @code{ftp}, @b{Ref@TeX{}} site

@b{Ref@TeX{}} was written by @i{Carsten Dominik}
@t{<dominik@@strw.LeidenUniv.nl>}, with contributions by @i{Stephen
Eglen}.  @b{Ref@TeX{}} is currently maintained by @refill

@example
Carsten Dominik <dominik@@strw.LeidenUniv.nl>
@end example

If you find a bug in @b{Ref@TeX{}} or its documentation, or if you want to
contribute code or ideas, please contact the maintainer.  Remember to
provide all necessary information such as version numbers of Emacs and
@b{Ref@TeX{}}, and the relevant part of your configuration in @file{.emacs}.
When reporting a bug, please include a backtrace if you know how to
produce one.

@b{Ref@TeX{}} is distributed with Emacs (version 20.2 and later) and XEmacs
(version 19.16 and 20.2 and later).  The latest version of @b{Ref@TeX{}}
is available at@refill

@example
http://www.strw.leidenuniv.nl/~dominik/Tools/
ftp://strw.leidenuniv.nl/pub/dominik/
@end example

@noindent
At that site you can also find a version of @b{Ref@TeX{}} compatible
with Emacs 19.@refill

Thanks to the people on the Net who have used @b{Ref@TeX{}} and helped
developing it with their reports.  In particular thanks to
@i{F. Burstall, Alastair Burt, Soren Dayton, Stephen Eglen, Karl
Eichwalder, Peter Galbraith, Dieter Kraft, Adrian Lanz, Rory Molinari,
Laurent Mugnier, Sudeep Kumar Palat, Daniel Polani, Robin Socha, Richard
Stanton, Allan Strand, Jan Vroonhof, Christoph Wedler}.@refill

The @code{view-crossref} feature was inspired by @i{Peter Galbraith's}
@file{bib-cite.el}.@refill

Finally thanks to @i{Uwe Bolick} who first got me (some years ago) into
supporting LaTeX labels and references with an Editor (which was
MicroEmacs at the time).@refill

@node Commands, Options, Imprint, Top
@chapter Commands
@cindex Commands, list of

Here is a summary of @b{Ref@TeX{}}'s commands.  All commands are available
from the @code{Ref} menu.  For keybindings, @pxref{Keybindings}.

@deffn Command reftex-label
Insert a unique label.  With one or two @kbd{C-u} prefixes, enforce
document rescan first.
@end deffn

@deffn Command reftex-reference
Start a selection process to select a label, and insert a reference to
it.  With one or two @kbd{C-u} prefixes, enforce document rescan first.
@end deffn

@deffn Command reftex-citation
Make a citation using BibTeX database files.  After asking for a Regular
Expression, it scans the buffers with BibTeX entries (taken from the
@code{\bibliography} command or a @code{thebibliography} environment)
and offers the matching entries for selection.  The selected entry is
formated according to @var{reftex-cite-format} and inserted into the
buffer.@refill @*
When called with one or two @kbd{C-u} prefixes, first rescans the document.
When called with a numeric prefix, make that many citations.  When
called with point inside the braces of a @code{\cite} command, it will
add another key, ignoring the value of @var{reftex-cite-format}.@refill @*
The regular expression uses an expanded syntax: @samp{&&} is interpreted as
@code{and}.  Thus, @samp{aaaa&&bbb} matches entries which contain both
@samp{aaaa} and @samp{bbb}.  While entering the regexp, completion on knows citation keys is possible.@refill
@end deffn

@deffn Command reftex-view-crossref
View cross reference of @code{\ref} or @code{\cite} macro at point.  If
the macro at point is a @code{\ref}, show the corresponding label
definition.  If it is a @code{\cite}, show the BibTeX database entry or the
@code{\bibitem}.  If there is no such macro at point, search forward to find
one.  When you call this function several times in direct succession,
point will move to view subsequent cross references further down in the
buffer.  To cope with the plethora of variations in packages, this
function assumes any macro either starting with or ending in @samp{ref} or
@samp{cite} to contain cross references.  When the LaTeX package @code{xr} is
being used, this command will also view cross-references in external
documents.  However, this works correctly only when the
@code{\externaldocument} macros are used with the optional label prefix
argument.@*@refill
With one or two @kbd{C-u} prefixes, enforce rescanning of the
document.  With argument t or 1, select the window showing the cross
reference.@refill
@end deffn

@deffn Command reftex-toc
Show the table of contents for the current document.  When called with
one ore two @kbd{C-u} prefixes, rescan the document first.@refill
@end deffn


@deffn Command reftex-create-tags-file
Create TAGS file by running @code{etags} on the current document.  The
TAGS file is also immediately visited with
@code{visit-tags-table}.@refill
@end deffn

@deffn Command reftex-grep-document
Run grep query through all files related to this document.
With prefix arg, force to rescan document.
This works also without an active TAGS table.@refill
@end deffn

@deffn Command reftex-search-document
Regexp search through all files of the current TeX document.
Starts always in the master file.  Stops when a match is found.
This works also without an active TAGS table.@refill
@end deffn

@deffn Command reftex-query-replace-document
Run a query-replace-regexp of FROM with TO over the entire TeX document.
With prefix arg, replace only word-delimited matches.
This works also without an active TAGS table.@refill
@end deffn

@deffn Command reftex-change-label
Query replace FROM with TO in all @code{\label} and @code{\ref} commands.
Works on the entire multifile document.
This works also without an active TAGS table.@refill
@end deffn

@deffn Command reftex-renumber-simple-labels
Renumber all simple labels in the document to make them sequentially.
Simple labels are the ones created by RefTeX, consisting only of the
prefix and a number.  After the command completes, all these labels will
have sequential numbers throughout the document.  Any references to the
labels will be changed as well.  For this, @b{Ref@TeX{}} looks at the
arguments of any macros which either start or end with the string
@samp{ref}.  This command should be used with care, in particular in
multifile documents.  You should not use it if another document refers
to this one with the @code{xr} package.@refill
@end deffn

@deffn Command reftex-find-duplicate-labels
Produce a list of all duplicate labels in the document.@refill
@end deffn

@deffn Command reftex-customize
Run the customize browser on the @b{Ref@TeX{}} group.
@end deffn
@deffn Command reftex-show-commentary
Show the commentary section from @file{reftex.el}.
@end deffn
@deffn Command reftex-info
Run info on the top @b{Ref@TeX{}} node.
@end deffn
@deffn Command reftex-parse-document
Parse the entire document in order to update the parsing information.
@end deffn
@deffn Command reftex-reset-mode
Enforce rebuilding of several internal lists and variables.  Also
removes the parse file associated with the current document.
@end deffn

@node Options, Keymaps and Hooks, Commands, Top
@chapter Options, Keymaps, Hooks
@cindex Options, list of

Here is a complete list of @b{Ref@TeX{}}'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
@code{customize} to look at and change these variables. @kbd{M-x
reftex-customize} will get you there.@refill

@menu
* Options (Defining Label Environments)::
* Options (Creating Labels)::
* Options (Referencing Labels)::
* Options (Creating Citations)::
* Options (Table of Contents)::
* Options (Viewing Cross References)::
* Options (Optimizations)::
* Options (Fontification)::
* Options (Misc)::
@end menu

@node Options (Defining Label Environments), Options (Creating Labels), , Options
@section Defining Label Environments
@cindex Options, defining label environments

@defopt reftex-default-label-alist-entries
Default label alist specifications.  It is a list of symbols with
associations in the constant @var{reftex-label-alist-builtin}.
@code{LaTeX} should always be the last entry.@refill
@end defopt

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

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

@example
 (ENV-OR-MACRO  TYPE-KEY  LABEL-PREFIX  REFERENCE-FORMAT
    CONTEXT-METHOD  (MAGIC-WORD ... ))
@end example

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

@table @asis
@item ENV-OR-MACRO
Name of the environment (like @samp{table}) or macro (like
@samp{\myfig}).  For macros, indicate the arguments, as in
@samp{\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
@samp{\label@{...@}} inside one of its arguments.@refill

Special names: @code{section} for section labels, @code{any} to define a
group which contains all labels.@refill

This may also be @code{nil} if the entry is only meant to change some
settings associated with the type indicator character (see
below).@refill

@item TYPE-KEY
Type indicator character, like @code{?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 @code{equation} and @code{eqnarray}).  If the type
indicator is @code{nil} and the macro has a label argument @samp{@{*@}},
the macro defines neutral labels just like @code{\label}.  In this case
the reminder of this entry is ignored.@refill

@item LABEL-PREFIX
Label prefix string, like @samp{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 @samp{%} escapes:@refill

@example
%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.
@end example

@noindent
Example: In a file @file{intro.tex}, @samp{eq:%f:} will become
@samp{eq:intro:}.@refill

@item REFERENCE-FORMAT
Format string for reference insert in buffer.  @samp{%s} will be
replaced by the label.  When the format starts with @samp{~}, this
@samp{~} will only be inserted when the character before point is
@emph{not} a whitespace.@refill

@item CONTEXT-METHOD
Indication on how to find the short context.
@itemize @minus
@item
If @code{nil}, use the text following the @samp{\label@{...@}} macro.@refill
@item
If @code{t}, use
@itemize @minus
@item
the section heading for section labels.
@item
text following the @samp{\begin@{...@}} statement of environments (not
a good choice for environments like eqnarray or enumerate, where one has
several labels in a single environment).@refill
@item
text after the macro name (starting with the first arg) for
macros.@refill
@end itemize
@item
If an integer, use the nth argument of the macro.  As a special case,
1000 means to get text after the last macro argument.@refill
@item
If a string, use as regexp to search @emph{backward} from the label.
Context is then the text following the end of the match.  E.g. putting
this to @samp{\\caption[@{]]} will use the caption in a figure or table
environment.  @samp{\\begin@{eqnarray@}\|\\\\} works for
eqnarrays.@refill
@item
If any of @code{caption}, @code{item}, @code{eqnarray-like},
@code{alignat-like}, this symbol will internally be translated into an
appropriate regexp (see also the variable
@var{reftex-default-context-regexps}).@refill
@item
If a function, call this function with the name of the environment/macro
as argument.  On call, point will be just after the @code{\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:@refill

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

Label context is used in two ways by @b{Ref@TeX{}}: 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. @code{(nil . t)} uses the text after the label (@code{nil}) for
display, and text from the default position (@code{t}) to derive a label
string.  This is actually used for section labels.@refill

Setting the variable @var{reftex-use-text-after-label-as-context} to
@code{t} overrides the setting here.@refill

@item MAGIC-WORD-LIST
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
@code{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@footnote{Careful:  @b{Ref@TeX{}} will add stuff to the
beginning and end of these regular expressions.}.@refill
@end table

If the type indicator characters of two or more entries are the same,
@b{Ref@TeX{}} will use@refill
@itemize @minus
@item
the first non-@code{nil} format and prefix
@item
the magic words of all involved entries.
@end itemize

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

@defopt reftex-section-levels
Commands and levels used for defining sections in the document.  The
@code{car} of each cons cell is the name of the section macro.  The
@code{cdr} is a number indicating its level.@refill
@end defopt

@defopt reftex-default-context-regexps
Alist with default regular expressions for finding context.  The emacs
lisp form @w{@code{(format regexp (regexp-quote environment))}} is used
to calculate the final regular expression - so @samp{%s} will be
replaced with the environment or macro.@refill
@end defopt
  
@defopt reftex-use-text-after-label-as-context
Non-@code{nil} means, grab context from directly after the
@samp{\label@{...@}} macro.  This is the fastest method for obtaining
context of the label definition, but requires discipline when placing
labels.  Setting this variable to @code{t} takes precedence over the
individual settings in @var{reftex-label-alist}.  This variable may be
set to @code{t}, @code{nil}, or a string of label type letters
indicating the label types for which it should be true.@refill
@end defopt

@node Options (Creating Labels), Options (Referencing Labels), Options (Defining Label Environments), Options
@section Creating Labels
@cindex Options, creating labels

@defopt reftex-insert-label-flags
Flags governing label insertion.  The value has the form

@example
(DERIVE PROMPT)
@end example

If DERIVE is @code{t}, @b{Ref@TeX{}} 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
@var{reftex-derive-label-parameters}.  If DERIVE is @code{nil}, the
default label will consist of the prefix and a unique number, like
@samp{eq:23}.@refill

If PROMPT is @code{t}, the user will be prompted for a label string.
When PROMPT is @code{nil}, the default label will be inserted without
query.@refill

So the combination of DERIVE and PROMPT controls label insertion.  Here
is a table describing all four possibilities:@refill

@example
@group
DERIVE PROMPT ACTION
-----------------------------------------------------------
nil    nil    @r{Insert simple label, like @samp{eq:22} or @samp{sec:13}. No query.}
nil    t      @r{Prompt for label.}
t      nil    @r{Derive a label from context and insert. No query.}
t      t      @r{Derive a label from context, prompt for confirmation.}
@end group
@end example

Each flag may be set to @code{t}, @code{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 @samp{"s"} and @samp{"sft"} mean: Derive section labels from
headings (with confirmation).  Prompt for figure and table labels.  Use
simple labels without confirmation for everything else.@refill

The available label types are: @code{s} (section), @code{f} (figure),
@code{t} (table), @code{i} (item), @code{e} (equation), @code{n}
(footnote), plus any definitions in @var{reftex-label-alist}.@refill
@end defopt

@deffn Hook reftex-format-label-function
If non-@code{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
@samp{\label@{%s@}}).  It should return the string to insert into the
buffer.@refill
@end deffn

@deffn Hook reftex-string-to-label-function
Function to turn an arbitrary string into a legal label.
@b{Ref@TeX{}}'s default function uses the variable
@var{reftex-derive-label-parameters}.@refill
@end deffn

@deffn Hook reftex-translate-to-ascii-function
Filter function which will process a context string before it is used to
derive a label from it.  A useful application would be to convert ISO or
Mule characters into something legal in labels.  By default,
@b{Ref@TeX{}} just removes these characters.  @code{X-Symbol} (>=2.6)
sets this variable to @code{x-symbol-translate-to-ascii}.@refill
@end deffn

@defopt reftex-derive-label-parameters
Parameters for converting a string into a label.  This variable is a
list of the following items:@refill
@table @asis
@item NWORDS
Number of words to use.
@item MAXCHAR
Maximum number of characters in a label string.
@item ILLEGAL
@code{nil}: Throw away any words containing characters illegal in labels.@*
@code{t}:   Throw away only the illegal characters, not the whole word.
@item ABBREV
@code{nil}: Never abbreviate words.@*
@code{t}:   Always abbreviate words (see @var{reftex-abbrev-parameters}).@*
@code{1}:   Abbreviate words if necessary to shorten label string.
@item SEPARATOR
String separating different words in the label.
@item IGNOREWORDS
List of words which should not be part of labels.
@item DOWNCASE
@code{t}:   Downcase words before putting them into the label.@*
@end table
@end defopt

@defopt reftex-label-illegal-re
Regexp matching characters not legal in labels.  For historic reasons,
this character class comes @emph{with} the @code{[]} brackets.
The default value allows the characters \300-\377 because these are the
european letters in ISO 8859-1.@refill
@end defopt

@defopt reftex-abbrev-parameters
Parameters for abbreviation of words.  A list of four parameters.@refill
@table @asis
@item MIN-CHARS
Minimum number of characters remaining after abbreviation.
@item MIN-KILL
Minimum number of characters to remove when abbreviating words.@refill
@item BEFORE
Character class before abbrev point in word.@refill
@item AFTER
Character class after  abbrev point in word.@refill
@end table
@end defopt

@node Options (Referencing Labels), Options (Creating Citations), Options (Creating Labels), Options
@section Referencing Labels
@cindex Options, referencing labels

@defopt reftex-label-menu-flags
List of flags governing the label menu makeup. The flags are:
@table @asis
@item TABLE-OF-CONTENTS
Show the labels embedded in a table of context.@refill
@item SECTION-NUMBERS
Include section numbers (like 4.1.3) in table of contents.@refill
@item COUNTERS
Show counters.  This just numbers the labels in the menu.@refill
@item NO-CONTEXT
Non-@code{nil} means do NOT show the short context.@refill
@item FOLLOW
Follow full context in other window.@refill
@item SHOW-COMMENTED
Show labels from regions which are commented out.@refill
@item MATCH-EVERYWHERE
Obsolete flag.@refill
@item SHOW FILES
Show begin and end of included files.@refill
@end table

Each of these flags can be set to @code{t} or @code{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 @samp{"sf"} makes the flag true for section
and figure labels, @code{nil} for everything else.  Setting it to
@samp{"^sf"} makes it the other way round.@refill

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

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.@refill
@end defopt

@deffn Hook reftex-format-ref-function
If non-@code{nil}, should be a function which produces the string to
insert as a reference.  Note that the insertion format can also be
changed with @var{reftex-label-alist}.  The function will be called with
two arguments, the LABEL and the DEFAULT FORMAT (usually
@samp{~\ref@{%s@}}).  It should return the string to insert into the
buffer.@refill
@end deffn

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

@defopt reftex-level-indent
Number of spaces to be used for indentation per section level.@refill
@end defopt

@defopt reftex-guess-label-type
Non-@code{nil} means, @code{reftex-reference} will try to guess the
label type.  To do that, @b{Ref@TeX{}} will look at the word before the
cursor and compare it with the magic words given in
@var{reftex-label-alist}.  When it finds a match, @b{Ref@TeX{}} will
immediately offer the correct label menu - otherwise it will prompt you
for a label type.  If you set this variable to @code{nil}, @b{Ref@TeX{}}
will always prompt for a label type.@refill
@end defopt

@deffn {Normal Hook} reftex-display-copied-context-hook
Normal Hook which is run before context is displayed anywhere.  Designed
for @w{@code{X-Symbol}}, but may have other uses as well.@refill
@end deffn

@deffn Hook reftex-pre-refontification-functions
@code{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.@refill
@end deffn

@deffn {Normal Hook} reftex-select-label-mode-hook
Normal hook which is run when a selection buffer enters
@code{reftex-select-label-mode}.@refill 
@end deffn

@deffn Keymap reftex-select-label-map
The keymap which is active in the labels selection process
(@pxref{Referencing Labels}).@refill
@end deffn

@node Options (Creating Citations), Options (Table of Contents), Options (Referencing Labels), Options
@section Creating Citations
@cindex Options, creating citations

@defopt reftex-bibpath-environment-variables
List of environment variables which might contain the path to BibTeX
database files.  Directories ending in @samp{//} or @samp{!!} will be
expanded recursively when necessary to find files.@refill
@end defopt

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

@defopt reftex-default-bibliography
List of BibTeX database file which should be used if none are specified.
When @code{reftex-citation} is called from a document which has neither
a @samp{\bibliography@{...@}} statement nor a @code{thebibliography}
environment, @b{Ref@TeX{}} will scan these files instead.  Intended for
using @code{reftex-citation} in non-LaTeX files.
@end defopt

@defopt reftex-sort-bibtex-matches
Sorting of the entries found in BibTeX databases by reftex-citation.
Possible values:@refill
@example
nil          @r{Do not sort entries.}
author       @r{Sort entries by author name.}
year         @r{Sort entries by increasing year.}
reverse-year @r{Sort entries by decreasing year.}
@end example
@end defopt

@defopt reftex-cite-format
The format of citations to be inserted into the buffer.  It can be a
string or an alist.  In the simplest case this is just the string
@samp{\cite@{%l@}}, which is also the default.  See the definition of
@var{reftex-cite-format-builtin} for more complex examples.@refill

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

@table @code
@item %l
The BibTeX label of the citation.
@item %a
List of author names, see also @var{reftex-cite-punctuation}.
@item %2a
Like %a, but abbreviate more than 2 authors like Jones et al.
@item %A
First author name only.
@item %e
Works like @samp{%a}, but on list of editor names. (@samp{%2e} and
@samp{%E} work a well).@refill
@end table

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

@example
%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
@end example

@noindent
Usually, only @samp{%l} is needed.  The other stuff is mainly for the
echo area display, and for @code{(setq reftex-comment-citations t)}.@refill

@samp{%<} as a special operator kills punctuation and space around it
after the string has been formatted.@refill

Beware that all this only works with BibTeX database files.  When
citations are made from the @code{\bibitems} in an explicit
@code{thebibliography} environment, only @samp{%l} is available.@refill

If @var{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.@refill

In order to configure this variable, you can either set
@var{reftex-cite-format} directly yourself or set it to the
@emph{symbol} of one of the predefined styles (see
@var{reftex-cite-format-builtin}).  E.g.: @code{(setq reftex-cite-format
'natbib)}.@refill
@end defopt

@deffn Hook reftex-format-cite-function
If non-@code{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 @var{reftex-cite-format}.  The function will be called
with two arguments, the CITATION KEY and the DEFAULT FORMAT (taken from
@var{reftex-cite-format}).  It should return the string to insert into
the buffer.
@end deffn

@defopt reftex-comment-citations
Non-@code{nil} means add a comment for each citation describing the full
entry.  The comment is formatted according to
@var{reftex-cite-comment-format}.@refill
@end defopt

@defopt reftex-cite-comment-format
Citation format used for commented citations.  Must @emph{not} contain
@samp{%l}.  See the variable @var{reftex-cite-format} for possible
percent escapes.@refill
@end defopt

@defopt reftex-cite-punctuation
Punctuation for formatting of name lists in citations.  This is a list
of 3 strings.@refill
@enumerate
@item
normal names separator, like @samp{, } in Jones, Brown and Miller
@item
final names separator, like @samp{ and }  in Jones, Brown and Miller
@item
The @samp{et al.} string, like @samp{ @{\it et al.@}} in 
Jones @{\it et al.@}
@end enumerate
@end defopt

@deffn {Normal Hook} reftex-select-bib-mode-hook
Normal hook which is run when a selection buffer enters
@code{reftex-select-bib-mode}.@refill 
@end deffn

@deffn Keymap reftex-select-bib-map
The keymap which is active in the citation-key selection process
(@pxref{Creating Citations}).@refill
@end deffn

@node Options (Table of Contents), Options (Viewing Cross References), Options (Creating Citations),  Options
@section Table of Contents
@cindex Options, table of contents

@defopt reftex-toc-follow-mode
Non-@code{nil} means, point in @code{*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 @code{*toc*} buffer with the @kbd{f}
key.@refill
@end defopt

@deffn {Normal Hook} reftex-toc-mode-hook
Normal hook which is run when a @code{*toc*} buffer is
created.@refill
@end deffn

@deffn Keymap reftex-toc-map
The keymap which is active in the @code{*toc*} buffer.
(@pxref{Table of Contents}).@refill
@end deffn

@node Options (Viewing Cross References), Options (Optimizations), Options (Table of Contents),  Options
@section Viewing Cross References and Citations
@cindex Options, viewing cross references

@defopt reftex-auto-view-crossref
Non-@code{nil} means, initially turn automatic viewing of crossref info
on.  Automatic viewing of crossref info uses the echo area.  Whenever
point is in the argument of a @code{\ref} or @code{\cite} macro, and no other
message is being displayed, the echo area will display information about
that cross reference.  The function @code{reftex-toggle-auto-view-crossref}
can be used to toggle this feature after startup.  See also the variable
@var{reftex-revisit-to-echo}.
@end defopt

@defopt reftex-idle-time
Time (secs) Emacs has to be idle before automatic crossref display is
done.@refill
@end defopt

@defopt reftex-cite-view-format
Citation format used to display citation info in the message area.  See
the variable @var{reftex-cite-format} for possible percent
escapes.@refill
@end defopt

@defopt reftex-revisit-to-echo
Non-@code{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 @var{reftex-cache-cite-echo}), or for
BibTeX database files which are already visited by a live associated
buffers.@refill
@end defopt

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

@node Options (Optimizations), Options (Fontification), Options (Viewing Cross References), Options
@section Optimizations
@cindex Options, optimizations

@defopt reftex-keep-temporary-buffers
Non-@code{nil} means, keep buffers created for parsing and lookup.
@b{Ref@TeX{}} sometimes needs to visit files related to the current
document.  We distinguish files visited for@refill
@table @asis
@item PARSING
Parts of a multifile document loaded when (re)-parsing the
document.@refill
@item LOOKUP
BibTeX database files and TeX files loaded to find a reference, to
display label context, etc.@refill
@end table
The created buffers can be kept for later use, or be thrown away
immediately after use, depending on the value of this variable:@refill

@table @code
@item nil
Throw away as much as possible.
@item t
Keep everything.
@item 1
Throw away buffers created for parsing, but keep the ones created for
lookup.@refill
@end table

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
@var{reftex-initialize-temporary-buffers}.@refill
@end defopt

@defopt reftex-initialize-temporary-buffers
Non-@code{nil} means do initializations even when visiting file
temporarily.  When @code{nil}, @b{Ref@TeX{}} may turn off find-file hooks and
other stuff to briefly visit a file. When @code{t}, the full default
initializations are done (@code{find-file-hook} etc.).  Instead of
@code{t} or @code{nil}, this variable may also be a list of hook
functions to do a minimal initialization.@refill
@end defopt

@defopt reftex-no-include-regexps
List of regular expressions to exclude certain input files from parsing.
If the name of a file included via @code{\include} or @code{\input} is
matched by any of the regular expressions in this list, that file is not
parsed by @b{Ref@TeX{}}.
@end defopt

@defopt reftex-enable-partial-scans
Non-@code{nil} means, re-parse only 1 file when asked to re-parse.
Re-parsing is normally requested with a @kbd{C-u} prefix to many @b{Ref@TeX{}}
commands, or with the @kbd{r} key in menus.  When this option is
@code{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 @kbd{C-u C-u} prefix or the capital @kbd{R} key in
menus.@refill
@end defopt

@defopt reftex-save-parse-info
Non-@code{nil} means, save information gathered with parsing in a file.
The file @file{MASTER.rel} in the same directory as @file{MASTER.tex} is
used to save the information.  When this variable is @code{t},
@itemize @minus
@item
accessing the parsing information for the first time in an editing
session will read that file (if available) instead of parsing the
document.@refill
@item
each time (part of) the document is rescanned, a new version of the file
is written.@refill
@end itemize
@end defopt

@defopt reftex-allow-automatic-rescan
Non-@code{nil} means, @b{Ref@TeX{}} 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.
@end defopt

@defopt reftex-use-multiple-selection-buffers
Non-@code{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 @var{reftex-auto-update-selection-buffers}.@refill
@end defopt

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

@node Options (Fontification), Options (Misc), Options (Optimizations), Options
@section Fontification
@cindex Options, fontification

@defopt reftex-use-fonts
Non-@code{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.@refill
@end defopt

@defopt reftex-refontify-context
Non-@code{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.@refill

This option may have 3 different values:
@table @code
@item nil
Never refontify.
@item t
Always refontify.
@item 1
Refontify when necessary, e.g. with old versions of the x-symbol
package.@refill
@end table
The option is ignored when @var{reftex-use-fonts} is @code{nil}.@refill
@end defopt

@defopt reftex-highlight-selection
Non-@code{nil} means, highlight selected text in selection and
@code{*toc*} buffers.  Normally, the text near the cursor is the
@emph{selected} text, and it is highlighted.  This is the entry most
keys in the selection and @code{*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 @emph{instead} or @emph{as well}. The
variable may have one of these values:@refill

@example
nil      @r{No highlighting.}
cursor   @r{Highlighting is cursor driven.}
mouse    @r{Highlighting is mouse driven.}
both     @r{Both cursor and mouse trigger highlighting.}
@end example

Changing this variable requires to rebuild the selection and *toc*
buffers to become effective (keys @kbd{g} or @kbd{r}).@refill
@end defopt

@defopt reftex-cursor-selected-face
Face name to highlight cursor selected item in toc and selection buffers.
See also the variable @var{reftex-highlight-selection}.@refill
@end defopt
@defopt reftex-mouse-selected-face
Face name to highlight mouse selected item in toc and selection buffers.
See also the variable @var{reftex-highlight-selection}.@refill
@end defopt
@defopt reftex-file-boundary-face
Face name for file boundaries in selection buffer.
@end defopt
@defopt reftex-label-face
Face name for labels in selection buffer.
@end defopt
@defopt reftex-section-heading-face
Face name for section headings in toc and selection buffers.
@end defopt
@defopt reftex-toc-header-face
Face name for the header of a toc buffer.
@end defopt
@defopt reftex-bib-author-face
Face name for author names in bib selection buffer.
@end defopt
@defopt reftex-bib-year-face
Face name for year in bib selection buffer.
@end defopt
@defopt reftex-bib-title-face
Face name for article title in bib selection buffer.
@end defopt
@defopt reftex-bib-extra-face
Face name for bibliographic information in bib selection buffer.
@end defopt

@node Options (Misc), , Options (Fontification), Options
@section Miscellaneous
@cindex Options, misc

@defopt reftex-extra-bindings
Non-@code{nil} means, make additional key bindings on startup.  These
extra bindings are located in the users @samp{C-c letter}
map. @xref{Keybindings}.@refill
@end defopt

@defopt reftex-plug-into-AUCTeX
Plug-in flags for AUCTeX interface.  This variable is a list of
4 boolean flags.  When a flag is non-@code{nil}, @b{Ref@TeX{}}
will@refill

@example
- supply labels in new sections and environments  (flag 1)
- supply arguments for macros like @code{\label}         (flag 2)
- supply arguments for macros like @code{\ref}           (flag 3)
- supply arguments for macros like @code{\cite}          (flag 4)
@end example

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 aplies when creating
sections with @kbd{C-c C-s} and environments with @kbd{C-c C-e}.@*
Supplying macro arguments applies when you insert such a macro
interactively with @kbd{C-c @key{RET}}.@*
See the AUCTeX documentation for more information.
@end defopt

@defopt reftex-revisit-to-follow
Non-@code{nil} means, follow-mode will revisit files if necessary.
When nil, follow-mode will be suspended for stuff in unvisited files.
@end defopt

@defopt reftex-allow-detached-macro-args
Non-@code{nil} means, allow arguments of macros to be detached by
whitespace.  When this is @code{t}, the @samp{aaa} in @w{@samp{\bbb
[xxx] @{aaa@}}} will be considered an argument of @code{\bb}.  Note that
this will be the case even if @code{\bb} is defined with zero or one
argument.@refill
@end defopt

@node Keymaps and Hooks, Changes, Options, Top
@section Keymaps and Hooks
@cindex Keymaps

@b{Ref@TeX{}} has the usual general keymap and load-- and mode-hook.

@deffn Keymap reftex-mode-map
The keymap for @b{Ref@TeX{}} mode.
@end deffn

@deffn {Normal Hook} reftex-load-hook
Normal hook which is being run when loading @file{reftex.el}.
@end deffn

@deffn {Normal Hook} reftex-mode-hook
Normal hook which is being run when turning on @b{Ref@TeX{}} mode.@refill
@end deffn

Furthermore, the 3 modes used for referencing labels, creating citations
and fo the table of contents buffer have their own keymaps and mode
hooks.  See the respective sections: @ref{Options (Referencing Labels)},
@ref{Options (Creating Citations)}, and @ref{Options (Table of
Contents)}.@refill

There are many more hooks which are described in the relevant sections
about options for a specific part of @b{Ref@TeX{}}.@refill

@node Changes, , Keymaps and Hooks, Top
@chapter Changes
@cindex Changes

Here is a list of recent changes to @b{Ref@TeX{}}.

@ignore
@noindent @b{Version 1.00}
@itemize @bullet
@item
released on 7 Jan 1997.
@end itemize

@noindent @b{Version 1.04}
@itemize @bullet
@item
Macros as wrappers, AMSTeX support, delayed context parsing for
new labels.@refill
@end itemize

@noindent @b{Version 1.05}
@itemize @bullet
@item
XEmacs port.
@end itemize

@noindent @b{Version 1.07}
@itemize @bullet
@item
@b{Ref@TeX{}} gets its own menu.
@end itemize

@noindent @b{Version 1.09}
@itemize @bullet
@item
Support for @var{tex-main-file}, an analogue for
@var{TeX-master}.@refill
@item
MS-DOS support.
@end itemize

@noindent @b{Version 2.00}
@itemize @bullet
@item
Labels can be derived from context (default for sections).
@item
Configuration of label insertion and label referencing revised.
@item
Crossref fields in BibTeX database entries.
@item
@code{reftex-toc} introduced (thanks to Stephen Eglen).
@end itemize

@noindent @b{Version 2.03}
@itemize @bullet
@item
@code{figure*}, @code{table*}, @code{sidewaysfigure/table} added to
default environments.@refill
@item
@var{reftex-bibfile-ignore-list} introduced (thanks to Rory Molinari).
@item
New functions @code{reftex-arg-label}, @code{reftex-arg-ref},
@code{reftex-arg-cite}.@refill
@item
Emacs/XEmacs compatibility reworked.  XEmacs 19.15 now is
required.@refill
@item
@code{reftex-add-to-label-alist} (to be called from AUCTeX style
files).@refill
@item
Finding context with a hook function.
@item
Sorting BibTeX entries (new variable:
@code{reftex-sort-bibtex-matches}).
@end itemize

@noindent @b{Version 2.05}
@itemize @bullet
@item
Support for @file{custom.el}.
@item
New function @code{reftex-grep-document} (thanks to Stephen Eglen).
@end itemize

@noindent @b{Version 2.07}
@itemize @bullet
@item
New functions @code{reftex-search-document},
@code{reftex-query-replace-document}.
@end itemize

@noindent @b{Version 2.11}
@itemize @bullet
@item
Submitted for inclusion to Emacs and XEmacs.
@end itemize

@noindent @b{Version 2.14}
@itemize @bullet
@item
Variable @var{reftex-plug-into-AUCTeX} simplifies cooperation with
AUCTeX.@refill
@end itemize

@noindent @b{Version 2.17}
@itemize @bullet
@item
Label prefix expands % escapes with current file name and other stuff.
@item
Citation format now with % escapes.  This is not backward
compatible!@refill
@item
TEXINPUTS variable recognized when looking for input files.
@item
Context can be the nth argument of a macro.@refill
@item
Searching in the select buffer is now possible (@kbd{C-s} and
@kbd{C-r}).@refill
@item
Display and derive-label can use two different context methods.
@item
AMSmath @code{xalignat} and @code{xxalignat} added.
@end itemize

@noindent @b{Version 3.00}
@itemize @bullet
@item
@b{Ref@TeX{}} should work better for very large projects:
@item
The new parser works without creating a master buffer.
@item
Rescanning can be limited to a part of a multifile document.
@item
Information from the parser can be stored in a file.
@item
@b{Ref@TeX{}} can deal with macros having a naked label as an argument.
@item
Macros may have white space and newlines between arguments.
@item
Multiple identical section headings no longer confuse
@code{reftex-toc}.@refill
@item
@b{Ref@TeX{}} should work correctly in combination with buffer-altering
packages like outline, folding, x-symbol, iso-cvt, isotex, etc.@refill
@item
All labeled environments discussed in @emph{The LaTeX Companion} by
Goossens, Mittelbach & Samarin, Addison-Wesley 1994) are part of
@b{Ref@TeX{}}'s defaults.@refill
@end itemize

@noindent @b{Version 3.03}
@itemize @bullet
@item
Support for the LaTeX package @code{xr}, for inter-document
references.@refill
@item
A few (minor) Mule-related changes.
@item
Fixed bug which could cause HUGE .rel files.
@item
Search for input and .bib files with recursive path definitions.
@end itemize

@noindent @b{Version 3.04}
@itemize @bullet
@item
Fixed BUG in the @emph{xr} support.
@end itemize

@noindent @b{Version 3.05}
@itemize @bullet
@item
Compatibility code now first checks for XEmacs feature.
@end itemize

@noindent @b{Version 3.07}
@itemize @bullet
@item
@code{Ref} menu improved.
@end itemize

@noindent @b{Version 3.10}
@itemize @bullet
@item
Fixed a bug which made reftex 3.07 fail on [X]Emacs version 19.
@item
Removed unimportant code which caused OS/2 Emacs to crash.
@item
All customization variables now accessible from menu.
@end itemize

@noindent @b{Version 3.11}
@itemize @bullet
@item
Fixed bug which led to naked label in (e.g.) footnotes.
@item
Added scroll-other-window functions to RefTeX-Select.
@end itemize

@noindent @b{Version 3.12}
@itemize @bullet
@item
There are 3 new keymaps for customization: @var{reftex-toc-map},
@var{reftex-select-label-map}, @var{reftex-select-bib-map}.
@item
Refontification uses more standard font-lock stuff.
@item
When no BibTeX database files are specified, citations can also use
@code{\bibitem} entries from a @code{thebibliography} environment.@refill
@end itemize

@noindent @b{Version 3.14}
@itemize @bullet
@item
Selection buffers can be kept between selections: this is faster.
See new variable @var{reftex-use-multiple-selection-buffers}.@refill
@item
Prefix interpretation of reftex-view-crossref changed.
@item
Support for the @code{varioref} package (@kbd{v} key in selection
buffer).@refill
@end itemize

@noindent @b{Version 3.16}
@itemize @bullet
@item
New hooks @var{reftex-format-label-function},
@var{reftex-format-ref-function}, @var{reftex-format-cite-function}.@refill
@item
TeXInfo documentation completed.
@item
Some restrictions in Label inserting and referencing removed.
@item
New variable @var{reftex-default-bibliography}.
@end itemize

@noindent @b{Version 3.17}
@itemize @bullet
@item
Additional bindings in selection and @code{*toc*} buffers.  @kbd{g}
redefined.
@item
New command @code{reftex-save-all-document-buffers}.
@item
Magic word matching made more intelligent.
@item
Selection process can switch to completion (with @key{TAB}).
@item
@code{\appendix} is now recognized and influences section numbering.
@item
File commentary shortened considerably (use Info documentation).
@item
New option @var{reftex-no-include-regexps} to skip some include files.
@item
New option @var{reftex-revisit-to-follow}.
@end itemize
@end ignore

@noindent @b{Version 3.18}
@itemize @bullet
@item
The selection now uses a recursive edit, much like minibuffer input.
This removes all restrictions during selection.  E.g. you can now
switch buffers at will, use the mouse etc.@refill
@item
New option @var{reftex-highlight-selection}.
@item
@kbd{mouse-2} can be used to select in selection and @code{*toc*}
buffers.@refill
@item
Fixed some problems regarding the interaction with VIPER mode.
@item
Follow-mode is now only used after point motion.
@item
@b{Ref@TeX{}} now finally does not fontify temporary files anymore.
@end itemize

@noindent @b{Version 3.19}
@itemize @bullet
@item
Fixed bug with AUCTeX @var{TeX-master}.
@end itemize

@noindent @b{Version 3.21}
@itemize @bullet
@item
New options for all faces used by @b{Ref@TeX{}}. They're in the
customization group @code{reftex-fontification-configurations}.@refill
@end itemize

@noindent @b{Version 3.22}
@itemize @bullet
@item
Fixed bug with empty context strings.
@item
@code{reftex-mouse-view-crossref} is now bound by default at
@kbd{S-mouse-2}.@refill
@end itemize

@noindent @b{Version 3.23}
@itemize @bullet
@item
Parse files @file{MASTER.rel} made compatible between Emacs and XEmacs.
@item
@code{kill-emacs-hook} and @code{kill-buffer-hook} now write the parse 
file.
@item
The cursor inside a @code{\ref} or @code{\cite} macro can now trigger
automatic display of crossref information in the echo area.  See
variable @var{reftex-auto-view-crossref}.
@item
AUCTeX interface updates:
@itemize @minus
@item
AUCTeX 9.9c and later notifies @b{Ref@TeX{}} about new sections.
@item
@b{Ref@TeX{}} notifies AUCTeX about new labels.
@item
@code{TeX-arg-ref} no longer used (introduction was unnecessaary).
@item
@code{reftex-arg-label} and @code{reftex-arg-cite} fixed up.
@item
Settings added to @b{Ref@TeX{}} via style files remain local.
@end itemize
@item
Fixed bug with @code{reftex-citation} in non-latex buffers.
@item
Fixed bug with syntax table and context refontification.
@item
Safety-net for name change of @var{font-lock-reference-face}.
@end itemize

@noindent @b{Version 3.24}
@itemize @bullet
@item
New option @var{reftex-revisit-to-echo}.
@item
Interface with X-Symbol (>=2.6) is now complete and stable.
@item
Adapted to new outline, which uses overlays.
@item
File names in @code{\bibliography} may now have the @code{.bib}
extension.@refill
@item
Fixed Bug with parsing "single file" from master file buffer.
@end itemize

@noindent @b{Version 3.25}
@itemize @bullet
@item
Echoing of citation info caches the info for displayed entries.
New option @var{reftex-cache-cite-echo}.@refill
@item
@kbd{M-x reftex-reset-mode} now also removes the file with parsing
info.@refill
@item
Default of @var{reftex-revisit-to-follow} changed to nil.
@end itemize

@noindent @b{Version 3.26}
@itemize @bullet
@item
[X]Emacs 19 no longer supported.  Use 3.22 for Emacs 19.
@item
New hooks @var{reftex-translate-to-ascii-function},
@var{reftex-string-to-label-function}.@refill
@item
Made sure automatic crossref display will not visit/scan files.
@end itemize

@noindent @b{Version 3.27}
@itemize @bullet
@item
Macros can define @emph{neutral} labels, just like @code{\label}
itself.@refill
@item
New option @var{reftex-allow-detached-macro-args}, default @code{nil}!
@end itemize

@noindent @b{Version 3.28}
@itemize @bullet
@item
Auto view crossref for XEmacs uses @var{post-command-hook} to restart the
timer, since itimer restart is not reliable.@refill
@item
Option @var{reftex-bibfile-ignore-list} renamed to @var{-regexps}.
@item
Expansion of recursive tex and bib path rewritten.
@item
Fixed problem where @b{Ref@TeX{}} did not scan unsaved buffers.
@item
Fixed bug with section numbering after *-red sections.
@end itemize

@noindent @b{Version 3.30}
@itemize @bullet
@item
In @code{reftex-citation}, the regular expression used to scan BibTeX
files can be specified using copletion on known citation keys.
@item
New keys @kbd{a} and @kbd{A} in BibTeX selecton process to cite @emph{all}
entries.
@item
New command @code{reftex-renumber-simple-labels} to renumber simple
labels like @samp{eq:13} sequentially through a document.
@end itemize
@noindent @b{Version 3.33}
@itemize @bullet
@item
Multiple selection buffers are now hidden buffers (they start with a
SPC).
@item 
Fixed bug with file search when TEXINPUTS environment variable is empty.
@end itemize
@noindent @b{Version 3.34}
@itemize @bullet
@item
Additional flag in @var{reftex-derive-label-parameters} do make only
lowercase labels (default @code{t}).
@item
All @file{.rel} files have a final newline to avoid queries.
@item
Single byte representations of accented European letters (ISO-8859-1)
are now legal in labels.
@end itemize

@node Index,  , , Top
@unnumbered Index
@printindex cp

@summarycontents
@contents
@bye




