/[emacs]/emacs/man/reftex.texi
ViewVC logotype

Diff of /emacs/man/reftex.texi

Parent Directory Parent Directory | Revision Log Revision Log | View Patch Patch

revision 1.20 by eggert, Fri Aug 16 06:29:40 2002 UTC revision 1.21 by cdominik, Tue Aug 27 09:58:05 2002 UTC
# Line 9  Line 9 
9  @synindex ky cp  @synindex ky cp
10  @syncodeindex vr cp  @syncodeindex vr cp
11  @syncodeindex fn cp  @syncodeindex fn cp
12  @set VERSION 4.18  @set VERSION 4.19
13  @set EDITION 4.18  @set EDITION 4.19
14  @set DATE July 2002  @set DATE August 2002
15  @c %**end of header  @c %**end of header
16  @finalout  @finalout
17    
# Line 409  contains style files which trigger appro Line 409  contains style files which trigger appro
409  additional customizations will be necessary.@refill  additional customizations will be necessary.@refill
410    
411  @item  @item
412  @b{Useful Settings}@* To make @b{Ref@TeX{}} faster for large documents,  @b{Useful Settings}@*
413  try these:@refill  To integrate RefTeX with AUCTeX, use
 @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  
414  @lisp  @lisp
415  (setq reftex-plug-into-AUCTeX t)  (setq reftex-plug-into-AUCTeX t)
416  @end lisp  @end lisp
# Line 528  mode.  See, however, the variable Line 521  mode.  See, however, the variable
521  Show calling point in another window.  This is the point from where  Show calling point in another window.  This is the point from where
522  @code{reftex-toc} was last called.  @code{reftex-toc} was last called.
523    
524    @page
525  @tablesubheading{Exiting}  @tablesubheading{Exiting}
526  @item q  @item q
527  Hide the @file{*toc*} buffer, return to the position where  Hide the @file{*toc*} buffer, return to the position where
# Line 606  current document is using the @code{xr} Line 600  current document is using the @code{xr}
600  package)}), @b{Ref@TeX{}} will switch to one of the external  package)}), @b{Ref@TeX{}} will switch to one of the external
601  documents.@refill  documents.@refill
602    
603    @item a
604    Toggle the automatic recentering of the @file{*toc*} buffer.  When this
605    option is on, moving around in the document will cause the @file{*toc*}
606    to always highlight the current section.  This can be enabled by default
607    with the variable @code{reftex-auto-recenter-toc}.
608    
609  @end table  @end table
610    
611  @vindex reftex-toc-map  @vindex reftex-toc-map
612  In order to define additional commands for the @file{*toc*} buffer, the  In order to define additional commands for the @file{*toc*} buffer, the
613  keymap @code{reftex-toc-map} may be used.@refill  keymap @code{reftex-toc-map} may be used.@refill
614    
615    @findex reftex-toc-recenter
616    @vindex reftex-auto-recenter-toc
617    @vindex reftex-idle-time
618    @cindex @file{*toc*} buffer, recentering
619    @cindex Table of contents buffer, recentering
620    @kindex C-c -
621    If you call @code{reftex-toc} while the @file{*toc*} buffer already
622    exists, the cursor will immediately jump to the right place, i.e. the
623    section from which @code{reftex-toc} was called will be highlighted.
624    The command @kbd{C-c -} (@code{reftex-toc-recenter}) will only redisplay
625    the @file{*toc*} buffer and highlight the correct line without actually
626    selecting the @file{*toc*} window.  This can be useful to quickly find
627    out where in the document you currently are.  If you want the TOC buffer
628    to show the current section automatically whenever you stop typing, try
629    @lisp
630    (setq reftex-auto-recenter-toc t)
631    @end lisp
632    When this is turned on, the toc buffer will be recentered whenever Emacs
633    is idle for more than @code{reftex-idle-time} seconds.
634    
635    
636  @cindex Sectioning commands  @cindex Sectioning commands
637  @cindex KOMA-Script, LaTeX classes  @cindex KOMA-Script, LaTeX classes
638  @cindex LaTeX classes, KOMA-Script  @cindex LaTeX classes, KOMA-Script
# Line 1508  the entries described above: Line 1529  the entries described above:
1529  @kindex C-c &  @kindex C-c &
1530  @kindex S-mouse-2  @kindex S-mouse-2
1531    
1532  When point is idle on the argument of a @code{\ref} macro, the echo area  When point is idle for more than @code{reftex-idle-time} seconds on the
1533  will display some information about the label referenced there.  Note  argument of a @code{\ref} macro, the echo area will display some
1534  that the information is only displayed if the echo area is not occupied  information about the label referenced there.  Note that the information
1535  by a different message.    is only displayed if the echo area is not occupied by a different
1536    message.
1537    
1538  @b{Ref@TeX{}} can also display the label definition corresponding to a  @b{Ref@TeX{}} can also display the label definition corresponding to a
1539  @code{\ref} macro, or all reference locations corresponding to a  @code{\ref} macro, or all reference locations corresponding to a
# Line 1808  files correctly.@refill Line 1830  files correctly.@refill
1830  @findex reftex-view-crossref  @findex reftex-view-crossref
1831  @findex reftex-mouse-view-crossref  @findex reftex-mouse-view-crossref
1832    
1833  When point is idle on the argument of a @code{\cite} macro, the echo area  When point is idle for more than @code{reftex-idle-time} seconds on the
1834  will display some information about the article cited there.  Note  argument of a @code{\cite} macro, the echo area will display some
1835  that the information is only displayed if the echo area is not occupied  information about the article cited there.  Note that the information is
1836  by a different message.    only displayed if the echo area is not occupied by a different message.
1837    
1838  @b{Ref@TeX{}} can also display the @code{\bibitem} or BibTeX database  @b{Ref@TeX{}} can also display the @code{\bibitem} or BibTeX database
1839  entry corresponding to a @code{\cite} macro, or all citation locations  entry corresponding to a @code{\cite} macro, or all citation locations
# Line 2578  entire set of options.@refill Line 2600  entire set of options.@refill
2600  Here is a summary of the available key bindings.  Here is a summary of the available key bindings.
2601    
2602  @kindex C-c =  @kindex C-c =
2603    @kindex C-c -
2604  @kindex C-c (  @kindex C-c (
2605  @kindex C-c )  @kindex C-c )
2606  @kindex C-c [  @kindex C-c [
# Line 2590  Here is a summary of the available key b Line 2613  Here is a summary of the available key b
2613  @kindex C-c >  @kindex C-c >
2614  @example  @example
2615  @kbd{C-c =}      @code{reftex-toc}  @kbd{C-c =}      @code{reftex-toc}
2616    @kbd{C-c -}      @code{reftex-toc-recenter}
2617  @kbd{C-c (}      @code{reftex-label}  @kbd{C-c (}      @code{reftex-label}
2618  @kbd{C-c )}      @code{reftex-reference}  @kbd{C-c )}      @code{reftex-reference}
2619  @kbd{C-c [}      @code{reftex-citation}  @kbd{C-c [}      @code{reftex-citation}
# Line 2840  the new extension must also be known to Line 2864  the new extension must also be known to
2864  @section Optimizations  @section Optimizations
2865  @cindex Optimizations  @cindex Optimizations
2866    
2867    @b{Note added 2002.  Computers have gotten a lot faster, so most of the
2868    optimizations discussed below will not be necessary on new machines.  I
2869    am leaving this stuff in the manual for people who want to write thick
2870    books, where some of it still might be useful.}
2871    
2872  Implementing the principle of least surprises, the default settings of  Implementing the principle of least surprises, the default settings of
2873  @b{Ref@TeX{}} ensure a safe ride for beginners and casual users.  However,  @b{Ref@TeX{}} ensure a safe ride for beginners and casual users.  However,
2874  when using @b{Ref@TeX{}} for a large project and/or on a small computer,  when using @b{Ref@TeX{}} for a large project and/or on a small computer,
# Line 3397  Thanks to the people on the Net who have Line 3426  Thanks to the people on the Net who have
3426  developing it with their reports.  In particular thanks to @i{Fran  developing it with their reports.  In particular thanks to @i{Fran
3427  Burstall, Alastair Burt, Lars Clausen, Soren Dayton, Stephen Eglen, Karl  Burstall, Alastair Burt, Lars Clausen, Soren Dayton, Stephen Eglen, Karl
3428  Eichwalder, Erik Frik, Erik Frisk, Peter Galbraith, Kai Grossjohann,  Eichwalder, Erik Frik, Erik Frisk, Peter Galbraith, Kai Grossjohann,
3429  Frank Harrell, Stephan Heuel, Alan Ho, Dieter Kraft, Adrian Lanz, Rory  Frank Harrell, Stephan Heuel, Alan Ho, Lute Kamstra, Dieter Kraft,
3430  Molinari, Stefan Monnier, Laurent Mugnier, Sudeep Kumar Palat, Daniel  Adrian Lanz, Rory Molinari, Stefan Monnier, Laurent Mugnier, Sudeep
3431  Polani, Alan Shutko, Robin Socha, Richard Stanton, Allan Strand, Jan  Kumar Palat, Daniel Polani, Alan Shutko, Robin Socha, Richard Stanton,
3432  Vroonhof, Christoph Wedler, Alan Williams, Roland Winkler, Eli  Allan Strand, Jan Vroonhof, Christoph Wedler, Alan Williams, Roland
3433  Zaretskii}.@refill  Winkler, Eli Zaretskii}.@refill
3434    
3435  The @code{view-crossref} feature was inspired by @i{Peter Galbraith's}  The @code{view-crossref} feature was inspired by @i{Peter Galbraith's}
3436  @file{bib-cite.el}.@refill  @file{bib-cite.el}.@refill
# Line 3543  document.  With prefix arg, replace only Line 3572  document.  With prefix arg, replace only
3572  active TAGS table is required.@refill  active TAGS table is required.@refill
3573  @end deffn  @end deffn
3574    
3575    @deffn Command reftex-goto-label
3576    Prompt for a label (with completion) and jump to the location of this
3577    label.  Optional prefix argument @var{other-window} goes to the label in
3578    another window.
3579    @end deffn
3580    
3581    
3582  @deffn Command reftex-change-label  @deffn Command reftex-change-label
3583  Query replace @var{from} with @var{to} in all @code{\label} and  Query replace @var{from} with @var{to} in all @code{\label} and
3584  @code{\ref} commands.  Works on the entire multifile document.  No  @code{\ref} commands.  Works on the entire multifile document.  No
# Line 3638  chapters are level 1, sections level 2 e Line 3674  chapters are level 1, sections level 2 e
3674  changed from within the @file{*toc*} buffer with the @kbd{t} key.@refill  changed from within the @file{*toc*} buffer with the @kbd{t} key.@refill
3675  @end defopt  @end defopt
3676    
3677    @defopt reftex-part-resets-chapter
3678    Non-@code{nil} means, @code{\part} is like any other sectioning command.
3679    This means, part numbers will be included in the numbering of chapters, and
3680    chapter counters will be reset for each part.
3681    When @code{nil} (the default), parts are special, do not reset the
3682    chapter counter and also do not show up in chapter numbers.
3683    @end defopt
3684    
3685    @defopt reftex-auto-recenter-toc
3686    Non-@code{nil} means, initially turn automatic recentering of toc on.
3687    When active, the @file{*TOC*} buffer will always show the section you
3688    are currently working in.  Recentering happens whenever Emacs is idle
3689    for more than `reftex-idle-time' seconds.
3690    This feature can be turned on and off from the menu
3691    (Ref->Options).
3692    @end defopt
3693    
3694  @defopt reftex-toc-split-windows-horizontally  @defopt reftex-toc-split-windows-horizontally
3695  Non-@code{nil} means, create TOC window by splitting window  Non-@code{nil} means, create TOC window by splitting window
3696  horizontally.  The default is to split vertically.  horizontally.  The default is to split vertically.
# Line 4512  integer indicating which subgroup of the Line 4565  integer indicating which subgroup of the
4565  @defopt reftex-auto-view-crossref  @defopt reftex-auto-view-crossref
4566  Non-@code{nil} means, initially turn automatic viewing of crossref info  Non-@code{nil} means, initially turn automatic viewing of crossref info
4567  on.  Automatic viewing of crossref info normally uses the echo area.  on.  Automatic viewing of crossref info normally uses the echo area.
4568  Whenever point is on the argument of a @code{\ref} or @code{\cite}  Whenever point is idle for more than @code{reftex-idle-time} seconds on
4569  macro, and no other message is being displayed, the echo area will  the argument of a @code{\ref} or @code{\cite} macro, and no other
4570  display information about that cross reference.  You can also set the  message is being displayed, the echo area will display information about
4571  variable to the symbol @code{window}.  In this case a small temporary  that cross reference.  You can also set the variable to the symbol
4572  window is used for the display.  This feature can be turned on and of  @code{window}.  In this case a small temporary window is used for the
4573  from the menu (Ref->Options).@refill  display.  This feature can be turned on and off from the menu
4574    (Ref->Options).@refill
4575  @end defopt  @end defopt
4576    
4577  @defopt reftex-idle-time  @defopt reftex-idle-time
4578  Time (secs) Emacs has to be idle before automatic crossref display is  Time (secs) Emacs has to be idle before automatic crossref display
4579  done.@refill  or toc recentering is done.@refill
4580  @end defopt  @end defopt
4581    
4582  @defopt reftex-cite-view-format  @defopt reftex-cite-view-format
# Line 5392  Files in @code{reftex-default-bibliograp Line 5446  Files in @code{reftex-default-bibliograp
5446  @item  @item
5447  Reading a parse file now checks consistency.  Reading a parse file now checks consistency.
5448  @end itemize  @end itemize
 @end ignore  
5449  @noindent @b{Version 4.00}  @noindent @b{Version 4.00}
5450  @itemize @bullet  @itemize @bullet
5451  @item  @item
# Line 5494  Small bug fixes. Line 5547  Small bug fixes.
5547  @item  @item
5548  Improved interaction with Emacs LaTeX mode.  Improved interaction with Emacs LaTeX mode.
5549  @end itemize  @end itemize
5550    @end ignore
5551  @noindent @b{Version 4.17}  @noindent @b{Version 4.17}
5552  @itemize @bullet  @itemize @bullet
5553  @item  @item
# Line 5521  Small bug fixes. Line 5575  Small bug fixes.
5575  @item  @item
5576  @code{reftex-citation} uses the word before the cursor as a default  @code{reftex-citation} uses the word before the cursor as a default
5577  search string.  search string.
5578    @item
5579    Simplified several regular expressions for speed.
5580    @item
5581    Better support for chapterbib.
5582    @end itemize
5583    @noindent @b{Version 4.19}
5584    @itemize @bullet
5585    @item
5586    New command `reftex-toc-recenter' (@kbd{C-c -}) which shows the current
5587    section in the TOC buffer without selecting the TOC window.
5588    @item
5589    Recentering happens automatically in idle time when the option
5590    @code{reftex-auto-recenter-toc} is turned on.
5591    @item
5592    Fixed several bugs related to automatic cursor positioning in the TOC
5593    buffer.
5594    @item
5595    The highlight in the TOC buffer stays when the focus moves to a
5596    different window.
5597    @item
5598    New command `reftex-goto-label'.
5599    @item
5600    Part numbers are no longer included in chapter numbers, and a new
5601    part does not reset the chapter counter.  See new option
5602    @code{reftex-part-resets-chapter}.
5603  @end itemize  @end itemize
5604    
5605  @node Index,  , , Top  @node Index,  , , Top

Legend:
Removed from v.1.20  
changed lines
  Added in v.1.21

savannah-hackers-public@gnu.org
ViewVC Help
Powered by ViewVC 1.1.26