X-Git-Url: http://git.hcoop.net/bpt/emacs.git/blobdiff_plain/6aa73dc4fe035103a48d7763b0a1c5f404b88884..18f952d5da07c039fb3a9489a878f462ebfc59e7:/man/reftex.texi diff --git a/man/reftex.texi b/man/reftex.texi index c00c56e10d..9d388d66b6 100644 --- a/man/reftex.texi +++ b/man/reftex.texi @@ -2,21 +2,48 @@ @c %**start of header @setfilename ../info/reftex @settitle RefTeX User Manual -@dircategory Emacs -@direntry -* RefTeX: (reftex). Emacs support for LaTeX cross-references and citations. -@end direntry @synindex ky cp @syncodeindex vr cp @syncodeindex fn cp -@set VERSION 4.15 -@set EDITION 4.15 -@set DATE November 2000 -@set AUTHOR Carsten Dominik -@set AUTHOR-EMAIL dominik@@astro.uva.nl -@set MAINTAINER Carsten Dominik -@set MAINTAINER-EMAIL dominik@@astro.uva.nl +@set VERSION 4.19 +@set EDITION 4.19 +@set DATE August 2002 @c %**end of header + +@copying +This file documents @b{Ref@TeX{}}, a package to do labels, references, +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}. + +Copyright (c) 1997, 1998, 1999, 2000, 2001, 2002 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 +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 +license is included in the section entitled ``GNU Free Documentation +License'' in the Emacs manual. + +(a) The FSF's Back-Cover Text is: ``You have freedom to copy and modify +this GNU Manual, like GNU software. Copies published by the Free +Software Foundation raise funds for GNU development.'' + +This document is part of a collection distributed under the GNU Free +Documentation License. If you want to distribute this document +separately from the collection, you can do so by adding a copy of the +license to the document, as described in section 6 of the license. +@end quotation +@end copying + +@dircategory Emacs +@direntry +* RefTeX: (reftex). Emacs support for LaTeX cross-references and citations. +@end direntry + @finalout @c Macro definitions @@ -31,40 +58,6 @@ @end ifnotinfo @end macro -@ifinfo -This file documents @b{Ref@TeX{}}, a package to do labels, references, -citations and indices for LaTeX documents with Emacs.@refill - -This is edition @value{EDITION} of the @b{Ref@TeX{}} User Manual for -@b{Ref@TeX{}} @value{VERSION}@refill - -Copyright (c) 1997, 1998, 1999, 2000 Free Software Foundation, Inc. - -Permission is granted to make and distribute verbatim -copies of this manual provided the copyright notice and -this permission notice are preserved on all copies. - -@ignore -Permission is granted to process this file through TeX -and print the results, provided the printed document -carries a copying permission notice identical to this -one except for the removal of this paragraph (this -paragraph not being relevant to the printed manual). - -@end ignore -Permission is granted to copy and distribute modified -versions of this manual under the conditions for -verbatim copying, provided that the entire resulting -derive work is distributed under the terms of a permission -notice identical to this one. - -Permission is granted to copy and distribute -translations of this manual into another language, -under the above conditions for modified versions, -except that this permission notice may be stated in a -translation approved by the Free Software Foundation. -@end ifinfo - @titlepage @title Ref@TeX{} User Manual @subtitle Support for LaTeX labels, references, citations and index entries with GNU Emacs @@ -72,32 +65,9 @@ translation approved by the Free Software Foundation. @author by Carsten Dominik @page -Copyright @copyright{} 1997, 1998, 1999, 2000 Free Software Foundation, Inc. - -@sp 2 -This is edition @value{EDITION} of the @cite{Ref@TeX{} User Manual} for -@b{Ref@TeX{}} version @value{VERSION}, @value{DATE}.@refill - -@sp 2 - -Permission is granted to make and distribute verbatim -copies of this manual provided the copyright notice and -this permission notice are preserved on all copies. - -Permission is granted to copy and distribute modified -versions of this manual under the conditions for -verbatim copying, provided that the entire resulting -derive work is distributed under the terms of a permission -notice identical to this one. - -Permission is granted to copy and distribute -translations of this manual into another language, -under the above conditions for modified versions, -except that this permission notice may be stated in a -translation approved by the Free Software Foundation. - +@vskip 0pt plus 1filll +@insertcopying @end titlepage -@page @ifnottex @node Top,,,(dir) @@ -121,7 +91,7 @@ needed.@refill * Viewing Cross-References:: Who references or cites what? * RefTeXs Menu:: The Ref menu in the menubar. -* Keybindings:: The default keybindings. +* Key Bindings:: The default key bindings. * Faces:: Fontification of RefTeX's buffers. * Multifile Documents:: Document spread over many files. * Language Support:: How to support other languages. @@ -420,15 +390,8 @@ contains style files which trigger appropriate settings in additional customizations will be necessary.@refill @item -@b{Useful Settings}@* To make @b{Ref@TeX{}} faster for large documents, -try these:@refill -@lisp -(setq reftex-enable-partial-scans t) -(setq reftex-save-parse-info t) -(setq reftex-use-multiple-selection-buffers t) -@end lisp - -To integrate with AUCTeX, use +@b{Useful Settings}@* +To integrate RefTeX with AUCTeX, use @lisp (setq reftex-plug-into-AUCTeX t) @end lisp @@ -500,6 +463,10 @@ separate section headings.@refill @item C-c C-p Goto previous section heading. +@item N z +Jump to section N, using the prefix arg. For example, @kbd{3 z} jumps +to section 3.@refill + @tablesubheading{Access to document locations} @item @key{SPC} Show the corresponding location in another window. This command does @@ -513,7 +480,7 @@ Go to the location and hide the @file{*toc*} buffer. This will restore the window configuration before @code{reftex-toc} (@kbd{C-c =}) was called.@refill -@item Mouse-2 +@item mouse-2 @vindex reftex-highlight-selection Clicking with mouse button 2 on a line has the same effect as @key{RET}. See also variable @code{reftex-highlight-selection}, @ref{Options @@ -535,6 +502,7 @@ mode. See, however, the variable Show calling point in another window. This is the point from where @code{reftex-toc} was last called. +@page @tablesubheading{Exiting} @item q Hide the @file{*toc*} buffer, return to the position where @@ -613,12 +581,39 @@ current document is using the @code{xr} package (@pxref{xr (LaTeX package)}), @b{Ref@TeX{}} will switch to one of the external documents.@refill +@item a +Toggle the automatic recentering of the @file{*toc*} buffer. When this +option is on, moving around in the document will cause the @file{*toc*} +to always highlight the current section. This can be enabled by default +with the variable @code{reftex-auto-recenter-toc}. + @end table @vindex reftex-toc-map In order to define additional commands for the @file{*toc*} buffer, the keymap @code{reftex-toc-map} may be used.@refill +@findex reftex-toc-recenter +@vindex reftex-auto-recenter-toc +@vindex reftex-idle-time +@cindex @file{*toc*} buffer, recentering +@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 +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. If you want the TOC buffer +to show the current section automatically whenever you stop typing, try +@lisp +(setq reftex-auto-recenter-toc t) +@end lisp +When this is turned on, the toc buffer will be recentered whenever Emacs +is idle for more than @code{reftex-idle-time} seconds. + + @cindex Sectioning commands @cindex KOMA-Script, LaTeX classes @cindex LaTeX classes, KOMA-Script @@ -803,6 +798,10 @@ Goto next section heading. @item C-c C-p Goto previous section heading. +@item N z +Jump to section N, using the prefix arg. For example @kbd{3 z} jumps to +section 3.@refill + @tablesubheading{Displaying Context} @item @key{SPC} Show the surroundings of the definition of the current label in another @@ -827,7 +826,7 @@ Insert a reference to the label at point into the buffer from which the selection process was started. When entries have been marked, @key{RET} references all marked labels.@refill -@item Mouse-2 +@item mouse-2 @vindex reftex-highlight-selection Clicking with mouse button 2 on a label will accept it like @key{RET} would. See also variable @code{reftex-highlight-selection}, @ref{Options @@ -1134,8 +1133,19 @@ was chosen for @code{theorem} since @code{?t} is already taken by @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 @b{Ref@TeX{}} to automatically create labels when a new -environment is inserted into a buffer.@refill +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 @samp{~\ref@{%s@}} is a format string indicating how to insert @@ -1398,7 +1408,7 @@ to search backward for these macros. When the first match is @code{\ee}, point is not in this environment. When the first match is @code{\be}, point is in this environment and the function must return the beginning of the match. To avoid scanning too far, we can also look -for empty lines which cannot occure inside an equation environment. +for empty lines which cannot occur inside an equation environment. Here is the setup:@refill @lisp @@ -1498,12 +1508,13 @@ the entries described above: @cindex Displaying cross-references @cindex Viewing cross-references @kindex C-c & -@kindex S-Mouse-2 +@kindex S-mouse-2 -When point is idle on the argument of a @code{\ref} macro, the echo area -will display some information about the label referenced there. Note -that the information is only displayed if the echo area is not occupied -by a different message. +When point is idle for more than @code{reftex-idle-time} seconds on the +argument of a @code{\ref} macro, the echo area will display some +information about the label referenced there. Note that the information +is only displayed if the echo area is not occupied by a different +message. @b{Ref@TeX{}} can also display the label definition corresponding to a @code{\ref} macro, or all reference locations corresponding to a @@ -1624,7 +1635,10 @@ logic @code{and} for regular expressions. For example @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.@refill +known citation keys. RefTeX also offers a default when prompting for a +regular expression. This default is the word before the cursor or the +word before the current @samp{\cite} command. Sometimes this may be a +good search key.@refill @cindex @code{\bibliography} @cindex @code{thebibliography}, LaTeX environment @@ -1677,7 +1691,7 @@ entries, follow mode can be rather slow.@refill Insert a citation referencing the article at point into the buffer from which the selection process was started.@refill -@item Mouse-2 +@item mouse-2 @vindex reftex-highlight-selection Clicking with mouse button 2 on a citation will accept it like @key{RET} would. See also variable @code{reftex-highlight-selection}, @ref{Options @@ -1793,14 +1807,14 @@ files correctly.@refill @cindex Citation info @cindex Viewing citations @kindex C-c & -@kindex S-Mouse-2 +@kindex S-mouse-2 @findex reftex-view-crossref @findex reftex-mouse-view-crossref -When point is idle on the argument of a @code{\cite} macro, the echo area -will display some information about the article cited there. Note -that the information is only displayed if the echo area is not occupied -by a different message. +When point is idle for more than @code{reftex-idle-time} seconds on the +argument of a @code{\cite} macro, the echo area will display some +information about the article cited there. Note that the information is +only displayed if the echo area is not occupied by a different message. @b{Ref@TeX{}} can also display the @code{\bibitem} or BibTeX database entry corresponding to a @code{\cite} macro, or all citation locations @@ -2131,7 +2145,7 @@ Select one of multiple index keys (those separated with @samp{||}). @item e Edit the replacement text. @item C-r -Recursive edit. Use @kbd{M-C-c} to return to the indexing process. +Recursive edit. Use @kbd{C-M-c} to return to the indexing process. @item s Save this buffer and ask again about the current match. @item S @@ -2474,7 +2488,7 @@ The index tag is "idx".@refill @findex reftex-view-crossref @findex reftex-mouse-view-crossref @kindex C-c & -@kindex S-Mouse-2 +@kindex S-mouse-2 @b{Ref@TeX{}} can display cross--referencing information. This means, if two document locations are linked, @b{Ref@TeX{}} can display the @@ -2486,7 +2500,7 @@ database entry.@refill The feature is invoked by pressing @kbd{C-c &} (@code{reftex-view-crossref}) while point is on the @var{key} argument of a macro involved in cross--referencing. You can also click with -@kbd{S-Mouse-2} on the macro argument. Here is what will happen for +@kbd{S-mouse-2} on the macro argument. Here is what will happen for individual classes of macros:@refill @table @asis @@ -2540,16 +2554,16 @@ and @code{\glossary} macros, all macros configured in @code{reftex-index-macros} will be recognized.@refill @end table -@vindex reftex-view-crossref-macros +@vindex reftex-view-crossref-extra While the display of cross referencing information for the above mentioned macros is hard--coded, you can configure additional relations -in the variable @code{reftex-view-crossref-macros}. +in the variable @code{reftex-view-crossref-extra}. @iftex @chapter All the Rest @end iftex -@node RefTeXs Menu, Keybindings, Viewing Cross-References, Top +@node RefTeXs Menu, Key Bindings, Viewing Cross-References, Top @section @b{Ref@TeX{}}'s Menu @cindex RefTeXs Menu @cindex Menu, in the menu bar @@ -2560,18 +2574,19 @@ which support this. From this menu you can access all of @code{Customize} submenu which can be used to access @b{Ref@TeX{}}'s entire set of options.@refill -@node Keybindings, Faces, RefTeXs Menu, Top -@section Default Keybindings -@cindex Keybindings, summary +@node Key Bindings, Faces, RefTeXs Menu, Top +@section Default Key Bindings +@cindex Key Bindings, summary -Here is a summary of the available keybindings. +Here is a summary of the available key bindings. @kindex C-c = +@kindex C-c - @kindex C-c ( @kindex C-c ) @kindex C-c [ @kindex C-c & -@kindex S-Mouse-2 +@kindex S-mouse-2 @kindex C-c / @kindex C-c \ @kindex C-c | @@ -2579,11 +2594,12 @@ Here is a summary of the available keybindings. @kindex C-c > @example @kbd{C-c =} @code{reftex-toc} +@kbd{C-c -} @code{reftex-toc-recenter} @kbd{C-c (} @code{reftex-label} @kbd{C-c )} @code{reftex-reference} @kbd{C-c [} @code{reftex-citation} @kbd{C-c &} @code{reftex-view-crossref} -@kbd{S-Mouse-2} @code{reftex-mouse-view-crossref} +@kbd{S-mouse-2} @code{reftex-mouse-view-crossref} @kbd{C-c /} @code{reftex-index-selection-or-word} @kbd{C-c \} @code{reftex-index-phrase-selection-or-word} @kbd{C-c |} @code{reftex-index-visit-phrases-buffer} @@ -2591,16 +2607,16 @@ Here is a summary of the available keybindings. @kbd{C-c >} @code{reftex-display-index} @end example -Note that the @kbd{S-Mouse-2} binding is only provided if this key is +Note that the @kbd{S-mouse-2} binding is only provided if this key is not already used by some other package. @b{Ref@TeX{}} will not override an -existing binding to @kbd{S-Mouse-2}.@refill +existing binding to @kbd{S-mouse-2}.@refill Personally, I also bind some functions in the users @kbd{C-c} map for easier access.@refill @c FIXME: Do we need bindings for the Index macros here as well? @c C-c i C-c I or so???? -@c How about keybindings for reftex-reset-mode and reftex-parse-document? +@c How about key bindings for reftex-reset-mode and reftex-parse-document? @kindex C-c t @kindex C-c l @kindex C-c r @@ -2619,7 +2635,7 @@ easier access.@refill @end example @noindent These keys are reserved for the user, so I cannot bind them by -default. If you want to have these keybindings available, set in your +default. If you want to have these key bindings available, set in your @file{.emacs} file: @vindex reftex-extra-bindings @@ -2628,11 +2644,11 @@ default. If you want to have these keybindings available, set in your @end lisp @vindex reftex-load-hook -Changing and adding to @b{Ref@TeX{}}'s keybindings is best done in the hook +Changing and adding to @b{Ref@TeX{}}'s key bindings is best done in the hook @code{reftex-load-hook}. For information on the keymaps which should be used to add keys, see @ref{Keymaps and Hooks}. -@node Faces, AUCTeX, Keybindings, Top +@node Faces, AUCTeX, Key Bindings, Top @section Faces @cindex Faces @@ -2803,15 +2819,37 @@ command depends upon the version of that program. @lisp (setq reftex-use-external-file-finders t) (setq reftex-external-file-finders - '(("tex" "kpsewhich -format=.tex %f") - ("bib" "kpsewhich -format=.bib %f"))) + '(("tex" . "kpsewhich -format=.tex %f") + ("bib" . "kpsewhich -format=.bib %f"))) @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 +@b{Note added 2002. Computers have gotten a lot faster, so most of the +optimizations discussed below will not be necessary on new machines. I +am leaving this stuff in the manual for people who want to write thick +books, where some of it still might be useful.} + Implementing the principle of least surprises, the default settings of @b{Ref@TeX{}} ensure a safe ride for beginners and casual users. However, when using @b{Ref@TeX{}} for a large project and/or on a small computer, @@ -2937,7 +2975,6 @@ with the @kbd{g} key. To get this behavior, use instead@refill @end group @end lisp -@page @node AUCTeX, Multifile Documents, Faces, Top @section @w{AUC @TeX{}} @cindex @code{AUCTeX}, Emacs package @@ -2945,7 +2982,7 @@ with the @kbd{g} key. To get this behavior, use instead@refill 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 +If AUCTeX is not part of your Emacs distribution, you can get it@footnote{XEmacs 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}. @@ -3168,7 +3205,7 @@ is a style file @file{foils.el} that will inform @b{Ref@TeX{}} about these: Once you have written a document with labels, references and citations, it can be nice to read it like a hypertext document. @b{Ref@TeX{}} has support for that: @code{reftex-view-crossref} (bound to @kbd{C-c -&}), @code{reftex-mouse-view-crossref} (bound to @kbd{S-Mouse-2}), and +&}), @code{reftex-mouse-view-crossref} (bound to @kbd{S-mouse-2}), and @code{reftex-search-document}. A somewhat fancier interface with mouse highlighting is provided (among other things) by Peter S. Galbraith's @file{bib-cite.el}. There is some overlap in the functionalities of @@ -3196,8 +3233,8 @@ make use of this feature, try@refill @item @b{LaTeX commands}@* @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).@refill +@code{\input}, @code{\include}, and @code{\section} (etc.) statements +have to be first on a line (except for white space).@refill @item @b{Commented regions}@* @@ -3312,7 +3349,7 @@ this bug gets fixed, a real idle timer can be requested with @item @b{Viper mode}@* @cindex Viper mode -@cindex Keybindings, problems with Viper mode +@cindex Key bindings, problems with Viper mode @findex viper-harness-minor-mode With @i{Viper} mode prior to Vipers version 3.01, you need to protect @b{Ref@TeX{}}'s keymaps with@refill @@ -3334,12 +3371,12 @@ With @i{Viper} mode prior to Vipers version 3.01, you need to protect @cindex @code{http}, @b{Ref@TeX{}} home page @cindex @code{ftp}, @b{Ref@TeX{}} site -@b{Ref@TeX{}} was written by @i{@value{AUTHOR}} -@email{@value{AUTHOR-EMAIL}}, with contributions by @i{Stephen +@b{Ref@TeX{}} was written by @i{@value{Carsten Dominik}} +@email{dominik@@science.uva.nl}, with contributions by @i{Stephen Eglen}. @b{Ref@TeX{}} is currently maintained by @refill @noindent -@value{MAINTAINER} @email{@value{MAINTAINER-EMAIL}} +@value{Carsten Dominik} @email{dominik@@science.uva.nl} If you have questions about @b{Ref@TeX{}}, there are several Usenet groups which have competent readers: @code{comp.emacs}, @@ -3348,7 +3385,7 @@ 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 -@uref{mailto:@value{MAINTAINER-EMAIL},contact the maintainer}. Remember +@uref{mailto:dominik@@science.uva.nl,contact the maintainer}. 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 @@ -3368,11 +3405,13 @@ features described in this manual.@refill 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, Soren Dayton, Stephen Eglen, Karl Eichwalder, -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 Williams}.@refill +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, Lute Kamstra, 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 Zaretskii}.@refill The @code{view-crossref} feature was inspired by @i{Peter Galbraith's} @file{bib-cite.el}.@refill @@ -3388,7 +3427,7 @@ MicroEmacs at the time).@refill Here is a summary of @b{Ref@TeX{}}'s commands which can be executed from LaTeX files. Command which are executed from the special buffers are not described here. All commands are available from the @code{Ref} -menu. For keybindings, @pxref{Keybindings}. +menu. See @xref{Key Bindings}. @deffn Command reftex-toc Show the table of contents for the current document. When called with @@ -3410,7 +3449,7 @@ Make a citation using BibTeX database files. After prompting for a regular expression, scans the buffers with BibTeX entries (taken from the @code{\bibliography} command or a @code{thebibliography} environment) and offers the matching entries for selection. The selected entry is -formated according to @code{reftex-cite-format} and inserted into the +formatted according to @code{reftex-cite-format} and inserted into the buffer.@refill @* When called with one or two @kbd{C-u} prefixes, first rescans the document. When called with a numeric prefix, make that many citations. @@ -3514,6 +3553,13 @@ document. With prefix arg, replace only word-delimited matches. No active TAGS table is required.@refill @end deffn +@deffn Command reftex-goto-label +Prompt for a label (with completion) and jump to the location of this +label. Optional prefix argument @var{other-window} goes to the label in +another window. +@end deffn + + @deffn Command reftex-change-label Query replace @var{from} with @var{to} in all @code{\label} and @code{\ref} commands. Works on the entire multifile document. No @@ -3582,6 +3628,26 @@ reftex-customize} will get you there.@refill @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 level.@refill +@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, @@ -3589,6 +3655,34 @@ chapters are level 1, sections level 2 etc. This variable can be changed from within the @file{*toc*} buffer with the @kbd{t} key.@refill @end defopt +@defopt reftex-part-resets-chapter +Non-@code{nil} means, @code{\part} is like any other sectioning command. +This means, part numbers will be included in the numbering of chapters, and +chapter counters will be reset for each part. +When @code{nil} (the default), parts are special, do not reset the +chapter counter and also do not show up in chapter numbers. +@end defopt + +@defopt reftex-auto-recenter-toc +Non-@code{nil} means, initially turn automatic recentering of toc on. +When active, the @file{*TOC*} buffer will always show the section you +are currently working in. Recentering happens whenever Emacs is idle +for more than `reftex-idle-time' seconds. +This feature can be turned on and off from the menu +(Ref->Options). +@end defopt + +@defopt reftex-toc-split-windows-horizontally +Non-@code{nil} 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 +non-@code{nil}. +@end defopt + @defopt reftex-toc-keep-other-windows Non-@code{nil} means, split the selected window to display the @file{*toc*} buffer. This helps to keep the window configuration, but @@ -3684,7 +3778,7 @@ Special names: @code{section} for section labels, @code{any} to define a group which contains all labels.@refill 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 +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 @@ -3816,20 +3910,6 @@ spliced into the list. However, builtin defaults should normally be set with the variable @code{reftex-default-label-alist-entries}.@refill @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 level.@refill -@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 @@ -4087,6 +4167,10 @@ The keymap which is active in the labels selection process @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 @code{\\bibliography@{..@}}. File names matched by any of these regexps @@ -4362,6 +4446,11 @@ Non-@code{nil} means, searching for index phrases will ignore case.@refill @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 Non-@code{nil} means, skip matches which appear to be indexed already. When doing global indexing from the phrases buffer, searches for some @@ -4457,17 +4546,18 @@ integer indicating which subgroup of the match should be highlighted. @defopt reftex-auto-view-crossref Non-@code{nil} means, initially turn automatic viewing of crossref info on. Automatic viewing of crossref info normally uses the echo area. -Whenever point is on the argument of a @code{\ref} or @code{\cite} -macro, and no other message is being displayed, the echo area will -display information about that cross reference. You can also set the -variable to the symbol @code{window}. In this case a small temporary -window is used for the display. This feature can be turned on and of -from the menu (Ref->Options).@refill +Whenever point is idle for more than @code{reftex-idle-time} seconds on +the argument of a @code{\ref} or @code{\cite} macro, and no other +message is being displayed, the echo area will display information about +that cross reference. You can also set the variable to the symbol +@code{window}. In this case a small temporary window is used for the +display. This feature can be turned on and off from the menu +(Ref->Options).@refill @end defopt @defopt reftex-idle-time -Time (secs) Emacs has to be idle before automatic crossref display is -done.@refill +Time (secs) Emacs has to be idle before automatic crossref display +or toc recentering is done.@refill @end defopt @defopt reftex-cite-view-format @@ -4795,7 +4885,7 @@ Face name for index entries. @defopt reftex-extra-bindings Non-@code{nil} means, make additional key bindings on startup. These extra bindings are located in the users @samp{C-c letter} -map. @xref{Keybindings}.@refill +map. @xref{Key Bindings}.@refill @end defopt @defopt reftex-plug-into-AUCTeX @@ -5123,7 +5213,7 @@ switch buffers at will, use the mouse etc.@refill @item New option @code{reftex-highlight-selection}. @item -@kbd{Mouse-2} can be used to select in selection and @file{*toc*} +@kbd{mouse-2} can be used to select in selection and @file{*toc*} buffers.@refill @item Fixed some problems regarding the interaction with VIPER mode. @@ -5152,7 +5242,7 @@ customization group @code{reftex-fontification-configurations}.@refill Fixed bug with empty context strings. @item @code{reftex-mouse-view-crossref} is now bound by default at -@kbd{S-Mouse-2}.@refill +@kbd{S-mouse-2}.@refill @end itemize @noindent @b{Version 3.23} @@ -5337,7 +5427,6 @@ Files in @code{reftex-default-bibliography} will be searched along @item Reading a parse file now checks consistency. @end itemize -@end ignore @noindent @b{Version 4.00} @itemize @bullet @item @@ -5390,10 +5479,10 @@ Multiple @code{thebibliography} environments recognized. @itemize @bullet @item New option @code{reftex-toc-max-level} to limit the depth of the toc. -New keybinding @kbd{t} in the @file{*toc*} buffer to change this +New key binding @kbd{t} in the @file{*toc*} buffer to change this setting.@refill @item -RefTeX maintaines an @file{Index Phrases} file in which phrases can be +RefTeX maintains an @file{Index Phrases} file in which phrases can be collected. When the document is ready, RefTeX can search all these phrases and assist indexing all matches.@refill @item @@ -5432,10 +5521,67 @@ Support for @file{bibentry} citation style. @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 +@end ignore +@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 @samp{@{\bibliography@{...@}@}} 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. +@item +Simplified several regular expressions for speed. +@item +Better support for chapterbib. +@end itemize +@noindent @b{Version 4.19} +@itemize @bullet +@item +New command `reftex-toc-recenter' (@kbd{C-c -}) which shows the current +section in the TOC buffer without selecting the TOC window. +@item +Recentering happens automatically in idle time when the option +@code{reftex-auto-recenter-toc} is turned on. +@item +Fixed several bugs related to automatic cursor positioning in the TOC +buffer. +@item +The highlight in the TOC buffer stays when the focus moves to a +different window. +@item +New command `reftex-goto-label'. +@item +Part numbers are no longer included in chapter numbers, and a new +part does not reset the chapter counter. See new option +@code{reftex-part-resets-chapter}. +@end itemize @node Index, , , Top @unnumbered Index