@syncodeindex fn cp
@c Version and Contact Info
-@set VERSION 4.28
-@set EDITION 4.28
-@set DATE May 2005
-@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, 2004, 2005 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
* Citation Info:: View the corresponding database entry.
* Chapterbib and Bibunits:: Multiple bibliographies in a Document.
* Citations Outside LaTeX:: How to make citations in Emails etc.
-* BibTeX Database Subsets:: Extract parts of a big database.
+* BibTeX Database Subsets:: Extract parts of a big database.
Index Support
* Citation Info:: View the corresponding database entry.
* Chapterbib and Bibunits:: Multiple bibliographies in a Document.
* Citations Outside LaTeX:: How to make citations in Emails etc.
-* BibTeX Database Subsets:: Extract parts of a big database.
+* BibTeX Database Subsets:: Extract parts of a big database.
@end menu
@node Creating Citations, Citation Styles, , Citations
@item e
Create a new BibTeX database file which contains all @i{marked} entries
in the selection buffer. If no entries are marked, all entries are
-selected.
+selected.
@item E
Create a new BibTeX database file which contains all @i{unmarked}
entries in the selection buffer. If no entries are marked, all entries
-are selected.
+are selected.
@item @key{TAB}
Enter a citation key with completion. This may also be a key which does
@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
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{}}.
+also work for people who do not use @b{Ref@TeX{}}.
Additions made with style files in the way described below remain local
to the current document. For example, if one package uses AMSTeX, the
@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
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
Create a new BibTeX database file with all entries referenced in document.
The command prompts for a filename and writes the collected entries to
that file. Only entries referenced in the current document with
-any @code{\cite}-like macros are used.
+any @code{\cite}-like macros are used.
The sequence in the new file is the same as it was in the old database.
@end deffn
@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
ordinary TOC window), the automatic recentering is turned on. When the
frame gets destroyed, automatic recentering is turned off again.
-This feature can be turned on and off from the menu
+This feature can be turned on and off from the menu
(Ref->Options).
@end defopt
This may also be a function to do local parsing and identify point to be
in a non-standard label environment. The function must take an
argument @var{bound} and limit backward searches to this value. It
-should return either @code{nil} or a cons cell @code{(@var{function}
+should return either nil or a cons cell @code{(@var{function}
. @var{position})} with the function symbol and the position where the
special environment starts. See the Info documentation for an
example.
default does parse around each label to detect the correct label type,
but this process can be slow when a document contains thousands of
labels. If you use label prefixes consistently, you may speed up
-document parsing by setting this variable to a non-@code{nil} value. RefTeX
+document parsing by setting this variable to a non-nil value. RefTeX
will then compare the label prefix with the prefixes found in
`reftex-label-alist' and derive the correct label type in this way.
Possible values for this option are:
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
@defopt reftex-index-verify-function
A function which is called at each match during global indexing.
-If the function returns @code{nil}, the current match is skipped.
+If the function returns nil, the current match is skipped.
@end defopt
@defopt reftex-index-phrases-skip-indexed-matches
@defopt reftex-revisit-to-echo
Non-@code{nil} means, automatic citation display will revisit files if
-necessary. When @code{nil}, citation display in echo area will only
-be active for cached echo strings (see @code{reftex-cache-cite-echo}),
-or for BibTeX database files which are already visited by a live
-associated buffers.
+necessary. When nil, citation display in echo area will only be active
+for cached echo strings (see @code{reftex-cache-cite-echo}), or for
+BibTeX database files which are already visited by a live associated
+buffers.
@end defopt
@defopt reftex-cache-cite-echo
@defopt reftex-revisit-to-follow
Non-@code{nil} means, follow-mode will revisit files if necessary.
-When @code{nil}, follow-mode will be suspended for stuff in unvisited files.
+When nil, follow-mode will be suspended for stuff in unvisited files.
@end defopt
@defopt reftex-allow-detached-macro-args
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
@noindent @b{Version 4.24}
@itemize @bullet
-@item
+@item
Inserting citation commands now prompts for optional arguments
when called with a prefix argument. Related new options are
@code{reftex-cite-prompt-optional-args} and
-@code{reftex-cite-cleanup-optional-args}.
+@code{reftex-cite-cleanup-optional-args}.
@item
New option @code{reftex-trust-label-prefix}. Configure this variable
if you'd like RefTeX to base its classification of labels on prefixes.
quality of the context used by RefTeX to describe a label.
@item
Fixed bug in @code{reftex-create-bibtex-file} when @code{reftex-comment-citations}
-is non-@code{nil}.
+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}
@itemize @bullet
-@item
+@item
New command @code{reftex-create-bibtex-file} to create a new database
with all entries referenced in the current document.
@item
@noindent @b{Version 4.21}
@itemize @bullet
-@item
+@item
Renaming labels from the toc buffer with key @kbd{M-%}.
@end itemize
document, all labels and associated context. New keys @kbd{i}, @kbd{l},
and @kbd{c}. New options @code{reftex-toc-include-labels},
@code{reftex-toc-include-context},
-@code{reftex-toc-include-file-boundaries}.
+@code{reftex-toc-include-file-boundaries}.
@end itemize
@noindent @b{Version 3.41}
@kbd{M-x reftex-reset-mode} now also removes the file with parsing
info.
@item
-Default of @code{reftex-revisit-to-follow} changed to @code{nil}.
+Default of @code{reftex-revisit-to-follow} changed to nil.
@end itemize
@noindent @b{Version 3.24}
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