Mercurial > emacs
annotate man/reftex.texi @ 64749:5e716228ee1e
Update "copyright years" section.
author | Thien-Thi Nguyen <ttn@gnuvola.org> |
---|---|
date | Sat, 06 Aug 2005 16:20:52 +0000 |
parents | 9fc49ac7fb44 |
children | 3723093a21fd b7da78284d4c |
rev | line source |
---|---|
25829 | 1 \input texinfo @c -*-texinfo-*- |
2 @c %**start of header | |
59538
87ebb131f763
corrected setfilename
Carsten Dominik <dominik@science.uva.nl>
parents:
59536
diff
changeset
|
3 @setfilename ../info/reftex |
25829 | 4 @settitle RefTeX User Manual |
5 @synindex ky cp | |
6 @syncodeindex vr cp | |
7 @syncodeindex fn cp | |
59536 | 8 |
9 @c Version and Contact Info | |
62469 | 10 @set VERSION 4.28 |
11 @set EDITION 4.28 | |
12 @set DATE May 2005 | |
59536 | 13 @set AUCTEXSITE @uref{http://www.nongnu.org/auctex/,AUCTeX distribution site} |
14 @set MAINTAINERSITE @uref{http://www.astro.uva.nl/~dominik/Tools/,maintainers webpage} | |
15 @set MAINTAINER Carsten Dominik | |
16 @set MAINTAINEREMAIL @email{dominik@@science.uva.nl} | |
17 @set MAINTAINERCONTACT @uref{mailto:dominik@@science.uva.nl,contact the maintainer} | |
18 @set XEMACSFTP @uref{ftp://ftp.xemacs.org/pub/xemacs/packages/,XEmacs ftp site}. | |
25829 | 19 @c %**end of header |
59579
a588c86a429c
Revision: miles@gnu.org--gnu-2005/emacs--cvs-trunk--0--patch-40
Miles Bader <miles@gnu.org>
parents:
59548
diff
changeset
|
20 |
a588c86a429c
Revision: miles@gnu.org--gnu-2005/emacs--cvs-trunk--0--patch-40
Miles Bader <miles@gnu.org>
parents:
59548
diff
changeset
|
21 @copying |
25829 | 22 This file documents @b{Ref@TeX{}}, a package to do labels, references, |
47737
0a70200bde27
use @copying instead of @ifinfo.
Karl Berry <karl@gnu.org>
parents:
47050
diff
changeset
|
23 citations and indices for LaTeX documents with Emacs. |
25829 | 24 |
25 This is edition @value{EDITION} of the @b{Ref@TeX{}} User Manual for | |
59536 | 26 @b{Ref@TeX{}} @value{VERSION} |
25829 | 27 |
62469 | 28 Copyright (c) 1997, 1998, 1999, 2000, 2001, 2002, 2004, 2005 Free Software Foundation, Inc. |
25829 | 29 |
59579
a588c86a429c
Revision: miles@gnu.org--gnu-2005/emacs--cvs-trunk--0--patch-40
Miles Bader <miles@gnu.org>
parents:
59548
diff
changeset
|
30 @quotation |
37404
730f77edf073
Use GNU Free Documentation License.
Gerd Moellmann <gerd@gnu.org>
parents:
37038
diff
changeset
|
31 Permission is granted to copy, distribute and/or modify this document |
730f77edf073
Use GNU Free Documentation License.
Gerd Moellmann <gerd@gnu.org>
parents:
37038
diff
changeset
|
32 under the terms of the GNU Free Documentation License, Version 1.1 or |
730f77edf073
Use GNU Free Documentation License.
Gerd Moellmann <gerd@gnu.org>
parents:
37038
diff
changeset
|
33 any later version published by the Free Software Foundation; with no |
730f77edf073
Use GNU Free Documentation License.
Gerd Moellmann <gerd@gnu.org>
parents:
37038
diff
changeset
|
34 Invariant Sections, with the Front-Cover texts being ``A GNU |
730f77edf073
Use GNU Free Documentation License.
Gerd Moellmann <gerd@gnu.org>
parents:
37038
diff
changeset
|
35 Manual'', and with the Back-Cover Texts as in (a) below. A copy of the |
730f77edf073
Use GNU Free Documentation License.
Gerd Moellmann <gerd@gnu.org>
parents:
37038
diff
changeset
|
36 license is included in the section entitled ``GNU Free Documentation |
730f77edf073
Use GNU Free Documentation License.
Gerd Moellmann <gerd@gnu.org>
parents:
37038
diff
changeset
|
37 License'' in the Emacs manual. |
730f77edf073
Use GNU Free Documentation License.
Gerd Moellmann <gerd@gnu.org>
parents:
37038
diff
changeset
|
38 |
730f77edf073
Use GNU Free Documentation License.
Gerd Moellmann <gerd@gnu.org>
parents:
37038
diff
changeset
|
39 (a) The FSF's Back-Cover Text is: ``You have freedom to copy and modify |
730f77edf073
Use GNU Free Documentation License.
Gerd Moellmann <gerd@gnu.org>
parents:
37038
diff
changeset
|
40 this GNU Manual, like GNU software. Copies published by the Free |
730f77edf073
Use GNU Free Documentation License.
Gerd Moellmann <gerd@gnu.org>
parents:
37038
diff
changeset
|
41 Software Foundation raise funds for GNU development.'' |
730f77edf073
Use GNU Free Documentation License.
Gerd Moellmann <gerd@gnu.org>
parents:
37038
diff
changeset
|
42 |
730f77edf073
Use GNU Free Documentation License.
Gerd Moellmann <gerd@gnu.org>
parents:
37038
diff
changeset
|
43 This document is part of a collection distributed under the GNU Free |
730f77edf073
Use GNU Free Documentation License.
Gerd Moellmann <gerd@gnu.org>
parents:
37038
diff
changeset
|
44 Documentation License. If you want to distribute this document |
730f77edf073
Use GNU Free Documentation License.
Gerd Moellmann <gerd@gnu.org>
parents:
37038
diff
changeset
|
45 separately from the collection, you can do so by adding a copy of the |
730f77edf073
Use GNU Free Documentation License.
Gerd Moellmann <gerd@gnu.org>
parents:
37038
diff
changeset
|
46 license to the document, as described in section 6 of the license. |
59579
a588c86a429c
Revision: miles@gnu.org--gnu-2005/emacs--cvs-trunk--0--patch-40
Miles Bader <miles@gnu.org>
parents:
59548
diff
changeset
|
47 @end quotation |
a588c86a429c
Revision: miles@gnu.org--gnu-2005/emacs--cvs-trunk--0--patch-40
Miles Bader <miles@gnu.org>
parents:
59548
diff
changeset
|
48 @end copying |
a588c86a429c
Revision: miles@gnu.org--gnu-2005/emacs--cvs-trunk--0--patch-40
Miles Bader <miles@gnu.org>
parents:
59548
diff
changeset
|
49 |
a588c86a429c
Revision: miles@gnu.org--gnu-2005/emacs--cvs-trunk--0--patch-40
Miles Bader <miles@gnu.org>
parents:
59548
diff
changeset
|
50 @dircategory Emacs |
a588c86a429c
Revision: miles@gnu.org--gnu-2005/emacs--cvs-trunk--0--patch-40
Miles Bader <miles@gnu.org>
parents:
59548
diff
changeset
|
51 @direntry |
a588c86a429c
Revision: miles@gnu.org--gnu-2005/emacs--cvs-trunk--0--patch-40
Miles Bader <miles@gnu.org>
parents:
59548
diff
changeset
|
52 * RefTeX: (reftex). Emacs support for LaTeX cross-references and citations. |
a588c86a429c
Revision: miles@gnu.org--gnu-2005/emacs--cvs-trunk--0--patch-40
Miles Bader <miles@gnu.org>
parents:
59548
diff
changeset
|
53 @end direntry |
a588c86a429c
Revision: miles@gnu.org--gnu-2005/emacs--cvs-trunk--0--patch-40
Miles Bader <miles@gnu.org>
parents:
59548
diff
changeset
|
54 |
a588c86a429c
Revision: miles@gnu.org--gnu-2005/emacs--cvs-trunk--0--patch-40
Miles Bader <miles@gnu.org>
parents:
59548
diff
changeset
|
55 @finalout |
a588c86a429c
Revision: miles@gnu.org--gnu-2005/emacs--cvs-trunk--0--patch-40
Miles Bader <miles@gnu.org>
parents:
59548
diff
changeset
|
56 |
a588c86a429c
Revision: miles@gnu.org--gnu-2005/emacs--cvs-trunk--0--patch-40
Miles Bader <miles@gnu.org>
parents:
59548
diff
changeset
|
57 @c Macro definitions |
a588c86a429c
Revision: miles@gnu.org--gnu-2005/emacs--cvs-trunk--0--patch-40
Miles Bader <miles@gnu.org>
parents:
59548
diff
changeset
|
58 |
a588c86a429c
Revision: miles@gnu.org--gnu-2005/emacs--cvs-trunk--0--patch-40
Miles Bader <miles@gnu.org>
parents:
59548
diff
changeset
|
59 @c Subheadings inside a table. Need a difference between info and the rest. |
a588c86a429c
Revision: miles@gnu.org--gnu-2005/emacs--cvs-trunk--0--patch-40
Miles Bader <miles@gnu.org>
parents:
59548
diff
changeset
|
60 @macro tablesubheading{text} |
a588c86a429c
Revision: miles@gnu.org--gnu-2005/emacs--cvs-trunk--0--patch-40
Miles Bader <miles@gnu.org>
parents:
59548
diff
changeset
|
61 @ifinfo |
a588c86a429c
Revision: miles@gnu.org--gnu-2005/emacs--cvs-trunk--0--patch-40
Miles Bader <miles@gnu.org>
parents:
59548
diff
changeset
|
62 @subsubheading \text\ |
25829 | 63 @end ifinfo |
59579
a588c86a429c
Revision: miles@gnu.org--gnu-2005/emacs--cvs-trunk--0--patch-40
Miles Bader <miles@gnu.org>
parents:
59548
diff
changeset
|
64 @ifnotinfo |
a588c86a429c
Revision: miles@gnu.org--gnu-2005/emacs--cvs-trunk--0--patch-40
Miles Bader <miles@gnu.org>
parents:
59548
diff
changeset
|
65 @item @b{\text\} |
a588c86a429c
Revision: miles@gnu.org--gnu-2005/emacs--cvs-trunk--0--patch-40
Miles Bader <miles@gnu.org>
parents:
59548
diff
changeset
|
66 @end ifnotinfo |
a588c86a429c
Revision: miles@gnu.org--gnu-2005/emacs--cvs-trunk--0--patch-40
Miles Bader <miles@gnu.org>
parents:
59548
diff
changeset
|
67 @end macro |
25829 | 68 |
69 @titlepage | |
70 @title Ref@TeX{} User Manual | |
71 @subtitle Support for LaTeX labels, references, citations and index entries with GNU Emacs | |
72 @subtitle Edition @value{EDITION}, @value{DATE} | |
73 | |
74 @author by Carsten Dominik | |
75 @page | |
59579
a588c86a429c
Revision: miles@gnu.org--gnu-2005/emacs--cvs-trunk--0--patch-40
Miles Bader <miles@gnu.org>
parents:
59548
diff
changeset
|
76 @vskip 0pt plus 1filll |
a588c86a429c
Revision: miles@gnu.org--gnu-2005/emacs--cvs-trunk--0--patch-40
Miles Bader <miles@gnu.org>
parents:
59548
diff
changeset
|
77 @insertcopying |
25829 | 78 @end titlepage |
79 | |
29772
265fdb06f294
Update to reftex 4 14
Carsten Dominik <dominik@science.uva.nl>
parents:
29713
diff
changeset
|
80 @ifnottex |
25829 | 81 @node Top,,,(dir) |
82 | |
83 @b{Ref@TeX{}} is a package for managing Labels, References, | |
59536 | 84 Citations and index entries with GNU Emacs. |
25829 | 85 |
86 Don't be discouraged by the size of this manual, which covers | |
87 @b{Ref@TeX{}} in great depth. All you need to know to use | |
88 @b{Ref@TeX{}} can be summarized on two pages (@pxref{RefTeX in a | |
89 Nutshell}). You can go back later to other parts of this document when | |
59536 | 90 needed. |
25829 | 91 |
92 @menu | |
93 * Introduction:: Quick-Start information. | |
94 | |
95 * Table of Contents:: A Tool to move around quickly. | |
96 * Labels and References:: Creating and referencing labels. | |
97 * Citations:: Creating Citations. | |
98 * Index Support:: Creating and Checking Index Entries. | |
99 * Viewing Cross-References:: Who references or cites what? | |
100 | |
101 * RefTeXs Menu:: The Ref menu in the menubar. | |
39267 | 102 * Key Bindings:: The default key bindings. |
25829 | 103 * Faces:: Fontification of RefTeX's buffers. |
104 * Multifile Documents:: Document spread over many files. | |
105 * Language Support:: How to support other languages. | |
106 * Finding Files:: Included TeX files and BibTeX .bib files. | |
107 * AUCTeX:: Cooperation with AUCTeX. | |
108 * Optimizations:: When RefTeX is too slow. | |
109 * Problems and Work-Arounds:: First Aid. | |
110 * Imprint:: Author, Web-site, Thanks | |
111 | |
112 * Commands:: Which are the available commands. | |
113 * Options:: How to extend and configure RefTeX. | |
114 * Keymaps and Hooks:: For customization. | |
115 * Changes:: A List of recent changes to RefTeX. | |
116 | |
117 The Index | |
118 | |
119 * Index:: The full index. | |
120 | |
121 @detailmenu | |
122 | |
123 Introduction | |
124 | |
125 * Installation:: How to install and activate RefTeX. | |
126 * RefTeX in a Nutshell:: A brief summary and quick guide. | |
59579
a588c86a429c
Revision: miles@gnu.org--gnu-2005/emacs--cvs-trunk--0--patch-40
Miles Bader <miles@gnu.org>
parents:
59548
diff
changeset
|
127 |
25829 | 128 Labels and References |
129 | |
130 * Creating Labels:: | |
131 * Referencing Labels:: | |
132 * Builtin Label Environments:: The environments RefTeX knows about. | |
133 * Defining Label Environments:: ... and environments it doesn't. | |
134 * Reference Info:: View the label corresponding to a \ref. | |
135 * xr (LaTeX package):: References to external documents. | |
136 * varioref (LaTeX package):: How to create \vref instead of \ref. | |
137 * fancyref (LaTeX package):: How to create \fref instead of \ref. | |
138 | |
139 Defining Label Environments | |
140 | |
141 * Theorem and Axiom:: Defined with @code{\newenvironment}. | |
142 * Quick Equation:: When a macro sets the label type. | |
143 * Figure Wrapper:: When a macro argument is a label. | |
144 * Adding Magic Words:: Other words for other languages. | |
145 * Using \eqref:: How to switch to this AMS-LaTeX macro. | |
146 * Non-Standard Environments:: Environments without \begin and \end | |
147 * Putting it Together:: How to combine many entries. | |
148 | |
149 Citations | |
150 | |
151 * Creating Citations:: How to create them. | |
152 * Citation Styles:: Natbib, Harvard, Chicago and Co. | |
153 * Citation Info:: View the corresponding database entry. | |
154 * Chapterbib and Bibunits:: Multiple bibliographies in a Document. | |
155 * Citations Outside LaTeX:: How to make citations in Emails etc. | |
63671
9fc49ac7fb44
(Options (Defining Label Environments), Options (Index Support), Options
Juanma Barranquero <lekktu@gmail.com>
parents:
62469
diff
changeset
|
156 * BibTeX Database Subsets:: Extract parts of a big database. |
25829 | 157 |
158 Index Support | |
159 | |
26911
d7f536a01276
Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents:
25829
diff
changeset
|
160 * Creating Index Entries:: Macros and completion of entries. |
d7f536a01276
Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents:
25829
diff
changeset
|
161 * The Index Phrases File:: A special file for global indexing. |
d7f536a01276
Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents:
25829
diff
changeset
|
162 * Displaying and Editing the Index:: The index editor. |
25829 | 163 * Builtin Index Macros:: The index macros RefTeX knows about. |
164 * Defining Index Macros:: ... and macros it doesn't. | |
165 | |
26911
d7f536a01276
Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents:
25829
diff
changeset
|
166 The Index Phrases File |
d7f536a01276
Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents:
25829
diff
changeset
|
167 |
d7f536a01276
Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents:
25829
diff
changeset
|
168 * Collecting Phrases:: Collecting from document or external. |
d7f536a01276
Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents:
25829
diff
changeset
|
169 * Consistency Checks:: Check for duplicates etc. |
d7f536a01276
Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents:
25829
diff
changeset
|
170 * Global Indexing:: The interactive indexing process. |
d7f536a01276
Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents:
25829
diff
changeset
|
171 |
25829 | 172 AUCTeX |
173 | |
174 * AUCTeX-RefTeX Interface:: How both packages work together | |
175 * Style Files:: AUCTeX's style files can support RefTeX | |
176 * Bib-Cite:: Hypertext reading of a document | |
177 | |
178 Options, Keymaps, Hooks | |
179 | |
180 * Options (Table of Contents):: | |
181 * Options (Defining Label Environments):: | |
182 * Options (Creating Labels):: | |
183 * Options (Referencing Labels):: | |
184 * Options (Creating Citations):: | |
185 * Options (Index Support):: | |
186 * Options (Viewing Cross-References):: | |
187 * Options (Finding Files):: | |
188 * Options (Optimizations):: | |
189 * Options (Fontification):: | |
190 * Options (Misc):: | |
191 | |
192 @end detailmenu | |
193 @end menu | |
194 | |
29772
265fdb06f294
Update to reftex 4 14
Carsten Dominik <dominik@science.uva.nl>
parents:
29713
diff
changeset
|
195 @end ifnottex |
25829 | 196 |
197 @node Introduction, Table of Contents, , Top | |
198 @chapter Introduction | |
199 @cindex Introduction | |
200 | |
201 @b{Ref@TeX{}} is a specialized package for support of labels, | |
202 references, citations, and the index in LaTeX. @b{Ref@TeX{}} wraps | |
203 itself round 4 LaTeX macros: @code{\label}, @code{\ref}, @code{\cite}, | |
204 and @code{\index}. Using these macros usually requires looking up | |
205 different parts of the document and searching through BibTeX database | |
206 files. @b{Ref@TeX{}} automates these time--consuming tasks almost | |
207 entirely. It also provides functions to display the structure of a | |
59536 | 208 document and to move around in this structure quickly. |
25829 | 209 |
210 @iftex | |
211 Don't be discouraged by the size of this manual, which covers @b{Ref@TeX{}} | |
212 in great depth. All you need to know to use @b{Ref@TeX{}} can be | |
213 summarized on two pages (@pxref{RefTeX in a Nutshell}). You can go | |
214 back later to other parts of this document when needed. | |
215 @end iftex | |
216 | |
217 @xref{Imprint}, for information about who to contact for help, bug | |
218 reports or suggestions. | |
219 | |
220 @menu | |
221 * Installation:: How to install and activate RefTeX. | |
222 * RefTeX in a Nutshell:: A brief summary and quick guide. | |
223 @end menu | |
224 | |
225 @node Installation, RefTeX in a Nutshell, , Introduction | |
226 @section Installation | |
227 @cindex Installation | |
228 | |
59536 | 229 @b{Ref@TeX{}} is bundled and pre--installed with Emacs since version |
230 20.2. It was also bundled and pre--installed with XEmacs 19.16--20.x. | |
231 XEmacs 21.x users want to install the corresponding plug-in package | |
232 which is available from the @value{XEMACSFTP}. See the XEmacs 21.x | |
233 documentation on package installation for details. | |
25829 | 234 |
235 Users of earlier Emacs distributions (including Emacs 19) can get a copy | |
236 of the @b{Ref@TeX{}} distribution from the maintainers web-page. | |
59536 | 237 @xref{Imprint}, for more information. |
25829 | 238 |
239 @section Environment | |
240 @cindex Finding files | |
241 @cindex BibTeX database files, not found | |
242 @cindex TeX files, not found | |
243 @cindex @code{TEXINPUTS}, environment variable | |
244 @cindex @code{BIBINPUTS}, environment variable | |
245 | |
246 @b{Ref@TeX{}} needs to access all files which are part of a multifile | |
247 document, and the BibTeX database files requested by the | |
248 @code{\bibliography} command. To find these files, @b{Ref@TeX{}} will | |
249 require a search path, i.e. a list of directories to check. Normally | |
250 this list is stored in the environment variables @code{TEXINPUTS} and | |
251 @code{BIBINPUTS} which are also used by @b{Ref@TeX{}}. However, on some | |
252 systems these variables do not contain the full search path. If | |
253 @b{Ref@TeX{}} does not work for you because it cannot find some files, | |
254 read @ref{Finding Files}. | |
255 | |
256 @section Entering @b{Ref@TeX{}} Mode | |
257 | |
258 @findex turn-on-reftex | |
259 @findex reftex-mode | |
260 @vindex LaTeX-mode-hook | |
261 @vindex latex-mode-hook | |
262 To turn @b{Ref@TeX{}} Mode on and off in a particular buffer, use | |
263 @kbd{M-x reftex-mode}. To turn on @b{Ref@TeX{}} Mode for all LaTeX | |
59536 | 264 files, add the following lines to your @file{.emacs} file: |
25829 | 265 |
266 @example | |
267 (add-hook 'LaTeX-mode-hook 'turn-on-reftex) ; with AUCTeX LaTeX mode | |
268 (add-hook 'latex-mode-hook 'turn-on-reftex) ; with Emacs latex mode | |
269 @end example | |
270 | |
271 @page | |
272 @node RefTeX in a Nutshell, , Installation, Introduction | |
273 @section @b{Ref@TeX{}} in a Nutshell | |
274 @cindex Quick-Start | |
275 @cindex Getting Started | |
276 @cindex RefTeX in a Nutshell | |
277 @cindex Nutshell, RefTeX in a | |
278 | |
279 @enumerate | |
280 @item | |
281 @b{Table of Contents}@* Typing @kbd{C-c =} (@code{reftex-toc}) will show | |
282 a table of contents of the document. This buffer can display sections, | |
283 labels and index entries defined in the document. From the buffer, you | |
284 can jump quickly to every part of your document. Press @kbd{?} to get | |
59536 | 285 help. |
25829 | 286 |
287 @item | |
288 @b{Labels and References}@* @b{Ref@TeX{}} helps to create unique labels | |
289 and to find the correct key for references quickly. It distinguishes | |
290 labels for different environments, knows about all standard | |
291 environments (and many others), and can be configured to recognize any | |
292 additional labeled environments you have defined yourself (variable | |
59536 | 293 @code{reftex-label-alist}). |
25829 | 294 |
295 @itemize @bullet | |
296 @item | |
59579
a588c86a429c
Revision: miles@gnu.org--gnu-2005/emacs--cvs-trunk--0--patch-40
Miles Bader <miles@gnu.org>
parents:
59548
diff
changeset
|
297 @b{Creating Labels}@* |
25829 | 298 Type @kbd{C-c (} (@code{reftex-label}) to insert a label at point. |
299 @b{Ref@TeX{}} will either | |
300 @itemize @minus | |
301 @item | |
302 derive a label from context (default for section labels) | |
303 @item | |
304 prompt for a label string (default for figures and tables) or | |
59579
a588c86a429c
Revision: miles@gnu.org--gnu-2005/emacs--cvs-trunk--0--patch-40
Miles Bader <miles@gnu.org>
parents:
59548
diff
changeset
|
305 @item |
25829 | 306 insert a simple label made of a prefix and a number (all other |
59536 | 307 environments) |
25829 | 308 @end itemize |
309 @noindent | |
310 Which labels are created how is configurable with the variable | |
59536 | 311 @code{reftex-insert-label-flags}. |
25829 | 312 |
313 @item | |
314 @b{Referencing Labels}@* To make a reference, type @kbd{C-c )} | |
315 (@code{reftex-reference}). This shows an outline of the document with | |
316 all labels of a certain type (figure, equation,...) and some label | |
317 context. Selecting a label inserts a @code{\ref@{@var{label}@}} macro | |
59536 | 318 into the original buffer. |
25829 | 319 @end itemize |
320 | |
321 @item | |
322 @b{Citations}@* | |
323 Typing @kbd{C-c [} (@code{reftex-citation}) will let you specify a | |
324 regular expression to search in current BibTeX database files (as | |
325 specified in the @code{\bibliography} command) and pull out a list of | |
326 matches for you to choose from. The list is @emph{formatted} and | |
327 sorted. The selected article is referenced as @samp{\cite@{@var{key}@}} | |
328 (see the variable @code{reftex-cite-format} if you want to insert | |
59536 | 329 different macros). |
25829 | 330 |
331 @item | |
332 @b{Index Support}@* | |
333 @b{Ref@TeX{}} helps to enter index entries. It also compiles all | |
334 entries into an alphabetically sorted @file{*Index*} buffer which you | |
335 can use to check and edit the entries. @b{Ref@TeX{}} knows about the | |
336 standard index macros and can be configured to recognize any additional | |
337 macros you have defined (@code{reftex-index-macros}). Multiple indices | |
59536 | 338 are supported. |
25829 | 339 |
340 @itemize @bullet | |
341 @item | |
342 @b{Creating Index Entries}@* | |
26911
d7f536a01276
Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents:
25829
diff
changeset
|
343 To index the current selection or the word at point, type @kbd{C-c /} |
d7f536a01276
Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents:
25829
diff
changeset
|
344 (@code{reftex-index-selection-or-word}). The default macro |
d7f536a01276
Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents:
25829
diff
changeset
|
345 @code{reftex-index-default-macro} will be used. For a more complex entry |
d7f536a01276
Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents:
25829
diff
changeset
|
346 type @kbd{C-c <} (@code{reftex-index}), select any of the index macros |
59536 | 347 and enter the arguments with completion. |
26911
d7f536a01276
Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents:
25829
diff
changeset
|
348 |
d7f536a01276
Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents:
25829
diff
changeset
|
349 @item |
d7f536a01276
Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents:
25829
diff
changeset
|
350 @b{The Index Phrases File (Delayed Indexing)}@* |
d7f536a01276
Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents:
25829
diff
changeset
|
351 Type @kbd{C-c \} (@code{reftex-index-phrase-selection-or-word}) to add |
d7f536a01276
Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents:
25829
diff
changeset
|
352 the current word or selection to a special @emph{index phrase file}. |
d7f536a01276
Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents:
25829
diff
changeset
|
353 @b{Ref@TeX{}} can later search the document for occurrences of these |
59536 | 354 phrases and let you interactively index the matches. |
26911
d7f536a01276
Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents:
25829
diff
changeset
|
355 |
d7f536a01276
Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents:
25829
diff
changeset
|
356 @item |
d7f536a01276
Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents:
25829
diff
changeset
|
357 @b{Displaying and Editing the Index}@* |
d7f536a01276
Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents:
25829
diff
changeset
|
358 To display the compiled index in a special buffer, type @kbd{C-c >} |
d7f536a01276
Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents:
25829
diff
changeset
|
359 (@code{reftex-display-index}). From that buffer you can check and edit |
59536 | 360 all entries. |
25829 | 361 @end itemize |
362 | |
363 @page | |
364 @item @b{Viewing Cross-References}@* | |
365 When point is on the @var{key} argument of a cross--referencing macro | |
366 (@code{\label}, @code{\ref}, @code{\cite}, @code{\bibitem}, | |
367 @code{\index}, and variations) or inside a BibTeX database entry, you | |
368 can press @kbd{C-c &} (@code{reftex-view-crossref}) to display | |
369 corresponding locations in the document and associated BibTeX database | |
59536 | 370 files. @* |
26911
d7f536a01276
Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents:
25829
diff
changeset
|
371 When the enclosing macro is @code{\cite} or @code{\ref} and no other |
d7f536a01276
Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents:
25829
diff
changeset
|
372 message occupies the echo area, information about the citation or label |
59536 | 373 will automatically be displayed in the echo area. |
25829 | 374 |
375 @item | |
376 @b{Multifile Documents}@* | |
377 Multifile Documents are fully supported. The included files must have a | |
378 file variable @code{TeX-master} or @code{tex-main-file} pointing to the | |
379 master file. @b{Ref@TeX{}} provides cross-referencing information from | |
380 all parts of the document, and across document borders | |
59536 | 381 (@file{xr.sty}). |
25829 | 382 |
383 @item | |
384 @b{Document Parsing}@* @b{Ref@TeX{}} needs to parse the document in | |
385 order to find labels and other information. It does it automatically | |
386 once and updates its list internally when @code{reftex-label} and | |
387 @code{reftex-index} are used. To enforce reparsing, call any of the | |
388 commands described above with a raw @kbd{C-u} prefix, or press the | |
389 @kbd{r} key in the label selection buffer, the table of contents | |
59536 | 390 buffer, or the index buffer. |
25829 | 391 |
392 @item | |
393 @b{AUCTeX} @* If your major LaTeX mode is AUCTeX, @b{Ref@TeX{}} can | |
394 cooperate with it (see variable @code{reftex-plug-into-AUCTeX}). AUCTeX | |
395 contains style files which trigger appropriate settings in | |
396 @b{Ref@TeX{}}, so that for many of the popular LaTeX packages no | |
59536 | 397 additional customizations will be necessary. |
25829 | 398 |
399 @item | |
47050
904fd28be439
Update to RefTeX 4.19
Carsten Dominik <dominik@science.uva.nl>
parents:
46918
diff
changeset
|
400 @b{Useful Settings}@* |
904fd28be439
Update to RefTeX 4.19
Carsten Dominik <dominik@science.uva.nl>
parents:
46918
diff
changeset
|
401 To integrate RefTeX with AUCTeX, use |
25829 | 402 @lisp |
403 (setq reftex-plug-into-AUCTeX t) | |
404 @end lisp | |
405 | |
406 To make your own LaTeX macro definitions known to @b{Ref@TeX{}}, | |
59536 | 407 customize the variables |
25829 | 408 @example |
409 @code{reftex-label-alist} @r{(for label macros/environments)} | |
410 @code{reftex-section-levels} @r{(for sectioning commands)} | |
411 @code{reftex-cite-format} @r{(for @code{\cite}-like macros)} | |
412 @code{reftex-index-macros} @r{(for @code{\index}-like macros)} | |
413 @code{reftex-index-default-macro} @r{(to set the default macro)} | |
414 @end example | |
415 If you have a large number of macros defined, you may want to write | |
416 an AUCTeX style file to support them with both AUCTeX and | |
59536 | 417 @b{Ref@TeX{}}. |
25829 | 418 |
419 @item @b{Where Next?}@* Go ahead and use @b{Ref@TeX{}}. Use its menus | |
420 until you have picked up the key bindings. For an overview of what you | |
421 can do in each of the different special buffers, press @kbd{?}. Read | |
26911
d7f536a01276
Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents:
25829
diff
changeset
|
422 the manual if you get stuck, of if you are curious what else might be |
d7f536a01276
Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents:
25829
diff
changeset
|
423 available. The first part of the manual explains in |
25829 | 424 a tutorial way how to use and customize @b{Ref@TeX{}}. The second |
59579
a588c86a429c
Revision: miles@gnu.org--gnu-2005/emacs--cvs-trunk--0--patch-40
Miles Bader <miles@gnu.org>
parents:
59548
diff
changeset
|
425 part is a command and variable reference. |
25829 | 426 @end enumerate |
427 | |
428 @node Table of Contents, Labels and References, Introduction, Top | |
429 @chapter Table of Contents | |
430 @cindex @file{*toc*} buffer | |
59536 | 431 @cindex Structure editing |
25829 | 432 @cindex Table of contents buffer |
433 @findex reftex-toc | |
434 @kindex C-c = | |
435 | |
436 Pressing the keys @kbd{C-c =} pops up a buffer showing the table of | |
437 contents of the document. By default, this @file{*toc*} buffer shows | |
438 only the sections of a document. Using the @kbd{l} and @kbd{i} keys you | |
439 can display all labels and index entries defined in the document as | |
59536 | 440 well. |
25829 | 441 |
442 With the cursor in any of the lines denoting a location in the | |
443 document, simple key strokes will display the corresponding part in | |
59536 | 444 another window, jump to that location, or perform other actions. |
25829 | 445 |
446 @kindex ? | |
447 Here is a list of special commands in the @file{*toc*} buffer. A | |
448 summary of this information is always available by pressing | |
59536 | 449 @kbd{?}. |
25829 | 450 |
451 @table @kbd | |
452 | |
453 @tablesubheading{General} | |
454 @item ? | |
455 Display a summary of commands. | |
456 | |
457 @item 0-9, - | |
458 Prefix argument. | |
459 | |
460 @tablesubheading{Moving around} | |
461 @item n | |
462 Goto next entry in the table of context. | |
463 | |
464 @item p | |
465 Goto previous entry in the table of context. | |
466 | |
467 @item C-c C-n | |
468 Goto next section heading. Useful when many labels and index entries | |
59536 | 469 separate section headings. |
25829 | 470 |
471 @item C-c C-p | |
472 Goto previous section heading. | |
473 | |
37999
8e7df927fd92
Updated to version 4.16
Carsten Dominik <dominik@science.uva.nl>
parents:
37404
diff
changeset
|
474 @item N z |
8e7df927fd92
Updated to version 4.16
Carsten Dominik <dominik@science.uva.nl>
parents:
37404
diff
changeset
|
475 Jump to section N, using the prefix arg. For example, @kbd{3 z} jumps |
59536 | 476 to section 3. |
37999
8e7df927fd92
Updated to version 4.16
Carsten Dominik <dominik@science.uva.nl>
parents:
37404
diff
changeset
|
477 |
25829 | 478 @tablesubheading{Access to document locations} |
479 @item @key{SPC} | |
480 Show the corresponding location in another window. This command does | |
59536 | 481 @emph{not} select that other window. |
25829 | 482 |
483 @item @key{TAB} | |
484 Goto the location in another window. | |
485 | |
486 @item @key{RET} | |
487 Go to the location and hide the @file{*toc*} buffer. This will restore | |
488 the window configuration before @code{reftex-toc} (@kbd{C-c =}) was | |
59536 | 489 called. |
25829 | 490 |
37999
8e7df927fd92
Updated to version 4.16
Carsten Dominik <dominik@science.uva.nl>
parents:
37404
diff
changeset
|
491 @item mouse-2 |
25829 | 492 @vindex reftex-highlight-selection |
493 Clicking with mouse button 2 on a line has the same effect as @key{RET}. | |
494 See also variable @code{reftex-highlight-selection}, @ref{Options | |
59536 | 495 (Fontification)}. |
25829 | 496 |
497 @item f | |
498 @vindex reftex-toc-follow-mode | |
499 @vindex reftex-revisit-to-follow | |
500 Toggle follow mode. When follow mode is active, the other window will | |
501 always show the location corresponding to the line at point in the | |
502 @file{*toc*} buffer. This is similar to pressing @key{SPC} after each | |
503 cursor motion. The default for this flag can be set with the variable | |
504 @code{reftex-toc-follow-mode}. Note that only context in files already | |
505 visited is shown. @b{Ref@TeX{}} will not visit a file just for follow | |
506 mode. See, however, the variable | |
59536 | 507 @code{reftex-revisit-to-follow}. |
25829 | 508 |
509 @item . | |
510 Show calling point in another window. This is the point from where | |
511 @code{reftex-toc} was last called. | |
512 | |
47050
904fd28be439
Update to RefTeX 4.19
Carsten Dominik <dominik@science.uva.nl>
parents:
46918
diff
changeset
|
513 @page |
59536 | 514 @tablesubheading{Promotion and Demotion} |
515 | |
516 @item < | |
517 Promote the current section. This will convert @code{\section} to | |
518 @code{\chapter}, @code{\subsection} to @code{\section} etc. If there is | |
519 an active region, all sections in the region will be promoted, including | |
520 the one at point. To avoid mistakes, @b{Ref@TeX{}} requires a fresh | |
521 document scan before executing this command - if necessary, it will | |
522 automatically do this scan and ask the user to repeat the promotion | |
523 command. | |
524 | |
525 @item > | |
526 Demote the current section. This is the opposite of promotion. It will | |
527 convert @code{\chapter} to @code{\section} etc. If there is an active | |
528 region, all sections in the region will be demoted, including the one at | |
529 point. | |
530 | |
531 @item M-% | |
532 Rename the label at point. While generally not recommended, this can be | |
533 useful when a package like @file{fancyref} is used where the label | |
534 prefix determines the wording of a reference. After a | |
535 promotion/demotion it may be necessary to change a few labels from | |
536 @samp{sec:xyz} to @samp{cha:xyz} or vice versa. This command can be | |
537 used to do this - it launches a query replace to rename the definition | |
538 and all references of a label. | |
539 | |
25829 | 540 @tablesubheading{Exiting} |
541 @item q | |
542 Hide the @file{*toc*} buffer, return to the position where | |
59536 | 543 @code{reftex-toc} was last called. |
25829 | 544 |
545 @item k | |
546 Kill the @file{*toc*} buffer, return to the position where | |
59536 | 547 @code{reftex-toc} was last called. |
25829 | 548 |
549 @item C-c > | |
550 Switch to the @file{*Index*} buffer of this document. With prefix | |
59579
a588c86a429c
Revision: miles@gnu.org--gnu-2005/emacs--cvs-trunk--0--patch-40
Miles Bader <miles@gnu.org>
parents:
59548
diff
changeset
|
551 @samp{2}, restrict the index to the section at point in the @file{*toc*} |
25829 | 552 buffer. |
553 | |
554 @tablesubheading{Controlling what gets displayed} | |
555 | |
26911
d7f536a01276
Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents:
25829
diff
changeset
|
556 @item t |
d7f536a01276
Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents:
25829
diff
changeset
|
557 @vindex reftex-toc-max-level |
d7f536a01276
Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents:
25829
diff
changeset
|
558 Change the maximum level of toc entries displayed in the @file{*toc*} |
d7f536a01276
Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents:
25829
diff
changeset
|
559 buffer. Without prefix arg, all levels will be included. With prefix |
d7f536a01276
Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents:
25829
diff
changeset
|
560 arg (e.g @kbd{3 t}), ignore all toc entries with level greater than |
d7f536a01276
Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents:
25829
diff
changeset
|
561 @var{arg} (3 in this case). Chapters are level 1, sections are level 2. |
d7f536a01276
Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents:
25829
diff
changeset
|
562 The mode line @samp{T<>} indicator shows the current value. The default |
d7f536a01276
Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents:
25829
diff
changeset
|
563 depth can be configured with the variable |
59536 | 564 @code{reftex-toc-max-level}. |
26911
d7f536a01276
Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents:
25829
diff
changeset
|
565 |
25829 | 566 @item F |
567 @vindex reftex-toc-include-file-boundaries | |
568 Toggle the display of the file borders of a multifile document in the | |
569 @file{*toc*} buffer. The default for this flag can be set with the | |
59536 | 570 variable @code{reftex-toc-include-file-boundaries}. |
25829 | 571 |
572 @item l | |
573 @vindex reftex-toc-include-labels | |
574 Toggle the display of labels in the @file{*toc*} buffer. The default | |
575 for this flag can be set with the variable | |
576 @code{reftex-toc-include-labels}. When called with a prefix argument, | |
577 @b{Ref@TeX{}} will prompt for a label type and include only labels of | |
578 the selected type in the @file{*toc*} buffer. The mode line @samp{L<>} | |
59536 | 579 indicator shows which labels are included. |
25829 | 580 |
581 @item i | |
582 @vindex reftex-toc-include-index-entries | |
583 Toggle the display of index entries in the @file{*toc*} buffer. The | |
584 default for this flag can be set with the variable | |
585 @code{reftex-toc-include-index-entries}. When called with a prefix | |
586 argument, @b{Ref@TeX{}} will prompt for a specific index and include | |
59579
a588c86a429c
Revision: miles@gnu.org--gnu-2005/emacs--cvs-trunk--0--patch-40
Miles Bader <miles@gnu.org>
parents:
59548
diff
changeset
|
587 only entries in the selected index in the @file{*toc*} buffer. The mode |
59536 | 588 line @samp{I<>} indicator shows which index is used. |
25829 | 589 |
590 @item c | |
591 @vindex reftex-toc-include-context | |
592 Toggle the display of label and index context in the @file{*toc*} | |
593 buffer. The default for this flag can be set with the variable | |
59536 | 594 @code{reftex-toc-include-context}. |
25829 | 595 |
596 @tablesubheading{Updating the buffer} | |
597 | |
598 @item g | |
599 Rebuild the @file{*toc*} buffer. This does @emph{not} rescan the | |
59536 | 600 document. |
25829 | 601 |
602 @item r | |
603 @vindex reftex-enable-partial-scans | |
604 Reparse the LaTeX document and rebuild the @file{*toc*} buffer. When | |
59579
a588c86a429c
Revision: miles@gnu.org--gnu-2005/emacs--cvs-trunk--0--patch-40
Miles Bader <miles@gnu.org>
parents:
59548
diff
changeset
|
605 @code{reftex-enable-partial-scans} is non-@code{nil}, rescan only the file this |
59536 | 606 location is defined in, not the entire document. |
25829 | 607 |
608 @item C-u r | |
609 Reparse the @emph{entire} LaTeX document and rebuild the @file{*toc*} | |
59536 | 610 buffer. |
25829 | 611 |
612 @item x | |
613 Switch to the @file{*toc*} buffer of an external document. When the | |
614 current document is using the @code{xr} package (@pxref{xr (LaTeX | |
615 package)}), @b{Ref@TeX{}} will switch to one of the external | |
59536 | 616 documents. |
617 | |
618 | |
619 @tablesubheading{Automatic recentering} | |
620 | |
621 @item d | |
622 Toggle the display of a dedicated frame displaying just the @file{*toc*} | |
623 buffer. Follow mode and visiting locations will not work that frame, | |
624 but automatic recentering will make this frame always show your current | |
625 editing location in the document (see below). | |
25829 | 626 |
47050
904fd28be439
Update to RefTeX 4.19
Carsten Dominik <dominik@science.uva.nl>
parents:
46918
diff
changeset
|
627 @item a |
904fd28be439
Update to RefTeX 4.19
Carsten Dominik <dominik@science.uva.nl>
parents:
46918
diff
changeset
|
628 Toggle the automatic recentering of the @file{*toc*} buffer. When this |
904fd28be439
Update to RefTeX 4.19
Carsten Dominik <dominik@science.uva.nl>
parents:
46918
diff
changeset
|
629 option is on, moving around in the document will cause the @file{*toc*} |
59536 | 630 to always highlight the current section. By default, this option is |
631 active while the dedicated @file{*TOC*} frame exists. See also the | |
632 variable @code{reftex-auto-recenter-toc}. | |
47050
904fd28be439
Update to RefTeX 4.19
Carsten Dominik <dominik@science.uva.nl>
parents:
46918
diff
changeset
|
633 |
25829 | 634 @end table |
635 | |
636 @vindex reftex-toc-map | |
637 In order to define additional commands for the @file{*toc*} buffer, the | |
59536 | 638 keymap @code{reftex-toc-map} may be used. |
25829 | 639 |
47050
904fd28be439
Update to RefTeX 4.19
Carsten Dominik <dominik@science.uva.nl>
parents:
46918
diff
changeset
|
640 @findex reftex-toc-recenter |
904fd28be439
Update to RefTeX 4.19
Carsten Dominik <dominik@science.uva.nl>
parents:
46918
diff
changeset
|
641 @vindex reftex-auto-recenter-toc |
904fd28be439
Update to RefTeX 4.19
Carsten Dominik <dominik@science.uva.nl>
parents:
46918
diff
changeset
|
642 @vindex reftex-idle-time |
904fd28be439
Update to RefTeX 4.19
Carsten Dominik <dominik@science.uva.nl>
parents:
46918
diff
changeset
|
643 @cindex @file{*toc*} buffer, recentering |
904fd28be439
Update to RefTeX 4.19
Carsten Dominik <dominik@science.uva.nl>
parents:
46918
diff
changeset
|
644 @cindex Table of contents buffer, recentering |
904fd28be439
Update to RefTeX 4.19
Carsten Dominik <dominik@science.uva.nl>
parents:
46918
diff
changeset
|
645 @kindex C-c - |
904fd28be439
Update to RefTeX 4.19
Carsten Dominik <dominik@science.uva.nl>
parents:
46918
diff
changeset
|
646 If you call @code{reftex-toc} while the @file{*toc*} buffer already |
904fd28be439
Update to RefTeX 4.19
Carsten Dominik <dominik@science.uva.nl>
parents:
46918
diff
changeset
|
647 exists, the cursor will immediately jump to the right place, i.e. the |
904fd28be439
Update to RefTeX 4.19
Carsten Dominik <dominik@science.uva.nl>
parents:
46918
diff
changeset
|
648 section from which @code{reftex-toc} was called will be highlighted. |
904fd28be439
Update to RefTeX 4.19
Carsten Dominik <dominik@science.uva.nl>
parents:
46918
diff
changeset
|
649 The command @kbd{C-c -} (@code{reftex-toc-recenter}) will only redisplay |
904fd28be439
Update to RefTeX 4.19
Carsten Dominik <dominik@science.uva.nl>
parents:
46918
diff
changeset
|
650 the @file{*toc*} buffer and highlight the correct line without actually |
904fd28be439
Update to RefTeX 4.19
Carsten Dominik <dominik@science.uva.nl>
parents:
46918
diff
changeset
|
651 selecting the @file{*toc*} window. This can be useful to quickly find |
59536 | 652 out where in the document you currently are. You can also automate this |
653 by asking RefTeX to keep track of your current editing position in the | |
654 TOC. The TOC window will then be updated whenever you stop typing for | |
655 more than @code{reftex-idle-time} seconds. By default this works only | |
656 with the dedicated @file{*TOC*} frame. But you can also force automatic | |
657 recentering of the TOC window on the current frame with | |
47050
904fd28be439
Update to RefTeX 4.19
Carsten Dominik <dominik@science.uva.nl>
parents:
46918
diff
changeset
|
658 @lisp |
904fd28be439
Update to RefTeX 4.19
Carsten Dominik <dominik@science.uva.nl>
parents:
46918
diff
changeset
|
659 (setq reftex-auto-recenter-toc t) |
904fd28be439
Update to RefTeX 4.19
Carsten Dominik <dominik@science.uva.nl>
parents:
46918
diff
changeset
|
660 @end lisp |
904fd28be439
Update to RefTeX 4.19
Carsten Dominik <dominik@science.uva.nl>
parents:
46918
diff
changeset
|
661 |
904fd28be439
Update to RefTeX 4.19
Carsten Dominik <dominik@science.uva.nl>
parents:
46918
diff
changeset
|
662 |
25829 | 663 @cindex Sectioning commands |
664 @cindex KOMA-Script, LaTeX classes | |
665 @cindex LaTeX classes, KOMA-Script | |
26911
d7f536a01276
Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents:
25829
diff
changeset
|
666 @cindex TOC entries for environments |
25829 | 667 @vindex reftex-section-levels |
668 The section macros recognized by @b{Ref@TeX{}} are all LaTeX section | |
669 macros (from @code{\part} to @code{\subsubparagraph}) and the commands | |
670 @code{\addchap} and @code{\addsec} from the KOMA-Script classes. | |
671 Additional macros can be configured with the variable | |
26911
d7f536a01276
Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents:
25829
diff
changeset
|
672 @code{reftex-section-levels}. It is also possible to add certain LaTeX |
d7f536a01276
Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents:
25829
diff
changeset
|
673 environments to the table of contents. This is probably only useful for |
d7f536a01276
Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents:
25829
diff
changeset
|
674 theorem-like environments. @xref{Defining Label Environments}, for an |
d7f536a01276
Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents:
25829
diff
changeset
|
675 example. |
25829 | 676 |
677 @node Labels and References, Citations, Table of Contents, Top | |
678 @chapter Labels and References | |
679 @cindex Labels in LaTeX | |
680 @cindex References in LaTeX | |
681 @cindex Label category | |
682 @cindex Label environment | |
683 @cindex @code{\label} | |
684 | |
685 LaTeX provides a powerful mechanism to deal with cross--references in a | |
686 document. When writing a document, any part of it can be marked with a | |
687 label, like @samp{\label@{mark@}}. LaTeX records the current value of a | |
688 certain counter when a label is defined. Later references to this label | |
689 (like @samp{\ref@{mark@}}) will produce the recorded value of the | |
59536 | 690 counter. |
25829 | 691 |
692 Labels can be used to mark sections, figures, tables, equations, | |
693 footnotes, items in enumerate lists etc. LaTeX is context sensitive in | |
694 doing this: A label defined in a figure environment automatically | |
59536 | 695 records the figure counter, not the section counter. |
25829 | 696 |
697 Several different environments can share a common counter and therefore | |
698 a common label category. E.g. labels in both @code{equation} and | |
699 @code{eqnarray} environments record the value of the same counter - the | |
59536 | 700 equation counter. |
25829 | 701 |
702 @menu | |
703 * Creating Labels:: | |
704 * Referencing Labels:: | |
705 * Builtin Label Environments:: The environments RefTeX knows about. | |
706 * Defining Label Environments:: ... and environments it doesn't. | |
707 * Reference Info:: View the label corresponding to a \ref. | |
708 * xr (LaTeX package):: References to external documents. | |
709 * varioref (LaTeX package):: How to create \vref instead of \ref. | |
710 * fancyref (LaTeX package):: How to create \fref instead of \ref. | |
711 @end menu | |
712 | |
713 @node Creating Labels, Referencing Labels, , Labels and References | |
714 @section Creating Labels | |
715 @cindex Creating labels | |
716 @cindex Labels, creating | |
717 @cindex Labels, deriving from context | |
718 @kindex C-c ( | |
719 @findex reftex-label | |
720 | |
721 In order to create a label in a LaTeX document, press @kbd{C-c (} | |
722 (@code{reftex-label}). Just like LaTeX, @b{Ref@TeX{}} is context sensitive | |
723 and will figure out the environment it currently is in and adapt the | |
724 label to that environment. A label usually consists of a short prefix | |
725 indicating the type of the label and a unique mark. @b{Ref@TeX{}} has | |
59536 | 726 3 different modes to create this mark. |
25829 | 727 |
728 @enumerate | |
729 @item | |
730 @vindex reftex-translate-to-ascii-function | |
731 @vindex reftex-derive-label-parameters | |
732 @vindex reftex-label-illegal-re | |
733 @vindex reftex-abbrev-parameters | |
734 A label can be derived from context. This means, @b{Ref@TeX{}} takes | |
735 the context of the label definition and constructs a label from | |
736 that@footnote{Note that the context may contain constructs which are | |
60919
3ad3287d2e49
* calc.texi, reftex.texi: Replace `illegal' with `invalid'.
Werner LEMBERG <wl@gnu.org>
parents:
59731
diff
changeset
|
737 invalid in labels. @b{Ref@TeX{}} will therefore strip the accent from |
25829 | 738 accented Latin-1 characters and remove everything else which is not |
60927
bae786986f2e
* calc.texi, cl.texi, gnus.texi, idlwave.texi, reftex.texi: Replace
Werner LEMBERG <wl@gnu.org>
parents:
60919
diff
changeset
|
739 valid in labels. This mechanism is safe, but may not be satisfactory |
25829 | 740 for non-western languages. Check the following variables if you need to |
741 change things: @code{reftex-translate-to-ascii-function}, | |
742 @code{reftex-derive-label-parameters}, @code{reftex-label-illegal-re}, | |
743 @code{reftex-abbrev-parameters}.}. This works best for section labels, | |
744 where the section heading is used to construct a label. In fact, | |
745 @b{Ref@TeX{}}'s default settings use this method only for section | |
746 labels. You will be asked to confirm the derived label, or edit | |
59536 | 747 it. |
25829 | 748 |
749 @item | |
750 We may also use a simple unique number to identify a label. This is | |
751 mostly useful for labels where it is difficult to come up with a very | |
752 good descriptive name. @b{Ref@TeX{}}'s default settings use this method | |
753 for equations, enumerate items and footnotes. The author of @b{Ref@TeX{}} | |
754 tends to write documents with many equations and finds it impossible | |
755 to come up with good names for each of them. These simple labels are | |
756 inserted without query, and are therefore very fast. Good descriptive | |
757 names are not really necessary as @b{Ref@TeX{}} will provide context to | |
59536 | 758 reference a label (@pxref{Referencing Labels}). |
25829 | 759 |
760 @item | |
761 The third method is to ask the user for a label. This is most | |
762 useful for things which are easy to describe briefly and do not turn up | |
763 too frequently in a document. @b{Ref@TeX{}} uses this for figures and | |
764 tables. Of course, one can enter the label directly by typing the full | |
765 @samp{\label@{mark@}}. The advantage of using @code{reftex-label} | |
766 anyway is that @b{Ref@TeX{}} will know that a new label has been defined. | |
767 It will then not be necessary to rescan the document in order to access | |
59536 | 768 this label later. |
25829 | 769 @end enumerate |
770 | |
771 @vindex reftex-insert-label-flags | |
772 If you want to change the way certain labels are created, check out the | |
773 variable @code{reftex-insert-label-flags} (@pxref{Options (Creating | |
59536 | 774 Labels)}). |
25829 | 775 |
776 If you are using AUCTeX to write your LaTeX documents, you can | |
777 set it up to delegate the creation of labels to | |
778 @b{Ref@TeX{}}. @xref{AUCTeX}, for more information. | |
779 | |
780 @node Referencing Labels, Builtin Label Environments, Creating Labels, Labels and References | |
781 @section Referencing Labels | |
782 @cindex Referencing labels | |
783 @cindex Labels, referencing | |
784 @cindex Selection buffer, labels | |
785 @cindex Selection process | |
786 @cindex @code{\ref} | |
787 @kindex C-c ) | |
788 @findex reftex-reference | |
789 | |
59536 | 790 @vindex reftex-trust-label-prefix |
791 @b{Ref@TeX{}} scans the document in order to find all labels. To make | |
792 referencing labels easier, it assigns to each label a category, the | |
793 @emph{label type} (for example section, table, figure, equation, etc.). | |
794 In order to determine the label type, RefTeX parses around each label | |
795 to see in what kind of environments it is located. You can speed up | |
796 the parsing by using type-specific prefixes for labels and configuring | |
797 the variable @code{reftex-trust-label-prefix}. | |
798 | |
25829 | 799 Referencing Labels is really at the heart of @b{Ref@TeX{}}. Press @kbd{C-c |
800 )} in order to reference a label (reftex-reference). This will start a | |
801 selection process and finally insert the complete @samp{\ref@{label@}} | |
59536 | 802 into the buffer. |
25829 | 803 |
804 First, @b{Ref@TeX{}} will determine the label category which is required. | |
805 Often that can be figured out from context. For example, if you | |
806 write @samp{As shown in eq.} and the press @kbd{C-c )}, @b{Ref@TeX{}} knows | |
807 that an equation label is going to be referenced. If it cannot figure | |
59536 | 808 out what label category is needed, it will query for one. |
25829 | 809 |
810 You will then be presented with a label selection menu. This is a | |
811 special buffer which contains an outline of the document along with all | |
812 labels of the given label category. In addition, next to the label | |
813 there will be one line of context of the label definition, which is some | |
814 text in the buffer near the label definition. Usually this is | |
815 sufficient to identify the label. If you are unsure about a certain | |
816 label, pressing @key{SPC} will show the label definition point in | |
59536 | 817 another window. |
25829 | 818 |
819 In order to reference a label, move to cursor to the correct label and | |
820 press @key{RET}. You can also reference several labels with a single | |
821 call to @code{reftex-reference} by marking entries with the @kbd{m} | |
822 key (see below). | |
823 | |
824 @kindex ? | |
825 Here is a list of special commands in the selection buffer. A summary | |
826 of this information is always available from the selection process by | |
59536 | 827 pressing @kbd{?}. |
25829 | 828 |
829 | |
830 | |
831 @table @kbd | |
832 @tablesubheading{General} | |
833 @item ? | |
834 Show a summary of available commands. | |
835 | |
836 @item 0-9,- | |
837 Prefix argument. | |
838 | |
839 @tablesubheading{Moving around} | |
840 @item n | |
841 Go to next label. | |
842 | |
843 @item p | |
844 Go to previous label. | |
845 | |
846 @item b | |
847 Jump back to the position where you last left the selection buffer. | |
59536 | 848 Normally this should get you back to the last referenced label. |
25829 | 849 |
850 @item C-c C-n | |
851 Goto next section heading. | |
852 | |
853 @item C-c C-p | |
854 Goto previous section heading. | |
855 | |
37999
8e7df927fd92
Updated to version 4.16
Carsten Dominik <dominik@science.uva.nl>
parents:
37404
diff
changeset
|
856 @item N z |
59579
a588c86a429c
Revision: miles@gnu.org--gnu-2005/emacs--cvs-trunk--0--patch-40
Miles Bader <miles@gnu.org>
parents:
59548
diff
changeset
|
857 Jump to section N, using the prefix arg. For example @kbd{3 z} jumps to |
59536 | 858 section 3. |
37999
8e7df927fd92
Updated to version 4.16
Carsten Dominik <dominik@science.uva.nl>
parents:
37404
diff
changeset
|
859 |
25829 | 860 @tablesubheading{Displaying Context} |
861 @item @key{SPC} | |
862 Show the surroundings of the definition of the current label in another | |
59536 | 863 window. See also the @kbd{f} key. |
25829 | 864 |
865 @item f | |
866 @vindex reftex-revisit-to-follow | |
867 Toggle follow mode. When follow mode is active, the other window will | |
868 always display the full context of the current label. This is similar | |
869 to pressing @key{SPC} after each cursor motion. Note that only context | |
870 in files already visited is shown. @b{RefTeX} will not visit a file | |
871 just for follow mode. See, however, the variable | |
59536 | 872 @code{reftex-revisit-to-follow}. |
25829 | 873 |
874 @item . | |
875 Show insertion point in another window. This is the point from where you | |
59536 | 876 called @code{reftex-reference}. |
25829 | 877 |
878 @tablesubheading{Selecting a label and creating the reference} | |
879 @item @key{RET} | |
880 Insert a reference to the label at point into the buffer from which the | |
881 selection process was started. When entries have been marked, @key{RET} | |
59536 | 882 references all marked labels. |
25829 | 883 |
37999
8e7df927fd92
Updated to version 4.16
Carsten Dominik <dominik@science.uva.nl>
parents:
37404
diff
changeset
|
884 @item mouse-2 |
25829 | 885 @vindex reftex-highlight-selection |
886 Clicking with mouse button 2 on a label will accept it like @key{RET} | |
887 would. See also variable @code{reftex-highlight-selection}, @ref{Options | |
59536 | 888 (Misc)}. |
25829 | 889 |
890 @vindex reftex-multiref-punctuation | |
891 @item m - + , | |
892 Mark the current entry. When several entries have been marked, pressing | |
893 @kbd{RET} will accept all of them and place them into several | |
894 @code{\ref} macros. The special markers @samp{,-+} also store a | |
895 separator to be inserted before the corresponding reference. So marking | |
896 six entries with the keys @samp{m , , - , +} will give a reference list | |
897 like this (see the variable @code{reftex-multiref-punctuation}) | |
898 @example | |
899 In eqs. (1), (2), (3)--(4), (5) and (6) | |
900 @end example | |
901 | |
902 @item u | |
903 Unmark a marked entry. | |
904 | |
905 @c FIXME: Do we need `A' as well for consistency? | |
906 @cindex LaTeX packages, @code{saferef} | |
907 @cindex @code{saferef}, LaTeX package | |
908 @item a | |
909 Accept the marked entries and put all labels as a comma-separated list | |
910 into one @emph{single} @code{\ref} macro. Some packages like | |
59536 | 911 @file{saferef.sty} support multiple references in this way. |
25829 | 912 |
913 @item l | |
914 Use the last referenced label(s) again. This is equivalent to moving to | |
59536 | 915 that label and pressing @key{RET}. |
25829 | 916 |
917 @item @key{TAB} | |
918 Enter a label with completion. This may also be a label which does not | |
919 yet exist in the document. | |
920 | |
921 @item v | |
922 @cindex @code{varioref}, LaTeX package | |
923 @cindex @code{\vref} | |
924 @cindex LaTeX packages, @code{varioref} | |
925 Toggle between @code{\ref} and @code{\vref} macro for references. The | |
926 @code{\vref} macro is defined in the @code{varioref} LaTeX package. | |
927 With this key you can force @b{Ref@TeX{}} to insert a @code{\vref} | |
928 macro. The current state of this flag is displayed by the @samp{S<>} | |
59536 | 929 indicator in the mode line of the selection buffer. |
25829 | 930 |
931 @item V | |
932 @cindex @code{fancyref}, LaTeX package | |
933 @cindex @code{\fref} | |
934 @cindex @code{\Fref} | |
935 @cindex LaTeX packages, @code{fancyref} | |
936 Cycle between @code{\ref}, @code{\fref} and @code{\Fref}. The | |
937 @code{\fref} and @code{\Fref} macros are defined in the @code{fancyref} | |
938 LaTeX package. With this key you can force @b{Ref@TeX{}} to insert a | |
939 @code{\fref} or @code{\Fref} macro. The current state of this flag is | |
940 displayed by the @samp{S<>} indicator in the mode line of the | |
941 selection buffer. | |
942 | |
943 @tablesubheading{Exiting} | |
944 | |
945 @item q | |
946 Exit the selection process without inserting any reference into the | |
59536 | 947 buffer. |
25829 | 948 |
949 @tablesubheading{Controlling what gets displayed} | |
950 @vindex reftex-label-menu-flags | |
59579
a588c86a429c
Revision: miles@gnu.org--gnu-2005/emacs--cvs-trunk--0--patch-40
Miles Bader <miles@gnu.org>
parents:
59548
diff
changeset
|
951 The defaults for the following flags can be configured with the variable |
25829 | 952 @code{reftex-label-menu-flags} (@pxref{Options (Referencing Labels)}). |
953 | |
954 @item c | |
955 Toggle the display of the one-line label definition context in the | |
59536 | 956 selection buffer. |
25829 | 957 |
958 @item F | |
959 Toggle the display of the file borders of a multifile document in the | |
59536 | 960 selection buffer. |
25829 | 961 |
962 @item t | |
26911
d7f536a01276
Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents:
25829
diff
changeset
|
963 Toggle the display of the table of contents in the selection buffer. |
59579
a588c86a429c
Revision: miles@gnu.org--gnu-2005/emacs--cvs-trunk--0--patch-40
Miles Bader <miles@gnu.org>
parents:
59548
diff
changeset
|
964 With prefix @var{arg}, change the maximum level of toc entries displayed |
59536 | 965 to @var{arg}. Chapters are level 1, section are level 2. |
25829 | 966 |
967 @item # | |
59536 | 968 Toggle the display of a label counter in the selection buffer. |
25829 | 969 |
970 @item % | |
971 Toggle the display of labels hidden in comments in the selection | |
972 buffers. Sometimes, you may have commented out parts of your document. | |
973 If these parts contain label definitions, @b{Ref@TeX{}} can still display | |
59536 | 974 and reference these labels. |
25829 | 975 |
976 @tablesubheading{Updating the buffer} | |
977 @item g | |
978 Update the menu. This will rebuilt the menu from the internal label | |
59536 | 979 list, but not reparse the document (see @kbd{r}). |
25829 | 980 |
981 @item r | |
982 @vindex reftex-enable-partial-scans | |
983 Reparse the document to update the information on all labels and rebuild | |
984 the menu. If the variable @code{reftex-enable-partial-scans} is | |
985 non-@code{nil} and your document is a multifile document, this will | |
986 reparse only a part of the document (the file in which the label at | |
59536 | 987 point was defined). |
25829 | 988 |
989 @item C-u r | |
990 Reparse the @emph{entire} document. | |
991 | |
992 @item s | |
993 Switch the label category. After prompting for another label category, | |
59536 | 994 a menu for that category will be shown. |
25829 | 995 |
996 @item x | |
997 Reference a label from an external document. With the LaTeX package | |
998 @code{xr} it is possible to reference labels defined in another | |
999 document. This key will switch to the label menu of an external | |
1000 document and let you select a label from there (@pxref{xr (LaTeX | |
59536 | 1001 package),,xr}). |
25829 | 1002 |
1003 @end table | |
1004 | |
1005 @vindex reftex-select-label-map | |
1006 In order to define additional commands for the selection process, the | |
59536 | 1007 keymap @code{reftex-select-label-map} may be used. |
25829 | 1008 |
1009 @node Builtin Label Environments, Defining Label Environments, Referencing Labels, Labels and References | |
1010 @section Builtin Label Environments | |
1011 @cindex Builtin label environments | |
1012 @cindex Label environments, builtin | |
1013 @cindex Environments, builtin | |
1014 @vindex reftex-label-alist | |
1015 @vindex reftex-label-alist-builtin | |
1016 | |
1017 @b{Ref@TeX{}} needs to be aware of the environments which can be referenced | |
1018 with a label (i.e. which carry their own counters). By default, @b{Ref@TeX{}} | |
1019 recognizes all labeled environments and macros discussed in @cite{The | |
1020 LaTeX Companion by Goossens, Mittelbach & Samarin, Addison-Wesley | |
59536 | 1021 1994.}. These are: |
25829 | 1022 |
1023 @itemize @minus | |
1024 @item | |
1025 @cindex @code{figure}, LaTeX environment | |
1026 @cindex @code{figure*}, LaTeX environment | |
1027 @cindex @code{table}, LaTeX environment | |
1028 @cindex @code{table*}, LaTeX environment | |
1029 @cindex @code{equation}, LaTeX environment | |
1030 @cindex @code{eqnarray}, LaTeX environment | |
1031 @cindex @code{enumerate}, LaTeX environment | |
1032 @cindex @code{\footnote}, LaTeX macro | |
1033 @cindex LaTeX macro @code{footnote} | |
1034 @cindex LaTeX core | |
1035 @code{figure}, @code{figure*}, @code{table}, @code{table*}, @code{equation}, | |
1036 @code{eqnarray}, @code{enumerate}, the @code{\footnote} macro (this is | |
59536 | 1037 the LaTeX core stuff) |
25829 | 1038 @item |
1039 @cindex AMS-LaTeX | |
1040 @cindex @code{amsmath}, LaTeX package | |
1041 @cindex LaTeX packages, @code{amsmath} | |
1042 @cindex @code{align}, AMS-LaTeX environment | |
1043 @cindex @code{gather}, AMS-LaTeX environment | |
1044 @cindex @code{multline}, AMS-LaTeX environment | |
1045 @cindex @code{flalign}, AMS-LaTeX environment | |
1046 @cindex @code{alignat}, AMS-LaTeX environment | |
1047 @cindex @code{xalignat}, AMS-LaTeX environment | |
1048 @cindex @code{xxalignat}, AMS-LaTeX environment | |
1049 @cindex @code{subequations}, AMS-LaTeX environment | |
1050 @code{align}, @code{gather}, @code{multline}, @code{flalign}, | |
1051 @code{alignat}, @code{xalignat}, @code{xxalignat}, @code{subequations} | |
59536 | 1052 (from AMS-LaTeX's @file{amsmath.sty} package) |
25829 | 1053 @item |
1054 @cindex @code{endnote}, LaTeX package | |
1055 @cindex LaTeX packages, @code{endnote} | |
1056 @cindex @code{\endnote}, LaTeX macro | |
1057 the @code{\endnote} macro (from @file{endnotes.sty}) | |
1058 @item | |
1059 @cindex @code{fancybox}, LaTeX package | |
1060 @cindex LaTeX packages, @code{fancybox} | |
1061 @cindex @code{Beqnarray}, LaTeX environment | |
1062 @code{Beqnarray} (@file{fancybox.sty}) | |
1063 @item | |
1064 @cindex @code{floatfig}, LaTeX package | |
1065 @cindex LaTeX packages, @code{floatfig} | |
1066 @cindex @code{floatingfig}, LaTeX environment | |
1067 @code{floatingfig} (@file{floatfig.sty}) | |
1068 @item | |
1069 @cindex @code{longtable}, LaTeX package | |
1070 @cindex LaTeX packages, @code{longtable} | |
1071 @cindex @code{longtable}, LaTeX environment | |
1072 @code{longtable} (@file{longtable.sty}) | |
1073 @item | |
1074 @cindex @code{picinpar}, LaTeX package | |
1075 @cindex LaTeX packages, @code{picinpar} | |
1076 @cindex @code{figwindow}, LaTeX environment | |
1077 @cindex @code{tabwindow}, LaTeX environment | |
1078 @code{figwindow}, @code{tabwindow} (@file{picinpar.sty}) | |
1079 @item | |
1080 @cindex @code{sidecap}, LaTeX package | |
1081 @cindex LaTeX packages, @code{sidecap} | |
1082 @cindex @code{SCfigure}, LaTeX environment | |
1083 @cindex @code{SCtable}, LaTeX environment | |
1084 @code{SCfigure}, @code{SCtable} (@file{sidecap.sty}) | |
1085 @item | |
1086 @cindex @code{rotating}, LaTeX package | |
1087 @cindex LaTeX packages, @code{rotating} | |
1088 @cindex @code{sidewaysfigure}, LaTeX environment | |
1089 @cindex @code{sidewaystable}, LaTeX environment | |
1090 @code{sidewaysfigure}, @code{sidewaystable} (@file{rotating.sty}) | |
1091 @item | |
1092 @cindex @code{subfig}, LaTeX package | |
1093 @cindex LaTeX packages, @code{subfigure} | |
1094 @cindex @code{subfigure}, LaTeX environment | |
1095 @cindex @code{subfigure*}, LaTeX environment | |
1096 @code{subfigure}, @code{subfigure*}, the @code{\subfigure} macro | |
59536 | 1097 (@file{subfigure.sty}) |
25829 | 1098 @item |
1099 @cindex @code{supertab}, LaTeX package | |
1100 @cindex LaTeX packages, @code{supertab} | |
1101 @cindex @code{supertabular}, LaTeX environment | |
1102 @code{supertabular} (@file{supertab.sty}) | |
1103 @item | |
1104 @cindex @code{wrapfig}, LaTeX package | |
1105 @cindex LaTeX packages, @code{wrapfig} | |
1106 @cindex @code{wrapfigure}, LaTeX environment | |
1107 @code{wrapfigure} (@file{wrapfig.sty}) | |
1108 @end itemize | |
1109 | |
1110 If you want to use other labeled environments, defined with | |
1111 @code{\newtheorem}, @b{Ref@TeX{}} needs to be configured to recognize | |
59536 | 1112 them (@pxref{Defining Label Environments}). |
25829 | 1113 |
1114 @node Defining Label Environments, Reference Info, Builtin Label Environments, Labels and References | |
1115 @section Defining Label Environments | |
1116 @cindex Label environments, defining | |
1117 | |
1118 @vindex reftex-label-alist | |
1119 @b{Ref@TeX{}} can be configured to recognize additional labeled | |
1120 environments and macros. This is done with the variable | |
1121 @code{reftex-label-alist} (@pxref{Options (Defining Label | |
1122 Environments)}). If you are not familiar with Lisp, you can use the | |
1123 @code{custom} library to configure this rather complex variable. To do | |
1124 this, use | |
1125 | |
1126 @example | |
1127 @kbd{M-x customize-variable @key{RET} reftex-label-alist @key{RET}} | |
1128 @end example | |
1129 | |
1130 @vindex reftex-label-alist-builtin | |
1131 Here we will discuss a few examples, in order to make things clearer. | |
1132 It can also be instructive to look at the constant | |
1133 @code{reftex-label-alist-builtin} which contains the entries for | |
1134 all the builtin environments and macros (@pxref{Builtin Label | |
59536 | 1135 Environments}). |
25829 | 1136 |
1137 @menu | |
1138 * Theorem and Axiom:: Defined with @code{\newenvironment}. | |
1139 * Quick Equation:: When a macro sets the label type. | |
1140 * Figure Wrapper:: When a macro argument is a label. | |
1141 * Adding Magic Words:: Other words for other languages. | |
1142 * Using \eqref:: How to switch to this AMS-LaTeX macro. | |
1143 * Non-Standard Environments:: Environments without \begin and \end | |
1144 * Putting it Together:: How to combine many entries. | |
1145 @end menu | |
1146 | |
1147 @node Theorem and Axiom, Quick Equation, , Defining Label Environments | |
1148 @subsection Theorem and Axiom Environments | |
1149 @cindex @code{theorem}, newtheorem | |
1150 @cindex @code{axiom}, newtheorem | |
1151 @cindex @code{\newtheorem} | |
1152 | |
1153 Suppose you are using @code{\newtheorem} in LaTeX in order to define two | |
59536 | 1154 new environments, @code{theorem} and @code{axiom} |
25829 | 1155 |
1156 @example | |
1157 \newtheorem@{axiom@}@{Axiom@} | |
1158 \newtheorem@{theorem@}@{Theorem@} | |
1159 @end example | |
1160 | |
1161 @noindent | |
1162 to be used like this: | |
1163 | |
1164 @example | |
1165 \begin@{axiom@} | |
1166 \label@{ax:first@} | |
1167 .... | |
1168 \end@{axiom@} | |
1169 @end example | |
1170 | |
1171 So we need to tell @b{Ref@TeX{}} that @code{theorem} and @code{axiom} are new | |
1172 labeled environments which define their own label categories. We can | |
1173 either use Lisp to do this (e.g. in @file{.emacs}) or use the custom | |
1174 library. With Lisp it would look like this | |
1175 | |
1176 @lisp | |
1177 (setq reftex-label-alist | |
26911
d7f536a01276
Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents:
25829
diff
changeset
|
1178 '(("axiom" ?a "ax:" "~\\ref@{%s@}" nil ("axiom" "ax.") -2) |
d7f536a01276
Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents:
25829
diff
changeset
|
1179 ("theorem" ?h "thr:" "~\\ref@{%s@}" t ("theorem" "th.") -3))) |
25829 | 1180 @end lisp |
1181 | |
1182 The type indicator characters @code{?a} and @code{?h} are used for | |
1183 prompts when @b{Ref@TeX{}} queries for a label type. @code{?h} | |
1184 was chosen for @code{theorem} since @code{?t} is already taken by | |
1185 @code{table}. Note that also @code{?s}, @code{?f}, @code{?e}, | |
59536 | 1186 @code{?i}, @code{?n} are already used for standard environments. |
25829 | 1187 |
1188 @noindent | |
1189 The labels for Axioms and Theorems will have the prefixes @samp{ax:} and | |
1190 @samp{thr:}, respectively. @xref{AUCTeX}, for information on how | |
46684
9569bac241a3
Update to RefTeX 4.18
Carsten Dominik <dominik@science.uva.nl>
parents:
46272
diff
changeset
|
1191 AUCTeX can use RefTeX to automatically create labels when a new environment |
9569bac241a3
Update to RefTeX 4.18
Carsten Dominik <dominik@science.uva.nl>
parents:
46272
diff
changeset
|
1192 is inserted into a buffer. Additionally, the following needs to be |
9569bac241a3
Update to RefTeX 4.18
Carsten Dominik <dominik@science.uva.nl>
parents:
46272
diff
changeset
|
1193 added to one's .emacs file before AUCTeX will automatically create |
9569bac241a3
Update to RefTeX 4.18
Carsten Dominik <dominik@science.uva.nl>
parents:
46272
diff
changeset
|
1194 labels for the new environments. |
9569bac241a3
Update to RefTeX 4.18
Carsten Dominik <dominik@science.uva.nl>
parents:
46272
diff
changeset
|
1195 |
9569bac241a3
Update to RefTeX 4.18
Carsten Dominik <dominik@science.uva.nl>
parents:
46272
diff
changeset
|
1196 @lisp |
9569bac241a3
Update to RefTeX 4.18
Carsten Dominik <dominik@science.uva.nl>
parents:
46272
diff
changeset
|
1197 (add-hook 'LaTeX-mode-hook |
9569bac241a3
Update to RefTeX 4.18
Carsten Dominik <dominik@science.uva.nl>
parents:
46272
diff
changeset
|
1198 (lambda () |
9569bac241a3
Update to RefTeX 4.18
Carsten Dominik <dominik@science.uva.nl>
parents:
46272
diff
changeset
|
1199 (LaTeX-add-environments |
9569bac241a3
Update to RefTeX 4.18
Carsten Dominik <dominik@science.uva.nl>
parents:
46272
diff
changeset
|
1200 '("axiom" LaTeX-env-label) |
9569bac241a3
Update to RefTeX 4.18
Carsten Dominik <dominik@science.uva.nl>
parents:
46272
diff
changeset
|
1201 '("theorem" LaTeX-env-label)))) |
9569bac241a3
Update to RefTeX 4.18
Carsten Dominik <dominik@science.uva.nl>
parents:
46272
diff
changeset
|
1202 @end lisp |
9569bac241a3
Update to RefTeX 4.18
Carsten Dominik <dominik@science.uva.nl>
parents:
46272
diff
changeset
|
1203 |
25829 | 1204 |
1205 @noindent | |
1206 The @samp{~\ref@{%s@}} is a format string indicating how to insert | |
59536 | 1207 references to these labels. |
25829 | 1208 |
1209 @noindent | |
59536 | 1210 The next item indicates how to grab context of the label definition. |
25829 | 1211 @itemize @minus |
1212 @item | |
1213 @code{t} means to get it from a default location (from the beginning of | |
1214 a @code{\macro} or after the @code{\begin} statement). @code{t} is | |
59536 | 1215 @emph{not} a good choice for eqnarray and similar environments. |
1216 @item | |
1217 @code{nil} means to use the text right after the label definition. | |
25829 | 1218 @item |
1219 For more complex ways of getting context, see the variable | |
1220 @code{reftex-label-alist} (@ref{Options (Defining Label | |
59536 | 1221 Environments)}). |
25829 | 1222 @end itemize |
1223 | |
26911
d7f536a01276
Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents:
25829
diff
changeset
|
1224 The following list of strings is used to guess the correct label type |
d7f536a01276
Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents:
25829
diff
changeset
|
1225 from the word before point when creating a reference. E.g. if you |
25829 | 1226 write: @samp{As we have shown in Theorem} and then press @kbd{C-c )}, |
26911
d7f536a01276
Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents:
25829
diff
changeset
|
1227 @b{Ref@TeX{}} will know that you are looking for a theorem label and |
59536 | 1228 restrict the menu to only these labels without even asking. |
26911
d7f536a01276
Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents:
25829
diff
changeset
|
1229 |
d7f536a01276
Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents:
25829
diff
changeset
|
1230 The final item in each entry is the level at which the environment |
d7f536a01276
Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents:
25829
diff
changeset
|
1231 should produce entries in the table of context buffer. If the number is |
d7f536a01276
Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents:
25829
diff
changeset
|
1232 positive, the environment will produce numbered entries (like |
d7f536a01276
Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents:
25829
diff
changeset
|
1233 @code{\section}), if it is negative the entries will be unnumbered (like |
d7f536a01276
Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents:
25829
diff
changeset
|
1234 @code{\section*}). Use this only for environments which structure the |
d7f536a01276
Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents:
25829
diff
changeset
|
1235 document similar to sectioning commands. For everything else, omit the |
59536 | 1236 item. |
25829 | 1237 |
1238 To do the same configuration with @code{customize}, you need to click on | |
1239 the @code{[INS]} button twice to create two templates and fill them in | |
59536 | 1240 like this: |
25829 | 1241 |
1242 @example | |
1243 Reftex Label Alist: [Hide] | |
1244 [INS] [DEL] Package or Detailed : [Value Menu] Detailed: | |
1245 Environment or \macro : [Value Menu] String: axiom | |
1246 Type specification : [Value Menu] Char : a | |
1247 Label prefix string : [Value Menu] String: ax: | |
1248 Label reference format: [Value Menu] String: ~\ref@{%s@} | |
1249 Context method : [Value Menu] After label | |
1250 Magic words: | |
1251 [INS] [DEL] String: axiom | |
1252 [INS] [DEL] String: ax. | |
1253 [INS] | |
26911
d7f536a01276
Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents:
25829
diff
changeset
|
1254 [X] Make TOC entry : [Value Menu] Level: -2 |
25829 | 1255 [INS] [DEL] Package or Detailed : [Value Menu] Detailed: |
1256 Environment or \macro : [Value Menu] String: theorem | |
1257 Type specification : [Value Menu] Char : h | |
1258 Label prefix string : [Value Menu] String: thr: | |
1259 Label reference format: [Value Menu] String: ~\ref@{%s@} | |
1260 Context method : [Value Menu] Default position | |
1261 Magic words: | |
1262 [INS] [DEL] String: theorem | |
1263 [INS] [DEL] String: theor. | |
1264 [INS] [DEL] String: th. | |
1265 [INS] | |
26911
d7f536a01276
Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents:
25829
diff
changeset
|
1266 [X] Make TOC entry : [Value Menu] Level: -3 |
25829 | 1267 @end example |
1268 | |
1269 @vindex reftex-insert-label-flags | |
1270 @vindex reftex-label-menu-flags | |
1271 Depending on how you would like the label insertion and selection for | |
1272 the new environments to work, you might want to add the letters @samp{a} | |
1273 and @samp{h} to some of the flags in the variables | |
1274 @code{reftex-insert-label-flags} (@pxref{Options (Creating Labels)}) | |
1275 and @code{reftex-label-menu-flags} (@pxref{Options (Referencing | |
59536 | 1276 Labels)}). |
25829 | 1277 |
1278 | |
1279 @node Quick Equation, Figure Wrapper, Theorem and Axiom , Defining Label Environments | |
1280 @subsection Quick Equation Macro | |
1281 @cindex Quick equation macro | |
1282 @cindex Macros as environment wrappers | |
1283 | |
1284 Suppose you would like to have a macro for quick equations. It | |
1285 could be defined like this: | |
1286 | |
1287 @example | |
1288 \newcommand@{\quickeq@}[1]@{\begin@{equation@} #1 \end@{equation@}@} | |
1289 @end example | |
1290 | |
1291 @noindent | |
1292 and used like this: | |
1293 | |
1294 @example | |
1295 Einstein's equation is \quickeq@{E=mc^2 \label@{eq:einstein@}@}. | |
1296 @end example | |
1297 | |
1298 We need to tell @b{Ref@TeX{}} that any label defined in the argument of the | |
1299 @code{\quickeq} is an equation label. Here is how to do this with lisp: | |
1300 | |
1301 @lisp | |
1302 (setq reftex-label-alist '(("\\quickeq@{@}" ?e nil nil 1 nil))) | |
1303 @end lisp | |
1304 | |
1305 The first element in this list is now the macro with empty braces as an | |
1306 @emph{image} of the macro arguments. @code{?e} indicates that this is | |
1307 an equation label, the different @code{nil} elements indicate to use the | |
1308 default values for equations. The @samp{1} as the fifth element | |
1309 indicates that the context of the label definition should be the 1st | |
59536 | 1310 argument of the macro. |
25829 | 1311 |
1312 Here is again how this would look in the customization buffer: | |
1313 | |
1314 @example | |
1315 Reftex Label Alist: [Hide] | |
1316 [INS] [DEL] Package or Detailed : [Value Menu] Detailed: | |
1317 Environment or \macro : [Value Menu] String: \quickeq@{@} | |
1318 Type specification : [Value Menu] Char : e | |
1319 Label prefix string : [Value Menu] Default | |
1320 Label reference format: [Value Menu] Default | |
1321 Context method : [Value Menu] Macro arg nr: 1 | |
1322 Magic words: | |
1323 [INS] | |
26911
d7f536a01276
Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents:
25829
diff
changeset
|
1324 [ ] Make TOC entry : [Value Menu] No entry |
25829 | 1325 @end example |
1326 | |
1327 @node Figure Wrapper, Adding Magic Words, Quick Equation, Defining Label Environments | |
1328 @subsection Figure Wrapping Macro | |
1329 @cindex Macros as environment wrappers | |
1330 @cindex Figure wrapping macro | |
1331 | |
1332 Suppose you want to make figures not directly with the figure | |
1333 environment, but with a macro like | |
1334 | |
1335 @example | |
1336 \newcommand@{\myfig@}[5][tbp]@{% | |
1337 \begin@{figure@}[#1] | |
1338 \epsimp[#5]@{#2@} | |
1339 \caption@{#3@} | |
1340 \label@{#4@} | |
1341 \end@{figure@}@} | |
1342 @end example | |
1343 | |
1344 @noindent | |
1345 which would be called like | |
1346 | |
1347 @example | |
1348 \myfig[htp]@{filename@}@{caption text@}@{label@}@{1@} | |
1349 @end example | |
1350 | |
1351 Now we need to tell @b{Ref@TeX{}} that the 4th argument of the | |
1352 @code{\myfig} macro @emph{is itself} a figure label, and where to find | |
59536 | 1353 the context. |
25829 | 1354 |
1355 @lisp | |
1356 (setq reftex-label-alist | |
1357 '(("\\myfig[]@{@}@{@}@{*@}@{@}" ?f nil nil 3))) | |
1358 @end lisp | |
1359 | |
1360 The empty pairs of brackets indicate the different arguments of the | |
1361 @code{\myfig} macro. The @samp{*} marks the label argument. @code{?f} | |
1362 indicates that this is a figure label which will be listed together with | |
1363 labels from normal figure environments. The @code{nil} entries for | |
1364 prefix and reference format mean to use the defaults for figure labels. | |
1365 The @samp{3} for the context method means to grab the 3rd macro argument | |
59536 | 1366 - the caption. |
25829 | 1367 |
1368 As a side effect of this configuration, @code{reftex-label} will now | |
1369 insert the required naked label (without the @code{\label} macro) when | |
1370 point is directly after the opening parenthesis of a @code{\myfig} macro | |
59536 | 1371 argument. |
25829 | 1372 |
1373 Again, here the configuration in the customization buffer: | |
1374 | |
1375 @example | |
1376 [INS] [DEL] Package or Detailed : [Value Menu] Detailed: | |
1377 Environment or \macro : [Value Menu] String: \myfig[]@{@}@{@}@{*@}@{@} | |
59579
a588c86a429c
Revision: miles@gnu.org--gnu-2005/emacs--cvs-trunk--0--patch-40
Miles Bader <miles@gnu.org>
parents:
59548
diff
changeset
|
1378 Type specification : [Value Menu] Char : f |
25829 | 1379 Label prefix string : [Value Menu] Default |
1380 Label reference format: [Value Menu] Default | |
1381 Context method : [Value Menu] Macro arg nr: 3 | |
1382 Magic words: | |
1383 [INS] | |
26911
d7f536a01276
Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents:
25829
diff
changeset
|
1384 [ ] Make TOC entry : [Value Menu] No entry |
25829 | 1385 @end example |
1386 | |
1387 @node Adding Magic Words, Using \eqref, Figure Wrapper, Defining Label Environments | |
1388 @subsection Adding Magic Words | |
1389 @cindex Magic words | |
1390 @cindex German magic words | |
1391 @cindex Label category | |
1392 | |
1393 Sometimes you don't want to define a new label environment or macro, but | |
1394 just change the information associated with a label category. Maybe you | |
1395 want to add some magic words, for another language. Changing only the | |
1396 information associated with a label category is done by giving | |
1397 @code{nil} for the environment name and then specify the items you want | |
1398 to define. Here is an example which adds German magic words to all | |
59536 | 1399 predefined label categories. |
25829 | 1400 |
1401 @lisp | |
1402 (setq reftex-label-alist | |
1403 '((nil ?s nil nil nil ("Kapitel" "Kap." "Abschnitt" "Teil")) | |
1404 (nil ?e nil nil nil ("Gleichung" "Gl.")) | |
1405 (nil ?t nil nil nil ("Tabelle")) | |
1406 (nil ?f nil nil nil ("Figur" "Abbildung" "Abb.")) | |
1407 (nil ?n nil nil nil ("Anmerkung" "Anm.")) | |
1408 (nil ?i nil nil nil ("Punkt")))) | |
1409 @end lisp | |
1410 | |
1411 @node Using \eqref, Non-Standard Environments, Adding Magic Words, Defining Label Environments | |
1412 @subsection Using @code{\eqref} | |
1413 @cindex @code{\eqref}, AMS-LaTeX macro | |
1414 @cindex AMS-LaTeX | |
1415 @cindex Label category | |
1416 | |
1417 Another case where one only wants to change the information associated | |
1418 with the label category is to change the macro which is used for | |
1419 referencing the label. When working with the AMS-LaTeX stuff, you might | |
1420 prefer @code{\eqref} for doing equation references. Here is how to | |
1421 do this: | |
1422 | |
1423 @lisp | |
1424 (setq reftex-label-alist '((nil ?e nil "~\\eqref@{%s@}" nil nil))) | |
1425 @end lisp | |
1426 | |
1427 @b{Ref@TeX{}} has also a predefined symbol for this special purpose. The | |
59536 | 1428 following is equivalent to the line above. |
25829 | 1429 |
1430 @lisp | |
1431 (setq reftex-label-alist '(AMSTeX)) | |
1432 @end lisp | |
1433 | |
1434 Note that this is automatically done by the @file{amsmath.el} style file | |
1435 of AUCTeX (@pxref{Style Files}) - so if you use AUCTeX, | |
59536 | 1436 this configuration will not be necessary. |
25829 | 1437 |
1438 @node Non-Standard Environments, Putting it Together, Using \eqref, Defining Label Environments | |
1439 @subsection Non-standard Environments | |
1440 @cindex Non-standard environments | |
1441 @cindex Environments without @code{\begin} | |
1442 @cindex Special parser functions | |
1443 @cindex Parser functions, for special environments | |
1444 | |
1445 Some LaTeX packages define environment-like structures without using the | |
1446 standard @samp{\begin..\end} structure. @b{Ref@TeX{}} cannot parse | |
1447 these directly, but you can write your own special-purpose parser and | |
1448 use it instead of the name of an environment in an entry for | |
1449 @code{reftex-label-alist}. The function should check if point is | |
1450 currently in the special environment it was written to detect. If so, | |
1451 it must return a buffer position indicating the start of this | |
1452 environment. The return value must be @code{nil} on failure to detect | |
1453 the environment. The function is called with one argument @var{bound}. | |
1454 If non-@code{nil}, @var{bound} is a boundary for backwards searches | |
59536 | 1455 which should be observed. We will discuss two examples. |
25829 | 1456 |
1457 @cindex LaTeX commands, abbreviated | |
1458 | |
1459 Some people define abbreviations for | |
1460 environments, like @code{\be} for @code{\begin@{equation@}}, and | |
1461 @code{\ee} for @code{\end@{equation@}}. The parser function would have | |
1462 to search backward for these macros. When the first match is | |
1463 @code{\ee}, point is not in this environment. When the first match is | |
1464 @code{\be}, point is in this environment and the function must return | |
1465 the beginning of the match. To avoid scanning too far, we can also look | |
46272 | 1466 for empty lines which cannot occur inside an equation environment. |
59536 | 1467 Here is the setup: |
25829 | 1468 |
1469 @lisp | |
1470 ;; Setup entry in reftex-label-alist, using all defaults for equations | |
1471 (setq reftex-label-alist '((detect-be-ee ?e nil nil nil nil))) | |
1472 | |
1473 (defun detect-be-ee (bound) | |
1474 ;; Search backward for the macros or an empty line | |
59579
a588c86a429c
Revision: miles@gnu.org--gnu-2005/emacs--cvs-trunk--0--patch-40
Miles Bader <miles@gnu.org>
parents:
59548
diff
changeset
|
1475 (if (re-search-backward |
25829 | 1476 "\\(^[ \t]*\n\\|\\\\ee\\>\\)\\|\\(\\\\be\\>\\)" bound t) |
1477 (if (match-beginning 2) | |
1478 (match-beginning 2) ; Return start of environment | |
1479 nil) ; Return nil because env is closed | |
1480 nil)) ; Return nil for not found | |
1481 @end lisp | |
1482 | |
1483 @cindex @code{linguex}, LaTeX package | |
1484 @cindex LaTeX packages, @code{linguex} | |
1485 A more complex example is the @file{linguex.sty} package which defines | |
1486 list macros @samp{\ex.}, @samp{\a.}, @samp{\b.} etc. for lists which are | |
59536 | 1487 terminated by @samp{\z.} or by an empty line. |
25829 | 1488 |
1489 @example | |
1490 \ex. \label@{ex:12@} Some text in an exotic language ... | |
1491 \a. \label@{ex:13@} more stuff | |
1492 \b. \label@{ex:14@} still more stuff | |
1493 \a. List on a deeper level | |
1494 \b. Another item | |
1495 \b. and the third one | |
1496 \z. | |
1497 \b. Third item on this level. | |
1498 | |
1499 ... text after the empty line terminating all lists | |
1500 @end example | |
1501 | |
1502 The difficulty is that the @samp{\a.} lists can nest and that an empty | |
1503 line terminates all list levels in one go. So we have to count nesting | |
1504 levels between @samp{\a.} and @samp{\z.}. Here is the implementation | |
1505 for @b{Ref@TeX{}}. | |
1506 | |
1507 @lisp | |
1508 (setq reftex-label-alist | |
1509 '((detect-linguex ?x "ex:" "~\\ref@{%s@}" nil ("Example" "Ex.")))) | |
1510 | |
1511 (defun detect-linguex (bound) | |
1512 (let ((cnt 0)) | |
1513 (catch 'exit | |
59579
a588c86a429c
Revision: miles@gnu.org--gnu-2005/emacs--cvs-trunk--0--patch-40
Miles Bader <miles@gnu.org>
parents:
59548
diff
changeset
|
1514 (while |
25829 | 1515 ;; Search backward for all possible delimiters |
1516 (re-search-backward | |
1517 (concat "\\(^[ \t]*\n\\)\\|\\(\\\\z\\.\\)\\|" | |
1518 "\\(\\ex[ig]?\\.\\)\\|\\(\\\\a\\.\\)") | |
1519 nil t) | |
1520 ;; Check which delimiter was matched. | |
59579
a588c86a429c
Revision: miles@gnu.org--gnu-2005/emacs--cvs-trunk--0--patch-40
Miles Bader <miles@gnu.org>
parents:
59548
diff
changeset
|
1521 (cond |
25829 | 1522 ((match-beginning 1) |
1523 ;; empty line terminates all - return nil | |
1524 (throw 'exit nil)) | |
1525 ((match-beginning 2) | |
1526 ;; \z. terminates one list level - decrease nesting count | |
1527 (decf cnt)) | |
1528 ((match-beginning 3) | |
1529 ;; \ex. : return match unless there was a \z. on this level | |
1530 (throw 'exit (if (>= cnt 0) (match-beginning 3) nil))) | |
1531 ((match-beginning 4) | |
1532 ;; \a. : return match when on level 0, otherwise | |
1533 ;; increment nesting count | |
1534 (if (>= cnt 0) | |
1535 (throw 'exit (match-beginning 4)) | |
1536 (incf cnt)))))))) | |
1537 @end lisp | |
1538 | |
1539 @node Putting it Together, , Non-Standard Environments, Defining Label Environments | |
1540 @subsection Putting it all together | |
1541 | |
1542 When you have to put several entries into @code{reftex-label-alist}, just | |
1543 put them after each other in a list, or create that many templates in | |
1544 the customization buffer. Here is a lisp example which uses several of | |
1545 the entries described above: | |
1546 | |
1547 @lisp | |
1548 (setq reftex-label-alist | |
26911
d7f536a01276
Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents:
25829
diff
changeset
|
1549 '(("axiom" ?a "ax:" "~\\ref@{%s@}" nil ("axiom" "ax.") -2) |
d7f536a01276
Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents:
25829
diff
changeset
|
1550 ("theorem" ?h "thr:" "~\\ref@{%s@}" t ("theorem" "theor." "th.") -3) |
25829 | 1551 ("\\quickeq@{@}" ?e nil nil 1 nil) |
1552 AMSTeX | |
1553 ("\\myfig[]@{@}@{@}@{*@}@{@}" ?f nil nil 3) | |
1554 (detect-linguex ?x "ex:" "~\\ref@{%s@}" nil ("Example" "Ex.")))) | |
1555 @end lisp | |
1556 | |
1557 @node Reference Info, xr (LaTeX package), Defining Label Environments, Labels and References | |
1558 @section Reference Info | |
1559 @findex reftex-view-crossref | |
1560 @findex reftex-mouse-view-crossref | |
1561 @cindex Cross-references, displaying | |
1562 @cindex Reference info | |
1563 @cindex Displaying cross-references | |
1564 @cindex Viewing cross-references | |
1565 @kindex C-c & | |
37999
8e7df927fd92
Updated to version 4.16
Carsten Dominik <dominik@science.uva.nl>
parents:
37404
diff
changeset
|
1566 @kindex S-mouse-2 |
25829 | 1567 |
47050
904fd28be439
Update to RefTeX 4.19
Carsten Dominik <dominik@science.uva.nl>
parents:
46918
diff
changeset
|
1568 When point is idle for more than @code{reftex-idle-time} seconds on the |
904fd28be439
Update to RefTeX 4.19
Carsten Dominik <dominik@science.uva.nl>
parents:
46918
diff
changeset
|
1569 argument of a @code{\ref} macro, the echo area will display some |
904fd28be439
Update to RefTeX 4.19
Carsten Dominik <dominik@science.uva.nl>
parents:
46918
diff
changeset
|
1570 information about the label referenced there. Note that the information |
904fd28be439
Update to RefTeX 4.19
Carsten Dominik <dominik@science.uva.nl>
parents:
46918
diff
changeset
|
1571 is only displayed if the echo area is not occupied by a different |
904fd28be439
Update to RefTeX 4.19
Carsten Dominik <dominik@science.uva.nl>
parents:
46918
diff
changeset
|
1572 message. |
25829 | 1573 |
1574 @b{Ref@TeX{}} can also display the label definition corresponding to a | |
1575 @code{\ref} macro, or all reference locations corresponding to a | |
1576 @code{\label} macro. @xref{Viewing Cross-References}, for more | |
59536 | 1577 information. |
25829 | 1578 |
1579 @node xr (LaTeX package), varioref (LaTeX package), Reference Info, Labels and References | |
1580 @section @code{xr}: Cross-Document References | |
1581 @cindex @code{xr}, LaTeX package | |
1582 @cindex LaTeX packages, @code{xr} | |
1583 @cindex @code{\externaldocument} | |
1584 @cindex External documents | |
1585 @cindex References to external documents | |
1586 @cindex Cross-document references | |
1587 | |
1588 The LaTeX package @code{xr} makes it possible to create references to | |
1589 labels defined in external documents. The preamble of a document using | |
59536 | 1590 @code{xr} will contain something like this: |
25829 | 1591 |
1592 @example | |
1593 \usepackage@{xr@} | |
1594 \externaldocument[V1-]@{volume1@} | |
1595 \externaldocument[V3-]@{volume3@} | |
1596 @end example | |
1597 | |
1598 @noindent | |
1599 and we can make references to any labels defined in these | |
1600 external documents by using the prefixes @samp{V1-} and @samp{V3-}, | |
59536 | 1601 respectively. |
25829 | 1602 |
1603 @b{Ref@TeX{}} can be used to create such references as well. Start the | |
1604 referencing process normally, by pressing @kbd{C-c )}. Select a label | |
1605 type if necessary. When you see the label selection buffer, pressing | |
1606 @kbd{x} will switch to the label selection buffer of one of the external | |
1607 documents. You may then select a label as before and @b{Ref@TeX{}} will | |
59536 | 1608 insert it along with the required prefix. |
25829 | 1609 |
1610 For this kind of inter-document cross-references, saving of parsing | |
1611 information and the use of multiple selection buffers can mean a large | |
59536 | 1612 speed-up (@pxref{Optimizations}). |
25829 | 1613 |
1614 @node varioref (LaTeX package), fancyref (LaTeX package), xr (LaTeX package), Labels and References | |
1615 @section @code{varioref}: Variable Page References | |
1616 @cindex @code{varioref}, LaTeX package | |
1617 @cindex @code{\vref} | |
1618 @cindex LaTeX packages, @code{varioref} | |
1619 @vindex reftex-vref-is-default | |
1620 @code{varioref} is a frequently used LaTeX package to create | |
1621 cross--references with page information. When you want to make a | |
1622 reference with the @code{\vref} macro, just press the @kbd{v} key in the | |
1623 selection buffer to toggle between @code{\ref} and @code{\vref} | |
1624 (@pxref{Referencing Labels}). The mode line of the selection buffer | |
1625 shows the current status of this switch. If you find that you almost | |
1626 always use @code{\vref}, you may want to make it the default by | |
1627 customizing the variable @code{reftex-vref-is-default}. If this | |
1628 toggling seems too inconvenient, you can also use the command | |
1629 @code{reftex-varioref-vref}@footnote{bind it to @kbd{C-c v}.}. | |
59536 | 1630 Or use AUCTeX to create your macros (@pxref{AUCTeX}). |
25829 | 1631 |
1632 @node fancyref (LaTeX package), , varioref (LaTeX package), Labels and References | |
1633 @section @code{fancyref}: Fancy Cross References | |
1634 @cindex @code{fancyref}, LaTeX package | |
1635 @cindex @code{\fref} | |
1636 @cindex @code{\Fref} | |
1637 @cindex LaTeX packages, @code{fancyref} | |
1638 @vindex reftex-fref-is-default | |
1639 @code{fancyref} is a LaTeX package where a macro call like | |
1640 @code{\fref@{@var{fig:map-of-germany}@}} creates not only the number of | |
1641 the referenced counter but also the complete text around it, like | |
1642 @samp{Figure 3 on the preceding page}. In order to make it work you | |
1643 need to use label prefixes like @samp{fig:} consistently - something | |
1644 @b{Ref@TeX{}} does automatically. When you want to make a reference | |
1645 with the @code{\fref} macro, just press the @kbd{V} key in the selection | |
1646 buffer to cycle between @code{\ref}, @code{\fref} and @code{\Fref} | |
1647 (@pxref{Referencing Labels}). The mode line of the selection buffer | |
1648 shows the current status of this switch. If this cycling seems | |
1649 inconvenient, you can also use the commands @code{reftex-fancyref-fref} | |
1650 and @code{reftex-fancyref-Fref}@footnote{bind them to @kbd{C-c | |
1651 f} and @kbd{C-c F}.}. Or use AUCTeX to create your macros | |
59536 | 1652 (@pxref{AUCTeX}). |
25829 | 1653 |
1654 @node Citations, Index Support, Labels and References, Top | |
1655 @chapter Citations | |
1656 @cindex Citations | |
1657 @cindex @code{\cite} | |
1658 | |
1659 Citations in LaTeX are done with the @code{\cite} macro or variations of | |
1660 it. The argument of the macro is a citation key which identifies an | |
1661 article or book in either a BibTeX database file or in an explicit | |
1662 @code{thebibliography} environment in the document. @b{Ref@TeX{}}'s | |
59536 | 1663 support for citations helps to select the correct key quickly. |
25829 | 1664 |
1665 @menu | |
1666 * Creating Citations:: How to create them. | |
1667 * Citation Styles:: Natbib, Harvard, Chicago and Co. | |
1668 * Citation Info:: View the corresponding database entry. | |
1669 * Chapterbib and Bibunits:: Multiple bibliographies in a Document. | |
1670 * Citations Outside LaTeX:: How to make citations in Emails etc. | |
63671
9fc49ac7fb44
(Options (Defining Label Environments), Options (Index Support), Options
Juanma Barranquero <lekktu@gmail.com>
parents:
62469
diff
changeset
|
1671 * BibTeX Database Subsets:: Extract parts of a big database. |
25829 | 1672 @end menu |
1673 | |
1674 @node Creating Citations, Citation Styles, , Citations | |
1675 @section Creating Citations | |
1676 @cindex Creating citations | |
1677 @cindex Citations, creating | |
1678 @findex reftex-citation | |
1679 @kindex C-c [ | |
1680 @cindex Selection buffer, citations | |
1681 @cindex Selection process | |
1682 | |
1683 In order to create a citation, press @kbd{C-c [}. @b{Ref@TeX{}} then | |
1684 prompts for a regular expression which will be used to search through | |
1685 the database and present the list of matches to choose from in a | |
1686 selection process similar to that for selecting labels | |
59536 | 1687 (@pxref{Referencing Labels}). |
25829 | 1688 |
1689 The regular expression uses an extended syntax: @samp{&&} defines a | |
1690 logic @code{and} for regular expressions. For example | |
1691 @samp{Einstein&&Bose} will match all articles which mention | |
1692 Bose-Einstein condensation, or which are co-authored by Bose and | |
1693 Einstein. When entering the regular expression, you can complete on | |
46918
82d113655734
Minor spelling and grammar corrections.
Paul Eggert <eggert@twinsun.com>
parents:
46684
diff
changeset
|
1694 known citation keys. RefTeX also offers a default when prompting for a |
46684
9569bac241a3
Update to RefTeX 4.18
Carsten Dominik <dominik@science.uva.nl>
parents:
46272
diff
changeset
|
1695 regular expression. This default is the word before the cursor or the |
46918
82d113655734
Minor spelling and grammar corrections.
Paul Eggert <eggert@twinsun.com>
parents:
46684
diff
changeset
|
1696 word before the current @samp{\cite} command. Sometimes this may be a |
59536 | 1697 good search key. |
25829 | 1698 |
1699 @cindex @code{\bibliography} | |
1700 @cindex @code{thebibliography}, LaTeX environment | |
1701 @cindex @code{BIBINPUTS}, environment variable | |
1702 @cindex @code{TEXBIB}, environment variable | |
1703 @b{Ref@TeX{}} prefers to use BibTeX database files specified with a | |
1704 @code{\bibliography} macro to collect its information. Just like | |
1705 BibTeX, it will search for the specified files in the current directory | |
1706 and along the path given in the environment variable @code{BIBINPUTS}. | |
1707 If you do not use BibTeX, but the document contains an explicit | |
1708 @code{thebibliography} environment, @b{Ref@TeX{}} will collect its | |
1709 information from there. Note that in this case the information | |
1710 presented in the selection buffer will just be a copy of relevant | |
1711 @code{\bibitem} entries, not the structured listing available with | |
59536 | 1712 BibTeX database files. |
25829 | 1713 |
1714 @kindex ? | |
1715 In the selection buffer, the following keys provide special commands. A | |
1716 summary of this information is always available from the selection | |
59536 | 1717 process by pressing @kbd{?}. |
25829 | 1718 |
1719 @table @kbd | |
1720 @tablesubheading{General} | |
1721 @item ? | |
1722 Show a summary of available commands. | |
1723 | |
1724 @item 0-9,- | |
1725 Prefix argument. | |
1726 | |
1727 @tablesubheading{Moving around} | |
1728 @item n | |
1729 Go to next article. | |
1730 | |
1731 @item p | |
1732 Go to previous article. | |
1733 | |
1734 @tablesubheading{Access to full database entries} | |
1735 @item @key{SPC} | |
1736 Show the database entry corresponding to the article at point, in | |
59536 | 1737 another window. See also the @kbd{f} key. |
25829 | 1738 |
1739 @item f | |
1740 Toggle follow mode. When follow mode is active, the other window will | |
1741 always display the full database entry of the current article. This is | |
1742 equivalent to pressing @key{SPC} after each cursor motion. With BibTeX | |
59536 | 1743 entries, follow mode can be rather slow. |
25829 | 1744 |
1745 @tablesubheading{Selecting entries and creating the citation} | |
1746 @item @key{RET} | |
1747 Insert a citation referencing the article at point into the buffer from | |
59536 | 1748 which the selection process was started. |
25829 | 1749 |
37999
8e7df927fd92
Updated to version 4.16
Carsten Dominik <dominik@science.uva.nl>
parents:
37404
diff
changeset
|
1750 @item mouse-2 |
25829 | 1751 @vindex reftex-highlight-selection |
1752 Clicking with mouse button 2 on a citation will accept it like @key{RET} | |
1753 would. See also variable @code{reftex-highlight-selection}, @ref{Options | |
59536 | 1754 (Misc)}. |
25829 | 1755 |
1756 @item m | |
1757 Mark the current entry. When one or several entries are marked, | |
1758 pressing @kbd{a} or @kbd{A} accepts all marked entries. Also, | |
1759 @key{RET} behaves like the @kbd{a} key. | |
1760 | |
1761 @item u | |
1762 Unmark a marked entry. | |
1763 | |
1764 @item a | |
1765 Accept all (marked) entries in the selection buffer and create a single | |
59536 | 1766 @code{\cite} macro referring to them. |
25829 | 1767 |
1768 @item A | |
1769 Accept all (marked) entries in the selection buffer and create a | |
59536 | 1770 separate @code{\cite} macro for each of it. |
1771 | |
1772 @item e | |
1773 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 | |
63671
9fc49ac7fb44
(Options (Defining Label Environments), Options (Index Support), Options
Juanma Barranquero <lekktu@gmail.com>
parents:
62469
diff
changeset
|
1775 selected. |
59536 | 1776 |
1777 @item E | |
1778 Create a new BibTeX database file which contains all @i{unmarked} | |
1779 entries in the selection buffer. If no entries are marked, all entries | |
63671
9fc49ac7fb44
(Options (Defining Label Environments), Options (Index Support), Options
Juanma Barranquero <lekktu@gmail.com>
parents:
62469
diff
changeset
|
1780 are selected. |
25829 | 1781 |
1782 @item @key{TAB} | |
1783 Enter a citation key with completion. This may also be a key which does | |
1784 not yet exist. | |
1785 | |
1786 @item . | |
1787 Show insertion point in another window. This is the point from where you | |
59536 | 1788 called @code{reftex-citation}. |
25829 | 1789 |
1790 @tablesubheading{Exiting} | |
1791 @item q | |
1792 Exit the selection process without inserting a citation into the | |
59536 | 1793 buffer. |
25829 | 1794 |
1795 @tablesubheading{Updating the buffer} | |
1796 | |
1797 @item g | |
1798 Start over with a new regular expression. The full database will be | |
59536 | 1799 rescanned with the new expression (see also @kbd{r}). |
25829 | 1800 |
1801 @c FIXME: Should we use something else here? r is usually rescan! | |
1802 @item r | |
1803 Refine the current selection with another regular expression. This will | |
1804 @emph{not} rescan the entire database, but just the already selected | |
59536 | 1805 entries. |
25829 | 1806 |
1807 @end table | |
1808 | |
1809 @vindex reftex-select-bib-map | |
1810 In order to define additional commands for this selection process, the | |
59536 | 1811 keymap @code{reftex-select-bib-map} may be used. |
25829 | 1812 |
1813 @node Citation Styles, Citation Info, Creating Citations, Citations | |
1814 @section Citation Styles | |
1815 @cindex Citation styles | |
1816 @cindex Citation styles, @code{natbib} | |
1817 @cindex Citation styles, @code{harvard} | |
1818 @cindex Citation styles, @code{chicago} | |
62469 | 1819 @cindex Citation styles, @code{jurabib} |
25829 | 1820 @cindex @code{natbib}, citation style |
1821 @cindex @code{harvard}, citation style | |
1822 @cindex @code{chicago}, citation style | |
62469 | 1823 @cindex @code{jurabib}, citation style |
25829 | 1824 |
1825 @vindex reftex-cite-format | |
1826 The standard LaTeX macro @code{\cite} works well with numeric or simple | |
1827 key citations. To deal with the more complex task of author-year | |
1828 citations as used in many natural sciences, a variety of packages has | |
1829 been developed which define derived forms of the @code{\cite} macro. | |
62469 | 1830 @b{Ref@TeX{}} can be configured to produce these citation macros as well |
1831 by setting the variable @code{reftex-cite-format}. For the most | |
1832 commonly used packages (@code{natbib}, @code{harvard}, @code{chicago}, | |
1833 @code{jurabib}) this may be done from the menu, under | |
1834 @code{Ref->Citation Styles}. Since there are usually several macros to | |
1835 create the citations, executing @code{reftex-citation} (@kbd{C-c [}) | |
1836 starts by prompting for the correct macro. For the Natbib style, this | |
1837 looks like this: | |
25829 | 1838 |
1839 @example | |
1840 SELECT A CITATION FORMAT | |
1841 | |
1842 [^M] \cite@{%l@} | |
1843 [t] \citet@{%l@} | |
1844 [T] \citet*@{%l@} | |
1845 [p] \citep@{%l@} | |
1846 [P] \citep*@{%l@} | |
1847 [e] \citep[e.g.][]@{%l@} | |
1848 [s] \citep[see][]@{%l@} | |
1849 [a] \citeauthor@{%l@} | |
1850 [A] \citeauthor*@{%l@} | |
1851 [y] \citeyear@{%l@} | |
1852 @end example | |
1853 | |
59536 | 1854 @vindex reftex-cite-prompt-optional-args |
1855 If cite formats contain empty paris of square brackets, RefTeX can | |
1856 will prompt for values of these optional arguments if you call the | |
1857 @code{reftex-citation} command with a @kbd{C-u} prefix. | |
25829 | 1858 Following the most generic of these packages, @code{natbib}, the builtin |
1859 citation packages always accept the @kbd{t} key for a @emph{textual} | |
59579
a588c86a429c
Revision: miles@gnu.org--gnu-2005/emacs--cvs-trunk--0--patch-40
Miles Bader <miles@gnu.org>
parents:
59548
diff
changeset
|
1860 citation (like: @code{Jones et al. (1997) have shown...}) as well as |
25829 | 1861 the @kbd{p} key for a parenthetical citation (like: @code{As shown |
59536 | 1862 earlier (Jones et al, 1997)}). |
25829 | 1863 |
1864 To make one of these styles the default, customize the variable | |
1865 @code{reftex-cite-format} or put into @file{.emacs}: | |
1866 | |
1867 @lisp | |
1868 (setq reftex-cite-format 'natbib) | |
1869 @end lisp | |
1870 | |
1871 You can also use AUCTeX style files to automatically set the | |
1872 citation style based on the @code{usepackage} commands in a given | |
1873 document. @xref{Style Files}, for information on how to set up the style | |
59536 | 1874 files correctly. |
25829 | 1875 |
1876 @node Citation Info, Chapterbib and Bibunits, Citation Styles, Citations, Top | |
1877 @section Citation Info | |
1878 @cindex Displaying citations | |
1879 @cindex Citations, displaying | |
1880 @cindex Citation info | |
1881 @cindex Viewing citations | |
1882 @kindex C-c & | |
37999
8e7df927fd92
Updated to version 4.16
Carsten Dominik <dominik@science.uva.nl>
parents:
37404
diff
changeset
|
1883 @kindex S-mouse-2 |
25829 | 1884 @findex reftex-view-crossref |
1885 @findex reftex-mouse-view-crossref | |
1886 | |
47050
904fd28be439
Update to RefTeX 4.19
Carsten Dominik <dominik@science.uva.nl>
parents:
46918
diff
changeset
|
1887 When point is idle for more than @code{reftex-idle-time} seconds on the |
904fd28be439
Update to RefTeX 4.19
Carsten Dominik <dominik@science.uva.nl>
parents:
46918
diff
changeset
|
1888 argument of a @code{\cite} macro, the echo area will display some |
904fd28be439
Update to RefTeX 4.19
Carsten Dominik <dominik@science.uva.nl>
parents:
46918
diff
changeset
|
1889 information about the article cited there. Note that the information is |
904fd28be439
Update to RefTeX 4.19
Carsten Dominik <dominik@science.uva.nl>
parents:
46918
diff
changeset
|
1890 only displayed if the echo area is not occupied by a different message. |
25829 | 1891 |
1892 @b{Ref@TeX{}} can also display the @code{\bibitem} or BibTeX database | |
1893 entry corresponding to a @code{\cite} macro, or all citation locations | |
1894 corresponding to a @code{\bibitem} or BibTeX database entry. | |
59536 | 1895 @xref{Viewing Cross-References}. |
25829 | 1896 |
1897 @node Chapterbib and Bibunits, Citations Outside LaTeX, Citation Info, Citations | |
1898 @section Chapterbib and Bibunits | |
1899 @cindex @code{chapterbib}, LaTeX package | |
1900 @cindex @code{bibunits}, LaTeX package | |
1901 @cindex Bibliographies, multiple | |
1902 | |
1903 @code{chapterbib} and @code{bibunits} are two LaTeX packages which | |
1904 produce multiple bibliographies in a document. This is no problem for | |
1905 @b{Ref@TeX{}} as long as all bibliographies use the same BibTeX database | |
1906 files. If they do not, it is best to have each document part in a | |
1907 separate file (as it is required for @code{chapterbib} anyway). Then | |
1908 @b{Ref@TeX{}} will still scan the locally relevant databases correctly. If | |
1909 you have multiple bibliographies within a @emph{single file}, this may | |
1910 or may not be the case. | |
1911 | |
59536 | 1912 @node Citations Outside LaTeX, BibTeX Database Subsets, Chapterbib and Bibunits, Citations |
25829 | 1913 @section Citations outside LaTeX |
1914 @cindex Citations outside LaTeX | |
1915 @vindex reftex-default-bibliography | |
1916 | |
1917 The command @code{reftex-citation} can also be executed outside a LaTeX | |
1918 buffer. This can be useful to reference articles in the mail buffer and | |
1919 other documents. You should @emph{not} enter @code{reftex-mode} for | |
1920 this, just execute the command. The list of BibTeX files will in this | |
1921 case be taken from the variable @code{reftex-default-bibliography}. | |
1922 Setting the variable @code{reftex-cite-format} to the symbol | |
1923 @code{locally} does a decent job of putting all relevant information | |
1924 about a citation directly into the buffer. Here is the lisp code to add | |
1925 the @kbd{C-c [} binding to the mail buffer. It also provides a local | |
59536 | 1926 binding for @code{reftex-cite-format}. |
25829 | 1927 |
1928 @lisp | |
26911
d7f536a01276
Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents:
25829
diff
changeset
|
1929 (add-hook 'mail-setup-hook |
d7f536a01276
Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents:
25829
diff
changeset
|
1930 (lambda () (define-key mail-mode-map "\C-c[" |
d7f536a01276
Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents:
25829
diff
changeset
|
1931 (lambda () (interactive) |
d7f536a01276
Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents:
25829
diff
changeset
|
1932 (require 'reftex) |
d7f536a01276
Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents:
25829
diff
changeset
|
1933 (let ((reftex-cite-format 'locally)) |
d7f536a01276
Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents:
25829
diff
changeset
|
1934 (reftex-citation)))))) |
25829 | 1935 @end lisp |
1936 | |
59536 | 1937 @node BibTeX Database Subsets, , Citations Outside LaTeX, Citations |
1938 @section Database Subsets | |
1939 @cindex BibTeX database subsets | |
1940 @findex reftex-create-bibtex-file | |
1941 | |
1942 @b{Ref@TeX{}} offers two ways to create a new BibTeX database file. | |
1943 | |
1944 The first option produces a file which contains only the entries | |
1945 actually referenced in the current document. This can be useful if | |
1946 the database in only meant for a single document and you want to clean | |
1947 it of old and unused ballast. It can also be useful while writing a | |
1948 document together with collaborators, in order to avoid sending around | |
1949 the entire (possibly very large) database. To create the file, use | |
1950 @kbd{M-x reftex-create-bibtex-file}, also available from the menu | |
1951 under @code{Ref->Global Actions->Create Bibtex File}. The command will | |
1952 prompt for a BibTeX file name and write the extracted entries to that | |
1953 file. | |
1954 | |
1955 The second option makes use of the selection process started by the | |
1956 command @kbd{C-c [} (@pxref{Creating Citations}). This command uses a | |
1957 regular expression to select entries, and lists them in a formatted | |
1958 selection buffer. After pressing the @kbd{e} key (mnemonics: Export), | |
1959 the command will prompt for the name of a new BibTeX file and write | |
1960 the selected entries to that file. You can also first mark some | |
1961 entries in the selection buffer with the @kbd{m} key and then export | |
1962 either the @i{marked} entries (with the @kbd{e} key) or the | |
1963 @i{unmarked} entries (with the @kbd{E} key). | |
1964 | |
25829 | 1965 @node Index Support, Viewing Cross-References, Citations, Top |
1966 @chapter Index Support | |
1967 @cindex Index Support | |
1968 @cindex @code{\index} | |
1969 | |
1970 LaTeX has builtin support for creating an Index. The LaTeX core | |
1971 supports two different indices, the standard index and a glossary. With | |
1972 the help of special LaTeX packages (@file{multind.sty} or | |
1973 @file{index.sty}), any number of indices can be supported. | |
1974 | |
1975 Index entries are created with the @code{\index@{@var{entry}@}} macro. | |
1976 All entries defined in a document are written out to the @file{.aux} | |
1977 file. A separate tool must be used to convert this information into a | |
1978 nicely formatted index. Tools used with LaTeX include @code{MakeIndex} | |
59536 | 1979 and @code{xindy}. |
25829 | 1980 |
26911
d7f536a01276
Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents:
25829
diff
changeset
|
1981 Indexing is a very difficult task. It must follow strict conventions to |
d7f536a01276
Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents:
25829
diff
changeset
|
1982 make the index consistent and complete. There are basically two |
d7f536a01276
Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents:
25829
diff
changeset
|
1983 approaches one can follow, and both have their merits. |
d7f536a01276
Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents:
25829
diff
changeset
|
1984 |
d7f536a01276
Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents:
25829
diff
changeset
|
1985 @enumerate |
d7f536a01276
Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents:
25829
diff
changeset
|
1986 @item |
d7f536a01276
Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents:
25829
diff
changeset
|
1987 Part of the indexing should already be done with the markup. The |
d7f536a01276
Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents:
25829
diff
changeset
|
1988 document structure should be reflected in the index, so when starting |
d7f536a01276
Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents:
25829
diff
changeset
|
1989 new sections, the basic topics of the section should be indexed. If the |
d7f536a01276
Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents:
25829
diff
changeset
|
1990 document contains definitions, theorems or the like, these should all |
d7f536a01276
Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents:
25829
diff
changeset
|
1991 correspond to appropriate index entries. This part of the index can |
d7f536a01276
Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents:
25829
diff
changeset
|
1992 very well be developed along with the document. Often it is worthwhile |
d7f536a01276
Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents:
25829
diff
changeset
|
1993 to define special purpose macros which define an item and at the same |
d7f536a01276
Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents:
25829
diff
changeset
|
1994 time make an index entry, possibly with special formatting to make the |
d7f536a01276
Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents:
25829
diff
changeset
|
1995 reference page in the index bold or underlined. To make @b{Ref@TeX{}} |
d7f536a01276
Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents:
25829
diff
changeset
|
1996 support for indexing possible, these special macros must be added to |
59536 | 1997 @b{Ref@TeX{}}'s configuration (@pxref{Defining Index Macros}). |
26911
d7f536a01276
Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents:
25829
diff
changeset
|
1998 |
d7f536a01276
Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents:
25829
diff
changeset
|
1999 @item |
d7f536a01276
Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents:
25829
diff
changeset
|
2000 The rest of the index is often just a collection of where in the |
d7f536a01276
Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents:
25829
diff
changeset
|
2001 document certain words or phrases are being used. This part is |
d7f536a01276
Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents:
25829
diff
changeset
|
2002 difficult to develop along with the document, because consistent entries |
d7f536a01276
Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents:
25829
diff
changeset
|
2003 for each occurrence are needed and are best selected when the document |
d7f536a01276
Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents:
25829
diff
changeset
|
2004 is ready. @b{Ref@TeX{}} supports this with an @emph{index phrases file} |
59536 | 2005 which collects phrases and helps indexing the phrases globally. |
26911
d7f536a01276
Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents:
25829
diff
changeset
|
2006 @end enumerate |
d7f536a01276
Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents:
25829
diff
changeset
|
2007 |
d7f536a01276
Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents:
25829
diff
changeset
|
2008 Before you start, you need to make sure that @b{Ref@TeX{}} knows about |
d7f536a01276
Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents:
25829
diff
changeset
|
2009 the index style being used in the current document. @b{Ref@TeX{}} has |
d7f536a01276
Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents:
25829
diff
changeset
|
2010 builtin support for the default @code{\index} and @code{\glossary} |
d7f536a01276
Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents:
25829
diff
changeset
|
2011 macros. Other LaTeX packages, like the @file{multind} or @file{index} |
d7f536a01276
Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents:
25829
diff
changeset
|
2012 package, redefine the @code{\index} macro to have an additional |
d7f536a01276
Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents:
25829
diff
changeset
|
2013 argument, and @b{Ref@TeX{}} needs to be configured for those. A |
d7f536a01276
Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents:
25829
diff
changeset
|
2014 sufficiently new version of AUCTeX (9.10c or later) will do this |
d7f536a01276
Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents:
25829
diff
changeset
|
2015 automatically. If you really don't use AUCTeX (you should!), this |
d7f536a01276
Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents:
25829
diff
changeset
|
2016 configuration needs to be done by hand with the menu (@code{Ref->Index |
59536 | 2017 Style}), or globally for all your documents with |
26911
d7f536a01276
Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents:
25829
diff
changeset
|
2018 |
d7f536a01276
Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents:
25829
diff
changeset
|
2019 @lisp |
d7f536a01276
Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents:
25829
diff
changeset
|
2020 (setq reftex-index-macros '(multind)) @r{or} |
d7f536a01276
Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents:
25829
diff
changeset
|
2021 (setq reftex-index-macros '(index)) |
d7f536a01276
Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents:
25829
diff
changeset
|
2022 @end lisp |
25829 | 2023 |
2024 @menu | |
26911
d7f536a01276
Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents:
25829
diff
changeset
|
2025 * Creating Index Entries:: Macros and completion of entries. |
d7f536a01276
Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents:
25829
diff
changeset
|
2026 * The Index Phrases File:: A special file for global indexing. |
d7f536a01276
Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents:
25829
diff
changeset
|
2027 * Displaying and Editing the Index:: The index editor. |
25829 | 2028 * Builtin Index Macros:: The index macros RefTeX knows about. |
2029 * Defining Index Macros:: ... and macros it doesn't. | |
2030 @end menu | |
2031 | |
26911
d7f536a01276
Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents:
25829
diff
changeset
|
2032 @node Creating Index Entries, The Index Phrases File, , Index Support |
25829 | 2033 @section Creating Index Entries |
2034 @cindex Creating index entries | |
2035 @cindex Index entries, creating | |
2036 @kindex C-c < | |
2037 @findex reftex-index | |
2038 @kindex C-c / | |
2039 @findex reftex-index-selection-or-word | |
2040 | |
2041 In order to index the current selection or the word at the cursor press | |
2042 @kbd{C-c /} (@code{reftex-index-selection-or-word}). This causes the | |
2043 selection or word @samp{@var{word}} to be replaced with | |
2044 @samp{\index@{@var{word}@}@var{word}}. The macro which is used | |
2045 (@code{\index} by default) can be configured with the variable | |
2046 @code{reftex-index-default-macro}. When the command is called with a | |
2047 prefix argument (@kbd{C-u C-c /}), you get a chance to edit the | |
2048 generated index entry. Use this to change the case of the word or to | |
2049 make the entry a subentry, for example by entering | |
2050 @samp{main!sub!@var{word}}. When called with two raw @kbd{C-u} prefixes | |
2051 (@kbd{C-u C-u C-c /}), you will be asked for the index macro as well. | |
2052 When there is nothing selected and no word at point, this command will | |
2053 just call @code{reftex-index}, described below. | |
2054 | |
2055 In order to create a general index entry, press @kbd{C-c <} | |
2056 (@code{reftex-index}). @b{Ref@TeX{}} will prompt for one of the | |
2057 available index macros and for its arguments. Completion will be | |
2058 available for the index entry and, if applicable, the index tag. The | |
2059 index tag is a string identifying one of multiple indices. With the | |
2060 @file{multind} and @file{index} packages, this tag is the first argument | |
59536 | 2061 to the redefined @code{\index} macro. |
25829 | 2062 |
26911
d7f536a01276
Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents:
25829
diff
changeset
|
2063 @node The Index Phrases File, Displaying and Editing the Index, Creating Index Entries, Index Support |
d7f536a01276
Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents:
25829
diff
changeset
|
2064 @section The Index Phrases File |
d7f536a01276
Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents:
25829
diff
changeset
|
2065 @cindex Index phrase file |
d7f536a01276
Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents:
25829
diff
changeset
|
2066 @cindex Phrase file |
d7f536a01276
Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents:
25829
diff
changeset
|
2067 @kindex C-c | |
d7f536a01276
Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents:
25829
diff
changeset
|
2068 @findex reftex-index-visit-phrases-buffer |
d7f536a01276
Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents:
25829
diff
changeset
|
2069 @cindex Macro definition lines, in phrase buffer |
d7f536a01276
Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents:
25829
diff
changeset
|
2070 |
d7f536a01276
Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents:
25829
diff
changeset
|
2071 @b{Ref@TeX{}} maintains a file in which phrases can be collected for |
d7f536a01276
Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents:
25829
diff
changeset
|
2072 later indexing. The file is located in the same directory as the master |
d7f536a01276
Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents:
25829
diff
changeset
|
2073 file of the document and has the extension @file{.rip} (@b{R}eftex |
d7f536a01276
Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents:
25829
diff
changeset
|
2074 @b{I}ndex @b{P}hrases). You can create or visit the file with @kbd{C-c |
d7f536a01276
Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents:
25829
diff
changeset
|
2075 |} (@code{reftex-index-visit-phrases-buffer}). If the file is empty it |
d7f536a01276
Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents:
25829
diff
changeset
|
2076 is initialized by inserting a file header which contains the definition |
d7f536a01276
Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents:
25829
diff
changeset
|
2077 of the available index macros. This list is initialized from |
d7f536a01276
Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents:
25829
diff
changeset
|
2078 @code{reftex-index-macros} (@pxref{Defining Index Macros}). You can |
d7f536a01276
Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents:
25829
diff
changeset
|
2079 edit the header as needed, but if you define new LaTeX indexing macros, |
d7f536a01276
Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents:
25829
diff
changeset
|
2080 don't forget to add them to @code{reftex-index-macros} as well. Here is |
59536 | 2081 a phrase file header example: |
26911
d7f536a01276
Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents:
25829
diff
changeset
|
2082 |
d7f536a01276
Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents:
25829
diff
changeset
|
2083 @example |
d7f536a01276
Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents:
25829
diff
changeset
|
2084 % -*- mode: reftex-index-phrases -*- |
d7f536a01276
Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents:
25829
diff
changeset
|
2085 % Key Macro Format Repeat |
d7f536a01276
Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents:
25829
diff
changeset
|
2086 %---------------------------------------------------------- |
d7f536a01276
Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents:
25829
diff
changeset
|
2087 >>>INDEX_MACRO_DEFINITION: i \index@{%s@} t |
d7f536a01276
Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents:
25829
diff
changeset
|
2088 >>>INDEX_MACRO_DEFINITION: I \index*@{%s@} nil |
d7f536a01276
Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents:
25829
diff
changeset
|
2089 >>>INDEX_MACRO_DEFINITION: g \glossary@{%s@} t |
d7f536a01276
Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents:
25829
diff
changeset
|
2090 >>>INDEX_MACRO_DEFINITION: n \index*[name]@{%s@} nil |
d7f536a01276
Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents:
25829
diff
changeset
|
2091 %---------------------------------------------------------- |
d7f536a01276
Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents:
25829
diff
changeset
|
2092 @end example |
d7f536a01276
Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents:
25829
diff
changeset
|
2093 |
d7f536a01276
Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents:
25829
diff
changeset
|
2094 The macro definition lines consist of a unique letter identifying a |
d7f536a01276
Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents:
25829
diff
changeset
|
2095 macro, a format string and the @var{repeat} flag, all separated by |
d7f536a01276
Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents:
25829
diff
changeset
|
2096 @key{TAB}. The format string shows how the macro is to be applied, the |
d7f536a01276
Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents:
25829
diff
changeset
|
2097 @samp{%s} will be replaced with the index entry. The repeat flag |
d7f536a01276
Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents:
25829
diff
changeset
|
2098 indicates if @var{word} is indexed by the macro as |
d7f536a01276
Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents:
25829
diff
changeset
|
2099 @samp{\index@{@var{word}@}} (@var{repeat} = @code{nil}) or as |
d7f536a01276
Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents:
25829
diff
changeset
|
2100 @samp{\index@{@var{word}@}@var{word}} (@var{repeat} = @code{t}). In the |
d7f536a01276
Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents:
25829
diff
changeset
|
2101 above example it is assumed that the macro @code{\index*@{@var{word}@}} |
d7f536a01276
Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents:
25829
diff
changeset
|
2102 already typesets its argument in the text, so that it is unnecessary to |
59536 | 2103 repeat @var{word} outside the macro. |
26911
d7f536a01276
Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents:
25829
diff
changeset
|
2104 |
d7f536a01276
Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents:
25829
diff
changeset
|
2105 @menu |
d7f536a01276
Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents:
25829
diff
changeset
|
2106 * Collecting Phrases:: Collecting from document or external. |
d7f536a01276
Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents:
25829
diff
changeset
|
2107 * Consistency Checks:: Check for duplicates etc. |
d7f536a01276
Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents:
25829
diff
changeset
|
2108 * Global Indexing:: The interactive indexing process. |
d7f536a01276
Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents:
25829
diff
changeset
|
2109 @end menu |
d7f536a01276
Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents:
25829
diff
changeset
|
2110 |
d7f536a01276
Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents:
25829
diff
changeset
|
2111 @node Collecting Phrases, Consistency Checks, , The Index Phrases File |
d7f536a01276
Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents:
25829
diff
changeset
|
2112 @subsection Collecting Phrases |
d7f536a01276
Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents:
25829
diff
changeset
|
2113 @cindex Collecting index phrases |
d7f536a01276
Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents:
25829
diff
changeset
|
2114 @cindex Index phrases, collection |
d7f536a01276
Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents:
25829
diff
changeset
|
2115 @cindex Phrases, collecting |
d7f536a01276
Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents:
25829
diff
changeset
|
2116 |
d7f536a01276
Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents:
25829
diff
changeset
|
2117 Phrases for indexing can be collected while writing the document. The |
d7f536a01276
Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents:
25829
diff
changeset
|
2118 command @kbd{C-c \} (@code{reftex-index-phrase-selection-or-word}) |
59579
a588c86a429c
Revision: miles@gnu.org--gnu-2005/emacs--cvs-trunk--0--patch-40
Miles Bader <miles@gnu.org>
parents:
59548
diff
changeset
|
2119 copies the current selection (if active) or the word near point into the |
26911
d7f536a01276
Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents:
25829
diff
changeset
|
2120 phrases buffer. It then selects this buffer, so that the phrase line |
d7f536a01276
Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents:
25829
diff
changeset
|
2121 can be edited. To return to the LaTeX document, press @kbd{C-c C-c} |
d7f536a01276
Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents:
25829
diff
changeset
|
2122 (@code{reftex-index-phrases-save-and-return}). |
d7f536a01276
Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents:
25829
diff
changeset
|
2123 |
d7f536a01276
Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents:
25829
diff
changeset
|
2124 You can also prepare the list of index phrases in a different way and |
59579
a588c86a429c
Revision: miles@gnu.org--gnu-2005/emacs--cvs-trunk--0--patch-40
Miles Bader <miles@gnu.org>
parents:
59548
diff
changeset
|
2125 copy it into the phrases file. For example you might want to start from |
26911
d7f536a01276
Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents:
25829
diff
changeset
|
2126 a word list of the document and remove all words which should not be |
d7f536a01276
Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents:
25829
diff
changeset
|
2127 indexed. |
d7f536a01276
Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents:
25829
diff
changeset
|
2128 |
d7f536a01276
Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents:
25829
diff
changeset
|
2129 The phrase lines in the phrase buffer must have a specific format. |
d7f536a01276
Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents:
25829
diff
changeset
|
2130 @b{Ref@TeX{}} will use font-lock to indicate if a line has the proper |
d7f536a01276
Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents:
25829
diff
changeset
|
2131 format. A phrase line looks like this: |
d7f536a01276
Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents:
25829
diff
changeset
|
2132 |
d7f536a01276
Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents:
25829
diff
changeset
|
2133 @example |
59579
a588c86a429c
Revision: miles@gnu.org--gnu-2005/emacs--cvs-trunk--0--patch-40
Miles Bader <miles@gnu.org>
parents:
59548
diff
changeset
|
2134 [@var{key}] <TABs> @var{phrase} [<TABs> @var{arg}[&&@var{arg}]... [ || @var{arg}]...] |
26911
d7f536a01276
Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents:
25829
diff
changeset
|
2135 @end example |
d7f536a01276
Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents:
25829
diff
changeset
|
2136 |
d7f536a01276
Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents:
25829
diff
changeset
|
2137 @code{<TABs>} stands for white space containing at least one @key{TAB}. |
d7f536a01276
Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents:
25829
diff
changeset
|
2138 @var{key} must be at the start of the line and is the character |
d7f536a01276
Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents:
25829
diff
changeset
|
2139 identifying one of the macros defined in the file header. It is |
d7f536a01276
Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents:
25829
diff
changeset
|
2140 optional - when omitted, the first macro definition line in the file |
d7f536a01276
Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents:
25829
diff
changeset
|
2141 will be used for this phrase. The @var{phrase} is the phrase to be |
d7f536a01276
Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents:
25829
diff
changeset
|
2142 searched for when indexing. It may contain several words separated by |
d7f536a01276
Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents:
25829
diff
changeset
|
2143 spaces. By default the search phrase is also the text entered as |
d7f536a01276
Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents:
25829
diff
changeset
|
2144 argument of the index macro. If you want the index entry to be |
d7f536a01276
Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents:
25829
diff
changeset
|
2145 different from the search phrase, enter another @key{TAB} and the index |
d7f536a01276
Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents:
25829
diff
changeset
|
2146 argument @var{arg}. If you want to have each match produce several |
d7f536a01276
Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents:
25829
diff
changeset
|
2147 index entries, separate the different index arguments with @samp{ && |
d7f536a01276
Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents:
25829
diff
changeset
|
2148 }@footnote{@samp{&&} with optional spaces, see |
d7f536a01276
Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents:
25829
diff
changeset
|
2149 @code{reftex-index-phrases-logical-and-regexp}.}. If you want to be |
d7f536a01276
Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents:
25829
diff
changeset
|
2150 able to choose at each match between several different index arguments, |
d7f536a01276
Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents:
25829
diff
changeset
|
2151 separate them with @samp{ || }@footnote{@samp{||} with optional spaces, |
d7f536a01276
Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents:
25829
diff
changeset
|
2152 see @code{reftex-index-phrases-logical-or-regexp}.}. Here is an |
59536 | 2153 example: |
26911
d7f536a01276
Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents:
25829
diff
changeset
|
2154 |
d7f536a01276
Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents:
25829
diff
changeset
|
2155 @example |
d7f536a01276
Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents:
25829
diff
changeset
|
2156 %-------------------------------------------------------------------- |
d7f536a01276
Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents:
25829
diff
changeset
|
2157 I Sun |
d7f536a01276
Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents:
25829
diff
changeset
|
2158 i Planet Planets |
d7f536a01276
Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents:
25829
diff
changeset
|
2159 i Vega Stars!Vega |
d7f536a01276
Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents:
25829
diff
changeset
|
2160 Jupiter Planets!Jupiter |
d7f536a01276
Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents:
25829
diff
changeset
|
2161 i Mars Planets!Mars || Gods!Mars || Chocolate Bars!Mars |
d7f536a01276
Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents:
25829
diff
changeset
|
2162 i Pluto Planets!Pluto && Kuiper Belt Objects!Pluto |
d7f536a01276
Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents:
25829
diff
changeset
|
2163 @end example |
d7f536a01276
Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents:
25829
diff
changeset
|
2164 |
d7f536a01276
Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents:
25829
diff
changeset
|
2165 |
d7f536a01276
Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents:
25829
diff
changeset
|
2166 So @samp{Sun} will be indexed directly as @samp{\index*@{Sun@}}, while |
d7f536a01276
Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents:
25829
diff
changeset
|
2167 @samp{Planet} will be indexed as @samp{\index@{Planets@}Planet}. |
d7f536a01276
Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents:
25829
diff
changeset
|
2168 @samp{Vega} will be indexed as a subitem of @samp{Stars}. The |
d7f536a01276
Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents:
25829
diff
changeset
|
2169 @samp{Jupiter} line will also use the @samp{i} macro as it was the first |
d7f536a01276
Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents:
25829
diff
changeset
|
2170 macro definition in the file header (see above example). At each |
d7f536a01276
Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents:
25829
diff
changeset
|
2171 occurrence of @samp{Mars} you will be able choose between indexing it as |
d7f536a01276
Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents:
25829
diff
changeset
|
2172 a subitem of @samp{Planets}, @samp{Gods} or @samp{Chocolate Bars}. |
d7f536a01276
Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents:
25829
diff
changeset
|
2173 Finally, every occurrence of @samp{Pluto} will be indexed as |
d7f536a01276
Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents:
25829
diff
changeset
|
2174 @samp{\index@{Planets!Pluto@}\index@{Kuiper Belt Objects!Pluto@}Pluto} |
59536 | 2175 and will therefore create two different index entries. |
26911
d7f536a01276
Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents:
25829
diff
changeset
|
2176 |
d7f536a01276
Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents:
25829
diff
changeset
|
2177 @node Consistency Checks, Global Indexing, Collecting Phrases, The Index Phrases File |
d7f536a01276
Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents:
25829
diff
changeset
|
2178 @subsection Consistency Checks |
d7f536a01276
Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents:
25829
diff
changeset
|
2179 @cindex Index phrases, consistency checks |
d7f536a01276
Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents:
25829
diff
changeset
|
2180 @cindex Phrases, consistency checks |
d7f536a01276
Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents:
25829
diff
changeset
|
2181 @cindex Consistency check for index phrases |
d7f536a01276
Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents:
25829
diff
changeset
|
2182 |
d7f536a01276
Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents:
25829
diff
changeset
|
2183 @kindex C-c C-s |
d7f536a01276
Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents:
25829
diff
changeset
|
2184 Before indexing the phrases in the phrases buffer, they should be |
d7f536a01276
Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents:
25829
diff
changeset
|
2185 checked carefully for consistency. A first step is to sort the phrases |
d7f536a01276
Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents:
25829
diff
changeset
|
2186 alphabetically - this is done with the command @kbd{C-c C-s} |
d7f536a01276
Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents:
25829
diff
changeset
|
2187 (@code{reftex-index-sort-phrases}). It will sort all phrases in the |
d7f536a01276
Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents:
25829
diff
changeset
|
2188 buffer alphabetically by search phrase. If you want to group certain |
d7f536a01276
Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents:
25829
diff
changeset
|
2189 phrases and only sort within the groups, insert empty lines between the |
d7f536a01276
Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents:
25829
diff
changeset
|
2190 groups. Sorting will only change the sequence of phrases within each |
59536 | 2191 group (see the variable @code{reftex-index-phrases-sort-in-blocks}). |
26911
d7f536a01276
Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents:
25829
diff
changeset
|
2192 |
d7f536a01276
Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents:
25829
diff
changeset
|
2193 @kindex C-c C-i |
d7f536a01276
Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents:
25829
diff
changeset
|
2194 A useful command is @kbd{C-c C-i} (@code{reftex-index-phrases-info}) |
d7f536a01276
Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents:
25829
diff
changeset
|
2195 which lists information about the phrase at point, including an example |
d7f536a01276
Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents:
25829
diff
changeset
|
2196 of how the index entry will look like and the number of expected matches |
59536 | 2197 in the document. |
26911
d7f536a01276
Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents:
25829
diff
changeset
|
2198 |
d7f536a01276
Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents:
25829
diff
changeset
|
2199 @kindex C-c C-t |
d7f536a01276
Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents:
25829
diff
changeset
|
2200 Another important check is to find out if there are double or |
d7f536a01276
Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents:
25829
diff
changeset
|
2201 overlapping entries in the buffer. For example if you are first |
d7f536a01276
Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents:
25829
diff
changeset
|
2202 searching and indexing @samp{Mars} and then @samp{Planet Mars}, the |
d7f536a01276
Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents:
25829
diff
changeset
|
2203 second phrase will not match because of the index macro inserted before |
d7f536a01276
Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents:
25829
diff
changeset
|
2204 @samp{Mars} earlier. The command @kbd{C-c C-t} |
d7f536a01276
Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents:
25829
diff
changeset
|
2205 (@code{reftex-index-find-next-conflict-phrase}) finds the next phrase in |
d7f536a01276
Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents:
25829
diff
changeset
|
2206 the buffer which is either duplicate or a subphrase of another phrase. |
d7f536a01276
Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents:
25829
diff
changeset
|
2207 In order to check the whole buffer like this, start at the beginning and |
59536 | 2208 execute this command repeatedly. |
26911
d7f536a01276
Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents:
25829
diff
changeset
|
2209 |
d7f536a01276
Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents:
25829
diff
changeset
|
2210 @node Global Indexing, , Consistency Checks, The Index Phrases File |
d7f536a01276
Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents:
25829
diff
changeset
|
2211 @subsection Global Indexing |
d7f536a01276
Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents:
25829
diff
changeset
|
2212 @cindex Global indexing |
d7f536a01276
Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents:
25829
diff
changeset
|
2213 @cindex Indexing, global |
d7f536a01276
Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents:
25829
diff
changeset
|
2214 @cindex Indexing, from @file{phrases} buffer |
d7f536a01276
Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents:
25829
diff
changeset
|
2215 |
d7f536a01276
Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents:
25829
diff
changeset
|
2216 Once the index phrases have been collected and organized, you are set |
d7f536a01276
Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents:
25829
diff
changeset
|
2217 for global indexing. I recommend to do this only on an otherwise |
d7f536a01276
Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents:
25829
diff
changeset
|
2218 finished document. Global indexing starts from the phrases buffer. |
d7f536a01276
Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents:
25829
diff
changeset
|
2219 There are several commands which start indexing: @kbd{C-c C-x} acts on |
d7f536a01276
Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents:
25829
diff
changeset
|
2220 the current phrase line, @kbd{C-c C-r} on all lines in the current |
d7f536a01276
Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents:
25829
diff
changeset
|
2221 region and @kbd{C-c C-a} on all phrase lines in the buffer. It is |
d7f536a01276
Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents:
25829
diff
changeset
|
2222 probably good to do indexing in small chunks since your concentration |
59536 | 2223 may not last long enough to do everything in one go. |
26911
d7f536a01276
Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents:
25829
diff
changeset
|
2224 |
d7f536a01276
Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents:
25829
diff
changeset
|
2225 @b{Ref@TeX{}} will start at the first phrase line and search the phrase |
d7f536a01276
Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents:
25829
diff
changeset
|
2226 globally in the whole document. At each match it will stop, compute the |
d7f536a01276
Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents:
25829
diff
changeset
|
2227 replacement string and offer you the following choices@footnote{Windows |
59579
a588c86a429c
Revision: miles@gnu.org--gnu-2005/emacs--cvs-trunk--0--patch-40
Miles Bader <miles@gnu.org>
parents:
59548
diff
changeset
|
2228 users: Restrict yourself to the described keys during indexing. Pressing |
59536 | 2229 @key{Help} at the indexing prompt can apparently hang Emacs.}: |
26911
d7f536a01276
Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents:
25829
diff
changeset
|
2230 |
d7f536a01276
Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents:
25829
diff
changeset
|
2231 @table @kbd |
d7f536a01276
Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents:
25829
diff
changeset
|
2232 @item y |
d7f536a01276
Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents:
25829
diff
changeset
|
2233 Replace this match with the proposed string. |
d7f536a01276
Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents:
25829
diff
changeset
|
2234 @item n |
d7f536a01276
Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents:
25829
diff
changeset
|
2235 Skip this match. |
d7f536a01276
Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents:
25829
diff
changeset
|
2236 @item ! |
d7f536a01276
Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents:
25829
diff
changeset
|
2237 Replace this and all further matches in this file. |
d7f536a01276
Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents:
25829
diff
changeset
|
2238 @item q |
d7f536a01276
Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents:
25829
diff
changeset
|
2239 Skip this match, start with next file. |
d7f536a01276
Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents:
25829
diff
changeset
|
2240 @item Q |
d7f536a01276
Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents:
25829
diff
changeset
|
2241 Skip this match, start with next phrase. |
d7f536a01276
Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents:
25829
diff
changeset
|
2242 @item o |
d7f536a01276
Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents:
25829
diff
changeset
|
2243 Select a different indexing macro for this match. |
d7f536a01276
Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents:
25829
diff
changeset
|
2244 @item 1-9 |
d7f536a01276
Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents:
25829
diff
changeset
|
2245 Select one of multiple index keys (those separated with @samp{||}). |
d7f536a01276
Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents:
25829
diff
changeset
|
2246 @item e |
d7f536a01276
Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents:
25829
diff
changeset
|
2247 Edit the replacement text. |
d7f536a01276
Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents:
25829
diff
changeset
|
2248 @item C-r |
40705 | 2249 Recursive edit. Use @kbd{C-M-c} to return to the indexing process. |
26911
d7f536a01276
Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents:
25829
diff
changeset
|
2250 @item s |
d7f536a01276
Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents:
25829
diff
changeset
|
2251 Save this buffer and ask again about the current match. |
d7f536a01276
Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents:
25829
diff
changeset
|
2252 @item S |
d7f536a01276
Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents:
25829
diff
changeset
|
2253 Save all document buffers and ask again about the current match. |
d7f536a01276
Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents:
25829
diff
changeset
|
2254 @item C-g |
d7f536a01276
Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents:
25829
diff
changeset
|
2255 Abort the indexing process. |
d7f536a01276
Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents:
25829
diff
changeset
|
2256 @end table |
d7f536a01276
Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents:
25829
diff
changeset
|
2257 |
d7f536a01276
Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents:
25829
diff
changeset
|
2258 The @samp{Find and Index in Document} menu in the phrases buffer also |
d7f536a01276
Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents:
25829
diff
changeset
|
2259 lists a few options for the indexing process. The options have |
d7f536a01276
Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents:
25829
diff
changeset
|
2260 associated customization variables to set the defaults (@pxref{Options |
d7f536a01276
Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents:
25829
diff
changeset
|
2261 (Index Support)}). Here is a short explanation of what the options do: |
d7f536a01276
Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents:
25829
diff
changeset
|
2262 |
d7f536a01276
Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents:
25829
diff
changeset
|
2263 @table @i |
d7f536a01276
Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents:
25829
diff
changeset
|
2264 @item Match Whole Words |
d7f536a01276
Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents:
25829
diff
changeset
|
2265 When searching for index phrases, make sure whole words are matched. |
d7f536a01276
Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents:
25829
diff
changeset
|
2266 This should probably always be on. |
d7f536a01276
Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents:
25829
diff
changeset
|
2267 @item Case Sensitive Search |
d7f536a01276
Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents:
25829
diff
changeset
|
2268 Search case sensitively for phrases. I recommend to have this setting |
d7f536a01276
Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents:
25829
diff
changeset
|
2269 off, in order to match the capitalized words at the beginning of a |
d7f536a01276
Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents:
25829
diff
changeset
|
2270 sentence, and even typos. You can always say @emph{no} at a match you |
d7f536a01276
Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents:
25829
diff
changeset
|
2271 do not like. |
d7f536a01276
Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents:
25829
diff
changeset
|
2272 @item Wrap Long Lines |
d7f536a01276
Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents:
25829
diff
changeset
|
2273 Inserting index macros increases the line length. Turn this option on |
d7f536a01276
Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents:
25829
diff
changeset
|
2274 to allow @b{Ref@TeX{}} to wrap long lines. |
d7f536a01276
Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents:
25829
diff
changeset
|
2275 @item Skip Indexed Matches |
d7f536a01276
Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents:
25829
diff
changeset
|
2276 When this is on, @b{Ref@TeX{}} will at each match try to figure out if |
d7f536a01276
Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents:
25829
diff
changeset
|
2277 this match is already indexed. A match is considered indexed if it is |
d7f536a01276
Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents:
25829
diff
changeset
|
2278 either the argument of an index macro, or if an index macro is directly |
d7f536a01276
Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents:
25829
diff
changeset
|
2279 (without whitespace separation) before or after the match. Index macros |
d7f536a01276
Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents:
25829
diff
changeset
|
2280 are those configured in @code{reftex-index-macros}. Intended for |
59536 | 2281 re-indexing a documents after changes have been made. |
26911
d7f536a01276
Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents:
25829
diff
changeset
|
2282 @end table |
d7f536a01276
Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents:
25829
diff
changeset
|
2283 |
d7f536a01276
Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents:
25829
diff
changeset
|
2284 Even though indexing should be the last thing you do to a document, you |
d7f536a01276
Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents:
25829
diff
changeset
|
2285 are bound to make changes afterwards. Indexing then has to be applied |
d7f536a01276
Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents:
25829
diff
changeset
|
2286 to the changed regions. The command |
d7f536a01276
Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents:
25829
diff
changeset
|
2287 @code{reftex-index-phrases-apply-to-region} is designed for this |
d7f536a01276
Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents:
25829
diff
changeset
|
2288 purpose. When called from a LaTeX document with active region, it will |
59536 | 2289 apply @code{reftex-index-all-phrases} to the current region. |
26911
d7f536a01276
Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents:
25829
diff
changeset
|
2290 |
d7f536a01276
Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents:
25829
diff
changeset
|
2291 @node Displaying and Editing the Index, Builtin Index Macros, The Index Phrases File, Index Support |
25829 | 2292 @section Displaying and Editing the Index |
2293 @cindex Displaying the Index | |
2294 @cindex Editing the Index | |
2295 @cindex Index entries, creating | |
2296 @cindex Index, displaying | |
2297 @cindex Index, editing | |
2298 @kindex C-c > | |
2299 @findex reftex-display-index | |
2300 | |
2301 In order to compile and display the index, press @kbd{C-c >}. If the | |
2302 document uses multiple indices, @b{Ref@TeX{}} will ask you to select | |
2303 one. Then, all index entries will be sorted alphabetically and | |
2304 displayed in a special buffer, the @file{*Index*} buffer. From that | |
59536 | 2305 buffer you can check and edit each entry. |
25829 | 2306 |
2307 The index can be restricted to the current section or the region. Then | |
2308 only entries in that part of the document will go into the compiled | |
2309 index. To restrict to the current section, use a numeric prefix | |
2310 @samp{2}, thus press @kbd{C-u 2 C-c >}. To restrict to the current | |
2311 region, make the region active and use a numeric prefix @samp{3} (press | |
2312 @kbd{C-u 3 C-c >}). From within the @file{*Index*} buffer the | |
26911
d7f536a01276
Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents:
25829
diff
changeset
|
2313 restriction can be moved from one section to the next by pressing the |
59536 | 2314 @kbd{<} and @kbd{>} keys. |
25829 | 2315 |
2316 One caveat: @b{Ref@TeX{}} finds the definition point of an index entry | |
2317 by searching near the buffer position where it had found to macro during | |
2318 scanning. If you have several identical index entries in the same | |
2319 buffer and significant changes have shifted the entries around, you must | |
2320 rescan the buffer to ensure the correspondence between the | |
2321 @file{*Index*} buffer and the definition locations. It is therefore | |
2322 advisable to rescan the document (with @kbd{r} or @kbd{C-u r}) | |
2323 frequently while editing the index from the @file{*Index*} | |
59536 | 2324 buffer. |
25829 | 2325 |
2326 @kindex ? | |
2327 Here is a list of special commands available in the @file{*Index*} buffer. A | |
2328 summary of this information is always available by pressing | |
59536 | 2329 @kbd{?}. |
25829 | 2330 |
2331 @table @kbd | |
2332 @tablesubheading{General} | |
2333 @item ? | |
2334 Display a summary of commands. | |
2335 | |
2336 @item 0-9, - | |
2337 Prefix argument. | |
2338 | |
2339 @tablesubheading{Moving around} | |
2340 @item ! A..Z | |
2341 Pressing any capital letter will jump to the corresponding section in | |
59579
a588c86a429c
Revision: miles@gnu.org--gnu-2005/emacs--cvs-trunk--0--patch-40
Miles Bader <miles@gnu.org>
parents:
59548
diff
changeset
|
2342 the @file{*Index*} buffer. The exclamation mark is special and jumps to |
25829 | 2343 the first entries alphabetically sorted below @samp{A}. These are |
59536 | 2344 usually non-alphanumeric characters. |
25829 | 2345 @item n |
59536 | 2346 Go to next entry. |
25829 | 2347 @item p |
59536 | 2348 Go to previous entry. |
25829 | 2349 |
2350 @tablesubheading{Access to document locations} | |
2351 @item @key{SPC} | |
59579
a588c86a429c
Revision: miles@gnu.org--gnu-2005/emacs--cvs-trunk--0--patch-40
Miles Bader <miles@gnu.org>
parents:
59548
diff
changeset
|
2352 Show the place in the document where this index entry is defined. |
25829 | 2353 |
2354 @item @key{TAB} | |
2355 Go to the definition of the current index entry in another | |
59536 | 2356 window. |
25829 | 2357 |
2358 @item @key{RET} | |
2359 Go to the definition of the current index entry and hide the | |
59536 | 2360 @file{*Index*} buffer window. |
25829 | 2361 |
2362 @item f | |
2363 @vindex reftex-index-follow-mode | |
2364 @vindex reftex-revisit-to-follow | |
2365 Toggle follow mode. When follow mode is active, the other window will | |
2366 always show the location corresponding to the line in the @file{*Index*} | |
2367 buffer at point. This is similar to pressing @key{SPC} after each | |
2368 cursor motion. The default for this flag can be set with the variable | |
2369 @code{reftex-index-follow-mode}. Note that only context in files | |
2370 already visited is shown. @b{Ref@TeX{}} will not visit a file just for | |
2371 follow mode. See, however, the variable | |
59536 | 2372 @code{reftex-revisit-to-follow}. |
25829 | 2373 |
2374 @tablesubheading{Entry editing} | |
2375 @item e | |
2376 Edit the current index entry. In the minibuffer, you can edit the | |
59536 | 2377 index macro which defines this entry. |
25829 | 2378 |
2379 @item C-k | |
2380 Kill the index entry. Currently not implemented because I don't know | |
59536 | 2381 how to implement an @code{undo} function for this. |
25829 | 2382 |
2383 @item * | |
2384 Edit the @var{key} part of the entry. This is the initial part of the | |
59536 | 2385 entry which determines the location of the entry in the index. |
25829 | 2386 |
2387 @item | | |
2388 Edit the @var{attribute} part of the entry. This is the part after the | |
2389 vertical bar. With @code{MakeIndex}, this part is an encapsulating | |
2390 macro. With @code{xindy}, it is called @emph{attribute} and is a | |
2391 property of the index entry that can lead to special formatting. When | |
2392 called with @kbd{C-u} prefix, kill the entire @var{attribute} | |
59536 | 2393 part. |
25829 | 2394 |
2395 @item @@ | |
2396 Edit the @var{visual} part of the entry. This is the part after the | |
2397 @samp{@@} which is used by @code{MakeIndex} to change the visual | |
2398 appearance of the entry in the index. When called with @kbd{C-u} | |
59536 | 2399 prefix, kill the entire @var{visual} part. |
25829 | 2400 |
2401 @item ( | |
2402 Toggle the beginning of page range property @samp{|(} of the | |
59579
a588c86a429c
Revision: miles@gnu.org--gnu-2005/emacs--cvs-trunk--0--patch-40
Miles Bader <miles@gnu.org>
parents:
59548
diff
changeset
|
2403 entry. |
25829 | 2404 |
2405 @item ) | |
59579
a588c86a429c
Revision: miles@gnu.org--gnu-2005/emacs--cvs-trunk--0--patch-40
Miles Bader <miles@gnu.org>
parents:
59548
diff
changeset
|
2406 Toggle the end of page range property @samp{|)} of the entry. |
25829 | 2407 |
2408 @item _ | |
2409 Make the current entry a subentry. This command will prompt for the | |
59536 | 2410 superordinate entry and insert it. |
25829 | 2411 |
2412 @item ^ | |
59579
a588c86a429c
Revision: miles@gnu.org--gnu-2005/emacs--cvs-trunk--0--patch-40
Miles Bader <miles@gnu.org>
parents:
59548
diff
changeset
|
2413 Remove the highest superordinate entry. If the current entry is a |
25829 | 2414 subitem (@samp{aaa!bbb!ccc}), this function moves it up the hierarchy |
59579
a588c86a429c
Revision: miles@gnu.org--gnu-2005/emacs--cvs-trunk--0--patch-40
Miles Bader <miles@gnu.org>
parents:
59548
diff
changeset
|
2415 (@samp{bbb!ccc}). |
25829 | 2416 |
2417 @tablesubheading{Exiting} | |
2418 @item q | |
59536 | 2419 Hide the @file{*Index*} buffer. |
25829 | 2420 |
2421 @item k | |
59536 | 2422 Kill the @file{*Index*} buffer. |
25829 | 2423 |
2424 @item C-c = | |
59536 | 2425 Switch to the Table of Contents buffer of this document. |
25829 | 2426 |
2427 @tablesubheading{Controlling what gets displayed} | |
2428 @item c | |
2429 @vindex reftex-index-include-context | |
2430 Toggle the display of short context in the @file{*Index*} buffer. The | |
2431 default for this flag can be set with the variable | |
59536 | 2432 @code{reftex-index-include-context}. |
25829 | 2433 |
2434 @item @} | |
2435 Restrict the index to a single document section. The corresponding | |
26911
d7f536a01276
Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents:
25829
diff
changeset
|
2436 section number will be displayed in the @code{R<>} indicator in the |
59536 | 2437 mode line and in the header of the @file{*Index*} buffer. |
25829 | 2438 |
2439 @item @{ | |
59536 | 2440 Widen the index to contain all entries of the document. |
25829 | 2441 |
2442 @item < | |
2443 When the index is currently restricted, move the restriction to the | |
59536 | 2444 previous section. |
25829 | 2445 |
2446 @item > | |
2447 When the index is currently restricted, move the restriction to the | |
59536 | 2448 next section. |
25829 | 2449 |
2450 @tablesubheading{Updating the buffer} | |
2451 @item g | |
2452 Rebuild the @file{*Index*} buffer. This does @emph{not} rescan the | |
2453 document. However, it sorts the entries again, so that edited entries | |
59536 | 2454 will move to the correct position. |
25829 | 2455 |
2456 @item r | |
2457 @vindex reftex-enable-partial-scans | |
2458 Reparse the LaTeX document and rebuild the @file{*Index*} buffer. When | |
59579
a588c86a429c
Revision: miles@gnu.org--gnu-2005/emacs--cvs-trunk--0--patch-40
Miles Bader <miles@gnu.org>
parents:
59548
diff
changeset
|
2459 @code{reftex-enable-partial-scans} is non-@code{nil}, rescan only the file this |
59536 | 2460 location is defined in, not the entire document. |
25829 | 2461 |
2462 @item C-u r | |
2463 Reparse the @emph{entire} LaTeX document and rebuild the @file{*Index*} | |
59536 | 2464 buffer. |
25829 | 2465 |
2466 @item s | |
2467 Switch to a different index (for documents with multiple | |
59579
a588c86a429c
Revision: miles@gnu.org--gnu-2005/emacs--cvs-trunk--0--patch-40
Miles Bader <miles@gnu.org>
parents:
59548
diff
changeset
|
2468 indices). |
25829 | 2469 @end table |
2470 | |
2471 | |
2472 @node Builtin Index Macros, Defining Index Macros, Displaying and Editing the Index, Index Support | |
2473 @section Builtin Index Macros | |
2474 @cindex Builtin index macros | |
2475 @cindex Index macros, builtin | |
2476 @vindex reftex-index-macros | |
2477 @cindex @code{multind}, LaTeX package | |
2478 @cindex @code{index}, LaTeX package | |
2479 @cindex LaTeX packages, @code{multind} | |
2480 @cindex LaTeX packages, @code{index} | |
2481 | |
2482 @b{Ref@TeX{}} by default recognizes the @code{\index} and | |
2483 @code{\glossary} macros which are defined in the LaTeX core. It has | |
26911
d7f536a01276
Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents:
25829
diff
changeset
|
2484 also builtin support for the re-implementations of @code{\index} |
d7f536a01276
Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents:
25829
diff
changeset
|
2485 in the @file{multind} and @file{index} packages. However, since |
25829 | 2486 the different definitions of the @code{\index} macro are incompatible, |
2487 you will have to explicitly specify the index style used. | |
2488 @xref{Creating Index Entries}, for information on how to do that. | |
2489 | |
2490 @node Defining Index Macros, , Builtin Index Macros, Index Support | |
2491 @section Defining Index Macros | |
2492 @cindex Defining Index Macros | |
2493 @cindex Index macros, defining | |
2494 @vindex reftex-index-macros | |
2495 | |
2496 When writing a document with an index you will probably define | |
2497 additional macros which make entries into the index. | |
2498 Let's look at an example. | |
2499 | |
2500 @example | |
2501 \newcommand@{\ix@}[1]@{#1\index@{#1@}@} | |
2502 \newcommand@{\nindex@}[1]@{\textit@{#1@}\index[name]@{#1@}@} | |
2503 \newcommand@{\astobj@}[1]@{\index@{Astronomical Objects!#1@}@} | |
2504 @end example | |
2505 | |
2506 The first macro @code{\ix} typesets its argument in the text and places | |
2507 it into the index. The second macro @code{\nindex} typesets its | |
2508 argument in the text and places it into a separate index with the tag | |
2509 @samp{name}@footnote{We are using the syntax of the @file{index} package | |
2510 here.}. The last macro also places its argument into the index, but as | |
2511 subitems under the main index entry @samp{Astronomical Objects}. Here | |
2512 is how to make @b{Ref@TeX{}} recognize and correctly interpret these | |
2513 macros, first with Emacs Lisp. | |
2514 | |
2515 @lisp | |
2516 (setq reftex-index-macros | |
26911
d7f536a01276
Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents:
25829
diff
changeset
|
2517 '(("\\ix@{*@}" "idx" ?x "" nil nil) |
d7f536a01276
Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents:
25829
diff
changeset
|
2518 ("\\nindex@{*@}" "name" ?n "" nil nil) |
d7f536a01276
Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents:
25829
diff
changeset
|
2519 ("\\astobj@{*@}" "idx" ?o "Astronomical Objects!" nil t))) |
25829 | 2520 @end lisp |
2521 | |
2522 Note that the index tag is @samp{idx} for the main index, and | |
2523 @samp{name} for the name index. @samp{idx} and @samp{glo} are reserved | |
2524 for the default index and for the glossary. | |
2525 | |
2526 The character arguments @code{?x}, @code{?n}, and @code{?o} are for | |
2527 quick identification of these macros when @b{Ref@TeX{}} inserts new | |
2528 index entries with @code{reftex-index}. These codes need to be | |
2529 unique. @code{?i}, @code{?I}, and @code{?g} are reserved for the | |
2530 @code{\index}, @code{\index*}, and @code{\glossary} macros, | |
59579
a588c86a429c
Revision: miles@gnu.org--gnu-2005/emacs--cvs-trunk--0--patch-40
Miles Bader <miles@gnu.org>
parents:
59548
diff
changeset
|
2531 respectively. |
25829 | 2532 |
2533 The following string is empty unless your macro adds a superordinate | |
2534 entry to the index key - this is the case for the @code{\astobj} macro. | |
2535 | |
26911
d7f536a01276
Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents:
25829
diff
changeset
|
2536 The next entry can be a hook function to exclude certain matches, it |
d7f536a01276
Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents:
25829
diff
changeset
|
2537 almost always can be @code{nil}. |
d7f536a01276
Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents:
25829
diff
changeset
|
2538 |
d7f536a01276
Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents:
25829
diff
changeset
|
2539 The final element in the list indicates if the text being indexed needs |
d7f536a01276
Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents:
25829
diff
changeset
|
2540 to be repeated outside the macro. For the normal index macros, this |
d7f536a01276
Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents:
25829
diff
changeset
|
2541 should be @code{t}. Only if the macro typesets the entry in the text |
d7f536a01276
Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents:
25829
diff
changeset
|
2542 (like @code{\ix} and @code{\nindex} in the example do), this should be |
d7f536a01276
Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents:
25829
diff
changeset
|
2543 @code{nil}. |
d7f536a01276
Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents:
25829
diff
changeset
|
2544 |
25829 | 2545 To do the same thing with customize, you need to fill in the templates |
2546 like this: | |
2547 | |
2548 @example | |
2549 Repeat: | |
2550 [INS] [DEL] List: | |
2551 Macro with args: \ix@{*@} | |
2552 Index Tag : [Value Menu] String: idx | |
2553 Access Key : x | |
59579
a588c86a429c
Revision: miles@gnu.org--gnu-2005/emacs--cvs-trunk--0--patch-40
Miles Bader <miles@gnu.org>
parents:
59548
diff
changeset
|
2554 Key Prefix : |
25829 | 2555 Exclusion hook : nil |
26911
d7f536a01276
Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents:
25829
diff
changeset
|
2556 Repeat Outside : [Toggle] off (nil) |
25829 | 2557 [INS] [DEL] List: |
2558 Macro with args: \nindex@{*@} | |
2559 Index Tag : [Value Menu] String: name | |
2560 Access Key : n | |
59579
a588c86a429c
Revision: miles@gnu.org--gnu-2005/emacs--cvs-trunk--0--patch-40
Miles Bader <miles@gnu.org>
parents:
59548
diff
changeset
|
2561 Key Prefix : |
25829 | 2562 Exclusion hook : nil |
26911
d7f536a01276
Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents:
25829
diff
changeset
|
2563 Repeat Outside : [Toggle] off (nil) |
25829 | 2564 [INS] [DEL] List: |
2565 Macro with args: \astobj@{*@} | |
2566 Index Tag : [Value Menu] String: idx | |
2567 Access Key : o | |
2568 Key Prefix : Astronomical Objects! | |
2569 Exclusion hook : nil | |
26911
d7f536a01276
Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents:
25829
diff
changeset
|
2570 Repeat Outside : [Toggle] on (non-nil) |
25829 | 2571 [INS] |
2572 @end example | |
2573 | |
2574 With the macro @code{\ix} defined, you may want to change the default | |
2575 macro used for indexing a text phrase (@pxref{Creating Index Entries}). | |
2576 This would be done like this | |
2577 | |
2578 @lisp | |
26911
d7f536a01276
Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents:
25829
diff
changeset
|
2579 (setq reftex-index-default-macro '(?x "idx")) |
25829 | 2580 @end lisp |
2581 | |
2582 which specifies that the macro identified with the character @code{?x} (the | |
2583 @code{\ix} macro) should be used for indexing phrases and words already | |
2584 in the buffer with @kbd{C-c /} (@code{reftex-index-selection-or-word}). | |
59536 | 2585 The index tag is "idx". |
25829 | 2586 |
2587 @node Viewing Cross-References, RefTeXs Menu, Index Support, Top | |
2588 @chapter Viewing Cross--References | |
2589 @findex reftex-view-crossref | |
2590 @findex reftex-mouse-view-crossref | |
2591 @kindex C-c & | |
37999
8e7df927fd92
Updated to version 4.16
Carsten Dominik <dominik@science.uva.nl>
parents:
37404
diff
changeset
|
2592 @kindex S-mouse-2 |
25829 | 2593 |
2594 @b{Ref@TeX{}} can display cross--referencing information. This means, | |
2595 if two document locations are linked, @b{Ref@TeX{}} can display the | |
2596 matching location(s) in another window. The @code{\label} and @code{\ref} | |
2597 macros are one way of establishing such a link. Also, a @code{\cite} | |
2598 macro is linked to the corresponding @code{\bibitem} macro or a BibTeX | |
59536 | 2599 database entry. |
25829 | 2600 |
2601 The feature is invoked by pressing @kbd{C-c &} | |
2602 (@code{reftex-view-crossref}) while point is on the @var{key} argument | |
2603 of a macro involved in cross--referencing. You can also click with | |
37999
8e7df927fd92
Updated to version 4.16
Carsten Dominik <dominik@science.uva.nl>
parents:
37404
diff
changeset
|
2604 @kbd{S-mouse-2} on the macro argument. Here is what will happen for |
59536 | 2605 individual classes of macros: |
25829 | 2606 |
2607 @table @asis | |
2608 | |
2609 @item @code{\ref} | |
2610 @cindex @code{\ref} | |
2611 Display the corresponding label definition. All usual | |
2612 variants@footnote{all macros that start with @samp{ref} or end with | |
2613 @samp{ref} or @samp{refrange}} of the @code{\ref} macro are active for | |
2614 cross--reference display. This works also for labels defined in an | |
2615 external document when the current document refers to them through the | |
59536 | 2616 @code{xr} interface (@pxref{xr (LaTeX package)}). |
25829 | 2617 |
2618 @item @code{\label} | |
2619 @cindex @code{\label} | |
2620 @vindex reftex-label-alist | |
2621 Display a document location which references this label. Pressing | |
2622 @kbd{C-c &} several times moves through the entire document and finds | |
2623 all locations. Not only the @code{\label} macro but also other macros | |
2624 with label arguments (as configured with @code{reftex-label-alist}) are | |
59536 | 2625 active for cross--reference display. |
25829 | 2626 |
2627 @item @code{\cite} | |
2628 @cindex @code{\cite} | |
2629 Display the corresponding BibTeX database entry or @code{\bibitem}. | |
2630 All usual variants@footnote{all macros that either start or end with | |
2631 @samp{cite}} of the @code{\cite} macro are active for cross--reference | |
59536 | 2632 display. |
25829 | 2633 |
2634 @item @code{\bibitem} | |
2635 @cindex @code{\bibitem} | |
2636 Display a document location which cites this article. Pressing | |
2637 @kbd{C-c &} several times moves through the entire document and finds | |
59536 | 2638 all locations. |
25829 | 2639 |
2640 @item BibTeX | |
2641 @cindex BibTeX buffer, viewing cite locations from | |
2642 @cindex Viewing cite locations from BibTeX buffer | |
2643 @kbd{C-c &} is also active in BibTeX buffers. All locations in a | |
2644 document where the database entry at point is cited will be displayed. | |
2645 On first use, @b{Ref@TeX{}} will prompt for a buffer which belongs to | |
2646 the document you want to search. Subsequent calls will use the same | |
2647 document, until you break this link with a prefix argument to @kbd{C-c | |
59536 | 2648 &}. |
25829 | 2649 |
2650 @item @code{\index} | |
2651 @cindex @code{\index} | |
2652 Display other locations in the document which are marked by an index | |
2653 macro with the same key argument. Along with the standard @code{\index} | |
2654 and @code{\glossary} macros, all macros configured in | |
59536 | 2655 @code{reftex-index-macros} will be recognized. |
25829 | 2656 @end table |
2657 | |
37999
8e7df927fd92
Updated to version 4.16
Carsten Dominik <dominik@science.uva.nl>
parents:
37404
diff
changeset
|
2658 @vindex reftex-view-crossref-extra |
25829 | 2659 While the display of cross referencing information for the above |
2660 mentioned macros is hard--coded, you can configure additional relations | |
37999
8e7df927fd92
Updated to version 4.16
Carsten Dominik <dominik@science.uva.nl>
parents:
37404
diff
changeset
|
2661 in the variable @code{reftex-view-crossref-extra}. |
59579
a588c86a429c
Revision: miles@gnu.org--gnu-2005/emacs--cvs-trunk--0--patch-40
Miles Bader <miles@gnu.org>
parents:
59548
diff
changeset
|
2662 |
25829 | 2663 @iftex |
2664 @chapter All the Rest | |
2665 @end iftex | |
2666 | |
39267 | 2667 @node RefTeXs Menu, Key Bindings, Viewing Cross-References, Top |
25829 | 2668 @section @b{Ref@TeX{}}'s Menu |
2669 @cindex RefTeXs Menu | |
2670 @cindex Menu, in the menu bar | |
2671 | |
2672 @b{Ref@TeX{}} installs a @code{Ref} menu in the menu bar on systems | |
2673 which support this. From this menu you can access all of | |
2674 @b{Ref@TeX{}}'s commands and a few of its options. There is also a | |
2675 @code{Customize} submenu which can be used to access @b{Ref@TeX{}}'s | |
59536 | 2676 entire set of options. |
25829 | 2677 |
39267 | 2678 @node Key Bindings, Faces, RefTeXs Menu, Top |
2679 @section Default Key Bindings | |
2680 @cindex Key Bindings, summary | |
2681 | |
2682 Here is a summary of the available key bindings. | |
25829 | 2683 |
2684 @kindex C-c = | |
47050
904fd28be439
Update to RefTeX 4.19
Carsten Dominik <dominik@science.uva.nl>
parents:
46918
diff
changeset
|
2685 @kindex C-c - |
25829 | 2686 @kindex C-c ( |
2687 @kindex C-c ) | |
2688 @kindex C-c [ | |
2689 @kindex C-c & | |
37999
8e7df927fd92
Updated to version 4.16
Carsten Dominik <dominik@science.uva.nl>
parents:
37404
diff
changeset
|
2690 @kindex S-mouse-2 |
25829 | 2691 @kindex C-c / |
26911
d7f536a01276
Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents:
25829
diff
changeset
|
2692 @kindex C-c \ |
d7f536a01276
Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents:
25829
diff
changeset
|
2693 @kindex C-c | |
25829 | 2694 @kindex C-c < |
2695 @kindex C-c > | |
2696 @example | |
2697 @kbd{C-c =} @code{reftex-toc} | |
47050
904fd28be439
Update to RefTeX 4.19
Carsten Dominik <dominik@science.uva.nl>
parents:
46918
diff
changeset
|
2698 @kbd{C-c -} @code{reftex-toc-recenter} |
25829 | 2699 @kbd{C-c (} @code{reftex-label} |
2700 @kbd{C-c )} @code{reftex-reference} | |
2701 @kbd{C-c [} @code{reftex-citation} | |
2702 @kbd{C-c &} @code{reftex-view-crossref} | |
37999
8e7df927fd92
Updated to version 4.16
Carsten Dominik <dominik@science.uva.nl>
parents:
37404
diff
changeset
|
2703 @kbd{S-mouse-2} @code{reftex-mouse-view-crossref} |
25829 | 2704 @kbd{C-c /} @code{reftex-index-selection-or-word} |
26911
d7f536a01276
Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents:
25829
diff
changeset
|
2705 @kbd{C-c \} @code{reftex-index-phrase-selection-or-word} |
d7f536a01276
Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents:
25829
diff
changeset
|
2706 @kbd{C-c |} @code{reftex-index-visit-phrases-buffer} |
25829 | 2707 @kbd{C-c <} @code{reftex-index} |
2708 @kbd{C-c >} @code{reftex-display-index} | |
2709 @end example | |
2710 | |
37999
8e7df927fd92
Updated to version 4.16
Carsten Dominik <dominik@science.uva.nl>
parents:
37404
diff
changeset
|
2711 Note that the @kbd{S-mouse-2} binding is only provided if this key is |
25829 | 2712 not already used by some other package. @b{Ref@TeX{}} will not override an |
59536 | 2713 existing binding to @kbd{S-mouse-2}. |
25829 | 2714 |
2715 Personally, I also bind some functions in the users @kbd{C-c} map for | |
59536 | 2716 easier access. |
25829 | 2717 |
2718 @c FIXME: Do we need bindings for the Index macros here as well? | |
2719 @c C-c i C-c I or so???? | |
39267 | 2720 @c How about key bindings for reftex-reset-mode and reftex-parse-document? |
25829 | 2721 @kindex C-c t |
2722 @kindex C-c l | |
2723 @kindex C-c r | |
2724 @kindex C-c c | |
2725 @kindex C-c v | |
2726 @kindex C-c s | |
2727 @kindex C-c g | |
2728 @example | |
2729 @kbd{C-c t} @code{reftex-toc} | |
2730 @kbd{C-c l} @code{reftex-label} | |
2731 @kbd{C-c r} @code{reftex-reference} | |
2732 @kbd{C-c c} @code{reftex-citation} | |
2733 @kbd{C-c v} @code{reftex-view-crossref} | |
2734 @kbd{C-c s} @code{reftex-search-document} | |
2735 @kbd{C-c g} @code{reftex-grep-document} | |
2736 @end example | |
2737 | |
2738 @noindent These keys are reserved for the user, so I cannot bind them by | |
39267 | 2739 default. If you want to have these key bindings available, set in your |
25829 | 2740 @file{.emacs} file: |
2741 | |
2742 @vindex reftex-extra-bindings | |
2743 @lisp | |
2744 (setq reftex-extra-bindings t) | |
2745 @end lisp | |
2746 | |
2747 @vindex reftex-load-hook | |
39267 | 2748 Changing and adding to @b{Ref@TeX{}}'s key bindings is best done in the hook |
25829 | 2749 @code{reftex-load-hook}. For information on the keymaps |
2750 which should be used to add keys, see @ref{Keymaps and Hooks}. | |
2751 | |
39267 | 2752 @node Faces, AUCTeX, Key Bindings, Top |
25829 | 2753 @section Faces |
2754 @cindex Faces | |
2755 | |
2756 @b{Ref@TeX{}} uses faces when available to structure the selection and | |
2757 table of contents buffers. It does not create its own faces, but uses | |
2758 the ones defined in @file{font-lock.el}. Therefore, @b{Ref@TeX{}} will | |
2759 use faces only when @code{font-lock} is loaded. This seems to be | |
2760 reasonable because people who like faces will very likely have it | |
2761 loaded. If you wish to turn off fontification or change the involved | |
59536 | 2762 faces, see @ref{Options (Fontification)}. |
25829 | 2763 |
2764 @node Multifile Documents, Language Support, AUCTeX, Top | |
2765 @section Multifile Documents | |
2766 @cindex Multifile documents | |
2767 @cindex Documents, spread over files | |
2768 | |
2769 The following is relevant when working with documents spread over many | |
59536 | 2770 files: |
25829 | 2771 |
2772 @itemize @bullet | |
2773 @item | |
2774 @b{Ref@TeX{}} has full support for multifile documents. You can edit parts of | |
2775 several (multifile) documents at the same time without conflicts. | |
2776 @b{Ref@TeX{}} provides functions to run @code{grep}, @code{search} and | |
2777 @code{query-replace} on all files which are part of a multifile | |
59536 | 2778 document. |
25829 | 2779 |
2780 @item | |
2781 @vindex tex-main-file | |
2782 @vindex TeX-master | |
29772
265fdb06f294
Update to reftex 4 14
Carsten Dominik <dominik@science.uva.nl>
parents:
29713
diff
changeset
|
2783 All files belonging to a multifile document should define a File |
265fdb06f294
Update to reftex 4 14
Carsten Dominik <dominik@science.uva.nl>
parents:
29713
diff
changeset
|
2784 Variable (@code{TeX-master} for AUCTeX or @code{tex-main-file} for the |
265fdb06f294
Update to reftex 4 14
Carsten Dominik <dominik@science.uva.nl>
parents:
29713
diff
changeset
|
2785 standard Emacs LaTeX mode) containing the name of the master file. For |
265fdb06f294
Update to reftex 4 14
Carsten Dominik <dominik@science.uva.nl>
parents:
29713
diff
changeset
|
2786 example, to set the file variable @code{TeX-master}, include something |
59536 | 2787 like the following at the end of each TeX file: |
29772
265fdb06f294
Update to reftex 4 14
Carsten Dominik <dominik@science.uva.nl>
parents:
29713
diff
changeset
|
2788 |
265fdb06f294
Update to reftex 4 14
Carsten Dominik <dominik@science.uva.nl>
parents:
29713
diff
changeset
|
2789 @example |
265fdb06f294
Update to reftex 4 14
Carsten Dominik <dominik@science.uva.nl>
parents:
29713
diff
changeset
|
2790 %%% Local Variables: *** |
265fdb06f294
Update to reftex 4 14
Carsten Dominik <dominik@science.uva.nl>
parents:
29713
diff
changeset
|
2791 %%% mode:latex *** |
265fdb06f294
Update to reftex 4 14
Carsten Dominik <dominik@science.uva.nl>
parents:
29713
diff
changeset
|
2792 %%% TeX-master: "thesis.tex" *** |
265fdb06f294
Update to reftex 4 14
Carsten Dominik <dominik@science.uva.nl>
parents:
29713
diff
changeset
|
2793 %%% End: *** |
265fdb06f294
Update to reftex 4 14
Carsten Dominik <dominik@science.uva.nl>
parents:
29713
diff
changeset
|
2794 @end example |
265fdb06f294
Update to reftex 4 14
Carsten Dominik <dominik@science.uva.nl>
parents:
29713
diff
changeset
|
2795 |
265fdb06f294
Update to reftex 4 14
Carsten Dominik <dominik@science.uva.nl>
parents:
29713
diff
changeset
|
2796 AUCTeX with the setting |
265fdb06f294
Update to reftex 4 14
Carsten Dominik <dominik@science.uva.nl>
parents:
29713
diff
changeset
|
2797 |
265fdb06f294
Update to reftex 4 14
Carsten Dominik <dominik@science.uva.nl>
parents:
29713
diff
changeset
|
2798 @lisp |
265fdb06f294
Update to reftex 4 14
Carsten Dominik <dominik@science.uva.nl>
parents:
29713
diff
changeset
|
2799 (setq-default TeX-master nil) |
265fdb06f294
Update to reftex 4 14
Carsten Dominik <dominik@science.uva.nl>
parents:
29713
diff
changeset
|
2800 @end lisp |
265fdb06f294
Update to reftex 4 14
Carsten Dominik <dominik@science.uva.nl>
parents:
29713
diff
changeset
|
2801 |
265fdb06f294
Update to reftex 4 14
Carsten Dominik <dominik@science.uva.nl>
parents:
29713
diff
changeset
|
2802 will actually ask you for each new file about the master file and insert |
265fdb06f294
Update to reftex 4 14
Carsten Dominik <dominik@science.uva.nl>
parents:
29713
diff
changeset
|
2803 this comment automatically. For more details see the documentation of |
265fdb06f294
Update to reftex 4 14
Carsten Dominik <dominik@science.uva.nl>
parents:
29713
diff
changeset
|
2804 the AUCTeX (@pxref{Multifile,,,auctex, The AUC TeX User Manual}), the |
265fdb06f294
Update to reftex 4 14
Carsten Dominik <dominik@science.uva.nl>
parents:
29713
diff
changeset
|
2805 documentation about the Emacs (La)TeX mode (@pxref{TeX Print,,,emacs, |
265fdb06f294
Update to reftex 4 14
Carsten Dominik <dominik@science.uva.nl>
parents:
29713
diff
changeset
|
2806 The GNU Emacs Manual}) and the Emacs documentation on File Variables |
59536 | 2807 (@pxref{File Variables,,,emacs, The GNU Emacs Manual}). |
25829 | 2808 |
2809 @item | |
2810 The context of a label definition must be found in the same file as the | |
2811 label itself in order to be processed correctly by @b{Ref@TeX{}}. The only | |
2812 exception is that section labels referring to a section statement | |
2813 outside the current file can still use that section title as | |
59536 | 2814 context. |
25829 | 2815 @end itemize |
2816 | |
2817 @node Language Support, Finding Files, Multifile Documents, Top | |
2818 @section Language Support | |
2819 @cindex Language support | |
2820 | |
2821 Some parts of @b{Ref@TeX{}} are language dependent. The default | |
2822 settings work well for English. If you are writing in a different | |
2823 language, the following hints may be useful: | |
2824 | |
2825 @itemize @bullet | |
2826 @item | |
2827 @vindex reftex-derive-label-parameters | |
2828 @vindex reftex-abbrev-parameters | |
2829 The mechanism to derive a label from context includes the abbreviation | |
2830 of words and omission of unimportant words. These mechanisms may have | |
2831 to be changed for other languages. See the variables | |
2832 @code{reftex-derive-label-parameters} and @code{reftex-abbrev-parameters}. | |
2833 | |
2834 @item | |
2835 @vindex reftex-translate-to-ascii-function | |
2836 @vindex reftex-label-illegal-re | |
2837 Also, when a label is derived from context, @b{Ref@TeX{}} clears the | |
60927
bae786986f2e
* calc.texi, cl.texi, gnus.texi, idlwave.texi, reftex.texi: Replace
Werner LEMBERG <wl@gnu.org>
parents:
60919
diff
changeset
|
2838 context string from non-ASCII characters in order to make a valid label. |
25829 | 2839 If there should ever be a version of @TeX{} which allows extended |
2840 characters @emph{in labels}, then we will have to look at the | |
2841 variables @code{reftex-translate-to-ascii-function} and | |
2842 @code{reftex-label-illegal-re}. | |
2843 | |
2844 @item | |
2845 When a label is referenced, @b{Ref@TeX{}} looks at the word before point | |
2846 to guess which label type is required. These @emph{magic words} are | |
2847 different in every language. For an example of how to add magic words, | |
2848 see @ref{Adding Magic Words}. | |
2849 | |
2850 @vindex reftex-multiref-punctuation | |
2851 @vindex reftex-cite-punctuation | |
59579
a588c86a429c
Revision: miles@gnu.org--gnu-2005/emacs--cvs-trunk--0--patch-40
Miles Bader <miles@gnu.org>
parents:
59548
diff
changeset
|
2852 @item |
25829 | 2853 @b{Ref@TeX{}} inserts ``punctuation'' for multiple references and |
2854 for the author list in citations. Some of this may be language | |
2855 dependent. See the variables @code{reftex-multiref-punctuation} and | |
2856 @code{reftex-cite-punctuation}. | |
2857 @end itemize | |
2858 | |
2859 @node Finding Files, Optimizations, Language Support, Top | |
2860 @section Finding Files | |
2861 @cindex Finding files | |
2862 | |
2863 In order to find files included in a document via @code{\input} or | |
2864 @code{\include}, @b{Ref@TeX{}} searches all directories specified in the | |
2865 environment variable @code{TEXINPUTS}. Similarly, it will search the | |
2866 path specified in the variables @code{BIBINPUTS} and @code{TEXBIB} for | |
2867 BibTeX database files. | |
2868 | |
2869 When searching, @b{Ref@TeX{}} will also expand recursive path | |
2870 definitions (directories ending in @samp{//} or @samp{!!}). But it will | |
2871 only search and expand directories @emph{explicitly} given in these | |
2872 variables. This may cause problems under the following circumstances: | |
2873 | |
2874 @itemize @bullet | |
2875 @item | |
2876 Most TeX system have a default search path for both TeX files and BibTeX | |
2877 files which is defined in some setup file. Usually this default path is | |
2878 for system files which @b{Ref@TeX{}} does not need to see. But if your | |
2879 document needs TeX files or BibTeX database files in a directory only | |
2880 given in the default search path, @b{Ref@TeX{}} will fail to find them. | |
2881 @item | |
2882 Some TeX systems do not use environment variables at all in order to | |
2883 specify the search path. Both default and user search path are then | |
2884 defined in setup files. | |
2885 @end itemize | |
2886 | |
2887 @noindent | |
2888 There are three ways to solve this problem: | |
2889 | |
2890 @itemize @bullet | |
2891 @item | |
2892 Specify all relevant directories explicitly in the environment | |
2893 variables. If for some reason you don't want to mess with the default | |
2894 variables @code{TEXINPUTS} and @code{BIBINPUTS}, define your own | |
2895 variables and configure @b{Ref@TeX{}} to use them instead: | |
2896 | |
2897 @lisp | |
2898 (setq reftex-texpath-environment-variables '("MYTEXINPUTS")) | |
2899 (setq reftex-bibpath-environment-variables '("MYBIBINPUTS")) | |
2900 @end lisp | |
2901 | |
2902 @item | |
2903 Specify the full search path directly in @b{Ref@TeX{}}'s variables. | |
2904 | |
2905 @lisp | |
59579
a588c86a429c
Revision: miles@gnu.org--gnu-2005/emacs--cvs-trunk--0--patch-40
Miles Bader <miles@gnu.org>
parents:
59548
diff
changeset
|
2906 (setq reftex-texpath-environment-variables |
25829 | 2907 '("./inp:/home/cd/tex//:/usr/local/tex//")) |
2908 (setq reftex-bibpath-environment-variables | |
2909 '("/home/cd/tex/lit/")) | |
2910 @end lisp | |
2911 | |
2912 @item | |
2913 Some TeX systems provide stand--alone programs to do the file search just | |
2914 like TeX and BibTeX. E.g. Thomas Esser's @code{teTeX} uses the | |
2915 @code{kpathsearch} library which provides the command @code{kpsewhich} | |
2916 to search for files. @b{Ref@TeX{}} can be configured to use this | |
2917 program. Note that the exact syntax of the @code{kpsewhich} | |
2918 command depends upon the version of that program. | |
2919 | |
2920 @lisp | |
2921 (setq reftex-use-external-file-finders t) | |
2922 (setq reftex-external-file-finders | |
37038
528310f62c34
(Finding Files): Fix an example.
Gerd Moellmann <gerd@gnu.org>
parents:
36509
diff
changeset
|
2923 '(("tex" . "kpsewhich -format=.tex %f") |
59579
a588c86a429c
Revision: miles@gnu.org--gnu-2005/emacs--cvs-trunk--0--patch-40
Miles Bader <miles@gnu.org>
parents:
59548
diff
changeset
|
2924 ("bib" . "kpsewhich -format=.bib %f"))) |
25829 | 2925 @end lisp |
2926 @end itemize | |
2927 | |
46684
9569bac241a3
Update to RefTeX 4.18
Carsten Dominik <dominik@science.uva.nl>
parents:
46272
diff
changeset
|
2928 @cindex Noweb files |
9569bac241a3
Update to RefTeX 4.18
Carsten Dominik <dominik@science.uva.nl>
parents:
46272
diff
changeset
|
2929 @vindex reftex-file-extensions |
9569bac241a3
Update to RefTeX 4.18
Carsten Dominik <dominik@science.uva.nl>
parents:
46272
diff
changeset
|
2930 @vindex TeX-file-extensions |
9569bac241a3
Update to RefTeX 4.18
Carsten Dominik <dominik@science.uva.nl>
parents:
46272
diff
changeset
|
2931 Some people like to use RefTeX with noweb files, which usually have the |
9569bac241a3
Update to RefTeX 4.18
Carsten Dominik <dominik@science.uva.nl>
parents:
46272
diff
changeset
|
2932 extension @file{.nw}. In order to deal with such files, the new |
9569bac241a3
Update to RefTeX 4.18
Carsten Dominik <dominik@science.uva.nl>
parents:
46272
diff
changeset
|
2933 extension must be added to the list of valid extensions in the variable |
9569bac241a3
Update to RefTeX 4.18
Carsten Dominik <dominik@science.uva.nl>
parents:
46272
diff
changeset
|
2934 @code{reftex-file-extensions}. When working with AUCTeX as major mode, |
9569bac241a3
Update to RefTeX 4.18
Carsten Dominik <dominik@science.uva.nl>
parents:
46272
diff
changeset
|
2935 the new extension must also be known to AUCTeX via the variable |
9569bac241a3
Update to RefTeX 4.18
Carsten Dominik <dominik@science.uva.nl>
parents:
46272
diff
changeset
|
2936 @code{TeX-file-extension}. For example: |
9569bac241a3
Update to RefTeX 4.18
Carsten Dominik <dominik@science.uva.nl>
parents:
46272
diff
changeset
|
2937 |
9569bac241a3
Update to RefTeX 4.18
Carsten Dominik <dominik@science.uva.nl>
parents:
46272
diff
changeset
|
2938 @lisp |
59579
a588c86a429c
Revision: miles@gnu.org--gnu-2005/emacs--cvs-trunk--0--patch-40
Miles Bader <miles@gnu.org>
parents:
59548
diff
changeset
|
2939 (setq reftex-file-extensions |
46684
9569bac241a3
Update to RefTeX 4.18
Carsten Dominik <dominik@science.uva.nl>
parents:
46272
diff
changeset
|
2940 '(("nw" "tex" ".tex" ".ltx") ("bib" ".bib"))) |
59579
a588c86a429c
Revision: miles@gnu.org--gnu-2005/emacs--cvs-trunk--0--patch-40
Miles Bader <miles@gnu.org>
parents:
59548
diff
changeset
|
2941 (setq TeX-file-extensions |
46684
9569bac241a3
Update to RefTeX 4.18
Carsten Dominik <dominik@science.uva.nl>
parents:
46272
diff
changeset
|
2942 '( "nw" "tex" "sty" "cls" "ltx" "texi" "texinfo")) |
9569bac241a3
Update to RefTeX 4.18
Carsten Dominik <dominik@science.uva.nl>
parents:
46272
diff
changeset
|
2943 @end lisp |
9569bac241a3
Update to RefTeX 4.18
Carsten Dominik <dominik@science.uva.nl>
parents:
46272
diff
changeset
|
2944 |
25829 | 2945 @node Optimizations, Problems and Work-Arounds, Finding Files, Top |
2946 @section Optimizations | |
2947 @cindex Optimizations | |
2948 | |
47050
904fd28be439
Update to RefTeX 4.19
Carsten Dominik <dominik@science.uva.nl>
parents:
46918
diff
changeset
|
2949 @b{Note added 2002. Computers have gotten a lot faster, so most of the |
904fd28be439
Update to RefTeX 4.19
Carsten Dominik <dominik@science.uva.nl>
parents:
46918
diff
changeset
|
2950 optimizations discussed below will not be necessary on new machines. I |
904fd28be439
Update to RefTeX 4.19
Carsten Dominik <dominik@science.uva.nl>
parents:
46918
diff
changeset
|
2951 am leaving this stuff in the manual for people who want to write thick |
904fd28be439
Update to RefTeX 4.19
Carsten Dominik <dominik@science.uva.nl>
parents:
46918
diff
changeset
|
2952 books, where some of it still might be useful.} |
904fd28be439
Update to RefTeX 4.19
Carsten Dominik <dominik@science.uva.nl>
parents:
46918
diff
changeset
|
2953 |
25829 | 2954 Implementing the principle of least surprises, the default settings of |
2955 @b{Ref@TeX{}} ensure a safe ride for beginners and casual users. However, | |
2956 when using @b{Ref@TeX{}} for a large project and/or on a small computer, | |
59536 | 2957 there are ways to improve speed or memory usage. |
25829 | 2958 |
2959 @itemize @bullet | |
2960 @item | |
2961 @b{Removing Lookup Buffers}@* | |
2962 @cindex Removing lookup buffers | |
2963 @b{Ref@TeX{}} will load other parts of a multifile document as well as BibTeX | |
2964 database files for lookup purposes. These buffers are kept, so that | |
2965 subsequent use of the same files is fast. If you can't afford keeping | |
2966 these buffers around, and if you can live with a speed penalty, try | |
2967 | |
2968 @vindex reftex-keep-temporary-buffers | |
2969 @lisp | |
2970 (setq reftex-keep-temporary-buffers nil) | |
2971 @end lisp | |
2972 | |
2973 @item | |
2974 @b{Partial Document Scans}@* | |
2975 @cindex Partial documents scans | |
2976 @cindex Document scanning, partial | |
2977 A @kbd{C-u} prefix on the major @b{Ref@TeX{}} commands @code{reftex-label} | |
2978 (@kbd{C-u C-c (}), @code{reftex-reference} (@kbd{C-u C-c )}), | |
2979 @code{reftex-citation} (@kbd{C-u C-c [}), @code{reftex-toc} (@kbd{C-u C-c | |
2980 =}), and @code{reftex-view-crossref} (@kbd{C-u C-c &}) initiates | |
2981 re-parsing of the entire document in order to update the parsing | |
2982 information. For a large document this can be unnecessary, in | |
2983 particular if only one file has changed. @b{Ref@TeX{}} can be configured | |
2984 to do partial scans instead of full ones. @kbd{C-u} re-parsing then | |
2985 does apply only to the current buffer and files included from it. | |
2986 Likewise, the @kbd{r} key in both the label selection buffer and the | |
2987 table-of-contents buffer will only prompt scanning of the file in which | |
2988 the label or section macro near the cursor was defined. Re-parsing of | |
2989 the entire document is still available by using @kbd{C-u C-u} as a | |
2990 prefix, or the capital @kbd{R} key in the menus. To use this feature, | |
59536 | 2991 try |
25829 | 2992 |
2993 @vindex reftex-enable-partial-scans | |
2994 @lisp | |
2995 (setq reftex-enable-partial-scans t) | |
2996 @end lisp | |
2997 | |
2998 @item | |
2999 @b{Saving Parser Information}@* | |
3000 @cindex Saving parser information | |
3001 @cindex Parse information, saving to a file | |
27195 | 3002 @vindex reftex-parse-file-extension |
25829 | 3003 Even with partial scans enabled, @b{Ref@TeX{}} still has to make one full |
3004 scan, when you start working with a document. To avoid this, parsing | |
3005 information can be stored in a file. The file @file{MASTER.rel} is used | |
3006 for storing information about a document with master file | |
3007 @file{MASTER.tex}. It is written automatically when you kill a buffer | |
3008 in @code{reftex-mode} or when you exit Emacs. The information is | |
3009 restored when you begin working with a document in a new editing | |
59536 | 3010 session. To use this feature, put into @file{.emacs}: |
25829 | 3011 |
3012 @vindex reftex-save-parse-info | |
3013 @lisp | |
3014 (setq reftex-save-parse-info t) | |
3015 @end lisp | |
3016 | |
3017 @item | |
59536 | 3018 @b{Identifying label types by prefix}@* |
3019 @cindex Parse information, saving to a file | |
3020 @vindex reftex-trust-label-prefix | |
3021 @b{Ref@TeX{}} normally parses around each label to check in which | |
3022 environment this label is located, in order to assign a label type to | |
3023 the label. If your document contains thousands of labels, document | |
3024 parsing will take considerable time. If you have been using label prefixes | |
3025 like tab: and fn: consistently, you can tell @b{Ref@TeX{}} to get the | |
3026 label type directly from the prefix, without additional parsing. This | |
3027 will be faster and also allow labels to end up in the correct category | |
3028 if for some reason it is not possible to derive the correct type from | |
3029 context. For example, to enable this feature for footnote and | |
3030 equation labels, use | |
3031 | |
3032 @lisp | |
3033 (setq reftex-trust-label-prefix '("fn:" "eq:")) | |
3034 @end lisp | |
3035 | |
3036 @item | |
25829 | 3037 @b{Automatic Document Scans}@* |
3038 @cindex Automatic document scans | |
3039 @cindex Document scanning, automatic | |
3040 At rare occasions, @b{Ref@TeX{}} will automatically rescan a part of the | |
3041 document. If this gets into your way, it can be turned off with | |
3042 | |
3043 @vindex reftex-allow-automatic-rescan | |
3044 @lisp | |
3045 (setq reftex-allow-automatic-rescan nil) | |
3046 @end lisp | |
3047 | |
3048 @b{Ref@TeX{}} will then occasionally annotate new labels in the selection | |
3049 buffer, saying that their position in the label list in uncertain. A | |
59536 | 3050 manual document scan will fix this. |
25829 | 3051 |
3052 @item | |
3053 @b{Multiple Selection Buffers}@* | |
3054 @cindex Multiple selection buffers | |
3055 @cindex Selection buffers, multiple | |
3056 Normally, the selection buffer @file{*RefTeX Select*} is re-created for | |
3057 every selection process. In documents with very many labels this can | |
3058 take several seconds. @b{Ref@TeX{}} provides an option to create a | |
3059 separate selection buffer for each label type and to keep this buffer | |
3060 from one selection to the next. These buffers are updated automatically | |
3061 only when a new label has been added in the buffers category with | |
3062 @code{reftex-label}. Updating the buffer takes as long as recreating it | |
3063 - so the time saving is limited to cases where no new labels of that | |
59536 | 3064 category have been added. To turn on this feature, use |
25829 | 3065 |
3066 @vindex reftex-use-multiple-selection-buffers | |
3067 @lisp | |
3068 (setq reftex-use-multiple-selection-buffers t) | |
3069 @end lisp | |
3070 | |
3071 @noindent | |
3072 @cindex Selection buffers, updating | |
3073 You can also inhibit the automatic updating entirely. Then the | |
3074 selection buffer will always pop up very fast, but may not contain the | |
3075 most recently defined labels. You can always update the buffer by hand, | |
59536 | 3076 with the @kbd{g} key. To get this behavior, use instead |
25829 | 3077 |
3078 @vindex reftex-auto-update-selection-buffers | |
3079 @lisp | |
3080 (setq reftex-use-multiple-selection-buffers t | |
3081 reftex-auto-update-selection-buffers nil) | |
3082 @end lisp | |
3083 @end itemize | |
3084 | |
3085 @need 2000 | |
3086 @noindent | |
3087 @b{As a summary}, here are the settings I recommend for heavy use of | |
3088 @b{Ref@TeX{}} with large documents: | |
3089 | |
3090 @lisp | |
3091 @group | |
3092 (setq reftex-enable-partial-scans t | |
3093 reftex-save-parse-info t | |
3094 reftex-use-multiple-selection-buffers t) | |
3095 @end group | |
3096 @end lisp | |
3097 | |
3098 @node AUCTeX, Multifile Documents, Faces, Top | |
59579
a588c86a429c
Revision: miles@gnu.org--gnu-2005/emacs--cvs-trunk--0--patch-40
Miles Bader <miles@gnu.org>
parents:
59548
diff
changeset
|
3099 @section AUC@TeX{} |
25829 | 3100 @cindex @code{AUCTeX}, Emacs package |
3101 @cindex Emacs packages, @code{AUCTeX} | |
3102 | |
3103 AUCTeX is without doubt the best major mode for editing TeX and LaTeX | |
29772
265fdb06f294
Update to reftex 4 14
Carsten Dominik <dominik@science.uva.nl>
parents:
29713
diff
changeset
|
3104 files with Emacs (@pxref{Top,AUCTeX,,auctex, The AUCTeX User Manual}). |
46684
9569bac241a3
Update to RefTeX 4.18
Carsten Dominik <dominik@science.uva.nl>
parents:
46272
diff
changeset
|
3105 If AUCTeX is not part of your Emacs distribution, you can get |
29772
265fdb06f294
Update to reftex 4 14
Carsten Dominik <dominik@science.uva.nl>
parents:
29713
diff
changeset
|
3106 it@footnote{XEmacs 21.x users may want to install the corresponding |
59536 | 3107 XEmacs package.} by ftp from the @value{AUCTEXSITE}. |
25829 | 3108 |
3109 @menu | |
3110 * AUCTeX-RefTeX Interface:: How both packages work together | |
3111 * Style Files:: AUCTeX's style files can support RefTeX | |
3112 * Bib-Cite:: Hypertext reading of a document | |
3113 @end menu | |
3114 | |
3115 @node AUCTeX-RefTeX Interface, Style Files, , AUCTeX | |
3116 @subsection The AUC@TeX{}-@b{Ref@TeX{}} Interface | |
3117 | |
3118 @b{Ref@TeX{}} contains code to interface with AUCTeX. When this | |
3119 interface is turned on, both packages will interact closely. Instead of | |
3120 using @b{Ref@TeX{}}'s commands directly, you can then also use them | |
3121 indirectly as part of the AUCTeX | |
3122 environment@footnote{@b{Ref@TeX{}} 4.0 and AUCTeX 9.10c will be | |
3123 needed for all of this to work. Parts of it work also with earlier | |
59536 | 3124 versions.}. The interface is turned on with |
25829 | 3125 |
3126 @lisp | |
3127 (setq reftex-plug-into-AUCTeX t) | |
3128 @end lisp | |
3129 | |
3130 If you need finer control about which parts of the interface are used | |
3131 and which not, read the docstring of the variable | |
3132 @code{reftex-plug-into-AUCTeX} or customize it with @kbd{M-x | |
3133 customize-variable @key{RET} reftex-plug-into-AUCTeX @key{RET}}. | |
3134 | |
3135 The following list describes the individual parts of the interface. | |
3136 | |
3137 @itemize @bullet | |
3138 @item | |
3139 @findex reftex-label | |
3140 @vindex LaTeX-label-function, @r{AUCTeX} | |
3141 @kindex C-c C-e | |
3142 @kindex C-c C-s | |
3143 @findex LaTeX-section, @r{AUCTeX} | |
3144 @findex TeX-insert-macro, @r{AUCTeX} | |
3145 @b{AUCTeX calls @code{reftex-label} to insert labels}@* | |
3146 When a new section is created with @kbd{C-c C-s}, or a new environment | |
3147 is inserted with @kbd{C-c C-e}, AUCTeX normally prompts for a label to | |
3148 go with it. With the interface, @code{reftex-label} is called instead. | |
3149 For example, if you type @kbd{C-c C-e equation @key{RET}}, AUCTeX and | |
3150 @b{Ref@TeX{}} will insert | |
3151 | |
3152 @example | |
3153 \begin@{equation@} | |
3154 \label@{eq:1@} | |
3155 | |
3156 \end@{equation@} | |
3157 @end example | |
3158 | |
3159 @noindent | |
3160 without further prompts. | |
3161 | |
3162 Similarly, when you type @kbd{C-c C-s section @key{RET}}, @b{Ref@TeX{}} | |
3163 will offer its default label which is derived from the section title. | |
3164 | |
3165 @item | |
3166 @b{AUCTeX tells @b{Ref@TeX{}} about new sections}@* | |
3167 When creating a new section with @kbd{C-c C-s}, @b{Ref@TeX{}} will not | |
59536 | 3168 have to rescan the buffer in order to see it. |
25829 | 3169 |
3170 @item | |
3171 @findex reftex-arg-label | |
3172 @findex TeX-arg-label, @r{AUCTeX function} | |
3173 @findex reftex-arg-ref | |
3174 @findex TeX-arg-ref, @r{AUCTeX function} | |
3175 @findex reftex-arg-cite | |
3176 @findex TeX-arg-cite, @r{AUCTeX function} | |
3177 @findex reftex-arg-index | |
3178 @findex TeX-arg-index, @r{AUCTeX function} | |
3179 @findex TeX-insert-macro, @r{AUCTeX function} | |
3180 @kindex C-c @key{RET} | |
3181 @b{@b{Ref@TeX{}} supplies macro arguments}@* When you insert a macro | |
3182 interactively with @kbd{C-c @key{RET}}, AUCTeX normally prompts for | |
3183 macro arguments. Internally, it uses the functions | |
3184 @code{TeX-arg-label}, @code{TeX-arg-cite}, and @code{TeX-arg-index} to | |
3185 prompt for arguments which are labels, citation keys and index entries. | |
3186 The interface takes over these functions@footnote{@code{fset} is used to | |
3187 do this, which is not reversible. However, @b{Ref@TeX{}} implements the | |
3188 old functionality when you later decide to turn off the interface.} and | |
3189 supplies the macro arguments with @b{Ref@TeX{}'s} mechanisms. For | |
3190 example, when you type @kbd{C-c @key{RET} ref @key{RET}}, @b{Ref@TeX{}} | |
3191 will supply its label selection process (@pxref{Referencing | |
59536 | 3192 Labels}). |
25829 | 3193 |
3194 @item | |
3195 @b{@b{Ref@TeX{}} tells AUCTeX about new labels, citation-- and index keys}@* | |
3196 @b{Ref@TeX{}} will add all newly created labels to AUCTeX's completion list. | |
3197 @end itemize | |
3198 | |
3199 @node Style Files, Bib-Cite, AUCTeX-RefTeX Interface, AUCTeX | |
3200 @subsection Style Files | |
3201 @cindex Style files, AUCTeX | |
3202 @findex TeX-add-style-hook, @r{AUCTeX} | |
3203 Style files are Emacs Lisp files which are evaluated by AUCTeX in | |
3204 association with the @code{\documentclass} and @code{\usepackage} | |
29772
265fdb06f294
Update to reftex 4 14
Carsten Dominik <dominik@science.uva.nl>
parents:
29713
diff
changeset
|
3205 commands of a document (@pxref{Style Files,,,auctex}). Support for |
265fdb06f294
Update to reftex 4 14
Carsten Dominik <dominik@science.uva.nl>
parents:
29713
diff
changeset
|
3206 @b{Ref@TeX{}} in such a style file is useful when the LaTeX style |
265fdb06f294
Update to reftex 4 14
Carsten Dominik <dominik@science.uva.nl>
parents:
29713
diff
changeset
|
3207 defines macros or environments connected with labels, citations, or the |
265fdb06f294
Update to reftex 4 14
Carsten Dominik <dominik@science.uva.nl>
parents:
29713
diff
changeset
|
3208 index. Many style files (e.g. @file{amsmath.el} or @file{natbib.el}) |
265fdb06f294
Update to reftex 4 14
Carsten Dominik <dominik@science.uva.nl>
parents:
29713
diff
changeset
|
3209 distributed with AUCTeX already support @b{Ref@TeX{}} in this |
59536 | 3210 way. |
25829 | 3211 |
3212 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 | |
63671
9fc49ac7fb44
(Options (Defining Label Environments), Options (Index Support), Options
Juanma Barranquero <lekktu@gmail.com>
parents:
62469
diff
changeset
|
3214 also work for people who do not use @b{Ref@TeX{}}. |
25829 | 3215 |
3216 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 | |
3218 style file will make @b{Ref@TeX{}} switch over to @code{\eqref}, but | |
59536 | 3219 this will not affect other documents. |
25829 | 3220 |
3221 @findex reftex-add-label-environments | |
3222 @findex reftex-add-to-label-alist | |
3223 A style hook may contain calls to | |
3224 @code{reftex-add-label-environments}@footnote{This used to be the | |
3225 function @code{reftex-add-to-label-alist} which is still available as an | |
3226 alias for compatibility.} which defines additions to | |
3227 @code{reftex-label-alist}. The argument taken by this function must have | |
3228 the same format as @code{reftex-label-alist}. The @file{amsmath.el} | |
59536 | 3229 style file of AUCTeX for example contains the following: |
25829 | 3230 |
3231 @lisp | |
3232 @group | |
3233 (TeX-add-style-hook "amsmath" | |
3234 (lambda () | |
3235 (if (fboundp 'reftex-add-label-environments) | |
3236 (reftex-add-label-environments '(AMSTeX))))) | |
3237 @end group | |
3238 @end lisp | |
3239 | |
3240 @noindent | |
3241 @findex LaTeX-add-environments, @r{AUCTeX} | |
3242 while a package @code{myprop} defining a @code{proposition} environment | |
59536 | 3243 with @code{\newtheorem} might use |
25829 | 3244 |
3245 @lisp | |
3246 @group | |
3247 (TeX-add-style-hook "myprop" | |
3248 (lambda () | |
3249 (LaTeX-add-environments '("proposition" LaTeX-env-label)) | |
3250 (if (fboundp 'reftex-add-label-environments) | |
3251 (reftex-add-label-environments | |
3252 '(("proposition" ?p "prop:" "~\\ref@{%s@}" t | |
26911
d7f536a01276
Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents:
25829
diff
changeset
|
3253 ("Proposition" "Prop.") -3)))))) |
25829 | 3254 @end group |
3255 @end lisp | |
3256 | |
3257 @findex reftex-set-cite-format | |
3258 Similarly, a style hook may contain a call to | |
3259 @code{reftex-set-cite-format} to set the citation format. The style | |
3260 file @file{natbib.el} for the Natbib citation style does switch | |
59536 | 3261 @b{Ref@TeX{}}'s citation format like this: |
25829 | 3262 |
3263 @lisp | |
3264 (TeX-add-style-hook "natbib" | |
3265 (lambda () | |
3266 (if (fboundp 'reftex-set-cite-format) | |
3267 (reftex-set-cite-format 'natbib)))) | |
3268 @end lisp | |
3269 | |
59579
a588c86a429c
Revision: miles@gnu.org--gnu-2005/emacs--cvs-trunk--0--patch-40
Miles Bader <miles@gnu.org>
parents:
59548
diff
changeset
|
3270 @findex reftex-add-index-macros |
25829 | 3271 The hook may contain a call to @code{reftex-add-index-macros} to |
3272 define additional @code{\index}-like macros. The argument must have | |
3273 the same format as @code{reftex-index-macros}. It may be a symbol, to | |
3274 trigger support for one of the builtin index packages. For example, | |
3275 the style @file{multind.el} contains | |
3276 | |
3277 @lisp | |
3278 (TeX-add-style-hook "multind" | |
3279 (lambda () | |
3280 (and (fboundp 'reftex-add-index-macros) | |
3281 (reftex-add-index-macros '(multind))))) | |
3282 @end lisp | |
3283 | |
3284 If you have your own package @file{myindex} which defines the | |
3285 following macros to be used with the LaTeX @file{index.sty} file | |
3286 @example | |
3287 \newcommand@{\molec@}[1]@{#1\index@{Molecules!#1@}@} | |
3288 \newcommand@{\aindex@}[1]@{#1\index[author]@{#1@} | |
3289 @end example | |
3290 | |
3291 you could write this in the style file @file{myindex.el}: | |
3292 | |
3293 @lisp | |
3294 (TeX-add-style-hook "myindex" | |
3295 (lambda () | |
3296 (TeX-add-symbols | |
3297 '("molec" TeX-arg-index) | |
3298 '("aindex" TeX-arg-index)) | |
3299 (if (fboundp 'reftex-add-index-macros) | |
3300 (reftex-add-index-macros | |
26911
d7f536a01276
Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents:
25829
diff
changeset
|
3301 '(("molec@{*@}" "idx" ?m "Molecules!" nil nil) |
d7f536a01276
Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents:
25829
diff
changeset
|
3302 ("aindex@{*@}" "author" ?a "" nil nil)))))) |
25829 | 3303 @end lisp |
3304 | |
3305 @findex reftex-add-section-levels | |
3306 Finally the hook may contain a call to @code{reftex-add-section-levels} | |
3307 to define additional section statements. For example, the FoilTeX class | |
3308 has just two headers, @code{\foilhead} and @code{\rotatefoilhead}. Here | |
3309 is a style file @file{foils.el} that will inform @b{Ref@TeX{}} about these: | |
3310 | |
3311 @lisp | |
3312 (TeX-add-style-hook "foils" | |
3313 (lambda () | |
3314 (if (fboundp 'reftex-add-section-levels) | |
3315 (reftex-add-section-levels '(("foilhead" . 3) | |
3316 ("rotatefoilhead" . 3)))))) | |
3317 @end lisp | |
3318 | |
3319 @node Bib-Cite, , Style Files, AUCTeX | |
3320 @subsection Bib-Cite | |
3321 @cindex @code{bib-cite}, Emacs package | |
3322 @cindex Emacs packages, @code{bib-cite} | |
3323 | |
3324 Once you have written a document with labels, references and citations, | |
3325 it can be nice to read it like a hypertext document. @b{Ref@TeX{}} has | |
26911
d7f536a01276
Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents:
25829
diff
changeset
|
3326 support for that: @code{reftex-view-crossref} (bound to @kbd{C-c |
37999
8e7df927fd92
Updated to version 4.16
Carsten Dominik <dominik@science.uva.nl>
parents:
37404
diff
changeset
|
3327 &}), @code{reftex-mouse-view-crossref} (bound to @kbd{S-mouse-2}), and |
25829 | 3328 @code{reftex-search-document}. A somewhat fancier interface with mouse |
3329 highlighting is provided (among other things) by Peter S. Galbraith's | |
3330 @file{bib-cite.el}. There is some overlap in the functionalities of | |
3331 Bib-cite and @b{Ref@TeX{}}. Bib-cite.el comes bundled with | |
59536 | 3332 AUCTeX. |
25829 | 3333 |
3334 Bib-cite version 3.06 and later can be configured so that bib-cite's | |
3335 mouse functions use @b{Ref@TeX{}} for displaying references and citations. | |
3336 This can be useful in particular when working with the LaTeX @code{xr} | |
3337 package or with an explicit @code{thebibliography} environment (rather | |
3338 than BibTeX). Bib-cite cannot handle those, but @b{Ref@TeX{}} does. To | |
59536 | 3339 make use of this feature, try |
25829 | 3340 |
3341 @vindex bib-cite-use-reftex-view-crossref | |
3342 @lisp | |
3343 (setq bib-cite-use-reftex-view-crossref t) | |
3344 @end lisp | |
3345 | |
3346 @page | |
3347 @node Problems and Work-Arounds, Imprint, Optimizations, Top | |
3348 @section Problems and Work-arounds | |
3349 @cindex Problems and work-arounds | |
3350 | |
3351 @itemize @bullet | |
3352 @item | |
3353 @b{LaTeX commands}@* | |
3354 @cindex LaTeX commands, not found | |
46684
9569bac241a3
Update to RefTeX 4.18
Carsten Dominik <dominik@science.uva.nl>
parents:
46272
diff
changeset
|
3355 @code{\input}, @code{\include}, and @code{\section} (etc.) statements |
59536 | 3356 have to be first on a line (except for white space). |
25829 | 3357 |
3358 @item | |
3359 @b{Commented regions}@* | |
3360 @cindex Labels, commented out | |
3361 @b{Ref@TeX{}} sees also labels in regions commented out and will refuse to | |
59536 | 3362 make duplicates of such labels. This is considered to be a feature. |
25829 | 3363 |
3364 @item | |
3365 @b{Wrong section numbers}@* | |
3366 @cindex Section numbers, wrong | |
3367 @vindex reftex-enable-partial-scans | |
3368 When using partial scans (@code{reftex-enable-partial-scans}), the section | |
3369 numbers in the table of contents may eventually become wrong. A full | |
59536 | 3370 scan will fix this. |
25829 | 3371 |
3372 @item | |
3373 @b{Local settings}@* | |
3374 @cindex Settings, local | |
3375 @findex reftex-add-label-environments | |
3376 @findex reftex-set-cite-format | |
3377 @findex reftex-add-section-levels | |
3378 The label environment definitions in @code{reftex-label-alist} are | |
3379 global and apply to all documents. If you need to make definitions | |
3380 local to a document, because they would interfere with settings in other | |
3381 documents, you should use AUCTeX and set up style files with calls to | |
3382 @code{reftex-add-label-environments}, @code{reftex-set-cite-format}, | |
3383 @code{reftex-add-index-macros}, and @code{reftex-add-section-levels}. | |
3384 Settings made with these functions remain local to the current | |
59536 | 3385 document. @xref{AUCTeX}. |
25829 | 3386 |
3387 @item | |
3388 @b{Funny display in selection buffer}@* | |
3389 @cindex @code{x-symbol}, Emacs package | |
3390 @cindex Emacs packages, @code{x-symbol} | |
3391 @cindex @code{isotex}, Emacs package | |
3392 @cindex Emacs packages, @code{isotex} | |
3393 @cindex @code{iso-cvt}, Emacs package | |
3394 @cindex Emacs packages, @code{iso-cvt} | |
3395 When using packages which make the buffer representation of a file | |
3396 different from its disk representation (e.g. x-symbol, isotex, | |
3397 iso-cvt) you may find that @b{Ref@TeX{}}'s parsing information sometimes | |
3398 reflects the disk state of a file. This happens only in @emph{unvisited} | |
3399 parts of a multifile document, because @b{Ref@TeX{}} visits these files | |
3400 literally for speed reasons. Then both short context and section | |
3401 headings may look different from what you usually see on your screen. | |
3402 In rare cases @code{reftex-toc} may have problems to jump to an affected | |
3403 section heading. There are three possible ways to deal with | |
59579
a588c86a429c
Revision: miles@gnu.org--gnu-2005/emacs--cvs-trunk--0--patch-40
Miles Bader <miles@gnu.org>
parents:
59548
diff
changeset
|
3404 this: |
25829 | 3405 @itemize @minus |
3406 @item | |
3407 @vindex reftex-keep-temporary-buffers | |
3408 @code{(setq reftex-keep-temporary-buffers t)}@* | |
3409 This implies that @b{Ref@TeX{}} will load all parts of a multifile | |
59536 | 3410 document into Emacs (i.e. there won't be any temporary buffers). |
25829 | 3411 @item |
3412 @vindex reftex-initialize-temporary-buffers | |
3413 @code{(setq reftex-initialize-temporary-buffers t)}@* | |
3414 This means full initialization of temporary buffers. It involves | |
59536 | 3415 a penalty when the same unvisited file is used for lookup often. |
25829 | 3416 @item |
3417 Set @code{reftex-initialize-temporary-buffers} to a list of hook | |
59536 | 3418 functions doing a minimal initialization. |
25829 | 3419 @end itemize |
3420 @vindex reftex-refontify-context | |
3421 See also the variable @code{reftex-refontify-context}. | |
3422 | |
3423 @item | |
3424 @b{Labels as arguments to \begin}@* | |
3425 @cindex @code{pf}, LaTeX package | |
3426 @cindex LaTeX packages, @code{pf} | |
3427 Some packages use an additional argument to a @code{\begin} macro | |
3428 to specify a label. E.g. Lamport's @file{pf.sty} uses both | |
3429 @example | |
3430 \step@{@var{label}@}@{@var{claim}@} and \begin@{step+@}@{@var{label}@} | |
3431 @var{claim} | |
3432 \end@{step+@} | |
3433 @end example | |
3434 | |
3435 @noindent | |
3436 We need to trick @b{Ref@TeX{}} into swallowing this: | |
3437 | |
3438 @lisp | |
3439 @group | |
3440 ;; Configuration for Lamport's pf.sty | |
3441 (setq reftex-label-alist | |
26911
d7f536a01276
Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents:
25829
diff
changeset
|
3442 '(("\\step@{*@}@{@}" ?p "st:" "~\\stepref@{%s@}" 2 ("Step" "St.")) |
d7f536a01276
Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents:
25829
diff
changeset
|
3443 ("\\begin@{step+@}@{*@}" ?p "st:" "~\\stepref@{%s@}" 1000))) |
25829 | 3444 @end group |
3445 @end lisp | |
3446 | |
3447 @noindent | |
3448 The first line is just a normal configuration for a macro. For the | |
3449 @code{step+} environment we actually tell @b{Ref@TeX{}} to look for the | |
3450 @emph{macro} @samp{\begin@{step+@}} and interpret the @emph{first} | |
3451 argument (which really is a second argument to the macro @code{\begin}) | |
3452 as a label of type @code{?p}. Argument count for this macro starts only | |
3453 after the @samp{@{step+@}}, also when specifying how to get | |
59579
a588c86a429c
Revision: miles@gnu.org--gnu-2005/emacs--cvs-trunk--0--patch-40
Miles Bader <miles@gnu.org>
parents:
59548
diff
changeset
|
3454 context. |
25829 | 3455 |
3456 @item | |
3457 @b{Idle timers in XEmacs}@* | |
3458 @cindex Idle timer restart | |
3459 @vindex reftex-use-itimer-in-xemacs | |
3460 In XEmacs, idle timer restart does not work reliably after fast | |
3461 keystrokes. Therefore @b{Ref@TeX{}} currently uses the post command | |
3462 hook to start the timer used for automatic crossref information. When | |
3463 this bug gets fixed, a real idle timer can be requested with | |
3464 @lisp | |
3465 (setq reftex-use-itimer-in-xemacs t) | |
3466 @end lisp | |
3467 | |
3468 @item | |
3469 @b{Viper mode}@* | |
3470 @cindex Viper mode | |
39267 | 3471 @cindex Key bindings, problems with Viper mode |
25829 | 3472 @findex viper-harness-minor-mode |
3473 With @i{Viper} mode prior to Vipers version 3.01, you need to protect | |
59536 | 3474 @b{Ref@TeX{}}'s keymaps with |
25829 | 3475 |
3476 @lisp | |
3477 (viper-harness-minor-mode "reftex") | |
3478 @end lisp | |
3479 | |
3480 @end itemize | |
3481 | |
3482 @page | |
3483 @node Imprint, Commands, Problems and Work-Arounds, Top | |
3484 @section Imprint | |
3485 @cindex Imprint | |
3486 @cindex Maintainer | |
3487 @cindex Acknowledgments | |
3488 @cindex Thanks | |
3489 @cindex Bug reports | |
3490 @cindex @code{http}, @b{Ref@TeX{}} home page | |
3491 @cindex @code{ftp}, @b{Ref@TeX{}} site | |
3492 | |
58872
6233bef879d8
(Imprint): Remove erroneous @value's.
Luc Teirlinck <teirllm@auburn.edu>
parents:
57912
diff
changeset
|
3493 @b{Ref@TeX{}} was written by @i{Carsten Dominik} |
46684
9569bac241a3
Update to RefTeX 4.18
Carsten Dominik <dominik@science.uva.nl>
parents:
46272
diff
changeset
|
3494 @email{dominik@@science.uva.nl}, with contributions by @i{Stephen |
63671
9fc49ac7fb44
(Options (Defining Label Environments), Options (Index Support), Options
Juanma Barranquero <lekktu@gmail.com>
parents:
62469
diff
changeset
|
3495 Eglen}. @b{Ref@TeX{}} is currently maintained by |
25829 | 3496 |
3497 @noindent | |
59536 | 3498 Carsten Dominik <dominik@@science.uva.nl> |
25829 | 3499 |
3500 If you have questions about @b{Ref@TeX{}}, there are several Usenet | |
3501 groups which have competent readers: @code{comp.emacs}, | |
59536 | 3502 @code{gnu.emacs.help}, @code{comp.emacs.xemacs}, @code{comp.text.tex}, |
3503 @code{de.comp.text.tex}. You can also write directly to the | |
3504 maintainer. | |
25829 | 3505 |
3506 If you find a bug in @b{Ref@TeX{}} or its documentation, or if you want | |
59536 | 3507 to contribute code or ideas, please @value{MAINTAINERCONTACT}. Remember |
25829 | 3508 to provide all necessary information such as version numbers of Emacs |
3509 and @b{Ref@TeX{}}, and the relevant part of your configuration in | |
3510 @file{.emacs}. When reporting a bug which throws an exception, please | |
3511 include a backtrace if you know how to produce one. | |
3512 | |
3513 @b{Ref@TeX{}} is bundled and pre-installed with Emacs since version 20.2. | |
3514 It was also bundled and pre-installed with XEmacs 19.16--20.x. XEmacs | |
3515 21.x users want to install the corresponding plugin package which is | |
59536 | 3516 available from the @value{XEMACSFTP}. See the XEmacs 21.x |
3517 documentation on package installation for details. | |
25829 | 3518 |
3519 Users of earlier Emacs distributions (including Emacs 19) can get a | |
59536 | 3520 @b{Ref@TeX{}} distribution from the @value{MAINTAINERSITE}. Note that |
3521 the Emacs 19 version supports many but not all features described in | |
3522 this manual. | |
25829 | 3523 |
3524 Thanks to the people on the Net who have used @b{Ref@TeX{}} and helped | |
62469 | 3525 developing it with their reports. In particular thanks to @i{Ralf |
3526 Angeli, Fran Burstall, Alastair Burt, Lars Clausen, Soren Dayton, | |
3527 Stephen Eglen, Karl Eichwalder, Erik Frisk, Peter Galbraith, Kai | |
3528 Grossjohann, Frank Harrell, Till A. Heilmann, Peter Heslin, Stephan | |
3529 Heuel, Alan Ho, Lute Kamstra, Dieter Kraft, David Kastrup, Adrian Lanz, | |
3530 Juri Linkov, Rory Molinari, Stefan Monnier, Laurent Mugnier, Dan | |
3531 Nicolaescu, Sudeep Kumar Palat, Daniel Polani, Alan Shutko, Robin Socha, | |
3532 Richard Stanton, Allan Strand, Jan Vroonhof, Christoph Wedler, Alan | |
3533 Williams, Roland Winkler, Hans-Christoph Wirth, Eli Zaretskii}. | |
59731
03809ff92a7f
documented `reftex-isearch-minor-mode'
Carsten Dominik <dominik@science.uva.nl>
parents:
59579
diff
changeset
|
3534 |
25829 | 3535 |
3536 The @code{view-crossref} feature was inspired by @i{Peter Galbraith's} | |
59536 | 3537 @file{bib-cite.el}. |
3538 | |
3539 Finally thanks to @i{Uwe Bolick} who first got me interested in | |
25829 | 3540 supporting LaTeX labels and references with an editor (which was |
59536 | 3541 MicroEmacs at the time). |
25829 | 3542 |
3543 @node Commands, Options, Imprint, Top | |
3544 @chapter Commands | |
3545 @cindex Commands, list of | |
3546 | |
26911
d7f536a01276
Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents:
25829
diff
changeset
|
3547 Here is a summary of @b{Ref@TeX{}}'s commands which can be executed from |
d7f536a01276
Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents:
25829
diff
changeset
|
3548 LaTeX files. Command which are executed from the special buffers are |
d7f536a01276
Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents:
25829
diff
changeset
|
3549 not described here. All commands are available from the @code{Ref} |
39267 | 3550 menu. See @xref{Key Bindings}. |
25829 | 3551 |
3552 @deffn Command reftex-toc | |
3553 Show the table of contents for the current document. When called with | |
59536 | 3554 one ore two @kbd{C-u} prefixes, rescan the document first. |
25829 | 3555 @end deffn |
3556 | |
3557 @deffn Command reftex-label | |
3558 Insert a unique label. With one or two @kbd{C-u} prefixes, enforce | |
3559 document rescan first. | |
3560 @end deffn | |
3561 | |
3562 @deffn Command reftex-reference | |
3563 Start a selection process to select a label, and insert a reference to | |
3564 it. With one or two @kbd{C-u} prefixes, enforce document rescan first. | |
3565 @end deffn | |
3566 | |
3567 @deffn Command reftex-citation | |
3568 Make a citation using BibTeX database files. After prompting for a regular | |
3569 expression, scans the buffers with BibTeX entries (taken from the | |
3570 @code{\bibliography} command or a @code{thebibliography} environment) | |
3571 and offers the matching entries for selection. The selected entry is | |
46918
82d113655734
Minor spelling and grammar corrections.
Paul Eggert <eggert@twinsun.com>
parents:
46684
diff
changeset
|
3572 formatted according to @code{reftex-cite-format} and inserted into the |
59536 | 3573 buffer. @* |
3574 When called with a @kbd{C-u} prefixe, prompt for optional arguments in | |
3575 cite macros. When called with a numeric prefix, make that many citations. | |
25829 | 3576 When called with point inside the braces of a @code{\cite} command, it |
3577 will add another key, ignoring the value of | |
59579
a588c86a429c
Revision: miles@gnu.org--gnu-2005/emacs--cvs-trunk--0--patch-40
Miles Bader <miles@gnu.org>
parents:
59548
diff
changeset
|
3578 @code{reftex-cite-format}. @* |
25829 | 3579 The regular expression uses an expanded syntax: @samp{&&} is interpreted |
3580 as @code{and}. Thus, @samp{aaaa&&bbb} matches entries which contain | |
3581 both @samp{aaaa} and @samp{bbb}. While entering the regexp, completion | |
3582 on knows citation keys is possible. @samp{=} is a good regular | |
59536 | 3583 expression to match all entries in all files. |
25829 | 3584 @end deffn |
3585 | |
3586 @deffn Command reftex-index | |
3587 Query for an index macro and insert it along with its arguments. The | |
3588 index macros available are those defined in @code{reftex-index-macro} or | |
3589 by a call to @code{reftex-add-index-macros}, typically from an AUCTeX | |
3590 style file. @b{Ref@TeX{}} provides completion for the index tag and the | |
59536 | 3591 index key, and will prompt for other arguments. |
25829 | 3592 @end deffn |
3593 | |
3594 @deffn Command reftex-index-selection-or-word | |
3595 Put current selection or the word near point into the default index | |
3596 macro. This uses the information in @code{reftex-index-default-macro} | |
3597 to make an index entry. The phrase indexed is the current selection or | |
3598 the word near point. When called with one @kbd{C-u} prefix, let the | |
3599 user have a chance to edit the index entry. When called with 2 | |
3600 @kbd{C-u} as prefix, also ask for the index macro and other stuff. When | |
3601 called inside TeX math mode as determined by the @file{texmathp.el} | |
3602 library which is part of AUCTeX, the string is first processed with the | |
59536 | 3603 @code{reftex-index-math-format}, which see. |
25829 | 3604 @end deffn |
3605 | |
26911
d7f536a01276
Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents:
25829
diff
changeset
|
3606 @deffn Command reftex-index-phrase-selection-or-word |
d7f536a01276
Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents:
25829
diff
changeset
|
3607 Add current selection or the word at point to the phrases buffer. |
d7f536a01276
Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents:
25829
diff
changeset
|
3608 When you are in transient-mark-mode and the region is active, the |
d7f536a01276
Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents:
25829
diff
changeset
|
3609 selection will be used - otherwise the word at point. |
d7f536a01276
Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents:
25829
diff
changeset
|
3610 You get a chance to edit the entry in the phrases buffer - to save the |
d7f536a01276
Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents:
25829
diff
changeset
|
3611 buffer and return to the LaTeX document, finish with @kbd{C-c C-c}. |
d7f536a01276
Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents:
25829
diff
changeset
|
3612 @end deffn |
d7f536a01276
Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents:
25829
diff
changeset
|
3613 |
d7f536a01276
Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents:
25829
diff
changeset
|
3614 @deffn Command reftex-index-visit-phrases-buffer |
d7f536a01276
Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents:
25829
diff
changeset
|
3615 Switch to the phrases buffer, initialize if empty. |
d7f536a01276
Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents:
25829
diff
changeset
|
3616 @end deffn |
d7f536a01276
Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents:
25829
diff
changeset
|
3617 |
d7f536a01276
Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents:
25829
diff
changeset
|
3618 @deffn Command reftex-index-phrases-apply-to-region |
d7f536a01276
Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents:
25829
diff
changeset
|
3619 Index all index phrases in the current region. |
d7f536a01276
Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents:
25829
diff
changeset
|
3620 This works exactly like global indexing from the index phrases buffer, |
d7f536a01276
Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents:
25829
diff
changeset
|
3621 but operation is restricted to the current region. |
d7f536a01276
Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents:
25829
diff
changeset
|
3622 @end deffn |
d7f536a01276
Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents:
25829
diff
changeset
|
3623 |
25829 | 3624 @deffn Command reftex-display-index |
3625 Display a buffer with an index compiled from the current document. | |
3626 When the document has multiple indices, first prompts for the correct one. | |
3627 When index support is turned off, offer to turn it on. | |
3628 With one or two @kbd{C-u} prefixes, rescan document first. | |
3629 With prefix 2, restrict index to current document section. | |
59536 | 3630 With prefix 3, restrict index to active region. |
25829 | 3631 @end deffn |
3632 | |
3633 @deffn Command reftex-view-crossref | |
3634 View cross reference of macro at point. Point must be on the @var{key} | |
3635 argument. Works with the macros @code{\label}, @code{\ref}, | |
3636 @code{\cite}, @code{\bibitem}, @code{\index} and many derivatives of | |
3637 these. Where it makes sense, subsequent calls show additional | |
3638 locations. See also the variable @code{reftex-view-crossref-extra} and | |
3639 the command @code{reftex-view-crossref-from-bibtex}. With one or two | |
3640 @kbd{C-u} prefixes, enforce rescanning of the document. With argument | |
3641 2, select the window showing the cross reference. | |
3642 @end deffn | |
3643 | |
3644 @deffn Command reftex-view-crossref-from-bibtex | |
3645 View location in a LaTeX document which cites the BibTeX entry at point. | |
3646 Since BibTeX files can be used by many LaTeX documents, this function | |
3647 prompts upon first use for a buffer in @b{Ref@TeX{}} mode. To reset this | |
46684
9569bac241a3
Update to RefTeX 4.18
Carsten Dominik <dominik@science.uva.nl>
parents:
46272
diff
changeset
|
3648 link to a document, call the function with a prefix arg. Calling |
25829 | 3649 this function several times find successive citation locations. |
3650 @end deffn | |
3651 | |
3652 @deffn Command reftex-create-tags-file | |
3653 Create TAGS file by running @code{etags} on the current document. The | |
3654 TAGS file is also immediately visited with | |
59536 | 3655 @code{visit-tags-table}. |
25829 | 3656 @end deffn |
3657 | |
3658 @deffn Command reftex-grep-document | |
3659 Run grep query through all files related to this document. | |
3660 With prefix arg, force to rescan document. | |
59536 | 3661 No active TAGS table is required. |
25829 | 3662 @end deffn |
3663 | |
3664 @deffn Command reftex-search-document | |
3665 Regexp search through all files of the current document. | |
3666 Starts always in the master file. Stops when a match is found. | |
59536 | 3667 No active TAGS table is required. |
25829 | 3668 @end deffn |
3669 | |
3670 @deffn Command reftex-query-replace-document | |
3671 Run a query-replace-regexp of @var{from} with @var{to} over the entire | |
3672 document. With prefix arg, replace only word-delimited matches. No | |
59536 | 3673 active TAGS table is required. |
25829 | 3674 @end deffn |
3675 | |
59731
03809ff92a7f
documented `reftex-isearch-minor-mode'
Carsten Dominik <dominik@science.uva.nl>
parents:
59579
diff
changeset
|
3676 @deffn Command reftex-isearch-minor-mode |
03809ff92a7f
documented `reftex-isearch-minor-mode'
Carsten Dominik <dominik@science.uva.nl>
parents:
59579
diff
changeset
|
3677 Toggle a minor mode which enables incremental search to work globally |
03809ff92a7f
documented `reftex-isearch-minor-mode'
Carsten Dominik <dominik@science.uva.nl>
parents:
59579
diff
changeset
|
3678 on the entire multifile document. Files will be searched in th |
03809ff92a7f
documented `reftex-isearch-minor-mode'
Carsten Dominik <dominik@science.uva.nl>
parents:
59579
diff
changeset
|
3679 sequence they appear in the document. |
03809ff92a7f
documented `reftex-isearch-minor-mode'
Carsten Dominik <dominik@science.uva.nl>
parents:
59579
diff
changeset
|
3680 @end deffn |
03809ff92a7f
documented `reftex-isearch-minor-mode'
Carsten Dominik <dominik@science.uva.nl>
parents:
59579
diff
changeset
|
3681 |
47050
904fd28be439
Update to RefTeX 4.19
Carsten Dominik <dominik@science.uva.nl>
parents:
46918
diff
changeset
|
3682 @deffn Command reftex-goto-label |
904fd28be439
Update to RefTeX 4.19
Carsten Dominik <dominik@science.uva.nl>
parents:
46918
diff
changeset
|
3683 Prompt for a label (with completion) and jump to the location of this |
904fd28be439
Update to RefTeX 4.19
Carsten Dominik <dominik@science.uva.nl>
parents:
46918
diff
changeset
|
3684 label. Optional prefix argument @var{other-window} goes to the label in |
904fd28be439
Update to RefTeX 4.19
Carsten Dominik <dominik@science.uva.nl>
parents:
46918
diff
changeset
|
3685 another window. |
904fd28be439
Update to RefTeX 4.19
Carsten Dominik <dominik@science.uva.nl>
parents:
46918
diff
changeset
|
3686 @end deffn |
904fd28be439
Update to RefTeX 4.19
Carsten Dominik <dominik@science.uva.nl>
parents:
46918
diff
changeset
|
3687 |
904fd28be439
Update to RefTeX 4.19
Carsten Dominik <dominik@science.uva.nl>
parents:
46918
diff
changeset
|
3688 |
25829 | 3689 @deffn Command reftex-change-label |
3690 Query replace @var{from} with @var{to} in all @code{\label} and | |
3691 @code{\ref} commands. Works on the entire multifile document. No | |
59536 | 3692 active TAGS table is required. |
25829 | 3693 @end deffn |
3694 | |
3695 @deffn Command reftex-renumber-simple-labels | |
3696 Renumber all simple labels in the document to make them sequentially. | |
3697 Simple labels are the ones created by RefTeX, consisting only of the | |
3698 prefix and a number. After the command completes, all these labels will | |
3699 have sequential numbers throughout the document. Any references to the | |
3700 labels will be changed as well. For this, @b{Ref@TeX{}} looks at the | |
3701 arguments of any macros which either start or end with the string | |
3702 @samp{ref}. This command should be used with care, in particular in | |
3703 multifile documents. You should not use it if another document refers | |
59536 | 3704 to this one with the @code{xr} package. |
25829 | 3705 @end deffn |
3706 | |
3707 @deffn Command reftex-find-duplicate-labels | |
59536 | 3708 Produce a list of all duplicate labels in the document. |
3709 @end deffn | |
3710 | |
3711 @deffn Command reftex-create-bibtex-file | |
3712 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 | |
3714 that file. Only entries referenced in the current document with | |
63671
9fc49ac7fb44
(Options (Defining Label Environments), Options (Index Support), Options
Juanma Barranquero <lekktu@gmail.com>
parents:
62469
diff
changeset
|
3715 any @code{\cite}-like macros are used. |
59536 | 3716 The sequence in the new file is the same as it was in the old database. |
25829 | 3717 @end deffn |
3718 | |
3719 @deffn Command reftex-customize | |
3720 Run the customize browser on the @b{Ref@TeX{}} group. | |
3721 @end deffn | |
3722 @deffn Command reftex-show-commentary | |
3723 Show the commentary section from @file{reftex.el}. | |
3724 @end deffn | |
3725 @deffn Command reftex-info | |
3726 Run info on the top @b{Ref@TeX{}} node. | |
3727 @end deffn | |
3728 @deffn Command reftex-parse-document | |
3729 Parse the entire document in order to update the parsing information. | |
3730 @end deffn | |
3731 @deffn Command reftex-reset-mode | |
3732 Enforce rebuilding of several internal lists and variables. Also | |
3733 removes the parse file associated with the current document. | |
3734 @end deffn | |
3735 | |
3736 @node Options, Keymaps and Hooks, Commands, Top | |
3737 @chapter Options, Keymaps, Hooks | |
3738 @cindex Options, list of | |
3739 | |
3740 Here is a complete list of @b{Ref@TeX{}}'s configuration variables. All | |
3741 variables have customize support - so if you are not familiar with Emacs | |
3742 Lisp (and even if you are) you might find it more comfortable to use | |
3743 @code{customize} to look at and change these variables. @kbd{M-x | |
59536 | 3744 reftex-customize} will get you there. |
25829 | 3745 |
3746 @menu | |
3747 * Options (Table of Contents):: | |
3748 * Options (Defining Label Environments):: | |
3749 * Options (Creating Labels):: | |
3750 * Options (Referencing Labels):: | |
3751 * Options (Creating Citations):: | |
3752 * Options (Index Support):: | |
3753 * Options (Viewing Cross-References):: | |
3754 * Options (Finding Files):: | |
3755 * Options (Optimizations):: | |
3756 * Options (Fontification):: | |
3757 * Options (Misc):: | |
3758 @end menu | |
3759 | |
3760 @node Options (Table of Contents), Options (Defining Label Environments), , Options | |
3761 @section Table of Contents | |
3762 @cindex Options, table of contents | |
3763 @cindex Table of contents, options | |
3764 | |
46684
9569bac241a3
Update to RefTeX 4.18
Carsten Dominik <dominik@science.uva.nl>
parents:
46272
diff
changeset
|
3765 @defopt reftex-include-file-commands |
9569bac241a3
Update to RefTeX 4.18
Carsten Dominik <dominik@science.uva.nl>
parents:
46272
diff
changeset
|
3766 List of LaTeX commands which input another file. |
9569bac241a3
Update to RefTeX 4.18
Carsten Dominik <dominik@science.uva.nl>
parents:
46272
diff
changeset
|
3767 The file name is expected after the command, either in braces or separated |
9569bac241a3
Update to RefTeX 4.18
Carsten Dominik <dominik@science.uva.nl>
parents:
46272
diff
changeset
|
3768 by whitespace. |
9569bac241a3
Update to RefTeX 4.18
Carsten Dominik <dominik@science.uva.nl>
parents:
46272
diff
changeset
|
3769 @end defopt |
9569bac241a3
Update to RefTeX 4.18
Carsten Dominik <dominik@science.uva.nl>
parents:
46272
diff
changeset
|
3770 |
9569bac241a3
Update to RefTeX 4.18
Carsten Dominik <dominik@science.uva.nl>
parents:
46272
diff
changeset
|
3771 @defopt reftex-max-section-depth |
9569bac241a3
Update to RefTeX 4.18
Carsten Dominik <dominik@science.uva.nl>
parents:
46272
diff
changeset
|
3772 Maximum depth of section levels in document structure. |
9569bac241a3
Update to RefTeX 4.18
Carsten Dominik <dominik@science.uva.nl>
parents:
46272
diff
changeset
|
3773 Standard LaTeX needs 7, default is 12. |
9569bac241a3
Update to RefTeX 4.18
Carsten Dominik <dominik@science.uva.nl>
parents:
46272
diff
changeset
|
3774 @end defopt |
9569bac241a3
Update to RefTeX 4.18
Carsten Dominik <dominik@science.uva.nl>
parents:
46272
diff
changeset
|
3775 |
9569bac241a3
Update to RefTeX 4.18
Carsten Dominik <dominik@science.uva.nl>
parents:
46272
diff
changeset
|
3776 @defopt reftex-section-levels |
9569bac241a3
Update to RefTeX 4.18
Carsten Dominik <dominik@science.uva.nl>
parents:
46272
diff
changeset
|
3777 Commands and levels used for defining sections in the document. The |
9569bac241a3
Update to RefTeX 4.18
Carsten Dominik <dominik@science.uva.nl>
parents:
46272
diff
changeset
|
3778 @code{car} of each cons cell is the name of the section macro. The |
9569bac241a3
Update to RefTeX 4.18
Carsten Dominik <dominik@science.uva.nl>
parents:
46272
diff
changeset
|
3779 @code{cdr} is a number indicating its level. A negative level means the |
59536 | 3780 same as the positive value, but the section will never get a number. |
3781 The @code{cdr} may also be a function which then has to return the | |
3782 level. This list is also used for promotion and demption of sectioning | |
3783 commands. If you are using a document class which has several sets of | |
3784 sectioning commands, promotion only works correctly if this list is | |
3785 sorted first by set, then within each set by level. The promotion | |
3786 commands always select the nearest entry with the correct new level. | |
3787 | |
46684
9569bac241a3
Update to RefTeX 4.18
Carsten Dominik <dominik@science.uva.nl>
parents:
46272
diff
changeset
|
3788 @end defopt |
9569bac241a3
Update to RefTeX 4.18
Carsten Dominik <dominik@science.uva.nl>
parents:
46272
diff
changeset
|
3789 |
26911
d7f536a01276
Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents:
25829
diff
changeset
|
3790 @defopt reftex-toc-max-level |
d7f536a01276
Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents:
25829
diff
changeset
|
3791 The maximum level of toc entries which will be included in the TOC. |
d7f536a01276
Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents:
25829
diff
changeset
|
3792 Section headings with a bigger level will be ignored. In RefTeX, |
d7f536a01276
Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents:
25829
diff
changeset
|
3793 chapters are level 1, sections level 2 etc. This variable can be |
59536 | 3794 changed from within the @file{*toc*} buffer with the @kbd{t} key. |
26911
d7f536a01276
Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents:
25829
diff
changeset
|
3795 @end defopt |
d7f536a01276
Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents:
25829
diff
changeset
|
3796 |
47050
904fd28be439
Update to RefTeX 4.19
Carsten Dominik <dominik@science.uva.nl>
parents:
46918
diff
changeset
|
3797 @defopt reftex-part-resets-chapter |
904fd28be439
Update to RefTeX 4.19
Carsten Dominik <dominik@science.uva.nl>
parents:
46918
diff
changeset
|
3798 Non-@code{nil} means, @code{\part} is like any other sectioning command. |
904fd28be439
Update to RefTeX 4.19
Carsten Dominik <dominik@science.uva.nl>
parents:
46918
diff
changeset
|
3799 This means, part numbers will be included in the numbering of chapters, and |
904fd28be439
Update to RefTeX 4.19
Carsten Dominik <dominik@science.uva.nl>
parents:
46918
diff
changeset
|
3800 chapter counters will be reset for each part. |
904fd28be439
Update to RefTeX 4.19
Carsten Dominik <dominik@science.uva.nl>
parents:
46918
diff
changeset
|
3801 When @code{nil} (the default), parts are special, do not reset the |
904fd28be439
Update to RefTeX 4.19
Carsten Dominik <dominik@science.uva.nl>
parents:
46918
diff
changeset
|
3802 chapter counter and also do not show up in chapter numbers. |
904fd28be439
Update to RefTeX 4.19
Carsten Dominik <dominik@science.uva.nl>
parents:
46918
diff
changeset
|
3803 @end defopt |
904fd28be439
Update to RefTeX 4.19
Carsten Dominik <dominik@science.uva.nl>
parents:
46918
diff
changeset
|
3804 |
904fd28be439
Update to RefTeX 4.19
Carsten Dominik <dominik@science.uva.nl>
parents:
46918
diff
changeset
|
3805 @defopt reftex-auto-recenter-toc |
59536 | 3806 Non-@code{nil} means, turn automatic recentering of @file{*TOC*} window on. |
3807 When active, the @file{*TOC*} window will always show the section you | |
3808 are currently working in. Recentering happens whenever Emacs is idle for | |
3809 more than @code{reftex-idle-time} seconds. | |
3810 | |
3811 Value @code{t} means, turn on immediately when RefTeX gets started. Then, | |
3812 recentering will work for any toc window created during the session. | |
3813 | |
3814 Value @code{frame} (the default) means, turn automatic recentering on | |
3815 only while the dedicated TOC frame does exist, and do the recentering | |
3816 only in that frame. So when creating that frame (with @kbd{d} key in an | |
3817 ordinary TOC window), the automatic recentering is turned on. When the | |
3818 frame gets destroyed, automatic recentering is turned off again. | |
3819 | |
63671
9fc49ac7fb44
(Options (Defining Label Environments), Options (Index Support), Options
Juanma Barranquero <lekktu@gmail.com>
parents:
62469
diff
changeset
|
3820 This feature can be turned on and off from the menu |
47050
904fd28be439
Update to RefTeX 4.19
Carsten Dominik <dominik@science.uva.nl>
parents:
46918
diff
changeset
|
3821 (Ref->Options). |
904fd28be439
Update to RefTeX 4.19
Carsten Dominik <dominik@science.uva.nl>
parents:
46918
diff
changeset
|
3822 @end defopt |
904fd28be439
Update to RefTeX 4.19
Carsten Dominik <dominik@science.uva.nl>
parents:
46918
diff
changeset
|
3823 |
46684
9569bac241a3
Update to RefTeX 4.18
Carsten Dominik <dominik@science.uva.nl>
parents:
46272
diff
changeset
|
3824 @defopt reftex-toc-split-windows-horizontally |
9569bac241a3
Update to RefTeX 4.18
Carsten Dominik <dominik@science.uva.nl>
parents:
46272
diff
changeset
|
3825 Non-@code{nil} means, create TOC window by splitting window |
9569bac241a3
Update to RefTeX 4.18
Carsten Dominik <dominik@science.uva.nl>
parents:
46272
diff
changeset
|
3826 horizontally. The default is to split vertically. |
9569bac241a3
Update to RefTeX 4.18
Carsten Dominik <dominik@science.uva.nl>
parents:
46272
diff
changeset
|
3827 @end defopt |
9569bac241a3
Update to RefTeX 4.18
Carsten Dominik <dominik@science.uva.nl>
parents:
46272
diff
changeset
|
3828 |
59536 | 3829 @defopt reftex-toc-split-windows-fraction |
3830 Fraction of the width or height of the frame to be used for TOC window. | |
46684
9569bac241a3
Update to RefTeX 4.18
Carsten Dominik <dominik@science.uva.nl>
parents:
46272
diff
changeset
|
3831 @end defopt |
9569bac241a3
Update to RefTeX 4.18
Carsten Dominik <dominik@science.uva.nl>
parents:
46272
diff
changeset
|
3832 |
25829 | 3833 @defopt reftex-toc-keep-other-windows |
3834 Non-@code{nil} means, split the selected window to display the | |
3835 @file{*toc*} buffer. This helps to keep the window configuration, but | |
3836 makes the @file{*toc*} small. When @code{nil}, all other windows except | |
3837 the selected one will be deleted, so that the @file{*toc*} window fills | |
59536 | 3838 half the frame. |
25829 | 3839 @end defopt |
3840 | |
3841 @defopt reftex-toc-include-file-boundaries | |
3842 Non-@code{nil} means, include file boundaries in @file{*toc*} buffer. | |
3843 This flag can be toggled from within the @file{*toc*} buffer with the | |
59536 | 3844 @kbd{i} key. |
25829 | 3845 @end defopt |
3846 | |
3847 @defopt reftex-toc-include-labels | |
3848 Non-@code{nil} means, include labels in @file{*toc*} buffer. This flag | |
3849 can be toggled from within the @file{*toc*} buffer with the @kbd{l} | |
59536 | 3850 key. |
25829 | 3851 @end defopt |
3852 | |
3853 @defopt reftex-toc-include-index-entries | |
3854 Non-@code{nil} means, include index entries in @file{*toc*} buffer. | |
3855 This flag can be toggled from within the @file{*toc*} buffer with the | |
3856 @kbd{i} key. | |
3857 @end defopt | |
3858 | |
3859 @defopt reftex-toc-include-context | |
3860 Non-@code{nil} means, include context with labels in the @file{*toc*} | |
3861 buffer. Context will only be shown if the labels are visible as well. | |
3862 This flag can be toggled from within the @file{*toc*} buffer with the | |
59536 | 3863 @kbd{c} key. |
25829 | 3864 @end defopt |
3865 | |
3866 @defopt reftex-toc-follow-mode | |
3867 Non-@code{nil} means, point in @file{*toc*} buffer (the | |
3868 table-of-contents buffer) will cause other window to follow. The other | |
3869 window will show the corresponding part of the document. This flag can | |
3870 be toggled from within the @file{*toc*} buffer with the @kbd{f} | |
59536 | 3871 key. |
25829 | 3872 @end defopt |
3873 | |
3874 @deffn {Normal Hook} reftex-toc-mode-hook | |
3875 Normal hook which is run when a @file{*toc*} buffer is | |
59536 | 3876 created. |
25829 | 3877 @end deffn |
3878 | |
3879 @deffn Keymap reftex-toc-map | |
3880 The keymap which is active in the @file{*toc*} buffer. | |
59536 | 3881 (@pxref{Table of Contents}). |
25829 | 3882 @end deffn |
3883 | |
3884 @node Options (Defining Label Environments), Options (Creating Labels), Options (Table of Contents), Options | |
3885 @section Defining Label Environments | |
3886 @cindex Options, defining label environments | |
3887 @cindex Defining label environments, options | |
3888 | |
3889 @defopt reftex-default-label-alist-entries | |
3890 Default label alist specifications. It is a list of symbols with | |
3891 associations in the constant @code{reftex-label-alist-builtin}. | |
59536 | 3892 @code{LaTeX} should always be the last entry. |
25829 | 3893 @end defopt |
3894 | |
3895 @defopt reftex-label-alist | |
3896 Set this variable to define additions and changes to the defaults in | |
3897 @code{reftex-default-label-alist-entries}. The only things you | |
3898 @emph{must not} change is that @code{?s} is the type indicator for | |
3899 section labels, and @key{SPC} for the @code{any} label type. These are | |
59536 | 3900 hard-coded at other places in the code. |
25829 | 3901 |
3902 The value of the variable must be a list of items. Each item is a list | |
3903 itself and has the following structure: | |
3904 | |
3905 @example | |
3906 (@var{env-or-macro} @var{type-key} @var{label-prefix} @var{reference-format} | |
26911
d7f536a01276
Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents:
25829
diff
changeset
|
3907 @var{context-method} (@var{magic-word} ... ) @var{toc-level}) |
25829 | 3908 @end example |
3909 | |
3910 Each list entry describes either an environment carrying a counter for | |
3911 use with @code{\label} and @code{\ref}, or a LaTeX macro defining a | |
3912 label as (or inside) one of its arguments. The elements of each list | |
59536 | 3913 entry are: |
25829 | 3914 |
3915 @table @asis | |
3916 @item @var{env-or-macro} | |
3917 Name of the environment (like @samp{table}) or macro (like | |
3918 @samp{\myfig}). For macros, indicate the arguments, as in | |
3919 @samp{\myfig[]@{@}@{@}@{*@}@{@}}. Use square brackets for optional | |
3920 arguments, a star to mark the label argument, if any. The macro does | |
3921 not have to have a label argument - you could also use | |
59536 | 3922 @samp{\label@{...@}} inside one of its arguments. |
25829 | 3923 |
3924 Special names: @code{section} for section labels, @code{any} to define a | |
59536 | 3925 group which contains all labels. |
25829 | 3926 |
3927 This may also be a function to do local parsing and identify point to be | |
46684
9569bac241a3
Update to RefTeX 4.18
Carsten Dominik <dominik@science.uva.nl>
parents:
46272
diff
changeset
|
3928 in a non-standard label environment. The function must take an |
25829 | 3929 argument @var{bound} and limit backward searches to this value. It |
63671
9fc49ac7fb44
(Options (Defining Label Environments), Options (Index Support), Options
Juanma Barranquero <lekktu@gmail.com>
parents:
62469
diff
changeset
|
3930 should return either @code{nil} or a cons cell @code{(@var{function} |
25829 | 3931 . @var{position})} with the function symbol and the position where the |
3932 special environment starts. See the Info documentation for an | |
59536 | 3933 example. |
25829 | 3934 |
3935 Finally this may also be @code{nil} if the entry is only meant to change | |
3936 some settings associated with the type indicator character (see | |
59536 | 3937 below). |
25829 | 3938 |
3939 @item @var{type-key} | |
3940 Type indicator character, like @code{?t}, must be a printable ASCII | |
3941 character. The type indicator is a single character which defines a | |
3942 label type. Any label inside the environment or macro is assumed to | |
3943 belong to this type. The same character may occur several times in this | |
3944 list, to cover cases in which different environments carry the same | |
3945 label type (like @code{equation} and @code{eqnarray}). If the type | |
3946 indicator is @code{nil} and the macro has a label argument @samp{@{*@}}, | |
3947 the macro defines neutral labels just like @code{\label}. In this case | |
59536 | 3948 the reminder of this entry is ignored. |
25829 | 3949 |
3950 @item @var{label-prefix} | |
3951 Label prefix string, like @samp{tab:}. The prefix is a short string | |
3952 used as the start of a label. It may be the empty string. The prefix | |
59536 | 3953 may contain the following @samp{%} escapes: |
25829 | 3954 |
3955 @example | |
3956 %f Current file name, directory and extension stripped. | |
3957 %F Current file name relative to master file directory. | |
59536 | 3958 %m Master file name, directory and extension stripped. |
3959 %M Directory name (without path) where master file is located. | |
25829 | 3960 %u User login name, on systems which support this. |
3961 %S A section prefix derived with variable @code{reftex-section-prefixes}. | |
3962 @end example | |
3963 | |
3964 @noindent | |
3965 Example: In a file @file{intro.tex}, @samp{eq:%f:} will become | |
59536 | 3966 @samp{eq:intro:}. |
25829 | 3967 |
3968 @item @var{reference-format} | |
3969 Format string for reference insert in buffer. @samp{%s} will be | |
3970 replaced by the label. When the format starts with @samp{~}, this | |
3971 @samp{~} will only be inserted when the character before point is | |
59536 | 3972 @emph{not} a whitespace. |
25829 | 3973 |
3974 @item @var{context-method} | |
3975 Indication on how to find the short context. | |
3976 @itemize @minus | |
3977 @item | |
59536 | 3978 If @code{nil}, use the text following the @samp{\label@{...@}} macro. |
25829 | 3979 @item |
3980 If @code{t}, use | |
3981 @itemize @minus | |
3982 @item | |
3983 the section heading for section labels. | |
3984 @item | |
3985 text following the @samp{\begin@{...@}} statement of environments (not | |
3986 a good choice for environments like eqnarray or enumerate, where one has | |
59536 | 3987 several labels in a single environment). |
25829 | 3988 @item |
3989 text after the macro name (starting with the first arg) for | |
59536 | 3990 macros. |
25829 | 3991 @end itemize |
3992 @item | |
3993 If an integer, use the nth argument of the macro. As a special case, | |
59536 | 3994 1000 means to get text after the last macro argument. |
25829 | 3995 @item |
3996 If a string, use as regexp to search @emph{backward} from the label. | |
3997 Context is then the text following the end of the match. E.g. putting | |
3998 this to @samp{\\caption[[@{]} will use the caption in a figure or table | |
3999 environment. @samp{\\begin@{eqnarray@}\|\\\\} works for | |
59536 | 4000 eqnarrays. |
25829 | 4001 @item |
4002 If any of @code{caption}, @code{item}, @code{eqnarray-like}, | |
4003 @code{alignat-like}, this symbol will internally be translated into an | |
4004 appropriate regexp (see also the variable | |
59536 | 4005 @code{reftex-default-context-regexps}). |
25829 | 4006 @item |
4007 If a function, call this function with the name of the environment/macro | |
4008 as argument. On call, point will be just after the @code{\label} macro. | |
4009 The function is expected to return a suitable context string. It should | |
4010 throw an exception (error) when failing to find context. As an example, | |
4011 here is a function returning the 10 chars following the label macro as | |
59536 | 4012 context: |
25829 | 4013 |
4014 @example | |
4015 (defun my-context-function (env-or-mac) | |
4016 (if (> (point-max) (+ 10 (point))) | |
4017 (buffer-substring (point) (+ 10 (point))) | |
4018 (error "Buffer too small"))) | |
4019 @end example | |
4020 @end itemize | |
4021 | |
4022 Label context is used in two ways by @b{Ref@TeX{}}: For display in the label | |
4023 menu, and to derive a label string. If you want to use a different | |
4024 method for each of these, specify them as a dotted pair. | |
4025 E.g. @code{(nil . t)} uses the text after the label (@code{nil}) for | |
4026 display, and text from the default position (@code{t}) to derive a label | |
59536 | 4027 string. This is actually used for section labels. |
25829 | 4028 |
4029 @item @var{magic-word-list} | |
4030 List of magic words which identify a reference to be of this type. If | |
4031 the word before point is equal to one of these words when calling | |
4032 @code{reftex-reference}, the label list offered will be automatically | |
4033 restricted to labels of the correct type. If the first element of this | |
4034 word--list is the symbol `regexp', the strings are interpreted as regular | |
59536 | 4035 expressions. |
26911
d7f536a01276
Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents:
25829
diff
changeset
|
4036 |
d7f536a01276
Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents:
25829
diff
changeset
|
4037 @item @var{toc-level} |
d7f536a01276
Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents:
25829
diff
changeset
|
4038 The integer level at which this environment should be added to the table |
d7f536a01276
Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents:
25829
diff
changeset
|
4039 of contents. See also @code{reftex-section-levels}. A positive value |
d7f536a01276
Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents:
25829
diff
changeset
|
4040 will number the entries mixed with the sectioning commands of the same |
d7f536a01276
Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents:
25829
diff
changeset
|
4041 level. A negative value will make unnumbered entries. Useful only for |
d7f536a01276
Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents:
25829
diff
changeset
|
4042 theorem-like environments which structure the document. Will be ignored |
d7f536a01276
Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents:
25829
diff
changeset
|
4043 for macros. When omitted or @code{nil}, no TOC entries will be |
59536 | 4044 made. |
25829 | 4045 @end table |
4046 | |
4047 If the type indicator characters of two or more entries are the same, | |
59536 | 4048 @b{Ref@TeX{}} will use |
25829 | 4049 @itemize @minus |
4050 @item | |
4051 the first non-@code{nil} format and prefix | |
4052 @item | |
4053 the magic words of all involved entries. | |
4054 @end itemize | |
4055 | |
4056 Any list entry may also be a symbol. If that has an association in | |
4057 @code{reftex-label-alist-builtin}, the @code{cddr} of that association is | |
4058 spliced into the list. However, builtin defaults should normally be set | |
59536 | 4059 with the variable @code{reftex-default-label-alist-entries}. |
25829 | 4060 @end defopt |
4061 | |
4062 @defopt reftex-section-prefixes | |
4063 Prefixes for section labels. When the label prefix given in an entry in | |
4064 @code{reftex-label-alist} contains @samp{%S}, this list is used to | |
4065 determine the correct prefix string depending on the current section | |
4066 level. The list is an alist, with each entry of the form | |
4067 @w{@code{(@var{key} . @var{prefix})}}. Possible keys are sectioning macro | |
4068 names like @samp{chapter}, integer section levels (as given in | |
4069 @code{reftex-section-levels}), and @code{t} for the default. | |
4070 @end defopt | |
4071 | |
4072 @defopt reftex-default-context-regexps | |
4073 Alist with default regular expressions for finding context. The emacs | |
4074 lisp form @w{@code{(format regexp (regexp-quote environment))}} is used | |
4075 to calculate the final regular expression - so @samp{%s} will be | |
59536 | 4076 replaced with the environment or macro. |
4077 @end defopt | |
4078 | |
4079 @defopt reftex-trust-label-prefix | |
4080 Non-@code{nil} means, trust the label prefix when determining label type. | |
4081 It is customary to use special label prefixes to distinguish different label | |
4082 types. The label prefixes have no syntactic meaning in LaTeX (unless | |
4083 special packages like fancyref) are being used. RefTeX can and by | |
4084 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 | |
4086 labels. If you use label prefixes consistently, you may speed up | |
63671
9fc49ac7fb44
(Options (Defining Label Environments), Options (Index Support), Options
Juanma Barranquero <lekktu@gmail.com>
parents:
62469
diff
changeset
|
4087 document parsing by setting this variable to a non-@code{nil} value. RefTeX |
59536 | 4088 will then compare the label prefix with the prefixes found in |
4089 `reftex-label-alist' and derive the correct label type in this way. | |
4090 Possible values for this option are: | |
4091 | |
4092 @example | |
4093 t @r{This means to trust any label prefixes found.} | |
4094 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} | |
63671
9fc49ac7fb44
(Options (Defining Label Environments), Options (Index Support), Options
Juanma Barranquero <lekktu@gmail.com>
parents:
62469
diff
changeset
|
4096 @r{the prefix, e.g. ("fn:" "eqn:" "item:").} |
59536 | 4097 nil @r{Never trust a label prefix.} |
4098 @end example | |
4099 The only disadvantage of using this feature is that the label context | |
4100 displayed in the label selection buffer along with each label is | |
4101 simply some text after the label definition. This is no problem if you | |
4102 place labels keeping this in mind (e.g. @i{before} the equation, @i{at | |
4103 the beginning} of a fig/tab caption ...). Anyway, it is probably best | |
4104 to use the regexp or the list value types to fine-tune this feature. | |
4105 For example, if your document contains thousands of footnotes with | |
4106 labels fn:xxx, you may want to set this variable to the value "^fn:$" or | |
4107 ("fn:"). Then RefTeX will still do extensive parsing for any | |
4108 non-footnote labels. | |
25829 | 4109 @end defopt |
4110 | |
4111 @node Options (Creating Labels), Options (Referencing Labels), Options (Defining Label Environments), Options | |
4112 @section Creating Labels | |
4113 @cindex Options, creating labels | |
4114 @cindex Creating labels, options | |
4115 | |
4116 @defopt reftex-insert-label-flags | |
4117 Flags governing label insertion. The value has the form | |
4118 | |
4119 @example | |
4120 (@var{derive} @var{prompt}) | |
4121 @end example | |
4122 | |
4123 If @var{derive}is @code{t}, @b{Ref@TeX{}} will try to derive a sensible | |
4124 label from context. A section label for example will be derived from | |
60927
bae786986f2e
* calc.texi, cl.texi, gnus.texi, idlwave.texi, reftex.texi: Replace
Werner LEMBERG <wl@gnu.org>
parents:
60919
diff
changeset
|
4125 the section heading. The conversion of the context to a valid label is |
25829 | 4126 governed by the specifications given in |
4127 @code{reftex-derive-label-parameters}. If @var{derive} is @code{nil}, | |
4128 the default label will consist of the prefix and a unique number, like | |
59536 | 4129 @samp{eq:23}. |
25829 | 4130 |
4131 If @var{prompt} is @code{t}, the user will be prompted for a label | |
4132 string. When @var{prompt} is @code{nil}, the default label will be | |
59536 | 4133 inserted without query. |
25829 | 4134 |
4135 So the combination of @var{derive} and @var{prompt} controls label | |
59536 | 4136 insertion. Here is a table describing all four possibilities: |
25829 | 4137 |
4138 @example | |
4139 @group | |
4140 @var{derive} @var{prompt} @var{action} | |
4141 ----------------------------------------------------------- | |
4142 nil nil @r{Insert simple label, like @samp{eq:22} or @samp{sec:13}. No query.} | |
4143 nil t @r{Prompt for label.} | |
4144 t nil @r{Derive a label from context and insert. No query.} | |
4145 t t @r{Derive a label from context, prompt for confirmation.} | |
4146 @end group | |
4147 @end example | |
4148 | |
4149 Each flag may be set to @code{t}, @code{nil}, or a string of label type | |
4150 letters indicating the label types for which it should be true. Thus, | |
4151 the combination may be set differently for each label type. The default | |
4152 settings @samp{"s"} and @samp{"sft"} mean: Derive section labels from | |
4153 headings (with confirmation). Prompt for figure and table labels. Use | |
59536 | 4154 simple labels without confirmation for everything else. |
25829 | 4155 |
4156 The available label types are: @code{s} (section), @code{f} (figure), | |
4157 @code{t} (table), @code{i} (item), @code{e} (equation), @code{n} | |
4158 (footnote), @code{N} (endnote) plus any definitions in | |
59536 | 4159 @code{reftex-label-alist}. |
25829 | 4160 @end defopt |
4161 | |
4162 @deffn Hook reftex-format-label-function | |
4163 If non-@code{nil}, should be a function which produces the string to | |
4164 insert as a label definition. The function will be called with two | |
4165 arguments, the @var{label} and the @var{default-format} (usually | |
4166 @samp{\label@{%s@}}). It should return the string to insert into the | |
59536 | 4167 buffer. |
25829 | 4168 @end deffn |
4169 | |
4170 @deffn Hook reftex-string-to-label-function | |
60927
bae786986f2e
* calc.texi, cl.texi, gnus.texi, idlwave.texi, reftex.texi: Replace
Werner LEMBERG <wl@gnu.org>
parents:
60919
diff
changeset
|
4171 Function to turn an arbitrary string into a valid label. |
25829 | 4172 @b{Ref@TeX{}}'s default function uses the variable |
59536 | 4173 @code{reftex-derive-label-parameters}. |
25829 | 4174 @end deffn |
4175 | |
4176 @deffn Hook reftex-translate-to-ascii-function | |
4177 Filter function which will process a context string before it is used to | |
4178 derive a label from it. The intended application is to convert ISO or | |
60927
bae786986f2e
* calc.texi, cl.texi, gnus.texi, idlwave.texi, reftex.texi: Replace
Werner LEMBERG <wl@gnu.org>
parents:
60919
diff
changeset
|
4179 Mule characters into something valid in labels. The default function |
25829 | 4180 @code{reftex-latin1-to-ascii} removes the accents from Latin-1 |
4181 characters. X-Symbol (>=2.6) sets this variable to the much more | |
59536 | 4182 general @code{x-symbol-translate-to-ascii}. |
25829 | 4183 @end deffn |
4184 | |
4185 @defopt reftex-derive-label-parameters | |
4186 Parameters for converting a string into a label. This variable is a | |
59536 | 4187 list of the following items: |
25829 | 4188 @table @asis |
4189 @item @var{nwords} | |
4190 Number of words to use. | |
4191 @item @var{maxchar} | |
4192 Maximum number of characters in a label string. | |
60919
3ad3287d2e49
* calc.texi, reftex.texi: Replace `illegal' with `invalid'.
Werner LEMBERG <wl@gnu.org>
parents:
59731
diff
changeset
|
4193 @item @var{invalid} |
3ad3287d2e49
* calc.texi, reftex.texi: Replace `illegal' with `invalid'.
Werner LEMBERG <wl@gnu.org>
parents:
59731
diff
changeset
|
4194 @code{nil}: Throw away any words containing characters invalid in labels.@* |
3ad3287d2e49
* calc.texi, reftex.texi: Replace `illegal' with `invalid'.
Werner LEMBERG <wl@gnu.org>
parents:
59731
diff
changeset
|
4195 @code{t}: Throw away only the invalid characters, not the whole word. |
25829 | 4196 @item @var{abbrev} |
4197 @code{nil}: Never abbreviate words.@* | |
4198 @code{t}: Always abbreviate words (see @code{reftex-abbrev-parameters}).@* | |
4199 @code{1}: Abbreviate words if necessary to shorten label string. | |
4200 @item @var{separator} | |
4201 String separating different words in the label. | |
4202 @item @var{ignorewords} | |
4203 List of words which should not be part of labels. | |
4204 @item @var{downcase} | |
4205 @code{t}: Downcase words before putting them into the label.@* | |
4206 @end table | |
4207 @end defopt | |
4208 | |
4209 @defopt reftex-label-illegal-re | |
60919
3ad3287d2e49
* calc.texi, reftex.texi: Replace `illegal' with `invalid'.
Werner LEMBERG <wl@gnu.org>
parents:
59731
diff
changeset
|
4210 Regexp matching characters not valid in labels. |
25829 | 4211 @end defopt |
4212 | |
4213 @defopt reftex-abbrev-parameters | |
59536 | 4214 Parameters for abbreviation of words. A list of four parameters. |
25829 | 4215 @table @asis |
4216 @item @var{min-chars} | |
4217 Minimum number of characters remaining after abbreviation. | |
4218 @item @var{min-kill} | |
59536 | 4219 Minimum number of characters to remove when abbreviating words. |
25829 | 4220 @item @var{before} |
59536 | 4221 Character class before abbrev point in word. |
25829 | 4222 @item @var{after} |
59536 | 4223 Character class after abbrev point in word. |
25829 | 4224 @end table |
4225 @end defopt | |
4226 | |
4227 @node Options (Referencing Labels), Options (Creating Citations), Options (Creating Labels), Options | |
4228 @section Referencing Labels | |
4229 @cindex Options, referencing labels | |
4230 @cindex Referencing labels, options | |
4231 | |
4232 @defopt reftex-label-menu-flags | |
4233 List of flags governing the label menu makeup. The flags are: | |
4234 @table @asis | |
4235 @item @var{table-of-contents} | |
59536 | 4236 Show the labels embedded in a table of context. |
25829 | 4237 @item @var{section-numbers} |
59536 | 4238 Include section numbers (like 4.1.3) in table of contents. |
25829 | 4239 @item @var{counters} |
59536 | 4240 Show counters. This just numbers the labels in the menu. |
25829 | 4241 @item @var{no-context} |
59536 | 4242 Non-@code{nil} means do @emph{not} show the short context. |
25829 | 4243 @item @var{follow} |
59536 | 4244 Follow full context in other window. |
25829 | 4245 @item @var{show-commented} |
59536 | 4246 Show labels from regions which are commented out. |
25829 | 4247 @item @var{match-everywhere} |
59536 | 4248 Obsolete flag. |
25829 | 4249 @item @var{show-files} |
59536 | 4250 Show begin and end of included files. |
25829 | 4251 @end table |
4252 | |
4253 Each of these flags can be set to @code{t} or @code{nil}, or to a string | |
4254 of type letters indicating the label types for which it should be true. | |
4255 These strings work like character classes in regular expressions. Thus, | |
4256 setting one of the flags to @samp{"sf"} makes the flag true for section | |
4257 and figure labels, @code{nil} for everything else. Setting it to | |
59536 | 4258 @samp{"^sf"} makes it the other way round. |
25829 | 4259 |
4260 The available label types are: @code{s} (section), @code{f} (figure), | |
4261 @code{t} (table), @code{i} (item), @code{e} (equation), @code{n} | |
59536 | 4262 (footnote), plus any definitions in @code{reftex-label-alist}. |
25829 | 4263 |
4264 Most options can also be switched from the label menu itself - so if you | |
4265 decide here to not have a table of contents in the label menu, you can | |
59536 | 4266 still get one interactively during selection from the label menu. |
25829 | 4267 @end defopt |
4268 | |
4269 @defopt reftex-multiref-punctuation | |
4270 Punctuation strings for multiple references. When marking is used in | |
4271 the selection buffer to select several references, this variable | |
4272 associates the 3 marking characters @samp{,-+} with prefix strings to be | |
4273 inserted into the buffer before the corresponding @code{\ref} macro. | |
4274 This is used to string together whole reference sets, like | |
4275 @samp{eqs. 1,2,3-5,6 and 7} in a single call to | |
59536 | 4276 @code{reftex-reference}. |
25829 | 4277 @end defopt |
4278 | |
4279 @defopt reftex-vref-is-default | |
4280 Non-@code{nil} means, the varioref macro @code{\vref} is used as | |
4281 default. In the selection buffer, the @kbd{v} key toggles the reference | |
4282 macro between @code{\ref} and @code{\vref}. The value of this variable | |
4283 determines the default which is active when entering the selection | |
4284 process. Instead of @code{nil} or @code{t}, this may also be a string | |
4285 of type letters indicating the label types for which it should be | |
59536 | 4286 true. |
25829 | 4287 @end defopt |
4288 | |
4289 @defopt reftex-fref-is-default | |
4290 Non-@code{nil} means, the fancyref macro @code{\fref} is used as | |
4291 default. In the selection buffer, the @kbd{V} key toggles the reference | |
4292 macro between @code{\ref}, @code{\fref} and @code{\Fref}. The value of | |
4293 this variable determines the default which is active when entering the | |
4294 selection process. Instead of @code{nil} or @code{t}, this may also be | |
4295 a string of type letters indicating the label types for which it should | |
4296 be true. | |
4297 @end defopt | |
4298 | |
4299 @deffn Hook reftex-format-ref-function | |
4300 If non-@code{nil}, should be a function which produces the string to | |
4301 insert as a reference. Note that the insertion format can also be | |
4302 changed with @code{reftex-label-alist}. This hook also is used by the | |
4303 special commands to insert @code{\vref} and @code{\fref} references, so | |
4304 even if you set this, your setting will be ignored by the special | |
4305 commands. The function will be called with two arguments, the | |
4306 @var{label} and the @var{default-format} (usually @samp{~\ref@{%s@}}). | |
59536 | 4307 It should return the string to insert into the buffer. |
25829 | 4308 @end deffn |
4309 | |
4310 @defopt reftex-level-indent | |
59536 | 4311 Number of spaces to be used for indentation per section level. |
25829 | 4312 @end defopt |
4313 | |
4314 @defopt reftex-guess-label-type | |
4315 Non-@code{nil} means, @code{reftex-reference} will try to guess the | |
4316 label type. To do that, @b{Ref@TeX{}} will look at the word before the | |
4317 cursor and compare it with the magic words given in | |
4318 @code{reftex-label-alist}. When it finds a match, @b{Ref@TeX{}} will | |
4319 immediately offer the correct label menu - otherwise it will prompt you | |
4320 for a label type. If you set this variable to @code{nil}, @b{Ref@TeX{}} | |
59536 | 4321 will always prompt for a label type. |
25829 | 4322 @end defopt |
4323 | |
4324 @deffn {Normal Hook} reftex-display-copied-context-hook | |
4325 Normal Hook which is run before context is displayed anywhere. Designed | |
59536 | 4326 for @w{@code{X-Symbol}}, but may have other uses as well. |
25829 | 4327 @end deffn |
4328 | |
4329 @deffn Hook reftex-pre-refontification-functions | |
4330 @code{X-Symbol} specific hook. Probably not useful for other purposes. | |
4331 The functions get two arguments, the buffer from where the command | |
4332 started and a symbol indicating in what context the hook is | |
59536 | 4333 called. |
25829 | 4334 @end deffn |
4335 | |
4336 @deffn {Normal Hook} reftex-select-label-mode-hook | |
4337 Normal hook which is run when a selection buffer enters | |
59579
a588c86a429c
Revision: miles@gnu.org--gnu-2005/emacs--cvs-trunk--0--patch-40
Miles Bader <miles@gnu.org>
parents:
59548
diff
changeset
|
4338 @code{reftex-select-label-mode}. |
25829 | 4339 @end deffn |
4340 | |
4341 @deffn Keymap reftex-select-label-map | |
4342 The keymap which is active in the labels selection process | |
59536 | 4343 (@pxref{Referencing Labels}). |
25829 | 4344 @end deffn |
4345 | |
4346 @node Options (Creating Citations), Options (Index Support), Options (Referencing Labels), Options | |
4347 @section Creating Citations | |
4348 @cindex Options, creating citations | |
4349 @cindex Creating citations, options | |
4350 | |
46684
9569bac241a3
Update to RefTeX 4.18
Carsten Dominik <dominik@science.uva.nl>
parents:
46272
diff
changeset
|
4351 @defopt reftex-bibliography-commands |
9569bac241a3
Update to RefTeX 4.18
Carsten Dominik <dominik@science.uva.nl>
parents:
46272
diff
changeset
|
4352 LaTeX commands which specify the BibTeX databases to use with the document. |
9569bac241a3
Update to RefTeX 4.18
Carsten Dominik <dominik@science.uva.nl>
parents:
46272
diff
changeset
|
4353 @end defopt |
9569bac241a3
Update to RefTeX 4.18
Carsten Dominik <dominik@science.uva.nl>
parents:
46272
diff
changeset
|
4354 |
25829 | 4355 @defopt reftex-bibfile-ignore-regexps |
4356 List of regular expressions to exclude files in | |
4357 @code{\\bibliography@{..@}}. File names matched by any of these regexps | |
4358 will not be parsed. Intended for files which contain only | |
4359 @code{@@string} macro definitions and the like, which are ignored by | |
59536 | 4360 @b{Ref@TeX{}} anyway. |
25829 | 4361 @end defopt |
4362 | |
4363 @defopt reftex-default-bibliography | |
4364 List of BibTeX database files which should be used if none are specified. | |
4365 When @code{reftex-citation} is called from a document with neither | |
4366 a @samp{\bibliography@{...@}} statement nor a @code{thebibliography} | |
4367 environment, @b{Ref@TeX{}} will scan these files instead. Intended for | |
4368 using @code{reftex-citation} in non-LaTeX files. The files will be | |
59536 | 4369 searched along the BIBINPUTS or TEXBIB path. |
25829 | 4370 @end defopt |
4371 | |
4372 @defopt reftex-sort-bibtex-matches | |
4373 Sorting of the entries found in BibTeX databases by reftex-citation. | |
59536 | 4374 Possible values: |
25829 | 4375 @example |
4376 nil @r{Do not sort entries.} | |
4377 author @r{Sort entries by author name.} | |
4378 year @r{Sort entries by increasing year.} | |
4379 reverse-year @r{Sort entries by decreasing year.} | |
4380 @end example | |
4381 @end defopt | |
4382 | |
4383 @defopt reftex-cite-format | |
4384 The format of citations to be inserted into the buffer. It can be a | |
4385 string, an alist or a symbol. In the simplest case this is just the string | |
4386 @samp{\cite@{%l@}}, which is also the default. See the definition of | |
59536 | 4387 @code{reftex-cite-format-builtin} for more complex examples. |
25829 | 4388 |
4389 If @code{reftex-cite-format} is a string, it will be used as the format. | |
59536 | 4390 In the format, the following percent escapes will be expanded. |
25829 | 4391 |
4392 @table @code | |
4393 @item %l | |
4394 The BibTeX label of the citation. | |
4395 @item %a | |
4396 List of author names, see also @code{reftex-cite-punctuation}. | |
4397 @item %2a | |
4398 Like %a, but abbreviate more than 2 authors like Jones et al. | |
4399 @item %A | |
4400 First author name only. | |
4401 @item %e | |
4402 Works like @samp{%a}, but on list of editor names. (@samp{%2e} and | |
59536 | 4403 @samp{%E} work a well). |
25829 | 4404 @end table |
4405 | |
4406 It is also possible to access all other BibTeX database fields: | |
4407 | |
4408 @example | |
4409 %b booktitle %c chapter %d edition %h howpublished | |
4410 %i institution %j journal %k key %m month | |
4411 %n number %o organization %p pages %P first page | |
4412 %r address %s school %u publisher %t title | |
4413 %v volume %y year | |
4414 %B booktitle, abbreviated %T title, abbreviated | |
4415 @end example | |
4416 | |
4417 @noindent | |
4418 Usually, only @samp{%l} is needed. The other stuff is mainly for the | |
59536 | 4419 echo area display, and for @code{(setq reftex-comment-citations t)}. |
25829 | 4420 |
4421 @samp{%<} as a special operator kills punctuation and space around it | |
59536 | 4422 after the string has been formatted. |
4423 | |
4424 A pair of square brackets indicates an optional argument, and RefTeX | |
4425 will prompt for the values of these arguments. | |
25829 | 4426 |
4427 Beware that all this only works with BibTeX database files. When | |
4428 citations are made from the @code{\bibitems} in an explicit | |
59536 | 4429 @code{thebibliography} environment, only @samp{%l} is available. |
25829 | 4430 |
4431 If @code{reftex-cite-format} is an alist of characters and strings, the | |
4432 user will be prompted for a character to select one of the possible | |
59536 | 4433 format strings. |
25829 | 4434 |
4435 In order to configure this variable, you can either set | |
4436 @code{reftex-cite-format} directly yourself or set it to the | |
4437 @emph{symbol} of one of the predefined styles. The predefined symbols | |
4438 are those which have an association in the constant | |
4439 @code{reftex-cite-format-builtin}) E.g.: @code{(setq reftex-cite-format | |
59536 | 4440 'natbib)}. |
25829 | 4441 @end defopt |
4442 | |
4443 @deffn Hook reftex-format-cite-function | |
4444 If non-@code{nil}, should be a function which produces the string to | |
4445 insert as a citation. Note that the citation format can also be changed | |
4446 with the variable @code{reftex-cite-format}. The function will be | |
4447 called with two arguments, the @var{citation-key} and the | |
4448 @var{default-format} (taken from @code{reftex-cite-format}). It should | |
59536 | 4449 return the string to insert into the buffer. |
25829 | 4450 @end deffn |
4451 | |
59536 | 4452 @defopt reftex-cite-prompt-optional-args |
4453 Non-@code{nil} means, prompt for empty optional arguments in cite macros. | |
4454 When an entry in @code{reftex-cite-format} ist given with square brackets to | |
4455 indicate optional arguments (for example @samp{\\cite[][]@{%l@}}), RefTeX can | |
4456 prompt for values. Possible values are: | |
4457 @example | |
4458 nil @r{Never prompt for optional arguments} | |
4459 t @r{Always prompt} | |
4460 maybe @r{Prompt only if @code{reftex-citation} was called with C-u prefix arg}@end example | |
4461 Unnecessary empty optional arguments are removed before insertion into | |
4462 the buffer. See @code{reftex-cite-cleanup-optional-args}. | |
4463 @end defopt | |
4464 | |
4465 @defopt reftex-cite-cleanup-optional-args | |
4466 Non-@code{nil} means, remove empty optional arguments from cite macros | |
4467 if possible. | |
4468 @end defopt | |
4469 | |
25829 | 4470 @defopt reftex-comment-citations |
4471 Non-@code{nil} means add a comment for each citation describing the full | |
4472 entry. The comment is formatted according to | |
59536 | 4473 @code{reftex-cite-comment-format}. |
25829 | 4474 @end defopt |
4475 | |
4476 @defopt reftex-cite-comment-format | |
4477 Citation format used for commented citations. Must @emph{not} contain | |
4478 @samp{%l}. See the variable @code{reftex-cite-format} for possible | |
59536 | 4479 percent escapes. |
25829 | 4480 @end defopt |
4481 | |
4482 @defopt reftex-cite-punctuation | |
4483 Punctuation for formatting of name lists in citations. This is a list | |
59536 | 4484 of 3 strings. |
25829 | 4485 @enumerate |
4486 @item | |
4487 normal names separator, like @samp{, } in Jones, Brown and Miller | |
4488 @item | |
4489 final names separator, like @samp{ and } in Jones, Brown and Miller | |
4490 @item | |
59579
a588c86a429c
Revision: miles@gnu.org--gnu-2005/emacs--cvs-trunk--0--patch-40
Miles Bader <miles@gnu.org>
parents:
59548
diff
changeset
|
4491 The @samp{et al.} string, like @samp{ @{\it et al.@}} in |
25829 | 4492 Jones @{\it et al.@} |
4493 @end enumerate | |
4494 @end defopt | |
4495 | |
4496 @deffn {Normal Hook} reftex-select-bib-mode-hook | |
4497 Normal hook which is run when a selection buffer enters | |
59579
a588c86a429c
Revision: miles@gnu.org--gnu-2005/emacs--cvs-trunk--0--patch-40
Miles Bader <miles@gnu.org>
parents:
59548
diff
changeset
|
4498 @code{reftex-select-bib-mode}. |
25829 | 4499 @end deffn |
4500 | |
4501 @deffn Keymap reftex-select-bib-map | |
4502 The keymap which is active in the citation-key selection process | |
59536 | 4503 (@pxref{Creating Citations}). |
25829 | 4504 @end deffn |
4505 | |
4506 @node Options (Index Support), Options (Viewing Cross-References), Options (Creating Citations), Options | |
4507 @section Index Support | |
4508 @cindex Options, Index support | |
4509 @cindex Index support, options | |
4510 | |
4511 @defopt reftex-support-index | |
4512 Non-@code{nil} means, index entries are parsed as well. Index support | |
4513 is resource intensive and the internal structure holding the parsed | |
4514 information can become quite big. Therefore it can be turned off. When | |
4515 this is @code{nil} and you execute a command which requires index | |
4516 support, you will be asked for confirmation to turn it on and rescan the | |
59536 | 4517 document. |
25829 | 4518 @end defopt |
4519 | |
4520 @defopt reftex-index-special-chars | |
4521 List of special characters in index entries, given as strings. These | |
59579
a588c86a429c
Revision: miles@gnu.org--gnu-2005/emacs--cvs-trunk--0--patch-40
Miles Bader <miles@gnu.org>
parents:
59548
diff
changeset
|
4522 correspond to the @code{MakeIndex} keywords |
25829 | 4523 @code{(@var{level} @var{encap} @var{actual} @var{quote} @var{escape})}. |
4524 @end defopt | |
4525 | |
4526 @defopt reftex-index-macros | |
4527 List of macros which define index entries. The structure of each entry | |
4528 is | |
4529 @lisp | |
26911
d7f536a01276
Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents:
25829
diff
changeset
|
4530 (@var{macro} @var{index-tag} @var{key} @var{prefix} @var{exclude} @var{repeat}) |
25829 | 4531 @end lisp |
4532 | |
4533 @var{macro} is the macro. Arguments should be denoted by empty braces, | |
4534 as for example in @samp{\index[]@{*@}}. Use square brackets to denote | |
59536 | 4535 optional arguments. The star marks where the index key is. |
25829 | 4536 |
4537 @var{index-tag} is a short name of the index. @samp{idx} and @samp{glo} | |
4538 are reserved for the default index and the glossary. Other indices can | |
4539 be defined as well. If this is an integer, the Nth argument of the | |
59536 | 4540 macro holds the index tag. |
25829 | 4541 |
4542 @var{key} is a character which is used to identify the macro for input | |
4543 with @code{reftex-index}. @samp{?i}, @samp{?I}, and @samp{?g} are | |
59536 | 4544 reserved for default index and glossary. |
25829 | 4545 |
4546 @var{prefix} can be a prefix which is added to the @var{key} part of the | |
4547 index entry. If you have a macro | |
4548 @code{\newcommand@{\molec@}[1]@{#1\index@{Molecules!#1@}}, this prefix | |
59536 | 4549 should be @samp{Molecules!}. |
25829 | 4550 |
4551 @var{exclude} can be a function. If this function exists and returns a | |
59579
a588c86a429c
Revision: miles@gnu.org--gnu-2005/emacs--cvs-trunk--0--patch-40
Miles Bader <miles@gnu.org>
parents:
59548
diff
changeset
|
4552 non-@code{nil} value, the index entry at point is ignored. This was |
25829 | 4553 implemented to support the (deprecated) @samp{^} and @samp{_} shortcuts |
59536 | 4554 in the LaTeX2e @code{index} package. |
25829 | 4555 |
26911
d7f536a01276
Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents:
25829
diff
changeset
|
4556 @var{repeat}, if non-@code{nil}, means the index macro does not typeset |
d7f536a01276
Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents:
25829
diff
changeset
|
4557 the entry in the text, so that the text has to be repeated outside the |
d7f536a01276
Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents:
25829
diff
changeset
|
4558 index macro. Needed for @code{reftex-index-selection-or-word} and for |
59536 | 4559 indexing from the phrase buffer. |
26911
d7f536a01276
Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents:
25829
diff
changeset
|
4560 |
25829 | 4561 The final entry may also be a symbol. It must have an association in |
4562 the variable @code{reftex-index-macros-builtin} to specify the main | |
60927
bae786986f2e
* calc.texi, cl.texi, gnus.texi, idlwave.texi, reftex.texi: Replace
Werner LEMBERG <wl@gnu.org>
parents:
60919
diff
changeset
|
4563 indexing package you are using. Valid values are currently |
25829 | 4564 @example |
4565 default @r{The LaTeX default - unnecessary to specify this one} | |
4566 multind @r{The multind.sty package} | |
4567 index @r{The index.sty package} | |
4568 index-shortcut @r{The index.sty packages with the ^ and _ shortcuts.} | |
4569 @r{Should not be used - only for old documents} | |
4570 @end example | |
4571 Note that AUCTeX sets these things internally for @b{Ref@TeX{}} as well, | |
4572 so with a sufficiently new version of AUCTeX, you should not set the | |
4573 package here. | |
4574 @end defopt | |
4575 | |
4576 @defopt reftex-index-default-macro | |
4577 The default index macro for @code{reftex-index-selection-or-word}. | |
26911
d7f536a01276
Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents:
25829
diff
changeset
|
4578 This is a list with @code{(@var{macro-key} @var{default-tag})}. |
25829 | 4579 |
4580 @var{macro-key} is a character identifying an index macro - see | |
4581 @code{reftex-index-macros}. | |
4582 | |
4583 @var{default-tag} is the tag to be used if the macro requires a | |
4584 @var{tag} argument. When this is @code{nil} and a @var{tag} is needed, | |
4585 @b{Ref@TeX{}} will ask for it. When this is the empty string and the | |
4586 TAG argument of the index macro is optional, the TAG argument will be | |
59536 | 4587 omitted. |
25829 | 4588 @end defopt |
4589 | |
4590 @defopt reftex-index-default-tag | |
4591 Default index tag. When working with multiple indexes, RefTeX queries | |
4592 for an index tag when creating index entries or displaying a specific | |
4593 index. This variable controls the default offered for these queries. | |
4594 The default can be selected with @key{RET} during selection or | |
60927
bae786986f2e
* calc.texi, cl.texi, gnus.texi, idlwave.texi, reftex.texi: Replace
Werner LEMBERG <wl@gnu.org>
parents:
60919
diff
changeset
|
4595 completion. Valid values of this variable are: |
25829 | 4596 @example |
4597 nil @r{Do not provide a default index} | |
4598 "tag" @r{The default index tag given as a string, e.g. "idx"} | |
4599 last @r{The last used index tag will be offered as default} | |
4600 @end example | |
4601 @end defopt | |
4602 | |
4603 @defopt reftex-index-math-format | |
4604 Format of index entries when copied from inside math mode. When | |
4605 @code{reftex-index-selection-or-word} is executed inside TeX math mode, | |
4606 the index key copied from the buffer is processed with this format | |
4607 string through the @code{format} function. This can be used to add the | |
4608 math delimiters (e.g. @samp{$}) to the string. Requires the | |
59536 | 4609 @file{texmathp.el} library which is part of AUCTeX. |
25829 | 4610 @end defopt |
4611 | |
27195 | 4612 @defopt reftex-index-phrase-file-extension |
4613 File extension for the index phrase file. This extension will be added | |
4614 to the base name of the master file. | |
4615 @end defopt | |
4616 | |
26911
d7f536a01276
Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents:
25829
diff
changeset
|
4617 @defopt reftex-index-phrases-logical-and-regexp |
d7f536a01276
Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents:
25829
diff
changeset
|
4618 Regexp matching the @samp{and} operator for index arguments in phrases |
d7f536a01276
Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents:
25829
diff
changeset
|
4619 file. When several index arguments in a phrase line are separated by |
d7f536a01276
Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents:
25829
diff
changeset
|
4620 this operator, each part will generate an index macro. So each match of |
d7f536a01276
Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents:
25829
diff
changeset
|
4621 the search phrase will produce @emph{several} different index entries. |
d7f536a01276
Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents:
25829
diff
changeset
|
4622 Make sure this does no match things which are not separators. This |
d7f536a01276
Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents:
25829
diff
changeset
|
4623 logical @samp{and} has higher priority than the logical @samp{or} |
59536 | 4624 specified in @code{reftex-index-phrases-logical-or-regexp}. |
26911
d7f536a01276
Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents:
25829
diff
changeset
|
4625 @end defopt |
d7f536a01276
Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents:
25829
diff
changeset
|
4626 |
d7f536a01276
Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents:
25829
diff
changeset
|
4627 @defopt reftex-index-phrases-logical-or-regexp |
d7f536a01276
Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents:
25829
diff
changeset
|
4628 Regexp matching the @samp{or} operator for index arguments in phrases |
d7f536a01276
Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents:
25829
diff
changeset
|
4629 file. When several index arguments in a phrase line are separated by |
d7f536a01276
Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents:
25829
diff
changeset
|
4630 this operator, the user will be asked to select one of them at each |
d7f536a01276
Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents:
25829
diff
changeset
|
4631 match of the search phrase. The first index arg will be the default. A |
d7f536a01276
Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents:
25829
diff
changeset
|
4632 number key @kbd{1}--@kbd{9} must be pressed to switch to another. Make |
d7f536a01276
Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents:
25829
diff
changeset
|
4633 sure this does no match things which are not separators. The logical |
d7f536a01276
Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents:
25829
diff
changeset
|
4634 @samp{and} specified in @code{reftex-index-phrases-logical-or-regexp} |
59536 | 4635 has higher priority than this logical @samp{or}. |
26911
d7f536a01276
Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents:
25829
diff
changeset
|
4636 @end defopt |
d7f536a01276
Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents:
25829
diff
changeset
|
4637 |
d7f536a01276
Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents:
25829
diff
changeset
|
4638 @defopt reftex-index-phrases-search-whole-words |
d7f536a01276
Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents:
25829
diff
changeset
|
4639 Non-@code{nil} means phrases search will look for whole words, not subwords. |
d7f536a01276
Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents:
25829
diff
changeset
|
4640 This works by requiring word boundaries at the beginning and end of |
d7f536a01276
Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents:
25829
diff
changeset
|
4641 the search string. When the search phrase already has a non-word-char |
d7f536a01276
Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents:
25829
diff
changeset
|
4642 at one of these points, no word boundary is required there. |
d7f536a01276
Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents:
25829
diff
changeset
|
4643 @end defopt |
d7f536a01276
Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents:
25829
diff
changeset
|
4644 |
d7f536a01276
Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents:
25829
diff
changeset
|
4645 @defopt reftex-index-phrases-case-fold-search |
d7f536a01276
Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents:
25829
diff
changeset
|
4646 Non-@code{nil} means, searching for index phrases will ignore |
59536 | 4647 case. |
26911
d7f536a01276
Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents:
25829
diff
changeset
|
4648 @end defopt |
d7f536a01276
Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents:
25829
diff
changeset
|
4649 |
46684
9569bac241a3
Update to RefTeX 4.18
Carsten Dominik <dominik@science.uva.nl>
parents:
46272
diff
changeset
|
4650 @defopt reftex-index-verify-function |
9569bac241a3
Update to RefTeX 4.18
Carsten Dominik <dominik@science.uva.nl>
parents:
46272
diff
changeset
|
4651 A function which is called at each match during global indexing. |
63671
9fc49ac7fb44
(Options (Defining Label Environments), Options (Index Support), Options
Juanma Barranquero <lekktu@gmail.com>
parents:
62469
diff
changeset
|
4652 If the function returns @code{nil}, the current match is skipped. |
46684
9569bac241a3
Update to RefTeX 4.18
Carsten Dominik <dominik@science.uva.nl>
parents:
46272
diff
changeset
|
4653 @end defopt |
9569bac241a3
Update to RefTeX 4.18
Carsten Dominik <dominik@science.uva.nl>
parents:
46272
diff
changeset
|
4654 |
26911
d7f536a01276
Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents:
25829
diff
changeset
|
4655 @defopt reftex-index-phrases-skip-indexed-matches |
d7f536a01276
Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents:
25829
diff
changeset
|
4656 Non-@code{nil} means, skip matches which appear to be indexed already. |
d7f536a01276
Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents:
25829
diff
changeset
|
4657 When doing global indexing from the phrases buffer, searches for some |
d7f536a01276
Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents:
25829
diff
changeset
|
4658 phrases may match at places where that phrase was already indexed. In |
d7f536a01276
Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents:
25829
diff
changeset
|
4659 particular when indexing an already processed document again, this |
d7f536a01276
Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents:
25829
diff
changeset
|
4660 will even be the norm. When this variable is non-@code{nil}, |
d7f536a01276
Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents:
25829
diff
changeset
|
4661 @b{Ref@TeX{}} checks if the match is an index macro argument, or if an |
d7f536a01276
Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents:
25829
diff
changeset
|
4662 index macro is directly before or after the phrase. If that is the |
59536 | 4663 case, that match will be ignored. |
26911
d7f536a01276
Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents:
25829
diff
changeset
|
4664 @end defopt |
d7f536a01276
Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents:
25829
diff
changeset
|
4665 |
d7f536a01276
Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents:
25829
diff
changeset
|
4666 @defopt reftex-index-phrases-wrap-long-lines |
d7f536a01276
Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents:
25829
diff
changeset
|
4667 Non-@code{nil} means, when indexing from the phrases buffer, wrap lines. |
d7f536a01276
Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents:
25829
diff
changeset
|
4668 Inserting indexing commands in a line makes the line longer - often |
d7f536a01276
Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents:
25829
diff
changeset
|
4669 so long that it does not fit onto the screen. When this variable is |
d7f536a01276
Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents:
25829
diff
changeset
|
4670 non-@code{nil}, newlines will be added as necessary before and/or after the |
d7f536a01276
Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents:
25829
diff
changeset
|
4671 indexing command to keep lines short. However, the matched text |
59536 | 4672 phrase and its index command will always end up on a single line. |
26911
d7f536a01276
Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents:
25829
diff
changeset
|
4673 @end defopt |
d7f536a01276
Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents:
25829
diff
changeset
|
4674 |
d7f536a01276
Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents:
25829
diff
changeset
|
4675 @defopt reftex-index-phrases-sort-prefers-entry |
d7f536a01276
Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents:
25829
diff
changeset
|
4676 Non-@code{nil} means when sorting phrase lines, the explicit index entry |
d7f536a01276
Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents:
25829
diff
changeset
|
4677 is used. Phrase lines in the phrases buffer contain a search phrase, and |
d7f536a01276
Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents:
25829
diff
changeset
|
4678 sorting is normally based on these. Some phrase lines also have |
d7f536a01276
Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents:
25829
diff
changeset
|
4679 an explicit index argument specified. When this variable is |
59536 | 4680 non-@code{nil}, the index argument will be used for sorting. |
26911
d7f536a01276
Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents:
25829
diff
changeset
|
4681 @end defopt |
d7f536a01276
Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents:
25829
diff
changeset
|
4682 |
d7f536a01276
Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents:
25829
diff
changeset
|
4683 @defopt reftex-index-phrases-sort-in-blocks |
d7f536a01276
Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents:
25829
diff
changeset
|
4684 Non-@code{nil} means, empty and comment lines separate phrase buffer |
d7f536a01276
Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents:
25829
diff
changeset
|
4685 into blocks. Sorting will then preserve blocks, so that lines are |
d7f536a01276
Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents:
25829
diff
changeset
|
4686 re-arranged only within blocks. |
d7f536a01276
Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents:
25829
diff
changeset
|
4687 @end defopt |
d7f536a01276
Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents:
25829
diff
changeset
|
4688 |
d7f536a01276
Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents:
25829
diff
changeset
|
4689 @defopt reftex-index-phrases-map |
d7f536a01276
Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents:
25829
diff
changeset
|
4690 Keymap for the Index Phrases buffer. |
d7f536a01276
Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents:
25829
diff
changeset
|
4691 @end defopt |
d7f536a01276
Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents:
25829
diff
changeset
|
4692 |
d7f536a01276
Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents:
25829
diff
changeset
|
4693 @defopt reftex-index-phrases-mode-hook |
d7f536a01276
Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents:
25829
diff
changeset
|
4694 Normal hook which is run when a buffer is put into |
59536 | 4695 @code{reftex-index-phrases-mode}. |
26911
d7f536a01276
Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents:
25829
diff
changeset
|
4696 @end defopt |
d7f536a01276
Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents:
25829
diff
changeset
|
4697 |
25829 | 4698 @defopt reftex-index-section-letters |
4699 The letters which denote sections in the index. Usually these are all | |
4700 capital letters. Don't use any downcase letters. Order is not | |
4701 significant, the index will be sorted by whatever the sort function | |
26911
d7f536a01276
Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents:
25829
diff
changeset
|
4702 thinks is correct. In addition to these letters, @b{Ref@TeX{}} will |
d7f536a01276
Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents:
25829
diff
changeset
|
4703 create a group @samp{!} which contains all entries sorted below the |
d7f536a01276
Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents:
25829
diff
changeset
|
4704 lowest specified letter. In the @file{*Index*} buffer, pressing any of |
59536 | 4705 these capital letters or @kbd{!} will jump to that section. |
25829 | 4706 @end defopt |
4707 | |
4708 @defopt reftex-index-include-context | |
4709 Non-@code{nil} means, display the index definition context in the | |
4710 @file{*Index*} buffer. This flag may also be toggled from the | |
4711 @file{*Index*} buffer with the @kbd{c} key. | |
4712 @end defopt | |
4713 | |
4714 @defopt reftex-index-follow-mode | |
4715 Non-@code{nil} means, point in @file{*Index*} buffer will cause other | |
4716 window to follow. The other window will show the corresponding part of | |
4717 the document. This flag can be toggled from within the @file{*Index*} | |
4718 buffer with the @kbd{f} key. | |
4719 @end defopt | |
4720 | |
4721 @deffn Keymap reftex-index-map | |
4722 The keymap which is active in the @file{*Index*} buffer | |
59536 | 4723 (@pxref{Index Support}). |
25829 | 4724 @end deffn |
4725 | |
4726 @node Options (Viewing Cross-References), Options (Finding Files), Options (Index Support), Options | |
4727 @section Viewing Cross-References | |
4728 @cindex Options, viewing cross-references | |
4729 @cindex Viewing cross-references, options | |
4730 | |
4731 @defopt reftex-view-crossref-extra | |
4732 Macros which can be used for the display of cross references. | |
4733 This is used when `reftex-view-crossref' is called with point in an | |
4734 argument of a macro. Note that crossref viewing for citations, | |
4735 references (both ways) and index entries is hard-coded. This variable | |
4736 is only to configure additional structures for which crossreference | |
59579
a588c86a429c
Revision: miles@gnu.org--gnu-2005/emacs--cvs-trunk--0--patch-40
Miles Bader <miles@gnu.org>
parents:
59548
diff
changeset
|
4737 viewing can be useful. Each entry has the structure |
25829 | 4738 @example |
4739 (@var{macro-re} @var{search-re} @var{highlight}). | |
4740 @end example | |
4741 @var{macro-re} is matched against the macro. @var{search-re} is the | |
4742 regexp used to search for cross references. @samp{%s} in this regexp is | |
46684
9569bac241a3
Update to RefTeX 4.18
Carsten Dominik <dominik@science.uva.nl>
parents:
46272
diff
changeset
|
4743 replaced with the macro argument at point. @var{highlight} is an |
25829 | 4744 integer indicating which subgroup of the match should be highlighted. |
4745 @end defopt | |
4746 | |
4747 @defopt reftex-auto-view-crossref | |
4748 Non-@code{nil} means, initially turn automatic viewing of crossref info | |
4749 on. Automatic viewing of crossref info normally uses the echo area. | |
47050
904fd28be439
Update to RefTeX 4.19
Carsten Dominik <dominik@science.uva.nl>
parents:
46918
diff
changeset
|
4750 Whenever point is idle for more than @code{reftex-idle-time} seconds on |
904fd28be439
Update to RefTeX 4.19
Carsten Dominik <dominik@science.uva.nl>
parents:
46918
diff
changeset
|
4751 the argument of a @code{\ref} or @code{\cite} macro, and no other |
904fd28be439
Update to RefTeX 4.19
Carsten Dominik <dominik@science.uva.nl>
parents:
46918
diff
changeset
|
4752 message is being displayed, the echo area will display information about |
904fd28be439
Update to RefTeX 4.19
Carsten Dominik <dominik@science.uva.nl>
parents:
46918
diff
changeset
|
4753 that cross reference. You can also set the variable to the symbol |
904fd28be439
Update to RefTeX 4.19
Carsten Dominik <dominik@science.uva.nl>
parents:
46918
diff
changeset
|
4754 @code{window}. In this case a small temporary window is used for the |
904fd28be439
Update to RefTeX 4.19
Carsten Dominik <dominik@science.uva.nl>
parents:
46918
diff
changeset
|
4755 display. This feature can be turned on and off from the menu |
59536 | 4756 (Ref->Options). |
25829 | 4757 @end defopt |
4758 | |
4759 @defopt reftex-idle-time | |
59579
a588c86a429c
Revision: miles@gnu.org--gnu-2005/emacs--cvs-trunk--0--patch-40
Miles Bader <miles@gnu.org>
parents:
59548
diff
changeset
|
4760 Time (secs) Emacs has to be idle before automatic crossref display |
59536 | 4761 or toc recentering is done. |
25829 | 4762 @end defopt |
4763 | |
4764 @defopt reftex-cite-view-format | |
4765 Citation format used to display citation info in the message area. See | |
4766 the variable @code{reftex-cite-format} for possible percent | |
59536 | 4767 escapes. |
25829 | 4768 @end defopt |
4769 | |
4770 @defopt reftex-revisit-to-echo | |
4771 Non-@code{nil} means, automatic citation display will revisit files if | |
63671
9fc49ac7fb44
(Options (Defining Label Environments), Options (Index Support), Options
Juanma Barranquero <lekktu@gmail.com>
parents:
62469
diff
changeset
|
4772 necessary. When @code{nil}, citation display in echo area will only |
9fc49ac7fb44
(Options (Defining Label Environments), Options (Index Support), Options
Juanma Barranquero <lekktu@gmail.com>
parents:
62469
diff
changeset
|
4773 be active for cached echo strings (see @code{reftex-cache-cite-echo}), |
9fc49ac7fb44
(Options (Defining Label Environments), Options (Index Support), Options
Juanma Barranquero <lekktu@gmail.com>
parents:
62469
diff
changeset
|
4774 or for BibTeX database files which are already visited by a live |
9fc49ac7fb44
(Options (Defining Label Environments), Options (Index Support), Options
Juanma Barranquero <lekktu@gmail.com>
parents:
62469
diff
changeset
|
4775 associated buffers. |
25829 | 4776 @end defopt |
4777 | |
4778 @defopt reftex-cache-cite-echo | |
4779 Non-@code{nil} means, the information displayed in the echo area for | |
4780 cite macros (see variable @code{reftex-auto-view-crossref}) is cached and | |
4781 saved along with the parsing information. The cache survives document | |
4782 scans. In order to clear it, use @kbd{M-x reftex-reset-mode}. | |
4783 @end defopt | |
4784 | |
4785 @node Options (Finding Files), Options (Optimizations), Options (Viewing Cross-References), Options | |
4786 @section Finding Files | |
4787 @cindex Options, Finding Files | |
4788 @cindex Finding files, options | |
4789 | |
4790 @defopt reftex-texpath-environment-variables | |
4791 List of specifications how to retrieve the search path for TeX files. | |
59536 | 4792 Several entries are possible. |
25829 | 4793 @itemize @minus |
4794 @item | |
4795 If an element is the name of an environment variable, its content is | |
59536 | 4796 used. |
25829 | 4797 @item |
4798 If an element starts with an exclamation mark, it is used as a command | |
4799 to retrieve the path. A typical command with the kpathsearch library | |
4800 would be @w{@code{"!kpsewhich -show-path=.tex"}}. | |
4801 @item | |
4802 Otherwise the element itself is interpreted as a path. | |
4803 @end itemize | |
4804 Multiple directories can be separated by the system dependent | |
4805 @code{path-separator}. Directories ending in @samp{//} or @samp{!!} will | |
4806 be expanded recursively. See also @code{reftex-use-external-file-finders}. | |
4807 @end defopt | |
4808 | |
4809 @defopt reftex-bibpath-environment-variables | |
4810 List of specifications how to retrieve the search path for BibTeX | |
59536 | 4811 files. Several entries are possible. |
25829 | 4812 @itemize @minus |
4813 @item | |
4814 If an element is the name of an environment variable, its content is | |
59536 | 4815 used. |
25829 | 4816 @item |
4817 If an element starts with an exclamation mark, it is used as a command | |
4818 to retrieve the path. A typical command with the kpathsearch library | |
4819 would be @w{@code{"!kpsewhich -show-path=.bib"}}. | |
4820 @item | |
4821 Otherwise the element itself is interpreted as a path. | |
4822 @end itemize | |
4823 Multiple directories can be separated by the system dependent | |
4824 @code{path-separator}. Directories ending in @samp{//} or @samp{!!} will | |
4825 be expanded recursively. See also @code{reftex-use-external-file-finders}. | |
4826 @end defopt | |
4827 | |
4828 @defopt reftex-file-extensions | |
4829 Association list with file extensions for different file types. | |
59579
a588c86a429c
Revision: miles@gnu.org--gnu-2005/emacs--cvs-trunk--0--patch-40
Miles Bader <miles@gnu.org>
parents:
59548
diff
changeset
|
4830 This is a list of items, each item is like: |
25829 | 4831 @code{(@var{type} . (@var{def-ext} @var{other-ext} ...))} |
4832 @example | |
4833 @var{type}: @r{File type like @code{"bib"} or @code{"tex"}.} | |
4834 @var{def-ext}: @r{The default extension for that file type, like @code{".tex"} or @code{".bib"}.} | |
60927
bae786986f2e
* calc.texi, cl.texi, gnus.texi, idlwave.texi, reftex.texi: Replace
Werner LEMBERG <wl@gnu.org>
parents:
60919
diff
changeset
|
4835 @var{other-ext}: @r{Any number of other valid extensions for this file type.} |
25829 | 4836 @end example |
60927
bae786986f2e
* calc.texi, cl.texi, gnus.texi, idlwave.texi, reftex.texi: Replace
Werner LEMBERG <wl@gnu.org>
parents:
60919
diff
changeset
|
4837 When a files is searched and it does not have any of the valid extensions, |
59536 | 4838 we try the default extension first, and then the naked file name. |
25829 | 4839 @end defopt |
4840 | |
4841 @defopt reftex-search-unrecursed-path-first | |
4842 Non-@code{nil} means, search all specified directories before trying | |
4843 recursion. Thus, in a path @samp{.//:/tex/}, search first @samp{./}, | |
4844 then @samp{/tex/}, and then all subdirectories of @samp{./}. If this | |
4845 option is @code{nil}, the subdirectories of @samp{./} are searched | |
4846 before @samp{/tex/}. This is mainly for speed - most of the time the | |
4847 recursive path is for the system files and not for the user files. Set | |
4848 this to @code{nil} if the default makes @b{Ref@TeX{}} finding files with | |
59536 | 4849 equal names in wrong sequence. |
25829 | 4850 @end defopt |
4851 | |
4852 @defopt reftex-use-external-file-finders | |
4853 Non-@code{nil} means, use external programs to find files. Normally, | |
4854 @b{Ref@TeX{}} searches the paths given in the environment variables | |
4855 @code{TEXINPUTS} and @code{BIBINPUTS} to find TeX files and BibTeX | |
4856 database files. With this option turned on, it calls an external | |
4857 program specified in the option @code{reftex-external-file-finders} | |
4858 instead. As a side effect, the variables | |
4859 @code{reftex-texpath-environment-variables} and | |
4860 @code{reftex-bibpath-environment-variables} will be ignored. | |
4861 @end defopt | |
4862 | |
4863 @defopt reftex-external-file-finders | |
4864 Association list with external programs to call for finding files. Each | |
4865 entry is a cons cell @w{@code{(@var{type} . @var{program})}}. | |
4866 @var{type} is either @code{"tex"} or @code{"bib"}. @var{program} is a | |
4867 string containing the external program to use with any arguments. | |
4868 @code{%f} will be replaced by the name of the file to be found. Note | |
4869 that these commands will be executed directly, not via a shell. Only | |
4870 relevant when @code{reftex-use-external-file-finders} is | |
59536 | 4871 non-@code{nil}. |
25829 | 4872 @end defopt |
4873 | |
4874 @page | |
4875 @node Options (Optimizations), Options (Fontification), Options (Finding Files), Options | |
4876 @section Optimizations | |
4877 @cindex Options, optimizations | |
4878 @cindex Optimizations, options | |
4879 | |
4880 @defopt reftex-keep-temporary-buffers | |
4881 Non-@code{nil} means, keep buffers created for parsing and lookup. | |
4882 @b{Ref@TeX{}} sometimes needs to visit files related to the current | |
59536 | 4883 document. We distinguish files visited for |
25829 | 4884 @table @asis |
4885 @item PARSING | |
4886 Parts of a multifile document loaded when (re)-parsing the | |
59536 | 4887 document. |
25829 | 4888 @item LOOKUP |
4889 BibTeX database files and TeX files loaded to find a reference, to | |
59536 | 4890 display label context, etc. |
25829 | 4891 @end table |
4892 The created buffers can be kept for later use, or be thrown away | |
59536 | 4893 immediately after use, depending on the value of this variable: |
25829 | 4894 |
4895 @table @code | |
4896 @item nil | |
4897 Throw away as much as possible. | |
4898 @item t | |
4899 Keep everything. | |
4900 @item 1 | |
4901 Throw away buffers created for parsing, but keep the ones created for | |
59536 | 4902 lookup. |
25829 | 4903 @end table |
4904 | |
4905 If a buffer is to be kept, the file is visited normally (which is | |
4906 potentially slow but will happen only once). If a buffer is to be thrown | |
4907 away, the initialization of the buffer depends upon the variable | |
59536 | 4908 @code{reftex-initialize-temporary-buffers}. |
25829 | 4909 @end defopt |
4910 | |
4911 @defopt reftex-initialize-temporary-buffers | |
4912 Non-@code{nil} means do initializations even when visiting file | |
4913 temporarily. When @code{nil}, @b{Ref@TeX{}} may turn off find-file hooks and | |
4914 other stuff to briefly visit a file. When @code{t}, the full default | |
4915 initializations are done (@code{find-file-hook} etc.). Instead of | |
4916 @code{t} or @code{nil}, this variable may also be a list of hook | |
59536 | 4917 functions to do a minimal initialization. |
25829 | 4918 @end defopt |
4919 | |
4920 @defopt reftex-no-include-regexps | |
4921 List of regular expressions to exclude certain input files from parsing. | |
4922 If the name of a file included via @code{\include} or @code{\input} is | |
4923 matched by any of the regular expressions in this list, that file is not | |
4924 parsed by @b{Ref@TeX{}}. | |
4925 @end defopt | |
4926 | |
4927 @defopt reftex-enable-partial-scans | |
4928 Non-@code{nil} means, re-parse only 1 file when asked to re-parse. | |
4929 Re-parsing is normally requested with a @kbd{C-u} prefix to many @b{Ref@TeX{}} | |
4930 commands, or with the @kbd{r} key in menus. When this option is | |
4931 @code{t} in a multifile document, we will only parse the current buffer, | |
4932 or the file associated with the label or section heading near point in a | |
4933 menu. Requesting re-parsing of an entire multifile document then | |
4934 requires a @kbd{C-u C-u} prefix or the capital @kbd{R} key in | |
59536 | 4935 menus. |
25829 | 4936 @end defopt |
4937 | |
4938 @defopt reftex-save-parse-info | |
4939 Non-@code{nil} means, save information gathered with parsing in files. | |
4940 The file @file{MASTER.rel} in the same directory as @file{MASTER.tex} is | |
4941 used to save the information. When this variable is @code{t}, | |
4942 @itemize @minus | |
4943 @item | |
4944 accessing the parsing information for the first time in an editing | |
4945 session will read that file (if available) instead of parsing the | |
59536 | 4946 document. |
25829 | 4947 @item |
4948 exiting Emacs or killing a buffer in reftex-mode will cause a new | |
59536 | 4949 version of the file to be written. |
25829 | 4950 @end itemize |
4951 @end defopt | |
4952 | |
27195 | 4953 @defopt reftex-parse-file-extension |
4954 File extension for the file in which parser information is stored. | |
4955 This extension is added to the base name of the master file. | |
4956 @end defopt | |
4957 | |
25829 | 4958 @defopt reftex-allow-automatic-rescan |
4959 Non-@code{nil} means, @b{Ref@TeX{}} may rescan the document when this seems | |
4960 necessary. Applies (currently) only in rare cases, when a new label | |
4961 cannot be placed with certainty into the internal label list. | |
4962 @end defopt | |
4963 | |
4964 @defopt reftex-use-multiple-selection-buffers | |
4965 Non-@code{nil} means use a separate selection buffer for each label | |
4966 type. These buffers are kept from one selection to the next and need | |
4967 not to be created for each use - so the menu generally comes up faster. | |
4968 The selection buffers will be erased (and therefore updated) | |
4969 automatically when new labels in its category are added. See the | |
59536 | 4970 variable @code{reftex-auto-update-selection-buffers}. |
25829 | 4971 @end defopt |
4972 | |
4973 @defopt reftex-auto-update-selection-buffers | |
4974 Non-@code{nil} means, selection buffers will be updated automatically. | |
4975 When a new label is defined with @code{reftex-label}, all selection | |
4976 buffers associated with that label category are emptied, in order to | |
4977 force an update upon next use. When @code{nil}, the buffers are left | |
4978 alone and have to be updated by hand, with the @kbd{g} key from the | |
4979 label selection process. The value of this variable will only have any | |
4980 effect when @code{reftex-use-multiple-selection-buffers} is | |
59536 | 4981 non-@code{nil}. |
25829 | 4982 @end defopt |
4983 | |
4984 @node Options (Fontification), Options (Misc), Options (Optimizations), Options | |
4985 @section Fontification | |
4986 @cindex Options, fontification | |
4987 @cindex Fontification, options | |
4988 | |
4989 @defopt reftex-use-fonts | |
4990 Non-@code{nil} means, use fonts in label menu and on-the-fly help. | |
4991 Font-lock must be loaded as well to actually get fontified | |
4992 display. After changing this option, a rescan may be necessary to | |
59536 | 4993 activate it. |
25829 | 4994 @end defopt |
4995 | |
4996 @defopt reftex-refontify-context | |
4997 Non-@code{nil} means, re-fontify the context in the label menu with | |
4998 font-lock. This slightly slows down the creation of the label menu. It | |
59536 | 4999 is only necessary when you definitely want the context fontified. |
25829 | 5000 |
5001 This option may have 3 different values: | |
5002 @table @code | |
5003 @item nil | |
5004 Never refontify. | |
5005 @item t | |
5006 Always refontify. | |
5007 @item 1 | |
5008 Refontify when necessary, e.g. with old versions of the x-symbol | |
59536 | 5009 package. |
25829 | 5010 @end table |
59536 | 5011 The option is ignored when @code{reftex-use-fonts} is @code{nil}. |
25829 | 5012 @end defopt |
5013 | |
5014 @defopt reftex-highlight-selection | |
5015 Non-@code{nil} means, highlight selected text in selection and | |
5016 @file{*toc*} buffers. Normally, the text near the cursor is the | |
5017 @emph{selected} text, and it is highlighted. This is the entry most | |
5018 keys in the selection and @file{*toc*} buffers act on. However, if you | |
5019 mainly use the mouse to select an item, you may find it nice to have | |
5020 mouse-triggered highlighting @emph{instead} or @emph{as well}. The | |
59536 | 5021 variable may have one of these values: |
25829 | 5022 |
5023 @example | |
5024 nil @r{No highlighting.} | |
5025 cursor @r{Highlighting is cursor driven.} | |
5026 mouse @r{Highlighting is mouse driven.} | |
5027 both @r{Both cursor and mouse trigger highlighting.} | |
5028 @end example | |
5029 | |
5030 Changing this variable requires to rebuild the selection and *toc* | |
59536 | 5031 buffers to become effective (keys @kbd{g} or @kbd{r}). |
25829 | 5032 @end defopt |
5033 | |
5034 @defopt reftex-cursor-selected-face | |
5035 Face name to highlight cursor selected item in toc and selection buffers. | |
59536 | 5036 See also the variable @code{reftex-highlight-selection}. |
25829 | 5037 @end defopt |
5038 @defopt reftex-mouse-selected-face | |
5039 Face name to highlight mouse selected item in toc and selection buffers. | |
59536 | 5040 See also the variable @code{reftex-highlight-selection}. |
25829 | 5041 @end defopt |
5042 @defopt reftex-file-boundary-face | |
5043 Face name for file boundaries in selection buffer. | |
5044 @end defopt | |
5045 @defopt reftex-label-face | |
5046 Face name for labels in selection buffer. | |
5047 @end defopt | |
5048 @defopt reftex-section-heading-face | |
5049 Face name for section headings in toc and selection buffers. | |
5050 @end defopt | |
5051 @defopt reftex-toc-header-face | |
5052 Face name for the header of a toc buffer. | |
5053 @end defopt | |
5054 @defopt reftex-bib-author-face | |
5055 Face name for author names in bib selection buffer. | |
5056 @end defopt | |
5057 @defopt reftex-bib-year-face | |
5058 Face name for year in bib selection buffer. | |
5059 @end defopt | |
5060 @defopt reftex-bib-title-face | |
5061 Face name for article title in bib selection buffer. | |
5062 @end defopt | |
5063 @defopt reftex-bib-extra-face | |
5064 Face name for bibliographic information in bib selection buffer. | |
5065 @end defopt | |
5066 @defopt reftex-select-mark-face | |
5067 Face name for marked entries in the selection buffers. | |
5068 @end defopt | |
5069 @defopt reftex-index-header-face | |
5070 Face name for the header of an index buffer. | |
5071 @end defopt | |
5072 @defopt reftex-index-section-face | |
5073 Face name for the start of a new letter section in the index. | |
5074 @end defopt | |
5075 @defopt reftex-index-tag-face | |
5076 Face name for index names (for multiple indices). | |
5077 @end defopt | |
5078 @defopt reftex-index-face | |
5079 Face name for index entries. | |
5080 @end defopt | |
5081 | |
5082 @node Options (Misc), , Options (Fontification), Options | |
5083 @section Miscellaneous | |
5084 @cindex Options, misc | |
5085 | |
5086 @defopt reftex-extra-bindings | |
5087 Non-@code{nil} means, make additional key bindings on startup. These | |
5088 extra bindings are located in the users @samp{C-c letter} | |
59536 | 5089 map. @xref{Key Bindings}. |
25829 | 5090 @end defopt |
5091 | |
5092 @defopt reftex-plug-into-AUCTeX | |
5093 Plug-in flags for AUCTeX interface. This variable is a list of | |
5094 5 boolean flags. When a flag is non-@code{nil}, @b{Ref@TeX{}} | |
59536 | 5095 will |
25829 | 5096 |
5097 @example | |
5098 - supply labels in new sections and environments (flag 1) | |
5099 - supply arguments for macros like @code{\label} (flag 2) | |
5100 - supply arguments for macros like @code{\ref} (flag 3) | |
5101 - supply arguments for macros like @code{\cite} (flag 4) | |
5102 - supply arguments for macros like @code{\index} (flag 5) | |
5103 @end example | |
5104 | |
5105 You may also set the variable itself to t or nil in order to turn all | |
5106 options on or off, respectively.@* | |
5107 Supplying labels in new sections and environments applies when creating | |
5108 sections with @kbd{C-c C-s} and environments with @kbd{C-c C-e}.@* | |
5109 Supplying macro arguments applies when you insert such a macro | |
5110 interactively with @kbd{C-c @key{RET}}.@* | |
5111 See the AUCTeX documentation for more information. | |
5112 @end defopt | |
5113 | |
5114 @defopt reftex-revisit-to-follow | |
5115 Non-@code{nil} means, follow-mode will revisit files if necessary. | |
63671
9fc49ac7fb44
(Options (Defining Label Environments), Options (Index Support), Options
Juanma Barranquero <lekktu@gmail.com>
parents:
62469
diff
changeset
|
5116 When @code{nil}, follow-mode will be suspended for stuff in unvisited files. |
25829 | 5117 @end defopt |
5118 | |
5119 @defopt reftex-allow-detached-macro-args | |
5120 Non-@code{nil} means, allow arguments of macros to be detached by | |
5121 whitespace. When this is @code{t}, the @samp{aaa} in @w{@samp{\bbb | |
5122 [xxx] @{aaa@}}} will be considered an argument of @code{\bb}. Note that | |
5123 this will be the case even if @code{\bb} is defined with zero or one | |
59536 | 5124 argument. |
25829 | 5125 @end defopt |
5126 | |
5127 @node Keymaps and Hooks, Changes, Options, Top | |
5128 @section Keymaps and Hooks | |
5129 @cindex Keymaps | |
5130 | |
5131 @b{Ref@TeX{}} has the usual general keymap and load-- and mode-hook. | |
5132 | |
5133 @deffn Keymap reftex-mode-map | |
5134 The keymap for @b{Ref@TeX{}} mode. | |
5135 @end deffn | |
5136 | |
5137 @deffn {Normal Hook} reftex-load-hook | |
5138 Normal hook which is being run when loading @file{reftex.el}. | |
5139 @end deffn | |
5140 | |
5141 @deffn {Normal Hook} reftex-mode-hook | |
59536 | 5142 Normal hook which is being run when turning on @b{Ref@TeX{}} mode. |
25829 | 5143 @end deffn |
5144 | |
26911
d7f536a01276
Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents:
25829
diff
changeset
|
5145 Furthermore, the 4 modes used for referencing labels, creating |
d7f536a01276
Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents:
25829
diff
changeset
|
5146 citations, the table of contents buffer and the phrases buffer have |
d7f536a01276
Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents:
25829
diff
changeset
|
5147 their own keymaps and mode hooks. See the respective sections. There |
d7f536a01276
Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents:
25829
diff
changeset
|
5148 are many more hooks which are described in the relevant sections about |
59536 | 5149 options for a specific part of @b{Ref@TeX{}}. |
25829 | 5150 |
5151 @node Changes, , Keymaps and Hooks, Top | |
5152 @chapter Changes | |
5153 @cindex Changes | |
5154 | |
5155 Here is a list of recent changes to @b{Ref@TeX{}}. | |
5156 | |
62469 | 5157 @noindent @b{Version 4.28} |
5158 @itemize @bullet | |
5159 @item Support for the Jurabib package. | |
5160 @item Improvements when selecting several items in a selection buffer. | |
5161 @end itemize | |
5162 | |
59536 | 5163 @noindent @b{Version 4.26} |
25829 | 5164 @itemize @bullet |
5165 @item | |
62469 | 5166 Support for global incremental search. |
5167 @item | |
5168 Some improvements for XEmacs compatibility. | |
25829 | 5169 @end itemize |
5170 | |
59536 | 5171 @noindent @b{Version 4.25} |
25829 | 5172 @itemize @bullet |
5173 @item | |
59536 | 5174 Fixed bug with @samp{%F} in a label prefix. Added new escapes |
5175 @samp{%m} and @samp{%M} for mater file name and master directory. | |
25829 | 5176 @end itemize |
5177 | |
59536 | 5178 @noindent @b{Version 4.24} |
25829 | 5179 @itemize @bullet |
63671
9fc49ac7fb44
(Options (Defining Label Environments), Options (Index Support), Options
Juanma Barranquero <lekktu@gmail.com>
parents:
62469
diff
changeset
|
5180 @item |
59536 | 5181 Inserting citation commands now prompts for optional arguments |
5182 when called with a prefix argument. Related new options are | |
5183 @code{reftex-cite-prompt-optional-args} and | |
63671
9fc49ac7fb44
(Options (Defining Label Environments), Options (Index Support), Options
Juanma Barranquero <lekktu@gmail.com>
parents:
62469
diff
changeset
|
5184 @code{reftex-cite-cleanup-optional-args}. |
59536 | 5185 @item |
5186 New option @code{reftex-trust-label-prefix}. Configure this variable | |
5187 if you'd like RefTeX to base its classification of labels on prefixes. | |
5188 This can speed-up document parsing, but may in some cases reduce the | |
5189 quality of the context used by RefTeX to describe a label. | |
5190 @item | |
5191 Fixed bug in @code{reftex-create-bibtex-file} when @code{reftex-comment-citations} | |
63671
9fc49ac7fb44
(Options (Defining Label Environments), Options (Index Support), Options
Juanma Barranquero <lekktu@gmail.com>
parents:
62469
diff
changeset
|
5192 is non-@code{nil}. |
59536 | 5193 @item |
5194 Fixed bugs in indexing: Case-sensitive search, quotes before and/or | |
5195 after words. Disabbled indexing in comment lines. | |
25829 | 5196 @end itemize |
5197 | |
59536 | 5198 @noindent @b{Version 4.22} |
25829 | 5199 @itemize @bullet |
63671
9fc49ac7fb44
(Options (Defining Label Environments), Options (Index Support), Options
Juanma Barranquero <lekktu@gmail.com>
parents:
62469
diff
changeset
|
5200 @item |
59536 | 5201 New command @code{reftex-create-bibtex-file} to create a new database |
5202 with all entries referenced in the current document. | |
5203 @item | |
5204 New keys @kbd{e} and @kbd{E} allow to produce a BibTeX database file | |
5205 from entries marked in a citation selection buffer. | |
5206 @end itemize | |
5207 | |
5208 @noindent @b{Version 4.21} | |
5209 @itemize @bullet | |
63671
9fc49ac7fb44
(Options (Defining Label Environments), Options (Index Support), Options
Juanma Barranquero <lekktu@gmail.com>
parents:
62469
diff
changeset
|
5210 @item |
59536 | 5211 Renaming labels from the toc buffer with key @kbd{M-%}. |
25829 | 5212 @end itemize |
5213 | |
59536 | 5214 @noindent @b{Version 4.20} |
25829 | 5215 @itemize @bullet |
5216 @item | |
59536 | 5217 Structure editing capabilities. The command keys @kbd{<} and @kbd{>} in |
5218 the TOC buffer promote/demote the section at point or all sections in | |
5219 the current region. | |
5220 @item | |
5221 New option @code{reftex-toc-split-windows-fraction} to set the size of | |
5222 the window used by the TOC. This makes the old variable | |
5223 @code{reftex-toc-split-windows-horizontally-fraction} obsolete. | |
5224 @item | |
5225 A dedicated frame can show the TOC with the current section | |
5226 always automatically highlighted. The frame is created and | |
5227 deleted from the toc buffer with the @kbd{d} key. | |
25829 | 5228 @end itemize |
5229 | |
59536 | 5230 @noindent @b{Version 4.19} |
25829 | 5231 @itemize @bullet |
5232 @item | |
59536 | 5233 New command `reftex-toc-recenter' (@kbd{C-c -}) which shows the current |
5234 section in the TOC buffer without selecting the TOC window. | |
5235 @item | |
5236 Recentering happens automatically in idle time when the option | |
5237 @code{reftex-auto-recenter-toc} is turned on. | |
5238 @item | |
5239 Fixed several bugs related to automatic cursor positioning in the TOC | |
5240 buffer. | |
5241 @item | |
5242 The highlight in the TOC buffer stays when the focus moves to a | |
5243 different window. | |
5244 @item | |
5245 New command `reftex-goto-label'. | |
5246 @item | |
5247 Part numbers are no longer included in chapter numbers, and a new | |
5248 part does not reset the chapter counter. See new option | |
5249 @code{reftex-part-resets-chapter}. | |
5250 @end itemize | |
5251 | |
5252 @noindent @b{Version 4.18} | |
5253 @itemize @bullet | |
5254 @item | |
5255 @code{reftex-citation} uses the word before the cursor as a default | |
5256 search string. | |
5257 @item | |
5258 Simplified several regular expressions for speed. | |
5259 @item | |
5260 Better support for chapterbib. | |
25829 | 5261 @end itemize |
5262 | |
59536 | 5263 @noindent @b{Version 4.17} |
25829 | 5264 @itemize @bullet |
59579
a588c86a429c
Revision: miles@gnu.org--gnu-2005/emacs--cvs-trunk--0--patch-40
Miles Bader <miles@gnu.org>
parents:
59548
diff
changeset
|
5265 @item |
59536 | 5266 The toc window can be split off horizontally. See new options |
5267 @code{reftex-toc-split-windows-horizontally}, | |
5268 @code{reftex-toc-split-windows-horizontally-fraction}. | |
5269 @item | |
5270 It is possible to specify a function which verifies an index match | |
5271 during global indexing. See new option @code{reftex-index-verify-function}. | |
5272 @item | |
5273 The macros which input a file in LaTeX (like \input, \include) can | |
5274 be configured. See new option @code{reftex-include-file-commands}. | |
5275 @item | |
5276 The macros which specify the bibliography file (like \bibliography) can | |
5277 be configured. See new option @code{reftex-bibliography-commands}. | |
5278 @item | |
5279 The regular expression used to search for the \bibliography macro has | |
5280 been relaxed to allow for @samp{@{\bibliography@{...@}@}} needed by | |
5281 chapterbib. | |
5282 @item | |
5283 Small bug fixes. | |
25829 | 5284 @end itemize |
5285 | |
59536 | 5286 @noindent @b{Version 4.15} |
25829 | 5287 @itemize @bullet |
5288 @item | |
59536 | 5289 Fixed bug with parsing of BibTeX files, when fields contain quotes or |
5290 unmatched parenthesis. | |
5291 @item | |
5292 Small bug fixes. | |
5293 @item | |
5294 Improved interaction with Emacs LaTeX mode. | |
25829 | 5295 @end itemize |
5296 | |
59536 | 5297 @noindent @b{Version 4.12} |
25829 | 5298 @itemize @bullet |
5299 @item | |
59536 | 5300 Support for @file{bibentry} citation style. |
25829 | 5301 @end itemize |
5302 | |
59536 | 5303 @noindent @b{Version 4.11} |
5304 @itemize @bullet | |
5305 @item | |
5306 Fixed bug which would parse @samp{\Section} just like @samp{\section}. | |
5307 @end itemize | |
5308 | |
5309 @noindent @b{Version 4.10} | |
25829 | 5310 @itemize @bullet |
5311 @item | |
59536 | 5312 Renamed @file{reftex-vcr.el} to @file{reftex-dcr.el} because of conflict |
5313 with @file{reftex-vars.el} on DOS machines. | |
5314 @item | |
5315 New options @code{reftex-parse-file-extension} and | |
5316 @code{reftex-index-phrase-file-extension}. | |
25829 | 5317 @end itemize |
5318 | |
59536 | 5319 @noindent [.....] |
5320 @ignore | |
5321 @noindent @b{Version 4.09} | |
25829 | 5322 @itemize @bullet |
5323 @item | |
59536 | 5324 New option @code{reftex-toc-max-level} to limit the depth of the toc. |
5325 New key binding @kbd{t} in the @file{*toc*} buffer to change this | |
59579
a588c86a429c
Revision: miles@gnu.org--gnu-2005/emacs--cvs-trunk--0--patch-40
Miles Bader <miles@gnu.org>
parents:
59548
diff
changeset
|
5326 setting. |
a588c86a429c
Revision: miles@gnu.org--gnu-2005/emacs--cvs-trunk--0--patch-40
Miles Bader <miles@gnu.org>
parents:
59548
diff
changeset
|
5327 @item |
a588c86a429c
Revision: miles@gnu.org--gnu-2005/emacs--cvs-trunk--0--patch-40
Miles Bader <miles@gnu.org>
parents:
59548
diff
changeset
|
5328 RefTeX maintains an @file{Index Phrases} file in which phrases can be |
59536 | 5329 collected. When the document is ready, RefTeX can search all |
5330 these phrases and assist indexing all matches. | |
5331 @item | |
5332 The variables @code{reftex-index-macros} and | |
5333 @code{reftex-index-default-macro} have changed their syntax slightly. | |
5334 The @var{repeat} parameter has move from the latter to the former. | |
5335 Also calls to @code{reftex-add-index-macros} from AUCTeX style files | |
5336 need to be adapted. | |
5337 @item | |
5338 The variable @code{reftex-section-levels} no longer contains the | |
5339 default stuff which has been moved to a constant. | |
5340 @item | |
5341 Environments like theorems can be placed into the TOC by putting | |
5342 entries for @samp{"begin@{theorem@}"} in | |
59579
a588c86a429c
Revision: miles@gnu.org--gnu-2005/emacs--cvs-trunk--0--patch-40
Miles Bader <miles@gnu.org>
parents:
59548
diff
changeset
|
5343 @code{reftex-setion-levels}. |
59536 | 5344 @end itemize |
5345 | |
5346 @noindent @b{Version 4.06} | |
5347 @itemize @bullet | |
5348 @item | |
5349 @code{reftex-section-levels} can contain a function to compute the level | |
5350 of a sectioning command. | |
5351 @item | |
5352 Multiple @code{thebibliography} environments recognized. | |
5353 @end itemize | |
5354 | |
5355 @noindent @b{Version 4.04} | |
5356 @itemize @bullet | |
5357 @item | |
5358 New option @code{reftex-index-default-tag} implements a default for queries. | |
25829 | 5359 @end itemize |
5360 | |
59536 | 5361 @noindent @b{Version 4.02} |
25829 | 5362 @itemize @bullet |
5363 @item | |
59536 | 5364 macros ending in @samp{refrange} are considered to contain references. |
5365 @item | |
5366 Index entries made with @code{reftex-index-selection-or-word} in TeX | |
5367 math mode automatically get enclosing @samp{$} to preserve math mode. See | |
5368 new option @code{reftex-index-math-format}. Requires AUCTeX. | |
25829 | 5369 @end itemize |
5370 | |
59536 | 5371 @noindent @b{Version 4.01} |
25829 | 5372 @itemize @bullet |
5373 @item | |
59536 | 5374 New command @code{reftex-index-globally} to index a word in many |
5375 places in the document. Also available from the index buffer with | |
5376 @kbd{&}. | |
5377 @item | |
5378 The first item in a @code{reftex-label-alist} entry may now also be a parser | |
5379 function to do non-standard parsing. | |
5380 @item | |
5381 @code{reftex-auto-view-crossref} no longer interferes with | |
5382 @code{pop-up-frames} (patch from Stefan Monnier). | |
25829 | 5383 @end itemize |
5384 | |
59536 | 5385 @noindent @b{Version 4.00} |
25829 | 5386 @itemize @bullet |
5387 @item | |
59579
a588c86a429c
Revision: miles@gnu.org--gnu-2005/emacs--cvs-trunk--0--patch-40
Miles Bader <miles@gnu.org>
parents:
59548
diff
changeset
|
5388 RefTeX has been split into several smaller files which are autoloaded on |
59536 | 5389 demand. |
5390 @item | |
5391 Index support, along with many new options. | |
5392 @item | |
5393 The selection of keys for @code{\ref} and @code{\cite} now allows to | |
5394 select multiple items by marking entries with the @kbd{m} key. | |
5395 @item | |
5396 Fancyref support. | |
25829 | 5397 @end itemize |
5398 | |
59536 | 5399 @noindent @b{Version 3.43} |
25829 | 5400 @itemize @bullet |
5401 @item | |
59536 | 5402 Viewing cross-references generalized. Now works on @code{\label}, |
5403 @code{\ref}, @code{\cite}, @code{\bibitem}, @code{\index}, variations of | |
5404 these, and from BibTeX buffers. | |
5405 @item | |
5406 New option @code{reftex-view-crossref-extra}. | |
5407 @item | |
5408 Support for the additional sectioning commands @code{\addchap} and | |
5409 @code{\addsec} which are defined in the LaTeX KOMA-Script classes. | |
5410 @item | |
5411 Files in @code{reftex-default-bibliography} will be searched along | |
5412 @code{BIBINPUTS} path. | |
5413 @item | |
5414 Reading a parse file now checks consistency. | |
25829 | 5415 @end itemize |
5416 | |
59536 | 5417 @noindent @b{Version 3.42} |
25829 | 5418 @itemize @bullet |
5419 @item | |
59536 | 5420 File search further refined. New option @code{reftex-file-extensions}. |
5421 @item | |
5422 @file{*toc*} buffer can show the file boundaries of a multifile | |
5423 document, all labels and associated context. New keys @kbd{i}, @kbd{l}, | |
5424 and @kbd{c}. New options @code{reftex-toc-include-labels}, | |
5425 @code{reftex-toc-include-context}, | |
63671
9fc49ac7fb44
(Options (Defining Label Environments), Options (Index Support), Options
Juanma Barranquero <lekktu@gmail.com>
parents:
62469
diff
changeset
|
5426 @code{reftex-toc-include-file-boundaries}. |
25829 | 5427 @end itemize |
5428 | |
59536 | 5429 @noindent @b{Version 3.41} |
25829 | 5430 @itemize @bullet |
5431 @item | |
59536 | 5432 New options @code{reftex-texpath-environment-variables}, |
59579
a588c86a429c
Revision: miles@gnu.org--gnu-2005/emacs--cvs-trunk--0--patch-40
Miles Bader <miles@gnu.org>
parents:
59548
diff
changeset
|
5433 @code{reftex-use-external-file-finders}, |
a588c86a429c
Revision: miles@gnu.org--gnu-2005/emacs--cvs-trunk--0--patch-40
Miles Bader <miles@gnu.org>
parents:
59548
diff
changeset
|
5434 @code{reftex-external-file-finders}, |
a588c86a429c
Revision: miles@gnu.org--gnu-2005/emacs--cvs-trunk--0--patch-40
Miles Bader <miles@gnu.org>
parents:
59548
diff
changeset
|
5435 @code{reftex-search-unrecursed-path-first}. |
59536 | 5436 @item |
5437 @emph{kpathsearch} support. See new options and | |
5438 @code{reftex-bibpath-environment-variables}. | |
5439 @end itemize | |
5440 | |
5441 @noindent @b{Version 3.38} | |
5442 @itemize @bullet | |
5443 @item | |
5444 @code{reftex-view-crossref} no longer moves to find a macro. Point has | |
5445 to be on the macro argument. | |
5446 @end itemize | |
5447 | |
5448 @noindent @b{Version 3.36} | |
5449 @itemize @bullet | |
5450 @item | |
5451 New value @code{window} for option @code{reftex-auto-view-crossref}. | |
25829 | 5452 @end itemize |
5453 | |
59536 | 5454 @noindent @b{Version 3.35} |
5455 @itemize @bullet | |
5456 @item | |
5457 ISO 8859 Latin-1 chars are converted to ASCII to derive better labels. | |
5458 This takes back the related changes in 3.34 for safety reasons. | |
5459 @end itemize | |
5460 | |
5461 @noindent @b{Version 3.34} | |
25829 | 5462 @itemize @bullet |
5463 @item | |
59536 | 5464 Additional flag in @code{reftex-derive-label-parameters} do make only |
5465 lowercase labels (default @code{t}). | |
5466 @item | |
5467 All @file{.rel} files have a final newline to avoid queries. | |
5468 @item | |
5469 Single byte representations of accented European letters (ISO-8859-1) | |
60927
bae786986f2e
* calc.texi, cl.texi, gnus.texi, idlwave.texi, reftex.texi: Replace
Werner LEMBERG <wl@gnu.org>
parents:
60919
diff
changeset
|
5470 are now valid in labels. |
25829 | 5471 @end itemize |
5472 | |
59536 | 5473 @noindent @b{Version 3.33} |
25829 | 5474 @itemize @bullet |
5475 @item | |
59536 | 5476 Multiple selection buffers are now hidden buffers (they start with a |
5477 SPACE). | |
59579
a588c86a429c
Revision: miles@gnu.org--gnu-2005/emacs--cvs-trunk--0--patch-40
Miles Bader <miles@gnu.org>
parents:
59548
diff
changeset
|
5478 @item |
59536 | 5479 Fixed bug with file search when TEXINPUTS environment variable is empty. |
25829 | 5480 @end itemize |
5481 | |
59536 | 5482 @noindent @b{Version 3.30} |
5483 @itemize @bullet | |
5484 @item | |
5485 In @code{reftex-citation}, the regular expression used to scan BibTeX | |
5486 files can be specified using completion on known citation keys. | |
5487 @item | |
5488 New keys @kbd{a} and @kbd{A} in BibTeX selection process to cite @emph{all} | |
5489 entries. | |
5490 @item | |
5491 New command @code{reftex-renumber-simple-labels} to renumber simple | |
5492 labels like @samp{eq:13} sequentially through a document. | |
5493 @end itemize | |
5494 | |
5495 @noindent @b{Version 3.28} | |
25829 | 5496 @itemize @bullet |
5497 @item | |
59536 | 5498 Auto view crossref for XEmacs uses @code{post-command-hook} to restart the |
5499 timer, since itimer restart is not reliable. | |
5500 @item | |
5501 Option @code{reftex-bibfile-ignore-list} renamed to @code{-regexps}. | |
5502 @item | |
5503 Expansion of recursive tex and bib path rewritten. | |
5504 @item | |
5505 Fixed problem where @b{Ref@TeX{}} did not scan unsaved buffers. | |
5506 @item | |
5507 Fixed bug with section numbering after *-red sections. | |
25829 | 5508 @end itemize |
5509 | |
59536 | 5510 @noindent @b{Version 3.27} |
5511 @itemize @bullet | |
5512 @item | |
5513 Macros can define @emph{neutral} labels, just like @code{\label} | |
5514 itself. | |
5515 @item | |
5516 New option @code{reftex-allow-detached-macro-args}, default @code{nil}! | |
5517 @end itemize | |
5518 | |
5519 @noindent @b{Version 3.26} | |
25829 | 5520 @itemize @bullet |
5521 @item | |
59536 | 5522 [X]Emacs 19 no longer supported. Use 3.22 for Emacs 19. |
5523 @item | |
5524 New hooks @code{reftex-translate-to-ascii-function}, | |
5525 @code{reftex-string-to-label-function}. | |
5526 @item | |
5527 Made sure automatic crossref display will not visit/scan files. | |
25829 | 5528 @end itemize |
5529 | |
59536 | 5530 @noindent @b{Version 3.25} |
25829 | 5531 @itemize @bullet |
5532 @item | |
59536 | 5533 Echoing of citation info caches the info for displayed entries. |
5534 New option @code{reftex-cache-cite-echo}. | |
5535 @item | |
5536 @kbd{M-x reftex-reset-mode} now also removes the file with parsing | |
5537 info. | |
5538 @item | |
63671
9fc49ac7fb44
(Options (Defining Label Environments), Options (Index Support), Options
Juanma Barranquero <lekktu@gmail.com>
parents:
62469
diff
changeset
|
5539 Default of @code{reftex-revisit-to-follow} changed to @code{nil}. |
59536 | 5540 @end itemize |
5541 | |
5542 @noindent @b{Version 3.24} | |
5543 @itemize @bullet | |
5544 @item | |
5545 New option @code{reftex-revisit-to-echo}. | |
5546 @item | |
5547 Interface with X-Symbol (>=2.6) is now complete and stable. | |
5548 @item | |
5549 Adapted to new outline, which uses overlays. | |
5550 @item | |
5551 File names in @code{\bibliography} may now have the @code{.bib} | |
5552 extension. | |
5553 @item | |
5554 Fixed Bug with parsing "single file" from master file buffer. | |
25829 | 5555 @end itemize |
5556 | |
5557 @noindent @b{Version 3.23} | |
5558 @itemize @bullet | |
5559 @item | |
5560 Parse files @file{MASTER.rel} made compatible between Emacs and XEmacs. | |
5561 @item | |
59579
a588c86a429c
Revision: miles@gnu.org--gnu-2005/emacs--cvs-trunk--0--patch-40
Miles Bader <miles@gnu.org>
parents:
59548
diff
changeset
|
5562 @code{kill-emacs-hook} and @code{kill-buffer-hook} now write the parse |
25829 | 5563 file. |
5564 @item | |
5565 The cursor inside a @code{\ref} or @code{\cite} macro can now trigger | |
5566 automatic display of crossref information in the echo area. See | |
5567 variable @code{reftex-auto-view-crossref}. | |
5568 @item | |
5569 AUCTeX interface updates: | |
5570 @itemize @minus | |
5571 @item | |
5572 AUCTeX 9.9c and later notifies @b{Ref@TeX{}} about new sections. | |
5573 @item | |
5574 @b{Ref@TeX{}} notifies AUCTeX about new labels. | |
5575 @item | |
5576 @code{TeX-arg-ref} no longer used (introduction was unnecessary). | |
5577 @item | |
5578 @code{reftex-arg-label} and @code{reftex-arg-cite} fixed up. | |
5579 @item | |
5580 Settings added to @b{Ref@TeX{}} via style files remain local. | |
5581 @end itemize | |
5582 @item | |
5583 Fixed bug with @code{reftex-citation} in non-latex buffers. | |
5584 @item | |
5585 Fixed bug with syntax table and context refontification. | |
5586 @item | |
5587 Safety-net for name change of @code{font-lock-reference-face}. | |
5588 @end itemize | |
5589 | |
59536 | 5590 @noindent @b{Version 3.22} |
25829 | 5591 @itemize @bullet |
5592 @item | |
59536 | 5593 Fixed bug with empty context strings. |
5594 @item | |
5595 @code{reftex-mouse-view-crossref} is now bound by default at | |
5596 @kbd{S-mouse-2}. | |
25829 | 5597 @end itemize |
5598 | |
59536 | 5599 @noindent @b{Version 3.21} |
25829 | 5600 @itemize @bullet |
5601 @item | |
59536 | 5602 New options for all faces used by @b{Ref@TeX{}}. They're in the |
5603 customization group @code{reftex-fontification-configurations}. | |
25829 | 5604 @end itemize |
5605 | |
59536 | 5606 @noindent @b{Version 3.19} |
5607 @itemize @bullet | |
5608 @item | |
5609 Fixed bug with AUCTeX @code{TeX-master}. | |
5610 @end itemize | |
5611 | |
5612 @noindent @b{Version 3.18} | |
25829 | 5613 @itemize @bullet |
5614 @item | |
59536 | 5615 The selection now uses a recursive edit, much like minibuffer input. |
5616 This removes all restrictions during selection. E.g. you can now | |
5617 switch buffers at will, use the mouse etc. | |
5618 @item | |
5619 New option @code{reftex-highlight-selection}. | |
5620 @item | |
5621 @kbd{mouse-2} can be used to select in selection and @file{*toc*} | |
5622 buffers. | |
5623 @item | |
5624 Fixed some problems regarding the interaction with VIPER mode. | |
5625 @item | |
5626 Follow-mode is now only used after point motion. | |
5627 @item | |
5628 @b{Ref@TeX{}} now finally does not fontify temporary files anymore. | |
25829 | 5629 @end itemize |
5630 | |
59536 | 5631 @noindent @b{Version 3.17} |
25829 | 5632 @itemize @bullet |
5633 @item | |
59536 | 5634 Additional bindings in selection and @file{*toc*} buffers. @kbd{g} |
5635 redefined. | |
5636 @item | |
5637 New command @code{reftex-save-all-document-buffers}. | |
5638 @item | |
5639 Magic word matching made more intelligent. | |
5640 @item | |
5641 Selection process can switch to completion (with @key{TAB}). | |
5642 @item | |
5643 @code{\appendix} is now recognized and influences section numbering. | |
5644 @item | |
5645 File commentary shortened considerably (use Info documentation). | |
5646 @item | |
5647 New option @code{reftex-no-include-regexps} to skip some include files. | |
5648 @item | |
5649 New option @code{reftex-revisit-to-follow}. | |
25829 | 5650 @end itemize |
5651 | |
59536 | 5652 @noindent @b{Version 3.16} |
25829 | 5653 @itemize @bullet |
5654 @item | |
59536 | 5655 New hooks @code{reftex-format-label-function}, |
5656 @code{reftex-format-ref-function}, @code{reftex-format-cite-function}. | |
5657 @item | |
5658 TeXInfo documentation completed. | |
5659 @item | |
5660 Some restrictions in Label inserting and referencing removed. | |
5661 @item | |
5662 New variable @code{reftex-default-bibliography}. | |
25829 | 5663 @end itemize |
59536 | 5664 |
5665 @noindent @b{Version 3.14} | |
25829 | 5666 @itemize @bullet |
5667 @item | |
59536 | 5668 Selection buffers can be kept between selections: this is faster. |
5669 See new variable @code{reftex-use-multiple-selection-buffers}. | |
5670 @item | |
5671 Prefix interpretation of reftex-view-crossref changed. | |
5672 @item | |
5673 Support for the @code{varioref} package (@kbd{v} key in selection | |
5674 buffer). | |
25829 | 5675 @end itemize |
59536 | 5676 |
5677 @noindent @b{Version 3.12} | |
25829 | 5678 @itemize @bullet |
5679 @item | |
59536 | 5680 There are 3 new keymaps for customization: @code{reftex-toc-map}, |
5681 @code{reftex-select-label-map}, @code{reftex-select-bib-map}. | |
5682 @item | |
5683 Refontification uses more standard font-lock stuff. | |
5684 @item | |
5685 When no BibTeX database files are specified, citations can also use | |
5686 @code{\bibitem} entries from a @code{thebibliography} environment. | |
25829 | 5687 @end itemize |
59536 | 5688 |
5689 @noindent @b{Version 3.11} | |
25829 | 5690 @itemize @bullet |
5691 @item | |
59536 | 5692 Fixed bug which led to naked label in (e.g.) footnotes. |
5693 @item | |
5694 Added scroll-other-window functions to RefTeX-Select. | |
25829 | 5695 @end itemize |
59536 | 5696 |
5697 @noindent @b{Version 3.10} | |
25829 | 5698 @itemize @bullet |
5699 @item | |
59536 | 5700 Fixed a bug which made reftex 3.07 fail on [X]Emacs version 19. |
5701 @item | |
5702 Removed unimportant code which caused OS/2 Emacs to crash. | |
5703 @item | |
5704 All customization variables now accessible from menu. | |
25829 | 5705 @end itemize |
59536 | 5706 |
5707 @noindent @b{Version 3.07} | |
25829 | 5708 @itemize @bullet |
5709 @item | |
59536 | 5710 @code{Ref} menu improved. |
5711 @end itemize | |
5712 | |
5713 @noindent @b{Version 3.05} | |
5714 @itemize @bullet | |
5715 @item | |
5716 Compatibility code now first checks for XEmacs feature. | |
25829 | 5717 @end itemize |
59536 | 5718 |
5719 @noindent @b{Version 3.04} | |
5720 @itemize @bullet | |
5721 @item | |
5722 Fixed BUG in the @emph{xr} support. | |
5723 @end itemize | |
5724 | |
5725 @noindent @b{Version 3.03} | |
25829 | 5726 @itemize @bullet |
5727 @item | |
59536 | 5728 Support for the LaTeX package @code{xr}, for inter-document |
5729 references. | |
5730 @item | |
5731 A few (minor) Mule-related changes. | |
5732 @item | |
5733 Fixed bug which could cause @emph{huge} @file{.rel} files. | |
5734 @item | |
5735 Search for input and @file{.bib} files with recursive path definitions. | |
25829 | 5736 @end itemize |
59536 | 5737 |
5738 @noindent @b{Version 3.00} | |
25829 | 5739 @itemize @bullet |
5740 @item | |
59536 | 5741 @b{Ref@TeX{}} should work better for very large projects: |
5742 @item | |
5743 The new parser works without creating a master buffer. | |
5744 @item | |
5745 Rescanning can be limited to a part of a multifile document. | |
5746 @item | |
5747 Information from the parser can be stored in a file. | |
5748 @item | |
5749 @b{Ref@TeX{}} can deal with macros having a naked label as an argument. | |
5750 @item | |
5751 Macros may have white space and newlines between arguments. | |
5752 @item | |
5753 Multiple identical section headings no longer confuse | |
5754 @code{reftex-toc}. | |
5755 @item | |
5756 @b{Ref@TeX{}} should work correctly in combination with buffer-altering | |
5757 packages like outline, folding, x-symbol, iso-cvt, isotex, etc. | |
5758 @item | |
5759 All labeled environments discussed in @emph{The LaTeX Companion} by | |
5760 Goossens, Mittelbach & Samarin, Addison-Wesley 1994) are part of | |
5761 @b{Ref@TeX{}}'s defaults. | |
25829 | 5762 @end itemize |
59536 | 5763 |
5764 @noindent @b{Version 2.17} | |
25829 | 5765 @itemize @bullet |
5766 @item | |
59536 | 5767 Label prefix expands % escapes with current file name and other stuff. |
5768 @item | |
5769 Citation format now with % escapes. This is not backward | |
5770 compatible! | |
5771 @item | |
5772 TEXINPUTS variable recognized when looking for input files. | |
5773 @item | |
5774 Context can be the nth argument of a macro. | |
5775 @item | |
5776 Searching in the select buffer is now possible (@kbd{C-s} and | |
5777 @kbd{C-r}). | |
5778 @item | |
5779 Display and derive-label can use two different context methods. | |
5780 @item | |
5781 AMSmath @code{xalignat} and @code{xxalignat} added. | |
25829 | 5782 @end itemize |
59536 | 5783 |
5784 @noindent @b{Version 2.14} | |
25829 | 5785 @itemize @bullet |
5786 @item | |
59536 | 5787 Variable @code{reftex-plug-into-AUCTeX} simplifies cooperation with |
5788 AUCTeX. | |
25829 | 5789 @end itemize |
59536 | 5790 |
5791 @noindent @b{Version 2.11} | |
5792 @itemize @bullet | |
5793 @item | |
5794 Submitted for inclusion to Emacs and XEmacs. | |
5795 @end itemize | |
5796 | |
5797 @noindent @b{Version 2.07} | |
25829 | 5798 @itemize @bullet |
5799 @item | |
59536 | 5800 New functions @code{reftex-search-document}, |
5801 @code{reftex-query-replace-document}. | |
25829 | 5802 @end itemize |
59536 | 5803 |
5804 @noindent @b{Version 2.05} | |
5805 @itemize @bullet | |
5806 @item | |
5807 Support for @file{custom.el}. | |
5808 @item | |
5809 New function @code{reftex-grep-document} (thanks to Stephen Eglen). | |
5810 @end itemize | |
5811 | |
5812 @noindent @b{Version 2.03} | |
25829 | 5813 @itemize @bullet |
5814 @item | |
59536 | 5815 @code{figure*}, @code{table*}, @code{sidewaysfigure/table} added to |
5816 default environments. | |
5817 @item | |
5818 @code{reftex-bibfile-ignore-list} introduced (thanks to Rory Molinari). | |
5819 @item | |
5820 New functions @code{reftex-arg-label}, @code{reftex-arg-ref}, | |
5821 @code{reftex-arg-cite}. | |
5822 @item | |
5823 Emacs/XEmacs compatibility reworked. XEmacs 19.15 now is | |
5824 required. | |
5825 @item | |
5826 @code{reftex-add-to-label-alist} (to be called from AUCTeX style | |
5827 files). | |
5828 @item | |
5829 Finding context with a hook function. | |
5830 @item | |
5831 Sorting BibTeX entries (new variable: | |
5832 @code{reftex-sort-bibtex-matches}). | |
25829 | 5833 @end itemize |
59536 | 5834 |
5835 @noindent @b{Version 2.00} | |
26911
d7f536a01276
Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents:
25829
diff
changeset
|
5836 @itemize @bullet |
d7f536a01276
Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents:
25829
diff
changeset
|
5837 @item |
59536 | 5838 Labels can be derived from context (default for sections). |
5839 @item | |
5840 Configuration of label insertion and label referencing revised. | |
5841 @item | |
5842 Crossref fields in BibTeX database entries. | |
5843 @item | |
5844 @code{reftex-toc} introduced (thanks to Stephen Eglen). | |
26911
d7f536a01276
Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents:
25829
diff
changeset
|
5845 @end itemize |
59536 | 5846 |
5847 @noindent @b{Version 1.09} | |
27195 | 5848 @itemize @bullet |
5849 @item | |
59536 | 5850 Support for @code{tex-main-file}, an analogue for |
5851 @code{TeX-master}. | |
5852 @item | |
5853 MS-DOS support. | |
27195 | 5854 @end itemize |
59536 | 5855 |
5856 @noindent @b{Version 1.07} | |
29772
265fdb06f294
Update to reftex 4 14
Carsten Dominik <dominik@science.uva.nl>
parents:
29713
diff
changeset
|
5857 @itemize @bullet |
265fdb06f294
Update to reftex 4 14
Carsten Dominik <dominik@science.uva.nl>
parents:
29713
diff
changeset
|
5858 @item |
59536 | 5859 @b{Ref@TeX{}} gets its own menu. |
29772
265fdb06f294
Update to reftex 4 14
Carsten Dominik <dominik@science.uva.nl>
parents:
29713
diff
changeset
|
5860 @end itemize |
59536 | 5861 |
5862 @noindent @b{Version 1.05} | |
34403
6679ef9b33fe
RefTeX 4.15 update
Carsten Dominik <dominik@science.uva.nl>
parents:
30009
diff
changeset
|
5863 @itemize @bullet |
6679ef9b33fe
RefTeX 4.15 update
Carsten Dominik <dominik@science.uva.nl>
parents:
30009
diff
changeset
|
5864 @item |
59536 | 5865 XEmacs port. |
5866 @end itemize | |
5867 | |
5868 @noindent @b{Version 1.04} | |
5869 @itemize @bullet | |
5870 @item | |
5871 Macros as wrappers, AMSTeX support, delayed context parsing for | |
5872 new labels. | |
34403
6679ef9b33fe
RefTeX 4.15 update
Carsten Dominik <dominik@science.uva.nl>
parents:
30009
diff
changeset
|
5873 @end itemize |
47050
904fd28be439
Update to RefTeX 4.19
Carsten Dominik <dominik@science.uva.nl>
parents:
46918
diff
changeset
|
5874 @end ignore |
59536 | 5875 |
5876 @noindent @b{Version 1.00} | |
46684
9569bac241a3
Update to RefTeX 4.18
Carsten Dominik <dominik@science.uva.nl>
parents:
46272
diff
changeset
|
5877 @itemize @bullet |
9569bac241a3
Update to RefTeX 4.18
Carsten Dominik <dominik@science.uva.nl>
parents:
46272
diff
changeset
|
5878 @item |
59536 | 5879 released on 7 Jan 1997. |
47050
904fd28be439
Update to RefTeX 4.19
Carsten Dominik <dominik@science.uva.nl>
parents:
46918
diff
changeset
|
5880 @end itemize |
59536 | 5881 |
5882 | |
5883 | |
5884 | |
25829 | 5885 |
5886 @node Index, , , Top | |
5887 @unnumbered Index | |
5888 @printindex cp | |
5889 | |
5890 @summarycontents | |
5891 @contents | |
5892 @bye | |
5893 | |
59548
83df5808ec6b
Changes from arch/CVS synchronization
Miles Bader <miles@gnu.org>
parents:
59538
diff
changeset
|
5894 @ignore |
83df5808ec6b
Changes from arch/CVS synchronization
Miles Bader <miles@gnu.org>
parents:
59538
diff
changeset
|
5895 arch-tag: 1e055774-0576-4b1b-b47f-550d0961fd43 |
83df5808ec6b
Changes from arch/CVS synchronization
Miles Bader <miles@gnu.org>
parents:
59538
diff
changeset
|
5896 @end ignore |