diff options
| author | Joakim Verona | 2012-12-22 20:17:08 +0100 |
|---|---|---|
| committer | Joakim Verona | 2012-12-22 20:17:08 +0100 |
| commit | a26b09f270e438e5ecfdce7bf9f424e5b7ec0766 (patch) | |
| tree | a2ba7ad3bb597144adedc70f7f0c8d6999dd2fe7 /doc/misc/reftex.texi | |
| parent | cc590e378e07c7eb84bb5d577b06b4d9a0177272 (diff) | |
| parent | 00afe3a454119390e78eaaa319a7d05e5e7723ae (diff) | |
| download | emacs-a26b09f270e438e5ecfdce7bf9f424e5b7ec0766.tar.gz emacs-a26b09f270e438e5ecfdce7bf9f424e5b7ec0766.zip | |
auto upstream
Diffstat (limited to 'doc/misc/reftex.texi')
| -rw-r--r-- | doc/misc/reftex.texi | 48 |
1 files changed, 24 insertions, 24 deletions
diff --git a/doc/misc/reftex.texi b/doc/misc/reftex.texi index 40cce472eed..f9f0fab9e4a 100644 --- a/doc/misc/reftex.texi +++ b/doc/misc/reftex.texi | |||
| @@ -45,7 +45,7 @@ This manual documents @RefTeX{} (version @value{VERSION}), a package | |||
| 45 | to do labels, references, citations and indices for LaTeX documents | 45 | to do labels, references, citations and indices for LaTeX documents |
| 46 | with Emacs. | 46 | with Emacs. |
| 47 | 47 | ||
| 48 | Copyright @copyright{} 1997-2012 Free Software Foundation, Inc. | 48 | Copyright @copyright{} 1997--2012 Free Software Foundation, Inc. |
| 49 | 49 | ||
| 50 | @quotation | 50 | @quotation |
| 51 | Permission is granted to copy, distribute and/or modify this document | 51 | Permission is granted to copy, distribute and/or modify this document |
| @@ -609,7 +609,7 @@ Promote the current section. This will convert @code{\section} to | |||
| 609 | @code{\chapter}, @code{\subsection} to @code{\section} etc. If there is | 609 | @code{\chapter}, @code{\subsection} to @code{\section} etc. If there is |
| 610 | an active region, all sections in the region will be promoted, including | 610 | an active region, all sections in the region will be promoted, including |
| 611 | the one at point. To avoid mistakes, @RefTeX{} requires a fresh | 611 | the one at point. To avoid mistakes, @RefTeX{} requires a fresh |
| 612 | document scan before executing this command -- if necessary, it will | 612 | document scan before executing this command; if necessary, it will |
| 613 | automatically do this scan and ask the user to repeat the promotion | 613 | automatically do this scan and ask the user to repeat the promotion |
| 614 | command. | 614 | command. |
| 615 | 615 | ||
| @@ -625,7 +625,7 @@ useful when a package like @file{fancyref} is used where the label | |||
| 625 | prefix determines the wording of a reference. After a | 625 | prefix determines the wording of a reference. After a |
| 626 | promotion/demotion it may be necessary to change a few labels from | 626 | promotion/demotion it may be necessary to change a few labels from |
| 627 | @samp{sec:xyz} to @samp{cha:xyz} or vice versa. This command can be | 627 | @samp{sec:xyz} to @samp{cha:xyz} or vice versa. This command can be |
| 628 | used to do this - it launches a query replace to rename the definition | 628 | used to do this; it launches a query replace to rename the definition |
| 629 | and all references of a label. | 629 | and all references of a label. |
| 630 | 630 | ||
| 631 | @tablesubheading{Exiting} | 631 | @tablesubheading{Exiting} |
| @@ -787,7 +787,7 @@ records the figure counter, not the section counter. | |||
| 787 | 787 | ||
| 788 | Several different environments can share a common counter and therefore | 788 | Several different environments can share a common counter and therefore |
| 789 | a common label category. For example labels in both @code{equation} and | 789 | a common label category. For example labels in both @code{equation} and |
| 790 | @code{eqnarray} environments record the value of the same counter -- the | 790 | @code{eqnarray} environments record the value of the same counter: the |
| 791 | equation counter. | 791 | equation counter. |
| 792 | 792 | ||
| 793 | @menu | 793 | @menu |
| @@ -1448,8 +1448,8 @@ The empty pairs of brackets indicate the different arguments of the | |||
| 1448 | indicates that this is a figure label which will be listed together with | 1448 | indicates that this is a figure label which will be listed together with |
| 1449 | labels from normal figure environments. The @code{nil} entries for | 1449 | labels from normal figure environments. The @code{nil} entries for |
| 1450 | prefix and reference format mean to use the defaults for figure labels. | 1450 | prefix and reference format mean to use the defaults for figure labels. |
| 1451 | The @samp{3} for the context method means to grab the third macro argument | 1451 | The @samp{3} for the context method means to grab the third macro argument: |
| 1452 | -- the caption. | 1452 | the caption. |
| 1453 | 1453 | ||
| 1454 | As a side effect of this configuration, @code{reftex-label} will now | 1454 | As a side effect of this configuration, @code{reftex-label} will now |
| 1455 | insert the required naked label (without the @code{\label} macro) when | 1455 | insert the required naked label (without the @code{\label} macro) when |
| @@ -1518,7 +1518,7 @@ following is equivalent to the line above. | |||
| 1518 | @end lisp | 1518 | @end lisp |
| 1519 | 1519 | ||
| 1520 | Note that this is automatically done by the @file{amsmath.el} style file | 1520 | Note that this is automatically done by the @file{amsmath.el} style file |
| 1521 | of @AUCTeX{} (@pxref{Style Files}) -- so if you use @AUCTeX{}, | 1521 | of @AUCTeX{} (@pxref{Style Files}); so if you use @AUCTeX{}, |
| 1522 | this configuration will not be necessary. | 1522 | this configuration will not be necessary. |
| 1523 | 1523 | ||
| 1524 | @node Non-Standard Environments, Putting it Together, Using \eqref, Defining Label Environments | 1524 | @node Non-Standard Environments, Putting it Together, Using \eqref, Defining Label Environments |
| @@ -1743,7 +1743,7 @@ package where a macro call like @code{\fref@{@var{fig:map-of-germany}@}} | |||
| 1743 | creates not only the number of the referenced counter but also the | 1743 | creates not only the number of the referenced counter but also the |
| 1744 | complete text around it, like @samp{Figure 3 on the preceding page}. In | 1744 | complete text around it, like @samp{Figure 3 on the preceding page}. In |
| 1745 | order to make it work you need to use label prefixes like @samp{fig:} | 1745 | order to make it work you need to use label prefixes like @samp{fig:} |
| 1746 | consistently -- something @RefTeX{} does automatically. For each of | 1746 | consistently---something @RefTeX{} does automatically. For each of |
| 1747 | these packages a variable could be configured to make its macros to take | 1747 | these packages a variable could be configured to make its macros to take |
| 1748 | precedence over @code{\ref}. Those were @code{reftex-vref-is-default} | 1748 | precedence over @code{\ref}. Those were @code{reftex-vref-is-default} |
| 1749 | and @code{reftex-fref-is-default} respectively. While still working, | 1749 | and @code{reftex-fref-is-default} respectively. While still working, |
| @@ -2284,7 +2284,7 @@ format. A phrase line looks like this: | |||
| 2284 | @code{<TABs>} stands for white space containing at least one @key{TAB}. | 2284 | @code{<TABs>} stands for white space containing at least one @key{TAB}. |
| 2285 | @var{key} must be at the start of the line and is the character | 2285 | @var{key} must be at the start of the line and is the character |
| 2286 | identifying one of the macros defined in the file header. It is | 2286 | identifying one of the macros defined in the file header. It is |
| 2287 | optional - when omitted, the first macro definition line in the file | 2287 | optional; when omitted, the first macro definition line in the file |
| 2288 | will be used for this phrase. The @var{phrase} is the phrase to be | 2288 | will be used for this phrase. The @var{phrase} is the phrase to be |
| 2289 | searched for when indexing. It may contain several words separated by | 2289 | searched for when indexing. It may contain several words separated by |
| 2290 | spaces. By default the search phrase is also the text entered as | 2290 | spaces. By default the search phrase is also the text entered as |
| @@ -2330,7 +2330,7 @@ and will therefore create two different index entries. | |||
| 2330 | @kindex C-c C-s | 2330 | @kindex C-c C-s |
| 2331 | Before indexing the phrases in the phrases buffer, they should be | 2331 | Before indexing the phrases in the phrases buffer, they should be |
| 2332 | checked carefully for consistency. A first step is to sort the phrases | 2332 | checked carefully for consistency. A first step is to sort the phrases |
| 2333 | alphabetically - this is done with the command @kbd{C-c C-s} | 2333 | alphabetically; this is done with the command @kbd{C-c C-s} |
| 2334 | (@code{reftex-index-sort-phrases}). It will sort all phrases in the | 2334 | (@code{reftex-index-sort-phrases}). It will sort all phrases in the |
| 2335 | buffer alphabetically by search phrase. If you want to group certain | 2335 | buffer alphabetically by search phrase. If you want to group certain |
| 2336 | phrases and only sort within the groups, insert empty lines between the | 2336 | phrases and only sort within the groups, insert empty lines between the |
| @@ -2678,7 +2678,7 @@ unique. @code{?i}, @code{?I}, and @code{?g} are reserved for the | |||
| 2678 | respectively. | 2678 | respectively. |
| 2679 | 2679 | ||
| 2680 | The following string is empty unless your macro adds a superordinate | 2680 | The following string is empty unless your macro adds a superordinate |
| 2681 | entry to the index key - this is the case for the @code{\astobj} macro. | 2681 | entry to the index key; this is the case for the @code{\astobj} macro. |
| 2682 | 2682 | ||
| 2683 | The next entry can be a hook function to exclude certain matches, it | 2683 | The next entry can be a hook function to exclude certain matches, it |
| 2684 | almost always can be @code{nil}. | 2684 | almost always can be @code{nil}. |
| @@ -3740,8 +3740,8 @@ library which is part of @AUCTeX{}, the string is first processed with the | |||
| 3740 | @deffn Command reftex-index-phrase-selection-or-word | 3740 | @deffn Command reftex-index-phrase-selection-or-word |
| 3741 | Add current selection or the word at point to the phrases buffer. | 3741 | Add current selection or the word at point to the phrases buffer. |
| 3742 | When you are in transient-mark-mode and the region is active, the | 3742 | When you are in transient-mark-mode and the region is active, the |
| 3743 | selection will be used - otherwise the word at point. | 3743 | selection will be used; otherwise the word at point. |
| 3744 | You get a chance to edit the entry in the phrases buffer - to save the | 3744 | You get a chance to edit the entry in the phrases buffer; to save the |
| 3745 | buffer and return to the @LaTeX{} document, finish with @kbd{C-c C-c}. | 3745 | buffer and return to the @LaTeX{} document, finish with @kbd{C-c C-c}. |
| 3746 | @end deffn | 3746 | @end deffn |
| 3747 | 3747 | ||
| @@ -3881,7 +3881,7 @@ removes the parse file associated with the current document. | |||
| 3881 | @cindex Options, list of | 3881 | @cindex Options, list of |
| 3882 | 3882 | ||
| 3883 | Here is a complete list of @RefTeX{}'s configuration variables. All | 3883 | Here is a complete list of @RefTeX{}'s configuration variables. All |
| 3884 | variables have customize support - so if you are not familiar with Emacs | 3884 | variables have customize support, so if you are not familiar with Emacs |
| 3885 | Lisp (and even if you are) you might find it more comfortable to use | 3885 | Lisp (and even if you are) you might find it more comfortable to use |
| 3886 | @code{customize} to look at and change these variables. @kbd{M-x | 3886 | @code{customize} to look at and change these variables. @kbd{M-x |
| 3887 | reftex-customize} will get you there. | 3887 | reftex-customize} will get you there. |
| @@ -4061,7 +4061,7 @@ Name of the environment (like @samp{table}) or macro (like | |||
| 4061 | @samp{\myfig}). For macros, indicate the arguments, as in | 4061 | @samp{\myfig}). For macros, indicate the arguments, as in |
| 4062 | @samp{\myfig[]@{@}@{@}@{*@}@{@}}. Use square brackets for optional | 4062 | @samp{\myfig[]@{@}@{@}@{*@}@{@}}. Use square brackets for optional |
| 4063 | arguments, a star to mark the label argument, if any. The macro does | 4063 | arguments, a star to mark the label argument, if any. The macro does |
| 4064 | not have to have a label argument - you could also use | 4064 | not have to have a label argument; you could also use |
| 4065 | @samp{\label@{...@}} inside one of its arguments. | 4065 | @samp{\label@{...@}} inside one of its arguments. |
| 4066 | 4066 | ||
| 4067 | Special names: @code{section} for section labels, @code{any} to define a | 4067 | Special names: @code{section} for section labels, @code{any} to define a |
| @@ -4215,7 +4215,7 @@ names like @samp{chapter}, integer section levels (as given in | |||
| 4215 | @defopt reftex-default-context-regexps | 4215 | @defopt reftex-default-context-regexps |
| 4216 | Alist with default regular expressions for finding context. The emacs | 4216 | Alist with default regular expressions for finding context. The emacs |
| 4217 | lisp form @w{@code{(format regexp (regexp-quote environment))}} is used | 4217 | lisp form @w{@code{(format regexp (regexp-quote environment))}} is used |
| 4218 | to calculate the final regular expression - so @samp{%s} will be | 4218 | to calculate the final regular expression, so @samp{%s} will be |
| 4219 | replaced with the environment or macro. | 4219 | replaced with the environment or macro. |
| 4220 | @end defopt | 4220 | @end defopt |
| 4221 | 4221 | ||
| @@ -4404,7 +4404,7 @@ The available label types are: @code{s} (section), @code{f} (figure), | |||
| 4404 | @code{t} (table), @code{i} (item), @code{e} (equation), @code{n} | 4404 | @code{t} (table), @code{i} (item), @code{e} (equation), @code{n} |
| 4405 | (footnote), plus any definitions in @code{reftex-label-alist}. | 4405 | (footnote), plus any definitions in @code{reftex-label-alist}. |
| 4406 | 4406 | ||
| 4407 | Most options can also be switched from the label menu itself - so if you | 4407 | Most options can also be switched from the label menu itself, so if you |
| 4408 | decide here to not have a table of contents in the label menu, you can | 4408 | decide here to not have a table of contents in the label menu, you can |
| 4409 | still get one interactively during selection from the label menu. | 4409 | still get one interactively during selection from the label menu. |
| 4410 | @end defopt | 4410 | @end defopt |
| @@ -4462,7 +4462,7 @@ Non-@code{nil} means, @code{reftex-reference} will try to guess the | |||
| 4462 | label type. To do that, @RefTeX{} will look at the word before the | 4462 | label type. To do that, @RefTeX{} will look at the word before the |
| 4463 | cursor and compare it with the magic words given in | 4463 | cursor and compare it with the magic words given in |
| 4464 | @code{reftex-label-alist}. When it finds a match, @RefTeX{} will | 4464 | @code{reftex-label-alist}. When it finds a match, @RefTeX{} will |
| 4465 | immediately offer the correct label menu - otherwise it will prompt you | 4465 | immediately offer the correct label menu; otherwise it will prompt you |
| 4466 | for a label type. If you set this variable to @code{nil}, @RefTeX{} | 4466 | for a label type. If you set this variable to @code{nil}, @RefTeX{} |
| 4467 | will always prompt for a label type. | 4467 | will always prompt for a label type. |
| 4468 | @end defopt | 4468 | @end defopt |
| @@ -4726,11 +4726,11 @@ The final entry may also be a symbol. It must have an association in | |||
| 4726 | the variable @code{reftex-index-macros-builtin} to specify the main | 4726 | the variable @code{reftex-index-macros-builtin} to specify the main |
| 4727 | indexing package you are using. Valid values are currently | 4727 | indexing package you are using. Valid values are currently |
| 4728 | @example | 4728 | @example |
| 4729 | default @r{The @LaTeX{} default - unnecessary to specify this one} | 4729 | default @r{The @LaTeX{} default; unnecessary to specify this one} |
| 4730 | multind @r{The multind.sty package} | 4730 | multind @r{The multind.sty package} |
| 4731 | index @r{The index.sty package} | 4731 | index @r{The index.sty package} |
| 4732 | index-shortcut @r{The index.sty packages with the ^ and _ shortcuts.} | 4732 | index-shortcut @r{The index.sty packages with the ^ and _ shortcuts.} |
| 4733 | @r{Should not be used - only for old documents} | 4733 | @r{Should not be used; only for old documents} |
| 4734 | @end example | 4734 | @end example |
| 4735 | Note that @AUCTeX{} sets these things internally for @RefTeX{} as well, | 4735 | Note that @AUCTeX{} sets these things internally for @RefTeX{} as well, |
| 4736 | so with a sufficiently new version of @AUCTeX{}, you should not set the | 4736 | so with a sufficiently new version of @AUCTeX{}, you should not set the |
| @@ -4741,7 +4741,7 @@ package here. | |||
| 4741 | The default index macro for @code{reftex-index-selection-or-word}. | 4741 | The default index macro for @code{reftex-index-selection-or-word}. |
| 4742 | This is a list with @code{(@var{macro-key} @var{default-tag})}. | 4742 | This is a list with @code{(@var{macro-key} @var{default-tag})}. |
| 4743 | 4743 | ||
| 4744 | @var{macro-key} is a character identifying an index macro - see | 4744 | @var{macro-key} is a character identifying an index macro; see |
| 4745 | @code{reftex-index-macros}. | 4745 | @code{reftex-index-macros}. |
| 4746 | 4746 | ||
| 4747 | @var{default-tag} is the tag to be used if the macro requires a | 4747 | @var{default-tag} is the tag to be used if the macro requires a |
| @@ -4829,7 +4829,7 @@ case, that match will be ignored. | |||
| 4829 | 4829 | ||
| 4830 | @defopt reftex-index-phrases-wrap-long-lines | 4830 | @defopt reftex-index-phrases-wrap-long-lines |
| 4831 | Non-@code{nil} means, when indexing from the phrases buffer, wrap lines. | 4831 | Non-@code{nil} means, when indexing from the phrases buffer, wrap lines. |
| 4832 | Inserting indexing commands in a line makes the line longer - often | 4832 | Inserting indexing commands in a line makes the line longer, often |
| 4833 | so long that it does not fit onto the screen. When this variable is | 4833 | so long that it does not fit onto the screen. When this variable is |
| 4834 | non-@code{nil}, newlines will be added as necessary before and/or after the | 4834 | non-@code{nil}, newlines will be added as necessary before and/or after the |
| 4835 | indexing command to keep lines short. However, the matched text | 4835 | indexing command to keep lines short. However, the matched text |
| @@ -5007,7 +5007,7 @@ Non-@code{nil} means, search all specified directories before trying | |||
| 5007 | recursion. Thus, in a path @samp{.//:/tex/}, search first @samp{./}, | 5007 | recursion. Thus, in a path @samp{.//:/tex/}, search first @samp{./}, |
| 5008 | then @samp{/tex/}, and then all subdirectories of @samp{./}. If this | 5008 | then @samp{/tex/}, and then all subdirectories of @samp{./}. If this |
| 5009 | option is @code{nil}, the subdirectories of @samp{./} are searched | 5009 | option is @code{nil}, the subdirectories of @samp{./} are searched |
| 5010 | before @samp{/tex/}. This is mainly for speed - most of the time the | 5010 | before @samp{/tex/}. This is mainly for speed; most of the time the |
| 5011 | recursive path is for the system files and not for the user files. Set | 5011 | recursive path is for the system files and not for the user files. Set |
| 5012 | this to @code{nil} if the default makes @RefTeX{} finding files with | 5012 | this to @code{nil} if the default makes @RefTeX{} finding files with |
| 5013 | equal names in wrong sequence. | 5013 | equal names in wrong sequence. |
| @@ -5128,7 +5128,7 @@ cannot be placed with certainty into the internal label list. | |||
| 5128 | @defopt reftex-use-multiple-selection-buffers | 5128 | @defopt reftex-use-multiple-selection-buffers |
| 5129 | Non-@code{nil} means use a separate selection buffer for each label | 5129 | Non-@code{nil} means use a separate selection buffer for each label |
| 5130 | type. These buffers are kept from one selection to the next and need | 5130 | type. These buffers are kept from one selection to the next and need |
| 5131 | not to be created for each use - so the menu generally comes up faster. | 5131 | not be created for each use, so the menu generally comes up faster. |
| 5132 | The selection buffers will be erased (and therefore updated) | 5132 | The selection buffers will be erased (and therefore updated) |
| 5133 | automatically when new labels in its category are added. See the | 5133 | automatically when new labels in its category are added. See the |
| 5134 | variable @code{reftex-auto-update-selection-buffers}. | 5134 | variable @code{reftex-auto-update-selection-buffers}. |