X-Git-Url: https://code.delx.au/gnu-emacs/blobdiff_plain/56f7c94ae595f158cfbcc492768fb90238a896ad..c897578d7d532c0d9fa5b5cc35e05fbd5dec4100:/man/reftex.texi diff --git a/man/reftex.texi b/man/reftex.texi index 946733de19..c6048f43b5 100644 --- a/man/reftex.texi +++ b/man/reftex.texi @@ -2,20 +2,20 @@ @c %**start of header @setfilename ../info/reftex @settitle RefTeX User Manual -@dircategory Editors +@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.11 -@set EDITION 4.11 -@set DATE February 2000 +@set VERSION 4.16 +@set EDITION 4.16 +@set DATE June 2001 @set AUTHOR Carsten Dominik -@set AUTHOR-EMAIL dominik@@strw.leidenuniv.nl +@set AUTHOR-EMAIL dominik@@astro.uva.nl @set MAINTAINER Carsten Dominik -@set MAINTAINER-EMAIL dominik@@strw.leidenuniv.nl +@set MAINTAINER-EMAIL dominik@@astro.uva.nl @c %**end of header @finalout @@ -38,31 +38,24 @@ 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. +Copyright (c) 1997, 1998, 1999, 2000 2001 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. +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 ifinfo @titlepage @@ -72,7 +65,7 @@ translation approved by the Free Software Foundation. @author by Carsten Dominik @page -Copyright @copyright{} 1997, 1998, 1999, 2000 Free Software Foundation, Inc. +Copyright @copyright{} 1997, 1998, 1999, 2000, 2001 Free Software Foundation, Inc. @sp 2 This is edition @value{EDITION} of the @cite{Ref@TeX{} User Manual} for @@ -80,26 +73,26 @@ This is edition @value{EDITION} of the @cite{Ref@TeX{} User Manual} for @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. - +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 titlepage @page -@ifinfo +@ifnottex @node Top,,,(dir) @b{Ref@TeX{}} is a package for managing Labels, References, @@ -121,7 +114,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. @@ -213,7 +206,7 @@ Options, Keymaps, Hooks @end detailmenu @end menu -@end ifinfo +@end ifnottex @node Introduction, Table of Contents, , Top @chapter Introduction @@ -500,6 +493,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 @@ -803,6 +800,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 @@ -2131,7 +2132,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 @@ -2540,16 +2541,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,11 +2561,11 @@ 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 ( @@ -2600,7 +2601,7 @@ 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 +2620,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 +2629,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 @@ -2663,11 +2664,31 @@ document.@refill @item @vindex tex-main-file @vindex TeX-master -All files belonging to a multifile document should have a File Variable -(@code{TeX-master} for AUCTeX or @code{tex-main-file} for the -standard Emacs LaTeX mode) set to the name of the master file. See the -documentation of your (La)TeX mode and @ref{File Variables,,,emacs, The -GNU Emacs Manual}.@refill +All files belonging to a multifile document should define a File +Variable (@code{TeX-master} for AUCTeX or @code{tex-main-file} for the +standard Emacs LaTeX mode) containing the name of the master file. For +example, to set the file variable @code{TeX-master}, include something +like the following at the end of each TeX file:@refill + +@example +%%% Local Variables: *** +%%% mode:latex *** +%%% TeX-master: "thesis.tex" *** +%%% End: *** +@end example + +AUCTeX with the setting + +@lisp +(setq-default TeX-master nil) +@end lisp + +will actually ask you for each new file about the master file and insert +this comment automatically. For more details see the documentation of +the AUCTeX (@pxref{Multifile,,,auctex, The AUC TeX User Manual}), the +documentation about the Emacs (La)TeX mode (@pxref{TeX Print,,,emacs, +The GNU Emacs Manual}) and the Emacs documentation on File Variables +(@pxref{File Variables,,,emacs, The GNU Emacs Manual}).@refill @item The context of a label definition must be found in the same file as the @@ -2783,8 +2804,8 @@ 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 @@ -2924,9 +2945,10 @@ with the @kbd{g} key. To get this behavior, use instead@refill @cindex Emacs packages, @code{AUCTeX} AUCTeX is without doubt the best major mode for editing TeX and LaTeX -files with Emacs. If AUCTeX is not part of you Emacs distribution, you -can get it@footnote{XEmacs 21.x users may -want to install the corresponding XEmacs package.} by ftp from the +files with Emacs (@pxref{Top,AUCTeX,,auctex, The AUCTeX User Manual}). +If AUCTeX is not part of you 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}. @menu @@ -3025,11 +3047,12 @@ Labels}).@refill @findex TeX-add-style-hook, @r{AUCTeX} Style files are Emacs Lisp files which are evaluated by AUCTeX in association with the @code{\documentclass} and @code{\usepackage} -commands of a document. Support for @b{Ref@TeX{}} in such a style file -is useful when the LaTeX style defines macros or environments connected -with labels, citations, or the index. Many style files -(e.g. @file{amsmath.el} or @file{natbib.el}) distributed with AUCTeX -already support @b{Ref@TeX{}} in this way.@refill +commands of a document (@pxref{Style Files,,,auctex}). Support for +@b{Ref@TeX{}} in such a style file is useful when the LaTeX style +defines macros or environments connected with labels, citations, or the +index. Many style files (e.g. @file{amsmath.el} or @file{natbib.el}) +distributed with AUCTeX already support @b{Ref@TeX{}} in this +way.@refill 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 @@ -3290,7 +3313,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 @@ -3347,10 +3370,10 @@ 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 +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 Williams}.@refill The @code{view-crossref} feature was inspired by @i{Peter Galbraith's} @file{bib-cite.el}.@refill @@ -3366,7 +3389,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 @@ -4773,7 +4796,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 @@ -5368,7 +5391,7 @@ 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 @@ -5402,12 +5425,23 @@ New options @code{reftex-parse-file-extension} and @item Fixed bug which would parse @samp{\Section} just like @samp{\section}. @end itemize +@noindent @b{Version 4.12} +@itemize @bullet +@item +Support for @file{bibentry} citation style. +@end itemize +@noindent @b{Version 4.15} +@itemize @bullet +@item +Small bug fixes. +@item +Improved interaction with Emacs LaTeX mode. +@end itemize @node Index, , , Top @unnumbered Index @printindex cp -@setchapternewpage odd @summarycontents @contents @bye