aboutsummaryrefslogtreecommitdiffstats
path: root/doc/misc/reftex.texi
diff options
context:
space:
mode:
authorJoakim Verona2013-08-13 09:16:29 +0200
committerJoakim Verona2013-08-13 09:16:29 +0200
commit0b4c71fb6ca9382bee1dfa6996b7a5d67f469880 (patch)
tree80ede09a1450c7098c5a88f0b20f2403eda47695 /doc/misc/reftex.texi
parentb3797d24ab7fd78fe54583b5f9a59e7bc87208cd (diff)
parent3e6b67c9b7230bf10219082d9215d9617a33715e (diff)
downloademacs-0b4c71fb6ca9382bee1dfa6996b7a5d67f469880.tar.gz
emacs-0b4c71fb6ca9382bee1dfa6996b7a5d67f469880.zip
merge from trunk
Diffstat (limited to 'doc/misc/reftex.texi')
-rw-r--r--doc/misc/reftex.texi117
1 files changed, 57 insertions, 60 deletions
diff --git a/doc/misc/reftex.texi b/doc/misc/reftex.texi
index b9cf2335647..ba83d8129a8 100644
--- a/doc/misc/reftex.texi
+++ b/doc/misc/reftex.texi
@@ -153,7 +153,7 @@ Labels and References
153* Defining Label Environments:: ... and environments it doesn't. 153* Defining Label Environments:: ... and environments it doesn't.
154* Reference Info:: View the label corresponding to a \ref. 154* Reference Info:: View the label corresponding to a \ref.
155* Reference Styles:: Macros to be used instead of \ref. 155* Reference Styles:: Macros to be used instead of \ref.
156* xr (LaTeX package):: References to external documents. 156* LaTeX xr Package:: References to external documents.
157 157
158Defining Label Environments 158Defining Label Environments
159 159
@@ -196,17 +196,17 @@ AUCTeX
196 196
197Options, Keymaps, Hooks 197Options, Keymaps, Hooks
198 198
199* Options (Table of Contents):: 199* Options - Table of Contents::
200* Options (Defining Label Environments):: 200* Options - Defining Label Environments::
201* Options (Creating Labels):: 201* Options - Creating Labels::
202* Options (Referencing Labels):: 202* Options - Referencing Labels::
203* Options (Creating Citations):: 203* Options - Creating Citations::
204* Options (Index Support):: 204* Options - Index Support::
205* Options (Viewing Cross-References):: 205* Options - Viewing Cross-References::
206* Options (Finding Files):: 206* Options - Finding Files::
207* Options (Optimizations):: 207* Options - Optimizations::
208* Options (Fontification):: 208* Options - Fontification::
209* Options (Misc):: 209* Options - Misc::
210 210
211@end detailmenu 211@end detailmenu
212@end menu 212@end menu
@@ -581,8 +581,8 @@ called.
581@item mouse-2 581@item mouse-2
582@vindex reftex-highlight-selection 582@vindex reftex-highlight-selection
583Clicking with mouse button 2 on a line has the same effect as @key{RET}. 583Clicking with mouse button 2 on a line has the same effect as @key{RET}.
584See also variable @code{reftex-highlight-selection}, @ref{Options 584See also variable @code{reftex-highlight-selection},
585(Fontification)}. 585@ref{Options - Fontification}.
586 586
587@item f 587@item f
588@vindex reftex-toc-follow-mode 588@vindex reftex-toc-follow-mode
@@ -701,9 +701,8 @@ buffer.
701 701
702@item x 702@item x
703Switch to the @file{*toc*} buffer of an external document. When the 703Switch to the @file{*toc*} buffer of an external document. When the
704current document is using the @code{xr} package (@pxref{xr (LaTeX 704current document is using the @code{xr} package (@pxref{LaTeX xr Package}),
705package)}), @RefTeX{} will switch to one of the external 705@RefTeX{} will switch to one of the external documents.
706documents.
707 706
708 707
709@tablesubheading{Automatic recentering} 708@tablesubheading{Automatic recentering}
@@ -796,7 +795,7 @@ equation counter.
796* Defining Label Environments:: ... and environments it doesn't. 795* Defining Label Environments:: ... and environments it doesn't.
797* Reference Info:: View the label corresponding to a \ref. 796* Reference Info:: View the label corresponding to a \ref.
798* Reference Styles:: Macros to be used instead of \ref. 797* Reference Styles:: Macros to be used instead of \ref.
799* xr (LaTeX package):: References to external documents. 798* LaTeX xr Package:: References to external documents.
800@end menu 799@end menu
801 800
802@node Creating Labels 801@node Creating Labels
@@ -859,8 +858,8 @@ this label later.
859 858
860@vindex reftex-insert-label-flags 859@vindex reftex-insert-label-flags
861If you want to change the way certain labels are created, check out the 860If you want to change the way certain labels are created, check out the
862variable @code{reftex-insert-label-flags} (@pxref{Options (Creating 861variable @code{reftex-insert-label-flags} (@pxref{Options - Creating
863Labels)}). 862Labels}).
864 863
865If you are using @AUCTeX{} to write your @LaTeX{} documents, you can 864If you are using @AUCTeX{} to write your @LaTeX{} documents, you can
866set it up to delegate the creation of labels to 865set it up to delegate the creation of labels to
@@ -981,7 +980,7 @@ references all marked labels.
981@vindex reftex-highlight-selection 980@vindex reftex-highlight-selection
982Clicking with mouse button 2 on a label will accept it like @key{RET} 981Clicking with mouse button 2 on a label will accept it like @key{RET}
983would. See also variable @code{reftex-highlight-selection}, 982would. See also variable @code{reftex-highlight-selection},
984@ref{Options (Misc)}. 983@ref{Options - Misc}.
985 984
986@vindex reftex-multiref-punctuation 985@vindex reftex-multiref-punctuation
987@item m - + , 986@item m - + ,
@@ -1034,7 +1033,7 @@ buffer.
1034@tablesubheading{Controlling what gets displayed} 1033@tablesubheading{Controlling what gets displayed}
1035@vindex reftex-label-menu-flags 1034@vindex reftex-label-menu-flags
1036The defaults for the following flags can be configured with the variable 1035The defaults for the following flags can be configured with the variable
1037@code{reftex-label-menu-flags} (@pxref{Options (Referencing Labels)}). 1036@code{reftex-label-menu-flags} (@pxref{Options - Referencing Labels}).
1038 1037
1039@item c 1038@item c
1040Toggle the display of the one-line label definition context in the 1039Toggle the display of the one-line label definition context in the
@@ -1082,8 +1081,7 @@ a menu for that category will be shown.
1082Reference a label from an external document. With the @LaTeX{} package 1081Reference a label from an external document. With the @LaTeX{} package
1083@code{xr} it is possible to reference labels defined in another 1082@code{xr} it is possible to reference labels defined in another
1084document. This key will switch to the label menu of an external 1083document. This key will switch to the label menu of an external
1085document and let you select a label from there (@pxref{xr (LaTeX 1084document and let you select a label from there (@pxref{LaTeX xr Package,,xr}).
1086package),,xr}).
1087 1085
1088@end table 1086@end table
1089 1087
@@ -1203,8 +1201,8 @@ them (@pxref{Defining Label Environments}).
1203@vindex reftex-label-alist 1201@vindex reftex-label-alist
1204@RefTeX{} can be configured to recognize additional labeled 1202@RefTeX{} can be configured to recognize additional labeled
1205environments and macros. This is done with the variable 1203environments and macros. This is done with the variable
1206@code{reftex-label-alist} (@pxref{Options (Defining Label 1204@code{reftex-label-alist} (@pxref{Options - Defining Label
1207Environments)}). If you are not familiar with Lisp, you can use the 1205Environments}). If you are not familiar with Lisp, you can use the
1208@code{custom} library to configure this rather complex variable. To do 1206@code{custom} library to configure this rather complex variable. To do
1209this, use 1207this, use
1210 1208
@@ -1302,8 +1300,7 @@ a @code{\macro} or after the @code{\begin} statement). @code{t} is
1302@code{nil} means to use the text right after the label definition. 1300@code{nil} means to use the text right after the label definition.
1303@item 1301@item
1304For more complex ways of getting context, see the variable 1302For more complex ways of getting context, see the variable
1305@code{reftex-label-alist} (@ref{Options (Defining Label 1303@code{reftex-label-alist} (@ref{Options - Defining Label Environments}).
1306Environments)}).
1307@end itemize 1304@end itemize
1308 1305
1309The following list of strings is used to guess the correct label type 1306The following list of strings is used to guess the correct label type
@@ -1356,9 +1353,8 @@ Reftex Label Alist: [Hide]
1356Depending on how you would like the label insertion and selection for 1353Depending on how you would like the label insertion and selection for
1357the new environments to work, you might want to add the letters @samp{a} 1354the new environments to work, you might want to add the letters @samp{a}
1358and @samp{h} to some of the flags in the variables 1355and @samp{h} to some of the flags in the variables
1359@code{reftex-insert-label-flags} (@pxref{Options (Creating Labels)}) 1356@code{reftex-insert-label-flags} (@pxref{Options - Creating Labels})
1360and @code{reftex-label-menu-flags} (@pxref{Options (Referencing 1357and @code{reftex-label-menu-flags} (@pxref{Options - Referencing Labels}).
1361Labels)}).
1362 1358
1363 1359
1364@node Quick Equation 1360@node Quick Equation
@@ -1749,7 +1745,7 @@ and @code{reftex-fref-is-default} respectively. While still working,
1749these variables are deprecated now. Instead of setting them, the 1745these variables are deprecated now. Instead of setting them, the
1750variable @code{reftex-ref-style-default-list} should be adapted now. 1746variable @code{reftex-ref-style-default-list} should be adapted now.
1751 1747
1752@node xr (LaTeX package) 1748@node LaTeX xr Package
1753@section @code{xr}: Cross-Document References 1749@section @code{xr}: Cross-Document References
1754@cindex @code{xr}, LaTeX package 1750@cindex @code{xr}, LaTeX package
1755@cindex LaTeX packages, @code{xr} 1751@cindex LaTeX packages, @code{xr}
@@ -1883,8 +1879,8 @@ which the selection process was started.
1883@item mouse-2 1879@item mouse-2
1884@vindex reftex-highlight-selection 1880@vindex reftex-highlight-selection
1885Clicking with mouse button 2 on a citation will accept it like @key{RET} 1881Clicking with mouse button 2 on a citation will accept it like @key{RET}
1886would. See also variable @code{reftex-highlight-selection}, @ref{Options 1882would. See also variable @code{reftex-highlight-selection},
1887(Misc)}. 1883@ref{Options - Misc}.
1888 1884
1889@item m 1885@item m
1890Mark the current entry. When one or several entries are marked, 1886Mark the current entry. When one or several entries are marked,
@@ -2403,8 +2399,9 @@ Abort the indexing process.
2403 2399
2404The @samp{Find and Index in Document} menu in the phrases buffer also 2400The @samp{Find and Index in Document} menu in the phrases buffer also
2405lists a few options for the indexing process. The options have 2401lists a few options for the indexing process. The options have
2406associated customization variables to set the defaults (@pxref{Options 2402associated customization variables to set the defaults
2407(Index Support)}). Here is a short explanation of what the options do: 2403(@pxref{Options - Index Support}). Here is a short explanation of
2404what the options do:
2408 2405
2409@table @i 2406@table @i
2410@item Match Whole Words 2407@item Match Whole Words
@@ -2759,7 +2756,7 @@ variants@footnote{all macros that start with @samp{ref} or end with
2759@samp{ref} or @samp{refrange}} of the @code{\ref} macro are active for 2756@samp{ref} or @samp{refrange}} of the @code{\ref} macro are active for
2760cross-reference display. This works also for labels defined in an 2757cross-reference display. This works also for labels defined in an
2761external document when the current document refers to them through the 2758external document when the current document refers to them through the
2762@code{xr} interface (@pxref{xr (LaTeX package)}). 2759@code{xr} interface (@pxref{LaTeX xr Package}).
2763 2760
2764@item @code{\label} 2761@item @code{\label}
2765@cindex @code{\label} 2762@cindex @code{\label}
@@ -2908,7 +2905,7 @@ the ones defined in @file{font-lock.el}. Therefore, @RefTeX{} will
2908use faces only when @code{font-lock} is loaded. This seems to be 2905use faces only when @code{font-lock} is loaded. This seems to be
2909reasonable because people who like faces will very likely have it 2906reasonable because people who like faces will very likely have it
2910loaded. If you wish to turn off fontification or change the involved 2907loaded. If you wish to turn off fontification or change the involved
2911faces, see @ref{Options (Fontification)}. 2908faces, see @ref{Options - Fontification}.
2912 2909
2913@node Multifile Documents 2910@node Multifile Documents
2914@section Multifile Documents 2911@section Multifile Documents
@@ -3894,21 +3891,21 @@ Lisp (and even if you are) you might find it more comfortable to use
3894reftex-customize} will get you there. 3891reftex-customize} will get you there.
3895 3892
3896@menu 3893@menu
3897* Options (Table of Contents):: 3894* Options - Table of Contents::
3898* Options (Defining Label Environments):: 3895* Options - Defining Label Environments::
3899* Options (Creating Labels):: 3896* Options - Creating Labels::
3900* Options (Referencing Labels):: 3897* Options - Referencing Labels::
3901* Options (Creating Citations):: 3898* Options - Creating Citations::
3902* Options (Index Support):: 3899* Options - Index Support::
3903* Options (Viewing Cross-References):: 3900* Options - Viewing Cross-References::
3904* Options (Finding Files):: 3901* Options - Finding Files::
3905* Options (Optimizations):: 3902* Options - Optimizations::
3906* Options (Fontification):: 3903* Options - Fontification::
3907* Options (Misc):: 3904* Options - Misc::
3908* Keymaps and Hooks:: 3905* Keymaps and Hooks::
3909@end menu 3906@end menu
3910 3907
3911@node Options (Table of Contents) 3908@node Options - Table of Contents
3912@section Table of Contents 3909@section Table of Contents
3913@cindex Options, table of contents 3910@cindex Options, table of contents
3914@cindex Table of contents, options 3911@cindex Table of contents, options
@@ -4032,7 +4029,7 @@ The keymap which is active in the @file{*toc*} buffer.
4032(@pxref{Table of Contents}). 4029(@pxref{Table of Contents}).
4033@end deffn 4030@end deffn
4034 4031
4035@node Options (Defining Label Environments) 4032@node Options - Defining Label Environments
4036@section Defining Label Environments 4033@section Defining Label Environments
4037@cindex Options, defining label environments 4034@cindex Options, defining label environments
4038@cindex Defining label environments, options 4035@cindex Defining label environments, options
@@ -4259,7 +4256,7 @@ labels fn:xxx, you may want to set this variable to the value "^fn:$" or
4259non-footnote labels. 4256non-footnote labels.
4260@end defopt 4257@end defopt
4261 4258
4262@node Options (Creating Labels) 4259@node Options - Creating Labels
4263@section Creating Labels 4260@section Creating Labels
4264@cindex Options, creating labels 4261@cindex Options, creating labels
4265@cindex Creating labels, options 4262@cindex Creating labels, options
@@ -4375,7 +4372,7 @@ Character class after abbrev point in word.
4375@end table 4372@end table
4376@end defopt 4373@end defopt
4377 4374
4378@node Options (Referencing Labels) 4375@node Options - Referencing Labels
4379@section Referencing Labels 4376@section Referencing Labels
4380@cindex Options, referencing labels 4377@cindex Options, referencing labels
4381@cindex Referencing labels, options 4378@cindex Referencing labels, options
@@ -4497,7 +4494,7 @@ The keymap which is active in the labels selection process
4497(@pxref{Referencing Labels}). 4494(@pxref{Referencing Labels}).
4498@end deffn 4495@end deffn
4499 4496
4500@node Options (Creating Citations) 4497@node Options - Creating Citations
4501@section Creating Citations 4498@section Creating Citations
4502@cindex Options, creating citations 4499@cindex Options, creating citations
4503@cindex Creating citations, options 4500@cindex Creating citations, options
@@ -4676,7 +4673,7 @@ Footer to insert in BibTeX files generated by
4676@end defopt 4673@end defopt
4677 4674
4678 4675
4679@node Options (Index Support) 4676@node Options - Index Support, Options - Viewing Cross-References, Options - Creating Citations, Options
4680@section Index Support 4677@section Index Support
4681@cindex Options, Index support 4678@cindex Options, Index support
4682@cindex Index support, options 4679@cindex Index support, options
@@ -4896,7 +4893,7 @@ The keymap which is active in the @file{*Index*} buffer
4896(@pxref{Index Support}). 4893(@pxref{Index Support}).
4897@end deffn 4894@end deffn
4898 4895
4899@node Options (Viewing Cross-References) 4896@node Options - Viewing Cross-References
4900@section Viewing Cross-References 4897@section Viewing Cross-References
4901@cindex Options, viewing cross-references 4898@cindex Options, viewing cross-references
4902@cindex Viewing cross-references, options 4899@cindex Viewing cross-references, options
@@ -4955,7 +4952,7 @@ saved along with the parsing information. The cache survives document
4955scans. In order to clear it, use @kbd{M-x reftex-reset-mode}. 4952scans. In order to clear it, use @kbd{M-x reftex-reset-mode}.
4956@end defopt 4953@end defopt
4957 4954
4958@node Options (Finding Files) 4955@node Options - Finding Files
4959@section Finding Files 4956@section Finding Files
4960@cindex Options, Finding Files 4957@cindex Options, Finding Files
4961@cindex Finding files, options 4958@cindex Finding files, options
@@ -5045,7 +5042,7 @@ non-@code{nil}.
5045@end defopt 5042@end defopt
5046 5043
5047@page 5044@page
5048@node Options (Optimizations) 5045@node Options - Optimizations
5049@section Optimizations 5046@section Optimizations
5050@cindex Options, optimizations 5047@cindex Options, optimizations
5051@cindex Optimizations, options 5048@cindex Optimizations, options
@@ -5154,7 +5151,7 @@ effect when @code{reftex-use-multiple-selection-buffers} is
5154non-@code{nil}. 5151non-@code{nil}.
5155@end defopt 5152@end defopt
5156 5153
5157@node Options (Fontification) 5154@node Options - Fontification
5158@section Fontification 5155@section Fontification
5159@cindex Options, fontification 5156@cindex Options, fontification
5160@cindex Fontification, options 5157@cindex Fontification, options
@@ -5252,7 +5249,7 @@ Face name for index names (for multiple indices).
5252Face name for index entries. 5249Face name for index entries.
5253@end defopt 5250@end defopt
5254 5251
5255@node Options (Misc) 5252@node Options - Misc
5256@section Miscellaneous 5253@section Miscellaneous
5257@cindex Options, misc 5254@cindex Options, misc
5258 5255