aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorCarsten Dominik2001-06-08 08:55:05 +0000
committerCarsten Dominik2001-06-08 08:55:05 +0000
commitfbeef7be20b2de33cb1d7557cb49074bc6a83b4e (patch)
tree6b690aca504d24fa82292672de0645b0112f98ba
parent70d797cd6e055969be39581f7963a8f1eb10b24e (diff)
downloademacs-fbeef7be20b2de33cb1d7557cb49074bc6a83b4e.tar.gz
emacs-fbeef7be20b2de33cb1d7557cb49074bc6a83b4e.zip
Updated to version 4.16
-rw-r--r--man/reftex.texi62
1 files changed, 35 insertions, 27 deletions
diff --git a/man/reftex.texi b/man/reftex.texi
index d90734f0248..64aa78078ac 100644
--- a/man/reftex.texi
+++ b/man/reftex.texi
@@ -1,6 +1,6 @@
1\input texinfo @c -*-texinfo-*- 1\input texinfo @c -*-texinfo-*-
2@c %**start of header 2@c %**start of header
3@setfilename ../info/reftex 3@setfilename ../indo/reftex
4@settitle RefTeX User Manual 4@settitle RefTeX User Manual
5@dircategory Emacs 5@dircategory Emacs
6@direntry 6@direntry
@@ -9,9 +9,9 @@
9@synindex ky cp 9@synindex ky cp
10@syncodeindex vr cp 10@syncodeindex vr cp
11@syncodeindex fn cp 11@syncodeindex fn cp
12@set VERSION 4.15 12@set VERSION 4.16
13@set EDITION 4.15 13@set EDITION 4.16
14@set DATE November 2000 14@set DATE June 2001
15@set AUTHOR Carsten Dominik 15@set AUTHOR Carsten Dominik
16@set AUTHOR-EMAIL dominik@@astro.uva.nl 16@set AUTHOR-EMAIL dominik@@astro.uva.nl
17@set MAINTAINER Carsten Dominik 17@set MAINTAINER Carsten Dominik
@@ -38,7 +38,7 @@ citations and indices for LaTeX documents with Emacs.@refill
38This is edition @value{EDITION} of the @b{Ref@TeX{}} User Manual for 38This is edition @value{EDITION} of the @b{Ref@TeX{}} User Manual for
39@b{Ref@TeX{}} @value{VERSION}@refill 39@b{Ref@TeX{}} @value{VERSION}@refill
40 40
41Copyright (c) 1997, 1998, 1999, 2000, 2001 Free Software Foundation, Inc. 41Copyright (c) 1997, 1998, 1999, 2000 2001 Free Software Foundation, Inc.
42 42
43Permission is granted to copy, distribute and/or modify this document 43Permission is granted to copy, distribute and/or modify this document
44under the terms of the GNU Free Documentation License, Version 1.1 or 44under the terms of the GNU Free Documentation License, Version 1.1 or
@@ -493,6 +493,10 @@ separate section headings.@refill
493@item C-c C-p 493@item C-c C-p
494Goto previous section heading. 494Goto previous section heading.
495 495
496@item N z
497Jump to section N, using the prefix arg. For example, @kbd{3 z} jumps
498to section 3.@refill
499
496@tablesubheading{Access to document locations} 500@tablesubheading{Access to document locations}
497@item @key{SPC} 501@item @key{SPC}
498Show the corresponding location in another window. This command does 502Show the corresponding location in another window. This command does
@@ -506,7 +510,7 @@ Go to the location and hide the @file{*toc*} buffer. This will restore
506the window configuration before @code{reftex-toc} (@kbd{C-c =}) was 510the window configuration before @code{reftex-toc} (@kbd{C-c =}) was
507called.@refill 511called.@refill
508 512
509@item Mouse-2 513@item mouse-2
510@vindex reftex-highlight-selection 514@vindex reftex-highlight-selection
511Clicking with mouse button 2 on a line has the same effect as @key{RET}. 515Clicking with mouse button 2 on a line has the same effect as @key{RET}.
512See also variable @code{reftex-highlight-selection}, @ref{Options 516See also variable @code{reftex-highlight-selection}, @ref{Options
@@ -796,6 +800,10 @@ Goto next section heading.
796@item C-c C-p 800@item C-c C-p
797Goto previous section heading. 801Goto previous section heading.
798 802
803@item N z
804Jump to section N, using the prefix arg. For example @kbd{3 z} jumps to
805section 3.@refill
806
799@tablesubheading{Displaying Context} 807@tablesubheading{Displaying Context}
800@item @key{SPC} 808@item @key{SPC}
801Show the surroundings of the definition of the current label in another 809Show the surroundings of the definition of the current label in another
@@ -820,7 +828,7 @@ Insert a reference to the label at point into the buffer from which the
820selection process was started. When entries have been marked, @key{RET} 828selection process was started. When entries have been marked, @key{RET}
821references all marked labels.@refill 829references all marked labels.@refill
822 830
823@item Mouse-2 831@item mouse-2
824@vindex reftex-highlight-selection 832@vindex reftex-highlight-selection
825Clicking with mouse button 2 on a label will accept it like @key{RET} 833Clicking with mouse button 2 on a label will accept it like @key{RET}
826would. See also variable @code{reftex-highlight-selection}, @ref{Options 834would. See also variable @code{reftex-highlight-selection}, @ref{Options
@@ -1491,7 +1499,7 @@ the entries described above:
1491@cindex Displaying cross-references 1499@cindex Displaying cross-references
1492@cindex Viewing cross-references 1500@cindex Viewing cross-references
1493@kindex C-c & 1501@kindex C-c &
1494@kindex S-Mouse-2 1502@kindex S-mouse-2
1495 1503
1496When point is idle on the argument of a @code{\ref} macro, the echo area 1504When point is idle on the argument of a @code{\ref} macro, the echo area
1497will display some information about the label referenced there. Note 1505will display some information about the label referenced there. Note
@@ -1670,7 +1678,7 @@ entries, follow mode can be rather slow.@refill
1670Insert a citation referencing the article at point into the buffer from 1678Insert a citation referencing the article at point into the buffer from
1671which the selection process was started.@refill 1679which the selection process was started.@refill
1672 1680
1673@item Mouse-2 1681@item mouse-2
1674@vindex reftex-highlight-selection 1682@vindex reftex-highlight-selection
1675Clicking with mouse button 2 on a citation will accept it like @key{RET} 1683Clicking with mouse button 2 on a citation will accept it like @key{RET}
1676would. See also variable @code{reftex-highlight-selection}, @ref{Options 1684would. See also variable @code{reftex-highlight-selection}, @ref{Options
@@ -1786,7 +1794,7 @@ files correctly.@refill
1786@cindex Citation info 1794@cindex Citation info
1787@cindex Viewing citations 1795@cindex Viewing citations
1788@kindex C-c & 1796@kindex C-c &
1789@kindex S-Mouse-2 1797@kindex S-mouse-2
1790@findex reftex-view-crossref 1798@findex reftex-view-crossref
1791@findex reftex-mouse-view-crossref 1799@findex reftex-mouse-view-crossref
1792 1800
@@ -2467,7 +2475,7 @@ The index tag is "idx".@refill
2467@findex reftex-view-crossref 2475@findex reftex-view-crossref
2468@findex reftex-mouse-view-crossref 2476@findex reftex-mouse-view-crossref
2469@kindex C-c & 2477@kindex C-c &
2470@kindex S-Mouse-2 2478@kindex S-mouse-2
2471 2479
2472@b{Ref@TeX{}} can display cross--referencing information. This means, 2480@b{Ref@TeX{}} can display cross--referencing information. This means,
2473if two document locations are linked, @b{Ref@TeX{}} can display the 2481if two document locations are linked, @b{Ref@TeX{}} can display the
@@ -2479,7 +2487,7 @@ database entry.@refill
2479The feature is invoked by pressing @kbd{C-c &} 2487The feature is invoked by pressing @kbd{C-c &}
2480(@code{reftex-view-crossref}) while point is on the @var{key} argument 2488(@code{reftex-view-crossref}) while point is on the @var{key} argument
2481of a macro involved in cross--referencing. You can also click with 2489of a macro involved in cross--referencing. You can also click with
2482@kbd{S-Mouse-2} on the macro argument. Here is what will happen for 2490@kbd{S-mouse-2} on the macro argument. Here is what will happen for
2483individual classes of macros:@refill 2491individual classes of macros:@refill
2484 2492
2485@table @asis 2493@table @asis
@@ -2533,10 +2541,10 @@ and @code{\glossary} macros, all macros configured in
2533@code{reftex-index-macros} will be recognized.@refill 2541@code{reftex-index-macros} will be recognized.@refill
2534@end table 2542@end table
2535 2543
2536@vindex reftex-view-crossref-macros 2544@vindex reftex-view-crossref-extra
2537While the display of cross referencing information for the above 2545While the display of cross referencing information for the above
2538mentioned macros is hard--coded, you can configure additional relations 2546mentioned macros is hard--coded, you can configure additional relations
2539in the variable @code{reftex-view-crossref-macros}. 2547in the variable @code{reftex-view-crossref-extra}.
2540 2548
2541@iftex 2549@iftex
2542@chapter All the Rest 2550@chapter All the Rest
@@ -2564,7 +2572,7 @@ Here is a summary of the available keybindings.
2564@kindex C-c ) 2572@kindex C-c )
2565@kindex C-c [ 2573@kindex C-c [
2566@kindex C-c & 2574@kindex C-c &
2567@kindex S-Mouse-2 2575@kindex S-mouse-2
2568@kindex C-c / 2576@kindex C-c /
2569@kindex C-c \ 2577@kindex C-c \
2570@kindex C-c | 2578@kindex C-c |
@@ -2576,7 +2584,7 @@ Here is a summary of the available keybindings.
2576@kbd{C-c )} @code{reftex-reference} 2584@kbd{C-c )} @code{reftex-reference}
2577@kbd{C-c [} @code{reftex-citation} 2585@kbd{C-c [} @code{reftex-citation}
2578@kbd{C-c &} @code{reftex-view-crossref} 2586@kbd{C-c &} @code{reftex-view-crossref}
2579@kbd{S-Mouse-2} @code{reftex-mouse-view-crossref} 2587@kbd{S-mouse-2} @code{reftex-mouse-view-crossref}
2580@kbd{C-c /} @code{reftex-index-selection-or-word} 2588@kbd{C-c /} @code{reftex-index-selection-or-word}
2581@kbd{C-c \} @code{reftex-index-phrase-selection-or-word} 2589@kbd{C-c \} @code{reftex-index-phrase-selection-or-word}
2582@kbd{C-c |} @code{reftex-index-visit-phrases-buffer} 2590@kbd{C-c |} @code{reftex-index-visit-phrases-buffer}
@@ -2584,9 +2592,9 @@ Here is a summary of the available keybindings.
2584@kbd{C-c >} @code{reftex-display-index} 2592@kbd{C-c >} @code{reftex-display-index}
2585@end example 2593@end example
2586 2594
2587Note that the @kbd{S-Mouse-2} binding is only provided if this key is 2595Note that the @kbd{S-mouse-2} binding is only provided if this key is
2588not already used by some other package. @b{Ref@TeX{}} will not override an 2596not already used by some other package. @b{Ref@TeX{}} will not override an
2589existing binding to @kbd{S-Mouse-2}.@refill 2597existing binding to @kbd{S-mouse-2}.@refill
2590 2598
2591Personally, I also bind some functions in the users @kbd{C-c} map for 2599Personally, I also bind some functions in the users @kbd{C-c} map for
2592easier access.@refill 2600easier access.@refill
@@ -3161,7 +3169,7 @@ is a style file @file{foils.el} that will inform @b{Ref@TeX{}} about these:
3161Once you have written a document with labels, references and citations, 3169Once you have written a document with labels, references and citations,
3162it can be nice to read it like a hypertext document. @b{Ref@TeX{}} has 3170it can be nice to read it like a hypertext document. @b{Ref@TeX{}} has
3163support for that: @code{reftex-view-crossref} (bound to @kbd{C-c 3171support for that: @code{reftex-view-crossref} (bound to @kbd{C-c
3164&}), @code{reftex-mouse-view-crossref} (bound to @kbd{S-Mouse-2}), and 3172&}), @code{reftex-mouse-view-crossref} (bound to @kbd{S-mouse-2}), and
3165@code{reftex-search-document}. A somewhat fancier interface with mouse 3173@code{reftex-search-document}. A somewhat fancier interface with mouse
3166highlighting is provided (among other things) by Peter S. Galbraith's 3174highlighting is provided (among other things) by Peter S. Galbraith's
3167@file{bib-cite.el}. There is some overlap in the functionalities of 3175@file{bib-cite.el}. There is some overlap in the functionalities of
@@ -3362,10 +3370,10 @@ features described in this manual.@refill
3362Thanks to the people on the Net who have used @b{Ref@TeX{}} and helped 3370Thanks to the people on the Net who have used @b{Ref@TeX{}} and helped
3363developing it with their reports. In particular thanks to @i{Fran 3371developing it with their reports. In particular thanks to @i{Fran
3364Burstall, Alastair Burt, Soren Dayton, Stephen Eglen, Karl Eichwalder, 3372Burstall, Alastair Burt, Soren Dayton, Stephen Eglen, Karl Eichwalder,
3365Peter Galbraith, Kai Grossjohann, Frank Harrell, Dieter Kraft, Adrian 3373Erik Frik, Peter Galbraith, Kai Grossjohann, Frank Harrell, Dieter
3366Lanz, Rory Molinari, Stefan Monnier, Laurent Mugnier, Sudeep Kumar 3374Kraft, Adrian Lanz, Rory Molinari, Stefan Monnier, Laurent Mugnier,
3367Palat, Daniel Polani, Robin Socha, Richard Stanton, Allan Strand, Jan 3375Sudeep Kumar Palat, Daniel Polani, Robin Socha, Richard Stanton, Allan
3368Vroonhof, Christoph Wedler, Alan Williams}.@refill 3376Strand, Jan Vroonhof, Christoph Wedler, Alan Williams}.@refill
3369 3377
3370The @code{view-crossref} feature was inspired by @i{Peter Galbraith's} 3378The @code{view-crossref} feature was inspired by @i{Peter Galbraith's}
3371@file{bib-cite.el}.@refill 3379@file{bib-cite.el}.@refill
@@ -3479,7 +3487,7 @@ the command @code{reftex-view-crossref-from-bibtex}. With one or two
3479View location in a LaTeX document which cites the BibTeX entry at point. 3487View location in a LaTeX document which cites the BibTeX entry at point.
3480Since BibTeX files can be used by many LaTeX documents, this function 3488Since BibTeX files can be used by many LaTeX documents, this function
3481prompts upon first use for a buffer in @b{Ref@TeX{}} mode. To reset this 3489prompts upon first use for a buffer in @b{Ref@TeX{}} mode. To reset this
3482link to a document, call the function with a prefix arg. Calling 3490link to a document, call the function with with a prefix arg. Calling
3483this function several times find successive citation locations. 3491this function several times find successive citation locations.
3484@end deffn 3492@end deffn
3485 3493
@@ -4443,7 +4451,7 @@ viewing can be useful. Each entry has the structure
4443@end example 4451@end example
4444@var{macro-re} is matched against the macro. @var{search-re} is the 4452@var{macro-re} is matched against the macro. @var{search-re} is the
4445regexp used to search for cross references. @samp{%s} in this regexp is 4453regexp used to search for cross references. @samp{%s} in this regexp is
4446replaced with the macro argument at point. @var{highlight} is an 4454replaced with with the macro argument at point. @var{highlight} is an
4447integer indicating which subgroup of the match should be highlighted. 4455integer indicating which subgroup of the match should be highlighted.
4448@end defopt 4456@end defopt
4449 4457
@@ -5116,7 +5124,7 @@ switch buffers at will, use the mouse etc.@refill
5116@item 5124@item
5117New option @code{reftex-highlight-selection}. 5125New option @code{reftex-highlight-selection}.
5118@item 5126@item
5119@kbd{Mouse-2} can be used to select in selection and @file{*toc*} 5127@kbd{mouse-2} can be used to select in selection and @file{*toc*}
5120buffers.@refill 5128buffers.@refill
5121@item 5129@item
5122Fixed some problems regarding the interaction with VIPER mode. 5130Fixed some problems regarding the interaction with VIPER mode.
@@ -5145,7 +5153,7 @@ customization group @code{reftex-fontification-configurations}.@refill
5145Fixed bug with empty context strings. 5153Fixed bug with empty context strings.
5146@item 5154@item
5147@code{reftex-mouse-view-crossref} is now bound by default at 5155@code{reftex-mouse-view-crossref} is now bound by default at
5148@kbd{S-Mouse-2}.@refill 5156@kbd{S-mouse-2}.@refill
5149@end itemize 5157@end itemize
5150 5158
5151@noindent @b{Version 3.23} 5159@noindent @b{Version 3.23}