annotate man/reftex.texi @ 29819:7a583e16423b

@setfilename to ../info/reftex.
author Gerd Moellmann <gerd@gnu.org>
date Tue, 20 Jun 2000 19:54:37 +0000
parents 265fdb06f294
children 95bdbefcdac6
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
25829
Dave Love <fx@gnu.org>
parents:
diff changeset
1 \input texinfo @c -*-texinfo-*-
Dave Love <fx@gnu.org>
parents:
diff changeset
2 @c %**start of header
29819
7a583e16423b @setfilename to ../info/reftex.
Gerd Moellmann <gerd@gnu.org>
parents: 29772
diff changeset
3 @setfilename ../info/reftex
25829
Dave Love <fx@gnu.org>
parents:
diff changeset
4 @settitle RefTeX User Manual
Dave Love <fx@gnu.org>
parents:
diff changeset
5 @dircategory Editors
Dave Love <fx@gnu.org>
parents:
diff changeset
6 @direntry
Dave Love <fx@gnu.org>
parents:
diff changeset
7 * RefTeX: (reftex). Emacs support for LaTeX cross-references and citations.
Dave Love <fx@gnu.org>
parents:
diff changeset
8 @end direntry
Dave Love <fx@gnu.org>
parents:
diff changeset
9 @synindex ky cp
Dave Love <fx@gnu.org>
parents:
diff changeset
10 @syncodeindex vr cp
Dave Love <fx@gnu.org>
parents:
diff changeset
11 @syncodeindex fn cp
29772
265fdb06f294 Update to reftex 4 14
Carsten Dominik <dominik@science.uva.nl>
parents: 29713
diff changeset
12 @set VERSION 4.12
265fdb06f294 Update to reftex 4 14
Carsten Dominik <dominik@science.uva.nl>
parents: 29713
diff changeset
13 @set EDITION 4.12
265fdb06f294 Update to reftex 4 14
Carsten Dominik <dominik@science.uva.nl>
parents: 29713
diff changeset
14 @set DATE March 2000
25829
Dave Love <fx@gnu.org>
parents:
diff changeset
15 @set AUTHOR Carsten Dominik
29772
265fdb06f294 Update to reftex 4 14
Carsten Dominik <dominik@science.uva.nl>
parents: 29713
diff changeset
16 @set AUTHOR-EMAIL dominik@@astro.uva.nl
25829
Dave Love <fx@gnu.org>
parents:
diff changeset
17 @set MAINTAINER Carsten Dominik
29772
265fdb06f294 Update to reftex 4 14
Carsten Dominik <dominik@science.uva.nl>
parents: 29713
diff changeset
18 @set MAINTAINER-EMAIL dominik@@astro.uva.nl
25829
Dave Love <fx@gnu.org>
parents:
diff changeset
19 @c %**end of header
Dave Love <fx@gnu.org>
parents:
diff changeset
20 @finalout
Dave Love <fx@gnu.org>
parents:
diff changeset
21
Dave Love <fx@gnu.org>
parents:
diff changeset
22 @c Macro definitions
Dave Love <fx@gnu.org>
parents:
diff changeset
23
Dave Love <fx@gnu.org>
parents:
diff changeset
24 @c Subheadings inside a table. Need a difference between info and the rest.
Dave Love <fx@gnu.org>
parents:
diff changeset
25 @macro tablesubheading{text}
Dave Love <fx@gnu.org>
parents:
diff changeset
26 @ifinfo
Dave Love <fx@gnu.org>
parents:
diff changeset
27 @subsubheading \text\
Dave Love <fx@gnu.org>
parents:
diff changeset
28 @end ifinfo
Dave Love <fx@gnu.org>
parents:
diff changeset
29 @ifnotinfo
Dave Love <fx@gnu.org>
parents:
diff changeset
30 @item @b{\text\}
Dave Love <fx@gnu.org>
parents:
diff changeset
31 @end ifnotinfo
Dave Love <fx@gnu.org>
parents:
diff changeset
32 @end macro
Dave Love <fx@gnu.org>
parents:
diff changeset
33
Dave Love <fx@gnu.org>
parents:
diff changeset
34 @ifinfo
Dave Love <fx@gnu.org>
parents:
diff changeset
35 This file documents @b{Ref@TeX{}}, a package to do labels, references,
Dave Love <fx@gnu.org>
parents:
diff changeset
36 citations and indices for LaTeX documents with Emacs.@refill
Dave Love <fx@gnu.org>
parents:
diff changeset
37
Dave Love <fx@gnu.org>
parents:
diff changeset
38 This is edition @value{EDITION} of the @b{Ref@TeX{}} User Manual for
Dave Love <fx@gnu.org>
parents:
diff changeset
39 @b{Ref@TeX{}} @value{VERSION}@refill
Dave Love <fx@gnu.org>
parents:
diff changeset
40
27195
d7311a9cb223 version 4.10
Carsten Dominik <dominik@science.uva.nl>
parents: 26911
diff changeset
41 Copyright (c) 1997, 1998, 1999, 2000 Free Software Foundation, Inc.
25829
Dave Love <fx@gnu.org>
parents:
diff changeset
42
Dave Love <fx@gnu.org>
parents:
diff changeset
43 Permission is granted to make and distribute verbatim
Dave Love <fx@gnu.org>
parents:
diff changeset
44 copies of this manual provided the copyright notice and
Dave Love <fx@gnu.org>
parents:
diff changeset
45 this permission notice are preserved on all copies.
Dave Love <fx@gnu.org>
parents:
diff changeset
46
Dave Love <fx@gnu.org>
parents:
diff changeset
47 @ignore
Dave Love <fx@gnu.org>
parents:
diff changeset
48 Permission is granted to process this file through TeX
Dave Love <fx@gnu.org>
parents:
diff changeset
49 and print the results, provided the printed document
Dave Love <fx@gnu.org>
parents:
diff changeset
50 carries a copying permission notice identical to this
Dave Love <fx@gnu.org>
parents:
diff changeset
51 one except for the removal of this paragraph (this
Dave Love <fx@gnu.org>
parents:
diff changeset
52 paragraph not being relevant to the printed manual).
Dave Love <fx@gnu.org>
parents:
diff changeset
53
Dave Love <fx@gnu.org>
parents:
diff changeset
54 @end ignore
Dave Love <fx@gnu.org>
parents:
diff changeset
55 Permission is granted to copy and distribute modified
Dave Love <fx@gnu.org>
parents:
diff changeset
56 versions of this manual under the conditions for
Dave Love <fx@gnu.org>
parents:
diff changeset
57 verbatim copying, provided that the entire resulting
Dave Love <fx@gnu.org>
parents:
diff changeset
58 derive work is distributed under the terms of a permission
Dave Love <fx@gnu.org>
parents:
diff changeset
59 notice identical to this one.
Dave Love <fx@gnu.org>
parents:
diff changeset
60
Dave Love <fx@gnu.org>
parents:
diff changeset
61 Permission is granted to copy and distribute
Dave Love <fx@gnu.org>
parents:
diff changeset
62 translations of this manual into another language,
Dave Love <fx@gnu.org>
parents:
diff changeset
63 under the above conditions for modified versions,
Dave Love <fx@gnu.org>
parents:
diff changeset
64 except that this permission notice may be stated in a
Dave Love <fx@gnu.org>
parents:
diff changeset
65 translation approved by the Free Software Foundation.
Dave Love <fx@gnu.org>
parents:
diff changeset
66 @end ifinfo
Dave Love <fx@gnu.org>
parents:
diff changeset
67
Dave Love <fx@gnu.org>
parents:
diff changeset
68 @titlepage
Dave Love <fx@gnu.org>
parents:
diff changeset
69 @title Ref@TeX{} User Manual
Dave Love <fx@gnu.org>
parents:
diff changeset
70 @subtitle Support for LaTeX labels, references, citations and index entries with GNU Emacs
Dave Love <fx@gnu.org>
parents:
diff changeset
71 @subtitle Edition @value{EDITION}, @value{DATE}
Dave Love <fx@gnu.org>
parents:
diff changeset
72
Dave Love <fx@gnu.org>
parents:
diff changeset
73 @author by Carsten Dominik
Dave Love <fx@gnu.org>
parents:
diff changeset
74 @page
27195
d7311a9cb223 version 4.10
Carsten Dominik <dominik@science.uva.nl>
parents: 26911
diff changeset
75 Copyright @copyright{} 1997, 1998, 1999, 2000 Free Software Foundation, Inc.
25829
Dave Love <fx@gnu.org>
parents:
diff changeset
76
Dave Love <fx@gnu.org>
parents:
diff changeset
77 @sp 2
Dave Love <fx@gnu.org>
parents:
diff changeset
78 This is edition @value{EDITION} of the @cite{Ref@TeX{} User Manual} for
Dave Love <fx@gnu.org>
parents:
diff changeset
79 @b{Ref@TeX{}} version @value{VERSION}, @value{DATE}.@refill
Dave Love <fx@gnu.org>
parents:
diff changeset
80
Dave Love <fx@gnu.org>
parents:
diff changeset
81 @sp 2
Dave Love <fx@gnu.org>
parents:
diff changeset
82
Dave Love <fx@gnu.org>
parents:
diff changeset
83 Permission is granted to make and distribute verbatim
Dave Love <fx@gnu.org>
parents:
diff changeset
84 copies of this manual provided the copyright notice and
Dave Love <fx@gnu.org>
parents:
diff changeset
85 this permission notice are preserved on all copies.
Dave Love <fx@gnu.org>
parents:
diff changeset
86
Dave Love <fx@gnu.org>
parents:
diff changeset
87 Permission is granted to copy and distribute modified
Dave Love <fx@gnu.org>
parents:
diff changeset
88 versions of this manual under the conditions for
Dave Love <fx@gnu.org>
parents:
diff changeset
89 verbatim copying, provided that the entire resulting
Dave Love <fx@gnu.org>
parents:
diff changeset
90 derive work is distributed under the terms of a permission
Dave Love <fx@gnu.org>
parents:
diff changeset
91 notice identical to this one.
Dave Love <fx@gnu.org>
parents:
diff changeset
92
Dave Love <fx@gnu.org>
parents:
diff changeset
93 Permission is granted to copy and distribute
Dave Love <fx@gnu.org>
parents:
diff changeset
94 translations of this manual into another language,
Dave Love <fx@gnu.org>
parents:
diff changeset
95 under the above conditions for modified versions,
Dave Love <fx@gnu.org>
parents:
diff changeset
96 except that this permission notice may be stated in a
Dave Love <fx@gnu.org>
parents:
diff changeset
97 translation approved by the Free Software Foundation.
Dave Love <fx@gnu.org>
parents:
diff changeset
98
Dave Love <fx@gnu.org>
parents:
diff changeset
99 @end titlepage
Dave Love <fx@gnu.org>
parents:
diff changeset
100 @page
Dave Love <fx@gnu.org>
parents:
diff changeset
101
29772
265fdb06f294 Update to reftex 4 14
Carsten Dominik <dominik@science.uva.nl>
parents: 29713
diff changeset
102 @ifnottex
25829
Dave Love <fx@gnu.org>
parents:
diff changeset
103 @node Top,,,(dir)
Dave Love <fx@gnu.org>
parents:
diff changeset
104
Dave Love <fx@gnu.org>
parents:
diff changeset
105 @b{Ref@TeX{}} is a package for managing Labels, References,
Dave Love <fx@gnu.org>
parents:
diff changeset
106 Citations and index entries with GNU Emacs.@refill
Dave Love <fx@gnu.org>
parents:
diff changeset
107
Dave Love <fx@gnu.org>
parents:
diff changeset
108 Don't be discouraged by the size of this manual, which covers
Dave Love <fx@gnu.org>
parents:
diff changeset
109 @b{Ref@TeX{}} in great depth. All you need to know to use
Dave Love <fx@gnu.org>
parents:
diff changeset
110 @b{Ref@TeX{}} can be summarized on two pages (@pxref{RefTeX in a
Dave Love <fx@gnu.org>
parents:
diff changeset
111 Nutshell}). You can go back later to other parts of this document when
Dave Love <fx@gnu.org>
parents:
diff changeset
112 needed.@refill
Dave Love <fx@gnu.org>
parents:
diff changeset
113
Dave Love <fx@gnu.org>
parents:
diff changeset
114 @menu
Dave Love <fx@gnu.org>
parents:
diff changeset
115 * Introduction:: Quick-Start information.
Dave Love <fx@gnu.org>
parents:
diff changeset
116
Dave Love <fx@gnu.org>
parents:
diff changeset
117 * Table of Contents:: A Tool to move around quickly.
Dave Love <fx@gnu.org>
parents:
diff changeset
118 * Labels and References:: Creating and referencing labels.
Dave Love <fx@gnu.org>
parents:
diff changeset
119 * Citations:: Creating Citations.
Dave Love <fx@gnu.org>
parents:
diff changeset
120 * Index Support:: Creating and Checking Index Entries.
Dave Love <fx@gnu.org>
parents:
diff changeset
121 * Viewing Cross-References:: Who references or cites what?
Dave Love <fx@gnu.org>
parents:
diff changeset
122
Dave Love <fx@gnu.org>
parents:
diff changeset
123 * RefTeXs Menu:: The Ref menu in the menubar.
Dave Love <fx@gnu.org>
parents:
diff changeset
124 * Keybindings:: The default keybindings.
Dave Love <fx@gnu.org>
parents:
diff changeset
125 * Faces:: Fontification of RefTeX's buffers.
Dave Love <fx@gnu.org>
parents:
diff changeset
126 * Multifile Documents:: Document spread over many files.
Dave Love <fx@gnu.org>
parents:
diff changeset
127 * Language Support:: How to support other languages.
Dave Love <fx@gnu.org>
parents:
diff changeset
128 * Finding Files:: Included TeX files and BibTeX .bib files.
Dave Love <fx@gnu.org>
parents:
diff changeset
129 * AUCTeX:: Cooperation with AUCTeX.
Dave Love <fx@gnu.org>
parents:
diff changeset
130 * Optimizations:: When RefTeX is too slow.
Dave Love <fx@gnu.org>
parents:
diff changeset
131 * Problems and Work-Arounds:: First Aid.
Dave Love <fx@gnu.org>
parents:
diff changeset
132 * Imprint:: Author, Web-site, Thanks
Dave Love <fx@gnu.org>
parents:
diff changeset
133
Dave Love <fx@gnu.org>
parents:
diff changeset
134 * Commands:: Which are the available commands.
Dave Love <fx@gnu.org>
parents:
diff changeset
135 * Options:: How to extend and configure RefTeX.
Dave Love <fx@gnu.org>
parents:
diff changeset
136 * Keymaps and Hooks:: For customization.
Dave Love <fx@gnu.org>
parents:
diff changeset
137 * Changes:: A List of recent changes to RefTeX.
Dave Love <fx@gnu.org>
parents:
diff changeset
138
Dave Love <fx@gnu.org>
parents:
diff changeset
139 The Index
Dave Love <fx@gnu.org>
parents:
diff changeset
140
Dave Love <fx@gnu.org>
parents:
diff changeset
141 * Index:: The full index.
Dave Love <fx@gnu.org>
parents:
diff changeset
142
Dave Love <fx@gnu.org>
parents:
diff changeset
143 @detailmenu
Dave Love <fx@gnu.org>
parents:
diff changeset
144
Dave Love <fx@gnu.org>
parents:
diff changeset
145 Introduction
Dave Love <fx@gnu.org>
parents:
diff changeset
146
Dave Love <fx@gnu.org>
parents:
diff changeset
147 * Installation:: How to install and activate RefTeX.
Dave Love <fx@gnu.org>
parents:
diff changeset
148 * RefTeX in a Nutshell:: A brief summary and quick guide.
Dave Love <fx@gnu.org>
parents:
diff changeset
149
Dave Love <fx@gnu.org>
parents:
diff changeset
150 Labels and References
Dave Love <fx@gnu.org>
parents:
diff changeset
151
Dave Love <fx@gnu.org>
parents:
diff changeset
152 * Creating Labels::
Dave Love <fx@gnu.org>
parents:
diff changeset
153 * Referencing Labels::
Dave Love <fx@gnu.org>
parents:
diff changeset
154 * Builtin Label Environments:: The environments RefTeX knows about.
Dave Love <fx@gnu.org>
parents:
diff changeset
155 * Defining Label Environments:: ... and environments it doesn't.
Dave Love <fx@gnu.org>
parents:
diff changeset
156 * Reference Info:: View the label corresponding to a \ref.
Dave Love <fx@gnu.org>
parents:
diff changeset
157 * xr (LaTeX package):: References to external documents.
Dave Love <fx@gnu.org>
parents:
diff changeset
158 * varioref (LaTeX package):: How to create \vref instead of \ref.
Dave Love <fx@gnu.org>
parents:
diff changeset
159 * fancyref (LaTeX package):: How to create \fref instead of \ref.
Dave Love <fx@gnu.org>
parents:
diff changeset
160
Dave Love <fx@gnu.org>
parents:
diff changeset
161 Defining Label Environments
Dave Love <fx@gnu.org>
parents:
diff changeset
162
Dave Love <fx@gnu.org>
parents:
diff changeset
163 * Theorem and Axiom:: Defined with @code{\newenvironment}.
Dave Love <fx@gnu.org>
parents:
diff changeset
164 * Quick Equation:: When a macro sets the label type.
Dave Love <fx@gnu.org>
parents:
diff changeset
165 * Figure Wrapper:: When a macro argument is a label.
Dave Love <fx@gnu.org>
parents:
diff changeset
166 * Adding Magic Words:: Other words for other languages.
Dave Love <fx@gnu.org>
parents:
diff changeset
167 * Using \eqref:: How to switch to this AMS-LaTeX macro.
Dave Love <fx@gnu.org>
parents:
diff changeset
168 * Non-Standard Environments:: Environments without \begin and \end
Dave Love <fx@gnu.org>
parents:
diff changeset
169 * Putting it Together:: How to combine many entries.
Dave Love <fx@gnu.org>
parents:
diff changeset
170
Dave Love <fx@gnu.org>
parents:
diff changeset
171 Citations
Dave Love <fx@gnu.org>
parents:
diff changeset
172
Dave Love <fx@gnu.org>
parents:
diff changeset
173 * Creating Citations:: How to create them.
Dave Love <fx@gnu.org>
parents:
diff changeset
174 * Citation Styles:: Natbib, Harvard, Chicago and Co.
Dave Love <fx@gnu.org>
parents:
diff changeset
175 * Citation Info:: View the corresponding database entry.
Dave Love <fx@gnu.org>
parents:
diff changeset
176 * Chapterbib and Bibunits:: Multiple bibliographies in a Document.
Dave Love <fx@gnu.org>
parents:
diff changeset
177 * Citations Outside LaTeX:: How to make citations in Emails etc.
Dave Love <fx@gnu.org>
parents:
diff changeset
178
Dave Love <fx@gnu.org>
parents:
diff changeset
179 Index Support
Dave Love <fx@gnu.org>
parents:
diff changeset
180
26911
d7f536a01276 Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents: 25829
diff changeset
181 * Creating Index Entries:: Macros and completion of entries.
d7f536a01276 Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents: 25829
diff changeset
182 * 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
183 * Displaying and Editing the Index:: The index editor.
25829
Dave Love <fx@gnu.org>
parents:
diff changeset
184 * Builtin Index Macros:: The index macros RefTeX knows about.
Dave Love <fx@gnu.org>
parents:
diff changeset
185 * Defining Index Macros:: ... and macros it doesn't.
Dave Love <fx@gnu.org>
parents:
diff changeset
186
26911
d7f536a01276 Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents: 25829
diff changeset
187 The Index Phrases File
d7f536a01276 Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents: 25829
diff changeset
188
d7f536a01276 Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents: 25829
diff changeset
189 * Collecting Phrases:: Collecting from document or external.
d7f536a01276 Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents: 25829
diff changeset
190 * Consistency Checks:: Check for duplicates etc.
d7f536a01276 Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents: 25829
diff changeset
191 * Global Indexing:: The interactive indexing process.
d7f536a01276 Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents: 25829
diff changeset
192
25829
Dave Love <fx@gnu.org>
parents:
diff changeset
193 AUCTeX
Dave Love <fx@gnu.org>
parents:
diff changeset
194
Dave Love <fx@gnu.org>
parents:
diff changeset
195 * AUCTeX-RefTeX Interface:: How both packages work together
Dave Love <fx@gnu.org>
parents:
diff changeset
196 * Style Files:: AUCTeX's style files can support RefTeX
Dave Love <fx@gnu.org>
parents:
diff changeset
197 * Bib-Cite:: Hypertext reading of a document
Dave Love <fx@gnu.org>
parents:
diff changeset
198
Dave Love <fx@gnu.org>
parents:
diff changeset
199 Options, Keymaps, Hooks
Dave Love <fx@gnu.org>
parents:
diff changeset
200
Dave Love <fx@gnu.org>
parents:
diff changeset
201 * Options (Table of Contents)::
Dave Love <fx@gnu.org>
parents:
diff changeset
202 * Options (Defining Label Environments)::
Dave Love <fx@gnu.org>
parents:
diff changeset
203 * Options (Creating Labels)::
Dave Love <fx@gnu.org>
parents:
diff changeset
204 * Options (Referencing Labels)::
Dave Love <fx@gnu.org>
parents:
diff changeset
205 * Options (Creating Citations)::
Dave Love <fx@gnu.org>
parents:
diff changeset
206 * Options (Index Support)::
Dave Love <fx@gnu.org>
parents:
diff changeset
207 * Options (Viewing Cross-References)::
Dave Love <fx@gnu.org>
parents:
diff changeset
208 * Options (Finding Files)::
Dave Love <fx@gnu.org>
parents:
diff changeset
209 * Options (Optimizations)::
Dave Love <fx@gnu.org>
parents:
diff changeset
210 * Options (Fontification)::
Dave Love <fx@gnu.org>
parents:
diff changeset
211 * Options (Misc)::
Dave Love <fx@gnu.org>
parents:
diff changeset
212
Dave Love <fx@gnu.org>
parents:
diff changeset
213 @end detailmenu
Dave Love <fx@gnu.org>
parents:
diff changeset
214 @end menu
Dave Love <fx@gnu.org>
parents:
diff changeset
215
29772
265fdb06f294 Update to reftex 4 14
Carsten Dominik <dominik@science.uva.nl>
parents: 29713
diff changeset
216 @end ifnottex
25829
Dave Love <fx@gnu.org>
parents:
diff changeset
217
Dave Love <fx@gnu.org>
parents:
diff changeset
218 @node Introduction, Table of Contents, , Top
Dave Love <fx@gnu.org>
parents:
diff changeset
219 @chapter Introduction
Dave Love <fx@gnu.org>
parents:
diff changeset
220 @cindex Introduction
Dave Love <fx@gnu.org>
parents:
diff changeset
221
Dave Love <fx@gnu.org>
parents:
diff changeset
222 @b{Ref@TeX{}} is a specialized package for support of labels,
Dave Love <fx@gnu.org>
parents:
diff changeset
223 references, citations, and the index in LaTeX. @b{Ref@TeX{}} wraps
Dave Love <fx@gnu.org>
parents:
diff changeset
224 itself round 4 LaTeX macros: @code{\label}, @code{\ref}, @code{\cite},
Dave Love <fx@gnu.org>
parents:
diff changeset
225 and @code{\index}. Using these macros usually requires looking up
Dave Love <fx@gnu.org>
parents:
diff changeset
226 different parts of the document and searching through BibTeX database
Dave Love <fx@gnu.org>
parents:
diff changeset
227 files. @b{Ref@TeX{}} automates these time--consuming tasks almost
Dave Love <fx@gnu.org>
parents:
diff changeset
228 entirely. It also provides functions to display the structure of a
Dave Love <fx@gnu.org>
parents:
diff changeset
229 document and to move around in this structure quickly.@refill
Dave Love <fx@gnu.org>
parents:
diff changeset
230
Dave Love <fx@gnu.org>
parents:
diff changeset
231 @iftex
Dave Love <fx@gnu.org>
parents:
diff changeset
232 Don't be discouraged by the size of this manual, which covers @b{Ref@TeX{}}
Dave Love <fx@gnu.org>
parents:
diff changeset
233 in great depth. All you need to know to use @b{Ref@TeX{}} can be
Dave Love <fx@gnu.org>
parents:
diff changeset
234 summarized on two pages (@pxref{RefTeX in a Nutshell}). You can go
Dave Love <fx@gnu.org>
parents:
diff changeset
235 back later to other parts of this document when needed.
Dave Love <fx@gnu.org>
parents:
diff changeset
236 @end iftex
Dave Love <fx@gnu.org>
parents:
diff changeset
237
Dave Love <fx@gnu.org>
parents:
diff changeset
238 @xref{Imprint}, for information about who to contact for help, bug
Dave Love <fx@gnu.org>
parents:
diff changeset
239 reports or suggestions.
Dave Love <fx@gnu.org>
parents:
diff changeset
240
Dave Love <fx@gnu.org>
parents:
diff changeset
241 @menu
Dave Love <fx@gnu.org>
parents:
diff changeset
242 * Installation:: How to install and activate RefTeX.
Dave Love <fx@gnu.org>
parents:
diff changeset
243 * RefTeX in a Nutshell:: A brief summary and quick guide.
Dave Love <fx@gnu.org>
parents:
diff changeset
244 @end menu
Dave Love <fx@gnu.org>
parents:
diff changeset
245
Dave Love <fx@gnu.org>
parents:
diff changeset
246 @node Installation, RefTeX in a Nutshell, , Introduction
Dave Love <fx@gnu.org>
parents:
diff changeset
247 @section Installation
Dave Love <fx@gnu.org>
parents:
diff changeset
248 @cindex Installation
Dave Love <fx@gnu.org>
parents:
diff changeset
249
Dave Love <fx@gnu.org>
parents:
diff changeset
250 @b{Ref@TeX{}} is bundled and pre--installed with Emacs since version 20.2.
Dave Love <fx@gnu.org>
parents:
diff changeset
251 It was also bundled and pre--installed with XEmacs 19.16--20.x. XEmacs
Dave Love <fx@gnu.org>
parents:
diff changeset
252 21.x users want to install the corresponding plug-in package which is
Dave Love <fx@gnu.org>
parents:
diff changeset
253 available from the
Dave Love <fx@gnu.org>
parents:
diff changeset
254 @uref{ftp://ftp.xemacs.org/pub/xemacs/packages/,XEmacs ftp site}. See
Dave Love <fx@gnu.org>
parents:
diff changeset
255 the XEmacs 21.x documentation on package installation for
Dave Love <fx@gnu.org>
parents:
diff changeset
256 details.@refill
Dave Love <fx@gnu.org>
parents:
diff changeset
257
Dave Love <fx@gnu.org>
parents:
diff changeset
258 Users of earlier Emacs distributions (including Emacs 19) can get a copy
Dave Love <fx@gnu.org>
parents:
diff changeset
259 of the @b{Ref@TeX{}} distribution from the maintainers web-page.
Dave Love <fx@gnu.org>
parents:
diff changeset
260 @xref{Imprint}, for more information.@refill
Dave Love <fx@gnu.org>
parents:
diff changeset
261
Dave Love <fx@gnu.org>
parents:
diff changeset
262 @section Environment
Dave Love <fx@gnu.org>
parents:
diff changeset
263 @cindex Finding files
Dave Love <fx@gnu.org>
parents:
diff changeset
264 @cindex BibTeX database files, not found
Dave Love <fx@gnu.org>
parents:
diff changeset
265 @cindex TeX files, not found
Dave Love <fx@gnu.org>
parents:
diff changeset
266 @cindex @code{TEXINPUTS}, environment variable
Dave Love <fx@gnu.org>
parents:
diff changeset
267 @cindex @code{BIBINPUTS}, environment variable
Dave Love <fx@gnu.org>
parents:
diff changeset
268
Dave Love <fx@gnu.org>
parents:
diff changeset
269 @b{Ref@TeX{}} needs to access all files which are part of a multifile
Dave Love <fx@gnu.org>
parents:
diff changeset
270 document, and the BibTeX database files requested by the
Dave Love <fx@gnu.org>
parents:
diff changeset
271 @code{\bibliography} command. To find these files, @b{Ref@TeX{}} will
Dave Love <fx@gnu.org>
parents:
diff changeset
272 require a search path, i.e. a list of directories to check. Normally
Dave Love <fx@gnu.org>
parents:
diff changeset
273 this list is stored in the environment variables @code{TEXINPUTS} and
Dave Love <fx@gnu.org>
parents:
diff changeset
274 @code{BIBINPUTS} which are also used by @b{Ref@TeX{}}. However, on some
Dave Love <fx@gnu.org>
parents:
diff changeset
275 systems these variables do not contain the full search path. If
Dave Love <fx@gnu.org>
parents:
diff changeset
276 @b{Ref@TeX{}} does not work for you because it cannot find some files,
Dave Love <fx@gnu.org>
parents:
diff changeset
277 read @ref{Finding Files}.
Dave Love <fx@gnu.org>
parents:
diff changeset
278
Dave Love <fx@gnu.org>
parents:
diff changeset
279 @section Entering @b{Ref@TeX{}} Mode
Dave Love <fx@gnu.org>
parents:
diff changeset
280
Dave Love <fx@gnu.org>
parents:
diff changeset
281 @findex turn-on-reftex
Dave Love <fx@gnu.org>
parents:
diff changeset
282 @findex reftex-mode
Dave Love <fx@gnu.org>
parents:
diff changeset
283 @vindex LaTeX-mode-hook
Dave Love <fx@gnu.org>
parents:
diff changeset
284 @vindex latex-mode-hook
Dave Love <fx@gnu.org>
parents:
diff changeset
285 To turn @b{Ref@TeX{}} Mode on and off in a particular buffer, use
Dave Love <fx@gnu.org>
parents:
diff changeset
286 @kbd{M-x reftex-mode}. To turn on @b{Ref@TeX{}} Mode for all LaTeX
Dave Love <fx@gnu.org>
parents:
diff changeset
287 files, add the following lines to your @file{.emacs} file:@refill
Dave Love <fx@gnu.org>
parents:
diff changeset
288
Dave Love <fx@gnu.org>
parents:
diff changeset
289 @example
Dave Love <fx@gnu.org>
parents:
diff changeset
290 (add-hook 'LaTeX-mode-hook 'turn-on-reftex) ; with AUCTeX LaTeX mode
Dave Love <fx@gnu.org>
parents:
diff changeset
291 (add-hook 'latex-mode-hook 'turn-on-reftex) ; with Emacs latex mode
Dave Love <fx@gnu.org>
parents:
diff changeset
292 @end example
Dave Love <fx@gnu.org>
parents:
diff changeset
293
Dave Love <fx@gnu.org>
parents:
diff changeset
294 @page
Dave Love <fx@gnu.org>
parents:
diff changeset
295 @node RefTeX in a Nutshell, , Installation, Introduction
Dave Love <fx@gnu.org>
parents:
diff changeset
296 @section @b{Ref@TeX{}} in a Nutshell
Dave Love <fx@gnu.org>
parents:
diff changeset
297 @cindex Quick-Start
Dave Love <fx@gnu.org>
parents:
diff changeset
298 @cindex Getting Started
Dave Love <fx@gnu.org>
parents:
diff changeset
299 @cindex RefTeX in a Nutshell
Dave Love <fx@gnu.org>
parents:
diff changeset
300 @cindex Nutshell, RefTeX in a
Dave Love <fx@gnu.org>
parents:
diff changeset
301
Dave Love <fx@gnu.org>
parents:
diff changeset
302 @enumerate
Dave Love <fx@gnu.org>
parents:
diff changeset
303 @item
Dave Love <fx@gnu.org>
parents:
diff changeset
304 @b{Table of Contents}@* Typing @kbd{C-c =} (@code{reftex-toc}) will show
Dave Love <fx@gnu.org>
parents:
diff changeset
305 a table of contents of the document. This buffer can display sections,
Dave Love <fx@gnu.org>
parents:
diff changeset
306 labels and index entries defined in the document. From the buffer, you
Dave Love <fx@gnu.org>
parents:
diff changeset
307 can jump quickly to every part of your document. Press @kbd{?} to get
Dave Love <fx@gnu.org>
parents:
diff changeset
308 help.@refill
Dave Love <fx@gnu.org>
parents:
diff changeset
309
Dave Love <fx@gnu.org>
parents:
diff changeset
310 @item
Dave Love <fx@gnu.org>
parents:
diff changeset
311 @b{Labels and References}@* @b{Ref@TeX{}} helps to create unique labels
Dave Love <fx@gnu.org>
parents:
diff changeset
312 and to find the correct key for references quickly. It distinguishes
Dave Love <fx@gnu.org>
parents:
diff changeset
313 labels for different environments, knows about all standard
Dave Love <fx@gnu.org>
parents:
diff changeset
314 environments (and many others), and can be configured to recognize any
Dave Love <fx@gnu.org>
parents:
diff changeset
315 additional labeled environments you have defined yourself (variable
Dave Love <fx@gnu.org>
parents:
diff changeset
316 @code{reftex-label-alist}).@refill
Dave Love <fx@gnu.org>
parents:
diff changeset
317
Dave Love <fx@gnu.org>
parents:
diff changeset
318 @itemize @bullet
Dave Love <fx@gnu.org>
parents:
diff changeset
319 @item
Dave Love <fx@gnu.org>
parents:
diff changeset
320 @b{Creating Labels}@*
Dave Love <fx@gnu.org>
parents:
diff changeset
321 Type @kbd{C-c (} (@code{reftex-label}) to insert a label at point.
Dave Love <fx@gnu.org>
parents:
diff changeset
322 @b{Ref@TeX{}} will either
Dave Love <fx@gnu.org>
parents:
diff changeset
323 @itemize @minus
Dave Love <fx@gnu.org>
parents:
diff changeset
324 @item
Dave Love <fx@gnu.org>
parents:
diff changeset
325 derive a label from context (default for section labels)
Dave Love <fx@gnu.org>
parents:
diff changeset
326 @item
Dave Love <fx@gnu.org>
parents:
diff changeset
327 prompt for a label string (default for figures and tables) or
Dave Love <fx@gnu.org>
parents:
diff changeset
328 @item
Dave Love <fx@gnu.org>
parents:
diff changeset
329 insert a simple label made of a prefix and a number (all other
Dave Love <fx@gnu.org>
parents:
diff changeset
330 environments)@refill
Dave Love <fx@gnu.org>
parents:
diff changeset
331 @end itemize
Dave Love <fx@gnu.org>
parents:
diff changeset
332 @noindent
Dave Love <fx@gnu.org>
parents:
diff changeset
333 Which labels are created how is configurable with the variable
Dave Love <fx@gnu.org>
parents:
diff changeset
334 @code{reftex-insert-label-flags}.@refill
Dave Love <fx@gnu.org>
parents:
diff changeset
335
Dave Love <fx@gnu.org>
parents:
diff changeset
336 @item
Dave Love <fx@gnu.org>
parents:
diff changeset
337 @b{Referencing Labels}@* To make a reference, type @kbd{C-c )}
Dave Love <fx@gnu.org>
parents:
diff changeset
338 (@code{reftex-reference}). This shows an outline of the document with
Dave Love <fx@gnu.org>
parents:
diff changeset
339 all labels of a certain type (figure, equation,...) and some label
Dave Love <fx@gnu.org>
parents:
diff changeset
340 context. Selecting a label inserts a @code{\ref@{@var{label}@}} macro
Dave Love <fx@gnu.org>
parents:
diff changeset
341 into the original buffer.@refill
Dave Love <fx@gnu.org>
parents:
diff changeset
342 @end itemize
Dave Love <fx@gnu.org>
parents:
diff changeset
343
Dave Love <fx@gnu.org>
parents:
diff changeset
344 @item
Dave Love <fx@gnu.org>
parents:
diff changeset
345 @b{Citations}@*
Dave Love <fx@gnu.org>
parents:
diff changeset
346 Typing @kbd{C-c [} (@code{reftex-citation}) will let you specify a
Dave Love <fx@gnu.org>
parents:
diff changeset
347 regular expression to search in current BibTeX database files (as
Dave Love <fx@gnu.org>
parents:
diff changeset
348 specified in the @code{\bibliography} command) and pull out a list of
Dave Love <fx@gnu.org>
parents:
diff changeset
349 matches for you to choose from. The list is @emph{formatted} and
Dave Love <fx@gnu.org>
parents:
diff changeset
350 sorted. The selected article is referenced as @samp{\cite@{@var{key}@}}
Dave Love <fx@gnu.org>
parents:
diff changeset
351 (see the variable @code{reftex-cite-format} if you want to insert
Dave Love <fx@gnu.org>
parents:
diff changeset
352 different macros).@refill
Dave Love <fx@gnu.org>
parents:
diff changeset
353
Dave Love <fx@gnu.org>
parents:
diff changeset
354 @item
Dave Love <fx@gnu.org>
parents:
diff changeset
355 @b{Index Support}@*
Dave Love <fx@gnu.org>
parents:
diff changeset
356 @b{Ref@TeX{}} helps to enter index entries. It also compiles all
Dave Love <fx@gnu.org>
parents:
diff changeset
357 entries into an alphabetically sorted @file{*Index*} buffer which you
Dave Love <fx@gnu.org>
parents:
diff changeset
358 can use to check and edit the entries. @b{Ref@TeX{}} knows about the
Dave Love <fx@gnu.org>
parents:
diff changeset
359 standard index macros and can be configured to recognize any additional
Dave Love <fx@gnu.org>
parents:
diff changeset
360 macros you have defined (@code{reftex-index-macros}). Multiple indices
Dave Love <fx@gnu.org>
parents:
diff changeset
361 are supported.@refill
Dave Love <fx@gnu.org>
parents:
diff changeset
362
Dave Love <fx@gnu.org>
parents:
diff changeset
363 @itemize @bullet
Dave Love <fx@gnu.org>
parents:
diff changeset
364 @item
Dave Love <fx@gnu.org>
parents:
diff changeset
365 @b{Creating Index Entries}@*
26911
d7f536a01276 Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents: 25829
diff changeset
366 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
367 (@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
368 @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
369 type @kbd{C-c <} (@code{reftex-index}), select any of the index macros
d7f536a01276 Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents: 25829
diff changeset
370 and enter the arguments with completion.@refill
d7f536a01276 Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents: 25829
diff changeset
371
d7f536a01276 Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents: 25829
diff changeset
372 @item
d7f536a01276 Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents: 25829
diff changeset
373 @b{The Index Phrases File (Delayed Indexing)}@*
d7f536a01276 Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents: 25829
diff changeset
374 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
375 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
376 @b{Ref@TeX{}} can later search the document for occurrences of these
d7f536a01276 Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents: 25829
diff changeset
377 phrases and let you interactively index the matches.@refill
d7f536a01276 Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents: 25829
diff changeset
378
d7f536a01276 Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents: 25829
diff changeset
379 @item
d7f536a01276 Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents: 25829
diff changeset
380 @b{Displaying and Editing the Index}@*
d7f536a01276 Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents: 25829
diff changeset
381 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
382 (@code{reftex-display-index}). From that buffer you can check and edit
d7f536a01276 Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents: 25829
diff changeset
383 all entries.@refill
25829
Dave Love <fx@gnu.org>
parents:
diff changeset
384 @end itemize
Dave Love <fx@gnu.org>
parents:
diff changeset
385
Dave Love <fx@gnu.org>
parents:
diff changeset
386 @page
Dave Love <fx@gnu.org>
parents:
diff changeset
387 @item @b{Viewing Cross-References}@*
Dave Love <fx@gnu.org>
parents:
diff changeset
388 When point is on the @var{key} argument of a cross--referencing macro
Dave Love <fx@gnu.org>
parents:
diff changeset
389 (@code{\label}, @code{\ref}, @code{\cite}, @code{\bibitem},
Dave Love <fx@gnu.org>
parents:
diff changeset
390 @code{\index}, and variations) or inside a BibTeX database entry, you
Dave Love <fx@gnu.org>
parents:
diff changeset
391 can press @kbd{C-c &} (@code{reftex-view-crossref}) to display
Dave Love <fx@gnu.org>
parents:
diff changeset
392 corresponding locations in the document and associated BibTeX database
26911
d7f536a01276 Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents: 25829
diff changeset
393 files.@refill @*
d7f536a01276 Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents: 25829
diff changeset
394 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
395 message occupies the echo area, information about the citation or label
d7f536a01276 Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents: 25829
diff changeset
396 will automatically be displayed in the echo area.@refill
25829
Dave Love <fx@gnu.org>
parents:
diff changeset
397
Dave Love <fx@gnu.org>
parents:
diff changeset
398 @item
Dave Love <fx@gnu.org>
parents:
diff changeset
399 @b{Multifile Documents}@*
Dave Love <fx@gnu.org>
parents:
diff changeset
400 Multifile Documents are fully supported. The included files must have a
Dave Love <fx@gnu.org>
parents:
diff changeset
401 file variable @code{TeX-master} or @code{tex-main-file} pointing to the
Dave Love <fx@gnu.org>
parents:
diff changeset
402 master file. @b{Ref@TeX{}} provides cross-referencing information from
Dave Love <fx@gnu.org>
parents:
diff changeset
403 all parts of the document, and across document borders
Dave Love <fx@gnu.org>
parents:
diff changeset
404 (@file{xr.sty}).@refill
Dave Love <fx@gnu.org>
parents:
diff changeset
405
Dave Love <fx@gnu.org>
parents:
diff changeset
406 @item
Dave Love <fx@gnu.org>
parents:
diff changeset
407 @b{Document Parsing}@* @b{Ref@TeX{}} needs to parse the document in
Dave Love <fx@gnu.org>
parents:
diff changeset
408 order to find labels and other information. It does it automatically
Dave Love <fx@gnu.org>
parents:
diff changeset
409 once and updates its list internally when @code{reftex-label} and
Dave Love <fx@gnu.org>
parents:
diff changeset
410 @code{reftex-index} are used. To enforce reparsing, call any of the
Dave Love <fx@gnu.org>
parents:
diff changeset
411 commands described above with a raw @kbd{C-u} prefix, or press the
Dave Love <fx@gnu.org>
parents:
diff changeset
412 @kbd{r} key in the label selection buffer, the table of contents
Dave Love <fx@gnu.org>
parents:
diff changeset
413 buffer, or the index buffer.@refill
Dave Love <fx@gnu.org>
parents:
diff changeset
414
Dave Love <fx@gnu.org>
parents:
diff changeset
415 @item
Dave Love <fx@gnu.org>
parents:
diff changeset
416 @b{AUCTeX} @* If your major LaTeX mode is AUCTeX, @b{Ref@TeX{}} can
Dave Love <fx@gnu.org>
parents:
diff changeset
417 cooperate with it (see variable @code{reftex-plug-into-AUCTeX}). AUCTeX
Dave Love <fx@gnu.org>
parents:
diff changeset
418 contains style files which trigger appropriate settings in
Dave Love <fx@gnu.org>
parents:
diff changeset
419 @b{Ref@TeX{}}, so that for many of the popular LaTeX packages no
Dave Love <fx@gnu.org>
parents:
diff changeset
420 additional customizations will be necessary.@refill
Dave Love <fx@gnu.org>
parents:
diff changeset
421
Dave Love <fx@gnu.org>
parents:
diff changeset
422 @item
Dave Love <fx@gnu.org>
parents:
diff changeset
423 @b{Useful Settings}@* To make @b{Ref@TeX{}} faster for large documents,
Dave Love <fx@gnu.org>
parents:
diff changeset
424 try these:@refill
Dave Love <fx@gnu.org>
parents:
diff changeset
425 @lisp
Dave Love <fx@gnu.org>
parents:
diff changeset
426 (setq reftex-enable-partial-scans t)
Dave Love <fx@gnu.org>
parents:
diff changeset
427 (setq reftex-save-parse-info t)
Dave Love <fx@gnu.org>
parents:
diff changeset
428 (setq reftex-use-multiple-selection-buffers t)
Dave Love <fx@gnu.org>
parents:
diff changeset
429 @end lisp
Dave Love <fx@gnu.org>
parents:
diff changeset
430
Dave Love <fx@gnu.org>
parents:
diff changeset
431 To integrate with AUCTeX, use
Dave Love <fx@gnu.org>
parents:
diff changeset
432 @lisp
Dave Love <fx@gnu.org>
parents:
diff changeset
433 (setq reftex-plug-into-AUCTeX t)
Dave Love <fx@gnu.org>
parents:
diff changeset
434 @end lisp
Dave Love <fx@gnu.org>
parents:
diff changeset
435
Dave Love <fx@gnu.org>
parents:
diff changeset
436 To make your own LaTeX macro definitions known to @b{Ref@TeX{}},
Dave Love <fx@gnu.org>
parents:
diff changeset
437 customize the variables@refill
Dave Love <fx@gnu.org>
parents:
diff changeset
438 @example
Dave Love <fx@gnu.org>
parents:
diff changeset
439 @code{reftex-label-alist} @r{(for label macros/environments)}
Dave Love <fx@gnu.org>
parents:
diff changeset
440 @code{reftex-section-levels} @r{(for sectioning commands)}
Dave Love <fx@gnu.org>
parents:
diff changeset
441 @code{reftex-cite-format} @r{(for @code{\cite}-like macros)}
Dave Love <fx@gnu.org>
parents:
diff changeset
442 @code{reftex-index-macros} @r{(for @code{\index}-like macros)}
Dave Love <fx@gnu.org>
parents:
diff changeset
443 @code{reftex-index-default-macro} @r{(to set the default macro)}
Dave Love <fx@gnu.org>
parents:
diff changeset
444 @end example
Dave Love <fx@gnu.org>
parents:
diff changeset
445 If you have a large number of macros defined, you may want to write
Dave Love <fx@gnu.org>
parents:
diff changeset
446 an AUCTeX style file to support them with both AUCTeX and
Dave Love <fx@gnu.org>
parents:
diff changeset
447 @b{Ref@TeX{}}.@refill
Dave Love <fx@gnu.org>
parents:
diff changeset
448
Dave Love <fx@gnu.org>
parents:
diff changeset
449 @item @b{Where Next?}@* Go ahead and use @b{Ref@TeX{}}. Use its menus
Dave Love <fx@gnu.org>
parents:
diff changeset
450 until you have picked up the key bindings. For an overview of what you
Dave Love <fx@gnu.org>
parents:
diff changeset
451 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
452 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
453 available. The first part of the manual explains in
25829
Dave Love <fx@gnu.org>
parents:
diff changeset
454 a tutorial way how to use and customize @b{Ref@TeX{}}. The second
Dave Love <fx@gnu.org>
parents:
diff changeset
455 part is a command and variable reference.@refill
Dave Love <fx@gnu.org>
parents:
diff changeset
456 @end enumerate
Dave Love <fx@gnu.org>
parents:
diff changeset
457
Dave Love <fx@gnu.org>
parents:
diff changeset
458 @node Table of Contents, Labels and References, Introduction, Top
Dave Love <fx@gnu.org>
parents:
diff changeset
459 @chapter Table of Contents
Dave Love <fx@gnu.org>
parents:
diff changeset
460 @cindex @file{*toc*} buffer
Dave Love <fx@gnu.org>
parents:
diff changeset
461 @cindex Table of contents buffer
Dave Love <fx@gnu.org>
parents:
diff changeset
462 @findex reftex-toc
Dave Love <fx@gnu.org>
parents:
diff changeset
463 @kindex C-c =
Dave Love <fx@gnu.org>
parents:
diff changeset
464
Dave Love <fx@gnu.org>
parents:
diff changeset
465 Pressing the keys @kbd{C-c =} pops up a buffer showing the table of
Dave Love <fx@gnu.org>
parents:
diff changeset
466 contents of the document. By default, this @file{*toc*} buffer shows
Dave Love <fx@gnu.org>
parents:
diff changeset
467 only the sections of a document. Using the @kbd{l} and @kbd{i} keys you
Dave Love <fx@gnu.org>
parents:
diff changeset
468 can display all labels and index entries defined in the document as
Dave Love <fx@gnu.org>
parents:
diff changeset
469 well.@refill
Dave Love <fx@gnu.org>
parents:
diff changeset
470
Dave Love <fx@gnu.org>
parents:
diff changeset
471 With the cursor in any of the lines denoting a location in the
Dave Love <fx@gnu.org>
parents:
diff changeset
472 document, simple key strokes will display the corresponding part in
Dave Love <fx@gnu.org>
parents:
diff changeset
473 another window, jump to that location, or perform other actions.@refill
Dave Love <fx@gnu.org>
parents:
diff changeset
474
Dave Love <fx@gnu.org>
parents:
diff changeset
475 @kindex ?
Dave Love <fx@gnu.org>
parents:
diff changeset
476 Here is a list of special commands in the @file{*toc*} buffer. A
Dave Love <fx@gnu.org>
parents:
diff changeset
477 summary of this information is always available by pressing
Dave Love <fx@gnu.org>
parents:
diff changeset
478 @kbd{?}.@refill
Dave Love <fx@gnu.org>
parents:
diff changeset
479
Dave Love <fx@gnu.org>
parents:
diff changeset
480 @table @kbd
Dave Love <fx@gnu.org>
parents:
diff changeset
481
Dave Love <fx@gnu.org>
parents:
diff changeset
482 @tablesubheading{General}
Dave Love <fx@gnu.org>
parents:
diff changeset
483 @item ?
Dave Love <fx@gnu.org>
parents:
diff changeset
484 Display a summary of commands.
Dave Love <fx@gnu.org>
parents:
diff changeset
485
Dave Love <fx@gnu.org>
parents:
diff changeset
486 @item 0-9, -
Dave Love <fx@gnu.org>
parents:
diff changeset
487 Prefix argument.
Dave Love <fx@gnu.org>
parents:
diff changeset
488
Dave Love <fx@gnu.org>
parents:
diff changeset
489 @tablesubheading{Moving around}
Dave Love <fx@gnu.org>
parents:
diff changeset
490 @item n
Dave Love <fx@gnu.org>
parents:
diff changeset
491 Goto next entry in the table of context.
Dave Love <fx@gnu.org>
parents:
diff changeset
492
Dave Love <fx@gnu.org>
parents:
diff changeset
493 @item p
Dave Love <fx@gnu.org>
parents:
diff changeset
494 Goto previous entry in the table of context.
Dave Love <fx@gnu.org>
parents:
diff changeset
495
Dave Love <fx@gnu.org>
parents:
diff changeset
496 @item C-c C-n
Dave Love <fx@gnu.org>
parents:
diff changeset
497 Goto next section heading. Useful when many labels and index entries
Dave Love <fx@gnu.org>
parents:
diff changeset
498 separate section headings.@refill
Dave Love <fx@gnu.org>
parents:
diff changeset
499
Dave Love <fx@gnu.org>
parents:
diff changeset
500 @item C-c C-p
Dave Love <fx@gnu.org>
parents:
diff changeset
501 Goto previous section heading.
Dave Love <fx@gnu.org>
parents:
diff changeset
502
Dave Love <fx@gnu.org>
parents:
diff changeset
503 @tablesubheading{Access to document locations}
Dave Love <fx@gnu.org>
parents:
diff changeset
504 @item @key{SPC}
Dave Love <fx@gnu.org>
parents:
diff changeset
505 Show the corresponding location in another window. This command does
Dave Love <fx@gnu.org>
parents:
diff changeset
506 @emph{not} select that other window.@refill
Dave Love <fx@gnu.org>
parents:
diff changeset
507
Dave Love <fx@gnu.org>
parents:
diff changeset
508 @item @key{TAB}
Dave Love <fx@gnu.org>
parents:
diff changeset
509 Goto the location in another window.
Dave Love <fx@gnu.org>
parents:
diff changeset
510
Dave Love <fx@gnu.org>
parents:
diff changeset
511 @item @key{RET}
Dave Love <fx@gnu.org>
parents:
diff changeset
512 Go to the location and hide the @file{*toc*} buffer. This will restore
Dave Love <fx@gnu.org>
parents:
diff changeset
513 the window configuration before @code{reftex-toc} (@kbd{C-c =}) was
Dave Love <fx@gnu.org>
parents:
diff changeset
514 called.@refill
Dave Love <fx@gnu.org>
parents:
diff changeset
515
Dave Love <fx@gnu.org>
parents:
diff changeset
516 @item mouse-2
Dave Love <fx@gnu.org>
parents:
diff changeset
517 @vindex reftex-highlight-selection
Dave Love <fx@gnu.org>
parents:
diff changeset
518 Clicking with mouse button 2 on a line has the same effect as @key{RET}.
Dave Love <fx@gnu.org>
parents:
diff changeset
519 See also variable @code{reftex-highlight-selection}, @ref{Options
Dave Love <fx@gnu.org>
parents:
diff changeset
520 (Fontification)}.@refill
Dave Love <fx@gnu.org>
parents:
diff changeset
521
Dave Love <fx@gnu.org>
parents:
diff changeset
522 @item f
Dave Love <fx@gnu.org>
parents:
diff changeset
523 @vindex reftex-toc-follow-mode
Dave Love <fx@gnu.org>
parents:
diff changeset
524 @vindex reftex-revisit-to-follow
Dave Love <fx@gnu.org>
parents:
diff changeset
525 Toggle follow mode. When follow mode is active, the other window will
Dave Love <fx@gnu.org>
parents:
diff changeset
526 always show the location corresponding to the line at point in the
Dave Love <fx@gnu.org>
parents:
diff changeset
527 @file{*toc*} buffer. This is similar to pressing @key{SPC} after each
Dave Love <fx@gnu.org>
parents:
diff changeset
528 cursor motion. The default for this flag can be set with the variable
Dave Love <fx@gnu.org>
parents:
diff changeset
529 @code{reftex-toc-follow-mode}. Note that only context in files already
Dave Love <fx@gnu.org>
parents:
diff changeset
530 visited is shown. @b{Ref@TeX{}} will not visit a file just for follow
Dave Love <fx@gnu.org>
parents:
diff changeset
531 mode. See, however, the variable
Dave Love <fx@gnu.org>
parents:
diff changeset
532 @code{reftex-revisit-to-follow}.@refill
Dave Love <fx@gnu.org>
parents:
diff changeset
533
Dave Love <fx@gnu.org>
parents:
diff changeset
534 @item .
Dave Love <fx@gnu.org>
parents:
diff changeset
535 Show calling point in another window. This is the point from where
Dave Love <fx@gnu.org>
parents:
diff changeset
536 @code{reftex-toc} was last called.
Dave Love <fx@gnu.org>
parents:
diff changeset
537
Dave Love <fx@gnu.org>
parents:
diff changeset
538 @tablesubheading{Exiting}
Dave Love <fx@gnu.org>
parents:
diff changeset
539 @item q
Dave Love <fx@gnu.org>
parents:
diff changeset
540 Hide the @file{*toc*} buffer, return to the position where
Dave Love <fx@gnu.org>
parents:
diff changeset
541 @code{reftex-toc} was last called.@refill
Dave Love <fx@gnu.org>
parents:
diff changeset
542
Dave Love <fx@gnu.org>
parents:
diff changeset
543 @item k
Dave Love <fx@gnu.org>
parents:
diff changeset
544 Kill the @file{*toc*} buffer, return to the position where
Dave Love <fx@gnu.org>
parents:
diff changeset
545 @code{reftex-toc} was last called.@refill
Dave Love <fx@gnu.org>
parents:
diff changeset
546
Dave Love <fx@gnu.org>
parents:
diff changeset
547 @item C-c >
Dave Love <fx@gnu.org>
parents:
diff changeset
548 Switch to the @file{*Index*} buffer of this document. With prefix
Dave Love <fx@gnu.org>
parents:
diff changeset
549 @samp{2}, restrict the index to the section at point in the @file{*toc*}
Dave Love <fx@gnu.org>
parents:
diff changeset
550 buffer.
Dave Love <fx@gnu.org>
parents:
diff changeset
551
Dave Love <fx@gnu.org>
parents:
diff changeset
552 @tablesubheading{Controlling what gets displayed}
Dave Love <fx@gnu.org>
parents:
diff changeset
553
26911
d7f536a01276 Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents: 25829
diff changeset
554 @item t
d7f536a01276 Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents: 25829
diff changeset
555 @vindex reftex-toc-max-level
d7f536a01276 Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents: 25829
diff changeset
556 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
557 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
558 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
559 @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
560 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
561 depth can be configured with the variable
d7f536a01276 Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents: 25829
diff changeset
562 @code{reftex-toc-max-level}.@refill
d7f536a01276 Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents: 25829
diff changeset
563
25829
Dave Love <fx@gnu.org>
parents:
diff changeset
564 @item F
Dave Love <fx@gnu.org>
parents:
diff changeset
565 @vindex reftex-toc-include-file-boundaries
Dave Love <fx@gnu.org>
parents:
diff changeset
566 Toggle the display of the file borders of a multifile document in the
Dave Love <fx@gnu.org>
parents:
diff changeset
567 @file{*toc*} buffer. The default for this flag can be set with the
Dave Love <fx@gnu.org>
parents:
diff changeset
568 variable @code{reftex-toc-include-file-boundaries}.@refill
Dave Love <fx@gnu.org>
parents:
diff changeset
569
Dave Love <fx@gnu.org>
parents:
diff changeset
570 @item l
Dave Love <fx@gnu.org>
parents:
diff changeset
571 @vindex reftex-toc-include-labels
Dave Love <fx@gnu.org>
parents:
diff changeset
572 Toggle the display of labels in the @file{*toc*} buffer. The default
Dave Love <fx@gnu.org>
parents:
diff changeset
573 for this flag can be set with the variable
Dave Love <fx@gnu.org>
parents:
diff changeset
574 @code{reftex-toc-include-labels}. When called with a prefix argument,
Dave Love <fx@gnu.org>
parents:
diff changeset
575 @b{Ref@TeX{}} will prompt for a label type and include only labels of
Dave Love <fx@gnu.org>
parents:
diff changeset
576 the selected type in the @file{*toc*} buffer. The mode line @samp{L<>}
Dave Love <fx@gnu.org>
parents:
diff changeset
577 indicator shows which labels are included.@refill
Dave Love <fx@gnu.org>
parents:
diff changeset
578
Dave Love <fx@gnu.org>
parents:
diff changeset
579 @item i
Dave Love <fx@gnu.org>
parents:
diff changeset
580 @vindex reftex-toc-include-index-entries
Dave Love <fx@gnu.org>
parents:
diff changeset
581 Toggle the display of index entries in the @file{*toc*} buffer. The
Dave Love <fx@gnu.org>
parents:
diff changeset
582 default for this flag can be set with the variable
Dave Love <fx@gnu.org>
parents:
diff changeset
583 @code{reftex-toc-include-index-entries}. When called with a prefix
Dave Love <fx@gnu.org>
parents:
diff changeset
584 argument, @b{Ref@TeX{}} will prompt for a specific index and include
Dave Love <fx@gnu.org>
parents:
diff changeset
585 only entries in the selected index in the @file{*toc*} buffer. The mode
Dave Love <fx@gnu.org>
parents:
diff changeset
586 line @samp{I<>} indicator shows which index is used.@refill
Dave Love <fx@gnu.org>
parents:
diff changeset
587
Dave Love <fx@gnu.org>
parents:
diff changeset
588 @item c
Dave Love <fx@gnu.org>
parents:
diff changeset
589 @vindex reftex-toc-include-context
Dave Love <fx@gnu.org>
parents:
diff changeset
590 Toggle the display of label and index context in the @file{*toc*}
Dave Love <fx@gnu.org>
parents:
diff changeset
591 buffer. The default for this flag can be set with the variable
Dave Love <fx@gnu.org>
parents:
diff changeset
592 @code{reftex-toc-include-context}.@refill
Dave Love <fx@gnu.org>
parents:
diff changeset
593
Dave Love <fx@gnu.org>
parents:
diff changeset
594 @tablesubheading{Updating the buffer}
Dave Love <fx@gnu.org>
parents:
diff changeset
595
Dave Love <fx@gnu.org>
parents:
diff changeset
596 @item g
Dave Love <fx@gnu.org>
parents:
diff changeset
597 Rebuild the @file{*toc*} buffer. This does @emph{not} rescan the
Dave Love <fx@gnu.org>
parents:
diff changeset
598 document.@refill
Dave Love <fx@gnu.org>
parents:
diff changeset
599
Dave Love <fx@gnu.org>
parents:
diff changeset
600 @item r
Dave Love <fx@gnu.org>
parents:
diff changeset
601 @vindex reftex-enable-partial-scans
Dave Love <fx@gnu.org>
parents:
diff changeset
602 Reparse the LaTeX document and rebuild the @file{*toc*} buffer. When
Dave Love <fx@gnu.org>
parents:
diff changeset
603 @code{reftex-enable-partial-scans} is non-nil, rescan only the file this
Dave Love <fx@gnu.org>
parents:
diff changeset
604 location is defined in, not the entire document.@refill
Dave Love <fx@gnu.org>
parents:
diff changeset
605
Dave Love <fx@gnu.org>
parents:
diff changeset
606 @item C-u r
Dave Love <fx@gnu.org>
parents:
diff changeset
607 Reparse the @emph{entire} LaTeX document and rebuild the @file{*toc*}
Dave Love <fx@gnu.org>
parents:
diff changeset
608 buffer.@refill
Dave Love <fx@gnu.org>
parents:
diff changeset
609
Dave Love <fx@gnu.org>
parents:
diff changeset
610 @item x
Dave Love <fx@gnu.org>
parents:
diff changeset
611 Switch to the @file{*toc*} buffer of an external document. When the
Dave Love <fx@gnu.org>
parents:
diff changeset
612 current document is using the @code{xr} package (@pxref{xr (LaTeX
Dave Love <fx@gnu.org>
parents:
diff changeset
613 package)}), @b{Ref@TeX{}} will switch to one of the external
Dave Love <fx@gnu.org>
parents:
diff changeset
614 documents.@refill
Dave Love <fx@gnu.org>
parents:
diff changeset
615
Dave Love <fx@gnu.org>
parents:
diff changeset
616 @end table
Dave Love <fx@gnu.org>
parents:
diff changeset
617
Dave Love <fx@gnu.org>
parents:
diff changeset
618 @vindex reftex-toc-map
Dave Love <fx@gnu.org>
parents:
diff changeset
619 In order to define additional commands for the @file{*toc*} buffer, the
Dave Love <fx@gnu.org>
parents:
diff changeset
620 keymap @code{reftex-toc-map} may be used.@refill
Dave Love <fx@gnu.org>
parents:
diff changeset
621
Dave Love <fx@gnu.org>
parents:
diff changeset
622 @cindex Sectioning commands
Dave Love <fx@gnu.org>
parents:
diff changeset
623 @cindex KOMA-Script, LaTeX classes
Dave Love <fx@gnu.org>
parents:
diff changeset
624 @cindex LaTeX classes, KOMA-Script
26911
d7f536a01276 Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents: 25829
diff changeset
625 @cindex TOC entries for environments
25829
Dave Love <fx@gnu.org>
parents:
diff changeset
626 @vindex reftex-section-levels
Dave Love <fx@gnu.org>
parents:
diff changeset
627 The section macros recognized by @b{Ref@TeX{}} are all LaTeX section
Dave Love <fx@gnu.org>
parents:
diff changeset
628 macros (from @code{\part} to @code{\subsubparagraph}) and the commands
Dave Love <fx@gnu.org>
parents:
diff changeset
629 @code{\addchap} and @code{\addsec} from the KOMA-Script classes.
Dave Love <fx@gnu.org>
parents:
diff changeset
630 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
631 @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
632 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
633 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
634 example.
25829
Dave Love <fx@gnu.org>
parents:
diff changeset
635
Dave Love <fx@gnu.org>
parents:
diff changeset
636 @node Labels and References, Citations, Table of Contents, Top
Dave Love <fx@gnu.org>
parents:
diff changeset
637 @chapter Labels and References
Dave Love <fx@gnu.org>
parents:
diff changeset
638 @cindex Labels in LaTeX
Dave Love <fx@gnu.org>
parents:
diff changeset
639 @cindex References in LaTeX
Dave Love <fx@gnu.org>
parents:
diff changeset
640 @cindex Label category
Dave Love <fx@gnu.org>
parents:
diff changeset
641 @cindex Label environment
Dave Love <fx@gnu.org>
parents:
diff changeset
642 @cindex @code{\label}
Dave Love <fx@gnu.org>
parents:
diff changeset
643
Dave Love <fx@gnu.org>
parents:
diff changeset
644 LaTeX provides a powerful mechanism to deal with cross--references in a
Dave Love <fx@gnu.org>
parents:
diff changeset
645 document. When writing a document, any part of it can be marked with a
Dave Love <fx@gnu.org>
parents:
diff changeset
646 label, like @samp{\label@{mark@}}. LaTeX records the current value of a
Dave Love <fx@gnu.org>
parents:
diff changeset
647 certain counter when a label is defined. Later references to this label
Dave Love <fx@gnu.org>
parents:
diff changeset
648 (like @samp{\ref@{mark@}}) will produce the recorded value of the
Dave Love <fx@gnu.org>
parents:
diff changeset
649 counter.@refill
Dave Love <fx@gnu.org>
parents:
diff changeset
650
Dave Love <fx@gnu.org>
parents:
diff changeset
651 Labels can be used to mark sections, figures, tables, equations,
Dave Love <fx@gnu.org>
parents:
diff changeset
652 footnotes, items in enumerate lists etc. LaTeX is context sensitive in
Dave Love <fx@gnu.org>
parents:
diff changeset
653 doing this: A label defined in a figure environment automatically
Dave Love <fx@gnu.org>
parents:
diff changeset
654 records the figure counter, not the section counter.@refill
Dave Love <fx@gnu.org>
parents:
diff changeset
655
Dave Love <fx@gnu.org>
parents:
diff changeset
656 Several different environments can share a common counter and therefore
Dave Love <fx@gnu.org>
parents:
diff changeset
657 a common label category. E.g. labels in both @code{equation} and
Dave Love <fx@gnu.org>
parents:
diff changeset
658 @code{eqnarray} environments record the value of the same counter - the
Dave Love <fx@gnu.org>
parents:
diff changeset
659 equation counter.@refill
Dave Love <fx@gnu.org>
parents:
diff changeset
660
Dave Love <fx@gnu.org>
parents:
diff changeset
661 @menu
Dave Love <fx@gnu.org>
parents:
diff changeset
662 * Creating Labels::
Dave Love <fx@gnu.org>
parents:
diff changeset
663 * Referencing Labels::
Dave Love <fx@gnu.org>
parents:
diff changeset
664 * Builtin Label Environments:: The environments RefTeX knows about.
Dave Love <fx@gnu.org>
parents:
diff changeset
665 * Defining Label Environments:: ... and environments it doesn't.
Dave Love <fx@gnu.org>
parents:
diff changeset
666 * Reference Info:: View the label corresponding to a \ref.
Dave Love <fx@gnu.org>
parents:
diff changeset
667 * xr (LaTeX package):: References to external documents.
Dave Love <fx@gnu.org>
parents:
diff changeset
668 * varioref (LaTeX package):: How to create \vref instead of \ref.
Dave Love <fx@gnu.org>
parents:
diff changeset
669 * fancyref (LaTeX package):: How to create \fref instead of \ref.
Dave Love <fx@gnu.org>
parents:
diff changeset
670 @end menu
Dave Love <fx@gnu.org>
parents:
diff changeset
671
Dave Love <fx@gnu.org>
parents:
diff changeset
672 @node Creating Labels, Referencing Labels, , Labels and References
Dave Love <fx@gnu.org>
parents:
diff changeset
673 @section Creating Labels
Dave Love <fx@gnu.org>
parents:
diff changeset
674 @cindex Creating labels
Dave Love <fx@gnu.org>
parents:
diff changeset
675 @cindex Labels, creating
Dave Love <fx@gnu.org>
parents:
diff changeset
676 @cindex Labels, deriving from context
Dave Love <fx@gnu.org>
parents:
diff changeset
677 @kindex C-c (
Dave Love <fx@gnu.org>
parents:
diff changeset
678 @findex reftex-label
Dave Love <fx@gnu.org>
parents:
diff changeset
679
Dave Love <fx@gnu.org>
parents:
diff changeset
680 In order to create a label in a LaTeX document, press @kbd{C-c (}
Dave Love <fx@gnu.org>
parents:
diff changeset
681 (@code{reftex-label}). Just like LaTeX, @b{Ref@TeX{}} is context sensitive
Dave Love <fx@gnu.org>
parents:
diff changeset
682 and will figure out the environment it currently is in and adapt the
Dave Love <fx@gnu.org>
parents:
diff changeset
683 label to that environment. A label usually consists of a short prefix
Dave Love <fx@gnu.org>
parents:
diff changeset
684 indicating the type of the label and a unique mark. @b{Ref@TeX{}} has
Dave Love <fx@gnu.org>
parents:
diff changeset
685 3 different modes to create this mark.@refill
Dave Love <fx@gnu.org>
parents:
diff changeset
686
Dave Love <fx@gnu.org>
parents:
diff changeset
687 @enumerate
Dave Love <fx@gnu.org>
parents:
diff changeset
688 @item
Dave Love <fx@gnu.org>
parents:
diff changeset
689 @vindex reftex-translate-to-ascii-function
Dave Love <fx@gnu.org>
parents:
diff changeset
690 @vindex reftex-derive-label-parameters
Dave Love <fx@gnu.org>
parents:
diff changeset
691 @vindex reftex-label-illegal-re
Dave Love <fx@gnu.org>
parents:
diff changeset
692 @vindex reftex-abbrev-parameters
Dave Love <fx@gnu.org>
parents:
diff changeset
693 A label can be derived from context. This means, @b{Ref@TeX{}} takes
Dave Love <fx@gnu.org>
parents:
diff changeset
694 the context of the label definition and constructs a label from
Dave Love <fx@gnu.org>
parents:
diff changeset
695 that@footnote{Note that the context may contain constructs which are
Dave Love <fx@gnu.org>
parents:
diff changeset
696 illegal in labels. @b{Ref@TeX{}} will therefore strip the accent from
Dave Love <fx@gnu.org>
parents:
diff changeset
697 accented Latin-1 characters and remove everything else which is not
Dave Love <fx@gnu.org>
parents:
diff changeset
698 legal in labels. This mechanism is safe, but may not be satisfactory
Dave Love <fx@gnu.org>
parents:
diff changeset
699 for non-western languages. Check the following variables if you need to
Dave Love <fx@gnu.org>
parents:
diff changeset
700 change things: @code{reftex-translate-to-ascii-function},
Dave Love <fx@gnu.org>
parents:
diff changeset
701 @code{reftex-derive-label-parameters}, @code{reftex-label-illegal-re},
Dave Love <fx@gnu.org>
parents:
diff changeset
702 @code{reftex-abbrev-parameters}.}. This works best for section labels,
Dave Love <fx@gnu.org>
parents:
diff changeset
703 where the section heading is used to construct a label. In fact,
Dave Love <fx@gnu.org>
parents:
diff changeset
704 @b{Ref@TeX{}}'s default settings use this method only for section
Dave Love <fx@gnu.org>
parents:
diff changeset
705 labels. You will be asked to confirm the derived label, or edit
Dave Love <fx@gnu.org>
parents:
diff changeset
706 it.@refill
Dave Love <fx@gnu.org>
parents:
diff changeset
707
Dave Love <fx@gnu.org>
parents:
diff changeset
708 @item
Dave Love <fx@gnu.org>
parents:
diff changeset
709 We may also use a simple unique number to identify a label. This is
Dave Love <fx@gnu.org>
parents:
diff changeset
710 mostly useful for labels where it is difficult to come up with a very
Dave Love <fx@gnu.org>
parents:
diff changeset
711 good descriptive name. @b{Ref@TeX{}}'s default settings use this method
Dave Love <fx@gnu.org>
parents:
diff changeset
712 for equations, enumerate items and footnotes. The author of @b{Ref@TeX{}}
Dave Love <fx@gnu.org>
parents:
diff changeset
713 tends to write documents with many equations and finds it impossible
Dave Love <fx@gnu.org>
parents:
diff changeset
714 to come up with good names for each of them. These simple labels are
Dave Love <fx@gnu.org>
parents:
diff changeset
715 inserted without query, and are therefore very fast. Good descriptive
Dave Love <fx@gnu.org>
parents:
diff changeset
716 names are not really necessary as @b{Ref@TeX{}} will provide context to
Dave Love <fx@gnu.org>
parents:
diff changeset
717 reference a label (@pxref{Referencing Labels}).@refill
Dave Love <fx@gnu.org>
parents:
diff changeset
718
Dave Love <fx@gnu.org>
parents:
diff changeset
719 @item
Dave Love <fx@gnu.org>
parents:
diff changeset
720 The third method is to ask the user for a label. This is most
Dave Love <fx@gnu.org>
parents:
diff changeset
721 useful for things which are easy to describe briefly and do not turn up
Dave Love <fx@gnu.org>
parents:
diff changeset
722 too frequently in a document. @b{Ref@TeX{}} uses this for figures and
Dave Love <fx@gnu.org>
parents:
diff changeset
723 tables. Of course, one can enter the label directly by typing the full
Dave Love <fx@gnu.org>
parents:
diff changeset
724 @samp{\label@{mark@}}. The advantage of using @code{reftex-label}
Dave Love <fx@gnu.org>
parents:
diff changeset
725 anyway is that @b{Ref@TeX{}} will know that a new label has been defined.
Dave Love <fx@gnu.org>
parents:
diff changeset
726 It will then not be necessary to rescan the document in order to access
Dave Love <fx@gnu.org>
parents:
diff changeset
727 this label later.@refill
Dave Love <fx@gnu.org>
parents:
diff changeset
728 @end enumerate
Dave Love <fx@gnu.org>
parents:
diff changeset
729
Dave Love <fx@gnu.org>
parents:
diff changeset
730 @vindex reftex-insert-label-flags
Dave Love <fx@gnu.org>
parents:
diff changeset
731 If you want to change the way certain labels are created, check out the
Dave Love <fx@gnu.org>
parents:
diff changeset
732 variable @code{reftex-insert-label-flags} (@pxref{Options (Creating
Dave Love <fx@gnu.org>
parents:
diff changeset
733 Labels)}).@refill
Dave Love <fx@gnu.org>
parents:
diff changeset
734
Dave Love <fx@gnu.org>
parents:
diff changeset
735 If you are using AUCTeX to write your LaTeX documents, you can
Dave Love <fx@gnu.org>
parents:
diff changeset
736 set it up to delegate the creation of labels to
Dave Love <fx@gnu.org>
parents:
diff changeset
737 @b{Ref@TeX{}}. @xref{AUCTeX}, for more information.
Dave Love <fx@gnu.org>
parents:
diff changeset
738
Dave Love <fx@gnu.org>
parents:
diff changeset
739 @node Referencing Labels, Builtin Label Environments, Creating Labels, Labels and References
Dave Love <fx@gnu.org>
parents:
diff changeset
740 @section Referencing Labels
Dave Love <fx@gnu.org>
parents:
diff changeset
741 @cindex Referencing labels
Dave Love <fx@gnu.org>
parents:
diff changeset
742 @cindex Labels, referencing
Dave Love <fx@gnu.org>
parents:
diff changeset
743 @cindex Selection buffer, labels
Dave Love <fx@gnu.org>
parents:
diff changeset
744 @cindex Selection process
Dave Love <fx@gnu.org>
parents:
diff changeset
745 @cindex @code{\ref}
Dave Love <fx@gnu.org>
parents:
diff changeset
746 @kindex C-c )
Dave Love <fx@gnu.org>
parents:
diff changeset
747 @findex reftex-reference
Dave Love <fx@gnu.org>
parents:
diff changeset
748
Dave Love <fx@gnu.org>
parents:
diff changeset
749 Referencing Labels is really at the heart of @b{Ref@TeX{}}. Press @kbd{C-c
Dave Love <fx@gnu.org>
parents:
diff changeset
750 )} in order to reference a label (reftex-reference). This will start a
Dave Love <fx@gnu.org>
parents:
diff changeset
751 selection process and finally insert the complete @samp{\ref@{label@}}
Dave Love <fx@gnu.org>
parents:
diff changeset
752 into the buffer.@refill
Dave Love <fx@gnu.org>
parents:
diff changeset
753
Dave Love <fx@gnu.org>
parents:
diff changeset
754 First, @b{Ref@TeX{}} will determine the label category which is required.
Dave Love <fx@gnu.org>
parents:
diff changeset
755 Often that can be figured out from context. For example, if you
Dave Love <fx@gnu.org>
parents:
diff changeset
756 write @samp{As shown in eq.} and the press @kbd{C-c )}, @b{Ref@TeX{}} knows
Dave Love <fx@gnu.org>
parents:
diff changeset
757 that an equation label is going to be referenced. If it cannot figure
Dave Love <fx@gnu.org>
parents:
diff changeset
758 out what label category is needed, it will query for one.@refill
Dave Love <fx@gnu.org>
parents:
diff changeset
759
Dave Love <fx@gnu.org>
parents:
diff changeset
760 You will then be presented with a label selection menu. This is a
Dave Love <fx@gnu.org>
parents:
diff changeset
761 special buffer which contains an outline of the document along with all
Dave Love <fx@gnu.org>
parents:
diff changeset
762 labels of the given label category. In addition, next to the label
Dave Love <fx@gnu.org>
parents:
diff changeset
763 there will be one line of context of the label definition, which is some
Dave Love <fx@gnu.org>
parents:
diff changeset
764 text in the buffer near the label definition. Usually this is
Dave Love <fx@gnu.org>
parents:
diff changeset
765 sufficient to identify the label. If you are unsure about a certain
Dave Love <fx@gnu.org>
parents:
diff changeset
766 label, pressing @key{SPC} will show the label definition point in
Dave Love <fx@gnu.org>
parents:
diff changeset
767 another window.@refill
Dave Love <fx@gnu.org>
parents:
diff changeset
768
Dave Love <fx@gnu.org>
parents:
diff changeset
769 In order to reference a label, move to cursor to the correct label and
Dave Love <fx@gnu.org>
parents:
diff changeset
770 press @key{RET}. You can also reference several labels with a single
Dave Love <fx@gnu.org>
parents:
diff changeset
771 call to @code{reftex-reference} by marking entries with the @kbd{m}
Dave Love <fx@gnu.org>
parents:
diff changeset
772 key (see below).
Dave Love <fx@gnu.org>
parents:
diff changeset
773
Dave Love <fx@gnu.org>
parents:
diff changeset
774 @kindex ?
Dave Love <fx@gnu.org>
parents:
diff changeset
775 Here is a list of special commands in the selection buffer. A summary
Dave Love <fx@gnu.org>
parents:
diff changeset
776 of this information is always available from the selection process by
Dave Love <fx@gnu.org>
parents:
diff changeset
777 pressing @kbd{?}.@refill
Dave Love <fx@gnu.org>
parents:
diff changeset
778
Dave Love <fx@gnu.org>
parents:
diff changeset
779
Dave Love <fx@gnu.org>
parents:
diff changeset
780
Dave Love <fx@gnu.org>
parents:
diff changeset
781 @table @kbd
Dave Love <fx@gnu.org>
parents:
diff changeset
782 @tablesubheading{General}
Dave Love <fx@gnu.org>
parents:
diff changeset
783 @item ?
Dave Love <fx@gnu.org>
parents:
diff changeset
784 Show a summary of available commands.
Dave Love <fx@gnu.org>
parents:
diff changeset
785
Dave Love <fx@gnu.org>
parents:
diff changeset
786 @item 0-9,-
Dave Love <fx@gnu.org>
parents:
diff changeset
787 Prefix argument.
Dave Love <fx@gnu.org>
parents:
diff changeset
788
Dave Love <fx@gnu.org>
parents:
diff changeset
789 @tablesubheading{Moving around}
Dave Love <fx@gnu.org>
parents:
diff changeset
790 @item n
Dave Love <fx@gnu.org>
parents:
diff changeset
791 Go to next label.
Dave Love <fx@gnu.org>
parents:
diff changeset
792
Dave Love <fx@gnu.org>
parents:
diff changeset
793 @item p
Dave Love <fx@gnu.org>
parents:
diff changeset
794 Go to previous label.
Dave Love <fx@gnu.org>
parents:
diff changeset
795
Dave Love <fx@gnu.org>
parents:
diff changeset
796 @item b
Dave Love <fx@gnu.org>
parents:
diff changeset
797 Jump back to the position where you last left the selection buffer.
Dave Love <fx@gnu.org>
parents:
diff changeset
798 Normally this should get you back to the last referenced label.@refill
Dave Love <fx@gnu.org>
parents:
diff changeset
799
Dave Love <fx@gnu.org>
parents:
diff changeset
800 @item C-c C-n
Dave Love <fx@gnu.org>
parents:
diff changeset
801 Goto next section heading.
Dave Love <fx@gnu.org>
parents:
diff changeset
802
Dave Love <fx@gnu.org>
parents:
diff changeset
803 @item C-c C-p
Dave Love <fx@gnu.org>
parents:
diff changeset
804 Goto previous section heading.
Dave Love <fx@gnu.org>
parents:
diff changeset
805
Dave Love <fx@gnu.org>
parents:
diff changeset
806 @tablesubheading{Displaying Context}
Dave Love <fx@gnu.org>
parents:
diff changeset
807 @item @key{SPC}
Dave Love <fx@gnu.org>
parents:
diff changeset
808 Show the surroundings of the definition of the current label in another
Dave Love <fx@gnu.org>
parents:
diff changeset
809 window. See also the @kbd{f} key.@refill
Dave Love <fx@gnu.org>
parents:
diff changeset
810
Dave Love <fx@gnu.org>
parents:
diff changeset
811 @item f
Dave Love <fx@gnu.org>
parents:
diff changeset
812 @vindex reftex-revisit-to-follow
Dave Love <fx@gnu.org>
parents:
diff changeset
813 Toggle follow mode. When follow mode is active, the other window will
Dave Love <fx@gnu.org>
parents:
diff changeset
814 always display the full context of the current label. This is similar
Dave Love <fx@gnu.org>
parents:
diff changeset
815 to pressing @key{SPC} after each cursor motion. Note that only context
Dave Love <fx@gnu.org>
parents:
diff changeset
816 in files already visited is shown. @b{RefTeX} will not visit a file
Dave Love <fx@gnu.org>
parents:
diff changeset
817 just for follow mode. See, however, the variable
Dave Love <fx@gnu.org>
parents:
diff changeset
818 @code{reftex-revisit-to-follow}.@refill
Dave Love <fx@gnu.org>
parents:
diff changeset
819
Dave Love <fx@gnu.org>
parents:
diff changeset
820 @item .
Dave Love <fx@gnu.org>
parents:
diff changeset
821 Show insertion point in another window. This is the point from where you
Dave Love <fx@gnu.org>
parents:
diff changeset
822 called @code{reftex-reference}.@refill
Dave Love <fx@gnu.org>
parents:
diff changeset
823
Dave Love <fx@gnu.org>
parents:
diff changeset
824 @tablesubheading{Selecting a label and creating the reference}
Dave Love <fx@gnu.org>
parents:
diff changeset
825 @item @key{RET}
Dave Love <fx@gnu.org>
parents:
diff changeset
826 Insert a reference to the label at point into the buffer from which the
Dave Love <fx@gnu.org>
parents:
diff changeset
827 selection process was started. When entries have been marked, @key{RET}
Dave Love <fx@gnu.org>
parents:
diff changeset
828 references all marked labels.@refill
Dave Love <fx@gnu.org>
parents:
diff changeset
829
Dave Love <fx@gnu.org>
parents:
diff changeset
830 @item mouse-2
Dave Love <fx@gnu.org>
parents:
diff changeset
831 @vindex reftex-highlight-selection
Dave Love <fx@gnu.org>
parents:
diff changeset
832 Clicking with mouse button 2 on a label will accept it like @key{RET}
Dave Love <fx@gnu.org>
parents:
diff changeset
833 would. See also variable @code{reftex-highlight-selection}, @ref{Options
Dave Love <fx@gnu.org>
parents:
diff changeset
834 (Misc)}.@refill
Dave Love <fx@gnu.org>
parents:
diff changeset
835
Dave Love <fx@gnu.org>
parents:
diff changeset
836 @vindex reftex-multiref-punctuation
Dave Love <fx@gnu.org>
parents:
diff changeset
837 @item m - + ,
Dave Love <fx@gnu.org>
parents:
diff changeset
838 Mark the current entry. When several entries have been marked, pressing
Dave Love <fx@gnu.org>
parents:
diff changeset
839 @kbd{RET} will accept all of them and place them into several
Dave Love <fx@gnu.org>
parents:
diff changeset
840 @code{\ref} macros. The special markers @samp{,-+} also store a
Dave Love <fx@gnu.org>
parents:
diff changeset
841 separator to be inserted before the corresponding reference. So marking
Dave Love <fx@gnu.org>
parents:
diff changeset
842 six entries with the keys @samp{m , , - , +} will give a reference list
Dave Love <fx@gnu.org>
parents:
diff changeset
843 like this (see the variable @code{reftex-multiref-punctuation})
Dave Love <fx@gnu.org>
parents:
diff changeset
844 @example
Dave Love <fx@gnu.org>
parents:
diff changeset
845 In eqs. (1), (2), (3)--(4), (5) and (6)
Dave Love <fx@gnu.org>
parents:
diff changeset
846 @end example
Dave Love <fx@gnu.org>
parents:
diff changeset
847
Dave Love <fx@gnu.org>
parents:
diff changeset
848 @item u
Dave Love <fx@gnu.org>
parents:
diff changeset
849 Unmark a marked entry.
Dave Love <fx@gnu.org>
parents:
diff changeset
850
Dave Love <fx@gnu.org>
parents:
diff changeset
851 @c FIXME: Do we need `A' as well for consistency?
Dave Love <fx@gnu.org>
parents:
diff changeset
852 @cindex LaTeX packages, @code{saferef}
Dave Love <fx@gnu.org>
parents:
diff changeset
853 @cindex @code{saferef}, LaTeX package
Dave Love <fx@gnu.org>
parents:
diff changeset
854 @item a
Dave Love <fx@gnu.org>
parents:
diff changeset
855 Accept the marked entries and put all labels as a comma-separated list
Dave Love <fx@gnu.org>
parents:
diff changeset
856 into one @emph{single} @code{\ref} macro. Some packages like
Dave Love <fx@gnu.org>
parents:
diff changeset
857 @file{saferef.sty} support multiple references in this way.@refill
Dave Love <fx@gnu.org>
parents:
diff changeset
858
Dave Love <fx@gnu.org>
parents:
diff changeset
859 @item l
Dave Love <fx@gnu.org>
parents:
diff changeset
860 Use the last referenced label(s) again. This is equivalent to moving to
Dave Love <fx@gnu.org>
parents:
diff changeset
861 that label and pressing @key{RET}.@refill
Dave Love <fx@gnu.org>
parents:
diff changeset
862
Dave Love <fx@gnu.org>
parents:
diff changeset
863 @item @key{TAB}
Dave Love <fx@gnu.org>
parents:
diff changeset
864 Enter a label with completion. This may also be a label which does not
Dave Love <fx@gnu.org>
parents:
diff changeset
865 yet exist in the document.
Dave Love <fx@gnu.org>
parents:
diff changeset
866
Dave Love <fx@gnu.org>
parents:
diff changeset
867 @item v
Dave Love <fx@gnu.org>
parents:
diff changeset
868 @cindex @code{varioref}, LaTeX package
Dave Love <fx@gnu.org>
parents:
diff changeset
869 @cindex @code{\vref}
Dave Love <fx@gnu.org>
parents:
diff changeset
870 @cindex LaTeX packages, @code{varioref}
Dave Love <fx@gnu.org>
parents:
diff changeset
871 Toggle between @code{\ref} and @code{\vref} macro for references. The
Dave Love <fx@gnu.org>
parents:
diff changeset
872 @code{\vref} macro is defined in the @code{varioref} LaTeX package.
Dave Love <fx@gnu.org>
parents:
diff changeset
873 With this key you can force @b{Ref@TeX{}} to insert a @code{\vref}
Dave Love <fx@gnu.org>
parents:
diff changeset
874 macro. The current state of this flag is displayed by the @samp{S<>}
Dave Love <fx@gnu.org>
parents:
diff changeset
875 indicator in the mode line of the selection buffer.@refill
Dave Love <fx@gnu.org>
parents:
diff changeset
876
Dave Love <fx@gnu.org>
parents:
diff changeset
877 @item V
Dave Love <fx@gnu.org>
parents:
diff changeset
878 @cindex @code{fancyref}, LaTeX package
Dave Love <fx@gnu.org>
parents:
diff changeset
879 @cindex @code{\fref}
Dave Love <fx@gnu.org>
parents:
diff changeset
880 @cindex @code{\Fref}
Dave Love <fx@gnu.org>
parents:
diff changeset
881 @cindex LaTeX packages, @code{fancyref}
Dave Love <fx@gnu.org>
parents:
diff changeset
882 Cycle between @code{\ref}, @code{\fref} and @code{\Fref}. The
Dave Love <fx@gnu.org>
parents:
diff changeset
883 @code{\fref} and @code{\Fref} macros are defined in the @code{fancyref}
Dave Love <fx@gnu.org>
parents:
diff changeset
884 LaTeX package. With this key you can force @b{Ref@TeX{}} to insert a
Dave Love <fx@gnu.org>
parents:
diff changeset
885 @code{\fref} or @code{\Fref} macro. The current state of this flag is
Dave Love <fx@gnu.org>
parents:
diff changeset
886 displayed by the @samp{S<>} indicator in the mode line of the
Dave Love <fx@gnu.org>
parents:
diff changeset
887 selection buffer.
Dave Love <fx@gnu.org>
parents:
diff changeset
888
Dave Love <fx@gnu.org>
parents:
diff changeset
889 @tablesubheading{Exiting}
Dave Love <fx@gnu.org>
parents:
diff changeset
890
Dave Love <fx@gnu.org>
parents:
diff changeset
891 @item q
Dave Love <fx@gnu.org>
parents:
diff changeset
892 Exit the selection process without inserting any reference into the
Dave Love <fx@gnu.org>
parents:
diff changeset
893 buffer.@refill
Dave Love <fx@gnu.org>
parents:
diff changeset
894
Dave Love <fx@gnu.org>
parents:
diff changeset
895 @tablesubheading{Controlling what gets displayed}
Dave Love <fx@gnu.org>
parents:
diff changeset
896 @vindex reftex-label-menu-flags
Dave Love <fx@gnu.org>
parents:
diff changeset
897 The defaults for the following flags can be configured with the variable
Dave Love <fx@gnu.org>
parents:
diff changeset
898 @code{reftex-label-menu-flags} (@pxref{Options (Referencing Labels)}).
Dave Love <fx@gnu.org>
parents:
diff changeset
899
Dave Love <fx@gnu.org>
parents:
diff changeset
900 @item c
Dave Love <fx@gnu.org>
parents:
diff changeset
901 Toggle the display of the one-line label definition context in the
Dave Love <fx@gnu.org>
parents:
diff changeset
902 selection buffer.@refill
Dave Love <fx@gnu.org>
parents:
diff changeset
903
Dave Love <fx@gnu.org>
parents:
diff changeset
904 @item F
Dave Love <fx@gnu.org>
parents:
diff changeset
905 Toggle the display of the file borders of a multifile document in the
Dave Love <fx@gnu.org>
parents:
diff changeset
906 selection buffer.@refill
Dave Love <fx@gnu.org>
parents:
diff changeset
907
Dave Love <fx@gnu.org>
parents:
diff changeset
908 @item t
26911
d7f536a01276 Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents: 25829
diff changeset
909 Toggle the display of the table of contents in the selection buffer.
d7f536a01276 Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents: 25829
diff changeset
910 With prefix @var{arg}, change the maximum level of toc entries displayed
d7f536a01276 Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents: 25829
diff changeset
911 to @var{arg}. Chapters are level 1, section are level 2.@refill
25829
Dave Love <fx@gnu.org>
parents:
diff changeset
912
Dave Love <fx@gnu.org>
parents:
diff changeset
913 @item #
Dave Love <fx@gnu.org>
parents:
diff changeset
914 Toggle the display of a label counter in the selection buffer.@refill
Dave Love <fx@gnu.org>
parents:
diff changeset
915
Dave Love <fx@gnu.org>
parents:
diff changeset
916 @item %
Dave Love <fx@gnu.org>
parents:
diff changeset
917 Toggle the display of labels hidden in comments in the selection
Dave Love <fx@gnu.org>
parents:
diff changeset
918 buffers. Sometimes, you may have commented out parts of your document.
Dave Love <fx@gnu.org>
parents:
diff changeset
919 If these parts contain label definitions, @b{Ref@TeX{}} can still display
Dave Love <fx@gnu.org>
parents:
diff changeset
920 and reference these labels.@refill
Dave Love <fx@gnu.org>
parents:
diff changeset
921
Dave Love <fx@gnu.org>
parents:
diff changeset
922 @tablesubheading{Updating the buffer}
Dave Love <fx@gnu.org>
parents:
diff changeset
923 @item g
Dave Love <fx@gnu.org>
parents:
diff changeset
924 Update the menu. This will rebuilt the menu from the internal label
Dave Love <fx@gnu.org>
parents:
diff changeset
925 list, but not reparse the document (see @kbd{r}).@refill
Dave Love <fx@gnu.org>
parents:
diff changeset
926
Dave Love <fx@gnu.org>
parents:
diff changeset
927 @item r
Dave Love <fx@gnu.org>
parents:
diff changeset
928 @vindex reftex-enable-partial-scans
Dave Love <fx@gnu.org>
parents:
diff changeset
929 Reparse the document to update the information on all labels and rebuild
Dave Love <fx@gnu.org>
parents:
diff changeset
930 the menu. If the variable @code{reftex-enable-partial-scans} is
Dave Love <fx@gnu.org>
parents:
diff changeset
931 non-@code{nil} and your document is a multifile document, this will
Dave Love <fx@gnu.org>
parents:
diff changeset
932 reparse only a part of the document (the file in which the label at
Dave Love <fx@gnu.org>
parents:
diff changeset
933 point was defined).@refill
Dave Love <fx@gnu.org>
parents:
diff changeset
934
Dave Love <fx@gnu.org>
parents:
diff changeset
935 @item C-u r
Dave Love <fx@gnu.org>
parents:
diff changeset
936 Reparse the @emph{entire} document.
Dave Love <fx@gnu.org>
parents:
diff changeset
937
Dave Love <fx@gnu.org>
parents:
diff changeset
938 @item s
Dave Love <fx@gnu.org>
parents:
diff changeset
939 Switch the label category. After prompting for another label category,
Dave Love <fx@gnu.org>
parents:
diff changeset
940 a menu for that category will be shown.@refill
Dave Love <fx@gnu.org>
parents:
diff changeset
941
Dave Love <fx@gnu.org>
parents:
diff changeset
942 @item x
Dave Love <fx@gnu.org>
parents:
diff changeset
943 Reference a label from an external document. With the LaTeX package
Dave Love <fx@gnu.org>
parents:
diff changeset
944 @code{xr} it is possible to reference labels defined in another
Dave Love <fx@gnu.org>
parents:
diff changeset
945 document. This key will switch to the label menu of an external
Dave Love <fx@gnu.org>
parents:
diff changeset
946 document and let you select a label from there (@pxref{xr (LaTeX
Dave Love <fx@gnu.org>
parents:
diff changeset
947 package),,xr}).@refill
Dave Love <fx@gnu.org>
parents:
diff changeset
948
Dave Love <fx@gnu.org>
parents:
diff changeset
949 @end table
Dave Love <fx@gnu.org>
parents:
diff changeset
950
Dave Love <fx@gnu.org>
parents:
diff changeset
951 @vindex reftex-select-label-map
Dave Love <fx@gnu.org>
parents:
diff changeset
952 In order to define additional commands for the selection process, the
Dave Love <fx@gnu.org>
parents:
diff changeset
953 keymap @code{reftex-select-label-map} may be used.@refill
Dave Love <fx@gnu.org>
parents:
diff changeset
954
Dave Love <fx@gnu.org>
parents:
diff changeset
955 @node Builtin Label Environments, Defining Label Environments, Referencing Labels, Labels and References
Dave Love <fx@gnu.org>
parents:
diff changeset
956 @section Builtin Label Environments
Dave Love <fx@gnu.org>
parents:
diff changeset
957 @cindex Builtin label environments
Dave Love <fx@gnu.org>
parents:
diff changeset
958 @cindex Label environments, builtin
Dave Love <fx@gnu.org>
parents:
diff changeset
959 @cindex Environments, builtin
Dave Love <fx@gnu.org>
parents:
diff changeset
960 @vindex reftex-label-alist
Dave Love <fx@gnu.org>
parents:
diff changeset
961 @vindex reftex-label-alist-builtin
Dave Love <fx@gnu.org>
parents:
diff changeset
962
Dave Love <fx@gnu.org>
parents:
diff changeset
963 @b{Ref@TeX{}} needs to be aware of the environments which can be referenced
Dave Love <fx@gnu.org>
parents:
diff changeset
964 with a label (i.e. which carry their own counters). By default, @b{Ref@TeX{}}
Dave Love <fx@gnu.org>
parents:
diff changeset
965 recognizes all labeled environments and macros discussed in @cite{The
Dave Love <fx@gnu.org>
parents:
diff changeset
966 LaTeX Companion by Goossens, Mittelbach & Samarin, Addison-Wesley
Dave Love <fx@gnu.org>
parents:
diff changeset
967 1994.}. These are:@refill
Dave Love <fx@gnu.org>
parents:
diff changeset
968
Dave Love <fx@gnu.org>
parents:
diff changeset
969 @itemize @minus
Dave Love <fx@gnu.org>
parents:
diff changeset
970 @item
Dave Love <fx@gnu.org>
parents:
diff changeset
971 @cindex @code{figure}, LaTeX environment
Dave Love <fx@gnu.org>
parents:
diff changeset
972 @cindex @code{figure*}, LaTeX environment
Dave Love <fx@gnu.org>
parents:
diff changeset
973 @cindex @code{table}, LaTeX environment
Dave Love <fx@gnu.org>
parents:
diff changeset
974 @cindex @code{table*}, LaTeX environment
Dave Love <fx@gnu.org>
parents:
diff changeset
975 @cindex @code{equation}, LaTeX environment
Dave Love <fx@gnu.org>
parents:
diff changeset
976 @cindex @code{eqnarray}, LaTeX environment
Dave Love <fx@gnu.org>
parents:
diff changeset
977 @cindex @code{enumerate}, LaTeX environment
Dave Love <fx@gnu.org>
parents:
diff changeset
978 @cindex @code{\footnote}, LaTeX macro
Dave Love <fx@gnu.org>
parents:
diff changeset
979 @cindex LaTeX macro @code{footnote}
Dave Love <fx@gnu.org>
parents:
diff changeset
980 @cindex LaTeX core
Dave Love <fx@gnu.org>
parents:
diff changeset
981 @code{figure}, @code{figure*}, @code{table}, @code{table*}, @code{equation},
Dave Love <fx@gnu.org>
parents:
diff changeset
982 @code{eqnarray}, @code{enumerate}, the @code{\footnote} macro (this is
Dave Love <fx@gnu.org>
parents:
diff changeset
983 the LaTeX core stuff)@refill
Dave Love <fx@gnu.org>
parents:
diff changeset
984 @item
Dave Love <fx@gnu.org>
parents:
diff changeset
985 @cindex AMS-LaTeX
Dave Love <fx@gnu.org>
parents:
diff changeset
986 @cindex @code{amsmath}, LaTeX package
Dave Love <fx@gnu.org>
parents:
diff changeset
987 @cindex LaTeX packages, @code{amsmath}
Dave Love <fx@gnu.org>
parents:
diff changeset
988 @cindex @code{align}, AMS-LaTeX environment
Dave Love <fx@gnu.org>
parents:
diff changeset
989 @cindex @code{gather}, AMS-LaTeX environment
Dave Love <fx@gnu.org>
parents:
diff changeset
990 @cindex @code{multline}, AMS-LaTeX environment
Dave Love <fx@gnu.org>
parents:
diff changeset
991 @cindex @code{flalign}, AMS-LaTeX environment
Dave Love <fx@gnu.org>
parents:
diff changeset
992 @cindex @code{alignat}, AMS-LaTeX environment
Dave Love <fx@gnu.org>
parents:
diff changeset
993 @cindex @code{xalignat}, AMS-LaTeX environment
Dave Love <fx@gnu.org>
parents:
diff changeset
994 @cindex @code{xxalignat}, AMS-LaTeX environment
Dave Love <fx@gnu.org>
parents:
diff changeset
995 @cindex @code{subequations}, AMS-LaTeX environment
Dave Love <fx@gnu.org>
parents:
diff changeset
996 @code{align}, @code{gather}, @code{multline}, @code{flalign},
Dave Love <fx@gnu.org>
parents:
diff changeset
997 @code{alignat}, @code{xalignat}, @code{xxalignat}, @code{subequations}
Dave Love <fx@gnu.org>
parents:
diff changeset
998 (from AMS-LaTeX's @file{amsmath.sty} package)@refill
Dave Love <fx@gnu.org>
parents:
diff changeset
999 @item
Dave Love <fx@gnu.org>
parents:
diff changeset
1000 @cindex @code{endnote}, LaTeX package
Dave Love <fx@gnu.org>
parents:
diff changeset
1001 @cindex LaTeX packages, @code{endnote}
Dave Love <fx@gnu.org>
parents:
diff changeset
1002 @cindex @code{\endnote}, LaTeX macro
Dave Love <fx@gnu.org>
parents:
diff changeset
1003 the @code{\endnote} macro (from @file{endnotes.sty})
Dave Love <fx@gnu.org>
parents:
diff changeset
1004 @item
Dave Love <fx@gnu.org>
parents:
diff changeset
1005 @cindex @code{fancybox}, LaTeX package
Dave Love <fx@gnu.org>
parents:
diff changeset
1006 @cindex LaTeX packages, @code{fancybox}
Dave Love <fx@gnu.org>
parents:
diff changeset
1007 @cindex @code{Beqnarray}, LaTeX environment
Dave Love <fx@gnu.org>
parents:
diff changeset
1008 @code{Beqnarray} (@file{fancybox.sty})
Dave Love <fx@gnu.org>
parents:
diff changeset
1009 @item
Dave Love <fx@gnu.org>
parents:
diff changeset
1010 @cindex @code{floatfig}, LaTeX package
Dave Love <fx@gnu.org>
parents:
diff changeset
1011 @cindex LaTeX packages, @code{floatfig}
Dave Love <fx@gnu.org>
parents:
diff changeset
1012 @cindex @code{floatingfig}, LaTeX environment
Dave Love <fx@gnu.org>
parents:
diff changeset
1013 @code{floatingfig} (@file{floatfig.sty})
Dave Love <fx@gnu.org>
parents:
diff changeset
1014 @item
Dave Love <fx@gnu.org>
parents:
diff changeset
1015 @cindex @code{longtable}, LaTeX package
Dave Love <fx@gnu.org>
parents:
diff changeset
1016 @cindex LaTeX packages, @code{longtable}
Dave Love <fx@gnu.org>
parents:
diff changeset
1017 @cindex @code{longtable}, LaTeX environment
Dave Love <fx@gnu.org>
parents:
diff changeset
1018 @code{longtable} (@file{longtable.sty})
Dave Love <fx@gnu.org>
parents:
diff changeset
1019 @item
Dave Love <fx@gnu.org>
parents:
diff changeset
1020 @cindex @code{picinpar}, LaTeX package
Dave Love <fx@gnu.org>
parents:
diff changeset
1021 @cindex LaTeX packages, @code{picinpar}
Dave Love <fx@gnu.org>
parents:
diff changeset
1022 @cindex @code{figwindow}, LaTeX environment
Dave Love <fx@gnu.org>
parents:
diff changeset
1023 @cindex @code{tabwindow}, LaTeX environment
Dave Love <fx@gnu.org>
parents:
diff changeset
1024 @code{figwindow}, @code{tabwindow} (@file{picinpar.sty})
Dave Love <fx@gnu.org>
parents:
diff changeset
1025 @item
Dave Love <fx@gnu.org>
parents:
diff changeset
1026 @cindex @code{sidecap}, LaTeX package
Dave Love <fx@gnu.org>
parents:
diff changeset
1027 @cindex LaTeX packages, @code{sidecap}
Dave Love <fx@gnu.org>
parents:
diff changeset
1028 @cindex @code{SCfigure}, LaTeX environment
Dave Love <fx@gnu.org>
parents:
diff changeset
1029 @cindex @code{SCtable}, LaTeX environment
Dave Love <fx@gnu.org>
parents:
diff changeset
1030 @code{SCfigure}, @code{SCtable} (@file{sidecap.sty})
Dave Love <fx@gnu.org>
parents:
diff changeset
1031 @item
Dave Love <fx@gnu.org>
parents:
diff changeset
1032 @cindex @code{rotating}, LaTeX package
Dave Love <fx@gnu.org>
parents:
diff changeset
1033 @cindex LaTeX packages, @code{rotating}
Dave Love <fx@gnu.org>
parents:
diff changeset
1034 @cindex @code{sidewaysfigure}, LaTeX environment
Dave Love <fx@gnu.org>
parents:
diff changeset
1035 @cindex @code{sidewaystable}, LaTeX environment
Dave Love <fx@gnu.org>
parents:
diff changeset
1036 @code{sidewaysfigure}, @code{sidewaystable} (@file{rotating.sty})
Dave Love <fx@gnu.org>
parents:
diff changeset
1037 @item
Dave Love <fx@gnu.org>
parents:
diff changeset
1038 @cindex @code{subfig}, LaTeX package
Dave Love <fx@gnu.org>
parents:
diff changeset
1039 @cindex LaTeX packages, @code{subfigure}
Dave Love <fx@gnu.org>
parents:
diff changeset
1040 @cindex @code{subfigure}, LaTeX environment
Dave Love <fx@gnu.org>
parents:
diff changeset
1041 @cindex @code{subfigure*}, LaTeX environment
Dave Love <fx@gnu.org>
parents:
diff changeset
1042 @code{subfigure}, @code{subfigure*}, the @code{\subfigure} macro
Dave Love <fx@gnu.org>
parents:
diff changeset
1043 (@file{subfigure.sty})@refill
Dave Love <fx@gnu.org>
parents:
diff changeset
1044 @item
Dave Love <fx@gnu.org>
parents:
diff changeset
1045 @cindex @code{supertab}, LaTeX package
Dave Love <fx@gnu.org>
parents:
diff changeset
1046 @cindex LaTeX packages, @code{supertab}
Dave Love <fx@gnu.org>
parents:
diff changeset
1047 @cindex @code{supertabular}, LaTeX environment
Dave Love <fx@gnu.org>
parents:
diff changeset
1048 @code{supertabular} (@file{supertab.sty})
Dave Love <fx@gnu.org>
parents:
diff changeset
1049 @item
Dave Love <fx@gnu.org>
parents:
diff changeset
1050 @cindex @code{wrapfig}, LaTeX package
Dave Love <fx@gnu.org>
parents:
diff changeset
1051 @cindex LaTeX packages, @code{wrapfig}
Dave Love <fx@gnu.org>
parents:
diff changeset
1052 @cindex @code{wrapfigure}, LaTeX environment
Dave Love <fx@gnu.org>
parents:
diff changeset
1053 @code{wrapfigure} (@file{wrapfig.sty})
Dave Love <fx@gnu.org>
parents:
diff changeset
1054 @end itemize
Dave Love <fx@gnu.org>
parents:
diff changeset
1055
Dave Love <fx@gnu.org>
parents:
diff changeset
1056 If you want to use other labeled environments, defined with
Dave Love <fx@gnu.org>
parents:
diff changeset
1057 @code{\newtheorem}, @b{Ref@TeX{}} needs to be configured to recognize
Dave Love <fx@gnu.org>
parents:
diff changeset
1058 them (@pxref{Defining Label Environments}).@refill
Dave Love <fx@gnu.org>
parents:
diff changeset
1059
Dave Love <fx@gnu.org>
parents:
diff changeset
1060 @node Defining Label Environments, Reference Info, Builtin Label Environments, Labels and References
Dave Love <fx@gnu.org>
parents:
diff changeset
1061 @section Defining Label Environments
Dave Love <fx@gnu.org>
parents:
diff changeset
1062 @cindex Label environments, defining
Dave Love <fx@gnu.org>
parents:
diff changeset
1063
Dave Love <fx@gnu.org>
parents:
diff changeset
1064 @vindex reftex-label-alist
Dave Love <fx@gnu.org>
parents:
diff changeset
1065 @b{Ref@TeX{}} can be configured to recognize additional labeled
Dave Love <fx@gnu.org>
parents:
diff changeset
1066 environments and macros. This is done with the variable
Dave Love <fx@gnu.org>
parents:
diff changeset
1067 @code{reftex-label-alist} (@pxref{Options (Defining Label
Dave Love <fx@gnu.org>
parents:
diff changeset
1068 Environments)}). If you are not familiar with Lisp, you can use the
Dave Love <fx@gnu.org>
parents:
diff changeset
1069 @code{custom} library to configure this rather complex variable. To do
Dave Love <fx@gnu.org>
parents:
diff changeset
1070 this, use
Dave Love <fx@gnu.org>
parents:
diff changeset
1071
Dave Love <fx@gnu.org>
parents:
diff changeset
1072 @example
Dave Love <fx@gnu.org>
parents:
diff changeset
1073 @kbd{M-x customize-variable @key{RET} reftex-label-alist @key{RET}}
Dave Love <fx@gnu.org>
parents:
diff changeset
1074 @end example
Dave Love <fx@gnu.org>
parents:
diff changeset
1075
Dave Love <fx@gnu.org>
parents:
diff changeset
1076 @vindex reftex-label-alist-builtin
Dave Love <fx@gnu.org>
parents:
diff changeset
1077 Here we will discuss a few examples, in order to make things clearer.
Dave Love <fx@gnu.org>
parents:
diff changeset
1078 It can also be instructive to look at the constant
Dave Love <fx@gnu.org>
parents:
diff changeset
1079 @code{reftex-label-alist-builtin} which contains the entries for
Dave Love <fx@gnu.org>
parents:
diff changeset
1080 all the builtin environments and macros (@pxref{Builtin Label
Dave Love <fx@gnu.org>
parents:
diff changeset
1081 Environments}).@refill
Dave Love <fx@gnu.org>
parents:
diff changeset
1082
Dave Love <fx@gnu.org>
parents:
diff changeset
1083 @menu
Dave Love <fx@gnu.org>
parents:
diff changeset
1084 * Theorem and Axiom:: Defined with @code{\newenvironment}.
Dave Love <fx@gnu.org>
parents:
diff changeset
1085 * Quick Equation:: When a macro sets the label type.
Dave Love <fx@gnu.org>
parents:
diff changeset
1086 * Figure Wrapper:: When a macro argument is a label.
Dave Love <fx@gnu.org>
parents:
diff changeset
1087 * Adding Magic Words:: Other words for other languages.
Dave Love <fx@gnu.org>
parents:
diff changeset
1088 * Using \eqref:: How to switch to this AMS-LaTeX macro.
Dave Love <fx@gnu.org>
parents:
diff changeset
1089 * Non-Standard Environments:: Environments without \begin and \end
Dave Love <fx@gnu.org>
parents:
diff changeset
1090 * Putting it Together:: How to combine many entries.
Dave Love <fx@gnu.org>
parents:
diff changeset
1091 @end menu
Dave Love <fx@gnu.org>
parents:
diff changeset
1092
Dave Love <fx@gnu.org>
parents:
diff changeset
1093 @node Theorem and Axiom, Quick Equation, , Defining Label Environments
Dave Love <fx@gnu.org>
parents:
diff changeset
1094 @subsection Theorem and Axiom Environments
Dave Love <fx@gnu.org>
parents:
diff changeset
1095 @cindex @code{theorem}, newtheorem
Dave Love <fx@gnu.org>
parents:
diff changeset
1096 @cindex @code{axiom}, newtheorem
Dave Love <fx@gnu.org>
parents:
diff changeset
1097 @cindex @code{\newtheorem}
Dave Love <fx@gnu.org>
parents:
diff changeset
1098
Dave Love <fx@gnu.org>
parents:
diff changeset
1099 Suppose you are using @code{\newtheorem} in LaTeX in order to define two
Dave Love <fx@gnu.org>
parents:
diff changeset
1100 new environments, @code{theorem} and @code{axiom}@refill
Dave Love <fx@gnu.org>
parents:
diff changeset
1101
Dave Love <fx@gnu.org>
parents:
diff changeset
1102 @example
Dave Love <fx@gnu.org>
parents:
diff changeset
1103 \newtheorem@{axiom@}@{Axiom@}
Dave Love <fx@gnu.org>
parents:
diff changeset
1104 \newtheorem@{theorem@}@{Theorem@}
Dave Love <fx@gnu.org>
parents:
diff changeset
1105 @end example
Dave Love <fx@gnu.org>
parents:
diff changeset
1106
Dave Love <fx@gnu.org>
parents:
diff changeset
1107 @noindent
Dave Love <fx@gnu.org>
parents:
diff changeset
1108 to be used like this:
Dave Love <fx@gnu.org>
parents:
diff changeset
1109
Dave Love <fx@gnu.org>
parents:
diff changeset
1110 @example
Dave Love <fx@gnu.org>
parents:
diff changeset
1111 \begin@{axiom@}
Dave Love <fx@gnu.org>
parents:
diff changeset
1112 \label@{ax:first@}
Dave Love <fx@gnu.org>
parents:
diff changeset
1113 ....
Dave Love <fx@gnu.org>
parents:
diff changeset
1114 \end@{axiom@}
Dave Love <fx@gnu.org>
parents:
diff changeset
1115 @end example
Dave Love <fx@gnu.org>
parents:
diff changeset
1116
Dave Love <fx@gnu.org>
parents:
diff changeset
1117 So we need to tell @b{Ref@TeX{}} that @code{theorem} and @code{axiom} are new
Dave Love <fx@gnu.org>
parents:
diff changeset
1118 labeled environments which define their own label categories. We can
Dave Love <fx@gnu.org>
parents:
diff changeset
1119 either use Lisp to do this (e.g. in @file{.emacs}) or use the custom
Dave Love <fx@gnu.org>
parents:
diff changeset
1120 library. With Lisp it would look like this
Dave Love <fx@gnu.org>
parents:
diff changeset
1121
Dave Love <fx@gnu.org>
parents:
diff changeset
1122 @lisp
Dave Love <fx@gnu.org>
parents:
diff changeset
1123 (setq reftex-label-alist
26911
d7f536a01276 Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents: 25829
diff changeset
1124 '(("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
1125 ("theorem" ?h "thr:" "~\\ref@{%s@}" t ("theorem" "th.") -3)))
25829
Dave Love <fx@gnu.org>
parents:
diff changeset
1126 @end lisp
Dave Love <fx@gnu.org>
parents:
diff changeset
1127
Dave Love <fx@gnu.org>
parents:
diff changeset
1128 The type indicator characters @code{?a} and @code{?h} are used for
Dave Love <fx@gnu.org>
parents:
diff changeset
1129 prompts when @b{Ref@TeX{}} queries for a label type. @code{?h}
Dave Love <fx@gnu.org>
parents:
diff changeset
1130 was chosen for @code{theorem} since @code{?t} is already taken by
Dave Love <fx@gnu.org>
parents:
diff changeset
1131 @code{table}. Note that also @code{?s}, @code{?f}, @code{?e},
Dave Love <fx@gnu.org>
parents:
diff changeset
1132 @code{?i}, @code{?n} are already used for standard environments.@refill
Dave Love <fx@gnu.org>
parents:
diff changeset
1133
Dave Love <fx@gnu.org>
parents:
diff changeset
1134 @noindent
Dave Love <fx@gnu.org>
parents:
diff changeset
1135 The labels for Axioms and Theorems will have the prefixes @samp{ax:} and
Dave Love <fx@gnu.org>
parents:
diff changeset
1136 @samp{thr:}, respectively. @xref{AUCTeX}, for information on how
Dave Love <fx@gnu.org>
parents:
diff changeset
1137 AUCTeX can use @b{Ref@TeX{}} to automatically create labels when a new
Dave Love <fx@gnu.org>
parents:
diff changeset
1138 environment is inserted into a buffer.@refill
Dave Love <fx@gnu.org>
parents:
diff changeset
1139
Dave Love <fx@gnu.org>
parents:
diff changeset
1140 @noindent
Dave Love <fx@gnu.org>
parents:
diff changeset
1141 The @samp{~\ref@{%s@}} is a format string indicating how to insert
Dave Love <fx@gnu.org>
parents:
diff changeset
1142 references to these labels.@refill
Dave Love <fx@gnu.org>
parents:
diff changeset
1143
Dave Love <fx@gnu.org>
parents:
diff changeset
1144 @noindent
Dave Love <fx@gnu.org>
parents:
diff changeset
1145 The next item indicates how to grab context of the label definition.@refill
Dave Love <fx@gnu.org>
parents:
diff changeset
1146 @itemize @minus
Dave Love <fx@gnu.org>
parents:
diff changeset
1147 @item
Dave Love <fx@gnu.org>
parents:
diff changeset
1148 @code{t} means to get it from a default location (from the beginning of
Dave Love <fx@gnu.org>
parents:
diff changeset
1149 a @code{\macro} or after the @code{\begin} statement). @code{t} is
Dave Love <fx@gnu.org>
parents:
diff changeset
1150 @emph{not} a good choice for eqnarray and similar environments.@refill
Dave Love <fx@gnu.org>
parents:
diff changeset
1151 @item
Dave Love <fx@gnu.org>
parents:
diff changeset
1152 @code{nil} means to use the text right after the label definition.@refill
Dave Love <fx@gnu.org>
parents:
diff changeset
1153 @item
Dave Love <fx@gnu.org>
parents:
diff changeset
1154 For more complex ways of getting context, see the variable
Dave Love <fx@gnu.org>
parents:
diff changeset
1155 @code{reftex-label-alist} (@ref{Options (Defining Label
Dave Love <fx@gnu.org>
parents:
diff changeset
1156 Environments)}).@refill
Dave Love <fx@gnu.org>
parents:
diff changeset
1157 @end itemize
Dave Love <fx@gnu.org>
parents:
diff changeset
1158
26911
d7f536a01276 Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents: 25829
diff changeset
1159 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
1160 from the word before point when creating a reference. E.g. if you
25829
Dave Love <fx@gnu.org>
parents:
diff changeset
1161 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
1162 @b{Ref@TeX{}} will know that you are looking for a theorem label and
d7f536a01276 Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents: 25829
diff changeset
1163 restrict the menu to only these labels without even asking.@refill
d7f536a01276 Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents: 25829
diff changeset
1164
d7f536a01276 Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents: 25829
diff changeset
1165 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
1166 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
1167 positive, the environment will produce numbered entries (like
d7f536a01276 Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents: 25829
diff changeset
1168 @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
1169 @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
1170 document similar to sectioning commands. For everything else, omit the
d7f536a01276 Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents: 25829
diff changeset
1171 item.@refill
25829
Dave Love <fx@gnu.org>
parents:
diff changeset
1172
Dave Love <fx@gnu.org>
parents:
diff changeset
1173 To do the same configuration with @code{customize}, you need to click on
Dave Love <fx@gnu.org>
parents:
diff changeset
1174 the @code{[INS]} button twice to create two templates and fill them in
Dave Love <fx@gnu.org>
parents:
diff changeset
1175 like this:@refill
Dave Love <fx@gnu.org>
parents:
diff changeset
1176
Dave Love <fx@gnu.org>
parents:
diff changeset
1177 @example
Dave Love <fx@gnu.org>
parents:
diff changeset
1178 Reftex Label Alist: [Hide]
Dave Love <fx@gnu.org>
parents:
diff changeset
1179 [INS] [DEL] Package or Detailed : [Value Menu] Detailed:
Dave Love <fx@gnu.org>
parents:
diff changeset
1180 Environment or \macro : [Value Menu] String: axiom
Dave Love <fx@gnu.org>
parents:
diff changeset
1181 Type specification : [Value Menu] Char : a
Dave Love <fx@gnu.org>
parents:
diff changeset
1182 Label prefix string : [Value Menu] String: ax:
Dave Love <fx@gnu.org>
parents:
diff changeset
1183 Label reference format: [Value Menu] String: ~\ref@{%s@}
Dave Love <fx@gnu.org>
parents:
diff changeset
1184 Context method : [Value Menu] After label
Dave Love <fx@gnu.org>
parents:
diff changeset
1185 Magic words:
Dave Love <fx@gnu.org>
parents:
diff changeset
1186 [INS] [DEL] String: axiom
Dave Love <fx@gnu.org>
parents:
diff changeset
1187 [INS] [DEL] String: ax.
Dave Love <fx@gnu.org>
parents:
diff changeset
1188 [INS]
26911
d7f536a01276 Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents: 25829
diff changeset
1189 [X] Make TOC entry : [Value Menu] Level: -2
25829
Dave Love <fx@gnu.org>
parents:
diff changeset
1190 [INS] [DEL] Package or Detailed : [Value Menu] Detailed:
Dave Love <fx@gnu.org>
parents:
diff changeset
1191 Environment or \macro : [Value Menu] String: theorem
Dave Love <fx@gnu.org>
parents:
diff changeset
1192 Type specification : [Value Menu] Char : h
Dave Love <fx@gnu.org>
parents:
diff changeset
1193 Label prefix string : [Value Menu] String: thr:
Dave Love <fx@gnu.org>
parents:
diff changeset
1194 Label reference format: [Value Menu] String: ~\ref@{%s@}
Dave Love <fx@gnu.org>
parents:
diff changeset
1195 Context method : [Value Menu] Default position
Dave Love <fx@gnu.org>
parents:
diff changeset
1196 Magic words:
Dave Love <fx@gnu.org>
parents:
diff changeset
1197 [INS] [DEL] String: theorem
Dave Love <fx@gnu.org>
parents:
diff changeset
1198 [INS] [DEL] String: theor.
Dave Love <fx@gnu.org>
parents:
diff changeset
1199 [INS] [DEL] String: th.
Dave Love <fx@gnu.org>
parents:
diff changeset
1200 [INS]
26911
d7f536a01276 Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents: 25829
diff changeset
1201 [X] Make TOC entry : [Value Menu] Level: -3
25829
Dave Love <fx@gnu.org>
parents:
diff changeset
1202 @end example
Dave Love <fx@gnu.org>
parents:
diff changeset
1203
Dave Love <fx@gnu.org>
parents:
diff changeset
1204 @vindex reftex-insert-label-flags
Dave Love <fx@gnu.org>
parents:
diff changeset
1205 @vindex reftex-label-menu-flags
Dave Love <fx@gnu.org>
parents:
diff changeset
1206 Depending on how you would like the label insertion and selection for
Dave Love <fx@gnu.org>
parents:
diff changeset
1207 the new environments to work, you might want to add the letters @samp{a}
Dave Love <fx@gnu.org>
parents:
diff changeset
1208 and @samp{h} to some of the flags in the variables
Dave Love <fx@gnu.org>
parents:
diff changeset
1209 @code{reftex-insert-label-flags} (@pxref{Options (Creating Labels)})
Dave Love <fx@gnu.org>
parents:
diff changeset
1210 and @code{reftex-label-menu-flags} (@pxref{Options (Referencing
Dave Love <fx@gnu.org>
parents:
diff changeset
1211 Labels)}).@refill
Dave Love <fx@gnu.org>
parents:
diff changeset
1212
Dave Love <fx@gnu.org>
parents:
diff changeset
1213
Dave Love <fx@gnu.org>
parents:
diff changeset
1214 @node Quick Equation, Figure Wrapper, Theorem and Axiom , Defining Label Environments
Dave Love <fx@gnu.org>
parents:
diff changeset
1215 @subsection Quick Equation Macro
Dave Love <fx@gnu.org>
parents:
diff changeset
1216 @cindex Quick equation macro
Dave Love <fx@gnu.org>
parents:
diff changeset
1217 @cindex Macros as environment wrappers
Dave Love <fx@gnu.org>
parents:
diff changeset
1218
Dave Love <fx@gnu.org>
parents:
diff changeset
1219 Suppose you would like to have a macro for quick equations. It
Dave Love <fx@gnu.org>
parents:
diff changeset
1220 could be defined like this:
Dave Love <fx@gnu.org>
parents:
diff changeset
1221
Dave Love <fx@gnu.org>
parents:
diff changeset
1222 @example
Dave Love <fx@gnu.org>
parents:
diff changeset
1223 \newcommand@{\quickeq@}[1]@{\begin@{equation@} #1 \end@{equation@}@}
Dave Love <fx@gnu.org>
parents:
diff changeset
1224 @end example
Dave Love <fx@gnu.org>
parents:
diff changeset
1225
Dave Love <fx@gnu.org>
parents:
diff changeset
1226 @noindent
Dave Love <fx@gnu.org>
parents:
diff changeset
1227 and used like this:
Dave Love <fx@gnu.org>
parents:
diff changeset
1228
Dave Love <fx@gnu.org>
parents:
diff changeset
1229 @example
Dave Love <fx@gnu.org>
parents:
diff changeset
1230 Einstein's equation is \quickeq@{E=mc^2 \label@{eq:einstein@}@}.
Dave Love <fx@gnu.org>
parents:
diff changeset
1231 @end example
Dave Love <fx@gnu.org>
parents:
diff changeset
1232
Dave Love <fx@gnu.org>
parents:
diff changeset
1233 We need to tell @b{Ref@TeX{}} that any label defined in the argument of the
Dave Love <fx@gnu.org>
parents:
diff changeset
1234 @code{\quickeq} is an equation label. Here is how to do this with lisp:
Dave Love <fx@gnu.org>
parents:
diff changeset
1235
Dave Love <fx@gnu.org>
parents:
diff changeset
1236 @lisp
Dave Love <fx@gnu.org>
parents:
diff changeset
1237 (setq reftex-label-alist '(("\\quickeq@{@}" ?e nil nil 1 nil)))
Dave Love <fx@gnu.org>
parents:
diff changeset
1238 @end lisp
Dave Love <fx@gnu.org>
parents:
diff changeset
1239
Dave Love <fx@gnu.org>
parents:
diff changeset
1240 The first element in this list is now the macro with empty braces as an
Dave Love <fx@gnu.org>
parents:
diff changeset
1241 @emph{image} of the macro arguments. @code{?e} indicates that this is
Dave Love <fx@gnu.org>
parents:
diff changeset
1242 an equation label, the different @code{nil} elements indicate to use the
Dave Love <fx@gnu.org>
parents:
diff changeset
1243 default values for equations. The @samp{1} as the fifth element
Dave Love <fx@gnu.org>
parents:
diff changeset
1244 indicates that the context of the label definition should be the 1st
Dave Love <fx@gnu.org>
parents:
diff changeset
1245 argument of the macro.@refill
Dave Love <fx@gnu.org>
parents:
diff changeset
1246
Dave Love <fx@gnu.org>
parents:
diff changeset
1247 Here is again how this would look in the customization buffer:
Dave Love <fx@gnu.org>
parents:
diff changeset
1248
Dave Love <fx@gnu.org>
parents:
diff changeset
1249 @example
Dave Love <fx@gnu.org>
parents:
diff changeset
1250 Reftex Label Alist: [Hide]
Dave Love <fx@gnu.org>
parents:
diff changeset
1251 [INS] [DEL] Package or Detailed : [Value Menu] Detailed:
Dave Love <fx@gnu.org>
parents:
diff changeset
1252 Environment or \macro : [Value Menu] String: \quickeq@{@}
Dave Love <fx@gnu.org>
parents:
diff changeset
1253 Type specification : [Value Menu] Char : e
Dave Love <fx@gnu.org>
parents:
diff changeset
1254 Label prefix string : [Value Menu] Default
Dave Love <fx@gnu.org>
parents:
diff changeset
1255 Label reference format: [Value Menu] Default
Dave Love <fx@gnu.org>
parents:
diff changeset
1256 Context method : [Value Menu] Macro arg nr: 1
Dave Love <fx@gnu.org>
parents:
diff changeset
1257 Magic words:
Dave Love <fx@gnu.org>
parents:
diff changeset
1258 [INS]
26911
d7f536a01276 Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents: 25829
diff changeset
1259 [ ] Make TOC entry : [Value Menu] No entry
25829
Dave Love <fx@gnu.org>
parents:
diff changeset
1260 @end example
Dave Love <fx@gnu.org>
parents:
diff changeset
1261
Dave Love <fx@gnu.org>
parents:
diff changeset
1262 @node Figure Wrapper, Adding Magic Words, Quick Equation, Defining Label Environments
Dave Love <fx@gnu.org>
parents:
diff changeset
1263 @subsection Figure Wrapping Macro
Dave Love <fx@gnu.org>
parents:
diff changeset
1264 @cindex Macros as environment wrappers
Dave Love <fx@gnu.org>
parents:
diff changeset
1265 @cindex Figure wrapping macro
Dave Love <fx@gnu.org>
parents:
diff changeset
1266
Dave Love <fx@gnu.org>
parents:
diff changeset
1267 Suppose you want to make figures not directly with the figure
Dave Love <fx@gnu.org>
parents:
diff changeset
1268 environment, but with a macro like
Dave Love <fx@gnu.org>
parents:
diff changeset
1269
Dave Love <fx@gnu.org>
parents:
diff changeset
1270 @example
Dave Love <fx@gnu.org>
parents:
diff changeset
1271 \newcommand@{\myfig@}[5][tbp]@{%
Dave Love <fx@gnu.org>
parents:
diff changeset
1272 \begin@{figure@}[#1]
Dave Love <fx@gnu.org>
parents:
diff changeset
1273 \epsimp[#5]@{#2@}
Dave Love <fx@gnu.org>
parents:
diff changeset
1274 \caption@{#3@}
Dave Love <fx@gnu.org>
parents:
diff changeset
1275 \label@{#4@}
Dave Love <fx@gnu.org>
parents:
diff changeset
1276 \end@{figure@}@}
Dave Love <fx@gnu.org>
parents:
diff changeset
1277 @end example
Dave Love <fx@gnu.org>
parents:
diff changeset
1278
Dave Love <fx@gnu.org>
parents:
diff changeset
1279 @noindent
Dave Love <fx@gnu.org>
parents:
diff changeset
1280 which would be called like
Dave Love <fx@gnu.org>
parents:
diff changeset
1281
Dave Love <fx@gnu.org>
parents:
diff changeset
1282 @example
Dave Love <fx@gnu.org>
parents:
diff changeset
1283 \myfig[htp]@{filename@}@{caption text@}@{label@}@{1@}
Dave Love <fx@gnu.org>
parents:
diff changeset
1284 @end example
Dave Love <fx@gnu.org>
parents:
diff changeset
1285
Dave Love <fx@gnu.org>
parents:
diff changeset
1286 Now we need to tell @b{Ref@TeX{}} that the 4th argument of the
Dave Love <fx@gnu.org>
parents:
diff changeset
1287 @code{\myfig} macro @emph{is itself} a figure label, and where to find
Dave Love <fx@gnu.org>
parents:
diff changeset
1288 the context.@refill
Dave Love <fx@gnu.org>
parents:
diff changeset
1289
Dave Love <fx@gnu.org>
parents:
diff changeset
1290 @lisp
Dave Love <fx@gnu.org>
parents:
diff changeset
1291 (setq reftex-label-alist
Dave Love <fx@gnu.org>
parents:
diff changeset
1292 '(("\\myfig[]@{@}@{@}@{*@}@{@}" ?f nil nil 3)))
Dave Love <fx@gnu.org>
parents:
diff changeset
1293 @end lisp
Dave Love <fx@gnu.org>
parents:
diff changeset
1294
Dave Love <fx@gnu.org>
parents:
diff changeset
1295 The empty pairs of brackets indicate the different arguments of the
Dave Love <fx@gnu.org>
parents:
diff changeset
1296 @code{\myfig} macro. The @samp{*} marks the label argument. @code{?f}
Dave Love <fx@gnu.org>
parents:
diff changeset
1297 indicates that this is a figure label which will be listed together with
Dave Love <fx@gnu.org>
parents:
diff changeset
1298 labels from normal figure environments. The @code{nil} entries for
Dave Love <fx@gnu.org>
parents:
diff changeset
1299 prefix and reference format mean to use the defaults for figure labels.
Dave Love <fx@gnu.org>
parents:
diff changeset
1300 The @samp{3} for the context method means to grab the 3rd macro argument
Dave Love <fx@gnu.org>
parents:
diff changeset
1301 - the caption.@refill
Dave Love <fx@gnu.org>
parents:
diff changeset
1302
Dave Love <fx@gnu.org>
parents:
diff changeset
1303 As a side effect of this configuration, @code{reftex-label} will now
Dave Love <fx@gnu.org>
parents:
diff changeset
1304 insert the required naked label (without the @code{\label} macro) when
Dave Love <fx@gnu.org>
parents:
diff changeset
1305 point is directly after the opening parenthesis of a @code{\myfig} macro
Dave Love <fx@gnu.org>
parents:
diff changeset
1306 argument.@refill
Dave Love <fx@gnu.org>
parents:
diff changeset
1307
Dave Love <fx@gnu.org>
parents:
diff changeset
1308 Again, here the configuration in the customization buffer:
Dave Love <fx@gnu.org>
parents:
diff changeset
1309
Dave Love <fx@gnu.org>
parents:
diff changeset
1310 @example
Dave Love <fx@gnu.org>
parents:
diff changeset
1311 [INS] [DEL] Package or Detailed : [Value Menu] Detailed:
Dave Love <fx@gnu.org>
parents:
diff changeset
1312 Environment or \macro : [Value Menu] String: \myfig[]@{@}@{@}@{*@}@{@}
Dave Love <fx@gnu.org>
parents:
diff changeset
1313 Type specification : [Value Menu] Char : f
Dave Love <fx@gnu.org>
parents:
diff changeset
1314 Label prefix string : [Value Menu] Default
Dave Love <fx@gnu.org>
parents:
diff changeset
1315 Label reference format: [Value Menu] Default
Dave Love <fx@gnu.org>
parents:
diff changeset
1316 Context method : [Value Menu] Macro arg nr: 3
Dave Love <fx@gnu.org>
parents:
diff changeset
1317 Magic words:
Dave Love <fx@gnu.org>
parents:
diff changeset
1318 [INS]
26911
d7f536a01276 Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents: 25829
diff changeset
1319 [ ] Make TOC entry : [Value Menu] No entry
25829
Dave Love <fx@gnu.org>
parents:
diff changeset
1320 @end example
Dave Love <fx@gnu.org>
parents:
diff changeset
1321
Dave Love <fx@gnu.org>
parents:
diff changeset
1322 @node Adding Magic Words, Using \eqref, Figure Wrapper, Defining Label Environments
Dave Love <fx@gnu.org>
parents:
diff changeset
1323 @subsection Adding Magic Words
Dave Love <fx@gnu.org>
parents:
diff changeset
1324 @cindex Magic words
Dave Love <fx@gnu.org>
parents:
diff changeset
1325 @cindex German magic words
Dave Love <fx@gnu.org>
parents:
diff changeset
1326 @cindex Label category
Dave Love <fx@gnu.org>
parents:
diff changeset
1327
Dave Love <fx@gnu.org>
parents:
diff changeset
1328 Sometimes you don't want to define a new label environment or macro, but
Dave Love <fx@gnu.org>
parents:
diff changeset
1329 just change the information associated with a label category. Maybe you
Dave Love <fx@gnu.org>
parents:
diff changeset
1330 want to add some magic words, for another language. Changing only the
Dave Love <fx@gnu.org>
parents:
diff changeset
1331 information associated with a label category is done by giving
Dave Love <fx@gnu.org>
parents:
diff changeset
1332 @code{nil} for the environment name and then specify the items you want
Dave Love <fx@gnu.org>
parents:
diff changeset
1333 to define. Here is an example which adds German magic words to all
Dave Love <fx@gnu.org>
parents:
diff changeset
1334 predefined label categories.@refill
Dave Love <fx@gnu.org>
parents:
diff changeset
1335
Dave Love <fx@gnu.org>
parents:
diff changeset
1336 @lisp
Dave Love <fx@gnu.org>
parents:
diff changeset
1337 (setq reftex-label-alist
Dave Love <fx@gnu.org>
parents:
diff changeset
1338 '((nil ?s nil nil nil ("Kapitel" "Kap." "Abschnitt" "Teil"))
Dave Love <fx@gnu.org>
parents:
diff changeset
1339 (nil ?e nil nil nil ("Gleichung" "Gl."))
Dave Love <fx@gnu.org>
parents:
diff changeset
1340 (nil ?t nil nil nil ("Tabelle"))
Dave Love <fx@gnu.org>
parents:
diff changeset
1341 (nil ?f nil nil nil ("Figur" "Abbildung" "Abb."))
Dave Love <fx@gnu.org>
parents:
diff changeset
1342 (nil ?n nil nil nil ("Anmerkung" "Anm."))
Dave Love <fx@gnu.org>
parents:
diff changeset
1343 (nil ?i nil nil nil ("Punkt"))))
Dave Love <fx@gnu.org>
parents:
diff changeset
1344 @end lisp
Dave Love <fx@gnu.org>
parents:
diff changeset
1345
Dave Love <fx@gnu.org>
parents:
diff changeset
1346 @node Using \eqref, Non-Standard Environments, Adding Magic Words, Defining Label Environments
Dave Love <fx@gnu.org>
parents:
diff changeset
1347 @subsection Using @code{\eqref}
Dave Love <fx@gnu.org>
parents:
diff changeset
1348 @cindex @code{\eqref}, AMS-LaTeX macro
Dave Love <fx@gnu.org>
parents:
diff changeset
1349 @cindex AMS-LaTeX
Dave Love <fx@gnu.org>
parents:
diff changeset
1350 @cindex Label category
Dave Love <fx@gnu.org>
parents:
diff changeset
1351
Dave Love <fx@gnu.org>
parents:
diff changeset
1352 Another case where one only wants to change the information associated
Dave Love <fx@gnu.org>
parents:
diff changeset
1353 with the label category is to change the macro which is used for
Dave Love <fx@gnu.org>
parents:
diff changeset
1354 referencing the label. When working with the AMS-LaTeX stuff, you might
Dave Love <fx@gnu.org>
parents:
diff changeset
1355 prefer @code{\eqref} for doing equation references. Here is how to
Dave Love <fx@gnu.org>
parents:
diff changeset
1356 do this:
Dave Love <fx@gnu.org>
parents:
diff changeset
1357
Dave Love <fx@gnu.org>
parents:
diff changeset
1358 @lisp
Dave Love <fx@gnu.org>
parents:
diff changeset
1359 (setq reftex-label-alist '((nil ?e nil "~\\eqref@{%s@}" nil nil)))
Dave Love <fx@gnu.org>
parents:
diff changeset
1360 @end lisp
Dave Love <fx@gnu.org>
parents:
diff changeset
1361
Dave Love <fx@gnu.org>
parents:
diff changeset
1362 @b{Ref@TeX{}} has also a predefined symbol for this special purpose. The
Dave Love <fx@gnu.org>
parents:
diff changeset
1363 following is equivalent to the line above.@refill
Dave Love <fx@gnu.org>
parents:
diff changeset
1364
Dave Love <fx@gnu.org>
parents:
diff changeset
1365 @lisp
Dave Love <fx@gnu.org>
parents:
diff changeset
1366 (setq reftex-label-alist '(AMSTeX))
Dave Love <fx@gnu.org>
parents:
diff changeset
1367 @end lisp
Dave Love <fx@gnu.org>
parents:
diff changeset
1368
Dave Love <fx@gnu.org>
parents:
diff changeset
1369 Note that this is automatically done by the @file{amsmath.el} style file
Dave Love <fx@gnu.org>
parents:
diff changeset
1370 of AUCTeX (@pxref{Style Files}) - so if you use AUCTeX,
Dave Love <fx@gnu.org>
parents:
diff changeset
1371 this configuration will not be necessary.@refill
Dave Love <fx@gnu.org>
parents:
diff changeset
1372
Dave Love <fx@gnu.org>
parents:
diff changeset
1373 @node Non-Standard Environments, Putting it Together, Using \eqref, Defining Label Environments
Dave Love <fx@gnu.org>
parents:
diff changeset
1374 @subsection Non-standard Environments
Dave Love <fx@gnu.org>
parents:
diff changeset
1375 @cindex Non-standard environments
Dave Love <fx@gnu.org>
parents:
diff changeset
1376 @cindex Environments without @code{\begin}
Dave Love <fx@gnu.org>
parents:
diff changeset
1377 @cindex Special parser functions
Dave Love <fx@gnu.org>
parents:
diff changeset
1378 @cindex Parser functions, for special environments
Dave Love <fx@gnu.org>
parents:
diff changeset
1379
Dave Love <fx@gnu.org>
parents:
diff changeset
1380 Some LaTeX packages define environment-like structures without using the
Dave Love <fx@gnu.org>
parents:
diff changeset
1381 standard @samp{\begin..\end} structure. @b{Ref@TeX{}} cannot parse
Dave Love <fx@gnu.org>
parents:
diff changeset
1382 these directly, but you can write your own special-purpose parser and
Dave Love <fx@gnu.org>
parents:
diff changeset
1383 use it instead of the name of an environment in an entry for
Dave Love <fx@gnu.org>
parents:
diff changeset
1384 @code{reftex-label-alist}. The function should check if point is
Dave Love <fx@gnu.org>
parents:
diff changeset
1385 currently in the special environment it was written to detect. If so,
Dave Love <fx@gnu.org>
parents:
diff changeset
1386 it must return a buffer position indicating the start of this
Dave Love <fx@gnu.org>
parents:
diff changeset
1387 environment. The return value must be @code{nil} on failure to detect
Dave Love <fx@gnu.org>
parents:
diff changeset
1388 the environment. The function is called with one argument @var{bound}.
Dave Love <fx@gnu.org>
parents:
diff changeset
1389 If non-@code{nil}, @var{bound} is a boundary for backwards searches
Dave Love <fx@gnu.org>
parents:
diff changeset
1390 which should be observed. We will discuss two examples.@refill
Dave Love <fx@gnu.org>
parents:
diff changeset
1391
Dave Love <fx@gnu.org>
parents:
diff changeset
1392 @cindex LaTeX commands, abbreviated
Dave Love <fx@gnu.org>
parents:
diff changeset
1393
Dave Love <fx@gnu.org>
parents:
diff changeset
1394 Some people define abbreviations for
Dave Love <fx@gnu.org>
parents:
diff changeset
1395 environments, like @code{\be} for @code{\begin@{equation@}}, and
Dave Love <fx@gnu.org>
parents:
diff changeset
1396 @code{\ee} for @code{\end@{equation@}}. The parser function would have
Dave Love <fx@gnu.org>
parents:
diff changeset
1397 to search backward for these macros. When the first match is
Dave Love <fx@gnu.org>
parents:
diff changeset
1398 @code{\ee}, point is not in this environment. When the first match is
Dave Love <fx@gnu.org>
parents:
diff changeset
1399 @code{\be}, point is in this environment and the function must return
Dave Love <fx@gnu.org>
parents:
diff changeset
1400 the beginning of the match. To avoid scanning too far, we can also look
Dave Love <fx@gnu.org>
parents:
diff changeset
1401 for empty lines which cannot occure inside an equation environment.
Dave Love <fx@gnu.org>
parents:
diff changeset
1402 Here is the setup:@refill
Dave Love <fx@gnu.org>
parents:
diff changeset
1403
Dave Love <fx@gnu.org>
parents:
diff changeset
1404 @lisp
Dave Love <fx@gnu.org>
parents:
diff changeset
1405 ;; Setup entry in reftex-label-alist, using all defaults for equations
Dave Love <fx@gnu.org>
parents:
diff changeset
1406 (setq reftex-label-alist '((detect-be-ee ?e nil nil nil nil)))
Dave Love <fx@gnu.org>
parents:
diff changeset
1407
Dave Love <fx@gnu.org>
parents:
diff changeset
1408 (defun detect-be-ee (bound)
Dave Love <fx@gnu.org>
parents:
diff changeset
1409 ;; Search backward for the macros or an empty line
Dave Love <fx@gnu.org>
parents:
diff changeset
1410 (if (re-search-backward
Dave Love <fx@gnu.org>
parents:
diff changeset
1411 "\\(^[ \t]*\n\\|\\\\ee\\>\\)\\|\\(\\\\be\\>\\)" bound t)
Dave Love <fx@gnu.org>
parents:
diff changeset
1412 (if (match-beginning 2)
Dave Love <fx@gnu.org>
parents:
diff changeset
1413 (match-beginning 2) ; Return start of environment
Dave Love <fx@gnu.org>
parents:
diff changeset
1414 nil) ; Return nil because env is closed
Dave Love <fx@gnu.org>
parents:
diff changeset
1415 nil)) ; Return nil for not found
Dave Love <fx@gnu.org>
parents:
diff changeset
1416 @end lisp
Dave Love <fx@gnu.org>
parents:
diff changeset
1417
Dave Love <fx@gnu.org>
parents:
diff changeset
1418 @cindex @code{linguex}, LaTeX package
Dave Love <fx@gnu.org>
parents:
diff changeset
1419 @cindex LaTeX packages, @code{linguex}
Dave Love <fx@gnu.org>
parents:
diff changeset
1420 A more complex example is the @file{linguex.sty} package which defines
Dave Love <fx@gnu.org>
parents:
diff changeset
1421 list macros @samp{\ex.}, @samp{\a.}, @samp{\b.} etc. for lists which are
Dave Love <fx@gnu.org>
parents:
diff changeset
1422 terminated by @samp{\z.} or by an empty line.@refill
Dave Love <fx@gnu.org>
parents:
diff changeset
1423
Dave Love <fx@gnu.org>
parents:
diff changeset
1424 @example
Dave Love <fx@gnu.org>
parents:
diff changeset
1425 \ex. \label@{ex:12@} Some text in an exotic language ...
Dave Love <fx@gnu.org>
parents:
diff changeset
1426 \a. \label@{ex:13@} more stuff
Dave Love <fx@gnu.org>
parents:
diff changeset
1427 \b. \label@{ex:14@} still more stuff
Dave Love <fx@gnu.org>
parents:
diff changeset
1428 \a. List on a deeper level
Dave Love <fx@gnu.org>
parents:
diff changeset
1429 \b. Another item
Dave Love <fx@gnu.org>
parents:
diff changeset
1430 \b. and the third one
Dave Love <fx@gnu.org>
parents:
diff changeset
1431 \z.
Dave Love <fx@gnu.org>
parents:
diff changeset
1432 \b. Third item on this level.
Dave Love <fx@gnu.org>
parents:
diff changeset
1433
Dave Love <fx@gnu.org>
parents:
diff changeset
1434 ... text after the empty line terminating all lists
Dave Love <fx@gnu.org>
parents:
diff changeset
1435 @end example
Dave Love <fx@gnu.org>
parents:
diff changeset
1436
Dave Love <fx@gnu.org>
parents:
diff changeset
1437 The difficulty is that the @samp{\a.} lists can nest and that an empty
Dave Love <fx@gnu.org>
parents:
diff changeset
1438 line terminates all list levels in one go. So we have to count nesting
Dave Love <fx@gnu.org>
parents:
diff changeset
1439 levels between @samp{\a.} and @samp{\z.}. Here is the implementation
Dave Love <fx@gnu.org>
parents:
diff changeset
1440 for @b{Ref@TeX{}}.
Dave Love <fx@gnu.org>
parents:
diff changeset
1441
Dave Love <fx@gnu.org>
parents:
diff changeset
1442 @lisp
Dave Love <fx@gnu.org>
parents:
diff changeset
1443 (setq reftex-label-alist
Dave Love <fx@gnu.org>
parents:
diff changeset
1444 '((detect-linguex ?x "ex:" "~\\ref@{%s@}" nil ("Example" "Ex."))))
Dave Love <fx@gnu.org>
parents:
diff changeset
1445
Dave Love <fx@gnu.org>
parents:
diff changeset
1446 (defun detect-linguex (bound)
Dave Love <fx@gnu.org>
parents:
diff changeset
1447 (let ((cnt 0))
Dave Love <fx@gnu.org>
parents:
diff changeset
1448 (catch 'exit
Dave Love <fx@gnu.org>
parents:
diff changeset
1449 (while
Dave Love <fx@gnu.org>
parents:
diff changeset
1450 ;; Search backward for all possible delimiters
Dave Love <fx@gnu.org>
parents:
diff changeset
1451 (re-search-backward
Dave Love <fx@gnu.org>
parents:
diff changeset
1452 (concat "\\(^[ \t]*\n\\)\\|\\(\\\\z\\.\\)\\|"
Dave Love <fx@gnu.org>
parents:
diff changeset
1453 "\\(\\ex[ig]?\\.\\)\\|\\(\\\\a\\.\\)")
Dave Love <fx@gnu.org>
parents:
diff changeset
1454 nil t)
Dave Love <fx@gnu.org>
parents:
diff changeset
1455 ;; Check which delimiter was matched.
Dave Love <fx@gnu.org>
parents:
diff changeset
1456 (cond
Dave Love <fx@gnu.org>
parents:
diff changeset
1457 ((match-beginning 1)
Dave Love <fx@gnu.org>
parents:
diff changeset
1458 ;; empty line terminates all - return nil
Dave Love <fx@gnu.org>
parents:
diff changeset
1459 (throw 'exit nil))
Dave Love <fx@gnu.org>
parents:
diff changeset
1460 ((match-beginning 2)
Dave Love <fx@gnu.org>
parents:
diff changeset
1461 ;; \z. terminates one list level - decrease nesting count
Dave Love <fx@gnu.org>
parents:
diff changeset
1462 (decf cnt))
Dave Love <fx@gnu.org>
parents:
diff changeset
1463 ((match-beginning 3)
Dave Love <fx@gnu.org>
parents:
diff changeset
1464 ;; \ex. : return match unless there was a \z. on this level
Dave Love <fx@gnu.org>
parents:
diff changeset
1465 (throw 'exit (if (>= cnt 0) (match-beginning 3) nil)))
Dave Love <fx@gnu.org>
parents:
diff changeset
1466 ((match-beginning 4)
Dave Love <fx@gnu.org>
parents:
diff changeset
1467 ;; \a. : return match when on level 0, otherwise
Dave Love <fx@gnu.org>
parents:
diff changeset
1468 ;; increment nesting count
Dave Love <fx@gnu.org>
parents:
diff changeset
1469 (if (>= cnt 0)
Dave Love <fx@gnu.org>
parents:
diff changeset
1470 (throw 'exit (match-beginning 4))
Dave Love <fx@gnu.org>
parents:
diff changeset
1471 (incf cnt))))))))
Dave Love <fx@gnu.org>
parents:
diff changeset
1472 @end lisp
Dave Love <fx@gnu.org>
parents:
diff changeset
1473
Dave Love <fx@gnu.org>
parents:
diff changeset
1474 @node Putting it Together, , Non-Standard Environments, Defining Label Environments
Dave Love <fx@gnu.org>
parents:
diff changeset
1475 @subsection Putting it all together
Dave Love <fx@gnu.org>
parents:
diff changeset
1476
Dave Love <fx@gnu.org>
parents:
diff changeset
1477 When you have to put several entries into @code{reftex-label-alist}, just
Dave Love <fx@gnu.org>
parents:
diff changeset
1478 put them after each other in a list, or create that many templates in
Dave Love <fx@gnu.org>
parents:
diff changeset
1479 the customization buffer. Here is a lisp example which uses several of
Dave Love <fx@gnu.org>
parents:
diff changeset
1480 the entries described above:
Dave Love <fx@gnu.org>
parents:
diff changeset
1481
Dave Love <fx@gnu.org>
parents:
diff changeset
1482 @lisp
Dave Love <fx@gnu.org>
parents:
diff changeset
1483 (setq reftex-label-alist
26911
d7f536a01276 Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents: 25829
diff changeset
1484 '(("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
1485 ("theorem" ?h "thr:" "~\\ref@{%s@}" t ("theorem" "theor." "th.") -3)
25829
Dave Love <fx@gnu.org>
parents:
diff changeset
1486 ("\\quickeq@{@}" ?e nil nil 1 nil)
Dave Love <fx@gnu.org>
parents:
diff changeset
1487 AMSTeX
Dave Love <fx@gnu.org>
parents:
diff changeset
1488 ("\\myfig[]@{@}@{@}@{*@}@{@}" ?f nil nil 3)
Dave Love <fx@gnu.org>
parents:
diff changeset
1489 (detect-linguex ?x "ex:" "~\\ref@{%s@}" nil ("Example" "Ex."))))
Dave Love <fx@gnu.org>
parents:
diff changeset
1490 @end lisp
Dave Love <fx@gnu.org>
parents:
diff changeset
1491
Dave Love <fx@gnu.org>
parents:
diff changeset
1492 @node Reference Info, xr (LaTeX package), Defining Label Environments, Labels and References
Dave Love <fx@gnu.org>
parents:
diff changeset
1493 @section Reference Info
Dave Love <fx@gnu.org>
parents:
diff changeset
1494 @findex reftex-view-crossref
Dave Love <fx@gnu.org>
parents:
diff changeset
1495 @findex reftex-mouse-view-crossref
Dave Love <fx@gnu.org>
parents:
diff changeset
1496 @cindex Cross-references, displaying
Dave Love <fx@gnu.org>
parents:
diff changeset
1497 @cindex Reference info
Dave Love <fx@gnu.org>
parents:
diff changeset
1498 @cindex Displaying cross-references
Dave Love <fx@gnu.org>
parents:
diff changeset
1499 @cindex Viewing cross-references
Dave Love <fx@gnu.org>
parents:
diff changeset
1500 @kindex C-c &
Dave Love <fx@gnu.org>
parents:
diff changeset
1501 @kindex S-mouse-2
Dave Love <fx@gnu.org>
parents:
diff changeset
1502
Dave Love <fx@gnu.org>
parents:
diff changeset
1503 When point is idle on the argument of a @code{\ref} macro, the echo area
Dave Love <fx@gnu.org>
parents:
diff changeset
1504 will display some information about the label referenced there. Note
Dave Love <fx@gnu.org>
parents:
diff changeset
1505 that the information is only displayed if the echo area is not occupied
Dave Love <fx@gnu.org>
parents:
diff changeset
1506 by a different message.
Dave Love <fx@gnu.org>
parents:
diff changeset
1507
Dave Love <fx@gnu.org>
parents:
diff changeset
1508 @b{Ref@TeX{}} can also display the label definition corresponding to a
Dave Love <fx@gnu.org>
parents:
diff changeset
1509 @code{\ref} macro, or all reference locations corresponding to a
Dave Love <fx@gnu.org>
parents:
diff changeset
1510 @code{\label} macro. @xref{Viewing Cross-References}, for more
Dave Love <fx@gnu.org>
parents:
diff changeset
1511 information.@refill
Dave Love <fx@gnu.org>
parents:
diff changeset
1512
Dave Love <fx@gnu.org>
parents:
diff changeset
1513 @node xr (LaTeX package), varioref (LaTeX package), Reference Info, Labels and References
Dave Love <fx@gnu.org>
parents:
diff changeset
1514 @section @code{xr}: Cross-Document References
Dave Love <fx@gnu.org>
parents:
diff changeset
1515 @cindex @code{xr}, LaTeX package
Dave Love <fx@gnu.org>
parents:
diff changeset
1516 @cindex LaTeX packages, @code{xr}
Dave Love <fx@gnu.org>
parents:
diff changeset
1517 @cindex @code{\externaldocument}
Dave Love <fx@gnu.org>
parents:
diff changeset
1518 @cindex External documents
Dave Love <fx@gnu.org>
parents:
diff changeset
1519 @cindex References to external documents
Dave Love <fx@gnu.org>
parents:
diff changeset
1520 @cindex Cross-document references
Dave Love <fx@gnu.org>
parents:
diff changeset
1521
Dave Love <fx@gnu.org>
parents:
diff changeset
1522 The LaTeX package @code{xr} makes it possible to create references to
Dave Love <fx@gnu.org>
parents:
diff changeset
1523 labels defined in external documents. The preamble of a document using
Dave Love <fx@gnu.org>
parents:
diff changeset
1524 @code{xr} will contain something like this:@refill
Dave Love <fx@gnu.org>
parents:
diff changeset
1525
Dave Love <fx@gnu.org>
parents:
diff changeset
1526 @example
Dave Love <fx@gnu.org>
parents:
diff changeset
1527 \usepackage@{xr@}
Dave Love <fx@gnu.org>
parents:
diff changeset
1528 \externaldocument[V1-]@{volume1@}
Dave Love <fx@gnu.org>
parents:
diff changeset
1529 \externaldocument[V3-]@{volume3@}
Dave Love <fx@gnu.org>
parents:
diff changeset
1530 @end example
Dave Love <fx@gnu.org>
parents:
diff changeset
1531
Dave Love <fx@gnu.org>
parents:
diff changeset
1532 @noindent
Dave Love <fx@gnu.org>
parents:
diff changeset
1533 and we can make references to any labels defined in these
Dave Love <fx@gnu.org>
parents:
diff changeset
1534 external documents by using the prefixes @samp{V1-} and @samp{V3-},
Dave Love <fx@gnu.org>
parents:
diff changeset
1535 respectively.@refill
Dave Love <fx@gnu.org>
parents:
diff changeset
1536
Dave Love <fx@gnu.org>
parents:
diff changeset
1537 @b{Ref@TeX{}} can be used to create such references as well. Start the
Dave Love <fx@gnu.org>
parents:
diff changeset
1538 referencing process normally, by pressing @kbd{C-c )}. Select a label
Dave Love <fx@gnu.org>
parents:
diff changeset
1539 type if necessary. When you see the label selection buffer, pressing
Dave Love <fx@gnu.org>
parents:
diff changeset
1540 @kbd{x} will switch to the label selection buffer of one of the external
Dave Love <fx@gnu.org>
parents:
diff changeset
1541 documents. You may then select a label as before and @b{Ref@TeX{}} will
Dave Love <fx@gnu.org>
parents:
diff changeset
1542 insert it along with the required prefix.@refill
Dave Love <fx@gnu.org>
parents:
diff changeset
1543
Dave Love <fx@gnu.org>
parents:
diff changeset
1544 For this kind of inter-document cross-references, saving of parsing
Dave Love <fx@gnu.org>
parents:
diff changeset
1545 information and the use of multiple selection buffers can mean a large
Dave Love <fx@gnu.org>
parents:
diff changeset
1546 speed-up (@pxref{Optimizations}).@refill
Dave Love <fx@gnu.org>
parents:
diff changeset
1547
Dave Love <fx@gnu.org>
parents:
diff changeset
1548 @node varioref (LaTeX package), fancyref (LaTeX package), xr (LaTeX package), Labels and References
Dave Love <fx@gnu.org>
parents:
diff changeset
1549 @section @code{varioref}: Variable Page References
Dave Love <fx@gnu.org>
parents:
diff changeset
1550 @cindex @code{varioref}, LaTeX package
Dave Love <fx@gnu.org>
parents:
diff changeset
1551 @cindex @code{\vref}
Dave Love <fx@gnu.org>
parents:
diff changeset
1552 @cindex LaTeX packages, @code{varioref}
Dave Love <fx@gnu.org>
parents:
diff changeset
1553 @vindex reftex-vref-is-default
Dave Love <fx@gnu.org>
parents:
diff changeset
1554 @code{varioref} is a frequently used LaTeX package to create
Dave Love <fx@gnu.org>
parents:
diff changeset
1555 cross--references with page information. When you want to make a
Dave Love <fx@gnu.org>
parents:
diff changeset
1556 reference with the @code{\vref} macro, just press the @kbd{v} key in the
Dave Love <fx@gnu.org>
parents:
diff changeset
1557 selection buffer to toggle between @code{\ref} and @code{\vref}
Dave Love <fx@gnu.org>
parents:
diff changeset
1558 (@pxref{Referencing Labels}). The mode line of the selection buffer
Dave Love <fx@gnu.org>
parents:
diff changeset
1559 shows the current status of this switch. If you find that you almost
Dave Love <fx@gnu.org>
parents:
diff changeset
1560 always use @code{\vref}, you may want to make it the default by
Dave Love <fx@gnu.org>
parents:
diff changeset
1561 customizing the variable @code{reftex-vref-is-default}. If this
Dave Love <fx@gnu.org>
parents:
diff changeset
1562 toggling seems too inconvenient, you can also use the command
Dave Love <fx@gnu.org>
parents:
diff changeset
1563 @code{reftex-varioref-vref}@footnote{bind it to @kbd{C-c v}.}.
Dave Love <fx@gnu.org>
parents:
diff changeset
1564 Or use AUCTeX to create your macros (@pxref{AUCTeX}).@refill
Dave Love <fx@gnu.org>
parents:
diff changeset
1565
Dave Love <fx@gnu.org>
parents:
diff changeset
1566 @node fancyref (LaTeX package), , varioref (LaTeX package), Labels and References
Dave Love <fx@gnu.org>
parents:
diff changeset
1567 @section @code{fancyref}: Fancy Cross References
Dave Love <fx@gnu.org>
parents:
diff changeset
1568 @cindex @code{fancyref}, LaTeX package
Dave Love <fx@gnu.org>
parents:
diff changeset
1569 @cindex @code{\fref}
Dave Love <fx@gnu.org>
parents:
diff changeset
1570 @cindex @code{\Fref}
Dave Love <fx@gnu.org>
parents:
diff changeset
1571 @cindex LaTeX packages, @code{fancyref}
Dave Love <fx@gnu.org>
parents:
diff changeset
1572 @vindex reftex-fref-is-default
Dave Love <fx@gnu.org>
parents:
diff changeset
1573 @code{fancyref} is a LaTeX package where a macro call like
Dave Love <fx@gnu.org>
parents:
diff changeset
1574 @code{\fref@{@var{fig:map-of-germany}@}} creates not only the number of
Dave Love <fx@gnu.org>
parents:
diff changeset
1575 the referenced counter but also the complete text around it, like
Dave Love <fx@gnu.org>
parents:
diff changeset
1576 @samp{Figure 3 on the preceding page}. In order to make it work you
Dave Love <fx@gnu.org>
parents:
diff changeset
1577 need to use label prefixes like @samp{fig:} consistently - something
Dave Love <fx@gnu.org>
parents:
diff changeset
1578 @b{Ref@TeX{}} does automatically. When you want to make a reference
Dave Love <fx@gnu.org>
parents:
diff changeset
1579 with the @code{\fref} macro, just press the @kbd{V} key in the selection
Dave Love <fx@gnu.org>
parents:
diff changeset
1580 buffer to cycle between @code{\ref}, @code{\fref} and @code{\Fref}
Dave Love <fx@gnu.org>
parents:
diff changeset
1581 (@pxref{Referencing Labels}). The mode line of the selection buffer
Dave Love <fx@gnu.org>
parents:
diff changeset
1582 shows the current status of this switch. If this cycling seems
Dave Love <fx@gnu.org>
parents:
diff changeset
1583 inconvenient, you can also use the commands @code{reftex-fancyref-fref}
Dave Love <fx@gnu.org>
parents:
diff changeset
1584 and @code{reftex-fancyref-Fref}@footnote{bind them to @kbd{C-c
Dave Love <fx@gnu.org>
parents:
diff changeset
1585 f} and @kbd{C-c F}.}. Or use AUCTeX to create your macros
Dave Love <fx@gnu.org>
parents:
diff changeset
1586 (@pxref{AUCTeX}).@refill
Dave Love <fx@gnu.org>
parents:
diff changeset
1587
Dave Love <fx@gnu.org>
parents:
diff changeset
1588 @node Citations, Index Support, Labels and References, Top
Dave Love <fx@gnu.org>
parents:
diff changeset
1589 @chapter Citations
Dave Love <fx@gnu.org>
parents:
diff changeset
1590 @cindex Citations
Dave Love <fx@gnu.org>
parents:
diff changeset
1591 @cindex @code{\cite}
Dave Love <fx@gnu.org>
parents:
diff changeset
1592
Dave Love <fx@gnu.org>
parents:
diff changeset
1593 Citations in LaTeX are done with the @code{\cite} macro or variations of
Dave Love <fx@gnu.org>
parents:
diff changeset
1594 it. The argument of the macro is a citation key which identifies an
Dave Love <fx@gnu.org>
parents:
diff changeset
1595 article or book in either a BibTeX database file or in an explicit
Dave Love <fx@gnu.org>
parents:
diff changeset
1596 @code{thebibliography} environment in the document. @b{Ref@TeX{}}'s
Dave Love <fx@gnu.org>
parents:
diff changeset
1597 support for citations helps to select the correct key quickly.@refill
Dave Love <fx@gnu.org>
parents:
diff changeset
1598
Dave Love <fx@gnu.org>
parents:
diff changeset
1599 @menu
Dave Love <fx@gnu.org>
parents:
diff changeset
1600 * Creating Citations:: How to create them.
Dave Love <fx@gnu.org>
parents:
diff changeset
1601 * Citation Styles:: Natbib, Harvard, Chicago and Co.
Dave Love <fx@gnu.org>
parents:
diff changeset
1602 * Citation Info:: View the corresponding database entry.
Dave Love <fx@gnu.org>
parents:
diff changeset
1603 * Chapterbib and Bibunits:: Multiple bibliographies in a Document.
Dave Love <fx@gnu.org>
parents:
diff changeset
1604 * Citations Outside LaTeX:: How to make citations in Emails etc.
Dave Love <fx@gnu.org>
parents:
diff changeset
1605 @end menu
Dave Love <fx@gnu.org>
parents:
diff changeset
1606
Dave Love <fx@gnu.org>
parents:
diff changeset
1607 @node Creating Citations, Citation Styles, , Citations
Dave Love <fx@gnu.org>
parents:
diff changeset
1608 @section Creating Citations
Dave Love <fx@gnu.org>
parents:
diff changeset
1609 @cindex Creating citations
Dave Love <fx@gnu.org>
parents:
diff changeset
1610 @cindex Citations, creating
Dave Love <fx@gnu.org>
parents:
diff changeset
1611 @findex reftex-citation
Dave Love <fx@gnu.org>
parents:
diff changeset
1612 @kindex C-c [
Dave Love <fx@gnu.org>
parents:
diff changeset
1613 @cindex Selection buffer, citations
Dave Love <fx@gnu.org>
parents:
diff changeset
1614 @cindex Selection process
Dave Love <fx@gnu.org>
parents:
diff changeset
1615
Dave Love <fx@gnu.org>
parents:
diff changeset
1616 In order to create a citation, press @kbd{C-c [}. @b{Ref@TeX{}} then
Dave Love <fx@gnu.org>
parents:
diff changeset
1617 prompts for a regular expression which will be used to search through
Dave Love <fx@gnu.org>
parents:
diff changeset
1618 the database and present the list of matches to choose from in a
Dave Love <fx@gnu.org>
parents:
diff changeset
1619 selection process similar to that for selecting labels
Dave Love <fx@gnu.org>
parents:
diff changeset
1620 (@pxref{Referencing Labels}).@refill
Dave Love <fx@gnu.org>
parents:
diff changeset
1621
Dave Love <fx@gnu.org>
parents:
diff changeset
1622 The regular expression uses an extended syntax: @samp{&&} defines a
Dave Love <fx@gnu.org>
parents:
diff changeset
1623 logic @code{and} for regular expressions. For example
Dave Love <fx@gnu.org>
parents:
diff changeset
1624 @samp{Einstein&&Bose} will match all articles which mention
Dave Love <fx@gnu.org>
parents:
diff changeset
1625 Bose-Einstein condensation, or which are co-authored by Bose and
Dave Love <fx@gnu.org>
parents:
diff changeset
1626 Einstein. When entering the regular expression, you can complete on
Dave Love <fx@gnu.org>
parents:
diff changeset
1627 known citation keys.@refill
Dave Love <fx@gnu.org>
parents:
diff changeset
1628
Dave Love <fx@gnu.org>
parents:
diff changeset
1629 @cindex @code{\bibliography}
Dave Love <fx@gnu.org>
parents:
diff changeset
1630 @cindex @code{thebibliography}, LaTeX environment
Dave Love <fx@gnu.org>
parents:
diff changeset
1631 @cindex @code{BIBINPUTS}, environment variable
Dave Love <fx@gnu.org>
parents:
diff changeset
1632 @cindex @code{TEXBIB}, environment variable
Dave Love <fx@gnu.org>
parents:
diff changeset
1633 @b{Ref@TeX{}} prefers to use BibTeX database files specified with a
Dave Love <fx@gnu.org>
parents:
diff changeset
1634 @code{\bibliography} macro to collect its information. Just like
Dave Love <fx@gnu.org>
parents:
diff changeset
1635 BibTeX, it will search for the specified files in the current directory
Dave Love <fx@gnu.org>
parents:
diff changeset
1636 and along the path given in the environment variable @code{BIBINPUTS}.
Dave Love <fx@gnu.org>
parents:
diff changeset
1637 If you do not use BibTeX, but the document contains an explicit
Dave Love <fx@gnu.org>
parents:
diff changeset
1638 @code{thebibliography} environment, @b{Ref@TeX{}} will collect its
Dave Love <fx@gnu.org>
parents:
diff changeset
1639 information from there. Note that in this case the information
Dave Love <fx@gnu.org>
parents:
diff changeset
1640 presented in the selection buffer will just be a copy of relevant
Dave Love <fx@gnu.org>
parents:
diff changeset
1641 @code{\bibitem} entries, not the structured listing available with
Dave Love <fx@gnu.org>
parents:
diff changeset
1642 BibTeX database files.@refill
Dave Love <fx@gnu.org>
parents:
diff changeset
1643
Dave Love <fx@gnu.org>
parents:
diff changeset
1644 @kindex ?
Dave Love <fx@gnu.org>
parents:
diff changeset
1645 In the selection buffer, the following keys provide special commands. A
Dave Love <fx@gnu.org>
parents:
diff changeset
1646 summary of this information is always available from the selection
Dave Love <fx@gnu.org>
parents:
diff changeset
1647 process by pressing @kbd{?}.@refill
Dave Love <fx@gnu.org>
parents:
diff changeset
1648
Dave Love <fx@gnu.org>
parents:
diff changeset
1649 @table @kbd
Dave Love <fx@gnu.org>
parents:
diff changeset
1650 @tablesubheading{General}
Dave Love <fx@gnu.org>
parents:
diff changeset
1651 @item ?
Dave Love <fx@gnu.org>
parents:
diff changeset
1652 Show a summary of available commands.
Dave Love <fx@gnu.org>
parents:
diff changeset
1653
Dave Love <fx@gnu.org>
parents:
diff changeset
1654 @item 0-9,-
Dave Love <fx@gnu.org>
parents:
diff changeset
1655 Prefix argument.
Dave Love <fx@gnu.org>
parents:
diff changeset
1656
Dave Love <fx@gnu.org>
parents:
diff changeset
1657 @tablesubheading{Moving around}
Dave Love <fx@gnu.org>
parents:
diff changeset
1658 @item n
Dave Love <fx@gnu.org>
parents:
diff changeset
1659 Go to next article.
Dave Love <fx@gnu.org>
parents:
diff changeset
1660
Dave Love <fx@gnu.org>
parents:
diff changeset
1661 @item p
Dave Love <fx@gnu.org>
parents:
diff changeset
1662 Go to previous article.
Dave Love <fx@gnu.org>
parents:
diff changeset
1663
Dave Love <fx@gnu.org>
parents:
diff changeset
1664 @tablesubheading{Access to full database entries}
Dave Love <fx@gnu.org>
parents:
diff changeset
1665 @item @key{SPC}
Dave Love <fx@gnu.org>
parents:
diff changeset
1666 Show the database entry corresponding to the article at point, in
Dave Love <fx@gnu.org>
parents:
diff changeset
1667 another window. See also the @kbd{f} key.@refill
Dave Love <fx@gnu.org>
parents:
diff changeset
1668
Dave Love <fx@gnu.org>
parents:
diff changeset
1669 @item f
Dave Love <fx@gnu.org>
parents:
diff changeset
1670 Toggle follow mode. When follow mode is active, the other window will
Dave Love <fx@gnu.org>
parents:
diff changeset
1671 always display the full database entry of the current article. This is
Dave Love <fx@gnu.org>
parents:
diff changeset
1672 equivalent to pressing @key{SPC} after each cursor motion. With BibTeX
Dave Love <fx@gnu.org>
parents:
diff changeset
1673 entries, follow mode can be rather slow.@refill
Dave Love <fx@gnu.org>
parents:
diff changeset
1674
Dave Love <fx@gnu.org>
parents:
diff changeset
1675 @tablesubheading{Selecting entries and creating the citation}
Dave Love <fx@gnu.org>
parents:
diff changeset
1676 @item @key{RET}
Dave Love <fx@gnu.org>
parents:
diff changeset
1677 Insert a citation referencing the article at point into the buffer from
Dave Love <fx@gnu.org>
parents:
diff changeset
1678 which the selection process was started.@refill
Dave Love <fx@gnu.org>
parents:
diff changeset
1679
Dave Love <fx@gnu.org>
parents:
diff changeset
1680 @item mouse-2
Dave Love <fx@gnu.org>
parents:
diff changeset
1681 @vindex reftex-highlight-selection
Dave Love <fx@gnu.org>
parents:
diff changeset
1682 Clicking with mouse button 2 on a citation will accept it like @key{RET}
Dave Love <fx@gnu.org>
parents:
diff changeset
1683 would. See also variable @code{reftex-highlight-selection}, @ref{Options
Dave Love <fx@gnu.org>
parents:
diff changeset
1684 (Misc)}.@refill
Dave Love <fx@gnu.org>
parents:
diff changeset
1685
Dave Love <fx@gnu.org>
parents:
diff changeset
1686 @item m
Dave Love <fx@gnu.org>
parents:
diff changeset
1687 Mark the current entry. When one or several entries are marked,
Dave Love <fx@gnu.org>
parents:
diff changeset
1688 pressing @kbd{a} or @kbd{A} accepts all marked entries. Also,
Dave Love <fx@gnu.org>
parents:
diff changeset
1689 @key{RET} behaves like the @kbd{a} key.
Dave Love <fx@gnu.org>
parents:
diff changeset
1690
Dave Love <fx@gnu.org>
parents:
diff changeset
1691 @item u
Dave Love <fx@gnu.org>
parents:
diff changeset
1692 Unmark a marked entry.
Dave Love <fx@gnu.org>
parents:
diff changeset
1693
Dave Love <fx@gnu.org>
parents:
diff changeset
1694 @item a
Dave Love <fx@gnu.org>
parents:
diff changeset
1695 Accept all (marked) entries in the selection buffer and create a single
Dave Love <fx@gnu.org>
parents:
diff changeset
1696 @code{\cite} macro referring to them.@refill
Dave Love <fx@gnu.org>
parents:
diff changeset
1697
Dave Love <fx@gnu.org>
parents:
diff changeset
1698 @item A
Dave Love <fx@gnu.org>
parents:
diff changeset
1699 Accept all (marked) entries in the selection buffer and create a
Dave Love <fx@gnu.org>
parents:
diff changeset
1700 separate @code{\cite} macro for each of it.@refill
Dave Love <fx@gnu.org>
parents:
diff changeset
1701
Dave Love <fx@gnu.org>
parents:
diff changeset
1702 @item @key{TAB}
Dave Love <fx@gnu.org>
parents:
diff changeset
1703 Enter a citation key with completion. This may also be a key which does
Dave Love <fx@gnu.org>
parents:
diff changeset
1704 not yet exist.
Dave Love <fx@gnu.org>
parents:
diff changeset
1705
Dave Love <fx@gnu.org>
parents:
diff changeset
1706 @item .
Dave Love <fx@gnu.org>
parents:
diff changeset
1707 Show insertion point in another window. This is the point from where you
Dave Love <fx@gnu.org>
parents:
diff changeset
1708 called @code{reftex-citation}.@refill
Dave Love <fx@gnu.org>
parents:
diff changeset
1709
Dave Love <fx@gnu.org>
parents:
diff changeset
1710 @tablesubheading{Exiting}
Dave Love <fx@gnu.org>
parents:
diff changeset
1711 @item q
Dave Love <fx@gnu.org>
parents:
diff changeset
1712 Exit the selection process without inserting a citation into the
Dave Love <fx@gnu.org>
parents:
diff changeset
1713 buffer.@refill
Dave Love <fx@gnu.org>
parents:
diff changeset
1714
Dave Love <fx@gnu.org>
parents:
diff changeset
1715 @tablesubheading{Updating the buffer}
Dave Love <fx@gnu.org>
parents:
diff changeset
1716
Dave Love <fx@gnu.org>
parents:
diff changeset
1717 @item g
Dave Love <fx@gnu.org>
parents:
diff changeset
1718 Start over with a new regular expression. The full database will be
Dave Love <fx@gnu.org>
parents:
diff changeset
1719 rescanned with the new expression (see also @kbd{r}).@refill
Dave Love <fx@gnu.org>
parents:
diff changeset
1720
Dave Love <fx@gnu.org>
parents:
diff changeset
1721 @c FIXME: Should we use something else here? r is usually rescan!
Dave Love <fx@gnu.org>
parents:
diff changeset
1722 @item r
Dave Love <fx@gnu.org>
parents:
diff changeset
1723 Refine the current selection with another regular expression. This will
Dave Love <fx@gnu.org>
parents:
diff changeset
1724 @emph{not} rescan the entire database, but just the already selected
Dave Love <fx@gnu.org>
parents:
diff changeset
1725 entries.@refill
Dave Love <fx@gnu.org>
parents:
diff changeset
1726
Dave Love <fx@gnu.org>
parents:
diff changeset
1727 @end table
Dave Love <fx@gnu.org>
parents:
diff changeset
1728
Dave Love <fx@gnu.org>
parents:
diff changeset
1729 @vindex reftex-select-bib-map
Dave Love <fx@gnu.org>
parents:
diff changeset
1730 In order to define additional commands for this selection process, the
Dave Love <fx@gnu.org>
parents:
diff changeset
1731 keymap @code{reftex-select-bib-map} may be used.@refill
Dave Love <fx@gnu.org>
parents:
diff changeset
1732
Dave Love <fx@gnu.org>
parents:
diff changeset
1733 @node Citation Styles, Citation Info, Creating Citations, Citations
Dave Love <fx@gnu.org>
parents:
diff changeset
1734 @section Citation Styles
Dave Love <fx@gnu.org>
parents:
diff changeset
1735 @cindex Citation styles
Dave Love <fx@gnu.org>
parents:
diff changeset
1736 @cindex Citation styles, @code{natbib}
Dave Love <fx@gnu.org>
parents:
diff changeset
1737 @cindex Citation styles, @code{harvard}
Dave Love <fx@gnu.org>
parents:
diff changeset
1738 @cindex Citation styles, @code{chicago}
Dave Love <fx@gnu.org>
parents:
diff changeset
1739 @cindex @code{natbib}, citation style
Dave Love <fx@gnu.org>
parents:
diff changeset
1740 @cindex @code{harvard}, citation style
Dave Love <fx@gnu.org>
parents:
diff changeset
1741 @cindex @code{chicago}, citation style
Dave Love <fx@gnu.org>
parents:
diff changeset
1742
Dave Love <fx@gnu.org>
parents:
diff changeset
1743 @vindex reftex-cite-format
Dave Love <fx@gnu.org>
parents:
diff changeset
1744 The standard LaTeX macro @code{\cite} works well with numeric or simple
Dave Love <fx@gnu.org>
parents:
diff changeset
1745 key citations. To deal with the more complex task of author-year
Dave Love <fx@gnu.org>
parents:
diff changeset
1746 citations as used in many natural sciences, a variety of packages has
Dave Love <fx@gnu.org>
parents:
diff changeset
1747 been developed which define derived forms of the @code{\cite} macro.
Dave Love <fx@gnu.org>
parents:
diff changeset
1748 @b{Ref@TeX{}} can be configured to produce these citation macros as well by
Dave Love <fx@gnu.org>
parents:
diff changeset
1749 setting the variable @code{reftex-cite-format}. For the most commonly
Dave Love <fx@gnu.org>
parents:
diff changeset
1750 used packages (@code{natbib}, @code{harvard}, @code{chicago}) this may
Dave Love <fx@gnu.org>
parents:
diff changeset
1751 be done from the menu, under @code{Ref->Citation Styles}. Since there
Dave Love <fx@gnu.org>
parents:
diff changeset
1752 are usually several macros to create the citations, executing
Dave Love <fx@gnu.org>
parents:
diff changeset
1753 @code{reftex-citation} (@kbd{C-c [}) starts by prompting for the correct
Dave Love <fx@gnu.org>
parents:
diff changeset
1754 macro. For the Natbib style, this looks like this:
Dave Love <fx@gnu.org>
parents:
diff changeset
1755
Dave Love <fx@gnu.org>
parents:
diff changeset
1756 @example
Dave Love <fx@gnu.org>
parents:
diff changeset
1757 SELECT A CITATION FORMAT
Dave Love <fx@gnu.org>
parents:
diff changeset
1758
Dave Love <fx@gnu.org>
parents:
diff changeset
1759 [^M] \cite@{%l@}
Dave Love <fx@gnu.org>
parents:
diff changeset
1760 [t] \citet@{%l@}
Dave Love <fx@gnu.org>
parents:
diff changeset
1761 [T] \citet*@{%l@}
Dave Love <fx@gnu.org>
parents:
diff changeset
1762 [p] \citep@{%l@}
Dave Love <fx@gnu.org>
parents:
diff changeset
1763 [P] \citep*@{%l@}
Dave Love <fx@gnu.org>
parents:
diff changeset
1764 [e] \citep[e.g.][]@{%l@}
Dave Love <fx@gnu.org>
parents:
diff changeset
1765 [s] \citep[see][]@{%l@}
Dave Love <fx@gnu.org>
parents:
diff changeset
1766 [a] \citeauthor@{%l@}
Dave Love <fx@gnu.org>
parents:
diff changeset
1767 [A] \citeauthor*@{%l@}
Dave Love <fx@gnu.org>
parents:
diff changeset
1768 [y] \citeyear@{%l@}
Dave Love <fx@gnu.org>
parents:
diff changeset
1769 @end example
Dave Love <fx@gnu.org>
parents:
diff changeset
1770
Dave Love <fx@gnu.org>
parents:
diff changeset
1771 Following the most generic of these packages, @code{natbib}, the builtin
Dave Love <fx@gnu.org>
parents:
diff changeset
1772 citation packages always accept the @kbd{t} key for a @emph{textual}
Dave Love <fx@gnu.org>
parents:
diff changeset
1773 citation (like: @code{Jones et al. (1997) have shown...}) as well as
Dave Love <fx@gnu.org>
parents:
diff changeset
1774 the @kbd{p} key for a parenthetical citation (like: @code{As shown
Dave Love <fx@gnu.org>
parents:
diff changeset
1775 earlier (Jones et al, 1997)}).@refill
Dave Love <fx@gnu.org>
parents:
diff changeset
1776
Dave Love <fx@gnu.org>
parents:
diff changeset
1777 To make one of these styles the default, customize the variable
Dave Love <fx@gnu.org>
parents:
diff changeset
1778 @code{reftex-cite-format} or put into @file{.emacs}:
Dave Love <fx@gnu.org>
parents:
diff changeset
1779
Dave Love <fx@gnu.org>
parents:
diff changeset
1780 @lisp
Dave Love <fx@gnu.org>
parents:
diff changeset
1781 (setq reftex-cite-format 'natbib)
Dave Love <fx@gnu.org>
parents:
diff changeset
1782 @end lisp
Dave Love <fx@gnu.org>
parents:
diff changeset
1783
Dave Love <fx@gnu.org>
parents:
diff changeset
1784 You can also use AUCTeX style files to automatically set the
Dave Love <fx@gnu.org>
parents:
diff changeset
1785 citation style based on the @code{usepackage} commands in a given
Dave Love <fx@gnu.org>
parents:
diff changeset
1786 document. @xref{Style Files}, for information on how to set up the style
Dave Love <fx@gnu.org>
parents:
diff changeset
1787 files correctly.@refill
Dave Love <fx@gnu.org>
parents:
diff changeset
1788
Dave Love <fx@gnu.org>
parents:
diff changeset
1789 @node Citation Info, Chapterbib and Bibunits, Citation Styles, Citations, Top
Dave Love <fx@gnu.org>
parents:
diff changeset
1790 @section Citation Info
Dave Love <fx@gnu.org>
parents:
diff changeset
1791 @cindex Displaying citations
Dave Love <fx@gnu.org>
parents:
diff changeset
1792 @cindex Citations, displaying
Dave Love <fx@gnu.org>
parents:
diff changeset
1793 @cindex Citation info
Dave Love <fx@gnu.org>
parents:
diff changeset
1794 @cindex Viewing citations
Dave Love <fx@gnu.org>
parents:
diff changeset
1795 @kindex C-c &
Dave Love <fx@gnu.org>
parents:
diff changeset
1796 @kindex S-mouse-2
Dave Love <fx@gnu.org>
parents:
diff changeset
1797 @findex reftex-view-crossref
Dave Love <fx@gnu.org>
parents:
diff changeset
1798 @findex reftex-mouse-view-crossref
Dave Love <fx@gnu.org>
parents:
diff changeset
1799
Dave Love <fx@gnu.org>
parents:
diff changeset
1800 When point is idle on the argument of a @code{\cite} macro, the echo area
Dave Love <fx@gnu.org>
parents:
diff changeset
1801 will display some information about the article cited there. Note
Dave Love <fx@gnu.org>
parents:
diff changeset
1802 that the information is only displayed if the echo area is not occupied
Dave Love <fx@gnu.org>
parents:
diff changeset
1803 by a different message.
Dave Love <fx@gnu.org>
parents:
diff changeset
1804
Dave Love <fx@gnu.org>
parents:
diff changeset
1805 @b{Ref@TeX{}} can also display the @code{\bibitem} or BibTeX database
Dave Love <fx@gnu.org>
parents:
diff changeset
1806 entry corresponding to a @code{\cite} macro, or all citation locations
Dave Love <fx@gnu.org>
parents:
diff changeset
1807 corresponding to a @code{\bibitem} or BibTeX database entry.
Dave Love <fx@gnu.org>
parents:
diff changeset
1808 @xref{Viewing Cross-References}.@refill
Dave Love <fx@gnu.org>
parents:
diff changeset
1809
Dave Love <fx@gnu.org>
parents:
diff changeset
1810 @node Chapterbib and Bibunits, Citations Outside LaTeX, Citation Info, Citations
Dave Love <fx@gnu.org>
parents:
diff changeset
1811 @section Chapterbib and Bibunits
Dave Love <fx@gnu.org>
parents:
diff changeset
1812 @cindex @code{chapterbib}, LaTeX package
Dave Love <fx@gnu.org>
parents:
diff changeset
1813 @cindex @code{bibunits}, LaTeX package
Dave Love <fx@gnu.org>
parents:
diff changeset
1814 @cindex Bibliographies, multiple
Dave Love <fx@gnu.org>
parents:
diff changeset
1815
Dave Love <fx@gnu.org>
parents:
diff changeset
1816 @code{chapterbib} and @code{bibunits} are two LaTeX packages which
Dave Love <fx@gnu.org>
parents:
diff changeset
1817 produce multiple bibliographies in a document. This is no problem for
Dave Love <fx@gnu.org>
parents:
diff changeset
1818 @b{Ref@TeX{}} as long as all bibliographies use the same BibTeX database
Dave Love <fx@gnu.org>
parents:
diff changeset
1819 files. If they do not, it is best to have each document part in a
Dave Love <fx@gnu.org>
parents:
diff changeset
1820 separate file (as it is required for @code{chapterbib} anyway). Then
Dave Love <fx@gnu.org>
parents:
diff changeset
1821 @b{Ref@TeX{}} will still scan the locally relevant databases correctly. If
Dave Love <fx@gnu.org>
parents:
diff changeset
1822 you have multiple bibliographies within a @emph{single file}, this may
Dave Love <fx@gnu.org>
parents:
diff changeset
1823 or may not be the case.
Dave Love <fx@gnu.org>
parents:
diff changeset
1824
Dave Love <fx@gnu.org>
parents:
diff changeset
1825 @node Citations Outside LaTeX, , Chapterbib and Bibunits, Citations
Dave Love <fx@gnu.org>
parents:
diff changeset
1826 @section Citations outside LaTeX
Dave Love <fx@gnu.org>
parents:
diff changeset
1827 @cindex Citations outside LaTeX
Dave Love <fx@gnu.org>
parents:
diff changeset
1828 @vindex reftex-default-bibliography
Dave Love <fx@gnu.org>
parents:
diff changeset
1829
Dave Love <fx@gnu.org>
parents:
diff changeset
1830 The command @code{reftex-citation} can also be executed outside a LaTeX
Dave Love <fx@gnu.org>
parents:
diff changeset
1831 buffer. This can be useful to reference articles in the mail buffer and
Dave Love <fx@gnu.org>
parents:
diff changeset
1832 other documents. You should @emph{not} enter @code{reftex-mode} for
Dave Love <fx@gnu.org>
parents:
diff changeset
1833 this, just execute the command. The list of BibTeX files will in this
Dave Love <fx@gnu.org>
parents:
diff changeset
1834 case be taken from the variable @code{reftex-default-bibliography}.
Dave Love <fx@gnu.org>
parents:
diff changeset
1835 Setting the variable @code{reftex-cite-format} to the symbol
Dave Love <fx@gnu.org>
parents:
diff changeset
1836 @code{locally} does a decent job of putting all relevant information
Dave Love <fx@gnu.org>
parents:
diff changeset
1837 about a citation directly into the buffer. Here is the lisp code to add
Dave Love <fx@gnu.org>
parents:
diff changeset
1838 the @kbd{C-c [} binding to the mail buffer. It also provides a local
Dave Love <fx@gnu.org>
parents:
diff changeset
1839 binding for @code{reftex-cite-format}.@refill
Dave Love <fx@gnu.org>
parents:
diff changeset
1840
Dave Love <fx@gnu.org>
parents:
diff changeset
1841 @lisp
26911
d7f536a01276 Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents: 25829
diff changeset
1842 (add-hook 'mail-setup-hook
d7f536a01276 Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents: 25829
diff changeset
1843 (lambda () (define-key mail-mode-map "\C-c["
d7f536a01276 Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents: 25829
diff changeset
1844 (lambda () (interactive)
d7f536a01276 Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents: 25829
diff changeset
1845 (require 'reftex)
d7f536a01276 Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents: 25829
diff changeset
1846 (let ((reftex-cite-format 'locally))
d7f536a01276 Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents: 25829
diff changeset
1847 (reftex-citation))))))
25829
Dave Love <fx@gnu.org>
parents:
diff changeset
1848 @end lisp
Dave Love <fx@gnu.org>
parents:
diff changeset
1849
Dave Love <fx@gnu.org>
parents:
diff changeset
1850 @node Index Support, Viewing Cross-References, Citations, Top
Dave Love <fx@gnu.org>
parents:
diff changeset
1851 @chapter Index Support
Dave Love <fx@gnu.org>
parents:
diff changeset
1852 @cindex Index Support
Dave Love <fx@gnu.org>
parents:
diff changeset
1853 @cindex @code{\index}
Dave Love <fx@gnu.org>
parents:
diff changeset
1854
Dave Love <fx@gnu.org>
parents:
diff changeset
1855 LaTeX has builtin support for creating an Index. The LaTeX core
Dave Love <fx@gnu.org>
parents:
diff changeset
1856 supports two different indices, the standard index and a glossary. With
Dave Love <fx@gnu.org>
parents:
diff changeset
1857 the help of special LaTeX packages (@file{multind.sty} or
Dave Love <fx@gnu.org>
parents:
diff changeset
1858 @file{index.sty}), any number of indices can be supported.
Dave Love <fx@gnu.org>
parents:
diff changeset
1859
Dave Love <fx@gnu.org>
parents:
diff changeset
1860 Index entries are created with the @code{\index@{@var{entry}@}} macro.
Dave Love <fx@gnu.org>
parents:
diff changeset
1861 All entries defined in a document are written out to the @file{.aux}
Dave Love <fx@gnu.org>
parents:
diff changeset
1862 file. A separate tool must be used to convert this information into a
Dave Love <fx@gnu.org>
parents:
diff changeset
1863 nicely formatted index. Tools used with LaTeX include @code{MakeIndex}
Dave Love <fx@gnu.org>
parents:
diff changeset
1864 and @code{xindy}.@refill
Dave Love <fx@gnu.org>
parents:
diff changeset
1865
26911
d7f536a01276 Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents: 25829
diff changeset
1866 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
1867 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
1868 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
1869
d7f536a01276 Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents: 25829
diff changeset
1870 @enumerate
d7f536a01276 Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents: 25829
diff changeset
1871 @item
d7f536a01276 Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents: 25829
diff changeset
1872 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
1873 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
1874 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
1875 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
1876 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
1877 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
1878 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
1879 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
1880 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
1881 support for indexing possible, these special macros must be added to
d7f536a01276 Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents: 25829
diff changeset
1882 @b{Ref@TeX{}}'s configuration (@pxref{Defining Index Macros}).@refill
d7f536a01276 Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents: 25829
diff changeset
1883
d7f536a01276 Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents: 25829
diff changeset
1884 @item
d7f536a01276 Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents: 25829
diff changeset
1885 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
1886 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
1887 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
1888 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
1889 is ready. @b{Ref@TeX{}} supports this with an @emph{index phrases file}
d7f536a01276 Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents: 25829
diff changeset
1890 which collects phrases and helps indexing the phrases globally.@refill
d7f536a01276 Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents: 25829
diff changeset
1891 @end enumerate
d7f536a01276 Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents: 25829
diff changeset
1892
d7f536a01276 Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents: 25829
diff changeset
1893 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
1894 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
1895 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
1896 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
1897 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
1898 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
1899 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
1900 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
1901 configuration needs to be done by hand with the menu (@code{Ref->Index
d7f536a01276 Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents: 25829
diff changeset
1902 Style}), or globally for all your documents with@refill
d7f536a01276 Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents: 25829
diff changeset
1903
d7f536a01276 Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents: 25829
diff changeset
1904 @lisp
d7f536a01276 Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents: 25829
diff changeset
1905 (setq reftex-index-macros '(multind)) @r{or}
d7f536a01276 Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents: 25829
diff changeset
1906 (setq reftex-index-macros '(index))
d7f536a01276 Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents: 25829
diff changeset
1907 @end lisp
25829
Dave Love <fx@gnu.org>
parents:
diff changeset
1908
Dave Love <fx@gnu.org>
parents:
diff changeset
1909 @menu
26911
d7f536a01276 Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents: 25829
diff changeset
1910 * Creating Index Entries:: Macros and completion of entries.
d7f536a01276 Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents: 25829
diff changeset
1911 * 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
1912 * Displaying and Editing the Index:: The index editor.
25829
Dave Love <fx@gnu.org>
parents:
diff changeset
1913 * Builtin Index Macros:: The index macros RefTeX knows about.
Dave Love <fx@gnu.org>
parents:
diff changeset
1914 * Defining Index Macros:: ... and macros it doesn't.
Dave Love <fx@gnu.org>
parents:
diff changeset
1915 @end menu
Dave Love <fx@gnu.org>
parents:
diff changeset
1916
26911
d7f536a01276 Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents: 25829
diff changeset
1917 @node Creating Index Entries, The Index Phrases File, , Index Support
25829
Dave Love <fx@gnu.org>
parents:
diff changeset
1918 @section Creating Index Entries
Dave Love <fx@gnu.org>
parents:
diff changeset
1919 @cindex Creating index entries
Dave Love <fx@gnu.org>
parents:
diff changeset
1920 @cindex Index entries, creating
Dave Love <fx@gnu.org>
parents:
diff changeset
1921 @kindex C-c <
Dave Love <fx@gnu.org>
parents:
diff changeset
1922 @findex reftex-index
Dave Love <fx@gnu.org>
parents:
diff changeset
1923 @kindex C-c /
Dave Love <fx@gnu.org>
parents:
diff changeset
1924 @findex reftex-index-selection-or-word
Dave Love <fx@gnu.org>
parents:
diff changeset
1925
Dave Love <fx@gnu.org>
parents:
diff changeset
1926 In order to index the current selection or the word at the cursor press
Dave Love <fx@gnu.org>
parents:
diff changeset
1927 @kbd{C-c /} (@code{reftex-index-selection-or-word}). This causes the
Dave Love <fx@gnu.org>
parents:
diff changeset
1928 selection or word @samp{@var{word}} to be replaced with
Dave Love <fx@gnu.org>
parents:
diff changeset
1929 @samp{\index@{@var{word}@}@var{word}}. The macro which is used
Dave Love <fx@gnu.org>
parents:
diff changeset
1930 (@code{\index} by default) can be configured with the variable
Dave Love <fx@gnu.org>
parents:
diff changeset
1931 @code{reftex-index-default-macro}. When the command is called with a
Dave Love <fx@gnu.org>
parents:
diff changeset
1932 prefix argument (@kbd{C-u C-c /}), you get a chance to edit the
Dave Love <fx@gnu.org>
parents:
diff changeset
1933 generated index entry. Use this to change the case of the word or to
Dave Love <fx@gnu.org>
parents:
diff changeset
1934 make the entry a subentry, for example by entering
Dave Love <fx@gnu.org>
parents:
diff changeset
1935 @samp{main!sub!@var{word}}. When called with two raw @kbd{C-u} prefixes
Dave Love <fx@gnu.org>
parents:
diff changeset
1936 (@kbd{C-u C-u C-c /}), you will be asked for the index macro as well.
Dave Love <fx@gnu.org>
parents:
diff changeset
1937 When there is nothing selected and no word at point, this command will
Dave Love <fx@gnu.org>
parents:
diff changeset
1938 just call @code{reftex-index}, described below.
Dave Love <fx@gnu.org>
parents:
diff changeset
1939
Dave Love <fx@gnu.org>
parents:
diff changeset
1940 In order to create a general index entry, press @kbd{C-c <}
Dave Love <fx@gnu.org>
parents:
diff changeset
1941 (@code{reftex-index}). @b{Ref@TeX{}} will prompt for one of the
Dave Love <fx@gnu.org>
parents:
diff changeset
1942 available index macros and for its arguments. Completion will be
Dave Love <fx@gnu.org>
parents:
diff changeset
1943 available for the index entry and, if applicable, the index tag. The
Dave Love <fx@gnu.org>
parents:
diff changeset
1944 index tag is a string identifying one of multiple indices. With the
Dave Love <fx@gnu.org>
parents:
diff changeset
1945 @file{multind} and @file{index} packages, this tag is the first argument
Dave Love <fx@gnu.org>
parents:
diff changeset
1946 to the redefined @code{\index} macro.@refill
Dave Love <fx@gnu.org>
parents:
diff changeset
1947
26911
d7f536a01276 Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents: 25829
diff changeset
1948 @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
1949 @section The Index Phrases File
d7f536a01276 Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents: 25829
diff changeset
1950 @cindex Index phrase file
d7f536a01276 Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents: 25829
diff changeset
1951 @cindex Phrase file
d7f536a01276 Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents: 25829
diff changeset
1952 @kindex C-c |
d7f536a01276 Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents: 25829
diff changeset
1953 @findex reftex-index-visit-phrases-buffer
d7f536a01276 Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents: 25829
diff changeset
1954 @cindex Macro definition lines, in phrase buffer
d7f536a01276 Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents: 25829
diff changeset
1955
d7f536a01276 Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents: 25829
diff changeset
1956 @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
1957 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
1958 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
1959 @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
1960 |} (@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
1961 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
1962 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
1963 @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
1964 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
1965 don't forget to add them to @code{reftex-index-macros} as well. Here is
d7f536a01276 Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents: 25829
diff changeset
1966 a phrase file header example:@refill
d7f536a01276 Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents: 25829
diff changeset
1967
d7f536a01276 Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents: 25829
diff changeset
1968 @example
d7f536a01276 Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents: 25829
diff changeset
1969 % -*- mode: reftex-index-phrases -*-
d7f536a01276 Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents: 25829
diff changeset
1970 % Key Macro Format Repeat
d7f536a01276 Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents: 25829
diff changeset
1971 %----------------------------------------------------------
d7f536a01276 Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents: 25829
diff changeset
1972 >>>INDEX_MACRO_DEFINITION: i \index@{%s@} t
d7f536a01276 Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents: 25829
diff changeset
1973 >>>INDEX_MACRO_DEFINITION: I \index*@{%s@} nil
d7f536a01276 Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents: 25829
diff changeset
1974 >>>INDEX_MACRO_DEFINITION: g \glossary@{%s@} t
d7f536a01276 Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents: 25829
diff changeset
1975 >>>INDEX_MACRO_DEFINITION: n \index*[name]@{%s@} nil
d7f536a01276 Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents: 25829
diff changeset
1976 %----------------------------------------------------------
d7f536a01276 Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents: 25829
diff changeset
1977 @end example
d7f536a01276 Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents: 25829
diff changeset
1978
d7f536a01276 Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents: 25829
diff changeset
1979 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
1980 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
1981 @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
1982 @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
1983 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
1984 @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
1985 @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
1986 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
1987 already typesets its argument in the text, so that it is unnecessary to
d7f536a01276 Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents: 25829
diff changeset
1988 repeat @var{word} outside the macro.@refill
d7f536a01276 Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents: 25829
diff changeset
1989
d7f536a01276 Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents: 25829
diff changeset
1990 @menu
d7f536a01276 Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents: 25829
diff changeset
1991 * Collecting Phrases:: Collecting from document or external.
d7f536a01276 Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents: 25829
diff changeset
1992 * Consistency Checks:: Check for duplicates etc.
d7f536a01276 Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents: 25829
diff changeset
1993 * Global Indexing:: The interactive indexing process.
d7f536a01276 Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents: 25829
diff changeset
1994 @end menu
d7f536a01276 Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents: 25829
diff changeset
1995
d7f536a01276 Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents: 25829
diff changeset
1996 @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
1997 @subsection Collecting Phrases
d7f536a01276 Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents: 25829
diff changeset
1998 @cindex Collecting index phrases
d7f536a01276 Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents: 25829
diff changeset
1999 @cindex Index phrases, collection
d7f536a01276 Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents: 25829
diff changeset
2000 @cindex Phrases, collecting
d7f536a01276 Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents: 25829
diff changeset
2001
d7f536a01276 Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents: 25829
diff changeset
2002 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
2003 command @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
2004 copies the current selection (if active) or the word near point into the
d7f536a01276 Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents: 25829
diff changeset
2005 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
2006 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
2007 (@code{reftex-index-phrases-save-and-return}).
d7f536a01276 Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents: 25829
diff changeset
2008
d7f536a01276 Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents: 25829
diff changeset
2009 You can also prepare the list of index phrases in a different way and
d7f536a01276 Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents: 25829
diff changeset
2010 copy it into the phrases file. For example you might want to start from
d7f536a01276 Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents: 25829
diff changeset
2011 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
2012 indexed.
d7f536a01276 Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents: 25829
diff changeset
2013
d7f536a01276 Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents: 25829
diff changeset
2014 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
2015 @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
2016 format. A phrase line looks like this:
d7f536a01276 Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents: 25829
diff changeset
2017
d7f536a01276 Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents: 25829
diff changeset
2018 @example
d7f536a01276 Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents: 25829
diff changeset
2019 [@var{key}] <TABs> @var{phrase} [<TABs> @var{arg}[&&@var{arg}]... [ || @var{arg}]...]
d7f536a01276 Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents: 25829
diff changeset
2020 @end example
d7f536a01276 Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents: 25829
diff changeset
2021
d7f536a01276 Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents: 25829
diff changeset
2022 @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
2023 @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
2024 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
2025 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
2026 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
2027 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
2028 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
2029 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
2030 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
2031 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
2032 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
2033 }@footnote{@samp{&&} with optional spaces, see
d7f536a01276 Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents: 25829
diff changeset
2034 @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
2035 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
2036 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
2037 see @code{reftex-index-phrases-logical-or-regexp}.}. Here is an
d7f536a01276 Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents: 25829
diff changeset
2038 example:@refill
d7f536a01276 Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents: 25829
diff changeset
2039
d7f536a01276 Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents: 25829
diff changeset
2040 @example
d7f536a01276 Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents: 25829
diff changeset
2041 %--------------------------------------------------------------------
d7f536a01276 Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents: 25829
diff changeset
2042 I Sun
d7f536a01276 Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents: 25829
diff changeset
2043 i Planet Planets
d7f536a01276 Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents: 25829
diff changeset
2044 i Vega Stars!Vega
d7f536a01276 Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents: 25829
diff changeset
2045 Jupiter Planets!Jupiter
d7f536a01276 Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents: 25829
diff changeset
2046 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
2047 i Pluto Planets!Pluto && Kuiper Belt Objects!Pluto
d7f536a01276 Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents: 25829
diff changeset
2048 @end example
d7f536a01276 Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents: 25829
diff changeset
2049
d7f536a01276 Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents: 25829
diff changeset
2050
d7f536a01276 Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents: 25829
diff changeset
2051 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
2052 @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
2053 @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
2054 @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
2055 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
2056 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
2057 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
2058 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
2059 @samp{\index@{Planets!Pluto@}\index@{Kuiper Belt Objects!Pluto@}Pluto}
d7f536a01276 Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents: 25829
diff changeset
2060 and will therefore create two different index entries.@refill
d7f536a01276 Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents: 25829
diff changeset
2061
d7f536a01276 Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents: 25829
diff changeset
2062 @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
2063 @subsection Consistency Checks
d7f536a01276 Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents: 25829
diff changeset
2064 @cindex Index phrases, consistency checks
d7f536a01276 Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents: 25829
diff changeset
2065 @cindex Phrases, consistency checks
d7f536a01276 Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents: 25829
diff changeset
2066 @cindex Consistency check for index phrases
d7f536a01276 Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents: 25829
diff changeset
2067
d7f536a01276 Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents: 25829
diff changeset
2068 @kindex C-c C-s
d7f536a01276 Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents: 25829
diff changeset
2069 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
2070 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
2071 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
2072 (@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
2073 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
2074 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
2075 groups. Sorting will only change the sequence of phrases within each
d7f536a01276 Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents: 25829
diff changeset
2076 group (see the variable @code{reftex-index-phrases-sort-in-blocks}).@refill
d7f536a01276 Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents: 25829
diff changeset
2077
d7f536a01276 Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents: 25829
diff changeset
2078 @kindex C-c C-i
d7f536a01276 Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents: 25829
diff changeset
2079 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
2080 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
2081 of how the index entry will look like and the number of expected matches
d7f536a01276 Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents: 25829
diff changeset
2082 in the document.@refill
d7f536a01276 Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents: 25829
diff changeset
2083
d7f536a01276 Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents: 25829
diff changeset
2084 @kindex C-c C-t
d7f536a01276 Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents: 25829
diff changeset
2085 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
2086 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
2087 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
2088 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
2089 @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
2090 (@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
2091 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
2092 In order to check the whole buffer like this, start at the beginning and
d7f536a01276 Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents: 25829
diff changeset
2093 execute this command repeatedly.@refill
d7f536a01276 Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents: 25829
diff changeset
2094
d7f536a01276 Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents: 25829
diff changeset
2095 @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
2096 @subsection Global Indexing
d7f536a01276 Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents: 25829
diff changeset
2097 @cindex Global indexing
d7f536a01276 Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents: 25829
diff changeset
2098 @cindex Indexing, global
d7f536a01276 Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents: 25829
diff changeset
2099 @cindex Indexing, from @file{phrases} buffer
d7f536a01276 Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents: 25829
diff changeset
2100
d7f536a01276 Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents: 25829
diff changeset
2101 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
2102 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
2103 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
2104 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
2105 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
2106 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
2107 probably good to do indexing in small chunks since your concentration
d7f536a01276 Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents: 25829
diff changeset
2108 may not last long enough to do everything in one go.@refill
d7f536a01276 Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents: 25829
diff changeset
2109
d7f536a01276 Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents: 25829
diff changeset
2110 @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
2111 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
2112 replacement string and offer you the following choices@footnote{Windows
d7f536a01276 Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents: 25829
diff changeset
2113 users: Restrict yourself to the described keys during indexing. Pressing
d7f536a01276 Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents: 25829
diff changeset
2114 @key{Help} at the indexing prompt can apparently hang Emacs.}:@refill
d7f536a01276 Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents: 25829
diff changeset
2115
d7f536a01276 Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents: 25829
diff changeset
2116 @table @kbd
d7f536a01276 Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents: 25829
diff changeset
2117 @item y
d7f536a01276 Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents: 25829
diff changeset
2118 Replace this match with the proposed string.
d7f536a01276 Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents: 25829
diff changeset
2119 @item n
d7f536a01276 Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents: 25829
diff changeset
2120 Skip this match.
d7f536a01276 Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents: 25829
diff changeset
2121 @item !
d7f536a01276 Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents: 25829
diff changeset
2122 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
2123 @item q
d7f536a01276 Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents: 25829
diff changeset
2124 Skip this match, start with next file.
d7f536a01276 Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents: 25829
diff changeset
2125 @item Q
d7f536a01276 Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents: 25829
diff changeset
2126 Skip this match, start with next phrase.
d7f536a01276 Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents: 25829
diff changeset
2127 @item o
d7f536a01276 Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents: 25829
diff changeset
2128 Select a different indexing macro for this match.
d7f536a01276 Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents: 25829
diff changeset
2129 @item 1-9
d7f536a01276 Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents: 25829
diff changeset
2130 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
2131 @item e
d7f536a01276 Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents: 25829
diff changeset
2132 Edit the replacement text.
d7f536a01276 Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents: 25829
diff changeset
2133 @item C-r
d7f536a01276 Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents: 25829
diff changeset
2134 Recursive edit. Use @kbd{M-C-c} to return to the indexing process.
d7f536a01276 Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents: 25829
diff changeset
2135 @item s
d7f536a01276 Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents: 25829
diff changeset
2136 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
2137 @item S
d7f536a01276 Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents: 25829
diff changeset
2138 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
2139 @item C-g
d7f536a01276 Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents: 25829
diff changeset
2140 Abort the indexing process.
d7f536a01276 Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents: 25829
diff changeset
2141 @end table
d7f536a01276 Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents: 25829
diff changeset
2142
d7f536a01276 Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents: 25829
diff changeset
2143 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
2144 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
2145 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
2146 (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
2147
d7f536a01276 Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents: 25829
diff changeset
2148 @table @i
d7f536a01276 Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents: 25829
diff changeset
2149 @item Match Whole Words
d7f536a01276 Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents: 25829
diff changeset
2150 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
2151 This should probably always be on.
d7f536a01276 Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents: 25829
diff changeset
2152 @item Case Sensitive Search
d7f536a01276 Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents: 25829
diff changeset
2153 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
2154 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
2155 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
2156 do not like.
d7f536a01276 Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents: 25829
diff changeset
2157 @item Wrap Long Lines
d7f536a01276 Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents: 25829
diff changeset
2158 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
2159 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
2160 @item Skip Indexed Matches
d7f536a01276 Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents: 25829
diff changeset
2161 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
2162 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
2163 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
2164 (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
2165 are those configured in @code{reftex-index-macros}. Intended for
d7f536a01276 Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents: 25829
diff changeset
2166 re-indexing a documents after changes have been made.@refill
d7f536a01276 Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents: 25829
diff changeset
2167 @end table
d7f536a01276 Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents: 25829
diff changeset
2168
d7f536a01276 Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents: 25829
diff changeset
2169 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
2170 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
2171 to the changed regions. The command
d7f536a01276 Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents: 25829
diff changeset
2172 @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
2173 purpose. When called from a LaTeX document with active region, it will
d7f536a01276 Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents: 25829
diff changeset
2174 apply @code{reftex-index-all-phrases} to the current region.@refill
d7f536a01276 Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents: 25829
diff changeset
2175
d7f536a01276 Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents: 25829
diff changeset
2176 @node Displaying and Editing the Index, Builtin Index Macros, The Index Phrases File, Index Support
25829
Dave Love <fx@gnu.org>
parents:
diff changeset
2177 @section Displaying and Editing the Index
Dave Love <fx@gnu.org>
parents:
diff changeset
2178 @cindex Displaying the Index
Dave Love <fx@gnu.org>
parents:
diff changeset
2179 @cindex Editing the Index
Dave Love <fx@gnu.org>
parents:
diff changeset
2180 @cindex Index entries, creating
Dave Love <fx@gnu.org>
parents:
diff changeset
2181 @cindex Index, displaying
Dave Love <fx@gnu.org>
parents:
diff changeset
2182 @cindex Index, editing
Dave Love <fx@gnu.org>
parents:
diff changeset
2183 @kindex C-c >
Dave Love <fx@gnu.org>
parents:
diff changeset
2184 @findex reftex-display-index
Dave Love <fx@gnu.org>
parents:
diff changeset
2185
Dave Love <fx@gnu.org>
parents:
diff changeset
2186 In order to compile and display the index, press @kbd{C-c >}. If the
Dave Love <fx@gnu.org>
parents:
diff changeset
2187 document uses multiple indices, @b{Ref@TeX{}} will ask you to select
Dave Love <fx@gnu.org>
parents:
diff changeset
2188 one. Then, all index entries will be sorted alphabetically and
Dave Love <fx@gnu.org>
parents:
diff changeset
2189 displayed in a special buffer, the @file{*Index*} buffer. From that
Dave Love <fx@gnu.org>
parents:
diff changeset
2190 buffer you can check and edit each entry.@refill
Dave Love <fx@gnu.org>
parents:
diff changeset
2191
Dave Love <fx@gnu.org>
parents:
diff changeset
2192 The index can be restricted to the current section or the region. Then
Dave Love <fx@gnu.org>
parents:
diff changeset
2193 only entries in that part of the document will go into the compiled
Dave Love <fx@gnu.org>
parents:
diff changeset
2194 index. To restrict to the current section, use a numeric prefix
Dave Love <fx@gnu.org>
parents:
diff changeset
2195 @samp{2}, thus press @kbd{C-u 2 C-c >}. To restrict to the current
Dave Love <fx@gnu.org>
parents:
diff changeset
2196 region, make the region active and use a numeric prefix @samp{3} (press
Dave Love <fx@gnu.org>
parents:
diff changeset
2197 @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
2198 restriction can be moved from one section to the next by pressing the
d7f536a01276 Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents: 25829
diff changeset
2199 @kbd{<} and @kbd{>} keys.@refill
25829
Dave Love <fx@gnu.org>
parents:
diff changeset
2200
Dave Love <fx@gnu.org>
parents:
diff changeset
2201 One caveat: @b{Ref@TeX{}} finds the definition point of an index entry
Dave Love <fx@gnu.org>
parents:
diff changeset
2202 by searching near the buffer position where it had found to macro during
Dave Love <fx@gnu.org>
parents:
diff changeset
2203 scanning. If you have several identical index entries in the same
Dave Love <fx@gnu.org>
parents:
diff changeset
2204 buffer and significant changes have shifted the entries around, you must
Dave Love <fx@gnu.org>
parents:
diff changeset
2205 rescan the buffer to ensure the correspondence between the
Dave Love <fx@gnu.org>
parents:
diff changeset
2206 @file{*Index*} buffer and the definition locations. It is therefore
Dave Love <fx@gnu.org>
parents:
diff changeset
2207 advisable to rescan the document (with @kbd{r} or @kbd{C-u r})
Dave Love <fx@gnu.org>
parents:
diff changeset
2208 frequently while editing the index from the @file{*Index*}
Dave Love <fx@gnu.org>
parents:
diff changeset
2209 buffer.@refill
Dave Love <fx@gnu.org>
parents:
diff changeset
2210
Dave Love <fx@gnu.org>
parents:
diff changeset
2211 @kindex ?
Dave Love <fx@gnu.org>
parents:
diff changeset
2212 Here is a list of special commands available in the @file{*Index*} buffer. A
Dave Love <fx@gnu.org>
parents:
diff changeset
2213 summary of this information is always available by pressing
Dave Love <fx@gnu.org>
parents:
diff changeset
2214 @kbd{?}.@refill
Dave Love <fx@gnu.org>
parents:
diff changeset
2215
Dave Love <fx@gnu.org>
parents:
diff changeset
2216 @table @kbd
Dave Love <fx@gnu.org>
parents:
diff changeset
2217 @tablesubheading{General}
Dave Love <fx@gnu.org>
parents:
diff changeset
2218 @item ?
Dave Love <fx@gnu.org>
parents:
diff changeset
2219 Display a summary of commands.
Dave Love <fx@gnu.org>
parents:
diff changeset
2220
Dave Love <fx@gnu.org>
parents:
diff changeset
2221 @item 0-9, -
Dave Love <fx@gnu.org>
parents:
diff changeset
2222 Prefix argument.
Dave Love <fx@gnu.org>
parents:
diff changeset
2223
Dave Love <fx@gnu.org>
parents:
diff changeset
2224 @tablesubheading{Moving around}
Dave Love <fx@gnu.org>
parents:
diff changeset
2225 @item ! A..Z
Dave Love <fx@gnu.org>
parents:
diff changeset
2226 Pressing any capital letter will jump to the corresponding section in
Dave Love <fx@gnu.org>
parents:
diff changeset
2227 the @file{*Index*} buffer. The exclamation mark is special and jumps to
Dave Love <fx@gnu.org>
parents:
diff changeset
2228 the first entries alphabetically sorted below @samp{A}. These are
Dave Love <fx@gnu.org>
parents:
diff changeset
2229 usually non-alphanumeric characters.@refill
Dave Love <fx@gnu.org>
parents:
diff changeset
2230 @item n
Dave Love <fx@gnu.org>
parents:
diff changeset
2231 Go to next entry.@refill
Dave Love <fx@gnu.org>
parents:
diff changeset
2232 @item p
Dave Love <fx@gnu.org>
parents:
diff changeset
2233 Go to previous entry.@refill
Dave Love <fx@gnu.org>
parents:
diff changeset
2234
Dave Love <fx@gnu.org>
parents:
diff changeset
2235 @tablesubheading{Access to document locations}
Dave Love <fx@gnu.org>
parents:
diff changeset
2236 @item @key{SPC}
Dave Love <fx@gnu.org>
parents:
diff changeset
2237 Show the place in the document where this index entry is defined.@refill
Dave Love <fx@gnu.org>
parents:
diff changeset
2238
Dave Love <fx@gnu.org>
parents:
diff changeset
2239 @item @key{TAB}
Dave Love <fx@gnu.org>
parents:
diff changeset
2240 Go to the definition of the current index entry in another
Dave Love <fx@gnu.org>
parents:
diff changeset
2241 window.@refill
Dave Love <fx@gnu.org>
parents:
diff changeset
2242
Dave Love <fx@gnu.org>
parents:
diff changeset
2243 @item @key{RET}
Dave Love <fx@gnu.org>
parents:
diff changeset
2244 Go to the definition of the current index entry and hide the
26911
d7f536a01276 Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents: 25829
diff changeset
2245 @file{*Index*} buffer window.@refill
25829
Dave Love <fx@gnu.org>
parents:
diff changeset
2246
Dave Love <fx@gnu.org>
parents:
diff changeset
2247 @item f
Dave Love <fx@gnu.org>
parents:
diff changeset
2248 @vindex reftex-index-follow-mode
Dave Love <fx@gnu.org>
parents:
diff changeset
2249 @vindex reftex-revisit-to-follow
Dave Love <fx@gnu.org>
parents:
diff changeset
2250 Toggle follow mode. When follow mode is active, the other window will
Dave Love <fx@gnu.org>
parents:
diff changeset
2251 always show the location corresponding to the line in the @file{*Index*}
Dave Love <fx@gnu.org>
parents:
diff changeset
2252 buffer at point. This is similar to pressing @key{SPC} after each
Dave Love <fx@gnu.org>
parents:
diff changeset
2253 cursor motion. The default for this flag can be set with the variable
Dave Love <fx@gnu.org>
parents:
diff changeset
2254 @code{reftex-index-follow-mode}. Note that only context in files
Dave Love <fx@gnu.org>
parents:
diff changeset
2255 already visited is shown. @b{Ref@TeX{}} will not visit a file just for
Dave Love <fx@gnu.org>
parents:
diff changeset
2256 follow mode. See, however, the variable
Dave Love <fx@gnu.org>
parents:
diff changeset
2257 @code{reftex-revisit-to-follow}.@refill
Dave Love <fx@gnu.org>
parents:
diff changeset
2258
Dave Love <fx@gnu.org>
parents:
diff changeset
2259 @tablesubheading{Entry editing}
Dave Love <fx@gnu.org>
parents:
diff changeset
2260 @item e
Dave Love <fx@gnu.org>
parents:
diff changeset
2261 Edit the current index entry. In the minibuffer, you can edit the
Dave Love <fx@gnu.org>
parents:
diff changeset
2262 index macro which defines this entry.@refill
Dave Love <fx@gnu.org>
parents:
diff changeset
2263
Dave Love <fx@gnu.org>
parents:
diff changeset
2264 @item C-k
Dave Love <fx@gnu.org>
parents:
diff changeset
2265 Kill the index entry. Currently not implemented because I don't know
Dave Love <fx@gnu.org>
parents:
diff changeset
2266 how to implement an @code{undo} function for this.@refill
Dave Love <fx@gnu.org>
parents:
diff changeset
2267
Dave Love <fx@gnu.org>
parents:
diff changeset
2268 @item *
Dave Love <fx@gnu.org>
parents:
diff changeset
2269 Edit the @var{key} part of the entry. This is the initial part of the
Dave Love <fx@gnu.org>
parents:
diff changeset
2270 entry which determines the location of the entry in the index.@refill
Dave Love <fx@gnu.org>
parents:
diff changeset
2271
Dave Love <fx@gnu.org>
parents:
diff changeset
2272 @item |
Dave Love <fx@gnu.org>
parents:
diff changeset
2273 Edit the @var{attribute} part of the entry. This is the part after the
Dave Love <fx@gnu.org>
parents:
diff changeset
2274 vertical bar. With @code{MakeIndex}, this part is an encapsulating
Dave Love <fx@gnu.org>
parents:
diff changeset
2275 macro. With @code{xindy}, it is called @emph{attribute} and is a
Dave Love <fx@gnu.org>
parents:
diff changeset
2276 property of the index entry that can lead to special formatting. When
Dave Love <fx@gnu.org>
parents:
diff changeset
2277 called with @kbd{C-u} prefix, kill the entire @var{attribute}
Dave Love <fx@gnu.org>
parents:
diff changeset
2278 part.@refill
Dave Love <fx@gnu.org>
parents:
diff changeset
2279
Dave Love <fx@gnu.org>
parents:
diff changeset
2280 @item @@
Dave Love <fx@gnu.org>
parents:
diff changeset
2281 Edit the @var{visual} part of the entry. This is the part after the
Dave Love <fx@gnu.org>
parents:
diff changeset
2282 @samp{@@} which is used by @code{MakeIndex} to change the visual
Dave Love <fx@gnu.org>
parents:
diff changeset
2283 appearance of the entry in the index. When called with @kbd{C-u}
Dave Love <fx@gnu.org>
parents:
diff changeset
2284 prefix, kill the entire @var{visual} part.@refill
Dave Love <fx@gnu.org>
parents:
diff changeset
2285
Dave Love <fx@gnu.org>
parents:
diff changeset
2286 @item (
Dave Love <fx@gnu.org>
parents:
diff changeset
2287 Toggle the beginning of page range property @samp{|(} of the
Dave Love <fx@gnu.org>
parents:
diff changeset
2288 entry.@refill
Dave Love <fx@gnu.org>
parents:
diff changeset
2289
Dave Love <fx@gnu.org>
parents:
diff changeset
2290 @item )
Dave Love <fx@gnu.org>
parents:
diff changeset
2291 Toggle the end of page range property @samp{|)} of the entry.@refill
Dave Love <fx@gnu.org>
parents:
diff changeset
2292
Dave Love <fx@gnu.org>
parents:
diff changeset
2293 @item _
Dave Love <fx@gnu.org>
parents:
diff changeset
2294 Make the current entry a subentry. This command will prompt for the
Dave Love <fx@gnu.org>
parents:
diff changeset
2295 superordinate entry and insert it.@refill
Dave Love <fx@gnu.org>
parents:
diff changeset
2296
Dave Love <fx@gnu.org>
parents:
diff changeset
2297 @item ^
Dave Love <fx@gnu.org>
parents:
diff changeset
2298 Remove the highest superordinate entry. If the current entry is a
Dave Love <fx@gnu.org>
parents:
diff changeset
2299 subitem (@samp{aaa!bbb!ccc}), this function moves it up the hierarchy
Dave Love <fx@gnu.org>
parents:
diff changeset
2300 (@samp{bbb!ccc}).@refill
Dave Love <fx@gnu.org>
parents:
diff changeset
2301
Dave Love <fx@gnu.org>
parents:
diff changeset
2302 @tablesubheading{Exiting}
Dave Love <fx@gnu.org>
parents:
diff changeset
2303 @item q
Dave Love <fx@gnu.org>
parents:
diff changeset
2304 Hide the @file{*Index*} buffer.@refill
Dave Love <fx@gnu.org>
parents:
diff changeset
2305
Dave Love <fx@gnu.org>
parents:
diff changeset
2306 @item k
Dave Love <fx@gnu.org>
parents:
diff changeset
2307 Kill the @file{*Index*} buffer.@refill
Dave Love <fx@gnu.org>
parents:
diff changeset
2308
Dave Love <fx@gnu.org>
parents:
diff changeset
2309 @item C-c =
Dave Love <fx@gnu.org>
parents:
diff changeset
2310 Switch to the Table of Contents buffer of this document.@refill
Dave Love <fx@gnu.org>
parents:
diff changeset
2311
Dave Love <fx@gnu.org>
parents:
diff changeset
2312 @tablesubheading{Controlling what gets displayed}
Dave Love <fx@gnu.org>
parents:
diff changeset
2313 @item c
Dave Love <fx@gnu.org>
parents:
diff changeset
2314 @vindex reftex-index-include-context
Dave Love <fx@gnu.org>
parents:
diff changeset
2315 Toggle the display of short context in the @file{*Index*} buffer. The
Dave Love <fx@gnu.org>
parents:
diff changeset
2316 default for this flag can be set with the variable
Dave Love <fx@gnu.org>
parents:
diff changeset
2317 @code{reftex-index-include-context}.@refill
Dave Love <fx@gnu.org>
parents:
diff changeset
2318
Dave Love <fx@gnu.org>
parents:
diff changeset
2319 @item @}
Dave Love <fx@gnu.org>
parents:
diff changeset
2320 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
2321 section number will be displayed in the @code{R<>} indicator in the
25829
Dave Love <fx@gnu.org>
parents:
diff changeset
2322 mode line and in the header of the @file{*Index*} buffer.@refill
Dave Love <fx@gnu.org>
parents:
diff changeset
2323
Dave Love <fx@gnu.org>
parents:
diff changeset
2324 @item @{
Dave Love <fx@gnu.org>
parents:
diff changeset
2325 Widen the index to contain all entries of the document.@refill
Dave Love <fx@gnu.org>
parents:
diff changeset
2326
Dave Love <fx@gnu.org>
parents:
diff changeset
2327 @item <
Dave Love <fx@gnu.org>
parents:
diff changeset
2328 When the index is currently restricted, move the restriction to the
Dave Love <fx@gnu.org>
parents:
diff changeset
2329 previous section.@refill
Dave Love <fx@gnu.org>
parents:
diff changeset
2330
Dave Love <fx@gnu.org>
parents:
diff changeset
2331 @item >
Dave Love <fx@gnu.org>
parents:
diff changeset
2332 When the index is currently restricted, move the restriction to the
Dave Love <fx@gnu.org>
parents:
diff changeset
2333 next section.@refill
Dave Love <fx@gnu.org>
parents:
diff changeset
2334
Dave Love <fx@gnu.org>
parents:
diff changeset
2335 @tablesubheading{Updating the buffer}
Dave Love <fx@gnu.org>
parents:
diff changeset
2336 @item g
Dave Love <fx@gnu.org>
parents:
diff changeset
2337 Rebuild the @file{*Index*} buffer. This does @emph{not} rescan the
Dave Love <fx@gnu.org>
parents:
diff changeset
2338 document. However, it sorts the entries again, so that edited entries
Dave Love <fx@gnu.org>
parents:
diff changeset
2339 will move to the correct position.@refill
Dave Love <fx@gnu.org>
parents:
diff changeset
2340
Dave Love <fx@gnu.org>
parents:
diff changeset
2341 @item r
Dave Love <fx@gnu.org>
parents:
diff changeset
2342 @vindex reftex-enable-partial-scans
Dave Love <fx@gnu.org>
parents:
diff changeset
2343 Reparse the LaTeX document and rebuild the @file{*Index*} buffer. When
Dave Love <fx@gnu.org>
parents:
diff changeset
2344 @code{reftex-enable-partial-scans} is non-nil, rescan only the file this
Dave Love <fx@gnu.org>
parents:
diff changeset
2345 location is defined in, not the entire document.@refill
Dave Love <fx@gnu.org>
parents:
diff changeset
2346
Dave Love <fx@gnu.org>
parents:
diff changeset
2347 @item C-u r
Dave Love <fx@gnu.org>
parents:
diff changeset
2348 Reparse the @emph{entire} LaTeX document and rebuild the @file{*Index*}
Dave Love <fx@gnu.org>
parents:
diff changeset
2349 buffer.@refill
Dave Love <fx@gnu.org>
parents:
diff changeset
2350
Dave Love <fx@gnu.org>
parents:
diff changeset
2351 @item s
Dave Love <fx@gnu.org>
parents:
diff changeset
2352 Switch to a different index (for documents with multiple
Dave Love <fx@gnu.org>
parents:
diff changeset
2353 indices).@refill
Dave Love <fx@gnu.org>
parents:
diff changeset
2354 @end table
Dave Love <fx@gnu.org>
parents:
diff changeset
2355
Dave Love <fx@gnu.org>
parents:
diff changeset
2356
Dave Love <fx@gnu.org>
parents:
diff changeset
2357 @node Builtin Index Macros, Defining Index Macros, Displaying and Editing the Index, Index Support
Dave Love <fx@gnu.org>
parents:
diff changeset
2358 @section Builtin Index Macros
Dave Love <fx@gnu.org>
parents:
diff changeset
2359 @cindex Builtin index macros
Dave Love <fx@gnu.org>
parents:
diff changeset
2360 @cindex Index macros, builtin
Dave Love <fx@gnu.org>
parents:
diff changeset
2361 @vindex reftex-index-macros
Dave Love <fx@gnu.org>
parents:
diff changeset
2362 @cindex @code{multind}, LaTeX package
Dave Love <fx@gnu.org>
parents:
diff changeset
2363 @cindex @code{index}, LaTeX package
Dave Love <fx@gnu.org>
parents:
diff changeset
2364 @cindex LaTeX packages, @code{multind}
Dave Love <fx@gnu.org>
parents:
diff changeset
2365 @cindex LaTeX packages, @code{index}
Dave Love <fx@gnu.org>
parents:
diff changeset
2366
Dave Love <fx@gnu.org>
parents:
diff changeset
2367 @b{Ref@TeX{}} by default recognizes the @code{\index} and
Dave Love <fx@gnu.org>
parents:
diff changeset
2368 @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
2369 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
2370 in the @file{multind} and @file{index} packages. However, since
25829
Dave Love <fx@gnu.org>
parents:
diff changeset
2371 the different definitions of the @code{\index} macro are incompatible,
Dave Love <fx@gnu.org>
parents:
diff changeset
2372 you will have to explicitly specify the index style used.
Dave Love <fx@gnu.org>
parents:
diff changeset
2373 @xref{Creating Index Entries}, for information on how to do that.
Dave Love <fx@gnu.org>
parents:
diff changeset
2374
Dave Love <fx@gnu.org>
parents:
diff changeset
2375 @node Defining Index Macros, , Builtin Index Macros, Index Support
Dave Love <fx@gnu.org>
parents:
diff changeset
2376 @section Defining Index Macros
Dave Love <fx@gnu.org>
parents:
diff changeset
2377 @cindex Defining Index Macros
Dave Love <fx@gnu.org>
parents:
diff changeset
2378 @cindex Index macros, defining
Dave Love <fx@gnu.org>
parents:
diff changeset
2379 @vindex reftex-index-macros
Dave Love <fx@gnu.org>
parents:
diff changeset
2380
Dave Love <fx@gnu.org>
parents:
diff changeset
2381 When writing a document with an index you will probably define
Dave Love <fx@gnu.org>
parents:
diff changeset
2382 additional macros which make entries into the index.
Dave Love <fx@gnu.org>
parents:
diff changeset
2383 Let's look at an example.
Dave Love <fx@gnu.org>
parents:
diff changeset
2384
Dave Love <fx@gnu.org>
parents:
diff changeset
2385 @example
Dave Love <fx@gnu.org>
parents:
diff changeset
2386 \newcommand@{\ix@}[1]@{#1\index@{#1@}@}
Dave Love <fx@gnu.org>
parents:
diff changeset
2387 \newcommand@{\nindex@}[1]@{\textit@{#1@}\index[name]@{#1@}@}
Dave Love <fx@gnu.org>
parents:
diff changeset
2388 \newcommand@{\astobj@}[1]@{\index@{Astronomical Objects!#1@}@}
Dave Love <fx@gnu.org>
parents:
diff changeset
2389 @end example
Dave Love <fx@gnu.org>
parents:
diff changeset
2390
Dave Love <fx@gnu.org>
parents:
diff changeset
2391 The first macro @code{\ix} typesets its argument in the text and places
Dave Love <fx@gnu.org>
parents:
diff changeset
2392 it into the index. The second macro @code{\nindex} typesets its
Dave Love <fx@gnu.org>
parents:
diff changeset
2393 argument in the text and places it into a separate index with the tag
Dave Love <fx@gnu.org>
parents:
diff changeset
2394 @samp{name}@footnote{We are using the syntax of the @file{index} package
Dave Love <fx@gnu.org>
parents:
diff changeset
2395 here.}. The last macro also places its argument into the index, but as
Dave Love <fx@gnu.org>
parents:
diff changeset
2396 subitems under the main index entry @samp{Astronomical Objects}. Here
Dave Love <fx@gnu.org>
parents:
diff changeset
2397 is how to make @b{Ref@TeX{}} recognize and correctly interpret these
Dave Love <fx@gnu.org>
parents:
diff changeset
2398 macros, first with Emacs Lisp.
Dave Love <fx@gnu.org>
parents:
diff changeset
2399
Dave Love <fx@gnu.org>
parents:
diff changeset
2400 @lisp
Dave Love <fx@gnu.org>
parents:
diff changeset
2401 (setq reftex-index-macros
26911
d7f536a01276 Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents: 25829
diff changeset
2402 '(("\\ix@{*@}" "idx" ?x "" nil nil)
d7f536a01276 Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents: 25829
diff changeset
2403 ("\\nindex@{*@}" "name" ?n "" nil nil)
d7f536a01276 Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents: 25829
diff changeset
2404 ("\\astobj@{*@}" "idx" ?o "Astronomical Objects!" nil t)))
25829
Dave Love <fx@gnu.org>
parents:
diff changeset
2405 @end lisp
Dave Love <fx@gnu.org>
parents:
diff changeset
2406
Dave Love <fx@gnu.org>
parents:
diff changeset
2407 Note that the index tag is @samp{idx} for the main index, and
Dave Love <fx@gnu.org>
parents:
diff changeset
2408 @samp{name} for the name index. @samp{idx} and @samp{glo} are reserved
Dave Love <fx@gnu.org>
parents:
diff changeset
2409 for the default index and for the glossary.
Dave Love <fx@gnu.org>
parents:
diff changeset
2410
Dave Love <fx@gnu.org>
parents:
diff changeset
2411 The character arguments @code{?x}, @code{?n}, and @code{?o} are for
Dave Love <fx@gnu.org>
parents:
diff changeset
2412 quick identification of these macros when @b{Ref@TeX{}} inserts new
Dave Love <fx@gnu.org>
parents:
diff changeset
2413 index entries with @code{reftex-index}. These codes need to be
Dave Love <fx@gnu.org>
parents:
diff changeset
2414 unique. @code{?i}, @code{?I}, and @code{?g} are reserved for the
Dave Love <fx@gnu.org>
parents:
diff changeset
2415 @code{\index}, @code{\index*}, and @code{\glossary} macros,
Dave Love <fx@gnu.org>
parents:
diff changeset
2416 respectively.
Dave Love <fx@gnu.org>
parents:
diff changeset
2417
Dave Love <fx@gnu.org>
parents:
diff changeset
2418 The following string is empty unless your macro adds a superordinate
Dave Love <fx@gnu.org>
parents:
diff changeset
2419 entry to the index key - this is the case for the @code{\astobj} macro.
Dave Love <fx@gnu.org>
parents:
diff changeset
2420
26911
d7f536a01276 Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents: 25829
diff changeset
2421 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
2422 almost always can be @code{nil}.
d7f536a01276 Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents: 25829
diff changeset
2423
d7f536a01276 Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents: 25829
diff changeset
2424 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
2425 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
2426 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
2427 (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
2428 @code{nil}.
d7f536a01276 Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents: 25829
diff changeset
2429
25829
Dave Love <fx@gnu.org>
parents:
diff changeset
2430 To do the same thing with customize, you need to fill in the templates
Dave Love <fx@gnu.org>
parents:
diff changeset
2431 like this:
Dave Love <fx@gnu.org>
parents:
diff changeset
2432
Dave Love <fx@gnu.org>
parents:
diff changeset
2433 @example
Dave Love <fx@gnu.org>
parents:
diff changeset
2434 Repeat:
Dave Love <fx@gnu.org>
parents:
diff changeset
2435 [INS] [DEL] List:
Dave Love <fx@gnu.org>
parents:
diff changeset
2436 Macro with args: \ix@{*@}
Dave Love <fx@gnu.org>
parents:
diff changeset
2437 Index Tag : [Value Menu] String: idx
Dave Love <fx@gnu.org>
parents:
diff changeset
2438 Access Key : x
Dave Love <fx@gnu.org>
parents:
diff changeset
2439 Key Prefix :
Dave Love <fx@gnu.org>
parents:
diff changeset
2440 Exclusion hook : nil
26911
d7f536a01276 Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents: 25829
diff changeset
2441 Repeat Outside : [Toggle] off (nil)
25829
Dave Love <fx@gnu.org>
parents:
diff changeset
2442 [INS] [DEL] List:
Dave Love <fx@gnu.org>
parents:
diff changeset
2443 Macro with args: \nindex@{*@}
Dave Love <fx@gnu.org>
parents:
diff changeset
2444 Index Tag : [Value Menu] String: name
Dave Love <fx@gnu.org>
parents:
diff changeset
2445 Access Key : n
Dave Love <fx@gnu.org>
parents:
diff changeset
2446 Key Prefix :
Dave Love <fx@gnu.org>
parents:
diff changeset
2447 Exclusion hook : nil
26911
d7f536a01276 Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents: 25829
diff changeset
2448 Repeat Outside : [Toggle] off (nil)
25829
Dave Love <fx@gnu.org>
parents:
diff changeset
2449 [INS] [DEL] List:
Dave Love <fx@gnu.org>
parents:
diff changeset
2450 Macro with args: \astobj@{*@}
Dave Love <fx@gnu.org>
parents:
diff changeset
2451 Index Tag : [Value Menu] String: idx
Dave Love <fx@gnu.org>
parents:
diff changeset
2452 Access Key : o
Dave Love <fx@gnu.org>
parents:
diff changeset
2453 Key Prefix : Astronomical Objects!
Dave Love <fx@gnu.org>
parents:
diff changeset
2454 Exclusion hook : nil
26911
d7f536a01276 Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents: 25829
diff changeset
2455 Repeat Outside : [Toggle] on (non-nil)
25829
Dave Love <fx@gnu.org>
parents:
diff changeset
2456 [INS]
Dave Love <fx@gnu.org>
parents:
diff changeset
2457 @end example
Dave Love <fx@gnu.org>
parents:
diff changeset
2458
Dave Love <fx@gnu.org>
parents:
diff changeset
2459 With the macro @code{\ix} defined, you may want to change the default
Dave Love <fx@gnu.org>
parents:
diff changeset
2460 macro used for indexing a text phrase (@pxref{Creating Index Entries}).
Dave Love <fx@gnu.org>
parents:
diff changeset
2461 This would be done like this
Dave Love <fx@gnu.org>
parents:
diff changeset
2462
Dave Love <fx@gnu.org>
parents:
diff changeset
2463 @lisp
26911
d7f536a01276 Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents: 25829
diff changeset
2464 (setq reftex-index-default-macro '(?x "idx"))
25829
Dave Love <fx@gnu.org>
parents:
diff changeset
2465 @end lisp
Dave Love <fx@gnu.org>
parents:
diff changeset
2466
Dave Love <fx@gnu.org>
parents:
diff changeset
2467 which specifies that the macro identified with the character @code{?x} (the
Dave Love <fx@gnu.org>
parents:
diff changeset
2468 @code{\ix} macro) should be used for indexing phrases and words already
Dave Love <fx@gnu.org>
parents:
diff changeset
2469 in the buffer with @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
2470 The index tag is "idx".@refill
25829
Dave Love <fx@gnu.org>
parents:
diff changeset
2471
Dave Love <fx@gnu.org>
parents:
diff changeset
2472 @node Viewing Cross-References, RefTeXs Menu, Index Support, Top
Dave Love <fx@gnu.org>
parents:
diff changeset
2473 @chapter Viewing Cross--References
Dave Love <fx@gnu.org>
parents:
diff changeset
2474 @findex reftex-view-crossref
Dave Love <fx@gnu.org>
parents:
diff changeset
2475 @findex reftex-mouse-view-crossref
Dave Love <fx@gnu.org>
parents:
diff changeset
2476 @kindex C-c &
Dave Love <fx@gnu.org>
parents:
diff changeset
2477 @kindex S-mouse-2
Dave Love <fx@gnu.org>
parents:
diff changeset
2478
Dave Love <fx@gnu.org>
parents:
diff changeset
2479 @b{Ref@TeX{}} can display cross--referencing information. This means,
Dave Love <fx@gnu.org>
parents:
diff changeset
2480 if two document locations are linked, @b{Ref@TeX{}} can display the
Dave Love <fx@gnu.org>
parents:
diff changeset
2481 matching location(s) in another window. The @code{\label} and @code{\ref}
Dave Love <fx@gnu.org>
parents:
diff changeset
2482 macros are one way of establishing such a link. Also, a @code{\cite}
Dave Love <fx@gnu.org>
parents:
diff changeset
2483 macro is linked to the corresponding @code{\bibitem} macro or a BibTeX
Dave Love <fx@gnu.org>
parents:
diff changeset
2484 database entry.@refill
Dave Love <fx@gnu.org>
parents:
diff changeset
2485
Dave Love <fx@gnu.org>
parents:
diff changeset
2486 The feature is invoked by pressing @kbd{C-c &}
Dave Love <fx@gnu.org>
parents:
diff changeset
2487 (@code{reftex-view-crossref}) while point is on the @var{key} argument
Dave Love <fx@gnu.org>
parents:
diff changeset
2488 of a macro involved in cross--referencing. You can also click with
Dave Love <fx@gnu.org>
parents:
diff changeset
2489 @kbd{S-mouse-2} on the macro argument. Here is what will happen for
Dave Love <fx@gnu.org>
parents:
diff changeset
2490 individual classes of macros:@refill
Dave Love <fx@gnu.org>
parents:
diff changeset
2491
Dave Love <fx@gnu.org>
parents:
diff changeset
2492 @table @asis
Dave Love <fx@gnu.org>
parents:
diff changeset
2493
Dave Love <fx@gnu.org>
parents:
diff changeset
2494 @item @code{\ref}
Dave Love <fx@gnu.org>
parents:
diff changeset
2495 @cindex @code{\ref}
Dave Love <fx@gnu.org>
parents:
diff changeset
2496 Display the corresponding label definition. All usual
Dave Love <fx@gnu.org>
parents:
diff changeset
2497 variants@footnote{all macros that start with @samp{ref} or end with
Dave Love <fx@gnu.org>
parents:
diff changeset
2498 @samp{ref} or @samp{refrange}} of the @code{\ref} macro are active for
Dave Love <fx@gnu.org>
parents:
diff changeset
2499 cross--reference display. This works also for labels defined in an
Dave Love <fx@gnu.org>
parents:
diff changeset
2500 external document when the current document refers to them through the
Dave Love <fx@gnu.org>
parents:
diff changeset
2501 @code{xr} interface (@pxref{xr (LaTeX package)}).@refill
Dave Love <fx@gnu.org>
parents:
diff changeset
2502
Dave Love <fx@gnu.org>
parents:
diff changeset
2503 @item @code{\label}
Dave Love <fx@gnu.org>
parents:
diff changeset
2504 @cindex @code{\label}
Dave Love <fx@gnu.org>
parents:
diff changeset
2505 @vindex reftex-label-alist
Dave Love <fx@gnu.org>
parents:
diff changeset
2506 Display a document location which references this label. Pressing
Dave Love <fx@gnu.org>
parents:
diff changeset
2507 @kbd{C-c &} several times moves through the entire document and finds
Dave Love <fx@gnu.org>
parents:
diff changeset
2508 all locations. Not only the @code{\label} macro but also other macros
Dave Love <fx@gnu.org>
parents:
diff changeset
2509 with label arguments (as configured with @code{reftex-label-alist}) are
Dave Love <fx@gnu.org>
parents:
diff changeset
2510 active for cross--reference display.@refill
Dave Love <fx@gnu.org>
parents:
diff changeset
2511
Dave Love <fx@gnu.org>
parents:
diff changeset
2512 @item @code{\cite}
Dave Love <fx@gnu.org>
parents:
diff changeset
2513 @cindex @code{\cite}
Dave Love <fx@gnu.org>
parents:
diff changeset
2514 Display the corresponding BibTeX database entry or @code{\bibitem}.
Dave Love <fx@gnu.org>
parents:
diff changeset
2515 All usual variants@footnote{all macros that either start or end with
Dave Love <fx@gnu.org>
parents:
diff changeset
2516 @samp{cite}} of the @code{\cite} macro are active for cross--reference
Dave Love <fx@gnu.org>
parents:
diff changeset
2517 display.@refill
Dave Love <fx@gnu.org>
parents:
diff changeset
2518
Dave Love <fx@gnu.org>
parents:
diff changeset
2519 @item @code{\bibitem}
Dave Love <fx@gnu.org>
parents:
diff changeset
2520 @cindex @code{\bibitem}
Dave Love <fx@gnu.org>
parents:
diff changeset
2521 Display a document location which cites this article. Pressing
Dave Love <fx@gnu.org>
parents:
diff changeset
2522 @kbd{C-c &} several times moves through the entire document and finds
Dave Love <fx@gnu.org>
parents:
diff changeset
2523 all locations.@refill
Dave Love <fx@gnu.org>
parents:
diff changeset
2524
Dave Love <fx@gnu.org>
parents:
diff changeset
2525 @item BibTeX
Dave Love <fx@gnu.org>
parents:
diff changeset
2526 @cindex BibTeX buffer, viewing cite locations from
Dave Love <fx@gnu.org>
parents:
diff changeset
2527 @cindex Viewing cite locations from BibTeX buffer
Dave Love <fx@gnu.org>
parents:
diff changeset
2528 @kbd{C-c &} is also active in BibTeX buffers. All locations in a
Dave Love <fx@gnu.org>
parents:
diff changeset
2529 document where the database entry at point is cited will be displayed.
Dave Love <fx@gnu.org>
parents:
diff changeset
2530 On first use, @b{Ref@TeX{}} will prompt for a buffer which belongs to
Dave Love <fx@gnu.org>
parents:
diff changeset
2531 the document you want to search. Subsequent calls will use the same
Dave Love <fx@gnu.org>
parents:
diff changeset
2532 document, until you break this link with a prefix argument to @kbd{C-c
Dave Love <fx@gnu.org>
parents:
diff changeset
2533 &}.@refill
Dave Love <fx@gnu.org>
parents:
diff changeset
2534
Dave Love <fx@gnu.org>
parents:
diff changeset
2535 @item @code{\index}
Dave Love <fx@gnu.org>
parents:
diff changeset
2536 @cindex @code{\index}
Dave Love <fx@gnu.org>
parents:
diff changeset
2537 Display other locations in the document which are marked by an index
Dave Love <fx@gnu.org>
parents:
diff changeset
2538 macro with the same key argument. Along with the standard @code{\index}
Dave Love <fx@gnu.org>
parents:
diff changeset
2539 and @code{\glossary} macros, all macros configured in
Dave Love <fx@gnu.org>
parents:
diff changeset
2540 @code{reftex-index-macros} will be recognized.@refill
Dave Love <fx@gnu.org>
parents:
diff changeset
2541 @end table
Dave Love <fx@gnu.org>
parents:
diff changeset
2542
Dave Love <fx@gnu.org>
parents:
diff changeset
2543 @vindex reftex-view-crossref-macros
Dave Love <fx@gnu.org>
parents:
diff changeset
2544 While the display of cross referencing information for the above
Dave Love <fx@gnu.org>
parents:
diff changeset
2545 mentioned macros is hard--coded, you can configure additional relations
Dave Love <fx@gnu.org>
parents:
diff changeset
2546 in the variable @code{reftex-view-crossref-macros}.
Dave Love <fx@gnu.org>
parents:
diff changeset
2547
Dave Love <fx@gnu.org>
parents:
diff changeset
2548 @iftex
Dave Love <fx@gnu.org>
parents:
diff changeset
2549 @chapter All the Rest
Dave Love <fx@gnu.org>
parents:
diff changeset
2550 @end iftex
Dave Love <fx@gnu.org>
parents:
diff changeset
2551
Dave Love <fx@gnu.org>
parents:
diff changeset
2552 @node RefTeXs Menu, Keybindings, Viewing Cross-References, Top
Dave Love <fx@gnu.org>
parents:
diff changeset
2553 @section @b{Ref@TeX{}}'s Menu
Dave Love <fx@gnu.org>
parents:
diff changeset
2554 @cindex RefTeXs Menu
Dave Love <fx@gnu.org>
parents:
diff changeset
2555 @cindex Menu, in the menu bar
Dave Love <fx@gnu.org>
parents:
diff changeset
2556
Dave Love <fx@gnu.org>
parents:
diff changeset
2557 @b{Ref@TeX{}} installs a @code{Ref} menu in the menu bar on systems
Dave Love <fx@gnu.org>
parents:
diff changeset
2558 which support this. From this menu you can access all of
Dave Love <fx@gnu.org>
parents:
diff changeset
2559 @b{Ref@TeX{}}'s commands and a few of its options. There is also a
Dave Love <fx@gnu.org>
parents:
diff changeset
2560 @code{Customize} submenu which can be used to access @b{Ref@TeX{}}'s
Dave Love <fx@gnu.org>
parents:
diff changeset
2561 entire set of options.@refill
Dave Love <fx@gnu.org>
parents:
diff changeset
2562
Dave Love <fx@gnu.org>
parents:
diff changeset
2563 @node Keybindings, Faces, RefTeXs Menu, Top
Dave Love <fx@gnu.org>
parents:
diff changeset
2564 @section Default Keybindings
Dave Love <fx@gnu.org>
parents:
diff changeset
2565 @cindex Keybindings, summary
Dave Love <fx@gnu.org>
parents:
diff changeset
2566
Dave Love <fx@gnu.org>
parents:
diff changeset
2567 Here is a summary of the available keybindings.
Dave Love <fx@gnu.org>
parents:
diff changeset
2568
Dave Love <fx@gnu.org>
parents:
diff changeset
2569 @kindex C-c =
Dave Love <fx@gnu.org>
parents:
diff changeset
2570 @kindex C-c (
Dave Love <fx@gnu.org>
parents:
diff changeset
2571 @kindex C-c )
Dave Love <fx@gnu.org>
parents:
diff changeset
2572 @kindex C-c [
Dave Love <fx@gnu.org>
parents:
diff changeset
2573 @kindex C-c &
Dave Love <fx@gnu.org>
parents:
diff changeset
2574 @kindex S-mouse-2
Dave Love <fx@gnu.org>
parents:
diff changeset
2575 @kindex C-c /
26911
d7f536a01276 Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents: 25829
diff changeset
2576 @kindex C-c \
d7f536a01276 Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents: 25829
diff changeset
2577 @kindex C-c |
25829
Dave Love <fx@gnu.org>
parents:
diff changeset
2578 @kindex C-c <
Dave Love <fx@gnu.org>
parents:
diff changeset
2579 @kindex C-c >
Dave Love <fx@gnu.org>
parents:
diff changeset
2580 @example
Dave Love <fx@gnu.org>
parents:
diff changeset
2581 @kbd{C-c =} @code{reftex-toc}
Dave Love <fx@gnu.org>
parents:
diff changeset
2582 @kbd{C-c (} @code{reftex-label}
Dave Love <fx@gnu.org>
parents:
diff changeset
2583 @kbd{C-c )} @code{reftex-reference}
Dave Love <fx@gnu.org>
parents:
diff changeset
2584 @kbd{C-c [} @code{reftex-citation}
Dave Love <fx@gnu.org>
parents:
diff changeset
2585 @kbd{C-c &} @code{reftex-view-crossref}
Dave Love <fx@gnu.org>
parents:
diff changeset
2586 @kbd{S-mouse-2} @code{reftex-mouse-view-crossref}
Dave Love <fx@gnu.org>
parents:
diff changeset
2587 @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
2588 @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
2589 @kbd{C-c |} @code{reftex-index-visit-phrases-buffer}
25829
Dave Love <fx@gnu.org>
parents:
diff changeset
2590 @kbd{C-c <} @code{reftex-index}
Dave Love <fx@gnu.org>
parents:
diff changeset
2591 @kbd{C-c >} @code{reftex-display-index}
Dave Love <fx@gnu.org>
parents:
diff changeset
2592 @end example
Dave Love <fx@gnu.org>
parents:
diff changeset
2593
Dave Love <fx@gnu.org>
parents:
diff changeset
2594 Note that the @kbd{S-mouse-2} binding is only provided if this key is
Dave Love <fx@gnu.org>
parents:
diff changeset
2595 not already used by some other package. @b{Ref@TeX{}} will not override an
Dave Love <fx@gnu.org>
parents:
diff changeset
2596 existing binding to @kbd{S-mouse-2}.@refill
Dave Love <fx@gnu.org>
parents:
diff changeset
2597
Dave Love <fx@gnu.org>
parents:
diff changeset
2598 Personally, I also bind some functions in the users @kbd{C-c} map for
Dave Love <fx@gnu.org>
parents:
diff changeset
2599 easier access.@refill
Dave Love <fx@gnu.org>
parents:
diff changeset
2600
Dave Love <fx@gnu.org>
parents:
diff changeset
2601 @c FIXME: Do we need bindings for the Index macros here as well?
Dave Love <fx@gnu.org>
parents:
diff changeset
2602 @c C-c i C-c I or so????
Dave Love <fx@gnu.org>
parents:
diff changeset
2603 @c How about keybindings for reftex-reset-mode and reftex-parse-document?
Dave Love <fx@gnu.org>
parents:
diff changeset
2604 @kindex C-c t
Dave Love <fx@gnu.org>
parents:
diff changeset
2605 @kindex C-c l
Dave Love <fx@gnu.org>
parents:
diff changeset
2606 @kindex C-c r
Dave Love <fx@gnu.org>
parents:
diff changeset
2607 @kindex C-c c
Dave Love <fx@gnu.org>
parents:
diff changeset
2608 @kindex C-c v
Dave Love <fx@gnu.org>
parents:
diff changeset
2609 @kindex C-c s
Dave Love <fx@gnu.org>
parents:
diff changeset
2610 @kindex C-c g
Dave Love <fx@gnu.org>
parents:
diff changeset
2611 @example
Dave Love <fx@gnu.org>
parents:
diff changeset
2612 @kbd{C-c t} @code{reftex-toc}
Dave Love <fx@gnu.org>
parents:
diff changeset
2613 @kbd{C-c l} @code{reftex-label}
Dave Love <fx@gnu.org>
parents:
diff changeset
2614 @kbd{C-c r} @code{reftex-reference}
Dave Love <fx@gnu.org>
parents:
diff changeset
2615 @kbd{C-c c} @code{reftex-citation}
Dave Love <fx@gnu.org>
parents:
diff changeset
2616 @kbd{C-c v} @code{reftex-view-crossref}
Dave Love <fx@gnu.org>
parents:
diff changeset
2617 @kbd{C-c s} @code{reftex-search-document}
Dave Love <fx@gnu.org>
parents:
diff changeset
2618 @kbd{C-c g} @code{reftex-grep-document}
Dave Love <fx@gnu.org>
parents:
diff changeset
2619 @end example
Dave Love <fx@gnu.org>
parents:
diff changeset
2620
Dave Love <fx@gnu.org>
parents:
diff changeset
2621 @noindent These keys are reserved for the user, so I cannot bind them by
Dave Love <fx@gnu.org>
parents:
diff changeset
2622 default. If you want to have these keybindings available, set in your
Dave Love <fx@gnu.org>
parents:
diff changeset
2623 @file{.emacs} file:
Dave Love <fx@gnu.org>
parents:
diff changeset
2624
Dave Love <fx@gnu.org>
parents:
diff changeset
2625 @vindex reftex-extra-bindings
Dave Love <fx@gnu.org>
parents:
diff changeset
2626 @lisp
Dave Love <fx@gnu.org>
parents:
diff changeset
2627 (setq reftex-extra-bindings t)
Dave Love <fx@gnu.org>
parents:
diff changeset
2628 @end lisp
Dave Love <fx@gnu.org>
parents:
diff changeset
2629
Dave Love <fx@gnu.org>
parents:
diff changeset
2630 @vindex reftex-load-hook
Dave Love <fx@gnu.org>
parents:
diff changeset
2631 Changing and adding to @b{Ref@TeX{}}'s keybindings is best done in the hook
Dave Love <fx@gnu.org>
parents:
diff changeset
2632 @code{reftex-load-hook}. For information on the keymaps
Dave Love <fx@gnu.org>
parents:
diff changeset
2633 which should be used to add keys, see @ref{Keymaps and Hooks}.
Dave Love <fx@gnu.org>
parents:
diff changeset
2634
Dave Love <fx@gnu.org>
parents:
diff changeset
2635 @node Faces, AUCTeX, Keybindings, Top
Dave Love <fx@gnu.org>
parents:
diff changeset
2636 @section Faces
Dave Love <fx@gnu.org>
parents:
diff changeset
2637 @cindex Faces
Dave Love <fx@gnu.org>
parents:
diff changeset
2638
Dave Love <fx@gnu.org>
parents:
diff changeset
2639 @b{Ref@TeX{}} uses faces when available to structure the selection and
Dave Love <fx@gnu.org>
parents:
diff changeset
2640 table of contents buffers. It does not create its own faces, but uses
Dave Love <fx@gnu.org>
parents:
diff changeset
2641 the ones defined in @file{font-lock.el}. Therefore, @b{Ref@TeX{}} will
Dave Love <fx@gnu.org>
parents:
diff changeset
2642 use faces only when @code{font-lock} is loaded. This seems to be
Dave Love <fx@gnu.org>
parents:
diff changeset
2643 reasonable because people who like faces will very likely have it
Dave Love <fx@gnu.org>
parents:
diff changeset
2644 loaded. If you wish to turn off fontification or change the involved
Dave Love <fx@gnu.org>
parents:
diff changeset
2645 faces, see @ref{Options (Fontification)}.@refill
Dave Love <fx@gnu.org>
parents:
diff changeset
2646
Dave Love <fx@gnu.org>
parents:
diff changeset
2647 @node Multifile Documents, Language Support, AUCTeX, Top
Dave Love <fx@gnu.org>
parents:
diff changeset
2648 @section Multifile Documents
Dave Love <fx@gnu.org>
parents:
diff changeset
2649 @cindex Multifile documents
Dave Love <fx@gnu.org>
parents:
diff changeset
2650 @cindex Documents, spread over files
Dave Love <fx@gnu.org>
parents:
diff changeset
2651
Dave Love <fx@gnu.org>
parents:
diff changeset
2652 The following is relevant when working with documents spread over many
Dave Love <fx@gnu.org>
parents:
diff changeset
2653 files:@refill
Dave Love <fx@gnu.org>
parents:
diff changeset
2654
Dave Love <fx@gnu.org>
parents:
diff changeset
2655 @itemize @bullet
Dave Love <fx@gnu.org>
parents:
diff changeset
2656 @item
Dave Love <fx@gnu.org>
parents:
diff changeset
2657 @b{Ref@TeX{}} has full support for multifile documents. You can edit parts of
Dave Love <fx@gnu.org>
parents:
diff changeset
2658 several (multifile) documents at the same time without conflicts.
Dave Love <fx@gnu.org>
parents:
diff changeset
2659 @b{Ref@TeX{}} provides functions to run @code{grep}, @code{search} and
Dave Love <fx@gnu.org>
parents:
diff changeset
2660 @code{query-replace} on all files which are part of a multifile
Dave Love <fx@gnu.org>
parents:
diff changeset
2661 document.@refill
Dave Love <fx@gnu.org>
parents:
diff changeset
2662
Dave Love <fx@gnu.org>
parents:
diff changeset
2663 @item
Dave Love <fx@gnu.org>
parents:
diff changeset
2664 @vindex tex-main-file
Dave Love <fx@gnu.org>
parents:
diff changeset
2665 @vindex TeX-master
29772
265fdb06f294 Update to reftex 4 14
Carsten Dominik <dominik@science.uva.nl>
parents: 29713
diff changeset
2666 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
2667 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
2668 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
2669 example, to set the file variable @code{TeX-master}, include something
265fdb06f294 Update to reftex 4 14
Carsten Dominik <dominik@science.uva.nl>
parents: 29713
diff changeset
2670 like the following at the end of each TeX file:@refill
265fdb06f294 Update to reftex 4 14
Carsten Dominik <dominik@science.uva.nl>
parents: 29713
diff changeset
2671
265fdb06f294 Update to reftex 4 14
Carsten Dominik <dominik@science.uva.nl>
parents: 29713
diff changeset
2672 @example
265fdb06f294 Update to reftex 4 14
Carsten Dominik <dominik@science.uva.nl>
parents: 29713
diff changeset
2673 %%% Local Variables: ***
265fdb06f294 Update to reftex 4 14
Carsten Dominik <dominik@science.uva.nl>
parents: 29713
diff changeset
2674 %%% mode:latex ***
265fdb06f294 Update to reftex 4 14
Carsten Dominik <dominik@science.uva.nl>
parents: 29713
diff changeset
2675 %%% TeX-master: "thesis.tex" ***
265fdb06f294 Update to reftex 4 14
Carsten Dominik <dominik@science.uva.nl>
parents: 29713
diff changeset
2676 %%% End: ***
265fdb06f294 Update to reftex 4 14
Carsten Dominik <dominik@science.uva.nl>
parents: 29713
diff changeset
2677 @end example
265fdb06f294 Update to reftex 4 14
Carsten Dominik <dominik@science.uva.nl>
parents: 29713
diff changeset
2678
265fdb06f294 Update to reftex 4 14
Carsten Dominik <dominik@science.uva.nl>
parents: 29713
diff changeset
2679 AUCTeX with the setting
265fdb06f294 Update to reftex 4 14
Carsten Dominik <dominik@science.uva.nl>
parents: 29713
diff changeset
2680
265fdb06f294 Update to reftex 4 14
Carsten Dominik <dominik@science.uva.nl>
parents: 29713
diff changeset
2681 @lisp
265fdb06f294 Update to reftex 4 14
Carsten Dominik <dominik@science.uva.nl>
parents: 29713
diff changeset
2682 (setq-default TeX-master nil)
265fdb06f294 Update to reftex 4 14
Carsten Dominik <dominik@science.uva.nl>
parents: 29713
diff changeset
2683 @end lisp
265fdb06f294 Update to reftex 4 14
Carsten Dominik <dominik@science.uva.nl>
parents: 29713
diff changeset
2684
265fdb06f294 Update to reftex 4 14
Carsten Dominik <dominik@science.uva.nl>
parents: 29713
diff changeset
2685 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
2686 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
2687 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
2688 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
2689 The GNU Emacs Manual}) and the Emacs documentation on File Variables
265fdb06f294 Update to reftex 4 14
Carsten Dominik <dominik@science.uva.nl>
parents: 29713
diff changeset
2690 (@pxref{File Variables,,,emacs, The GNU Emacs Manual}).@refill
25829
Dave Love <fx@gnu.org>
parents:
diff changeset
2691
Dave Love <fx@gnu.org>
parents:
diff changeset
2692 @item
Dave Love <fx@gnu.org>
parents:
diff changeset
2693 The context of a label definition must be found in the same file as the
Dave Love <fx@gnu.org>
parents:
diff changeset
2694 label itself in order to be processed correctly by @b{Ref@TeX{}}. The only
Dave Love <fx@gnu.org>
parents:
diff changeset
2695 exception is that section labels referring to a section statement
Dave Love <fx@gnu.org>
parents:
diff changeset
2696 outside the current file can still use that section title as
Dave Love <fx@gnu.org>
parents:
diff changeset
2697 context.@refill
Dave Love <fx@gnu.org>
parents:
diff changeset
2698 @end itemize
Dave Love <fx@gnu.org>
parents:
diff changeset
2699
Dave Love <fx@gnu.org>
parents:
diff changeset
2700 @node Language Support, Finding Files, Multifile Documents, Top
Dave Love <fx@gnu.org>
parents:
diff changeset
2701 @section Language Support
Dave Love <fx@gnu.org>
parents:
diff changeset
2702 @cindex Language support
Dave Love <fx@gnu.org>
parents:
diff changeset
2703
Dave Love <fx@gnu.org>
parents:
diff changeset
2704 Some parts of @b{Ref@TeX{}} are language dependent. The default
Dave Love <fx@gnu.org>
parents:
diff changeset
2705 settings work well for English. If you are writing in a different
Dave Love <fx@gnu.org>
parents:
diff changeset
2706 language, the following hints may be useful:
Dave Love <fx@gnu.org>
parents:
diff changeset
2707
Dave Love <fx@gnu.org>
parents:
diff changeset
2708 @itemize @bullet
Dave Love <fx@gnu.org>
parents:
diff changeset
2709 @item
Dave Love <fx@gnu.org>
parents:
diff changeset
2710 @vindex reftex-derive-label-parameters
Dave Love <fx@gnu.org>
parents:
diff changeset
2711 @vindex reftex-abbrev-parameters
Dave Love <fx@gnu.org>
parents:
diff changeset
2712 The mechanism to derive a label from context includes the abbreviation
Dave Love <fx@gnu.org>
parents:
diff changeset
2713 of words and omission of unimportant words. These mechanisms may have
Dave Love <fx@gnu.org>
parents:
diff changeset
2714 to be changed for other languages. See the variables
Dave Love <fx@gnu.org>
parents:
diff changeset
2715 @code{reftex-derive-label-parameters} and @code{reftex-abbrev-parameters}.
Dave Love <fx@gnu.org>
parents:
diff changeset
2716
Dave Love <fx@gnu.org>
parents:
diff changeset
2717 @item
Dave Love <fx@gnu.org>
parents:
diff changeset
2718 @vindex reftex-translate-to-ascii-function
Dave Love <fx@gnu.org>
parents:
diff changeset
2719 @vindex reftex-label-illegal-re
Dave Love <fx@gnu.org>
parents:
diff changeset
2720 Also, when a label is derived from context, @b{Ref@TeX{}} clears the
Dave Love <fx@gnu.org>
parents:
diff changeset
2721 context string from non-ASCII characters in order to make a legal label.
Dave Love <fx@gnu.org>
parents:
diff changeset
2722 If there should ever be a version of @TeX{} which allows extended
Dave Love <fx@gnu.org>
parents:
diff changeset
2723 characters @emph{in labels}, then we will have to look at the
Dave Love <fx@gnu.org>
parents:
diff changeset
2724 variables @code{reftex-translate-to-ascii-function} and
Dave Love <fx@gnu.org>
parents:
diff changeset
2725 @code{reftex-label-illegal-re}.
Dave Love <fx@gnu.org>
parents:
diff changeset
2726
Dave Love <fx@gnu.org>
parents:
diff changeset
2727 @item
Dave Love <fx@gnu.org>
parents:
diff changeset
2728 When a label is referenced, @b{Ref@TeX{}} looks at the word before point
Dave Love <fx@gnu.org>
parents:
diff changeset
2729 to guess which label type is required. These @emph{magic words} are
Dave Love <fx@gnu.org>
parents:
diff changeset
2730 different in every language. For an example of how to add magic words,
Dave Love <fx@gnu.org>
parents:
diff changeset
2731 see @ref{Adding Magic Words}.
Dave Love <fx@gnu.org>
parents:
diff changeset
2732
Dave Love <fx@gnu.org>
parents:
diff changeset
2733 @vindex reftex-multiref-punctuation
Dave Love <fx@gnu.org>
parents:
diff changeset
2734 @vindex reftex-cite-punctuation
Dave Love <fx@gnu.org>
parents:
diff changeset
2735 @item
Dave Love <fx@gnu.org>
parents:
diff changeset
2736 @b{Ref@TeX{}} inserts ``punctuation'' for multiple references and
Dave Love <fx@gnu.org>
parents:
diff changeset
2737 for the author list in citations. Some of this may be language
Dave Love <fx@gnu.org>
parents:
diff changeset
2738 dependent. See the variables @code{reftex-multiref-punctuation} and
Dave Love <fx@gnu.org>
parents:
diff changeset
2739 @code{reftex-cite-punctuation}.
Dave Love <fx@gnu.org>
parents:
diff changeset
2740 @end itemize
Dave Love <fx@gnu.org>
parents:
diff changeset
2741
Dave Love <fx@gnu.org>
parents:
diff changeset
2742 @node Finding Files, Optimizations, Language Support, Top
Dave Love <fx@gnu.org>
parents:
diff changeset
2743 @section Finding Files
Dave Love <fx@gnu.org>
parents:
diff changeset
2744 @cindex Finding files
Dave Love <fx@gnu.org>
parents:
diff changeset
2745
Dave Love <fx@gnu.org>
parents:
diff changeset
2746 In order to find files included in a document via @code{\input} or
Dave Love <fx@gnu.org>
parents:
diff changeset
2747 @code{\include}, @b{Ref@TeX{}} searches all directories specified in the
Dave Love <fx@gnu.org>
parents:
diff changeset
2748 environment variable @code{TEXINPUTS}. Similarly, it will search the
Dave Love <fx@gnu.org>
parents:
diff changeset
2749 path specified in the variables @code{BIBINPUTS} and @code{TEXBIB} for
Dave Love <fx@gnu.org>
parents:
diff changeset
2750 BibTeX database files.
Dave Love <fx@gnu.org>
parents:
diff changeset
2751
Dave Love <fx@gnu.org>
parents:
diff changeset
2752 When searching, @b{Ref@TeX{}} will also expand recursive path
Dave Love <fx@gnu.org>
parents:
diff changeset
2753 definitions (directories ending in @samp{//} or @samp{!!}). But it will
Dave Love <fx@gnu.org>
parents:
diff changeset
2754 only search and expand directories @emph{explicitly} given in these
Dave Love <fx@gnu.org>
parents:
diff changeset
2755 variables. This may cause problems under the following circumstances:
Dave Love <fx@gnu.org>
parents:
diff changeset
2756
Dave Love <fx@gnu.org>
parents:
diff changeset
2757 @itemize @bullet
Dave Love <fx@gnu.org>
parents:
diff changeset
2758 @item
Dave Love <fx@gnu.org>
parents:
diff changeset
2759 Most TeX system have a default search path for both TeX files and BibTeX
Dave Love <fx@gnu.org>
parents:
diff changeset
2760 files which is defined in some setup file. Usually this default path is
Dave Love <fx@gnu.org>
parents:
diff changeset
2761 for system files which @b{Ref@TeX{}} does not need to see. But if your
Dave Love <fx@gnu.org>
parents:
diff changeset
2762 document needs TeX files or BibTeX database files in a directory only
Dave Love <fx@gnu.org>
parents:
diff changeset
2763 given in the default search path, @b{Ref@TeX{}} will fail to find them.
Dave Love <fx@gnu.org>
parents:
diff changeset
2764 @item
Dave Love <fx@gnu.org>
parents:
diff changeset
2765 Some TeX systems do not use environment variables at all in order to
Dave Love <fx@gnu.org>
parents:
diff changeset
2766 specify the search path. Both default and user search path are then
Dave Love <fx@gnu.org>
parents:
diff changeset
2767 defined in setup files.
Dave Love <fx@gnu.org>
parents:
diff changeset
2768 @end itemize
Dave Love <fx@gnu.org>
parents:
diff changeset
2769
Dave Love <fx@gnu.org>
parents:
diff changeset
2770 @noindent
Dave Love <fx@gnu.org>
parents:
diff changeset
2771 There are three ways to solve this problem:
Dave Love <fx@gnu.org>
parents:
diff changeset
2772
Dave Love <fx@gnu.org>
parents:
diff changeset
2773 @itemize @bullet
Dave Love <fx@gnu.org>
parents:
diff changeset
2774 @item
Dave Love <fx@gnu.org>
parents:
diff changeset
2775 Specify all relevant directories explicitly in the environment
Dave Love <fx@gnu.org>
parents:
diff changeset
2776 variables. If for some reason you don't want to mess with the default
Dave Love <fx@gnu.org>
parents:
diff changeset
2777 variables @code{TEXINPUTS} and @code{BIBINPUTS}, define your own
Dave Love <fx@gnu.org>
parents:
diff changeset
2778 variables and configure @b{Ref@TeX{}} to use them instead:
Dave Love <fx@gnu.org>
parents:
diff changeset
2779
Dave Love <fx@gnu.org>
parents:
diff changeset
2780 @lisp
Dave Love <fx@gnu.org>
parents:
diff changeset
2781 (setq reftex-texpath-environment-variables '("MYTEXINPUTS"))
Dave Love <fx@gnu.org>
parents:
diff changeset
2782 (setq reftex-bibpath-environment-variables '("MYBIBINPUTS"))
Dave Love <fx@gnu.org>
parents:
diff changeset
2783 @end lisp
Dave Love <fx@gnu.org>
parents:
diff changeset
2784
Dave Love <fx@gnu.org>
parents:
diff changeset
2785 @item
Dave Love <fx@gnu.org>
parents:
diff changeset
2786 Specify the full search path directly in @b{Ref@TeX{}}'s variables.
Dave Love <fx@gnu.org>
parents:
diff changeset
2787
Dave Love <fx@gnu.org>
parents:
diff changeset
2788 @lisp
Dave Love <fx@gnu.org>
parents:
diff changeset
2789 (setq reftex-texpath-environment-variables
Dave Love <fx@gnu.org>
parents:
diff changeset
2790 '("./inp:/home/cd/tex//:/usr/local/tex//"))
Dave Love <fx@gnu.org>
parents:
diff changeset
2791 (setq reftex-bibpath-environment-variables
Dave Love <fx@gnu.org>
parents:
diff changeset
2792 '("/home/cd/tex/lit/"))
Dave Love <fx@gnu.org>
parents:
diff changeset
2793 @end lisp
Dave Love <fx@gnu.org>
parents:
diff changeset
2794
Dave Love <fx@gnu.org>
parents:
diff changeset
2795 @item
Dave Love <fx@gnu.org>
parents:
diff changeset
2796 Some TeX systems provide stand--alone programs to do the file search just
Dave Love <fx@gnu.org>
parents:
diff changeset
2797 like TeX and BibTeX. E.g. Thomas Esser's @code{teTeX} uses the
Dave Love <fx@gnu.org>
parents:
diff changeset
2798 @code{kpathsearch} library which provides the command @code{kpsewhich}
Dave Love <fx@gnu.org>
parents:
diff changeset
2799 to search for files. @b{Ref@TeX{}} can be configured to use this
Dave Love <fx@gnu.org>
parents:
diff changeset
2800 program. Note that the exact syntax of the @code{kpsewhich}
Dave Love <fx@gnu.org>
parents:
diff changeset
2801 command depends upon the version of that program.
Dave Love <fx@gnu.org>
parents:
diff changeset
2802
Dave Love <fx@gnu.org>
parents:
diff changeset
2803 @lisp
Dave Love <fx@gnu.org>
parents:
diff changeset
2804 (setq reftex-use-external-file-finders t)
Dave Love <fx@gnu.org>
parents:
diff changeset
2805 (setq reftex-external-file-finders
Dave Love <fx@gnu.org>
parents:
diff changeset
2806 '(("tex" "kpsewhich -format=.tex %f")
Dave Love <fx@gnu.org>
parents:
diff changeset
2807 ("bib" "kpsewhich -format=.bib %f")))
Dave Love <fx@gnu.org>
parents:
diff changeset
2808 @end lisp
Dave Love <fx@gnu.org>
parents:
diff changeset
2809 @end itemize
Dave Love <fx@gnu.org>
parents:
diff changeset
2810
Dave Love <fx@gnu.org>
parents:
diff changeset
2811 @node Optimizations, Problems and Work-Arounds, Finding Files, Top
Dave Love <fx@gnu.org>
parents:
diff changeset
2812 @section Optimizations
Dave Love <fx@gnu.org>
parents:
diff changeset
2813 @cindex Optimizations
Dave Love <fx@gnu.org>
parents:
diff changeset
2814
Dave Love <fx@gnu.org>
parents:
diff changeset
2815 Implementing the principle of least surprises, the default settings of
Dave Love <fx@gnu.org>
parents:
diff changeset
2816 @b{Ref@TeX{}} ensure a safe ride for beginners and casual users. However,
Dave Love <fx@gnu.org>
parents:
diff changeset
2817 when using @b{Ref@TeX{}} for a large project and/or on a small computer,
Dave Love <fx@gnu.org>
parents:
diff changeset
2818 there are ways to improve speed or memory usage.@refill
Dave Love <fx@gnu.org>
parents:
diff changeset
2819
Dave Love <fx@gnu.org>
parents:
diff changeset
2820 @itemize @bullet
Dave Love <fx@gnu.org>
parents:
diff changeset
2821 @item
Dave Love <fx@gnu.org>
parents:
diff changeset
2822 @b{Removing Lookup Buffers}@*
Dave Love <fx@gnu.org>
parents:
diff changeset
2823 @cindex Removing lookup buffers
Dave Love <fx@gnu.org>
parents:
diff changeset
2824 @b{Ref@TeX{}} will load other parts of a multifile document as well as BibTeX
Dave Love <fx@gnu.org>
parents:
diff changeset
2825 database files for lookup purposes. These buffers are kept, so that
Dave Love <fx@gnu.org>
parents:
diff changeset
2826 subsequent use of the same files is fast. If you can't afford keeping
Dave Love <fx@gnu.org>
parents:
diff changeset
2827 these buffers around, and if you can live with a speed penalty, try
Dave Love <fx@gnu.org>
parents:
diff changeset
2828
Dave Love <fx@gnu.org>
parents:
diff changeset
2829 @vindex reftex-keep-temporary-buffers
Dave Love <fx@gnu.org>
parents:
diff changeset
2830 @lisp
Dave Love <fx@gnu.org>
parents:
diff changeset
2831 (setq reftex-keep-temporary-buffers nil)
Dave Love <fx@gnu.org>
parents:
diff changeset
2832 @end lisp
Dave Love <fx@gnu.org>
parents:
diff changeset
2833
Dave Love <fx@gnu.org>
parents:
diff changeset
2834 @item
Dave Love <fx@gnu.org>
parents:
diff changeset
2835 @b{Partial Document Scans}@*
Dave Love <fx@gnu.org>
parents:
diff changeset
2836 @cindex Partial documents scans
Dave Love <fx@gnu.org>
parents:
diff changeset
2837 @cindex Document scanning, partial
Dave Love <fx@gnu.org>
parents:
diff changeset
2838 A @kbd{C-u} prefix on the major @b{Ref@TeX{}} commands @code{reftex-label}
Dave Love <fx@gnu.org>
parents:
diff changeset
2839 (@kbd{C-u C-c (}), @code{reftex-reference} (@kbd{C-u C-c )}),
Dave Love <fx@gnu.org>
parents:
diff changeset
2840 @code{reftex-citation} (@kbd{C-u C-c [}), @code{reftex-toc} (@kbd{C-u C-c
Dave Love <fx@gnu.org>
parents:
diff changeset
2841 =}), and @code{reftex-view-crossref} (@kbd{C-u C-c &}) initiates
Dave Love <fx@gnu.org>
parents:
diff changeset
2842 re-parsing of the entire document in order to update the parsing
Dave Love <fx@gnu.org>
parents:
diff changeset
2843 information. For a large document this can be unnecessary, in
Dave Love <fx@gnu.org>
parents:
diff changeset
2844 particular if only one file has changed. @b{Ref@TeX{}} can be configured
Dave Love <fx@gnu.org>
parents:
diff changeset
2845 to do partial scans instead of full ones. @kbd{C-u} re-parsing then
Dave Love <fx@gnu.org>
parents:
diff changeset
2846 does apply only to the current buffer and files included from it.
Dave Love <fx@gnu.org>
parents:
diff changeset
2847 Likewise, the @kbd{r} key in both the label selection buffer and the
Dave Love <fx@gnu.org>
parents:
diff changeset
2848 table-of-contents buffer will only prompt scanning of the file in which
Dave Love <fx@gnu.org>
parents:
diff changeset
2849 the label or section macro near the cursor was defined. Re-parsing of
Dave Love <fx@gnu.org>
parents:
diff changeset
2850 the entire document is still available by using @kbd{C-u C-u} as a
Dave Love <fx@gnu.org>
parents:
diff changeset
2851 prefix, or the capital @kbd{R} key in the menus. To use this feature,
Dave Love <fx@gnu.org>
parents:
diff changeset
2852 try@refill
Dave Love <fx@gnu.org>
parents:
diff changeset
2853
Dave Love <fx@gnu.org>
parents:
diff changeset
2854 @vindex reftex-enable-partial-scans
Dave Love <fx@gnu.org>
parents:
diff changeset
2855 @lisp
Dave Love <fx@gnu.org>
parents:
diff changeset
2856 (setq reftex-enable-partial-scans t)
Dave Love <fx@gnu.org>
parents:
diff changeset
2857 @end lisp
Dave Love <fx@gnu.org>
parents:
diff changeset
2858
Dave Love <fx@gnu.org>
parents:
diff changeset
2859 @item
Dave Love <fx@gnu.org>
parents:
diff changeset
2860 @b{Saving Parser Information}@*
Dave Love <fx@gnu.org>
parents:
diff changeset
2861 @cindex Saving parser information
Dave Love <fx@gnu.org>
parents:
diff changeset
2862 @cindex Parse information, saving to a file
27195
d7311a9cb223 version 4.10
Carsten Dominik <dominik@science.uva.nl>
parents: 26911
diff changeset
2863 @vindex reftex-parse-file-extension
25829
Dave Love <fx@gnu.org>
parents:
diff changeset
2864 Even with partial scans enabled, @b{Ref@TeX{}} still has to make one full
Dave Love <fx@gnu.org>
parents:
diff changeset
2865 scan, when you start working with a document. To avoid this, parsing
Dave Love <fx@gnu.org>
parents:
diff changeset
2866 information can be stored in a file. The file @file{MASTER.rel} is used
Dave Love <fx@gnu.org>
parents:
diff changeset
2867 for storing information about a document with master file
Dave Love <fx@gnu.org>
parents:
diff changeset
2868 @file{MASTER.tex}. It is written automatically when you kill a buffer
Dave Love <fx@gnu.org>
parents:
diff changeset
2869 in @code{reftex-mode} or when you exit Emacs. The information is
Dave Love <fx@gnu.org>
parents:
diff changeset
2870 restored when you begin working with a document in a new editing
Dave Love <fx@gnu.org>
parents:
diff changeset
2871 session. To use this feature, put into @file{.emacs}:@refill
Dave Love <fx@gnu.org>
parents:
diff changeset
2872
Dave Love <fx@gnu.org>
parents:
diff changeset
2873 @vindex reftex-save-parse-info
Dave Love <fx@gnu.org>
parents:
diff changeset
2874 @lisp
Dave Love <fx@gnu.org>
parents:
diff changeset
2875 (setq reftex-save-parse-info t)
Dave Love <fx@gnu.org>
parents:
diff changeset
2876 @end lisp
Dave Love <fx@gnu.org>
parents:
diff changeset
2877
Dave Love <fx@gnu.org>
parents:
diff changeset
2878 @item
Dave Love <fx@gnu.org>
parents:
diff changeset
2879 @b{Automatic Document Scans}@*
Dave Love <fx@gnu.org>
parents:
diff changeset
2880 @cindex Automatic document scans
Dave Love <fx@gnu.org>
parents:
diff changeset
2881 @cindex Document scanning, automatic
Dave Love <fx@gnu.org>
parents:
diff changeset
2882 At rare occasions, @b{Ref@TeX{}} will automatically rescan a part of the
Dave Love <fx@gnu.org>
parents:
diff changeset
2883 document. If this gets into your way, it can be turned off with
Dave Love <fx@gnu.org>
parents:
diff changeset
2884
Dave Love <fx@gnu.org>
parents:
diff changeset
2885 @vindex reftex-allow-automatic-rescan
Dave Love <fx@gnu.org>
parents:
diff changeset
2886 @lisp
Dave Love <fx@gnu.org>
parents:
diff changeset
2887 (setq reftex-allow-automatic-rescan nil)
Dave Love <fx@gnu.org>
parents:
diff changeset
2888 @end lisp
Dave Love <fx@gnu.org>
parents:
diff changeset
2889
Dave Love <fx@gnu.org>
parents:
diff changeset
2890 @b{Ref@TeX{}} will then occasionally annotate new labels in the selection
Dave Love <fx@gnu.org>
parents:
diff changeset
2891 buffer, saying that their position in the label list in uncertain. A
Dave Love <fx@gnu.org>
parents:
diff changeset
2892 manual document scan will fix this.@refill
Dave Love <fx@gnu.org>
parents:
diff changeset
2893
Dave Love <fx@gnu.org>
parents:
diff changeset
2894 @item
Dave Love <fx@gnu.org>
parents:
diff changeset
2895 @b{Multiple Selection Buffers}@*
Dave Love <fx@gnu.org>
parents:
diff changeset
2896 @cindex Multiple selection buffers
Dave Love <fx@gnu.org>
parents:
diff changeset
2897 @cindex Selection buffers, multiple
Dave Love <fx@gnu.org>
parents:
diff changeset
2898 Normally, the selection buffer @file{*RefTeX Select*} is re-created for
Dave Love <fx@gnu.org>
parents:
diff changeset
2899 every selection process. In documents with very many labels this can
Dave Love <fx@gnu.org>
parents:
diff changeset
2900 take several seconds. @b{Ref@TeX{}} provides an option to create a
Dave Love <fx@gnu.org>
parents:
diff changeset
2901 separate selection buffer for each label type and to keep this buffer
Dave Love <fx@gnu.org>
parents:
diff changeset
2902 from one selection to the next. These buffers are updated automatically
Dave Love <fx@gnu.org>
parents:
diff changeset
2903 only when a new label has been added in the buffers category with
Dave Love <fx@gnu.org>
parents:
diff changeset
2904 @code{reftex-label}. Updating the buffer takes as long as recreating it
Dave Love <fx@gnu.org>
parents:
diff changeset
2905 - so the time saving is limited to cases where no new labels of that
Dave Love <fx@gnu.org>
parents:
diff changeset
2906 category have been added. To turn on this feature, use@refill
Dave Love <fx@gnu.org>
parents:
diff changeset
2907
Dave Love <fx@gnu.org>
parents:
diff changeset
2908 @vindex reftex-use-multiple-selection-buffers
Dave Love <fx@gnu.org>
parents:
diff changeset
2909 @lisp
Dave Love <fx@gnu.org>
parents:
diff changeset
2910 (setq reftex-use-multiple-selection-buffers t)
Dave Love <fx@gnu.org>
parents:
diff changeset
2911 @end lisp
Dave Love <fx@gnu.org>
parents:
diff changeset
2912
Dave Love <fx@gnu.org>
parents:
diff changeset
2913 @noindent
Dave Love <fx@gnu.org>
parents:
diff changeset
2914 @cindex Selection buffers, updating
Dave Love <fx@gnu.org>
parents:
diff changeset
2915 You can also inhibit the automatic updating entirely. Then the
Dave Love <fx@gnu.org>
parents:
diff changeset
2916 selection buffer will always pop up very fast, but may not contain the
Dave Love <fx@gnu.org>
parents:
diff changeset
2917 most recently defined labels. You can always update the buffer by hand,
Dave Love <fx@gnu.org>
parents:
diff changeset
2918 with the @kbd{g} key. To get this behavior, use instead@refill
Dave Love <fx@gnu.org>
parents:
diff changeset
2919
Dave Love <fx@gnu.org>
parents:
diff changeset
2920 @vindex reftex-auto-update-selection-buffers
Dave Love <fx@gnu.org>
parents:
diff changeset
2921 @lisp
Dave Love <fx@gnu.org>
parents:
diff changeset
2922 (setq reftex-use-multiple-selection-buffers t
Dave Love <fx@gnu.org>
parents:
diff changeset
2923 reftex-auto-update-selection-buffers nil)
Dave Love <fx@gnu.org>
parents:
diff changeset
2924 @end lisp
Dave Love <fx@gnu.org>
parents:
diff changeset
2925 @end itemize
Dave Love <fx@gnu.org>
parents:
diff changeset
2926
Dave Love <fx@gnu.org>
parents:
diff changeset
2927 @need 2000
Dave Love <fx@gnu.org>
parents:
diff changeset
2928 @noindent
Dave Love <fx@gnu.org>
parents:
diff changeset
2929 @b{As a summary}, here are the settings I recommend for heavy use of
Dave Love <fx@gnu.org>
parents:
diff changeset
2930 @b{Ref@TeX{}} with large documents:
Dave Love <fx@gnu.org>
parents:
diff changeset
2931
Dave Love <fx@gnu.org>
parents:
diff changeset
2932 @lisp
Dave Love <fx@gnu.org>
parents:
diff changeset
2933 @group
Dave Love <fx@gnu.org>
parents:
diff changeset
2934 (setq reftex-enable-partial-scans t
Dave Love <fx@gnu.org>
parents:
diff changeset
2935 reftex-save-parse-info t
Dave Love <fx@gnu.org>
parents:
diff changeset
2936 reftex-use-multiple-selection-buffers t)
Dave Love <fx@gnu.org>
parents:
diff changeset
2937 @end group
Dave Love <fx@gnu.org>
parents:
diff changeset
2938 @end lisp
Dave Love <fx@gnu.org>
parents:
diff changeset
2939
Dave Love <fx@gnu.org>
parents:
diff changeset
2940 @page
Dave Love <fx@gnu.org>
parents:
diff changeset
2941 @node AUCTeX, Multifile Documents, Faces, Top
Dave Love <fx@gnu.org>
parents:
diff changeset
2942 @section @w{AUC @TeX{}}
Dave Love <fx@gnu.org>
parents:
diff changeset
2943 @cindex @code{AUCTeX}, Emacs package
Dave Love <fx@gnu.org>
parents:
diff changeset
2944 @cindex Emacs packages, @code{AUCTeX}
Dave Love <fx@gnu.org>
parents:
diff changeset
2945
Dave Love <fx@gnu.org>
parents:
diff changeset
2946 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
2947 files with Emacs (@pxref{Top,AUCTeX,,auctex, The AUCTeX User Manual}).
265fdb06f294 Update to reftex 4 14
Carsten Dominik <dominik@science.uva.nl>
parents: 29713
diff changeset
2948 If AUCTeX is not part of you Emacs distribution, you can get
265fdb06f294 Update to reftex 4 14
Carsten Dominik <dominik@science.uva.nl>
parents: 29713
diff changeset
2949 it@footnote{XEmacs 21.x users may want to install the corresponding
265fdb06f294 Update to reftex 4 14
Carsten Dominik <dominik@science.uva.nl>
parents: 29713
diff changeset
2950 XEmacs package.} by ftp from the
25829
Dave Love <fx@gnu.org>
parents:
diff changeset
2951 @uref{http://www.sunsite.auc.dk/auctex/,AUCTeX distribution site}.
Dave Love <fx@gnu.org>
parents:
diff changeset
2952
Dave Love <fx@gnu.org>
parents:
diff changeset
2953 @menu
Dave Love <fx@gnu.org>
parents:
diff changeset
2954 * AUCTeX-RefTeX Interface:: How both packages work together
Dave Love <fx@gnu.org>
parents:
diff changeset
2955 * Style Files:: AUCTeX's style files can support RefTeX
Dave Love <fx@gnu.org>
parents:
diff changeset
2956 * Bib-Cite:: Hypertext reading of a document
Dave Love <fx@gnu.org>
parents:
diff changeset
2957 @end menu
Dave Love <fx@gnu.org>
parents:
diff changeset
2958
Dave Love <fx@gnu.org>
parents:
diff changeset
2959 @node AUCTeX-RefTeX Interface, Style Files, , AUCTeX
Dave Love <fx@gnu.org>
parents:
diff changeset
2960 @subsection The AUC@TeX{}-@b{Ref@TeX{}} Interface
Dave Love <fx@gnu.org>
parents:
diff changeset
2961
Dave Love <fx@gnu.org>
parents:
diff changeset
2962 @b{Ref@TeX{}} contains code to interface with AUCTeX. When this
Dave Love <fx@gnu.org>
parents:
diff changeset
2963 interface is turned on, both packages will interact closely. Instead of
Dave Love <fx@gnu.org>
parents:
diff changeset
2964 using @b{Ref@TeX{}}'s commands directly, you can then also use them
Dave Love <fx@gnu.org>
parents:
diff changeset
2965 indirectly as part of the AUCTeX
Dave Love <fx@gnu.org>
parents:
diff changeset
2966 environment@footnote{@b{Ref@TeX{}} 4.0 and AUCTeX 9.10c will be
Dave Love <fx@gnu.org>
parents:
diff changeset
2967 needed for all of this to work. Parts of it work also with earlier
Dave Love <fx@gnu.org>
parents:
diff changeset
2968 versions.}. The interface is turned on with@refill
Dave Love <fx@gnu.org>
parents:
diff changeset
2969
Dave Love <fx@gnu.org>
parents:
diff changeset
2970 @lisp
Dave Love <fx@gnu.org>
parents:
diff changeset
2971 (setq reftex-plug-into-AUCTeX t)
Dave Love <fx@gnu.org>
parents:
diff changeset
2972 @end lisp
Dave Love <fx@gnu.org>
parents:
diff changeset
2973
Dave Love <fx@gnu.org>
parents:
diff changeset
2974 If you need finer control about which parts of the interface are used
Dave Love <fx@gnu.org>
parents:
diff changeset
2975 and which not, read the docstring of the variable
Dave Love <fx@gnu.org>
parents:
diff changeset
2976 @code{reftex-plug-into-AUCTeX} or customize it with @kbd{M-x
Dave Love <fx@gnu.org>
parents:
diff changeset
2977 customize-variable @key{RET} reftex-plug-into-AUCTeX @key{RET}}.
Dave Love <fx@gnu.org>
parents:
diff changeset
2978
Dave Love <fx@gnu.org>
parents:
diff changeset
2979 The following list describes the individual parts of the interface.
Dave Love <fx@gnu.org>
parents:
diff changeset
2980
Dave Love <fx@gnu.org>
parents:
diff changeset
2981 @itemize @bullet
Dave Love <fx@gnu.org>
parents:
diff changeset
2982 @item
Dave Love <fx@gnu.org>
parents:
diff changeset
2983 @findex reftex-label
Dave Love <fx@gnu.org>
parents:
diff changeset
2984 @vindex LaTeX-label-function, @r{AUCTeX}
Dave Love <fx@gnu.org>
parents:
diff changeset
2985 @kindex C-c C-e
Dave Love <fx@gnu.org>
parents:
diff changeset
2986 @kindex C-c C-s
Dave Love <fx@gnu.org>
parents:
diff changeset
2987 @findex LaTeX-section, @r{AUCTeX}
Dave Love <fx@gnu.org>
parents:
diff changeset
2988 @findex TeX-insert-macro, @r{AUCTeX}
Dave Love <fx@gnu.org>
parents:
diff changeset
2989 @b{AUCTeX calls @code{reftex-label} to insert labels}@*
Dave Love <fx@gnu.org>
parents:
diff changeset
2990 When a new section is created with @kbd{C-c C-s}, or a new environment
Dave Love <fx@gnu.org>
parents:
diff changeset
2991 is inserted with @kbd{C-c C-e}, AUCTeX normally prompts for a label to
Dave Love <fx@gnu.org>
parents:
diff changeset
2992 go with it. With the interface, @code{reftex-label} is called instead.
Dave Love <fx@gnu.org>
parents:
diff changeset
2993 For example, if you type @kbd{C-c C-e equation @key{RET}}, AUCTeX and
Dave Love <fx@gnu.org>
parents:
diff changeset
2994 @b{Ref@TeX{}} will insert
Dave Love <fx@gnu.org>
parents:
diff changeset
2995
Dave Love <fx@gnu.org>
parents:
diff changeset
2996 @example
Dave Love <fx@gnu.org>
parents:
diff changeset
2997 \begin@{equation@}
Dave Love <fx@gnu.org>
parents:
diff changeset
2998 \label@{eq:1@}
Dave Love <fx@gnu.org>
parents:
diff changeset
2999
Dave Love <fx@gnu.org>
parents:
diff changeset
3000 \end@{equation@}
Dave Love <fx@gnu.org>
parents:
diff changeset
3001 @end example
Dave Love <fx@gnu.org>
parents:
diff changeset
3002
Dave Love <fx@gnu.org>
parents:
diff changeset
3003 @noindent
Dave Love <fx@gnu.org>
parents:
diff changeset
3004 without further prompts.
Dave Love <fx@gnu.org>
parents:
diff changeset
3005
Dave Love <fx@gnu.org>
parents:
diff changeset
3006 Similarly, when you type @kbd{C-c C-s section @key{RET}}, @b{Ref@TeX{}}
Dave Love <fx@gnu.org>
parents:
diff changeset
3007 will offer its default label which is derived from the section title.
Dave Love <fx@gnu.org>
parents:
diff changeset
3008
Dave Love <fx@gnu.org>
parents:
diff changeset
3009 @item
Dave Love <fx@gnu.org>
parents:
diff changeset
3010 @b{AUCTeX tells @b{Ref@TeX{}} about new sections}@*
Dave Love <fx@gnu.org>
parents:
diff changeset
3011 When creating a new section with @kbd{C-c C-s}, @b{Ref@TeX{}} will not
Dave Love <fx@gnu.org>
parents:
diff changeset
3012 have to rescan the buffer in order to see it.@refill
Dave Love <fx@gnu.org>
parents:
diff changeset
3013
Dave Love <fx@gnu.org>
parents:
diff changeset
3014 @item
Dave Love <fx@gnu.org>
parents:
diff changeset
3015 @findex reftex-arg-label
Dave Love <fx@gnu.org>
parents:
diff changeset
3016 @findex TeX-arg-label, @r{AUCTeX function}
Dave Love <fx@gnu.org>
parents:
diff changeset
3017 @findex reftex-arg-ref
Dave Love <fx@gnu.org>
parents:
diff changeset
3018 @findex TeX-arg-ref, @r{AUCTeX function}
Dave Love <fx@gnu.org>
parents:
diff changeset
3019 @findex reftex-arg-cite
Dave Love <fx@gnu.org>
parents:
diff changeset
3020 @findex TeX-arg-cite, @r{AUCTeX function}
Dave Love <fx@gnu.org>
parents:
diff changeset
3021 @findex reftex-arg-index
Dave Love <fx@gnu.org>
parents:
diff changeset
3022 @findex TeX-arg-index, @r{AUCTeX function}
Dave Love <fx@gnu.org>
parents:
diff changeset
3023 @findex TeX-insert-macro, @r{AUCTeX function}
Dave Love <fx@gnu.org>
parents:
diff changeset
3024 @kindex C-c @key{RET}
Dave Love <fx@gnu.org>
parents:
diff changeset
3025 @b{@b{Ref@TeX{}} supplies macro arguments}@* When you insert a macro
Dave Love <fx@gnu.org>
parents:
diff changeset
3026 interactively with @kbd{C-c @key{RET}}, AUCTeX normally prompts for
Dave Love <fx@gnu.org>
parents:
diff changeset
3027 macro arguments. Internally, it uses the functions
Dave Love <fx@gnu.org>
parents:
diff changeset
3028 @code{TeX-arg-label}, @code{TeX-arg-cite}, and @code{TeX-arg-index} to
Dave Love <fx@gnu.org>
parents:
diff changeset
3029 prompt for arguments which are labels, citation keys and index entries.
Dave Love <fx@gnu.org>
parents:
diff changeset
3030 The interface takes over these functions@footnote{@code{fset} is used to
Dave Love <fx@gnu.org>
parents:
diff changeset
3031 do this, which is not reversible. However, @b{Ref@TeX{}} implements the
Dave Love <fx@gnu.org>
parents:
diff changeset
3032 old functionality when you later decide to turn off the interface.} and
Dave Love <fx@gnu.org>
parents:
diff changeset
3033 supplies the macro arguments with @b{Ref@TeX{}'s} mechanisms. For
Dave Love <fx@gnu.org>
parents:
diff changeset
3034 example, when you type @kbd{C-c @key{RET} ref @key{RET}}, @b{Ref@TeX{}}
Dave Love <fx@gnu.org>
parents:
diff changeset
3035 will supply its label selection process (@pxref{Referencing
Dave Love <fx@gnu.org>
parents:
diff changeset
3036 Labels}).@refill
Dave Love <fx@gnu.org>
parents:
diff changeset
3037
Dave Love <fx@gnu.org>
parents:
diff changeset
3038 @item
Dave Love <fx@gnu.org>
parents:
diff changeset
3039 @b{@b{Ref@TeX{}} tells AUCTeX about new labels, citation-- and index keys}@*
Dave Love <fx@gnu.org>
parents:
diff changeset
3040 @b{Ref@TeX{}} will add all newly created labels to AUCTeX's completion list.
Dave Love <fx@gnu.org>
parents:
diff changeset
3041 @end itemize
Dave Love <fx@gnu.org>
parents:
diff changeset
3042
Dave Love <fx@gnu.org>
parents:
diff changeset
3043 @node Style Files, Bib-Cite, AUCTeX-RefTeX Interface, AUCTeX
Dave Love <fx@gnu.org>
parents:
diff changeset
3044 @subsection Style Files
Dave Love <fx@gnu.org>
parents:
diff changeset
3045 @cindex Style files, AUCTeX
Dave Love <fx@gnu.org>
parents:
diff changeset
3046 @findex TeX-add-style-hook, @r{AUCTeX}
Dave Love <fx@gnu.org>
parents:
diff changeset
3047 Style files are Emacs Lisp files which are evaluated by AUCTeX in
Dave Love <fx@gnu.org>
parents:
diff changeset
3048 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
3049 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
3050 @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
3051 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
3052 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
3053 distributed with AUCTeX already support @b{Ref@TeX{}} in this
265fdb06f294 Update to reftex 4 14
Carsten Dominik <dominik@science.uva.nl>
parents: 29713
diff changeset
3054 way.@refill
25829
Dave Love <fx@gnu.org>
parents:
diff changeset
3055
Dave Love <fx@gnu.org>
parents:
diff changeset
3056 Before calling a @b{Ref@TeX{}} function, the style hook should always
Dave Love <fx@gnu.org>
parents:
diff changeset
3057 test for the availability of the function, so that the style file will
Dave Love <fx@gnu.org>
parents:
diff changeset
3058 also work for people who do not use @b{Ref@TeX{}}. @refill
Dave Love <fx@gnu.org>
parents:
diff changeset
3059
Dave Love <fx@gnu.org>
parents:
diff changeset
3060 Additions made with style files in the way described below remain local
Dave Love <fx@gnu.org>
parents:
diff changeset
3061 to the current document. For example, if one package uses AMSTeX, the
Dave Love <fx@gnu.org>
parents:
diff changeset
3062 style file will make @b{Ref@TeX{}} switch over to @code{\eqref}, but
Dave Love <fx@gnu.org>
parents:
diff changeset
3063 this will not affect other documents.@refill
Dave Love <fx@gnu.org>
parents:
diff changeset
3064
Dave Love <fx@gnu.org>
parents:
diff changeset
3065 @findex reftex-add-label-environments
Dave Love <fx@gnu.org>
parents:
diff changeset
3066 @findex reftex-add-to-label-alist
Dave Love <fx@gnu.org>
parents:
diff changeset
3067 A style hook may contain calls to
Dave Love <fx@gnu.org>
parents:
diff changeset
3068 @code{reftex-add-label-environments}@footnote{This used to be the
Dave Love <fx@gnu.org>
parents:
diff changeset
3069 function @code{reftex-add-to-label-alist} which is still available as an
Dave Love <fx@gnu.org>
parents:
diff changeset
3070 alias for compatibility.} which defines additions to
Dave Love <fx@gnu.org>
parents:
diff changeset
3071 @code{reftex-label-alist}. The argument taken by this function must have
Dave Love <fx@gnu.org>
parents:
diff changeset
3072 the same format as @code{reftex-label-alist}. The @file{amsmath.el}
Dave Love <fx@gnu.org>
parents:
diff changeset
3073 style file of AUCTeX for example contains the following:@refill
Dave Love <fx@gnu.org>
parents:
diff changeset
3074
Dave Love <fx@gnu.org>
parents:
diff changeset
3075 @lisp
Dave Love <fx@gnu.org>
parents:
diff changeset
3076 @group
Dave Love <fx@gnu.org>
parents:
diff changeset
3077 (TeX-add-style-hook "amsmath"
Dave Love <fx@gnu.org>
parents:
diff changeset
3078 (lambda ()
Dave Love <fx@gnu.org>
parents:
diff changeset
3079 (if (fboundp 'reftex-add-label-environments)
Dave Love <fx@gnu.org>
parents:
diff changeset
3080 (reftex-add-label-environments '(AMSTeX)))))
Dave Love <fx@gnu.org>
parents:
diff changeset
3081 @end group
Dave Love <fx@gnu.org>
parents:
diff changeset
3082 @end lisp
Dave Love <fx@gnu.org>
parents:
diff changeset
3083
Dave Love <fx@gnu.org>
parents:
diff changeset
3084 @noindent
Dave Love <fx@gnu.org>
parents:
diff changeset
3085 @findex LaTeX-add-environments, @r{AUCTeX}
Dave Love <fx@gnu.org>
parents:
diff changeset
3086 while a package @code{myprop} defining a @code{proposition} environment
Dave Love <fx@gnu.org>
parents:
diff changeset
3087 with @code{\newtheorem} might use@refill
Dave Love <fx@gnu.org>
parents:
diff changeset
3088
Dave Love <fx@gnu.org>
parents:
diff changeset
3089 @lisp
Dave Love <fx@gnu.org>
parents:
diff changeset
3090 @group
Dave Love <fx@gnu.org>
parents:
diff changeset
3091 (TeX-add-style-hook "myprop"
Dave Love <fx@gnu.org>
parents:
diff changeset
3092 (lambda ()
Dave Love <fx@gnu.org>
parents:
diff changeset
3093 (LaTeX-add-environments '("proposition" LaTeX-env-label))
Dave Love <fx@gnu.org>
parents:
diff changeset
3094 (if (fboundp 'reftex-add-label-environments)
Dave Love <fx@gnu.org>
parents:
diff changeset
3095 (reftex-add-label-environments
Dave Love <fx@gnu.org>
parents:
diff changeset
3096 '(("proposition" ?p "prop:" "~\\ref@{%s@}" t
26911
d7f536a01276 Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents: 25829
diff changeset
3097 ("Proposition" "Prop.") -3))))))
25829
Dave Love <fx@gnu.org>
parents:
diff changeset
3098 @end group
Dave Love <fx@gnu.org>
parents:
diff changeset
3099 @end lisp
Dave Love <fx@gnu.org>
parents:
diff changeset
3100
Dave Love <fx@gnu.org>
parents:
diff changeset
3101 @findex reftex-set-cite-format
Dave Love <fx@gnu.org>
parents:
diff changeset
3102 Similarly, a style hook may contain a call to
Dave Love <fx@gnu.org>
parents:
diff changeset
3103 @code{reftex-set-cite-format} to set the citation format. The style
Dave Love <fx@gnu.org>
parents:
diff changeset
3104 file @file{natbib.el} for the Natbib citation style does switch
Dave Love <fx@gnu.org>
parents:
diff changeset
3105 @b{Ref@TeX{}}'s citation format like this:@refill
Dave Love <fx@gnu.org>
parents:
diff changeset
3106
Dave Love <fx@gnu.org>
parents:
diff changeset
3107 @lisp
Dave Love <fx@gnu.org>
parents:
diff changeset
3108 (TeX-add-style-hook "natbib"
Dave Love <fx@gnu.org>
parents:
diff changeset
3109 (lambda ()
Dave Love <fx@gnu.org>
parents:
diff changeset
3110 (if (fboundp 'reftex-set-cite-format)
Dave Love <fx@gnu.org>
parents:
diff changeset
3111 (reftex-set-cite-format 'natbib))))
Dave Love <fx@gnu.org>
parents:
diff changeset
3112 @end lisp
Dave Love <fx@gnu.org>
parents:
diff changeset
3113
Dave Love <fx@gnu.org>
parents:
diff changeset
3114 @findex reftex-add-index-macros
Dave Love <fx@gnu.org>
parents:
diff changeset
3115 The hook may contain a call to @code{reftex-add-index-macros} to
Dave Love <fx@gnu.org>
parents:
diff changeset
3116 define additional @code{\index}-like macros. The argument must have
Dave Love <fx@gnu.org>
parents:
diff changeset
3117 the same format as @code{reftex-index-macros}. It may be a symbol, to
Dave Love <fx@gnu.org>
parents:
diff changeset
3118 trigger support for one of the builtin index packages. For example,
Dave Love <fx@gnu.org>
parents:
diff changeset
3119 the style @file{multind.el} contains
Dave Love <fx@gnu.org>
parents:
diff changeset
3120
Dave Love <fx@gnu.org>
parents:
diff changeset
3121 @lisp
Dave Love <fx@gnu.org>
parents:
diff changeset
3122 (TeX-add-style-hook "multind"
Dave Love <fx@gnu.org>
parents:
diff changeset
3123 (lambda ()
Dave Love <fx@gnu.org>
parents:
diff changeset
3124 (and (fboundp 'reftex-add-index-macros)
Dave Love <fx@gnu.org>
parents:
diff changeset
3125 (reftex-add-index-macros '(multind)))))
Dave Love <fx@gnu.org>
parents:
diff changeset
3126 @end lisp
Dave Love <fx@gnu.org>
parents:
diff changeset
3127
Dave Love <fx@gnu.org>
parents:
diff changeset
3128 If you have your own package @file{myindex} which defines the
Dave Love <fx@gnu.org>
parents:
diff changeset
3129 following macros to be used with the LaTeX @file{index.sty} file
Dave Love <fx@gnu.org>
parents:
diff changeset
3130 @example
Dave Love <fx@gnu.org>
parents:
diff changeset
3131 \newcommand@{\molec@}[1]@{#1\index@{Molecules!#1@}@}
Dave Love <fx@gnu.org>
parents:
diff changeset
3132 \newcommand@{\aindex@}[1]@{#1\index[author]@{#1@}
Dave Love <fx@gnu.org>
parents:
diff changeset
3133 @end example
Dave Love <fx@gnu.org>
parents:
diff changeset
3134
Dave Love <fx@gnu.org>
parents:
diff changeset
3135 you could write this in the style file @file{myindex.el}:
Dave Love <fx@gnu.org>
parents:
diff changeset
3136
Dave Love <fx@gnu.org>
parents:
diff changeset
3137 @lisp
Dave Love <fx@gnu.org>
parents:
diff changeset
3138 (TeX-add-style-hook "myindex"
Dave Love <fx@gnu.org>
parents:
diff changeset
3139 (lambda ()
Dave Love <fx@gnu.org>
parents:
diff changeset
3140 (TeX-add-symbols
Dave Love <fx@gnu.org>
parents:
diff changeset
3141 '("molec" TeX-arg-index)
Dave Love <fx@gnu.org>
parents:
diff changeset
3142 '("aindex" TeX-arg-index))
Dave Love <fx@gnu.org>
parents:
diff changeset
3143 (if (fboundp 'reftex-add-index-macros)
Dave Love <fx@gnu.org>
parents:
diff changeset
3144 (reftex-add-index-macros
26911
d7f536a01276 Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents: 25829
diff changeset
3145 '(("molec@{*@}" "idx" ?m "Molecules!" nil nil)
d7f536a01276 Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents: 25829
diff changeset
3146 ("aindex@{*@}" "author" ?a "" nil nil))))))
25829
Dave Love <fx@gnu.org>
parents:
diff changeset
3147 @end lisp
Dave Love <fx@gnu.org>
parents:
diff changeset
3148
Dave Love <fx@gnu.org>
parents:
diff changeset
3149 @findex reftex-add-section-levels
Dave Love <fx@gnu.org>
parents:
diff changeset
3150 Finally the hook may contain a call to @code{reftex-add-section-levels}
Dave Love <fx@gnu.org>
parents:
diff changeset
3151 to define additional section statements. For example, the FoilTeX class
Dave Love <fx@gnu.org>
parents:
diff changeset
3152 has just two headers, @code{\foilhead} and @code{\rotatefoilhead}. Here
Dave Love <fx@gnu.org>
parents:
diff changeset
3153 is a style file @file{foils.el} that will inform @b{Ref@TeX{}} about these:
Dave Love <fx@gnu.org>
parents:
diff changeset
3154
Dave Love <fx@gnu.org>
parents:
diff changeset
3155 @lisp
Dave Love <fx@gnu.org>
parents:
diff changeset
3156 (TeX-add-style-hook "foils"
Dave Love <fx@gnu.org>
parents:
diff changeset
3157 (lambda ()
Dave Love <fx@gnu.org>
parents:
diff changeset
3158 (if (fboundp 'reftex-add-section-levels)
Dave Love <fx@gnu.org>
parents:
diff changeset
3159 (reftex-add-section-levels '(("foilhead" . 3)
Dave Love <fx@gnu.org>
parents:
diff changeset
3160 ("rotatefoilhead" . 3))))))
Dave Love <fx@gnu.org>
parents:
diff changeset
3161 @end lisp
Dave Love <fx@gnu.org>
parents:
diff changeset
3162
Dave Love <fx@gnu.org>
parents:
diff changeset
3163 @node Bib-Cite, , Style Files, AUCTeX
Dave Love <fx@gnu.org>
parents:
diff changeset
3164 @subsection Bib-Cite
Dave Love <fx@gnu.org>
parents:
diff changeset
3165 @cindex @code{bib-cite}, Emacs package
Dave Love <fx@gnu.org>
parents:
diff changeset
3166 @cindex Emacs packages, @code{bib-cite}
Dave Love <fx@gnu.org>
parents:
diff changeset
3167
Dave Love <fx@gnu.org>
parents:
diff changeset
3168 Once you have written a document with labels, references and citations,
Dave Love <fx@gnu.org>
parents:
diff changeset
3169 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
3170 support for that: @code{reftex-view-crossref} (bound to @kbd{C-c
25829
Dave Love <fx@gnu.org>
parents:
diff changeset
3171 &}), @code{reftex-mouse-view-crossref} (bound to @kbd{S-mouse-2}), and
Dave Love <fx@gnu.org>
parents:
diff changeset
3172 @code{reftex-search-document}. A somewhat fancier interface with mouse
Dave Love <fx@gnu.org>
parents:
diff changeset
3173 highlighting is provided (among other things) by Peter S. Galbraith's
Dave Love <fx@gnu.org>
parents:
diff changeset
3174 @file{bib-cite.el}. There is some overlap in the functionalities of
Dave Love <fx@gnu.org>
parents:
diff changeset
3175 Bib-cite and @b{Ref@TeX{}}. Bib-cite.el comes bundled with
Dave Love <fx@gnu.org>
parents:
diff changeset
3176 AUCTeX.@refill
Dave Love <fx@gnu.org>
parents:
diff changeset
3177
Dave Love <fx@gnu.org>
parents:
diff changeset
3178 Bib-cite version 3.06 and later can be configured so that bib-cite's
Dave Love <fx@gnu.org>
parents:
diff changeset
3179 mouse functions use @b{Ref@TeX{}} for displaying references and citations.
Dave Love <fx@gnu.org>
parents:
diff changeset
3180 This can be useful in particular when working with the LaTeX @code{xr}
Dave Love <fx@gnu.org>
parents:
diff changeset
3181 package or with an explicit @code{thebibliography} environment (rather
Dave Love <fx@gnu.org>
parents:
diff changeset
3182 than BibTeX). Bib-cite cannot handle those, but @b{Ref@TeX{}} does. To
Dave Love <fx@gnu.org>
parents:
diff changeset
3183 make use of this feature, try@refill
Dave Love <fx@gnu.org>
parents:
diff changeset
3184
Dave Love <fx@gnu.org>
parents:
diff changeset
3185 @vindex bib-cite-use-reftex-view-crossref
Dave Love <fx@gnu.org>
parents:
diff changeset
3186 @lisp
Dave Love <fx@gnu.org>
parents:
diff changeset
3187 (setq bib-cite-use-reftex-view-crossref t)
Dave Love <fx@gnu.org>
parents:
diff changeset
3188 @end lisp
Dave Love <fx@gnu.org>
parents:
diff changeset
3189
Dave Love <fx@gnu.org>
parents:
diff changeset
3190 @page
Dave Love <fx@gnu.org>
parents:
diff changeset
3191 @node Problems and Work-Arounds, Imprint, Optimizations, Top
Dave Love <fx@gnu.org>
parents:
diff changeset
3192 @section Problems and Work-arounds
Dave Love <fx@gnu.org>
parents:
diff changeset
3193 @cindex Problems and work-arounds
Dave Love <fx@gnu.org>
parents:
diff changeset
3194
Dave Love <fx@gnu.org>
parents:
diff changeset
3195 @itemize @bullet
Dave Love <fx@gnu.org>
parents:
diff changeset
3196 @item
Dave Love <fx@gnu.org>
parents:
diff changeset
3197 @b{LaTeX commands}@*
Dave Love <fx@gnu.org>
parents:
diff changeset
3198 @cindex LaTeX commands, not found
Dave Love <fx@gnu.org>
parents:
diff changeset
3199 @code{\input}, @code{\include}, @code{\bibliography} and @code{\section}
Dave Love <fx@gnu.org>
parents:
diff changeset
3200 (etc.) statements have to be first on a line (except for white space).@refill
Dave Love <fx@gnu.org>
parents:
diff changeset
3201
Dave Love <fx@gnu.org>
parents:
diff changeset
3202 @item
Dave Love <fx@gnu.org>
parents:
diff changeset
3203 @b{Commented regions}@*
Dave Love <fx@gnu.org>
parents:
diff changeset
3204 @cindex Labels, commented out
Dave Love <fx@gnu.org>
parents:
diff changeset
3205 @b{Ref@TeX{}} sees also labels in regions commented out and will refuse to
Dave Love <fx@gnu.org>
parents:
diff changeset
3206 make duplicates of such labels. This is considered to be a feature.@refill
Dave Love <fx@gnu.org>
parents:
diff changeset
3207
Dave Love <fx@gnu.org>
parents:
diff changeset
3208 @item
Dave Love <fx@gnu.org>
parents:
diff changeset
3209 @b{Wrong section numbers}@*
Dave Love <fx@gnu.org>
parents:
diff changeset
3210 @cindex Section numbers, wrong
Dave Love <fx@gnu.org>
parents:
diff changeset
3211 @vindex reftex-enable-partial-scans
Dave Love <fx@gnu.org>
parents:
diff changeset
3212 When using partial scans (@code{reftex-enable-partial-scans}), the section
Dave Love <fx@gnu.org>
parents:
diff changeset
3213 numbers in the table of contents may eventually become wrong. A full
Dave Love <fx@gnu.org>
parents:
diff changeset
3214 scan will fix this.@refill
Dave Love <fx@gnu.org>
parents:
diff changeset
3215
Dave Love <fx@gnu.org>
parents:
diff changeset
3216 @item
Dave Love <fx@gnu.org>
parents:
diff changeset
3217 @b{Local settings}@*
Dave Love <fx@gnu.org>
parents:
diff changeset
3218 @cindex Settings, local
Dave Love <fx@gnu.org>
parents:
diff changeset
3219 @findex reftex-add-label-environments
Dave Love <fx@gnu.org>
parents:
diff changeset
3220 @findex reftex-set-cite-format
Dave Love <fx@gnu.org>
parents:
diff changeset
3221 @findex reftex-add-section-levels
Dave Love <fx@gnu.org>
parents:
diff changeset
3222 The label environment definitions in @code{reftex-label-alist} are
Dave Love <fx@gnu.org>
parents:
diff changeset
3223 global and apply to all documents. If you need to make definitions
Dave Love <fx@gnu.org>
parents:
diff changeset
3224 local to a document, because they would interfere with settings in other
Dave Love <fx@gnu.org>
parents:
diff changeset
3225 documents, you should use AUCTeX and set up style files with calls to
Dave Love <fx@gnu.org>
parents:
diff changeset
3226 @code{reftex-add-label-environments}, @code{reftex-set-cite-format},
Dave Love <fx@gnu.org>
parents:
diff changeset
3227 @code{reftex-add-index-macros}, and @code{reftex-add-section-levels}.
Dave Love <fx@gnu.org>
parents:
diff changeset
3228 Settings made with these functions remain local to the current
Dave Love <fx@gnu.org>
parents:
diff changeset
3229 document. @xref{AUCTeX}.@refill
Dave Love <fx@gnu.org>
parents:
diff changeset
3230
Dave Love <fx@gnu.org>
parents:
diff changeset
3231 @item
Dave Love <fx@gnu.org>
parents:
diff changeset
3232 @b{Funny display in selection buffer}@*
Dave Love <fx@gnu.org>
parents:
diff changeset
3233 @cindex @code{x-symbol}, Emacs package
Dave Love <fx@gnu.org>
parents:
diff changeset
3234 @cindex Emacs packages, @code{x-symbol}
Dave Love <fx@gnu.org>
parents:
diff changeset
3235 @cindex @code{isotex}, Emacs package
Dave Love <fx@gnu.org>
parents:
diff changeset
3236 @cindex Emacs packages, @code{isotex}
Dave Love <fx@gnu.org>
parents:
diff changeset
3237 @cindex @code{iso-cvt}, Emacs package
Dave Love <fx@gnu.org>
parents:
diff changeset
3238 @cindex Emacs packages, @code{iso-cvt}
Dave Love <fx@gnu.org>
parents:
diff changeset
3239 When using packages which make the buffer representation of a file
Dave Love <fx@gnu.org>
parents:
diff changeset
3240 different from its disk representation (e.g. x-symbol, isotex,
Dave Love <fx@gnu.org>
parents:
diff changeset
3241 iso-cvt) you may find that @b{Ref@TeX{}}'s parsing information sometimes
Dave Love <fx@gnu.org>
parents:
diff changeset
3242 reflects the disk state of a file. This happens only in @emph{unvisited}
Dave Love <fx@gnu.org>
parents:
diff changeset
3243 parts of a multifile document, because @b{Ref@TeX{}} visits these files
Dave Love <fx@gnu.org>
parents:
diff changeset
3244 literally for speed reasons. Then both short context and section
Dave Love <fx@gnu.org>
parents:
diff changeset
3245 headings may look different from what you usually see on your screen.
Dave Love <fx@gnu.org>
parents:
diff changeset
3246 In rare cases @code{reftex-toc} may have problems to jump to an affected
Dave Love <fx@gnu.org>
parents:
diff changeset
3247 section heading. There are three possible ways to deal with
Dave Love <fx@gnu.org>
parents:
diff changeset
3248 this:@refill
Dave Love <fx@gnu.org>
parents:
diff changeset
3249 @itemize @minus
Dave Love <fx@gnu.org>
parents:
diff changeset
3250 @item
Dave Love <fx@gnu.org>
parents:
diff changeset
3251 @vindex reftex-keep-temporary-buffers
Dave Love <fx@gnu.org>
parents:
diff changeset
3252 @code{(setq reftex-keep-temporary-buffers t)}@*
Dave Love <fx@gnu.org>
parents:
diff changeset
3253 This implies that @b{Ref@TeX{}} will load all parts of a multifile
Dave Love <fx@gnu.org>
parents:
diff changeset
3254 document into Emacs (i.e. there won't be any temporary buffers).@refill
Dave Love <fx@gnu.org>
parents:
diff changeset
3255 @item
Dave Love <fx@gnu.org>
parents:
diff changeset
3256 @vindex reftex-initialize-temporary-buffers
Dave Love <fx@gnu.org>
parents:
diff changeset
3257 @code{(setq reftex-initialize-temporary-buffers t)}@*
Dave Love <fx@gnu.org>
parents:
diff changeset
3258 This means full initialization of temporary buffers. It involves
Dave Love <fx@gnu.org>
parents:
diff changeset
3259 a penalty when the same unvisited file is used for lookup often.@refill
Dave Love <fx@gnu.org>
parents:
diff changeset
3260 @item
Dave Love <fx@gnu.org>
parents:
diff changeset
3261 Set @code{reftex-initialize-temporary-buffers} to a list of hook
Dave Love <fx@gnu.org>
parents:
diff changeset
3262 functions doing a minimal initialization.@refill
Dave Love <fx@gnu.org>
parents:
diff changeset
3263 @end itemize
Dave Love <fx@gnu.org>
parents:
diff changeset
3264 @vindex reftex-refontify-context
Dave Love <fx@gnu.org>
parents:
diff changeset
3265 See also the variable @code{reftex-refontify-context}.
Dave Love <fx@gnu.org>
parents:
diff changeset
3266
Dave Love <fx@gnu.org>
parents:
diff changeset
3267 @item
Dave Love <fx@gnu.org>
parents:
diff changeset
3268 @b{Labels as arguments to \begin}@*
Dave Love <fx@gnu.org>
parents:
diff changeset
3269 @cindex @code{pf}, LaTeX package
Dave Love <fx@gnu.org>
parents:
diff changeset
3270 @cindex LaTeX packages, @code{pf}
Dave Love <fx@gnu.org>
parents:
diff changeset
3271 Some packages use an additional argument to a @code{\begin} macro
Dave Love <fx@gnu.org>
parents:
diff changeset
3272 to specify a label. E.g. Lamport's @file{pf.sty} uses both
Dave Love <fx@gnu.org>
parents:
diff changeset
3273 @example
Dave Love <fx@gnu.org>
parents:
diff changeset
3274 \step@{@var{label}@}@{@var{claim}@} and \begin@{step+@}@{@var{label}@}
Dave Love <fx@gnu.org>
parents:
diff changeset
3275 @var{claim}
Dave Love <fx@gnu.org>
parents:
diff changeset
3276 \end@{step+@}
Dave Love <fx@gnu.org>
parents:
diff changeset
3277 @end example
Dave Love <fx@gnu.org>
parents:
diff changeset
3278
Dave Love <fx@gnu.org>
parents:
diff changeset
3279 @noindent
Dave Love <fx@gnu.org>
parents:
diff changeset
3280 We need to trick @b{Ref@TeX{}} into swallowing this:
Dave Love <fx@gnu.org>
parents:
diff changeset
3281
Dave Love <fx@gnu.org>
parents:
diff changeset
3282 @lisp
Dave Love <fx@gnu.org>
parents:
diff changeset
3283 @group
Dave Love <fx@gnu.org>
parents:
diff changeset
3284 ;; Configuration for Lamport's pf.sty
Dave Love <fx@gnu.org>
parents:
diff changeset
3285 (setq reftex-label-alist
26911
d7f536a01276 Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents: 25829
diff changeset
3286 '(("\\step@{*@}@{@}" ?p "st:" "~\\stepref@{%s@}" 2 ("Step" "St."))
d7f536a01276 Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents: 25829
diff changeset
3287 ("\\begin@{step+@}@{*@}" ?p "st:" "~\\stepref@{%s@}" 1000)))
25829
Dave Love <fx@gnu.org>
parents:
diff changeset
3288 @end group
Dave Love <fx@gnu.org>
parents:
diff changeset
3289 @end lisp
Dave Love <fx@gnu.org>
parents:
diff changeset
3290
Dave Love <fx@gnu.org>
parents:
diff changeset
3291 @noindent
Dave Love <fx@gnu.org>
parents:
diff changeset
3292 The first line is just a normal configuration for a macro. For the
Dave Love <fx@gnu.org>
parents:
diff changeset
3293 @code{step+} environment we actually tell @b{Ref@TeX{}} to look for the
Dave Love <fx@gnu.org>
parents:
diff changeset
3294 @emph{macro} @samp{\begin@{step+@}} and interpret the @emph{first}
Dave Love <fx@gnu.org>
parents:
diff changeset
3295 argument (which really is a second argument to the macro @code{\begin})
Dave Love <fx@gnu.org>
parents:
diff changeset
3296 as a label of type @code{?p}. Argument count for this macro starts only
Dave Love <fx@gnu.org>
parents:
diff changeset
3297 after the @samp{@{step+@}}, also when specifying how to get
Dave Love <fx@gnu.org>
parents:
diff changeset
3298 context.@refill
Dave Love <fx@gnu.org>
parents:
diff changeset
3299
Dave Love <fx@gnu.org>
parents:
diff changeset
3300 @item
Dave Love <fx@gnu.org>
parents:
diff changeset
3301 @b{Idle timers in XEmacs}@*
Dave Love <fx@gnu.org>
parents:
diff changeset
3302 @cindex Idle timer restart
Dave Love <fx@gnu.org>
parents:
diff changeset
3303 @vindex reftex-use-itimer-in-xemacs
Dave Love <fx@gnu.org>
parents:
diff changeset
3304 In XEmacs, idle timer restart does not work reliably after fast
Dave Love <fx@gnu.org>
parents:
diff changeset
3305 keystrokes. Therefore @b{Ref@TeX{}} currently uses the post command
Dave Love <fx@gnu.org>
parents:
diff changeset
3306 hook to start the timer used for automatic crossref information. When
Dave Love <fx@gnu.org>
parents:
diff changeset
3307 this bug gets fixed, a real idle timer can be requested with
Dave Love <fx@gnu.org>
parents:
diff changeset
3308 @lisp
Dave Love <fx@gnu.org>
parents:
diff changeset
3309 (setq reftex-use-itimer-in-xemacs t)
Dave Love <fx@gnu.org>
parents:
diff changeset
3310 @end lisp
Dave Love <fx@gnu.org>
parents:
diff changeset
3311
Dave Love <fx@gnu.org>
parents:
diff changeset
3312 @item
Dave Love <fx@gnu.org>
parents:
diff changeset
3313 @b{Viper mode}@*
Dave Love <fx@gnu.org>
parents:
diff changeset
3314 @cindex Viper mode
Dave Love <fx@gnu.org>
parents:
diff changeset
3315 @cindex Keybindings, problems with Viper mode
Dave Love <fx@gnu.org>
parents:
diff changeset
3316 @findex viper-harness-minor-mode
Dave Love <fx@gnu.org>
parents:
diff changeset
3317 With @i{Viper} mode prior to Vipers version 3.01, you need to protect
Dave Love <fx@gnu.org>
parents:
diff changeset
3318 @b{Ref@TeX{}}'s keymaps with@refill
Dave Love <fx@gnu.org>
parents:
diff changeset
3319
Dave Love <fx@gnu.org>
parents:
diff changeset
3320 @lisp
Dave Love <fx@gnu.org>
parents:
diff changeset
3321 (viper-harness-minor-mode "reftex")
Dave Love <fx@gnu.org>
parents:
diff changeset
3322 @end lisp
Dave Love <fx@gnu.org>
parents:
diff changeset
3323
Dave Love <fx@gnu.org>
parents:
diff changeset
3324 @end itemize
Dave Love <fx@gnu.org>
parents:
diff changeset
3325
Dave Love <fx@gnu.org>
parents:
diff changeset
3326 @page
Dave Love <fx@gnu.org>
parents:
diff changeset
3327 @node Imprint, Commands, Problems and Work-Arounds, Top
Dave Love <fx@gnu.org>
parents:
diff changeset
3328 @section Imprint
Dave Love <fx@gnu.org>
parents:
diff changeset
3329 @cindex Imprint
Dave Love <fx@gnu.org>
parents:
diff changeset
3330 @cindex Maintainer
Dave Love <fx@gnu.org>
parents:
diff changeset
3331 @cindex Acknowledgments
Dave Love <fx@gnu.org>
parents:
diff changeset
3332 @cindex Thanks
Dave Love <fx@gnu.org>
parents:
diff changeset
3333 @cindex Bug reports
Dave Love <fx@gnu.org>
parents:
diff changeset
3334 @cindex @code{http}, @b{Ref@TeX{}} home page
Dave Love <fx@gnu.org>
parents:
diff changeset
3335 @cindex @code{ftp}, @b{Ref@TeX{}} site
Dave Love <fx@gnu.org>
parents:
diff changeset
3336
Dave Love <fx@gnu.org>
parents:
diff changeset
3337 @b{Ref@TeX{}} was written by @i{@value{AUTHOR}}
Dave Love <fx@gnu.org>
parents:
diff changeset
3338 @email{@value{AUTHOR-EMAIL}}, with contributions by @i{Stephen
Dave Love <fx@gnu.org>
parents:
diff changeset
3339 Eglen}. @b{Ref@TeX{}} is currently maintained by @refill
Dave Love <fx@gnu.org>
parents:
diff changeset
3340
Dave Love <fx@gnu.org>
parents:
diff changeset
3341 @noindent
Dave Love <fx@gnu.org>
parents:
diff changeset
3342 @value{MAINTAINER} @email{@value{MAINTAINER-EMAIL}}
Dave Love <fx@gnu.org>
parents:
diff changeset
3343
Dave Love <fx@gnu.org>
parents:
diff changeset
3344 If you have questions about @b{Ref@TeX{}}, there are several Usenet
Dave Love <fx@gnu.org>
parents:
diff changeset
3345 groups which have competent readers: @code{comp.emacs},
Dave Love <fx@gnu.org>
parents:
diff changeset
3346 @code{gnu.emacs.help}, @code{comp.emacs.xemacs}, @code{comp.text.tex}.
Dave Love <fx@gnu.org>
parents:
diff changeset
3347 You can also write directly to the maintainer.
Dave Love <fx@gnu.org>
parents:
diff changeset
3348
Dave Love <fx@gnu.org>
parents:
diff changeset
3349 If you find a bug in @b{Ref@TeX{}} or its documentation, or if you want
Dave Love <fx@gnu.org>
parents:
diff changeset
3350 to contribute code or ideas, please
Dave Love <fx@gnu.org>
parents:
diff changeset
3351 @uref{mailto:@value{MAINTAINER-EMAIL},contact the maintainer}. Remember
Dave Love <fx@gnu.org>
parents:
diff changeset
3352 to provide all necessary information such as version numbers of Emacs
Dave Love <fx@gnu.org>
parents:
diff changeset
3353 and @b{Ref@TeX{}}, and the relevant part of your configuration in
Dave Love <fx@gnu.org>
parents:
diff changeset
3354 @file{.emacs}. When reporting a bug which throws an exception, please
Dave Love <fx@gnu.org>
parents:
diff changeset
3355 include a backtrace if you know how to produce one.
Dave Love <fx@gnu.org>
parents:
diff changeset
3356
Dave Love <fx@gnu.org>
parents:
diff changeset
3357 @b{Ref@TeX{}} is bundled and pre-installed with Emacs since version 20.2.
Dave Love <fx@gnu.org>
parents:
diff changeset
3358 It was also bundled and pre-installed with XEmacs 19.16--20.x. XEmacs
Dave Love <fx@gnu.org>
parents:
diff changeset
3359 21.x users want to install the corresponding plugin package which is
Dave Love <fx@gnu.org>
parents:
diff changeset
3360 available from the XEmacs @code{ftp} site. See the XEmacs 21.x
Dave Love <fx@gnu.org>
parents:
diff changeset
3361 documentation on package installation for details.@refill
Dave Love <fx@gnu.org>
parents:
diff changeset
3362
Dave Love <fx@gnu.org>
parents:
diff changeset
3363 Users of earlier Emacs distributions (including Emacs 19) can get a
Dave Love <fx@gnu.org>
parents:
diff changeset
3364 @b{Ref@TeX{}} distribution from the
Dave Love <fx@gnu.org>
parents:
diff changeset
3365 @uref{http://www.strw.leidenuniv.nl/~dominik/Tools/,maintainers
Dave Love <fx@gnu.org>
parents:
diff changeset
3366 webpage}. Note that the Emacs 19 version supports many but not all
Dave Love <fx@gnu.org>
parents:
diff changeset
3367 features described in this manual.@refill
Dave Love <fx@gnu.org>
parents:
diff changeset
3368
Dave Love <fx@gnu.org>
parents:
diff changeset
3369 Thanks to the people on the Net who have used @b{Ref@TeX{}} and helped
26911
d7f536a01276 Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents: 25829
diff changeset
3370 developing it with their reports. In particular thanks to @i{Fran
d7f536a01276 Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents: 25829
diff changeset
3371 Burstall, Alastair Burt, Soren Dayton, Stephen Eglen, Karl Eichwalder,
d7f536a01276 Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents: 25829
diff changeset
3372 Peter Galbraith, Kai Grossjohann, Frank Harrell, Dieter Kraft, Adrian
d7f536a01276 Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents: 25829
diff changeset
3373 Lanz, Rory Molinari, Stefan Monnier, Laurent Mugnier, Sudeep Kumar
d7f536a01276 Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents: 25829
diff changeset
3374 Palat, Daniel Polani, Robin Socha, Richard Stanton, Allan Strand, Jan
d7f536a01276 Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents: 25829
diff changeset
3375 Vroonhof, Christoph Wedler, Alan Williams}.@refill
25829
Dave Love <fx@gnu.org>
parents:
diff changeset
3376
Dave Love <fx@gnu.org>
parents:
diff changeset
3377 The @code{view-crossref} feature was inspired by @i{Peter Galbraith's}
Dave Love <fx@gnu.org>
parents:
diff changeset
3378 @file{bib-cite.el}.@refill
Dave Love <fx@gnu.org>
parents:
diff changeset
3379
Dave Love <fx@gnu.org>
parents:
diff changeset
3380 Finally thanks to @i{Uwe Bolick} who first got me (some years ago) into
Dave Love <fx@gnu.org>
parents:
diff changeset
3381 supporting LaTeX labels and references with an editor (which was
Dave Love <fx@gnu.org>
parents:
diff changeset
3382 MicroEmacs at the time).@refill
Dave Love <fx@gnu.org>
parents:
diff changeset
3383
Dave Love <fx@gnu.org>
parents:
diff changeset
3384 @node Commands, Options, Imprint, Top
Dave Love <fx@gnu.org>
parents:
diff changeset
3385 @chapter Commands
Dave Love <fx@gnu.org>
parents:
diff changeset
3386 @cindex Commands, list of
Dave Love <fx@gnu.org>
parents:
diff changeset
3387
26911
d7f536a01276 Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents: 25829
diff changeset
3388 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
3389 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
3390 not described here. All commands are available from the @code{Ref}
d7f536a01276 Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents: 25829
diff changeset
3391 menu. For keybindings, @pxref{Keybindings}.
25829
Dave Love <fx@gnu.org>
parents:
diff changeset
3392
Dave Love <fx@gnu.org>
parents:
diff changeset
3393 @deffn Command reftex-toc
Dave Love <fx@gnu.org>
parents:
diff changeset
3394 Show the table of contents for the current document. When called with
Dave Love <fx@gnu.org>
parents:
diff changeset
3395 one ore two @kbd{C-u} prefixes, rescan the document first.@refill
Dave Love <fx@gnu.org>
parents:
diff changeset
3396 @end deffn
Dave Love <fx@gnu.org>
parents:
diff changeset
3397
Dave Love <fx@gnu.org>
parents:
diff changeset
3398 @deffn Command reftex-label
Dave Love <fx@gnu.org>
parents:
diff changeset
3399 Insert a unique label. With one or two @kbd{C-u} prefixes, enforce
Dave Love <fx@gnu.org>
parents:
diff changeset
3400 document rescan first.
Dave Love <fx@gnu.org>
parents:
diff changeset
3401 @end deffn
Dave Love <fx@gnu.org>
parents:
diff changeset
3402
Dave Love <fx@gnu.org>
parents:
diff changeset
3403 @deffn Command reftex-reference
Dave Love <fx@gnu.org>
parents:
diff changeset
3404 Start a selection process to select a label, and insert a reference to
Dave Love <fx@gnu.org>
parents:
diff changeset
3405 it. With one or two @kbd{C-u} prefixes, enforce document rescan first.
Dave Love <fx@gnu.org>
parents:
diff changeset
3406 @end deffn
Dave Love <fx@gnu.org>
parents:
diff changeset
3407
Dave Love <fx@gnu.org>
parents:
diff changeset
3408 @deffn Command reftex-citation
Dave Love <fx@gnu.org>
parents:
diff changeset
3409 Make a citation using BibTeX database files. After prompting for a regular
Dave Love <fx@gnu.org>
parents:
diff changeset
3410 expression, scans the buffers with BibTeX entries (taken from the
Dave Love <fx@gnu.org>
parents:
diff changeset
3411 @code{\bibliography} command or a @code{thebibliography} environment)
Dave Love <fx@gnu.org>
parents:
diff changeset
3412 and offers the matching entries for selection. The selected entry is
Dave Love <fx@gnu.org>
parents:
diff changeset
3413 formated according to @code{reftex-cite-format} and inserted into the
Dave Love <fx@gnu.org>
parents:
diff changeset
3414 buffer.@refill @*
Dave Love <fx@gnu.org>
parents:
diff changeset
3415 When called with one or two @kbd{C-u} prefixes, first rescans the
Dave Love <fx@gnu.org>
parents:
diff changeset
3416 document. When called with a numeric prefix, make that many citations.
Dave Love <fx@gnu.org>
parents:
diff changeset
3417 When called with point inside the braces of a @code{\cite} command, it
Dave Love <fx@gnu.org>
parents:
diff changeset
3418 will add another key, ignoring the value of
Dave Love <fx@gnu.org>
parents:
diff changeset
3419 @code{reftex-cite-format}.@refill @*
Dave Love <fx@gnu.org>
parents:
diff changeset
3420 The regular expression uses an expanded syntax: @samp{&&} is interpreted
Dave Love <fx@gnu.org>
parents:
diff changeset
3421 as @code{and}. Thus, @samp{aaaa&&bbb} matches entries which contain
Dave Love <fx@gnu.org>
parents:
diff changeset
3422 both @samp{aaaa} and @samp{bbb}. While entering the regexp, completion
Dave Love <fx@gnu.org>
parents:
diff changeset
3423 on knows citation keys is possible. @samp{=} is a good regular
Dave Love <fx@gnu.org>
parents:
diff changeset
3424 expression to match all entries in all files.@refill
Dave Love <fx@gnu.org>
parents:
diff changeset
3425 @end deffn
Dave Love <fx@gnu.org>
parents:
diff changeset
3426
Dave Love <fx@gnu.org>
parents:
diff changeset
3427 @deffn Command reftex-index
Dave Love <fx@gnu.org>
parents:
diff changeset
3428 Query for an index macro and insert it along with its arguments. The
Dave Love <fx@gnu.org>
parents:
diff changeset
3429 index macros available are those defined in @code{reftex-index-macro} or
Dave Love <fx@gnu.org>
parents:
diff changeset
3430 by a call to @code{reftex-add-index-macros}, typically from an AUCTeX
Dave Love <fx@gnu.org>
parents:
diff changeset
3431 style file. @b{Ref@TeX{}} provides completion for the index tag and the
Dave Love <fx@gnu.org>
parents:
diff changeset
3432 index key, and will prompt for other arguments.@refill
Dave Love <fx@gnu.org>
parents:
diff changeset
3433 @end deffn
Dave Love <fx@gnu.org>
parents:
diff changeset
3434
Dave Love <fx@gnu.org>
parents:
diff changeset
3435 @deffn Command reftex-index-selection-or-word
Dave Love <fx@gnu.org>
parents:
diff changeset
3436 Put current selection or the word near point into the default index
Dave Love <fx@gnu.org>
parents:
diff changeset
3437 macro. This uses the information in @code{reftex-index-default-macro}
Dave Love <fx@gnu.org>
parents:
diff changeset
3438 to make an index entry. The phrase indexed is the current selection or
Dave Love <fx@gnu.org>
parents:
diff changeset
3439 the word near point. When called with one @kbd{C-u} prefix, let the
Dave Love <fx@gnu.org>
parents:
diff changeset
3440 user have a chance to edit the index entry. When called with 2
Dave Love <fx@gnu.org>
parents:
diff changeset
3441 @kbd{C-u} as prefix, also ask for the index macro and other stuff. When
Dave Love <fx@gnu.org>
parents:
diff changeset
3442 called inside TeX math mode as determined by the @file{texmathp.el}
Dave Love <fx@gnu.org>
parents:
diff changeset
3443 library which is part of AUCTeX, the string is first processed with the
Dave Love <fx@gnu.org>
parents:
diff changeset
3444 @code{reftex-index-math-format}, which see.@refill
Dave Love <fx@gnu.org>
parents:
diff changeset
3445 @end deffn
Dave Love <fx@gnu.org>
parents:
diff changeset
3446
26911
d7f536a01276 Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents: 25829
diff changeset
3447 @deffn Command reftex-index-phrase-selection-or-word
d7f536a01276 Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents: 25829
diff changeset
3448 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
3449 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
3450 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
3451 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
3452 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
3453 @end deffn
d7f536a01276 Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents: 25829
diff changeset
3454
d7f536a01276 Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents: 25829
diff changeset
3455 @deffn Command reftex-index-visit-phrases-buffer
d7f536a01276 Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents: 25829
diff changeset
3456 Switch to the phrases buffer, initialize if empty.
d7f536a01276 Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents: 25829
diff changeset
3457 @end deffn
d7f536a01276 Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents: 25829
diff changeset
3458
d7f536a01276 Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents: 25829
diff changeset
3459 @deffn Command reftex-index-phrases-apply-to-region
d7f536a01276 Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents: 25829
diff changeset
3460 Index all index phrases in the current region.
d7f536a01276 Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents: 25829
diff changeset
3461 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
3462 but operation is restricted to the current region.
d7f536a01276 Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents: 25829
diff changeset
3463 @end deffn
d7f536a01276 Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents: 25829
diff changeset
3464
25829
Dave Love <fx@gnu.org>
parents:
diff changeset
3465 @deffn Command reftex-display-index
Dave Love <fx@gnu.org>
parents:
diff changeset
3466 Display a buffer with an index compiled from the current document.
Dave Love <fx@gnu.org>
parents:
diff changeset
3467 When the document has multiple indices, first prompts for the correct one.
Dave Love <fx@gnu.org>
parents:
diff changeset
3468 When index support is turned off, offer to turn it on.
Dave Love <fx@gnu.org>
parents:
diff changeset
3469 With one or two @kbd{C-u} prefixes, rescan document first.
Dave Love <fx@gnu.org>
parents:
diff changeset
3470 With prefix 2, restrict index to current document section.
Dave Love <fx@gnu.org>
parents:
diff changeset
3471 With prefix 3, restrict index to active region.@refill
Dave Love <fx@gnu.org>
parents:
diff changeset
3472 @end deffn
Dave Love <fx@gnu.org>
parents:
diff changeset
3473
Dave Love <fx@gnu.org>
parents:
diff changeset
3474 @deffn Command reftex-view-crossref
Dave Love <fx@gnu.org>
parents:
diff changeset
3475 View cross reference of macro at point. Point must be on the @var{key}
Dave Love <fx@gnu.org>
parents:
diff changeset
3476 argument. Works with the macros @code{\label}, @code{\ref},
Dave Love <fx@gnu.org>
parents:
diff changeset
3477 @code{\cite}, @code{\bibitem}, @code{\index} and many derivatives of
Dave Love <fx@gnu.org>
parents:
diff changeset
3478 these. Where it makes sense, subsequent calls show additional
Dave Love <fx@gnu.org>
parents:
diff changeset
3479 locations. See also the variable @code{reftex-view-crossref-extra} and
Dave Love <fx@gnu.org>
parents:
diff changeset
3480 the command @code{reftex-view-crossref-from-bibtex}. With one or two
Dave Love <fx@gnu.org>
parents:
diff changeset
3481 @kbd{C-u} prefixes, enforce rescanning of the document. With argument
Dave Love <fx@gnu.org>
parents:
diff changeset
3482 2, select the window showing the cross reference.
Dave Love <fx@gnu.org>
parents:
diff changeset
3483 @end deffn
Dave Love <fx@gnu.org>
parents:
diff changeset
3484
Dave Love <fx@gnu.org>
parents:
diff changeset
3485 @deffn Command reftex-view-crossref-from-bibtex
Dave Love <fx@gnu.org>
parents:
diff changeset
3486 View location in a LaTeX document which cites the BibTeX entry at point.
Dave Love <fx@gnu.org>
parents:
diff changeset
3487 Since BibTeX files can be used by many LaTeX documents, this function
Dave Love <fx@gnu.org>
parents:
diff changeset
3488 prompts upon first use for a buffer in @b{Ref@TeX{}} mode. To reset this
Dave Love <fx@gnu.org>
parents:
diff changeset
3489 link to a document, call the function with with a prefix arg. Calling
Dave Love <fx@gnu.org>
parents:
diff changeset
3490 this function several times find successive citation locations.
Dave Love <fx@gnu.org>
parents:
diff changeset
3491 @end deffn
Dave Love <fx@gnu.org>
parents:
diff changeset
3492
Dave Love <fx@gnu.org>
parents:
diff changeset
3493 @deffn Command reftex-create-tags-file
Dave Love <fx@gnu.org>
parents:
diff changeset
3494 Create TAGS file by running @code{etags} on the current document. The
Dave Love <fx@gnu.org>
parents:
diff changeset
3495 TAGS file is also immediately visited with
Dave Love <fx@gnu.org>
parents:
diff changeset
3496 @code{visit-tags-table}.@refill
Dave Love <fx@gnu.org>
parents:
diff changeset
3497 @end deffn
Dave Love <fx@gnu.org>
parents:
diff changeset
3498
Dave Love <fx@gnu.org>
parents:
diff changeset
3499 @deffn Command reftex-grep-document
Dave Love <fx@gnu.org>
parents:
diff changeset
3500 Run grep query through all files related to this document.
Dave Love <fx@gnu.org>
parents:
diff changeset
3501 With prefix arg, force to rescan document.
Dave Love <fx@gnu.org>
parents:
diff changeset
3502 No active TAGS table is required.@refill
Dave Love <fx@gnu.org>
parents:
diff changeset
3503 @end deffn
Dave Love <fx@gnu.org>
parents:
diff changeset
3504
Dave Love <fx@gnu.org>
parents:
diff changeset
3505 @deffn Command reftex-search-document
Dave Love <fx@gnu.org>
parents:
diff changeset
3506 Regexp search through all files of the current document.
Dave Love <fx@gnu.org>
parents:
diff changeset
3507 Starts always in the master file. Stops when a match is found.
Dave Love <fx@gnu.org>
parents:
diff changeset
3508 No active TAGS table is required.@refill
Dave Love <fx@gnu.org>
parents:
diff changeset
3509 @end deffn
Dave Love <fx@gnu.org>
parents:
diff changeset
3510
Dave Love <fx@gnu.org>
parents:
diff changeset
3511 @deffn Command reftex-query-replace-document
Dave Love <fx@gnu.org>
parents:
diff changeset
3512 Run a query-replace-regexp of @var{from} with @var{to} over the entire
Dave Love <fx@gnu.org>
parents:
diff changeset
3513 document. With prefix arg, replace only word-delimited matches. No
Dave Love <fx@gnu.org>
parents:
diff changeset
3514 active TAGS table is required.@refill
Dave Love <fx@gnu.org>
parents:
diff changeset
3515 @end deffn
Dave Love <fx@gnu.org>
parents:
diff changeset
3516
Dave Love <fx@gnu.org>
parents:
diff changeset
3517 @deffn Command reftex-change-label
Dave Love <fx@gnu.org>
parents:
diff changeset
3518 Query replace @var{from} with @var{to} in all @code{\label} and
Dave Love <fx@gnu.org>
parents:
diff changeset
3519 @code{\ref} commands. Works on the entire multifile document. No
Dave Love <fx@gnu.org>
parents:
diff changeset
3520 active TAGS table is required.@refill
Dave Love <fx@gnu.org>
parents:
diff changeset
3521 @end deffn
Dave Love <fx@gnu.org>
parents:
diff changeset
3522
Dave Love <fx@gnu.org>
parents:
diff changeset
3523 @deffn Command reftex-renumber-simple-labels
Dave Love <fx@gnu.org>
parents:
diff changeset
3524 Renumber all simple labels in the document to make them sequentially.
Dave Love <fx@gnu.org>
parents:
diff changeset
3525 Simple labels are the ones created by RefTeX, consisting only of the
Dave Love <fx@gnu.org>
parents:
diff changeset
3526 prefix and a number. After the command completes, all these labels will
Dave Love <fx@gnu.org>
parents:
diff changeset
3527 have sequential numbers throughout the document. Any references to the
Dave Love <fx@gnu.org>
parents:
diff changeset
3528 labels will be changed as well. For this, @b{Ref@TeX{}} looks at the
Dave Love <fx@gnu.org>
parents:
diff changeset
3529 arguments of any macros which either start or end with the string
Dave Love <fx@gnu.org>
parents:
diff changeset
3530 @samp{ref}. This command should be used with care, in particular in
Dave Love <fx@gnu.org>
parents:
diff changeset
3531 multifile documents. You should not use it if another document refers
Dave Love <fx@gnu.org>
parents:
diff changeset
3532 to this one with the @code{xr} package.@refill
Dave Love <fx@gnu.org>
parents:
diff changeset
3533 @end deffn
Dave Love <fx@gnu.org>
parents:
diff changeset
3534
Dave Love <fx@gnu.org>
parents:
diff changeset
3535 @deffn Command reftex-find-duplicate-labels
Dave Love <fx@gnu.org>
parents:
diff changeset
3536 Produce a list of all duplicate labels in the document.@refill
Dave Love <fx@gnu.org>
parents:
diff changeset
3537 @end deffn
Dave Love <fx@gnu.org>
parents:
diff changeset
3538
Dave Love <fx@gnu.org>
parents:
diff changeset
3539 @deffn Command reftex-customize
Dave Love <fx@gnu.org>
parents:
diff changeset
3540 Run the customize browser on the @b{Ref@TeX{}} group.
Dave Love <fx@gnu.org>
parents:
diff changeset
3541 @end deffn
Dave Love <fx@gnu.org>
parents:
diff changeset
3542 @deffn Command reftex-show-commentary
Dave Love <fx@gnu.org>
parents:
diff changeset
3543 Show the commentary section from @file{reftex.el}.
Dave Love <fx@gnu.org>
parents:
diff changeset
3544 @end deffn
Dave Love <fx@gnu.org>
parents:
diff changeset
3545 @deffn Command reftex-info
Dave Love <fx@gnu.org>
parents:
diff changeset
3546 Run info on the top @b{Ref@TeX{}} node.
Dave Love <fx@gnu.org>
parents:
diff changeset
3547 @end deffn
Dave Love <fx@gnu.org>
parents:
diff changeset
3548 @deffn Command reftex-parse-document
Dave Love <fx@gnu.org>
parents:
diff changeset
3549 Parse the entire document in order to update the parsing information.
Dave Love <fx@gnu.org>
parents:
diff changeset
3550 @end deffn
Dave Love <fx@gnu.org>
parents:
diff changeset
3551 @deffn Command reftex-reset-mode
Dave Love <fx@gnu.org>
parents:
diff changeset
3552 Enforce rebuilding of several internal lists and variables. Also
Dave Love <fx@gnu.org>
parents:
diff changeset
3553 removes the parse file associated with the current document.
Dave Love <fx@gnu.org>
parents:
diff changeset
3554 @end deffn
Dave Love <fx@gnu.org>
parents:
diff changeset
3555
Dave Love <fx@gnu.org>
parents:
diff changeset
3556 @node Options, Keymaps and Hooks, Commands, Top
Dave Love <fx@gnu.org>
parents:
diff changeset
3557 @chapter Options, Keymaps, Hooks
Dave Love <fx@gnu.org>
parents:
diff changeset
3558 @cindex Options, list of
Dave Love <fx@gnu.org>
parents:
diff changeset
3559
Dave Love <fx@gnu.org>
parents:
diff changeset
3560 Here is a complete list of @b{Ref@TeX{}}'s configuration variables. All
Dave Love <fx@gnu.org>
parents:
diff changeset
3561 variables have customize support - so if you are not familiar with Emacs
Dave Love <fx@gnu.org>
parents:
diff changeset
3562 Lisp (and even if you are) you might find it more comfortable to use
Dave Love <fx@gnu.org>
parents:
diff changeset
3563 @code{customize} to look at and change these variables. @kbd{M-x
Dave Love <fx@gnu.org>
parents:
diff changeset
3564 reftex-customize} will get you there.@refill
Dave Love <fx@gnu.org>
parents:
diff changeset
3565
Dave Love <fx@gnu.org>
parents:
diff changeset
3566 @menu
Dave Love <fx@gnu.org>
parents:
diff changeset
3567 * Options (Table of Contents)::
Dave Love <fx@gnu.org>
parents:
diff changeset
3568 * Options (Defining Label Environments)::
Dave Love <fx@gnu.org>
parents:
diff changeset
3569 * Options (Creating Labels)::
Dave Love <fx@gnu.org>
parents:
diff changeset
3570 * Options (Referencing Labels)::
Dave Love <fx@gnu.org>
parents:
diff changeset
3571 * Options (Creating Citations)::
Dave Love <fx@gnu.org>
parents:
diff changeset
3572 * Options (Index Support)::
Dave Love <fx@gnu.org>
parents:
diff changeset
3573 * Options (Viewing Cross-References)::
Dave Love <fx@gnu.org>
parents:
diff changeset
3574 * Options (Finding Files)::
Dave Love <fx@gnu.org>
parents:
diff changeset
3575 * Options (Optimizations)::
Dave Love <fx@gnu.org>
parents:
diff changeset
3576 * Options (Fontification)::
Dave Love <fx@gnu.org>
parents:
diff changeset
3577 * Options (Misc)::
Dave Love <fx@gnu.org>
parents:
diff changeset
3578 @end menu
Dave Love <fx@gnu.org>
parents:
diff changeset
3579
Dave Love <fx@gnu.org>
parents:
diff changeset
3580 @node Options (Table of Contents), Options (Defining Label Environments), , Options
Dave Love <fx@gnu.org>
parents:
diff changeset
3581 @section Table of Contents
Dave Love <fx@gnu.org>
parents:
diff changeset
3582 @cindex Options, table of contents
Dave Love <fx@gnu.org>
parents:
diff changeset
3583 @cindex Table of contents, options
Dave Love <fx@gnu.org>
parents:
diff changeset
3584
26911
d7f536a01276 Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents: 25829
diff changeset
3585 @defopt reftex-toc-max-level
d7f536a01276 Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents: 25829
diff changeset
3586 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
3587 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
3588 chapters are level 1, sections level 2 etc. This variable can be
d7f536a01276 Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents: 25829
diff changeset
3589 changed from within the @file{*toc*} buffer with the @kbd{t} key.@refill
d7f536a01276 Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents: 25829
diff changeset
3590 @end defopt
d7f536a01276 Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents: 25829
diff changeset
3591
25829
Dave Love <fx@gnu.org>
parents:
diff changeset
3592 @defopt reftex-toc-keep-other-windows
Dave Love <fx@gnu.org>
parents:
diff changeset
3593 Non-@code{nil} means, split the selected window to display the
Dave Love <fx@gnu.org>
parents:
diff changeset
3594 @file{*toc*} buffer. This helps to keep the window configuration, but
Dave Love <fx@gnu.org>
parents:
diff changeset
3595 makes the @file{*toc*} small. When @code{nil}, all other windows except
Dave Love <fx@gnu.org>
parents:
diff changeset
3596 the selected one will be deleted, so that the @file{*toc*} window fills
Dave Love <fx@gnu.org>
parents:
diff changeset
3597 half the frame.@refill
Dave Love <fx@gnu.org>
parents:
diff changeset
3598 @end defopt
Dave Love <fx@gnu.org>
parents:
diff changeset
3599
Dave Love <fx@gnu.org>
parents:
diff changeset
3600 @defopt reftex-toc-include-file-boundaries
Dave Love <fx@gnu.org>
parents:
diff changeset
3601 Non-@code{nil} means, include file boundaries in @file{*toc*} buffer.
Dave Love <fx@gnu.org>
parents:
diff changeset
3602 This flag can be toggled from within the @file{*toc*} buffer with the
Dave Love <fx@gnu.org>
parents:
diff changeset
3603 @kbd{i} key.@refill
Dave Love <fx@gnu.org>
parents:
diff changeset
3604 @end defopt
Dave Love <fx@gnu.org>
parents:
diff changeset
3605
Dave Love <fx@gnu.org>
parents:
diff changeset
3606 @defopt reftex-toc-include-labels
Dave Love <fx@gnu.org>
parents:
diff changeset
3607 Non-@code{nil} means, include labels in @file{*toc*} buffer. This flag
Dave Love <fx@gnu.org>
parents:
diff changeset
3608 can be toggled from within the @file{*toc*} buffer with the @kbd{l}
Dave Love <fx@gnu.org>
parents:
diff changeset
3609 key.@refill
Dave Love <fx@gnu.org>
parents:
diff changeset
3610 @end defopt
Dave Love <fx@gnu.org>
parents:
diff changeset
3611
Dave Love <fx@gnu.org>
parents:
diff changeset
3612 @defopt reftex-toc-include-index-entries
Dave Love <fx@gnu.org>
parents:
diff changeset
3613 Non-@code{nil} means, include index entries in @file{*toc*} buffer.
Dave Love <fx@gnu.org>
parents:
diff changeset
3614 This flag can be toggled from within the @file{*toc*} buffer with the
Dave Love <fx@gnu.org>
parents:
diff changeset
3615 @kbd{i} key.
Dave Love <fx@gnu.org>
parents:
diff changeset
3616 @end defopt
Dave Love <fx@gnu.org>
parents:
diff changeset
3617
Dave Love <fx@gnu.org>
parents:
diff changeset
3618 @defopt reftex-toc-include-context
Dave Love <fx@gnu.org>
parents:
diff changeset
3619 Non-@code{nil} means, include context with labels in the @file{*toc*}
Dave Love <fx@gnu.org>
parents:
diff changeset
3620 buffer. Context will only be shown if the labels are visible as well.
Dave Love <fx@gnu.org>
parents:
diff changeset
3621 This flag can be toggled from within the @file{*toc*} buffer with the
Dave Love <fx@gnu.org>
parents:
diff changeset
3622 @kbd{c} key.@refill
Dave Love <fx@gnu.org>
parents:
diff changeset
3623 @end defopt
Dave Love <fx@gnu.org>
parents:
diff changeset
3624
Dave Love <fx@gnu.org>
parents:
diff changeset
3625 @defopt reftex-toc-follow-mode
Dave Love <fx@gnu.org>
parents:
diff changeset
3626 Non-@code{nil} means, point in @file{*toc*} buffer (the
Dave Love <fx@gnu.org>
parents:
diff changeset
3627 table-of-contents buffer) will cause other window to follow. The other
Dave Love <fx@gnu.org>
parents:
diff changeset
3628 window will show the corresponding part of the document. This flag can
Dave Love <fx@gnu.org>
parents:
diff changeset
3629 be toggled from within the @file{*toc*} buffer with the @kbd{f}
Dave Love <fx@gnu.org>
parents:
diff changeset
3630 key.@refill
Dave Love <fx@gnu.org>
parents:
diff changeset
3631 @end defopt
Dave Love <fx@gnu.org>
parents:
diff changeset
3632
Dave Love <fx@gnu.org>
parents:
diff changeset
3633 @deffn {Normal Hook} reftex-toc-mode-hook
Dave Love <fx@gnu.org>
parents:
diff changeset
3634 Normal hook which is run when a @file{*toc*} buffer is
Dave Love <fx@gnu.org>
parents:
diff changeset
3635 created.@refill
Dave Love <fx@gnu.org>
parents:
diff changeset
3636 @end deffn
Dave Love <fx@gnu.org>
parents:
diff changeset
3637
Dave Love <fx@gnu.org>
parents:
diff changeset
3638 @deffn Keymap reftex-toc-map
Dave Love <fx@gnu.org>
parents:
diff changeset
3639 The keymap which is active in the @file{*toc*} buffer.
Dave Love <fx@gnu.org>
parents:
diff changeset
3640 (@pxref{Table of Contents}).@refill
Dave Love <fx@gnu.org>
parents:
diff changeset
3641 @end deffn
Dave Love <fx@gnu.org>
parents:
diff changeset
3642
Dave Love <fx@gnu.org>
parents:
diff changeset
3643 @node Options (Defining Label Environments), Options (Creating Labels), Options (Table of Contents), Options
Dave Love <fx@gnu.org>
parents:
diff changeset
3644 @section Defining Label Environments
Dave Love <fx@gnu.org>
parents:
diff changeset
3645 @cindex Options, defining label environments
Dave Love <fx@gnu.org>
parents:
diff changeset
3646 @cindex Defining label environments, options
Dave Love <fx@gnu.org>
parents:
diff changeset
3647
Dave Love <fx@gnu.org>
parents:
diff changeset
3648 @defopt reftex-default-label-alist-entries
Dave Love <fx@gnu.org>
parents:
diff changeset
3649 Default label alist specifications. It is a list of symbols with
Dave Love <fx@gnu.org>
parents:
diff changeset
3650 associations in the constant @code{reftex-label-alist-builtin}.
Dave Love <fx@gnu.org>
parents:
diff changeset
3651 @code{LaTeX} should always be the last entry.@refill
Dave Love <fx@gnu.org>
parents:
diff changeset
3652 @end defopt
Dave Love <fx@gnu.org>
parents:
diff changeset
3653
Dave Love <fx@gnu.org>
parents:
diff changeset
3654 @defopt reftex-label-alist
Dave Love <fx@gnu.org>
parents:
diff changeset
3655 Set this variable to define additions and changes to the defaults in
Dave Love <fx@gnu.org>
parents:
diff changeset
3656 @code{reftex-default-label-alist-entries}. The only things you
Dave Love <fx@gnu.org>
parents:
diff changeset
3657 @emph{must not} change is that @code{?s} is the type indicator for
Dave Love <fx@gnu.org>
parents:
diff changeset
3658 section labels, and @key{SPC} for the @code{any} label type. These are
Dave Love <fx@gnu.org>
parents:
diff changeset
3659 hard-coded at other places in the code.@refill
Dave Love <fx@gnu.org>
parents:
diff changeset
3660
Dave Love <fx@gnu.org>
parents:
diff changeset
3661 The value of the variable must be a list of items. Each item is a list
Dave Love <fx@gnu.org>
parents:
diff changeset
3662 itself and has the following structure:
Dave Love <fx@gnu.org>
parents:
diff changeset
3663
Dave Love <fx@gnu.org>
parents:
diff changeset
3664 @example
Dave Love <fx@gnu.org>
parents:
diff changeset
3665 (@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
3666 @var{context-method} (@var{magic-word} ... ) @var{toc-level})
25829
Dave Love <fx@gnu.org>
parents:
diff changeset
3667 @end example
Dave Love <fx@gnu.org>
parents:
diff changeset
3668
Dave Love <fx@gnu.org>
parents:
diff changeset
3669 Each list entry describes either an environment carrying a counter for
Dave Love <fx@gnu.org>
parents:
diff changeset
3670 use with @code{\label} and @code{\ref}, or a LaTeX macro defining a
Dave Love <fx@gnu.org>
parents:
diff changeset
3671 label as (or inside) one of its arguments. The elements of each list
Dave Love <fx@gnu.org>
parents:
diff changeset
3672 entry are:@refill
Dave Love <fx@gnu.org>
parents:
diff changeset
3673
Dave Love <fx@gnu.org>
parents:
diff changeset
3674 @table @asis
Dave Love <fx@gnu.org>
parents:
diff changeset
3675 @item @var{env-or-macro}
Dave Love <fx@gnu.org>
parents:
diff changeset
3676 Name of the environment (like @samp{table}) or macro (like
Dave Love <fx@gnu.org>
parents:
diff changeset
3677 @samp{\myfig}). For macros, indicate the arguments, as in
Dave Love <fx@gnu.org>
parents:
diff changeset
3678 @samp{\myfig[]@{@}@{@}@{*@}@{@}}. Use square brackets for optional
Dave Love <fx@gnu.org>
parents:
diff changeset
3679 arguments, a star to mark the label argument, if any. The macro does
Dave Love <fx@gnu.org>
parents:
diff changeset
3680 not have to have a label argument - you could also use
Dave Love <fx@gnu.org>
parents:
diff changeset
3681 @samp{\label@{...@}} inside one of its arguments.@refill
Dave Love <fx@gnu.org>
parents:
diff changeset
3682
Dave Love <fx@gnu.org>
parents:
diff changeset
3683 Special names: @code{section} for section labels, @code{any} to define a
Dave Love <fx@gnu.org>
parents:
diff changeset
3684 group which contains all labels.@refill
Dave Love <fx@gnu.org>
parents:
diff changeset
3685
Dave Love <fx@gnu.org>
parents:
diff changeset
3686 This may also be a function to do local parsing and identify point to be
Dave Love <fx@gnu.org>
parents:
diff changeset
3687 in a a non-standard label environment. The function must take an
Dave Love <fx@gnu.org>
parents:
diff changeset
3688 argument @var{bound} and limit backward searches to this value. It
Dave Love <fx@gnu.org>
parents:
diff changeset
3689 should return either nil or a cons cell @code{(@var{function}
Dave Love <fx@gnu.org>
parents:
diff changeset
3690 . @var{position})} with the function symbol and the position where the
Dave Love <fx@gnu.org>
parents:
diff changeset
3691 special environment starts. See the Info documentation for an
Dave Love <fx@gnu.org>
parents:
diff changeset
3692 example.@refill
Dave Love <fx@gnu.org>
parents:
diff changeset
3693
Dave Love <fx@gnu.org>
parents:
diff changeset
3694 Finally this may also be @code{nil} if the entry is only meant to change
Dave Love <fx@gnu.org>
parents:
diff changeset
3695 some settings associated with the type indicator character (see
Dave Love <fx@gnu.org>
parents:
diff changeset
3696 below).@refill
Dave Love <fx@gnu.org>
parents:
diff changeset
3697
Dave Love <fx@gnu.org>
parents:
diff changeset
3698 @item @var{type-key}
Dave Love <fx@gnu.org>
parents:
diff changeset
3699 Type indicator character, like @code{?t}, must be a printable ASCII
Dave Love <fx@gnu.org>
parents:
diff changeset
3700 character. The type indicator is a single character which defines a
Dave Love <fx@gnu.org>
parents:
diff changeset
3701 label type. Any label inside the environment or macro is assumed to
Dave Love <fx@gnu.org>
parents:
diff changeset
3702 belong to this type. The same character may occur several times in this
Dave Love <fx@gnu.org>
parents:
diff changeset
3703 list, to cover cases in which different environments carry the same
Dave Love <fx@gnu.org>
parents:
diff changeset
3704 label type (like @code{equation} and @code{eqnarray}). If the type
Dave Love <fx@gnu.org>
parents:
diff changeset
3705 indicator is @code{nil} and the macro has a label argument @samp{@{*@}},
Dave Love <fx@gnu.org>
parents:
diff changeset
3706 the macro defines neutral labels just like @code{\label}. In this case
Dave Love <fx@gnu.org>
parents:
diff changeset
3707 the reminder of this entry is ignored.@refill
Dave Love <fx@gnu.org>
parents:
diff changeset
3708
Dave Love <fx@gnu.org>
parents:
diff changeset
3709 @item @var{label-prefix}
Dave Love <fx@gnu.org>
parents:
diff changeset
3710 Label prefix string, like @samp{tab:}. The prefix is a short string
Dave Love <fx@gnu.org>
parents:
diff changeset
3711 used as the start of a label. It may be the empty string. The prefix
Dave Love <fx@gnu.org>
parents:
diff changeset
3712 may contain the following @samp{%} escapes:@refill
Dave Love <fx@gnu.org>
parents:
diff changeset
3713
Dave Love <fx@gnu.org>
parents:
diff changeset
3714 @example
Dave Love <fx@gnu.org>
parents:
diff changeset
3715 %f Current file name, directory and extension stripped.
Dave Love <fx@gnu.org>
parents:
diff changeset
3716 %F Current file name relative to master file directory.
Dave Love <fx@gnu.org>
parents:
diff changeset
3717 %u User login name, on systems which support this.
Dave Love <fx@gnu.org>
parents:
diff changeset
3718 %S A section prefix derived with variable @code{reftex-section-prefixes}.
Dave Love <fx@gnu.org>
parents:
diff changeset
3719 @end example
Dave Love <fx@gnu.org>
parents:
diff changeset
3720
Dave Love <fx@gnu.org>
parents:
diff changeset
3721 @noindent
Dave Love <fx@gnu.org>
parents:
diff changeset
3722 Example: In a file @file{intro.tex}, @samp{eq:%f:} will become
Dave Love <fx@gnu.org>
parents:
diff changeset
3723 @samp{eq:intro:}.@refill
Dave Love <fx@gnu.org>
parents:
diff changeset
3724
Dave Love <fx@gnu.org>
parents:
diff changeset
3725 @item @var{reference-format}
Dave Love <fx@gnu.org>
parents:
diff changeset
3726 Format string for reference insert in buffer. @samp{%s} will be
Dave Love <fx@gnu.org>
parents:
diff changeset
3727 replaced by the label. When the format starts with @samp{~}, this
Dave Love <fx@gnu.org>
parents:
diff changeset
3728 @samp{~} will only be inserted when the character before point is
Dave Love <fx@gnu.org>
parents:
diff changeset
3729 @emph{not} a whitespace.@refill
Dave Love <fx@gnu.org>
parents:
diff changeset
3730
Dave Love <fx@gnu.org>
parents:
diff changeset
3731 @item @var{context-method}
Dave Love <fx@gnu.org>
parents:
diff changeset
3732 Indication on how to find the short context.
Dave Love <fx@gnu.org>
parents:
diff changeset
3733 @itemize @minus
Dave Love <fx@gnu.org>
parents:
diff changeset
3734 @item
Dave Love <fx@gnu.org>
parents:
diff changeset
3735 If @code{nil}, use the text following the @samp{\label@{...@}} macro.@refill
Dave Love <fx@gnu.org>
parents:
diff changeset
3736 @item
Dave Love <fx@gnu.org>
parents:
diff changeset
3737 If @code{t}, use
Dave Love <fx@gnu.org>
parents:
diff changeset
3738 @itemize @minus
Dave Love <fx@gnu.org>
parents:
diff changeset
3739 @item
Dave Love <fx@gnu.org>
parents:
diff changeset
3740 the section heading for section labels.
Dave Love <fx@gnu.org>
parents:
diff changeset
3741 @item
Dave Love <fx@gnu.org>
parents:
diff changeset
3742 text following the @samp{\begin@{...@}} statement of environments (not
Dave Love <fx@gnu.org>
parents:
diff changeset
3743 a good choice for environments like eqnarray or enumerate, where one has
Dave Love <fx@gnu.org>
parents:
diff changeset
3744 several labels in a single environment).@refill
Dave Love <fx@gnu.org>
parents:
diff changeset
3745 @item
Dave Love <fx@gnu.org>
parents:
diff changeset
3746 text after the macro name (starting with the first arg) for
Dave Love <fx@gnu.org>
parents:
diff changeset
3747 macros.@refill
Dave Love <fx@gnu.org>
parents:
diff changeset
3748 @end itemize
Dave Love <fx@gnu.org>
parents:
diff changeset
3749 @item
Dave Love <fx@gnu.org>
parents:
diff changeset
3750 If an integer, use the nth argument of the macro. As a special case,
Dave Love <fx@gnu.org>
parents:
diff changeset
3751 1000 means to get text after the last macro argument.@refill
Dave Love <fx@gnu.org>
parents:
diff changeset
3752 @item
Dave Love <fx@gnu.org>
parents:
diff changeset
3753 If a string, use as regexp to search @emph{backward} from the label.
Dave Love <fx@gnu.org>
parents:
diff changeset
3754 Context is then the text following the end of the match. E.g. putting
Dave Love <fx@gnu.org>
parents:
diff changeset
3755 this to @samp{\\caption[[@{]} will use the caption in a figure or table
Dave Love <fx@gnu.org>
parents:
diff changeset
3756 environment. @samp{\\begin@{eqnarray@}\|\\\\} works for
Dave Love <fx@gnu.org>
parents:
diff changeset
3757 eqnarrays.@refill
Dave Love <fx@gnu.org>
parents:
diff changeset
3758 @item
Dave Love <fx@gnu.org>
parents:
diff changeset
3759 If any of @code{caption}, @code{item}, @code{eqnarray-like},
Dave Love <fx@gnu.org>
parents:
diff changeset
3760 @code{alignat-like}, this symbol will internally be translated into an
Dave Love <fx@gnu.org>
parents:
diff changeset
3761 appropriate regexp (see also the variable
Dave Love <fx@gnu.org>
parents:
diff changeset
3762 @code{reftex-default-context-regexps}).@refill
Dave Love <fx@gnu.org>
parents:
diff changeset
3763 @item
Dave Love <fx@gnu.org>
parents:
diff changeset
3764 If a function, call this function with the name of the environment/macro
Dave Love <fx@gnu.org>
parents:
diff changeset
3765 as argument. On call, point will be just after the @code{\label} macro.
Dave Love <fx@gnu.org>
parents:
diff changeset
3766 The function is expected to return a suitable context string. It should
Dave Love <fx@gnu.org>
parents:
diff changeset
3767 throw an exception (error) when failing to find context. As an example,
Dave Love <fx@gnu.org>
parents:
diff changeset
3768 here is a function returning the 10 chars following the label macro as
Dave Love <fx@gnu.org>
parents:
diff changeset
3769 context:@refill
Dave Love <fx@gnu.org>
parents:
diff changeset
3770
Dave Love <fx@gnu.org>
parents:
diff changeset
3771 @example
Dave Love <fx@gnu.org>
parents:
diff changeset
3772 (defun my-context-function (env-or-mac)
Dave Love <fx@gnu.org>
parents:
diff changeset
3773 (if (> (point-max) (+ 10 (point)))
Dave Love <fx@gnu.org>
parents:
diff changeset
3774 (buffer-substring (point) (+ 10 (point)))
Dave Love <fx@gnu.org>
parents:
diff changeset
3775 (error "Buffer too small")))
Dave Love <fx@gnu.org>
parents:
diff changeset
3776 @end example
Dave Love <fx@gnu.org>
parents:
diff changeset
3777 @end itemize
Dave Love <fx@gnu.org>
parents:
diff changeset
3778
Dave Love <fx@gnu.org>
parents:
diff changeset
3779 Label context is used in two ways by @b{Ref@TeX{}}: For display in the label
Dave Love <fx@gnu.org>
parents:
diff changeset
3780 menu, and to derive a label string. If you want to use a different
Dave Love <fx@gnu.org>
parents:
diff changeset
3781 method for each of these, specify them as a dotted pair.
Dave Love <fx@gnu.org>
parents:
diff changeset
3782 E.g. @code{(nil . t)} uses the text after the label (@code{nil}) for
Dave Love <fx@gnu.org>
parents:
diff changeset
3783 display, and text from the default position (@code{t}) to derive a label
Dave Love <fx@gnu.org>
parents:
diff changeset
3784 string. This is actually used for section labels.@refill
Dave Love <fx@gnu.org>
parents:
diff changeset
3785
Dave Love <fx@gnu.org>
parents:
diff changeset
3786 @item @var{magic-word-list}
Dave Love <fx@gnu.org>
parents:
diff changeset
3787 List of magic words which identify a reference to be of this type. If
Dave Love <fx@gnu.org>
parents:
diff changeset
3788 the word before point is equal to one of these words when calling
Dave Love <fx@gnu.org>
parents:
diff changeset
3789 @code{reftex-reference}, the label list offered will be automatically
Dave Love <fx@gnu.org>
parents:
diff changeset
3790 restricted to labels of the correct type. If the first element of this
Dave Love <fx@gnu.org>
parents:
diff changeset
3791 word--list is the symbol `regexp', the strings are interpreted as regular
26911
d7f536a01276 Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents: 25829
diff changeset
3792 expressions.@refill
d7f536a01276 Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents: 25829
diff changeset
3793
d7f536a01276 Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents: 25829
diff changeset
3794 @item @var{toc-level}
d7f536a01276 Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents: 25829
diff changeset
3795 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
3796 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
3797 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
3798 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
3799 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
3800 for macros. When omitted or @code{nil}, no TOC entries will be
d7f536a01276 Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents: 25829
diff changeset
3801 made.@refill
25829
Dave Love <fx@gnu.org>
parents:
diff changeset
3802 @end table
Dave Love <fx@gnu.org>
parents:
diff changeset
3803
Dave Love <fx@gnu.org>
parents:
diff changeset
3804 If the type indicator characters of two or more entries are the same,
Dave Love <fx@gnu.org>
parents:
diff changeset
3805 @b{Ref@TeX{}} will use@refill
Dave Love <fx@gnu.org>
parents:
diff changeset
3806 @itemize @minus
Dave Love <fx@gnu.org>
parents:
diff changeset
3807 @item
Dave Love <fx@gnu.org>
parents:
diff changeset
3808 the first non-@code{nil} format and prefix
Dave Love <fx@gnu.org>
parents:
diff changeset
3809 @item
Dave Love <fx@gnu.org>
parents:
diff changeset
3810 the magic words of all involved entries.
Dave Love <fx@gnu.org>
parents:
diff changeset
3811 @end itemize
Dave Love <fx@gnu.org>
parents:
diff changeset
3812
Dave Love <fx@gnu.org>
parents:
diff changeset
3813 Any list entry may also be a symbol. If that has an association in
Dave Love <fx@gnu.org>
parents:
diff changeset
3814 @code{reftex-label-alist-builtin}, the @code{cddr} of that association is
Dave Love <fx@gnu.org>
parents:
diff changeset
3815 spliced into the list. However, builtin defaults should normally be set
Dave Love <fx@gnu.org>
parents:
diff changeset
3816 with the variable @code{reftex-default-label-alist-entries}.@refill
Dave Love <fx@gnu.org>
parents:
diff changeset
3817 @end defopt
Dave Love <fx@gnu.org>
parents:
diff changeset
3818
Dave Love <fx@gnu.org>
parents:
diff changeset
3819 @defopt reftex-max-section-depth
Dave Love <fx@gnu.org>
parents:
diff changeset
3820 Maximum depth of section levels in document structure.
Dave Love <fx@gnu.org>
parents:
diff changeset
3821 Standard LaTeX needs 7, default is 12.
Dave Love <fx@gnu.org>
parents:
diff changeset
3822 @end defopt
Dave Love <fx@gnu.org>
parents:
diff changeset
3823
Dave Love <fx@gnu.org>
parents:
diff changeset
3824 @defopt reftex-section-levels
Dave Love <fx@gnu.org>
parents:
diff changeset
3825 Commands and levels used for defining sections in the document. The
Dave Love <fx@gnu.org>
parents:
diff changeset
3826 @code{car} of each cons cell is the name of the section macro. The
Dave Love <fx@gnu.org>
parents:
diff changeset
3827 @code{cdr} is a number indicating its level. A negative level means the
Dave Love <fx@gnu.org>
parents:
diff changeset
3828 same as the positive value, but the section will never get a
26911
d7f536a01276 Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents: 25829
diff changeset
3829 number. The @code{cdr} may also be a function which then has to return
25829
Dave Love <fx@gnu.org>
parents:
diff changeset
3830 the level.@refill
Dave Love <fx@gnu.org>
parents:
diff changeset
3831 @end defopt
Dave Love <fx@gnu.org>
parents:
diff changeset
3832
Dave Love <fx@gnu.org>
parents:
diff changeset
3833 @defopt reftex-section-prefixes
Dave Love <fx@gnu.org>
parents:
diff changeset
3834 Prefixes for section labels. When the label prefix given in an entry in
Dave Love <fx@gnu.org>
parents:
diff changeset
3835 @code{reftex-label-alist} contains @samp{%S}, this list is used to
Dave Love <fx@gnu.org>
parents:
diff changeset
3836 determine the correct prefix string depending on the current section
Dave Love <fx@gnu.org>
parents:
diff changeset
3837 level. The list is an alist, with each entry of the form
Dave Love <fx@gnu.org>
parents:
diff changeset
3838 @w{@code{(@var{key} . @var{prefix})}}. Possible keys are sectioning macro
Dave Love <fx@gnu.org>
parents:
diff changeset
3839 names like @samp{chapter}, integer section levels (as given in
Dave Love <fx@gnu.org>
parents:
diff changeset
3840 @code{reftex-section-levels}), and @code{t} for the default.
Dave Love <fx@gnu.org>
parents:
diff changeset
3841 @end defopt
Dave Love <fx@gnu.org>
parents:
diff changeset
3842
Dave Love <fx@gnu.org>
parents:
diff changeset
3843 @defopt reftex-default-context-regexps
Dave Love <fx@gnu.org>
parents:
diff changeset
3844 Alist with default regular expressions for finding context. The emacs
Dave Love <fx@gnu.org>
parents:
diff changeset
3845 lisp form @w{@code{(format regexp (regexp-quote environment))}} is used
Dave Love <fx@gnu.org>
parents:
diff changeset
3846 to calculate the final regular expression - so @samp{%s} will be
Dave Love <fx@gnu.org>
parents:
diff changeset
3847 replaced with the environment or macro.@refill
Dave Love <fx@gnu.org>
parents:
diff changeset
3848 @end defopt
Dave Love <fx@gnu.org>
parents:
diff changeset
3849
Dave Love <fx@gnu.org>
parents:
diff changeset
3850 @node Options (Creating Labels), Options (Referencing Labels), Options (Defining Label Environments), Options
Dave Love <fx@gnu.org>
parents:
diff changeset
3851 @section Creating Labels
Dave Love <fx@gnu.org>
parents:
diff changeset
3852 @cindex Options, creating labels
Dave Love <fx@gnu.org>
parents:
diff changeset
3853 @cindex Creating labels, options
Dave Love <fx@gnu.org>
parents:
diff changeset
3854
Dave Love <fx@gnu.org>
parents:
diff changeset
3855 @defopt reftex-insert-label-flags
Dave Love <fx@gnu.org>
parents:
diff changeset
3856 Flags governing label insertion. The value has the form
Dave Love <fx@gnu.org>
parents:
diff changeset
3857
Dave Love <fx@gnu.org>
parents:
diff changeset
3858 @example
Dave Love <fx@gnu.org>
parents:
diff changeset
3859 (@var{derive} @var{prompt})
Dave Love <fx@gnu.org>
parents:
diff changeset
3860 @end example
Dave Love <fx@gnu.org>
parents:
diff changeset
3861
Dave Love <fx@gnu.org>
parents:
diff changeset
3862 If @var{derive}is @code{t}, @b{Ref@TeX{}} will try to derive a sensible
Dave Love <fx@gnu.org>
parents:
diff changeset
3863 label from context. A section label for example will be derived from
Dave Love <fx@gnu.org>
parents:
diff changeset
3864 the section heading. The conversion of the context to a legal label is
Dave Love <fx@gnu.org>
parents:
diff changeset
3865 governed by the specifications given in
Dave Love <fx@gnu.org>
parents:
diff changeset
3866 @code{reftex-derive-label-parameters}. If @var{derive} is @code{nil},
Dave Love <fx@gnu.org>
parents:
diff changeset
3867 the default label will consist of the prefix and a unique number, like
Dave Love <fx@gnu.org>
parents:
diff changeset
3868 @samp{eq:23}.@refill
Dave Love <fx@gnu.org>
parents:
diff changeset
3869
Dave Love <fx@gnu.org>
parents:
diff changeset
3870 If @var{prompt} is @code{t}, the user will be prompted for a label
Dave Love <fx@gnu.org>
parents:
diff changeset
3871 string. When @var{prompt} is @code{nil}, the default label will be
Dave Love <fx@gnu.org>
parents:
diff changeset
3872 inserted without query.@refill
Dave Love <fx@gnu.org>
parents:
diff changeset
3873
Dave Love <fx@gnu.org>
parents:
diff changeset
3874 So the combination of @var{derive} and @var{prompt} controls label
Dave Love <fx@gnu.org>
parents:
diff changeset
3875 insertion. Here is a table describing all four possibilities:@refill
Dave Love <fx@gnu.org>
parents:
diff changeset
3876
Dave Love <fx@gnu.org>
parents:
diff changeset
3877 @example
Dave Love <fx@gnu.org>
parents:
diff changeset
3878 @group
Dave Love <fx@gnu.org>
parents:
diff changeset
3879 @var{derive} @var{prompt} @var{action}
Dave Love <fx@gnu.org>
parents:
diff changeset
3880 -----------------------------------------------------------
Dave Love <fx@gnu.org>
parents:
diff changeset
3881 nil nil @r{Insert simple label, like @samp{eq:22} or @samp{sec:13}. No query.}
Dave Love <fx@gnu.org>
parents:
diff changeset
3882 nil t @r{Prompt for label.}
Dave Love <fx@gnu.org>
parents:
diff changeset
3883 t nil @r{Derive a label from context and insert. No query.}
Dave Love <fx@gnu.org>
parents:
diff changeset
3884 t t @r{Derive a label from context, prompt for confirmation.}
Dave Love <fx@gnu.org>
parents:
diff changeset
3885 @end group
Dave Love <fx@gnu.org>
parents:
diff changeset
3886 @end example
Dave Love <fx@gnu.org>
parents:
diff changeset
3887
Dave Love <fx@gnu.org>
parents:
diff changeset
3888 Each flag may be set to @code{t}, @code{nil}, or a string of label type
Dave Love <fx@gnu.org>
parents:
diff changeset
3889 letters indicating the label types for which it should be true. Thus,
Dave Love <fx@gnu.org>
parents:
diff changeset
3890 the combination may be set differently for each label type. The default
Dave Love <fx@gnu.org>
parents:
diff changeset
3891 settings @samp{"s"} and @samp{"sft"} mean: Derive section labels from
Dave Love <fx@gnu.org>
parents:
diff changeset
3892 headings (with confirmation). Prompt for figure and table labels. Use
Dave Love <fx@gnu.org>
parents:
diff changeset
3893 simple labels without confirmation for everything else.@refill
Dave Love <fx@gnu.org>
parents:
diff changeset
3894
Dave Love <fx@gnu.org>
parents:
diff changeset
3895 The available label types are: @code{s} (section), @code{f} (figure),
Dave Love <fx@gnu.org>
parents:
diff changeset
3896 @code{t} (table), @code{i} (item), @code{e} (equation), @code{n}
Dave Love <fx@gnu.org>
parents:
diff changeset
3897 (footnote), @code{N} (endnote) plus any definitions in
Dave Love <fx@gnu.org>
parents:
diff changeset
3898 @code{reftex-label-alist}.@refill
Dave Love <fx@gnu.org>
parents:
diff changeset
3899 @end defopt
Dave Love <fx@gnu.org>
parents:
diff changeset
3900
Dave Love <fx@gnu.org>
parents:
diff changeset
3901 @deffn Hook reftex-format-label-function
Dave Love <fx@gnu.org>
parents:
diff changeset
3902 If non-@code{nil}, should be a function which produces the string to
Dave Love <fx@gnu.org>
parents:
diff changeset
3903 insert as a label definition. The function will be called with two
Dave Love <fx@gnu.org>
parents:
diff changeset
3904 arguments, the @var{label} and the @var{default-format} (usually
Dave Love <fx@gnu.org>
parents:
diff changeset
3905 @samp{\label@{%s@}}). It should return the string to insert into the
Dave Love <fx@gnu.org>
parents:
diff changeset
3906 buffer.@refill
Dave Love <fx@gnu.org>
parents:
diff changeset
3907 @end deffn
Dave Love <fx@gnu.org>
parents:
diff changeset
3908
Dave Love <fx@gnu.org>
parents:
diff changeset
3909 @deffn Hook reftex-string-to-label-function
Dave Love <fx@gnu.org>
parents:
diff changeset
3910 Function to turn an arbitrary string into a legal label.
Dave Love <fx@gnu.org>
parents:
diff changeset
3911 @b{Ref@TeX{}}'s default function uses the variable
Dave Love <fx@gnu.org>
parents:
diff changeset
3912 @code{reftex-derive-label-parameters}.@refill
Dave Love <fx@gnu.org>
parents:
diff changeset
3913 @end deffn
Dave Love <fx@gnu.org>
parents:
diff changeset
3914
Dave Love <fx@gnu.org>
parents:
diff changeset
3915 @deffn Hook reftex-translate-to-ascii-function
Dave Love <fx@gnu.org>
parents:
diff changeset
3916 Filter function which will process a context string before it is used to
Dave Love <fx@gnu.org>
parents:
diff changeset
3917 derive a label from it. The intended application is to convert ISO or
Dave Love <fx@gnu.org>
parents:
diff changeset
3918 Mule characters into something legal in labels. The default function
Dave Love <fx@gnu.org>
parents:
diff changeset
3919 @code{reftex-latin1-to-ascii} removes the accents from Latin-1
Dave Love <fx@gnu.org>
parents:
diff changeset
3920 characters. X-Symbol (>=2.6) sets this variable to the much more
Dave Love <fx@gnu.org>
parents:
diff changeset
3921 general @code{x-symbol-translate-to-ascii}.@refill
Dave Love <fx@gnu.org>
parents:
diff changeset
3922 @end deffn
Dave Love <fx@gnu.org>
parents:
diff changeset
3923
Dave Love <fx@gnu.org>
parents:
diff changeset
3924 @defopt reftex-derive-label-parameters
Dave Love <fx@gnu.org>
parents:
diff changeset
3925 Parameters for converting a string into a label. This variable is a
Dave Love <fx@gnu.org>
parents:
diff changeset
3926 list of the following items:@refill
Dave Love <fx@gnu.org>
parents:
diff changeset
3927 @table @asis
Dave Love <fx@gnu.org>
parents:
diff changeset
3928 @item @var{nwords}
Dave Love <fx@gnu.org>
parents:
diff changeset
3929 Number of words to use.
Dave Love <fx@gnu.org>
parents:
diff changeset
3930 @item @var{maxchar}
Dave Love <fx@gnu.org>
parents:
diff changeset
3931 Maximum number of characters in a label string.
Dave Love <fx@gnu.org>
parents:
diff changeset
3932 @item @var{illegal}
Dave Love <fx@gnu.org>
parents:
diff changeset
3933 @code{nil}: Throw away any words containing characters illegal in labels.@*
Dave Love <fx@gnu.org>
parents:
diff changeset
3934 @code{t}: Throw away only the illegal characters, not the whole word.
Dave Love <fx@gnu.org>
parents:
diff changeset
3935 @item @var{abbrev}
Dave Love <fx@gnu.org>
parents:
diff changeset
3936 @code{nil}: Never abbreviate words.@*
Dave Love <fx@gnu.org>
parents:
diff changeset
3937 @code{t}: Always abbreviate words (see @code{reftex-abbrev-parameters}).@*
Dave Love <fx@gnu.org>
parents:
diff changeset
3938 @code{1}: Abbreviate words if necessary to shorten label string.
Dave Love <fx@gnu.org>
parents:
diff changeset
3939 @item @var{separator}
Dave Love <fx@gnu.org>
parents:
diff changeset
3940 String separating different words in the label.
Dave Love <fx@gnu.org>
parents:
diff changeset
3941 @item @var{ignorewords}
Dave Love <fx@gnu.org>
parents:
diff changeset
3942 List of words which should not be part of labels.
Dave Love <fx@gnu.org>
parents:
diff changeset
3943 @item @var{downcase}
Dave Love <fx@gnu.org>
parents:
diff changeset
3944 @code{t}: Downcase words before putting them into the label.@*
Dave Love <fx@gnu.org>
parents:
diff changeset
3945 @end table
Dave Love <fx@gnu.org>
parents:
diff changeset
3946 @end defopt
Dave Love <fx@gnu.org>
parents:
diff changeset
3947
Dave Love <fx@gnu.org>
parents:
diff changeset
3948 @defopt reftex-label-illegal-re
Dave Love <fx@gnu.org>
parents:
diff changeset
3949 Regexp matching characters not legal in labels.
Dave Love <fx@gnu.org>
parents:
diff changeset
3950 @end defopt
Dave Love <fx@gnu.org>
parents:
diff changeset
3951
Dave Love <fx@gnu.org>
parents:
diff changeset
3952 @defopt reftex-abbrev-parameters
Dave Love <fx@gnu.org>
parents:
diff changeset
3953 Parameters for abbreviation of words. A list of four parameters.@refill
Dave Love <fx@gnu.org>
parents:
diff changeset
3954 @table @asis
Dave Love <fx@gnu.org>
parents:
diff changeset
3955 @item @var{min-chars}
Dave Love <fx@gnu.org>
parents:
diff changeset
3956 Minimum number of characters remaining after abbreviation.
Dave Love <fx@gnu.org>
parents:
diff changeset
3957 @item @var{min-kill}
Dave Love <fx@gnu.org>
parents:
diff changeset
3958 Minimum number of characters to remove when abbreviating words.@refill
Dave Love <fx@gnu.org>
parents:
diff changeset
3959 @item @var{before}
Dave Love <fx@gnu.org>
parents:
diff changeset
3960 Character class before abbrev point in word.@refill
Dave Love <fx@gnu.org>
parents:
diff changeset
3961 @item @var{after}
Dave Love <fx@gnu.org>
parents:
diff changeset
3962 Character class after abbrev point in word.@refill
Dave Love <fx@gnu.org>
parents:
diff changeset
3963 @end table
Dave Love <fx@gnu.org>
parents:
diff changeset
3964 @end defopt
Dave Love <fx@gnu.org>
parents:
diff changeset
3965
Dave Love <fx@gnu.org>
parents:
diff changeset
3966 @node Options (Referencing Labels), Options (Creating Citations), Options (Creating Labels), Options
Dave Love <fx@gnu.org>
parents:
diff changeset
3967 @section Referencing Labels
Dave Love <fx@gnu.org>
parents:
diff changeset
3968 @cindex Options, referencing labels
Dave Love <fx@gnu.org>
parents:
diff changeset
3969 @cindex Referencing labels, options
Dave Love <fx@gnu.org>
parents:
diff changeset
3970
Dave Love <fx@gnu.org>
parents:
diff changeset
3971 @defopt reftex-label-menu-flags
Dave Love <fx@gnu.org>
parents:
diff changeset
3972 List of flags governing the label menu makeup. The flags are:
Dave Love <fx@gnu.org>
parents:
diff changeset
3973 @table @asis
Dave Love <fx@gnu.org>
parents:
diff changeset
3974 @item @var{table-of-contents}
Dave Love <fx@gnu.org>
parents:
diff changeset
3975 Show the labels embedded in a table of context.@refill
Dave Love <fx@gnu.org>
parents:
diff changeset
3976 @item @var{section-numbers}
Dave Love <fx@gnu.org>
parents:
diff changeset
3977 Include section numbers (like 4.1.3) in table of contents.@refill
Dave Love <fx@gnu.org>
parents:
diff changeset
3978 @item @var{counters}
Dave Love <fx@gnu.org>
parents:
diff changeset
3979 Show counters. This just numbers the labels in the menu.@refill
Dave Love <fx@gnu.org>
parents:
diff changeset
3980 @item @var{no-context}
Dave Love <fx@gnu.org>
parents:
diff changeset
3981 Non-@code{nil} means do @emph{not} show the short context.@refill
Dave Love <fx@gnu.org>
parents:
diff changeset
3982 @item @var{follow}
Dave Love <fx@gnu.org>
parents:
diff changeset
3983 Follow full context in other window.@refill
Dave Love <fx@gnu.org>
parents:
diff changeset
3984 @item @var{show-commented}
Dave Love <fx@gnu.org>
parents:
diff changeset
3985 Show labels from regions which are commented out.@refill
Dave Love <fx@gnu.org>
parents:
diff changeset
3986 @item @var{match-everywhere}
Dave Love <fx@gnu.org>
parents:
diff changeset
3987 Obsolete flag.@refill
Dave Love <fx@gnu.org>
parents:
diff changeset
3988 @item @var{show-files}
Dave Love <fx@gnu.org>
parents:
diff changeset
3989 Show begin and end of included files.@refill
Dave Love <fx@gnu.org>
parents:
diff changeset
3990 @end table
Dave Love <fx@gnu.org>
parents:
diff changeset
3991
Dave Love <fx@gnu.org>
parents:
diff changeset
3992 Each of these flags can be set to @code{t} or @code{nil}, or to a string
Dave Love <fx@gnu.org>
parents:
diff changeset
3993 of type letters indicating the label types for which it should be true.
Dave Love <fx@gnu.org>
parents:
diff changeset
3994 These strings work like character classes in regular expressions. Thus,
Dave Love <fx@gnu.org>
parents:
diff changeset
3995 setting one of the flags to @samp{"sf"} makes the flag true for section
Dave Love <fx@gnu.org>
parents:
diff changeset
3996 and figure labels, @code{nil} for everything else. Setting it to
Dave Love <fx@gnu.org>
parents:
diff changeset
3997 @samp{"^sf"} makes it the other way round.@refill
Dave Love <fx@gnu.org>
parents:
diff changeset
3998
Dave Love <fx@gnu.org>
parents:
diff changeset
3999 The available label types are: @code{s} (section), @code{f} (figure),
Dave Love <fx@gnu.org>
parents:
diff changeset
4000 @code{t} (table), @code{i} (item), @code{e} (equation), @code{n}
Dave Love <fx@gnu.org>
parents:
diff changeset
4001 (footnote), plus any definitions in @code{reftex-label-alist}.@refill
Dave Love <fx@gnu.org>
parents:
diff changeset
4002
Dave Love <fx@gnu.org>
parents:
diff changeset
4003 Most options can also be switched from the label menu itself - so if you
Dave Love <fx@gnu.org>
parents:
diff changeset
4004 decide here to not have a table of contents in the label menu, you can
Dave Love <fx@gnu.org>
parents:
diff changeset
4005 still get one interactively during selection from the label menu.@refill
Dave Love <fx@gnu.org>
parents:
diff changeset
4006 @end defopt
Dave Love <fx@gnu.org>
parents:
diff changeset
4007
Dave Love <fx@gnu.org>
parents:
diff changeset
4008 @defopt reftex-multiref-punctuation
Dave Love <fx@gnu.org>
parents:
diff changeset
4009 Punctuation strings for multiple references. When marking is used in
Dave Love <fx@gnu.org>
parents:
diff changeset
4010 the selection buffer to select several references, this variable
Dave Love <fx@gnu.org>
parents:
diff changeset
4011 associates the 3 marking characters @samp{,-+} with prefix strings to be
Dave Love <fx@gnu.org>
parents:
diff changeset
4012 inserted into the buffer before the corresponding @code{\ref} macro.
Dave Love <fx@gnu.org>
parents:
diff changeset
4013 This is used to string together whole reference sets, like
Dave Love <fx@gnu.org>
parents:
diff changeset
4014 @samp{eqs. 1,2,3-5,6 and 7} in a single call to
Dave Love <fx@gnu.org>
parents:
diff changeset
4015 @code{reftex-reference}.@refill
Dave Love <fx@gnu.org>
parents:
diff changeset
4016 @end defopt
Dave Love <fx@gnu.org>
parents:
diff changeset
4017
Dave Love <fx@gnu.org>
parents:
diff changeset
4018 @defopt reftex-vref-is-default
Dave Love <fx@gnu.org>
parents:
diff changeset
4019 Non-@code{nil} means, the varioref macro @code{\vref} is used as
Dave Love <fx@gnu.org>
parents:
diff changeset
4020 default. In the selection buffer, the @kbd{v} key toggles the reference
Dave Love <fx@gnu.org>
parents:
diff changeset
4021 macro between @code{\ref} and @code{\vref}. The value of this variable
Dave Love <fx@gnu.org>
parents:
diff changeset
4022 determines the default which is active when entering the selection
Dave Love <fx@gnu.org>
parents:
diff changeset
4023 process. Instead of @code{nil} or @code{t}, this may also be a string
Dave Love <fx@gnu.org>
parents:
diff changeset
4024 of type letters indicating the label types for which it should be
Dave Love <fx@gnu.org>
parents:
diff changeset
4025 true.@refill
Dave Love <fx@gnu.org>
parents:
diff changeset
4026 @end defopt
Dave Love <fx@gnu.org>
parents:
diff changeset
4027
Dave Love <fx@gnu.org>
parents:
diff changeset
4028 @defopt reftex-fref-is-default
Dave Love <fx@gnu.org>
parents:
diff changeset
4029 Non-@code{nil} means, the fancyref macro @code{\fref} is used as
Dave Love <fx@gnu.org>
parents:
diff changeset
4030 default. In the selection buffer, the @kbd{V} key toggles the reference
Dave Love <fx@gnu.org>
parents:
diff changeset
4031 macro between @code{\ref}, @code{\fref} and @code{\Fref}. The value of
Dave Love <fx@gnu.org>
parents:
diff changeset
4032 this variable determines the default which is active when entering the
Dave Love <fx@gnu.org>
parents:
diff changeset
4033 selection process. Instead of @code{nil} or @code{t}, this may also be
Dave Love <fx@gnu.org>
parents:
diff changeset
4034 a string of type letters indicating the label types for which it should
Dave Love <fx@gnu.org>
parents:
diff changeset
4035 be true.
Dave Love <fx@gnu.org>
parents:
diff changeset
4036 @end defopt
Dave Love <fx@gnu.org>
parents:
diff changeset
4037
Dave Love <fx@gnu.org>
parents:
diff changeset
4038 @deffn Hook reftex-format-ref-function
Dave Love <fx@gnu.org>
parents:
diff changeset
4039 If non-@code{nil}, should be a function which produces the string to
Dave Love <fx@gnu.org>
parents:
diff changeset
4040 insert as a reference. Note that the insertion format can also be
Dave Love <fx@gnu.org>
parents:
diff changeset
4041 changed with @code{reftex-label-alist}. This hook also is used by the
Dave Love <fx@gnu.org>
parents:
diff changeset
4042 special commands to insert @code{\vref} and @code{\fref} references, so
Dave Love <fx@gnu.org>
parents:
diff changeset
4043 even if you set this, your setting will be ignored by the special
Dave Love <fx@gnu.org>
parents:
diff changeset
4044 commands. The function will be called with two arguments, the
Dave Love <fx@gnu.org>
parents:
diff changeset
4045 @var{label} and the @var{default-format} (usually @samp{~\ref@{%s@}}).
Dave Love <fx@gnu.org>
parents:
diff changeset
4046 It should return the string to insert into the buffer.@refill
Dave Love <fx@gnu.org>
parents:
diff changeset
4047 @end deffn
Dave Love <fx@gnu.org>
parents:
diff changeset
4048
Dave Love <fx@gnu.org>
parents:
diff changeset
4049 @defopt reftex-level-indent
Dave Love <fx@gnu.org>
parents:
diff changeset
4050 Number of spaces to be used for indentation per section level.@refill
Dave Love <fx@gnu.org>
parents:
diff changeset
4051 @end defopt
Dave Love <fx@gnu.org>
parents:
diff changeset
4052
Dave Love <fx@gnu.org>
parents:
diff changeset
4053 @defopt reftex-guess-label-type
Dave Love <fx@gnu.org>
parents:
diff changeset
4054 Non-@code{nil} means, @code{reftex-reference} will try to guess the
Dave Love <fx@gnu.org>
parents:
diff changeset
4055 label type. To do that, @b{Ref@TeX{}} will look at the word before the
Dave Love <fx@gnu.org>
parents:
diff changeset
4056 cursor and compare it with the magic words given in
Dave Love <fx@gnu.org>
parents:
diff changeset
4057 @code{reftex-label-alist}. When it finds a match, @b{Ref@TeX{}} will
Dave Love <fx@gnu.org>
parents:
diff changeset
4058 immediately offer the correct label menu - otherwise it will prompt you
Dave Love <fx@gnu.org>
parents:
diff changeset
4059 for a label type. If you set this variable to @code{nil}, @b{Ref@TeX{}}
Dave Love <fx@gnu.org>
parents:
diff changeset
4060 will always prompt for a label type.@refill
Dave Love <fx@gnu.org>
parents:
diff changeset
4061 @end defopt
Dave Love <fx@gnu.org>
parents:
diff changeset
4062
Dave Love <fx@gnu.org>
parents:
diff changeset
4063 @deffn {Normal Hook} reftex-display-copied-context-hook
Dave Love <fx@gnu.org>
parents:
diff changeset
4064 Normal Hook which is run before context is displayed anywhere. Designed
Dave Love <fx@gnu.org>
parents:
diff changeset
4065 for @w{@code{X-Symbol}}, but may have other uses as well.@refill
Dave Love <fx@gnu.org>
parents:
diff changeset
4066 @end deffn
Dave Love <fx@gnu.org>
parents:
diff changeset
4067
Dave Love <fx@gnu.org>
parents:
diff changeset
4068 @deffn Hook reftex-pre-refontification-functions
Dave Love <fx@gnu.org>
parents:
diff changeset
4069 @code{X-Symbol} specific hook. Probably not useful for other purposes.
Dave Love <fx@gnu.org>
parents:
diff changeset
4070 The functions get two arguments, the buffer from where the command
Dave Love <fx@gnu.org>
parents:
diff changeset
4071 started and a symbol indicating in what context the hook is
Dave Love <fx@gnu.org>
parents:
diff changeset
4072 called.@refill
Dave Love <fx@gnu.org>
parents:
diff changeset
4073 @end deffn
Dave Love <fx@gnu.org>
parents:
diff changeset
4074
Dave Love <fx@gnu.org>
parents:
diff changeset
4075 @deffn {Normal Hook} reftex-select-label-mode-hook
Dave Love <fx@gnu.org>
parents:
diff changeset
4076 Normal hook which is run when a selection buffer enters
Dave Love <fx@gnu.org>
parents:
diff changeset
4077 @code{reftex-select-label-mode}.@refill
Dave Love <fx@gnu.org>
parents:
diff changeset
4078 @end deffn
Dave Love <fx@gnu.org>
parents:
diff changeset
4079
Dave Love <fx@gnu.org>
parents:
diff changeset
4080 @deffn Keymap reftex-select-label-map
Dave Love <fx@gnu.org>
parents:
diff changeset
4081 The keymap which is active in the labels selection process
Dave Love <fx@gnu.org>
parents:
diff changeset
4082 (@pxref{Referencing Labels}).@refill
Dave Love <fx@gnu.org>
parents:
diff changeset
4083 @end deffn
Dave Love <fx@gnu.org>
parents:
diff changeset
4084
Dave Love <fx@gnu.org>
parents:
diff changeset
4085 @node Options (Creating Citations), Options (Index Support), Options (Referencing Labels), Options
Dave Love <fx@gnu.org>
parents:
diff changeset
4086 @section Creating Citations
Dave Love <fx@gnu.org>
parents:
diff changeset
4087 @cindex Options, creating citations
Dave Love <fx@gnu.org>
parents:
diff changeset
4088 @cindex Creating citations, options
Dave Love <fx@gnu.org>
parents:
diff changeset
4089
Dave Love <fx@gnu.org>
parents:
diff changeset
4090 @defopt reftex-bibfile-ignore-regexps
Dave Love <fx@gnu.org>
parents:
diff changeset
4091 List of regular expressions to exclude files in
Dave Love <fx@gnu.org>
parents:
diff changeset
4092 @code{\\bibliography@{..@}}. File names matched by any of these regexps
Dave Love <fx@gnu.org>
parents:
diff changeset
4093 will not be parsed. Intended for files which contain only
Dave Love <fx@gnu.org>
parents:
diff changeset
4094 @code{@@string} macro definitions and the like, which are ignored by
Dave Love <fx@gnu.org>
parents:
diff changeset
4095 @b{Ref@TeX{}} anyway.@refill
Dave Love <fx@gnu.org>
parents:
diff changeset
4096 @end defopt
Dave Love <fx@gnu.org>
parents:
diff changeset
4097
Dave Love <fx@gnu.org>
parents:
diff changeset
4098 @defopt reftex-default-bibliography
Dave Love <fx@gnu.org>
parents:
diff changeset
4099 List of BibTeX database files which should be used if none are specified.
Dave Love <fx@gnu.org>
parents:
diff changeset
4100 When @code{reftex-citation} is called from a document with neither
Dave Love <fx@gnu.org>
parents:
diff changeset
4101 a @samp{\bibliography@{...@}} statement nor a @code{thebibliography}
Dave Love <fx@gnu.org>
parents:
diff changeset
4102 environment, @b{Ref@TeX{}} will scan these files instead. Intended for
Dave Love <fx@gnu.org>
parents:
diff changeset
4103 using @code{reftex-citation} in non-LaTeX files. The files will be
Dave Love <fx@gnu.org>
parents:
diff changeset
4104 searched along the BIBINPUTS or TEXBIB path.@refill
Dave Love <fx@gnu.org>
parents:
diff changeset
4105 @end defopt
Dave Love <fx@gnu.org>
parents:
diff changeset
4106
Dave Love <fx@gnu.org>
parents:
diff changeset
4107 @defopt reftex-sort-bibtex-matches
Dave Love <fx@gnu.org>
parents:
diff changeset
4108 Sorting of the entries found in BibTeX databases by reftex-citation.
Dave Love <fx@gnu.org>
parents:
diff changeset
4109 Possible values:@refill
Dave Love <fx@gnu.org>
parents:
diff changeset
4110 @example
Dave Love <fx@gnu.org>
parents:
diff changeset
4111 nil @r{Do not sort entries.}
Dave Love <fx@gnu.org>
parents:
diff changeset
4112 author @r{Sort entries by author name.}
Dave Love <fx@gnu.org>
parents:
diff changeset
4113 year @r{Sort entries by increasing year.}
Dave Love <fx@gnu.org>
parents:
diff changeset
4114 reverse-year @r{Sort entries by decreasing year.}
Dave Love <fx@gnu.org>
parents:
diff changeset
4115 @end example
Dave Love <fx@gnu.org>
parents:
diff changeset
4116 @end defopt
Dave Love <fx@gnu.org>
parents:
diff changeset
4117
Dave Love <fx@gnu.org>
parents:
diff changeset
4118 @defopt reftex-cite-format
Dave Love <fx@gnu.org>
parents:
diff changeset
4119 The format of citations to be inserted into the buffer. It can be a
Dave Love <fx@gnu.org>
parents:
diff changeset
4120 string, an alist or a symbol. In the simplest case this is just the string
Dave Love <fx@gnu.org>
parents:
diff changeset
4121 @samp{\cite@{%l@}}, which is also the default. See the definition of
Dave Love <fx@gnu.org>
parents:
diff changeset
4122 @code{reftex-cite-format-builtin} for more complex examples.@refill
Dave Love <fx@gnu.org>
parents:
diff changeset
4123
Dave Love <fx@gnu.org>
parents:
diff changeset
4124 If @code{reftex-cite-format} is a string, it will be used as the format.
Dave Love <fx@gnu.org>
parents:
diff changeset
4125 In the format, the following percent escapes will be expanded.@refill
Dave Love <fx@gnu.org>
parents:
diff changeset
4126
Dave Love <fx@gnu.org>
parents:
diff changeset
4127 @table @code
Dave Love <fx@gnu.org>
parents:
diff changeset
4128 @item %l
Dave Love <fx@gnu.org>
parents:
diff changeset
4129 The BibTeX label of the citation.
Dave Love <fx@gnu.org>
parents:
diff changeset
4130 @item %a
Dave Love <fx@gnu.org>
parents:
diff changeset
4131 List of author names, see also @code{reftex-cite-punctuation}.
Dave Love <fx@gnu.org>
parents:
diff changeset
4132 @item %2a
Dave Love <fx@gnu.org>
parents:
diff changeset
4133 Like %a, but abbreviate more than 2 authors like Jones et al.
Dave Love <fx@gnu.org>
parents:
diff changeset
4134 @item %A
Dave Love <fx@gnu.org>
parents:
diff changeset
4135 First author name only.
Dave Love <fx@gnu.org>
parents:
diff changeset
4136 @item %e
Dave Love <fx@gnu.org>
parents:
diff changeset
4137 Works like @samp{%a}, but on list of editor names. (@samp{%2e} and
Dave Love <fx@gnu.org>
parents:
diff changeset
4138 @samp{%E} work a well).@refill
Dave Love <fx@gnu.org>
parents:
diff changeset
4139 @end table
Dave Love <fx@gnu.org>
parents:
diff changeset
4140
Dave Love <fx@gnu.org>
parents:
diff changeset
4141 It is also possible to access all other BibTeX database fields:
Dave Love <fx@gnu.org>
parents:
diff changeset
4142
Dave Love <fx@gnu.org>
parents:
diff changeset
4143 @example
Dave Love <fx@gnu.org>
parents:
diff changeset
4144 %b booktitle %c chapter %d edition %h howpublished
Dave Love <fx@gnu.org>
parents:
diff changeset
4145 %i institution %j journal %k key %m month
Dave Love <fx@gnu.org>
parents:
diff changeset
4146 %n number %o organization %p pages %P first page
Dave Love <fx@gnu.org>
parents:
diff changeset
4147 %r address %s school %u publisher %t title
Dave Love <fx@gnu.org>
parents:
diff changeset
4148 %v volume %y year
Dave Love <fx@gnu.org>
parents:
diff changeset
4149 %B booktitle, abbreviated %T title, abbreviated
Dave Love <fx@gnu.org>
parents:
diff changeset
4150 @end example
Dave Love <fx@gnu.org>
parents:
diff changeset
4151
Dave Love <fx@gnu.org>
parents:
diff changeset
4152 @noindent
Dave Love <fx@gnu.org>
parents:
diff changeset
4153 Usually, only @samp{%l} is needed. The other stuff is mainly for the
Dave Love <fx@gnu.org>
parents:
diff changeset
4154 echo area display, and for @code{(setq reftex-comment-citations t)}.@refill
Dave Love <fx@gnu.org>
parents:
diff changeset
4155
Dave Love <fx@gnu.org>
parents:
diff changeset
4156 @samp{%<} as a special operator kills punctuation and space around it
Dave Love <fx@gnu.org>
parents:
diff changeset
4157 after the string has been formatted.@refill
Dave Love <fx@gnu.org>
parents:
diff changeset
4158
Dave Love <fx@gnu.org>
parents:
diff changeset
4159 Beware that all this only works with BibTeX database files. When
Dave Love <fx@gnu.org>
parents:
diff changeset
4160 citations are made from the @code{\bibitems} in an explicit
Dave Love <fx@gnu.org>
parents:
diff changeset
4161 @code{thebibliography} environment, only @samp{%l} is available.@refill
Dave Love <fx@gnu.org>
parents:
diff changeset
4162
Dave Love <fx@gnu.org>
parents:
diff changeset
4163 If @code{reftex-cite-format} is an alist of characters and strings, the
Dave Love <fx@gnu.org>
parents:
diff changeset
4164 user will be prompted for a character to select one of the possible
Dave Love <fx@gnu.org>
parents:
diff changeset
4165 format strings.@refill
Dave Love <fx@gnu.org>
parents:
diff changeset
4166
Dave Love <fx@gnu.org>
parents:
diff changeset
4167 In order to configure this variable, you can either set
Dave Love <fx@gnu.org>
parents:
diff changeset
4168 @code{reftex-cite-format} directly yourself or set it to the
Dave Love <fx@gnu.org>
parents:
diff changeset
4169 @emph{symbol} of one of the predefined styles. The predefined symbols
Dave Love <fx@gnu.org>
parents:
diff changeset
4170 are those which have an association in the constant
Dave Love <fx@gnu.org>
parents:
diff changeset
4171 @code{reftex-cite-format-builtin}) E.g.: @code{(setq reftex-cite-format
Dave Love <fx@gnu.org>
parents:
diff changeset
4172 'natbib)}.@refill
Dave Love <fx@gnu.org>
parents:
diff changeset
4173 @end defopt
Dave Love <fx@gnu.org>
parents:
diff changeset
4174
Dave Love <fx@gnu.org>
parents:
diff changeset
4175 @deffn Hook reftex-format-cite-function
Dave Love <fx@gnu.org>
parents:
diff changeset
4176
Dave Love <fx@gnu.org>
parents:
diff changeset
4177 If non-@code{nil}, should be a function which produces the string to
Dave Love <fx@gnu.org>
parents:
diff changeset
4178 insert as a citation. Note that the citation format can also be changed
Dave Love <fx@gnu.org>
parents:
diff changeset
4179 with the variable @code{reftex-cite-format}. The function will be
Dave Love <fx@gnu.org>
parents:
diff changeset
4180 called with two arguments, the @var{citation-key} and the
Dave Love <fx@gnu.org>
parents:
diff changeset
4181 @var{default-format} (taken from @code{reftex-cite-format}). It should
Dave Love <fx@gnu.org>
parents:
diff changeset
4182 return the string to insert into the buffer.@refill
Dave Love <fx@gnu.org>
parents:
diff changeset
4183 @end deffn
Dave Love <fx@gnu.org>
parents:
diff changeset
4184
Dave Love <fx@gnu.org>
parents:
diff changeset
4185 @defopt reftex-comment-citations
Dave Love <fx@gnu.org>
parents:
diff changeset
4186 Non-@code{nil} means add a comment for each citation describing the full
Dave Love <fx@gnu.org>
parents:
diff changeset
4187 entry. The comment is formatted according to
Dave Love <fx@gnu.org>
parents:
diff changeset
4188 @code{reftex-cite-comment-format}.@refill
Dave Love <fx@gnu.org>
parents:
diff changeset
4189 @end defopt
Dave Love <fx@gnu.org>
parents:
diff changeset
4190
Dave Love <fx@gnu.org>
parents:
diff changeset
4191 @defopt reftex-cite-comment-format
Dave Love <fx@gnu.org>
parents:
diff changeset
4192 Citation format used for commented citations. Must @emph{not} contain
Dave Love <fx@gnu.org>
parents:
diff changeset
4193 @samp{%l}. See the variable @code{reftex-cite-format} for possible
Dave Love <fx@gnu.org>
parents:
diff changeset
4194 percent escapes.@refill
Dave Love <fx@gnu.org>
parents:
diff changeset
4195 @end defopt
Dave Love <fx@gnu.org>
parents:
diff changeset
4196
Dave Love <fx@gnu.org>
parents:
diff changeset
4197 @defopt reftex-cite-punctuation
Dave Love <fx@gnu.org>
parents:
diff changeset
4198 Punctuation for formatting of name lists in citations. This is a list
Dave Love <fx@gnu.org>
parents:
diff changeset
4199 of 3 strings.@refill
Dave Love <fx@gnu.org>
parents:
diff changeset
4200 @enumerate
Dave Love <fx@gnu.org>
parents:
diff changeset
4201 @item
Dave Love <fx@gnu.org>
parents:
diff changeset
4202 normal names separator, like @samp{, } in Jones, Brown and Miller
Dave Love <fx@gnu.org>
parents:
diff changeset
4203 @item
Dave Love <fx@gnu.org>
parents:
diff changeset
4204 final names separator, like @samp{ and } in Jones, Brown and Miller
Dave Love <fx@gnu.org>
parents:
diff changeset
4205 @item
Dave Love <fx@gnu.org>
parents:
diff changeset
4206 The @samp{et al.} string, like @samp{ @{\it et al.@}} in
Dave Love <fx@gnu.org>
parents:
diff changeset
4207 Jones @{\it et al.@}
Dave Love <fx@gnu.org>
parents:
diff changeset
4208 @end enumerate
Dave Love <fx@gnu.org>
parents:
diff changeset
4209 @end defopt
Dave Love <fx@gnu.org>
parents:
diff changeset
4210
Dave Love <fx@gnu.org>
parents:
diff changeset
4211 @deffn {Normal Hook} reftex-select-bib-mode-hook
Dave Love <fx@gnu.org>
parents:
diff changeset
4212 Normal hook which is run when a selection buffer enters
Dave Love <fx@gnu.org>
parents:
diff changeset
4213 @code{reftex-select-bib-mode}.@refill
Dave Love <fx@gnu.org>
parents:
diff changeset
4214 @end deffn
Dave Love <fx@gnu.org>
parents:
diff changeset
4215
Dave Love <fx@gnu.org>
parents:
diff changeset
4216 @deffn Keymap reftex-select-bib-map
Dave Love <fx@gnu.org>
parents:
diff changeset
4217 The keymap which is active in the citation-key selection process
Dave Love <fx@gnu.org>
parents:
diff changeset
4218 (@pxref{Creating Citations}).@refill
Dave Love <fx@gnu.org>
parents:
diff changeset
4219 @end deffn
Dave Love <fx@gnu.org>
parents:
diff changeset
4220
Dave Love <fx@gnu.org>
parents:
diff changeset
4221 @node Options (Index Support), Options (Viewing Cross-References), Options (Creating Citations), Options
Dave Love <fx@gnu.org>
parents:
diff changeset
4222 @section Index Support
Dave Love <fx@gnu.org>
parents:
diff changeset
4223 @cindex Options, Index support
Dave Love <fx@gnu.org>
parents:
diff changeset
4224 @cindex Index support, options
Dave Love <fx@gnu.org>
parents:
diff changeset
4225
Dave Love <fx@gnu.org>
parents:
diff changeset
4226 @defopt reftex-support-index
Dave Love <fx@gnu.org>
parents:
diff changeset
4227 Non-@code{nil} means, index entries are parsed as well. Index support
Dave Love <fx@gnu.org>
parents:
diff changeset
4228 is resource intensive and the internal structure holding the parsed
Dave Love <fx@gnu.org>
parents:
diff changeset
4229 information can become quite big. Therefore it can be turned off. When
Dave Love <fx@gnu.org>
parents:
diff changeset
4230 this is @code{nil} and you execute a command which requires index
Dave Love <fx@gnu.org>
parents:
diff changeset
4231 support, you will be asked for confirmation to turn it on and rescan the
Dave Love <fx@gnu.org>
parents:
diff changeset
4232 document.@refill
Dave Love <fx@gnu.org>
parents:
diff changeset
4233 @end defopt
Dave Love <fx@gnu.org>
parents:
diff changeset
4234
Dave Love <fx@gnu.org>
parents:
diff changeset
4235 @defopt reftex-index-special-chars
Dave Love <fx@gnu.org>
parents:
diff changeset
4236 List of special characters in index entries, given as strings. These
Dave Love <fx@gnu.org>
parents:
diff changeset
4237 correspond to the @code{MakeIndex} keywords
Dave Love <fx@gnu.org>
parents:
diff changeset
4238 @code{(@var{level} @var{encap} @var{actual} @var{quote} @var{escape})}.
Dave Love <fx@gnu.org>
parents:
diff changeset
4239 @end defopt
Dave Love <fx@gnu.org>
parents:
diff changeset
4240
Dave Love <fx@gnu.org>
parents:
diff changeset
4241 @defopt reftex-index-macros
Dave Love <fx@gnu.org>
parents:
diff changeset
4242 List of macros which define index entries. The structure of each entry
Dave Love <fx@gnu.org>
parents:
diff changeset
4243 is
Dave Love <fx@gnu.org>
parents:
diff changeset
4244 @lisp
26911
d7f536a01276 Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents: 25829
diff changeset
4245 (@var{macro} @var{index-tag} @var{key} @var{prefix} @var{exclude} @var{repeat})
25829
Dave Love <fx@gnu.org>
parents:
diff changeset
4246 @end lisp
Dave Love <fx@gnu.org>
parents:
diff changeset
4247
Dave Love <fx@gnu.org>
parents:
diff changeset
4248 @var{macro} is the macro. Arguments should be denoted by empty braces,
Dave Love <fx@gnu.org>
parents:
diff changeset
4249 as for example in @samp{\index[]@{*@}}. Use square brackets to denote
Dave Love <fx@gnu.org>
parents:
diff changeset
4250 optional arguments. The star marks where the index key is.@refill
Dave Love <fx@gnu.org>
parents:
diff changeset
4251
Dave Love <fx@gnu.org>
parents:
diff changeset
4252 @var{index-tag} is a short name of the index. @samp{idx} and @samp{glo}
Dave Love <fx@gnu.org>
parents:
diff changeset
4253 are reserved for the default index and the glossary. Other indices can
Dave Love <fx@gnu.org>
parents:
diff changeset
4254 be defined as well. If this is an integer, the Nth argument of the
Dave Love <fx@gnu.org>
parents:
diff changeset
4255 macro holds the index tag.@refill
Dave Love <fx@gnu.org>
parents:
diff changeset
4256
Dave Love <fx@gnu.org>
parents:
diff changeset
4257 @var{key} is a character which is used to identify the macro for input
Dave Love <fx@gnu.org>
parents:
diff changeset
4258 with @code{reftex-index}. @samp{?i}, @samp{?I}, and @samp{?g} are
Dave Love <fx@gnu.org>
parents:
diff changeset
4259 reserved for default index and glossary.@refill
Dave Love <fx@gnu.org>
parents:
diff changeset
4260
Dave Love <fx@gnu.org>
parents:
diff changeset
4261 @var{prefix} can be a prefix which is added to the @var{key} part of the
Dave Love <fx@gnu.org>
parents:
diff changeset
4262 index entry. If you have a macro
Dave Love <fx@gnu.org>
parents:
diff changeset
4263 @code{\newcommand@{\molec@}[1]@{#1\index@{Molecules!#1@}}, this prefix
Dave Love <fx@gnu.org>
parents:
diff changeset
4264 should be @samp{Molecules!}.@refill
Dave Love <fx@gnu.org>
parents:
diff changeset
4265
Dave Love <fx@gnu.org>
parents:
diff changeset
4266 @var{exclude} can be a function. If this function exists and returns a
Dave Love <fx@gnu.org>
parents:
diff changeset
4267 non-nil value, the index entry at point is ignored. This was
Dave Love <fx@gnu.org>
parents:
diff changeset
4268 implemented to support the (deprecated) @samp{^} and @samp{_} shortcuts
Dave Love <fx@gnu.org>
parents:
diff changeset
4269 in the LaTeX2e @code{index} package.@refill
Dave Love <fx@gnu.org>
parents:
diff changeset
4270
26911
d7f536a01276 Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents: 25829
diff changeset
4271 @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
4272 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
4273 index macro. Needed for @code{reftex-index-selection-or-word} and for
d7f536a01276 Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents: 25829
diff changeset
4274 indexing from the phrase buffer.@refill
d7f536a01276 Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents: 25829
diff changeset
4275
25829
Dave Love <fx@gnu.org>
parents:
diff changeset
4276 The final entry may also be a symbol. It must have an association in
Dave Love <fx@gnu.org>
parents:
diff changeset
4277 the variable @code{reftex-index-macros-builtin} to specify the main
Dave Love <fx@gnu.org>
parents:
diff changeset
4278 indexing package you are using. Legal values are currently@refill
Dave Love <fx@gnu.org>
parents:
diff changeset
4279 @example
Dave Love <fx@gnu.org>
parents:
diff changeset
4280 default @r{The LaTeX default - unnecessary to specify this one}
Dave Love <fx@gnu.org>
parents:
diff changeset
4281 multind @r{The multind.sty package}
Dave Love <fx@gnu.org>
parents:
diff changeset
4282 index @r{The index.sty package}
Dave Love <fx@gnu.org>
parents:
diff changeset
4283 index-shortcut @r{The index.sty packages with the ^ and _ shortcuts.}
Dave Love <fx@gnu.org>
parents:
diff changeset
4284 @r{Should not be used - only for old documents}
Dave Love <fx@gnu.org>
parents:
diff changeset
4285 @end example
Dave Love <fx@gnu.org>
parents:
diff changeset
4286 Note that AUCTeX sets these things internally for @b{Ref@TeX{}} as well,
Dave Love <fx@gnu.org>
parents:
diff changeset
4287 so with a sufficiently new version of AUCTeX, you should not set the
Dave Love <fx@gnu.org>
parents:
diff changeset
4288 package here.
Dave Love <fx@gnu.org>
parents:
diff changeset
4289 @end defopt
Dave Love <fx@gnu.org>
parents:
diff changeset
4290
Dave Love <fx@gnu.org>
parents:
diff changeset
4291 @defopt reftex-index-default-macro
Dave Love <fx@gnu.org>
parents:
diff changeset
4292 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
4293 This is a list with @code{(@var{macro-key} @var{default-tag})}.
25829
Dave Love <fx@gnu.org>
parents:
diff changeset
4294
Dave Love <fx@gnu.org>
parents:
diff changeset
4295 @var{macro-key} is a character identifying an index macro - see
Dave Love <fx@gnu.org>
parents:
diff changeset
4296 @code{reftex-index-macros}.
Dave Love <fx@gnu.org>
parents:
diff changeset
4297
Dave Love <fx@gnu.org>
parents:
diff changeset
4298 @var{default-tag} is the tag to be used if the macro requires a
Dave Love <fx@gnu.org>
parents:
diff changeset
4299 @var{tag} argument. When this is @code{nil} and a @var{tag} is needed,
Dave Love <fx@gnu.org>
parents:
diff changeset
4300 @b{Ref@TeX{}} will ask for it. When this is the empty string and the
Dave Love <fx@gnu.org>
parents:
diff changeset
4301 TAG argument of the index macro is optional, the TAG argument will be
26911
d7f536a01276 Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents: 25829
diff changeset
4302 omitted.@refill
25829
Dave Love <fx@gnu.org>
parents:
diff changeset
4303 @end defopt
Dave Love <fx@gnu.org>
parents:
diff changeset
4304
Dave Love <fx@gnu.org>
parents:
diff changeset
4305 @defopt reftex-index-default-tag
Dave Love <fx@gnu.org>
parents:
diff changeset
4306 Default index tag. When working with multiple indexes, RefTeX queries
Dave Love <fx@gnu.org>
parents:
diff changeset
4307 for an index tag when creating index entries or displaying a specific
Dave Love <fx@gnu.org>
parents:
diff changeset
4308 index. This variable controls the default offered for these queries.
Dave Love <fx@gnu.org>
parents:
diff changeset
4309 The default can be selected with @key{RET} during selection or
Dave Love <fx@gnu.org>
parents:
diff changeset
4310 completion. Legal values of this variable are:@refill
Dave Love <fx@gnu.org>
parents:
diff changeset
4311 @example
Dave Love <fx@gnu.org>
parents:
diff changeset
4312 nil @r{Do not provide a default index}
Dave Love <fx@gnu.org>
parents:
diff changeset
4313 "tag" @r{The default index tag given as a string, e.g. "idx"}
Dave Love <fx@gnu.org>
parents:
diff changeset
4314 last @r{The last used index tag will be offered as default}
Dave Love <fx@gnu.org>
parents:
diff changeset
4315 @end example
Dave Love <fx@gnu.org>
parents:
diff changeset
4316 @end defopt
Dave Love <fx@gnu.org>
parents:
diff changeset
4317
Dave Love <fx@gnu.org>
parents:
diff changeset
4318 @defopt reftex-index-math-format
Dave Love <fx@gnu.org>
parents:
diff changeset
4319 Format of index entries when copied from inside math mode. When
Dave Love <fx@gnu.org>
parents:
diff changeset
4320 @code{reftex-index-selection-or-word} is executed inside TeX math mode,
Dave Love <fx@gnu.org>
parents:
diff changeset
4321 the index key copied from the buffer is processed with this format
Dave Love <fx@gnu.org>
parents:
diff changeset
4322 string through the @code{format} function. This can be used to add the
Dave Love <fx@gnu.org>
parents:
diff changeset
4323 math delimiters (e.g. @samp{$}) to the string. Requires the
Dave Love <fx@gnu.org>
parents:
diff changeset
4324 @file{texmathp.el} library which is part of AUCTeX.@refill
Dave Love <fx@gnu.org>
parents:
diff changeset
4325 @end defopt
Dave Love <fx@gnu.org>
parents:
diff changeset
4326
27195
d7311a9cb223 version 4.10
Carsten Dominik <dominik@science.uva.nl>
parents: 26911
diff changeset
4327 @defopt reftex-index-phrase-file-extension
d7311a9cb223 version 4.10
Carsten Dominik <dominik@science.uva.nl>
parents: 26911
diff changeset
4328 File extension for the index phrase file. This extension will be added
d7311a9cb223 version 4.10
Carsten Dominik <dominik@science.uva.nl>
parents: 26911
diff changeset
4329 to the base name of the master file.
d7311a9cb223 version 4.10
Carsten Dominik <dominik@science.uva.nl>
parents: 26911
diff changeset
4330 @end defopt
d7311a9cb223 version 4.10
Carsten Dominik <dominik@science.uva.nl>
parents: 26911
diff changeset
4331
26911
d7f536a01276 Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents: 25829
diff changeset
4332 @defopt reftex-index-phrases-logical-and-regexp
d7f536a01276 Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents: 25829
diff changeset
4333 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
4334 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
4335 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
4336 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
4337 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
4338 logical @samp{and} has higher priority than the logical @samp{or}
d7f536a01276 Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents: 25829
diff changeset
4339 specified in @code{reftex-index-phrases-logical-or-regexp}.@refill
d7f536a01276 Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents: 25829
diff changeset
4340 @end defopt
d7f536a01276 Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents: 25829
diff changeset
4341
d7f536a01276 Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents: 25829
diff changeset
4342 @defopt reftex-index-phrases-logical-or-regexp
d7f536a01276 Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents: 25829
diff changeset
4343 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
4344 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
4345 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
4346 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
4347 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
4348 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
4349 @samp{and} specified in @code{reftex-index-phrases-logical-or-regexp}
d7f536a01276 Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents: 25829
diff changeset
4350 has higher priority than this logical @samp{or}.@refill
d7f536a01276 Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents: 25829
diff changeset
4351 @end defopt
d7f536a01276 Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents: 25829
diff changeset
4352
d7f536a01276 Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents: 25829
diff changeset
4353 @defopt reftex-index-phrases-search-whole-words
d7f536a01276 Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents: 25829
diff changeset
4354 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
4355 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
4356 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
4357 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
4358 @end defopt
d7f536a01276 Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents: 25829
diff changeset
4359
d7f536a01276 Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents: 25829
diff changeset
4360 @defopt reftex-index-phrases-case-fold-search
d7f536a01276 Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents: 25829
diff changeset
4361 Non-@code{nil} means, searching for index phrases will ignore
d7f536a01276 Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents: 25829
diff changeset
4362 case.@refill
d7f536a01276 Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents: 25829
diff changeset
4363 @end defopt
d7f536a01276 Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents: 25829
diff changeset
4364
d7f536a01276 Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents: 25829
diff changeset
4365 @defopt reftex-index-phrases-skip-indexed-matches
d7f536a01276 Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents: 25829
diff changeset
4366 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
4367 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
4368 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
4369 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
4370 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
4371 @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
4372 index macro is directly before or after the phrase. If that is the
d7f536a01276 Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents: 25829
diff changeset
4373 case, that match will be ignored.@refill
d7f536a01276 Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents: 25829
diff changeset
4374 @end defopt
d7f536a01276 Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents: 25829
diff changeset
4375
d7f536a01276 Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents: 25829
diff changeset
4376 @defopt reftex-index-phrases-wrap-long-lines
d7f536a01276 Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents: 25829
diff changeset
4377 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
4378 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
4379 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
4380 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
4381 indexing command to keep lines short. However, the matched text
d7f536a01276 Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents: 25829
diff changeset
4382 phrase and its index command will always end up on a single line.@refill
d7f536a01276 Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents: 25829
diff changeset
4383 @end defopt
d7f536a01276 Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents: 25829
diff changeset
4384
d7f536a01276 Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents: 25829
diff changeset
4385 @defopt reftex-index-phrases-sort-prefers-entry
d7f536a01276 Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents: 25829
diff changeset
4386 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
4387 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
4388 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
4389 an explicit index argument specified. When this variable is
d7f536a01276 Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents: 25829
diff changeset
4390 non-@code{nil}, the index argument will be used for sorting.@refill
d7f536a01276 Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents: 25829
diff changeset
4391 @end defopt
d7f536a01276 Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents: 25829
diff changeset
4392
d7f536a01276 Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents: 25829
diff changeset
4393 @defopt reftex-index-phrases-sort-in-blocks
d7f536a01276 Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents: 25829
diff changeset
4394 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
4395 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
4396 re-arranged only within blocks.
d7f536a01276 Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents: 25829
diff changeset
4397 @end defopt
d7f536a01276 Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents: 25829
diff changeset
4398
d7f536a01276 Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents: 25829
diff changeset
4399 @defopt reftex-index-phrases-map
d7f536a01276 Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents: 25829
diff changeset
4400 Keymap for the Index Phrases buffer.
d7f536a01276 Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents: 25829
diff changeset
4401 @end defopt
d7f536a01276 Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents: 25829
diff changeset
4402
d7f536a01276 Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents: 25829
diff changeset
4403 @defopt reftex-index-phrases-mode-hook
d7f536a01276 Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents: 25829
diff changeset
4404 Normal hook which is run when a buffer is put into
d7f536a01276 Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents: 25829
diff changeset
4405 @code{reftex-index-phrases-mode}.@refill
d7f536a01276 Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents: 25829
diff changeset
4406 @end defopt
d7f536a01276 Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents: 25829
diff changeset
4407
25829
Dave Love <fx@gnu.org>
parents:
diff changeset
4408 @defopt reftex-index-section-letters
Dave Love <fx@gnu.org>
parents:
diff changeset
4409 The letters which denote sections in the index. Usually these are all
Dave Love <fx@gnu.org>
parents:
diff changeset
4410 capital letters. Don't use any downcase letters. Order is not
Dave Love <fx@gnu.org>
parents:
diff changeset
4411 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
4412 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
4413 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
4414 lowest specified letter. In the @file{*Index*} buffer, pressing any of
d7f536a01276 Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents: 25829
diff changeset
4415 these capital letters or @kbd{!} will jump to that section.@refill
25829
Dave Love <fx@gnu.org>
parents:
diff changeset
4416 @end defopt
Dave Love <fx@gnu.org>
parents:
diff changeset
4417
Dave Love <fx@gnu.org>
parents:
diff changeset
4418 @defopt reftex-index-include-context
Dave Love <fx@gnu.org>
parents:
diff changeset
4419 Non-@code{nil} means, display the index definition context in the
Dave Love <fx@gnu.org>
parents:
diff changeset
4420 @file{*Index*} buffer. This flag may also be toggled from the
Dave Love <fx@gnu.org>
parents:
diff changeset
4421 @file{*Index*} buffer with the @kbd{c} key.
Dave Love <fx@gnu.org>
parents:
diff changeset
4422 @end defopt
Dave Love <fx@gnu.org>
parents:
diff changeset
4423
Dave Love <fx@gnu.org>
parents:
diff changeset
4424 @defopt reftex-index-follow-mode
Dave Love <fx@gnu.org>
parents:
diff changeset
4425 Non-@code{nil} means, point in @file{*Index*} buffer will cause other
Dave Love <fx@gnu.org>
parents:
diff changeset
4426 window to follow. The other window will show the corresponding part of
Dave Love <fx@gnu.org>
parents:
diff changeset
4427 the document. This flag can be toggled from within the @file{*Index*}
Dave Love <fx@gnu.org>
parents:
diff changeset
4428 buffer with the @kbd{f} key.
Dave Love <fx@gnu.org>
parents:
diff changeset
4429 @end defopt
Dave Love <fx@gnu.org>
parents:
diff changeset
4430
Dave Love <fx@gnu.org>
parents:
diff changeset
4431 @deffn Keymap reftex-index-map
Dave Love <fx@gnu.org>
parents:
diff changeset
4432 The keymap which is active in the @file{*Index*} buffer
Dave Love <fx@gnu.org>
parents:
diff changeset
4433 (@pxref{Index Support}).@refill
Dave Love <fx@gnu.org>
parents:
diff changeset
4434 @end deffn
Dave Love <fx@gnu.org>
parents:
diff changeset
4435
Dave Love <fx@gnu.org>
parents:
diff changeset
4436 @node Options (Viewing Cross-References), Options (Finding Files), Options (Index Support), Options
Dave Love <fx@gnu.org>
parents:
diff changeset
4437 @section Viewing Cross-References
Dave Love <fx@gnu.org>
parents:
diff changeset
4438 @cindex Options, viewing cross-references
Dave Love <fx@gnu.org>
parents:
diff changeset
4439 @cindex Viewing cross-references, options
Dave Love <fx@gnu.org>
parents:
diff changeset
4440
Dave Love <fx@gnu.org>
parents:
diff changeset
4441 @defopt reftex-view-crossref-extra
Dave Love <fx@gnu.org>
parents:
diff changeset
4442 Macros which can be used for the display of cross references.
Dave Love <fx@gnu.org>
parents:
diff changeset
4443 This is used when `reftex-view-crossref' is called with point in an
Dave Love <fx@gnu.org>
parents:
diff changeset
4444 argument of a macro. Note that crossref viewing for citations,
Dave Love <fx@gnu.org>
parents:
diff changeset
4445 references (both ways) and index entries is hard-coded. This variable
Dave Love <fx@gnu.org>
parents:
diff changeset
4446 is only to configure additional structures for which crossreference
Dave Love <fx@gnu.org>
parents:
diff changeset
4447 viewing can be useful. Each entry has the structure
Dave Love <fx@gnu.org>
parents:
diff changeset
4448 @example
Dave Love <fx@gnu.org>
parents:
diff changeset
4449 (@var{macro-re} @var{search-re} @var{highlight}).
Dave Love <fx@gnu.org>
parents:
diff changeset
4450 @end example
Dave Love <fx@gnu.org>
parents:
diff changeset
4451 @var{macro-re} is matched against the macro. @var{search-re} is the
Dave Love <fx@gnu.org>
parents:
diff changeset
4452 regexp used to search for cross references. @samp{%s} in this regexp is
Dave Love <fx@gnu.org>
parents:
diff changeset
4453 replaced with with the macro argument at point. @var{highlight} is an
Dave Love <fx@gnu.org>
parents:
diff changeset
4454 integer indicating which subgroup of the match should be highlighted.
Dave Love <fx@gnu.org>
parents:
diff changeset
4455 @end defopt
Dave Love <fx@gnu.org>
parents:
diff changeset
4456
Dave Love <fx@gnu.org>
parents:
diff changeset
4457 @defopt reftex-auto-view-crossref
Dave Love <fx@gnu.org>
parents:
diff changeset
4458 Non-@code{nil} means, initially turn automatic viewing of crossref info
Dave Love <fx@gnu.org>
parents:
diff changeset
4459 on. Automatic viewing of crossref info normally uses the echo area.
Dave Love <fx@gnu.org>
parents:
diff changeset
4460 Whenever point is on the argument of a @code{\ref} or @code{\cite}
Dave Love <fx@gnu.org>
parents:
diff changeset
4461 macro, and no other message is being displayed, the echo area will
Dave Love <fx@gnu.org>
parents:
diff changeset
4462 display information about that cross reference. You can also set the
Dave Love <fx@gnu.org>
parents:
diff changeset
4463 variable to the symbol @code{window}. In this case a small temporary
Dave Love <fx@gnu.org>
parents:
diff changeset
4464 window is used for the display. This feature can be turned on and of
Dave Love <fx@gnu.org>
parents:
diff changeset
4465 from the menu (Ref->Options).@refill
Dave Love <fx@gnu.org>
parents:
diff changeset
4466 @end defopt
Dave Love <fx@gnu.org>
parents:
diff changeset
4467
Dave Love <fx@gnu.org>
parents:
diff changeset
4468 @defopt reftex-idle-time
Dave Love <fx@gnu.org>
parents:
diff changeset
4469 Time (secs) Emacs has to be idle before automatic crossref display is
Dave Love <fx@gnu.org>
parents:
diff changeset
4470 done.@refill
Dave Love <fx@gnu.org>
parents:
diff changeset
4471 @end defopt
Dave Love <fx@gnu.org>
parents:
diff changeset
4472
Dave Love <fx@gnu.org>
parents:
diff changeset
4473 @defopt reftex-cite-view-format
Dave Love <fx@gnu.org>
parents:
diff changeset
4474 Citation format used to display citation info in the message area. See
Dave Love <fx@gnu.org>
parents:
diff changeset
4475 the variable @code{reftex-cite-format} for possible percent
Dave Love <fx@gnu.org>
parents:
diff changeset
4476 escapes.@refill
Dave Love <fx@gnu.org>
parents:
diff changeset
4477 @end defopt
Dave Love <fx@gnu.org>
parents:
diff changeset
4478
Dave Love <fx@gnu.org>
parents:
diff changeset
4479 @defopt reftex-revisit-to-echo
Dave Love <fx@gnu.org>
parents:
diff changeset
4480 Non-@code{nil} means, automatic citation display will revisit files if
Dave Love <fx@gnu.org>
parents:
diff changeset
4481 necessary. When nil, citation display in echo area will only be active
Dave Love <fx@gnu.org>
parents:
diff changeset
4482 for cached echo strings (see @code{reftex-cache-cite-echo}), or for
Dave Love <fx@gnu.org>
parents:
diff changeset
4483 BibTeX database files which are already visited by a live associated
Dave Love <fx@gnu.org>
parents:
diff changeset
4484 buffers.@refill
Dave Love <fx@gnu.org>
parents:
diff changeset
4485 @end defopt
Dave Love <fx@gnu.org>
parents:
diff changeset
4486
Dave Love <fx@gnu.org>
parents:
diff changeset
4487 @defopt reftex-cache-cite-echo
Dave Love <fx@gnu.org>
parents:
diff changeset
4488 Non-@code{nil} means, the information displayed in the echo area for
Dave Love <fx@gnu.org>
parents:
diff changeset
4489 cite macros (see variable @code{reftex-auto-view-crossref}) is cached and
Dave Love <fx@gnu.org>
parents:
diff changeset
4490 saved along with the parsing information. The cache survives document
Dave Love <fx@gnu.org>
parents:
diff changeset
4491 scans. In order to clear it, use @kbd{M-x reftex-reset-mode}.
Dave Love <fx@gnu.org>
parents:
diff changeset
4492 @end defopt
Dave Love <fx@gnu.org>
parents:
diff changeset
4493
Dave Love <fx@gnu.org>
parents:
diff changeset
4494 @node Options (Finding Files), Options (Optimizations), Options (Viewing Cross-References), Options
Dave Love <fx@gnu.org>
parents:
diff changeset
4495 @section Finding Files
Dave Love <fx@gnu.org>
parents:
diff changeset
4496 @cindex Options, Finding Files
Dave Love <fx@gnu.org>
parents:
diff changeset
4497 @cindex Finding files, options
Dave Love <fx@gnu.org>
parents:
diff changeset
4498
Dave Love <fx@gnu.org>
parents:
diff changeset
4499 @defopt reftex-texpath-environment-variables
Dave Love <fx@gnu.org>
parents:
diff changeset
4500 List of specifications how to retrieve the search path for TeX files.
Dave Love <fx@gnu.org>
parents:
diff changeset
4501 Several entries are possible.@refill
Dave Love <fx@gnu.org>
parents:
diff changeset
4502 @itemize @minus
Dave Love <fx@gnu.org>
parents:
diff changeset
4503 @item
Dave Love <fx@gnu.org>
parents:
diff changeset
4504 If an element is the name of an environment variable, its content is
Dave Love <fx@gnu.org>
parents:
diff changeset
4505 used.@refill
Dave Love <fx@gnu.org>
parents:
diff changeset
4506 @item
Dave Love <fx@gnu.org>
parents:
diff changeset
4507 If an element starts with an exclamation mark, it is used as a command
Dave Love <fx@gnu.org>
parents:
diff changeset
4508 to retrieve the path. A typical command with the kpathsearch library
Dave Love <fx@gnu.org>
parents:
diff changeset
4509 would be @w{@code{"!kpsewhich -show-path=.tex"}}.
Dave Love <fx@gnu.org>
parents:
diff changeset
4510 @item
Dave Love <fx@gnu.org>
parents:
diff changeset
4511 Otherwise the element itself is interpreted as a path.
Dave Love <fx@gnu.org>
parents:
diff changeset
4512 @end itemize
Dave Love <fx@gnu.org>
parents:
diff changeset
4513 Multiple directories can be separated by the system dependent
Dave Love <fx@gnu.org>
parents:
diff changeset
4514 @code{path-separator}. Directories ending in @samp{//} or @samp{!!} will
Dave Love <fx@gnu.org>
parents:
diff changeset
4515 be expanded recursively. See also @code{reftex-use-external-file-finders}.
Dave Love <fx@gnu.org>
parents:
diff changeset
4516 @end defopt
Dave Love <fx@gnu.org>
parents:
diff changeset
4517
Dave Love <fx@gnu.org>
parents:
diff changeset
4518 @defopt reftex-bibpath-environment-variables
Dave Love <fx@gnu.org>
parents:
diff changeset
4519 List of specifications how to retrieve the search path for BibTeX
Dave Love <fx@gnu.org>
parents:
diff changeset
4520 files. Several entries are possible.@refill
Dave Love <fx@gnu.org>
parents:
diff changeset
4521 @itemize @minus
Dave Love <fx@gnu.org>
parents:
diff changeset
4522 @item
Dave Love <fx@gnu.org>
parents:
diff changeset
4523 If an element is the name of an environment variable, its content is
Dave Love <fx@gnu.org>
parents:
diff changeset
4524 used.@refill
Dave Love <fx@gnu.org>
parents:
diff changeset
4525 @item
Dave Love <fx@gnu.org>
parents:
diff changeset
4526 If an element starts with an exclamation mark, it is used as a command
Dave Love <fx@gnu.org>
parents:
diff changeset
4527 to retrieve the path. A typical command with the kpathsearch library
Dave Love <fx@gnu.org>
parents:
diff changeset
4528 would be @w{@code{"!kpsewhich -show-path=.bib"}}.
Dave Love <fx@gnu.org>
parents:
diff changeset
4529 @item
Dave Love <fx@gnu.org>
parents:
diff changeset
4530 Otherwise the element itself is interpreted as a path.
Dave Love <fx@gnu.org>
parents:
diff changeset
4531 @end itemize
Dave Love <fx@gnu.org>
parents:
diff changeset
4532 Multiple directories can be separated by the system dependent
Dave Love <fx@gnu.org>
parents:
diff changeset
4533 @code{path-separator}. Directories ending in @samp{//} or @samp{!!} will
Dave Love <fx@gnu.org>
parents:
diff changeset
4534 be expanded recursively. See also @code{reftex-use-external-file-finders}.
Dave Love <fx@gnu.org>
parents:
diff changeset
4535 @end defopt
Dave Love <fx@gnu.org>
parents:
diff changeset
4536
Dave Love <fx@gnu.org>
parents:
diff changeset
4537 @defopt reftex-file-extensions
Dave Love <fx@gnu.org>
parents:
diff changeset
4538 Association list with file extensions for different file types.
Dave Love <fx@gnu.org>
parents:
diff changeset
4539 This is a list of items, each item is like:
Dave Love <fx@gnu.org>
parents:
diff changeset
4540 @code{(@var{type} . (@var{def-ext} @var{other-ext} ...))}
Dave Love <fx@gnu.org>
parents:
diff changeset
4541 @example
Dave Love <fx@gnu.org>
parents:
diff changeset
4542 @var{type}: @r{File type like @code{"bib"} or @code{"tex"}.}
Dave Love <fx@gnu.org>
parents:
diff changeset
4543 @var{def-ext}: @r{The default extension for that file type, like @code{".tex"} or @code{".bib"}.}
Dave Love <fx@gnu.org>
parents:
diff changeset
4544 @var{other-ext}: @r{Any number of other legal extensions for this file type.}
Dave Love <fx@gnu.org>
parents:
diff changeset
4545 @end example
Dave Love <fx@gnu.org>
parents:
diff changeset
4546 When a files is searched and it does not have any of the legal extensions,
Dave Love <fx@gnu.org>
parents:
diff changeset
4547 we try the default extension first, and then the naked file name.@refill
Dave Love <fx@gnu.org>
parents:
diff changeset
4548 @end defopt
Dave Love <fx@gnu.org>
parents:
diff changeset
4549
Dave Love <fx@gnu.org>
parents:
diff changeset
4550 @defopt reftex-search-unrecursed-path-first
Dave Love <fx@gnu.org>
parents:
diff changeset
4551 Non-@code{nil} means, search all specified directories before trying
Dave Love <fx@gnu.org>
parents:
diff changeset
4552 recursion. Thus, in a path @samp{.//:/tex/}, search first @samp{./},
Dave Love <fx@gnu.org>
parents:
diff changeset
4553 then @samp{/tex/}, and then all subdirectories of @samp{./}. If this
Dave Love <fx@gnu.org>
parents:
diff changeset
4554 option is @code{nil}, the subdirectories of @samp{./} are searched
Dave Love <fx@gnu.org>
parents:
diff changeset
4555 before @samp{/tex/}. This is mainly for speed - most of the time the
Dave Love <fx@gnu.org>
parents:
diff changeset
4556 recursive path is for the system files and not for the user files. Set
Dave Love <fx@gnu.org>
parents:
diff changeset
4557 this to @code{nil} if the default makes @b{Ref@TeX{}} finding files with
Dave Love <fx@gnu.org>
parents:
diff changeset
4558 equal names in wrong sequence.@refill
Dave Love <fx@gnu.org>
parents:
diff changeset
4559 @end defopt
Dave Love <fx@gnu.org>
parents:
diff changeset
4560
Dave Love <fx@gnu.org>
parents:
diff changeset
4561 @defopt reftex-use-external-file-finders
Dave Love <fx@gnu.org>
parents:
diff changeset
4562 Non-@code{nil} means, use external programs to find files. Normally,
Dave Love <fx@gnu.org>
parents:
diff changeset
4563 @b{Ref@TeX{}} searches the paths given in the environment variables
Dave Love <fx@gnu.org>
parents:
diff changeset
4564 @code{TEXINPUTS} and @code{BIBINPUTS} to find TeX files and BibTeX
Dave Love <fx@gnu.org>
parents:
diff changeset
4565 database files. With this option turned on, it calls an external
Dave Love <fx@gnu.org>
parents:
diff changeset
4566 program specified in the option @code{reftex-external-file-finders}
Dave Love <fx@gnu.org>
parents:
diff changeset
4567 instead. As a side effect, the variables
Dave Love <fx@gnu.org>
parents:
diff changeset
4568 @code{reftex-texpath-environment-variables} and
Dave Love <fx@gnu.org>
parents:
diff changeset
4569 @code{reftex-bibpath-environment-variables} will be ignored.
Dave Love <fx@gnu.org>
parents:
diff changeset
4570 @end defopt
Dave Love <fx@gnu.org>
parents:
diff changeset
4571
Dave Love <fx@gnu.org>
parents:
diff changeset
4572 @defopt reftex-external-file-finders
Dave Love <fx@gnu.org>
parents:
diff changeset
4573 Association list with external programs to call for finding files. Each
Dave Love <fx@gnu.org>
parents:
diff changeset
4574 entry is a cons cell @w{@code{(@var{type} . @var{program})}}.
Dave Love <fx@gnu.org>
parents:
diff changeset
4575 @var{type} is either @code{"tex"} or @code{"bib"}. @var{program} is a
Dave Love <fx@gnu.org>
parents:
diff changeset
4576 string containing the external program to use with any arguments.
Dave Love <fx@gnu.org>
parents:
diff changeset
4577 @code{%f} will be replaced by the name of the file to be found. Note
Dave Love <fx@gnu.org>
parents:
diff changeset
4578 that these commands will be executed directly, not via a shell. Only
Dave Love <fx@gnu.org>
parents:
diff changeset
4579 relevant when @code{reftex-use-external-file-finders} is
Dave Love <fx@gnu.org>
parents:
diff changeset
4580 non-@code{nil}.@refill
Dave Love <fx@gnu.org>
parents:
diff changeset
4581 @end defopt
Dave Love <fx@gnu.org>
parents:
diff changeset
4582
Dave Love <fx@gnu.org>
parents:
diff changeset
4583 @page
Dave Love <fx@gnu.org>
parents:
diff changeset
4584 @node Options (Optimizations), Options (Fontification), Options (Finding Files), Options
Dave Love <fx@gnu.org>
parents:
diff changeset
4585 @section Optimizations
Dave Love <fx@gnu.org>
parents:
diff changeset
4586 @cindex Options, optimizations
Dave Love <fx@gnu.org>
parents:
diff changeset
4587 @cindex Optimizations, options
Dave Love <fx@gnu.org>
parents:
diff changeset
4588
Dave Love <fx@gnu.org>
parents:
diff changeset
4589 @defopt reftex-keep-temporary-buffers
Dave Love <fx@gnu.org>
parents:
diff changeset
4590 Non-@code{nil} means, keep buffers created for parsing and lookup.
Dave Love <fx@gnu.org>
parents:
diff changeset
4591 @b{Ref@TeX{}} sometimes needs to visit files related to the current
Dave Love <fx@gnu.org>
parents:
diff changeset
4592 document. We distinguish files visited for@refill
Dave Love <fx@gnu.org>
parents:
diff changeset
4593 @table @asis
Dave Love <fx@gnu.org>
parents:
diff changeset
4594 @item PARSING
Dave Love <fx@gnu.org>
parents:
diff changeset
4595 Parts of a multifile document loaded when (re)-parsing the
Dave Love <fx@gnu.org>
parents:
diff changeset
4596 document.@refill
Dave Love <fx@gnu.org>
parents:
diff changeset
4597 @item LOOKUP
Dave Love <fx@gnu.org>
parents:
diff changeset
4598 BibTeX database files and TeX files loaded to find a reference, to
Dave Love <fx@gnu.org>
parents:
diff changeset
4599 display label context, etc.@refill
Dave Love <fx@gnu.org>
parents:
diff changeset
4600 @end table
Dave Love <fx@gnu.org>
parents:
diff changeset
4601 The created buffers can be kept for later use, or be thrown away
Dave Love <fx@gnu.org>
parents:
diff changeset
4602 immediately after use, depending on the value of this variable:@refill
Dave Love <fx@gnu.org>
parents:
diff changeset
4603
Dave Love <fx@gnu.org>
parents:
diff changeset
4604 @table @code
Dave Love <fx@gnu.org>
parents:
diff changeset
4605 @item nil
Dave Love <fx@gnu.org>
parents:
diff changeset
4606 Throw away as much as possible.
Dave Love <fx@gnu.org>
parents:
diff changeset
4607 @item t
Dave Love <fx@gnu.org>
parents:
diff changeset
4608 Keep everything.
Dave Love <fx@gnu.org>
parents:
diff changeset
4609 @item 1
Dave Love <fx@gnu.org>
parents:
diff changeset
4610 Throw away buffers created for parsing, but keep the ones created for
Dave Love <fx@gnu.org>
parents:
diff changeset
4611 lookup.@refill
Dave Love <fx@gnu.org>
parents:
diff changeset
4612 @end table
Dave Love <fx@gnu.org>
parents:
diff changeset
4613
Dave Love <fx@gnu.org>
parents:
diff changeset
4614 If a buffer is to be kept, the file is visited normally (which is
Dave Love <fx@gnu.org>
parents:
diff changeset
4615 potentially slow but will happen only once). If a buffer is to be thrown
Dave Love <fx@gnu.org>
parents:
diff changeset
4616 away, the initialization of the buffer depends upon the variable
Dave Love <fx@gnu.org>
parents:
diff changeset
4617 @code{reftex-initialize-temporary-buffers}.@refill
Dave Love <fx@gnu.org>
parents:
diff changeset
4618 @end defopt
Dave Love <fx@gnu.org>
parents:
diff changeset
4619
Dave Love <fx@gnu.org>
parents:
diff changeset
4620 @defopt reftex-initialize-temporary-buffers
Dave Love <fx@gnu.org>
parents:
diff changeset
4621 Non-@code{nil} means do initializations even when visiting file
Dave Love <fx@gnu.org>
parents:
diff changeset
4622 temporarily. When @code{nil}, @b{Ref@TeX{}} may turn off find-file hooks and
Dave Love <fx@gnu.org>
parents:
diff changeset
4623 other stuff to briefly visit a file. When @code{t}, the full default
Dave Love <fx@gnu.org>
parents:
diff changeset
4624 initializations are done (@code{find-file-hook} etc.). Instead of
Dave Love <fx@gnu.org>
parents:
diff changeset
4625 @code{t} or @code{nil}, this variable may also be a list of hook
Dave Love <fx@gnu.org>
parents:
diff changeset
4626 functions to do a minimal initialization.@refill
Dave Love <fx@gnu.org>
parents:
diff changeset
4627 @end defopt
Dave Love <fx@gnu.org>
parents:
diff changeset
4628
Dave Love <fx@gnu.org>
parents:
diff changeset
4629 @defopt reftex-no-include-regexps
Dave Love <fx@gnu.org>
parents:
diff changeset
4630 List of regular expressions to exclude certain input files from parsing.
Dave Love <fx@gnu.org>
parents:
diff changeset
4631 If the name of a file included via @code{\include} or @code{\input} is
Dave Love <fx@gnu.org>
parents:
diff changeset
4632 matched by any of the regular expressions in this list, that file is not
Dave Love <fx@gnu.org>
parents:
diff changeset
4633 parsed by @b{Ref@TeX{}}.
Dave Love <fx@gnu.org>
parents:
diff changeset
4634 @end defopt
Dave Love <fx@gnu.org>
parents:
diff changeset
4635
Dave Love <fx@gnu.org>
parents:
diff changeset
4636 @defopt reftex-enable-partial-scans
Dave Love <fx@gnu.org>
parents:
diff changeset
4637 Non-@code{nil} means, re-parse only 1 file when asked to re-parse.
Dave Love <fx@gnu.org>
parents:
diff changeset
4638 Re-parsing is normally requested with a @kbd{C-u} prefix to many @b{Ref@TeX{}}
Dave Love <fx@gnu.org>
parents:
diff changeset
4639 commands, or with the @kbd{r} key in menus. When this option is
Dave Love <fx@gnu.org>
parents:
diff changeset
4640 @code{t} in a multifile document, we will only parse the current buffer,
Dave Love <fx@gnu.org>
parents:
diff changeset
4641 or the file associated with the label or section heading near point in a
Dave Love <fx@gnu.org>
parents:
diff changeset
4642 menu. Requesting re-parsing of an entire multifile document then
Dave Love <fx@gnu.org>
parents:
diff changeset
4643 requires a @kbd{C-u C-u} prefix or the capital @kbd{R} key in
Dave Love <fx@gnu.org>
parents:
diff changeset
4644 menus.@refill
Dave Love <fx@gnu.org>
parents:
diff changeset
4645 @end defopt
Dave Love <fx@gnu.org>
parents:
diff changeset
4646
Dave Love <fx@gnu.org>
parents:
diff changeset
4647 @defopt reftex-save-parse-info
Dave Love <fx@gnu.org>
parents:
diff changeset
4648 Non-@code{nil} means, save information gathered with parsing in files.
Dave Love <fx@gnu.org>
parents:
diff changeset
4649 The file @file{MASTER.rel} in the same directory as @file{MASTER.tex} is
Dave Love <fx@gnu.org>
parents:
diff changeset
4650 used to save the information. When this variable is @code{t},
Dave Love <fx@gnu.org>
parents:
diff changeset
4651 @itemize @minus
Dave Love <fx@gnu.org>
parents:
diff changeset
4652 @item
Dave Love <fx@gnu.org>
parents:
diff changeset
4653 accessing the parsing information for the first time in an editing
Dave Love <fx@gnu.org>
parents:
diff changeset
4654 session will read that file (if available) instead of parsing the
Dave Love <fx@gnu.org>
parents:
diff changeset
4655 document.@refill
Dave Love <fx@gnu.org>
parents:
diff changeset
4656 @item
Dave Love <fx@gnu.org>
parents:
diff changeset
4657 exiting Emacs or killing a buffer in reftex-mode will cause a new
Dave Love <fx@gnu.org>
parents:
diff changeset
4658 version of the file to be written.@refill
Dave Love <fx@gnu.org>
parents:
diff changeset
4659 @end itemize
Dave Love <fx@gnu.org>
parents:
diff changeset
4660 @end defopt
Dave Love <fx@gnu.org>
parents:
diff changeset
4661
27195
d7311a9cb223 version 4.10
Carsten Dominik <dominik@science.uva.nl>
parents: 26911
diff changeset
4662 @defopt reftex-parse-file-extension
d7311a9cb223 version 4.10
Carsten Dominik <dominik@science.uva.nl>
parents: 26911
diff changeset
4663 File extension for the file in which parser information is stored.
d7311a9cb223 version 4.10
Carsten Dominik <dominik@science.uva.nl>
parents: 26911
diff changeset
4664 This extension is added to the base name of the master file.
d7311a9cb223 version 4.10
Carsten Dominik <dominik@science.uva.nl>
parents: 26911
diff changeset
4665 @end defopt
d7311a9cb223 version 4.10
Carsten Dominik <dominik@science.uva.nl>
parents: 26911
diff changeset
4666
25829
Dave Love <fx@gnu.org>
parents:
diff changeset
4667 @defopt reftex-allow-automatic-rescan
Dave Love <fx@gnu.org>
parents:
diff changeset
4668 Non-@code{nil} means, @b{Ref@TeX{}} may rescan the document when this seems
Dave Love <fx@gnu.org>
parents:
diff changeset
4669 necessary. Applies (currently) only in rare cases, when a new label
Dave Love <fx@gnu.org>
parents:
diff changeset
4670 cannot be placed with certainty into the internal label list.
Dave Love <fx@gnu.org>
parents:
diff changeset
4671 @end defopt
Dave Love <fx@gnu.org>
parents:
diff changeset
4672
Dave Love <fx@gnu.org>
parents:
diff changeset
4673 @defopt reftex-use-multiple-selection-buffers
Dave Love <fx@gnu.org>
parents:
diff changeset
4674 Non-@code{nil} means use a separate selection buffer for each label
Dave Love <fx@gnu.org>
parents:
diff changeset
4675 type. These buffers are kept from one selection to the next and need
Dave Love <fx@gnu.org>
parents:
diff changeset
4676 not to be created for each use - so the menu generally comes up faster.
Dave Love <fx@gnu.org>
parents:
diff changeset
4677 The selection buffers will be erased (and therefore updated)
Dave Love <fx@gnu.org>
parents:
diff changeset
4678 automatically when new labels in its category are added. See the
Dave Love <fx@gnu.org>
parents:
diff changeset
4679 variable @code{reftex-auto-update-selection-buffers}.@refill
Dave Love <fx@gnu.org>
parents:
diff changeset
4680 @end defopt
Dave Love <fx@gnu.org>
parents:
diff changeset
4681
Dave Love <fx@gnu.org>
parents:
diff changeset
4682 @defopt reftex-auto-update-selection-buffers
Dave Love <fx@gnu.org>
parents:
diff changeset
4683 Non-@code{nil} means, selection buffers will be updated automatically.
Dave Love <fx@gnu.org>
parents:
diff changeset
4684 When a new label is defined with @code{reftex-label}, all selection
Dave Love <fx@gnu.org>
parents:
diff changeset
4685 buffers associated with that label category are emptied, in order to
Dave Love <fx@gnu.org>
parents:
diff changeset
4686 force an update upon next use. When @code{nil}, the buffers are left
Dave Love <fx@gnu.org>
parents:
diff changeset
4687 alone and have to be updated by hand, with the @kbd{g} key from the
Dave Love <fx@gnu.org>
parents:
diff changeset
4688 label selection process. The value of this variable will only have any
Dave Love <fx@gnu.org>
parents:
diff changeset
4689 effect when @code{reftex-use-multiple-selection-buffers} is
Dave Love <fx@gnu.org>
parents:
diff changeset
4690 non-@code{nil}.@refill
Dave Love <fx@gnu.org>
parents:
diff changeset
4691 @end defopt
Dave Love <fx@gnu.org>
parents:
diff changeset
4692
Dave Love <fx@gnu.org>
parents:
diff changeset
4693 @node Options (Fontification), Options (Misc), Options (Optimizations), Options
Dave Love <fx@gnu.org>
parents:
diff changeset
4694 @section Fontification
Dave Love <fx@gnu.org>
parents:
diff changeset
4695 @cindex Options, fontification
Dave Love <fx@gnu.org>
parents:
diff changeset
4696 @cindex Fontification, options
Dave Love <fx@gnu.org>
parents:
diff changeset
4697
Dave Love <fx@gnu.org>
parents:
diff changeset
4698 @defopt reftex-use-fonts
Dave Love <fx@gnu.org>
parents:
diff changeset
4699 Non-@code{nil} means, use fonts in label menu and on-the-fly help.
Dave Love <fx@gnu.org>
parents:
diff changeset
4700 Font-lock must be loaded as well to actually get fontified
Dave Love <fx@gnu.org>
parents:
diff changeset
4701 display. After changing this option, a rescan may be necessary to
Dave Love <fx@gnu.org>
parents:
diff changeset
4702 activate it.@refill
Dave Love <fx@gnu.org>
parents:
diff changeset
4703 @end defopt
Dave Love <fx@gnu.org>
parents:
diff changeset
4704
Dave Love <fx@gnu.org>
parents:
diff changeset
4705 @defopt reftex-refontify-context
Dave Love <fx@gnu.org>
parents:
diff changeset
4706 Non-@code{nil} means, re-fontify the context in the label menu with
Dave Love <fx@gnu.org>
parents:
diff changeset
4707 font-lock. This slightly slows down the creation of the label menu. It
Dave Love <fx@gnu.org>
parents:
diff changeset
4708 is only necessary when you definitely want the context fontified.@refill
Dave Love <fx@gnu.org>
parents:
diff changeset
4709
Dave Love <fx@gnu.org>
parents:
diff changeset
4710 This option may have 3 different values:
Dave Love <fx@gnu.org>
parents:
diff changeset
4711 @table @code
Dave Love <fx@gnu.org>
parents:
diff changeset
4712 @item nil
Dave Love <fx@gnu.org>
parents:
diff changeset
4713 Never refontify.
Dave Love <fx@gnu.org>
parents:
diff changeset
4714 @item t
Dave Love <fx@gnu.org>
parents:
diff changeset
4715 Always refontify.
Dave Love <fx@gnu.org>
parents:
diff changeset
4716 @item 1
Dave Love <fx@gnu.org>
parents:
diff changeset
4717 Refontify when necessary, e.g. with old versions of the x-symbol
Dave Love <fx@gnu.org>
parents:
diff changeset
4718 package.@refill
Dave Love <fx@gnu.org>
parents:
diff changeset
4719 @end table
Dave Love <fx@gnu.org>
parents:
diff changeset
4720 The option is ignored when @code{reftex-use-fonts} is @code{nil}.@refill
Dave Love <fx@gnu.org>
parents:
diff changeset
4721 @end defopt
Dave Love <fx@gnu.org>
parents:
diff changeset
4722
Dave Love <fx@gnu.org>
parents:
diff changeset
4723 @defopt reftex-highlight-selection
Dave Love <fx@gnu.org>
parents:
diff changeset
4724 Non-@code{nil} means, highlight selected text in selection and
Dave Love <fx@gnu.org>
parents:
diff changeset
4725 @file{*toc*} buffers. Normally, the text near the cursor is the
Dave Love <fx@gnu.org>
parents:
diff changeset
4726 @emph{selected} text, and it is highlighted. This is the entry most
Dave Love <fx@gnu.org>
parents:
diff changeset
4727 keys in the selection and @file{*toc*} buffers act on. However, if you
Dave Love <fx@gnu.org>
parents:
diff changeset
4728 mainly use the mouse to select an item, you may find it nice to have
Dave Love <fx@gnu.org>
parents:
diff changeset
4729 mouse-triggered highlighting @emph{instead} or @emph{as well}. The
Dave Love <fx@gnu.org>
parents:
diff changeset
4730 variable may have one of these values:@refill
Dave Love <fx@gnu.org>
parents:
diff changeset
4731
Dave Love <fx@gnu.org>
parents:
diff changeset
4732 @example
Dave Love <fx@gnu.org>
parents:
diff changeset
4733 nil @r{No highlighting.}
Dave Love <fx@gnu.org>
parents:
diff changeset
4734 cursor @r{Highlighting is cursor driven.}
Dave Love <fx@gnu.org>
parents:
diff changeset
4735 mouse @r{Highlighting is mouse driven.}
Dave Love <fx@gnu.org>
parents:
diff changeset
4736 both @r{Both cursor and mouse trigger highlighting.}
Dave Love <fx@gnu.org>
parents:
diff changeset
4737 @end example
Dave Love <fx@gnu.org>
parents:
diff changeset
4738
Dave Love <fx@gnu.org>
parents:
diff changeset
4739 Changing this variable requires to rebuild the selection and *toc*
Dave Love <fx@gnu.org>
parents:
diff changeset
4740 buffers to become effective (keys @kbd{g} or @kbd{r}).@refill
Dave Love <fx@gnu.org>
parents:
diff changeset
4741 @end defopt
Dave Love <fx@gnu.org>
parents:
diff changeset
4742
Dave Love <fx@gnu.org>
parents:
diff changeset
4743 @defopt reftex-cursor-selected-face
Dave Love <fx@gnu.org>
parents:
diff changeset
4744 Face name to highlight cursor selected item in toc and selection buffers.
Dave Love <fx@gnu.org>
parents:
diff changeset
4745 See also the variable @code{reftex-highlight-selection}.@refill
Dave Love <fx@gnu.org>
parents:
diff changeset
4746 @end defopt
Dave Love <fx@gnu.org>
parents:
diff changeset
4747 @defopt reftex-mouse-selected-face
Dave Love <fx@gnu.org>
parents:
diff changeset
4748 Face name to highlight mouse selected item in toc and selection buffers.
Dave Love <fx@gnu.org>
parents:
diff changeset
4749 See also the variable @code{reftex-highlight-selection}.@refill
Dave Love <fx@gnu.org>
parents:
diff changeset
4750 @end defopt
Dave Love <fx@gnu.org>
parents:
diff changeset
4751 @defopt reftex-file-boundary-face
Dave Love <fx@gnu.org>
parents:
diff changeset
4752 Face name for file boundaries in selection buffer.
Dave Love <fx@gnu.org>
parents:
diff changeset
4753 @end defopt
Dave Love <fx@gnu.org>
parents:
diff changeset
4754 @defopt reftex-label-face
Dave Love <fx@gnu.org>
parents:
diff changeset
4755 Face name for labels in selection buffer.
Dave Love <fx@gnu.org>
parents:
diff changeset
4756 @end defopt
Dave Love <fx@gnu.org>
parents:
diff changeset
4757 @defopt reftex-section-heading-face
Dave Love <fx@gnu.org>
parents:
diff changeset
4758 Face name for section headings in toc and selection buffers.
Dave Love <fx@gnu.org>
parents:
diff changeset
4759 @end defopt
Dave Love <fx@gnu.org>
parents:
diff changeset
4760 @defopt reftex-toc-header-face
Dave Love <fx@gnu.org>
parents:
diff changeset
4761 Face name for the header of a toc buffer.
Dave Love <fx@gnu.org>
parents:
diff changeset
4762 @end defopt
Dave Love <fx@gnu.org>
parents:
diff changeset
4763 @defopt reftex-bib-author-face
Dave Love <fx@gnu.org>
parents:
diff changeset
4764 Face name for author names in bib selection buffer.
Dave Love <fx@gnu.org>
parents:
diff changeset
4765 @end defopt
Dave Love <fx@gnu.org>
parents:
diff changeset
4766 @defopt reftex-bib-year-face
Dave Love <fx@gnu.org>
parents:
diff changeset
4767 Face name for year in bib selection buffer.
Dave Love <fx@gnu.org>
parents:
diff changeset
4768 @end defopt
Dave Love <fx@gnu.org>
parents:
diff changeset
4769 @defopt reftex-bib-title-face
Dave Love <fx@gnu.org>
parents:
diff changeset
4770 Face name for article title in bib selection buffer.
Dave Love <fx@gnu.org>
parents:
diff changeset
4771 @end defopt
Dave Love <fx@gnu.org>
parents:
diff changeset
4772 @defopt reftex-bib-extra-face
Dave Love <fx@gnu.org>
parents:
diff changeset
4773 Face name for bibliographic information in bib selection buffer.
Dave Love <fx@gnu.org>
parents:
diff changeset
4774 @end defopt
Dave Love <fx@gnu.org>
parents:
diff changeset
4775 @defopt reftex-select-mark-face
Dave Love <fx@gnu.org>
parents:
diff changeset
4776 Face name for marked entries in the selection buffers.
Dave Love <fx@gnu.org>
parents:
diff changeset
4777 @end defopt
Dave Love <fx@gnu.org>
parents:
diff changeset
4778 @defopt reftex-index-header-face
Dave Love <fx@gnu.org>
parents:
diff changeset
4779 Face name for the header of an index buffer.
Dave Love <fx@gnu.org>
parents:
diff changeset
4780 @end defopt
Dave Love <fx@gnu.org>
parents:
diff changeset
4781 @defopt reftex-index-section-face
Dave Love <fx@gnu.org>
parents:
diff changeset
4782 Face name for the start of a new letter section in the index.
Dave Love <fx@gnu.org>
parents:
diff changeset
4783 @end defopt
Dave Love <fx@gnu.org>
parents:
diff changeset
4784 @defopt reftex-index-tag-face
Dave Love <fx@gnu.org>
parents:
diff changeset
4785 Face name for index names (for multiple indices).
Dave Love <fx@gnu.org>
parents:
diff changeset
4786 @end defopt
Dave Love <fx@gnu.org>
parents:
diff changeset
4787 @defopt reftex-index-face
Dave Love <fx@gnu.org>
parents:
diff changeset
4788 Face name for index entries.
Dave Love <fx@gnu.org>
parents:
diff changeset
4789 @end defopt
Dave Love <fx@gnu.org>
parents:
diff changeset
4790
Dave Love <fx@gnu.org>
parents:
diff changeset
4791 @node Options (Misc), , Options (Fontification), Options
Dave Love <fx@gnu.org>
parents:
diff changeset
4792 @section Miscellaneous
Dave Love <fx@gnu.org>
parents:
diff changeset
4793 @cindex Options, misc
Dave Love <fx@gnu.org>
parents:
diff changeset
4794
Dave Love <fx@gnu.org>
parents:
diff changeset
4795 @defopt reftex-extra-bindings
Dave Love <fx@gnu.org>
parents:
diff changeset
4796 Non-@code{nil} means, make additional key bindings on startup. These
Dave Love <fx@gnu.org>
parents:
diff changeset
4797 extra bindings are located in the users @samp{C-c letter}
Dave Love <fx@gnu.org>
parents:
diff changeset
4798 map. @xref{Keybindings}.@refill
Dave Love <fx@gnu.org>
parents:
diff changeset
4799 @end defopt
Dave Love <fx@gnu.org>
parents:
diff changeset
4800
Dave Love <fx@gnu.org>
parents:
diff changeset
4801 @defopt reftex-plug-into-AUCTeX
Dave Love <fx@gnu.org>
parents:
diff changeset
4802 Plug-in flags for AUCTeX interface. This variable is a list of
Dave Love <fx@gnu.org>
parents:
diff changeset
4803 5 boolean flags. When a flag is non-@code{nil}, @b{Ref@TeX{}}
Dave Love <fx@gnu.org>
parents:
diff changeset
4804 will@refill
Dave Love <fx@gnu.org>
parents:
diff changeset
4805
Dave Love <fx@gnu.org>
parents:
diff changeset
4806 @example
Dave Love <fx@gnu.org>
parents:
diff changeset
4807 - supply labels in new sections and environments (flag 1)
Dave Love <fx@gnu.org>
parents:
diff changeset
4808 - supply arguments for macros like @code{\label} (flag 2)
Dave Love <fx@gnu.org>
parents:
diff changeset
4809 - supply arguments for macros like @code{\ref} (flag 3)
Dave Love <fx@gnu.org>
parents:
diff changeset
4810 - supply arguments for macros like @code{\cite} (flag 4)
Dave Love <fx@gnu.org>
parents:
diff changeset
4811 - supply arguments for macros like @code{\index} (flag 5)
Dave Love <fx@gnu.org>
parents:
diff changeset
4812 @end example
Dave Love <fx@gnu.org>
parents:
diff changeset
4813
Dave Love <fx@gnu.org>
parents:
diff changeset
4814 You may also set the variable itself to t or nil in order to turn all
Dave Love <fx@gnu.org>
parents:
diff changeset
4815 options on or off, respectively.@*
Dave Love <fx@gnu.org>
parents:
diff changeset
4816 Supplying labels in new sections and environments applies when creating
Dave Love <fx@gnu.org>
parents:
diff changeset
4817 sections with @kbd{C-c C-s} and environments with @kbd{C-c C-e}.@*
Dave Love <fx@gnu.org>
parents:
diff changeset
4818 Supplying macro arguments applies when you insert such a macro
Dave Love <fx@gnu.org>
parents:
diff changeset
4819 interactively with @kbd{C-c @key{RET}}.@*
Dave Love <fx@gnu.org>
parents:
diff changeset
4820 See the AUCTeX documentation for more information.
Dave Love <fx@gnu.org>
parents:
diff changeset
4821 @end defopt
Dave Love <fx@gnu.org>
parents:
diff changeset
4822
Dave Love <fx@gnu.org>
parents:
diff changeset
4823 @defopt reftex-revisit-to-follow
Dave Love <fx@gnu.org>
parents:
diff changeset
4824 Non-@code{nil} means, follow-mode will revisit files if necessary.
Dave Love <fx@gnu.org>
parents:
diff changeset
4825 When nil, follow-mode will be suspended for stuff in unvisited files.
Dave Love <fx@gnu.org>
parents:
diff changeset
4826 @end defopt
Dave Love <fx@gnu.org>
parents:
diff changeset
4827
Dave Love <fx@gnu.org>
parents:
diff changeset
4828 @defopt reftex-allow-detached-macro-args
Dave Love <fx@gnu.org>
parents:
diff changeset
4829 Non-@code{nil} means, allow arguments of macros to be detached by
Dave Love <fx@gnu.org>
parents:
diff changeset
4830 whitespace. When this is @code{t}, the @samp{aaa} in @w{@samp{\bbb
Dave Love <fx@gnu.org>
parents:
diff changeset
4831 [xxx] @{aaa@}}} will be considered an argument of @code{\bb}. Note that
Dave Love <fx@gnu.org>
parents:
diff changeset
4832 this will be the case even if @code{\bb} is defined with zero or one
Dave Love <fx@gnu.org>
parents:
diff changeset
4833 argument.@refill
Dave Love <fx@gnu.org>
parents:
diff changeset
4834 @end defopt
Dave Love <fx@gnu.org>
parents:
diff changeset
4835
Dave Love <fx@gnu.org>
parents:
diff changeset
4836 @node Keymaps and Hooks, Changes, Options, Top
Dave Love <fx@gnu.org>
parents:
diff changeset
4837 @section Keymaps and Hooks
Dave Love <fx@gnu.org>
parents:
diff changeset
4838 @cindex Keymaps
Dave Love <fx@gnu.org>
parents:
diff changeset
4839
Dave Love <fx@gnu.org>
parents:
diff changeset
4840 @b{Ref@TeX{}} has the usual general keymap and load-- and mode-hook.
Dave Love <fx@gnu.org>
parents:
diff changeset
4841
Dave Love <fx@gnu.org>
parents:
diff changeset
4842 @deffn Keymap reftex-mode-map
Dave Love <fx@gnu.org>
parents:
diff changeset
4843 The keymap for @b{Ref@TeX{}} mode.
Dave Love <fx@gnu.org>
parents:
diff changeset
4844 @end deffn
Dave Love <fx@gnu.org>
parents:
diff changeset
4845
Dave Love <fx@gnu.org>
parents:
diff changeset
4846 @deffn {Normal Hook} reftex-load-hook
Dave Love <fx@gnu.org>
parents:
diff changeset
4847 Normal hook which is being run when loading @file{reftex.el}.
Dave Love <fx@gnu.org>
parents:
diff changeset
4848 @end deffn
Dave Love <fx@gnu.org>
parents:
diff changeset
4849
Dave Love <fx@gnu.org>
parents:
diff changeset
4850 @deffn {Normal Hook} reftex-mode-hook
Dave Love <fx@gnu.org>
parents:
diff changeset
4851 Normal hook which is being run when turning on @b{Ref@TeX{}} mode.@refill
Dave Love <fx@gnu.org>
parents:
diff changeset
4852 @end deffn
Dave Love <fx@gnu.org>
parents:
diff changeset
4853
26911
d7f536a01276 Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents: 25829
diff changeset
4854 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
4855 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
4856 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
4857 are many more hooks which are described in the relevant sections about
d7f536a01276 Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents: 25829
diff changeset
4858 options for a specific part of @b{Ref@TeX{}}.@refill
25829
Dave Love <fx@gnu.org>
parents:
diff changeset
4859
Dave Love <fx@gnu.org>
parents:
diff changeset
4860 @node Changes, , Keymaps and Hooks, Top
Dave Love <fx@gnu.org>
parents:
diff changeset
4861 @chapter Changes
Dave Love <fx@gnu.org>
parents:
diff changeset
4862 @cindex Changes
Dave Love <fx@gnu.org>
parents:
diff changeset
4863
Dave Love <fx@gnu.org>
parents:
diff changeset
4864 Here is a list of recent changes to @b{Ref@TeX{}}.
Dave Love <fx@gnu.org>
parents:
diff changeset
4865
Dave Love <fx@gnu.org>
parents:
diff changeset
4866 @ignore
Dave Love <fx@gnu.org>
parents:
diff changeset
4867 @noindent @b{Version 1.00}
Dave Love <fx@gnu.org>
parents:
diff changeset
4868 @itemize @bullet
Dave Love <fx@gnu.org>
parents:
diff changeset
4869 @item
Dave Love <fx@gnu.org>
parents:
diff changeset
4870 released on 7 Jan 1997.
Dave Love <fx@gnu.org>
parents:
diff changeset
4871 @end itemize
Dave Love <fx@gnu.org>
parents:
diff changeset
4872
Dave Love <fx@gnu.org>
parents:
diff changeset
4873 @noindent @b{Version 1.04}
Dave Love <fx@gnu.org>
parents:
diff changeset
4874 @itemize @bullet
Dave Love <fx@gnu.org>
parents:
diff changeset
4875 @item
Dave Love <fx@gnu.org>
parents:
diff changeset
4876 Macros as wrappers, AMSTeX support, delayed context parsing for
Dave Love <fx@gnu.org>
parents:
diff changeset
4877 new labels.@refill
Dave Love <fx@gnu.org>
parents:
diff changeset
4878 @end itemize
Dave Love <fx@gnu.org>
parents:
diff changeset
4879
Dave Love <fx@gnu.org>
parents:
diff changeset
4880 @noindent @b{Version 1.05}
Dave Love <fx@gnu.org>
parents:
diff changeset
4881 @itemize @bullet
Dave Love <fx@gnu.org>
parents:
diff changeset
4882 @item
Dave Love <fx@gnu.org>
parents:
diff changeset
4883 XEmacs port.
Dave Love <fx@gnu.org>
parents:
diff changeset
4884 @end itemize
Dave Love <fx@gnu.org>
parents:
diff changeset
4885
Dave Love <fx@gnu.org>
parents:
diff changeset
4886 @noindent @b{Version 1.07}
Dave Love <fx@gnu.org>
parents:
diff changeset
4887 @itemize @bullet
Dave Love <fx@gnu.org>
parents:
diff changeset
4888 @item
Dave Love <fx@gnu.org>
parents:
diff changeset
4889 @b{Ref@TeX{}} gets its own menu.
Dave Love <fx@gnu.org>
parents:
diff changeset
4890 @end itemize
Dave Love <fx@gnu.org>
parents:
diff changeset
4891
Dave Love <fx@gnu.org>
parents:
diff changeset
4892 @noindent @b{Version 1.09}
Dave Love <fx@gnu.org>
parents:
diff changeset
4893 @itemize @bullet
Dave Love <fx@gnu.org>
parents:
diff changeset
4894 @item
Dave Love <fx@gnu.org>
parents:
diff changeset
4895 Support for @code{tex-main-file}, an analogue for
Dave Love <fx@gnu.org>
parents:
diff changeset
4896 @code{TeX-master}.@refill
Dave Love <fx@gnu.org>
parents:
diff changeset
4897 @item
Dave Love <fx@gnu.org>
parents:
diff changeset
4898 MS-DOS support.
Dave Love <fx@gnu.org>
parents:
diff changeset
4899 @end itemize
Dave Love <fx@gnu.org>
parents:
diff changeset
4900
Dave Love <fx@gnu.org>
parents:
diff changeset
4901 @noindent @b{Version 2.00}
Dave Love <fx@gnu.org>
parents:
diff changeset
4902 @itemize @bullet
Dave Love <fx@gnu.org>
parents:
diff changeset
4903 @item
Dave Love <fx@gnu.org>
parents:
diff changeset
4904 Labels can be derived from context (default for sections).
Dave Love <fx@gnu.org>
parents:
diff changeset
4905 @item
Dave Love <fx@gnu.org>
parents:
diff changeset
4906 Configuration of label insertion and label referencing revised.
Dave Love <fx@gnu.org>
parents:
diff changeset
4907 @item
Dave Love <fx@gnu.org>
parents:
diff changeset
4908 Crossref fields in BibTeX database entries.
Dave Love <fx@gnu.org>
parents:
diff changeset
4909 @item
Dave Love <fx@gnu.org>
parents:
diff changeset
4910 @code{reftex-toc} introduced (thanks to Stephen Eglen).
Dave Love <fx@gnu.org>
parents:
diff changeset
4911 @end itemize
Dave Love <fx@gnu.org>
parents:
diff changeset
4912
Dave Love <fx@gnu.org>
parents:
diff changeset
4913 @noindent @b{Version 2.03}
Dave Love <fx@gnu.org>
parents:
diff changeset
4914 @itemize @bullet
Dave Love <fx@gnu.org>
parents:
diff changeset
4915 @item
Dave Love <fx@gnu.org>
parents:
diff changeset
4916 @code{figure*}, @code{table*}, @code{sidewaysfigure/table} added to
Dave Love <fx@gnu.org>
parents:
diff changeset
4917 default environments.@refill
Dave Love <fx@gnu.org>
parents:
diff changeset
4918 @item
Dave Love <fx@gnu.org>
parents:
diff changeset
4919 @code{reftex-bibfile-ignore-list} introduced (thanks to Rory Molinari).
Dave Love <fx@gnu.org>
parents:
diff changeset
4920 @item
Dave Love <fx@gnu.org>
parents:
diff changeset
4921 New functions @code{reftex-arg-label}, @code{reftex-arg-ref},
Dave Love <fx@gnu.org>
parents:
diff changeset
4922 @code{reftex-arg-cite}.@refill
Dave Love <fx@gnu.org>
parents:
diff changeset
4923 @item
Dave Love <fx@gnu.org>
parents:
diff changeset
4924 Emacs/XEmacs compatibility reworked. XEmacs 19.15 now is
Dave Love <fx@gnu.org>
parents:
diff changeset
4925 required.@refill
Dave Love <fx@gnu.org>
parents:
diff changeset
4926 @item
Dave Love <fx@gnu.org>
parents:
diff changeset
4927 @code{reftex-add-to-label-alist} (to be called from AUCTeX style
Dave Love <fx@gnu.org>
parents:
diff changeset
4928 files).@refill
Dave Love <fx@gnu.org>
parents:
diff changeset
4929 @item
Dave Love <fx@gnu.org>
parents:
diff changeset
4930 Finding context with a hook function.
Dave Love <fx@gnu.org>
parents:
diff changeset
4931 @item
Dave Love <fx@gnu.org>
parents:
diff changeset
4932 Sorting BibTeX entries (new variable:
Dave Love <fx@gnu.org>
parents:
diff changeset
4933 @code{reftex-sort-bibtex-matches}).
Dave Love <fx@gnu.org>
parents:
diff changeset
4934 @end itemize
Dave Love <fx@gnu.org>
parents:
diff changeset
4935
Dave Love <fx@gnu.org>
parents:
diff changeset
4936 @noindent @b{Version 2.05}
Dave Love <fx@gnu.org>
parents:
diff changeset
4937 @itemize @bullet
Dave Love <fx@gnu.org>
parents:
diff changeset
4938 @item
Dave Love <fx@gnu.org>
parents:
diff changeset
4939 Support for @file{custom.el}.
Dave Love <fx@gnu.org>
parents:
diff changeset
4940 @item
Dave Love <fx@gnu.org>
parents:
diff changeset
4941 New function @code{reftex-grep-document} (thanks to Stephen Eglen).
Dave Love <fx@gnu.org>
parents:
diff changeset
4942 @end itemize
Dave Love <fx@gnu.org>
parents:
diff changeset
4943
Dave Love <fx@gnu.org>
parents:
diff changeset
4944 @noindent @b{Version 2.07}
Dave Love <fx@gnu.org>
parents:
diff changeset
4945 @itemize @bullet
Dave Love <fx@gnu.org>
parents:
diff changeset
4946 @item
Dave Love <fx@gnu.org>
parents:
diff changeset
4947 New functions @code{reftex-search-document},
Dave Love <fx@gnu.org>
parents:
diff changeset
4948 @code{reftex-query-replace-document}.
Dave Love <fx@gnu.org>
parents:
diff changeset
4949 @end itemize
Dave Love <fx@gnu.org>
parents:
diff changeset
4950
Dave Love <fx@gnu.org>
parents:
diff changeset
4951 @noindent @b{Version 2.11}
Dave Love <fx@gnu.org>
parents:
diff changeset
4952 @itemize @bullet
Dave Love <fx@gnu.org>
parents:
diff changeset
4953 @item
Dave Love <fx@gnu.org>
parents:
diff changeset
4954 Submitted for inclusion to Emacs and XEmacs.
Dave Love <fx@gnu.org>
parents:
diff changeset
4955 @end itemize
Dave Love <fx@gnu.org>
parents:
diff changeset
4956
Dave Love <fx@gnu.org>
parents:
diff changeset
4957 @noindent @b{Version 2.14}
Dave Love <fx@gnu.org>
parents:
diff changeset
4958 @itemize @bullet
Dave Love <fx@gnu.org>
parents:
diff changeset
4959 @item
Dave Love <fx@gnu.org>
parents:
diff changeset
4960 Variable @code{reftex-plug-into-AUCTeX} simplifies cooperation with
Dave Love <fx@gnu.org>
parents:
diff changeset
4961 AUCTeX.@refill
Dave Love <fx@gnu.org>
parents:
diff changeset
4962 @end itemize
Dave Love <fx@gnu.org>
parents:
diff changeset
4963
Dave Love <fx@gnu.org>
parents:
diff changeset
4964 @noindent @b{Version 2.17}
Dave Love <fx@gnu.org>
parents:
diff changeset
4965 @itemize @bullet
Dave Love <fx@gnu.org>
parents:
diff changeset
4966 @item
Dave Love <fx@gnu.org>
parents:
diff changeset
4967 Label prefix expands % escapes with current file name and other stuff.
Dave Love <fx@gnu.org>
parents:
diff changeset
4968 @item
Dave Love <fx@gnu.org>
parents:
diff changeset
4969 Citation format now with % escapes. This is not backward
Dave Love <fx@gnu.org>
parents:
diff changeset
4970 compatible!@refill
Dave Love <fx@gnu.org>
parents:
diff changeset
4971 @item
Dave Love <fx@gnu.org>
parents:
diff changeset
4972 TEXINPUTS variable recognized when looking for input files.
Dave Love <fx@gnu.org>
parents:
diff changeset
4973 @item
Dave Love <fx@gnu.org>
parents:
diff changeset
4974 Context can be the nth argument of a macro.@refill
Dave Love <fx@gnu.org>
parents:
diff changeset
4975 @item
Dave Love <fx@gnu.org>
parents:
diff changeset
4976 Searching in the select buffer is now possible (@kbd{C-s} and
Dave Love <fx@gnu.org>
parents:
diff changeset
4977 @kbd{C-r}).@refill
Dave Love <fx@gnu.org>
parents:
diff changeset
4978 @item
Dave Love <fx@gnu.org>
parents:
diff changeset
4979 Display and derive-label can use two different context methods.
Dave Love <fx@gnu.org>
parents:
diff changeset
4980 @item
Dave Love <fx@gnu.org>
parents:
diff changeset
4981 AMSmath @code{xalignat} and @code{xxalignat} added.
Dave Love <fx@gnu.org>
parents:
diff changeset
4982 @end itemize
Dave Love <fx@gnu.org>
parents:
diff changeset
4983
Dave Love <fx@gnu.org>
parents:
diff changeset
4984 @noindent @b{Version 3.00}
Dave Love <fx@gnu.org>
parents:
diff changeset
4985 @itemize @bullet
Dave Love <fx@gnu.org>
parents:
diff changeset
4986 @item
Dave Love <fx@gnu.org>
parents:
diff changeset
4987 @b{Ref@TeX{}} should work better for very large projects:
Dave Love <fx@gnu.org>
parents:
diff changeset
4988 @item
Dave Love <fx@gnu.org>
parents:
diff changeset
4989 The new parser works without creating a master buffer.
Dave Love <fx@gnu.org>
parents:
diff changeset
4990 @item
Dave Love <fx@gnu.org>
parents:
diff changeset
4991 Rescanning can be limited to a part of a multifile document.
Dave Love <fx@gnu.org>
parents:
diff changeset
4992 @item
Dave Love <fx@gnu.org>
parents:
diff changeset
4993 Information from the parser can be stored in a file.
Dave Love <fx@gnu.org>
parents:
diff changeset
4994 @item
Dave Love <fx@gnu.org>
parents:
diff changeset
4995 @b{Ref@TeX{}} can deal with macros having a naked label as an argument.
Dave Love <fx@gnu.org>
parents:
diff changeset
4996 @item
Dave Love <fx@gnu.org>
parents:
diff changeset
4997 Macros may have white space and newlines between arguments.
Dave Love <fx@gnu.org>
parents:
diff changeset
4998 @item
Dave Love <fx@gnu.org>
parents:
diff changeset
4999 Multiple identical section headings no longer confuse
Dave Love <fx@gnu.org>
parents:
diff changeset
5000 @code{reftex-toc}.@refill
Dave Love <fx@gnu.org>
parents:
diff changeset
5001 @item
Dave Love <fx@gnu.org>
parents:
diff changeset
5002 @b{Ref@TeX{}} should work correctly in combination with buffer-altering
Dave Love <fx@gnu.org>
parents:
diff changeset
5003 packages like outline, folding, x-symbol, iso-cvt, isotex, etc.@refill
Dave Love <fx@gnu.org>
parents:
diff changeset
5004 @item
Dave Love <fx@gnu.org>
parents:
diff changeset
5005 All labeled environments discussed in @emph{The LaTeX Companion} by
Dave Love <fx@gnu.org>
parents:
diff changeset
5006 Goossens, Mittelbach & Samarin, Addison-Wesley 1994) are part of
Dave Love <fx@gnu.org>
parents:
diff changeset
5007 @b{Ref@TeX{}}'s defaults.@refill
Dave Love <fx@gnu.org>
parents:
diff changeset
5008 @end itemize
Dave Love <fx@gnu.org>
parents:
diff changeset
5009
Dave Love <fx@gnu.org>
parents:
diff changeset
5010 @noindent @b{Version 3.03}
Dave Love <fx@gnu.org>
parents:
diff changeset
5011 @itemize @bullet
Dave Love <fx@gnu.org>
parents:
diff changeset
5012 @item
Dave Love <fx@gnu.org>
parents:
diff changeset
5013 Support for the LaTeX package @code{xr}, for inter-document
Dave Love <fx@gnu.org>
parents:
diff changeset
5014 references.@refill
Dave Love <fx@gnu.org>
parents:
diff changeset
5015 @item
Dave Love <fx@gnu.org>
parents:
diff changeset
5016 A few (minor) Mule-related changes.
Dave Love <fx@gnu.org>
parents:
diff changeset
5017 @item
Dave Love <fx@gnu.org>
parents:
diff changeset
5018 Fixed bug which could cause @emph{huge} @file{.rel} files.
Dave Love <fx@gnu.org>
parents:
diff changeset
5019 @item
Dave Love <fx@gnu.org>
parents:
diff changeset
5020 Search for input and @file{.bib} files with recursive path definitions.
Dave Love <fx@gnu.org>
parents:
diff changeset
5021 @end itemize
Dave Love <fx@gnu.org>
parents:
diff changeset
5022
Dave Love <fx@gnu.org>
parents:
diff changeset
5023 @noindent @b{Version 3.04}
Dave Love <fx@gnu.org>
parents:
diff changeset
5024 @itemize @bullet
Dave Love <fx@gnu.org>
parents:
diff changeset
5025 @item
Dave Love <fx@gnu.org>
parents:
diff changeset
5026 Fixed BUG in the @emph{xr} support.
Dave Love <fx@gnu.org>
parents:
diff changeset
5027 @end itemize
Dave Love <fx@gnu.org>
parents:
diff changeset
5028
Dave Love <fx@gnu.org>
parents:
diff changeset
5029 @noindent @b{Version 3.05}
Dave Love <fx@gnu.org>
parents:
diff changeset
5030 @itemize @bullet
Dave Love <fx@gnu.org>
parents:
diff changeset
5031 @item
Dave Love <fx@gnu.org>
parents:
diff changeset
5032 Compatibility code now first checks for XEmacs feature.
Dave Love <fx@gnu.org>
parents:
diff changeset
5033 @end itemize
Dave Love <fx@gnu.org>
parents:
diff changeset
5034
Dave Love <fx@gnu.org>
parents:
diff changeset
5035 @noindent @b{Version 3.07}
Dave Love <fx@gnu.org>
parents:
diff changeset
5036 @itemize @bullet
Dave Love <fx@gnu.org>
parents:
diff changeset
5037 @item
Dave Love <fx@gnu.org>
parents:
diff changeset
5038 @code{Ref} menu improved.
Dave Love <fx@gnu.org>
parents:
diff changeset
5039 @end itemize
Dave Love <fx@gnu.org>
parents:
diff changeset
5040
Dave Love <fx@gnu.org>
parents:
diff changeset
5041 @noindent @b{Version 3.10}
Dave Love <fx@gnu.org>
parents:
diff changeset
5042 @itemize @bullet
Dave Love <fx@gnu.org>
parents:
diff changeset
5043 @item
Dave Love <fx@gnu.org>
parents:
diff changeset
5044 Fixed a bug which made reftex 3.07 fail on [X]Emacs version 19.
Dave Love <fx@gnu.org>
parents:
diff changeset
5045 @item
Dave Love <fx@gnu.org>
parents:
diff changeset
5046 Removed unimportant code which caused OS/2 Emacs to crash.
Dave Love <fx@gnu.org>
parents:
diff changeset
5047 @item
Dave Love <fx@gnu.org>
parents:
diff changeset
5048 All customization variables now accessible from menu.
Dave Love <fx@gnu.org>
parents:
diff changeset
5049 @end itemize
Dave Love <fx@gnu.org>
parents:
diff changeset
5050
Dave Love <fx@gnu.org>
parents:
diff changeset
5051 @noindent @b{Version 3.11}
Dave Love <fx@gnu.org>
parents:
diff changeset
5052 @itemize @bullet
Dave Love <fx@gnu.org>
parents:
diff changeset
5053 @item
Dave Love <fx@gnu.org>
parents:
diff changeset
5054 Fixed bug which led to naked label in (e.g.) footnotes.
Dave Love <fx@gnu.org>
parents:
diff changeset
5055 @item
Dave Love <fx@gnu.org>
parents:
diff changeset
5056 Added scroll-other-window functions to RefTeX-Select.
Dave Love <fx@gnu.org>
parents:
diff changeset
5057 @end itemize
Dave Love <fx@gnu.org>
parents:
diff changeset
5058
Dave Love <fx@gnu.org>
parents:
diff changeset
5059 @noindent @b{Version 3.12}
Dave Love <fx@gnu.org>
parents:
diff changeset
5060 @itemize @bullet
Dave Love <fx@gnu.org>
parents:
diff changeset
5061 @item
Dave Love <fx@gnu.org>
parents:
diff changeset
5062 There are 3 new keymaps for customization: @code{reftex-toc-map},
Dave Love <fx@gnu.org>
parents:
diff changeset
5063 @code{reftex-select-label-map}, @code{reftex-select-bib-map}.
Dave Love <fx@gnu.org>
parents:
diff changeset
5064 @item
Dave Love <fx@gnu.org>
parents:
diff changeset
5065 Refontification uses more standard font-lock stuff.
Dave Love <fx@gnu.org>
parents:
diff changeset
5066 @item
Dave Love <fx@gnu.org>
parents:
diff changeset
5067 When no BibTeX database files are specified, citations can also use
Dave Love <fx@gnu.org>
parents:
diff changeset
5068 @code{\bibitem} entries from a @code{thebibliography} environment.@refill
Dave Love <fx@gnu.org>
parents:
diff changeset
5069 @end itemize
Dave Love <fx@gnu.org>
parents:
diff changeset
5070
Dave Love <fx@gnu.org>
parents:
diff changeset
5071 @noindent @b{Version 3.14}
Dave Love <fx@gnu.org>
parents:
diff changeset
5072 @itemize @bullet
Dave Love <fx@gnu.org>
parents:
diff changeset
5073 @item
Dave Love <fx@gnu.org>
parents:
diff changeset
5074 Selection buffers can be kept between selections: this is faster.
Dave Love <fx@gnu.org>
parents:
diff changeset
5075 See new variable @code{reftex-use-multiple-selection-buffers}.@refill
Dave Love <fx@gnu.org>
parents:
diff changeset
5076 @item
Dave Love <fx@gnu.org>
parents:
diff changeset
5077 Prefix interpretation of reftex-view-crossref changed.
Dave Love <fx@gnu.org>
parents:
diff changeset
5078 @item
Dave Love <fx@gnu.org>
parents:
diff changeset
5079 Support for the @code{varioref} package (@kbd{v} key in selection
Dave Love <fx@gnu.org>
parents:
diff changeset
5080 buffer).@refill
Dave Love <fx@gnu.org>
parents:
diff changeset
5081 @end itemize
Dave Love <fx@gnu.org>
parents:
diff changeset
5082
Dave Love <fx@gnu.org>
parents:
diff changeset
5083 @noindent @b{Version 3.16}
Dave Love <fx@gnu.org>
parents:
diff changeset
5084 @itemize @bullet
Dave Love <fx@gnu.org>
parents:
diff changeset
5085 @item
Dave Love <fx@gnu.org>
parents:
diff changeset
5086 New hooks @code{reftex-format-label-function},
Dave Love <fx@gnu.org>
parents:
diff changeset
5087 @code{reftex-format-ref-function}, @code{reftex-format-cite-function}.@refill
Dave Love <fx@gnu.org>
parents:
diff changeset
5088 @item
Dave Love <fx@gnu.org>
parents:
diff changeset
5089 TeXInfo documentation completed.
Dave Love <fx@gnu.org>
parents:
diff changeset
5090 @item
Dave Love <fx@gnu.org>
parents:
diff changeset
5091 Some restrictions in Label inserting and referencing removed.
Dave Love <fx@gnu.org>
parents:
diff changeset
5092 @item
Dave Love <fx@gnu.org>
parents:
diff changeset
5093 New variable @code{reftex-default-bibliography}.
Dave Love <fx@gnu.org>
parents:
diff changeset
5094 @end itemize
Dave Love <fx@gnu.org>
parents:
diff changeset
5095
Dave Love <fx@gnu.org>
parents:
diff changeset
5096 @noindent @b{Version 3.17}
Dave Love <fx@gnu.org>
parents:
diff changeset
5097 @itemize @bullet
Dave Love <fx@gnu.org>
parents:
diff changeset
5098 @item
Dave Love <fx@gnu.org>
parents:
diff changeset
5099 Additional bindings in selection and @file{*toc*} buffers. @kbd{g}
Dave Love <fx@gnu.org>
parents:
diff changeset
5100 redefined.
Dave Love <fx@gnu.org>
parents:
diff changeset
5101 @item
Dave Love <fx@gnu.org>
parents:
diff changeset
5102 New command @code{reftex-save-all-document-buffers}.
Dave Love <fx@gnu.org>
parents:
diff changeset
5103 @item
Dave Love <fx@gnu.org>
parents:
diff changeset
5104 Magic word matching made more intelligent.
Dave Love <fx@gnu.org>
parents:
diff changeset
5105 @item
Dave Love <fx@gnu.org>
parents:
diff changeset
5106 Selection process can switch to completion (with @key{TAB}).
Dave Love <fx@gnu.org>
parents:
diff changeset
5107 @item
Dave Love <fx@gnu.org>
parents:
diff changeset
5108 @code{\appendix} is now recognized and influences section numbering.
Dave Love <fx@gnu.org>
parents:
diff changeset
5109 @item
Dave Love <fx@gnu.org>
parents:
diff changeset
5110 File commentary shortened considerably (use Info documentation).
Dave Love <fx@gnu.org>
parents:
diff changeset
5111 @item
Dave Love <fx@gnu.org>
parents:
diff changeset
5112 New option @code{reftex-no-include-regexps} to skip some include files.
Dave Love <fx@gnu.org>
parents:
diff changeset
5113 @item
Dave Love <fx@gnu.org>
parents:
diff changeset
5114 New option @code{reftex-revisit-to-follow}.
Dave Love <fx@gnu.org>
parents:
diff changeset
5115 @end itemize
Dave Love <fx@gnu.org>
parents:
diff changeset
5116
Dave Love <fx@gnu.org>
parents:
diff changeset
5117 @noindent @b{Version 3.18}
Dave Love <fx@gnu.org>
parents:
diff changeset
5118 @itemize @bullet
Dave Love <fx@gnu.org>
parents:
diff changeset
5119 @item
Dave Love <fx@gnu.org>
parents:
diff changeset
5120 The selection now uses a recursive edit, much like minibuffer input.
Dave Love <fx@gnu.org>
parents:
diff changeset
5121 This removes all restrictions during selection. E.g. you can now
Dave Love <fx@gnu.org>
parents:
diff changeset
5122 switch buffers at will, use the mouse etc.@refill
Dave Love <fx@gnu.org>
parents:
diff changeset
5123 @item
Dave Love <fx@gnu.org>
parents:
diff changeset
5124 New option @code{reftex-highlight-selection}.
Dave Love <fx@gnu.org>
parents:
diff changeset
5125 @item
Dave Love <fx@gnu.org>
parents:
diff changeset
5126 @kbd{mouse-2} can be used to select in selection and @file{*toc*}
Dave Love <fx@gnu.org>
parents:
diff changeset
5127 buffers.@refill
Dave Love <fx@gnu.org>
parents:
diff changeset
5128 @item
Dave Love <fx@gnu.org>
parents:
diff changeset
5129 Fixed some problems regarding the interaction with VIPER mode.
Dave Love <fx@gnu.org>
parents:
diff changeset
5130 @item
Dave Love <fx@gnu.org>
parents:
diff changeset
5131 Follow-mode is now only used after point motion.
Dave Love <fx@gnu.org>
parents:
diff changeset
5132 @item
Dave Love <fx@gnu.org>
parents:
diff changeset
5133 @b{Ref@TeX{}} now finally does not fontify temporary files anymore.
Dave Love <fx@gnu.org>
parents:
diff changeset
5134 @end itemize
Dave Love <fx@gnu.org>
parents:
diff changeset
5135
Dave Love <fx@gnu.org>
parents:
diff changeset
5136 @noindent @b{Version 3.19}
Dave Love <fx@gnu.org>
parents:
diff changeset
5137 @itemize @bullet
Dave Love <fx@gnu.org>
parents:
diff changeset
5138 @item
Dave Love <fx@gnu.org>
parents:
diff changeset
5139 Fixed bug with AUCTeX @code{TeX-master}.
Dave Love <fx@gnu.org>
parents:
diff changeset
5140 @end itemize
Dave Love <fx@gnu.org>
parents:
diff changeset
5141
Dave Love <fx@gnu.org>
parents:
diff changeset
5142 @noindent @b{Version 3.21}
Dave Love <fx@gnu.org>
parents:
diff changeset
5143 @itemize @bullet
Dave Love <fx@gnu.org>
parents:
diff changeset
5144 @item
Dave Love <fx@gnu.org>
parents:
diff changeset
5145 New options for all faces used by @b{Ref@TeX{}}. They're in the
Dave Love <fx@gnu.org>
parents:
diff changeset
5146 customization group @code{reftex-fontification-configurations}.@refill
Dave Love <fx@gnu.org>
parents:
diff changeset
5147 @end itemize
Dave Love <fx@gnu.org>
parents:
diff changeset
5148
Dave Love <fx@gnu.org>
parents:
diff changeset
5149 @noindent @b{Version 3.22}
Dave Love <fx@gnu.org>
parents:
diff changeset
5150 @itemize @bullet
Dave Love <fx@gnu.org>
parents:
diff changeset
5151 @item
Dave Love <fx@gnu.org>
parents:
diff changeset
5152 Fixed bug with empty context strings.
Dave Love <fx@gnu.org>
parents:
diff changeset
5153 @item
Dave Love <fx@gnu.org>
parents:
diff changeset
5154 @code{reftex-mouse-view-crossref} is now bound by default at
Dave Love <fx@gnu.org>
parents:
diff changeset
5155 @kbd{S-mouse-2}.@refill
Dave Love <fx@gnu.org>
parents:
diff changeset
5156 @end itemize
Dave Love <fx@gnu.org>
parents:
diff changeset
5157
Dave Love <fx@gnu.org>
parents:
diff changeset
5158 @noindent @b{Version 3.23}
Dave Love <fx@gnu.org>
parents:
diff changeset
5159 @itemize @bullet
Dave Love <fx@gnu.org>
parents:
diff changeset
5160 @item
Dave Love <fx@gnu.org>
parents:
diff changeset
5161 Parse files @file{MASTER.rel} made compatible between Emacs and XEmacs.
Dave Love <fx@gnu.org>
parents:
diff changeset
5162 @item
Dave Love <fx@gnu.org>
parents:
diff changeset
5163 @code{kill-emacs-hook} and @code{kill-buffer-hook} now write the parse
Dave Love <fx@gnu.org>
parents:
diff changeset
5164 file.
Dave Love <fx@gnu.org>
parents:
diff changeset
5165 @item
Dave Love <fx@gnu.org>
parents:
diff changeset
5166 The cursor inside a @code{\ref} or @code{\cite} macro can now trigger
Dave Love <fx@gnu.org>
parents:
diff changeset
5167 automatic display of crossref information in the echo area. See
Dave Love <fx@gnu.org>
parents:
diff changeset
5168 variable @code{reftex-auto-view-crossref}.
Dave Love <fx@gnu.org>
parents:
diff changeset
5169 @item
Dave Love <fx@gnu.org>
parents:
diff changeset
5170 AUCTeX interface updates:
Dave Love <fx@gnu.org>
parents:
diff changeset
5171 @itemize @minus
Dave Love <fx@gnu.org>
parents:
diff changeset
5172 @item
Dave Love <fx@gnu.org>
parents:
diff changeset
5173 AUCTeX 9.9c and later notifies @b{Ref@TeX{}} about new sections.
Dave Love <fx@gnu.org>
parents:
diff changeset
5174 @item
Dave Love <fx@gnu.org>
parents:
diff changeset
5175 @b{Ref@TeX{}} notifies AUCTeX about new labels.
Dave Love <fx@gnu.org>
parents:
diff changeset
5176 @item
Dave Love <fx@gnu.org>
parents:
diff changeset
5177 @code{TeX-arg-ref} no longer used (introduction was unnecessary).
Dave Love <fx@gnu.org>
parents:
diff changeset
5178 @item
Dave Love <fx@gnu.org>
parents:
diff changeset
5179 @code{reftex-arg-label} and @code{reftex-arg-cite} fixed up.
Dave Love <fx@gnu.org>
parents:
diff changeset
5180 @item
Dave Love <fx@gnu.org>
parents:
diff changeset
5181 Settings added to @b{Ref@TeX{}} via style files remain local.
Dave Love <fx@gnu.org>
parents:
diff changeset
5182 @end itemize
Dave Love <fx@gnu.org>
parents:
diff changeset
5183 @item
Dave Love <fx@gnu.org>
parents:
diff changeset
5184 Fixed bug with @code{reftex-citation} in non-latex buffers.
Dave Love <fx@gnu.org>
parents:
diff changeset
5185 @item
Dave Love <fx@gnu.org>
parents:
diff changeset
5186 Fixed bug with syntax table and context refontification.
Dave Love <fx@gnu.org>
parents:
diff changeset
5187 @item
Dave Love <fx@gnu.org>
parents:
diff changeset
5188 Safety-net for name change of @code{font-lock-reference-face}.
Dave Love <fx@gnu.org>
parents:
diff changeset
5189 @end itemize
Dave Love <fx@gnu.org>
parents:
diff changeset
5190
Dave Love <fx@gnu.org>
parents:
diff changeset
5191 @noindent @b{Version 3.24}
Dave Love <fx@gnu.org>
parents:
diff changeset
5192 @itemize @bullet
Dave Love <fx@gnu.org>
parents:
diff changeset
5193 @item
Dave Love <fx@gnu.org>
parents:
diff changeset
5194 New option @code{reftex-revisit-to-echo}.
Dave Love <fx@gnu.org>
parents:
diff changeset
5195 @item
Dave Love <fx@gnu.org>
parents:
diff changeset
5196 Interface with X-Symbol (>=2.6) is now complete and stable.
Dave Love <fx@gnu.org>
parents:
diff changeset
5197 @item
Dave Love <fx@gnu.org>
parents:
diff changeset
5198 Adapted to new outline, which uses overlays.
Dave Love <fx@gnu.org>
parents:
diff changeset
5199 @item
Dave Love <fx@gnu.org>
parents:
diff changeset
5200 File names in @code{\bibliography} may now have the @code{.bib}
Dave Love <fx@gnu.org>
parents:
diff changeset
5201 extension.@refill
Dave Love <fx@gnu.org>
parents:
diff changeset
5202 @item
Dave Love <fx@gnu.org>
parents:
diff changeset
5203 Fixed Bug with parsing "single file" from master file buffer.
Dave Love <fx@gnu.org>
parents:
diff changeset
5204 @end itemize
Dave Love <fx@gnu.org>
parents:
diff changeset
5205
Dave Love <fx@gnu.org>
parents:
diff changeset
5206 @noindent @b{Version 3.25}
Dave Love <fx@gnu.org>
parents:
diff changeset
5207 @itemize @bullet
Dave Love <fx@gnu.org>
parents:
diff changeset
5208 @item
Dave Love <fx@gnu.org>
parents:
diff changeset
5209 Echoing of citation info caches the info for displayed entries.
Dave Love <fx@gnu.org>
parents:
diff changeset
5210 New option @code{reftex-cache-cite-echo}.@refill
Dave Love <fx@gnu.org>
parents:
diff changeset
5211 @item
Dave Love <fx@gnu.org>
parents:
diff changeset
5212 @kbd{M-x reftex-reset-mode} now also removes the file with parsing
Dave Love <fx@gnu.org>
parents:
diff changeset
5213 info.@refill
Dave Love <fx@gnu.org>
parents:
diff changeset
5214 @item
Dave Love <fx@gnu.org>
parents:
diff changeset
5215 Default of @code{reftex-revisit-to-follow} changed to nil.
Dave Love <fx@gnu.org>
parents:
diff changeset
5216 @end itemize
Dave Love <fx@gnu.org>
parents:
diff changeset
5217
Dave Love <fx@gnu.org>
parents:
diff changeset
5218 @noindent @b{Version 3.26}
Dave Love <fx@gnu.org>
parents:
diff changeset
5219 @itemize @bullet
Dave Love <fx@gnu.org>
parents:
diff changeset
5220 @item
Dave Love <fx@gnu.org>
parents:
diff changeset
5221 [X]Emacs 19 no longer supported. Use 3.22 for Emacs 19.
Dave Love <fx@gnu.org>
parents:
diff changeset
5222 @item
Dave Love <fx@gnu.org>
parents:
diff changeset
5223 New hooks @code{reftex-translate-to-ascii-function},
Dave Love <fx@gnu.org>
parents:
diff changeset
5224 @code{reftex-string-to-label-function}.@refill
Dave Love <fx@gnu.org>
parents:
diff changeset
5225 @item
Dave Love <fx@gnu.org>
parents:
diff changeset
5226 Made sure automatic crossref display will not visit/scan files.
Dave Love <fx@gnu.org>
parents:
diff changeset
5227 @end itemize
Dave Love <fx@gnu.org>
parents:
diff changeset
5228
Dave Love <fx@gnu.org>
parents:
diff changeset
5229 @noindent @b{Version 3.27}
Dave Love <fx@gnu.org>
parents:
diff changeset
5230 @itemize @bullet
Dave Love <fx@gnu.org>
parents:
diff changeset
5231 @item
Dave Love <fx@gnu.org>
parents:
diff changeset
5232 Macros can define @emph{neutral} labels, just like @code{\label}
Dave Love <fx@gnu.org>
parents:
diff changeset
5233 itself.@refill
Dave Love <fx@gnu.org>
parents:
diff changeset
5234 @item
Dave Love <fx@gnu.org>
parents:
diff changeset
5235 New option @code{reftex-allow-detached-macro-args}, default @code{nil}!
Dave Love <fx@gnu.org>
parents:
diff changeset
5236 @end itemize
Dave Love <fx@gnu.org>
parents:
diff changeset
5237
Dave Love <fx@gnu.org>
parents:
diff changeset
5238 @noindent @b{Version 3.28}
Dave Love <fx@gnu.org>
parents:
diff changeset
5239 @itemize @bullet
Dave Love <fx@gnu.org>
parents:
diff changeset
5240 @item
Dave Love <fx@gnu.org>
parents:
diff changeset
5241 Auto view crossref for XEmacs uses @code{post-command-hook} to restart the
Dave Love <fx@gnu.org>
parents:
diff changeset
5242 timer, since itimer restart is not reliable.@refill
Dave Love <fx@gnu.org>
parents:
diff changeset
5243 @item
Dave Love <fx@gnu.org>
parents:
diff changeset
5244 Option @code{reftex-bibfile-ignore-list} renamed to @code{-regexps}.
Dave Love <fx@gnu.org>
parents:
diff changeset
5245 @item
Dave Love <fx@gnu.org>
parents:
diff changeset
5246 Expansion of recursive tex and bib path rewritten.
Dave Love <fx@gnu.org>
parents:
diff changeset
5247 @item
Dave Love <fx@gnu.org>
parents:
diff changeset
5248 Fixed problem where @b{Ref@TeX{}} did not scan unsaved buffers.
Dave Love <fx@gnu.org>
parents:
diff changeset
5249 @item
Dave Love <fx@gnu.org>
parents:
diff changeset
5250 Fixed bug with section numbering after *-red sections.
Dave Love <fx@gnu.org>
parents:
diff changeset
5251 @end itemize
Dave Love <fx@gnu.org>
parents:
diff changeset
5252
Dave Love <fx@gnu.org>
parents:
diff changeset
5253 @noindent @b{Version 3.30}
Dave Love <fx@gnu.org>
parents:
diff changeset
5254 @itemize @bullet
Dave Love <fx@gnu.org>
parents:
diff changeset
5255 @item
Dave Love <fx@gnu.org>
parents:
diff changeset
5256 In @code{reftex-citation}, the regular expression used to scan BibTeX
Dave Love <fx@gnu.org>
parents:
diff changeset
5257 files can be specified using completion on known citation keys.
Dave Love <fx@gnu.org>
parents:
diff changeset
5258 @item
Dave Love <fx@gnu.org>
parents:
diff changeset
5259 New keys @kbd{a} and @kbd{A} in BibTeX selection process to cite @emph{all}
Dave Love <fx@gnu.org>
parents:
diff changeset
5260 entries.
Dave Love <fx@gnu.org>
parents:
diff changeset
5261 @item
Dave Love <fx@gnu.org>
parents:
diff changeset
5262 New command @code{reftex-renumber-simple-labels} to renumber simple
Dave Love <fx@gnu.org>
parents:
diff changeset
5263 labels like @samp{eq:13} sequentially through a document.
Dave Love <fx@gnu.org>
parents:
diff changeset
5264 @end itemize
Dave Love <fx@gnu.org>
parents:
diff changeset
5265 @noindent @b{Version 3.33}
Dave Love <fx@gnu.org>
parents:
diff changeset
5266 @itemize @bullet
Dave Love <fx@gnu.org>
parents:
diff changeset
5267 @item
Dave Love <fx@gnu.org>
parents:
diff changeset
5268 Multiple selection buffers are now hidden buffers (they start with a
Dave Love <fx@gnu.org>
parents:
diff changeset
5269 SPACE).
Dave Love <fx@gnu.org>
parents:
diff changeset
5270 @item
Dave Love <fx@gnu.org>
parents:
diff changeset
5271 Fixed bug with file search when TEXINPUTS environment variable is empty.
Dave Love <fx@gnu.org>
parents:
diff changeset
5272 @end itemize
Dave Love <fx@gnu.org>
parents:
diff changeset
5273 @noindent @b{Version 3.34}
Dave Love <fx@gnu.org>
parents:
diff changeset
5274 @itemize @bullet
Dave Love <fx@gnu.org>
parents:
diff changeset
5275 @item
Dave Love <fx@gnu.org>
parents:
diff changeset
5276 Additional flag in @code{reftex-derive-label-parameters} do make only
Dave Love <fx@gnu.org>
parents:
diff changeset
5277 lowercase labels (default @code{t}).
Dave Love <fx@gnu.org>
parents:
diff changeset
5278 @item
Dave Love <fx@gnu.org>
parents:
diff changeset
5279 All @file{.rel} files have a final newline to avoid queries.
Dave Love <fx@gnu.org>
parents:
diff changeset
5280 @item
Dave Love <fx@gnu.org>
parents:
diff changeset
5281 Single byte representations of accented European letters (ISO-8859-1)
Dave Love <fx@gnu.org>
parents:
diff changeset
5282 are now legal in labels.
Dave Love <fx@gnu.org>
parents:
diff changeset
5283 @end itemize
Dave Love <fx@gnu.org>
parents:
diff changeset
5284 @noindent @b{Version 3.35}
Dave Love <fx@gnu.org>
parents:
diff changeset
5285 @itemize @bullet
Dave Love <fx@gnu.org>
parents:
diff changeset
5286 @item
Dave Love <fx@gnu.org>
parents:
diff changeset
5287 ISO 8859 Latin-1 chars are converted to ASCII to derive better labels.
Dave Love <fx@gnu.org>
parents:
diff changeset
5288 This takes back the related changes in 3.34 for safety reasons.@refill
Dave Love <fx@gnu.org>
parents:
diff changeset
5289 @end itemize
Dave Love <fx@gnu.org>
parents:
diff changeset
5290 @noindent @b{Version 3.36}
Dave Love <fx@gnu.org>
parents:
diff changeset
5291 @itemize @bullet
Dave Love <fx@gnu.org>
parents:
diff changeset
5292 @item
Dave Love <fx@gnu.org>
parents:
diff changeset
5293 New value @code{window} for option @code{reftex-auto-view-crossref}.
Dave Love <fx@gnu.org>
parents:
diff changeset
5294 @end itemize
Dave Love <fx@gnu.org>
parents:
diff changeset
5295 @noindent @b{Version 3.38}
Dave Love <fx@gnu.org>
parents:
diff changeset
5296 @itemize @bullet
Dave Love <fx@gnu.org>
parents:
diff changeset
5297 @item
Dave Love <fx@gnu.org>
parents:
diff changeset
5298 @code{reftex-view-crossref} no longer moves to find a macro. Point has
Dave Love <fx@gnu.org>
parents:
diff changeset
5299 to be on the macro argument.
Dave Love <fx@gnu.org>
parents:
diff changeset
5300 @end itemize
Dave Love <fx@gnu.org>
parents:
diff changeset
5301 @noindent @b{Version 3.41}
Dave Love <fx@gnu.org>
parents:
diff changeset
5302 @itemize @bullet
Dave Love <fx@gnu.org>
parents:
diff changeset
5303 @item
Dave Love <fx@gnu.org>
parents:
diff changeset
5304 New options @code{reftex-texpath-environment-variables},
Dave Love <fx@gnu.org>
parents:
diff changeset
5305 @code{reftex-use-external-file-finders},
Dave Love <fx@gnu.org>
parents:
diff changeset
5306 @code{reftex-external-file-finders},
Dave Love <fx@gnu.org>
parents:
diff changeset
5307 @code{reftex-search-unrecursed-path-first}.
Dave Love <fx@gnu.org>
parents:
diff changeset
5308 @item
Dave Love <fx@gnu.org>
parents:
diff changeset
5309 @emph{kpathsearch} support. See new options and
Dave Love <fx@gnu.org>
parents:
diff changeset
5310 @code{reftex-bibpath-environment-variables}.
Dave Love <fx@gnu.org>
parents:
diff changeset
5311 @end itemize
Dave Love <fx@gnu.org>
parents:
diff changeset
5312 @noindent @b{Version 3.42}
Dave Love <fx@gnu.org>
parents:
diff changeset
5313 @itemize @bullet
Dave Love <fx@gnu.org>
parents:
diff changeset
5314 @item
Dave Love <fx@gnu.org>
parents:
diff changeset
5315 File search further refined. New option @code{reftex-file-extensions}.
Dave Love <fx@gnu.org>
parents:
diff changeset
5316 @item
Dave Love <fx@gnu.org>
parents:
diff changeset
5317 @file{*toc*} buffer can show the file boundaries of a multifile
Dave Love <fx@gnu.org>
parents:
diff changeset
5318 document, all labels and associated context. New keys @kbd{i}, @kbd{l},
Dave Love <fx@gnu.org>
parents:
diff changeset
5319 and @kbd{c}. New options @code{reftex-toc-include-labels},
Dave Love <fx@gnu.org>
parents:
diff changeset
5320 @code{reftex-toc-include-context},
Dave Love <fx@gnu.org>
parents:
diff changeset
5321 @code{reftex-toc-include-file-boundaries}. @refill
Dave Love <fx@gnu.org>
parents:
diff changeset
5322 @end itemize
Dave Love <fx@gnu.org>
parents:
diff changeset
5323 @noindent @b{Version 3.43}
Dave Love <fx@gnu.org>
parents:
diff changeset
5324 @itemize @bullet
Dave Love <fx@gnu.org>
parents:
diff changeset
5325 @item
Dave Love <fx@gnu.org>
parents:
diff changeset
5326 Viewing cross-references generalized. Now works on @code{\label},
Dave Love <fx@gnu.org>
parents:
diff changeset
5327 @code{\ref}, @code{\cite}, @code{\bibitem}, @code{\index}, variations of
Dave Love <fx@gnu.org>
parents:
diff changeset
5328 these, and from BibTeX buffers.@refill
Dave Love <fx@gnu.org>
parents:
diff changeset
5329 @item
Dave Love <fx@gnu.org>
parents:
diff changeset
5330 New option @code{reftex-view-crossref-extra}.@refill
Dave Love <fx@gnu.org>
parents:
diff changeset
5331 @item
Dave Love <fx@gnu.org>
parents:
diff changeset
5332 Support for the additional sectioning commands @code{\addchap} and
Dave Love <fx@gnu.org>
parents:
diff changeset
5333 @code{\addsec} which are defined in the LaTeX KOMA-Script classes.@refill
Dave Love <fx@gnu.org>
parents:
diff changeset
5334 @item
Dave Love <fx@gnu.org>
parents:
diff changeset
5335 Files in @code{reftex-default-bibliography} will be searched along
Dave Love <fx@gnu.org>
parents:
diff changeset
5336 @code{BIBINPUTS} path.@refill
Dave Love <fx@gnu.org>
parents:
diff changeset
5337 @item
Dave Love <fx@gnu.org>
parents:
diff changeset
5338 Reading a parse file now checks consistency.
Dave Love <fx@gnu.org>
parents:
diff changeset
5339 @end itemize
26911
d7f536a01276 Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents: 25829
diff changeset
5340 @end ignore
25829
Dave Love <fx@gnu.org>
parents:
diff changeset
5341 @noindent @b{Version 4.00}
Dave Love <fx@gnu.org>
parents:
diff changeset
5342 @itemize @bullet
Dave Love <fx@gnu.org>
parents:
diff changeset
5343 @item
Dave Love <fx@gnu.org>
parents:
diff changeset
5344 RefTeX has been split into several smaller files which are autoloaded on
Dave Love <fx@gnu.org>
parents:
diff changeset
5345 demand.
Dave Love <fx@gnu.org>
parents:
diff changeset
5346 @item
Dave Love <fx@gnu.org>
parents:
diff changeset
5347 Index support, along with many new options.
Dave Love <fx@gnu.org>
parents:
diff changeset
5348 @item
Dave Love <fx@gnu.org>
parents:
diff changeset
5349 The selection of keys for @code{\ref} and @code{\cite} now allows to
Dave Love <fx@gnu.org>
parents:
diff changeset
5350 select multiple items by marking entries with the @kbd{m} key.
Dave Love <fx@gnu.org>
parents:
diff changeset
5351 @item
Dave Love <fx@gnu.org>
parents:
diff changeset
5352 Fancyref support.
Dave Love <fx@gnu.org>
parents:
diff changeset
5353 @end itemize
Dave Love <fx@gnu.org>
parents:
diff changeset
5354 @noindent @b{Version 4.01}
Dave Love <fx@gnu.org>
parents:
diff changeset
5355 @itemize @bullet
Dave Love <fx@gnu.org>
parents:
diff changeset
5356 @item
Dave Love <fx@gnu.org>
parents:
diff changeset
5357 New command @code{reftex-index-globally} to index a word in many
Dave Love <fx@gnu.org>
parents:
diff changeset
5358 places in the document. Also available from the index buffer with
Dave Love <fx@gnu.org>
parents:
diff changeset
5359 @kbd{&}.
Dave Love <fx@gnu.org>
parents:
diff changeset
5360 @item
Dave Love <fx@gnu.org>
parents:
diff changeset
5361 The first item in a @code{reftex-label-alist} entry may now also be a parser
Dave Love <fx@gnu.org>
parents:
diff changeset
5362 function to do non-standard parsing.
Dave Love <fx@gnu.org>
parents:
diff changeset
5363 @item
Dave Love <fx@gnu.org>
parents:
diff changeset
5364 @code{reftex-auto-view-crossref} no longer interferes with
Dave Love <fx@gnu.org>
parents:
diff changeset
5365 @code{pop-up-frames} (patch from Stefan Monnier).
Dave Love <fx@gnu.org>
parents:
diff changeset
5366 @end itemize
Dave Love <fx@gnu.org>
parents:
diff changeset
5367 @noindent @b{Version 4.02}
Dave Love <fx@gnu.org>
parents:
diff changeset
5368 @itemize @bullet
Dave Love <fx@gnu.org>
parents:
diff changeset
5369 @item
Dave Love <fx@gnu.org>
parents:
diff changeset
5370 macros ending in @samp{refrange} are considered to contain references.
Dave Love <fx@gnu.org>
parents:
diff changeset
5371 @item
Dave Love <fx@gnu.org>
parents:
diff changeset
5372 Index entries made with @code{reftex-index-selection-or-word} in TeX
Dave Love <fx@gnu.org>
parents:
diff changeset
5373 math mode automatically get enclosing @samp{$} to preserve math mode. See
Dave Love <fx@gnu.org>
parents:
diff changeset
5374 new option @code{reftex-index-math-format}. Requires AUCTeX.
Dave Love <fx@gnu.org>
parents:
diff changeset
5375 @end itemize
Dave Love <fx@gnu.org>
parents:
diff changeset
5376 @noindent @b{Version 4.04}
Dave Love <fx@gnu.org>
parents:
diff changeset
5377 @itemize @bullet
Dave Love <fx@gnu.org>
parents:
diff changeset
5378 @item
Dave Love <fx@gnu.org>
parents:
diff changeset
5379 New option @code{reftex-index-default-tag} implements a default for queries.
Dave Love <fx@gnu.org>
parents:
diff changeset
5380 @end itemize
Dave Love <fx@gnu.org>
parents:
diff changeset
5381 @noindent @b{Version 4.06}
Dave Love <fx@gnu.org>
parents:
diff changeset
5382 @itemize @bullet
Dave Love <fx@gnu.org>
parents:
diff changeset
5383 @item
Dave Love <fx@gnu.org>
parents:
diff changeset
5384 @code{reftex-section-levels} can contain a function to compute the level
Dave Love <fx@gnu.org>
parents:
diff changeset
5385 of a sectioning command.
Dave Love <fx@gnu.org>
parents:
diff changeset
5386 @item
Dave Love <fx@gnu.org>
parents:
diff changeset
5387 Multiple @code{thebibliography} environments recognized.
Dave Love <fx@gnu.org>
parents:
diff changeset
5388 @end itemize
26911
d7f536a01276 Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents: 25829
diff changeset
5389 @noindent @b{Version 4.09}
d7f536a01276 Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents: 25829
diff changeset
5390 @itemize @bullet
d7f536a01276 Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents: 25829
diff changeset
5391 @item
d7f536a01276 Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents: 25829
diff changeset
5392 New option @code{reftex-toc-max-level} to limit the depth of the toc.
d7f536a01276 Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents: 25829
diff changeset
5393 New keybinding @kbd{t} in the @file{*toc*} buffer to change this
d7f536a01276 Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents: 25829
diff changeset
5394 setting.@refill
d7f536a01276 Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents: 25829
diff changeset
5395 @item
d7f536a01276 Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents: 25829
diff changeset
5396 RefTeX maintaines an @file{Index Phrases} file in which phrases can be
d7f536a01276 Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents: 25829
diff changeset
5397 collected. When the document is ready, RefTeX can search all
d7f536a01276 Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents: 25829
diff changeset
5398 these phrases and assist indexing all matches.@refill
d7f536a01276 Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents: 25829
diff changeset
5399 @item
d7f536a01276 Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents: 25829
diff changeset
5400 The variables @code{reftex-index-macros} and
d7f536a01276 Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents: 25829
diff changeset
5401 @code{reftex-index-default-macro} have changed their syntax slightly.
d7f536a01276 Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents: 25829
diff changeset
5402 The @var{repeat} parameter has move from the latter to the former.
d7f536a01276 Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents: 25829
diff changeset
5403 Also calls to @code{reftex-add-index-macros} from AUCTeX style files
d7f536a01276 Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents: 25829
diff changeset
5404 need to be adapted.@refill
d7f536a01276 Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents: 25829
diff changeset
5405 @item
d7f536a01276 Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents: 25829
diff changeset
5406 The variable @code{reftex-section-levels} no longer contains the
d7f536a01276 Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents: 25829
diff changeset
5407 default stuff which has been moved to a constant.@refill
d7f536a01276 Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents: 25829
diff changeset
5408 @item
d7f536a01276 Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents: 25829
diff changeset
5409 Environments like theorems can be placed into the TOC by putting
d7f536a01276 Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents: 25829
diff changeset
5410 entries for @samp{"begin@{theorem@}"} in
d7f536a01276 Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents: 25829
diff changeset
5411 @code{reftex-setion-levels}.@refill
d7f536a01276 Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents: 25829
diff changeset
5412 @end itemize
27195
d7311a9cb223 version 4.10
Carsten Dominik <dominik@science.uva.nl>
parents: 26911
diff changeset
5413 @noindent @b{Version 4.10}
d7311a9cb223 version 4.10
Carsten Dominik <dominik@science.uva.nl>
parents: 26911
diff changeset
5414 @itemize @bullet
d7311a9cb223 version 4.10
Carsten Dominik <dominik@science.uva.nl>
parents: 26911
diff changeset
5415 @item
d7311a9cb223 version 4.10
Carsten Dominik <dominik@science.uva.nl>
parents: 26911
diff changeset
5416 Renamed @file{reftex-vcr.el} to @file{reftex-dcr.el} because of conflict
d7311a9cb223 version 4.10
Carsten Dominik <dominik@science.uva.nl>
parents: 26911
diff changeset
5417 with @file{reftex-vars.el} on DOS machines.
d7311a9cb223 version 4.10
Carsten Dominik <dominik@science.uva.nl>
parents: 26911
diff changeset
5418 @item
d7311a9cb223 version 4.10
Carsten Dominik <dominik@science.uva.nl>
parents: 26911
diff changeset
5419 New options @code{reftex-parse-file-extension} and
d7311a9cb223 version 4.10
Carsten Dominik <dominik@science.uva.nl>
parents: 26911
diff changeset
5420 @code{reftex-index-phrase-file-extension}.
d7311a9cb223 version 4.10
Carsten Dominik <dominik@science.uva.nl>
parents: 26911
diff changeset
5421 @end itemize
27604
0b645a4a64fa RefTeX 4.11
Carsten Dominik <dominik@science.uva.nl>
parents: 27195
diff changeset
5422 @noindent @b{Version 4.11}
0b645a4a64fa RefTeX 4.11
Carsten Dominik <dominik@science.uva.nl>
parents: 27195
diff changeset
5423 @itemize @bullet
0b645a4a64fa RefTeX 4.11
Carsten Dominik <dominik@science.uva.nl>
parents: 27195
diff changeset
5424 @item
0b645a4a64fa RefTeX 4.11
Carsten Dominik <dominik@science.uva.nl>
parents: 27195
diff changeset
5425 Fixed bug which would parse @samp{\Section} just like @samp{\section}.
0b645a4a64fa RefTeX 4.11
Carsten Dominik <dominik@science.uva.nl>
parents: 27195
diff changeset
5426 @end itemize
29772
265fdb06f294 Update to reftex 4 14
Carsten Dominik <dominik@science.uva.nl>
parents: 29713
diff changeset
5427 @noindent @b{Version 4.12}
265fdb06f294 Update to reftex 4 14
Carsten Dominik <dominik@science.uva.nl>
parents: 29713
diff changeset
5428 @itemize @bullet
265fdb06f294 Update to reftex 4 14
Carsten Dominik <dominik@science.uva.nl>
parents: 29713
diff changeset
5429 @item
265fdb06f294 Update to reftex 4 14
Carsten Dominik <dominik@science.uva.nl>
parents: 29713
diff changeset
5430 Support for @file{bibentry} citation style.
265fdb06f294 Update to reftex 4 14
Carsten Dominik <dominik@science.uva.nl>
parents: 29713
diff changeset
5431 @end itemize
25829
Dave Love <fx@gnu.org>
parents:
diff changeset
5432
Dave Love <fx@gnu.org>
parents:
diff changeset
5433 @node Index, , , Top
Dave Love <fx@gnu.org>
parents:
diff changeset
5434 @unnumbered Index
Dave Love <fx@gnu.org>
parents:
diff changeset
5435 @printindex cp
Dave Love <fx@gnu.org>
parents:
diff changeset
5436
Dave Love <fx@gnu.org>
parents:
diff changeset
5437 @summarycontents
Dave Love <fx@gnu.org>
parents:
diff changeset
5438 @contents
Dave Love <fx@gnu.org>
parents:
diff changeset
5439 @bye
Dave Love <fx@gnu.org>
parents:
diff changeset
5440