7 |
@syncodeindex fn cp |
@syncodeindex fn cp |
8 |
|
|
9 |
@c Version and Contact Info |
@c Version and Contact Info |
10 |
@set VERSION 4.28 |
@set VERSION 4.30 |
11 |
@set EDITION 4.28 |
@set EDITION 4.30 |
12 |
@set DATE May 2005 |
@set DATE September 2005 |
13 |
@set AUCTEXSITE @uref{http://www.nongnu.org/auctex/,AUCTeX distribution site} |
@set AUCTEXSITE @uref{http://www.nongnu.org/auctex/,AUCTeX distribution site} |
14 |
@set MAINTAINERSITE @uref{http://www.astro.uva.nl/~dominik/Tools/,maintainers webpage} |
@set MAINTAINERSITE @uref{http://www.astro.uva.nl/~dominik/Tools/,maintainers webpage} |
15 |
@set MAINTAINER Carsten Dominik |
@set MAINTAINER Carsten Dominik |
25 |
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 |
26 |
@b{Ref@TeX{}} @value{VERSION} |
@b{Ref@TeX{}} @value{VERSION} |
27 |
|
|
28 |
Copyright (C) 1997, 1998, 1999, 2000, 2001, 2002, 2004, |
Copyright (c) 1997, 1998, 1999, 2000, 2001, 2002, 2004, 2005 Free Software Foundation, Inc. |
|
2005 Free Software Foundation, Inc. |
|
29 |
|
|
30 |
@quotation |
@quotation |
31 |
Permission is granted to copy, distribute and/or modify this document |
Permission is granted to copy, distribute and/or modify this document |
153 |
* Citation Info:: View the corresponding database entry. |
* Citation Info:: View the corresponding database entry. |
154 |
* Chapterbib and Bibunits:: Multiple bibliographies in a Document. |
* Chapterbib and Bibunits:: Multiple bibliographies in a Document. |
155 |
* Citations Outside LaTeX:: How to make citations in Emails etc. |
* Citations Outside LaTeX:: How to make citations in Emails etc. |
156 |
* BibTeX Database Subsets:: Extract parts of a big database. |
* BibTeX Database Subsets:: Extract parts of a big database. |
157 |
|
|
158 |
Index Support |
Index Support |
159 |
|
|
1668 |
* Citation Info:: View the corresponding database entry. |
* Citation Info:: View the corresponding database entry. |
1669 |
* Chapterbib and Bibunits:: Multiple bibliographies in a Document. |
* Chapterbib and Bibunits:: Multiple bibliographies in a Document. |
1670 |
* Citations Outside LaTeX:: How to make citations in Emails etc. |
* Citations Outside LaTeX:: How to make citations in Emails etc. |
1671 |
* BibTeX Database Subsets:: Extract parts of a big database. |
* BibTeX Database Subsets:: Extract parts of a big database. |
1672 |
@end menu |
@end menu |
1673 |
|
|
1674 |
@node Creating Citations, Citation Styles, , Citations |
@node Creating Citations, Citation Styles, , Citations |
1772 |
@item e |
@item e |
1773 |
Create a new BibTeX database file which contains all @i{marked} entries |
Create a new BibTeX database file which contains all @i{marked} entries |
1774 |
in the selection buffer. If no entries are marked, all entries are |
in the selection buffer. If no entries are marked, all entries are |
1775 |
selected. |
selected. |
1776 |
|
|
1777 |
@item E |
@item E |
1778 |
Create a new BibTeX database file which contains all @i{unmarked} |
Create a new BibTeX database file which contains all @i{unmarked} |
1779 |
entries in the selection buffer. If no entries are marked, all entries |
entries in the selection buffer. If no entries are marked, all entries |
1780 |
are selected. |
are selected. |
1781 |
|
|
1782 |
@item @key{TAB} |
@item @key{TAB} |
1783 |
Enter a citation key with completion. This may also be a key which does |
Enter a citation key with completion. This may also be a key which does |
3211 |
|
|
3212 |
Before calling a @b{Ref@TeX{}} function, the style hook should always |
Before calling a @b{Ref@TeX{}} function, the style hook should always |
3213 |
test for the availability of the function, so that the style file will |
test for the availability of the function, so that the style file will |
3214 |
also work for people who do not use @b{Ref@TeX{}}. |
also work for people who do not use @b{Ref@TeX{}}. |
3215 |
|
|
3216 |
Additions made with style files in the way described below remain local |
Additions made with style files in the way described below remain local |
3217 |
to the current document. For example, if one package uses AMSTeX, the |
to the current document. For example, if one package uses AMSTeX, the |
3492 |
|
|
3493 |
@b{Ref@TeX{}} was written by @i{Carsten Dominik} |
@b{Ref@TeX{}} was written by @i{Carsten Dominik} |
3494 |
@email{dominik@@science.uva.nl}, with contributions by @i{Stephen |
@email{dominik@@science.uva.nl}, with contributions by @i{Stephen |
3495 |
Eglen}. @b{Ref@TeX{}} is currently maintained by |
Eglen}. @b{Ref@TeX{}} is currently maintained by |
3496 |
|
|
3497 |
@noindent |
@noindent |
3498 |
Carsten Dominik <dominik@@science.uva.nl> |
Carsten Dominik <dominik@@science.uva.nl> |
3712 |
Create a new BibTeX database file with all entries referenced in document. |
Create a new BibTeX database file with all entries referenced in document. |
3713 |
The command prompts for a filename and writes the collected entries to |
The command prompts for a filename and writes the collected entries to |
3714 |
that file. Only entries referenced in the current document with |
that file. Only entries referenced in the current document with |
3715 |
any @code{\cite}-like macros are used. |
any @code{\cite}-like macros are used. |
3716 |
The sequence in the new file is the same as it was in the old database. |
The sequence in the new file is the same as it was in the old database. |
3717 |
@end deffn |
@end deffn |
3718 |
|
|
3817 |
ordinary TOC window), the automatic recentering is turned on. When the |
ordinary TOC window), the automatic recentering is turned on. When the |
3818 |
frame gets destroyed, automatic recentering is turned off again. |
frame gets destroyed, automatic recentering is turned off again. |
3819 |
|
|
3820 |
This feature can be turned on and off from the menu |
This feature can be turned on and off from the menu |
3821 |
(Ref->Options). |
(Ref->Options). |
3822 |
@end defopt |
@end defopt |
3823 |
|
|
3927 |
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 |
3928 |
in a non-standard label environment. The function must take an |
in a non-standard label environment. The function must take an |
3929 |
argument @var{bound} and limit backward searches to this value. It |
argument @var{bound} and limit backward searches to this value. It |
3930 |
should return either @code{nil} or a cons cell @code{(@var{function} |
should return either nil or a cons cell @code{(@var{function} |
3931 |
. @var{position})} with the function symbol and the position where the |
. @var{position})} with the function symbol and the position where the |
3932 |
special environment starts. See the Info documentation for an |
special environment starts. See the Info documentation for an |
3933 |
example. |
example. |
4084 |
default does parse around each label to detect the correct label type, |
default does parse around each label to detect the correct label type, |
4085 |
but this process can be slow when a document contains thousands of |
but this process can be slow when a document contains thousands of |
4086 |
labels. If you use label prefixes consistently, you may speed up |
labels. If you use label prefixes consistently, you may speed up |
4087 |
document parsing by setting this variable to a non-@code{nil} value. RefTeX |
document parsing by setting this variable to a non-nil value. RefTeX |
4088 |
will then compare the label prefix with the prefixes found in |
will then compare the label prefix with the prefixes found in |
4089 |
`reftex-label-alist' and derive the correct label type in this way. |
`reftex-label-alist' and derive the correct label type in this way. |
4090 |
Possible values for this option are: |
Possible values for this option are: |
4093 |
t @r{This means to trust any label prefixes found.} |
t @r{This means to trust any label prefixes found.} |
4094 |
regexp @r{If a regexp, only prefixes matched by the regexp are trusted.} |
regexp @r{If a regexp, only prefixes matched by the regexp are trusted.} |
4095 |
list @r{List of accepted prefixes, as strings. The colon is part of} |
list @r{List of accepted prefixes, as strings. The colon is part of} |
4096 |
@r{the prefix, e.g. ("fn:" "eqn:" "item:").} |
@r{the prefix, e.g. ("fn:" "eqn:" "item:").} |
4097 |
nil @r{Never trust a label prefix.} |
nil @r{Never trust a label prefix.} |
4098 |
@end example |
@end example |
4099 |
The only disadvantage of using this feature is that the label context |
The only disadvantage of using this feature is that the label context |
4649 |
|
|
4650 |
@defopt reftex-index-verify-function |
@defopt reftex-index-verify-function |
4651 |
A function which is called at each match during global indexing. |
A function which is called at each match during global indexing. |
4652 |
If the function returns @code{nil}, the current match is skipped. |
If the function returns nil, the current match is skipped. |
4653 |
@end defopt |
@end defopt |
4654 |
|
|
4655 |
@defopt reftex-index-phrases-skip-indexed-matches |
@defopt reftex-index-phrases-skip-indexed-matches |
4769 |
|
|
4770 |
@defopt reftex-revisit-to-echo |
@defopt reftex-revisit-to-echo |
4771 |
Non-@code{nil} means, automatic citation display will revisit files if |
Non-@code{nil} means, automatic citation display will revisit files if |
4772 |
necessary. When @code{nil}, citation display in echo area will only |
necessary. When nil, citation display in echo area will only be active |
4773 |
be active for cached echo strings (see @code{reftex-cache-cite-echo}), |
for cached echo strings (see @code{reftex-cache-cite-echo}), or for |
4774 |
or for BibTeX database files which are already visited by a live |
BibTeX database files which are already visited by a live associated |
4775 |
associated buffers. |
buffers. |
4776 |
@end defopt |
@end defopt |
4777 |
|
|
4778 |
@defopt reftex-cache-cite-echo |
@defopt reftex-cache-cite-echo |
5113 |
|
|
5114 |
@defopt reftex-revisit-to-follow |
@defopt reftex-revisit-to-follow |
5115 |
Non-@code{nil} means, follow-mode will revisit files if necessary. |
Non-@code{nil} means, follow-mode will revisit files if necessary. |
5116 |
When @code{nil}, follow-mode will be suspended for stuff in unvisited files. |
When nil, follow-mode will be suspended for stuff in unvisited files. |
5117 |
@end defopt |
@end defopt |
5118 |
|
|
5119 |
@defopt reftex-allow-detached-macro-args |
@defopt reftex-allow-detached-macro-args |
5177 |
|
|
5178 |
@noindent @b{Version 4.24} |
@noindent @b{Version 4.24} |
5179 |
@itemize @bullet |
@itemize @bullet |
5180 |
@item |
@item |
5181 |
Inserting citation commands now prompts for optional arguments |
Inserting citation commands now prompts for optional arguments |
5182 |
when called with a prefix argument. Related new options are |
when called with a prefix argument. Related new options are |
5183 |
@code{reftex-cite-prompt-optional-args} and |
@code{reftex-cite-prompt-optional-args} and |
5184 |
@code{reftex-cite-cleanup-optional-args}. |
@code{reftex-cite-cleanup-optional-args}. |
5185 |
@item |
@item |
5186 |
New option @code{reftex-trust-label-prefix}. Configure this variable |
New option @code{reftex-trust-label-prefix}. Configure this variable |
5187 |
if you'd like RefTeX to base its classification of labels on prefixes. |
if you'd like RefTeX to base its classification of labels on prefixes. |
5189 |
quality of the context used by RefTeX to describe a label. |
quality of the context used by RefTeX to describe a label. |
5190 |
@item |
@item |
5191 |
Fixed bug in @code{reftex-create-bibtex-file} when @code{reftex-comment-citations} |
Fixed bug in @code{reftex-create-bibtex-file} when @code{reftex-comment-citations} |
5192 |
is non-@code{nil}. |
is non-nil. |
5193 |
@item |
@item |
5194 |
Fixed bugs in indexing: Case-sensitive search, quotes before and/or |
Fixed bugs in indexing: Case-sensitive search, quotes before and/or |
5195 |
after words. Disabbled indexing in comment lines. |
after words. Disabbled indexing in comment lines. |
5197 |
|
|
5198 |
@noindent @b{Version 4.22} |
@noindent @b{Version 4.22} |
5199 |
@itemize @bullet |
@itemize @bullet |
5200 |
@item |
@item |
5201 |
New command @code{reftex-create-bibtex-file} to create a new database |
New command @code{reftex-create-bibtex-file} to create a new database |
5202 |
with all entries referenced in the current document. |
with all entries referenced in the current document. |
5203 |
@item |
@item |
5207 |
|
|
5208 |
@noindent @b{Version 4.21} |
@noindent @b{Version 4.21} |
5209 |
@itemize @bullet |
@itemize @bullet |
5210 |
@item |
@item |
5211 |
Renaming labels from the toc buffer with key @kbd{M-%}. |
Renaming labels from the toc buffer with key @kbd{M-%}. |
5212 |
@end itemize |
@end itemize |
5213 |
|
|
5423 |
document, all labels and associated context. New keys @kbd{i}, @kbd{l}, |
document, all labels and associated context. New keys @kbd{i}, @kbd{l}, |
5424 |
and @kbd{c}. New options @code{reftex-toc-include-labels}, |
and @kbd{c}. New options @code{reftex-toc-include-labels}, |
5425 |
@code{reftex-toc-include-context}, |
@code{reftex-toc-include-context}, |
5426 |
@code{reftex-toc-include-file-boundaries}. |
@code{reftex-toc-include-file-boundaries}. |
5427 |
@end itemize |
@end itemize |
5428 |
|
|
5429 |
@noindent @b{Version 3.41} |
@noindent @b{Version 3.41} |
5536 |
@kbd{M-x reftex-reset-mode} now also removes the file with parsing |
@kbd{M-x reftex-reset-mode} now also removes the file with parsing |
5537 |
info. |
info. |
5538 |
@item |
@item |
5539 |
Default of @code{reftex-revisit-to-follow} changed to @code{nil}. |
Default of @code{reftex-revisit-to-follow} changed to nil. |
5540 |
@end itemize |
@end itemize |
5541 |
|
|
5542 |
@noindent @b{Version 3.24} |
@noindent @b{Version 3.24} |