\gdef\ConTeXt{Con\TeX t}
@end tex
-@include ../emacs/emacsver.texi
+@include emacsver.texi
@set VERSION @value{EMACSVER}
@set AUCTEXSITE @uref{http://www.gnu.org/software/auctex/,@AUCTeX{} web site}
to do labels, references, citations and indices for LaTeX documents
with Emacs.
-Copyright @copyright{} 1997-2012 Free Software Foundation, Inc.
+Copyright @copyright{} 1997--2013 Free Software Foundation, Inc.
@quotation
Permission is granted to copy, distribute and/or modify this document
is included in the section entitled ``GNU Free Documentation License''.
(a) The FSF's Back-Cover Text is: ``You have the freedom to copy and
-modify this GNU manual. Buying copies from the FSF supports it in
-developing GNU and promoting software freedom.''
+modify this GNU manual.''
@end quotation
@end copying
@contents
@ifnottex
-@node Top,,,(dir)
+@node Top
@top @RefTeX{}
@RefTeX{} is a package for managing Labels, References, Citations and
* Multifile Documents:: Document spread over many files.
* Language Support:: How to support other languages.
* Finding Files:: Included @TeX{} files and @BibTeX{} .bib files.
-* AUCTeX:: Cooperation with @AUCTeX{}.
* Optimizations:: When RefTeX is too slow.
+* AUCTeX:: Cooperation with @AUCTeX{}.
* 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.
* GNU Free Documentation License:: The license for this documentation.
@end ifnottex
-@node Introduction, Table of Contents, , Top
+@node Introduction
@chapter Introduction
@cindex Introduction
* RefTeX in a Nutshell:: A brief summary and quick guide.
@end menu
-@node Installation, RefTeX in a Nutshell, , Introduction
+@node Installation
@section Installation
@cindex Installation
for Emacs Lisp files and info files. Also, enter the name of your Emacs
executable (usually either @samp{emacs} or @samp{xemacs}).
-Then, type
+Then, type
@example
make
@RefTeX{} needs to access all files which are part of a multifile
document, and the BibTeX database files requested by the
@code{\bibliography} command. To find these files, @RefTeX{} will
-require a search path, i.e. a list of directories to check. Normally
+require a search path, i.e., a list of directories to check. Normally
this list is stored in the environment variables @code{TEXINPUTS} and
@code{BIBINPUTS} which are also used by @RefTeX{}. However, on some
systems these variables do not contain the full search path. If
@xref{Finding Files}.
@page
-@node RefTeX in a Nutshell, , Installation, Introduction
+@node RefTeX in a Nutshell
@section @RefTeX{} in a Nutshell
@cindex Quick-Start
@cindex Getting Started
part is a command and variable reference.
@end enumerate
-@node Table of Contents, Labels and References, Introduction, Top
+@node Table of Contents
@chapter Table of Contents
@cindex @file{*toc*} buffer
@cindex Structure editing
@code{\chapter}, @code{\subsection} to @code{\section} etc. If there is
an active region, all sections in the region will be promoted, including
the one at point. To avoid mistakes, @RefTeX{} requires a fresh
-document scan before executing this command -- if necessary, it will
+document scan before executing this command; if necessary, it will
automatically do this scan and ask the user to repeat the promotion
command.
prefix determines the wording of a reference. After a
promotion/demotion it may be necessary to change a few labels from
@samp{sec:xyz} to @samp{cha:xyz} or vice versa. This command can be
-used to do this - it launches a query replace to rename the definition
+used to do this; it launches a query replace to rename the definition
and all references of a label.
@tablesubheading{Exiting}
@vindex reftex-toc-max-level
Change the maximum level of toc entries displayed in the @file{*toc*}
buffer. Without prefix arg, all levels will be included. With prefix
-arg (e.g @kbd{3 t}), ignore all toc entries with level greater than
+arg (e.g., @kbd{3 t}), ignore all toc entries with level greater than
@var{arg} (3 in this case). Chapters are level 1, sections are level 2.
The mode line @samp{T<>} indicator shows the current value. The default
depth can be configured with the variable
@cindex Table of contents buffer, recentering
@kindex C-c -
If you call @code{reftex-toc} while the @file{*toc*} buffer already
-exists, the cursor will immediately jump to the right place, i.e. the
+exists, the cursor will immediately jump to the right place, i.e., the
section from which @code{reftex-toc} was called will be highlighted.
The command @kbd{C-c -} (@code{reftex-toc-recenter}) will only redisplay
the @file{*toc*} buffer and highlight the correct line without actually
selecting the @file{*toc*} window. This can be useful to quickly find
out where in the document you currently are. You can also automate this
by asking RefTeX to keep track of your current editing position in the
-TOC. The TOC window will then be updated whenever you stop typing for
+TOC@. The TOC window will then be updated whenever you stop typing for
more than @code{reftex-idle-time} seconds. By default this works only
with the dedicated @file{*TOC*} frame. But you can also force automatic
recentering of the TOC window on the current frame with
theorem-like environments. @xref{Defining Label Environments}, for an
example.
-@node Labels and References, Citations, Table of Contents, Top
+@node Labels and References
@chapter Labels and References
@cindex Labels in LaTeX
@cindex References in LaTeX
Several different environments can share a common counter and therefore
a common label category. For example labels in both @code{equation} and
-@code{eqnarray} environments record the value of the same counter -- the
+@code{eqnarray} environments record the value of the same counter: the
equation counter.
@menu
* xr (LaTeX package):: References to external documents.
@end menu
-@node Creating Labels, Referencing Labels, , Labels and References
+@node Creating Labels
@section Creating Labels
@cindex Creating labels
@cindex Labels, creating
set it up to delegate the creation of labels to
@RefTeX{}. @xref{AUCTeX}, for more information.
-@node Referencing Labels, Builtin Label Environments, Creating Labels, Labels and References
+@node Referencing Labels
@section Referencing Labels
@cindex Referencing labels
@cindex Labels, referencing
@vindex reftex-ref-macro-prompt
First, you can select which reference macro you want to use,
-e.g. @samp{\ref} or @samp{\pageref}. Later in the process you have
+e.g., @samp{\ref} or @samp{\pageref}. Later in the process you have
another chance to make this selection and you can therefore disable this
step by customizing @code{reftex-ref-macro-prompt} if you find it too
intrusive. @xref{Reference Styles}.
displayed by the @samp{S<...>} indicator in the mode line of the
selection buffer. This mechanism comes in handy if you are using
@LaTeX{} packages like @code{varioref} or @code{fancyref} and want to
-use the special referencing macros they provide (e.g. @code{\vref} or
+use the special referencing macros they provide (e.g., @code{\vref} or
@code{\fref}) instead of @code{\ref}.
@item V
In order to define additional commands for the selection process, the
keymap @code{reftex-select-label-map} may be used.
-@node Builtin Label Environments, Defining Label Environments, Referencing Labels, Labels and References
+@node Builtin Label Environments
@section Builtin Label Environments
@cindex Builtin label environments
@cindex Label environments, builtin
@vindex reftex-label-alist-builtin
@RefTeX{} needs to be aware of the environments which can be referenced
-with a label (i.e. which carry their own counters). By default, @RefTeX{}
+with a label (i.e., which carry their own counters). By default, @RefTeX{}
recognizes all labeled environments and macros discussed in @cite{The
@LaTeX{} Companion by Goossens, Mittelbach & Samarin, Addison-Wesley
1994.}. These are:
@code{\newtheorem}, @RefTeX{} needs to be configured to recognize
them (@pxref{Defining Label Environments}).
-@node Defining Label Environments, Reference Info, Builtin Label Environments, Labels and References
+@node Defining Label Environments
@section Defining Label Environments
@cindex Label environments, defining
* Putting it Together:: How to combine many entries.
@end menu
-@node Theorem and Axiom, Quick Equation, , Defining Label Environments
+@node Theorem and Axiom
@subsection Theorem and Axiom Environments
@cindex @code{theorem}, newtheorem
@cindex @code{axiom}, newtheorem
So we need to tell @RefTeX{} 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
+either use Lisp to do this (e.g., in @file{.emacs}) or use the custom
library. With Lisp it would look like this
@lisp
Labels)}).
-@node Quick Equation, Figure Wrapper, Theorem and Axiom , Defining Label Environments
+@node Quick Equation
@subsection Quick Equation Macro
@cindex Quick equation macro
@cindex Macros as environment wrappers
[ ] Make TOC entry : [Value Menu] No entry
@end example
-@node Figure Wrapper, Adding Magic Words, Quick Equation, Defining Label Environments
+@node Figure Wrapper
@subsection Figure Wrapping Macro
@cindex Macros as environment wrappers
@cindex Figure wrapping macro
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 third macro argument
--- the caption.
+The @samp{3} for the context method means to grab the third macro argument:
+the caption.
As a side effect of this configuration, @code{reftex-label} will now
insert the required naked label (without the @code{\label} macro) when
[ ] Make TOC entry : [Value Menu] No entry
@end example
-@node Adding Magic Words, Using \eqref, Figure Wrapper, Defining Label Environments
+@node Adding Magic Words
@subsection Adding Magic Words
@cindex Magic words
@cindex German magic words
(nil ?i nil nil nil ("Punkt"))))
@end lisp
-@node Using \eqref, Non-Standard Environments, Adding Magic Words, Defining Label Environments
+@node Using \eqref
@subsection Using @code{\eqref}
@cindex @code{\eqref}, AMS-LaTeX macro
@cindex AMS-LaTeX
@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{},
+of @AUCTeX{} (@pxref{Style Files}); so if you use @AUCTeX{},
this configuration will not be necessary.
-@node Non-Standard Environments, Putting it Together, Using \eqref, Defining Label Environments
+@node Non-Standard Environments
@subsection Non-standard Environments
@cindex Non-standard environments
@cindex Environments without @code{\begin}
(incf cnt))))))))
@end lisp
-@node Putting it Together, , Non-Standard Environments, Defining Label Environments
+@node Putting it Together
@subsection Putting it all together
When you have to put several entries into @code{reftex-label-alist}, just
(detect-linguex ?x "ex:" "~\\ref@{%s@}" nil ("Example" "Ex."))))
@end lisp
-@node Reference Info, Reference Styles, Defining Label Environments, Labels and References
+@node Reference Info
@section Reference Info
@findex reftex-view-crossref
@findex reftex-mouse-view-crossref
@code{\label} macro. @xref{Viewing Cross-References}, for more
information.
-@node Reference Styles, xr (LaTeX package), Reference Info, Labels and References
+@node Reference Styles
@section Reference Styles
In case you defined your own macros for referencing or you are using
customizing @code{reftex-ref-macro-prompt} and relying only on the
selection facilities provided in the last step.
-In the last step, i.e. the label selection, two key bindings are
+In the last step, i.e., the label selection, two key bindings are
provided to set the reference macro. Type @key{v} in order to cycle
forward through the list of available macros or @key{V} to cycle
backward. The mode line of the selection buffer shows the macro
@code{reftex-ref-style-alist} to fit your liking.
For each entry in @code{reftex-ref-style-alist} a function with the name
-@code{reftex-<package>-<macro>} (e.g. @code{reftex-varioref-vref}) will
+@code{reftex-<package>-<macro>} (e.g., @code{reftex-varioref-vref}) will
be created automatically by @RefTeX{}. These functions can be used
instead of @kbd{C-c )} and provide an alternative way of having your
favorite referencing macro preselected and if cycling through the macros
-seems inconvenient to you.@footnote{You could e.g. bind
+seems inconvenient to you.@footnote{You could, e.g., bind
@code{reftex-varioref-vref} to @kbd{C-c v} and
@code{reftex-fancyref-fref} to @kbd{C-c f}.}
creates not only the number of the referenced counter but also the
complete text around it, like @samp{Figure 3 on the preceding page}. In
order to make it work you need to use label prefixes like @samp{fig:}
-consistently -- something @RefTeX{} does automatically. For each of
+consistently---something @RefTeX{} does automatically. For each of
these packages a variable could be configured to make its macros to take
precedence over @code{\ref}. Those were @code{reftex-vref-is-default}
and @code{reftex-fref-is-default} respectively. While still working,
these variables are deprecated now. Instead of setting them, the
variable @code{reftex-ref-style-default-list} should be adapted now.
-@node xr (LaTeX package), , Reference Styles, Labels and References
+@node xr (LaTeX package)
@section @code{xr}: Cross-Document References
@cindex @code{xr}, LaTeX package
@cindex LaTeX packages, @code{xr}
information and the use of multiple selection buffers can mean a large
speed-up (@pxref{Optimizations}).
-@node Citations, Index Support, Labels and References, Top
+@node Citations
@chapter Citations
@cindex Citations
@cindex @code{\cite}
* BibTeX Database Subsets:: Extract parts of a big database.
@end menu
-@node Creating Citations, Citation Styles, , Citations
+@node Creating Citations
@section Creating Citations
@cindex Creating citations
@cindex Citations, creating
@end lisp
-@node Citation Styles, Citation Info, Creating Citations, Citations
+@node Citation Styles
@section Citation Styles
@cindex Citation styles
@cindex Citation styles, @code{natbib}
document. @xref{Style Files}, for information on how to set up the style
files correctly.
-@node Citation Info, Chapterbib and Bibunits, Citation Styles, Citations
+@node Citation Info
@section Citation Info
@cindex Displaying citations
@cindex Citations, displaying
corresponding to a @code{\bibitem} or @BibTeX{} database entry.
@xref{Viewing Cross-References}.
-@node Chapterbib and Bibunits, Citations Outside LaTeX, Citation Info, Citations
+@node Chapterbib and Bibunits
@section Chapterbib and Bibunits
@cindex @code{chapterbib}, LaTeX package
@cindex @code{bibunits}, LaTeX package
you have multiple bibliographies within a @emph{single file}, this may
or may not be the case.
-@node Citations Outside LaTeX, BibTeX Database Subsets, Chapterbib and Bibunits, Citations
+@node Citations Outside LaTeX
@section Citations outside @LaTeX{}
@cindex Citations outside LaTeX
@vindex reftex-default-bibliography
(reftex-citation))))))
@end lisp
-@node BibTeX Database Subsets, , Citations Outside LaTeX, Citations
+@node BibTeX Database Subsets
@section Database Subsets
@cindex BibTeX database subsets
@findex reftex-create-bibtex-file
either the @i{marked} entries (with the @kbd{e} key) or the
@i{unmarked} entries (with the @kbd{E} key).
-@node Index Support, Viewing Cross-References, Citations, Top
+@node Index Support
@chapter Index Support
@cindex Index Support
@cindex @code{\index}
* Defining Index Macros:: ... and macros it doesn't.
@end menu
-@node Creating Index Entries, The Index Phrases File, , Index Support
+@node Creating Index Entries
@section Creating Index Entries
@cindex Creating index entries
@cindex Index entries, creating
@file{multind} and @file{index} packages, this tag is the first argument
to the redefined @code{\index} macro.
-@node The Index Phrases File, Displaying and Editing the Index, Creating Index Entries, Index Support
+@node The Index Phrases File
@section The Index Phrases File
@cindex Index phrase file
@cindex Phrase file
* Global Indexing:: The interactive indexing process.
@end menu
-@node Collecting Phrases, Consistency Checks, , The Index Phrases File
+@node Collecting Phrases
@subsection Collecting Phrases
@cindex Collecting index phrases
@cindex Index phrases, collection
@code{<TABs>} stands for white space containing at least one @key{TAB}.
@var{key} must be at the start of the line and is the character
identifying one of the macros defined in the file header. It is
-optional - when omitted, the first macro definition line in the file
+optional; when omitted, the first macro definition line in the file
will be used for this phrase. The @var{phrase} is the phrase to be
searched for when indexing. It may contain several words separated by
spaces. By default the search phrase is also the text entered as
@samp{\index@{Planets!Pluto@}\index@{Kuiper Belt Objects!Pluto@}Pluto}
and will therefore create two different index entries.
-@node Consistency Checks, Global Indexing, Collecting Phrases, The Index Phrases File
+@node Consistency Checks
@subsection Consistency Checks
@cindex Index phrases, consistency checks
@cindex Phrases, consistency checks
@kindex C-c C-s
Before indexing the phrases in the phrases buffer, they should be
checked carefully for consistency. A first step is to sort the phrases
-alphabetically - this is done with the command @kbd{C-c C-s}
+alphabetically; this is done with the command @kbd{C-c C-s}
(@code{reftex-index-sort-phrases}). It will sort all phrases in the
buffer alphabetically by search phrase. If you want to group certain
phrases and only sort within the groups, insert empty lines between the
In order to check the whole buffer like this, start at the beginning and
execute this command repeatedly.
-@node Global Indexing, , Consistency Checks, The Index Phrases File
+@node Global Indexing
@subsection Global Indexing
@cindex Global indexing
@cindex Indexing, global
purpose. When called from a @LaTeX{} document with active region, it will
apply @code{reftex-index-all-phrases} to the current region.
-@node Displaying and Editing the Index, Builtin Index Macros, The Index Phrases File, Index Support
+@node Displaying and Editing the Index
@section Displaying and Editing the Index
@cindex Displaying the Index
@cindex Editing the Index
@end table
-@node Builtin Index Macros, Defining Index Macros, Displaying and Editing the Index, Index Support
+@node Builtin Index Macros
@section Builtin Index Macros
@cindex Builtin index macros
@cindex Index macros, builtin
you will have to explicitly specify the index style used.
@xref{Creating Index Entries}, for information on how to do that.
-@node Defining Index Macros, , Builtin Index Macros, Index Support
+@node Defining Index Macros
@section Defining Index Macros
@cindex Defining Index Macros
@cindex Index macros, defining
respectively.
The following string is empty unless your macro adds a superordinate
-entry to the index key - this is the case for the @code{\astobj} macro.
+entry to the index key; this is the case for the @code{\astobj} macro.
The next entry can be a hook function to exclude certain matches, it
almost always can be @code{nil}.
in the buffer with @kbd{C-c /} (@code{reftex-index-selection-or-word}).
The index tag is "idx".
-@node Viewing Cross-References, RefTeXs Menu, Index Support, Top
+@node Viewing Cross-References
@chapter Viewing Cross-References
@findex reftex-view-crossref
@findex reftex-mouse-view-crossref
@iftex
@chapter All the Rest
@end iftex
+@ifnottex
+@raisesections
+@end ifnottex
-@node RefTeXs Menu, Key Bindings, Viewing Cross-References, Top
+@node RefTeXs Menu
@section @RefTeX{}'s Menu
@cindex RefTeXs Menu
@cindex Menu, in the menu bar
@code{Customize} submenu which can be used to access @RefTeX{}'s
entire set of options.
-@node Key Bindings, Faces, RefTeXs Menu, Top
+@node Key Bindings
@section Default Key Bindings
@cindex Key Bindings, summary
@code{reftex-load-hook}. For information on the keymaps
which should be used to add keys, see @ref{Keymaps and Hooks}.
-@node Faces, AUCTeX, Key Bindings, Top
+@node Faces
@section Faces
@cindex Faces
loaded. If you wish to turn off fontification or change the involved
faces, see @ref{Options (Fontification)}.
-@node Multifile Documents, Language Support, AUCTeX, Top
+@node Multifile Documents
@section Multifile Documents
@cindex Multifile documents
@cindex Documents, spread over files
context.
@end itemize
-@node Language Support, Finding Files, Multifile Documents, Top
+@node Language Support
@section Language Support
@cindex Language support
@code{reftex-cite-punctuation}.
@end itemize
-@node Finding Files, Optimizations, Language Support, Top
+@node Finding Files
@section Finding Files
@cindex Finding files
@item
Some @TeX{} systems provide stand-alone programs to do the file search just
-like @TeX{} and @BibTeX{}. E.g. Thomas Esser's @code{teTeX} uses the
+like @TeX{} and @BibTeX{}. E.g., Thomas Esser's @code{teTeX} uses the
@code{kpathsearch} library which provides the command @code{kpsewhich}
to search for files. @RefTeX{} can be configured to use this
program. Note that the exact syntax of the @code{kpsewhich}
'( "nw" "tex" "sty" "cls" "ltx" "texi" "texinfo"))
@end lisp
-@node Optimizations, Problems and Work-Arounds, Finding Files, Top
+@node Optimizations
@section Optimizations
@cindex Optimizations
@end group
@end lisp
-@node AUCTeX, Multifile Documents, Faces, Top
+@node AUCTeX
@section @AUCTeX{}
@cindex @code{AUCTeX}, Emacs package
@cindex Emacs packages, @code{AUCTeX}
* Bib-Cite:: Hypertext reading of a document
@end menu
-@node AUCTeX-RefTeX Interface, Style Files, , AUCTeX
+@node AUCTeX-RefTeX Interface
@subsection The @AUCTeX{}-@RefTeX{} Interface
@RefTeX{} contains code to interface with @AUCTeX{}. When this
@RefTeX{} will add all newly created labels to @AUCTeX{}'s completion list.
@end itemize
-@node Style Files, Bib-Cite, AUCTeX-RefTeX Interface, AUCTeX
+@node Style Files
@subsection Style Files
@cindex Style files, AUCTeX
@findex TeX-add-style-hook, @r{AUCTeX}
commands of a document (@pxref{Style Files,,,auctex}). Support for
@RefTeX{} in such a style file is useful when the @LaTeX{} style
defines macros or environments connected with labels, citations, or the
-index. Many style files (e.g. @file{amsmath.el} or @file{natbib.el})
+index. Many style files (e.g., @file{amsmath.el} or @file{natbib.el})
distributed with @AUCTeX{} already support @RefTeX{} in this
way.
("rotatefoilhead" . 3))))))
@end lisp
-@node Bib-Cite, , Style Files, AUCTeX
+@node Bib-Cite
@subsection Bib-Cite
@cindex @code{bib-cite}, Emacs package
@cindex Emacs packages, @code{bib-cite}
@end lisp
@page
-@node Problems and Work-Arounds, Imprint, Optimizations, Top
+@node Problems and Work-Arounds
@section Problems and Work-arounds
@cindex Problems and work-arounds
@item
@b{@LaTeX{} commands}@*
@cindex LaTeX commands, not found
-@code{\input}, @code{\include}, and @code{\section} (etc.) statements
+@code{\input}, @code{\include}, and @code{\section} (etc.)@: statements
have to be first on a line (except for white space).
@item
@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,
+different from its disk representation (e.g., x-symbol, isotex,
iso-cvt) you may find that @RefTeX{}'s parsing information sometimes
reflects the disk state of a file. This happens only in @emph{unvisited}
parts of a multifile document, because @RefTeX{} visits these files
@vindex reftex-keep-temporary-buffers
@code{(setq reftex-keep-temporary-buffers t)}@*
This implies that @RefTeX{} will load all parts of a multifile
-document into Emacs (i.e. there won't be any temporary buffers).
+document into Emacs (i.e., there won't be any temporary buffers).
@item
@vindex reftex-initialize-temporary-buffers
@code{(setq reftex-initialize-temporary-buffers t)}@*
@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
+to specify a label. E.g., Lamport's @file{pf.sty} uses both
@example
\step@{@var{label}@}@{@var{claim}@} and \begin@{step+@}@{@var{label}@}
@var{claim}
@end itemize
@page
-@node Imprint, Commands, Problems and Work-Arounds, Top
+@node Imprint
@section Imprint
@cindex Imprint
@cindex Maintainer
@cindex @code{http}, @RefTeX{} home page
@cindex @code{ftp}, @RefTeX{} site
-@RefTeX{} was written by @i{Carsten Dominik}
-@email{dominik@@science.uva.nl}, with contributions by @i{Stephen
+@c dominik@@science.uva.nl
+@RefTeX{} was written by @i{Carsten Dominik}, with contributions by @i{Stephen
Eglen}. @RefTeX{} is currently maintained by @value{MAINTAINER}, see
the @value{MAINTAINERSITE} for detailed information.
supporting @LaTeX{} labels and references with an editor (which was
MicroEmacs at the time).
-@node Commands, Options, Imprint, Top
+@c Turn off the raising that we turned on in ``All the rest''.
+@ifnottex
+@lowersections
+@end ifnottex
+
+@node Commands
@chapter Commands
@cindex Commands, list of
@deffn Command reftex-index-phrase-selection-or-word
Add current selection or the word at point to the phrases buffer.
When you are in transient-mark-mode and the region is active, the
-selection will be used - otherwise the word at point.
-You get a chance to edit the entry in the phrases buffer - to save the
+selection will be used; otherwise the word at point.
+You get a chance to edit the entry in the phrases buffer; to save the
buffer and return to the @LaTeX{} document, finish with @kbd{C-c C-c}.
@end deffn
removes the parse file associated with the current document.
@end deffn
-@node Options, Keymaps and Hooks, Commands, Top
+@node Options
@chapter Options, Keymaps, Hooks
@cindex Options, list of
Here is a complete list of @RefTeX{}'s configuration variables. All
-variables have customize support - so if you are not familiar with Emacs
+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.
* Options (Optimizations)::
* Options (Fontification)::
* Options (Misc)::
+* Keymaps and Hooks::
@end menu
-@node Options (Table of Contents), Options (Defining Label Environments), , Options
+@node Options (Table of Contents)
@section Table of Contents
@cindex Options, table of contents
@cindex Table of contents, options
@end defopt
@defopt reftex-toc-max-level
-The maximum level of toc entries which will be included in the TOC.
+The maximum level of toc entries which will be included in the TOC@.
Section headings with a bigger level will be ignored. In RefTeX,
chapters are level 1, sections level 2 etc. This variable can be
changed from within the @file{*toc*} buffer with the @kbd{t} key.
(@pxref{Table of Contents}).
@end deffn
-@node Options (Defining Label Environments), Options (Creating Labels), Options (Table of Contents), Options
+@node Options (Defining Label Environments)
@section Defining Label Environments
@cindex Options, defining label environments
@cindex Defining label environments, options
@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
+not have to have a label argument; you could also use
@samp{\label@{...@}} inside one of its arguments.
Special names: @code{section} for section labels, @code{any} to define a
1000 means to get text after the last macro argument.
@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. setting
+Context is then the text following the end of the match. E.g., setting
this to @samp{\\caption[[@{]} will use the caption in a figure or table
environment. @samp{\\begin@{eqnarray@}\|\\\\} works for
eqnarrays.
Label context is used in two ways by @RefTeX{}: For display in the label
menu, and to derive a label string. If you want to use a different
method for each of these, specify them as a dotted pair.
-E.g. @code{(nil . t)} uses the text after the label (@code{nil}) for
+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.
@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
+to calculate the final regular expression, so @samp{%s} will be
replaced with the environment or macro.
@end defopt
t @r{This means to trust any label prefixes found.}
regexp @r{If a regexp, only prefixes matched by the regexp are trusted.}
list @r{List of accepted prefixes, as strings. The colon is part of}
- @r{the prefix, e.g. ("fn:" "eqn:" "item:").}
+ @r{the prefix, e.g., ("fn:" "eqn:" "item:").}
nil @r{Never trust a label prefix.}
@end example
The only disadvantage of using this feature is that the label context
displayed in the label selection buffer along with each label is
simply some text after the label definition. This is no problem if you
-place labels keeping this in mind (e.g. @i{before} the equation, @i{at
+place labels keeping this in mind (e.g., @i{before} the equation, @i{at
the beginning} of a fig/tab caption ...). Anyway, it is probably best
to use the regexp or the list value types to fine-tune this feature.
For example, if your document contains thousands of footnotes with
non-footnote labels.
@end defopt
-@node Options (Creating Labels), Options (Referencing Labels), Options (Defining Label Environments), Options
+@node Options (Creating Labels)
@section Creating Labels
@cindex Options, creating labels
@cindex Creating labels, options
@end table
@end defopt
-@node Options (Referencing Labels), Options (Creating Citations), Options (Creating Labels), Options
+@node Options (Referencing Labels)
@section Referencing Labels
@cindex Options, referencing labels
@cindex Referencing labels, options
@code{t} (table), @code{i} (item), @code{e} (equation), @code{n}
(footnote), plus any definitions in @code{reftex-label-alist}.
-Most options can also be switched from the label menu itself - so if you
+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.
@end defopt
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 @code{reftex-label-alist}. This hook also is used by the
-special commands to insert e.g. @code{\vref} and @code{\fref}
+special commands to insert, e.g., @code{\vref} and @code{\fref}
references, so even if you set this, your setting will be ignored by the
special commands. The function will be called with three arguments, the
@var{label}, the @var{default format} which normally is
label type. To do that, @RefTeX{} will look at the word before the
cursor and compare it with the magic words given in
@code{reftex-label-alist}. When it finds a match, @RefTeX{} will
-immediately offer the correct label menu - otherwise it will prompt you
+immediately offer the correct label menu; otherwise it will prompt you
for a label type. If you set this variable to @code{nil}, @RefTeX{}
will always prompt for a label type.
@end defopt
(@pxref{Referencing Labels}).
@end deffn
-@node Options (Creating Citations), Options (Index Support), Options (Referencing Labels), Options
+@node Options (Creating Citations)
@section Creating Citations
@cindex Options, creating citations
@cindex Creating citations, options
@example
nil @r{Never prompt for optional arguments}
t @r{Always prompt}
-maybe @r{Prompt only if @code{reftex-citation} was called with C-u prefix arg}@end example
+maybe @r{Prompt only if @code{reftex-citation} was called with C-u prefix arg}
+@end example
Unnecessary empty optional arguments are removed before insertion into
the buffer. See @code{reftex-cite-cleanup-optional-args}.
@end defopt
@end defopt
-@node Options (Index Support), Options (Viewing Cross-References), Options (Creating Citations), Options
+@node Options (Index Support)
@section Index Support
@cindex Options, Index support
@cindex Index support, options
the variable @code{reftex-index-macros-builtin} to specify the main
indexing package you are using. Valid values are currently
@example
-default @r{The @LaTeX{} default - unnecessary to specify this one}
+default @r{The @LaTeX{} default; unnecessary to specify this one}
multind @r{The multind.sty package}
index @r{The index.sty package}
index-shortcut @r{The index.sty packages with the ^ and _ shortcuts.}
- @r{Should not be used - only for old documents}
+ @r{Should not be used; only for old documents}
@end example
Note that @AUCTeX{} sets these things internally for @RefTeX{} as well,
so with a sufficiently new version of @AUCTeX{}, you should not set the
The default index macro for @code{reftex-index-selection-or-word}.
This is a list with @code{(@var{macro-key} @var{default-tag})}.
-@var{macro-key} is a character identifying an index macro - see
+@var{macro-key} is a character identifying an index macro; see
@code{reftex-index-macros}.
@var{default-tag} is the tag to be used if the macro requires a
completion. Valid values of this variable are:
@example
nil @r{Do not provide a default index}
-"tag" @r{The default index tag given as a string, e.g. "idx"}
+"tag" @r{The default index tag given as a string, e.g., "idx"}
last @r{The last used index tag will be offered as default}
@end example
@end defopt
@code{reftex-index-selection-or-word} is executed inside @TeX{} math mode,
the index key copied from the buffer is processed with this format
string through the @code{format} function. This can be used to add the
-math delimiters (e.g. @samp{$}) to the string. Requires the
+math delimiters (e.g., @samp{$}) to the string. Requires the
@file{texmathp.el} library which is part of @AUCTeX{}.
@end defopt
@defopt reftex-index-phrases-wrap-long-lines
Non-@code{nil} means, when indexing from the phrases buffer, wrap lines.
-Inserting indexing commands in a line makes the line longer - often
+Inserting indexing commands in a line makes the line longer, often
so long that it does not fit onto the screen. When this variable is
non-@code{nil}, newlines will be added as necessary before and/or after the
indexing command to keep lines short. However, the matched text
(@pxref{Index Support}).
@end deffn
-@node Options (Viewing Cross-References), Options (Finding Files), Options (Index Support), Options
+@node Options (Viewing Cross-References)
@section Viewing Cross-References
@cindex Options, viewing cross-references
@cindex Viewing cross-references, options
scans. In order to clear it, use @kbd{M-x reftex-reset-mode}.
@end defopt
-@node Options (Finding Files), Options (Optimizations), Options (Viewing Cross-References), Options
+@node Options (Finding Files)
@section Finding Files
@cindex Options, Finding Files
@cindex Finding files, options
recursion. Thus, in a path @samp{.//:/tex/}, search first @samp{./},
then @samp{/tex/}, and then all subdirectories of @samp{./}. If this
option is @code{nil}, the subdirectories of @samp{./} are searched
-before @samp{/tex/}. This is mainly for speed - most of the time the
+before @samp{/tex/}. This is mainly for speed; most of the time the
recursive path is for the system files and not for the user files. Set
this to @code{nil} if the default makes @RefTeX{} finding files with
equal names in wrong sequence.
@end defopt
@page
-@node Options (Optimizations), Options (Fontification), Options (Finding Files), Options
+@node Options (Optimizations)
@section Optimizations
@cindex Options, optimizations
@cindex Optimizations, options
@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.
+not 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 @code{reftex-auto-update-selection-buffers}.
non-@code{nil}.
@end defopt
-@node Options (Fontification), Options (Misc), Options (Optimizations), Options
+@node Options (Fontification)
@section Fontification
@cindex Options, fontification
@cindex Fontification, options
@item t
Always refontify.
@item 1
-Refontify when necessary, e.g. with old versions of the x-symbol
+Refontify when necessary, e.g., with old versions of the x-symbol
package.
@end table
The option is ignored when @code{reftex-use-fonts} is @code{nil}.
Face name for index entries.
@end defopt
-@node Options (Misc), , Options (Fontification), Options
+@node Options (Misc)
@section Miscellaneous
@cindex Options, misc
argument.
@end defopt
-@node Keymaps and Hooks, Changes, Options, Top
+@node Keymaps and Hooks
@section Keymaps and Hooks
@cindex Keymaps
are many more hooks which are described in the relevant sections about
options for a specific part of @RefTeX{}.
-@node Changes, GNU Free Documentation License, Keymaps and Hooks, Top
+@node Changes
@chapter Changes
@cindex Changes
the current region.
@item
New option @code{reftex-toc-split-windows-fraction} to set the size of
-the window used by the TOC. This makes the old variable
+the window used by the TOC@. This makes the old variable
@code{reftex-toc-split-windows-horizontally-fraction} obsolete.
@item
A dedicated frame can show the TOC with the current section
@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
+This removes all restrictions during selection. E.g., you can now
switch buffers at will, use the mouse etc.
@item
New option @code{reftex-highlight-selection}.
@noindent @b{Version 3.11}
@itemize @bullet
@item
-Fixed bug which led to naked label in (e.g.) footnotes.
+Fixed bug which led to naked label in (e.g.@:) footnotes.
@item
Added scroll-other-window functions to RefTeX-Select.
@end itemize
released on 7 Jan 1997.
@end itemize
-@node GNU Free Documentation License, Index, Changes, Top
+@node GNU Free Documentation License
@appendix GNU Free Documentation License
@include doclicense.texi
-@node Index, , GNU Free Documentation License, Top
+@node Index
@unnumbered Index
@printindex cp
HCoop / bpt / emacs.git / blobdiff