2 |
@c %**start of header |
@c %**start of header |
3 |
@setfilename ../info/reftex |
@setfilename ../info/reftex |
4 |
@settitle RefTeX User Manual |
@settitle RefTeX User Manual |
|
@dircategory Emacs |
|
|
@direntry |
|
|
* RefTeX: (reftex). Emacs support for LaTeX cross-references and citations. |
|
|
@end direntry |
|
5 |
@synindex ky cp |
@synindex ky cp |
6 |
@syncodeindex vr cp |
@syncodeindex vr cp |
7 |
@syncodeindex fn cp |
@syncodeindex fn cp |
8 |
@set VERSION 4.16 |
@set VERSION 4.19 |
9 |
@set EDITION 4.16 |
@set EDITION 4.19 |
10 |
@set DATE June 2001 |
@set DATE August 2002 |
|
@set AUTHOR Carsten Dominik |
|
|
@set AUTHOR-EMAIL dominik@@astro.uva.nl |
|
|
@set MAINTAINER Carsten Dominik |
|
|
@set MAINTAINER-EMAIL dominik@@astro.uva.nl |
|
11 |
@c %**end of header |
@c %**end of header |
|
@finalout |
|
12 |
|
|
13 |
@c Macro definitions |
@copying |
|
|
|
|
@c Subheadings inside a table. Need a difference between info and the rest. |
|
|
@macro tablesubheading{text} |
|
|
@ifinfo |
|
|
@subsubheading \text\ |
|
|
@end ifinfo |
|
|
@ifnotinfo |
|
|
@item @b{\text\} |
|
|
@end ifnotinfo |
|
|
@end macro |
|
|
|
|
|
@ifinfo |
|
14 |
This file documents @b{Ref@TeX{}}, a package to do labels, references, |
This file documents @b{Ref@TeX{}}, a package to do labels, references, |
15 |
citations and indices for LaTeX documents with Emacs.@refill |
citations and indices for LaTeX documents with Emacs. |
16 |
|
|
17 |
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 |
18 |
@b{Ref@TeX{}} @value{VERSION}@refill |
@b{Ref@TeX{}} @value{VERSION}. |
19 |
|
|
20 |
Copyright (c) 1997, 1998, 1999, 2000 2001 Free Software Foundation, Inc. |
Copyright (c) 1997, 1998, 1999, 2000, 2001, 2002 Free Software Foundation, Inc. |
21 |
|
|
22 |
|
@quotation |
23 |
Permission is granted to copy, distribute and/or modify this document |
Permission is granted to copy, distribute and/or modify this document |
24 |
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 |
25 |
any later version published by the Free Software Foundation; with no |
any later version published by the Free Software Foundation; with no |
36 |
Documentation License. If you want to distribute this document |
Documentation License. If you want to distribute this document |
37 |
separately from the collection, you can do so by adding a copy of the |
separately from the collection, you can do so by adding a copy of the |
38 |
license to the document, as described in section 6 of the license. |
license to the document, as described in section 6 of the license. |
39 |
|
@end quotation |
40 |
|
@end copying |
41 |
|
|
42 |
|
@dircategory Emacs |
43 |
|
@direntry |
44 |
|
* RefTeX: (reftex). Emacs support for LaTeX cross-references and citations. |
45 |
|
@end direntry |
46 |
|
|
47 |
|
@finalout |
48 |
|
|
49 |
|
@c Macro definitions |
50 |
|
|
51 |
|
@c Subheadings inside a table. Need a difference between info and the rest. |
52 |
|
@macro tablesubheading{text} |
53 |
|
@ifinfo |
54 |
|
@subsubheading \text\ |
55 |
@end ifinfo |
@end ifinfo |
56 |
|
@ifnotinfo |
57 |
|
@item @b{\text\} |
58 |
|
@end ifnotinfo |
59 |
|
@end macro |
60 |
|
|
61 |
@titlepage |
@titlepage |
62 |
@title Ref@TeX{} User Manual |
@title Ref@TeX{} User Manual |
65 |
|
|
66 |
@author by Carsten Dominik |
@author by Carsten Dominik |
67 |
@page |
@page |
68 |
Copyright @copyright{} 1997, 1998, 1999, 2000, 2001 Free Software Foundation, Inc. |
@vskip 0pt plus 1filll |
69 |
|
@insertcopying |
|
@sp 2 |
|
|
This is edition @value{EDITION} of the @cite{Ref@TeX{} User Manual} for |
|
|
@b{Ref@TeX{}} version @value{VERSION}, @value{DATE}.@refill |
|
|
|
|
|
@sp 2 |
|
|
|
|
|
Permission is granted to copy, distribute and/or modify this document |
|
|
under the terms of the GNU Free Documentation License, Version 1.1 or |
|
|
any later version published by the Free Software Foundation; with no |
|
|
Invariant Sections, with the Front-Cover texts being ``A GNU |
|
|
Manual'', and with the Back-Cover Texts as in (a) below. A copy of the |
|
|
license is included in the section entitled ``GNU Free Documentation |
|
|
License'' in the Emacs manual. |
|
|
|
|
|
(a) The FSF's Back-Cover Text is: ``You have freedom to copy and modify |
|
|
this GNU Manual, like GNU software. Copies published by the Free |
|
|
Software Foundation raise funds for GNU development.'' |
|
|
|
|
|
This document is part of a collection distributed under the GNU Free |
|
|
Documentation License. If you want to distribute this document |
|
|
separately from the collection, you can do so by adding a copy of the |
|
|
license to the document, as described in section 6 of the license. |
|
70 |
@end titlepage |
@end titlepage |
|
@page |
|
71 |
|
|
72 |
@ifnottex |
@ifnottex |
73 |
@node Top,,,(dir) |
@node Top,,,(dir) |
116 |
|
|
117 |
* Installation:: How to install and activate RefTeX. |
* Installation:: How to install and activate RefTeX. |
118 |
* RefTeX in a Nutshell:: A brief summary and quick guide. |
* RefTeX in a Nutshell:: A brief summary and quick guide. |
119 |
|
|
120 |
Labels and References |
Labels and References |
121 |
|
|
122 |
* Creating Labels:: |
* Creating Labels:: |
287 |
|
|
288 |
@itemize @bullet |
@itemize @bullet |
289 |
@item |
@item |
290 |
@b{Creating Labels}@* |
@b{Creating Labels}@* |
291 |
Type @kbd{C-c (} (@code{reftex-label}) to insert a label at point. |
Type @kbd{C-c (} (@code{reftex-label}) to insert a label at point. |
292 |
@b{Ref@TeX{}} will either |
@b{Ref@TeX{}} will either |
293 |
@itemize @minus |
@itemize @minus |
295 |
derive a label from context (default for section labels) |
derive a label from context (default for section labels) |
296 |
@item |
@item |
297 |
prompt for a label string (default for figures and tables) or |
prompt for a label string (default for figures and tables) or |
298 |
@item |
@item |
299 |
insert a simple label made of a prefix and a number (all other |
insert a simple label made of a prefix and a number (all other |
300 |
environments)@refill |
environments)@refill |
301 |
@end itemize |
@end itemize |
390 |
additional customizations will be necessary.@refill |
additional customizations will be necessary.@refill |
391 |
|
|
392 |
@item |
@item |
393 |
@b{Useful Settings}@* To make @b{Ref@TeX{}} faster for large documents, |
@b{Useful Settings}@* |
394 |
try these:@refill |
To integrate RefTeX with AUCTeX, use |
|
@lisp |
|
|
(setq reftex-enable-partial-scans t) |
|
|
(setq reftex-save-parse-info t) |
|
|
(setq reftex-use-multiple-selection-buffers t) |
|
|
@end lisp |
|
|
|
|
|
To integrate with AUCTeX, use |
|
395 |
@lisp |
@lisp |
396 |
(setq reftex-plug-into-AUCTeX t) |
(setq reftex-plug-into-AUCTeX t) |
397 |
@end lisp |
@end lisp |
415 |
the manual if you get stuck, of if you are curious what else might be |
the manual if you get stuck, of if you are curious what else might be |
416 |
available. The first part of the manual explains in |
available. The first part of the manual explains in |
417 |
a tutorial way how to use and customize @b{Ref@TeX{}}. The second |
a tutorial way how to use and customize @b{Ref@TeX{}}. The second |
418 |
part is a command and variable reference.@refill |
part is a command and variable reference.@refill |
419 |
@end enumerate |
@end enumerate |
420 |
|
|
421 |
@node Table of Contents, Labels and References, Introduction, Top |
@node Table of Contents, Labels and References, Introduction, Top |
502 |
Show calling point in another window. This is the point from where |
Show calling point in another window. This is the point from where |
503 |
@code{reftex-toc} was last called. |
@code{reftex-toc} was last called. |
504 |
|
|
505 |
|
@page |
506 |
@tablesubheading{Exiting} |
@tablesubheading{Exiting} |
507 |
@item q |
@item q |
508 |
Hide the @file{*toc*} buffer, return to the position where |
Hide the @file{*toc*} buffer, return to the position where |
514 |
|
|
515 |
@item C-c > |
@item C-c > |
516 |
Switch to the @file{*Index*} buffer of this document. With prefix |
Switch to the @file{*Index*} buffer of this document. With prefix |
517 |
@samp{2}, restrict the index to the section at point in the @file{*toc*} |
@samp{2}, restrict the index to the section at point in the @file{*toc*} |
518 |
buffer. |
buffer. |
519 |
|
|
520 |
@tablesubheading{Controlling what gets displayed} |
@tablesubheading{Controlling what gets displayed} |
550 |
default for this flag can be set with the variable |
default for this flag can be set with the variable |
551 |
@code{reftex-toc-include-index-entries}. When called with a prefix |
@code{reftex-toc-include-index-entries}. When called with a prefix |
552 |
argument, @b{Ref@TeX{}} will prompt for a specific index and include |
argument, @b{Ref@TeX{}} will prompt for a specific index and include |
553 |
only entries in the selected index in the @file{*toc*} buffer. The mode |
only entries in the selected index in the @file{*toc*} buffer. The mode |
554 |
line @samp{I<>} indicator shows which index is used.@refill |
line @samp{I<>} indicator shows which index is used.@refill |
555 |
|
|
556 |
@item c |
@item c |
581 |
package)}), @b{Ref@TeX{}} will switch to one of the external |
package)}), @b{Ref@TeX{}} will switch to one of the external |
582 |
documents.@refill |
documents.@refill |
583 |
|
|
584 |
|
@item a |
585 |
|
Toggle the automatic recentering of the @file{*toc*} buffer. When this |
586 |
|
option is on, moving around in the document will cause the @file{*toc*} |
587 |
|
to always highlight the current section. This can be enabled by default |
588 |
|
with the variable @code{reftex-auto-recenter-toc}. |
589 |
|
|
590 |
@end table |
@end table |
591 |
|
|
592 |
@vindex reftex-toc-map |
@vindex reftex-toc-map |
593 |
In order to define additional commands for the @file{*toc*} buffer, the |
In order to define additional commands for the @file{*toc*} buffer, the |
594 |
keymap @code{reftex-toc-map} may be used.@refill |
keymap @code{reftex-toc-map} may be used.@refill |
595 |
|
|
596 |
|
@findex reftex-toc-recenter |
597 |
|
@vindex reftex-auto-recenter-toc |
598 |
|
@vindex reftex-idle-time |
599 |
|
@cindex @file{*toc*} buffer, recentering |
600 |
|
@cindex Table of contents buffer, recentering |
601 |
|
@kindex C-c - |
602 |
|
If you call @code{reftex-toc} while the @file{*toc*} buffer already |
603 |
|
exists, the cursor will immediately jump to the right place, i.e. the |
604 |
|
section from which @code{reftex-toc} was called will be highlighted. |
605 |
|
The command @kbd{C-c -} (@code{reftex-toc-recenter}) will only redisplay |
606 |
|
the @file{*toc*} buffer and highlight the correct line without actually |
607 |
|
selecting the @file{*toc*} window. This can be useful to quickly find |
608 |
|
out where in the document you currently are. If you want the TOC buffer |
609 |
|
to show the current section automatically whenever you stop typing, try |
610 |
|
@lisp |
611 |
|
(setq reftex-auto-recenter-toc t) |
612 |
|
@end lisp |
613 |
|
When this is turned on, the toc buffer will be recentered whenever Emacs |
614 |
|
is idle for more than @code{reftex-idle-time} seconds. |
615 |
|
|
616 |
|
|
617 |
@cindex Sectioning commands |
@cindex Sectioning commands |
618 |
@cindex KOMA-Script, LaTeX classes |
@cindex KOMA-Script, LaTeX classes |
619 |
@cindex LaTeX classes, KOMA-Script |
@cindex LaTeX classes, KOMA-Script |
799 |
Goto previous section heading. |
Goto previous section heading. |
800 |
|
|
801 |
@item N z |
@item N z |
802 |
Jump to section N, using the prefix arg. For example @kbd{3 z} jumps to |
Jump to section N, using the prefix arg. For example @kbd{3 z} jumps to |
803 |
section 3.@refill |
section 3.@refill |
804 |
|
|
805 |
@tablesubheading{Displaying Context} |
@tablesubheading{Displaying Context} |
893 |
|
|
894 |
@tablesubheading{Controlling what gets displayed} |
@tablesubheading{Controlling what gets displayed} |
895 |
@vindex reftex-label-menu-flags |
@vindex reftex-label-menu-flags |
896 |
The defaults for the following flags can be configured with the variable |
The defaults for the following flags can be configured with the variable |
897 |
@code{reftex-label-menu-flags} (@pxref{Options (Referencing Labels)}). |
@code{reftex-label-menu-flags} (@pxref{Options (Referencing Labels)}). |
898 |
|
|
899 |
@item c |
@item c |
906 |
|
|
907 |
@item t |
@item t |
908 |
Toggle the display of the table of contents in the selection buffer. |
Toggle the display of the table of contents in the selection buffer. |
909 |
With prefix @var{arg}, change the maximum level of toc entries displayed |
With prefix @var{arg}, change the maximum level of toc entries displayed |
910 |
to @var{arg}. Chapters are level 1, section are level 2.@refill |
to @var{arg}. Chapters are level 1, section are level 2.@refill |
911 |
|
|
912 |
@item # |
@item # |
1133 |
@noindent |
@noindent |
1134 |
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 |
1135 |
@samp{thr:}, respectively. @xref{AUCTeX}, for information on how |
@samp{thr:}, respectively. @xref{AUCTeX}, for information on how |
1136 |
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 |
1137 |
environment is inserted into a buffer.@refill |
is inserted into a buffer. Additionally, the following needs to be |
1138 |
|
added to one's .emacs file before AUCTeX will automatically create |
1139 |
|
labels for the new environments. |
1140 |
|
|
1141 |
|
@lisp |
1142 |
|
(add-hook 'LaTeX-mode-hook |
1143 |
|
(lambda () |
1144 |
|
(LaTeX-add-environments |
1145 |
|
'("axiom" LaTeX-env-label) |
1146 |
|
'("theorem" LaTeX-env-label)))) |
1147 |
|
@end lisp |
1148 |
|
|
1149 |
|
|
1150 |
@noindent |
@noindent |
1151 |
The @samp{~\ref@{%s@}} is a format string indicating how to insert |
The @samp{~\ref@{%s@}} is a format string indicating how to insert |
1320 |
@example |
@example |
1321 |
[INS] [DEL] Package or Detailed : [Value Menu] Detailed: |
[INS] [DEL] Package or Detailed : [Value Menu] Detailed: |
1322 |
Environment or \macro : [Value Menu] String: \myfig[]@{@}@{@}@{*@}@{@} |
Environment or \macro : [Value Menu] String: \myfig[]@{@}@{@}@{*@}@{@} |
1323 |
Type specification : [Value Menu] Char : f |
Type specification : [Value Menu] Char : f |
1324 |
Label prefix string : [Value Menu] Default |
Label prefix string : [Value Menu] Default |
1325 |
Label reference format: [Value Menu] Default |
Label reference format: [Value Menu] Default |
1326 |
Context method : [Value Menu] Macro arg nr: 3 |
Context method : [Value Menu] Macro arg nr: 3 |
1408 |
@code{\ee}, point is not in this environment. When the first match is |
@code{\ee}, point is not in this environment. When the first match is |
1409 |
@code{\be}, point is in this environment and the function must return |
@code{\be}, point is in this environment and the function must return |
1410 |
the beginning of the match. To avoid scanning too far, we can also look |
the beginning of the match. To avoid scanning too far, we can also look |
1411 |
for empty lines which cannot occure inside an equation environment. |
for empty lines which cannot occur inside an equation environment. |
1412 |
Here is the setup:@refill |
Here is the setup:@refill |
1413 |
|
|
1414 |
@lisp |
@lisp |
1417 |
|
|
1418 |
(defun detect-be-ee (bound) |
(defun detect-be-ee (bound) |
1419 |
;; Search backward for the macros or an empty line |
;; Search backward for the macros or an empty line |
1420 |
(if (re-search-backward |
(if (re-search-backward |
1421 |
"\\(^[ \t]*\n\\|\\\\ee\\>\\)\\|\\(\\\\be\\>\\)" bound t) |
"\\(^[ \t]*\n\\|\\\\ee\\>\\)\\|\\(\\\\be\\>\\)" bound t) |
1422 |
(if (match-beginning 2) |
(if (match-beginning 2) |
1423 |
(match-beginning 2) ; Return start of environment |
(match-beginning 2) ; Return start of environment |
1456 |
(defun detect-linguex (bound) |
(defun detect-linguex (bound) |
1457 |
(let ((cnt 0)) |
(let ((cnt 0)) |
1458 |
(catch 'exit |
(catch 'exit |
1459 |
(while |
(while |
1460 |
;; Search backward for all possible delimiters |
;; Search backward for all possible delimiters |
1461 |
(re-search-backward |
(re-search-backward |
1462 |
(concat "\\(^[ \t]*\n\\)\\|\\(\\\\z\\.\\)\\|" |
(concat "\\(^[ \t]*\n\\)\\|\\(\\\\z\\.\\)\\|" |
1463 |
"\\(\\ex[ig]?\\.\\)\\|\\(\\\\a\\.\\)") |
"\\(\\ex[ig]?\\.\\)\\|\\(\\\\a\\.\\)") |
1464 |
nil t) |
nil t) |
1465 |
;; Check which delimiter was matched. |
;; Check which delimiter was matched. |
1466 |
(cond |
(cond |
1467 |
((match-beginning 1) |
((match-beginning 1) |
1468 |
;; empty line terminates all - return nil |
;; empty line terminates all - return nil |
1469 |
(throw 'exit nil)) |
(throw 'exit nil)) |
1510 |
@kindex C-c & |
@kindex C-c & |
1511 |
@kindex S-mouse-2 |
@kindex S-mouse-2 |
1512 |
|
|
1513 |
When point is idle on the argument of a @code{\ref} macro, the echo area |
When point is idle for more than @code{reftex-idle-time} seconds on the |
1514 |
will display some information about the label referenced there. Note |
argument of a @code{\ref} macro, the echo area will display some |
1515 |
that the information is only displayed if the echo area is not occupied |
information about the label referenced there. Note that the information |
1516 |
by a different message. |
is only displayed if the echo area is not occupied by a different |
1517 |
|
message. |
1518 |
|
|
1519 |
@b{Ref@TeX{}} can also display the label definition corresponding to a |
@b{Ref@TeX{}} can also display the label definition corresponding to a |
1520 |
@code{\ref} macro, or all reference locations corresponding to a |
@code{\ref} macro, or all reference locations corresponding to a |
1635 |
@samp{Einstein&&Bose} will match all articles which mention |
@samp{Einstein&&Bose} will match all articles which mention |
1636 |
Bose-Einstein condensation, or which are co-authored by Bose and |
Bose-Einstein condensation, or which are co-authored by Bose and |
1637 |
Einstein. When entering the regular expression, you can complete on |
Einstein. When entering the regular expression, you can complete on |
1638 |
known citation keys.@refill |
known citation keys. RefTeX also offers a default when prompting for a |
1639 |
|
regular expression. This default is the word before the cursor or the |
1640 |
|
word before the current @samp{\cite} command. Sometimes this may be a |
1641 |
|
good search key.@refill |
1642 |
|
|
1643 |
@cindex @code{\bibliography} |
@cindex @code{\bibliography} |
1644 |
@cindex @code{thebibliography}, LaTeX environment |
@cindex @code{thebibliography}, LaTeX environment |
1784 |
|
|
1785 |
Following the most generic of these packages, @code{natbib}, the builtin |
Following the most generic of these packages, @code{natbib}, the builtin |
1786 |
citation packages always accept the @kbd{t} key for a @emph{textual} |
citation packages always accept the @kbd{t} key for a @emph{textual} |
1787 |
citation (like: @code{Jones et al. (1997) have shown...}) as well as |
citation (like: @code{Jones et al. (1997) have shown...}) as well as |
1788 |
the @kbd{p} key for a parenthetical citation (like: @code{As shown |
the @kbd{p} key for a parenthetical citation (like: @code{As shown |
1789 |
earlier (Jones et al, 1997)}).@refill |
earlier (Jones et al, 1997)}).@refill |
1790 |
|
|
1811 |
@findex reftex-view-crossref |
@findex reftex-view-crossref |
1812 |
@findex reftex-mouse-view-crossref |
@findex reftex-mouse-view-crossref |
1813 |
|
|
1814 |
When point is idle on the argument of a @code{\cite} macro, the echo area |
When point is idle for more than @code{reftex-idle-time} seconds on the |
1815 |
will display some information about the article cited there. Note |
argument of a @code{\cite} macro, the echo area will display some |
1816 |
that the information is only displayed if the echo area is not occupied |
information about the article cited there. Note that the information is |
1817 |
by a different message. |
only displayed if the echo area is not occupied by a different message. |
1818 |
|
|
1819 |
@b{Ref@TeX{}} can also display the @code{\bibitem} or BibTeX database |
@b{Ref@TeX{}} can also display the @code{\bibitem} or BibTeX database |
1820 |
entry corresponding to a @code{\cite} macro, or all citation locations |
entry corresponding to a @code{\cite} macro, or all citation locations |
2015 |
|
|
2016 |
Phrases for indexing can be collected while writing the document. The |
Phrases for indexing can be collected while writing the document. The |
2017 |
command @kbd{C-c \} (@code{reftex-index-phrase-selection-or-word}) |
command @kbd{C-c \} (@code{reftex-index-phrase-selection-or-word}) |
2018 |
copies the current selection (if active) or the word near point into the |
copies the current selection (if active) or the word near point into the |
2019 |
phrases buffer. It then selects this buffer, so that the phrase line |
phrases buffer. It then selects this buffer, so that the phrase line |
2020 |
can be edited. To return to the LaTeX document, press @kbd{C-c C-c} |
can be edited. To return to the LaTeX document, press @kbd{C-c C-c} |
2021 |
(@code{reftex-index-phrases-save-and-return}). |
(@code{reftex-index-phrases-save-and-return}). |
2022 |
|
|
2023 |
You can also prepare the list of index phrases in a different way and |
You can also prepare the list of index phrases in a different way and |
2024 |
copy it into the phrases file. For example you might want to start from |
copy it into the phrases file. For example you might want to start from |
2025 |
a word list of the document and remove all words which should not be |
a word list of the document and remove all words which should not be |
2026 |
indexed. |
indexed. |
2027 |
|
|
2030 |
format. A phrase line looks like this: |
format. A phrase line looks like this: |
2031 |
|
|
2032 |
@example |
@example |
2033 |
[@var{key}] <TABs> @var{phrase} [<TABs> @var{arg}[&&@var{arg}]... [ || @var{arg}]...] |
[@var{key}] <TABs> @var{phrase} [<TABs> @var{arg}[&&@var{arg}]... [ || @var{arg}]...] |
2034 |
@end example |
@end example |
2035 |
|
|
2036 |
@code{<TABs>} stands for white space containing at least one @key{TAB}. |
@code{<TABs>} stands for white space containing at least one @key{TAB}. |
2124 |
@b{Ref@TeX{}} will start at the first phrase line and search the phrase |
@b{Ref@TeX{}} will start at the first phrase line and search the phrase |
2125 |
globally in the whole document. At each match it will stop, compute the |
globally in the whole document. At each match it will stop, compute the |
2126 |
replacement string and offer you the following choices@footnote{Windows |
replacement string and offer you the following choices@footnote{Windows |
2127 |
users: Restrict yourself to the described keys during indexing. Pressing |
users: Restrict yourself to the described keys during indexing. Pressing |
2128 |
@key{Help} at the indexing prompt can apparently hang Emacs.}:@refill |
@key{Help} at the indexing prompt can apparently hang Emacs.}:@refill |
2129 |
|
|
2130 |
@table @kbd |
@table @kbd |
2238 |
@tablesubheading{Moving around} |
@tablesubheading{Moving around} |
2239 |
@item ! A..Z |
@item ! A..Z |
2240 |
Pressing any capital letter will jump to the corresponding section in |
Pressing any capital letter will jump to the corresponding section in |
2241 |
the @file{*Index*} buffer. The exclamation mark is special and jumps to |
the @file{*Index*} buffer. The exclamation mark is special and jumps to |
2242 |
the first entries alphabetically sorted below @samp{A}. These are |
the first entries alphabetically sorted below @samp{A}. These are |
2243 |
usually non-alphanumeric characters.@refill |
usually non-alphanumeric characters.@refill |
2244 |
@item n |
@item n |
2248 |
|
|
2249 |
@tablesubheading{Access to document locations} |
@tablesubheading{Access to document locations} |
2250 |
@item @key{SPC} |
@item @key{SPC} |
2251 |
Show the place in the document where this index entry is defined.@refill |
Show the place in the document where this index entry is defined.@refill |
2252 |
|
|
2253 |
@item @key{TAB} |
@item @key{TAB} |
2254 |
Go to the definition of the current index entry in another |
Go to the definition of the current index entry in another |
2299 |
|
|
2300 |
@item ( |
@item ( |
2301 |
Toggle the beginning of page range property @samp{|(} of the |
Toggle the beginning of page range property @samp{|(} of the |
2302 |
entry.@refill |
entry.@refill |
2303 |
|
|
2304 |
@item ) |
@item ) |
2305 |
Toggle the end of page range property @samp{|)} of the entry.@refill |
Toggle the end of page range property @samp{|)} of the entry.@refill |
2306 |
|
|
2307 |
@item _ |
@item _ |
2308 |
Make the current entry a subentry. This command will prompt for the |
Make the current entry a subentry. This command will prompt for the |
2309 |
superordinate entry and insert it.@refill |
superordinate entry and insert it.@refill |
2310 |
|
|
2311 |
@item ^ |
@item ^ |
2312 |
Remove the highest superordinate entry. If the current entry is a |
Remove the highest superordinate entry. If the current entry is a |
2313 |
subitem (@samp{aaa!bbb!ccc}), this function moves it up the hierarchy |
subitem (@samp{aaa!bbb!ccc}), this function moves it up the hierarchy |
2314 |
(@samp{bbb!ccc}).@refill |
(@samp{bbb!ccc}).@refill |
2315 |
|
|
2316 |
@tablesubheading{Exiting} |
@tablesubheading{Exiting} |
2317 |
@item q |
@item q |
2364 |
|
|
2365 |
@item s |
@item s |
2366 |
Switch to a different index (for documents with multiple |
Switch to a different index (for documents with multiple |
2367 |
indices).@refill |
indices).@refill |
2368 |
@end table |
@end table |
2369 |
|
|
2370 |
|
|
2427 |
index entries with @code{reftex-index}. These codes need to be |
index entries with @code{reftex-index}. These codes need to be |
2428 |
unique. @code{?i}, @code{?I}, and @code{?g} are reserved for the |
unique. @code{?i}, @code{?I}, and @code{?g} are reserved for the |
2429 |
@code{\index}, @code{\index*}, and @code{\glossary} macros, |
@code{\index}, @code{\index*}, and @code{\glossary} macros, |
2430 |
respectively. |
respectively. |
2431 |
|
|
2432 |
The following string is empty unless your macro adds a superordinate |
The following string is empty unless your macro adds a superordinate |
2433 |
entry to the index key - this is the case for the @code{\astobj} macro. |
entry to the index key - this is the case for the @code{\astobj} macro. |
2450 |
Macro with args: \ix@{*@} |
Macro with args: \ix@{*@} |
2451 |
Index Tag : [Value Menu] String: idx |
Index Tag : [Value Menu] String: idx |
2452 |
Access Key : x |
Access Key : x |
2453 |
Key Prefix : |
Key Prefix : |
2454 |
Exclusion hook : nil |
Exclusion hook : nil |
2455 |
Repeat Outside : [Toggle] off (nil) |
Repeat Outside : [Toggle] off (nil) |
2456 |
[INS] [DEL] List: |
[INS] [DEL] List: |
2457 |
Macro with args: \nindex@{*@} |
Macro with args: \nindex@{*@} |
2458 |
Index Tag : [Value Menu] String: name |
Index Tag : [Value Menu] String: name |
2459 |
Access Key : n |
Access Key : n |
2460 |
Key Prefix : |
Key Prefix : |
2461 |
Exclusion hook : nil |
Exclusion hook : nil |
2462 |
Repeat Outside : [Toggle] off (nil) |
Repeat Outside : [Toggle] off (nil) |
2463 |
[INS] [DEL] List: |
[INS] [DEL] List: |
2558 |
While the display of cross referencing information for the above |
While the display of cross referencing information for the above |
2559 |
mentioned macros is hard--coded, you can configure additional relations |
mentioned macros is hard--coded, you can configure additional relations |
2560 |
in the variable @code{reftex-view-crossref-extra}. |
in the variable @code{reftex-view-crossref-extra}. |
2561 |
|
|
2562 |
@iftex |
@iftex |
2563 |
@chapter All the Rest |
@chapter All the Rest |
2564 |
@end iftex |
@end iftex |
2581 |
Here is a summary of the available key bindings. |
Here is a summary of the available key bindings. |
2582 |
|
|
2583 |
@kindex C-c = |
@kindex C-c = |
2584 |
|
@kindex C-c - |
2585 |
@kindex C-c ( |
@kindex C-c ( |
2586 |
@kindex C-c ) |
@kindex C-c ) |
2587 |
@kindex C-c [ |
@kindex C-c [ |
2594 |
@kindex C-c > |
@kindex C-c > |
2595 |
@example |
@example |
2596 |
@kbd{C-c =} @code{reftex-toc} |
@kbd{C-c =} @code{reftex-toc} |
2597 |
|
@kbd{C-c -} @code{reftex-toc-recenter} |
2598 |
@kbd{C-c (} @code{reftex-label} |
@kbd{C-c (} @code{reftex-label} |
2599 |
@kbd{C-c )} @code{reftex-reference} |
@kbd{C-c )} @code{reftex-reference} |
2600 |
@kbd{C-c [} @code{reftex-citation} |
@kbd{C-c [} @code{reftex-citation} |
2748 |
|
|
2749 |
@vindex reftex-multiref-punctuation |
@vindex reftex-multiref-punctuation |
2750 |
@vindex reftex-cite-punctuation |
@vindex reftex-cite-punctuation |
2751 |
@item |
@item |
2752 |
@b{Ref@TeX{}} inserts ``punctuation'' for multiple references and |
@b{Ref@TeX{}} inserts ``punctuation'' for multiple references and |
2753 |
for the author list in citations. Some of this may be language |
for the author list in citations. Some of this may be language |
2754 |
dependent. See the variables @code{reftex-multiref-punctuation} and |
dependent. See the variables @code{reftex-multiref-punctuation} and |
2802 |
Specify the full search path directly in @b{Ref@TeX{}}'s variables. |
Specify the full search path directly in @b{Ref@TeX{}}'s variables. |
2803 |
|
|
2804 |
@lisp |
@lisp |
2805 |
(setq reftex-texpath-environment-variables |
(setq reftex-texpath-environment-variables |
2806 |
'("./inp:/home/cd/tex//:/usr/local/tex//")) |
'("./inp:/home/cd/tex//:/usr/local/tex//")) |
2807 |
(setq reftex-bibpath-environment-variables |
(setq reftex-bibpath-environment-variables |
2808 |
'("/home/cd/tex/lit/")) |
'("/home/cd/tex/lit/")) |
2820 |
(setq reftex-use-external-file-finders t) |
(setq reftex-use-external-file-finders t) |
2821 |
(setq reftex-external-file-finders |
(setq reftex-external-file-finders |
2822 |
'(("tex" . "kpsewhich -format=.tex %f") |
'(("tex" . "kpsewhich -format=.tex %f") |
2823 |
("bib" . "kpsewhich -format=.bib %f"))) |
("bib" . "kpsewhich -format=.bib %f"))) |
2824 |
@end lisp |
@end lisp |
2825 |
@end itemize |
@end itemize |
2826 |
|
|
2827 |
|
@cindex Noweb files |
2828 |
|
@vindex reftex-file-extensions |
2829 |
|
@vindex TeX-file-extensions |
2830 |
|
Some people like to use RefTeX with noweb files, which usually have the |
2831 |
|
extension @file{.nw}. In order to deal with such files, the new |
2832 |
|
extension must be added to the list of valid extensions in the variable |
2833 |
|
@code{reftex-file-extensions}. When working with AUCTeX as major mode, |
2834 |
|
the new extension must also be known to AUCTeX via the variable |
2835 |
|
@code{TeX-file-extension}. For example: |
2836 |
|
|
2837 |
|
@lisp |
2838 |
|
(setq reftex-file-extensions |
2839 |
|
'(("nw" "tex" ".tex" ".ltx") ("bib" ".bib"))) |
2840 |
|
(setq TeX-file-extensions |
2841 |
|
'( "nw" "tex" "sty" "cls" "ltx" "texi" "texinfo")) |
2842 |
|
@end lisp |
2843 |
|
|
2844 |
@node Optimizations, Problems and Work-Arounds, Finding Files, Top |
@node Optimizations, Problems and Work-Arounds, Finding Files, Top |
2845 |
@section Optimizations |
@section Optimizations |
2846 |
@cindex Optimizations |
@cindex Optimizations |
2847 |
|
|
2848 |
|
@b{Note added 2002. Computers have gotten a lot faster, so most of the |
2849 |
|
optimizations discussed below will not be necessary on new machines. I |
2850 |
|
am leaving this stuff in the manual for people who want to write thick |
2851 |
|
books, where some of it still might be useful.} |
2852 |
|
|
2853 |
Implementing the principle of least surprises, the default settings of |
Implementing the principle of least surprises, the default settings of |
2854 |
@b{Ref@TeX{}} ensure a safe ride for beginners and casual users. However, |
@b{Ref@TeX{}} ensure a safe ride for beginners and casual users. However, |
2855 |
when using @b{Ref@TeX{}} for a large project and/or on a small computer, |
when using @b{Ref@TeX{}} for a large project and/or on a small computer, |
2975 |
@end group |
@end group |
2976 |
@end lisp |
@end lisp |
2977 |
|
|
|
@page |
|
2978 |
@node AUCTeX, Multifile Documents, Faces, Top |
@node AUCTeX, Multifile Documents, Faces, Top |
2979 |
@section @w{AUC @TeX{}} |
@section @w{AUC @TeX{}} |
2980 |
@cindex @code{AUCTeX}, Emacs package |
@cindex @code{AUCTeX}, Emacs package |
2982 |
|
|
2983 |
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 |
2984 |
files with Emacs (@pxref{Top,AUCTeX,,auctex, The AUCTeX User Manual}). |
files with Emacs (@pxref{Top,AUCTeX,,auctex, The AUCTeX User Manual}). |
2985 |
If AUCTeX is not part of you Emacs distribution, you can get |
If AUCTeX is not part of your Emacs distribution, you can get |
2986 |
it@footnote{XEmacs 21.x users may want to install the corresponding |
it@footnote{XEmacs 21.x users may want to install the corresponding |
2987 |
XEmacs package.} by ftp from the |
XEmacs package.} by ftp from the |
2988 |
@uref{http://www.sunsite.auc.dk/auctex/,AUCTeX distribution site}. |
@uref{http://www.sunsite.auc.dk/auctex/,AUCTeX distribution site}. |
3148 |
(reftex-set-cite-format 'natbib)))) |
(reftex-set-cite-format 'natbib)))) |
3149 |
@end lisp |
@end lisp |
3150 |
|
|
3151 |
@findex reftex-add-index-macros |
@findex reftex-add-index-macros |
3152 |
The hook may contain a call to @code{reftex-add-index-macros} to |
The hook may contain a call to @code{reftex-add-index-macros} to |
3153 |
define additional @code{\index}-like macros. The argument must have |
define additional @code{\index}-like macros. The argument must have |
3154 |
the same format as @code{reftex-index-macros}. It may be a symbol, to |
the same format as @code{reftex-index-macros}. It may be a symbol, to |
3233 |
@item |
@item |
3234 |
@b{LaTeX commands}@* |
@b{LaTeX commands}@* |
3235 |
@cindex LaTeX commands, not found |
@cindex LaTeX commands, not found |
3236 |
@code{\input}, @code{\include}, @code{\bibliography} and @code{\section} |
@code{\input}, @code{\include}, and @code{\section} (etc.) statements |
3237 |
(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 |
3238 |
|
|
3239 |
@item |
@item |
3240 |
@b{Commented regions}@* |
@b{Commented regions}@* |
3282 |
headings may look different from what you usually see on your screen. |
headings may look different from what you usually see on your screen. |
3283 |
In rare cases @code{reftex-toc} may have problems to jump to an affected |
In rare cases @code{reftex-toc} may have problems to jump to an affected |
3284 |
section heading. There are three possible ways to deal with |
section heading. There are three possible ways to deal with |
3285 |
this:@refill |
this:@refill |
3286 |
@itemize @minus |
@itemize @minus |
3287 |
@item |
@item |
3288 |
@vindex reftex-keep-temporary-buffers |
@vindex reftex-keep-temporary-buffers |
3332 |
argument (which really is a second argument to the macro @code{\begin}) |
argument (which really is a second argument to the macro @code{\begin}) |
3333 |
as a label of type @code{?p}. Argument count for this macro starts only |
as a label of type @code{?p}. Argument count for this macro starts only |
3334 |
after the @samp{@{step+@}}, also when specifying how to get |
after the @samp{@{step+@}}, also when specifying how to get |
3335 |
context.@refill |
context.@refill |
3336 |
|
|
3337 |
@item |
@item |
3338 |
@b{Idle timers in XEmacs}@* |
@b{Idle timers in XEmacs}@* |
3371 |
@cindex @code{http}, @b{Ref@TeX{}} home page |
@cindex @code{http}, @b{Ref@TeX{}} home page |
3372 |
@cindex @code{ftp}, @b{Ref@TeX{}} site |
@cindex @code{ftp}, @b{Ref@TeX{}} site |
3373 |
|
|
3374 |
@b{Ref@TeX{}} was written by @i{@value{AUTHOR}} |
@b{Ref@TeX{}} was written by @i{@value{Carsten Dominik}} |
3375 |
@email{@value{AUTHOR-EMAIL}}, with contributions by @i{Stephen |
@email{dominik@@science.uva.nl}, with contributions by @i{Stephen |
3376 |
Eglen}. @b{Ref@TeX{}} is currently maintained by @refill |
Eglen}. @b{Ref@TeX{}} is currently maintained by @refill |
3377 |
|
|
3378 |
@noindent |
@noindent |
3379 |
@value{MAINTAINER} @email{@value{MAINTAINER-EMAIL}} |
@value{Carsten Dominik} @email{dominik@@science.uva.nl} |
3380 |
|
|
3381 |
If you have questions about @b{Ref@TeX{}}, there are several Usenet |
If you have questions about @b{Ref@TeX{}}, there are several Usenet |
3382 |
groups which have competent readers: @code{comp.emacs}, |
groups which have competent readers: @code{comp.emacs}, |
3385 |
|
|
3386 |
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 |
3387 |
to contribute code or ideas, please |
to contribute code or ideas, please |
3388 |
@uref{mailto:@value{MAINTAINER-EMAIL},contact the maintainer}. Remember |
@uref{mailto:dominik@@science.uva.nl,contact the maintainer}. Remember |
3389 |
to provide all necessary information such as version numbers of Emacs |
to provide all necessary information such as version numbers of Emacs |
3390 |
and @b{Ref@TeX{}}, and the relevant part of your configuration in |
and @b{Ref@TeX{}}, and the relevant part of your configuration in |
3391 |
@file{.emacs}. When reporting a bug which throws an exception, please |
@file{.emacs}. When reporting a bug which throws an exception, please |
3405 |
|
|
3406 |
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 |
3407 |
developing it with their reports. In particular thanks to @i{Fran |
developing it with their reports. In particular thanks to @i{Fran |
3408 |
Burstall, Alastair Burt, Soren Dayton, Stephen Eglen, Karl Eichwalder, |
Burstall, Alastair Burt, Lars Clausen, Soren Dayton, Stephen Eglen, Karl |
3409 |
Erik Frik, Peter Galbraith, Kai Grossjohann, Frank Harrell, Dieter |
Eichwalder, Erik Frik, Erik Frisk, Peter Galbraith, Kai Grossjohann, |
3410 |
Kraft, Adrian Lanz, Rory Molinari, Stefan Monnier, Laurent Mugnier, |
Frank Harrell, Stephan Heuel, Alan Ho, Lute Kamstra, Dieter Kraft, |
3411 |
Sudeep Kumar Palat, Daniel Polani, Robin Socha, Richard Stanton, Allan |
Adrian Lanz, Rory Molinari, Stefan Monnier, Laurent Mugnier, Sudeep |
3412 |
Strand, Jan Vroonhof, Christoph Wedler, Alan Williams}.@refill |
Kumar Palat, Daniel Polani, Alan Shutko, Robin Socha, Richard Stanton, |
3413 |
|
Allan Strand, Jan Vroonhof, Christoph Wedler, Alan Williams, Roland |
3414 |
|
Winkler, Eli Zaretskii}.@refill |
3415 |
|
|
3416 |
The @code{view-crossref} feature was inspired by @i{Peter Galbraith's} |
The @code{view-crossref} feature was inspired by @i{Peter Galbraith's} |
3417 |
@file{bib-cite.el}.@refill |
@file{bib-cite.el}.@refill |
3449 |
expression, scans the buffers with BibTeX entries (taken from the |
expression, scans the buffers with BibTeX entries (taken from the |
3450 |
@code{\bibliography} command or a @code{thebibliography} environment) |
@code{\bibliography} command or a @code{thebibliography} environment) |
3451 |
and offers the matching entries for selection. The selected entry is |
and offers the matching entries for selection. The selected entry is |
3452 |
formated according to @code{reftex-cite-format} and inserted into the |
formatted according to @code{reftex-cite-format} and inserted into the |
3453 |
buffer.@refill @* |
buffer.@refill @* |
3454 |
When called with one or two @kbd{C-u} prefixes, first rescans the |
When called with one or two @kbd{C-u} prefixes, first rescans the |
3455 |
document. When called with a numeric prefix, make that many citations. |
document. When called with a numeric prefix, make that many citations. |
3456 |
When called with point inside the braces of a @code{\cite} command, it |
When called with point inside the braces of a @code{\cite} command, it |
3457 |
will add another key, ignoring the value of |
will add another key, ignoring the value of |
3458 |
@code{reftex-cite-format}.@refill @* |
@code{reftex-cite-format}.@refill @* |
3459 |
The regular expression uses an expanded syntax: @samp{&&} is interpreted |
The regular expression uses an expanded syntax: @samp{&&} is interpreted |
3460 |
as @code{and}. Thus, @samp{aaaa&&bbb} matches entries which contain |
as @code{and}. Thus, @samp{aaaa&&bbb} matches entries which contain |
3461 |
both @samp{aaaa} and @samp{bbb}. While entering the regexp, completion |
both @samp{aaaa} and @samp{bbb}. While entering the regexp, completion |
3525 |
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. |
3526 |
Since BibTeX files can be used by many LaTeX documents, this function |
Since BibTeX files can be used by many LaTeX documents, this function |
3527 |
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 |
3528 |
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 |
3529 |
this function several times find successive citation locations. |
this function several times find successive citation locations. |
3530 |
@end deffn |
@end deffn |
3531 |
|
|
3553 |
active TAGS table is required.@refill |
active TAGS table is required.@refill |
3554 |
@end deffn |
@end deffn |
3555 |
|
|
3556 |
|
@deffn Command reftex-goto-label |
3557 |
|
Prompt for a label (with completion) and jump to the location of this |
3558 |
|
label. Optional prefix argument @var{other-window} goes to the label in |
3559 |
|
another window. |
3560 |
|
@end deffn |
3561 |
|
|
3562 |
|
|
3563 |
@deffn Command reftex-change-label |
@deffn Command reftex-change-label |
3564 |
Query replace @var{from} with @var{to} in all @code{\label} and |
Query replace @var{from} with @var{to} in all @code{\label} and |
3565 |
@code{\ref} commands. Works on the entire multifile document. No |
@code{\ref} commands. Works on the entire multifile document. No |
3628 |
@cindex Options, table of contents |
@cindex Options, table of contents |
3629 |
@cindex Table of contents, options |
@cindex Table of contents, options |
3630 |
|
|
3631 |
|
@defopt reftex-include-file-commands |
3632 |
|
List of LaTeX commands which input another file. |
3633 |
|
The file name is expected after the command, either in braces or separated |
3634 |
|
by whitespace. |
3635 |
|
@end defopt |
3636 |
|
|
3637 |
|
@defopt reftex-max-section-depth |
3638 |
|
Maximum depth of section levels in document structure. |
3639 |
|
Standard LaTeX needs 7, default is 12. |
3640 |
|
@end defopt |
3641 |
|
|
3642 |
|
@defopt reftex-section-levels |
3643 |
|
Commands and levels used for defining sections in the document. The |
3644 |
|
@code{car} of each cons cell is the name of the section macro. The |
3645 |
|
@code{cdr} is a number indicating its level. A negative level means the |
3646 |
|
same as the positive value, but the section will never get a |
3647 |
|
number. The @code{cdr} may also be a function which then has to return |
3648 |
|
the level.@refill |
3649 |
|
@end defopt |
3650 |
|
|
3651 |
@defopt reftex-toc-max-level |
@defopt reftex-toc-max-level |
3652 |
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. |
3653 |
Section headings with a bigger level will be ignored. In RefTeX, |
Section headings with a bigger level will be ignored. In RefTeX, |
3655 |
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 |
3656 |
@end defopt |
@end defopt |
3657 |
|
|
3658 |
|
@defopt reftex-part-resets-chapter |
3659 |
|
Non-@code{nil} means, @code{\part} is like any other sectioning command. |
3660 |
|
This means, part numbers will be included in the numbering of chapters, and |
3661 |
|
chapter counters will be reset for each part. |
3662 |
|
When @code{nil} (the default), parts are special, do not reset the |
3663 |
|
chapter counter and also do not show up in chapter numbers. |
3664 |
|
@end defopt |
3665 |
|
|
3666 |
|
@defopt reftex-auto-recenter-toc |
3667 |
|
Non-@code{nil} means, initially turn automatic recentering of toc on. |
3668 |
|
When active, the @file{*TOC*} buffer will always show the section you |
3669 |
|
are currently working in. Recentering happens whenever Emacs is idle |
3670 |
|
for more than `reftex-idle-time' seconds. |
3671 |
|
This feature can be turned on and off from the menu |
3672 |
|
(Ref->Options). |
3673 |
|
@end defopt |
3674 |
|
|
3675 |
|
@defopt reftex-toc-split-windows-horizontally |
3676 |
|
Non-@code{nil} means, create TOC window by splitting window |
3677 |
|
horizontally. The default is to split vertically. |
3678 |
|
@end defopt |
3679 |
|
|
3680 |
|
@defopt reftex-toc-split-windows-horizontally-fraction |
3681 |
|
Fraction of the horizontal width of the frame to be used for TOC window. |
3682 |
|
Only relevant when @code{reftex-toc-split-windows-horizontally} is |
3683 |
|
non-@code{nil}. |
3684 |
|
@end defopt |
3685 |
|
|
3686 |
@defopt reftex-toc-keep-other-windows |
@defopt reftex-toc-keep-other-windows |
3687 |
Non-@code{nil} means, split the selected window to display the |
Non-@code{nil} means, split the selected window to display the |
3688 |
@file{*toc*} buffer. This helps to keep the window configuration, but |
@file{*toc*} buffer. This helps to keep the window configuration, but |
3778 |
group which contains all labels.@refill |
group which contains all labels.@refill |
3779 |
|
|
3780 |
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 |
3781 |
in a a non-standard label environment. The function must take an |
in a non-standard label environment. The function must take an |
3782 |
argument @var{bound} and limit backward searches to this value. It |
argument @var{bound} and limit backward searches to this value. It |
3783 |
should return either nil or a cons cell @code{(@var{function} |
should return either nil or a cons cell @code{(@var{function} |
3784 |
. @var{position})} with the function symbol and the position where the |
. @var{position})} with the function symbol and the position where the |
3910 |
with the variable @code{reftex-default-label-alist-entries}.@refill |
with the variable @code{reftex-default-label-alist-entries}.@refill |
3911 |
@end defopt |
@end defopt |
3912 |
|
|
|
@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 |
|
|
|
|
3913 |
@defopt reftex-section-prefixes |
@defopt reftex-section-prefixes |
3914 |
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 |
3915 |
@code{reftex-label-alist} contains @samp{%S}, this list is used to |
@code{reftex-label-alist} contains @samp{%S}, this list is used to |
4154 |
|
|
4155 |
@deffn {Normal Hook} reftex-select-label-mode-hook |
@deffn {Normal Hook} reftex-select-label-mode-hook |
4156 |
Normal hook which is run when a selection buffer enters |
Normal hook which is run when a selection buffer enters |
4157 |
@code{reftex-select-label-mode}.@refill |
@code{reftex-select-label-mode}.@refill |
4158 |
@end deffn |
@end deffn |
4159 |
|
|
4160 |
@deffn Keymap reftex-select-label-map |
@deffn Keymap reftex-select-label-map |
4167 |
@cindex Options, creating citations |
@cindex Options, creating citations |
4168 |
@cindex Creating citations, options |
@cindex Creating citations, options |
4169 |
|
|
4170 |
|
@defopt reftex-bibliography-commands |
4171 |
|
LaTeX commands which specify the BibTeX databases to use with the document. |
4172 |
|
@end defopt |
4173 |
|
|
4174 |
@defopt reftex-bibfile-ignore-regexps |
@defopt reftex-bibfile-ignore-regexps |
4175 |
List of regular expressions to exclude files in |
List of regular expressions to exclude files in |
4176 |
@code{\\bibliography@{..@}}. File names matched by any of these regexps |
@code{\\bibliography@{..@}}. File names matched by any of these regexps |
4287 |
@item |
@item |
4288 |
final names separator, like @samp{ and } in Jones, Brown and Miller |
final names separator, like @samp{ and } in Jones, Brown and Miller |
4289 |
@item |
@item |
4290 |
The @samp{et al.} string, like @samp{ @{\it et al.@}} in |
The @samp{et al.} string, like @samp{ @{\it et al.@}} in |
4291 |
Jones @{\it et al.@} |
Jones @{\it et al.@} |
4292 |
@end enumerate |
@end enumerate |
4293 |
@end defopt |
@end defopt |
4294 |
|
|
4295 |
@deffn {Normal Hook} reftex-select-bib-mode-hook |
@deffn {Normal Hook} reftex-select-bib-mode-hook |
4296 |
Normal hook which is run when a selection buffer enters |
Normal hook which is run when a selection buffer enters |
4297 |
@code{reftex-select-bib-mode}.@refill |
@code{reftex-select-bib-mode}.@refill |
4298 |
@end deffn |
@end deffn |
4299 |
|
|
4300 |
@deffn Keymap reftex-select-bib-map |
@deffn Keymap reftex-select-bib-map |
4318 |
|
|
4319 |
@defopt reftex-index-special-chars |
@defopt reftex-index-special-chars |
4320 |
List of special characters in index entries, given as strings. These |
List of special characters in index entries, given as strings. These |
4321 |
correspond to the @code{MakeIndex} keywords |
correspond to the @code{MakeIndex} keywords |
4322 |
@code{(@var{level} @var{encap} @var{actual} @var{quote} @var{escape})}. |
@code{(@var{level} @var{encap} @var{actual} @var{quote} @var{escape})}. |
4323 |
@end defopt |
@end defopt |
4324 |
|
|
4446 |
case.@refill |
case.@refill |
4447 |
@end defopt |
@end defopt |
4448 |
|
|
4449 |
|
@defopt reftex-index-verify-function |
4450 |
|
A function which is called at each match during global indexing. |
4451 |
|
If the function returns nil, the current match is skipped. |
4452 |
|
@end defopt |
4453 |
|
|
4454 |
@defopt reftex-index-phrases-skip-indexed-matches |
@defopt reftex-index-phrases-skip-indexed-matches |
4455 |
Non-@code{nil} means, skip matches which appear to be indexed already. |
Non-@code{nil} means, skip matches which appear to be indexed already. |
4456 |
When doing global indexing from the phrases buffer, searches for some |
When doing global indexing from the phrases buffer, searches for some |
4533 |
argument of a macro. Note that crossref viewing for citations, |
argument of a macro. Note that crossref viewing for citations, |
4534 |
references (both ways) and index entries is hard-coded. This variable |
references (both ways) and index entries is hard-coded. This variable |
4535 |
is only to configure additional structures for which crossreference |
is only to configure additional structures for which crossreference |
4536 |
viewing can be useful. Each entry has the structure |
viewing can be useful. Each entry has the structure |
4537 |
@example |
@example |
4538 |
(@var{macro-re} @var{search-re} @var{highlight}). |
(@var{macro-re} @var{search-re} @var{highlight}). |
4539 |
@end example |
@end example |
4540 |
@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 |
4541 |
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 |
4542 |
replaced with with the macro argument at point. @var{highlight} is an |
replaced with the macro argument at point. @var{highlight} is an |
4543 |
integer indicating which subgroup of the match should be highlighted. |
integer indicating which subgroup of the match should be highlighted. |
4544 |
@end defopt |
@end defopt |
4545 |
|
|
4546 |
@defopt reftex-auto-view-crossref |
@defopt reftex-auto-view-crossref |
4547 |
Non-@code{nil} means, initially turn automatic viewing of crossref info |
Non-@code{nil} means, initially turn automatic viewing of crossref info |
4548 |
on. Automatic viewing of crossref info normally uses the echo area. |
on. Automatic viewing of crossref info normally uses the echo area. |
4549 |
Whenever point is on the argument of a @code{\ref} or @code{\cite} |
Whenever point is idle for more than @code{reftex-idle-time} seconds on |
4550 |
macro, and no other message is being displayed, the echo area will |
the argument of a @code{\ref} or @code{\cite} macro, and no other |
4551 |
display information about that cross reference. You can also set the |
message is being displayed, the echo area will display information about |
4552 |
variable to the symbol @code{window}. In this case a small temporary |
that cross reference. You can also set the variable to the symbol |
4553 |
window is used for the display. This feature can be turned on and of |
@code{window}. In this case a small temporary window is used for the |
4554 |
from the menu (Ref->Options).@refill |
display. This feature can be turned on and off from the menu |
4555 |
|
(Ref->Options).@refill |
4556 |
@end defopt |
@end defopt |
4557 |
|
|
4558 |
@defopt reftex-idle-time |
@defopt reftex-idle-time |
4559 |
Time (secs) Emacs has to be idle before automatic crossref display is |
Time (secs) Emacs has to be idle before automatic crossref display |
4560 |
done.@refill |
or toc recentering is done.@refill |
4561 |
@end defopt |
@end defopt |
4562 |
|
|
4563 |
@defopt reftex-cite-view-format |
@defopt reftex-cite-view-format |
4626 |
|
|
4627 |
@defopt reftex-file-extensions |
@defopt reftex-file-extensions |
4628 |
Association list with file extensions for different file types. |
Association list with file extensions for different file types. |
4629 |
This is a list of items, each item is like: |
This is a list of items, each item is like: |
4630 |
@code{(@var{type} . (@var{def-ext} @var{other-ext} ...))} |
@code{(@var{type} . (@var{def-ext} @var{other-ext} ...))} |
4631 |
@example |
@example |
4632 |
@var{type}: @r{File type like @code{"bib"} or @code{"tex"}.} |
@var{type}: @r{File type like @code{"bib"} or @code{"tex"}.} |
5250 |
@item |
@item |
5251 |
Parse files @file{MASTER.rel} made compatible between Emacs and XEmacs. |
Parse files @file{MASTER.rel} made compatible between Emacs and XEmacs. |
5252 |
@item |
@item |
5253 |
@code{kill-emacs-hook} and @code{kill-buffer-hook} now write the parse |
@code{kill-emacs-hook} and @code{kill-buffer-hook} now write the parse |
5254 |
file. |
file. |
5255 |
@item |
@item |
5256 |
The cursor inside a @code{\ref} or @code{\cite} macro can now trigger |
The cursor inside a @code{\ref} or @code{\cite} macro can now trigger |
5357 |
@item |
@item |
5358 |
Multiple selection buffers are now hidden buffers (they start with a |
Multiple selection buffers are now hidden buffers (they start with a |
5359 |
SPACE). |
SPACE). |
5360 |
@item |
@item |
5361 |
Fixed bug with file search when TEXINPUTS environment variable is empty. |
Fixed bug with file search when TEXINPUTS environment variable is empty. |
5362 |
@end itemize |
@end itemize |
5363 |
@noindent @b{Version 3.34} |
@noindent @b{Version 3.34} |
5392 |
@itemize @bullet |
@itemize @bullet |
5393 |
@item |
@item |
5394 |
New options @code{reftex-texpath-environment-variables}, |
New options @code{reftex-texpath-environment-variables}, |
5395 |
@code{reftex-use-external-file-finders}, |
@code{reftex-use-external-file-finders}, |
5396 |
@code{reftex-external-file-finders}, |
@code{reftex-external-file-finders}, |
5397 |
@code{reftex-search-unrecursed-path-first}. |
@code{reftex-search-unrecursed-path-first}. |
5398 |
@item |
@item |
5399 |
@emph{kpathsearch} support. See new options and |
@emph{kpathsearch} support. See new options and |
5400 |
@code{reftex-bibpath-environment-variables}. |
@code{reftex-bibpath-environment-variables}. |
5427 |
@item |
@item |
5428 |
Reading a parse file now checks consistency. |
Reading a parse file now checks consistency. |
5429 |
@end itemize |
@end itemize |
|
@end ignore |
|
5430 |
@noindent @b{Version 4.00} |
@noindent @b{Version 4.00} |
5431 |
@itemize @bullet |
@itemize @bullet |
5432 |
@item |
@item |
5433 |
RefTeX has been split into several smaller files which are autoloaded on |
RefTeX has been split into several smaller files which are autoloaded on |
5434 |
demand. |
demand. |
5435 |
@item |
@item |
5436 |
Index support, along with many new options. |
Index support, along with many new options. |
5480 |
@item |
@item |
5481 |
New option @code{reftex-toc-max-level} to limit the depth of the toc. |
New option @code{reftex-toc-max-level} to limit the depth of the toc. |
5482 |
New key binding @kbd{t} in the @file{*toc*} buffer to change this |
New key binding @kbd{t} in the @file{*toc*} buffer to change this |
5483 |
setting.@refill |
setting.@refill |
5484 |
@item |
@item |
5485 |
RefTeX maintaines an @file{Index Phrases} file in which phrases can be |
RefTeX maintains an @file{Index Phrases} file in which phrases can be |
5486 |
collected. When the document is ready, RefTeX can search all |
collected. When the document is ready, RefTeX can search all |
5487 |
these phrases and assist indexing all matches.@refill |
these phrases and assist indexing all matches.@refill |
5488 |
@item |
@item |
5497 |
@item |
@item |
5498 |
Environments like theorems can be placed into the TOC by putting |
Environments like theorems can be placed into the TOC by putting |
5499 |
entries for @samp{"begin@{theorem@}"} in |
entries for @samp{"begin@{theorem@}"} in |
5500 |
@code{reftex-setion-levels}.@refill |
@code{reftex-setion-levels}.@refill |
5501 |
@end itemize |
@end itemize |
5502 |
@noindent @b{Version 4.10} |
@noindent @b{Version 4.10} |
5503 |
@itemize @bullet |
@itemize @bullet |
5521 |
@noindent @b{Version 4.15} |
@noindent @b{Version 4.15} |
5522 |
@itemize @bullet |
@itemize @bullet |
5523 |
@item |
@item |
5524 |
|
Fixed bug with parsing of BibTeX files, when fields contain quotes or |
5525 |
|
unmatched parenthesis. |
5526 |
|
@item |
5527 |
Small bug fixes. |
Small bug fixes. |
5528 |
@item |
@item |
5529 |
Improved interaction with Emacs LaTeX mode. |
Improved interaction with Emacs LaTeX mode. |
5530 |
@end itemize |
@end itemize |
5531 |
|
@end ignore |
5532 |
|
@noindent @b{Version 4.17} |
5533 |
|
@itemize @bullet |
5534 |
|
@item |
5535 |
|
The toc window can be split off horizontally. See new options |
5536 |
|
@code{reftex-toc-split-windows-horizontally}, |
5537 |
|
@code{reftex-toc-split-windows-horizontally-fraction}. |
5538 |
|
@item |
5539 |
|
It is possible to specify a function which verifies an index match |
5540 |
|
during global indexing. See new option @code{reftex-index-verify-function}. |
5541 |
|
@item |
5542 |
|
The macros which input a file in LaTeX (like \input, \include) can |
5543 |
|
be configured. See new option @code{reftex-include-file-commands}. |
5544 |
|
@item |
5545 |
|
The macros which specify the bibliography file (like \bibliography) can |
5546 |
|
be configured. See new option @code{reftex-bibliography-commands}. |
5547 |
|
@item |
5548 |
|
The regular expression used to search for the \bibliography macro has |
5549 |
|
been relaxed to allow for @samp{@{\bibliography@{...@}@}} needed by |
5550 |
|
chapterbib. |
5551 |
|
@item |
5552 |
|
Small bug fixes. |
5553 |
|
@end itemize |
5554 |
|
@noindent @b{Version 4.18} |
5555 |
|
@itemize @bullet |
5556 |
|
@item |
5557 |
|
@code{reftex-citation} uses the word before the cursor as a default |
5558 |
|
search string. |
5559 |
|
@item |
5560 |
|
Simplified several regular expressions for speed. |
5561 |
|
@item |
5562 |
|
Better support for chapterbib. |
5563 |
|
@end itemize |
5564 |
|
@noindent @b{Version 4.19} |
5565 |
|
@itemize @bullet |
5566 |
|
@item |
5567 |
|
New command `reftex-toc-recenter' (@kbd{C-c -}) which shows the current |
5568 |
|
section in the TOC buffer without selecting the TOC window. |
5569 |
|
@item |
5570 |
|
Recentering happens automatically in idle time when the option |
5571 |
|
@code{reftex-auto-recenter-toc} is turned on. |
5572 |
|
@item |
5573 |
|
Fixed several bugs related to automatic cursor positioning in the TOC |
5574 |
|
buffer. |
5575 |
|
@item |
5576 |
|
The highlight in the TOC buffer stays when the focus moves to a |
5577 |
|
different window. |
5578 |
|
@item |
5579 |
|
New command `reftex-goto-label'. |
5580 |
|
@item |
5581 |
|
Part numbers are no longer included in chapter numbers, and a new |
5582 |
|
part does not reset the chapter counter. See new option |
5583 |
|
@code{reftex-part-resets-chapter}. |
5584 |
|
@end itemize |
5585 |
|
|
5586 |
@node Index, , , Top |
@node Index, , , Top |
5587 |
@unnumbered Index |
@unnumbered Index |