*** empty log message ***

[gnu-emacs] / man / reftex.texi

diff --git a/man/reftex.texi b/man/reftex.texi
index 7de16dcb0e1ae46c6e22ab58801d5c5b455c2e63..b08b0d25d9f8a548e526866a016406ebaf6af871 100644 (file)
--- a/man/reftex.texi
+++ b/man/reftex.texi
@@ -7,9 +7,9 @@
 @syncodeindex fn cp
 
 @c Version and Contact Info
 @syncodeindex fn cp
 
 @c Version and Contact Info

-@set VERSION 4.24
-@set EDITION 4.24
-@set DATE August 2004
+@set VERSION 4.31
+@set EDITION 4.31
+@set DATE February 2006

 @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 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


@@ -25,11 +25,12 @@ citations and indices for LaTeX documents with Emacs.
 This is edition @value{EDITION} of the @b{Ref@TeX{}} User Manual for
 @b{Ref@TeX{}} @value{VERSION}
 
 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, 2004, 2005, 2006
+Free Software Foundation, Inc.

 
 @quotation
 Permission is granted to copy, distribute and/or modify this document
 
 @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
 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


@@ -734,9 +735,9 @@ indicating the type of the label and a unique mark.  @b{Ref@TeX{}} has
 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
 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
 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},
 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},


@@ -1816,22 +1817,25 @@ keymap @code{reftex-select-bib-map} may be used.
 @cindex Citation styles, @code{natbib}
 @cindex Citation styles, @code{harvard}
 @cindex Citation styles, @code{chicago}
 @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{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.
 
 @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
 
 @example
 SELECT A CITATION FORMAT


@@ -2832,7 +2836,7 @@ to be changed for other languages.  See the variables
 @vindex reftex-translate-to-ascii-function
 @vindex reftex-label-illegal-re
 Also, when a label is derived from context, @b{Ref@TeX{}} clears the
 @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
 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


@@ -3519,15 +3523,15 @@ the Emacs 19 version supports many but not all features described in
 this manual.
 
 Thanks to the people on the Net who have used @b{Ref@TeX{}} and helped
 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}
 
 
 The @code{view-crossref} feature was inspired by @i{Peter Galbraith's}


@@ -3568,7 +3572,7 @@ expression, scans the buffers with BibTeX entries (taken from the
 and offers the matching entries for selection.  The selected entry is
 formatted according to @code{reftex-cite-format} and inserted into the
 buffer. @*
 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
 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


@@ -3776,7 +3780,7 @@ Commands and levels used for defining sections in the document.  The
 @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
 @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
 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


@@ -4119,7 +4123,7 @@ Flags governing label insertion.  The value has the form
 
 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
 
 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
 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


@@ -4165,7 +4169,7 @@ buffer.
 @end deffn
 
 @deffn Hook reftex-string-to-label-function
 @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
 @b{Ref@TeX{}}'s default function uses the variable
 @code{reftex-derive-label-parameters}.
 @end deffn


@@ -4173,7 +4177,7 @@ Function to turn an arbitrary string into a legal label.
 @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
 @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}.
 @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}.


@@ -4187,9 +4191,9 @@ list of the following items:
 Number of words to use.
 @item @var{maxchar}
 Maximum number of characters in a label string.
 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}).@*
 @item @var{abbrev}
 @code{nil}: Never abbreviate words.@*
 @code{t}:   Always abbreviate words (see @code{reftex-abbrev-parameters}).@*


@@ -4204,7 +4208,7 @@ List of words which should not be part of labels.
 @end defopt
 
 @defopt reftex-label-illegal-re
 @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
 @end defopt
 
 @defopt reftex-abbrev-parameters


@@ -4557,7 +4561,7 @@ indexing from the phrase buffer.
 
 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
 
 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}
 @example
 default         @r{The LaTeX default - unnecessary to specify this one}
 multind         @r{The multind.sty package}


@@ -4589,7 +4593,7 @@ Default index tag.  When working with multiple indexes, RefTeX queries
 for an index tag when creating index entries or displaying a specific
 index.  This variable controls the default offered for these queries.
 The default can be selected with @key{RET} during selection or
 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
 nil        @r{Do not provide a default index}
 "tag"      @r{The default index tag given as a string, e.g. "idx"}


@@ -4829,9 +4833,9 @@ This is a list of items, each item is like:
 @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"}.}
 @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
 @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
 
 we try the default extension first, and then the naked file name.
 @end defopt
 


@@ -5151,10 +5155,18 @@ options for a specific part of @b{Ref@TeX{}}.
 
 Here is a list of recent changes to @b{Ref@TeX{}}.
 
 
 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
 @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}
 @end itemize
 
 @noindent @b{Version 4.25}


@@ -5181,7 +5193,7 @@ Fixed bug in @code{reftex-create-bibtex-file} when @code{reftex-comment-citation
 is non-nil.
 @item
 Fixed bugs in indexing: Case-sensitive search, quotes before and/or
 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}
 @end itemize
 
 @noindent @b{Version 4.22}


@@ -5456,7 +5468,7 @@ lowercase labels (default @code{t}).
 All @file{.rel} files have a final newline to avoid queries.
 @item
 Single byte representations of accented European letters (ISO-8859-1)
 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}
 @end itemize
 
 @noindent @b{Version 3.33}