@syncodeindex fn cp
@c Version and Contact Info
-@set VERSION 4.24
-@set EDITION 4.24
-@set DATE August 2004
-@set AUCTEXSITE @uref{http://www.nongnu.org/auctex/,AUCTeX distribution site}
-@set MAINTAINERSITE @uref{http://www.astro.uva.nl/~dominik/Tools/,maintainers webpage}
-@set MAINTAINER Carsten Dominik
-@set MAINTAINEREMAIL @email{dominik@@science.uva.nl}
-@set MAINTAINERCONTACT @uref{mailto:dominik@@science.uva.nl,contact the maintainer}
-@set XEMACSFTP @uref{ftp://ftp.xemacs.org/pub/xemacs/packages/,XEmacs ftp site}.
+@set VERSION 4.31
+@set EDITION 4.31
+@set DATE February 2006
+@set AUCTEXSITE @uref{http://www.gnu.org/software/auctex/,AUCTeX distribution site}
+@set MAINTAINERSITE @uref{http://www.gnu.org/software/auctex/reftex.html,Ref@TeX{} web page}
+@set MAINTAINERCONTACT @uref{mailto:auctex-devel@@gnu.org,contact the maintainers}
+@set MAINTAINER the AUC@TeX{} project
+@set SUPPORTADDRESS AUC@TeX{} user mailing list (@email{auctex@@gnu.org})
+@set DEVELADDRESS AUC@TeX{} developer mailing list (@email{auctex-devel@@gnu.org})
+@set BUGADDRESS AUC@TeX{} bug mailing list (@email{bug-auctex@@gnu.org})
+@set XEMACSFTP @uref{ftp://ftp.xemacs.org/pub/xemacs/packages/,XEmacs ftp site}
@c %**end of header
@copying
This is edition @value{EDITION} of the @b{Ref@TeX{}} User Manual for
@b{Ref@TeX{}} @value{VERSION}
-Copyright (c) 1997, 1998, 1999, 2000, 2001, 2002 Free Software Foundation, Inc.
+Copyright @copyright{} 1997, 1998, 1999, 2000, 2001, 2002, 2003, 2004,
+2005, 2006, 2007 Free Software Foundation, Inc.
@quotation
Permission is granted to copy, distribute and/or modify this document
-under the terms of the GNU Free Documentation License, Version 1.1 or
+under the terms of the GNU Free Documentation License, Version 1.2 or
any later version published by the Free Software Foundation; with no
Invariant Sections, with the Front-Cover texts being ``A GNU
Manual'', and with the Back-Cover Texts as in (a) below. A copy of the
* 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.
The Index
A label can be derived from context. This means, @b{Ref@TeX{}} takes
the context of the label definition and constructs a label from
that@footnote{Note that the context may contain constructs which are
-illegal in labels. @b{Ref@TeX{}} will therefore strip the accent from
+invalid in labels. @b{Ref@TeX{}} will therefore strip the accent from
accented Latin-1 characters and remove everything else which is not
-legal in labels. This mechanism is safe, but may not be satisfactory
+valid in labels. This mechanism is safe, but may not be satisfactory
for non-western languages. Check the following variables if you need to
change things: @code{reftex-translate-to-ascii-function},
@code{reftex-derive-label-parameters}, @code{reftex-label-illegal-re},
@cindex Citation styles, @code{natbib}
@cindex Citation styles, @code{harvard}
@cindex Citation styles, @code{chicago}
+@cindex Citation styles, @code{jurabib}
@cindex @code{natbib}, citation style
@cindex @code{harvard}, citation style
@cindex @code{chicago}, citation style
+@cindex @code{jurabib}, citation style
@vindex reftex-cite-format
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 @code{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->Citation Styles}. 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 Natbib style, this looks like this:
+@b{Ref@TeX{}} can be configured to produce these citation macros as well
+by setting the variable @code{reftex-cite-format}. For the most
+commonly used packages (@code{natbib}, @code{harvard}, @code{chicago},
+@code{jurabib}) this may be done from the menu, under
+@code{Ref->Citation Styles}. 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 Natbib style, this
+looks like this:
@example
SELECT A CITATION FORMAT
@lisp
(add-hook 'mail-setup-hook
(lambda () (define-key mail-mode-map "\C-c["
- (lambda () (interactive)
- (require 'reftex)
+ (lambda ()
+ (interactive)
(let ((reftex-cite-format 'locally))
(reftex-citation))))))
@end lisp
@vindex reftex-translate-to-ascii-function
@vindex reftex-label-illegal-re
Also, when a label is derived from context, @b{Ref@TeX{}} clears the
-context string from non-ASCII characters in order to make a legal label.
+context string from non-ASCII characters in order to make a valid label.
If there should ever be a version of @TeX{} which allows extended
characters @emph{in labels}, then we will have to look at the
variables @code{reftex-translate-to-ascii-function} and
@cindex @code{http}, @b{Ref@TeX{}} home page
@cindex @code{ftp}, @b{Ref@TeX{}} site
-@b{Ref@TeX{}} was written by @i{Carsten Dominik}
+Ref@TeX{} was written by @i{Carsten Dominik}
@email{dominik@@science.uva.nl}, with contributions by @i{Stephen
-Eglen}. @b{Ref@TeX{}} is currently maintained by
-
-@noindent
-Carsten Dominik <dominik@@science.uva.nl>
-
-If you have questions about @b{Ref@TeX{}}, there are several Usenet
-groups which have competent readers: @code{comp.emacs},
-@code{gnu.emacs.help}, @code{comp.emacs.xemacs}, @code{comp.text.tex},
-@code{de.comp.text.tex}. You can also write directly to the
-maintainer.
-
-If you find a bug in @b{Ref@TeX{}} or its documentation, or if you want
-to contribute code or ideas, please @value{MAINTAINERCONTACT}. 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 which throws an exception, please
-include a backtrace if you know how to produce one.
+Eglen}. Ref@TeX{} is currently maintained by @value{MAINTAINER}, see
+the @value{MAINTAINERSITE} for detailed information.
+
+If you have questions about Ref@TeX{}, you can send email to the
+@value{SUPPORTADDRESS}. If you want to contribute code or ideas, write
+to the @value{DEVELADDRESS}. And in the rare case of finding a bug,
+please use @kbd{M-x reftex-report-bug @key{RET}} which will prepare a
+bug report with useful information about your setup. Remember to add
+essential information like a recipe for reproducing the bug, what you
+expected to happen, and what actually happened. Send the bug report to
+the @value{BUGADDRESS}.
+
+There are also several Usenet groups which have competent readers who
+might be able to help: @code{comp.emacs}, @code{gnu.emacs.help},
+@code{comp.emacs.xemacs}, and @code{comp.text.tex}.
@b{Ref@TeX{}} is bundled and pre-installed with Emacs since version 20.2.
It was also bundled and pre-installed with XEmacs 19.16--20.x. XEmacs
this manual.
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{Fran
-Burstall, Alastair Burt, Lars Clausen, Soren Dayton, Stephen Eglen,
-Karl Eichwalder, Erik Frisk, Peter Galbraith, Kai Grossjohann, Frank
-Harrell, Peter Heslin, Stephan Heuel, Alan Ho, Lute Kamstra, Dieter
-Kraft, David Kastrup, Adrian Lanz, Juri Linkov, Rory Molinari, Stefan
-Monnier, Laurent Mugnier, Dan Nicolaescu, Sudeep Kumar Palat, Daniel
-Polani, Alan Shutko, Robin Socha, Richard Stanton, Allan Strand, Jan
-Vroonhof, Christoph Wedler, Alan Williams, Roland Winkler,
-Hans-Christoph Wirth, Eli Zaretskii}.
+developing it with their reports. In particular thanks to @i{Ralf
+Angeli, Fran Burstall, Alastair Burt, Lars Clausen, Soren Dayton,
+Stephen Eglen, Karl Eichwalder, Erik Frisk, Peter Galbraith, Kai
+Grossjohann, Frank Harrell, Till A. Heilmann, Peter Heslin, Stephan
+Heuel, Alan Ho, Lute Kamstra, Dieter Kraft, David Kastrup, Adrian Lanz,
+Juri Linkov, Rory Molinari, Stefan Monnier, Laurent Mugnier, Dan
+Nicolaescu, Sudeep Kumar Palat, Daniel Polani, Alan Shutko, Robin Socha,
+Richard Stanton, Allan Strand, Jan Vroonhof, Christoph Wedler, Alan
+Williams, Roland Winkler, Hans-Christoph Wirth, Eli Zaretskii}.
The @code{view-crossref} feature was inspired by @i{Peter Galbraith's}
and offers the matching entries for selection. The selected entry is
formatted according to @code{reftex-cite-format} and inserted into the
buffer. @*
-When called with a @kbd{C-u} prefixe, prompt for optional arguments in
+When called with a @kbd{C-u} prefix, prompt for optional arguments in
cite macros. 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
@code{cdr} is a number indicating its level. A negative level means the
same as the positive value, but the section will never get a number.
The @code{cdr} may also be a function which then has to return the
-level. This list is also used for promotion and demption of sectioning
+level. This list is also used for promotion and demotion of sectioning
commands. If you are using a document class which has several sets of
sectioning commands, promotion only works correctly if this list is
sorted first by set, then within each set by level. The promotion
If @var{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
+the section heading. The conversion of the context to a valid label is
governed by the specifications given in
@code{reftex-derive-label-parameters}. If @var{derive} is @code{nil},
the default label will consist of the prefix and a unique number, like
@end deffn
@deffn Hook reftex-string-to-label-function
-Function to turn an arbitrary string into a legal label.
+Function to turn an arbitrary string into a valid label.
@b{Ref@TeX{}}'s default function uses the variable
@code{reftex-derive-label-parameters}.
@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. The intended application is to convert ISO or
-Mule characters into something legal in labels. The default function
+Mule characters into something valid in labels. The default function
@code{reftex-latin1-to-ascii} removes the accents from Latin-1
characters. X-Symbol (>=2.6) sets this variable to the much more
general @code{x-symbol-translate-to-ascii}.
Number of words to use.
@item @var{maxchar}
Maximum number of characters in a label string.
-@item @var{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 @var{invalid}
+@code{nil}: Throw away any words containing characters invalid in labels.@*
+@code{t}: Throw away only the invalid characters, not the whole word.
@item @var{abbrev}
@code{nil}: Never abbreviate words.@*
@code{t}: Always abbreviate words (see @code{reftex-abbrev-parameters}).@*
@end defopt
@defopt reftex-label-illegal-re
-Regexp matching characters not legal in labels.
+Regexp matching characters not valid in labels.
@end defopt
@defopt reftex-abbrev-parameters
The final entry may also be a symbol. It must have an association in
the variable @code{reftex-index-macros-builtin} to specify the main
-indexing package you are using. Legal values are currently
+indexing package you are using. Valid values are currently
@example
default @r{The LaTeX default - unnecessary to specify this one}
multind @r{The multind.sty package}
for an index tag when creating index entries or displaying a specific
index. This variable controls the default offered for these queries.
The default can be selected with @key{RET} during selection or
-completion. Legal values of this variable are:
+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"}
@example
@var{type}: @r{File type like @code{"bib"} or @code{"tex"}.}
@var{def-ext}: @r{The default extension for that file type, like @code{".tex"} or @code{".bib"}.}
-@var{other-ext}: @r{Any number of other legal extensions for this file type.}
+@var{other-ext}: @r{Any number of other valid extensions for this file type.}
@end example
-When a files is searched and it does not have any of the legal extensions,
+When a files is searched and it does not have any of the valid extensions,
we try the default extension first, and then the naked file name.
@end defopt
are many more hooks which are described in the relevant sections about
options for a specific part of @b{Ref@TeX{}}.
-@node Changes, , Keymaps and Hooks, Top
+@node Changes, GNU Free Documentation License, Keymaps and Hooks, Top
@chapter Changes
@cindex Changes
Here is a list of recent changes to @b{Ref@TeX{}}.
+@noindent @b{Version 4.28}
+@itemize @bullet
+@item Support for the Jurabib package.
+@item Improvements when selecting several items in a selection buffer.
+@end itemize
+
@noindent @b{Version 4.26}
@itemize @bullet
@item
-Bug fixes only.
+Support for global incremental search.
+@item
+Some improvements for XEmacs compatibility.
@end itemize
@noindent @b{Version 4.25}
is non-nil.
@item
Fixed bugs in indexing: Case-sensitive search, quotes before and/or
-after words. Disabbled indexing in comment lines.
+after words. Disabled indexing in comment lines.
@end itemize
@noindent @b{Version 4.22}
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.
+are now valid in labels.
@end itemize
@noindent @b{Version 3.33}
released on 7 Jan 1997.
@end itemize
+@node GNU Free Documentation License, Index, Changes, Top
+@appendix GNU Free Documentation License
+@include doclicense.texi
-
-
-
-@node Index, , , Top
+@node Index, , GNU Free Documentation License, Top
@unnumbered Index
@printindex cp