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.16 |
@set VERSION 4.18 |
13 |
@set EDITION 4.16 |
@set EDITION 4.18 |
14 |
@set DATE June 2001 |
@set DATE July 2002 |
|
@set AUTHOR Carsten Dominik |
|
|
@set AUTHOR-EMAIL dominik@@astro.uva.nl |
|
|
@set MAINTAINER Carsten Dominik |
|
|
@set MAINTAINER-EMAIL dominik@@astro.uva.nl |
|
15 |
@c %**end of header |
@c %**end of header |
16 |
@finalout |
@finalout |
17 |
|
|
34 |
This is edition @value{EDITION} of the @b{Ref@TeX{}} User Manual for |
This is edition @value{EDITION} of the @b{Ref@TeX{}} User Manual for |
35 |
@b{Ref@TeX{}} @value{VERSION}@refill |
@b{Ref@TeX{}} @value{VERSION}@refill |
36 |
|
|
37 |
Copyright (c) 1997, 1998, 1999, 2000 2001 Free Software Foundation, Inc. |
Copyright (c) 1997, 1998, 1999, 2000, 2001, 2002 Free Software Foundation, Inc. |
38 |
|
|
39 |
Permission is granted to copy, distribute and/or modify this document |
Permission is granted to copy, distribute and/or modify this document |
40 |
under the terms of the GNU Free Documentation License, Version 1.1 or |
under the terms of the GNU Free Documentation License, Version 1.1 or |
61 |
|
|
62 |
@author by Carsten Dominik |
@author by Carsten Dominik |
63 |
@page |
@page |
64 |
Copyright @copyright{} 1997, 1998, 1999, 2000, 2001 Free Software Foundation, Inc. |
Copyright @copyright{} 1997, 1998, 1999, 2000, 2001, 2002 Free Software Foundation, Inc. |
65 |
|
|
66 |
@sp 2 |
@sp 2 |
67 |
This is edition @value{EDITION} of the @cite{Ref@TeX{} User Manual} for |
This is edition @value{EDITION} of the @cite{Ref@TeX{} User Manual} for |
1131 |
@noindent |
@noindent |
1132 |
The labels for Axioms and Theorems will have the prefixes @samp{ax:} and |
The labels for Axioms and Theorems will have the prefixes @samp{ax:} and |
1133 |
@samp{thr:}, respectively. @xref{AUCTeX}, for information on how |
@samp{thr:}, respectively. @xref{AUCTeX}, for information on how |
1134 |
AUCTeX can use @b{Ref@TeX{}} to automatically create labels when a new |
AUCTeX can use RefTeX to automatically create labels when a new environment |
1135 |
environment is inserted into a buffer.@refill |
is inserted into a buffer. Additionally, the following needs to be |
1136 |
|
added to one's .emacs file before AUCTeX will automatically create |
1137 |
|
labels for the new environments. |
1138 |
|
|
1139 |
|
@lisp |
1140 |
|
(add-hook 'LaTeX-mode-hook |
1141 |
|
(lambda () |
1142 |
|
(LaTeX-add-environments |
1143 |
|
'("axiom" LaTeX-env-label) |
1144 |
|
'("theorem" LaTeX-env-label)))) |
1145 |
|
@end lisp |
1146 |
|
|
1147 |
|
|
1148 |
@noindent |
@noindent |
1149 |
The @samp{~\ref@{%s@}} is a format string indicating how to insert |
The @samp{~\ref@{%s@}} is a format string indicating how to insert |
1632 |
@samp{Einstein&&Bose} will match all articles which mention |
@samp{Einstein&&Bose} will match all articles which mention |
1633 |
Bose-Einstein condensation, or which are co-authored by Bose and |
Bose-Einstein condensation, or which are co-authored by Bose and |
1634 |
Einstein. When entering the regular expression, you can complete on |
Einstein. When entering the regular expression, you can complete on |
1635 |
known citation keys.@refill |
known citation keys. RefTeX also offeres a default when prompting for a |
1636 |
|
regular expression. This default is the word before the cursor or the |
1637 |
|
word before the current @samp{\cite} comand. Sometimes this may be a |
1638 |
|
good search key.@refill |
1639 |
|
|
1640 |
@cindex @code{\bibliography} |
@cindex @code{\bibliography} |
1641 |
@cindex @code{thebibliography}, LaTeX environment |
@cindex @code{thebibliography}, LaTeX environment |
2819 |
@end lisp |
@end lisp |
2820 |
@end itemize |
@end itemize |
2821 |
|
|
2822 |
|
@cindex Noweb files |
2823 |
|
@vindex reftex-file-extensions |
2824 |
|
@vindex TeX-file-extensions |
2825 |
|
Some people like to use RefTeX with noweb files, which usually have the |
2826 |
|
extension @file{.nw}. In order to deal with such files, the new |
2827 |
|
extension must be added to the list of valid extensions in the variable |
2828 |
|
@code{reftex-file-extensions}. When working with AUCTeX as major mode, |
2829 |
|
the new extension must also be known to AUCTeX via the variable |
2830 |
|
@code{TeX-file-extension}. For example: |
2831 |
|
|
2832 |
|
@lisp |
2833 |
|
(setq reftex-file-extensions |
2834 |
|
'(("nw" "tex" ".tex" ".ltx") ("bib" ".bib"))) |
2835 |
|
(setq TeX-file-extensions |
2836 |
|
'( "nw" "tex" "sty" "cls" "ltx" "texi" "texinfo")) |
2837 |
|
@end lisp |
2838 |
|
|
2839 |
@node Optimizations, Problems and Work-Arounds, Finding Files, Top |
@node Optimizations, Problems and Work-Arounds, Finding Files, Top |
2840 |
@section Optimizations |
@section Optimizations |
2841 |
@cindex Optimizations |
@cindex Optimizations |
2965 |
@end group |
@end group |
2966 |
@end lisp |
@end lisp |
2967 |
|
|
|
@page |
|
2968 |
@node AUCTeX, Multifile Documents, Faces, Top |
@node AUCTeX, Multifile Documents, Faces, Top |
2969 |
@section @w{AUC @TeX{}} |
@section @w{AUC @TeX{}} |
2970 |
@cindex @code{AUCTeX}, Emacs package |
@cindex @code{AUCTeX}, Emacs package |
2972 |
|
|
2973 |
AUCTeX is without doubt the best major mode for editing TeX and LaTeX |
AUCTeX is without doubt the best major mode for editing TeX and LaTeX |
2974 |
files with Emacs (@pxref{Top,AUCTeX,,auctex, The AUCTeX User Manual}). |
files with Emacs (@pxref{Top,AUCTeX,,auctex, The AUCTeX User Manual}). |
2975 |
If AUCTeX is not part of you Emacs distribution, you can get |
If AUCTeX is not part of your Emacs distribution, you can get |
2976 |
it@footnote{XEmacs 21.x users may want to install the corresponding |
it@footnote{XEmacs 21.x users may want to install the corresponding |
2977 |
XEmacs package.} by ftp from the |
XEmacs package.} by ftp from the |
2978 |
@uref{http://www.sunsite.auc.dk/auctex/,AUCTeX distribution site}. |
@uref{http://www.sunsite.auc.dk/auctex/,AUCTeX distribution site}. |
3223 |
@item |
@item |
3224 |
@b{LaTeX commands}@* |
@b{LaTeX commands}@* |
3225 |
@cindex LaTeX commands, not found |
@cindex LaTeX commands, not found |
3226 |
@code{\input}, @code{\include}, @code{\bibliography} and @code{\section} |
@code{\input}, @code{\include}, and @code{\section} (etc.) statements |
3227 |
(etc.) statements have to be first on a line (except for white space).@refill |
have to be first on a line (except for white space).@refill |
3228 |
|
|
3229 |
@item |
@item |
3230 |
@b{Commented regions}@* |
@b{Commented regions}@* |
3361 |
@cindex @code{http}, @b{Ref@TeX{}} home page |
@cindex @code{http}, @b{Ref@TeX{}} home page |
3362 |
@cindex @code{ftp}, @b{Ref@TeX{}} site |
@cindex @code{ftp}, @b{Ref@TeX{}} site |
3363 |
|
|
3364 |
@b{Ref@TeX{}} was written by @i{@value{AUTHOR}} |
@b{Ref@TeX{}} was written by @i{@value{Carsten Dominik}} |
3365 |
@email{@value{AUTHOR-EMAIL}}, with contributions by @i{Stephen |
@email{dominik@@science.uva.nl}, with contributions by @i{Stephen |
3366 |
Eglen}. @b{Ref@TeX{}} is currently maintained by @refill |
Eglen}. @b{Ref@TeX{}} is currently maintained by @refill |
3367 |
|
|
3368 |
@noindent |
@noindent |
3369 |
@value{MAINTAINER} @email{@value{MAINTAINER-EMAIL}} |
@value{Carsten Dominik} @email{dominik@@science.uva.nl} |
3370 |
|
|
3371 |
If you have questions about @b{Ref@TeX{}}, there are several Usenet |
If you have questions about @b{Ref@TeX{}}, there are several Usenet |
3372 |
groups which have competent readers: @code{comp.emacs}, |
groups which have competent readers: @code{comp.emacs}, |
3375 |
|
|
3376 |
If you find a bug in @b{Ref@TeX{}} or its documentation, or if you want |
If you find a bug in @b{Ref@TeX{}} or its documentation, or if you want |
3377 |
to contribute code or ideas, please |
to contribute code or ideas, please |
3378 |
@uref{mailto:@value{MAINTAINER-EMAIL},contact the maintainer}. Remember |
@uref{mailto:dominik@@science.uva.nl,contact the maintainer}. Remember |
3379 |
to provide all necessary information such as version numbers of Emacs |
to provide all necessary information such as version numbers of Emacs |
3380 |
and @b{Ref@TeX{}}, and the relevant part of your configuration in |
and @b{Ref@TeX{}}, and the relevant part of your configuration in |
3381 |
@file{.emacs}. When reporting a bug which throws an exception, please |
@file{.emacs}. When reporting a bug which throws an exception, please |
3395 |
|
|
3396 |
Thanks to the people on the Net who have used @b{Ref@TeX{}} and helped |
Thanks to the people on the Net who have used @b{Ref@TeX{}} and helped |
3397 |
developing it with their reports. In particular thanks to @i{Fran |
developing it with their reports. In particular thanks to @i{Fran |
3398 |
Burstall, Alastair Burt, Soren Dayton, Stephen Eglen, Karl Eichwalder, |
Burstall, Alastair Burt, Lars Clausen, Soren Dayton, Stephen Eglen, Karl |
3399 |
Erik Frik, Peter Galbraith, Kai Grossjohann, Frank Harrell, Dieter |
Eichwalder, Erik Frik, Erik Frisk, Peter Galbraith, Kai Grossjohann, |
3400 |
Kraft, Adrian Lanz, Rory Molinari, Stefan Monnier, Laurent Mugnier, |
Frank Harrell, Stephan Heuel, Alan Ho, Dieter Kraft, Adrian Lanz, Rory |
3401 |
Sudeep Kumar Palat, Daniel Polani, Robin Socha, Richard Stanton, Allan |
Molinari, Stefan Monnier, Laurent Mugnier, Sudeep Kumar Palat, Daniel |
3402 |
Strand, Jan Vroonhof, Christoph Wedler, Alan Williams}.@refill |
Polani, Alan Shutko, Robin Socha, Richard Stanton, Allan Strand, Jan |
3403 |
|
Vroonhof, Christoph Wedler, Alan Williams, Roland Winkler, Eli |
3404 |
|
Zaretskii}.@refill |
3405 |
|
|
3406 |
The @code{view-crossref} feature was inspired by @i{Peter Galbraith's} |
The @code{view-crossref} feature was inspired by @i{Peter Galbraith's} |
3407 |
@file{bib-cite.el}.@refill |
@file{bib-cite.el}.@refill |
3515 |
View location in a LaTeX document which cites the BibTeX entry at point. |
View location in a LaTeX document which cites the BibTeX entry at point. |
3516 |
Since BibTeX files can be used by many LaTeX documents, this function |
Since BibTeX files can be used by many LaTeX documents, this function |
3517 |
prompts upon first use for a buffer in @b{Ref@TeX{}} mode. To reset this |
prompts upon first use for a buffer in @b{Ref@TeX{}} mode. To reset this |
3518 |
link to a document, call the function with with a prefix arg. Calling |
link to a document, call the function with a prefix arg. Calling |
3519 |
this function several times find successive citation locations. |
this function several times find successive citation locations. |
3520 |
@end deffn |
@end deffn |
3521 |
|
|
3611 |
@cindex Options, table of contents |
@cindex Options, table of contents |
3612 |
@cindex Table of contents, options |
@cindex Table of contents, options |
3613 |
|
|
3614 |
|
@defopt reftex-include-file-commands |
3615 |
|
List of LaTeX commands which input another file. |
3616 |
|
The file name is expected after the command, either in braces or separated |
3617 |
|
by whitespace. |
3618 |
|
@end defopt |
3619 |
|
|
3620 |
|
@defopt reftex-max-section-depth |
3621 |
|
Maximum depth of section levels in document structure. |
3622 |
|
Standard LaTeX needs 7, default is 12. |
3623 |
|
@end defopt |
3624 |
|
|
3625 |
|
@defopt reftex-section-levels |
3626 |
|
Commands and levels used for defining sections in the document. The |
3627 |
|
@code{car} of each cons cell is the name of the section macro. The |
3628 |
|
@code{cdr} is a number indicating its level. A negative level means the |
3629 |
|
same as the positive value, but the section will never get a |
3630 |
|
number. The @code{cdr} may also be a function which then has to return |
3631 |
|
the level.@refill |
3632 |
|
@end defopt |
3633 |
|
|
3634 |
@defopt reftex-toc-max-level |
@defopt reftex-toc-max-level |
3635 |
The maximum level of toc entries which will be included in the TOC. |
The maximum level of toc entries which will be included in the TOC. |
3636 |
Section headings with a bigger level will be ignored. In RefTeX, |
Section headings with a bigger level will be ignored. In RefTeX, |
3638 |
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 |
3639 |
@end defopt |
@end defopt |
3640 |
|
|
3641 |
|
@defopt reftex-toc-split-windows-horizontally |
3642 |
|
Non-@code{nil} means, create TOC window by splitting window |
3643 |
|
horizontally. The default is to split vertically. |
3644 |
|
@end defopt |
3645 |
|
|
3646 |
|
@defopt reftex-toc-split-windows-horizontally-fraction |
3647 |
|
Fraction of the horizontal width of the frame to be used for TOC window. |
3648 |
|
Only relevant when @code{reftex-toc-split-windows-horizontally} is |
3649 |
|
non-@code{nil}. |
3650 |
|
@end defopt |
3651 |
|
|
3652 |
@defopt reftex-toc-keep-other-windows |
@defopt reftex-toc-keep-other-windows |
3653 |
Non-@code{nil} means, split the selected window to display the |
Non-@code{nil} means, split the selected window to display the |
3654 |
@file{*toc*} buffer. This helps to keep the window configuration, but |
@file{*toc*} buffer. This helps to keep the window configuration, but |
3744 |
group which contains all labels.@refill |
group which contains all labels.@refill |
3745 |
|
|
3746 |
This may also be a function to do local parsing and identify point to be |
This may also be a function to do local parsing and identify point to be |
3747 |
in a a non-standard label environment. The function must take an |
in a non-standard label environment. The function must take an |
3748 |
argument @var{bound} and limit backward searches to this value. It |
argument @var{bound} and limit backward searches to this value. It |
3749 |
should return either nil or a cons cell @code{(@var{function} |
should return either nil or a cons cell @code{(@var{function} |
3750 |
. @var{position})} with the function symbol and the position where the |
. @var{position})} with the function symbol and the position where the |
3876 |
with the variable @code{reftex-default-label-alist-entries}.@refill |
with the variable @code{reftex-default-label-alist-entries}.@refill |
3877 |
@end defopt |
@end defopt |
3878 |
|
|
|
@defopt reftex-max-section-depth |
|
|
Maximum depth of section levels in document structure. |
|
|
Standard LaTeX needs 7, default is 12. |
|
|
@end defopt |
|
|
|
|
|
@defopt reftex-section-levels |
|
|
Commands and levels used for defining sections in the document. The |
|
|
@code{car} of each cons cell is the name of the section macro. The |
|
|
@code{cdr} is a number indicating its level. A negative level means the |
|
|
same as the positive value, but the section will never get a |
|
|
number. The @code{cdr} may also be a function which then has to return |
|
|
the level.@refill |
|
|
@end defopt |
|
|
|
|
3879 |
@defopt reftex-section-prefixes |
@defopt reftex-section-prefixes |
3880 |
Prefixes for section labels. When the label prefix given in an entry in |
Prefixes for section labels. When the label prefix given in an entry in |
3881 |
@code{reftex-label-alist} contains @samp{%S}, this list is used to |
@code{reftex-label-alist} contains @samp{%S}, this list is used to |
4133 |
@cindex Options, creating citations |
@cindex Options, creating citations |
4134 |
@cindex Creating citations, options |
@cindex Creating citations, options |
4135 |
|
|
4136 |
|
@defopt reftex-bibliography-commands |
4137 |
|
LaTeX commands which specify the BibTeX databases to use with the document. |
4138 |
|
@end defopt |
4139 |
|
|
4140 |
@defopt reftex-bibfile-ignore-regexps |
@defopt reftex-bibfile-ignore-regexps |
4141 |
List of regular expressions to exclude files in |
List of regular expressions to exclude files in |
4142 |
@code{\\bibliography@{..@}}. File names matched by any of these regexps |
@code{\\bibliography@{..@}}. File names matched by any of these regexps |
4412 |
case.@refill |
case.@refill |
4413 |
@end defopt |
@end defopt |
4414 |
|
|
4415 |
|
@defopt reftex-index-verify-function |
4416 |
|
A function which is called at each match during global indexing. |
4417 |
|
If the function returns nil, the current match is skipped. |
4418 |
|
@end defopt |
4419 |
|
|
4420 |
@defopt reftex-index-phrases-skip-indexed-matches |
@defopt reftex-index-phrases-skip-indexed-matches |
4421 |
Non-@code{nil} means, skip matches which appear to be indexed already. |
Non-@code{nil} means, skip matches which appear to be indexed already. |
4422 |
When doing global indexing from the phrases buffer, searches for some |
When doing global indexing from the phrases buffer, searches for some |
4505 |
@end example |
@end example |
4506 |
@var{macro-re} is matched against the macro. @var{search-re} is the |
@var{macro-re} is matched against the macro. @var{search-re} is the |
4507 |
regexp used to search for cross references. @samp{%s} in this regexp is |
regexp used to search for cross references. @samp{%s} in this regexp is |
4508 |
replaced with with the macro argument at point. @var{highlight} is an |
replaced with the macro argument at point. @var{highlight} is an |
4509 |
integer indicating which subgroup of the match should be highlighted. |
integer indicating which subgroup of the match should be highlighted. |
4510 |
@end defopt |
@end defopt |
4511 |
|
|
5487 |
@noindent @b{Version 4.15} |
@noindent @b{Version 4.15} |
5488 |
@itemize @bullet |
@itemize @bullet |
5489 |
@item |
@item |
5490 |
|
Fixed bug with parsing of BibTeX files, when fields contain quotes or |
5491 |
|
unmatched parenthesis. |
5492 |
|
@item |
5493 |
Small bug fixes. |
Small bug fixes. |
5494 |
@item |
@item |
5495 |
Improved interaction with Emacs LaTeX mode. |
Improved interaction with Emacs LaTeX mode. |
5496 |
@end itemize |
@end itemize |
5497 |
|
@noindent @b{Version 4.17} |
5498 |
|
@itemize @bullet |
5499 |
|
@item |
5500 |
|
The toc window can be split off horizontally. See new options |
5501 |
|
@code{reftex-toc-split-windows-horizontally}, |
5502 |
|
@code{reftex-toc-split-windows-horizontally-fraction}. |
5503 |
|
@item |
5504 |
|
It is possible to specify a function which verifies an index match |
5505 |
|
during global indexing. See new option @code{reftex-index-verify-function}. |
5506 |
|
@item |
5507 |
|
The macros which input a file in LaTeX (like \input, \include) can |
5508 |
|
be configured. See new option @code{reftex-include-file-commands}. |
5509 |
|
@item |
5510 |
|
The macros which specify the bibliography file (like \bibliography) can |
5511 |
|
be configured. See new option @code{reftex-bibliography-commands}. |
5512 |
|
@item |
5513 |
|
The regular expression used to search for the \bibliography macro has |
5514 |
|
been relaxed to allow for @samp{@{\bibliography@{...@}@}} needed by |
5515 |
|
chapterbib. |
5516 |
|
@item |
5517 |
|
Small bug fixes. |
5518 |
|
@end itemize |
5519 |
|
@noindent @b{Version 4.18} |
5520 |
|
@itemize @bullet |
5521 |
|
@item |
5522 |
|
@code{reftex-citation} uses the word before the cursor as a default |
5523 |
|
search string. |
5524 |
|
@end itemize |
5525 |
|
|
5526 |
@node Index, , , Top |
@node Index, , , Top |
5527 |
@unnumbered Index |
@unnumbered Index |