[Emacs-diffs] Changes to emacs/man/reftex.texi

[Carsten Dominik]

Index: emacs/man/reftex.texi
diff -c emacs/man/reftex.texi:1.18 emacs/man/reftex.texi:1.19
*** emacs/man/reftex.texi:1.18  Tue Jul  9 05:57:34 2002
--- emacs/man/reftex.texi       Thu Jul 25 03:09:00 2002
***************
*** 9,21 ****
  @synindex ky cp
  @syncodeindex vr cp
  @syncodeindex fn cp
! @set VERSION 4.16
! @set EDITION 4.16
! @set DATE June 2001
! @set AUTHOR Carsten Dominik
! @set AUTHOR-EMAIL dominik@@astro.uva.nl
! @set MAINTAINER Carsten Dominik
! @set MAINTAINER-EMAIL dominik@@astro.uva.nl
  @c %**end of header
  @finalout
  
--- 9,17 ----
  @synindex ky cp
  @syncodeindex vr cp
  @syncodeindex fn cp
! @set VERSION 4.18
! @set EDITION 4.18
! @set DATE July 2002
  @c %**end of header
  @finalout
  
***************
*** 38,44 ****
  This is edition @value{EDITION} of the @address@hidden User Manual for
  @address@hidden @address@hidden
  
! Copyright (c) 1997, 1998, 1999, 2000 2001 Free Software Foundation, Inc.
  
  Permission is granted to copy, distribute and/or modify this document
  under the terms of the GNU Free Documentation License, Version 1.1 or
--- 34,40 ----
  This is edition @value{EDITION} of the @address@hidden User Manual for
  @address@hidden @address@hidden
  
! Copyright (c) 1997, 1998, 1999, 2000, 2001, 2002 Free Software Foundation, 
Inc.
  
  Permission is granted to copy, distribute and/or modify this document
  under the terms of the GNU Free Documentation License, Version 1.1 or
***************
*** 65,71 ****
  
  @author by Carsten Dominik
  @page
! Copyright @copyright{} 1997, 1998, 1999, 2000, 2001 Free Software Foundation, 
Inc.
  
  @sp 2
  This is edition @value{EDITION} of the @address@hidden User Manual} for
--- 61,67 ----
  
  @author by Carsten Dominik
  @page
! Copyright @copyright{} 1997, 1998, 1999, 2000, 2001, 2002 Free Software 
Foundation, Inc.
  
  @sp 2
  This is edition @value{EDITION} of the @address@hidden User Manual} for
***************
*** 1135,1142 ****
  @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 @address@hidden to automatically create labels when a new
! environment is inserted into a address@hidden
  
  @noindent
  The @address@hidden@}} is a format string indicating how to insert
--- 1131,1149 ----
  @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 RefTeX to automatically create labels when a new environment
! is inserted into a buffer.  Additionally, the following needs to be
! added to one's .emacs file before AUCTeX will automatically create
! labels for the new environments.
! 
! @lisp
! (add-hook 'LaTeX-mode-hook
!    (lambda ()
!      (LaTeX-add-environments
!        '("axiom" LaTeX-env-label)
!        '("theorem" LaTeX-env-label))))
! @end lisp
! 
  
  @noindent
  The @address@hidden@}} is a format string indicating how to insert
***************
*** 1625,1631 ****
  @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 address@hidden
  
  @cindex @code{\bibliography}
  @cindex @code{thebibliography}, LaTeX environment
--- 1632,1641 ----
  @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.  RefTeX also offeres a default when prompting for a
! regular expression.  This default is the word before the cursor or the
! word before the current @samp{\cite} comand.  Sometimes this may be a
! good search address@hidden
  
  @cindex @code{\bibliography}
  @cindex @code{thebibliography}, LaTeX environment
***************
*** 2809,2814 ****
--- 2819,2841 ----
  @end lisp
  @end itemize
  
+ @cindex Noweb files
+ @vindex reftex-file-extensions
+ @vindex TeX-file-extensions
+ Some people like to use RefTeX with noweb files, which usually have the
+ extension @file{.nw}.  In order to deal with such files, the new
+ extension must be added to the list of valid extensions in the variable
+ @code{reftex-file-extensions}.  When working with AUCTeX as major mode,
+ the new extension must also be known to AUCTeX via the variable
+ @code{TeX-file-extension}.  For example:
+ 
+ @lisp
+ (setq reftex-file-extensions 
+       '(("nw" "tex" ".tex" ".ltx") ("bib" ".bib")))
+ (setq TeX-file-extensions 
+       '( "nw" "tex" "sty" "cls" "ltx" "texi" "texinfo"))
+ @end lisp
+ 
  @node Optimizations, Problems and Work-Arounds, Finding Files, Top
  @section Optimizations
  @cindex Optimizations
***************
*** 2938,2944 ****
  @end group
  @end lisp
  
- @page
  @node AUCTeX, Multifile Documents, Faces, Top
  @section @w{AUC @TeX{}}
  @cindex @code{AUCTeX}, Emacs package
--- 2965,2970 ----
***************
*** 2946,2952 ****
  
  AUCTeX is without doubt the best major mode for editing TeX and LaTeX
  files with Emacs (@pxref{Top,AUCTeX,,auctex, The AUCTeX User Manual}).
! If AUCTeX is not part of you Emacs distribution, you can get
  address@hidden 21.x users may want to install the corresponding
  XEmacs package.} by ftp from the
  @uref{http://www.sunsite.auc.dk/auctex/,AUCTeX distribution site}.
--- 2972,2978 ----
  
  AUCTeX is without doubt the best major mode for editing TeX and LaTeX
  files with Emacs (@pxref{Top,AUCTeX,,auctex, The AUCTeX User Manual}).
! If AUCTeX is not part of your Emacs distribution, you can get
  address@hidden 21.x users may want to install the corresponding
  XEmacs package.} by ftp from the
  @uref{http://www.sunsite.auc.dk/auctex/,AUCTeX distribution site}.
***************
*** 3197,3204 ****
  @item
  @b{LaTeX address@hidden
  @cindex LaTeX commands, not found
! @code{\input}, @code{\include}, @code{\bibliography} and @code{\section}
! (etc.) statements have to be first on a line (except for white 
space)address@hidden
  
  @item
  @b{Commented address@hidden
--- 3223,3230 ----
  @item
  @b{LaTeX address@hidden
  @cindex LaTeX commands, not found
! @code{\input}, @code{\include}, and @code{\section} (etc.) statements
! have to be first on a line (except for white space)address@hidden
  
  @item
  @b{Commented address@hidden
***************
*** 3335,3346 ****
  @cindex @code{http}, @address@hidden home page
  @cindex @code{ftp}, @address@hidden site
  
! @address@hidden was written by @address@hidden
! @address@hidden, with contributions by @i{Stephen
  Eglen}.  @address@hidden is currently maintained by @refill
  
  @noindent
! @value{MAINTAINER} @address@hidden
  
  If you have questions about @address@hidden, there are several Usenet
  groups which have competent readers: @code{comp.emacs},
--- 3361,3372 ----
  @cindex @code{http}, @address@hidden home page
  @cindex @code{ftp}, @address@hidden site
  
! @address@hidden was written by @address@hidden Dominik}}
! @email{dominik@@science.uva.nl}, with contributions by @i{Stephen
  Eglen}.  @address@hidden is currently maintained by @refill
  
  @noindent
! @value{Carsten Dominik} @email{dominik@@science.uva.nl}
  
  If you have questions about @address@hidden, there are several Usenet
  groups which have competent readers: @code{comp.emacs},
***************
*** 3349,3355 ****
  
  If you find a bug in @address@hidden or its documentation, or if you want
  to contribute code or ideas, please
! @uref{mailto:@value{MAINTAINER-EMAIL},contact the maintainer}.  Remember
  to provide all necessary information such as version numbers of Emacs
  and @address@hidden, and the relevant part of your configuration in
  @file{.emacs}.  When reporting a bug which throws an exception, please
--- 3375,3381 ----
  
  If you find a bug in @address@hidden or its documentation, or if you want
  to contribute code or ideas, please
! @uref{mailto:dominik@@science.uva.nl,contact the maintainer}.  Remember
  to provide all necessary information such as version numbers of Emacs
  and @address@hidden, and the relevant part of your configuration in
  @file{.emacs}.  When reporting a bug which throws an exception, please
***************
*** 3369,3379 ****
  
  Thanks to the people on the Net who have used @address@hidden and helped
  developing it with their reports.  In particular thanks to @i{Fran
! Burstall, Alastair Burt, Soren Dayton, Stephen Eglen, Karl Eichwalder,
! Erik Frik, Peter Galbraith, Kai Grossjohann, Frank Harrell, Dieter
! Kraft, Adrian Lanz, Rory Molinari, Stefan Monnier, Laurent Mugnier,
! Sudeep Kumar Palat, Daniel Polani, Robin Socha, Richard Stanton, Allan
! Strand, Jan Vroonhof, Christoph Wedler, Alan address@hidden
  
  The @code{view-crossref} feature was inspired by @i{Peter Galbraith's}
  @address@hidden
--- 3395,3407 ----
  
  Thanks to the people on the Net who have used @address@hidden 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 Frik, Erik Frisk, Peter Galbraith, Kai Grossjohann,
! Frank Harrell, Stephan Heuel, Alan Ho, Dieter Kraft, Adrian Lanz, Rory
! Molinari, Stefan Monnier, Laurent Mugnier, Sudeep Kumar Palat, Daniel
! Polani, Alan Shutko, Robin Socha, Richard Stanton, Allan Strand, Jan
! Vroonhof, Christoph Wedler, Alan Williams, Roland Winkler, Eli
! address@hidden
  
  The @code{view-crossref} feature was inspired by @i{Peter Galbraith's}
  @address@hidden
***************
*** 3487,3493 ****
  View location in a LaTeX document which cites the BibTeX entry at point.
  Since BibTeX files can be used by many LaTeX documents, this function
  prompts upon first use for a buffer in @address@hidden mode.  To reset this
! link to a document, call the function with with a prefix arg.  Calling
  this function several times find successive citation locations.
  @end deffn
  
--- 3515,3521 ----
  View location in a LaTeX document which cites the BibTeX entry at point.
  Since BibTeX files can be used by many LaTeX documents, this function
  prompts upon first use for a buffer in @address@hidden mode.  To reset this
! link to a document, call the function with a prefix arg.  Calling
  this function several times find successive citation locations.
  @end deffn
  
***************
*** 3583,3588 ****
--- 3611,3636 ----
  @cindex Options, table of contents
  @cindex Table of contents, options
  
+ @defopt reftex-include-file-commands
+ List of LaTeX commands which input another file.
+ The file name is expected after the command, either in braces or separated
+ by whitespace.
+ @end defopt
+ 
+ @defopt reftex-max-section-depth
+ Maximum depth of section levels in document structure.
+ Standard LaTeX needs 7, default is 12.
+ @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.  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 address@hidden
+ @end defopt
+ 
  @defopt reftex-toc-max-level
  The maximum level of toc entries which will be included in the TOC.
  Section headings with a bigger level will be ignored.  In RefTeX,
***************
*** 3590,3595 ****
--- 3638,3654 ----
  changed from within the @file{*toc*} buffer with the @kbd{t} address@hidden
  @end defopt
  
+ @defopt reftex-toc-split-windows-horizontally
+ address@hidden means, create TOC window by splitting window
+ horizontally.  The default is to split vertically.
+ @end defopt
+ 
+ @defopt reftex-toc-split-windows-horizontally-fraction
+ Fraction of the horizontal width of the frame to be used for TOC window.
+ Only relevant when @code{reftex-toc-split-windows-horizontally} is
+ address@hidden
+ @end defopt
+ 
  @defopt reftex-toc-keep-other-windows
  address@hidden means, split the selected window to display the
  @file{*toc*} buffer.  This helps to keep the window configuration, but
***************
*** 3685,3691 ****
  group which contains all address@hidden
  
  This may also be a function to do local parsing and identify point to be
! in a a non-standard label environment.  The function must take an
  argument @var{bound} and limit backward searches to this value.  It
  should return either nil or a cons cell @code{(@var{function}
  . @var{position})} with the function symbol and the position where the
--- 3744,3750 ----
  group which contains all address@hidden
  
  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 nil or a cons cell @code{(@var{function}
  . @var{position})} with the function symbol and the position where the
***************
*** 3817,3836 ****
  with the variable @address@hidden
  @end defopt
  
- @defopt reftex-max-section-depth
- Maximum depth of section levels in document structure.
- Standard LaTeX needs 7, default is 12.
- @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.  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 address@hidden
- @end defopt
- 
  @defopt reftex-section-prefixes
  Prefixes for section labels.  When the label prefix given in an entry in
  @code{reftex-label-alist} contains @samp{%S}, this list is used to
--- 3876,3881 ----
***************
*** 4088,4093 ****
--- 4133,4142 ----
  @cindex Options, creating citations
  @cindex Creating citations, options
  
+ @defopt reftex-bibliography-commands
+ LaTeX commands which specify the BibTeX databases to use with the document.
+ @end defopt
+ 
  @defopt reftex-bibfile-ignore-regexps
  List of regular expressions to exclude files in
  @address@hidden@}}.  File names matched by any of these regexps
***************
*** 4363,4368 ****
--- 4412,4422 ----
  address@hidden
  @end defopt
  
+ @defopt reftex-index-verify-function
+ A function which is called at each match during global indexing.
+ If the function returns nil, the current match is skipped.
+ @end defopt
+ 
  @defopt reftex-index-phrases-skip-indexed-matches
  address@hidden means, skip matches which appear to be indexed already.
  When doing global indexing from the phrases buffer, searches for some
***************
*** 4451,4457 ****
  @end example
  @var{macro-re} is matched against the macro.  @var{search-re} is the
  regexp used to search for cross references.  @samp{%s} in this regexp is
! replaced with with the macro argument at point.  @var{highlight} is an
  integer indicating which subgroup of the match should be highlighted.
  @end defopt
  
--- 4505,4511 ----
  @end example
  @var{macro-re} is matched against the macro.  @var{search-re} is the
  regexp used to search for cross references.  @samp{%s} in this regexp is
! replaced with the macro argument at point.  @var{highlight} is an
  integer indicating which subgroup of the match should be highlighted.
  @end defopt
  
***************
*** 5433,5441 ****
--- 5487,5526 ----
  @noindent @b{Version 4.15}
  @itemize @bullet
  @item
+ Fixed bug with parsing of BibTeX files, when fields contain quotes or
+ unmatched parenthesis.
+ @item
  Small bug fixes.
  @item
  Improved interaction with Emacs LaTeX mode.
+ @end itemize
+ @noindent @b{Version 4.17}
+ @itemize @bullet
+ @item 
+ The toc window can be split off horizontally.  See new options
+ @code{reftex-toc-split-windows-horizontally},
+ @code{reftex-toc-split-windows-horizontally-fraction}.
+ @item
+ It is possible to specify a function which verifies an index match
+ during global indexing.  See new option @code{reftex-index-verify-function}.
+ @item
+ The macros which input a file in LaTeX (like \input, \include) can
+ be configured.  See new option @code{reftex-include-file-commands}.
+ @item
+ The macros which specify the bibliography file (like \bibliography) can
+ be configured.  See new option @code{reftex-bibliography-commands}.
+ @item
+ The regular expression used to search for the \bibliography macro has
+ been relaxed to allow for @address@hidden@address@hidden@}} needed by
+ chapterbib.
+ @item
+ Small bug fixes.
+ @end itemize
+ @noindent @b{Version 4.18}
+ @itemize @bullet
+ @item
+ @code{reftex-citation} uses the word before the cursor as a default
+ search string.
  @end itemize
  
  @node Index,  , , Top