annotate man/reftex.texi @ 40964:fb970d0c56eb

Change doc-string comments to `new style'. [w/`doc:' keyword]. Doc fixes. Don't define max. (Fx_open_connection): Only execute once.
author Jason Rumney <jasonr@gnu.org>
date Tue, 13 Nov 2001 00:02:55 +0000
parents 421e0a91a1d1
children 2406cf2da1d4
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
38003
8d7aebc49a9a Fix a bad @setfilename.
Eli Zaretskii <eliz@gnu.org>
parents: 37999
diff changeset
3 @setfilename ../info/reftex
25829
Dave Love <fx@gnu.org>
parents:
diff changeset
4 @settitle RefTeX User Manual
30009
95bdbefcdac6 Use dircategory `Emacs'.
Gerd Moellmann <gerd@gnu.org>
parents: 29819
diff changeset
5 @dircategory Emacs
25829
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
37999
8e7df927fd92 Updated to version 4.16
Carsten Dominik <dominik@science.uva.nl>
parents: 37404
diff changeset
12 @set VERSION 4.16
8e7df927fd92 Updated to version 4.16
Carsten Dominik <dominik@science.uva.nl>
parents: 37404
diff changeset
13 @set EDITION 4.16
8e7df927fd92 Updated to version 4.16
Carsten Dominik <dominik@science.uva.nl>
parents: 37404
diff changeset
14 @set DATE June 2001
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
37999
8e7df927fd92 Updated to version 4.16
Carsten Dominik <dominik@science.uva.nl>
parents: 37404
diff changeset
41 Copyright (c) 1997, 1998, 1999, 2000 2001 Free Software Foundation, Inc.
25829
Dave Love <fx@gnu.org>
parents:
diff changeset
42
37404
730f77edf073 Use GNU Free Documentation License.
Gerd Moellmann <gerd@gnu.org>
parents: 37038
diff changeset
43 Permission is granted to copy, distribute and/or modify this document
730f77edf073 Use GNU Free Documentation License.
Gerd Moellmann <gerd@gnu.org>
parents: 37038
diff changeset
44 under the terms of the GNU Free Documentation License, Version 1.1 or
730f77edf073 Use GNU Free Documentation License.
Gerd Moellmann <gerd@gnu.org>
parents: 37038
diff changeset
45 any later version published by the Free Software Foundation; with no
730f77edf073 Use GNU Free Documentation License.
Gerd Moellmann <gerd@gnu.org>
parents: 37038
diff changeset
46 Invariant Sections, with the Front-Cover texts being ``A GNU
730f77edf073 Use GNU Free Documentation License.
Gerd Moellmann <gerd@gnu.org>
parents: 37038
diff changeset
47 Manual'', and with the Back-Cover Texts as in (a) below. A copy of the
730f77edf073 Use GNU Free Documentation License.
Gerd Moellmann <gerd@gnu.org>
parents: 37038
diff changeset
48 license is included in the section entitled ``GNU Free Documentation
730f77edf073 Use GNU Free Documentation License.
Gerd Moellmann <gerd@gnu.org>
parents: 37038
diff changeset
49 License'' in the Emacs manual.
730f77edf073 Use GNU Free Documentation License.
Gerd Moellmann <gerd@gnu.org>
parents: 37038
diff changeset
50
730f77edf073 Use GNU Free Documentation License.
Gerd Moellmann <gerd@gnu.org>
parents: 37038
diff changeset
51 (a) The FSF's Back-Cover Text is: ``You have freedom to copy and modify
730f77edf073 Use GNU Free Documentation License.
Gerd Moellmann <gerd@gnu.org>
parents: 37038
diff changeset
52 this GNU Manual, like GNU software. Copies published by the Free
730f77edf073 Use GNU Free Documentation License.
Gerd Moellmann <gerd@gnu.org>
parents: 37038
diff changeset
53 Software Foundation raise funds for GNU development.''
730f77edf073 Use GNU Free Documentation License.
Gerd Moellmann <gerd@gnu.org>
parents: 37038
diff changeset
54
730f77edf073 Use GNU Free Documentation License.
Gerd Moellmann <gerd@gnu.org>
parents: 37038
diff changeset
55 This document is part of a collection distributed under the GNU Free
730f77edf073 Use GNU Free Documentation License.
Gerd Moellmann <gerd@gnu.org>
parents: 37038
diff changeset
56 Documentation License. If you want to distribute this document
730f77edf073 Use GNU Free Documentation License.
Gerd Moellmann <gerd@gnu.org>
parents: 37038
diff changeset
57 separately from the collection, you can do so by adding a copy of the
730f77edf073 Use GNU Free Documentation License.
Gerd Moellmann <gerd@gnu.org>
parents: 37038
diff changeset
58 license to the document, as described in section 6 of the license.
25829
Dave Love <fx@gnu.org>
parents:
diff changeset
59 @end ifinfo
Dave Love <fx@gnu.org>
parents:
diff changeset
60
Dave Love <fx@gnu.org>
parents:
diff changeset
61 @titlepage
Dave Love <fx@gnu.org>
parents:
diff changeset
62 @title Ref@TeX{} User Manual
Dave Love <fx@gnu.org>
parents:
diff changeset
63 @subtitle Support for LaTeX labels, references, citations and index entries with GNU Emacs
Dave Love <fx@gnu.org>
parents:
diff changeset
64 @subtitle Edition @value{EDITION}, @value{DATE}
Dave Love <fx@gnu.org>
parents:
diff changeset
65
Dave Love <fx@gnu.org>
parents:
diff changeset
66 @author by Carsten Dominik
Dave Love <fx@gnu.org>
parents:
diff changeset
67 @page
37038
528310f62c34 (Finding Files): Fix an example.
Gerd Moellmann <gerd@gnu.org>
parents: 36509
diff changeset
68 Copyright @copyright{} 1997, 1998, 1999, 2000, 2001 Free Software Foundation, Inc.
25829
Dave Love <fx@gnu.org>
parents:
diff changeset
69
Dave Love <fx@gnu.org>
parents:
diff changeset
70 @sp 2
Dave Love <fx@gnu.org>
parents:
diff changeset
71 This is edition @value{EDITION} of the @cite{Ref@TeX{} User Manual} for
Dave Love <fx@gnu.org>
parents:
diff changeset
72 @b{Ref@TeX{}} version @value{VERSION}, @value{DATE}.@refill
Dave Love <fx@gnu.org>
parents:
diff changeset
73
Dave Love <fx@gnu.org>
parents:
diff changeset
74 @sp 2
Dave Love <fx@gnu.org>
parents:
diff changeset
75
37404
730f77edf073 Use GNU Free Documentation License.
Gerd Moellmann <gerd@gnu.org>
parents: 37038
diff changeset
76 Permission is granted to copy, distribute and/or modify this document
730f77edf073 Use GNU Free Documentation License.
Gerd Moellmann <gerd@gnu.org>
parents: 37038
diff changeset
77 under the terms of the GNU Free Documentation License, Version 1.1 or
730f77edf073 Use GNU Free Documentation License.
Gerd Moellmann <gerd@gnu.org>
parents: 37038
diff changeset
78 any later version published by the Free Software Foundation; with no
730f77edf073 Use GNU Free Documentation License.
Gerd Moellmann <gerd@gnu.org>
parents: 37038
diff changeset
79 Invariant Sections, with the Front-Cover texts being ``A GNU
730f77edf073 Use GNU Free Documentation License.
Gerd Moellmann <gerd@gnu.org>
parents: 37038
diff changeset
80 Manual'', and with the Back-Cover Texts as in (a) below. A copy of the
730f77edf073 Use GNU Free Documentation License.
Gerd Moellmann <gerd@gnu.org>
parents: 37038
diff changeset
81 license is included in the section entitled ``GNU Free Documentation
730f77edf073 Use GNU Free Documentation License.
Gerd Moellmann <gerd@gnu.org>
parents: 37038
diff changeset
82 License'' in the Emacs manual.
730f77edf073 Use GNU Free Documentation License.
Gerd Moellmann <gerd@gnu.org>
parents: 37038
diff changeset
83
730f77edf073 Use GNU Free Documentation License.
Gerd Moellmann <gerd@gnu.org>
parents: 37038
diff changeset
84 (a) The FSF's Back-Cover Text is: ``You have freedom to copy and modify
730f77edf073 Use GNU Free Documentation License.
Gerd Moellmann <gerd@gnu.org>
parents: 37038
diff changeset
85 this GNU Manual, like GNU software. Copies published by the Free
730f77edf073 Use GNU Free Documentation License.
Gerd Moellmann <gerd@gnu.org>
parents: 37038
diff changeset
86 Software Foundation raise funds for GNU development.''
730f77edf073 Use GNU Free Documentation License.
Gerd Moellmann <gerd@gnu.org>
parents: 37038
diff changeset
87
730f77edf073 Use GNU Free Documentation License.
Gerd Moellmann <gerd@gnu.org>
parents: 37038
diff changeset
88 This document is part of a collection distributed under the GNU Free
730f77edf073 Use GNU Free Documentation License.
Gerd Moellmann <gerd@gnu.org>
parents: 37038
diff changeset
89 Documentation License. If you want to distribute this document
730f77edf073 Use GNU Free Documentation License.
Gerd Moellmann <gerd@gnu.org>
parents: 37038
diff changeset
90 separately from the collection, you can do so by adding a copy of the
730f77edf073 Use GNU Free Documentation License.
Gerd Moellmann <gerd@gnu.org>
parents: 37038
diff changeset
91 license to the document, as described in section 6 of the license.
25829
Dave Love <fx@gnu.org>
parents:
diff changeset
92 @end titlepage
Dave Love <fx@gnu.org>
parents:
diff changeset
93 @page
Dave Love <fx@gnu.org>
parents:
diff changeset
94
29772
265fdb06f294 Update to reftex 4 14
Carsten Dominik <dominik@science.uva.nl>
parents: 29713
diff changeset
95 @ifnottex
25829
Dave Love <fx@gnu.org>
parents:
diff changeset
96 @node Top,,,(dir)
Dave Love <fx@gnu.org>
parents:
diff changeset
97
Dave Love <fx@gnu.org>
parents:
diff changeset
98 @b{Ref@TeX{}} is a package for managing Labels, References,
Dave Love <fx@gnu.org>
parents:
diff changeset
99 Citations and index entries with GNU Emacs.@refill
Dave Love <fx@gnu.org>
parents:
diff changeset
100
Dave Love <fx@gnu.org>
parents:
diff changeset
101 Don't be discouraged by the size of this manual, which covers
Dave Love <fx@gnu.org>
parents:
diff changeset
102 @b{Ref@TeX{}} in great depth. All you need to know to use
Dave Love <fx@gnu.org>
parents:
diff changeset
103 @b{Ref@TeX{}} can be summarized on two pages (@pxref{RefTeX in a
Dave Love <fx@gnu.org>
parents:
diff changeset
104 Nutshell}). You can go back later to other parts of this document when
Dave Love <fx@gnu.org>
parents:
diff changeset
105 needed.@refill
Dave Love <fx@gnu.org>
parents:
diff changeset
106
Dave Love <fx@gnu.org>
parents:
diff changeset
107 @menu
Dave Love <fx@gnu.org>
parents:
diff changeset
108 * Introduction:: Quick-Start information.
Dave Love <fx@gnu.org>
parents:
diff changeset
109
Dave Love <fx@gnu.org>
parents:
diff changeset
110 * Table of Contents:: A Tool to move around quickly.
Dave Love <fx@gnu.org>
parents:
diff changeset
111 * Labels and References:: Creating and referencing labels.
Dave Love <fx@gnu.org>
parents:
diff changeset
112 * Citations:: Creating Citations.
Dave Love <fx@gnu.org>
parents:
diff changeset
113 * Index Support:: Creating and Checking Index Entries.
Dave Love <fx@gnu.org>
parents:
diff changeset
114 * Viewing Cross-References:: Who references or cites what?
Dave Love <fx@gnu.org>
parents:
diff changeset
115
Dave Love <fx@gnu.org>
parents:
diff changeset
116 * RefTeXs Menu:: The Ref menu in the menubar.
39267
a8c0a02f6129 Spelling corrections.
Richard M. Stallman <rms@gnu.org>
parents: 38003
diff changeset
117 * Key Bindings:: The default key bindings.
25829
Dave Love <fx@gnu.org>
parents:
diff changeset
118 * Faces:: Fontification of RefTeX's buffers.
Dave Love <fx@gnu.org>
parents:
diff changeset
119 * Multifile Documents:: Document spread over many files.
Dave Love <fx@gnu.org>
parents:
diff changeset
120 * Language Support:: How to support other languages.
Dave Love <fx@gnu.org>
parents:
diff changeset
121 * Finding Files:: Included TeX files and BibTeX .bib files.
Dave Love <fx@gnu.org>
parents:
diff changeset
122 * AUCTeX:: Cooperation with AUCTeX.
Dave Love <fx@gnu.org>
parents:
diff changeset
123 * Optimizations:: When RefTeX is too slow.
Dave Love <fx@gnu.org>
parents:
diff changeset
124 * Problems and Work-Arounds:: First Aid.
Dave Love <fx@gnu.org>
parents:
diff changeset
125 * Imprint:: Author, Web-site, Thanks
Dave Love <fx@gnu.org>
parents:
diff changeset
126
Dave Love <fx@gnu.org>
parents:
diff changeset
127 * Commands:: Which are the available commands.
Dave Love <fx@gnu.org>
parents:
diff changeset
128 * Options:: How to extend and configure RefTeX.
Dave Love <fx@gnu.org>
parents:
diff changeset
129 * Keymaps and Hooks:: For customization.
Dave Love <fx@gnu.org>
parents:
diff changeset
130 * Changes:: A List of recent changes to RefTeX.
Dave Love <fx@gnu.org>
parents:
diff changeset
131
Dave Love <fx@gnu.org>
parents:
diff changeset
132 The Index
Dave Love <fx@gnu.org>
parents:
diff changeset
133
Dave Love <fx@gnu.org>
parents:
diff changeset
134 * Index:: The full index.
Dave Love <fx@gnu.org>
parents:
diff changeset
135
Dave Love <fx@gnu.org>
parents:
diff changeset
136 @detailmenu
Dave Love <fx@gnu.org>
parents:
diff changeset
137
Dave Love <fx@gnu.org>
parents:
diff changeset
138 Introduction
Dave Love <fx@gnu.org>
parents:
diff changeset
139
Dave Love <fx@gnu.org>
parents:
diff changeset
140 * Installation:: How to install and activate RefTeX.
Dave Love <fx@gnu.org>
parents:
diff changeset
141 * RefTeX in a Nutshell:: A brief summary and quick guide.
Dave Love <fx@gnu.org>
parents:
diff changeset
142
Dave Love <fx@gnu.org>
parents:
diff changeset
143 Labels and References
Dave Love <fx@gnu.org>
parents:
diff changeset
144
Dave Love <fx@gnu.org>
parents:
diff changeset
145 * Creating Labels::
Dave Love <fx@gnu.org>
parents:
diff changeset
146 * Referencing Labels::
Dave Love <fx@gnu.org>
parents:
diff changeset
147 * Builtin Label Environments:: The environments RefTeX knows about.
Dave Love <fx@gnu.org>
parents:
diff changeset
148 * Defining Label Environments:: ... and environments it doesn't.
Dave Love <fx@gnu.org>
parents:
diff changeset
149 * Reference Info:: View the label corresponding to a \ref.
Dave Love <fx@gnu.org>
parents:
diff changeset
150 * xr (LaTeX package):: References to external documents.
Dave Love <fx@gnu.org>
parents:
diff changeset
151 * varioref (LaTeX package):: How to create \vref instead of \ref.
Dave Love <fx@gnu.org>
parents:
diff changeset
152 * fancyref (LaTeX package):: How to create \fref instead of \ref.
Dave Love <fx@gnu.org>
parents:
diff changeset
153
Dave Love <fx@gnu.org>
parents:
diff changeset
154 Defining Label Environments
Dave Love <fx@gnu.org>
parents:
diff changeset
155
Dave Love <fx@gnu.org>
parents:
diff changeset
156 * Theorem and Axiom:: Defined with @code{\newenvironment}.
Dave Love <fx@gnu.org>
parents:
diff changeset
157 * Quick Equation:: When a macro sets the label type.
Dave Love <fx@gnu.org>
parents:
diff changeset
158 * Figure Wrapper:: When a macro argument is a label.
Dave Love <fx@gnu.org>
parents:
diff changeset
159 * Adding Magic Words:: Other words for other languages.
Dave Love <fx@gnu.org>
parents:
diff changeset
160 * Using \eqref:: How to switch to this AMS-LaTeX macro.
Dave Love <fx@gnu.org>
parents:
diff changeset
161 * Non-Standard Environments:: Environments without \begin and \end
Dave Love <fx@gnu.org>
parents:
diff changeset
162 * Putting it Together:: How to combine many entries.
Dave Love <fx@gnu.org>
parents:
diff changeset
163
Dave Love <fx@gnu.org>
parents:
diff changeset
164 Citations
Dave Love <fx@gnu.org>
parents:
diff changeset
165
Dave Love <fx@gnu.org>
parents:
diff changeset
166 * Creating Citations:: How to create them.
Dave Love <fx@gnu.org>
parents:
diff changeset
167 * Citation Styles:: Natbib, Harvard, Chicago and Co.
Dave Love <fx@gnu.org>
parents:
diff changeset
168 * Citation Info:: View the corresponding database entry.
Dave Love <fx@gnu.org>
parents:
diff changeset
169 * Chapterbib and Bibunits:: Multiple bibliographies in a Document.
Dave Love <fx@gnu.org>
parents:
diff changeset
170 * Citations Outside LaTeX:: How to make citations in Emails etc.
Dave Love <fx@gnu.org>
parents:
diff changeset
171
Dave Love <fx@gnu.org>
parents:
diff changeset
172 Index Support
Dave Love <fx@gnu.org>
parents:
diff changeset
173
26911
d7f536a01276 Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents: 25829
diff changeset
174 * Creating Index Entries:: Macros and completion of entries.
d7f536a01276 Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents: 25829
diff changeset
175 * 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
176 * Displaying and Editing the Index:: The index editor.
25829
Dave Love <fx@gnu.org>
parents:
diff changeset
177 * Builtin Index Macros:: The index macros RefTeX knows about.
Dave Love <fx@gnu.org>
parents:
diff changeset
178 * Defining Index Macros:: ... and macros it doesn't.
Dave Love <fx@gnu.org>
parents:
diff changeset
179
26911
d7f536a01276 Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents: 25829
diff changeset
180 The Index Phrases File
d7f536a01276 Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents: 25829
diff changeset
181
d7f536a01276 Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents: 25829
diff changeset
182 * Collecting Phrases:: Collecting from document or external.
d7f536a01276 Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents: 25829
diff changeset
183 * Consistency Checks:: Check for duplicates etc.
d7f536a01276 Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents: 25829
diff changeset
184 * Global Indexing:: The interactive indexing process.
d7f536a01276 Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents: 25829
diff changeset
185
25829
Dave Love <fx@gnu.org>
parents:
diff changeset
186 AUCTeX
Dave Love <fx@gnu.org>
parents:
diff changeset
187
Dave Love <fx@gnu.org>
parents:
diff changeset
188 * AUCTeX-RefTeX Interface:: How both packages work together
Dave Love <fx@gnu.org>
parents:
diff changeset
189 * Style Files:: AUCTeX's style files can support RefTeX
Dave Love <fx@gnu.org>
parents:
diff changeset
190 * Bib-Cite:: Hypertext reading of a document
Dave Love <fx@gnu.org>
parents:
diff changeset
191
Dave Love <fx@gnu.org>
parents:
diff changeset
192 Options, Keymaps, Hooks
Dave Love <fx@gnu.org>
parents:
diff changeset
193
Dave Love <fx@gnu.org>
parents:
diff changeset
194 * Options (Table of Contents)::
Dave Love <fx@gnu.org>
parents:
diff changeset
195 * Options (Defining Label Environments)::
Dave Love <fx@gnu.org>
parents:
diff changeset
196 * Options (Creating Labels)::
Dave Love <fx@gnu.org>
parents:
diff changeset
197 * Options (Referencing Labels)::
Dave Love <fx@gnu.org>
parents:
diff changeset
198 * Options (Creating Citations)::
Dave Love <fx@gnu.org>
parents:
diff changeset
199 * Options (Index Support)::
Dave Love <fx@gnu.org>
parents:
diff changeset
200 * Options (Viewing Cross-References)::
Dave Love <fx@gnu.org>
parents:
diff changeset
201 * Options (Finding Files)::
Dave Love <fx@gnu.org>
parents:
diff changeset
202 * Options (Optimizations)::
Dave Love <fx@gnu.org>
parents:
diff changeset
203 * Options (Fontification)::
Dave Love <fx@gnu.org>
parents:
diff changeset
204 * Options (Misc)::
Dave Love <fx@gnu.org>
parents:
diff changeset
205
Dave Love <fx@gnu.org>
parents:
diff changeset
206 @end detailmenu
Dave Love <fx@gnu.org>
parents:
diff changeset
207 @end menu
Dave Love <fx@gnu.org>
parents:
diff changeset
208
29772
265fdb06f294 Update to reftex 4 14
Carsten Dominik <dominik@science.uva.nl>
parents: 29713
diff changeset
209 @end ifnottex
25829
Dave Love <fx@gnu.org>
parents:
diff changeset
210
Dave Love <fx@gnu.org>
parents:
diff changeset
211 @node Introduction, Table of Contents, , Top
Dave Love <fx@gnu.org>
parents:
diff changeset
212 @chapter Introduction
Dave Love <fx@gnu.org>
parents:
diff changeset
213 @cindex Introduction
Dave Love <fx@gnu.org>
parents:
diff changeset
214
Dave Love <fx@gnu.org>
parents:
diff changeset
215 @b{Ref@TeX{}} is a specialized package for support of labels,
Dave Love <fx@gnu.org>
parents:
diff changeset
216 references, citations, and the index in LaTeX. @b{Ref@TeX{}} wraps
Dave Love <fx@gnu.org>
parents:
diff changeset
217 itself round 4 LaTeX macros: @code{\label}, @code{\ref}, @code{\cite},
Dave Love <fx@gnu.org>
parents:
diff changeset
218 and @code{\index}. Using these macros usually requires looking up
Dave Love <fx@gnu.org>
parents:
diff changeset
219 different parts of the document and searching through BibTeX database
Dave Love <fx@gnu.org>
parents:
diff changeset
220 files. @b{Ref@TeX{}} automates these time--consuming tasks almost
Dave Love <fx@gnu.org>
parents:
diff changeset
221 entirely. It also provides functions to display the structure of a
Dave Love <fx@gnu.org>
parents:
diff changeset
222 document and to move around in this structure quickly.@refill
Dave Love <fx@gnu.org>
parents:
diff changeset
223
Dave Love <fx@gnu.org>
parents:
diff changeset
224 @iftex
Dave Love <fx@gnu.org>
parents:
diff changeset
225 Don't be discouraged by the size of this manual, which covers @b{Ref@TeX{}}
Dave Love <fx@gnu.org>
parents:
diff changeset
226 in great depth. All you need to know to use @b{Ref@TeX{}} can be
Dave Love <fx@gnu.org>
parents:
diff changeset
227 summarized on two pages (@pxref{RefTeX in a Nutshell}). You can go
Dave Love <fx@gnu.org>
parents:
diff changeset
228 back later to other parts of this document when needed.
Dave Love <fx@gnu.org>
parents:
diff changeset
229 @end iftex
Dave Love <fx@gnu.org>
parents:
diff changeset
230
Dave Love <fx@gnu.org>
parents:
diff changeset
231 @xref{Imprint}, for information about who to contact for help, bug
Dave Love <fx@gnu.org>
parents:
diff changeset
232 reports or suggestions.
Dave Love <fx@gnu.org>
parents:
diff changeset
233
Dave Love <fx@gnu.org>
parents:
diff changeset
234 @menu
Dave Love <fx@gnu.org>
parents:
diff changeset
235 * Installation:: How to install and activate RefTeX.
Dave Love <fx@gnu.org>
parents:
diff changeset
236 * RefTeX in a Nutshell:: A brief summary and quick guide.
Dave Love <fx@gnu.org>
parents:
diff changeset
237 @end menu
Dave Love <fx@gnu.org>
parents:
diff changeset
238
Dave Love <fx@gnu.org>
parents:
diff changeset
239 @node Installation, RefTeX in a Nutshell, , Introduction
Dave Love <fx@gnu.org>
parents:
diff changeset
240 @section Installation
Dave Love <fx@gnu.org>
parents:
diff changeset
241 @cindex Installation
Dave Love <fx@gnu.org>
parents:
diff changeset
242
Dave Love <fx@gnu.org>
parents:
diff changeset
243 @b{Ref@TeX{}} is bundled and pre--installed with Emacs since version 20.2.
Dave Love <fx@gnu.org>
parents:
diff changeset
244 It was also bundled and pre--installed with XEmacs 19.16--20.x. XEmacs
Dave Love <fx@gnu.org>
parents:
diff changeset
245 21.x users want to install the corresponding plug-in package which is
Dave Love <fx@gnu.org>
parents:
diff changeset
246 available from the
Dave Love <fx@gnu.org>
parents:
diff changeset
247 @uref{ftp://ftp.xemacs.org/pub/xemacs/packages/,XEmacs ftp site}. See
Dave Love <fx@gnu.org>
parents:
diff changeset
248 the XEmacs 21.x documentation on package installation for
Dave Love <fx@gnu.org>
parents:
diff changeset
249 details.@refill
Dave Love <fx@gnu.org>
parents:
diff changeset
250
Dave Love <fx@gnu.org>
parents:
diff changeset
251 Users of earlier Emacs distributions (including Emacs 19) can get a copy
Dave Love <fx@gnu.org>
parents:
diff changeset
252 of the @b{Ref@TeX{}} distribution from the maintainers web-page.
Dave Love <fx@gnu.org>
parents:
diff changeset
253 @xref{Imprint}, for more information.@refill
Dave Love <fx@gnu.org>
parents:
diff changeset
254
Dave Love <fx@gnu.org>
parents:
diff changeset
255 @section Environment
Dave Love <fx@gnu.org>
parents:
diff changeset
256 @cindex Finding files
Dave Love <fx@gnu.org>
parents:
diff changeset
257 @cindex BibTeX database files, not found
Dave Love <fx@gnu.org>
parents:
diff changeset
258 @cindex TeX files, not found
Dave Love <fx@gnu.org>
parents:
diff changeset
259 @cindex @code{TEXINPUTS}, environment variable
Dave Love <fx@gnu.org>
parents:
diff changeset
260 @cindex @code{BIBINPUTS}, environment variable
Dave Love <fx@gnu.org>
parents:
diff changeset
261
Dave Love <fx@gnu.org>
parents:
diff changeset
262 @b{Ref@TeX{}} needs to access all files which are part of a multifile
Dave Love <fx@gnu.org>
parents:
diff changeset
263 document, and the BibTeX database files requested by the
Dave Love <fx@gnu.org>
parents:
diff changeset
264 @code{\bibliography} command. To find these files, @b{Ref@TeX{}} will
Dave Love <fx@gnu.org>
parents:
diff changeset
265 require a search path, i.e. a list of directories to check. Normally
Dave Love <fx@gnu.org>
parents:
diff changeset
266 this list is stored in the environment variables @code{TEXINPUTS} and
Dave Love <fx@gnu.org>
parents:
diff changeset
267 @code{BIBINPUTS} which are also used by @b{Ref@TeX{}}. However, on some
Dave Love <fx@gnu.org>
parents:
diff changeset
268 systems these variables do not contain the full search path. If
Dave Love <fx@gnu.org>
parents:
diff changeset
269 @b{Ref@TeX{}} does not work for you because it cannot find some files,
Dave Love <fx@gnu.org>
parents:
diff changeset
270 read @ref{Finding Files}.
Dave Love <fx@gnu.org>
parents:
diff changeset
271
Dave Love <fx@gnu.org>
parents:
diff changeset
272 @section Entering @b{Ref@TeX{}} Mode
Dave Love <fx@gnu.org>
parents:
diff changeset
273
Dave Love <fx@gnu.org>
parents:
diff changeset
274 @findex turn-on-reftex
Dave Love <fx@gnu.org>
parents:
diff changeset
275 @findex reftex-mode
Dave Love <fx@gnu.org>
parents:
diff changeset
276 @vindex LaTeX-mode-hook
Dave Love <fx@gnu.org>
parents:
diff changeset
277 @vindex latex-mode-hook
Dave Love <fx@gnu.org>
parents:
diff changeset
278 To turn @b{Ref@TeX{}} Mode on and off in a particular buffer, use
Dave Love <fx@gnu.org>
parents:
diff changeset
279 @kbd{M-x reftex-mode}. To turn on @b{Ref@TeX{}} Mode for all LaTeX
Dave Love <fx@gnu.org>
parents:
diff changeset
280 files, add the following lines to your @file{.emacs} file:@refill
Dave Love <fx@gnu.org>
parents:
diff changeset
281
Dave Love <fx@gnu.org>
parents:
diff changeset
282 @example
Dave Love <fx@gnu.org>
parents:
diff changeset
283 (add-hook 'LaTeX-mode-hook 'turn-on-reftex) ; with AUCTeX LaTeX mode
Dave Love <fx@gnu.org>
parents:
diff changeset
284 (add-hook 'latex-mode-hook 'turn-on-reftex) ; with Emacs latex mode
Dave Love <fx@gnu.org>
parents:
diff changeset
285 @end example
Dave Love <fx@gnu.org>
parents:
diff changeset
286
Dave Love <fx@gnu.org>
parents:
diff changeset
287 @page
Dave Love <fx@gnu.org>
parents:
diff changeset
288 @node RefTeX in a Nutshell, , Installation, Introduction
Dave Love <fx@gnu.org>
parents:
diff changeset
289 @section @b{Ref@TeX{}} in a Nutshell
Dave Love <fx@gnu.org>
parents:
diff changeset
290 @cindex Quick-Start
Dave Love <fx@gnu.org>
parents:
diff changeset
291 @cindex Getting Started
Dave Love <fx@gnu.org>
parents:
diff changeset
292 @cindex RefTeX in a Nutshell
Dave Love <fx@gnu.org>
parents:
diff changeset
293 @cindex Nutshell, RefTeX in a
Dave Love <fx@gnu.org>
parents:
diff changeset
294
Dave Love <fx@gnu.org>
parents:
diff changeset
295 @enumerate
Dave Love <fx@gnu.org>
parents:
diff changeset
296 @item
Dave Love <fx@gnu.org>
parents:
diff changeset
297 @b{Table of Contents}@* Typing @kbd{C-c =} (@code{reftex-toc}) will show
Dave Love <fx@gnu.org>
parents:
diff changeset
298 a table of contents of the document. This buffer can display sections,
Dave Love <fx@gnu.org>
parents:
diff changeset
299 labels and index entries defined in the document. From the buffer, you
Dave Love <fx@gnu.org>
parents:
diff changeset
300 can jump quickly to every part of your document. Press @kbd{?} to get
Dave Love <fx@gnu.org>
parents:
diff changeset
301 help.@refill
Dave Love <fx@gnu.org>
parents:
diff changeset
302
Dave Love <fx@gnu.org>
parents:
diff changeset
303 @item
Dave Love <fx@gnu.org>
parents:
diff changeset
304 @b{Labels and References}@* @b{Ref@TeX{}} helps to create unique labels
Dave Love <fx@gnu.org>
parents:
diff changeset
305 and to find the correct key for references quickly. It distinguishes
Dave Love <fx@gnu.org>
parents:
diff changeset
306 labels for different environments, knows about all standard
Dave Love <fx@gnu.org>
parents:
diff changeset
307 environments (and many others), and can be configured to recognize any
Dave Love <fx@gnu.org>
parents:
diff changeset
308 additional labeled environments you have defined yourself (variable
Dave Love <fx@gnu.org>
parents:
diff changeset
309 @code{reftex-label-alist}).@refill
Dave Love <fx@gnu.org>
parents:
diff changeset
310
Dave Love <fx@gnu.org>
parents:
diff changeset
311 @itemize @bullet
Dave Love <fx@gnu.org>
parents:
diff changeset
312 @item
Dave Love <fx@gnu.org>
parents:
diff changeset
313 @b{Creating Labels}@*
Dave Love <fx@gnu.org>
parents:
diff changeset
314 Type @kbd{C-c (} (@code{reftex-label}) to insert a label at point.
Dave Love <fx@gnu.org>
parents:
diff changeset
315 @b{Ref@TeX{}} will either
Dave Love <fx@gnu.org>
parents:
diff changeset
316 @itemize @minus
Dave Love <fx@gnu.org>
parents:
diff changeset
317 @item
Dave Love <fx@gnu.org>
parents:
diff changeset
318 derive a label from context (default for section labels)
Dave Love <fx@gnu.org>
parents:
diff changeset
319 @item
Dave Love <fx@gnu.org>
parents:
diff changeset
320 prompt for a label string (default for figures and tables) or
Dave Love <fx@gnu.org>
parents:
diff changeset
321 @item
Dave Love <fx@gnu.org>
parents:
diff changeset
322 insert a simple label made of a prefix and a number (all other
Dave Love <fx@gnu.org>
parents:
diff changeset
323 environments)@refill
Dave Love <fx@gnu.org>
parents:
diff changeset
324 @end itemize
Dave Love <fx@gnu.org>
parents:
diff changeset
325 @noindent
Dave Love <fx@gnu.org>
parents:
diff changeset
326 Which labels are created how is configurable with the variable
Dave Love <fx@gnu.org>
parents:
diff changeset
327 @code{reftex-insert-label-flags}.@refill
Dave Love <fx@gnu.org>
parents:
diff changeset
328
Dave Love <fx@gnu.org>
parents:
diff changeset
329 @item
Dave Love <fx@gnu.org>
parents:
diff changeset
330 @b{Referencing Labels}@* To make a reference, type @kbd{C-c )}
Dave Love <fx@gnu.org>
parents:
diff changeset
331 (@code{reftex-reference}). This shows an outline of the document with
Dave Love <fx@gnu.org>
parents:
diff changeset
332 all labels of a certain type (figure, equation,...) and some label
Dave Love <fx@gnu.org>
parents:
diff changeset
333 context. Selecting a label inserts a @code{\ref@{@var{label}@}} macro
Dave Love <fx@gnu.org>
parents:
diff changeset
334 into the original buffer.@refill
Dave Love <fx@gnu.org>
parents:
diff changeset
335 @end itemize
Dave Love <fx@gnu.org>
parents:
diff changeset
336
Dave Love <fx@gnu.org>
parents:
diff changeset
337 @item
Dave Love <fx@gnu.org>
parents:
diff changeset
338 @b{Citations}@*
Dave Love <fx@gnu.org>
parents:
diff changeset
339 Typing @kbd{C-c [} (@code{reftex-citation}) will let you specify a
Dave Love <fx@gnu.org>
parents:
diff changeset
340 regular expression to search in current BibTeX database files (as
Dave Love <fx@gnu.org>
parents:
diff changeset
341 specified in the @code{\bibliography} command) and pull out a list of
Dave Love <fx@gnu.org>
parents:
diff changeset
342 matches for you to choose from. The list is @emph{formatted} and
Dave Love <fx@gnu.org>
parents:
diff changeset
343 sorted. The selected article is referenced as @samp{\cite@{@var{key}@}}
Dave Love <fx@gnu.org>
parents:
diff changeset
344 (see the variable @code{reftex-cite-format} if you want to insert
Dave Love <fx@gnu.org>
parents:
diff changeset
345 different macros).@refill
Dave Love <fx@gnu.org>
parents:
diff changeset
346
Dave Love <fx@gnu.org>
parents:
diff changeset
347 @item
Dave Love <fx@gnu.org>
parents:
diff changeset
348 @b{Index Support}@*
Dave Love <fx@gnu.org>
parents:
diff changeset
349 @b{Ref@TeX{}} helps to enter index entries. It also compiles all
Dave Love <fx@gnu.org>
parents:
diff changeset
350 entries into an alphabetically sorted @file{*Index*} buffer which you
Dave Love <fx@gnu.org>
parents:
diff changeset
351 can use to check and edit the entries. @b{Ref@TeX{}} knows about the
Dave Love <fx@gnu.org>
parents:
diff changeset
352 standard index macros and can be configured to recognize any additional
Dave Love <fx@gnu.org>
parents:
diff changeset
353 macros you have defined (@code{reftex-index-macros}). Multiple indices
Dave Love <fx@gnu.org>
parents:
diff changeset
354 are supported.@refill
Dave Love <fx@gnu.org>
parents:
diff changeset
355
Dave Love <fx@gnu.org>
parents:
diff changeset
356 @itemize @bullet
Dave Love <fx@gnu.org>
parents:
diff changeset
357 @item
Dave Love <fx@gnu.org>
parents:
diff changeset
358 @b{Creating Index Entries}@*
26911
d7f536a01276 Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents: 25829
diff changeset
359 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
360 (@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
361 @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
362 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
363 and enter the arguments with completion.@refill
d7f536a01276 Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents: 25829
diff changeset
364
d7f536a01276 Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents: 25829
diff changeset
365 @item
d7f536a01276 Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents: 25829
diff changeset
366 @b{The Index Phrases File (Delayed Indexing)}@*
d7f536a01276 Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents: 25829
diff changeset
367 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
368 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
369 @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
370 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
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{Displaying and Editing the Index}@*
d7f536a01276 Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents: 25829
diff changeset
374 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
375 (@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
376 all entries.@refill
25829
Dave Love <fx@gnu.org>
parents:
diff changeset
377 @end itemize
Dave Love <fx@gnu.org>
parents:
diff changeset
378
Dave Love <fx@gnu.org>
parents:
diff changeset
379 @page
Dave Love <fx@gnu.org>
parents:
diff changeset
380 @item @b{Viewing Cross-References}@*
Dave Love <fx@gnu.org>
parents:
diff changeset
381 When point is on the @var{key} argument of a cross--referencing macro
Dave Love <fx@gnu.org>
parents:
diff changeset
382 (@code{\label}, @code{\ref}, @code{\cite}, @code{\bibitem},
Dave Love <fx@gnu.org>
parents:
diff changeset
383 @code{\index}, and variations) or inside a BibTeX database entry, you
Dave Love <fx@gnu.org>
parents:
diff changeset
384 can press @kbd{C-c &} (@code{reftex-view-crossref}) to display
Dave Love <fx@gnu.org>
parents:
diff changeset
385 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
386 files.@refill @*
d7f536a01276 Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents: 25829
diff changeset
387 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
388 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
389 will automatically be displayed in the echo area.@refill
25829
Dave Love <fx@gnu.org>
parents:
diff changeset
390
Dave Love <fx@gnu.org>
parents:
diff changeset
391 @item
Dave Love <fx@gnu.org>
parents:
diff changeset
392 @b{Multifile Documents}@*
Dave Love <fx@gnu.org>
parents:
diff changeset
393 Multifile Documents are fully supported. The included files must have a
Dave Love <fx@gnu.org>
parents:
diff changeset
394 file variable @code{TeX-master} or @code{tex-main-file} pointing to the
Dave Love <fx@gnu.org>
parents:
diff changeset
395 master file. @b{Ref@TeX{}} provides cross-referencing information from
Dave Love <fx@gnu.org>
parents:
diff changeset
396 all parts of the document, and across document borders
Dave Love <fx@gnu.org>
parents:
diff changeset
397 (@file{xr.sty}).@refill
Dave Love <fx@gnu.org>
parents:
diff changeset
398
Dave Love <fx@gnu.org>
parents:
diff changeset
399 @item
Dave Love <fx@gnu.org>
parents:
diff changeset
400 @b{Document Parsing}@* @b{Ref@TeX{}} needs to parse the document in
Dave Love <fx@gnu.org>
parents:
diff changeset
401 order to find labels and other information. It does it automatically
Dave Love <fx@gnu.org>
parents:
diff changeset
402 once and updates its list internally when @code{reftex-label} and
Dave Love <fx@gnu.org>
parents:
diff changeset
403 @code{reftex-index} are used. To enforce reparsing, call any of the
Dave Love <fx@gnu.org>
parents:
diff changeset
404 commands described above with a raw @kbd{C-u} prefix, or press the
Dave Love <fx@gnu.org>
parents:
diff changeset
405 @kbd{r} key in the label selection buffer, the table of contents
Dave Love <fx@gnu.org>
parents:
diff changeset
406 buffer, or the index buffer.@refill
Dave Love <fx@gnu.org>
parents:
diff changeset
407
Dave Love <fx@gnu.org>
parents:
diff changeset
408 @item
Dave Love <fx@gnu.org>
parents:
diff changeset
409 @b{AUCTeX} @* If your major LaTeX mode is AUCTeX, @b{Ref@TeX{}} can
Dave Love <fx@gnu.org>
parents:
diff changeset
410 cooperate with it (see variable @code{reftex-plug-into-AUCTeX}). AUCTeX
Dave Love <fx@gnu.org>
parents:
diff changeset
411 contains style files which trigger appropriate settings in
Dave Love <fx@gnu.org>
parents:
diff changeset
412 @b{Ref@TeX{}}, so that for many of the popular LaTeX packages no
Dave Love <fx@gnu.org>
parents:
diff changeset
413 additional customizations will be necessary.@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{Useful Settings}@* To make @b{Ref@TeX{}} faster for large documents,
Dave Love <fx@gnu.org>
parents:
diff changeset
417 try these:@refill
Dave Love <fx@gnu.org>
parents:
diff changeset
418 @lisp
Dave Love <fx@gnu.org>
parents:
diff changeset
419 (setq reftex-enable-partial-scans t)
Dave Love <fx@gnu.org>
parents:
diff changeset
420 (setq reftex-save-parse-info t)
Dave Love <fx@gnu.org>
parents:
diff changeset
421 (setq reftex-use-multiple-selection-buffers t)
Dave Love <fx@gnu.org>
parents:
diff changeset
422 @end lisp
Dave Love <fx@gnu.org>
parents:
diff changeset
423
Dave Love <fx@gnu.org>
parents:
diff changeset
424 To integrate with AUCTeX, use
Dave Love <fx@gnu.org>
parents:
diff changeset
425 @lisp
Dave Love <fx@gnu.org>
parents:
diff changeset
426 (setq reftex-plug-into-AUCTeX t)
Dave Love <fx@gnu.org>
parents:
diff changeset
427 @end lisp
Dave Love <fx@gnu.org>
parents:
diff changeset
428
Dave Love <fx@gnu.org>
parents:
diff changeset
429 To make your own LaTeX macro definitions known to @b{Ref@TeX{}},
Dave Love <fx@gnu.org>
parents:
diff changeset
430 customize the variables@refill
Dave Love <fx@gnu.org>
parents:
diff changeset
431 @example
Dave Love <fx@gnu.org>
parents:
diff changeset
432 @code{reftex-label-alist} @r{(for label macros/environments)}
Dave Love <fx@gnu.org>
parents:
diff changeset
433 @code{reftex-section-levels} @r{(for sectioning commands)}
Dave Love <fx@gnu.org>
parents:
diff changeset
434 @code{reftex-cite-format} @r{(for @code{\cite}-like macros)}
Dave Love <fx@gnu.org>
parents:
diff changeset
435 @code{reftex-index-macros} @r{(for @code{\index}-like macros)}
Dave Love <fx@gnu.org>
parents:
diff changeset
436 @code{reftex-index-default-macro} @r{(to set the default macro)}
Dave Love <fx@gnu.org>
parents:
diff changeset
437 @end example
Dave Love <fx@gnu.org>
parents:
diff changeset
438 If you have a large number of macros defined, you may want to write
Dave Love <fx@gnu.org>
parents:
diff changeset
439 an AUCTeX style file to support them with both AUCTeX and
Dave Love <fx@gnu.org>
parents:
diff changeset
440 @b{Ref@TeX{}}.@refill
Dave Love <fx@gnu.org>
parents:
diff changeset
441
Dave Love <fx@gnu.org>
parents:
diff changeset
442 @item @b{Where Next?}@* Go ahead and use @b{Ref@TeX{}}. Use its menus
Dave Love <fx@gnu.org>
parents:
diff changeset
443 until you have picked up the key bindings. For an overview of what you
Dave Love <fx@gnu.org>
parents:
diff changeset
444 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
445 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
446 available. The first part of the manual explains in
25829
Dave Love <fx@gnu.org>
parents:
diff changeset
447 a tutorial way how to use and customize @b{Ref@TeX{}}. The second
Dave Love <fx@gnu.org>
parents:
diff changeset
448 part is a command and variable reference.@refill
Dave Love <fx@gnu.org>
parents:
diff changeset
449 @end enumerate
Dave Love <fx@gnu.org>
parents:
diff changeset
450
Dave Love <fx@gnu.org>
parents:
diff changeset
451 @node Table of Contents, Labels and References, Introduction, Top
Dave Love <fx@gnu.org>
parents:
diff changeset
452 @chapter Table of Contents
Dave Love <fx@gnu.org>
parents:
diff changeset
453 @cindex @file{*toc*} buffer
Dave Love <fx@gnu.org>
parents:
diff changeset
454 @cindex Table of contents buffer
Dave Love <fx@gnu.org>
parents:
diff changeset
455 @findex reftex-toc
Dave Love <fx@gnu.org>
parents:
diff changeset
456 @kindex C-c =
Dave Love <fx@gnu.org>
parents:
diff changeset
457
Dave Love <fx@gnu.org>
parents:
diff changeset
458 Pressing the keys @kbd{C-c =} pops up a buffer showing the table of
Dave Love <fx@gnu.org>
parents:
diff changeset
459 contents of the document. By default, this @file{*toc*} buffer shows
Dave Love <fx@gnu.org>
parents:
diff changeset
460 only the sections of a document. Using the @kbd{l} and @kbd{i} keys you
Dave Love <fx@gnu.org>
parents:
diff changeset
461 can display all labels and index entries defined in the document as
Dave Love <fx@gnu.org>
parents:
diff changeset
462 well.@refill
Dave Love <fx@gnu.org>
parents:
diff changeset
463
Dave Love <fx@gnu.org>
parents:
diff changeset
464 With the cursor in any of the lines denoting a location in the
Dave Love <fx@gnu.org>
parents:
diff changeset
465 document, simple key strokes will display the corresponding part in
Dave Love <fx@gnu.org>
parents:
diff changeset
466 another window, jump to that location, or perform other actions.@refill
Dave Love <fx@gnu.org>
parents:
diff changeset
467
Dave Love <fx@gnu.org>
parents:
diff changeset
468 @kindex ?
Dave Love <fx@gnu.org>
parents:
diff changeset
469 Here is a list of special commands in the @file{*toc*} buffer. A
Dave Love <fx@gnu.org>
parents:
diff changeset
470 summary of this information is always available by pressing
Dave Love <fx@gnu.org>
parents:
diff changeset
471 @kbd{?}.@refill
Dave Love <fx@gnu.org>
parents:
diff changeset
472
Dave Love <fx@gnu.org>
parents:
diff changeset
473 @table @kbd
Dave Love <fx@gnu.org>
parents:
diff changeset
474
Dave Love <fx@gnu.org>
parents:
diff changeset
475 @tablesubheading{General}
Dave Love <fx@gnu.org>
parents:
diff changeset
476 @item ?
Dave Love <fx@gnu.org>
parents:
diff changeset
477 Display a summary of commands.
Dave Love <fx@gnu.org>
parents:
diff changeset
478
Dave Love <fx@gnu.org>
parents:
diff changeset
479 @item 0-9, -
Dave Love <fx@gnu.org>
parents:
diff changeset
480 Prefix argument.
Dave Love <fx@gnu.org>
parents:
diff changeset
481
Dave Love <fx@gnu.org>
parents:
diff changeset
482 @tablesubheading{Moving around}
Dave Love <fx@gnu.org>
parents:
diff changeset
483 @item n
Dave Love <fx@gnu.org>
parents:
diff changeset
484 Goto next entry in the table of context.
Dave Love <fx@gnu.org>
parents:
diff changeset
485
Dave Love <fx@gnu.org>
parents:
diff changeset
486 @item p
Dave Love <fx@gnu.org>
parents:
diff changeset
487 Goto previous entry in the table of context.
Dave Love <fx@gnu.org>
parents:
diff changeset
488
Dave Love <fx@gnu.org>
parents:
diff changeset
489 @item C-c C-n
Dave Love <fx@gnu.org>
parents:
diff changeset
490 Goto next section heading. Useful when many labels and index entries
Dave Love <fx@gnu.org>
parents:
diff changeset
491 separate section headings.@refill
Dave Love <fx@gnu.org>
parents:
diff changeset
492
Dave Love <fx@gnu.org>
parents:
diff changeset
493 @item C-c C-p
Dave Love <fx@gnu.org>
parents:
diff changeset
494 Goto previous section heading.
Dave Love <fx@gnu.org>
parents:
diff changeset
495
37999
8e7df927fd92 Updated to version 4.16
Carsten Dominik <dominik@science.uva.nl>
parents: 37404
diff changeset
496 @item N z
8e7df927fd92 Updated to version 4.16
Carsten Dominik <dominik@science.uva.nl>
parents: 37404
diff changeset
497 Jump to section N, using the prefix arg. For example, @kbd{3 z} jumps
8e7df927fd92 Updated to version 4.16
Carsten Dominik <dominik@science.uva.nl>
parents: 37404
diff changeset
498 to section 3.@refill
8e7df927fd92 Updated to version 4.16
Carsten Dominik <dominik@science.uva.nl>
parents: 37404
diff changeset
499
25829
Dave Love <fx@gnu.org>
parents:
diff changeset
500 @tablesubheading{Access to document locations}
Dave Love <fx@gnu.org>
parents:
diff changeset
501 @item @key{SPC}
Dave Love <fx@gnu.org>
parents:
diff changeset
502 Show the corresponding location in another window. This command does
Dave Love <fx@gnu.org>
parents:
diff changeset
503 @emph{not} select that other window.@refill
Dave Love <fx@gnu.org>
parents:
diff changeset
504
Dave Love <fx@gnu.org>
parents:
diff changeset
505 @item @key{TAB}
Dave Love <fx@gnu.org>
parents:
diff changeset
506 Goto the location in another window.
Dave Love <fx@gnu.org>
parents:
diff changeset
507
Dave Love <fx@gnu.org>
parents:
diff changeset
508 @item @key{RET}
Dave Love <fx@gnu.org>
parents:
diff changeset
509 Go to the location and hide the @file{*toc*} buffer. This will restore
Dave Love <fx@gnu.org>
parents:
diff changeset
510 the window configuration before @code{reftex-toc} (@kbd{C-c =}) was
Dave Love <fx@gnu.org>
parents:
diff changeset
511 called.@refill
Dave Love <fx@gnu.org>
parents:
diff changeset
512
37999
8e7df927fd92 Updated to version 4.16
Carsten Dominik <dominik@science.uva.nl>
parents: 37404
diff changeset
513 @item mouse-2
25829
Dave Love <fx@gnu.org>
parents:
diff changeset
514 @vindex reftex-highlight-selection
Dave Love <fx@gnu.org>
parents:
diff changeset
515 Clicking with mouse button 2 on a line has the same effect as @key{RET}.
Dave Love <fx@gnu.org>
parents:
diff changeset
516 See also variable @code{reftex-highlight-selection}, @ref{Options
Dave Love <fx@gnu.org>
parents:
diff changeset
517 (Fontification)}.@refill
Dave Love <fx@gnu.org>
parents:
diff changeset
518
Dave Love <fx@gnu.org>
parents:
diff changeset
519 @item f
Dave Love <fx@gnu.org>
parents:
diff changeset
520 @vindex reftex-toc-follow-mode
Dave Love <fx@gnu.org>
parents:
diff changeset
521 @vindex reftex-revisit-to-follow
Dave Love <fx@gnu.org>
parents:
diff changeset
522 Toggle follow mode. When follow mode is active, the other window will
Dave Love <fx@gnu.org>
parents:
diff changeset
523 always show the location corresponding to the line at point in the
Dave Love <fx@gnu.org>
parents:
diff changeset
524 @file{*toc*} buffer. This is similar to pressing @key{SPC} after each
Dave Love <fx@gnu.org>
parents:
diff changeset
525 cursor motion. The default for this flag can be set with the variable
Dave Love <fx@gnu.org>
parents:
diff changeset
526 @code{reftex-toc-follow-mode}. Note that only context in files already
Dave Love <fx@gnu.org>
parents:
diff changeset
527 visited is shown. @b{Ref@TeX{}} will not visit a file just for follow
Dave Love <fx@gnu.org>
parents:
diff changeset
528 mode. See, however, the variable
Dave Love <fx@gnu.org>
parents:
diff changeset
529 @code{reftex-revisit-to-follow}.@refill
Dave Love <fx@gnu.org>
parents:
diff changeset
530
Dave Love <fx@gnu.org>
parents:
diff changeset
531 @item .
Dave Love <fx@gnu.org>
parents:
diff changeset
532 Show calling point in another window. This is the point from where
Dave Love <fx@gnu.org>
parents:
diff changeset
533 @code{reftex-toc} was last called.
Dave Love <fx@gnu.org>
parents:
diff changeset
534
Dave Love <fx@gnu.org>
parents:
diff changeset
535 @tablesubheading{Exiting}
Dave Love <fx@gnu.org>
parents:
diff changeset
536 @item q
Dave Love <fx@gnu.org>
parents:
diff changeset
537 Hide the @file{*toc*} buffer, return to the position where
Dave Love <fx@gnu.org>
parents:
diff changeset
538 @code{reftex-toc} was last called.@refill
Dave Love <fx@gnu.org>
parents:
diff changeset
539
Dave Love <fx@gnu.org>
parents:
diff changeset
540 @item k
Dave Love <fx@gnu.org>
parents:
diff changeset
541 Kill the @file{*toc*} buffer, return to the position where
Dave Love <fx@gnu.org>
parents:
diff changeset
542 @code{reftex-toc} was last called.@refill
Dave Love <fx@gnu.org>
parents:
diff changeset
543
Dave Love <fx@gnu.org>
parents:
diff changeset
544 @item C-c >
Dave Love <fx@gnu.org>
parents:
diff changeset
545 Switch to the @file{*Index*} buffer of this document. With prefix
Dave Love <fx@gnu.org>
parents:
diff changeset
546 @samp{2}, restrict the index to the section at point in the @file{*toc*}
Dave Love <fx@gnu.org>
parents:
diff changeset
547 buffer.
Dave Love <fx@gnu.org>
parents:
diff changeset
548
Dave Love <fx@gnu.org>
parents:
diff changeset
549 @tablesubheading{Controlling what gets displayed}
Dave Love <fx@gnu.org>
parents:
diff changeset
550
26911
d7f536a01276 Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents: 25829
diff changeset
551 @item t
d7f536a01276 Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents: 25829
diff changeset
552 @vindex reftex-toc-max-level
d7f536a01276 Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents: 25829
diff changeset
553 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
554 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
555 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
556 @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
557 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
558 depth can be configured with the variable
d7f536a01276 Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents: 25829
diff changeset
559 @code{reftex-toc-max-level}.@refill
d7f536a01276 Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents: 25829
diff changeset
560
25829
Dave Love <fx@gnu.org>
parents:
diff changeset
561 @item F
Dave Love <fx@gnu.org>
parents:
diff changeset
562 @vindex reftex-toc-include-file-boundaries
Dave Love <fx@gnu.org>
parents:
diff changeset
563 Toggle the display of the file borders of a multifile document in the
Dave Love <fx@gnu.org>
parents:
diff changeset
564 @file{*toc*} buffer. The default for this flag can be set with the
Dave Love <fx@gnu.org>
parents:
diff changeset
565 variable @code{reftex-toc-include-file-boundaries}.@refill
Dave Love <fx@gnu.org>
parents:
diff changeset
566
Dave Love <fx@gnu.org>
parents:
diff changeset
567 @item l
Dave Love <fx@gnu.org>
parents:
diff changeset
568 @vindex reftex-toc-include-labels
Dave Love <fx@gnu.org>
parents:
diff changeset
569 Toggle the display of labels in the @file{*toc*} buffer. The default
Dave Love <fx@gnu.org>
parents:
diff changeset
570 for this flag can be set with the variable
Dave Love <fx@gnu.org>
parents:
diff changeset
571 @code{reftex-toc-include-labels}. When called with a prefix argument,
Dave Love <fx@gnu.org>
parents:
diff changeset
572 @b{Ref@TeX{}} will prompt for a label type and include only labels of
Dave Love <fx@gnu.org>
parents:
diff changeset
573 the selected type in the @file{*toc*} buffer. The mode line @samp{L<>}
Dave Love <fx@gnu.org>
parents:
diff changeset
574 indicator shows which labels are included.@refill
Dave Love <fx@gnu.org>
parents:
diff changeset
575
Dave Love <fx@gnu.org>
parents:
diff changeset
576 @item i
Dave Love <fx@gnu.org>
parents:
diff changeset
577 @vindex reftex-toc-include-index-entries
Dave Love <fx@gnu.org>
parents:
diff changeset
578 Toggle the display of index entries in the @file{*toc*} buffer. The
Dave Love <fx@gnu.org>
parents:
diff changeset
579 default for this flag can be set with the variable
Dave Love <fx@gnu.org>
parents:
diff changeset
580 @code{reftex-toc-include-index-entries}. When called with a prefix
Dave Love <fx@gnu.org>
parents:
diff changeset
581 argument, @b{Ref@TeX{}} will prompt for a specific index and include
Dave Love <fx@gnu.org>
parents:
diff changeset
582 only entries in the selected index in the @file{*toc*} buffer. The mode
Dave Love <fx@gnu.org>
parents:
diff changeset
583 line @samp{I<>} indicator shows which index is used.@refill
Dave Love <fx@gnu.org>
parents:
diff changeset
584
Dave Love <fx@gnu.org>
parents:
diff changeset
585 @item c
Dave Love <fx@gnu.org>
parents:
diff changeset
586 @vindex reftex-toc-include-context
Dave Love <fx@gnu.org>
parents:
diff changeset
587 Toggle the display of label and index context in the @file{*toc*}
Dave Love <fx@gnu.org>
parents:
diff changeset
588 buffer. The default for this flag can be set with the variable
Dave Love <fx@gnu.org>
parents:
diff changeset
589 @code{reftex-toc-include-context}.@refill
Dave Love <fx@gnu.org>
parents:
diff changeset
590
Dave Love <fx@gnu.org>
parents:
diff changeset
591 @tablesubheading{Updating the buffer}
Dave Love <fx@gnu.org>
parents:
diff changeset
592
Dave Love <fx@gnu.org>
parents:
diff changeset
593 @item g
Dave Love <fx@gnu.org>
parents:
diff changeset
594 Rebuild the @file{*toc*} buffer. This does @emph{not} rescan the
Dave Love <fx@gnu.org>
parents:
diff changeset
595 document.@refill
Dave Love <fx@gnu.org>
parents:
diff changeset
596
Dave Love <fx@gnu.org>
parents:
diff changeset
597 @item r
Dave Love <fx@gnu.org>
parents:
diff changeset
598 @vindex reftex-enable-partial-scans
Dave Love <fx@gnu.org>
parents:
diff changeset
599 Reparse the LaTeX document and rebuild the @file{*toc*} buffer. When
Dave Love <fx@gnu.org>
parents:
diff changeset
600 @code{reftex-enable-partial-scans} is non-nil, rescan only the file this
Dave Love <fx@gnu.org>
parents:
diff changeset
601 location is defined in, not the entire document.@refill
Dave Love <fx@gnu.org>
parents:
diff changeset
602
Dave Love <fx@gnu.org>
parents:
diff changeset
603 @item C-u r
Dave Love <fx@gnu.org>
parents:
diff changeset
604 Reparse the @emph{entire} LaTeX document and rebuild the @file{*toc*}
Dave Love <fx@gnu.org>
parents:
diff changeset
605 buffer.@refill
Dave Love <fx@gnu.org>
parents:
diff changeset
606
Dave Love <fx@gnu.org>
parents:
diff changeset
607 @item x
Dave Love <fx@gnu.org>
parents:
diff changeset
608 Switch to the @file{*toc*} buffer of an external document. When the
Dave Love <fx@gnu.org>
parents:
diff changeset
609 current document is using the @code{xr} package (@pxref{xr (LaTeX
Dave Love <fx@gnu.org>
parents:
diff changeset
610 package)}), @b{Ref@TeX{}} will switch to one of the external
Dave Love <fx@gnu.org>
parents:
diff changeset
611 documents.@refill
Dave Love <fx@gnu.org>
parents:
diff changeset
612
Dave Love <fx@gnu.org>
parents:
diff changeset
613 @end table
Dave Love <fx@gnu.org>
parents:
diff changeset
614
Dave Love <fx@gnu.org>
parents:
diff changeset
615 @vindex reftex-toc-map
Dave Love <fx@gnu.org>
parents:
diff changeset
616 In order to define additional commands for the @file{*toc*} buffer, the
Dave Love <fx@gnu.org>
parents:
diff changeset
617 keymap @code{reftex-toc-map} may be used.@refill
Dave Love <fx@gnu.org>
parents:
diff changeset
618
Dave Love <fx@gnu.org>
parents:
diff changeset
619 @cindex Sectioning commands
Dave Love <fx@gnu.org>
parents:
diff changeset
620 @cindex KOMA-Script, LaTeX classes
Dave Love <fx@gnu.org>
parents:
diff changeset
621 @cindex LaTeX classes, KOMA-Script
26911
d7f536a01276 Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents: 25829
diff changeset
622 @cindex TOC entries for environments
25829
Dave Love <fx@gnu.org>
parents:
diff changeset
623 @vindex reftex-section-levels
Dave Love <fx@gnu.org>
parents:
diff changeset
624 The section macros recognized by @b{Ref@TeX{}} are all LaTeX section
Dave Love <fx@gnu.org>
parents:
diff changeset
625 macros (from @code{\part} to @code{\subsubparagraph}) and the commands
Dave Love <fx@gnu.org>
parents:
diff changeset
626 @code{\addchap} and @code{\addsec} from the KOMA-Script classes.
Dave Love <fx@gnu.org>
parents:
diff changeset
627 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
628 @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
629 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
630 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
631 example.
25829
Dave Love <fx@gnu.org>
parents:
diff changeset
632
Dave Love <fx@gnu.org>
parents:
diff changeset
633 @node Labels and References, Citations, Table of Contents, Top
Dave Love <fx@gnu.org>
parents:
diff changeset
634 @chapter Labels and References
Dave Love <fx@gnu.org>
parents:
diff changeset
635 @cindex Labels in LaTeX
Dave Love <fx@gnu.org>
parents:
diff changeset
636 @cindex References in LaTeX
Dave Love <fx@gnu.org>
parents:
diff changeset
637 @cindex Label category
Dave Love <fx@gnu.org>
parents:
diff changeset
638 @cindex Label environment
Dave Love <fx@gnu.org>
parents:
diff changeset
639 @cindex @code{\label}
Dave Love <fx@gnu.org>
parents:
diff changeset
640
Dave Love <fx@gnu.org>
parents:
diff changeset
641 LaTeX provides a powerful mechanism to deal with cross--references in a
Dave Love <fx@gnu.org>
parents:
diff changeset
642 document. When writing a document, any part of it can be marked with a
Dave Love <fx@gnu.org>
parents:
diff changeset
643 label, like @samp{\label@{mark@}}. LaTeX records the current value of a
Dave Love <fx@gnu.org>
parents:
diff changeset
644 certain counter when a label is defined. Later references to this label
Dave Love <fx@gnu.org>
parents:
diff changeset
645 (like @samp{\ref@{mark@}}) will produce the recorded value of the
Dave Love <fx@gnu.org>
parents:
diff changeset
646 counter.@refill
Dave Love <fx@gnu.org>
parents:
diff changeset
647
Dave Love <fx@gnu.org>
parents:
diff changeset
648 Labels can be used to mark sections, figures, tables, equations,
Dave Love <fx@gnu.org>
parents:
diff changeset
649 footnotes, items in enumerate lists etc. LaTeX is context sensitive in
Dave Love <fx@gnu.org>
parents:
diff changeset
650 doing this: A label defined in a figure environment automatically
Dave Love <fx@gnu.org>
parents:
diff changeset
651 records the figure counter, not the section counter.@refill
Dave Love <fx@gnu.org>
parents:
diff changeset
652
Dave Love <fx@gnu.org>
parents:
diff changeset
653 Several different environments can share a common counter and therefore
Dave Love <fx@gnu.org>
parents:
diff changeset
654 a common label category. E.g. labels in both @code{equation} and
Dave Love <fx@gnu.org>
parents:
diff changeset
655 @code{eqnarray} environments record the value of the same counter - the
Dave Love <fx@gnu.org>
parents:
diff changeset
656 equation counter.@refill
Dave Love <fx@gnu.org>
parents:
diff changeset
657
Dave Love <fx@gnu.org>
parents:
diff changeset
658 @menu
Dave Love <fx@gnu.org>
parents:
diff changeset
659 * Creating Labels::
Dave Love <fx@gnu.org>
parents:
diff changeset
660 * Referencing Labels::
Dave Love <fx@gnu.org>
parents:
diff changeset
661 * Builtin Label Environments:: The environments RefTeX knows about.
Dave Love <fx@gnu.org>
parents:
diff changeset
662 * Defining Label Environments:: ... and environments it doesn't.
Dave Love <fx@gnu.org>
parents:
diff changeset
663 * Reference Info:: View the label corresponding to a \ref.
Dave Love <fx@gnu.org>
parents:
diff changeset
664 * xr (LaTeX package):: References to external documents.
Dave Love <fx@gnu.org>
parents:
diff changeset
665 * varioref (LaTeX package):: How to create \vref instead of \ref.
Dave Love <fx@gnu.org>
parents:
diff changeset
666 * fancyref (LaTeX package):: How to create \fref instead of \ref.
Dave Love <fx@gnu.org>
parents:
diff changeset
667 @end menu
Dave Love <fx@gnu.org>
parents:
diff changeset
668
Dave Love <fx@gnu.org>
parents:
diff changeset
669 @node Creating Labels, Referencing Labels, , Labels and References
Dave Love <fx@gnu.org>
parents:
diff changeset
670 @section Creating Labels
Dave Love <fx@gnu.org>
parents:
diff changeset
671 @cindex Creating labels
Dave Love <fx@gnu.org>
parents:
diff changeset
672 @cindex Labels, creating
Dave Love <fx@gnu.org>
parents:
diff changeset
673 @cindex Labels, deriving from context
Dave Love <fx@gnu.org>
parents:
diff changeset
674 @kindex C-c (
Dave Love <fx@gnu.org>
parents:
diff changeset
675 @findex reftex-label
Dave Love <fx@gnu.org>
parents:
diff changeset
676
Dave Love <fx@gnu.org>
parents:
diff changeset
677 In order to create a label in a LaTeX document, press @kbd{C-c (}
Dave Love <fx@gnu.org>
parents:
diff changeset
678 (@code{reftex-label}). Just like LaTeX, @b{Ref@TeX{}} is context sensitive
Dave Love <fx@gnu.org>
parents:
diff changeset
679 and will figure out the environment it currently is in and adapt the
Dave Love <fx@gnu.org>
parents:
diff changeset
680 label to that environment. A label usually consists of a short prefix
Dave Love <fx@gnu.org>
parents:
diff changeset
681 indicating the type of the label and a unique mark. @b{Ref@TeX{}} has
Dave Love <fx@gnu.org>
parents:
diff changeset
682 3 different modes to create this mark.@refill
Dave Love <fx@gnu.org>
parents:
diff changeset
683
Dave Love <fx@gnu.org>
parents:
diff changeset
684 @enumerate
Dave Love <fx@gnu.org>
parents:
diff changeset
685 @item
Dave Love <fx@gnu.org>
parents:
diff changeset
686 @vindex reftex-translate-to-ascii-function
Dave Love <fx@gnu.org>
parents:
diff changeset
687 @vindex reftex-derive-label-parameters
Dave Love <fx@gnu.org>
parents:
diff changeset
688 @vindex reftex-label-illegal-re
Dave Love <fx@gnu.org>
parents:
diff changeset
689 @vindex reftex-abbrev-parameters
Dave Love <fx@gnu.org>
parents:
diff changeset
690 A label can be derived from context. This means, @b{Ref@TeX{}} takes
Dave Love <fx@gnu.org>
parents:
diff changeset
691 the context of the label definition and constructs a label from
Dave Love <fx@gnu.org>
parents:
diff changeset
692 that@footnote{Note that the context may contain constructs which are
Dave Love <fx@gnu.org>
parents:
diff changeset
693 illegal in labels. @b{Ref@TeX{}} will therefore strip the accent from
Dave Love <fx@gnu.org>
parents:
diff changeset
694 accented Latin-1 characters and remove everything else which is not
Dave Love <fx@gnu.org>
parents:
diff changeset
695 legal in labels. This mechanism is safe, but may not be satisfactory
Dave Love <fx@gnu.org>
parents:
diff changeset
696 for non-western languages. Check the following variables if you need to
Dave Love <fx@gnu.org>
parents:
diff changeset
697 change things: @code{reftex-translate-to-ascii-function},
Dave Love <fx@gnu.org>
parents:
diff changeset
698 @code{reftex-derive-label-parameters}, @code{reftex-label-illegal-re},
Dave Love <fx@gnu.org>
parents:
diff changeset
699 @code{reftex-abbrev-parameters}.}. This works best for section labels,
Dave Love <fx@gnu.org>
parents:
diff changeset
700 where the section heading is used to construct a label. In fact,
Dave Love <fx@gnu.org>
parents:
diff changeset
701 @b{Ref@TeX{}}'s default settings use this method only for section
Dave Love <fx@gnu.org>
parents:
diff changeset
702 labels. You will be asked to confirm the derived label, or edit
Dave Love <fx@gnu.org>
parents:
diff changeset
703 it.@refill
Dave Love <fx@gnu.org>
parents:
diff changeset
704
Dave Love <fx@gnu.org>
parents:
diff changeset
705 @item
Dave Love <fx@gnu.org>
parents:
diff changeset
706 We may also use a simple unique number to identify a label. This is
Dave Love <fx@gnu.org>
parents:
diff changeset
707 mostly useful for labels where it is difficult to come up with a very
Dave Love <fx@gnu.org>
parents:
diff changeset
708 good descriptive name. @b{Ref@TeX{}}'s default settings use this method
Dave Love <fx@gnu.org>
parents:
diff changeset
709 for equations, enumerate items and footnotes. The author of @b{Ref@TeX{}}
Dave Love <fx@gnu.org>
parents:
diff changeset
710 tends to write documents with many equations and finds it impossible
Dave Love <fx@gnu.org>
parents:
diff changeset
711 to come up with good names for each of them. These simple labels are
Dave Love <fx@gnu.org>
parents:
diff changeset
712 inserted without query, and are therefore very fast. Good descriptive
Dave Love <fx@gnu.org>
parents:
diff changeset
713 names are not really necessary as @b{Ref@TeX{}} will provide context to
Dave Love <fx@gnu.org>
parents:
diff changeset
714 reference a label (@pxref{Referencing Labels}).@refill
Dave Love <fx@gnu.org>
parents:
diff changeset
715
Dave Love <fx@gnu.org>
parents:
diff changeset
716 @item
Dave Love <fx@gnu.org>
parents:
diff changeset
717 The third method is to ask the user for a label. This is most
Dave Love <fx@gnu.org>
parents:
diff changeset
718 useful for things which are easy to describe briefly and do not turn up
Dave Love <fx@gnu.org>
parents:
diff changeset
719 too frequently in a document. @b{Ref@TeX{}} uses this for figures and
Dave Love <fx@gnu.org>
parents:
diff changeset
720 tables. Of course, one can enter the label directly by typing the full
Dave Love <fx@gnu.org>
parents:
diff changeset
721 @samp{\label@{mark@}}. The advantage of using @code{reftex-label}
Dave Love <fx@gnu.org>
parents:
diff changeset
722 anyway is that @b{Ref@TeX{}} will know that a new label has been defined.
Dave Love <fx@gnu.org>
parents:
diff changeset
723 It will then not be necessary to rescan the document in order to access
Dave Love <fx@gnu.org>
parents:
diff changeset
724 this label later.@refill
Dave Love <fx@gnu.org>
parents:
diff changeset
725 @end enumerate
Dave Love <fx@gnu.org>
parents:
diff changeset
726
Dave Love <fx@gnu.org>
parents:
diff changeset
727 @vindex reftex-insert-label-flags
Dave Love <fx@gnu.org>
parents:
diff changeset
728 If you want to change the way certain labels are created, check out the
Dave Love <fx@gnu.org>
parents:
diff changeset
729 variable @code{reftex-insert-label-flags} (@pxref{Options (Creating
Dave Love <fx@gnu.org>
parents:
diff changeset
730 Labels)}).@refill
Dave Love <fx@gnu.org>
parents:
diff changeset
731
Dave Love <fx@gnu.org>
parents:
diff changeset
732 If you are using AUCTeX to write your LaTeX documents, you can
Dave Love <fx@gnu.org>
parents:
diff changeset
733 set it up to delegate the creation of labels to
Dave Love <fx@gnu.org>
parents:
diff changeset
734 @b{Ref@TeX{}}. @xref{AUCTeX}, for more information.
Dave Love <fx@gnu.org>
parents:
diff changeset
735
Dave Love <fx@gnu.org>
parents:
diff changeset
736 @node Referencing Labels, Builtin Label Environments, Creating Labels, Labels and References
Dave Love <fx@gnu.org>
parents:
diff changeset
737 @section Referencing Labels
Dave Love <fx@gnu.org>
parents:
diff changeset
738 @cindex Referencing labels
Dave Love <fx@gnu.org>
parents:
diff changeset
739 @cindex Labels, referencing
Dave Love <fx@gnu.org>
parents:
diff changeset
740 @cindex Selection buffer, labels
Dave Love <fx@gnu.org>
parents:
diff changeset
741 @cindex Selection process
Dave Love <fx@gnu.org>
parents:
diff changeset
742 @cindex @code{\ref}
Dave Love <fx@gnu.org>
parents:
diff changeset
743 @kindex C-c )
Dave Love <fx@gnu.org>
parents:
diff changeset
744 @findex reftex-reference
Dave Love <fx@gnu.org>
parents:
diff changeset
745
Dave Love <fx@gnu.org>
parents:
diff changeset
746 Referencing Labels is really at the heart of @b{Ref@TeX{}}. Press @kbd{C-c
Dave Love <fx@gnu.org>
parents:
diff changeset
747 )} in order to reference a label (reftex-reference). This will start a
Dave Love <fx@gnu.org>
parents:
diff changeset
748 selection process and finally insert the complete @samp{\ref@{label@}}
Dave Love <fx@gnu.org>
parents:
diff changeset
749 into the buffer.@refill
Dave Love <fx@gnu.org>
parents:
diff changeset
750
Dave Love <fx@gnu.org>
parents:
diff changeset
751 First, @b{Ref@TeX{}} will determine the label category which is required.
Dave Love <fx@gnu.org>
parents:
diff changeset
752 Often that can be figured out from context. For example, if you
Dave Love <fx@gnu.org>
parents:
diff changeset
753 write @samp{As shown in eq.} and the press @kbd{C-c )}, @b{Ref@TeX{}} knows
Dave Love <fx@gnu.org>
parents:
diff changeset
754 that an equation label is going to be referenced. If it cannot figure
Dave Love <fx@gnu.org>
parents:
diff changeset
755 out what label category is needed, it will query for one.@refill
Dave Love <fx@gnu.org>
parents:
diff changeset
756
Dave Love <fx@gnu.org>
parents:
diff changeset
757 You will then be presented with a label selection menu. This is a
Dave Love <fx@gnu.org>
parents:
diff changeset
758 special buffer which contains an outline of the document along with all
Dave Love <fx@gnu.org>
parents:
diff changeset
759 labels of the given label category. In addition, next to the label
Dave Love <fx@gnu.org>
parents:
diff changeset
760 there will be one line of context of the label definition, which is some
Dave Love <fx@gnu.org>
parents:
diff changeset
761 text in the buffer near the label definition. Usually this is
Dave Love <fx@gnu.org>
parents:
diff changeset
762 sufficient to identify the label. If you are unsure about a certain
Dave Love <fx@gnu.org>
parents:
diff changeset
763 label, pressing @key{SPC} will show the label definition point in
Dave Love <fx@gnu.org>
parents:
diff changeset
764 another window.@refill
Dave Love <fx@gnu.org>
parents:
diff changeset
765
Dave Love <fx@gnu.org>
parents:
diff changeset
766 In order to reference a label, move to cursor to the correct label and
Dave Love <fx@gnu.org>
parents:
diff changeset
767 press @key{RET}. You can also reference several labels with a single
Dave Love <fx@gnu.org>
parents:
diff changeset
768 call to @code{reftex-reference} by marking entries with the @kbd{m}
Dave Love <fx@gnu.org>
parents:
diff changeset
769 key (see below).
Dave Love <fx@gnu.org>
parents:
diff changeset
770
Dave Love <fx@gnu.org>
parents:
diff changeset
771 @kindex ?
Dave Love <fx@gnu.org>
parents:
diff changeset
772 Here is a list of special commands in the selection buffer. A summary
Dave Love <fx@gnu.org>
parents:
diff changeset
773 of this information is always available from the selection process by
Dave Love <fx@gnu.org>
parents:
diff changeset
774 pressing @kbd{?}.@refill
Dave Love <fx@gnu.org>
parents:
diff changeset
775
Dave Love <fx@gnu.org>
parents:
diff changeset
776
Dave Love <fx@gnu.org>
parents:
diff changeset
777
Dave Love <fx@gnu.org>
parents:
diff changeset
778 @table @kbd
Dave Love <fx@gnu.org>
parents:
diff changeset
779 @tablesubheading{General}
Dave Love <fx@gnu.org>
parents:
diff changeset
780 @item ?
Dave Love <fx@gnu.org>
parents:
diff changeset
781 Show a summary of available commands.
Dave Love <fx@gnu.org>
parents:
diff changeset
782
Dave Love <fx@gnu.org>
parents:
diff changeset
783 @item 0-9,-
Dave Love <fx@gnu.org>
parents:
diff changeset
784 Prefix argument.
Dave Love <fx@gnu.org>
parents:
diff changeset
785
Dave Love <fx@gnu.org>
parents:
diff changeset
786 @tablesubheading{Moving around}
Dave Love <fx@gnu.org>
parents:
diff changeset
787 @item n
Dave Love <fx@gnu.org>
parents:
diff changeset
788 Go to next label.
Dave Love <fx@gnu.org>
parents:
diff changeset
789
Dave Love <fx@gnu.org>
parents:
diff changeset
790 @item p
Dave Love <fx@gnu.org>
parents:
diff changeset
791 Go to previous label.
Dave Love <fx@gnu.org>
parents:
diff changeset
792
Dave Love <fx@gnu.org>
parents:
diff changeset
793 @item b
Dave Love <fx@gnu.org>
parents:
diff changeset
794 Jump back to the position where you last left the selection buffer.
Dave Love <fx@gnu.org>
parents:
diff changeset
795 Normally this should get you back to the last referenced label.@refill
Dave Love <fx@gnu.org>
parents:
diff changeset
796
Dave Love <fx@gnu.org>
parents:
diff changeset
797 @item C-c C-n
Dave Love <fx@gnu.org>
parents:
diff changeset
798 Goto next section heading.
Dave Love <fx@gnu.org>
parents:
diff changeset
799
Dave Love <fx@gnu.org>
parents:
diff changeset
800 @item C-c C-p
Dave Love <fx@gnu.org>
parents:
diff changeset
801 Goto previous section heading.
Dave Love <fx@gnu.org>
parents:
diff changeset
802
37999
8e7df927fd92 Updated to version 4.16
Carsten Dominik <dominik@science.uva.nl>
parents: 37404
diff changeset
803 @item N z
8e7df927fd92 Updated to version 4.16
Carsten Dominik <dominik@science.uva.nl>
parents: 37404
diff changeset
804 Jump to section N, using the prefix arg. For example @kbd{3 z} jumps to
8e7df927fd92 Updated to version 4.16
Carsten Dominik <dominik@science.uva.nl>
parents: 37404
diff changeset
805 section 3.@refill
8e7df927fd92 Updated to version 4.16
Carsten Dominik <dominik@science.uva.nl>
parents: 37404
diff changeset
806
25829
Dave Love <fx@gnu.org>
parents:
diff changeset
807 @tablesubheading{Displaying Context}
Dave Love <fx@gnu.org>
parents:
diff changeset
808 @item @key{SPC}
Dave Love <fx@gnu.org>
parents:
diff changeset
809 Show the surroundings of the definition of the current label in another
Dave Love <fx@gnu.org>
parents:
diff changeset
810 window. See also the @kbd{f} key.@refill
Dave Love <fx@gnu.org>
parents:
diff changeset
811
Dave Love <fx@gnu.org>
parents:
diff changeset
812 @item f
Dave Love <fx@gnu.org>
parents:
diff changeset
813 @vindex reftex-revisit-to-follow
Dave Love <fx@gnu.org>
parents:
diff changeset
814 Toggle follow mode. When follow mode is active, the other window will
Dave Love <fx@gnu.org>
parents:
diff changeset
815 always display the full context of the current label. This is similar
Dave Love <fx@gnu.org>
parents:
diff changeset
816 to pressing @key{SPC} after each cursor motion. Note that only context
Dave Love <fx@gnu.org>
parents:
diff changeset
817 in files already visited is shown. @b{RefTeX} will not visit a file
Dave Love <fx@gnu.org>
parents:
diff changeset
818 just for follow mode. See, however, the variable
Dave Love <fx@gnu.org>
parents:
diff changeset
819 @code{reftex-revisit-to-follow}.@refill
Dave Love <fx@gnu.org>
parents:
diff changeset
820
Dave Love <fx@gnu.org>
parents:
diff changeset
821 @item .
Dave Love <fx@gnu.org>
parents:
diff changeset
822 Show insertion point in another window. This is the point from where you
Dave Love <fx@gnu.org>
parents:
diff changeset
823 called @code{reftex-reference}.@refill
Dave Love <fx@gnu.org>
parents:
diff changeset
824
Dave Love <fx@gnu.org>
parents:
diff changeset
825 @tablesubheading{Selecting a label and creating the reference}
Dave Love <fx@gnu.org>
parents:
diff changeset
826 @item @key{RET}
Dave Love <fx@gnu.org>
parents:
diff changeset
827 Insert a reference to the label at point into the buffer from which the
Dave Love <fx@gnu.org>
parents:
diff changeset
828 selection process was started. When entries have been marked, @key{RET}
Dave Love <fx@gnu.org>
parents:
diff changeset
829 references all marked labels.@refill
Dave Love <fx@gnu.org>
parents:
diff changeset
830
37999
8e7df927fd92 Updated to version 4.16
Carsten Dominik <dominik@science.uva.nl>
parents: 37404
diff changeset
831 @item mouse-2
25829
Dave Love <fx@gnu.org>
parents:
diff changeset
832 @vindex reftex-highlight-selection
Dave Love <fx@gnu.org>
parents:
diff changeset
833 Clicking with mouse button 2 on a label will accept it like @key{RET}
Dave Love <fx@gnu.org>
parents:
diff changeset
834 would. See also variable @code{reftex-highlight-selection}, @ref{Options
Dave Love <fx@gnu.org>
parents:
diff changeset
835 (Misc)}.@refill
Dave Love <fx@gnu.org>
parents:
diff changeset
836
Dave Love <fx@gnu.org>
parents:
diff changeset
837 @vindex reftex-multiref-punctuation
Dave Love <fx@gnu.org>
parents:
diff changeset
838 @item m - + ,
Dave Love <fx@gnu.org>
parents:
diff changeset
839 Mark the current entry. When several entries have been marked, pressing
Dave Love <fx@gnu.org>
parents:
diff changeset
840 @kbd{RET} will accept all of them and place them into several
Dave Love <fx@gnu.org>
parents:
diff changeset
841 @code{\ref} macros. The special markers @samp{,-+} also store a
Dave Love <fx@gnu.org>
parents:
diff changeset
842 separator to be inserted before the corresponding reference. So marking
Dave Love <fx@gnu.org>
parents:
diff changeset
843 six entries with the keys @samp{m , , - , +} will give a reference list
Dave Love <fx@gnu.org>
parents:
diff changeset
844 like this (see the variable @code{reftex-multiref-punctuation})
Dave Love <fx@gnu.org>
parents:
diff changeset
845 @example
Dave Love <fx@gnu.org>
parents:
diff changeset
846 In eqs. (1), (2), (3)--(4), (5) and (6)
Dave Love <fx@gnu.org>
parents:
diff changeset
847 @end example
Dave Love <fx@gnu.org>
parents:
diff changeset
848
Dave Love <fx@gnu.org>
parents:
diff changeset
849 @item u
Dave Love <fx@gnu.org>
parents:
diff changeset
850 Unmark a marked entry.
Dave Love <fx@gnu.org>
parents:
diff changeset
851
Dave Love <fx@gnu.org>
parents:
diff changeset
852 @c FIXME: Do we need `A' as well for consistency?
Dave Love <fx@gnu.org>
parents:
diff changeset
853 @cindex LaTeX packages, @code{saferef}
Dave Love <fx@gnu.org>
parents:
diff changeset
854 @cindex @code{saferef}, LaTeX package
Dave Love <fx@gnu.org>
parents:
diff changeset
855 @item a
Dave Love <fx@gnu.org>
parents:
diff changeset
856 Accept the marked entries and put all labels as a comma-separated list
Dave Love <fx@gnu.org>
parents:
diff changeset
857 into one @emph{single} @code{\ref} macro. Some packages like
Dave Love <fx@gnu.org>
parents:
diff changeset
858 @file{saferef.sty} support multiple references in this way.@refill
Dave Love <fx@gnu.org>
parents:
diff changeset
859
Dave Love <fx@gnu.org>
parents:
diff changeset
860 @item l
Dave Love <fx@gnu.org>
parents:
diff changeset
861 Use the last referenced label(s) again. This is equivalent to moving to
Dave Love <fx@gnu.org>
parents:
diff changeset
862 that label and pressing @key{RET}.@refill
Dave Love <fx@gnu.org>
parents:
diff changeset
863
Dave Love <fx@gnu.org>
parents:
diff changeset
864 @item @key{TAB}
Dave Love <fx@gnu.org>
parents:
diff changeset
865 Enter a label with completion. This may also be a label which does not
Dave Love <fx@gnu.org>
parents:
diff changeset
866 yet exist in the document.
Dave Love <fx@gnu.org>
parents:
diff changeset
867
Dave Love <fx@gnu.org>
parents:
diff changeset
868 @item v
Dave Love <fx@gnu.org>
parents:
diff changeset
869 @cindex @code{varioref}, LaTeX package
Dave Love <fx@gnu.org>
parents:
diff changeset
870 @cindex @code{\vref}
Dave Love <fx@gnu.org>
parents:
diff changeset
871 @cindex LaTeX packages, @code{varioref}
Dave Love <fx@gnu.org>
parents:
diff changeset
872 Toggle between @code{\ref} and @code{\vref} macro for references. The
Dave Love <fx@gnu.org>
parents:
diff changeset
873 @code{\vref} macro is defined in the @code{varioref} LaTeX package.
Dave Love <fx@gnu.org>
parents:
diff changeset
874 With this key you can force @b{Ref@TeX{}} to insert a @code{\vref}
Dave Love <fx@gnu.org>
parents:
diff changeset
875 macro. The current state of this flag is displayed by the @samp{S<>}
Dave Love <fx@gnu.org>
parents:
diff changeset
876 indicator in the mode line of the selection buffer.@refill
Dave Love <fx@gnu.org>
parents:
diff changeset
877
Dave Love <fx@gnu.org>
parents:
diff changeset
878 @item V
Dave Love <fx@gnu.org>
parents:
diff changeset
879 @cindex @code{fancyref}, LaTeX package
Dave Love <fx@gnu.org>
parents:
diff changeset
880 @cindex @code{\fref}
Dave Love <fx@gnu.org>
parents:
diff changeset
881 @cindex @code{\Fref}
Dave Love <fx@gnu.org>
parents:
diff changeset
882 @cindex LaTeX packages, @code{fancyref}
Dave Love <fx@gnu.org>
parents:
diff changeset
883 Cycle between @code{\ref}, @code{\fref} and @code{\Fref}. The
Dave Love <fx@gnu.org>
parents:
diff changeset
884 @code{\fref} and @code{\Fref} macros are defined in the @code{fancyref}
Dave Love <fx@gnu.org>
parents:
diff changeset
885 LaTeX package. With this key you can force @b{Ref@TeX{}} to insert a
Dave Love <fx@gnu.org>
parents:
diff changeset
886 @code{\fref} or @code{\Fref} macro. The current state of this flag is
Dave Love <fx@gnu.org>
parents:
diff changeset
887 displayed by the @samp{S<>} indicator in the mode line of the
Dave Love <fx@gnu.org>
parents:
diff changeset
888 selection buffer.
Dave Love <fx@gnu.org>
parents:
diff changeset
889
Dave Love <fx@gnu.org>
parents:
diff changeset
890 @tablesubheading{Exiting}
Dave Love <fx@gnu.org>
parents:
diff changeset
891
Dave Love <fx@gnu.org>
parents:
diff changeset
892 @item q
Dave Love <fx@gnu.org>
parents:
diff changeset
893 Exit the selection process without inserting any reference into the
Dave Love <fx@gnu.org>
parents:
diff changeset
894 buffer.@refill
Dave Love <fx@gnu.org>
parents:
diff changeset
895
Dave Love <fx@gnu.org>
parents:
diff changeset
896 @tablesubheading{Controlling what gets displayed}
Dave Love <fx@gnu.org>
parents:
diff changeset
897 @vindex reftex-label-menu-flags
Dave Love <fx@gnu.org>
parents:
diff changeset
898 The defaults for the following flags can be configured with the variable
Dave Love <fx@gnu.org>
parents:
diff changeset
899 @code{reftex-label-menu-flags} (@pxref{Options (Referencing Labels)}).
Dave Love <fx@gnu.org>
parents:
diff changeset
900
Dave Love <fx@gnu.org>
parents:
diff changeset
901 @item c
Dave Love <fx@gnu.org>
parents:
diff changeset
902 Toggle the display of the one-line label definition context in the
Dave Love <fx@gnu.org>
parents:
diff changeset
903 selection buffer.@refill
Dave Love <fx@gnu.org>
parents:
diff changeset
904
Dave Love <fx@gnu.org>
parents:
diff changeset
905 @item F
Dave Love <fx@gnu.org>
parents:
diff changeset
906 Toggle the display of the file borders of a multifile document in the
Dave Love <fx@gnu.org>
parents:
diff changeset
907 selection buffer.@refill
Dave Love <fx@gnu.org>
parents:
diff changeset
908
Dave Love <fx@gnu.org>
parents:
diff changeset
909 @item t
26911
d7f536a01276 Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents: 25829
diff changeset
910 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
911 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
912 to @var{arg}. Chapters are level 1, section are level 2.@refill
25829
Dave Love <fx@gnu.org>
parents:
diff changeset
913
Dave Love <fx@gnu.org>
parents:
diff changeset
914 @item #
Dave Love <fx@gnu.org>
parents:
diff changeset
915 Toggle the display of a label counter in the selection buffer.@refill
Dave Love <fx@gnu.org>
parents:
diff changeset
916
Dave Love <fx@gnu.org>
parents:
diff changeset
917 @item %
Dave Love <fx@gnu.org>
parents:
diff changeset
918 Toggle the display of labels hidden in comments in the selection
Dave Love <fx@gnu.org>
parents:
diff changeset
919 buffers. Sometimes, you may have commented out parts of your document.
Dave Love <fx@gnu.org>
parents:
diff changeset
920 If these parts contain label definitions, @b{Ref@TeX{}} can still display
Dave Love <fx@gnu.org>
parents:
diff changeset
921 and reference these labels.@refill
Dave Love <fx@gnu.org>
parents:
diff changeset
922
Dave Love <fx@gnu.org>
parents:
diff changeset
923 @tablesubheading{Updating the buffer}
Dave Love <fx@gnu.org>
parents:
diff changeset
924 @item g
Dave Love <fx@gnu.org>
parents:
diff changeset
925 Update the menu. This will rebuilt the menu from the internal label
Dave Love <fx@gnu.org>
parents:
diff changeset
926 list, but not reparse the document (see @kbd{r}).@refill
Dave Love <fx@gnu.org>
parents:
diff changeset
927
Dave Love <fx@gnu.org>
parents:
diff changeset
928 @item r
Dave Love <fx@gnu.org>
parents:
diff changeset
929 @vindex reftex-enable-partial-scans
Dave Love <fx@gnu.org>
parents:
diff changeset
930 Reparse the document to update the information on all labels and rebuild
Dave Love <fx@gnu.org>
parents:
diff changeset
931 the menu. If the variable @code{reftex-enable-partial-scans} is
Dave Love <fx@gnu.org>
parents:
diff changeset
932 non-@code{nil} and your document is a multifile document, this will
Dave Love <fx@gnu.org>
parents:
diff changeset
933 reparse only a part of the document (the file in which the label at
Dave Love <fx@gnu.org>
parents:
diff changeset
934 point was defined).@refill
Dave Love <fx@gnu.org>
parents:
diff changeset
935
Dave Love <fx@gnu.org>
parents:
diff changeset
936 @item C-u r
Dave Love <fx@gnu.org>
parents:
diff changeset
937 Reparse the @emph{entire} document.
Dave Love <fx@gnu.org>
parents:
diff changeset
938
Dave Love <fx@gnu.org>
parents:
diff changeset
939 @item s
Dave Love <fx@gnu.org>
parents:
diff changeset
940 Switch the label category. After prompting for another label category,
Dave Love <fx@gnu.org>
parents:
diff changeset
941 a menu for that category will be shown.@refill
Dave Love <fx@gnu.org>
parents:
diff changeset
942
Dave Love <fx@gnu.org>
parents:
diff changeset
943 @item x
Dave Love <fx@gnu.org>
parents:
diff changeset
944 Reference a label from an external document. With the LaTeX package
Dave Love <fx@gnu.org>
parents:
diff changeset
945 @code{xr} it is possible to reference labels defined in another
Dave Love <fx@gnu.org>
parents:
diff changeset
946 document. This key will switch to the label menu of an external
Dave Love <fx@gnu.org>
parents:
diff changeset
947 document and let you select a label from there (@pxref{xr (LaTeX
Dave Love <fx@gnu.org>
parents:
diff changeset
948 package),,xr}).@refill
Dave Love <fx@gnu.org>
parents:
diff changeset
949
Dave Love <fx@gnu.org>
parents:
diff changeset
950 @end table
Dave Love <fx@gnu.org>
parents:
diff changeset
951
Dave Love <fx@gnu.org>
parents:
diff changeset
952 @vindex reftex-select-label-map
Dave Love <fx@gnu.org>
parents:
diff changeset
953 In order to define additional commands for the selection process, the
Dave Love <fx@gnu.org>
parents:
diff changeset
954 keymap @code{reftex-select-label-map} may be used.@refill
Dave Love <fx@gnu.org>
parents:
diff changeset
955
Dave Love <fx@gnu.org>
parents:
diff changeset
956 @node Builtin Label Environments, Defining Label Environments, Referencing Labels, Labels and References
Dave Love <fx@gnu.org>
parents:
diff changeset
957 @section Builtin Label Environments
Dave Love <fx@gnu.org>
parents:
diff changeset
958 @cindex Builtin label environments
Dave Love <fx@gnu.org>
parents:
diff changeset
959 @cindex Label environments, builtin
Dave Love <fx@gnu.org>
parents:
diff changeset
960 @cindex Environments, builtin
Dave Love <fx@gnu.org>
parents:
diff changeset
961 @vindex reftex-label-alist
Dave Love <fx@gnu.org>
parents:
diff changeset
962 @vindex reftex-label-alist-builtin
Dave Love <fx@gnu.org>
parents:
diff changeset
963
Dave Love <fx@gnu.org>
parents:
diff changeset
964 @b{Ref@TeX{}} needs to be aware of the environments which can be referenced
Dave Love <fx@gnu.org>
parents:
diff changeset
965 with a label (i.e. which carry their own counters). By default, @b{Ref@TeX{}}
Dave Love <fx@gnu.org>
parents:
diff changeset
966 recognizes all labeled environments and macros discussed in @cite{The
Dave Love <fx@gnu.org>
parents:
diff changeset
967 LaTeX Companion by Goossens, Mittelbach & Samarin, Addison-Wesley
Dave Love <fx@gnu.org>
parents:
diff changeset
968 1994.}. These are:@refill
Dave Love <fx@gnu.org>
parents:
diff changeset
969
Dave Love <fx@gnu.org>
parents:
diff changeset
970 @itemize @minus
Dave Love <fx@gnu.org>
parents:
diff changeset
971 @item
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{figure*}, 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{table*}, LaTeX environment
Dave Love <fx@gnu.org>
parents:
diff changeset
976 @cindex @code{equation}, LaTeX environment
Dave Love <fx@gnu.org>
parents:
diff changeset
977 @cindex @code{eqnarray}, LaTeX environment
Dave Love <fx@gnu.org>
parents:
diff changeset
978 @cindex @code{enumerate}, LaTeX environment
Dave Love <fx@gnu.org>
parents:
diff changeset
979 @cindex @code{\footnote}, LaTeX macro
Dave Love <fx@gnu.org>
parents:
diff changeset
980 @cindex LaTeX macro @code{footnote}
Dave Love <fx@gnu.org>
parents:
diff changeset
981 @cindex LaTeX core
Dave Love <fx@gnu.org>
parents:
diff changeset
982 @code{figure}, @code{figure*}, @code{table}, @code{table*}, @code{equation},
Dave Love <fx@gnu.org>
parents:
diff changeset
983 @code{eqnarray}, @code{enumerate}, the @code{\footnote} macro (this is
Dave Love <fx@gnu.org>
parents:
diff changeset
984 the LaTeX core stuff)@refill
Dave Love <fx@gnu.org>
parents:
diff changeset
985 @item
Dave Love <fx@gnu.org>
parents:
diff changeset
986 @cindex AMS-LaTeX
Dave Love <fx@gnu.org>
parents:
diff changeset
987 @cindex @code{amsmath}, LaTeX package
Dave Love <fx@gnu.org>
parents:
diff changeset
988 @cindex LaTeX packages, @code{amsmath}
Dave Love <fx@gnu.org>
parents:
diff changeset
989 @cindex @code{align}, AMS-LaTeX environment
Dave Love <fx@gnu.org>
parents:
diff changeset
990 @cindex @code{gather}, AMS-LaTeX environment
Dave Love <fx@gnu.org>
parents:
diff changeset
991 @cindex @code{multline}, AMS-LaTeX environment
Dave Love <fx@gnu.org>
parents:
diff changeset
992 @cindex @code{flalign}, AMS-LaTeX environment
Dave Love <fx@gnu.org>
parents:
diff changeset
993 @cindex @code{alignat}, AMS-LaTeX environment
Dave Love <fx@gnu.org>
parents:
diff changeset
994 @cindex @code{xalignat}, AMS-LaTeX environment
Dave Love <fx@gnu.org>
parents:
diff changeset
995 @cindex @code{xxalignat}, AMS-LaTeX environment
Dave Love <fx@gnu.org>
parents:
diff changeset
996 @cindex @code{subequations}, AMS-LaTeX environment
Dave Love <fx@gnu.org>
parents:
diff changeset
997 @code{align}, @code{gather}, @code{multline}, @code{flalign},
Dave Love <fx@gnu.org>
parents:
diff changeset
998 @code{alignat}, @code{xalignat}, @code{xxalignat}, @code{subequations}
Dave Love <fx@gnu.org>
parents:
diff changeset
999 (from AMS-LaTeX's @file{amsmath.sty} package)@refill
Dave Love <fx@gnu.org>
parents:
diff changeset
1000 @item
Dave Love <fx@gnu.org>
parents:
diff changeset
1001 @cindex @code{endnote}, LaTeX package
Dave Love <fx@gnu.org>
parents:
diff changeset
1002 @cindex LaTeX packages, @code{endnote}
Dave Love <fx@gnu.org>
parents:
diff changeset
1003 @cindex @code{\endnote}, LaTeX macro
Dave Love <fx@gnu.org>
parents:
diff changeset
1004 the @code{\endnote} macro (from @file{endnotes.sty})
Dave Love <fx@gnu.org>
parents:
diff changeset
1005 @item
Dave Love <fx@gnu.org>
parents:
diff changeset
1006 @cindex @code{fancybox}, LaTeX package
Dave Love <fx@gnu.org>
parents:
diff changeset
1007 @cindex LaTeX packages, @code{fancybox}
Dave Love <fx@gnu.org>
parents:
diff changeset
1008 @cindex @code{Beqnarray}, LaTeX environment
Dave Love <fx@gnu.org>
parents:
diff changeset
1009 @code{Beqnarray} (@file{fancybox.sty})
Dave Love <fx@gnu.org>
parents:
diff changeset
1010 @item
Dave Love <fx@gnu.org>
parents:
diff changeset
1011 @cindex @code{floatfig}, LaTeX package
Dave Love <fx@gnu.org>
parents:
diff changeset
1012 @cindex LaTeX packages, @code{floatfig}
Dave Love <fx@gnu.org>
parents:
diff changeset
1013 @cindex @code{floatingfig}, LaTeX environment
Dave Love <fx@gnu.org>
parents:
diff changeset
1014 @code{floatingfig} (@file{floatfig.sty})
Dave Love <fx@gnu.org>
parents:
diff changeset
1015 @item
Dave Love <fx@gnu.org>
parents:
diff changeset
1016 @cindex @code{longtable}, LaTeX package
Dave Love <fx@gnu.org>
parents:
diff changeset
1017 @cindex LaTeX packages, @code{longtable}
Dave Love <fx@gnu.org>
parents:
diff changeset
1018 @cindex @code{longtable}, LaTeX environment
Dave Love <fx@gnu.org>
parents:
diff changeset
1019 @code{longtable} (@file{longtable.sty})
Dave Love <fx@gnu.org>
parents:
diff changeset
1020 @item
Dave Love <fx@gnu.org>
parents:
diff changeset
1021 @cindex @code{picinpar}, LaTeX package
Dave Love <fx@gnu.org>
parents:
diff changeset
1022 @cindex LaTeX packages, @code{picinpar}
Dave Love <fx@gnu.org>
parents:
diff changeset
1023 @cindex @code{figwindow}, LaTeX environment
Dave Love <fx@gnu.org>
parents:
diff changeset
1024 @cindex @code{tabwindow}, LaTeX environment
Dave Love <fx@gnu.org>
parents:
diff changeset
1025 @code{figwindow}, @code{tabwindow} (@file{picinpar.sty})
Dave Love <fx@gnu.org>
parents:
diff changeset
1026 @item
Dave Love <fx@gnu.org>
parents:
diff changeset
1027 @cindex @code{sidecap}, LaTeX package
Dave Love <fx@gnu.org>
parents:
diff changeset
1028 @cindex LaTeX packages, @code{sidecap}
Dave Love <fx@gnu.org>
parents:
diff changeset
1029 @cindex @code{SCfigure}, LaTeX environment
Dave Love <fx@gnu.org>
parents:
diff changeset
1030 @cindex @code{SCtable}, LaTeX environment
Dave Love <fx@gnu.org>
parents:
diff changeset
1031 @code{SCfigure}, @code{SCtable} (@file{sidecap.sty})
Dave Love <fx@gnu.org>
parents:
diff changeset
1032 @item
Dave Love <fx@gnu.org>
parents:
diff changeset
1033 @cindex @code{rotating}, LaTeX package
Dave Love <fx@gnu.org>
parents:
diff changeset
1034 @cindex LaTeX packages, @code{rotating}
Dave Love <fx@gnu.org>
parents:
diff changeset
1035 @cindex @code{sidewaysfigure}, LaTeX environment
Dave Love <fx@gnu.org>
parents:
diff changeset
1036 @cindex @code{sidewaystable}, LaTeX environment
Dave Love <fx@gnu.org>
parents:
diff changeset
1037 @code{sidewaysfigure}, @code{sidewaystable} (@file{rotating.sty})
Dave Love <fx@gnu.org>
parents:
diff changeset
1038 @item
Dave Love <fx@gnu.org>
parents:
diff changeset
1039 @cindex @code{subfig}, LaTeX package
Dave Love <fx@gnu.org>
parents:
diff changeset
1040 @cindex LaTeX packages, @code{subfigure}
Dave Love <fx@gnu.org>
parents:
diff changeset
1041 @cindex @code{subfigure}, LaTeX environment
Dave Love <fx@gnu.org>
parents:
diff changeset
1042 @cindex @code{subfigure*}, LaTeX environment
Dave Love <fx@gnu.org>
parents:
diff changeset
1043 @code{subfigure}, @code{subfigure*}, the @code{\subfigure} macro
Dave Love <fx@gnu.org>
parents:
diff changeset
1044 (@file{subfigure.sty})@refill
Dave Love <fx@gnu.org>
parents:
diff changeset
1045 @item
Dave Love <fx@gnu.org>
parents:
diff changeset
1046 @cindex @code{supertab}, LaTeX package
Dave Love <fx@gnu.org>
parents:
diff changeset
1047 @cindex LaTeX packages, @code{supertab}
Dave Love <fx@gnu.org>
parents:
diff changeset
1048 @cindex @code{supertabular}, LaTeX environment
Dave Love <fx@gnu.org>
parents:
diff changeset
1049 @code{supertabular} (@file{supertab.sty})
Dave Love <fx@gnu.org>
parents:
diff changeset
1050 @item
Dave Love <fx@gnu.org>
parents:
diff changeset
1051 @cindex @code{wrapfig}, LaTeX package
Dave Love <fx@gnu.org>
parents:
diff changeset
1052 @cindex LaTeX packages, @code{wrapfig}
Dave Love <fx@gnu.org>
parents:
diff changeset
1053 @cindex @code{wrapfigure}, LaTeX environment
Dave Love <fx@gnu.org>
parents:
diff changeset
1054 @code{wrapfigure} (@file{wrapfig.sty})
Dave Love <fx@gnu.org>
parents:
diff changeset
1055 @end itemize
Dave Love <fx@gnu.org>
parents:
diff changeset
1056
Dave Love <fx@gnu.org>
parents:
diff changeset
1057 If you want to use other labeled environments, defined with
Dave Love <fx@gnu.org>
parents:
diff changeset
1058 @code{\newtheorem}, @b{Ref@TeX{}} needs to be configured to recognize
Dave Love <fx@gnu.org>
parents:
diff changeset
1059 them (@pxref{Defining Label Environments}).@refill
Dave Love <fx@gnu.org>
parents:
diff changeset
1060
Dave Love <fx@gnu.org>
parents:
diff changeset
1061 @node Defining Label Environments, Reference Info, Builtin Label Environments, Labels and References
Dave Love <fx@gnu.org>
parents:
diff changeset
1062 @section Defining Label Environments
Dave Love <fx@gnu.org>
parents:
diff changeset
1063 @cindex Label environments, defining
Dave Love <fx@gnu.org>
parents:
diff changeset
1064
Dave Love <fx@gnu.org>
parents:
diff changeset
1065 @vindex reftex-label-alist
Dave Love <fx@gnu.org>
parents:
diff changeset
1066 @b{Ref@TeX{}} can be configured to recognize additional labeled
Dave Love <fx@gnu.org>
parents:
diff changeset
1067 environments and macros. This is done with the variable
Dave Love <fx@gnu.org>
parents:
diff changeset
1068 @code{reftex-label-alist} (@pxref{Options (Defining Label
Dave Love <fx@gnu.org>
parents:
diff changeset
1069 Environments)}). If you are not familiar with Lisp, you can use the
Dave Love <fx@gnu.org>
parents:
diff changeset
1070 @code{custom} library to configure this rather complex variable. To do
Dave Love <fx@gnu.org>
parents:
diff changeset
1071 this, use
Dave Love <fx@gnu.org>
parents:
diff changeset
1072
Dave Love <fx@gnu.org>
parents:
diff changeset
1073 @example
Dave Love <fx@gnu.org>
parents:
diff changeset
1074 @kbd{M-x customize-variable @key{RET} reftex-label-alist @key{RET}}
Dave Love <fx@gnu.org>
parents:
diff changeset
1075 @end example
Dave Love <fx@gnu.org>
parents:
diff changeset
1076
Dave Love <fx@gnu.org>
parents:
diff changeset
1077 @vindex reftex-label-alist-builtin
Dave Love <fx@gnu.org>
parents:
diff changeset
1078 Here we will discuss a few examples, in order to make things clearer.
Dave Love <fx@gnu.org>
parents:
diff changeset
1079 It can also be instructive to look at the constant
Dave Love <fx@gnu.org>
parents:
diff changeset
1080 @code{reftex-label-alist-builtin} which contains the entries for
Dave Love <fx@gnu.org>
parents:
diff changeset
1081 all the builtin environments and macros (@pxref{Builtin Label
Dave Love <fx@gnu.org>
parents:
diff changeset
1082 Environments}).@refill
Dave Love <fx@gnu.org>
parents:
diff changeset
1083
Dave Love <fx@gnu.org>
parents:
diff changeset
1084 @menu
Dave Love <fx@gnu.org>
parents:
diff changeset
1085 * Theorem and Axiom:: Defined with @code{\newenvironment}.
Dave Love <fx@gnu.org>
parents:
diff changeset
1086 * Quick Equation:: When a macro sets the label type.
Dave Love <fx@gnu.org>
parents:
diff changeset
1087 * Figure Wrapper:: When a macro argument is a label.
Dave Love <fx@gnu.org>
parents:
diff changeset
1088 * Adding Magic Words:: Other words for other languages.
Dave Love <fx@gnu.org>
parents:
diff changeset
1089 * Using \eqref:: How to switch to this AMS-LaTeX macro.
Dave Love <fx@gnu.org>
parents:
diff changeset
1090 * Non-Standard Environments:: Environments without \begin and \end
Dave Love <fx@gnu.org>
parents:
diff changeset
1091 * Putting it Together:: How to combine many entries.
Dave Love <fx@gnu.org>
parents:
diff changeset
1092 @end menu
Dave Love <fx@gnu.org>
parents:
diff changeset
1093
Dave Love <fx@gnu.org>
parents:
diff changeset
1094 @node Theorem and Axiom, Quick Equation, , Defining Label Environments
Dave Love <fx@gnu.org>
parents:
diff changeset
1095 @subsection Theorem and Axiom Environments
Dave Love <fx@gnu.org>
parents:
diff changeset
1096 @cindex @code{theorem}, newtheorem
Dave Love <fx@gnu.org>
parents:
diff changeset
1097 @cindex @code{axiom}, newtheorem
Dave Love <fx@gnu.org>
parents:
diff changeset
1098 @cindex @code{\newtheorem}
Dave Love <fx@gnu.org>
parents:
diff changeset
1099
Dave Love <fx@gnu.org>
parents:
diff changeset
1100 Suppose you are using @code{\newtheorem} in LaTeX in order to define two
Dave Love <fx@gnu.org>
parents:
diff changeset
1101 new environments, @code{theorem} and @code{axiom}@refill
Dave Love <fx@gnu.org>
parents:
diff changeset
1102
Dave Love <fx@gnu.org>
parents:
diff changeset
1103 @example
Dave Love <fx@gnu.org>
parents:
diff changeset
1104 \newtheorem@{axiom@}@{Axiom@}
Dave Love <fx@gnu.org>
parents:
diff changeset
1105 \newtheorem@{theorem@}@{Theorem@}
Dave Love <fx@gnu.org>
parents:
diff changeset
1106 @end example
Dave Love <fx@gnu.org>
parents:
diff changeset
1107
Dave Love <fx@gnu.org>
parents:
diff changeset
1108 @noindent
Dave Love <fx@gnu.org>
parents:
diff changeset
1109 to be used like this:
Dave Love <fx@gnu.org>
parents:
diff changeset
1110
Dave Love <fx@gnu.org>
parents:
diff changeset
1111 @example
Dave Love <fx@gnu.org>
parents:
diff changeset
1112 \begin@{axiom@}
Dave Love <fx@gnu.org>
parents:
diff changeset
1113 \label@{ax:first@}
Dave Love <fx@gnu.org>
parents:
diff changeset
1114 ....
Dave Love <fx@gnu.org>
parents:
diff changeset
1115 \end@{axiom@}
Dave Love <fx@gnu.org>
parents:
diff changeset
1116 @end example
Dave Love <fx@gnu.org>
parents:
diff changeset
1117
Dave Love <fx@gnu.org>
parents:
diff changeset
1118 So we need to tell @b{Ref@TeX{}} that @code{theorem} and @code{axiom} are new
Dave Love <fx@gnu.org>
parents:
diff changeset
1119 labeled environments which define their own label categories. We can
Dave Love <fx@gnu.org>
parents:
diff changeset
1120 either use Lisp to do this (e.g. in @file{.emacs}) or use the custom
Dave Love <fx@gnu.org>
parents:
diff changeset
1121 library. With Lisp it would look like this
Dave Love <fx@gnu.org>
parents:
diff changeset
1122
Dave Love <fx@gnu.org>
parents:
diff changeset
1123 @lisp
Dave Love <fx@gnu.org>
parents:
diff changeset
1124 (setq reftex-label-alist
26911
d7f536a01276 Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents: 25829
diff changeset
1125 '(("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
1126 ("theorem" ?h "thr:" "~\\ref@{%s@}" t ("theorem" "th.") -3)))
25829
Dave Love <fx@gnu.org>
parents:
diff changeset
1127 @end lisp
Dave Love <fx@gnu.org>
parents:
diff changeset
1128
Dave Love <fx@gnu.org>
parents:
diff changeset
1129 The type indicator characters @code{?a} and @code{?h} are used for
Dave Love <fx@gnu.org>
parents:
diff changeset
1130 prompts when @b{Ref@TeX{}} queries for a label type. @code{?h}
Dave Love <fx@gnu.org>
parents:
diff changeset
1131 was chosen for @code{theorem} since @code{?t} is already taken by
Dave Love <fx@gnu.org>
parents:
diff changeset
1132 @code{table}. Note that also @code{?s}, @code{?f}, @code{?e},
Dave Love <fx@gnu.org>
parents:
diff changeset
1133 @code{?i}, @code{?n} are already used for standard environments.@refill
Dave Love <fx@gnu.org>
parents:
diff changeset
1134
Dave Love <fx@gnu.org>
parents:
diff changeset
1135 @noindent
Dave Love <fx@gnu.org>
parents:
diff changeset
1136 The labels for Axioms and Theorems will have the prefixes @samp{ax:} and
Dave Love <fx@gnu.org>
parents:
diff changeset
1137 @samp{thr:}, respectively. @xref{AUCTeX}, for information on how
Dave Love <fx@gnu.org>
parents:
diff changeset
1138 AUCTeX can use @b{Ref@TeX{}} to automatically create labels when a new
Dave Love <fx@gnu.org>
parents:
diff changeset
1139 environment is inserted into a buffer.@refill
Dave Love <fx@gnu.org>
parents:
diff changeset
1140
Dave Love <fx@gnu.org>
parents:
diff changeset
1141 @noindent
Dave Love <fx@gnu.org>
parents:
diff changeset
1142 The @samp{~\ref@{%s@}} is a format string indicating how to insert
Dave Love <fx@gnu.org>
parents:
diff changeset
1143 references to these labels.@refill
Dave Love <fx@gnu.org>
parents:
diff changeset
1144
Dave Love <fx@gnu.org>
parents:
diff changeset
1145 @noindent
Dave Love <fx@gnu.org>
parents:
diff changeset
1146 The next item indicates how to grab context of the label definition.@refill
Dave Love <fx@gnu.org>
parents:
diff changeset
1147 @itemize @minus
Dave Love <fx@gnu.org>
parents:
diff changeset
1148 @item
Dave Love <fx@gnu.org>
parents:
diff changeset
1149 @code{t} means to get it from a default location (from the beginning of
Dave Love <fx@gnu.org>
parents:
diff changeset
1150 a @code{\macro} or after the @code{\begin} statement). @code{t} is
Dave Love <fx@gnu.org>
parents:
diff changeset
1151 @emph{not} a good choice for eqnarray and similar environments.@refill
Dave Love <fx@gnu.org>
parents:
diff changeset
1152 @item
Dave Love <fx@gnu.org>
parents:
diff changeset
1153 @code{nil} means to use the text right after the label definition.@refill
Dave Love <fx@gnu.org>
parents:
diff changeset
1154 @item
Dave Love <fx@gnu.org>
parents:
diff changeset
1155 For more complex ways of getting context, see the variable
Dave Love <fx@gnu.org>
parents:
diff changeset
1156 @code{reftex-label-alist} (@ref{Options (Defining Label
Dave Love <fx@gnu.org>
parents:
diff changeset
1157 Environments)}).@refill
Dave Love <fx@gnu.org>
parents:
diff changeset
1158 @end itemize
Dave Love <fx@gnu.org>
parents:
diff changeset
1159
26911
d7f536a01276 Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents: 25829
diff changeset
1160 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
1161 from the word before point when creating a reference. E.g. if you
25829
Dave Love <fx@gnu.org>
parents:
diff changeset
1162 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
1163 @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
1164 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
1165
d7f536a01276 Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents: 25829
diff changeset
1166 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
1167 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
1168 positive, the environment will produce numbered entries (like
d7f536a01276 Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents: 25829
diff changeset
1169 @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
1170 @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
1171 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
1172 item.@refill
25829
Dave Love <fx@gnu.org>
parents:
diff changeset
1173
Dave Love <fx@gnu.org>
parents:
diff changeset
1174 To do the same configuration with @code{customize}, you need to click on
Dave Love <fx@gnu.org>
parents:
diff changeset
1175 the @code{[INS]} button twice to create two templates and fill them in
Dave Love <fx@gnu.org>
parents:
diff changeset
1176 like this:@refill
Dave Love <fx@gnu.org>
parents:
diff changeset
1177
Dave Love <fx@gnu.org>
parents:
diff changeset
1178 @example
Dave Love <fx@gnu.org>
parents:
diff changeset
1179 Reftex Label Alist: [Hide]
Dave Love <fx@gnu.org>
parents:
diff changeset
1180 [INS] [DEL] Package or Detailed : [Value Menu] Detailed:
Dave Love <fx@gnu.org>
parents:
diff changeset
1181 Environment or \macro : [Value Menu] String: axiom
Dave Love <fx@gnu.org>
parents:
diff changeset
1182 Type specification : [Value Menu] Char : a
Dave Love <fx@gnu.org>
parents:
diff changeset
1183 Label prefix string : [Value Menu] String: ax:
Dave Love <fx@gnu.org>
parents:
diff changeset
1184 Label reference format: [Value Menu] String: ~\ref@{%s@}
Dave Love <fx@gnu.org>
parents:
diff changeset
1185 Context method : [Value Menu] After label
Dave Love <fx@gnu.org>
parents:
diff changeset
1186 Magic words:
Dave Love <fx@gnu.org>
parents:
diff changeset
1187 [INS] [DEL] String: axiom
Dave Love <fx@gnu.org>
parents:
diff changeset
1188 [INS] [DEL] String: ax.
Dave Love <fx@gnu.org>
parents:
diff changeset
1189 [INS]
26911
d7f536a01276 Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents: 25829
diff changeset
1190 [X] Make TOC entry : [Value Menu] Level: -2
25829
Dave Love <fx@gnu.org>
parents:
diff changeset
1191 [INS] [DEL] Package or Detailed : [Value Menu] Detailed:
Dave Love <fx@gnu.org>
parents:
diff changeset
1192 Environment or \macro : [Value Menu] String: theorem
Dave Love <fx@gnu.org>
parents:
diff changeset
1193 Type specification : [Value Menu] Char : h
Dave Love <fx@gnu.org>
parents:
diff changeset
1194 Label prefix string : [Value Menu] String: thr:
Dave Love <fx@gnu.org>
parents:
diff changeset
1195 Label reference format: [Value Menu] String: ~\ref@{%s@}
Dave Love <fx@gnu.org>
parents:
diff changeset
1196 Context method : [Value Menu] Default position
Dave Love <fx@gnu.org>
parents:
diff changeset
1197 Magic words:
Dave Love <fx@gnu.org>
parents:
diff changeset
1198 [INS] [DEL] String: theorem
Dave Love <fx@gnu.org>
parents:
diff changeset
1199 [INS] [DEL] String: theor.
Dave Love <fx@gnu.org>
parents:
diff changeset
1200 [INS] [DEL] String: th.
Dave Love <fx@gnu.org>
parents:
diff changeset
1201 [INS]
26911
d7f536a01276 Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents: 25829
diff changeset
1202 [X] Make TOC entry : [Value Menu] Level: -3
25829
Dave Love <fx@gnu.org>
parents:
diff changeset
1203 @end example
Dave Love <fx@gnu.org>
parents:
diff changeset
1204
Dave Love <fx@gnu.org>
parents:
diff changeset
1205 @vindex reftex-insert-label-flags
Dave Love <fx@gnu.org>
parents:
diff changeset
1206 @vindex reftex-label-menu-flags
Dave Love <fx@gnu.org>
parents:
diff changeset
1207 Depending on how you would like the label insertion and selection for
Dave Love <fx@gnu.org>
parents:
diff changeset
1208 the new environments to work, you might want to add the letters @samp{a}
Dave Love <fx@gnu.org>
parents:
diff changeset
1209 and @samp{h} to some of the flags in the variables
Dave Love <fx@gnu.org>
parents:
diff changeset
1210 @code{reftex-insert-label-flags} (@pxref{Options (Creating Labels)})
Dave Love <fx@gnu.org>
parents:
diff changeset
1211 and @code{reftex-label-menu-flags} (@pxref{Options (Referencing
Dave Love <fx@gnu.org>
parents:
diff changeset
1212 Labels)}).@refill
Dave Love <fx@gnu.org>
parents:
diff changeset
1213
Dave Love <fx@gnu.org>
parents:
diff changeset
1214
Dave Love <fx@gnu.org>
parents:
diff changeset
1215 @node Quick Equation, Figure Wrapper, Theorem and Axiom , Defining Label Environments
Dave Love <fx@gnu.org>
parents:
diff changeset
1216 @subsection Quick Equation Macro
Dave Love <fx@gnu.org>
parents:
diff changeset
1217 @cindex Quick equation macro
Dave Love <fx@gnu.org>
parents:
diff changeset
1218 @cindex Macros as environment wrappers
Dave Love <fx@gnu.org>
parents:
diff changeset
1219
Dave Love <fx@gnu.org>
parents:
diff changeset
1220 Suppose you would like to have a macro for quick equations. It
Dave Love <fx@gnu.org>
parents:
diff changeset
1221 could be defined like this:
Dave Love <fx@gnu.org>
parents:
diff changeset
1222
Dave Love <fx@gnu.org>
parents:
diff changeset
1223 @example
Dave Love <fx@gnu.org>
parents:
diff changeset
1224 \newcommand@{\quickeq@}[1]@{\begin@{equation@} #1 \end@{equation@}@}
Dave Love <fx@gnu.org>
parents:
diff changeset
1225 @end example
Dave Love <fx@gnu.org>
parents:
diff changeset
1226
Dave Love <fx@gnu.org>
parents:
diff changeset
1227 @noindent
Dave Love <fx@gnu.org>
parents:
diff changeset
1228 and used like this:
Dave Love <fx@gnu.org>
parents:
diff changeset
1229
Dave Love <fx@gnu.org>
parents:
diff changeset
1230 @example
Dave Love <fx@gnu.org>
parents:
diff changeset
1231 Einstein's equation is \quickeq@{E=mc^2 \label@{eq:einstein@}@}.
Dave Love <fx@gnu.org>
parents:
diff changeset
1232 @end example
Dave Love <fx@gnu.org>
parents:
diff changeset
1233
Dave Love <fx@gnu.org>
parents:
diff changeset
1234 We need to tell @b{Ref@TeX{}} that any label defined in the argument of the
Dave Love <fx@gnu.org>
parents:
diff changeset
1235 @code{\quickeq} is an equation label. Here is how to do this with lisp:
Dave Love <fx@gnu.org>
parents:
diff changeset
1236
Dave Love <fx@gnu.org>
parents:
diff changeset
1237 @lisp
Dave Love <fx@gnu.org>
parents:
diff changeset
1238 (setq reftex-label-alist '(("\\quickeq@{@}" ?e nil nil 1 nil)))
Dave Love <fx@gnu.org>
parents:
diff changeset
1239 @end lisp
Dave Love <fx@gnu.org>
parents:
diff changeset
1240
Dave Love <fx@gnu.org>
parents:
diff changeset
1241 The first element in this list is now the macro with empty braces as an
Dave Love <fx@gnu.org>
parents:
diff changeset
1242 @emph{image} of the macro arguments. @code{?e} indicates that this is
Dave Love <fx@gnu.org>
parents:
diff changeset
1243 an equation label, the different @code{nil} elements indicate to use the
Dave Love <fx@gnu.org>
parents:
diff changeset
1244 default values for equations. The @samp{1} as the fifth element
Dave Love <fx@gnu.org>
parents:
diff changeset
1245 indicates that the context of the label definition should be the 1st
Dave Love <fx@gnu.org>
parents:
diff changeset
1246 argument of the macro.@refill
Dave Love <fx@gnu.org>
parents:
diff changeset
1247
Dave Love <fx@gnu.org>
parents:
diff changeset
1248 Here is again how this would look in the customization buffer:
Dave Love <fx@gnu.org>
parents:
diff changeset
1249
Dave Love <fx@gnu.org>
parents:
diff changeset
1250 @example
Dave Love <fx@gnu.org>
parents:
diff changeset
1251 Reftex Label Alist: [Hide]
Dave Love <fx@gnu.org>
parents:
diff changeset
1252 [INS] [DEL] Package or Detailed : [Value Menu] Detailed:
Dave Love <fx@gnu.org>
parents:
diff changeset
1253 Environment or \macro : [Value Menu] String: \quickeq@{@}
Dave Love <fx@gnu.org>
parents:
diff changeset
1254 Type specification : [Value Menu] Char : e
Dave Love <fx@gnu.org>
parents:
diff changeset
1255 Label prefix string : [Value Menu] Default
Dave Love <fx@gnu.org>
parents:
diff changeset
1256 Label reference format: [Value Menu] Default
Dave Love <fx@gnu.org>
parents:
diff changeset
1257 Context method : [Value Menu] Macro arg nr: 1
Dave Love <fx@gnu.org>
parents:
diff changeset
1258 Magic words:
Dave Love <fx@gnu.org>
parents:
diff changeset
1259 [INS]
26911
d7f536a01276 Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents: 25829
diff changeset
1260 [ ] Make TOC entry : [Value Menu] No entry
25829
Dave Love <fx@gnu.org>
parents:
diff changeset
1261 @end example
Dave Love <fx@gnu.org>
parents:
diff changeset
1262
Dave Love <fx@gnu.org>
parents:
diff changeset
1263 @node Figure Wrapper, Adding Magic Words, Quick Equation, Defining Label Environments
Dave Love <fx@gnu.org>
parents:
diff changeset
1264 @subsection Figure Wrapping Macro
Dave Love <fx@gnu.org>
parents:
diff changeset
1265 @cindex Macros as environment wrappers
Dave Love <fx@gnu.org>
parents:
diff changeset
1266 @cindex Figure wrapping macro
Dave Love <fx@gnu.org>
parents:
diff changeset
1267
Dave Love <fx@gnu.org>
parents:
diff changeset
1268 Suppose you want to make figures not directly with the figure
Dave Love <fx@gnu.org>
parents:
diff changeset
1269 environment, but with a macro like
Dave Love <fx@gnu.org>
parents:
diff changeset
1270
Dave Love <fx@gnu.org>
parents:
diff changeset
1271 @example
Dave Love <fx@gnu.org>
parents:
diff changeset
1272 \newcommand@{\myfig@}[5][tbp]@{%
Dave Love <fx@gnu.org>
parents:
diff changeset
1273 \begin@{figure@}[#1]
Dave Love <fx@gnu.org>
parents:
diff changeset
1274 \epsimp[#5]@{#2@}
Dave Love <fx@gnu.org>
parents:
diff changeset
1275 \caption@{#3@}
Dave Love <fx@gnu.org>
parents:
diff changeset
1276 \label@{#4@}
Dave Love <fx@gnu.org>
parents:
diff changeset
1277 \end@{figure@}@}
Dave Love <fx@gnu.org>
parents:
diff changeset
1278 @end example
Dave Love <fx@gnu.org>
parents:
diff changeset
1279
Dave Love <fx@gnu.org>
parents:
diff changeset
1280 @noindent
Dave Love <fx@gnu.org>
parents:
diff changeset
1281 which would be called like
Dave Love <fx@gnu.org>
parents:
diff changeset
1282
Dave Love <fx@gnu.org>
parents:
diff changeset
1283 @example
Dave Love <fx@gnu.org>
parents:
diff changeset
1284 \myfig[htp]@{filename@}@{caption text@}@{label@}@{1@}
Dave Love <fx@gnu.org>
parents:
diff changeset
1285 @end example
Dave Love <fx@gnu.org>
parents:
diff changeset
1286
Dave Love <fx@gnu.org>
parents:
diff changeset
1287 Now we need to tell @b{Ref@TeX{}} that the 4th argument of the
Dave Love <fx@gnu.org>
parents:
diff changeset
1288 @code{\myfig} macro @emph{is itself} a figure label, and where to find
Dave Love <fx@gnu.org>
parents:
diff changeset
1289 the context.@refill
Dave Love <fx@gnu.org>
parents:
diff changeset
1290
Dave Love <fx@gnu.org>
parents:
diff changeset
1291 @lisp
Dave Love <fx@gnu.org>
parents:
diff changeset
1292 (setq reftex-label-alist
Dave Love <fx@gnu.org>
parents:
diff changeset
1293 '(("\\myfig[]@{@}@{@}@{*@}@{@}" ?f nil nil 3)))
Dave Love <fx@gnu.org>
parents:
diff changeset
1294 @end lisp
Dave Love <fx@gnu.org>
parents:
diff changeset
1295
Dave Love <fx@gnu.org>
parents:
diff changeset
1296 The empty pairs of brackets indicate the different arguments of the
Dave Love <fx@gnu.org>
parents:
diff changeset
1297 @code{\myfig} macro. The @samp{*} marks the label argument. @code{?f}
Dave Love <fx@gnu.org>
parents:
diff changeset
1298 indicates that this is a figure label which will be listed together with
Dave Love <fx@gnu.org>
parents:
diff changeset
1299 labels from normal figure environments. The @code{nil} entries for
Dave Love <fx@gnu.org>
parents:
diff changeset
1300 prefix and reference format mean to use the defaults for figure labels.
Dave Love <fx@gnu.org>
parents:
diff changeset
1301 The @samp{3} for the context method means to grab the 3rd macro argument
Dave Love <fx@gnu.org>
parents:
diff changeset
1302 - the caption.@refill
Dave Love <fx@gnu.org>
parents:
diff changeset
1303
Dave Love <fx@gnu.org>
parents:
diff changeset
1304 As a side effect of this configuration, @code{reftex-label} will now
Dave Love <fx@gnu.org>
parents:
diff changeset
1305 insert the required naked label (without the @code{\label} macro) when
Dave Love <fx@gnu.org>
parents:
diff changeset
1306 point is directly after the opening parenthesis of a @code{\myfig} macro
Dave Love <fx@gnu.org>
parents:
diff changeset
1307 argument.@refill
Dave Love <fx@gnu.org>
parents:
diff changeset
1308
Dave Love <fx@gnu.org>
parents:
diff changeset
1309 Again, here the configuration in the customization buffer:
Dave Love <fx@gnu.org>
parents:
diff changeset
1310
Dave Love <fx@gnu.org>
parents:
diff changeset
1311 @example
Dave Love <fx@gnu.org>
parents:
diff changeset
1312 [INS] [DEL] Package or Detailed : [Value Menu] Detailed:
Dave Love <fx@gnu.org>
parents:
diff changeset
1313 Environment or \macro : [Value Menu] String: \myfig[]@{@}@{@}@{*@}@{@}
Dave Love <fx@gnu.org>
parents:
diff changeset
1314 Type specification : [Value Menu] Char : f
Dave Love <fx@gnu.org>
parents:
diff changeset
1315 Label prefix string : [Value Menu] Default
Dave Love <fx@gnu.org>
parents:
diff changeset
1316 Label reference format: [Value Menu] Default
Dave Love <fx@gnu.org>
parents:
diff changeset
1317 Context method : [Value Menu] Macro arg nr: 3
Dave Love <fx@gnu.org>
parents:
diff changeset
1318 Magic words:
Dave Love <fx@gnu.org>
parents:
diff changeset
1319 [INS]
26911
d7f536a01276 Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents: 25829
diff changeset
1320 [ ] Make TOC entry : [Value Menu] No entry
25829
Dave Love <fx@gnu.org>
parents:
diff changeset
1321 @end example
Dave Love <fx@gnu.org>
parents:
diff changeset
1322
Dave Love <fx@gnu.org>
parents:
diff changeset
1323 @node Adding Magic Words, Using \eqref, Figure Wrapper, Defining Label Environments
Dave Love <fx@gnu.org>
parents:
diff changeset
1324 @subsection Adding Magic Words
Dave Love <fx@gnu.org>
parents:
diff changeset
1325 @cindex Magic words
Dave Love <fx@gnu.org>
parents:
diff changeset
1326 @cindex German magic words
Dave Love <fx@gnu.org>
parents:
diff changeset
1327 @cindex Label category
Dave Love <fx@gnu.org>
parents:
diff changeset
1328
Dave Love <fx@gnu.org>
parents:
diff changeset
1329 Sometimes you don't want to define a new label environment or macro, but
Dave Love <fx@gnu.org>
parents:
diff changeset
1330 just change the information associated with a label category. Maybe you
Dave Love <fx@gnu.org>
parents:
diff changeset
1331 want to add some magic words, for another language. Changing only the
Dave Love <fx@gnu.org>
parents:
diff changeset
1332 information associated with a label category is done by giving
Dave Love <fx@gnu.org>
parents:
diff changeset
1333 @code{nil} for the environment name and then specify the items you want
Dave Love <fx@gnu.org>
parents:
diff changeset
1334 to define. Here is an example which adds German magic words to all
Dave Love <fx@gnu.org>
parents:
diff changeset
1335 predefined label categories.@refill
Dave Love <fx@gnu.org>
parents:
diff changeset
1336
Dave Love <fx@gnu.org>
parents:
diff changeset
1337 @lisp
Dave Love <fx@gnu.org>
parents:
diff changeset
1338 (setq reftex-label-alist
Dave Love <fx@gnu.org>
parents:
diff changeset
1339 '((nil ?s nil nil nil ("Kapitel" "Kap." "Abschnitt" "Teil"))
Dave Love <fx@gnu.org>
parents:
diff changeset
1340 (nil ?e nil nil nil ("Gleichung" "Gl."))
Dave Love <fx@gnu.org>
parents:
diff changeset
1341 (nil ?t nil nil nil ("Tabelle"))
Dave Love <fx@gnu.org>
parents:
diff changeset
1342 (nil ?f nil nil nil ("Figur" "Abbildung" "Abb."))
Dave Love <fx@gnu.org>
parents:
diff changeset
1343 (nil ?n nil nil nil ("Anmerkung" "Anm."))
Dave Love <fx@gnu.org>
parents:
diff changeset
1344 (nil ?i nil nil nil ("Punkt"))))
Dave Love <fx@gnu.org>
parents:
diff changeset
1345 @end lisp
Dave Love <fx@gnu.org>
parents:
diff changeset
1346
Dave Love <fx@gnu.org>
parents:
diff changeset
1347 @node Using \eqref, Non-Standard Environments, Adding Magic Words, Defining Label Environments
Dave Love <fx@gnu.org>
parents:
diff changeset
1348 @subsection Using @code{\eqref}
Dave Love <fx@gnu.org>
parents:
diff changeset
1349 @cindex @code{\eqref}, AMS-LaTeX macro
Dave Love <fx@gnu.org>
parents:
diff changeset
1350 @cindex AMS-LaTeX
Dave Love <fx@gnu.org>
parents:
diff changeset
1351 @cindex Label category
Dave Love <fx@gnu.org>
parents:
diff changeset
1352
Dave Love <fx@gnu.org>
parents:
diff changeset
1353 Another case where one only wants to change the information associated
Dave Love <fx@gnu.org>
parents:
diff changeset
1354 with the label category is to change the macro which is used for
Dave Love <fx@gnu.org>
parents:
diff changeset
1355 referencing the label. When working with the AMS-LaTeX stuff, you might
Dave Love <fx@gnu.org>
parents:
diff changeset
1356 prefer @code{\eqref} for doing equation references. Here is how to
Dave Love <fx@gnu.org>
parents:
diff changeset
1357 do this:
Dave Love <fx@gnu.org>
parents:
diff changeset
1358
Dave Love <fx@gnu.org>
parents:
diff changeset
1359 @lisp
Dave Love <fx@gnu.org>
parents:
diff changeset
1360 (setq reftex-label-alist '((nil ?e nil "~\\eqref@{%s@}" nil nil)))
Dave Love <fx@gnu.org>
parents:
diff changeset
1361 @end lisp
Dave Love <fx@gnu.org>
parents:
diff changeset
1362
Dave Love <fx@gnu.org>
parents:
diff changeset
1363 @b{Ref@TeX{}} has also a predefined symbol for this special purpose. The
Dave Love <fx@gnu.org>
parents:
diff changeset
1364 following is equivalent to the line above.@refill
Dave Love <fx@gnu.org>
parents:
diff changeset
1365
Dave Love <fx@gnu.org>
parents:
diff changeset
1366 @lisp
Dave Love <fx@gnu.org>
parents:
diff changeset
1367 (setq reftex-label-alist '(AMSTeX))
Dave Love <fx@gnu.org>
parents:
diff changeset
1368 @end lisp
Dave Love <fx@gnu.org>
parents:
diff changeset
1369
Dave Love <fx@gnu.org>
parents:
diff changeset
1370 Note that this is automatically done by the @file{amsmath.el} style file
Dave Love <fx@gnu.org>
parents:
diff changeset
1371 of AUCTeX (@pxref{Style Files}) - so if you use AUCTeX,
Dave Love <fx@gnu.org>
parents:
diff changeset
1372 this configuration will not be necessary.@refill
Dave Love <fx@gnu.org>
parents:
diff changeset
1373
Dave Love <fx@gnu.org>
parents:
diff changeset
1374 @node Non-Standard Environments, Putting it Together, Using \eqref, Defining Label Environments
Dave Love <fx@gnu.org>
parents:
diff changeset
1375 @subsection Non-standard Environments
Dave Love <fx@gnu.org>
parents:
diff changeset
1376 @cindex Non-standard environments
Dave Love <fx@gnu.org>
parents:
diff changeset
1377 @cindex Environments without @code{\begin}
Dave Love <fx@gnu.org>
parents:
diff changeset
1378 @cindex Special parser functions
Dave Love <fx@gnu.org>
parents:
diff changeset
1379 @cindex Parser functions, for special environments
Dave Love <fx@gnu.org>
parents:
diff changeset
1380
Dave Love <fx@gnu.org>
parents:
diff changeset
1381 Some LaTeX packages define environment-like structures without using the
Dave Love <fx@gnu.org>
parents:
diff changeset
1382 standard @samp{\begin..\end} structure. @b{Ref@TeX{}} cannot parse
Dave Love <fx@gnu.org>
parents:
diff changeset
1383 these directly, but you can write your own special-purpose parser and
Dave Love <fx@gnu.org>
parents:
diff changeset
1384 use it instead of the name of an environment in an entry for
Dave Love <fx@gnu.org>
parents:
diff changeset
1385 @code{reftex-label-alist}. The function should check if point is
Dave Love <fx@gnu.org>
parents:
diff changeset
1386 currently in the special environment it was written to detect. If so,
Dave Love <fx@gnu.org>
parents:
diff changeset
1387 it must return a buffer position indicating the start of this
Dave Love <fx@gnu.org>
parents:
diff changeset
1388 environment. The return value must be @code{nil} on failure to detect
Dave Love <fx@gnu.org>
parents:
diff changeset
1389 the environment. The function is called with one argument @var{bound}.
Dave Love <fx@gnu.org>
parents:
diff changeset
1390 If non-@code{nil}, @var{bound} is a boundary for backwards searches
Dave Love <fx@gnu.org>
parents:
diff changeset
1391 which should be observed. We will discuss two examples.@refill
Dave Love <fx@gnu.org>
parents:
diff changeset
1392
Dave Love <fx@gnu.org>
parents:
diff changeset
1393 @cindex LaTeX commands, abbreviated
Dave Love <fx@gnu.org>
parents:
diff changeset
1394
Dave Love <fx@gnu.org>
parents:
diff changeset
1395 Some people define abbreviations for
Dave Love <fx@gnu.org>
parents:
diff changeset
1396 environments, like @code{\be} for @code{\begin@{equation@}}, and
Dave Love <fx@gnu.org>
parents:
diff changeset
1397 @code{\ee} for @code{\end@{equation@}}. The parser function would have
Dave Love <fx@gnu.org>
parents:
diff changeset
1398 to search backward for these macros. When the first match is
Dave Love <fx@gnu.org>
parents:
diff changeset
1399 @code{\ee}, point is not in this environment. When the first match is
Dave Love <fx@gnu.org>
parents:
diff changeset
1400 @code{\be}, point is in this environment and the function must return
Dave Love <fx@gnu.org>
parents:
diff changeset
1401 the beginning of the match. To avoid scanning too far, we can also look
Dave Love <fx@gnu.org>
parents:
diff changeset
1402 for empty lines which cannot occure inside an equation environment.
Dave Love <fx@gnu.org>
parents:
diff changeset
1403 Here is the setup:@refill
Dave Love <fx@gnu.org>
parents:
diff changeset
1404
Dave Love <fx@gnu.org>
parents:
diff changeset
1405 @lisp
Dave Love <fx@gnu.org>
parents:
diff changeset
1406 ;; Setup entry in reftex-label-alist, using all defaults for equations
Dave Love <fx@gnu.org>
parents:
diff changeset
1407 (setq reftex-label-alist '((detect-be-ee ?e nil nil nil nil)))
Dave Love <fx@gnu.org>
parents:
diff changeset
1408
Dave Love <fx@gnu.org>
parents:
diff changeset
1409 (defun detect-be-ee (bound)
Dave Love <fx@gnu.org>
parents:
diff changeset
1410 ;; Search backward for the macros or an empty line
Dave Love <fx@gnu.org>
parents:
diff changeset
1411 (if (re-search-backward
Dave Love <fx@gnu.org>
parents:
diff changeset
1412 "\\(^[ \t]*\n\\|\\\\ee\\>\\)\\|\\(\\\\be\\>\\)" bound t)
Dave Love <fx@gnu.org>
parents:
diff changeset
1413 (if (match-beginning 2)
Dave Love <fx@gnu.org>
parents:
diff changeset
1414 (match-beginning 2) ; Return start of environment
Dave Love <fx@gnu.org>
parents:
diff changeset
1415 nil) ; Return nil because env is closed
Dave Love <fx@gnu.org>
parents:
diff changeset
1416 nil)) ; Return nil for not found
Dave Love <fx@gnu.org>
parents:
diff changeset
1417 @end lisp
Dave Love <fx@gnu.org>
parents:
diff changeset
1418
Dave Love <fx@gnu.org>
parents:
diff changeset
1419 @cindex @code{linguex}, LaTeX package
Dave Love <fx@gnu.org>
parents:
diff changeset
1420 @cindex LaTeX packages, @code{linguex}
Dave Love <fx@gnu.org>
parents:
diff changeset
1421 A more complex example is the @file{linguex.sty} package which defines
Dave Love <fx@gnu.org>
parents:
diff changeset
1422 list macros @samp{\ex.}, @samp{\a.}, @samp{\b.} etc. for lists which are
Dave Love <fx@gnu.org>
parents:
diff changeset
1423 terminated by @samp{\z.} or by an empty line.@refill
Dave Love <fx@gnu.org>
parents:
diff changeset
1424
Dave Love <fx@gnu.org>
parents:
diff changeset
1425 @example
Dave Love <fx@gnu.org>
parents:
diff changeset
1426 \ex. \label@{ex:12@} Some text in an exotic language ...
Dave Love <fx@gnu.org>
parents:
diff changeset
1427 \a. \label@{ex:13@} more stuff
Dave Love <fx@gnu.org>
parents:
diff changeset
1428 \b. \label@{ex:14@} still more stuff
Dave Love <fx@gnu.org>
parents:
diff changeset
1429 \a. List on a deeper level
Dave Love <fx@gnu.org>
parents:
diff changeset
1430 \b. Another item
Dave Love <fx@gnu.org>
parents:
diff changeset
1431 \b. and the third one
Dave Love <fx@gnu.org>
parents:
diff changeset
1432 \z.
Dave Love <fx@gnu.org>
parents:
diff changeset
1433 \b. Third item on this level.
Dave Love <fx@gnu.org>
parents:
diff changeset
1434
Dave Love <fx@gnu.org>
parents:
diff changeset
1435 ... text after the empty line terminating all lists
Dave Love <fx@gnu.org>
parents:
diff changeset
1436 @end example
Dave Love <fx@gnu.org>
parents:
diff changeset
1437
Dave Love <fx@gnu.org>
parents:
diff changeset
1438 The difficulty is that the @samp{\a.} lists can nest and that an empty
Dave Love <fx@gnu.org>
parents:
diff changeset
1439 line terminates all list levels in one go. So we have to count nesting
Dave Love <fx@gnu.org>
parents:
diff changeset
1440 levels between @samp{\a.} and @samp{\z.}. Here is the implementation
Dave Love <fx@gnu.org>
parents:
diff changeset
1441 for @b{Ref@TeX{}}.
Dave Love <fx@gnu.org>
parents:
diff changeset
1442
Dave Love <fx@gnu.org>
parents:
diff changeset
1443 @lisp
Dave Love <fx@gnu.org>
parents:
diff changeset
1444 (setq reftex-label-alist
Dave Love <fx@gnu.org>
parents:
diff changeset
1445 '((detect-linguex ?x "ex:" "~\\ref@{%s@}" nil ("Example" "Ex."))))
Dave Love <fx@gnu.org>
parents:
diff changeset
1446
Dave Love <fx@gnu.org>
parents:
diff changeset
1447 (defun detect-linguex (bound)
Dave Love <fx@gnu.org>
parents:
diff changeset
1448 (let ((cnt 0))
Dave Love <fx@gnu.org>
parents:
diff changeset
1449 (catch 'exit
Dave Love <fx@gnu.org>
parents:
diff changeset
1450 (while
Dave Love <fx@gnu.org>
parents:
diff changeset
1451 ;; Search backward for all possible delimiters
Dave Love <fx@gnu.org>
parents:
diff changeset
1452 (re-search-backward
Dave Love <fx@gnu.org>
parents:
diff changeset
1453 (concat "\\(^[ \t]*\n\\)\\|\\(\\\\z\\.\\)\\|"
Dave Love <fx@gnu.org>
parents:
diff changeset
1454 "\\(\\ex[ig]?\\.\\)\\|\\(\\\\a\\.\\)")
Dave Love <fx@gnu.org>
parents:
diff changeset
1455 nil t)
Dave Love <fx@gnu.org>
parents:
diff changeset
1456 ;; Check which delimiter was matched.
Dave Love <fx@gnu.org>
parents:
diff changeset
1457 (cond
Dave Love <fx@gnu.org>
parents:
diff changeset
1458 ((match-beginning 1)
Dave Love <fx@gnu.org>
parents:
diff changeset
1459 ;; empty line terminates all - return nil
Dave Love <fx@gnu.org>
parents:
diff changeset
1460 (throw 'exit nil))
Dave Love <fx@gnu.org>
parents:
diff changeset
1461 ((match-beginning 2)
Dave Love <fx@gnu.org>
parents:
diff changeset
1462 ;; \z. terminates one list level - decrease nesting count
Dave Love <fx@gnu.org>
parents:
diff changeset
1463 (decf cnt))
Dave Love <fx@gnu.org>
parents:
diff changeset
1464 ((match-beginning 3)
Dave Love <fx@gnu.org>
parents:
diff changeset
1465 ;; \ex. : return match unless there was a \z. on this level
Dave Love <fx@gnu.org>
parents:
diff changeset
1466 (throw 'exit (if (>= cnt 0) (match-beginning 3) nil)))
Dave Love <fx@gnu.org>
parents:
diff changeset
1467 ((match-beginning 4)
Dave Love <fx@gnu.org>
parents:
diff changeset
1468 ;; \a. : return match when on level 0, otherwise
Dave Love <fx@gnu.org>
parents:
diff changeset
1469 ;; increment nesting count
Dave Love <fx@gnu.org>
parents:
diff changeset
1470 (if (>= cnt 0)
Dave Love <fx@gnu.org>
parents:
diff changeset
1471 (throw 'exit (match-beginning 4))
Dave Love <fx@gnu.org>
parents:
diff changeset
1472 (incf cnt))))))))
Dave Love <fx@gnu.org>
parents:
diff changeset
1473 @end lisp
Dave Love <fx@gnu.org>
parents:
diff changeset
1474
Dave Love <fx@gnu.org>
parents:
diff changeset
1475 @node Putting it Together, , Non-Standard Environments, Defining Label Environments
Dave Love <fx@gnu.org>
parents:
diff changeset
1476 @subsection Putting it all together
Dave Love <fx@gnu.org>
parents:
diff changeset
1477
Dave Love <fx@gnu.org>
parents:
diff changeset
1478 When you have to put several entries into @code{reftex-label-alist}, just
Dave Love <fx@gnu.org>
parents:
diff changeset
1479 put them after each other in a list, or create that many templates in
Dave Love <fx@gnu.org>
parents:
diff changeset
1480 the customization buffer. Here is a lisp example which uses several of
Dave Love <fx@gnu.org>
parents:
diff changeset
1481 the entries described above:
Dave Love <fx@gnu.org>
parents:
diff changeset
1482
Dave Love <fx@gnu.org>
parents:
diff changeset
1483 @lisp
Dave Love <fx@gnu.org>
parents:
diff changeset
1484 (setq reftex-label-alist
26911
d7f536a01276 Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents: 25829
diff changeset
1485 '(("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
1486 ("theorem" ?h "thr:" "~\\ref@{%s@}" t ("theorem" "theor." "th.") -3)
25829
Dave Love <fx@gnu.org>
parents:
diff changeset
1487 ("\\quickeq@{@}" ?e nil nil 1 nil)
Dave Love <fx@gnu.org>
parents:
diff changeset
1488 AMSTeX
Dave Love <fx@gnu.org>
parents:
diff changeset
1489 ("\\myfig[]@{@}@{@}@{*@}@{@}" ?f nil nil 3)
Dave Love <fx@gnu.org>
parents:
diff changeset
1490 (detect-linguex ?x "ex:" "~\\ref@{%s@}" nil ("Example" "Ex."))))
Dave Love <fx@gnu.org>
parents:
diff changeset
1491 @end lisp
Dave Love <fx@gnu.org>
parents:
diff changeset
1492
Dave Love <fx@gnu.org>
parents:
diff changeset
1493 @node Reference Info, xr (LaTeX package), Defining Label Environments, Labels and References
Dave Love <fx@gnu.org>
parents:
diff changeset
1494 @section Reference Info
Dave Love <fx@gnu.org>
parents:
diff changeset
1495 @findex reftex-view-crossref
Dave Love <fx@gnu.org>
parents:
diff changeset
1496 @findex reftex-mouse-view-crossref
Dave Love <fx@gnu.org>
parents:
diff changeset
1497 @cindex Cross-references, displaying
Dave Love <fx@gnu.org>
parents:
diff changeset
1498 @cindex Reference info
Dave Love <fx@gnu.org>
parents:
diff changeset
1499 @cindex Displaying cross-references
Dave Love <fx@gnu.org>
parents:
diff changeset
1500 @cindex Viewing cross-references
Dave Love <fx@gnu.org>
parents:
diff changeset
1501 @kindex C-c &
37999
8e7df927fd92 Updated to version 4.16
Carsten Dominik <dominik@science.uva.nl>
parents: 37404
diff changeset
1502 @kindex S-mouse-2
25829
Dave Love <fx@gnu.org>
parents:
diff changeset
1503
Dave Love <fx@gnu.org>
parents:
diff changeset
1504 When point is idle on the argument of a @code{\ref} macro, the echo area
Dave Love <fx@gnu.org>
parents:
diff changeset
1505 will display some information about the label referenced there. Note
Dave Love <fx@gnu.org>
parents:
diff changeset
1506 that the information is only displayed if the echo area is not occupied
Dave Love <fx@gnu.org>
parents:
diff changeset
1507 by a different message.
Dave Love <fx@gnu.org>
parents:
diff changeset
1508
Dave Love <fx@gnu.org>
parents:
diff changeset
1509 @b{Ref@TeX{}} can also display the label definition corresponding to a
Dave Love <fx@gnu.org>
parents:
diff changeset
1510 @code{\ref} macro, or all reference locations corresponding to a
Dave Love <fx@gnu.org>
parents:
diff changeset
1511 @code{\label} macro. @xref{Viewing Cross-References}, for more
Dave Love <fx@gnu.org>
parents:
diff changeset
1512 information.@refill
Dave Love <fx@gnu.org>
parents:
diff changeset
1513
Dave Love <fx@gnu.org>
parents:
diff changeset
1514 @node xr (LaTeX package), varioref (LaTeX package), Reference Info, Labels and References
Dave Love <fx@gnu.org>
parents:
diff changeset
1515 @section @code{xr}: Cross-Document References
Dave Love <fx@gnu.org>
parents:
diff changeset
1516 @cindex @code{xr}, LaTeX package
Dave Love <fx@gnu.org>
parents:
diff changeset
1517 @cindex LaTeX packages, @code{xr}
Dave Love <fx@gnu.org>
parents:
diff changeset
1518 @cindex @code{\externaldocument}
Dave Love <fx@gnu.org>
parents:
diff changeset
1519 @cindex External documents
Dave Love <fx@gnu.org>
parents:
diff changeset
1520 @cindex References to external documents
Dave Love <fx@gnu.org>
parents:
diff changeset
1521 @cindex Cross-document references
Dave Love <fx@gnu.org>
parents:
diff changeset
1522
Dave Love <fx@gnu.org>
parents:
diff changeset
1523 The LaTeX package @code{xr} makes it possible to create references to
Dave Love <fx@gnu.org>
parents:
diff changeset
1524 labels defined in external documents. The preamble of a document using
Dave Love <fx@gnu.org>
parents:
diff changeset
1525 @code{xr} will contain something like this:@refill
Dave Love <fx@gnu.org>
parents:
diff changeset
1526
Dave Love <fx@gnu.org>
parents:
diff changeset
1527 @example
Dave Love <fx@gnu.org>
parents:
diff changeset
1528 \usepackage@{xr@}
Dave Love <fx@gnu.org>
parents:
diff changeset
1529 \externaldocument[V1-]@{volume1@}
Dave Love <fx@gnu.org>
parents:
diff changeset
1530 \externaldocument[V3-]@{volume3@}
Dave Love <fx@gnu.org>
parents:
diff changeset
1531 @end example
Dave Love <fx@gnu.org>
parents:
diff changeset
1532
Dave Love <fx@gnu.org>
parents:
diff changeset
1533 @noindent
Dave Love <fx@gnu.org>
parents:
diff changeset
1534 and we can make references to any labels defined in these
Dave Love <fx@gnu.org>
parents:
diff changeset
1535 external documents by using the prefixes @samp{V1-} and @samp{V3-},
Dave Love <fx@gnu.org>
parents:
diff changeset
1536 respectively.@refill
Dave Love <fx@gnu.org>
parents:
diff changeset
1537
Dave Love <fx@gnu.org>
parents:
diff changeset
1538 @b{Ref@TeX{}} can be used to create such references as well. Start the
Dave Love <fx@gnu.org>
parents:
diff changeset
1539 referencing process normally, by pressing @kbd{C-c )}. Select a label
Dave Love <fx@gnu.org>
parents:
diff changeset
1540 type if necessary. When you see the label selection buffer, pressing
Dave Love <fx@gnu.org>
parents:
diff changeset
1541 @kbd{x} will switch to the label selection buffer of one of the external
Dave Love <fx@gnu.org>
parents:
diff changeset
1542 documents. You may then select a label as before and @b{Ref@TeX{}} will
Dave Love <fx@gnu.org>
parents:
diff changeset
1543 insert it along with the required prefix.@refill
Dave Love <fx@gnu.org>
parents:
diff changeset
1544
Dave Love <fx@gnu.org>
parents:
diff changeset
1545 For this kind of inter-document cross-references, saving of parsing
Dave Love <fx@gnu.org>
parents:
diff changeset
1546 information and the use of multiple selection buffers can mean a large
Dave Love <fx@gnu.org>
parents:
diff changeset
1547 speed-up (@pxref{Optimizations}).@refill
Dave Love <fx@gnu.org>
parents:
diff changeset
1548
Dave Love <fx@gnu.org>
parents:
diff changeset
1549 @node varioref (LaTeX package), fancyref (LaTeX package), xr (LaTeX package), Labels and References
Dave Love <fx@gnu.org>
parents:
diff changeset
1550 @section @code{varioref}: Variable Page References
Dave Love <fx@gnu.org>
parents:
diff changeset
1551 @cindex @code{varioref}, LaTeX package
Dave Love <fx@gnu.org>
parents:
diff changeset
1552 @cindex @code{\vref}
Dave Love <fx@gnu.org>
parents:
diff changeset
1553 @cindex LaTeX packages, @code{varioref}
Dave Love <fx@gnu.org>
parents:
diff changeset
1554 @vindex reftex-vref-is-default
Dave Love <fx@gnu.org>
parents:
diff changeset
1555 @code{varioref} is a frequently used LaTeX package to create
Dave Love <fx@gnu.org>
parents:
diff changeset
1556 cross--references with page information. When you want to make a
Dave Love <fx@gnu.org>
parents:
diff changeset
1557 reference with the @code{\vref} macro, just press the @kbd{v} key in the
Dave Love <fx@gnu.org>
parents:
diff changeset
1558 selection buffer to toggle between @code{\ref} and @code{\vref}
Dave Love <fx@gnu.org>
parents:
diff changeset
1559 (@pxref{Referencing Labels}). The mode line of the selection buffer
Dave Love <fx@gnu.org>
parents:
diff changeset
1560 shows the current status of this switch. If you find that you almost
Dave Love <fx@gnu.org>
parents:
diff changeset
1561 always use @code{\vref}, you may want to make it the default by
Dave Love <fx@gnu.org>
parents:
diff changeset
1562 customizing the variable @code{reftex-vref-is-default}. If this
Dave Love <fx@gnu.org>
parents:
diff changeset
1563 toggling seems too inconvenient, you can also use the command
Dave Love <fx@gnu.org>
parents:
diff changeset
1564 @code{reftex-varioref-vref}@footnote{bind it to @kbd{C-c v}.}.
Dave Love <fx@gnu.org>
parents:
diff changeset
1565 Or use AUCTeX to create your macros (@pxref{AUCTeX}).@refill
Dave Love <fx@gnu.org>
parents:
diff changeset
1566
Dave Love <fx@gnu.org>
parents:
diff changeset
1567 @node fancyref (LaTeX package), , varioref (LaTeX package), Labels and References
Dave Love <fx@gnu.org>
parents:
diff changeset
1568 @section @code{fancyref}: Fancy Cross References
Dave Love <fx@gnu.org>
parents:
diff changeset
1569 @cindex @code{fancyref}, LaTeX package
Dave Love <fx@gnu.org>
parents:
diff changeset
1570 @cindex @code{\fref}
Dave Love <fx@gnu.org>
parents:
diff changeset
1571 @cindex @code{\Fref}
Dave Love <fx@gnu.org>
parents:
diff changeset
1572 @cindex LaTeX packages, @code{fancyref}
Dave Love <fx@gnu.org>
parents:
diff changeset
1573 @vindex reftex-fref-is-default
Dave Love <fx@gnu.org>
parents:
diff changeset
1574 @code{fancyref} is a LaTeX package where a macro call like
Dave Love <fx@gnu.org>
parents:
diff changeset
1575 @code{\fref@{@var{fig:map-of-germany}@}} creates not only the number of
Dave Love <fx@gnu.org>
parents:
diff changeset
1576 the referenced counter but also the complete text around it, like
Dave Love <fx@gnu.org>
parents:
diff changeset
1577 @samp{Figure 3 on the preceding page}. In order to make it work you
Dave Love <fx@gnu.org>
parents:
diff changeset
1578 need to use label prefixes like @samp{fig:} consistently - something
Dave Love <fx@gnu.org>
parents:
diff changeset
1579 @b{Ref@TeX{}} does automatically. When you want to make a reference
Dave Love <fx@gnu.org>
parents:
diff changeset
1580 with the @code{\fref} macro, just press the @kbd{V} key in the selection
Dave Love <fx@gnu.org>
parents:
diff changeset
1581 buffer to cycle between @code{\ref}, @code{\fref} and @code{\Fref}
Dave Love <fx@gnu.org>
parents:
diff changeset
1582 (@pxref{Referencing Labels}). The mode line of the selection buffer
Dave Love <fx@gnu.org>
parents:
diff changeset
1583 shows the current status of this switch. If this cycling seems
Dave Love <fx@gnu.org>
parents:
diff changeset
1584 inconvenient, you can also use the commands @code{reftex-fancyref-fref}
Dave Love <fx@gnu.org>
parents:
diff changeset
1585 and @code{reftex-fancyref-Fref}@footnote{bind them to @kbd{C-c
Dave Love <fx@gnu.org>
parents:
diff changeset
1586 f} and @kbd{C-c F}.}. Or use AUCTeX to create your macros
Dave Love <fx@gnu.org>
parents:
diff changeset
1587 (@pxref{AUCTeX}).@refill
Dave Love <fx@gnu.org>
parents:
diff changeset
1588
Dave Love <fx@gnu.org>
parents:
diff changeset
1589 @node Citations, Index Support, Labels and References, Top
Dave Love <fx@gnu.org>
parents:
diff changeset
1590 @chapter Citations
Dave Love <fx@gnu.org>
parents:
diff changeset
1591 @cindex Citations
Dave Love <fx@gnu.org>
parents:
diff changeset
1592 @cindex @code{\cite}
Dave Love <fx@gnu.org>
parents:
diff changeset
1593
Dave Love <fx@gnu.org>
parents:
diff changeset
1594 Citations in LaTeX are done with the @code{\cite} macro or variations of
Dave Love <fx@gnu.org>
parents:
diff changeset
1595 it. The argument of the macro is a citation key which identifies an
Dave Love <fx@gnu.org>
parents:
diff changeset
1596 article or book in either a BibTeX database file or in an explicit
Dave Love <fx@gnu.org>
parents:
diff changeset
1597 @code{thebibliography} environment in the document. @b{Ref@TeX{}}'s
Dave Love <fx@gnu.org>
parents:
diff changeset
1598 support for citations helps to select the correct key quickly.@refill
Dave Love <fx@gnu.org>
parents:
diff changeset
1599
Dave Love <fx@gnu.org>
parents:
diff changeset
1600 @menu
Dave Love <fx@gnu.org>
parents:
diff changeset
1601 * Creating Citations:: How to create them.
Dave Love <fx@gnu.org>
parents:
diff changeset
1602 * Citation Styles:: Natbib, Harvard, Chicago and Co.
Dave Love <fx@gnu.org>
parents:
diff changeset
1603 * Citation Info:: View the corresponding database entry.
Dave Love <fx@gnu.org>
parents:
diff changeset
1604 * Chapterbib and Bibunits:: Multiple bibliographies in a Document.
Dave Love <fx@gnu.org>
parents:
diff changeset
1605 * Citations Outside LaTeX:: How to make citations in Emails etc.
Dave Love <fx@gnu.org>
parents:
diff changeset
1606 @end menu
Dave Love <fx@gnu.org>
parents:
diff changeset
1607
Dave Love <fx@gnu.org>
parents:
diff changeset
1608 @node Creating Citations, Citation Styles, , Citations
Dave Love <fx@gnu.org>
parents:
diff changeset
1609 @section Creating Citations
Dave Love <fx@gnu.org>
parents:
diff changeset
1610 @cindex Creating citations
Dave Love <fx@gnu.org>
parents:
diff changeset
1611 @cindex Citations, creating
Dave Love <fx@gnu.org>
parents:
diff changeset
1612 @findex reftex-citation
Dave Love <fx@gnu.org>
parents:
diff changeset
1613 @kindex C-c [
Dave Love <fx@gnu.org>
parents:
diff changeset
1614 @cindex Selection buffer, citations
Dave Love <fx@gnu.org>
parents:
diff changeset
1615 @cindex Selection process
Dave Love <fx@gnu.org>
parents:
diff changeset
1616
Dave Love <fx@gnu.org>
parents:
diff changeset
1617 In order to create a citation, press @kbd{C-c [}. @b{Ref@TeX{}} then
Dave Love <fx@gnu.org>
parents:
diff changeset
1618 prompts for a regular expression which will be used to search through
Dave Love <fx@gnu.org>
parents:
diff changeset
1619 the database and present the list of matches to choose from in a
Dave Love <fx@gnu.org>
parents:
diff changeset
1620 selection process similar to that for selecting labels
Dave Love <fx@gnu.org>
parents:
diff changeset
1621 (@pxref{Referencing Labels}).@refill
Dave Love <fx@gnu.org>
parents:
diff changeset
1622
Dave Love <fx@gnu.org>
parents:
diff changeset
1623 The regular expression uses an extended syntax: @samp{&&} defines a
Dave Love <fx@gnu.org>
parents:
diff changeset
1624 logic @code{and} for regular expressions. For example
Dave Love <fx@gnu.org>
parents:
diff changeset
1625 @samp{Einstein&&Bose} will match all articles which mention
Dave Love <fx@gnu.org>
parents:
diff changeset
1626 Bose-Einstein condensation, or which are co-authored by Bose and
Dave Love <fx@gnu.org>
parents:
diff changeset
1627 Einstein. When entering the regular expression, you can complete on
Dave Love <fx@gnu.org>
parents:
diff changeset
1628 known citation keys.@refill
Dave Love <fx@gnu.org>
parents:
diff changeset
1629
Dave Love <fx@gnu.org>
parents:
diff changeset
1630 @cindex @code{\bibliography}
Dave Love <fx@gnu.org>
parents:
diff changeset
1631 @cindex @code{thebibliography}, LaTeX environment
Dave Love <fx@gnu.org>
parents:
diff changeset
1632 @cindex @code{BIBINPUTS}, environment variable
Dave Love <fx@gnu.org>
parents:
diff changeset
1633 @cindex @code{TEXBIB}, environment variable
Dave Love <fx@gnu.org>
parents:
diff changeset
1634 @b{Ref@TeX{}} prefers to use BibTeX database files specified with a
Dave Love <fx@gnu.org>
parents:
diff changeset
1635 @code{\bibliography} macro to collect its information. Just like
Dave Love <fx@gnu.org>
parents:
diff changeset
1636 BibTeX, it will search for the specified files in the current directory
Dave Love <fx@gnu.org>
parents:
diff changeset
1637 and along the path given in the environment variable @code{BIBINPUTS}.
Dave Love <fx@gnu.org>
parents:
diff changeset
1638 If you do not use BibTeX, but the document contains an explicit
Dave Love <fx@gnu.org>
parents:
diff changeset
1639 @code{thebibliography} environment, @b{Ref@TeX{}} will collect its
Dave Love <fx@gnu.org>
parents:
diff changeset
1640 information from there. Note that in this case the information
Dave Love <fx@gnu.org>
parents:
diff changeset
1641 presented in the selection buffer will just be a copy of relevant
Dave Love <fx@gnu.org>
parents:
diff changeset
1642 @code{\bibitem} entries, not the structured listing available with
Dave Love <fx@gnu.org>
parents:
diff changeset
1643 BibTeX database files.@refill
Dave Love <fx@gnu.org>
parents:
diff changeset
1644
Dave Love <fx@gnu.org>
parents:
diff changeset
1645 @kindex ?
Dave Love <fx@gnu.org>
parents:
diff changeset
1646 In the selection buffer, the following keys provide special commands. A
Dave Love <fx@gnu.org>
parents:
diff changeset
1647 summary of this information is always available from the selection
Dave Love <fx@gnu.org>
parents:
diff changeset
1648 process by pressing @kbd{?}.@refill
Dave Love <fx@gnu.org>
parents:
diff changeset
1649
Dave Love <fx@gnu.org>
parents:
diff changeset
1650 @table @kbd
Dave Love <fx@gnu.org>
parents:
diff changeset
1651 @tablesubheading{General}
Dave Love <fx@gnu.org>
parents:
diff changeset
1652 @item ?
Dave Love <fx@gnu.org>
parents:
diff changeset
1653 Show a summary of available commands.
Dave Love <fx@gnu.org>
parents:
diff changeset
1654
Dave Love <fx@gnu.org>
parents:
diff changeset
1655 @item 0-9,-
Dave Love <fx@gnu.org>
parents:
diff changeset
1656 Prefix argument.
Dave Love <fx@gnu.org>
parents:
diff changeset
1657
Dave Love <fx@gnu.org>
parents:
diff changeset
1658 @tablesubheading{Moving around}
Dave Love <fx@gnu.org>
parents:
diff changeset
1659 @item n
Dave Love <fx@gnu.org>
parents:
diff changeset
1660 Go to next article.
Dave Love <fx@gnu.org>
parents:
diff changeset
1661
Dave Love <fx@gnu.org>
parents:
diff changeset
1662 @item p
Dave Love <fx@gnu.org>
parents:
diff changeset
1663 Go to previous article.
Dave Love <fx@gnu.org>
parents:
diff changeset
1664
Dave Love <fx@gnu.org>
parents:
diff changeset
1665 @tablesubheading{Access to full database entries}
Dave Love <fx@gnu.org>
parents:
diff changeset
1666 @item @key{SPC}
Dave Love <fx@gnu.org>
parents:
diff changeset
1667 Show the database entry corresponding to the article at point, in
Dave Love <fx@gnu.org>
parents:
diff changeset
1668 another window. See also the @kbd{f} key.@refill
Dave Love <fx@gnu.org>
parents:
diff changeset
1669
Dave Love <fx@gnu.org>
parents:
diff changeset
1670 @item f
Dave Love <fx@gnu.org>
parents:
diff changeset
1671 Toggle follow mode. When follow mode is active, the other window will
Dave Love <fx@gnu.org>
parents:
diff changeset
1672 always display the full database entry of the current article. This is
Dave Love <fx@gnu.org>
parents:
diff changeset
1673 equivalent to pressing @key{SPC} after each cursor motion. With BibTeX
Dave Love <fx@gnu.org>
parents:
diff changeset
1674 entries, follow mode can be rather slow.@refill
Dave Love <fx@gnu.org>
parents:
diff changeset
1675
Dave Love <fx@gnu.org>
parents:
diff changeset
1676 @tablesubheading{Selecting entries and creating the citation}
Dave Love <fx@gnu.org>
parents:
diff changeset
1677 @item @key{RET}
Dave Love <fx@gnu.org>
parents:
diff changeset
1678 Insert a citation referencing the article at point into the buffer from
Dave Love <fx@gnu.org>
parents:
diff changeset
1679 which the selection process was started.@refill
Dave Love <fx@gnu.org>
parents:
diff changeset
1680
37999
8e7df927fd92 Updated to version 4.16
Carsten Dominik <dominik@science.uva.nl>
parents: 37404
diff changeset
1681 @item mouse-2
25829
Dave Love <fx@gnu.org>
parents:
diff changeset
1682 @vindex reftex-highlight-selection
Dave Love <fx@gnu.org>
parents:
diff changeset
1683 Clicking with mouse button 2 on a citation will accept it like @key{RET}
Dave Love <fx@gnu.org>
parents:
diff changeset
1684 would. See also variable @code{reftex-highlight-selection}, @ref{Options
Dave Love <fx@gnu.org>
parents:
diff changeset
1685 (Misc)}.@refill
Dave Love <fx@gnu.org>
parents:
diff changeset
1686
Dave Love <fx@gnu.org>
parents:
diff changeset
1687 @item m
Dave Love <fx@gnu.org>
parents:
diff changeset
1688 Mark the current entry. When one or several entries are marked,
Dave Love <fx@gnu.org>
parents:
diff changeset
1689 pressing @kbd{a} or @kbd{A} accepts all marked entries. Also,
Dave Love <fx@gnu.org>
parents:
diff changeset
1690 @key{RET} behaves like the @kbd{a} key.
Dave Love <fx@gnu.org>
parents:
diff changeset
1691
Dave Love <fx@gnu.org>
parents:
diff changeset
1692 @item u
Dave Love <fx@gnu.org>
parents:
diff changeset
1693 Unmark a marked entry.
Dave Love <fx@gnu.org>
parents:
diff changeset
1694
Dave Love <fx@gnu.org>
parents:
diff changeset
1695 @item a
Dave Love <fx@gnu.org>
parents:
diff changeset
1696 Accept all (marked) entries in the selection buffer and create a single
Dave Love <fx@gnu.org>
parents:
diff changeset
1697 @code{\cite} macro referring to them.@refill
Dave Love <fx@gnu.org>
parents:
diff changeset
1698
Dave Love <fx@gnu.org>
parents:
diff changeset
1699 @item A
Dave Love <fx@gnu.org>
parents:
diff changeset
1700 Accept all (marked) entries in the selection buffer and create a
Dave Love <fx@gnu.org>
parents:
diff changeset
1701 separate @code{\cite} macro for each of it.@refill
Dave Love <fx@gnu.org>
parents:
diff changeset
1702
Dave Love <fx@gnu.org>
parents:
diff changeset
1703 @item @key{TAB}
Dave Love <fx@gnu.org>
parents:
diff changeset
1704 Enter a citation key with completion. This may also be a key which does
Dave Love <fx@gnu.org>
parents:
diff changeset
1705 not yet exist.
Dave Love <fx@gnu.org>
parents:
diff changeset
1706
Dave Love <fx@gnu.org>
parents:
diff changeset
1707 @item .
Dave Love <fx@gnu.org>
parents:
diff changeset
1708 Show insertion point in another window. This is the point from where you
Dave Love <fx@gnu.org>
parents:
diff changeset
1709 called @code{reftex-citation}.@refill
Dave Love <fx@gnu.org>
parents:
diff changeset
1710
Dave Love <fx@gnu.org>
parents:
diff changeset
1711 @tablesubheading{Exiting}
Dave Love <fx@gnu.org>
parents:
diff changeset
1712 @item q
Dave Love <fx@gnu.org>
parents:
diff changeset
1713 Exit the selection process without inserting a citation into the
Dave Love <fx@gnu.org>
parents:
diff changeset
1714 buffer.@refill
Dave Love <fx@gnu.org>
parents:
diff changeset
1715
Dave Love <fx@gnu.org>
parents:
diff changeset
1716 @tablesubheading{Updating the buffer}
Dave Love <fx@gnu.org>
parents:
diff changeset
1717
Dave Love <fx@gnu.org>
parents:
diff changeset
1718 @item g
Dave Love <fx@gnu.org>
parents:
diff changeset
1719 Start over with a new regular expression. The full database will be
Dave Love <fx@gnu.org>
parents:
diff changeset
1720 rescanned with the new expression (see also @kbd{r}).@refill
Dave Love <fx@gnu.org>
parents:
diff changeset
1721
Dave Love <fx@gnu.org>
parents:
diff changeset
1722 @c FIXME: Should we use something else here? r is usually rescan!
Dave Love <fx@gnu.org>
parents:
diff changeset
1723 @item r
Dave Love <fx@gnu.org>
parents:
diff changeset
1724 Refine the current selection with another regular expression. This will
Dave Love <fx@gnu.org>
parents:
diff changeset
1725 @emph{not} rescan the entire database, but just the already selected
Dave Love <fx@gnu.org>
parents:
diff changeset
1726 entries.@refill
Dave Love <fx@gnu.org>
parents:
diff changeset
1727
Dave Love <fx@gnu.org>
parents:
diff changeset
1728 @end table
Dave Love <fx@gnu.org>
parents:
diff changeset
1729
Dave Love <fx@gnu.org>
parents:
diff changeset
1730 @vindex reftex-select-bib-map
Dave Love <fx@gnu.org>
parents:
diff changeset
1731 In order to define additional commands for this selection process, the
Dave Love <fx@gnu.org>
parents:
diff changeset
1732 keymap @code{reftex-select-bib-map} may be used.@refill
Dave Love <fx@gnu.org>
parents:
diff changeset
1733
Dave Love <fx@gnu.org>
parents:
diff changeset
1734 @node Citation Styles, Citation Info, Creating Citations, Citations
Dave Love <fx@gnu.org>
parents:
diff changeset
1735 @section Citation Styles
Dave Love <fx@gnu.org>
parents:
diff changeset
1736 @cindex Citation styles
Dave Love <fx@gnu.org>
parents:
diff changeset
1737 @cindex Citation styles, @code{natbib}
Dave Love <fx@gnu.org>
parents:
diff changeset
1738 @cindex Citation styles, @code{harvard}
Dave Love <fx@gnu.org>
parents:
diff changeset
1739 @cindex Citation styles, @code{chicago}
Dave Love <fx@gnu.org>
parents:
diff changeset
1740 @cindex @code{natbib}, citation style
Dave Love <fx@gnu.org>
parents:
diff changeset
1741 @cindex @code{harvard}, citation style
Dave Love <fx@gnu.org>
parents:
diff changeset
1742 @cindex @code{chicago}, citation style
Dave Love <fx@gnu.org>
parents:
diff changeset
1743
Dave Love <fx@gnu.org>
parents:
diff changeset
1744 @vindex reftex-cite-format
Dave Love <fx@gnu.org>
parents:
diff changeset
1745 The standard LaTeX macro @code{\cite} works well with numeric or simple
Dave Love <fx@gnu.org>
parents:
diff changeset
1746 key citations. To deal with the more complex task of author-year
Dave Love <fx@gnu.org>
parents:
diff changeset
1747 citations as used in many natural sciences, a variety of packages has
Dave Love <fx@gnu.org>
parents:
diff changeset
1748 been developed which define derived forms of the @code{\cite} macro.
Dave Love <fx@gnu.org>
parents:
diff changeset
1749 @b{Ref@TeX{}} can be configured to produce these citation macros as well by
Dave Love <fx@gnu.org>
parents:
diff changeset
1750 setting the variable @code{reftex-cite-format}. For the most commonly
Dave Love <fx@gnu.org>
parents:
diff changeset
1751 used packages (@code{natbib}, @code{harvard}, @code{chicago}) this may
Dave Love <fx@gnu.org>
parents:
diff changeset
1752 be done from the menu, under @code{Ref->Citation Styles}. Since there
Dave Love <fx@gnu.org>
parents:
diff changeset
1753 are usually several macros to create the citations, executing
Dave Love <fx@gnu.org>
parents:
diff changeset
1754 @code{reftex-citation} (@kbd{C-c [}) starts by prompting for the correct
Dave Love <fx@gnu.org>
parents:
diff changeset
1755 macro. For the Natbib style, this looks like this:
Dave Love <fx@gnu.org>
parents:
diff changeset
1756
Dave Love <fx@gnu.org>
parents:
diff changeset
1757 @example
Dave Love <fx@gnu.org>
parents:
diff changeset
1758 SELECT A CITATION FORMAT
Dave Love <fx@gnu.org>
parents:
diff changeset
1759
Dave Love <fx@gnu.org>
parents:
diff changeset
1760 [^M] \cite@{%l@}
Dave Love <fx@gnu.org>
parents:
diff changeset
1761 [t] \citet@{%l@}
Dave Love <fx@gnu.org>
parents:
diff changeset
1762 [T] \citet*@{%l@}
Dave Love <fx@gnu.org>
parents:
diff changeset
1763 [p] \citep@{%l@}
Dave Love <fx@gnu.org>
parents:
diff changeset
1764 [P] \citep*@{%l@}
Dave Love <fx@gnu.org>
parents:
diff changeset
1765 [e] \citep[e.g.][]@{%l@}
Dave Love <fx@gnu.org>
parents:
diff changeset
1766 [s] \citep[see][]@{%l@}
Dave Love <fx@gnu.org>
parents:
diff changeset
1767 [a] \citeauthor@{%l@}
Dave Love <fx@gnu.org>
parents:
diff changeset
1768 [A] \citeauthor*@{%l@}
Dave Love <fx@gnu.org>
parents:
diff changeset
1769 [y] \citeyear@{%l@}
Dave Love <fx@gnu.org>
parents:
diff changeset
1770 @end example
Dave Love <fx@gnu.org>
parents:
diff changeset
1771
Dave Love <fx@gnu.org>
parents:
diff changeset
1772 Following the most generic of these packages, @code{natbib}, the builtin
Dave Love <fx@gnu.org>
parents:
diff changeset
1773 citation packages always accept the @kbd{t} key for a @emph{textual}
Dave Love <fx@gnu.org>
parents:
diff changeset
1774 citation (like: @code{Jones et al. (1997) have shown...}) as well as
Dave Love <fx@gnu.org>
parents:
diff changeset
1775 the @kbd{p} key for a parenthetical citation (like: @code{As shown
Dave Love <fx@gnu.org>
parents:
diff changeset
1776 earlier (Jones et al, 1997)}).@refill
Dave Love <fx@gnu.org>
parents:
diff changeset
1777
Dave Love <fx@gnu.org>
parents:
diff changeset
1778 To make one of these styles the default, customize the variable
Dave Love <fx@gnu.org>
parents:
diff changeset
1779 @code{reftex-cite-format} or put into @file{.emacs}:
Dave Love <fx@gnu.org>
parents:
diff changeset
1780
Dave Love <fx@gnu.org>
parents:
diff changeset
1781 @lisp
Dave Love <fx@gnu.org>
parents:
diff changeset
1782 (setq reftex-cite-format 'natbib)
Dave Love <fx@gnu.org>
parents:
diff changeset
1783 @end lisp
Dave Love <fx@gnu.org>
parents:
diff changeset
1784
Dave Love <fx@gnu.org>
parents:
diff changeset
1785 You can also use AUCTeX style files to automatically set the
Dave Love <fx@gnu.org>
parents:
diff changeset
1786 citation style based on the @code{usepackage} commands in a given
Dave Love <fx@gnu.org>
parents:
diff changeset
1787 document. @xref{Style Files}, for information on how to set up the style
Dave Love <fx@gnu.org>
parents:
diff changeset
1788 files correctly.@refill
Dave Love <fx@gnu.org>
parents:
diff changeset
1789
Dave Love <fx@gnu.org>
parents:
diff changeset
1790 @node Citation Info, Chapterbib and Bibunits, Citation Styles, Citations, Top
Dave Love <fx@gnu.org>
parents:
diff changeset
1791 @section Citation Info
Dave Love <fx@gnu.org>
parents:
diff changeset
1792 @cindex Displaying citations
Dave Love <fx@gnu.org>
parents:
diff changeset
1793 @cindex Citations, displaying
Dave Love <fx@gnu.org>
parents:
diff changeset
1794 @cindex Citation info
Dave Love <fx@gnu.org>
parents:
diff changeset
1795 @cindex Viewing citations
Dave Love <fx@gnu.org>
parents:
diff changeset
1796 @kindex C-c &
37999
8e7df927fd92 Updated to version 4.16
Carsten Dominik <dominik@science.uva.nl>
parents: 37404
diff changeset
1797 @kindex S-mouse-2
25829
Dave Love <fx@gnu.org>
parents:
diff changeset
1798 @findex reftex-view-crossref
Dave Love <fx@gnu.org>
parents:
diff changeset
1799 @findex reftex-mouse-view-crossref
Dave Love <fx@gnu.org>
parents:
diff changeset
1800
Dave Love <fx@gnu.org>
parents:
diff changeset
1801 When point is idle on the argument of a @code{\cite} macro, the echo area
Dave Love <fx@gnu.org>
parents:
diff changeset
1802 will display some information about the article cited there. Note
Dave Love <fx@gnu.org>
parents:
diff changeset
1803 that the information is only displayed if the echo area is not occupied
Dave Love <fx@gnu.org>
parents:
diff changeset
1804 by a different message.
Dave Love <fx@gnu.org>
parents:
diff changeset
1805
Dave Love <fx@gnu.org>
parents:
diff changeset
1806 @b{Ref@TeX{}} can also display the @code{\bibitem} or BibTeX database
Dave Love <fx@gnu.org>
parents:
diff changeset
1807 entry corresponding to a @code{\cite} macro, or all citation locations
Dave Love <fx@gnu.org>
parents:
diff changeset
1808 corresponding to a @code{\bibitem} or BibTeX database entry.
Dave Love <fx@gnu.org>
parents:
diff changeset
1809 @xref{Viewing Cross-References}.@refill
Dave Love <fx@gnu.org>
parents:
diff changeset
1810
Dave Love <fx@gnu.org>
parents:
diff changeset
1811 @node Chapterbib and Bibunits, Citations Outside LaTeX, Citation Info, Citations
Dave Love <fx@gnu.org>
parents:
diff changeset
1812 @section Chapterbib and Bibunits
Dave Love <fx@gnu.org>
parents:
diff changeset
1813 @cindex @code{chapterbib}, LaTeX package
Dave Love <fx@gnu.org>
parents:
diff changeset
1814 @cindex @code{bibunits}, LaTeX package
Dave Love <fx@gnu.org>
parents:
diff changeset
1815 @cindex Bibliographies, multiple
Dave Love <fx@gnu.org>
parents:
diff changeset
1816
Dave Love <fx@gnu.org>
parents:
diff changeset
1817 @code{chapterbib} and @code{bibunits} are two LaTeX packages which
Dave Love <fx@gnu.org>
parents:
diff changeset
1818 produce multiple bibliographies in a document. This is no problem for
Dave Love <fx@gnu.org>
parents:
diff changeset
1819 @b{Ref@TeX{}} as long as all bibliographies use the same BibTeX database
Dave Love <fx@gnu.org>
parents:
diff changeset
1820 files. If they do not, it is best to have each document part in a
Dave Love <fx@gnu.org>
parents:
diff changeset
1821 separate file (as it is required for @code{chapterbib} anyway). Then
Dave Love <fx@gnu.org>
parents:
diff changeset
1822 @b{Ref@TeX{}} will still scan the locally relevant databases correctly. If
Dave Love <fx@gnu.org>
parents:
diff changeset
1823 you have multiple bibliographies within a @emph{single file}, this may
Dave Love <fx@gnu.org>
parents:
diff changeset
1824 or may not be the case.
Dave Love <fx@gnu.org>
parents:
diff changeset
1825
Dave Love <fx@gnu.org>
parents:
diff changeset
1826 @node Citations Outside LaTeX, , Chapterbib and Bibunits, Citations
Dave Love <fx@gnu.org>
parents:
diff changeset
1827 @section Citations outside LaTeX
Dave Love <fx@gnu.org>
parents:
diff changeset
1828 @cindex Citations outside LaTeX
Dave Love <fx@gnu.org>
parents:
diff changeset
1829 @vindex reftex-default-bibliography
Dave Love <fx@gnu.org>
parents:
diff changeset
1830
Dave Love <fx@gnu.org>
parents:
diff changeset
1831 The command @code{reftex-citation} can also be executed outside a LaTeX
Dave Love <fx@gnu.org>
parents:
diff changeset
1832 buffer. This can be useful to reference articles in the mail buffer and
Dave Love <fx@gnu.org>
parents:
diff changeset
1833 other documents. You should @emph{not} enter @code{reftex-mode} for
Dave Love <fx@gnu.org>
parents:
diff changeset
1834 this, just execute the command. The list of BibTeX files will in this
Dave Love <fx@gnu.org>
parents:
diff changeset
1835 case be taken from the variable @code{reftex-default-bibliography}.
Dave Love <fx@gnu.org>
parents:
diff changeset
1836 Setting the variable @code{reftex-cite-format} to the symbol
Dave Love <fx@gnu.org>
parents:
diff changeset
1837 @code{locally} does a decent job of putting all relevant information
Dave Love <fx@gnu.org>
parents:
diff changeset
1838 about a citation directly into the buffer. Here is the lisp code to add
Dave Love <fx@gnu.org>
parents:
diff changeset
1839 the @kbd{C-c [} binding to the mail buffer. It also provides a local
Dave Love <fx@gnu.org>
parents:
diff changeset
1840 binding for @code{reftex-cite-format}.@refill
Dave Love <fx@gnu.org>
parents:
diff changeset
1841
Dave Love <fx@gnu.org>
parents:
diff changeset
1842 @lisp
26911
d7f536a01276 Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents: 25829
diff changeset
1843 (add-hook 'mail-setup-hook
d7f536a01276 Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents: 25829
diff changeset
1844 (lambda () (define-key mail-mode-map "\C-c["
d7f536a01276 Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents: 25829
diff changeset
1845 (lambda () (interactive)
d7f536a01276 Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents: 25829
diff changeset
1846 (require 'reftex)
d7f536a01276 Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents: 25829
diff changeset
1847 (let ((reftex-cite-format 'locally))
d7f536a01276 Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents: 25829
diff changeset
1848 (reftex-citation))))))
25829
Dave Love <fx@gnu.org>
parents:
diff changeset
1849 @end lisp
Dave Love <fx@gnu.org>
parents:
diff changeset
1850
Dave Love <fx@gnu.org>
parents:
diff changeset
1851 @node Index Support, Viewing Cross-References, Citations, Top
Dave Love <fx@gnu.org>
parents:
diff changeset
1852 @chapter Index Support
Dave Love <fx@gnu.org>
parents:
diff changeset
1853 @cindex Index Support
Dave Love <fx@gnu.org>
parents:
diff changeset
1854 @cindex @code{\index}
Dave Love <fx@gnu.org>
parents:
diff changeset
1855
Dave Love <fx@gnu.org>
parents:
diff changeset
1856 LaTeX has builtin support for creating an Index. The LaTeX core
Dave Love <fx@gnu.org>
parents:
diff changeset
1857 supports two different indices, the standard index and a glossary. With
Dave Love <fx@gnu.org>
parents:
diff changeset
1858 the help of special LaTeX packages (@file{multind.sty} or
Dave Love <fx@gnu.org>
parents:
diff changeset
1859 @file{index.sty}), any number of indices can be supported.
Dave Love <fx@gnu.org>
parents:
diff changeset
1860
Dave Love <fx@gnu.org>
parents:
diff changeset
1861 Index entries are created with the @code{\index@{@var{entry}@}} macro.
Dave Love <fx@gnu.org>
parents:
diff changeset
1862 All entries defined in a document are written out to the @file{.aux}
Dave Love <fx@gnu.org>
parents:
diff changeset
1863 file. A separate tool must be used to convert this information into a
Dave Love <fx@gnu.org>
parents:
diff changeset
1864 nicely formatted index. Tools used with LaTeX include @code{MakeIndex}
Dave Love <fx@gnu.org>
parents:
diff changeset
1865 and @code{xindy}.@refill
Dave Love <fx@gnu.org>
parents:
diff changeset
1866
26911
d7f536a01276 Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents: 25829
diff changeset
1867 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
1868 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
1869 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
1870
d7f536a01276 Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents: 25829
diff changeset
1871 @enumerate
d7f536a01276 Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents: 25829
diff changeset
1872 @item
d7f536a01276 Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents: 25829
diff changeset
1873 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
1874 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
1875 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
1876 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
1877 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
1878 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
1879 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
1880 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
1881 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
1882 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
1883 @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
1884
d7f536a01276 Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents: 25829
diff changeset
1885 @item
d7f536a01276 Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents: 25829
diff changeset
1886 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
1887 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
1888 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
1889 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
1890 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
1891 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
1892 @end enumerate
d7f536a01276 Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents: 25829
diff changeset
1893
d7f536a01276 Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents: 25829
diff changeset
1894 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
1895 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
1896 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
1897 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
1898 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
1899 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
1900 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
1901 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
1902 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
1903 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
1904
d7f536a01276 Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents: 25829
diff changeset
1905 @lisp
d7f536a01276 Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents: 25829
diff changeset
1906 (setq reftex-index-macros '(multind)) @r{or}
d7f536a01276 Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents: 25829
diff changeset
1907 (setq reftex-index-macros '(index))
d7f536a01276 Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents: 25829
diff changeset
1908 @end lisp
25829
Dave Love <fx@gnu.org>
parents:
diff changeset
1909
Dave Love <fx@gnu.org>
parents:
diff changeset
1910 @menu
26911
d7f536a01276 Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents: 25829
diff changeset
1911 * Creating Index Entries:: Macros and completion of entries.
d7f536a01276 Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents: 25829
diff changeset
1912 * 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
1913 * Displaying and Editing the Index:: The index editor.
25829
Dave Love <fx@gnu.org>
parents:
diff changeset
1914 * Builtin Index Macros:: The index macros RefTeX knows about.
Dave Love <fx@gnu.org>
parents:
diff changeset
1915 * Defining Index Macros:: ... and macros it doesn't.
Dave Love <fx@gnu.org>
parents:
diff changeset
1916 @end menu
Dave Love <fx@gnu.org>
parents:
diff changeset
1917
26911
d7f536a01276 Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents: 25829
diff changeset
1918 @node Creating Index Entries, The Index Phrases File, , Index Support
25829
Dave Love <fx@gnu.org>
parents:
diff changeset
1919 @section Creating Index Entries
Dave Love <fx@gnu.org>
parents:
diff changeset
1920 @cindex Creating index entries
Dave Love <fx@gnu.org>
parents:
diff changeset
1921 @cindex Index entries, creating
Dave Love <fx@gnu.org>
parents:
diff changeset
1922 @kindex C-c <
Dave Love <fx@gnu.org>
parents:
diff changeset
1923 @findex reftex-index
Dave Love <fx@gnu.org>
parents:
diff changeset
1924 @kindex C-c /
Dave Love <fx@gnu.org>
parents:
diff changeset
1925 @findex reftex-index-selection-or-word
Dave Love <fx@gnu.org>
parents:
diff changeset
1926
Dave Love <fx@gnu.org>
parents:
diff changeset
1927 In order to index the current selection or the word at the cursor press
Dave Love <fx@gnu.org>
parents:
diff changeset
1928 @kbd{C-c /} (@code{reftex-index-selection-or-word}). This causes the
Dave Love <fx@gnu.org>
parents:
diff changeset
1929 selection or word @samp{@var{word}} to be replaced with
Dave Love <fx@gnu.org>
parents:
diff changeset
1930 @samp{\index@{@var{word}@}@var{word}}. The macro which is used
Dave Love <fx@gnu.org>
parents:
diff changeset
1931 (@code{\index} by default) can be configured with the variable
Dave Love <fx@gnu.org>
parents:
diff changeset
1932 @code{reftex-index-default-macro}. When the command is called with a
Dave Love <fx@gnu.org>
parents:
diff changeset
1933 prefix argument (@kbd{C-u C-c /}), you get a chance to edit the
Dave Love <fx@gnu.org>
parents:
diff changeset
1934 generated index entry. Use this to change the case of the word or to
Dave Love <fx@gnu.org>
parents:
diff changeset
1935 make the entry a subentry, for example by entering
Dave Love <fx@gnu.org>
parents:
diff changeset
1936 @samp{main!sub!@var{word}}. When called with two raw @kbd{C-u} prefixes
Dave Love <fx@gnu.org>
parents:
diff changeset
1937 (@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
1938 When there is nothing selected and no word at point, this command will
Dave Love <fx@gnu.org>
parents:
diff changeset
1939 just call @code{reftex-index}, described below.
Dave Love <fx@gnu.org>
parents:
diff changeset
1940
Dave Love <fx@gnu.org>
parents:
diff changeset
1941 In order to create a general index entry, press @kbd{C-c <}
Dave Love <fx@gnu.org>
parents:
diff changeset
1942 (@code{reftex-index}). @b{Ref@TeX{}} will prompt for one of the
Dave Love <fx@gnu.org>
parents:
diff changeset
1943 available index macros and for its arguments. Completion will be
Dave Love <fx@gnu.org>
parents:
diff changeset
1944 available for the index entry and, if applicable, the index tag. The
Dave Love <fx@gnu.org>
parents:
diff changeset
1945 index tag is a string identifying one of multiple indices. With the
Dave Love <fx@gnu.org>
parents:
diff changeset
1946 @file{multind} and @file{index} packages, this tag is the first argument
Dave Love <fx@gnu.org>
parents:
diff changeset
1947 to the redefined @code{\index} macro.@refill
Dave Love <fx@gnu.org>
parents:
diff changeset
1948
26911
d7f536a01276 Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents: 25829
diff changeset
1949 @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
1950 @section The Index Phrases File
d7f536a01276 Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents: 25829
diff changeset
1951 @cindex Index phrase file
d7f536a01276 Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents: 25829
diff changeset
1952 @cindex Phrase file
d7f536a01276 Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents: 25829
diff changeset
1953 @kindex C-c |
d7f536a01276 Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents: 25829
diff changeset
1954 @findex reftex-index-visit-phrases-buffer
d7f536a01276 Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents: 25829
diff changeset
1955 @cindex Macro definition lines, in phrase buffer
d7f536a01276 Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents: 25829
diff changeset
1956
d7f536a01276 Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents: 25829
diff changeset
1957 @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
1958 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
1959 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
1960 @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
1961 |} (@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
1962 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
1963 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
1964 @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
1965 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
1966 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
1967 a phrase file header example:@refill
d7f536a01276 Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents: 25829
diff changeset
1968
d7f536a01276 Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents: 25829
diff changeset
1969 @example
d7f536a01276 Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents: 25829
diff changeset
1970 % -*- mode: reftex-index-phrases -*-
d7f536a01276 Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents: 25829
diff changeset
1971 % Key Macro Format Repeat
d7f536a01276 Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents: 25829
diff changeset
1972 %----------------------------------------------------------
d7f536a01276 Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents: 25829
diff changeset
1973 >>>INDEX_MACRO_DEFINITION: i \index@{%s@} t
d7f536a01276 Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents: 25829
diff changeset
1974 >>>INDEX_MACRO_DEFINITION: I \index*@{%s@} nil
d7f536a01276 Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents: 25829
diff changeset
1975 >>>INDEX_MACRO_DEFINITION: g \glossary@{%s@} t
d7f536a01276 Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents: 25829
diff changeset
1976 >>>INDEX_MACRO_DEFINITION: n \index*[name]@{%s@} nil
d7f536a01276 Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents: 25829
diff changeset
1977 %----------------------------------------------------------
d7f536a01276 Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents: 25829
diff changeset
1978 @end example
d7f536a01276 Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents: 25829
diff changeset
1979
d7f536a01276 Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents: 25829
diff changeset
1980 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
1981 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
1982 @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
1983 @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
1984 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
1985 @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
1986 @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
1987 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
1988 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
1989 repeat @var{word} outside the macro.@refill
d7f536a01276 Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents: 25829
diff changeset
1990
d7f536a01276 Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents: 25829
diff changeset
1991 @menu
d7f536a01276 Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents: 25829
diff changeset
1992 * Collecting Phrases:: Collecting from document or external.
d7f536a01276 Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents: 25829
diff changeset
1993 * Consistency Checks:: Check for duplicates etc.
d7f536a01276 Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents: 25829
diff changeset
1994 * Global Indexing:: The interactive indexing process.
d7f536a01276 Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents: 25829
diff changeset
1995 @end menu
d7f536a01276 Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents: 25829
diff changeset
1996
d7f536a01276 Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents: 25829
diff changeset
1997 @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
1998 @subsection Collecting Phrases
d7f536a01276 Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents: 25829
diff changeset
1999 @cindex Collecting index phrases
d7f536a01276 Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents: 25829
diff changeset
2000 @cindex Index phrases, collection
d7f536a01276 Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents: 25829
diff changeset
2001 @cindex Phrases, collecting
d7f536a01276 Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents: 25829
diff changeset
2002
d7f536a01276 Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents: 25829
diff changeset
2003 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
2004 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
2005 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
2006 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
2007 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
2008 (@code{reftex-index-phrases-save-and-return}).
d7f536a01276 Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents: 25829
diff changeset
2009
d7f536a01276 Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents: 25829
diff changeset
2010 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
2011 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
2012 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
2013 indexed.
d7f536a01276 Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents: 25829
diff changeset
2014
d7f536a01276 Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents: 25829
diff changeset
2015 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
2016 @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
2017 format. A phrase line looks like this:
d7f536a01276 Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents: 25829
diff changeset
2018
d7f536a01276 Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents: 25829
diff changeset
2019 @example
d7f536a01276 Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents: 25829
diff changeset
2020 [@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
2021 @end example
d7f536a01276 Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents: 25829
diff changeset
2022
d7f536a01276 Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents: 25829
diff changeset
2023 @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
2024 @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
2025 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
2026 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
2027 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
2028 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
2029 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
2030 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
2031 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
2032 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
2033 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
2034 }@footnote{@samp{&&} with optional spaces, see
d7f536a01276 Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents: 25829
diff changeset
2035 @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
2036 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
2037 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
2038 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
2039 example:@refill
d7f536a01276 Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents: 25829
diff changeset
2040
d7f536a01276 Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents: 25829
diff changeset
2041 @example
d7f536a01276 Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents: 25829
diff changeset
2042 %--------------------------------------------------------------------
d7f536a01276 Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents: 25829
diff changeset
2043 I Sun
d7f536a01276 Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents: 25829
diff changeset
2044 i Planet Planets
d7f536a01276 Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents: 25829
diff changeset
2045 i Vega Stars!Vega
d7f536a01276 Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents: 25829
diff changeset
2046 Jupiter Planets!Jupiter
d7f536a01276 Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents: 25829
diff changeset
2047 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
2048 i Pluto Planets!Pluto && Kuiper Belt Objects!Pluto
d7f536a01276 Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents: 25829
diff changeset
2049 @end example
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
d7f536a01276 Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents: 25829
diff changeset
2052 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
2053 @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
2054 @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
2055 @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
2056 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
2057 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
2058 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
2059 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
2060 @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
2061 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
2062
d7f536a01276 Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents: 25829
diff changeset
2063 @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
2064 @subsection Consistency Checks
d7f536a01276 Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents: 25829
diff changeset
2065 @cindex Index phrases, consistency checks
d7f536a01276 Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents: 25829
diff changeset
2066 @cindex Phrases, consistency checks
d7f536a01276 Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents: 25829
diff changeset
2067 @cindex Consistency check for index phrases
d7f536a01276 Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents: 25829
diff changeset
2068
d7f536a01276 Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents: 25829
diff changeset
2069 @kindex C-c C-s
d7f536a01276 Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents: 25829
diff changeset
2070 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
2071 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
2072 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
2073 (@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
2074 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
2075 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
2076 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
2077 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
2078
d7f536a01276 Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents: 25829
diff changeset
2079 @kindex C-c C-i
d7f536a01276 Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents: 25829
diff changeset
2080 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
2081 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
2082 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
2083 in the document.@refill
d7f536a01276 Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents: 25829
diff changeset
2084
d7f536a01276 Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents: 25829
diff changeset
2085 @kindex C-c C-t
d7f536a01276 Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents: 25829
diff changeset
2086 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
2087 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
2088 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
2089 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
2090 @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
2091 (@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
2092 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
2093 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
2094 execute this command repeatedly.@refill
d7f536a01276 Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents: 25829
diff changeset
2095
d7f536a01276 Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents: 25829
diff changeset
2096 @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
2097 @subsection Global Indexing
d7f536a01276 Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents: 25829
diff changeset
2098 @cindex Global indexing
d7f536a01276 Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents: 25829
diff changeset
2099 @cindex Indexing, global
d7f536a01276 Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents: 25829
diff changeset
2100 @cindex Indexing, from @file{phrases} buffer
d7f536a01276 Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents: 25829
diff changeset
2101
d7f536a01276 Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents: 25829
diff changeset
2102 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
2103 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
2104 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
2105 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
2106 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
2107 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
2108 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
2109 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
2110
d7f536a01276 Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents: 25829
diff changeset
2111 @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
2112 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
2113 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
2114 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
2115 @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
2116
d7f536a01276 Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents: 25829
diff changeset
2117 @table @kbd
d7f536a01276 Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents: 25829
diff changeset
2118 @item y
d7f536a01276 Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents: 25829
diff changeset
2119 Replace this match with the proposed string.
d7f536a01276 Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents: 25829
diff changeset
2120 @item n
d7f536a01276 Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents: 25829
diff changeset
2121 Skip this match.
d7f536a01276 Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents: 25829
diff changeset
2122 @item !
d7f536a01276 Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents: 25829
diff changeset
2123 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
2124 @item q
d7f536a01276 Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents: 25829
diff changeset
2125 Skip this match, start with next file.
d7f536a01276 Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents: 25829
diff changeset
2126 @item Q
d7f536a01276 Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents: 25829
diff changeset
2127 Skip this match, start with next phrase.
d7f536a01276 Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents: 25829
diff changeset
2128 @item o
d7f536a01276 Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents: 25829
diff changeset
2129 Select a different indexing macro for this match.
d7f536a01276 Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents: 25829
diff changeset
2130 @item 1-9
d7f536a01276 Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents: 25829
diff changeset
2131 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
2132 @item e
d7f536a01276 Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents: 25829
diff changeset
2133 Edit the replacement text.
d7f536a01276 Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents: 25829
diff changeset
2134 @item C-r
40705
421e0a91a1d1 Replace M-C- with C-M-
Eli Zaretskii <eliz@gnu.org>
parents: 39267
diff changeset
2135 Recursive edit. Use @kbd{C-M-c} to return to the indexing process.
26911
d7f536a01276 Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents: 25829
diff changeset
2136 @item s
d7f536a01276 Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents: 25829
diff changeset
2137 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
2138 @item S
d7f536a01276 Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents: 25829
diff changeset
2139 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
2140 @item C-g
d7f536a01276 Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents: 25829
diff changeset
2141 Abort the indexing process.
d7f536a01276 Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents: 25829
diff changeset
2142 @end table
d7f536a01276 Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents: 25829
diff changeset
2143
d7f536a01276 Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents: 25829
diff changeset
2144 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
2145 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
2146 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
2147 (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
2148
d7f536a01276 Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents: 25829
diff changeset
2149 @table @i
d7f536a01276 Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents: 25829
diff changeset
2150 @item Match Whole Words
d7f536a01276 Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents: 25829
diff changeset
2151 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
2152 This should probably always be on.
d7f536a01276 Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents: 25829
diff changeset
2153 @item Case Sensitive Search
d7f536a01276 Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents: 25829
diff changeset
2154 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
2155 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
2156 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
2157 do not like.
d7f536a01276 Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents: 25829
diff changeset
2158 @item Wrap Long Lines
d7f536a01276 Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents: 25829
diff changeset
2159 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
2160 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
2161 @item Skip Indexed Matches
d7f536a01276 Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents: 25829
diff changeset
2162 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
2163 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
2164 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
2165 (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
2166 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
2167 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
2168 @end table
d7f536a01276 Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents: 25829
diff changeset
2169
d7f536a01276 Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents: 25829
diff changeset
2170 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
2171 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
2172 to the changed regions. The command
d7f536a01276 Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents: 25829
diff changeset
2173 @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
2174 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
2175 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
2176
d7f536a01276 Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents: 25829
diff changeset
2177 @node Displaying and Editing the Index, Builtin Index Macros, The Index Phrases File, Index Support
25829
Dave Love <fx@gnu.org>
parents:
diff changeset
2178 @section Displaying and Editing the Index
Dave Love <fx@gnu.org>
parents:
diff changeset
2179 @cindex Displaying the Index
Dave Love <fx@gnu.org>
parents:
diff changeset
2180 @cindex Editing the Index
Dave Love <fx@gnu.org>
parents:
diff changeset
2181 @cindex Index entries, creating
Dave Love <fx@gnu.org>
parents:
diff changeset
2182 @cindex Index, displaying
Dave Love <fx@gnu.org>
parents:
diff changeset
2183 @cindex Index, editing
Dave Love <fx@gnu.org>
parents:
diff changeset
2184 @kindex C-c >
Dave Love <fx@gnu.org>
parents:
diff changeset
2185 @findex reftex-display-index
Dave Love <fx@gnu.org>
parents:
diff changeset
2186
Dave Love <fx@gnu.org>
parents:
diff changeset
2187 In order to compile and display the index, press @kbd{C-c >}. If the
Dave Love <fx@gnu.org>
parents:
diff changeset
2188 document uses multiple indices, @b{Ref@TeX{}} will ask you to select
Dave Love <fx@gnu.org>
parents:
diff changeset
2189 one. Then, all index entries will be sorted alphabetically and
Dave Love <fx@gnu.org>
parents:
diff changeset
2190 displayed in a special buffer, the @file{*Index*} buffer. From that
Dave Love <fx@gnu.org>
parents:
diff changeset
2191 buffer you can check and edit each entry.@refill
Dave Love <fx@gnu.org>
parents:
diff changeset
2192
Dave Love <fx@gnu.org>
parents:
diff changeset
2193 The index can be restricted to the current section or the region. Then
Dave Love <fx@gnu.org>
parents:
diff changeset
2194 only entries in that part of the document will go into the compiled
Dave Love <fx@gnu.org>
parents:
diff changeset
2195 index. To restrict to the current section, use a numeric prefix
Dave Love <fx@gnu.org>
parents:
diff changeset
2196 @samp{2}, thus press @kbd{C-u 2 C-c >}. To restrict to the current
Dave Love <fx@gnu.org>
parents:
diff changeset
2197 region, make the region active and use a numeric prefix @samp{3} (press
Dave Love <fx@gnu.org>
parents:
diff changeset
2198 @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
2199 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
2200 @kbd{<} and @kbd{>} keys.@refill
25829
Dave Love <fx@gnu.org>
parents:
diff changeset
2201
Dave Love <fx@gnu.org>
parents:
diff changeset
2202 One caveat: @b{Ref@TeX{}} finds the definition point of an index entry
Dave Love <fx@gnu.org>
parents:
diff changeset
2203 by searching near the buffer position where it had found to macro during
Dave Love <fx@gnu.org>
parents:
diff changeset
2204 scanning. If you have several identical index entries in the same
Dave Love <fx@gnu.org>
parents:
diff changeset
2205 buffer and significant changes have shifted the entries around, you must
Dave Love <fx@gnu.org>
parents:
diff changeset
2206 rescan the buffer to ensure the correspondence between the
Dave Love <fx@gnu.org>
parents:
diff changeset
2207 @file{*Index*} buffer and the definition locations. It is therefore
Dave Love <fx@gnu.org>
parents:
diff changeset
2208 advisable to rescan the document (with @kbd{r} or @kbd{C-u r})
Dave Love <fx@gnu.org>
parents:
diff changeset
2209 frequently while editing the index from the @file{*Index*}
Dave Love <fx@gnu.org>
parents:
diff changeset
2210 buffer.@refill
Dave Love <fx@gnu.org>
parents:
diff changeset
2211
Dave Love <fx@gnu.org>
parents:
diff changeset
2212 @kindex ?
Dave Love <fx@gnu.org>
parents:
diff changeset
2213 Here is a list of special commands available in the @file{*Index*} buffer. A
Dave Love <fx@gnu.org>
parents:
diff changeset
2214 summary of this information is always available by pressing
Dave Love <fx@gnu.org>
parents:
diff changeset
2215 @kbd{?}.@refill
Dave Love <fx@gnu.org>
parents:
diff changeset
2216
Dave Love <fx@gnu.org>
parents:
diff changeset
2217 @table @kbd
Dave Love <fx@gnu.org>
parents:
diff changeset
2218 @tablesubheading{General}
Dave Love <fx@gnu.org>
parents:
diff changeset
2219 @item ?
Dave Love <fx@gnu.org>
parents:
diff changeset
2220 Display a summary of commands.
Dave Love <fx@gnu.org>
parents:
diff changeset
2221
Dave Love <fx@gnu.org>
parents:
diff changeset
2222 @item 0-9, -
Dave Love <fx@gnu.org>
parents:
diff changeset
2223 Prefix argument.
Dave Love <fx@gnu.org>
parents:
diff changeset
2224
Dave Love <fx@gnu.org>
parents:
diff changeset
2225 @tablesubheading{Moving around}
Dave Love <fx@gnu.org>
parents:
diff changeset
2226 @item ! A..Z
Dave Love <fx@gnu.org>
parents:
diff changeset
2227 Pressing any capital letter will jump to the corresponding section in
Dave Love <fx@gnu.org>
parents:
diff changeset
2228 the @file{*Index*} buffer. The exclamation mark is special and jumps to
Dave Love <fx@gnu.org>
parents:
diff changeset
2229 the first entries alphabetically sorted below @samp{A}. These are
Dave Love <fx@gnu.org>
parents:
diff changeset
2230 usually non-alphanumeric characters.@refill
Dave Love <fx@gnu.org>
parents:
diff changeset
2231 @item n
Dave Love <fx@gnu.org>
parents:
diff changeset
2232 Go to next entry.@refill
Dave Love <fx@gnu.org>
parents:
diff changeset
2233 @item p
Dave Love <fx@gnu.org>
parents:
diff changeset
2234 Go to previous entry.@refill
Dave Love <fx@gnu.org>
parents:
diff changeset
2235
Dave Love <fx@gnu.org>
parents:
diff changeset
2236 @tablesubheading{Access to document locations}
Dave Love <fx@gnu.org>
parents:
diff changeset
2237 @item @key{SPC}
Dave Love <fx@gnu.org>
parents:
diff changeset
2238 Show the place in the document where this index entry is defined.@refill
Dave Love <fx@gnu.org>
parents:
diff changeset
2239
Dave Love <fx@gnu.org>
parents:
diff changeset
2240 @item @key{TAB}
Dave Love <fx@gnu.org>
parents:
diff changeset
2241 Go to the definition of the current index entry in another
Dave Love <fx@gnu.org>
parents:
diff changeset
2242 window.@refill
Dave Love <fx@gnu.org>
parents:
diff changeset
2243
Dave Love <fx@gnu.org>
parents:
diff changeset
2244 @item @key{RET}
Dave Love <fx@gnu.org>
parents:
diff changeset
2245 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
2246 @file{*Index*} buffer window.@refill
25829
Dave Love <fx@gnu.org>
parents:
diff changeset
2247
Dave Love <fx@gnu.org>
parents:
diff changeset
2248 @item f
Dave Love <fx@gnu.org>
parents:
diff changeset
2249 @vindex reftex-index-follow-mode
Dave Love <fx@gnu.org>
parents:
diff changeset
2250 @vindex reftex-revisit-to-follow
Dave Love <fx@gnu.org>
parents:
diff changeset
2251 Toggle follow mode. When follow mode is active, the other window will
Dave Love <fx@gnu.org>
parents:
diff changeset
2252 always show the location corresponding to the line in the @file{*Index*}
Dave Love <fx@gnu.org>
parents:
diff changeset
2253 buffer at point. This is similar to pressing @key{SPC} after each
Dave Love <fx@gnu.org>
parents:
diff changeset
2254 cursor motion. The default for this flag can be set with the variable
Dave Love <fx@gnu.org>
parents:
diff changeset
2255 @code{reftex-index-follow-mode}. Note that only context in files
Dave Love <fx@gnu.org>
parents:
diff changeset
2256 already visited is shown. @b{Ref@TeX{}} will not visit a file just for
Dave Love <fx@gnu.org>
parents:
diff changeset
2257 follow mode. See, however, the variable
Dave Love <fx@gnu.org>
parents:
diff changeset
2258 @code{reftex-revisit-to-follow}.@refill
Dave Love <fx@gnu.org>
parents:
diff changeset
2259
Dave Love <fx@gnu.org>
parents:
diff changeset
2260 @tablesubheading{Entry editing}
Dave Love <fx@gnu.org>
parents:
diff changeset
2261 @item e
Dave Love <fx@gnu.org>
parents:
diff changeset
2262 Edit the current index entry. In the minibuffer, you can edit the
Dave Love <fx@gnu.org>
parents:
diff changeset
2263 index macro which defines this entry.@refill
Dave Love <fx@gnu.org>
parents:
diff changeset
2264
Dave Love <fx@gnu.org>
parents:
diff changeset
2265 @item C-k
Dave Love <fx@gnu.org>
parents:
diff changeset
2266 Kill the index entry. Currently not implemented because I don't know
Dave Love <fx@gnu.org>
parents:
diff changeset
2267 how to implement an @code{undo} function for this.@refill
Dave Love <fx@gnu.org>
parents:
diff changeset
2268
Dave Love <fx@gnu.org>
parents:
diff changeset
2269 @item *
Dave Love <fx@gnu.org>
parents:
diff changeset
2270 Edit the @var{key} part of the entry. This is the initial part of the
Dave Love <fx@gnu.org>
parents:
diff changeset
2271 entry which determines the location of the entry in the index.@refill
Dave Love <fx@gnu.org>
parents:
diff changeset
2272
Dave Love <fx@gnu.org>
parents:
diff changeset
2273 @item |
Dave Love <fx@gnu.org>
parents:
diff changeset
2274 Edit the @var{attribute} part of the entry. This is the part after the
Dave Love <fx@gnu.org>
parents:
diff changeset
2275 vertical bar. With @code{MakeIndex}, this part is an encapsulating
Dave Love <fx@gnu.org>
parents:
diff changeset
2276 macro. With @code{xindy}, it is called @emph{attribute} and is a
Dave Love <fx@gnu.org>
parents:
diff changeset
2277 property of the index entry that can lead to special formatting. When
Dave Love <fx@gnu.org>
parents:
diff changeset
2278 called with @kbd{C-u} prefix, kill the entire @var{attribute}
Dave Love <fx@gnu.org>
parents:
diff changeset
2279 part.@refill
Dave Love <fx@gnu.org>
parents:
diff changeset
2280
Dave Love <fx@gnu.org>
parents:
diff changeset
2281 @item @@
Dave Love <fx@gnu.org>
parents:
diff changeset
2282 Edit the @var{visual} part of the entry. This is the part after the
Dave Love <fx@gnu.org>
parents:
diff changeset
2283 @samp{@@} which is used by @code{MakeIndex} to change the visual
Dave Love <fx@gnu.org>
parents:
diff changeset
2284 appearance of the entry in the index. When called with @kbd{C-u}
Dave Love <fx@gnu.org>
parents:
diff changeset
2285 prefix, kill the entire @var{visual} part.@refill
Dave Love <fx@gnu.org>
parents:
diff changeset
2286
Dave Love <fx@gnu.org>
parents:
diff changeset
2287 @item (
Dave Love <fx@gnu.org>
parents:
diff changeset
2288 Toggle the beginning of page range property @samp{|(} of the
Dave Love <fx@gnu.org>
parents:
diff changeset
2289 entry.@refill
Dave Love <fx@gnu.org>
parents:
diff changeset
2290
Dave Love <fx@gnu.org>
parents:
diff changeset
2291 @item )
Dave Love <fx@gnu.org>
parents:
diff changeset
2292 Toggle the end of page range property @samp{|)} of the entry.@refill
Dave Love <fx@gnu.org>
parents:
diff changeset
2293
Dave Love <fx@gnu.org>
parents:
diff changeset
2294 @item _
Dave Love <fx@gnu.org>
parents:
diff changeset
2295 Make the current entry a subentry. This command will prompt for the
Dave Love <fx@gnu.org>
parents:
diff changeset
2296 superordinate entry and insert it.@refill
Dave Love <fx@gnu.org>
parents:
diff changeset
2297
Dave Love <fx@gnu.org>
parents:
diff changeset
2298 @item ^
Dave Love <fx@gnu.org>
parents:
diff changeset
2299 Remove the highest superordinate entry. If the current entry is a
Dave Love <fx@gnu.org>
parents:
diff changeset
2300 subitem (@samp{aaa!bbb!ccc}), this function moves it up the hierarchy
Dave Love <fx@gnu.org>
parents:
diff changeset
2301 (@samp{bbb!ccc}).@refill
Dave Love <fx@gnu.org>
parents:
diff changeset
2302
Dave Love <fx@gnu.org>
parents:
diff changeset
2303 @tablesubheading{Exiting}
Dave Love <fx@gnu.org>
parents:
diff changeset
2304 @item q
Dave Love <fx@gnu.org>
parents:
diff changeset
2305 Hide the @file{*Index*} buffer.@refill
Dave Love <fx@gnu.org>
parents:
diff changeset
2306
Dave Love <fx@gnu.org>
parents:
diff changeset
2307 @item k
Dave Love <fx@gnu.org>
parents:
diff changeset
2308 Kill the @file{*Index*} buffer.@refill
Dave Love <fx@gnu.org>
parents:
diff changeset
2309
Dave Love <fx@gnu.org>
parents:
diff changeset
2310 @item C-c =
Dave Love <fx@gnu.org>
parents:
diff changeset
2311 Switch to the Table of Contents buffer of this document.@refill
Dave Love <fx@gnu.org>
parents:
diff changeset
2312
Dave Love <fx@gnu.org>
parents:
diff changeset
2313 @tablesubheading{Controlling what gets displayed}
Dave Love <fx@gnu.org>
parents:
diff changeset
2314 @item c
Dave Love <fx@gnu.org>
parents:
diff changeset
2315 @vindex reftex-index-include-context
Dave Love <fx@gnu.org>
parents:
diff changeset
2316 Toggle the display of short context in the @file{*Index*} buffer. The
Dave Love <fx@gnu.org>
parents:
diff changeset
2317 default for this flag can be set with the variable
Dave Love <fx@gnu.org>
parents:
diff changeset
2318 @code{reftex-index-include-context}.@refill
Dave Love <fx@gnu.org>
parents:
diff changeset
2319
Dave Love <fx@gnu.org>
parents:
diff changeset
2320 @item @}
Dave Love <fx@gnu.org>
parents:
diff changeset
2321 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
2322 section number will be displayed in the @code{R<>} indicator in the
25829
Dave Love <fx@gnu.org>
parents:
diff changeset
2323 mode line and in the header of the @file{*Index*} buffer.@refill
Dave Love <fx@gnu.org>
parents:
diff changeset
2324
Dave Love <fx@gnu.org>
parents:
diff changeset
2325 @item @{
Dave Love <fx@gnu.org>
parents:
diff changeset
2326 Widen the index to contain all entries of the document.@refill
Dave Love <fx@gnu.org>
parents:
diff changeset
2327
Dave Love <fx@gnu.org>
parents:
diff changeset
2328 @item <
Dave Love <fx@gnu.org>
parents:
diff changeset
2329 When the index is currently restricted, move the restriction to the
Dave Love <fx@gnu.org>
parents:
diff changeset
2330 previous section.@refill
Dave Love <fx@gnu.org>
parents:
diff changeset
2331
Dave Love <fx@gnu.org>
parents:
diff changeset
2332 @item >
Dave Love <fx@gnu.org>
parents:
diff changeset
2333 When the index is currently restricted, move the restriction to the
Dave Love <fx@gnu.org>
parents:
diff changeset
2334 next section.@refill
Dave Love <fx@gnu.org>
parents:
diff changeset
2335
Dave Love <fx@gnu.org>
parents:
diff changeset
2336 @tablesubheading{Updating the buffer}
Dave Love <fx@gnu.org>
parents:
diff changeset
2337 @item g
Dave Love <fx@gnu.org>
parents:
diff changeset
2338 Rebuild the @file{*Index*} buffer. This does @emph{not} rescan the
Dave Love <fx@gnu.org>
parents:
diff changeset
2339 document. However, it sorts the entries again, so that edited entries
Dave Love <fx@gnu.org>
parents:
diff changeset
2340 will move to the correct position.@refill
Dave Love <fx@gnu.org>
parents:
diff changeset
2341
Dave Love <fx@gnu.org>
parents:
diff changeset
2342 @item r
Dave Love <fx@gnu.org>
parents:
diff changeset
2343 @vindex reftex-enable-partial-scans
Dave Love <fx@gnu.org>
parents:
diff changeset
2344 Reparse the LaTeX document and rebuild the @file{*Index*} buffer. When
Dave Love <fx@gnu.org>
parents:
diff changeset
2345 @code{reftex-enable-partial-scans} is non-nil, rescan only the file this
Dave Love <fx@gnu.org>
parents:
diff changeset
2346 location is defined in, not the entire document.@refill
Dave Love <fx@gnu.org>
parents:
diff changeset
2347
Dave Love <fx@gnu.org>
parents:
diff changeset
2348 @item C-u r
Dave Love <fx@gnu.org>
parents:
diff changeset
2349 Reparse the @emph{entire} LaTeX document and rebuild the @file{*Index*}
Dave Love <fx@gnu.org>
parents:
diff changeset
2350 buffer.@refill
Dave Love <fx@gnu.org>
parents:
diff changeset
2351
Dave Love <fx@gnu.org>
parents:
diff changeset
2352 @item s
Dave Love <fx@gnu.org>
parents:
diff changeset
2353 Switch to a different index (for documents with multiple
Dave Love <fx@gnu.org>
parents:
diff changeset
2354 indices).@refill
Dave Love <fx@gnu.org>
parents:
diff changeset
2355 @end table
Dave Love <fx@gnu.org>
parents:
diff changeset
2356
Dave Love <fx@gnu.org>
parents:
diff changeset
2357
Dave Love <fx@gnu.org>
parents:
diff changeset
2358 @node Builtin Index Macros, Defining Index Macros, Displaying and Editing the Index, Index Support
Dave Love <fx@gnu.org>
parents:
diff changeset
2359 @section Builtin Index Macros
Dave Love <fx@gnu.org>
parents:
diff changeset
2360 @cindex Builtin index macros
Dave Love <fx@gnu.org>
parents:
diff changeset
2361 @cindex Index macros, builtin
Dave Love <fx@gnu.org>
parents:
diff changeset
2362 @vindex reftex-index-macros
Dave Love <fx@gnu.org>
parents:
diff changeset
2363 @cindex @code{multind}, LaTeX package
Dave Love <fx@gnu.org>
parents:
diff changeset
2364 @cindex @code{index}, LaTeX package
Dave Love <fx@gnu.org>
parents:
diff changeset
2365 @cindex LaTeX packages, @code{multind}
Dave Love <fx@gnu.org>
parents:
diff changeset
2366 @cindex LaTeX packages, @code{index}
Dave Love <fx@gnu.org>
parents:
diff changeset
2367
Dave Love <fx@gnu.org>
parents:
diff changeset
2368 @b{Ref@TeX{}} by default recognizes the @code{\index} and
Dave Love <fx@gnu.org>
parents:
diff changeset
2369 @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
2370 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
2371 in the @file{multind} and @file{index} packages. However, since
25829
Dave Love <fx@gnu.org>
parents:
diff changeset
2372 the different definitions of the @code{\index} macro are incompatible,
Dave Love <fx@gnu.org>
parents:
diff changeset
2373 you will have to explicitly specify the index style used.
Dave Love <fx@gnu.org>
parents:
diff changeset
2374 @xref{Creating Index Entries}, for information on how to do that.
Dave Love <fx@gnu.org>
parents:
diff changeset
2375
Dave Love <fx@gnu.org>
parents:
diff changeset
2376 @node Defining Index Macros, , Builtin Index Macros, Index Support
Dave Love <fx@gnu.org>
parents:
diff changeset
2377 @section Defining Index Macros
Dave Love <fx@gnu.org>
parents:
diff changeset
2378 @cindex Defining Index Macros
Dave Love <fx@gnu.org>
parents:
diff changeset
2379 @cindex Index macros, defining
Dave Love <fx@gnu.org>
parents:
diff changeset
2380 @vindex reftex-index-macros
Dave Love <fx@gnu.org>
parents:
diff changeset
2381
Dave Love <fx@gnu.org>
parents:
diff changeset
2382 When writing a document with an index you will probably define
Dave Love <fx@gnu.org>
parents:
diff changeset
2383 additional macros which make entries into the index.
Dave Love <fx@gnu.org>
parents:
diff changeset
2384 Let's look at an example.
Dave Love <fx@gnu.org>
parents:
diff changeset
2385
Dave Love <fx@gnu.org>
parents:
diff changeset
2386 @example
Dave Love <fx@gnu.org>
parents:
diff changeset
2387 \newcommand@{\ix@}[1]@{#1\index@{#1@}@}
Dave Love <fx@gnu.org>
parents:
diff changeset
2388 \newcommand@{\nindex@}[1]@{\textit@{#1@}\index[name]@{#1@}@}
Dave Love <fx@gnu.org>
parents:
diff changeset
2389 \newcommand@{\astobj@}[1]@{\index@{Astronomical Objects!#1@}@}
Dave Love <fx@gnu.org>
parents:
diff changeset
2390 @end example
Dave Love <fx@gnu.org>
parents:
diff changeset
2391
Dave Love <fx@gnu.org>
parents:
diff changeset
2392 The first macro @code{\ix} typesets its argument in the text and places
Dave Love <fx@gnu.org>
parents:
diff changeset
2393 it into the index. The second macro @code{\nindex} typesets its
Dave Love <fx@gnu.org>
parents:
diff changeset
2394 argument in the text and places it into a separate index with the tag
Dave Love <fx@gnu.org>
parents:
diff changeset
2395 @samp{name}@footnote{We are using the syntax of the @file{index} package
Dave Love <fx@gnu.org>
parents:
diff changeset
2396 here.}. The last macro also places its argument into the index, but as
Dave Love <fx@gnu.org>
parents:
diff changeset
2397 subitems under the main index entry @samp{Astronomical Objects}. Here
Dave Love <fx@gnu.org>
parents:
diff changeset
2398 is how to make @b{Ref@TeX{}} recognize and correctly interpret these
Dave Love <fx@gnu.org>
parents:
diff changeset
2399 macros, first with Emacs Lisp.
Dave Love <fx@gnu.org>
parents:
diff changeset
2400
Dave Love <fx@gnu.org>
parents:
diff changeset
2401 @lisp
Dave Love <fx@gnu.org>
parents:
diff changeset
2402 (setq reftex-index-macros
26911
d7f536a01276 Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents: 25829
diff changeset
2403 '(("\\ix@{*@}" "idx" ?x "" nil nil)
d7f536a01276 Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents: 25829
diff changeset
2404 ("\\nindex@{*@}" "name" ?n "" nil nil)
d7f536a01276 Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents: 25829
diff changeset
2405 ("\\astobj@{*@}" "idx" ?o "Astronomical Objects!" nil t)))
25829
Dave Love <fx@gnu.org>
parents:
diff changeset
2406 @end lisp
Dave Love <fx@gnu.org>
parents:
diff changeset
2407
Dave Love <fx@gnu.org>
parents:
diff changeset
2408 Note that the index tag is @samp{idx} for the main index, and
Dave Love <fx@gnu.org>
parents:
diff changeset
2409 @samp{name} for the name index. @samp{idx} and @samp{glo} are reserved
Dave Love <fx@gnu.org>
parents:
diff changeset
2410 for the default index and for the glossary.
Dave Love <fx@gnu.org>
parents:
diff changeset
2411
Dave Love <fx@gnu.org>
parents:
diff changeset
2412 The character arguments @code{?x}, @code{?n}, and @code{?o} are for
Dave Love <fx@gnu.org>
parents:
diff changeset
2413 quick identification of these macros when @b{Ref@TeX{}} inserts new
Dave Love <fx@gnu.org>
parents:
diff changeset
2414 index entries with @code{reftex-index}. These codes need to be
Dave Love <fx@gnu.org>
parents:
diff changeset
2415 unique. @code{?i}, @code{?I}, and @code{?g} are reserved for the
Dave Love <fx@gnu.org>
parents:
diff changeset
2416 @code{\index}, @code{\index*}, and @code{\glossary} macros,
Dave Love <fx@gnu.org>
parents:
diff changeset
2417 respectively.
Dave Love <fx@gnu.org>
parents:
diff changeset
2418
Dave Love <fx@gnu.org>
parents:
diff changeset
2419 The following string is empty unless your macro adds a superordinate
Dave Love <fx@gnu.org>
parents:
diff changeset
2420 entry to the index key - this is the case for the @code{\astobj} macro.
Dave Love <fx@gnu.org>
parents:
diff changeset
2421
26911
d7f536a01276 Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents: 25829
diff changeset
2422 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
2423 almost always can be @code{nil}.
d7f536a01276 Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents: 25829
diff changeset
2424
d7f536a01276 Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents: 25829
diff changeset
2425 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
2426 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
2427 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
2428 (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
2429 @code{nil}.
d7f536a01276 Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents: 25829
diff changeset
2430
25829
Dave Love <fx@gnu.org>
parents:
diff changeset
2431 To do the same thing with customize, you need to fill in the templates
Dave Love <fx@gnu.org>
parents:
diff changeset
2432 like this:
Dave Love <fx@gnu.org>
parents:
diff changeset
2433
Dave Love <fx@gnu.org>
parents:
diff changeset
2434 @example
Dave Love <fx@gnu.org>
parents:
diff changeset
2435 Repeat:
Dave Love <fx@gnu.org>
parents:
diff changeset
2436 [INS] [DEL] List:
Dave Love <fx@gnu.org>
parents:
diff changeset
2437 Macro with args: \ix@{*@}
Dave Love <fx@gnu.org>
parents:
diff changeset
2438 Index Tag : [Value Menu] String: idx
Dave Love <fx@gnu.org>
parents:
diff changeset
2439 Access Key : x
Dave Love <fx@gnu.org>
parents:
diff changeset
2440 Key Prefix :
Dave Love <fx@gnu.org>
parents:
diff changeset
2441 Exclusion hook : nil
26911
d7f536a01276 Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents: 25829
diff changeset
2442 Repeat Outside : [Toggle] off (nil)
25829
Dave Love <fx@gnu.org>
parents:
diff changeset
2443 [INS] [DEL] List:
Dave Love <fx@gnu.org>
parents:
diff changeset
2444 Macro with args: \nindex@{*@}
Dave Love <fx@gnu.org>
parents:
diff changeset
2445 Index Tag : [Value Menu] String: name
Dave Love <fx@gnu.org>
parents:
diff changeset
2446 Access Key : n
Dave Love <fx@gnu.org>
parents:
diff changeset
2447 Key Prefix :
Dave Love <fx@gnu.org>
parents:
diff changeset
2448 Exclusion hook : nil
26911
d7f536a01276 Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents: 25829
diff changeset
2449 Repeat Outside : [Toggle] off (nil)
25829
Dave Love <fx@gnu.org>
parents:
diff changeset
2450 [INS] [DEL] List:
Dave Love <fx@gnu.org>
parents:
diff changeset
2451 Macro with args: \astobj@{*@}
Dave Love <fx@gnu.org>
parents:
diff changeset
2452 Index Tag : [Value Menu] String: idx
Dave Love <fx@gnu.org>
parents:
diff changeset
2453 Access Key : o
Dave Love <fx@gnu.org>
parents:
diff changeset
2454 Key Prefix : Astronomical Objects!
Dave Love <fx@gnu.org>
parents:
diff changeset
2455 Exclusion hook : nil
26911
d7f536a01276 Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents: 25829
diff changeset
2456 Repeat Outside : [Toggle] on (non-nil)
25829
Dave Love <fx@gnu.org>
parents:
diff changeset
2457 [INS]
Dave Love <fx@gnu.org>
parents:
diff changeset
2458 @end example
Dave Love <fx@gnu.org>
parents:
diff changeset
2459
Dave Love <fx@gnu.org>
parents:
diff changeset
2460 With the macro @code{\ix} defined, you may want to change the default
Dave Love <fx@gnu.org>
parents:
diff changeset
2461 macro used for indexing a text phrase (@pxref{Creating Index Entries}).
Dave Love <fx@gnu.org>
parents:
diff changeset
2462 This would be done like this
Dave Love <fx@gnu.org>
parents:
diff changeset
2463
Dave Love <fx@gnu.org>
parents:
diff changeset
2464 @lisp
26911
d7f536a01276 Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents: 25829
diff changeset
2465 (setq reftex-index-default-macro '(?x "idx"))
25829
Dave Love <fx@gnu.org>
parents:
diff changeset
2466 @end lisp
Dave Love <fx@gnu.org>
parents:
diff changeset
2467
Dave Love <fx@gnu.org>
parents:
diff changeset
2468 which specifies that the macro identified with the character @code{?x} (the
Dave Love <fx@gnu.org>
parents:
diff changeset
2469 @code{\ix} macro) should be used for indexing phrases and words already
Dave Love <fx@gnu.org>
parents:
diff changeset
2470 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
2471 The index tag is "idx".@refill
25829
Dave Love <fx@gnu.org>
parents:
diff changeset
2472
Dave Love <fx@gnu.org>
parents:
diff changeset
2473 @node Viewing Cross-References, RefTeXs Menu, Index Support, Top
Dave Love <fx@gnu.org>
parents:
diff changeset
2474 @chapter Viewing Cross--References
Dave Love <fx@gnu.org>
parents:
diff changeset
2475 @findex reftex-view-crossref
Dave Love <fx@gnu.org>
parents:
diff changeset
2476 @findex reftex-mouse-view-crossref
Dave Love <fx@gnu.org>
parents:
diff changeset
2477 @kindex C-c &
37999
8e7df927fd92 Updated to version 4.16
Carsten Dominik <dominik@science.uva.nl>
parents: 37404
diff changeset
2478 @kindex S-mouse-2
25829
Dave Love <fx@gnu.org>
parents:
diff changeset
2479
Dave Love <fx@gnu.org>
parents:
diff changeset
2480 @b{Ref@TeX{}} can display cross--referencing information. This means,
Dave Love <fx@gnu.org>
parents:
diff changeset
2481 if two document locations are linked, @b{Ref@TeX{}} can display the
Dave Love <fx@gnu.org>
parents:
diff changeset
2482 matching location(s) in another window. The @code{\label} and @code{\ref}
Dave Love <fx@gnu.org>
parents:
diff changeset
2483 macros are one way of establishing such a link. Also, a @code{\cite}
Dave Love <fx@gnu.org>
parents:
diff changeset
2484 macro is linked to the corresponding @code{\bibitem} macro or a BibTeX
Dave Love <fx@gnu.org>
parents:
diff changeset
2485 database entry.@refill
Dave Love <fx@gnu.org>
parents:
diff changeset
2486
Dave Love <fx@gnu.org>
parents:
diff changeset
2487 The feature is invoked by pressing @kbd{C-c &}
Dave Love <fx@gnu.org>
parents:
diff changeset
2488 (@code{reftex-view-crossref}) while point is on the @var{key} argument
Dave Love <fx@gnu.org>
parents:
diff changeset
2489 of a macro involved in cross--referencing. You can also click with
37999
8e7df927fd92 Updated to version 4.16
Carsten Dominik <dominik@science.uva.nl>
parents: 37404
diff changeset
2490 @kbd{S-mouse-2} on the macro argument. Here is what will happen for
25829
Dave Love <fx@gnu.org>
parents:
diff changeset
2491 individual classes of macros:@refill
Dave Love <fx@gnu.org>
parents:
diff changeset
2492
Dave Love <fx@gnu.org>
parents:
diff changeset
2493 @table @asis
Dave Love <fx@gnu.org>
parents:
diff changeset
2494
Dave Love <fx@gnu.org>
parents:
diff changeset
2495 @item @code{\ref}
Dave Love <fx@gnu.org>
parents:
diff changeset
2496 @cindex @code{\ref}
Dave Love <fx@gnu.org>
parents:
diff changeset
2497 Display the corresponding label definition. All usual
Dave Love <fx@gnu.org>
parents:
diff changeset
2498 variants@footnote{all macros that start with @samp{ref} or end with
Dave Love <fx@gnu.org>
parents:
diff changeset
2499 @samp{ref} or @samp{refrange}} of the @code{\ref} macro are active for
Dave Love <fx@gnu.org>
parents:
diff changeset
2500 cross--reference display. This works also for labels defined in an
Dave Love <fx@gnu.org>
parents:
diff changeset
2501 external document when the current document refers to them through the
Dave Love <fx@gnu.org>
parents:
diff changeset
2502 @code{xr} interface (@pxref{xr (LaTeX package)}).@refill
Dave Love <fx@gnu.org>
parents:
diff changeset
2503
Dave Love <fx@gnu.org>
parents:
diff changeset
2504 @item @code{\label}
Dave Love <fx@gnu.org>
parents:
diff changeset
2505 @cindex @code{\label}
Dave Love <fx@gnu.org>
parents:
diff changeset
2506 @vindex reftex-label-alist
Dave Love <fx@gnu.org>
parents:
diff changeset
2507 Display a document location which references this label. Pressing
Dave Love <fx@gnu.org>
parents:
diff changeset
2508 @kbd{C-c &} several times moves through the entire document and finds
Dave Love <fx@gnu.org>
parents:
diff changeset
2509 all locations. Not only the @code{\label} macro but also other macros
Dave Love <fx@gnu.org>
parents:
diff changeset
2510 with label arguments (as configured with @code{reftex-label-alist}) are
Dave Love <fx@gnu.org>
parents:
diff changeset
2511 active for cross--reference display.@refill
Dave Love <fx@gnu.org>
parents:
diff changeset
2512
Dave Love <fx@gnu.org>
parents:
diff changeset
2513 @item @code{\cite}
Dave Love <fx@gnu.org>
parents:
diff changeset
2514 @cindex @code{\cite}
Dave Love <fx@gnu.org>
parents:
diff changeset
2515 Display the corresponding BibTeX database entry or @code{\bibitem}.
Dave Love <fx@gnu.org>
parents:
diff changeset
2516 All usual variants@footnote{all macros that either start or end with
Dave Love <fx@gnu.org>
parents:
diff changeset
2517 @samp{cite}} of the @code{\cite} macro are active for cross--reference
Dave Love <fx@gnu.org>
parents:
diff changeset
2518 display.@refill
Dave Love <fx@gnu.org>
parents:
diff changeset
2519
Dave Love <fx@gnu.org>
parents:
diff changeset
2520 @item @code{\bibitem}
Dave Love <fx@gnu.org>
parents:
diff changeset
2521 @cindex @code{\bibitem}
Dave Love <fx@gnu.org>
parents:
diff changeset
2522 Display a document location which cites this article. Pressing
Dave Love <fx@gnu.org>
parents:
diff changeset
2523 @kbd{C-c &} several times moves through the entire document and finds
Dave Love <fx@gnu.org>
parents:
diff changeset
2524 all locations.@refill
Dave Love <fx@gnu.org>
parents:
diff changeset
2525
Dave Love <fx@gnu.org>
parents:
diff changeset
2526 @item BibTeX
Dave Love <fx@gnu.org>
parents:
diff changeset
2527 @cindex BibTeX buffer, viewing cite locations from
Dave Love <fx@gnu.org>
parents:
diff changeset
2528 @cindex Viewing cite locations from BibTeX buffer
Dave Love <fx@gnu.org>
parents:
diff changeset
2529 @kbd{C-c &} is also active in BibTeX buffers. All locations in a
Dave Love <fx@gnu.org>
parents:
diff changeset
2530 document where the database entry at point is cited will be displayed.
Dave Love <fx@gnu.org>
parents:
diff changeset
2531 On first use, @b{Ref@TeX{}} will prompt for a buffer which belongs to
Dave Love <fx@gnu.org>
parents:
diff changeset
2532 the document you want to search. Subsequent calls will use the same
Dave Love <fx@gnu.org>
parents:
diff changeset
2533 document, until you break this link with a prefix argument to @kbd{C-c
Dave Love <fx@gnu.org>
parents:
diff changeset
2534 &}.@refill
Dave Love <fx@gnu.org>
parents:
diff changeset
2535
Dave Love <fx@gnu.org>
parents:
diff changeset
2536 @item @code{\index}
Dave Love <fx@gnu.org>
parents:
diff changeset
2537 @cindex @code{\index}
Dave Love <fx@gnu.org>
parents:
diff changeset
2538 Display other locations in the document which are marked by an index
Dave Love <fx@gnu.org>
parents:
diff changeset
2539 macro with the same key argument. Along with the standard @code{\index}
Dave Love <fx@gnu.org>
parents:
diff changeset
2540 and @code{\glossary} macros, all macros configured in
Dave Love <fx@gnu.org>
parents:
diff changeset
2541 @code{reftex-index-macros} will be recognized.@refill
Dave Love <fx@gnu.org>
parents:
diff changeset
2542 @end table
Dave Love <fx@gnu.org>
parents:
diff changeset
2543
37999
8e7df927fd92 Updated to version 4.16
Carsten Dominik <dominik@science.uva.nl>
parents: 37404
diff changeset
2544 @vindex reftex-view-crossref-extra
25829
Dave Love <fx@gnu.org>
parents:
diff changeset
2545 While the display of cross referencing information for the above
Dave Love <fx@gnu.org>
parents:
diff changeset
2546 mentioned macros is hard--coded, you can configure additional relations
37999
8e7df927fd92 Updated to version 4.16
Carsten Dominik <dominik@science.uva.nl>
parents: 37404
diff changeset
2547 in the variable @code{reftex-view-crossref-extra}.
25829
Dave Love <fx@gnu.org>
parents:
diff changeset
2548
Dave Love <fx@gnu.org>
parents:
diff changeset
2549 @iftex
Dave Love <fx@gnu.org>
parents:
diff changeset
2550 @chapter All the Rest
Dave Love <fx@gnu.org>
parents:
diff changeset
2551 @end iftex
Dave Love <fx@gnu.org>
parents:
diff changeset
2552
39267
a8c0a02f6129 Spelling corrections.
Richard M. Stallman <rms@gnu.org>
parents: 38003
diff changeset
2553 @node RefTeXs Menu, Key Bindings, Viewing Cross-References, Top
25829
Dave Love <fx@gnu.org>
parents:
diff changeset
2554 @section @b{Ref@TeX{}}'s Menu
Dave Love <fx@gnu.org>
parents:
diff changeset
2555 @cindex RefTeXs Menu
Dave Love <fx@gnu.org>
parents:
diff changeset
2556 @cindex Menu, in the menu bar
Dave Love <fx@gnu.org>
parents:
diff changeset
2557
Dave Love <fx@gnu.org>
parents:
diff changeset
2558 @b{Ref@TeX{}} installs a @code{Ref} menu in the menu bar on systems
Dave Love <fx@gnu.org>
parents:
diff changeset
2559 which support this. From this menu you can access all of
Dave Love <fx@gnu.org>
parents:
diff changeset
2560 @b{Ref@TeX{}}'s commands and a few of its options. There is also a
Dave Love <fx@gnu.org>
parents:
diff changeset
2561 @code{Customize} submenu which can be used to access @b{Ref@TeX{}}'s
Dave Love <fx@gnu.org>
parents:
diff changeset
2562 entire set of options.@refill
Dave Love <fx@gnu.org>
parents:
diff changeset
2563
39267
a8c0a02f6129 Spelling corrections.
Richard M. Stallman <rms@gnu.org>
parents: 38003
diff changeset
2564 @node Key Bindings, Faces, RefTeXs Menu, Top
a8c0a02f6129 Spelling corrections.
Richard M. Stallman <rms@gnu.org>
parents: 38003
diff changeset
2565 @section Default Key Bindings
a8c0a02f6129 Spelling corrections.
Richard M. Stallman <rms@gnu.org>
parents: 38003
diff changeset
2566 @cindex Key Bindings, summary
a8c0a02f6129 Spelling corrections.
Richard M. Stallman <rms@gnu.org>
parents: 38003
diff changeset
2567
a8c0a02f6129 Spelling corrections.
Richard M. Stallman <rms@gnu.org>
parents: 38003
diff changeset
2568 Here is a summary of the available key bindings.
25829
Dave Love <fx@gnu.org>
parents:
diff changeset
2569
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 C-c &
37999
8e7df927fd92 Updated to version 4.16
Carsten Dominik <dominik@science.uva.nl>
parents: 37404
diff changeset
2575 @kindex S-mouse-2
25829
Dave Love <fx@gnu.org>
parents:
diff changeset
2576 @kindex C-c /
26911
d7f536a01276 Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents: 25829
diff changeset
2577 @kindex C-c \
d7f536a01276 Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents: 25829
diff changeset
2578 @kindex C-c |
25829
Dave Love <fx@gnu.org>
parents:
diff changeset
2579 @kindex C-c <
Dave Love <fx@gnu.org>
parents:
diff changeset
2580 @kindex C-c >
Dave Love <fx@gnu.org>
parents:
diff changeset
2581 @example
Dave Love <fx@gnu.org>
parents:
diff changeset
2582 @kbd{C-c =} @code{reftex-toc}
Dave Love <fx@gnu.org>
parents:
diff changeset
2583 @kbd{C-c (} @code{reftex-label}
Dave Love <fx@gnu.org>
parents:
diff changeset
2584 @kbd{C-c )} @code{reftex-reference}
Dave Love <fx@gnu.org>
parents:
diff changeset
2585 @kbd{C-c [} @code{reftex-citation}
Dave Love <fx@gnu.org>
parents:
diff changeset
2586 @kbd{C-c &} @code{reftex-view-crossref}
37999
8e7df927fd92 Updated to version 4.16
Carsten Dominik <dominik@science.uva.nl>
parents: 37404
diff changeset
2587 @kbd{S-mouse-2} @code{reftex-mouse-view-crossref}
25829
Dave Love <fx@gnu.org>
parents:
diff changeset
2588 @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
2589 @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
2590 @kbd{C-c |} @code{reftex-index-visit-phrases-buffer}
25829
Dave Love <fx@gnu.org>
parents:
diff changeset
2591 @kbd{C-c <} @code{reftex-index}
Dave Love <fx@gnu.org>
parents:
diff changeset
2592 @kbd{C-c >} @code{reftex-display-index}
Dave Love <fx@gnu.org>
parents:
diff changeset
2593 @end example
Dave Love <fx@gnu.org>
parents:
diff changeset
2594
37999
8e7df927fd92 Updated to version 4.16
Carsten Dominik <dominik@science.uva.nl>
parents: 37404
diff changeset
2595 Note that the @kbd{S-mouse-2} binding is only provided if this key is
25829
Dave Love <fx@gnu.org>
parents:
diff changeset
2596 not already used by some other package. @b{Ref@TeX{}} will not override an
37999
8e7df927fd92 Updated to version 4.16
Carsten Dominik <dominik@science.uva.nl>
parents: 37404
diff changeset
2597 existing binding to @kbd{S-mouse-2}.@refill
25829
Dave Love <fx@gnu.org>
parents:
diff changeset
2598
Dave Love <fx@gnu.org>
parents:
diff changeset
2599 Personally, I also bind some functions in the users @kbd{C-c} map for
Dave Love <fx@gnu.org>
parents:
diff changeset
2600 easier access.@refill
Dave Love <fx@gnu.org>
parents:
diff changeset
2601
Dave Love <fx@gnu.org>
parents:
diff changeset
2602 @c FIXME: Do we need bindings for the Index macros here as well?
Dave Love <fx@gnu.org>
parents:
diff changeset
2603 @c C-c i C-c I or so????
39267
a8c0a02f6129 Spelling corrections.
Richard M. Stallman <rms@gnu.org>
parents: 38003
diff changeset
2604 @c How about key bindings for reftex-reset-mode and reftex-parse-document?
25829
Dave Love <fx@gnu.org>
parents:
diff changeset
2605 @kindex C-c t
Dave Love <fx@gnu.org>
parents:
diff changeset
2606 @kindex C-c l
Dave Love <fx@gnu.org>
parents:
diff changeset
2607 @kindex C-c r
Dave Love <fx@gnu.org>
parents:
diff changeset
2608 @kindex C-c c
Dave Love <fx@gnu.org>
parents:
diff changeset
2609 @kindex C-c v
Dave Love <fx@gnu.org>
parents:
diff changeset
2610 @kindex C-c s
Dave Love <fx@gnu.org>
parents:
diff changeset
2611 @kindex C-c g
Dave Love <fx@gnu.org>
parents:
diff changeset
2612 @example
Dave Love <fx@gnu.org>
parents:
diff changeset
2613 @kbd{C-c t} @code{reftex-toc}
Dave Love <fx@gnu.org>
parents:
diff changeset
2614 @kbd{C-c l} @code{reftex-label}
Dave Love <fx@gnu.org>
parents:
diff changeset
2615 @kbd{C-c r} @code{reftex-reference}
Dave Love <fx@gnu.org>
parents:
diff changeset
2616 @kbd{C-c c} @code{reftex-citation}
Dave Love <fx@gnu.org>
parents:
diff changeset
2617 @kbd{C-c v} @code{reftex-view-crossref}
Dave Love <fx@gnu.org>
parents:
diff changeset
2618 @kbd{C-c s} @code{reftex-search-document}
Dave Love <fx@gnu.org>
parents:
diff changeset
2619 @kbd{C-c g} @code{reftex-grep-document}
Dave Love <fx@gnu.org>
parents:
diff changeset
2620 @end example
Dave Love <fx@gnu.org>
parents:
diff changeset
2621
Dave Love <fx@gnu.org>
parents:
diff changeset
2622 @noindent These keys are reserved for the user, so I cannot bind them by
39267
a8c0a02f6129 Spelling corrections.
Richard M. Stallman <rms@gnu.org>
parents: 38003
diff changeset
2623 default. If you want to have these key bindings available, set in your
25829
Dave Love <fx@gnu.org>
parents:
diff changeset
2624 @file{.emacs} file:
Dave Love <fx@gnu.org>
parents:
diff changeset
2625
Dave Love <fx@gnu.org>
parents:
diff changeset
2626 @vindex reftex-extra-bindings
Dave Love <fx@gnu.org>
parents:
diff changeset
2627 @lisp
Dave Love <fx@gnu.org>
parents:
diff changeset
2628 (setq reftex-extra-bindings t)
Dave Love <fx@gnu.org>
parents:
diff changeset
2629 @end lisp
Dave Love <fx@gnu.org>
parents:
diff changeset
2630
Dave Love <fx@gnu.org>
parents:
diff changeset
2631 @vindex reftex-load-hook
39267
a8c0a02f6129 Spelling corrections.
Richard M. Stallman <rms@gnu.org>
parents: 38003
diff changeset
2632 Changing and adding to @b{Ref@TeX{}}'s key bindings is best done in the hook
25829
Dave Love <fx@gnu.org>
parents:
diff changeset
2633 @code{reftex-load-hook}. For information on the keymaps
Dave Love <fx@gnu.org>
parents:
diff changeset
2634 which should be used to add keys, see @ref{Keymaps and Hooks}.
Dave Love <fx@gnu.org>
parents:
diff changeset
2635
39267
a8c0a02f6129 Spelling corrections.
Richard M. Stallman <rms@gnu.org>
parents: 38003
diff changeset
2636 @node Faces, AUCTeX, Key Bindings, Top
25829
Dave Love <fx@gnu.org>
parents:
diff changeset
2637 @section Faces
Dave Love <fx@gnu.org>
parents:
diff changeset
2638 @cindex Faces
Dave Love <fx@gnu.org>
parents:
diff changeset
2639
Dave Love <fx@gnu.org>
parents:
diff changeset
2640 @b{Ref@TeX{}} uses faces when available to structure the selection and
Dave Love <fx@gnu.org>
parents:
diff changeset
2641 table of contents buffers. It does not create its own faces, but uses
Dave Love <fx@gnu.org>
parents:
diff changeset
2642 the ones defined in @file{font-lock.el}. Therefore, @b{Ref@TeX{}} will
Dave Love <fx@gnu.org>
parents:
diff changeset
2643 use faces only when @code{font-lock} is loaded. This seems to be
Dave Love <fx@gnu.org>
parents:
diff changeset
2644 reasonable because people who like faces will very likely have it
Dave Love <fx@gnu.org>
parents:
diff changeset
2645 loaded. If you wish to turn off fontification or change the involved
Dave Love <fx@gnu.org>
parents:
diff changeset
2646 faces, see @ref{Options (Fontification)}.@refill
Dave Love <fx@gnu.org>
parents:
diff changeset
2647
Dave Love <fx@gnu.org>
parents:
diff changeset
2648 @node Multifile Documents, Language Support, AUCTeX, Top
Dave Love <fx@gnu.org>
parents:
diff changeset
2649 @section Multifile Documents
Dave Love <fx@gnu.org>
parents:
diff changeset
2650 @cindex Multifile documents
Dave Love <fx@gnu.org>
parents:
diff changeset
2651 @cindex Documents, spread over files
Dave Love <fx@gnu.org>
parents:
diff changeset
2652
Dave Love <fx@gnu.org>
parents:
diff changeset
2653 The following is relevant when working with documents spread over many
Dave Love <fx@gnu.org>
parents:
diff changeset
2654 files:@refill
Dave Love <fx@gnu.org>
parents:
diff changeset
2655
Dave Love <fx@gnu.org>
parents:
diff changeset
2656 @itemize @bullet
Dave Love <fx@gnu.org>
parents:
diff changeset
2657 @item
Dave Love <fx@gnu.org>
parents:
diff changeset
2658 @b{Ref@TeX{}} has full support for multifile documents. You can edit parts of
Dave Love <fx@gnu.org>
parents:
diff changeset
2659 several (multifile) documents at the same time without conflicts.
Dave Love <fx@gnu.org>
parents:
diff changeset
2660 @b{Ref@TeX{}} provides functions to run @code{grep}, @code{search} and
Dave Love <fx@gnu.org>
parents:
diff changeset
2661 @code{query-replace} on all files which are part of a multifile
Dave Love <fx@gnu.org>
parents:
diff changeset
2662 document.@refill
Dave Love <fx@gnu.org>
parents:
diff changeset
2663
Dave Love <fx@gnu.org>
parents:
diff changeset
2664 @item
Dave Love <fx@gnu.org>
parents:
diff changeset
2665 @vindex tex-main-file
Dave Love <fx@gnu.org>
parents:
diff changeset
2666 @vindex TeX-master
29772
265fdb06f294 Update to reftex 4 14
Carsten Dominik <dominik@science.uva.nl>
parents: 29713
diff changeset
2667 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
2668 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
2669 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
2670 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
2671 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
2672
265fdb06f294 Update to reftex 4 14
Carsten Dominik <dominik@science.uva.nl>
parents: 29713
diff changeset
2673 @example
265fdb06f294 Update to reftex 4 14
Carsten Dominik <dominik@science.uva.nl>
parents: 29713
diff changeset
2674 %%% Local Variables: ***
265fdb06f294 Update to reftex 4 14
Carsten Dominik <dominik@science.uva.nl>
parents: 29713
diff changeset
2675 %%% mode:latex ***
265fdb06f294 Update to reftex 4 14
Carsten Dominik <dominik@science.uva.nl>
parents: 29713
diff changeset
2676 %%% TeX-master: "thesis.tex" ***
265fdb06f294 Update to reftex 4 14
Carsten Dominik <dominik@science.uva.nl>
parents: 29713
diff changeset
2677 %%% End: ***
265fdb06f294 Update to reftex 4 14
Carsten Dominik <dominik@science.uva.nl>
parents: 29713
diff changeset
2678 @end example
265fdb06f294 Update to reftex 4 14
Carsten Dominik <dominik@science.uva.nl>
parents: 29713
diff changeset
2679
265fdb06f294 Update to reftex 4 14
Carsten Dominik <dominik@science.uva.nl>
parents: 29713
diff changeset
2680 AUCTeX with the setting
265fdb06f294 Update to reftex 4 14
Carsten Dominik <dominik@science.uva.nl>
parents: 29713
diff changeset
2681
265fdb06f294 Update to reftex 4 14
Carsten Dominik <dominik@science.uva.nl>
parents: 29713
diff changeset
2682 @lisp
265fdb06f294 Update to reftex 4 14
Carsten Dominik <dominik@science.uva.nl>
parents: 29713
diff changeset
2683 (setq-default TeX-master nil)
265fdb06f294 Update to reftex 4 14
Carsten Dominik <dominik@science.uva.nl>
parents: 29713
diff changeset
2684 @end lisp
265fdb06f294 Update to reftex 4 14
Carsten Dominik <dominik@science.uva.nl>
parents: 29713
diff changeset
2685
265fdb06f294 Update to reftex 4 14
Carsten Dominik <dominik@science.uva.nl>
parents: 29713
diff changeset
2686 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
2687 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
2688 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
2689 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
2690 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
2691 (@pxref{File Variables,,,emacs, The GNU Emacs Manual}).@refill
25829
Dave Love <fx@gnu.org>
parents:
diff changeset
2692
Dave Love <fx@gnu.org>
parents:
diff changeset
2693 @item
Dave Love <fx@gnu.org>
parents:
diff changeset
2694 The context of a label definition must be found in the same file as the
Dave Love <fx@gnu.org>
parents:
diff changeset
2695 label itself in order to be processed correctly by @b{Ref@TeX{}}. The only
Dave Love <fx@gnu.org>
parents:
diff changeset
2696 exception is that section labels referring to a section statement
Dave Love <fx@gnu.org>
parents:
diff changeset
2697 outside the current file can still use that section title as
Dave Love <fx@gnu.org>
parents:
diff changeset
2698 context.@refill
Dave Love <fx@gnu.org>
parents:
diff changeset
2699 @end itemize
Dave Love <fx@gnu.org>
parents:
diff changeset
2700
Dave Love <fx@gnu.org>
parents:
diff changeset
2701 @node Language Support, Finding Files, Multifile Documents, Top
Dave Love <fx@gnu.org>
parents:
diff changeset
2702 @section Language Support
Dave Love <fx@gnu.org>
parents:
diff changeset
2703 @cindex Language support
Dave Love <fx@gnu.org>
parents:
diff changeset
2704
Dave Love <fx@gnu.org>
parents:
diff changeset
2705 Some parts of @b{Ref@TeX{}} are language dependent. The default
Dave Love <fx@gnu.org>
parents:
diff changeset
2706 settings work well for English. If you are writing in a different
Dave Love <fx@gnu.org>
parents:
diff changeset
2707 language, the following hints may be useful:
Dave Love <fx@gnu.org>
parents:
diff changeset
2708
Dave Love <fx@gnu.org>
parents:
diff changeset
2709 @itemize @bullet
Dave Love <fx@gnu.org>
parents:
diff changeset
2710 @item
Dave Love <fx@gnu.org>
parents:
diff changeset
2711 @vindex reftex-derive-label-parameters
Dave Love <fx@gnu.org>
parents:
diff changeset
2712 @vindex reftex-abbrev-parameters
Dave Love <fx@gnu.org>
parents:
diff changeset
2713 The mechanism to derive a label from context includes the abbreviation
Dave Love <fx@gnu.org>
parents:
diff changeset
2714 of words and omission of unimportant words. These mechanisms may have
Dave Love <fx@gnu.org>
parents:
diff changeset
2715 to be changed for other languages. See the variables
Dave Love <fx@gnu.org>
parents:
diff changeset
2716 @code{reftex-derive-label-parameters} and @code{reftex-abbrev-parameters}.
Dave Love <fx@gnu.org>
parents:
diff changeset
2717
Dave Love <fx@gnu.org>
parents:
diff changeset
2718 @item
Dave Love <fx@gnu.org>
parents:
diff changeset
2719 @vindex reftex-translate-to-ascii-function
Dave Love <fx@gnu.org>
parents:
diff changeset
2720 @vindex reftex-label-illegal-re
Dave Love <fx@gnu.org>
parents:
diff changeset
2721 Also, when a label is derived from context, @b{Ref@TeX{}} clears the
Dave Love <fx@gnu.org>
parents:
diff changeset
2722 context string from non-ASCII characters in order to make a legal label.
Dave Love <fx@gnu.org>
parents:
diff changeset
2723 If there should ever be a version of @TeX{} which allows extended
Dave Love <fx@gnu.org>
parents:
diff changeset
2724 characters @emph{in labels}, then we will have to look at the
Dave Love <fx@gnu.org>
parents:
diff changeset
2725 variables @code{reftex-translate-to-ascii-function} and
Dave Love <fx@gnu.org>
parents:
diff changeset
2726 @code{reftex-label-illegal-re}.
Dave Love <fx@gnu.org>
parents:
diff changeset
2727
Dave Love <fx@gnu.org>
parents:
diff changeset
2728 @item
Dave Love <fx@gnu.org>
parents:
diff changeset
2729 When a label is referenced, @b{Ref@TeX{}} looks at the word before point
Dave Love <fx@gnu.org>
parents:
diff changeset
2730 to guess which label type is required. These @emph{magic words} are
Dave Love <fx@gnu.org>
parents:
diff changeset
2731 different in every language. For an example of how to add magic words,
Dave Love <fx@gnu.org>
parents:
diff changeset
2732 see @ref{Adding Magic Words}.
Dave Love <fx@gnu.org>
parents:
diff changeset
2733
Dave Love <fx@gnu.org>
parents:
diff changeset
2734 @vindex reftex-multiref-punctuation
Dave Love <fx@gnu.org>
parents:
diff changeset
2735 @vindex reftex-cite-punctuation
Dave Love <fx@gnu.org>
parents:
diff changeset
2736 @item
Dave Love <fx@gnu.org>
parents:
diff changeset
2737 @b{Ref@TeX{}} inserts ``punctuation'' for multiple references and
Dave Love <fx@gnu.org>
parents:
diff changeset
2738 for the author list in citations. Some of this may be language
Dave Love <fx@gnu.org>
parents:
diff changeset
2739 dependent. See the variables @code{reftex-multiref-punctuation} and
Dave Love <fx@gnu.org>
parents:
diff changeset
2740 @code{reftex-cite-punctuation}.
Dave Love <fx@gnu.org>
parents:
diff changeset
2741 @end itemize
Dave Love <fx@gnu.org>
parents:
diff changeset
2742
Dave Love <fx@gnu.org>
parents:
diff changeset
2743 @node Finding Files, Optimizations, Language Support, Top
Dave Love <fx@gnu.org>
parents:
diff changeset
2744 @section Finding Files
Dave Love <fx@gnu.org>
parents:
diff changeset
2745 @cindex Finding files
Dave Love <fx@gnu.org>
parents:
diff changeset
2746
Dave Love <fx@gnu.org>
parents:
diff changeset
2747 In order to find files included in a document via @code{\input} or
Dave Love <fx@gnu.org>
parents:
diff changeset
2748 @code{\include}, @b{Ref@TeX{}} searches all directories specified in the
Dave Love <fx@gnu.org>
parents:
diff changeset
2749 environment variable @code{TEXINPUTS}. Similarly, it will search the
Dave Love <fx@gnu.org>
parents:
diff changeset
2750 path specified in the variables @code{BIBINPUTS} and @code{TEXBIB} for
Dave Love <fx@gnu.org>
parents:
diff changeset
2751 BibTeX database files.
Dave Love <fx@gnu.org>
parents:
diff changeset
2752
Dave Love <fx@gnu.org>
parents:
diff changeset
2753 When searching, @b{Ref@TeX{}} will also expand recursive path
Dave Love <fx@gnu.org>
parents:
diff changeset
2754 definitions (directories ending in @samp{//} or @samp{!!}). But it will
Dave Love <fx@gnu.org>
parents:
diff changeset
2755 only search and expand directories @emph{explicitly} given in these
Dave Love <fx@gnu.org>
parents:
diff changeset
2756 variables. This may cause problems under the following circumstances:
Dave Love <fx@gnu.org>
parents:
diff changeset
2757
Dave Love <fx@gnu.org>
parents:
diff changeset
2758 @itemize @bullet
Dave Love <fx@gnu.org>
parents:
diff changeset
2759 @item
Dave Love <fx@gnu.org>
parents:
diff changeset
2760 Most TeX system have a default search path for both TeX files and BibTeX
Dave Love <fx@gnu.org>
parents:
diff changeset
2761 files which is defined in some setup file. Usually this default path is
Dave Love <fx@gnu.org>
parents:
diff changeset
2762 for system files which @b{Ref@TeX{}} does not need to see. But if your
Dave Love <fx@gnu.org>
parents:
diff changeset
2763 document needs TeX files or BibTeX database files in a directory only
Dave Love <fx@gnu.org>
parents:
diff changeset
2764 given in the default search path, @b{Ref@TeX{}} will fail to find them.
Dave Love <fx@gnu.org>
parents:
diff changeset
2765 @item
Dave Love <fx@gnu.org>
parents:
diff changeset
2766 Some TeX systems do not use environment variables at all in order to
Dave Love <fx@gnu.org>
parents:
diff changeset
2767 specify the search path. Both default and user search path are then
Dave Love <fx@gnu.org>
parents:
diff changeset
2768 defined in setup files.
Dave Love <fx@gnu.org>
parents:
diff changeset
2769 @end itemize
Dave Love <fx@gnu.org>
parents:
diff changeset
2770
Dave Love <fx@gnu.org>
parents:
diff changeset
2771 @noindent
Dave Love <fx@gnu.org>
parents:
diff changeset
2772 There are three ways to solve this problem:
Dave Love <fx@gnu.org>
parents:
diff changeset
2773
Dave Love <fx@gnu.org>
parents:
diff changeset
2774 @itemize @bullet
Dave Love <fx@gnu.org>
parents:
diff changeset
2775 @item
Dave Love <fx@gnu.org>
parents:
diff changeset
2776 Specify all relevant directories explicitly in the environment
Dave Love <fx@gnu.org>
parents:
diff changeset
2777 variables. If for some reason you don't want to mess with the default
Dave Love <fx@gnu.org>
parents:
diff changeset
2778 variables @code{TEXINPUTS} and @code{BIBINPUTS}, define your own
Dave Love <fx@gnu.org>
parents:
diff changeset
2779 variables and configure @b{Ref@TeX{}} to use them instead:
Dave Love <fx@gnu.org>
parents:
diff changeset
2780
Dave Love <fx@gnu.org>
parents:
diff changeset
2781 @lisp
Dave Love <fx@gnu.org>
parents:
diff changeset
2782 (setq reftex-texpath-environment-variables '("MYTEXINPUTS"))
Dave Love <fx@gnu.org>
parents:
diff changeset
2783 (setq reftex-bibpath-environment-variables '("MYBIBINPUTS"))
Dave Love <fx@gnu.org>
parents:
diff changeset
2784 @end lisp
Dave Love <fx@gnu.org>
parents:
diff changeset
2785
Dave Love <fx@gnu.org>
parents:
diff changeset
2786 @item
Dave Love <fx@gnu.org>
parents:
diff changeset
2787 Specify the full search path directly in @b{Ref@TeX{}}'s variables.
Dave Love <fx@gnu.org>
parents:
diff changeset
2788
Dave Love <fx@gnu.org>
parents:
diff changeset
2789 @lisp
Dave Love <fx@gnu.org>
parents:
diff changeset
2790 (setq reftex-texpath-environment-variables
Dave Love <fx@gnu.org>
parents:
diff changeset
2791 '("./inp:/home/cd/tex//:/usr/local/tex//"))
Dave Love <fx@gnu.org>
parents:
diff changeset
2792 (setq reftex-bibpath-environment-variables
Dave Love <fx@gnu.org>
parents:
diff changeset
2793 '("/home/cd/tex/lit/"))
Dave Love <fx@gnu.org>
parents:
diff changeset
2794 @end lisp
Dave Love <fx@gnu.org>
parents:
diff changeset
2795
Dave Love <fx@gnu.org>
parents:
diff changeset
2796 @item
Dave Love <fx@gnu.org>
parents:
diff changeset
2797 Some TeX systems provide stand--alone programs to do the file search just
Dave Love <fx@gnu.org>
parents:
diff changeset
2798 like TeX and BibTeX. E.g. Thomas Esser's @code{teTeX} uses the
Dave Love <fx@gnu.org>
parents:
diff changeset
2799 @code{kpathsearch} library which provides the command @code{kpsewhich}
Dave Love <fx@gnu.org>
parents:
diff changeset
2800 to search for files. @b{Ref@TeX{}} can be configured to use this
Dave Love <fx@gnu.org>
parents:
diff changeset
2801 program. Note that the exact syntax of the @code{kpsewhich}
Dave Love <fx@gnu.org>
parents:
diff changeset
2802 command depends upon the version of that program.
Dave Love <fx@gnu.org>
parents:
diff changeset
2803
Dave Love <fx@gnu.org>
parents:
diff changeset
2804 @lisp
Dave Love <fx@gnu.org>
parents:
diff changeset
2805 (setq reftex-use-external-file-finders t)
Dave Love <fx@gnu.org>
parents:
diff changeset
2806 (setq reftex-external-file-finders
37038
528310f62c34 (Finding Files): Fix an example.
Gerd Moellmann <gerd@gnu.org>
parents: 36509
diff changeset
2807 '(("tex" . "kpsewhich -format=.tex %f")
528310f62c34 (Finding Files): Fix an example.
Gerd Moellmann <gerd@gnu.org>
parents: 36509
diff changeset
2808 ("bib" . "kpsewhich -format=.bib %f")))
25829
Dave Love <fx@gnu.org>
parents:
diff changeset
2809 @end lisp
Dave Love <fx@gnu.org>
parents:
diff changeset
2810 @end itemize
Dave Love <fx@gnu.org>
parents:
diff changeset
2811
Dave Love <fx@gnu.org>
parents:
diff changeset
2812 @node Optimizations, Problems and Work-Arounds, Finding Files, Top
Dave Love <fx@gnu.org>
parents:
diff changeset
2813 @section Optimizations
Dave Love <fx@gnu.org>
parents:
diff changeset
2814 @cindex Optimizations
Dave Love <fx@gnu.org>
parents:
diff changeset
2815
Dave Love <fx@gnu.org>
parents:
diff changeset
2816 Implementing the principle of least surprises, the default settings of
Dave Love <fx@gnu.org>
parents:
diff changeset
2817 @b{Ref@TeX{}} ensure a safe ride for beginners and casual users. However,
Dave Love <fx@gnu.org>
parents:
diff changeset
2818 when using @b{Ref@TeX{}} for a large project and/or on a small computer,
Dave Love <fx@gnu.org>
parents:
diff changeset
2819 there are ways to improve speed or memory usage.@refill
Dave Love <fx@gnu.org>
parents:
diff changeset
2820
Dave Love <fx@gnu.org>
parents:
diff changeset
2821 @itemize @bullet
Dave Love <fx@gnu.org>
parents:
diff changeset
2822 @item
Dave Love <fx@gnu.org>
parents:
diff changeset
2823 @b{Removing Lookup Buffers}@*
Dave Love <fx@gnu.org>
parents:
diff changeset
2824 @cindex Removing lookup buffers
Dave Love <fx@gnu.org>
parents:
diff changeset
2825 @b{Ref@TeX{}} will load other parts of a multifile document as well as BibTeX
Dave Love <fx@gnu.org>
parents:
diff changeset
2826 database files for lookup purposes. These buffers are kept, so that
Dave Love <fx@gnu.org>
parents:
diff changeset
2827 subsequent use of the same files is fast. If you can't afford keeping
Dave Love <fx@gnu.org>
parents:
diff changeset
2828 these buffers around, and if you can live with a speed penalty, try
Dave Love <fx@gnu.org>
parents:
diff changeset
2829
Dave Love <fx@gnu.org>
parents:
diff changeset
2830 @vindex reftex-keep-temporary-buffers
Dave Love <fx@gnu.org>
parents:
diff changeset
2831 @lisp
Dave Love <fx@gnu.org>
parents:
diff changeset
2832 (setq reftex-keep-temporary-buffers nil)
Dave Love <fx@gnu.org>
parents:
diff changeset
2833 @end lisp
Dave Love <fx@gnu.org>
parents:
diff changeset
2834
Dave Love <fx@gnu.org>
parents:
diff changeset
2835 @item
Dave Love <fx@gnu.org>
parents:
diff changeset
2836 @b{Partial Document Scans}@*
Dave Love <fx@gnu.org>
parents:
diff changeset
2837 @cindex Partial documents scans
Dave Love <fx@gnu.org>
parents:
diff changeset
2838 @cindex Document scanning, partial
Dave Love <fx@gnu.org>
parents:
diff changeset
2839 A @kbd{C-u} prefix on the major @b{Ref@TeX{}} commands @code{reftex-label}
Dave Love <fx@gnu.org>
parents:
diff changeset
2840 (@kbd{C-u C-c (}), @code{reftex-reference} (@kbd{C-u C-c )}),
Dave Love <fx@gnu.org>
parents:
diff changeset
2841 @code{reftex-citation} (@kbd{C-u C-c [}), @code{reftex-toc} (@kbd{C-u C-c
Dave Love <fx@gnu.org>
parents:
diff changeset
2842 =}), and @code{reftex-view-crossref} (@kbd{C-u C-c &}) initiates
Dave Love <fx@gnu.org>
parents:
diff changeset
2843 re-parsing of the entire document in order to update the parsing
Dave Love <fx@gnu.org>
parents:
diff changeset
2844 information. For a large document this can be unnecessary, in
Dave Love <fx@gnu.org>
parents:
diff changeset
2845 particular if only one file has changed. @b{Ref@TeX{}} can be configured
Dave Love <fx@gnu.org>
parents:
diff changeset
2846 to do partial scans instead of full ones. @kbd{C-u} re-parsing then
Dave Love <fx@gnu.org>
parents:
diff changeset
2847 does apply only to the current buffer and files included from it.
Dave Love <fx@gnu.org>
parents:
diff changeset
2848 Likewise, the @kbd{r} key in both the label selection buffer and the
Dave Love <fx@gnu.org>
parents:
diff changeset
2849 table-of-contents buffer will only prompt scanning of the file in which
Dave Love <fx@gnu.org>
parents:
diff changeset
2850 the label or section macro near the cursor was defined. Re-parsing of
Dave Love <fx@gnu.org>
parents:
diff changeset
2851 the entire document is still available by using @kbd{C-u C-u} as a
Dave Love <fx@gnu.org>
parents:
diff changeset
2852 prefix, or the capital @kbd{R} key in the menus. To use this feature,
Dave Love <fx@gnu.org>
parents:
diff changeset
2853 try@refill
Dave Love <fx@gnu.org>
parents:
diff changeset
2854
Dave Love <fx@gnu.org>
parents:
diff changeset
2855 @vindex reftex-enable-partial-scans
Dave Love <fx@gnu.org>
parents:
diff changeset
2856 @lisp
Dave Love <fx@gnu.org>
parents:
diff changeset
2857 (setq reftex-enable-partial-scans t)
Dave Love <fx@gnu.org>
parents:
diff changeset
2858 @end lisp
Dave Love <fx@gnu.org>
parents:
diff changeset
2859
Dave Love <fx@gnu.org>
parents:
diff changeset
2860 @item
Dave Love <fx@gnu.org>
parents:
diff changeset
2861 @b{Saving Parser Information}@*
Dave Love <fx@gnu.org>
parents:
diff changeset
2862 @cindex Saving parser information
Dave Love <fx@gnu.org>
parents:
diff changeset
2863 @cindex Parse information, saving to a file
27195
d7311a9cb223 version 4.10
Carsten Dominik <dominik@science.uva.nl>
parents: 26911
diff changeset
2864 @vindex reftex-parse-file-extension
25829
Dave Love <fx@gnu.org>
parents:
diff changeset
2865 Even with partial scans enabled, @b{Ref@TeX{}} still has to make one full
Dave Love <fx@gnu.org>
parents:
diff changeset
2866 scan, when you start working with a document. To avoid this, parsing
Dave Love <fx@gnu.org>
parents:
diff changeset
2867 information can be stored in a file. The file @file{MASTER.rel} is used
Dave Love <fx@gnu.org>
parents:
diff changeset
2868 for storing information about a document with master file
Dave Love <fx@gnu.org>
parents:
diff changeset
2869 @file{MASTER.tex}. It is written automatically when you kill a buffer
Dave Love <fx@gnu.org>
parents:
diff changeset
2870 in @code{reftex-mode} or when you exit Emacs. The information is
Dave Love <fx@gnu.org>
parents:
diff changeset
2871 restored when you begin working with a document in a new editing
Dave Love <fx@gnu.org>
parents:
diff changeset
2872 session. To use this feature, put into @file{.emacs}:@refill
Dave Love <fx@gnu.org>
parents:
diff changeset
2873
Dave Love <fx@gnu.org>
parents:
diff changeset
2874 @vindex reftex-save-parse-info
Dave Love <fx@gnu.org>
parents:
diff changeset
2875 @lisp
Dave Love <fx@gnu.org>
parents:
diff changeset
2876 (setq reftex-save-parse-info t)
Dave Love <fx@gnu.org>
parents:
diff changeset
2877 @end lisp
Dave Love <fx@gnu.org>
parents:
diff changeset
2878
Dave Love <fx@gnu.org>
parents:
diff changeset
2879 @item
Dave Love <fx@gnu.org>
parents:
diff changeset
2880 @b{Automatic Document Scans}@*
Dave Love <fx@gnu.org>
parents:
diff changeset
2881 @cindex Automatic document scans
Dave Love <fx@gnu.org>
parents:
diff changeset
2882 @cindex Document scanning, automatic
Dave Love <fx@gnu.org>
parents:
diff changeset
2883 At rare occasions, @b{Ref@TeX{}} will automatically rescan a part of the
Dave Love <fx@gnu.org>
parents:
diff changeset
2884 document. If this gets into your way, it can be turned off with
Dave Love <fx@gnu.org>
parents:
diff changeset
2885
Dave Love <fx@gnu.org>
parents:
diff changeset
2886 @vindex reftex-allow-automatic-rescan
Dave Love <fx@gnu.org>
parents:
diff changeset
2887 @lisp
Dave Love <fx@gnu.org>
parents:
diff changeset
2888 (setq reftex-allow-automatic-rescan nil)
Dave Love <fx@gnu.org>
parents:
diff changeset
2889 @end lisp
Dave Love <fx@gnu.org>
parents:
diff changeset
2890
Dave Love <fx@gnu.org>
parents:
diff changeset
2891 @b{Ref@TeX{}} will then occasionally annotate new labels in the selection
Dave Love <fx@gnu.org>
parents:
diff changeset
2892 buffer, saying that their position in the label list in uncertain. A
Dave Love <fx@gnu.org>
parents:
diff changeset
2893 manual document scan will fix this.@refill
Dave Love <fx@gnu.org>
parents:
diff changeset
2894
Dave Love <fx@gnu.org>
parents:
diff changeset
2895 @item
Dave Love <fx@gnu.org>
parents:
diff changeset
2896 @b{Multiple Selection Buffers}@*
Dave Love <fx@gnu.org>
parents:
diff changeset
2897 @cindex Multiple selection buffers
Dave Love <fx@gnu.org>
parents:
diff changeset
2898 @cindex Selection buffers, multiple
Dave Love <fx@gnu.org>
parents:
diff changeset
2899 Normally, the selection buffer @file{*RefTeX Select*} is re-created for
Dave Love <fx@gnu.org>
parents:
diff changeset
2900 every selection process. In documents with very many labels this can
Dave Love <fx@gnu.org>
parents:
diff changeset
2901 take several seconds. @b{Ref@TeX{}} provides an option to create a
Dave Love <fx@gnu.org>
parents:
diff changeset
2902 separate selection buffer for each label type and to keep this buffer
Dave Love <fx@gnu.org>
parents:
diff changeset
2903 from one selection to the next. These buffers are updated automatically
Dave Love <fx@gnu.org>
parents:
diff changeset
2904 only when a new label has been added in the buffers category with
Dave Love <fx@gnu.org>
parents:
diff changeset
2905 @code{reftex-label}. Updating the buffer takes as long as recreating it
Dave Love <fx@gnu.org>
parents:
diff changeset
2906 - so the time saving is limited to cases where no new labels of that
Dave Love <fx@gnu.org>
parents:
diff changeset
2907 category have been added. To turn on this feature, use@refill
Dave Love <fx@gnu.org>
parents:
diff changeset
2908
Dave Love <fx@gnu.org>
parents:
diff changeset
2909 @vindex reftex-use-multiple-selection-buffers
Dave Love <fx@gnu.org>
parents:
diff changeset
2910 @lisp
Dave Love <fx@gnu.org>
parents:
diff changeset
2911 (setq reftex-use-multiple-selection-buffers t)
Dave Love <fx@gnu.org>
parents:
diff changeset
2912 @end lisp
Dave Love <fx@gnu.org>
parents:
diff changeset
2913
Dave Love <fx@gnu.org>
parents:
diff changeset
2914 @noindent
Dave Love <fx@gnu.org>
parents:
diff changeset
2915 @cindex Selection buffers, updating
Dave Love <fx@gnu.org>
parents:
diff changeset
2916 You can also inhibit the automatic updating entirely. Then the
Dave Love <fx@gnu.org>
parents:
diff changeset
2917 selection buffer will always pop up very fast, but may not contain the
Dave Love <fx@gnu.org>
parents:
diff changeset
2918 most recently defined labels. You can always update the buffer by hand,
Dave Love <fx@gnu.org>
parents:
diff changeset
2919 with the @kbd{g} key. To get this behavior, use instead@refill
Dave Love <fx@gnu.org>
parents:
diff changeset
2920
Dave Love <fx@gnu.org>
parents:
diff changeset
2921 @vindex reftex-auto-update-selection-buffers
Dave Love <fx@gnu.org>
parents:
diff changeset
2922 @lisp
Dave Love <fx@gnu.org>
parents:
diff changeset
2923 (setq reftex-use-multiple-selection-buffers t
Dave Love <fx@gnu.org>
parents:
diff changeset
2924 reftex-auto-update-selection-buffers nil)
Dave Love <fx@gnu.org>
parents:
diff changeset
2925 @end lisp
Dave Love <fx@gnu.org>
parents:
diff changeset
2926 @end itemize
Dave Love <fx@gnu.org>
parents:
diff changeset
2927
Dave Love <fx@gnu.org>
parents:
diff changeset
2928 @need 2000
Dave Love <fx@gnu.org>
parents:
diff changeset
2929 @noindent
Dave Love <fx@gnu.org>
parents:
diff changeset
2930 @b{As a summary}, here are the settings I recommend for heavy use of
Dave Love <fx@gnu.org>
parents:
diff changeset
2931 @b{Ref@TeX{}} with large documents:
Dave Love <fx@gnu.org>
parents:
diff changeset
2932
Dave Love <fx@gnu.org>
parents:
diff changeset
2933 @lisp
Dave Love <fx@gnu.org>
parents:
diff changeset
2934 @group
Dave Love <fx@gnu.org>
parents:
diff changeset
2935 (setq reftex-enable-partial-scans t
Dave Love <fx@gnu.org>
parents:
diff changeset
2936 reftex-save-parse-info t
Dave Love <fx@gnu.org>
parents:
diff changeset
2937 reftex-use-multiple-selection-buffers t)
Dave Love <fx@gnu.org>
parents:
diff changeset
2938 @end group
Dave Love <fx@gnu.org>
parents:
diff changeset
2939 @end lisp
Dave Love <fx@gnu.org>
parents:
diff changeset
2940
Dave Love <fx@gnu.org>
parents:
diff changeset
2941 @page
Dave Love <fx@gnu.org>
parents:
diff changeset
2942 @node AUCTeX, Multifile Documents, Faces, Top
Dave Love <fx@gnu.org>
parents:
diff changeset
2943 @section @w{AUC @TeX{}}
Dave Love <fx@gnu.org>
parents:
diff changeset
2944 @cindex @code{AUCTeX}, Emacs package
Dave Love <fx@gnu.org>
parents:
diff changeset
2945 @cindex Emacs packages, @code{AUCTeX}
Dave Love <fx@gnu.org>
parents:
diff changeset
2946
Dave Love <fx@gnu.org>
parents:
diff changeset
2947 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
2948 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
2949 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
2950 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
2951 XEmacs package.} by ftp from the
25829
Dave Love <fx@gnu.org>
parents:
diff changeset
2952 @uref{http://www.sunsite.auc.dk/auctex/,AUCTeX distribution site}.
Dave Love <fx@gnu.org>
parents:
diff changeset
2953
Dave Love <fx@gnu.org>
parents:
diff changeset
2954 @menu
Dave Love <fx@gnu.org>
parents:
diff changeset
2955 * AUCTeX-RefTeX Interface:: How both packages work together
Dave Love <fx@gnu.org>
parents:
diff changeset
2956 * Style Files:: AUCTeX's style files can support RefTeX
Dave Love <fx@gnu.org>
parents:
diff changeset
2957 * Bib-Cite:: Hypertext reading of a document
Dave Love <fx@gnu.org>
parents:
diff changeset
2958 @end menu
Dave Love <fx@gnu.org>
parents:
diff changeset
2959
Dave Love <fx@gnu.org>
parents:
diff changeset
2960 @node AUCTeX-RefTeX Interface, Style Files, , AUCTeX
Dave Love <fx@gnu.org>
parents:
diff changeset
2961 @subsection The AUC@TeX{}-@b{Ref@TeX{}} Interface
Dave Love <fx@gnu.org>
parents:
diff changeset
2962
Dave Love <fx@gnu.org>
parents:
diff changeset
2963 @b{Ref@TeX{}} contains code to interface with AUCTeX. When this
Dave Love <fx@gnu.org>
parents:
diff changeset
2964 interface is turned on, both packages will interact closely. Instead of
Dave Love <fx@gnu.org>
parents:
diff changeset
2965 using @b{Ref@TeX{}}'s commands directly, you can then also use them
Dave Love <fx@gnu.org>
parents:
diff changeset
2966 indirectly as part of the AUCTeX
Dave Love <fx@gnu.org>
parents:
diff changeset
2967 environment@footnote{@b{Ref@TeX{}} 4.0 and AUCTeX 9.10c will be
Dave Love <fx@gnu.org>
parents:
diff changeset
2968 needed for all of this to work. Parts of it work also with earlier
Dave Love <fx@gnu.org>
parents:
diff changeset
2969 versions.}. The interface is turned on with@refill
Dave Love <fx@gnu.org>
parents:
diff changeset
2970
Dave Love <fx@gnu.org>
parents:
diff changeset
2971 @lisp
Dave Love <fx@gnu.org>
parents:
diff changeset
2972 (setq reftex-plug-into-AUCTeX t)
Dave Love <fx@gnu.org>
parents:
diff changeset
2973 @end lisp
Dave Love <fx@gnu.org>
parents:
diff changeset
2974
Dave Love <fx@gnu.org>
parents:
diff changeset
2975 If you need finer control about which parts of the interface are used
Dave Love <fx@gnu.org>
parents:
diff changeset
2976 and which not, read the docstring of the variable
Dave Love <fx@gnu.org>
parents:
diff changeset
2977 @code{reftex-plug-into-AUCTeX} or customize it with @kbd{M-x
Dave Love <fx@gnu.org>
parents:
diff changeset
2978 customize-variable @key{RET} reftex-plug-into-AUCTeX @key{RET}}.
Dave Love <fx@gnu.org>
parents:
diff changeset
2979
Dave Love <fx@gnu.org>
parents:
diff changeset
2980 The following list describes the individual parts of the interface.
Dave Love <fx@gnu.org>
parents:
diff changeset
2981
Dave Love <fx@gnu.org>
parents:
diff changeset
2982 @itemize @bullet
Dave Love <fx@gnu.org>
parents:
diff changeset
2983 @item
Dave Love <fx@gnu.org>
parents:
diff changeset
2984 @findex reftex-label
Dave Love <fx@gnu.org>
parents:
diff changeset
2985 @vindex LaTeX-label-function, @r{AUCTeX}
Dave Love <fx@gnu.org>
parents:
diff changeset
2986 @kindex C-c C-e
Dave Love <fx@gnu.org>
parents:
diff changeset
2987 @kindex C-c C-s
Dave Love <fx@gnu.org>
parents:
diff changeset
2988 @findex LaTeX-section, @r{AUCTeX}
Dave Love <fx@gnu.org>
parents:
diff changeset
2989 @findex TeX-insert-macro, @r{AUCTeX}
Dave Love <fx@gnu.org>
parents:
diff changeset
2990 @b{AUCTeX calls @code{reftex-label} to insert labels}@*
Dave Love <fx@gnu.org>
parents:
diff changeset
2991 When a new section is created with @kbd{C-c C-s}, or a new environment
Dave Love <fx@gnu.org>
parents:
diff changeset
2992 is inserted with @kbd{C-c C-e}, AUCTeX normally prompts for a label to
Dave Love <fx@gnu.org>
parents:
diff changeset
2993 go with it. With the interface, @code{reftex-label} is called instead.
Dave Love <fx@gnu.org>
parents:
diff changeset
2994 For example, if you type @kbd{C-c C-e equation @key{RET}}, AUCTeX and
Dave Love <fx@gnu.org>
parents:
diff changeset
2995 @b{Ref@TeX{}} will insert
Dave Love <fx@gnu.org>
parents:
diff changeset
2996
Dave Love <fx@gnu.org>
parents:
diff changeset
2997 @example
Dave Love <fx@gnu.org>
parents:
diff changeset
2998 \begin@{equation@}
Dave Love <fx@gnu.org>
parents:
diff changeset
2999 \label@{eq:1@}
Dave Love <fx@gnu.org>
parents:
diff changeset
3000
Dave Love <fx@gnu.org>
parents:
diff changeset
3001 \end@{equation@}
Dave Love <fx@gnu.org>
parents:
diff changeset
3002 @end example
Dave Love <fx@gnu.org>
parents:
diff changeset
3003
Dave Love <fx@gnu.org>
parents:
diff changeset
3004 @noindent
Dave Love <fx@gnu.org>
parents:
diff changeset
3005 without further prompts.
Dave Love <fx@gnu.org>
parents:
diff changeset
3006
Dave Love <fx@gnu.org>
parents:
diff changeset
3007 Similarly, when you type @kbd{C-c C-s section @key{RET}}, @b{Ref@TeX{}}
Dave Love <fx@gnu.org>
parents:
diff changeset
3008 will offer its default label which is derived from the section title.
Dave Love <fx@gnu.org>
parents:
diff changeset
3009
Dave Love <fx@gnu.org>
parents:
diff changeset
3010 @item
Dave Love <fx@gnu.org>
parents:
diff changeset
3011 @b{AUCTeX tells @b{Ref@TeX{}} about new sections}@*
Dave Love <fx@gnu.org>
parents:
diff changeset
3012 When creating a new section with @kbd{C-c C-s}, @b{Ref@TeX{}} will not
Dave Love <fx@gnu.org>
parents:
diff changeset
3013 have to rescan the buffer in order to see it.@refill
Dave Love <fx@gnu.org>
parents:
diff changeset
3014
Dave Love <fx@gnu.org>
parents:
diff changeset
3015 @item
Dave Love <fx@gnu.org>
parents:
diff changeset
3016 @findex reftex-arg-label
Dave Love <fx@gnu.org>
parents:
diff changeset
3017 @findex TeX-arg-label, @r{AUCTeX function}
Dave Love <fx@gnu.org>
parents:
diff changeset
3018 @findex reftex-arg-ref
Dave Love <fx@gnu.org>
parents:
diff changeset
3019 @findex TeX-arg-ref, @r{AUCTeX function}
Dave Love <fx@gnu.org>
parents:
diff changeset
3020 @findex reftex-arg-cite
Dave Love <fx@gnu.org>
parents:
diff changeset
3021 @findex TeX-arg-cite, @r{AUCTeX function}
Dave Love <fx@gnu.org>
parents:
diff changeset
3022 @findex reftex-arg-index
Dave Love <fx@gnu.org>
parents:
diff changeset
3023 @findex TeX-arg-index, @r{AUCTeX function}
Dave Love <fx@gnu.org>
parents:
diff changeset
3024 @findex TeX-insert-macro, @r{AUCTeX function}
Dave Love <fx@gnu.org>
parents:
diff changeset
3025 @kindex C-c @key{RET}
Dave Love <fx@gnu.org>
parents:
diff changeset
3026 @b{@b{Ref@TeX{}} supplies macro arguments}@* When you insert a macro
Dave Love <fx@gnu.org>
parents:
diff changeset
3027 interactively with @kbd{C-c @key{RET}}, AUCTeX normally prompts for
Dave Love <fx@gnu.org>
parents:
diff changeset
3028 macro arguments. Internally, it uses the functions
Dave Love <fx@gnu.org>
parents:
diff changeset
3029 @code{TeX-arg-label}, @code{TeX-arg-cite}, and @code{TeX-arg-index} to
Dave Love <fx@gnu.org>
parents:
diff changeset
3030 prompt for arguments which are labels, citation keys and index entries.
Dave Love <fx@gnu.org>
parents:
diff changeset
3031 The interface takes over these functions@footnote{@code{fset} is used to
Dave Love <fx@gnu.org>
parents:
diff changeset
3032 do this, which is not reversible. However, @b{Ref@TeX{}} implements the
Dave Love <fx@gnu.org>
parents:
diff changeset
3033 old functionality when you later decide to turn off the interface.} and
Dave Love <fx@gnu.org>
parents:
diff changeset
3034 supplies the macro arguments with @b{Ref@TeX{}'s} mechanisms. For
Dave Love <fx@gnu.org>
parents:
diff changeset
3035 example, when you type @kbd{C-c @key{RET} ref @key{RET}}, @b{Ref@TeX{}}
Dave Love <fx@gnu.org>
parents:
diff changeset
3036 will supply its label selection process (@pxref{Referencing
Dave Love <fx@gnu.org>
parents:
diff changeset
3037 Labels}).@refill
Dave Love <fx@gnu.org>
parents:
diff changeset
3038
Dave Love <fx@gnu.org>
parents:
diff changeset
3039 @item
Dave Love <fx@gnu.org>
parents:
diff changeset
3040 @b{@b{Ref@TeX{}} tells AUCTeX about new labels, citation-- and index keys}@*
Dave Love <fx@gnu.org>
parents:
diff changeset
3041 @b{Ref@TeX{}} will add all newly created labels to AUCTeX's completion list.
Dave Love <fx@gnu.org>
parents:
diff changeset
3042 @end itemize
Dave Love <fx@gnu.org>
parents:
diff changeset
3043
Dave Love <fx@gnu.org>
parents:
diff changeset
3044 @node Style Files, Bib-Cite, AUCTeX-RefTeX Interface, AUCTeX
Dave Love <fx@gnu.org>
parents:
diff changeset
3045 @subsection Style Files
Dave Love <fx@gnu.org>
parents:
diff changeset
3046 @cindex Style files, AUCTeX
Dave Love <fx@gnu.org>
parents:
diff changeset
3047 @findex TeX-add-style-hook, @r{AUCTeX}
Dave Love <fx@gnu.org>
parents:
diff changeset
3048 Style files are Emacs Lisp files which are evaluated by AUCTeX in
Dave Love <fx@gnu.org>
parents:
diff changeset
3049 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
3050 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
3051 @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
3052 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
3053 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
3054 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
3055 way.@refill
25829
Dave Love <fx@gnu.org>
parents:
diff changeset
3056
Dave Love <fx@gnu.org>
parents:
diff changeset
3057 Before calling a @b{Ref@TeX{}} function, the style hook should always
Dave Love <fx@gnu.org>
parents:
diff changeset
3058 test for the availability of the function, so that the style file will
Dave Love <fx@gnu.org>
parents:
diff changeset
3059 also work for people who do not use @b{Ref@TeX{}}. @refill
Dave Love <fx@gnu.org>
parents:
diff changeset
3060
Dave Love <fx@gnu.org>
parents:
diff changeset
3061 Additions made with style files in the way described below remain local
Dave Love <fx@gnu.org>
parents:
diff changeset
3062 to the current document. For example, if one package uses AMSTeX, the
Dave Love <fx@gnu.org>
parents:
diff changeset
3063 style file will make @b{Ref@TeX{}} switch over to @code{\eqref}, but
Dave Love <fx@gnu.org>
parents:
diff changeset
3064 this will not affect other documents.@refill
Dave Love <fx@gnu.org>
parents:
diff changeset
3065
Dave Love <fx@gnu.org>
parents:
diff changeset
3066 @findex reftex-add-label-environments
Dave Love <fx@gnu.org>
parents:
diff changeset
3067 @findex reftex-add-to-label-alist
Dave Love <fx@gnu.org>
parents:
diff changeset
3068 A style hook may contain calls to
Dave Love <fx@gnu.org>
parents:
diff changeset
3069 @code{reftex-add-label-environments}@footnote{This used to be the
Dave Love <fx@gnu.org>
parents:
diff changeset
3070 function @code{reftex-add-to-label-alist} which is still available as an
Dave Love <fx@gnu.org>
parents:
diff changeset
3071 alias for compatibility.} which defines additions to
Dave Love <fx@gnu.org>
parents:
diff changeset
3072 @code{reftex-label-alist}. The argument taken by this function must have
Dave Love <fx@gnu.org>
parents:
diff changeset
3073 the same format as @code{reftex-label-alist}. The @file{amsmath.el}
Dave Love <fx@gnu.org>
parents:
diff changeset
3074 style file of AUCTeX for example contains the following:@refill
Dave Love <fx@gnu.org>
parents:
diff changeset
3075
Dave Love <fx@gnu.org>
parents:
diff changeset
3076 @lisp
Dave Love <fx@gnu.org>
parents:
diff changeset
3077 @group
Dave Love <fx@gnu.org>
parents:
diff changeset
3078 (TeX-add-style-hook "amsmath"
Dave Love <fx@gnu.org>
parents:
diff changeset
3079 (lambda ()
Dave Love <fx@gnu.org>
parents:
diff changeset
3080 (if (fboundp 'reftex-add-label-environments)
Dave Love <fx@gnu.org>
parents:
diff changeset
3081 (reftex-add-label-environments '(AMSTeX)))))
Dave Love <fx@gnu.org>
parents:
diff changeset
3082 @end group
Dave Love <fx@gnu.org>
parents:
diff changeset
3083 @end lisp
Dave Love <fx@gnu.org>
parents:
diff changeset
3084
Dave Love <fx@gnu.org>
parents:
diff changeset
3085 @noindent
Dave Love <fx@gnu.org>
parents:
diff changeset
3086 @findex LaTeX-add-environments, @r{AUCTeX}
Dave Love <fx@gnu.org>
parents:
diff changeset
3087 while a package @code{myprop} defining a @code{proposition} environment
Dave Love <fx@gnu.org>
parents:
diff changeset
3088 with @code{\newtheorem} might use@refill
Dave Love <fx@gnu.org>
parents:
diff changeset
3089
Dave Love <fx@gnu.org>
parents:
diff changeset
3090 @lisp
Dave Love <fx@gnu.org>
parents:
diff changeset
3091 @group
Dave Love <fx@gnu.org>
parents:
diff changeset
3092 (TeX-add-style-hook "myprop"
Dave Love <fx@gnu.org>
parents:
diff changeset
3093 (lambda ()
Dave Love <fx@gnu.org>
parents:
diff changeset
3094 (LaTeX-add-environments '("proposition" LaTeX-env-label))
Dave Love <fx@gnu.org>
parents:
diff changeset
3095 (if (fboundp 'reftex-add-label-environments)
Dave Love <fx@gnu.org>
parents:
diff changeset
3096 (reftex-add-label-environments
Dave Love <fx@gnu.org>
parents:
diff changeset
3097 '(("proposition" ?p "prop:" "~\\ref@{%s@}" t
26911
d7f536a01276 Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents: 25829
diff changeset
3098 ("Proposition" "Prop.") -3))))))
25829
Dave Love <fx@gnu.org>
parents:
diff changeset
3099 @end group
Dave Love <fx@gnu.org>
parents:
diff changeset
3100 @end lisp
Dave Love <fx@gnu.org>
parents:
diff changeset
3101
Dave Love <fx@gnu.org>
parents:
diff changeset
3102 @findex reftex-set-cite-format
Dave Love <fx@gnu.org>
parents:
diff changeset
3103 Similarly, a style hook may contain a call to
Dave Love <fx@gnu.org>
parents:
diff changeset
3104 @code{reftex-set-cite-format} to set the citation format. The style
Dave Love <fx@gnu.org>
parents:
diff changeset
3105 file @file{natbib.el} for the Natbib citation style does switch
Dave Love <fx@gnu.org>
parents:
diff changeset
3106 @b{Ref@TeX{}}'s citation format like this:@refill
Dave Love <fx@gnu.org>
parents:
diff changeset
3107
Dave Love <fx@gnu.org>
parents:
diff changeset
3108 @lisp
Dave Love <fx@gnu.org>
parents:
diff changeset
3109 (TeX-add-style-hook "natbib"
Dave Love <fx@gnu.org>
parents:
diff changeset
3110 (lambda ()
Dave Love <fx@gnu.org>
parents:
diff changeset
3111 (if (fboundp 'reftex-set-cite-format)
Dave Love <fx@gnu.org>
parents:
diff changeset
3112 (reftex-set-cite-format 'natbib))))
Dave Love <fx@gnu.org>
parents:
diff changeset
3113 @end lisp
Dave Love <fx@gnu.org>
parents:
diff changeset
3114
Dave Love <fx@gnu.org>
parents:
diff changeset
3115 @findex reftex-add-index-macros
Dave Love <fx@gnu.org>
parents:
diff changeset
3116 The hook may contain a call to @code{reftex-add-index-macros} to
Dave Love <fx@gnu.org>
parents:
diff changeset
3117 define additional @code{\index}-like macros. The argument must have
Dave Love <fx@gnu.org>
parents:
diff changeset
3118 the same format as @code{reftex-index-macros}. It may be a symbol, to
Dave Love <fx@gnu.org>
parents:
diff changeset
3119 trigger support for one of the builtin index packages. For example,
Dave Love <fx@gnu.org>
parents:
diff changeset
3120 the style @file{multind.el} contains
Dave Love <fx@gnu.org>
parents:
diff changeset
3121
Dave Love <fx@gnu.org>
parents:
diff changeset
3122 @lisp
Dave Love <fx@gnu.org>
parents:
diff changeset
3123 (TeX-add-style-hook "multind"
Dave Love <fx@gnu.org>
parents:
diff changeset
3124 (lambda ()
Dave Love <fx@gnu.org>
parents:
diff changeset
3125 (and (fboundp 'reftex-add-index-macros)
Dave Love <fx@gnu.org>
parents:
diff changeset
3126 (reftex-add-index-macros '(multind)))))
Dave Love <fx@gnu.org>
parents:
diff changeset
3127 @end lisp
Dave Love <fx@gnu.org>
parents:
diff changeset
3128
Dave Love <fx@gnu.org>
parents:
diff changeset
3129 If you have your own package @file{myindex} which defines the
Dave Love <fx@gnu.org>
parents:
diff changeset
3130 following macros to be used with the LaTeX @file{index.sty} file
Dave Love <fx@gnu.org>
parents:
diff changeset
3131 @example
Dave Love <fx@gnu.org>
parents:
diff changeset
3132 \newcommand@{\molec@}[1]@{#1\index@{Molecules!#1@}@}
Dave Love <fx@gnu.org>
parents:
diff changeset
3133 \newcommand@{\aindex@}[1]@{#1\index[author]@{#1@}
Dave Love <fx@gnu.org>
parents:
diff changeset
3134 @end example
Dave Love <fx@gnu.org>
parents:
diff changeset
3135
Dave Love <fx@gnu.org>
parents:
diff changeset
3136 you could write this in the style file @file{myindex.el}:
Dave Love <fx@gnu.org>
parents:
diff changeset
3137
Dave Love <fx@gnu.org>
parents:
diff changeset
3138 @lisp
Dave Love <fx@gnu.org>
parents:
diff changeset
3139 (TeX-add-style-hook "myindex"
Dave Love <fx@gnu.org>
parents:
diff changeset
3140 (lambda ()
Dave Love <fx@gnu.org>
parents:
diff changeset
3141 (TeX-add-symbols
Dave Love <fx@gnu.org>
parents:
diff changeset
3142 '("molec" TeX-arg-index)
Dave Love <fx@gnu.org>
parents:
diff changeset
3143 '("aindex" TeX-arg-index))
Dave Love <fx@gnu.org>
parents:
diff changeset
3144 (if (fboundp 'reftex-add-index-macros)
Dave Love <fx@gnu.org>
parents:
diff changeset
3145 (reftex-add-index-macros
26911
d7f536a01276 Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents: 25829
diff changeset
3146 '(("molec@{*@}" "idx" ?m "Molecules!" nil nil)
d7f536a01276 Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents: 25829
diff changeset
3147 ("aindex@{*@}" "author" ?a "" nil nil))))))
25829
Dave Love <fx@gnu.org>
parents:
diff changeset
3148 @end lisp
Dave Love <fx@gnu.org>
parents:
diff changeset
3149
Dave Love <fx@gnu.org>
parents:
diff changeset
3150 @findex reftex-add-section-levels
Dave Love <fx@gnu.org>
parents:
diff changeset
3151 Finally the hook may contain a call to @code{reftex-add-section-levels}
Dave Love <fx@gnu.org>
parents:
diff changeset
3152 to define additional section statements. For example, the FoilTeX class
Dave Love <fx@gnu.org>
parents:
diff changeset
3153 has just two headers, @code{\foilhead} and @code{\rotatefoilhead}. Here
Dave Love <fx@gnu.org>
parents:
diff changeset
3154 is a style file @file{foils.el} that will inform @b{Ref@TeX{}} about these:
Dave Love <fx@gnu.org>
parents:
diff changeset
3155
Dave Love <fx@gnu.org>
parents:
diff changeset
3156 @lisp
Dave Love <fx@gnu.org>
parents:
diff changeset
3157 (TeX-add-style-hook "foils"
Dave Love <fx@gnu.org>
parents:
diff changeset
3158 (lambda ()
Dave Love <fx@gnu.org>
parents:
diff changeset
3159 (if (fboundp 'reftex-add-section-levels)
Dave Love <fx@gnu.org>
parents:
diff changeset
3160 (reftex-add-section-levels '(("foilhead" . 3)
Dave Love <fx@gnu.org>
parents:
diff changeset
3161 ("rotatefoilhead" . 3))))))
Dave Love <fx@gnu.org>
parents:
diff changeset
3162 @end lisp
Dave Love <fx@gnu.org>
parents:
diff changeset
3163
Dave Love <fx@gnu.org>
parents:
diff changeset
3164 @node Bib-Cite, , Style Files, AUCTeX
Dave Love <fx@gnu.org>
parents:
diff changeset
3165 @subsection Bib-Cite
Dave Love <fx@gnu.org>
parents:
diff changeset
3166 @cindex @code{bib-cite}, Emacs package
Dave Love <fx@gnu.org>
parents:
diff changeset
3167 @cindex Emacs packages, @code{bib-cite}
Dave Love <fx@gnu.org>
parents:
diff changeset
3168
Dave Love <fx@gnu.org>
parents:
diff changeset
3169 Once you have written a document with labels, references and citations,
Dave Love <fx@gnu.org>
parents:
diff changeset
3170 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
3171 support for that: @code{reftex-view-crossref} (bound to @kbd{C-c
37999
8e7df927fd92 Updated to version 4.16
Carsten Dominik <dominik@science.uva.nl>
parents: 37404
diff changeset
3172 &}), @code{reftex-mouse-view-crossref} (bound to @kbd{S-mouse-2}), and
25829
Dave Love <fx@gnu.org>
parents:
diff changeset
3173 @code{reftex-search-document}. A somewhat fancier interface with mouse
Dave Love <fx@gnu.org>
parents:
diff changeset
3174 highlighting is provided (among other things) by Peter S. Galbraith's
Dave Love <fx@gnu.org>
parents:
diff changeset
3175 @file{bib-cite.el}. There is some overlap in the functionalities of
Dave Love <fx@gnu.org>
parents:
diff changeset
3176 Bib-cite and @b{Ref@TeX{}}. Bib-cite.el comes bundled with
Dave Love <fx@gnu.org>
parents:
diff changeset
3177 AUCTeX.@refill
Dave Love <fx@gnu.org>
parents:
diff changeset
3178
Dave Love <fx@gnu.org>
parents:
diff changeset
3179 Bib-cite version 3.06 and later can be configured so that bib-cite's
Dave Love <fx@gnu.org>
parents:
diff changeset
3180 mouse functions use @b{Ref@TeX{}} for displaying references and citations.
Dave Love <fx@gnu.org>
parents:
diff changeset
3181 This can be useful in particular when working with the LaTeX @code{xr}
Dave Love <fx@gnu.org>
parents:
diff changeset
3182 package or with an explicit @code{thebibliography} environment (rather
Dave Love <fx@gnu.org>
parents:
diff changeset
3183 than BibTeX). Bib-cite cannot handle those, but @b{Ref@TeX{}} does. To
Dave Love <fx@gnu.org>
parents:
diff changeset
3184 make use of this feature, try@refill
Dave Love <fx@gnu.org>
parents:
diff changeset
3185
Dave Love <fx@gnu.org>
parents:
diff changeset
3186 @vindex bib-cite-use-reftex-view-crossref
Dave Love <fx@gnu.org>
parents:
diff changeset
3187 @lisp
Dave Love <fx@gnu.org>
parents:
diff changeset
3188 (setq bib-cite-use-reftex-view-crossref t)
Dave Love <fx@gnu.org>
parents:
diff changeset
3189 @end lisp
Dave Love <fx@gnu.org>
parents:
diff changeset
3190
Dave Love <fx@gnu.org>
parents:
diff changeset
3191 @page
Dave Love <fx@gnu.org>
parents:
diff changeset
3192 @node Problems and Work-Arounds, Imprint, Optimizations, Top
Dave Love <fx@gnu.org>
parents:
diff changeset
3193 @section Problems and Work-arounds
Dave Love <fx@gnu.org>
parents:
diff changeset
3194 @cindex Problems and work-arounds
Dave Love <fx@gnu.org>
parents:
diff changeset
3195
Dave Love <fx@gnu.org>
parents:
diff changeset
3196 @itemize @bullet
Dave Love <fx@gnu.org>
parents:
diff changeset
3197 @item
Dave Love <fx@gnu.org>
parents:
diff changeset
3198 @b{LaTeX commands}@*
Dave Love <fx@gnu.org>
parents:
diff changeset
3199 @cindex LaTeX commands, not found
Dave Love <fx@gnu.org>
parents:
diff changeset
3200 @code{\input}, @code{\include}, @code{\bibliography} and @code{\section}
Dave Love <fx@gnu.org>
parents:
diff changeset
3201 (etc.) statements have to be first on a line (except for white space).@refill
Dave Love <fx@gnu.org>
parents:
diff changeset
3202
Dave Love <fx@gnu.org>
parents:
diff changeset
3203 @item
Dave Love <fx@gnu.org>
parents:
diff changeset
3204 @b{Commented regions}@*
Dave Love <fx@gnu.org>
parents:
diff changeset
3205 @cindex Labels, commented out
Dave Love <fx@gnu.org>
parents:
diff changeset
3206 @b{Ref@TeX{}} sees also labels in regions commented out and will refuse to
Dave Love <fx@gnu.org>
parents:
diff changeset
3207 make duplicates of such labels. This is considered to be a feature.@refill
Dave Love <fx@gnu.org>
parents:
diff changeset
3208
Dave Love <fx@gnu.org>
parents:
diff changeset
3209 @item
Dave Love <fx@gnu.org>
parents:
diff changeset
3210 @b{Wrong section numbers}@*
Dave Love <fx@gnu.org>
parents:
diff changeset
3211 @cindex Section numbers, wrong
Dave Love <fx@gnu.org>
parents:
diff changeset
3212 @vindex reftex-enable-partial-scans
Dave Love <fx@gnu.org>
parents:
diff changeset
3213 When using partial scans (@code{reftex-enable-partial-scans}), the section
Dave Love <fx@gnu.org>
parents:
diff changeset
3214 numbers in the table of contents may eventually become wrong. A full
Dave Love <fx@gnu.org>
parents:
diff changeset
3215 scan will fix this.@refill
Dave Love <fx@gnu.org>
parents:
diff changeset
3216
Dave Love <fx@gnu.org>
parents:
diff changeset
3217 @item
Dave Love <fx@gnu.org>
parents:
diff changeset
3218 @b{Local settings}@*
Dave Love <fx@gnu.org>
parents:
diff changeset
3219 @cindex Settings, local
Dave Love <fx@gnu.org>
parents:
diff changeset
3220 @findex reftex-add-label-environments
Dave Love <fx@gnu.org>
parents:
diff changeset
3221 @findex reftex-set-cite-format
Dave Love <fx@gnu.org>
parents:
diff changeset
3222 @findex reftex-add-section-levels
Dave Love <fx@gnu.org>
parents:
diff changeset
3223 The label environment definitions in @code{reftex-label-alist} are
Dave Love <fx@gnu.org>
parents:
diff changeset
3224 global and apply to all documents. If you need to make definitions
Dave Love <fx@gnu.org>
parents:
diff changeset
3225 local to a document, because they would interfere with settings in other
Dave Love <fx@gnu.org>
parents:
diff changeset
3226 documents, you should use AUCTeX and set up style files with calls to
Dave Love <fx@gnu.org>
parents:
diff changeset
3227 @code{reftex-add-label-environments}, @code{reftex-set-cite-format},
Dave Love <fx@gnu.org>
parents:
diff changeset
3228 @code{reftex-add-index-macros}, and @code{reftex-add-section-levels}.
Dave Love <fx@gnu.org>
parents:
diff changeset
3229 Settings made with these functions remain local to the current
Dave Love <fx@gnu.org>
parents:
diff changeset
3230 document. @xref{AUCTeX}.@refill
Dave Love <fx@gnu.org>
parents:
diff changeset
3231
Dave Love <fx@gnu.org>
parents:
diff changeset
3232 @item
Dave Love <fx@gnu.org>
parents:
diff changeset
3233 @b{Funny display in selection buffer}@*
Dave Love <fx@gnu.org>
parents:
diff changeset
3234 @cindex @code{x-symbol}, Emacs package
Dave Love <fx@gnu.org>
parents:
diff changeset
3235 @cindex Emacs packages, @code{x-symbol}
Dave Love <fx@gnu.org>
parents:
diff changeset
3236 @cindex @code{isotex}, Emacs package
Dave Love <fx@gnu.org>
parents:
diff changeset
3237 @cindex Emacs packages, @code{isotex}
Dave Love <fx@gnu.org>
parents:
diff changeset
3238 @cindex @code{iso-cvt}, Emacs package
Dave Love <fx@gnu.org>
parents:
diff changeset
3239 @cindex Emacs packages, @code{iso-cvt}
Dave Love <fx@gnu.org>
parents:
diff changeset
3240 When using packages which make the buffer representation of a file
Dave Love <fx@gnu.org>
parents:
diff changeset
3241 different from its disk representation (e.g. x-symbol, isotex,
Dave Love <fx@gnu.org>
parents:
diff changeset
3242 iso-cvt) you may find that @b{Ref@TeX{}}'s parsing information sometimes
Dave Love <fx@gnu.org>
parents:
diff changeset
3243 reflects the disk state of a file. This happens only in @emph{unvisited}
Dave Love <fx@gnu.org>
parents:
diff changeset
3244 parts of a multifile document, because @b{Ref@TeX{}} visits these files
Dave Love <fx@gnu.org>
parents:
diff changeset
3245 literally for speed reasons. Then both short context and section
Dave Love <fx@gnu.org>
parents:
diff changeset
3246 headings may look different from what you usually see on your screen.
Dave Love <fx@gnu.org>
parents:
diff changeset
3247 In rare cases @code{reftex-toc} may have problems to jump to an affected
Dave Love <fx@gnu.org>
parents:
diff changeset
3248 section heading. There are three possible ways to deal with
Dave Love <fx@gnu.org>
parents:
diff changeset
3249 this:@refill
Dave Love <fx@gnu.org>
parents:
diff changeset
3250 @itemize @minus
Dave Love <fx@gnu.org>
parents:
diff changeset
3251 @item
Dave Love <fx@gnu.org>
parents:
diff changeset
3252 @vindex reftex-keep-temporary-buffers
Dave Love <fx@gnu.org>
parents:
diff changeset
3253 @code{(setq reftex-keep-temporary-buffers t)}@*
Dave Love <fx@gnu.org>
parents:
diff changeset
3254 This implies that @b{Ref@TeX{}} will load all parts of a multifile
Dave Love <fx@gnu.org>
parents:
diff changeset
3255 document into Emacs (i.e. there won't be any temporary buffers).@refill
Dave Love <fx@gnu.org>
parents:
diff changeset
3256 @item
Dave Love <fx@gnu.org>
parents:
diff changeset
3257 @vindex reftex-initialize-temporary-buffers
Dave Love <fx@gnu.org>
parents:
diff changeset
3258 @code{(setq reftex-initialize-temporary-buffers t)}@*
Dave Love <fx@gnu.org>
parents:
diff changeset
3259 This means full initialization of temporary buffers. It involves
Dave Love <fx@gnu.org>
parents:
diff changeset
3260 a penalty when the same unvisited file is used for lookup often.@refill
Dave Love <fx@gnu.org>
parents:
diff changeset
3261 @item
Dave Love <fx@gnu.org>
parents:
diff changeset
3262 Set @code{reftex-initialize-temporary-buffers} to a list of hook
Dave Love <fx@gnu.org>
parents:
diff changeset
3263 functions doing a minimal initialization.@refill
Dave Love <fx@gnu.org>
parents:
diff changeset
3264 @end itemize
Dave Love <fx@gnu.org>
parents:
diff changeset
3265 @vindex reftex-refontify-context
Dave Love <fx@gnu.org>
parents:
diff changeset
3266 See also the variable @code{reftex-refontify-context}.
Dave Love <fx@gnu.org>
parents:
diff changeset
3267
Dave Love <fx@gnu.org>
parents:
diff changeset
3268 @item
Dave Love <fx@gnu.org>
parents:
diff changeset
3269 @b{Labels as arguments to \begin}@*
Dave Love <fx@gnu.org>
parents:
diff changeset
3270 @cindex @code{pf}, LaTeX package
Dave Love <fx@gnu.org>
parents:
diff changeset
3271 @cindex LaTeX packages, @code{pf}
Dave Love <fx@gnu.org>
parents:
diff changeset
3272 Some packages use an additional argument to a @code{\begin} macro
Dave Love <fx@gnu.org>
parents:
diff changeset
3273 to specify a label. E.g. Lamport's @file{pf.sty} uses both
Dave Love <fx@gnu.org>
parents:
diff changeset
3274 @example
Dave Love <fx@gnu.org>
parents:
diff changeset
3275 \step@{@var{label}@}@{@var{claim}@} and \begin@{step+@}@{@var{label}@}
Dave Love <fx@gnu.org>
parents:
diff changeset
3276 @var{claim}
Dave Love <fx@gnu.org>
parents:
diff changeset
3277 \end@{step+@}
Dave Love <fx@gnu.org>
parents:
diff changeset
3278 @end example
Dave Love <fx@gnu.org>
parents:
diff changeset
3279
Dave Love <fx@gnu.org>
parents:
diff changeset
3280 @noindent
Dave Love <fx@gnu.org>
parents:
diff changeset
3281 We need to trick @b{Ref@TeX{}} into swallowing this:
Dave Love <fx@gnu.org>
parents:
diff changeset
3282
Dave Love <fx@gnu.org>
parents:
diff changeset
3283 @lisp
Dave Love <fx@gnu.org>
parents:
diff changeset
3284 @group
Dave Love <fx@gnu.org>
parents:
diff changeset
3285 ;; Configuration for Lamport's pf.sty
Dave Love <fx@gnu.org>
parents:
diff changeset
3286 (setq reftex-label-alist
26911
d7f536a01276 Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents: 25829
diff changeset
3287 '(("\\step@{*@}@{@}" ?p "st:" "~\\stepref@{%s@}" 2 ("Step" "St."))
d7f536a01276 Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents: 25829
diff changeset
3288 ("\\begin@{step+@}@{*@}" ?p "st:" "~\\stepref@{%s@}" 1000)))
25829
Dave Love <fx@gnu.org>
parents:
diff changeset
3289 @end group
Dave Love <fx@gnu.org>
parents:
diff changeset
3290 @end lisp
Dave Love <fx@gnu.org>
parents:
diff changeset
3291
Dave Love <fx@gnu.org>
parents:
diff changeset
3292 @noindent
Dave Love <fx@gnu.org>
parents:
diff changeset
3293 The first line is just a normal configuration for a macro. For the
Dave Love <fx@gnu.org>
parents:
diff changeset
3294 @code{step+} environment we actually tell @b{Ref@TeX{}} to look for the
Dave Love <fx@gnu.org>
parents:
diff changeset
3295 @emph{macro} @samp{\begin@{step+@}} and interpret the @emph{first}
Dave Love <fx@gnu.org>
parents:
diff changeset
3296 argument (which really is a second argument to the macro @code{\begin})
Dave Love <fx@gnu.org>
parents:
diff changeset
3297 as a label of type @code{?p}. Argument count for this macro starts only
Dave Love <fx@gnu.org>
parents:
diff changeset
3298 after the @samp{@{step+@}}, also when specifying how to get
Dave Love <fx@gnu.org>
parents:
diff changeset
3299 context.@refill
Dave Love <fx@gnu.org>
parents:
diff changeset
3300
Dave Love <fx@gnu.org>
parents:
diff changeset
3301 @item
Dave Love <fx@gnu.org>
parents:
diff changeset
3302 @b{Idle timers in XEmacs}@*
Dave Love <fx@gnu.org>
parents:
diff changeset
3303 @cindex Idle timer restart
Dave Love <fx@gnu.org>
parents:
diff changeset
3304 @vindex reftex-use-itimer-in-xemacs
Dave Love <fx@gnu.org>
parents:
diff changeset
3305 In XEmacs, idle timer restart does not work reliably after fast
Dave Love <fx@gnu.org>
parents:
diff changeset
3306 keystrokes. Therefore @b{Ref@TeX{}} currently uses the post command
Dave Love <fx@gnu.org>
parents:
diff changeset
3307 hook to start the timer used for automatic crossref information. When
Dave Love <fx@gnu.org>
parents:
diff changeset
3308 this bug gets fixed, a real idle timer can be requested with
Dave Love <fx@gnu.org>
parents:
diff changeset
3309 @lisp
Dave Love <fx@gnu.org>
parents:
diff changeset
3310 (setq reftex-use-itimer-in-xemacs t)
Dave Love <fx@gnu.org>
parents:
diff changeset
3311 @end lisp
Dave Love <fx@gnu.org>
parents:
diff changeset
3312
Dave Love <fx@gnu.org>
parents:
diff changeset
3313 @item
Dave Love <fx@gnu.org>
parents:
diff changeset
3314 @b{Viper mode}@*
Dave Love <fx@gnu.org>
parents:
diff changeset
3315 @cindex Viper mode
39267
a8c0a02f6129 Spelling corrections.
Richard M. Stallman <rms@gnu.org>
parents: 38003
diff changeset
3316 @cindex Key bindings, problems with Viper mode
25829
Dave Love <fx@gnu.org>
parents:
diff changeset
3317 @findex viper-harness-minor-mode
Dave Love <fx@gnu.org>
parents:
diff changeset
3318 With @i{Viper} mode prior to Vipers version 3.01, you need to protect
Dave Love <fx@gnu.org>
parents:
diff changeset
3319 @b{Ref@TeX{}}'s keymaps with@refill
Dave Love <fx@gnu.org>
parents:
diff changeset
3320
Dave Love <fx@gnu.org>
parents:
diff changeset
3321 @lisp
Dave Love <fx@gnu.org>
parents:
diff changeset
3322 (viper-harness-minor-mode "reftex")
Dave Love <fx@gnu.org>
parents:
diff changeset
3323 @end lisp
Dave Love <fx@gnu.org>
parents:
diff changeset
3324
Dave Love <fx@gnu.org>
parents:
diff changeset
3325 @end itemize
Dave Love <fx@gnu.org>
parents:
diff changeset
3326
Dave Love <fx@gnu.org>
parents:
diff changeset
3327 @page
Dave Love <fx@gnu.org>
parents:
diff changeset
3328 @node Imprint, Commands, Problems and Work-Arounds, Top
Dave Love <fx@gnu.org>
parents:
diff changeset
3329 @section Imprint
Dave Love <fx@gnu.org>
parents:
diff changeset
3330 @cindex Imprint
Dave Love <fx@gnu.org>
parents:
diff changeset
3331 @cindex Maintainer
Dave Love <fx@gnu.org>
parents:
diff changeset
3332 @cindex Acknowledgments
Dave Love <fx@gnu.org>
parents:
diff changeset
3333 @cindex Thanks
Dave Love <fx@gnu.org>
parents:
diff changeset
3334 @cindex Bug reports
Dave Love <fx@gnu.org>
parents:
diff changeset
3335 @cindex @code{http}, @b{Ref@TeX{}} home page
Dave Love <fx@gnu.org>
parents:
diff changeset
3336 @cindex @code{ftp}, @b{Ref@TeX{}} site
Dave Love <fx@gnu.org>
parents:
diff changeset
3337
Dave Love <fx@gnu.org>
parents:
diff changeset
3338 @b{Ref@TeX{}} was written by @i{@value{AUTHOR}}
Dave Love <fx@gnu.org>
parents:
diff changeset
3339 @email{@value{AUTHOR-EMAIL}}, with contributions by @i{Stephen
Dave Love <fx@gnu.org>
parents:
diff changeset
3340 Eglen}. @b{Ref@TeX{}} is currently maintained by @refill
Dave Love <fx@gnu.org>
parents:
diff changeset
3341
Dave Love <fx@gnu.org>
parents:
diff changeset
3342 @noindent
Dave Love <fx@gnu.org>
parents:
diff changeset
3343 @value{MAINTAINER} @email{@value{MAINTAINER-EMAIL}}
Dave Love <fx@gnu.org>
parents:
diff changeset
3344
Dave Love <fx@gnu.org>
parents:
diff changeset
3345 If you have questions about @b{Ref@TeX{}}, there are several Usenet
Dave Love <fx@gnu.org>
parents:
diff changeset
3346 groups which have competent readers: @code{comp.emacs},
Dave Love <fx@gnu.org>
parents:
diff changeset
3347 @code{gnu.emacs.help}, @code{comp.emacs.xemacs}, @code{comp.text.tex}.
Dave Love <fx@gnu.org>
parents:
diff changeset
3348 You can also write directly to the maintainer.
Dave Love <fx@gnu.org>
parents:
diff changeset
3349
Dave Love <fx@gnu.org>
parents:
diff changeset
3350 If you find a bug in @b{Ref@TeX{}} or its documentation, or if you want
Dave Love <fx@gnu.org>
parents:
diff changeset
3351 to contribute code or ideas, please
Dave Love <fx@gnu.org>
parents:
diff changeset
3352 @uref{mailto:@value{MAINTAINER-EMAIL},contact the maintainer}. Remember
Dave Love <fx@gnu.org>
parents:
diff changeset
3353 to provide all necessary information such as version numbers of Emacs
Dave Love <fx@gnu.org>
parents:
diff changeset
3354 and @b{Ref@TeX{}}, and the relevant part of your configuration in
Dave Love <fx@gnu.org>
parents:
diff changeset
3355 @file{.emacs}. When reporting a bug which throws an exception, please
Dave Love <fx@gnu.org>
parents:
diff changeset
3356 include a backtrace if you know how to produce one.
Dave Love <fx@gnu.org>
parents:
diff changeset
3357
Dave Love <fx@gnu.org>
parents:
diff changeset
3358 @b{Ref@TeX{}} is bundled and pre-installed with Emacs since version 20.2.
Dave Love <fx@gnu.org>
parents:
diff changeset
3359 It was also bundled and pre-installed with XEmacs 19.16--20.x. XEmacs
Dave Love <fx@gnu.org>
parents:
diff changeset
3360 21.x users want to install the corresponding plugin package which is
Dave Love <fx@gnu.org>
parents:
diff changeset
3361 available from the XEmacs @code{ftp} site. See the XEmacs 21.x
Dave Love <fx@gnu.org>
parents:
diff changeset
3362 documentation on package installation for details.@refill
Dave Love <fx@gnu.org>
parents:
diff changeset
3363
Dave Love <fx@gnu.org>
parents:
diff changeset
3364 Users of earlier Emacs distributions (including Emacs 19) can get a
Dave Love <fx@gnu.org>
parents:
diff changeset
3365 @b{Ref@TeX{}} distribution from the
Dave Love <fx@gnu.org>
parents:
diff changeset
3366 @uref{http://www.strw.leidenuniv.nl/~dominik/Tools/,maintainers
Dave Love <fx@gnu.org>
parents:
diff changeset
3367 webpage}. Note that the Emacs 19 version supports many but not all
Dave Love <fx@gnu.org>
parents:
diff changeset
3368 features described in this manual.@refill
Dave Love <fx@gnu.org>
parents:
diff changeset
3369
Dave Love <fx@gnu.org>
parents:
diff changeset
3370 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
3371 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
3372 Burstall, Alastair Burt, Soren Dayton, Stephen Eglen, Karl Eichwalder,
37999
8e7df927fd92 Updated to version 4.16
Carsten Dominik <dominik@science.uva.nl>
parents: 37404
diff changeset
3373 Erik Frik, Peter Galbraith, Kai Grossjohann, Frank Harrell, Dieter
8e7df927fd92 Updated to version 4.16
Carsten Dominik <dominik@science.uva.nl>
parents: 37404
diff changeset
3374 Kraft, Adrian Lanz, Rory Molinari, Stefan Monnier, Laurent Mugnier,
8e7df927fd92 Updated to version 4.16
Carsten Dominik <dominik@science.uva.nl>
parents: 37404
diff changeset
3375 Sudeep Kumar Palat, Daniel Polani, Robin Socha, Richard Stanton, Allan
8e7df927fd92 Updated to version 4.16
Carsten Dominik <dominik@science.uva.nl>
parents: 37404
diff changeset
3376 Strand, Jan Vroonhof, Christoph Wedler, Alan Williams}.@refill
25829
Dave Love <fx@gnu.org>
parents:
diff changeset
3377
Dave Love <fx@gnu.org>
parents:
diff changeset
3378 The @code{view-crossref} feature was inspired by @i{Peter Galbraith's}
Dave Love <fx@gnu.org>
parents:
diff changeset
3379 @file{bib-cite.el}.@refill
Dave Love <fx@gnu.org>
parents:
diff changeset
3380
Dave Love <fx@gnu.org>
parents:
diff changeset
3381 Finally thanks to @i{Uwe Bolick} who first got me (some years ago) into
Dave Love <fx@gnu.org>
parents:
diff changeset
3382 supporting LaTeX labels and references with an editor (which was
Dave Love <fx@gnu.org>
parents:
diff changeset
3383 MicroEmacs at the time).@refill
Dave Love <fx@gnu.org>
parents:
diff changeset
3384
Dave Love <fx@gnu.org>
parents:
diff changeset
3385 @node Commands, Options, Imprint, Top
Dave Love <fx@gnu.org>
parents:
diff changeset
3386 @chapter Commands
Dave Love <fx@gnu.org>
parents:
diff changeset
3387 @cindex Commands, list of
Dave Love <fx@gnu.org>
parents:
diff changeset
3388
26911
d7f536a01276 Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents: 25829
diff changeset
3389 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
3390 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
3391 not described here. All commands are available from the @code{Ref}
39267
a8c0a02f6129 Spelling corrections.
Richard M. Stallman <rms@gnu.org>
parents: 38003
diff changeset
3392 menu. See @xref{Key Bindings}.
25829
Dave Love <fx@gnu.org>
parents:
diff changeset
3393
Dave Love <fx@gnu.org>
parents:
diff changeset
3394 @deffn Command reftex-toc
Dave Love <fx@gnu.org>
parents:
diff changeset
3395 Show the table of contents for the current document. When called with
Dave Love <fx@gnu.org>
parents:
diff changeset
3396 one ore two @kbd{C-u} prefixes, rescan the document first.@refill
Dave Love <fx@gnu.org>
parents:
diff changeset
3397 @end deffn
Dave Love <fx@gnu.org>
parents:
diff changeset
3398
Dave Love <fx@gnu.org>
parents:
diff changeset
3399 @deffn Command reftex-label
Dave Love <fx@gnu.org>
parents:
diff changeset
3400 Insert a unique label. With one or two @kbd{C-u} prefixes, enforce
Dave Love <fx@gnu.org>
parents:
diff changeset
3401 document rescan first.
Dave Love <fx@gnu.org>
parents:
diff changeset
3402 @end deffn
Dave Love <fx@gnu.org>
parents:
diff changeset
3403
Dave Love <fx@gnu.org>
parents:
diff changeset
3404 @deffn Command reftex-reference
Dave Love <fx@gnu.org>
parents:
diff changeset
3405 Start a selection process to select a label, and insert a reference to
Dave Love <fx@gnu.org>
parents:
diff changeset
3406 it. With one or two @kbd{C-u} prefixes, enforce document rescan first.
Dave Love <fx@gnu.org>
parents:
diff changeset
3407 @end deffn
Dave Love <fx@gnu.org>
parents:
diff changeset
3408
Dave Love <fx@gnu.org>
parents:
diff changeset
3409 @deffn Command reftex-citation
Dave Love <fx@gnu.org>
parents:
diff changeset
3410 Make a citation using BibTeX database files. After prompting for a regular
Dave Love <fx@gnu.org>
parents:
diff changeset
3411 expression, scans the buffers with BibTeX entries (taken from the
Dave Love <fx@gnu.org>
parents:
diff changeset
3412 @code{\bibliography} command or a @code{thebibliography} environment)
Dave Love <fx@gnu.org>
parents:
diff changeset
3413 and offers the matching entries for selection. The selected entry is
Dave Love <fx@gnu.org>
parents:
diff changeset
3414 formated according to @code{reftex-cite-format} and inserted into the
Dave Love <fx@gnu.org>
parents:
diff changeset
3415 buffer.@refill @*
Dave Love <fx@gnu.org>
parents:
diff changeset
3416 When called with one or two @kbd{C-u} prefixes, first rescans the
Dave Love <fx@gnu.org>
parents:
diff changeset
3417 document. When called with a numeric prefix, make that many citations.
Dave Love <fx@gnu.org>
parents:
diff changeset
3418 When called with point inside the braces of a @code{\cite} command, it
Dave Love <fx@gnu.org>
parents:
diff changeset
3419 will add another key, ignoring the value of
Dave Love <fx@gnu.org>
parents:
diff changeset
3420 @code{reftex-cite-format}.@refill @*
Dave Love <fx@gnu.org>
parents:
diff changeset
3421 The regular expression uses an expanded syntax: @samp{&&} is interpreted
Dave Love <fx@gnu.org>
parents:
diff changeset
3422 as @code{and}. Thus, @samp{aaaa&&bbb} matches entries which contain
Dave Love <fx@gnu.org>
parents:
diff changeset
3423 both @samp{aaaa} and @samp{bbb}. While entering the regexp, completion
Dave Love <fx@gnu.org>
parents:
diff changeset
3424 on knows citation keys is possible. @samp{=} is a good regular
Dave Love <fx@gnu.org>
parents:
diff changeset
3425 expression to match all entries in all files.@refill
Dave Love <fx@gnu.org>
parents:
diff changeset
3426 @end deffn
Dave Love <fx@gnu.org>
parents:
diff changeset
3427
Dave Love <fx@gnu.org>
parents:
diff changeset
3428 @deffn Command reftex-index
Dave Love <fx@gnu.org>
parents:
diff changeset
3429 Query for an index macro and insert it along with its arguments. The
Dave Love <fx@gnu.org>
parents:
diff changeset
3430 index macros available are those defined in @code{reftex-index-macro} or
Dave Love <fx@gnu.org>
parents:
diff changeset
3431 by a call to @code{reftex-add-index-macros}, typically from an AUCTeX
Dave Love <fx@gnu.org>
parents:
diff changeset
3432 style file. @b{Ref@TeX{}} provides completion for the index tag and the
Dave Love <fx@gnu.org>
parents:
diff changeset
3433 index key, and will prompt for other arguments.@refill
Dave Love <fx@gnu.org>
parents:
diff changeset
3434 @end deffn
Dave Love <fx@gnu.org>
parents:
diff changeset
3435
Dave Love <fx@gnu.org>
parents:
diff changeset
3436 @deffn Command reftex-index-selection-or-word
Dave Love <fx@gnu.org>
parents:
diff changeset
3437 Put current selection or the word near point into the default index
Dave Love <fx@gnu.org>
parents:
diff changeset
3438 macro. This uses the information in @code{reftex-index-default-macro}
Dave Love <fx@gnu.org>
parents:
diff changeset
3439 to make an index entry. The phrase indexed is the current selection or
Dave Love <fx@gnu.org>
parents:
diff changeset
3440 the word near point. When called with one @kbd{C-u} prefix, let the
Dave Love <fx@gnu.org>
parents:
diff changeset
3441 user have a chance to edit the index entry. When called with 2
Dave Love <fx@gnu.org>
parents:
diff changeset
3442 @kbd{C-u} as prefix, also ask for the index macro and other stuff. When
Dave Love <fx@gnu.org>
parents:
diff changeset
3443 called inside TeX math mode as determined by the @file{texmathp.el}
Dave Love <fx@gnu.org>
parents:
diff changeset
3444 library which is part of AUCTeX, the string is first processed with the
Dave Love <fx@gnu.org>
parents:
diff changeset
3445 @code{reftex-index-math-format}, which see.@refill
Dave Love <fx@gnu.org>
parents:
diff changeset
3446 @end deffn
Dave Love <fx@gnu.org>
parents:
diff changeset
3447
26911
d7f536a01276 Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents: 25829
diff changeset
3448 @deffn Command reftex-index-phrase-selection-or-word
d7f536a01276 Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents: 25829
diff changeset
3449 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
3450 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
3451 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
3452 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
3453 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
3454 @end deffn
d7f536a01276 Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents: 25829
diff changeset
3455
d7f536a01276 Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents: 25829
diff changeset
3456 @deffn Command reftex-index-visit-phrases-buffer
d7f536a01276 Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents: 25829
diff changeset
3457 Switch to the phrases buffer, initialize if empty.
d7f536a01276 Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents: 25829
diff changeset
3458 @end deffn
d7f536a01276 Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents: 25829
diff changeset
3459
d7f536a01276 Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents: 25829
diff changeset
3460 @deffn Command reftex-index-phrases-apply-to-region
d7f536a01276 Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents: 25829
diff changeset
3461 Index all index phrases in the current region.
d7f536a01276 Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents: 25829
diff changeset
3462 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
3463 but operation is restricted to the current region.
d7f536a01276 Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents: 25829
diff changeset
3464 @end deffn
d7f536a01276 Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents: 25829
diff changeset
3465
25829
Dave Love <fx@gnu.org>
parents:
diff changeset
3466 @deffn Command reftex-display-index
Dave Love <fx@gnu.org>
parents:
diff changeset
3467 Display a buffer with an index compiled from the current document.
Dave Love <fx@gnu.org>
parents:
diff changeset
3468 When the document has multiple indices, first prompts for the correct one.
Dave Love <fx@gnu.org>
parents:
diff changeset
3469 When index support is turned off, offer to turn it on.
Dave Love <fx@gnu.org>
parents:
diff changeset
3470 With one or two @kbd{C-u} prefixes, rescan document first.
Dave Love <fx@gnu.org>
parents:
diff changeset
3471 With prefix 2, restrict index to current document section.
Dave Love <fx@gnu.org>
parents:
diff changeset
3472 With prefix 3, restrict index to active region.@refill
Dave Love <fx@gnu.org>
parents:
diff changeset
3473 @end deffn
Dave Love <fx@gnu.org>
parents:
diff changeset
3474
Dave Love <fx@gnu.org>
parents:
diff changeset
3475 @deffn Command reftex-view-crossref
Dave Love <fx@gnu.org>
parents:
diff changeset
3476 View cross reference of macro at point. Point must be on the @var{key}
Dave Love <fx@gnu.org>
parents:
diff changeset
3477 argument. Works with the macros @code{\label}, @code{\ref},
Dave Love <fx@gnu.org>
parents:
diff changeset
3478 @code{\cite}, @code{\bibitem}, @code{\index} and many derivatives of
Dave Love <fx@gnu.org>
parents:
diff changeset
3479 these. Where it makes sense, subsequent calls show additional
Dave Love <fx@gnu.org>
parents:
diff changeset
3480 locations. See also the variable @code{reftex-view-crossref-extra} and
Dave Love <fx@gnu.org>
parents:
diff changeset
3481 the command @code{reftex-view-crossref-from-bibtex}. With one or two
Dave Love <fx@gnu.org>
parents:
diff changeset
3482 @kbd{C-u} prefixes, enforce rescanning of the document. With argument
Dave Love <fx@gnu.org>
parents:
diff changeset
3483 2, select the window showing the cross reference.
Dave Love <fx@gnu.org>
parents:
diff changeset
3484 @end deffn
Dave Love <fx@gnu.org>
parents:
diff changeset
3485
Dave Love <fx@gnu.org>
parents:
diff changeset
3486 @deffn Command reftex-view-crossref-from-bibtex
Dave Love <fx@gnu.org>
parents:
diff changeset
3487 View location in a LaTeX document which cites the BibTeX entry at point.
Dave Love <fx@gnu.org>
parents:
diff changeset
3488 Since BibTeX files can be used by many LaTeX documents, this function
Dave Love <fx@gnu.org>
parents:
diff changeset
3489 prompts upon first use for a buffer in @b{Ref@TeX{}} mode. To reset this
37999
8e7df927fd92 Updated to version 4.16
Carsten Dominik <dominik@science.uva.nl>
parents: 37404
diff changeset
3490 link to a document, call the function with with a prefix arg. Calling
25829
Dave Love <fx@gnu.org>
parents:
diff changeset
3491 this function several times find successive citation locations.
Dave Love <fx@gnu.org>
parents:
diff changeset
3492 @end deffn
Dave Love <fx@gnu.org>
parents:
diff changeset
3493
Dave Love <fx@gnu.org>
parents:
diff changeset
3494 @deffn Command reftex-create-tags-file
Dave Love <fx@gnu.org>
parents:
diff changeset
3495 Create TAGS file by running @code{etags} on the current document. The
Dave Love <fx@gnu.org>
parents:
diff changeset
3496 TAGS file is also immediately visited with
Dave Love <fx@gnu.org>
parents:
diff changeset
3497 @code{visit-tags-table}.@refill
Dave Love <fx@gnu.org>
parents:
diff changeset
3498 @end deffn
Dave Love <fx@gnu.org>
parents:
diff changeset
3499
Dave Love <fx@gnu.org>
parents:
diff changeset
3500 @deffn Command reftex-grep-document
Dave Love <fx@gnu.org>
parents:
diff changeset
3501 Run grep query through all files related to this document.
Dave Love <fx@gnu.org>
parents:
diff changeset
3502 With prefix arg, force to rescan document.
Dave Love <fx@gnu.org>
parents:
diff changeset
3503 No active TAGS table is required.@refill
Dave Love <fx@gnu.org>
parents:
diff changeset
3504 @end deffn
Dave Love <fx@gnu.org>
parents:
diff changeset
3505
Dave Love <fx@gnu.org>
parents:
diff changeset
3506 @deffn Command reftex-search-document
Dave Love <fx@gnu.org>
parents:
diff changeset
3507 Regexp search through all files of the current document.
Dave Love <fx@gnu.org>
parents:
diff changeset
3508 Starts always in the master file. Stops when a match is found.
Dave Love <fx@gnu.org>
parents:
diff changeset
3509 No active TAGS table is required.@refill
Dave Love <fx@gnu.org>
parents:
diff changeset
3510 @end deffn
Dave Love <fx@gnu.org>
parents:
diff changeset
3511
Dave Love <fx@gnu.org>
parents:
diff changeset
3512 @deffn Command reftex-query-replace-document
Dave Love <fx@gnu.org>
parents:
diff changeset
3513 Run a query-replace-regexp of @var{from} with @var{to} over the entire
Dave Love <fx@gnu.org>
parents:
diff changeset
3514 document. With prefix arg, replace only word-delimited matches. No
Dave Love <fx@gnu.org>
parents:
diff changeset
3515 active TAGS table is required.@refill
Dave Love <fx@gnu.org>
parents:
diff changeset
3516 @end deffn
Dave Love <fx@gnu.org>
parents:
diff changeset
3517
Dave Love <fx@gnu.org>
parents:
diff changeset
3518 @deffn Command reftex-change-label
Dave Love <fx@gnu.org>
parents:
diff changeset
3519 Query replace @var{from} with @var{to} in all @code{\label} and
Dave Love <fx@gnu.org>
parents:
diff changeset
3520 @code{\ref} commands. Works on the entire multifile document. No
Dave Love <fx@gnu.org>
parents:
diff changeset
3521 active TAGS table is required.@refill
Dave Love <fx@gnu.org>
parents:
diff changeset
3522 @end deffn
Dave Love <fx@gnu.org>
parents:
diff changeset
3523
Dave Love <fx@gnu.org>
parents:
diff changeset
3524 @deffn Command reftex-renumber-simple-labels
Dave Love <fx@gnu.org>
parents:
diff changeset
3525 Renumber all simple labels in the document to make them sequentially.
Dave Love <fx@gnu.org>
parents:
diff changeset
3526 Simple labels are the ones created by RefTeX, consisting only of the
Dave Love <fx@gnu.org>
parents:
diff changeset
3527 prefix and a number. After the command completes, all these labels will
Dave Love <fx@gnu.org>
parents:
diff changeset
3528 have sequential numbers throughout the document. Any references to the
Dave Love <fx@gnu.org>
parents:
diff changeset
3529 labels will be changed as well. For this, @b{Ref@TeX{}} looks at the
Dave Love <fx@gnu.org>
parents:
diff changeset
3530 arguments of any macros which either start or end with the string
Dave Love <fx@gnu.org>
parents:
diff changeset
3531 @samp{ref}. This command should be used with care, in particular in
Dave Love <fx@gnu.org>
parents:
diff changeset
3532 multifile documents. You should not use it if another document refers
Dave Love <fx@gnu.org>
parents:
diff changeset
3533 to this one with the @code{xr} package.@refill
Dave Love <fx@gnu.org>
parents:
diff changeset
3534 @end deffn
Dave Love <fx@gnu.org>
parents:
diff changeset
3535
Dave Love <fx@gnu.org>
parents:
diff changeset
3536 @deffn Command reftex-find-duplicate-labels
Dave Love <fx@gnu.org>
parents:
diff changeset
3537 Produce a list of all duplicate labels in the document.@refill
Dave Love <fx@gnu.org>
parents:
diff changeset
3538 @end deffn
Dave Love <fx@gnu.org>
parents:
diff changeset
3539
Dave Love <fx@gnu.org>
parents:
diff changeset
3540 @deffn Command reftex-customize
Dave Love <fx@gnu.org>
parents:
diff changeset
3541 Run the customize browser on the @b{Ref@TeX{}} group.
Dave Love <fx@gnu.org>
parents:
diff changeset
3542 @end deffn
Dave Love <fx@gnu.org>
parents:
diff changeset
3543 @deffn Command reftex-show-commentary
Dave Love <fx@gnu.org>
parents:
diff changeset
3544 Show the commentary section from @file{reftex.el}.
Dave Love <fx@gnu.org>
parents:
diff changeset
3545 @end deffn
Dave Love <fx@gnu.org>
parents:
diff changeset
3546 @deffn Command reftex-info
Dave Love <fx@gnu.org>
parents:
diff changeset
3547 Run info on the top @b{Ref@TeX{}} node.
Dave Love <fx@gnu.org>
parents:
diff changeset
3548 @end deffn
Dave Love <fx@gnu.org>
parents:
diff changeset
3549 @deffn Command reftex-parse-document
Dave Love <fx@gnu.org>
parents:
diff changeset
3550 Parse the entire document in order to update the parsing information.
Dave Love <fx@gnu.org>
parents:
diff changeset
3551 @end deffn
Dave Love <fx@gnu.org>
parents:
diff changeset
3552 @deffn Command reftex-reset-mode
Dave Love <fx@gnu.org>
parents:
diff changeset
3553 Enforce rebuilding of several internal lists and variables. Also
Dave Love <fx@gnu.org>
parents:
diff changeset
3554 removes the parse file associated with the current document.
Dave Love <fx@gnu.org>
parents:
diff changeset
3555 @end deffn
Dave Love <fx@gnu.org>
parents:
diff changeset
3556
Dave Love <fx@gnu.org>
parents:
diff changeset
3557 @node Options, Keymaps and Hooks, Commands, Top
Dave Love <fx@gnu.org>
parents:
diff changeset
3558 @chapter Options, Keymaps, Hooks
Dave Love <fx@gnu.org>
parents:
diff changeset
3559 @cindex Options, list of
Dave Love <fx@gnu.org>
parents:
diff changeset
3560
Dave Love <fx@gnu.org>
parents:
diff changeset
3561 Here is a complete list of @b{Ref@TeX{}}'s configuration variables. All
Dave Love <fx@gnu.org>
parents:
diff changeset
3562 variables have customize support - so if you are not familiar with Emacs
Dave Love <fx@gnu.org>
parents:
diff changeset
3563 Lisp (and even if you are) you might find it more comfortable to use
Dave Love <fx@gnu.org>
parents:
diff changeset
3564 @code{customize} to look at and change these variables. @kbd{M-x
Dave Love <fx@gnu.org>
parents:
diff changeset
3565 reftex-customize} will get you there.@refill
Dave Love <fx@gnu.org>
parents:
diff changeset
3566
Dave Love <fx@gnu.org>
parents:
diff changeset
3567 @menu
Dave Love <fx@gnu.org>
parents:
diff changeset
3568 * Options (Table of Contents)::
Dave Love <fx@gnu.org>
parents:
diff changeset
3569 * Options (Defining Label Environments)::
Dave Love <fx@gnu.org>
parents:
diff changeset
3570 * Options (Creating Labels)::
Dave Love <fx@gnu.org>
parents:
diff changeset
3571 * Options (Referencing Labels)::
Dave Love <fx@gnu.org>
parents:
diff changeset
3572 * Options (Creating Citations)::
Dave Love <fx@gnu.org>
parents:
diff changeset
3573 * Options (Index Support)::
Dave Love <fx@gnu.org>
parents:
diff changeset
3574 * Options (Viewing Cross-References)::
Dave Love <fx@gnu.org>
parents:
diff changeset
3575 * Options (Finding Files)::
Dave Love <fx@gnu.org>
parents:
diff changeset
3576 * Options (Optimizations)::
Dave Love <fx@gnu.org>
parents:
diff changeset
3577 * Options (Fontification)::
Dave Love <fx@gnu.org>
parents:
diff changeset
3578 * Options (Misc)::
Dave Love <fx@gnu.org>
parents:
diff changeset
3579 @end menu
Dave Love <fx@gnu.org>
parents:
diff changeset
3580
Dave Love <fx@gnu.org>
parents:
diff changeset
3581 @node Options (Table of Contents), Options (Defining Label Environments), , Options
Dave Love <fx@gnu.org>
parents:
diff changeset
3582 @section Table of Contents
Dave Love <fx@gnu.org>
parents:
diff changeset
3583 @cindex Options, table of contents
Dave Love <fx@gnu.org>
parents:
diff changeset
3584 @cindex Table of contents, options
Dave Love <fx@gnu.org>
parents:
diff changeset
3585
26911
d7f536a01276 Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents: 25829
diff changeset
3586 @defopt reftex-toc-max-level
d7f536a01276 Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents: 25829
diff changeset
3587 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
3588 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
3589 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
3590 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
3591 @end defopt
d7f536a01276 Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents: 25829
diff changeset
3592
25829
Dave Love <fx@gnu.org>
parents:
diff changeset
3593 @defopt reftex-toc-keep-other-windows
Dave Love <fx@gnu.org>
parents:
diff changeset
3594 Non-@code{nil} means, split the selected window to display the
Dave Love <fx@gnu.org>
parents:
diff changeset
3595 @file{*toc*} buffer. This helps to keep the window configuration, but
Dave Love <fx@gnu.org>
parents:
diff changeset
3596 makes the @file{*toc*} small. When @code{nil}, all other windows except
Dave Love <fx@gnu.org>
parents:
diff changeset
3597 the selected one will be deleted, so that the @file{*toc*} window fills
Dave Love <fx@gnu.org>
parents:
diff changeset
3598 half the frame.@refill
Dave Love <fx@gnu.org>
parents:
diff changeset
3599 @end defopt
Dave Love <fx@gnu.org>
parents:
diff changeset
3600
Dave Love <fx@gnu.org>
parents:
diff changeset
3601 @defopt reftex-toc-include-file-boundaries
Dave Love <fx@gnu.org>
parents:
diff changeset
3602 Non-@code{nil} means, include file boundaries in @file{*toc*} buffer.
Dave Love <fx@gnu.org>
parents:
diff changeset
3603 This flag can be toggled from within the @file{*toc*} buffer with the
Dave Love <fx@gnu.org>
parents:
diff changeset
3604 @kbd{i} key.@refill
Dave Love <fx@gnu.org>
parents:
diff changeset
3605 @end defopt
Dave Love <fx@gnu.org>
parents:
diff changeset
3606
Dave Love <fx@gnu.org>
parents:
diff changeset
3607 @defopt reftex-toc-include-labels
Dave Love <fx@gnu.org>
parents:
diff changeset
3608 Non-@code{nil} means, include labels in @file{*toc*} buffer. This flag
Dave Love <fx@gnu.org>
parents:
diff changeset
3609 can be toggled from within the @file{*toc*} buffer with the @kbd{l}
Dave Love <fx@gnu.org>
parents:
diff changeset
3610 key.@refill
Dave Love <fx@gnu.org>
parents:
diff changeset
3611 @end defopt
Dave Love <fx@gnu.org>
parents:
diff changeset
3612
Dave Love <fx@gnu.org>
parents:
diff changeset
3613 @defopt reftex-toc-include-index-entries
Dave Love <fx@gnu.org>
parents:
diff changeset
3614 Non-@code{nil} means, include index entries in @file{*toc*} buffer.
Dave Love <fx@gnu.org>
parents:
diff changeset
3615 This flag can be toggled from within the @file{*toc*} buffer with the
Dave Love <fx@gnu.org>
parents:
diff changeset
3616 @kbd{i} key.
Dave Love <fx@gnu.org>
parents:
diff changeset
3617 @end defopt
Dave Love <fx@gnu.org>
parents:
diff changeset
3618
Dave Love <fx@gnu.org>
parents:
diff changeset
3619 @defopt reftex-toc-include-context
Dave Love <fx@gnu.org>
parents:
diff changeset
3620 Non-@code{nil} means, include context with labels in the @file{*toc*}
Dave Love <fx@gnu.org>
parents:
diff changeset
3621 buffer. Context will only be shown if the labels are visible as well.
Dave Love <fx@gnu.org>
parents:
diff changeset
3622 This flag can be toggled from within the @file{*toc*} buffer with the
Dave Love <fx@gnu.org>
parents:
diff changeset
3623 @kbd{c} key.@refill
Dave Love <fx@gnu.org>
parents:
diff changeset
3624 @end defopt
Dave Love <fx@gnu.org>
parents:
diff changeset
3625
Dave Love <fx@gnu.org>
parents:
diff changeset
3626 @defopt reftex-toc-follow-mode
Dave Love <fx@gnu.org>
parents:
diff changeset
3627 Non-@code{nil} means, point in @file{*toc*} buffer (the
Dave Love <fx@gnu.org>
parents:
diff changeset
3628 table-of-contents buffer) will cause other window to follow. The other
Dave Love <fx@gnu.org>
parents:
diff changeset
3629 window will show the corresponding part of the document. This flag can
Dave Love <fx@gnu.org>
parents:
diff changeset
3630 be toggled from within the @file{*toc*} buffer with the @kbd{f}
Dave Love <fx@gnu.org>
parents:
diff changeset
3631 key.@refill
Dave Love <fx@gnu.org>
parents:
diff changeset
3632 @end defopt
Dave Love <fx@gnu.org>
parents:
diff changeset
3633
Dave Love <fx@gnu.org>
parents:
diff changeset
3634 @deffn {Normal Hook} reftex-toc-mode-hook
Dave Love <fx@gnu.org>
parents:
diff changeset
3635 Normal hook which is run when a @file{*toc*} buffer is
Dave Love <fx@gnu.org>
parents:
diff changeset
3636 created.@refill
Dave Love <fx@gnu.org>
parents:
diff changeset
3637 @end deffn
Dave Love <fx@gnu.org>
parents:
diff changeset
3638
Dave Love <fx@gnu.org>
parents:
diff changeset
3639 @deffn Keymap reftex-toc-map
Dave Love <fx@gnu.org>
parents:
diff changeset
3640 The keymap which is active in the @file{*toc*} buffer.
Dave Love <fx@gnu.org>
parents:
diff changeset
3641 (@pxref{Table of Contents}).@refill
Dave Love <fx@gnu.org>
parents:
diff changeset
3642 @end deffn
Dave Love <fx@gnu.org>
parents:
diff changeset
3643
Dave Love <fx@gnu.org>
parents:
diff changeset
3644 @node Options (Defining Label Environments), Options (Creating Labels), Options (Table of Contents), Options
Dave Love <fx@gnu.org>
parents:
diff changeset
3645 @section Defining Label Environments
Dave Love <fx@gnu.org>
parents:
diff changeset
3646 @cindex Options, defining label environments
Dave Love <fx@gnu.org>
parents:
diff changeset
3647 @cindex Defining label environments, options
Dave Love <fx@gnu.org>
parents:
diff changeset
3648
Dave Love <fx@gnu.org>
parents:
diff changeset
3649 @defopt reftex-default-label-alist-entries
Dave Love <fx@gnu.org>
parents:
diff changeset
3650 Default label alist specifications. It is a list of symbols with
Dave Love <fx@gnu.org>
parents:
diff changeset
3651 associations in the constant @code{reftex-label-alist-builtin}.
Dave Love <fx@gnu.org>
parents:
diff changeset
3652 @code{LaTeX} should always be the last entry.@refill
Dave Love <fx@gnu.org>
parents:
diff changeset
3653 @end defopt
Dave Love <fx@gnu.org>
parents:
diff changeset
3654
Dave Love <fx@gnu.org>
parents:
diff changeset
3655 @defopt reftex-label-alist
Dave Love <fx@gnu.org>
parents:
diff changeset
3656 Set this variable to define additions and changes to the defaults in
Dave Love <fx@gnu.org>
parents:
diff changeset
3657 @code{reftex-default-label-alist-entries}. The only things you
Dave Love <fx@gnu.org>
parents:
diff changeset
3658 @emph{must not} change is that @code{?s} is the type indicator for
Dave Love <fx@gnu.org>
parents:
diff changeset
3659 section labels, and @key{SPC} for the @code{any} label type. These are
Dave Love <fx@gnu.org>
parents:
diff changeset
3660 hard-coded at other places in the code.@refill
Dave Love <fx@gnu.org>
parents:
diff changeset
3661
Dave Love <fx@gnu.org>
parents:
diff changeset
3662 The value of the variable must be a list of items. Each item is a list
Dave Love <fx@gnu.org>
parents:
diff changeset
3663 itself and has the following structure:
Dave Love <fx@gnu.org>
parents:
diff changeset
3664
Dave Love <fx@gnu.org>
parents:
diff changeset
3665 @example
Dave Love <fx@gnu.org>
parents:
diff changeset
3666 (@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
3667 @var{context-method} (@var{magic-word} ... ) @var{toc-level})
25829
Dave Love <fx@gnu.org>
parents:
diff changeset
3668 @end example
Dave Love <fx@gnu.org>
parents:
diff changeset
3669
Dave Love <fx@gnu.org>
parents:
diff changeset
3670 Each list entry describes either an environment carrying a counter for
Dave Love <fx@gnu.org>
parents:
diff changeset
3671 use with @code{\label} and @code{\ref}, or a LaTeX macro defining a
Dave Love <fx@gnu.org>
parents:
diff changeset
3672 label as (or inside) one of its arguments. The elements of each list
Dave Love <fx@gnu.org>
parents:
diff changeset
3673 entry are:@refill
Dave Love <fx@gnu.org>
parents:
diff changeset
3674
Dave Love <fx@gnu.org>
parents:
diff changeset
3675 @table @asis
Dave Love <fx@gnu.org>
parents:
diff changeset
3676 @item @var{env-or-macro}
Dave Love <fx@gnu.org>
parents:
diff changeset
3677 Name of the environment (like @samp{table}) or macro (like
Dave Love <fx@gnu.org>
parents:
diff changeset
3678 @samp{\myfig}). For macros, indicate the arguments, as in
Dave Love <fx@gnu.org>
parents:
diff changeset
3679 @samp{\myfig[]@{@}@{@}@{*@}@{@}}. Use square brackets for optional
Dave Love <fx@gnu.org>
parents:
diff changeset
3680 arguments, a star to mark the label argument, if any. The macro does
Dave Love <fx@gnu.org>
parents:
diff changeset
3681 not have to have a label argument - you could also use
Dave Love <fx@gnu.org>
parents:
diff changeset
3682 @samp{\label@{...@}} inside one of its arguments.@refill
Dave Love <fx@gnu.org>
parents:
diff changeset
3683
Dave Love <fx@gnu.org>
parents:
diff changeset
3684 Special names: @code{section} for section labels, @code{any} to define a
Dave Love <fx@gnu.org>
parents:
diff changeset
3685 group which contains all labels.@refill
Dave Love <fx@gnu.org>
parents:
diff changeset
3686
Dave Love <fx@gnu.org>
parents:
diff changeset
3687 This may also be a function to do local parsing and identify point to be
Dave Love <fx@gnu.org>
parents:
diff changeset
3688 in a a non-standard label environment. The function must take an
Dave Love <fx@gnu.org>
parents:
diff changeset
3689 argument @var{bound} and limit backward searches to this value. It
Dave Love <fx@gnu.org>
parents:
diff changeset
3690 should return either nil or a cons cell @code{(@var{function}
Dave Love <fx@gnu.org>
parents:
diff changeset
3691 . @var{position})} with the function symbol and the position where the
Dave Love <fx@gnu.org>
parents:
diff changeset
3692 special environment starts. See the Info documentation for an
Dave Love <fx@gnu.org>
parents:
diff changeset
3693 example.@refill
Dave Love <fx@gnu.org>
parents:
diff changeset
3694
Dave Love <fx@gnu.org>
parents:
diff changeset
3695 Finally this may also be @code{nil} if the entry is only meant to change
Dave Love <fx@gnu.org>
parents:
diff changeset
3696 some settings associated with the type indicator character (see
Dave Love <fx@gnu.org>
parents:
diff changeset
3697 below).@refill
Dave Love <fx@gnu.org>
parents:
diff changeset
3698
Dave Love <fx@gnu.org>
parents:
diff changeset
3699 @item @var{type-key}
Dave Love <fx@gnu.org>
parents:
diff changeset
3700 Type indicator character, like @code{?t}, must be a printable ASCII
Dave Love <fx@gnu.org>
parents:
diff changeset
3701 character. The type indicator is a single character which defines a
Dave Love <fx@gnu.org>
parents:
diff changeset
3702 label type. Any label inside the environment or macro is assumed to
Dave Love <fx@gnu.org>
parents:
diff changeset
3703 belong to this type. The same character may occur several times in this
Dave Love <fx@gnu.org>
parents:
diff changeset
3704 list, to cover cases in which different environments carry the same
Dave Love <fx@gnu.org>
parents:
diff changeset
3705 label type (like @code{equation} and @code{eqnarray}). If the type
Dave Love <fx@gnu.org>
parents:
diff changeset
3706 indicator is @code{nil} and the macro has a label argument @samp{@{*@}},
Dave Love <fx@gnu.org>
parents:
diff changeset
3707 the macro defines neutral labels just like @code{\label}. In this case
Dave Love <fx@gnu.org>
parents:
diff changeset
3708 the reminder of this entry is ignored.@refill
Dave Love <fx@gnu.org>
parents:
diff changeset
3709
Dave Love <fx@gnu.org>
parents:
diff changeset
3710 @item @var{label-prefix}
Dave Love <fx@gnu.org>
parents:
diff changeset
3711 Label prefix string, like @samp{tab:}. The prefix is a short string
Dave Love <fx@gnu.org>
parents:
diff changeset
3712 used as the start of a label. It may be the empty string. The prefix
Dave Love <fx@gnu.org>
parents:
diff changeset
3713 may contain the following @samp{%} escapes:@refill
Dave Love <fx@gnu.org>
parents:
diff changeset
3714
Dave Love <fx@gnu.org>
parents:
diff changeset
3715 @example
Dave Love <fx@gnu.org>
parents:
diff changeset
3716 %f Current file name, directory and extension stripped.
Dave Love <fx@gnu.org>
parents:
diff changeset
3717 %F Current file name relative to master file directory.
Dave Love <fx@gnu.org>
parents:
diff changeset
3718 %u User login name, on systems which support this.
Dave Love <fx@gnu.org>
parents:
diff changeset
3719 %S A section prefix derived with variable @code{reftex-section-prefixes}.
Dave Love <fx@gnu.org>
parents:
diff changeset
3720 @end example
Dave Love <fx@gnu.org>
parents:
diff changeset
3721
Dave Love <fx@gnu.org>
parents:
diff changeset
3722 @noindent
Dave Love <fx@gnu.org>
parents:
diff changeset
3723 Example: In a file @file{intro.tex}, @samp{eq:%f:} will become
Dave Love <fx@gnu.org>
parents:
diff changeset
3724 @samp{eq:intro:}.@refill
Dave Love <fx@gnu.org>
parents:
diff changeset
3725
Dave Love <fx@gnu.org>
parents:
diff changeset
3726 @item @var{reference-format}
Dave Love <fx@gnu.org>
parents:
diff changeset
3727 Format string for reference insert in buffer. @samp{%s} will be
Dave Love <fx@gnu.org>
parents:
diff changeset
3728 replaced by the label. When the format starts with @samp{~}, this
Dave Love <fx@gnu.org>
parents:
diff changeset
3729 @samp{~} will only be inserted when the character before point is
Dave Love <fx@gnu.org>
parents:
diff changeset
3730 @emph{not} a whitespace.@refill
Dave Love <fx@gnu.org>
parents:
diff changeset
3731
Dave Love <fx@gnu.org>
parents:
diff changeset
3732 @item @var{context-method}
Dave Love <fx@gnu.org>
parents:
diff changeset
3733 Indication on how to find the short context.
Dave Love <fx@gnu.org>
parents:
diff changeset
3734 @itemize @minus
Dave Love <fx@gnu.org>
parents:
diff changeset
3735 @item
Dave Love <fx@gnu.org>
parents:
diff changeset
3736 If @code{nil}, use the text following the @samp{\label@{...@}} macro.@refill
Dave Love <fx@gnu.org>
parents:
diff changeset
3737 @item
Dave Love <fx@gnu.org>
parents:
diff changeset
3738 If @code{t}, use
Dave Love <fx@gnu.org>
parents:
diff changeset
3739 @itemize @minus
Dave Love <fx@gnu.org>
parents:
diff changeset
3740 @item
Dave Love <fx@gnu.org>
parents:
diff changeset
3741 the section heading for section labels.
Dave Love <fx@gnu.org>
parents:
diff changeset
3742 @item
Dave Love <fx@gnu.org>
parents:
diff changeset
3743 text following the @samp{\begin@{...@}} statement of environments (not
Dave Love <fx@gnu.org>
parents:
diff changeset
3744 a good choice for environments like eqnarray or enumerate, where one has
Dave Love <fx@gnu.org>
parents:
diff changeset
3745 several labels in a single environment).@refill
Dave Love <fx@gnu.org>
parents:
diff changeset
3746 @item
Dave Love <fx@gnu.org>
parents:
diff changeset
3747 text after the macro name (starting with the first arg) for
Dave Love <fx@gnu.org>
parents:
diff changeset
3748 macros.@refill
Dave Love <fx@gnu.org>
parents:
diff changeset
3749 @end itemize
Dave Love <fx@gnu.org>
parents:
diff changeset
3750 @item
Dave Love <fx@gnu.org>
parents:
diff changeset
3751 If an integer, use the nth argument of the macro. As a special case,
Dave Love <fx@gnu.org>
parents:
diff changeset
3752 1000 means to get text after the last macro argument.@refill
Dave Love <fx@gnu.org>
parents:
diff changeset
3753 @item
Dave Love <fx@gnu.org>
parents:
diff changeset
3754 If a string, use as regexp to search @emph{backward} from the label.
Dave Love <fx@gnu.org>
parents:
diff changeset
3755 Context is then the text following the end of the match. E.g. putting
Dave Love <fx@gnu.org>
parents:
diff changeset
3756 this to @samp{\\caption[[@{]} will use the caption in a figure or table
Dave Love <fx@gnu.org>
parents:
diff changeset
3757 environment. @samp{\\begin@{eqnarray@}\|\\\\} works for
Dave Love <fx@gnu.org>
parents:
diff changeset
3758 eqnarrays.@refill
Dave Love <fx@gnu.org>
parents:
diff changeset
3759 @item
Dave Love <fx@gnu.org>
parents:
diff changeset
3760 If any of @code{caption}, @code{item}, @code{eqnarray-like},
Dave Love <fx@gnu.org>
parents:
diff changeset
3761 @code{alignat-like}, this symbol will internally be translated into an
Dave Love <fx@gnu.org>
parents:
diff changeset
3762 appropriate regexp (see also the variable
Dave Love <fx@gnu.org>
parents:
diff changeset
3763 @code{reftex-default-context-regexps}).@refill
Dave Love <fx@gnu.org>
parents:
diff changeset
3764 @item
Dave Love <fx@gnu.org>
parents:
diff changeset
3765 If a function, call this function with the name of the environment/macro
Dave Love <fx@gnu.org>
parents:
diff changeset
3766 as argument. On call, point will be just after the @code{\label} macro.
Dave Love <fx@gnu.org>
parents:
diff changeset
3767 The function is expected to return a suitable context string. It should
Dave Love <fx@gnu.org>
parents:
diff changeset
3768 throw an exception (error) when failing to find context. As an example,
Dave Love <fx@gnu.org>
parents:
diff changeset
3769 here is a function returning the 10 chars following the label macro as
Dave Love <fx@gnu.org>
parents:
diff changeset
3770 context:@refill
Dave Love <fx@gnu.org>
parents:
diff changeset
3771
Dave Love <fx@gnu.org>
parents:
diff changeset
3772 @example
Dave Love <fx@gnu.org>
parents:
diff changeset
3773 (defun my-context-function (env-or-mac)
Dave Love <fx@gnu.org>
parents:
diff changeset
3774 (if (> (point-max) (+ 10 (point)))
Dave Love <fx@gnu.org>
parents:
diff changeset
3775 (buffer-substring (point) (+ 10 (point)))
Dave Love <fx@gnu.org>
parents:
diff changeset
3776 (error "Buffer too small")))
Dave Love <fx@gnu.org>
parents:
diff changeset
3777 @end example
Dave Love <fx@gnu.org>
parents:
diff changeset
3778 @end itemize
Dave Love <fx@gnu.org>
parents:
diff changeset
3779
Dave Love <fx@gnu.org>
parents:
diff changeset
3780 Label context is used in two ways by @b{Ref@TeX{}}: For display in the label
Dave Love <fx@gnu.org>
parents:
diff changeset
3781 menu, and to derive a label string. If you want to use a different
Dave Love <fx@gnu.org>
parents:
diff changeset
3782 method for each of these, specify them as a dotted pair.
Dave Love <fx@gnu.org>
parents:
diff changeset
3783 E.g. @code{(nil . t)} uses the text after the label (@code{nil}) for
Dave Love <fx@gnu.org>
parents:
diff changeset
3784 display, and text from the default position (@code{t}) to derive a label
Dave Love <fx@gnu.org>
parents:
diff changeset
3785 string. This is actually used for section labels.@refill
Dave Love <fx@gnu.org>
parents:
diff changeset
3786
Dave Love <fx@gnu.org>
parents:
diff changeset
3787 @item @var{magic-word-list}
Dave Love <fx@gnu.org>
parents:
diff changeset
3788 List of magic words which identify a reference to be of this type. If
Dave Love <fx@gnu.org>
parents:
diff changeset
3789 the word before point is equal to one of these words when calling
Dave Love <fx@gnu.org>
parents:
diff changeset
3790 @code{reftex-reference}, the label list offered will be automatically
Dave Love <fx@gnu.org>
parents:
diff changeset
3791 restricted to labels of the correct type. If the first element of this
Dave Love <fx@gnu.org>
parents:
diff changeset
3792 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
3793 expressions.@refill
d7f536a01276 Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents: 25829
diff changeset
3794
d7f536a01276 Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents: 25829
diff changeset
3795 @item @var{toc-level}
d7f536a01276 Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents: 25829
diff changeset
3796 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
3797 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
3798 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
3799 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
3800 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
3801 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
3802 made.@refill
25829
Dave Love <fx@gnu.org>
parents:
diff changeset
3803 @end table
Dave Love <fx@gnu.org>
parents:
diff changeset
3804
Dave Love <fx@gnu.org>
parents:
diff changeset
3805 If the type indicator characters of two or more entries are the same,
Dave Love <fx@gnu.org>
parents:
diff changeset
3806 @b{Ref@TeX{}} will use@refill
Dave Love <fx@gnu.org>
parents:
diff changeset
3807 @itemize @minus
Dave Love <fx@gnu.org>
parents:
diff changeset
3808 @item
Dave Love <fx@gnu.org>
parents:
diff changeset
3809 the first non-@code{nil} format and prefix
Dave Love <fx@gnu.org>
parents:
diff changeset
3810 @item
Dave Love <fx@gnu.org>
parents:
diff changeset
3811 the magic words of all involved entries.
Dave Love <fx@gnu.org>
parents:
diff changeset
3812 @end itemize
Dave Love <fx@gnu.org>
parents:
diff changeset
3813
Dave Love <fx@gnu.org>
parents:
diff changeset
3814 Any list entry may also be a symbol. If that has an association in
Dave Love <fx@gnu.org>
parents:
diff changeset
3815 @code{reftex-label-alist-builtin}, the @code{cddr} of that association is
Dave Love <fx@gnu.org>
parents:
diff changeset
3816 spliced into the list. However, builtin defaults should normally be set
Dave Love <fx@gnu.org>
parents:
diff changeset
3817 with the variable @code{reftex-default-label-alist-entries}.@refill
Dave Love <fx@gnu.org>
parents:
diff changeset
3818 @end defopt
Dave Love <fx@gnu.org>
parents:
diff changeset
3819
Dave Love <fx@gnu.org>
parents:
diff changeset
3820 @defopt reftex-max-section-depth
Dave Love <fx@gnu.org>
parents:
diff changeset
3821 Maximum depth of section levels in document structure.
Dave Love <fx@gnu.org>
parents:
diff changeset
3822 Standard LaTeX needs 7, default is 12.
Dave Love <fx@gnu.org>
parents:
diff changeset
3823 @end defopt
Dave Love <fx@gnu.org>
parents:
diff changeset
3824
Dave Love <fx@gnu.org>
parents:
diff changeset
3825 @defopt reftex-section-levels
Dave Love <fx@gnu.org>
parents:
diff changeset
3826 Commands and levels used for defining sections in the document. The
Dave Love <fx@gnu.org>
parents:
diff changeset
3827 @code{car} of each cons cell is the name of the section macro. The
Dave Love <fx@gnu.org>
parents:
diff changeset
3828 @code{cdr} is a number indicating its level. A negative level means the
Dave Love <fx@gnu.org>
parents:
diff changeset
3829 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
3830 number. The @code{cdr} may also be a function which then has to return
25829
Dave Love <fx@gnu.org>
parents:
diff changeset
3831 the level.@refill
Dave Love <fx@gnu.org>
parents:
diff changeset
3832 @end defopt
Dave Love <fx@gnu.org>
parents:
diff changeset
3833
Dave Love <fx@gnu.org>
parents:
diff changeset
3834 @defopt reftex-section-prefixes
Dave Love <fx@gnu.org>
parents:
diff changeset
3835 Prefixes for section labels. When the label prefix given in an entry in
Dave Love <fx@gnu.org>
parents:
diff changeset
3836 @code{reftex-label-alist} contains @samp{%S}, this list is used to
Dave Love <fx@gnu.org>
parents:
diff changeset
3837 determine the correct prefix string depending on the current section
Dave Love <fx@gnu.org>
parents:
diff changeset
3838 level. The list is an alist, with each entry of the form
Dave Love <fx@gnu.org>
parents:
diff changeset
3839 @w{@code{(@var{key} . @var{prefix})}}. Possible keys are sectioning macro
Dave Love <fx@gnu.org>
parents:
diff changeset
3840 names like @samp{chapter}, integer section levels (as given in
Dave Love <fx@gnu.org>
parents:
diff changeset
3841 @code{reftex-section-levels}), and @code{t} for the default.
Dave Love <fx@gnu.org>
parents:
diff changeset
3842 @end defopt
Dave Love <fx@gnu.org>
parents:
diff changeset
3843
Dave Love <fx@gnu.org>
parents:
diff changeset
3844 @defopt reftex-default-context-regexps
Dave Love <fx@gnu.org>
parents:
diff changeset
3845 Alist with default regular expressions for finding context. The emacs
Dave Love <fx@gnu.org>
parents:
diff changeset
3846 lisp form @w{@code{(format regexp (regexp-quote environment))}} is used
Dave Love <fx@gnu.org>
parents:
diff changeset
3847 to calculate the final regular expression - so @samp{%s} will be
Dave Love <fx@gnu.org>
parents:
diff changeset
3848 replaced with the environment or macro.@refill
Dave Love <fx@gnu.org>
parents:
diff changeset
3849 @end defopt
Dave Love <fx@gnu.org>
parents:
diff changeset
3850
Dave Love <fx@gnu.org>
parents:
diff changeset
3851 @node Options (Creating Labels), Options (Referencing Labels), Options (Defining Label Environments), Options
Dave Love <fx@gnu.org>
parents:
diff changeset
3852 @section Creating Labels
Dave Love <fx@gnu.org>
parents:
diff changeset
3853 @cindex Options, creating labels
Dave Love <fx@gnu.org>
parents:
diff changeset
3854 @cindex Creating labels, options
Dave Love <fx@gnu.org>
parents:
diff changeset
3855
Dave Love <fx@gnu.org>
parents:
diff changeset
3856 @defopt reftex-insert-label-flags
Dave Love <fx@gnu.org>
parents:
diff changeset
3857 Flags governing label insertion. The value has the form
Dave Love <fx@gnu.org>
parents:
diff changeset
3858
Dave Love <fx@gnu.org>
parents:
diff changeset
3859 @example
Dave Love <fx@gnu.org>
parents:
diff changeset
3860 (@var{derive} @var{prompt})
Dave Love <fx@gnu.org>
parents:
diff changeset
3861 @end example
Dave Love <fx@gnu.org>
parents:
diff changeset
3862
Dave Love <fx@gnu.org>
parents:
diff changeset
3863 If @var{derive}is @code{t}, @b{Ref@TeX{}} will try to derive a sensible
Dave Love <fx@gnu.org>
parents:
diff changeset
3864 label from context. A section label for example will be derived from
Dave Love <fx@gnu.org>
parents:
diff changeset
3865 the section heading. The conversion of the context to a legal label is
Dave Love <fx@gnu.org>
parents:
diff changeset
3866 governed by the specifications given in
Dave Love <fx@gnu.org>
parents:
diff changeset
3867 @code{reftex-derive-label-parameters}. If @var{derive} is @code{nil},
Dave Love <fx@gnu.org>
parents:
diff changeset
3868 the default label will consist of the prefix and a unique number, like
Dave Love <fx@gnu.org>
parents:
diff changeset
3869 @samp{eq:23}.@refill
Dave Love <fx@gnu.org>
parents:
diff changeset
3870
Dave Love <fx@gnu.org>
parents:
diff changeset
3871 If @var{prompt} is @code{t}, the user will be prompted for a label
Dave Love <fx@gnu.org>
parents:
diff changeset
3872 string. When @var{prompt} is @code{nil}, the default label will be
Dave Love <fx@gnu.org>
parents:
diff changeset
3873 inserted without query.@refill
Dave Love <fx@gnu.org>
parents:
diff changeset
3874
Dave Love <fx@gnu.org>
parents:
diff changeset
3875 So the combination of @var{derive} and @var{prompt} controls label
Dave Love <fx@gnu.org>
parents:
diff changeset
3876 insertion. Here is a table describing all four possibilities:@refill
Dave Love <fx@gnu.org>
parents:
diff changeset
3877
Dave Love <fx@gnu.org>
parents:
diff changeset
3878 @example
Dave Love <fx@gnu.org>
parents:
diff changeset
3879 @group
Dave Love <fx@gnu.org>
parents:
diff changeset
3880 @var{derive} @var{prompt} @var{action}
Dave Love <fx@gnu.org>
parents:
diff changeset
3881 -----------------------------------------------------------
Dave Love <fx@gnu.org>
parents:
diff changeset
3882 nil nil @r{Insert simple label, like @samp{eq:22} or @samp{sec:13}. No query.}
Dave Love <fx@gnu.org>
parents:
diff changeset
3883 nil t @r{Prompt for label.}
Dave Love <fx@gnu.org>
parents:
diff changeset
3884 t nil @r{Derive a label from context and insert. No query.}
Dave Love <fx@gnu.org>
parents:
diff changeset
3885 t t @r{Derive a label from context, prompt for confirmation.}
Dave Love <fx@gnu.org>
parents:
diff changeset
3886 @end group
Dave Love <fx@gnu.org>
parents:
diff changeset
3887 @end example
Dave Love <fx@gnu.org>
parents:
diff changeset
3888
Dave Love <fx@gnu.org>
parents:
diff changeset
3889 Each flag may be set to @code{t}, @code{nil}, or a string of label type
Dave Love <fx@gnu.org>
parents:
diff changeset
3890 letters indicating the label types for which it should be true. Thus,
Dave Love <fx@gnu.org>
parents:
diff changeset
3891 the combination may be set differently for each label type. The default
Dave Love <fx@gnu.org>
parents:
diff changeset
3892 settings @samp{"s"} and @samp{"sft"} mean: Derive section labels from
Dave Love <fx@gnu.org>
parents:
diff changeset
3893 headings (with confirmation). Prompt for figure and table labels. Use
Dave Love <fx@gnu.org>
parents:
diff changeset
3894 simple labels without confirmation for everything else.@refill
Dave Love <fx@gnu.org>
parents:
diff changeset
3895
Dave Love <fx@gnu.org>
parents:
diff changeset
3896 The available label types are: @code{s} (section), @code{f} (figure),
Dave Love <fx@gnu.org>
parents:
diff changeset
3897 @code{t} (table), @code{i} (item), @code{e} (equation), @code{n}
Dave Love <fx@gnu.org>
parents:
diff changeset
3898 (footnote), @code{N} (endnote) plus any definitions in
Dave Love <fx@gnu.org>
parents:
diff changeset
3899 @code{reftex-label-alist}.@refill
Dave Love <fx@gnu.org>
parents:
diff changeset
3900 @end defopt
Dave Love <fx@gnu.org>
parents:
diff changeset
3901
Dave Love <fx@gnu.org>
parents:
diff changeset
3902 @deffn Hook reftex-format-label-function
Dave Love <fx@gnu.org>
parents:
diff changeset
3903 If non-@code{nil}, should be a function which produces the string to
Dave Love <fx@gnu.org>
parents:
diff changeset
3904 insert as a label definition. The function will be called with two
Dave Love <fx@gnu.org>
parents:
diff changeset
3905 arguments, the @var{label} and the @var{default-format} (usually
Dave Love <fx@gnu.org>
parents:
diff changeset
3906 @samp{\label@{%s@}}). It should return the string to insert into the
Dave Love <fx@gnu.org>
parents:
diff changeset
3907 buffer.@refill
Dave Love <fx@gnu.org>
parents:
diff changeset
3908 @end deffn
Dave Love <fx@gnu.org>
parents:
diff changeset
3909
Dave Love <fx@gnu.org>
parents:
diff changeset
3910 @deffn Hook reftex-string-to-label-function
Dave Love <fx@gnu.org>
parents:
diff changeset
3911 Function to turn an arbitrary string into a legal label.
Dave Love <fx@gnu.org>
parents:
diff changeset
3912 @b{Ref@TeX{}}'s default function uses the variable
Dave Love <fx@gnu.org>
parents:
diff changeset
3913 @code{reftex-derive-label-parameters}.@refill
Dave Love <fx@gnu.org>
parents:
diff changeset
3914 @end deffn
Dave Love <fx@gnu.org>
parents:
diff changeset
3915
Dave Love <fx@gnu.org>
parents:
diff changeset
3916 @deffn Hook reftex-translate-to-ascii-function
Dave Love <fx@gnu.org>
parents:
diff changeset
3917 Filter function which will process a context string before it is used to
Dave Love <fx@gnu.org>
parents:
diff changeset
3918 derive a label from it. The intended application is to convert ISO or
Dave Love <fx@gnu.org>
parents:
diff changeset
3919 Mule characters into something legal in labels. The default function
Dave Love <fx@gnu.org>
parents:
diff changeset
3920 @code{reftex-latin1-to-ascii} removes the accents from Latin-1
Dave Love <fx@gnu.org>
parents:
diff changeset
3921 characters. X-Symbol (>=2.6) sets this variable to the much more
Dave Love <fx@gnu.org>
parents:
diff changeset
3922 general @code{x-symbol-translate-to-ascii}.@refill
Dave Love <fx@gnu.org>
parents:
diff changeset
3923 @end deffn
Dave Love <fx@gnu.org>
parents:
diff changeset
3924
Dave Love <fx@gnu.org>
parents:
diff changeset
3925 @defopt reftex-derive-label-parameters
Dave Love <fx@gnu.org>
parents:
diff changeset
3926 Parameters for converting a string into a label. This variable is a
Dave Love <fx@gnu.org>
parents:
diff changeset
3927 list of the following items:@refill
Dave Love <fx@gnu.org>
parents:
diff changeset
3928 @table @asis
Dave Love <fx@gnu.org>
parents:
diff changeset
3929 @item @var{nwords}
Dave Love <fx@gnu.org>
parents:
diff changeset
3930 Number of words to use.
Dave Love <fx@gnu.org>
parents:
diff changeset
3931 @item @var{maxchar}
Dave Love <fx@gnu.org>
parents:
diff changeset
3932 Maximum number of characters in a label string.
Dave Love <fx@gnu.org>
parents:
diff changeset
3933 @item @var{illegal}
Dave Love <fx@gnu.org>
parents:
diff changeset
3934 @code{nil}: Throw away any words containing characters illegal in labels.@*
Dave Love <fx@gnu.org>
parents:
diff changeset
3935 @code{t}: Throw away only the illegal characters, not the whole word.
Dave Love <fx@gnu.org>
parents:
diff changeset
3936 @item @var{abbrev}
Dave Love <fx@gnu.org>
parents:
diff changeset
3937 @code{nil}: Never abbreviate words.@*
Dave Love <fx@gnu.org>
parents:
diff changeset
3938 @code{t}: Always abbreviate words (see @code{reftex-abbrev-parameters}).@*
Dave Love <fx@gnu.org>
parents:
diff changeset
3939 @code{1}: Abbreviate words if necessary to shorten label string.
Dave Love <fx@gnu.org>
parents:
diff changeset
3940 @item @var{separator}
Dave Love <fx@gnu.org>
parents:
diff changeset
3941 String separating different words in the label.
Dave Love <fx@gnu.org>
parents:
diff changeset
3942 @item @var{ignorewords}
Dave Love <fx@gnu.org>
parents:
diff changeset
3943 List of words which should not be part of labels.
Dave Love <fx@gnu.org>
parents:
diff changeset
3944 @item @var{downcase}
Dave Love <fx@gnu.org>
parents:
diff changeset
3945 @code{t}: Downcase words before putting them into the label.@*
Dave Love <fx@gnu.org>
parents:
diff changeset
3946 @end table
Dave Love <fx@gnu.org>
parents:
diff changeset
3947 @end defopt
Dave Love <fx@gnu.org>
parents:
diff changeset
3948
Dave Love <fx@gnu.org>
parents:
diff changeset
3949 @defopt reftex-label-illegal-re
Dave Love <fx@gnu.org>
parents:
diff changeset
3950 Regexp matching characters not legal in labels.
Dave Love <fx@gnu.org>
parents:
diff changeset
3951 @end defopt
Dave Love <fx@gnu.org>
parents:
diff changeset
3952
Dave Love <fx@gnu.org>
parents:
diff changeset
3953 @defopt reftex-abbrev-parameters
Dave Love <fx@gnu.org>
parents:
diff changeset
3954 Parameters for abbreviation of words. A list of four parameters.@refill
Dave Love <fx@gnu.org>
parents:
diff changeset
3955 @table @asis
Dave Love <fx@gnu.org>
parents:
diff changeset
3956 @item @var{min-chars}
Dave Love <fx@gnu.org>
parents:
diff changeset
3957 Minimum number of characters remaining after abbreviation.
Dave Love <fx@gnu.org>
parents:
diff changeset
3958 @item @var{min-kill}
Dave Love <fx@gnu.org>
parents:
diff changeset
3959 Minimum number of characters to remove when abbreviating words.@refill
Dave Love <fx@gnu.org>
parents:
diff changeset
3960 @item @var{before}
Dave Love <fx@gnu.org>
parents:
diff changeset
3961 Character class before abbrev point in word.@refill
Dave Love <fx@gnu.org>
parents:
diff changeset
3962 @item @var{after}
Dave Love <fx@gnu.org>
parents:
diff changeset
3963 Character class after abbrev point in word.@refill
Dave Love <fx@gnu.org>
parents:
diff changeset
3964 @end table
Dave Love <fx@gnu.org>
parents:
diff changeset
3965 @end defopt
Dave Love <fx@gnu.org>
parents:
diff changeset
3966
Dave Love <fx@gnu.org>
parents:
diff changeset
3967 @node Options (Referencing Labels), Options (Creating Citations), Options (Creating Labels), Options
Dave Love <fx@gnu.org>
parents:
diff changeset
3968 @section Referencing Labels
Dave Love <fx@gnu.org>
parents:
diff changeset
3969 @cindex Options, referencing labels
Dave Love <fx@gnu.org>
parents:
diff changeset
3970 @cindex Referencing labels, options
Dave Love <fx@gnu.org>
parents:
diff changeset
3971
Dave Love <fx@gnu.org>
parents:
diff changeset
3972 @defopt reftex-label-menu-flags
Dave Love <fx@gnu.org>
parents:
diff changeset
3973 List of flags governing the label menu makeup. The flags are:
Dave Love <fx@gnu.org>
parents:
diff changeset
3974 @table @asis
Dave Love <fx@gnu.org>
parents:
diff changeset
3975 @item @var{table-of-contents}
Dave Love <fx@gnu.org>
parents:
diff changeset
3976 Show the labels embedded in a table of context.@refill
Dave Love <fx@gnu.org>
parents:
diff changeset
3977 @item @var{section-numbers}
Dave Love <fx@gnu.org>
parents:
diff changeset
3978 Include section numbers (like 4.1.3) in table of contents.@refill
Dave Love <fx@gnu.org>
parents:
diff changeset
3979 @item @var{counters}
Dave Love <fx@gnu.org>
parents:
diff changeset
3980 Show counters. This just numbers the labels in the menu.@refill
Dave Love <fx@gnu.org>
parents:
diff changeset
3981 @item @var{no-context}
Dave Love <fx@gnu.org>
parents:
diff changeset
3982 Non-@code{nil} means do @emph{not} show the short context.@refill
Dave Love <fx@gnu.org>
parents:
diff changeset
3983 @item @var{follow}
Dave Love <fx@gnu.org>
parents:
diff changeset
3984 Follow full context in other window.@refill
Dave Love <fx@gnu.org>
parents:
diff changeset
3985 @item @var{show-commented}
Dave Love <fx@gnu.org>
parents:
diff changeset
3986 Show labels from regions which are commented out.@refill
Dave Love <fx@gnu.org>
parents:
diff changeset
3987 @item @var{match-everywhere}
Dave Love <fx@gnu.org>
parents:
diff changeset
3988 Obsolete flag.@refill
Dave Love <fx@gnu.org>
parents:
diff changeset
3989 @item @var{show-files}
Dave Love <fx@gnu.org>
parents:
diff changeset
3990 Show begin and end of included files.@refill
Dave Love <fx@gnu.org>
parents:
diff changeset
3991 @end table
Dave Love <fx@gnu.org>
parents:
diff changeset
3992
Dave Love <fx@gnu.org>
parents:
diff changeset
3993 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
3994 of type letters indicating the label types for which it should be true.
Dave Love <fx@gnu.org>
parents:
diff changeset
3995 These strings work like character classes in regular expressions. Thus,
Dave Love <fx@gnu.org>
parents:
diff changeset
3996 setting one of the flags to @samp{"sf"} makes the flag true for section
Dave Love <fx@gnu.org>
parents:
diff changeset
3997 and figure labels, @code{nil} for everything else. Setting it to
Dave Love <fx@gnu.org>
parents:
diff changeset
3998 @samp{"^sf"} makes it the other way round.@refill
Dave Love <fx@gnu.org>
parents:
diff changeset
3999
Dave Love <fx@gnu.org>
parents:
diff changeset
4000 The available label types are: @code{s} (section), @code{f} (figure),
Dave Love <fx@gnu.org>
parents:
diff changeset
4001 @code{t} (table), @code{i} (item), @code{e} (equation), @code{n}
Dave Love <fx@gnu.org>
parents:
diff changeset
4002 (footnote), plus any definitions in @code{reftex-label-alist}.@refill
Dave Love <fx@gnu.org>
parents:
diff changeset
4003
Dave Love <fx@gnu.org>
parents:
diff changeset
4004 Most options can also be switched from the label menu itself - so if you
Dave Love <fx@gnu.org>
parents:
diff changeset
4005 decide here to not have a table of contents in the label menu, you can
Dave Love <fx@gnu.org>
parents:
diff changeset
4006 still get one interactively during selection from the label menu.@refill
Dave Love <fx@gnu.org>
parents:
diff changeset
4007 @end defopt
Dave Love <fx@gnu.org>
parents:
diff changeset
4008
Dave Love <fx@gnu.org>
parents:
diff changeset
4009 @defopt reftex-multiref-punctuation
Dave Love <fx@gnu.org>
parents:
diff changeset
4010 Punctuation strings for multiple references. When marking is used in
Dave Love <fx@gnu.org>
parents:
diff changeset
4011 the selection buffer to select several references, this variable
Dave Love <fx@gnu.org>
parents:
diff changeset
4012 associates the 3 marking characters @samp{,-+} with prefix strings to be
Dave Love <fx@gnu.org>
parents:
diff changeset
4013 inserted into the buffer before the corresponding @code{\ref} macro.
Dave Love <fx@gnu.org>
parents:
diff changeset
4014 This is used to string together whole reference sets, like
Dave Love <fx@gnu.org>
parents:
diff changeset
4015 @samp{eqs. 1,2,3-5,6 and 7} in a single call to
Dave Love <fx@gnu.org>
parents:
diff changeset
4016 @code{reftex-reference}.@refill
Dave Love <fx@gnu.org>
parents:
diff changeset
4017 @end defopt
Dave Love <fx@gnu.org>
parents:
diff changeset
4018
Dave Love <fx@gnu.org>
parents:
diff changeset
4019 @defopt reftex-vref-is-default
Dave Love <fx@gnu.org>
parents:
diff changeset
4020 Non-@code{nil} means, the varioref macro @code{\vref} is used as
Dave Love <fx@gnu.org>
parents:
diff changeset
4021 default. In the selection buffer, the @kbd{v} key toggles the reference
Dave Love <fx@gnu.org>
parents:
diff changeset
4022 macro between @code{\ref} and @code{\vref}. The value of this variable
Dave Love <fx@gnu.org>
parents:
diff changeset
4023 determines the default which is active when entering the selection
Dave Love <fx@gnu.org>
parents:
diff changeset
4024 process. Instead of @code{nil} or @code{t}, this may also be a string
Dave Love <fx@gnu.org>
parents:
diff changeset
4025 of type letters indicating the label types for which it should be
Dave Love <fx@gnu.org>
parents:
diff changeset
4026 true.@refill
Dave Love <fx@gnu.org>
parents:
diff changeset
4027 @end defopt
Dave Love <fx@gnu.org>
parents:
diff changeset
4028
Dave Love <fx@gnu.org>
parents:
diff changeset
4029 @defopt reftex-fref-is-default
Dave Love <fx@gnu.org>
parents:
diff changeset
4030 Non-@code{nil} means, the fancyref macro @code{\fref} is used as
Dave Love <fx@gnu.org>
parents:
diff changeset
4031 default. In the selection buffer, the @kbd{V} key toggles the reference
Dave Love <fx@gnu.org>
parents:
diff changeset
4032 macro between @code{\ref}, @code{\fref} and @code{\Fref}. The value of
Dave Love <fx@gnu.org>
parents:
diff changeset
4033 this variable determines the default which is active when entering the
Dave Love <fx@gnu.org>
parents:
diff changeset
4034 selection process. Instead of @code{nil} or @code{t}, this may also be
Dave Love <fx@gnu.org>
parents:
diff changeset
4035 a string of type letters indicating the label types for which it should
Dave Love <fx@gnu.org>
parents:
diff changeset
4036 be true.
Dave Love <fx@gnu.org>
parents:
diff changeset
4037 @end defopt
Dave Love <fx@gnu.org>
parents:
diff changeset
4038
Dave Love <fx@gnu.org>
parents:
diff changeset
4039 @deffn Hook reftex-format-ref-function
Dave Love <fx@gnu.org>
parents:
diff changeset
4040 If non-@code{nil}, should be a function which produces the string to
Dave Love <fx@gnu.org>
parents:
diff changeset
4041 insert as a reference. Note that the insertion format can also be
Dave Love <fx@gnu.org>
parents:
diff changeset
4042 changed with @code{reftex-label-alist}. This hook also is used by the
Dave Love <fx@gnu.org>
parents:
diff changeset
4043 special commands to insert @code{\vref} and @code{\fref} references, so
Dave Love <fx@gnu.org>
parents:
diff changeset
4044 even if you set this, your setting will be ignored by the special
Dave Love <fx@gnu.org>
parents:
diff changeset
4045 commands. The function will be called with two arguments, the
Dave Love <fx@gnu.org>
parents:
diff changeset
4046 @var{label} and the @var{default-format} (usually @samp{~\ref@{%s@}}).
Dave Love <fx@gnu.org>
parents:
diff changeset
4047 It should return the string to insert into the buffer.@refill
Dave Love <fx@gnu.org>
parents:
diff changeset
4048 @end deffn
Dave Love <fx@gnu.org>
parents:
diff changeset
4049
Dave Love <fx@gnu.org>
parents:
diff changeset
4050 @defopt reftex-level-indent
Dave Love <fx@gnu.org>
parents:
diff changeset
4051 Number of spaces to be used for indentation per section level.@refill
Dave Love <fx@gnu.org>
parents:
diff changeset
4052 @end defopt
Dave Love <fx@gnu.org>
parents:
diff changeset
4053
Dave Love <fx@gnu.org>
parents:
diff changeset
4054 @defopt reftex-guess-label-type
Dave Love <fx@gnu.org>
parents:
diff changeset
4055 Non-@code{nil} means, @code{reftex-reference} will try to guess the
Dave Love <fx@gnu.org>
parents:
diff changeset
4056 label type. To do that, @b{Ref@TeX{}} will look at the word before the
Dave Love <fx@gnu.org>
parents:
diff changeset
4057 cursor and compare it with the magic words given in
Dave Love <fx@gnu.org>
parents:
diff changeset
4058 @code{reftex-label-alist}. When it finds a match, @b{Ref@TeX{}} will
Dave Love <fx@gnu.org>
parents:
diff changeset
4059 immediately offer the correct label menu - otherwise it will prompt you
Dave Love <fx@gnu.org>
parents:
diff changeset
4060 for a label type. If you set this variable to @code{nil}, @b{Ref@TeX{}}
Dave Love <fx@gnu.org>
parents:
diff changeset
4061 will always prompt for a label type.@refill
Dave Love <fx@gnu.org>
parents:
diff changeset
4062 @end defopt
Dave Love <fx@gnu.org>
parents:
diff changeset
4063
Dave Love <fx@gnu.org>
parents:
diff changeset
4064 @deffn {Normal Hook} reftex-display-copied-context-hook
Dave Love <fx@gnu.org>
parents:
diff changeset
4065 Normal Hook which is run before context is displayed anywhere. Designed
Dave Love <fx@gnu.org>
parents:
diff changeset
4066 for @w{@code{X-Symbol}}, but may have other uses as well.@refill
Dave Love <fx@gnu.org>
parents:
diff changeset
4067 @end deffn
Dave Love <fx@gnu.org>
parents:
diff changeset
4068
Dave Love <fx@gnu.org>
parents:
diff changeset
4069 @deffn Hook reftex-pre-refontification-functions
Dave Love <fx@gnu.org>
parents:
diff changeset
4070 @code{X-Symbol} specific hook. Probably not useful for other purposes.
Dave Love <fx@gnu.org>
parents:
diff changeset
4071 The functions get two arguments, the buffer from where the command
Dave Love <fx@gnu.org>
parents:
diff changeset
4072 started and a symbol indicating in what context the hook is
Dave Love <fx@gnu.org>
parents:
diff changeset
4073 called.@refill
Dave Love <fx@gnu.org>
parents:
diff changeset
4074 @end deffn
Dave Love <fx@gnu.org>
parents:
diff changeset
4075
Dave Love <fx@gnu.org>
parents:
diff changeset
4076 @deffn {Normal Hook} reftex-select-label-mode-hook
Dave Love <fx@gnu.org>
parents:
diff changeset
4077 Normal hook which is run when a selection buffer enters
Dave Love <fx@gnu.org>
parents:
diff changeset
4078 @code{reftex-select-label-mode}.@refill
Dave Love <fx@gnu.org>
parents:
diff changeset
4079 @end deffn
Dave Love <fx@gnu.org>
parents:
diff changeset
4080
Dave Love <fx@gnu.org>
parents:
diff changeset
4081 @deffn Keymap reftex-select-label-map
Dave Love <fx@gnu.org>
parents:
diff changeset
4082 The keymap which is active in the labels selection process
Dave Love <fx@gnu.org>
parents:
diff changeset
4083 (@pxref{Referencing Labels}).@refill
Dave Love <fx@gnu.org>
parents:
diff changeset
4084 @end deffn
Dave Love <fx@gnu.org>
parents:
diff changeset
4085
Dave Love <fx@gnu.org>
parents:
diff changeset
4086 @node Options (Creating Citations), Options (Index Support), Options (Referencing Labels), Options
Dave Love <fx@gnu.org>
parents:
diff changeset
4087 @section Creating Citations
Dave Love <fx@gnu.org>
parents:
diff changeset
4088 @cindex Options, creating citations
Dave Love <fx@gnu.org>
parents:
diff changeset
4089 @cindex Creating citations, options
Dave Love <fx@gnu.org>
parents:
diff changeset
4090
Dave Love <fx@gnu.org>
parents:
diff changeset
4091 @defopt reftex-bibfile-ignore-regexps
Dave Love <fx@gnu.org>
parents:
diff changeset
4092 List of regular expressions to exclude files in
Dave Love <fx@gnu.org>
parents:
diff changeset
4093 @code{\\bibliography@{..@}}. File names matched by any of these regexps
Dave Love <fx@gnu.org>
parents:
diff changeset
4094 will not be parsed. Intended for files which contain only
Dave Love <fx@gnu.org>
parents:
diff changeset
4095 @code{@@string} macro definitions and the like, which are ignored by
Dave Love <fx@gnu.org>
parents:
diff changeset
4096 @b{Ref@TeX{}} anyway.@refill
Dave Love <fx@gnu.org>
parents:
diff changeset
4097 @end defopt
Dave Love <fx@gnu.org>
parents:
diff changeset
4098
Dave Love <fx@gnu.org>
parents:
diff changeset
4099 @defopt reftex-default-bibliography
Dave Love <fx@gnu.org>
parents:
diff changeset
4100 List of BibTeX database files which should be used if none are specified.
Dave Love <fx@gnu.org>
parents:
diff changeset
4101 When @code{reftex-citation} is called from a document with neither
Dave Love <fx@gnu.org>
parents:
diff changeset
4102 a @samp{\bibliography@{...@}} statement nor a @code{thebibliography}
Dave Love <fx@gnu.org>
parents:
diff changeset
4103 environment, @b{Ref@TeX{}} will scan these files instead. Intended for
Dave Love <fx@gnu.org>
parents:
diff changeset
4104 using @code{reftex-citation} in non-LaTeX files. The files will be
Dave Love <fx@gnu.org>
parents:
diff changeset
4105 searched along the BIBINPUTS or TEXBIB path.@refill
Dave Love <fx@gnu.org>
parents:
diff changeset
4106 @end defopt
Dave Love <fx@gnu.org>
parents:
diff changeset
4107
Dave Love <fx@gnu.org>
parents:
diff changeset
4108 @defopt reftex-sort-bibtex-matches
Dave Love <fx@gnu.org>
parents:
diff changeset
4109 Sorting of the entries found in BibTeX databases by reftex-citation.
Dave Love <fx@gnu.org>
parents:
diff changeset
4110 Possible values:@refill
Dave Love <fx@gnu.org>
parents:
diff changeset
4111 @example
Dave Love <fx@gnu.org>
parents:
diff changeset
4112 nil @r{Do not sort entries.}
Dave Love <fx@gnu.org>
parents:
diff changeset
4113 author @r{Sort entries by author name.}
Dave Love <fx@gnu.org>
parents:
diff changeset
4114 year @r{Sort entries by increasing year.}
Dave Love <fx@gnu.org>
parents:
diff changeset
4115 reverse-year @r{Sort entries by decreasing year.}
Dave Love <fx@gnu.org>
parents:
diff changeset
4116 @end example
Dave Love <fx@gnu.org>
parents:
diff changeset
4117 @end defopt
Dave Love <fx@gnu.org>
parents:
diff changeset
4118
Dave Love <fx@gnu.org>
parents:
diff changeset
4119 @defopt reftex-cite-format
Dave Love <fx@gnu.org>
parents:
diff changeset
4120 The format of citations to be inserted into the buffer. It can be a
Dave Love <fx@gnu.org>
parents:
diff changeset
4121 string, an alist or a symbol. In the simplest case this is just the string
Dave Love <fx@gnu.org>
parents:
diff changeset
4122 @samp{\cite@{%l@}}, which is also the default. See the definition of
Dave Love <fx@gnu.org>
parents:
diff changeset
4123 @code{reftex-cite-format-builtin} for more complex examples.@refill
Dave Love <fx@gnu.org>
parents:
diff changeset
4124
Dave Love <fx@gnu.org>
parents:
diff changeset
4125 If @code{reftex-cite-format} is a string, it will be used as the format.
Dave Love <fx@gnu.org>
parents:
diff changeset
4126 In the format, the following percent escapes will be expanded.@refill
Dave Love <fx@gnu.org>
parents:
diff changeset
4127
Dave Love <fx@gnu.org>
parents:
diff changeset
4128 @table @code
Dave Love <fx@gnu.org>
parents:
diff changeset
4129 @item %l
Dave Love <fx@gnu.org>
parents:
diff changeset
4130 The BibTeX label of the citation.
Dave Love <fx@gnu.org>
parents:
diff changeset
4131 @item %a
Dave Love <fx@gnu.org>
parents:
diff changeset
4132 List of author names, see also @code{reftex-cite-punctuation}.
Dave Love <fx@gnu.org>
parents:
diff changeset
4133 @item %2a
Dave Love <fx@gnu.org>
parents:
diff changeset
4134 Like %a, but abbreviate more than 2 authors like Jones et al.
Dave Love <fx@gnu.org>
parents:
diff changeset
4135 @item %A
Dave Love <fx@gnu.org>
parents:
diff changeset
4136 First author name only.
Dave Love <fx@gnu.org>
parents:
diff changeset
4137 @item %e
Dave Love <fx@gnu.org>
parents:
diff changeset
4138 Works like @samp{%a}, but on list of editor names. (@samp{%2e} and
Dave Love <fx@gnu.org>
parents:
diff changeset
4139 @samp{%E} work a well).@refill
Dave Love <fx@gnu.org>
parents:
diff changeset
4140 @end table
Dave Love <fx@gnu.org>
parents:
diff changeset
4141
Dave Love <fx@gnu.org>
parents:
diff changeset
4142 It is also possible to access all other BibTeX database fields:
Dave Love <fx@gnu.org>
parents:
diff changeset
4143
Dave Love <fx@gnu.org>
parents:
diff changeset
4144 @example
Dave Love <fx@gnu.org>
parents:
diff changeset
4145 %b booktitle %c chapter %d edition %h howpublished
Dave Love <fx@gnu.org>
parents:
diff changeset
4146 %i institution %j journal %k key %m month
Dave Love <fx@gnu.org>
parents:
diff changeset
4147 %n number %o organization %p pages %P first page
Dave Love <fx@gnu.org>
parents:
diff changeset
4148 %r address %s school %u publisher %t title
Dave Love <fx@gnu.org>
parents:
diff changeset
4149 %v volume %y year
Dave Love <fx@gnu.org>
parents:
diff changeset
4150 %B booktitle, abbreviated %T title, abbreviated
Dave Love <fx@gnu.org>
parents:
diff changeset
4151 @end example
Dave Love <fx@gnu.org>
parents:
diff changeset
4152
Dave Love <fx@gnu.org>
parents:
diff changeset
4153 @noindent
Dave Love <fx@gnu.org>
parents:
diff changeset
4154 Usually, only @samp{%l} is needed. The other stuff is mainly for the
Dave Love <fx@gnu.org>
parents:
diff changeset
4155 echo area display, and for @code{(setq reftex-comment-citations t)}.@refill
Dave Love <fx@gnu.org>
parents:
diff changeset
4156
Dave Love <fx@gnu.org>
parents:
diff changeset
4157 @samp{%<} as a special operator kills punctuation and space around it
Dave Love <fx@gnu.org>
parents:
diff changeset
4158 after the string has been formatted.@refill
Dave Love <fx@gnu.org>
parents:
diff changeset
4159
Dave Love <fx@gnu.org>
parents:
diff changeset
4160 Beware that all this only works with BibTeX database files. When
Dave Love <fx@gnu.org>
parents:
diff changeset
4161 citations are made from the @code{\bibitems} in an explicit
Dave Love <fx@gnu.org>
parents:
diff changeset
4162 @code{thebibliography} environment, only @samp{%l} is available.@refill
Dave Love <fx@gnu.org>
parents:
diff changeset
4163
Dave Love <fx@gnu.org>
parents:
diff changeset
4164 If @code{reftex-cite-format} is an alist of characters and strings, the
Dave Love <fx@gnu.org>
parents:
diff changeset
4165 user will be prompted for a character to select one of the possible
Dave Love <fx@gnu.org>
parents:
diff changeset
4166 format strings.@refill
Dave Love <fx@gnu.org>
parents:
diff changeset
4167
Dave Love <fx@gnu.org>
parents:
diff changeset
4168 In order to configure this variable, you can either set
Dave Love <fx@gnu.org>
parents:
diff changeset
4169 @code{reftex-cite-format} directly yourself or set it to the
Dave Love <fx@gnu.org>
parents:
diff changeset
4170 @emph{symbol} of one of the predefined styles. The predefined symbols
Dave Love <fx@gnu.org>
parents:
diff changeset
4171 are those which have an association in the constant
Dave Love <fx@gnu.org>
parents:
diff changeset
4172 @code{reftex-cite-format-builtin}) E.g.: @code{(setq reftex-cite-format
Dave Love <fx@gnu.org>
parents:
diff changeset
4173 'natbib)}.@refill
Dave Love <fx@gnu.org>
parents:
diff changeset
4174 @end defopt
Dave Love <fx@gnu.org>
parents:
diff changeset
4175
Dave Love <fx@gnu.org>
parents:
diff changeset
4176 @deffn Hook reftex-format-cite-function
Dave Love <fx@gnu.org>
parents:
diff changeset
4177
Dave Love <fx@gnu.org>
parents:
diff changeset
4178 If non-@code{nil}, should be a function which produces the string to
Dave Love <fx@gnu.org>
parents:
diff changeset
4179 insert as a citation. Note that the citation format can also be changed
Dave Love <fx@gnu.org>
parents:
diff changeset
4180 with the variable @code{reftex-cite-format}. The function will be
Dave Love <fx@gnu.org>
parents:
diff changeset
4181 called with two arguments, the @var{citation-key} and the
Dave Love <fx@gnu.org>
parents:
diff changeset
4182 @var{default-format} (taken from @code{reftex-cite-format}). It should
Dave Love <fx@gnu.org>
parents:
diff changeset
4183 return the string to insert into the buffer.@refill
Dave Love <fx@gnu.org>
parents:
diff changeset
4184 @end deffn
Dave Love <fx@gnu.org>
parents:
diff changeset
4185
Dave Love <fx@gnu.org>
parents:
diff changeset
4186 @defopt reftex-comment-citations
Dave Love <fx@gnu.org>
parents:
diff changeset
4187 Non-@code{nil} means add a comment for each citation describing the full
Dave Love <fx@gnu.org>
parents:
diff changeset
4188 entry. The comment is formatted according to
Dave Love <fx@gnu.org>
parents:
diff changeset
4189 @code{reftex-cite-comment-format}.@refill
Dave Love <fx@gnu.org>
parents:
diff changeset
4190 @end defopt
Dave Love <fx@gnu.org>
parents:
diff changeset
4191
Dave Love <fx@gnu.org>
parents:
diff changeset
4192 @defopt reftex-cite-comment-format
Dave Love <fx@gnu.org>
parents:
diff changeset
4193 Citation format used for commented citations. Must @emph{not} contain
Dave Love <fx@gnu.org>
parents:
diff changeset
4194 @samp{%l}. See the variable @code{reftex-cite-format} for possible
Dave Love <fx@gnu.org>
parents:
diff changeset
4195 percent escapes.@refill
Dave Love <fx@gnu.org>
parents:
diff changeset
4196 @end defopt
Dave Love <fx@gnu.org>
parents:
diff changeset
4197
Dave Love <fx@gnu.org>
parents:
diff changeset
4198 @defopt reftex-cite-punctuation
Dave Love <fx@gnu.org>
parents:
diff changeset
4199 Punctuation for formatting of name lists in citations. This is a list
Dave Love <fx@gnu.org>
parents:
diff changeset
4200 of 3 strings.@refill
Dave Love <fx@gnu.org>
parents:
diff changeset
4201 @enumerate
Dave Love <fx@gnu.org>
parents:
diff changeset
4202 @item
Dave Love <fx@gnu.org>
parents:
diff changeset
4203 normal names separator, like @samp{, } in Jones, Brown and Miller
Dave Love <fx@gnu.org>
parents:
diff changeset
4204 @item
Dave Love <fx@gnu.org>
parents:
diff changeset
4205 final names separator, like @samp{ and } in Jones, Brown and Miller
Dave Love <fx@gnu.org>
parents:
diff changeset
4206 @item
Dave Love <fx@gnu.org>
parents:
diff changeset
4207 The @samp{et al.} string, like @samp{ @{\it et al.@}} in
Dave Love <fx@gnu.org>
parents:
diff changeset
4208 Jones @{\it et al.@}
Dave Love <fx@gnu.org>
parents:
diff changeset
4209 @end enumerate
Dave Love <fx@gnu.org>
parents:
diff changeset
4210 @end defopt
Dave Love <fx@gnu.org>
parents:
diff changeset
4211
Dave Love <fx@gnu.org>
parents:
diff changeset
4212 @deffn {Normal Hook} reftex-select-bib-mode-hook
Dave Love <fx@gnu.org>
parents:
diff changeset
4213 Normal hook which is run when a selection buffer enters
Dave Love <fx@gnu.org>
parents:
diff changeset
4214 @code{reftex-select-bib-mode}.@refill
Dave Love <fx@gnu.org>
parents:
diff changeset
4215 @end deffn
Dave Love <fx@gnu.org>
parents:
diff changeset
4216
Dave Love <fx@gnu.org>
parents:
diff changeset
4217 @deffn Keymap reftex-select-bib-map
Dave Love <fx@gnu.org>
parents:
diff changeset
4218 The keymap which is active in the citation-key selection process
Dave Love <fx@gnu.org>
parents:
diff changeset
4219 (@pxref{Creating Citations}).@refill
Dave Love <fx@gnu.org>
parents:
diff changeset
4220 @end deffn
Dave Love <fx@gnu.org>
parents:
diff changeset
4221
Dave Love <fx@gnu.org>
parents:
diff changeset
4222 @node Options (Index Support), Options (Viewing Cross-References), Options (Creating Citations), Options
Dave Love <fx@gnu.org>
parents:
diff changeset
4223 @section Index Support
Dave Love <fx@gnu.org>
parents:
diff changeset
4224 @cindex Options, Index support
Dave Love <fx@gnu.org>
parents:
diff changeset
4225 @cindex Index support, options
Dave Love <fx@gnu.org>
parents:
diff changeset
4226
Dave Love <fx@gnu.org>
parents:
diff changeset
4227 @defopt reftex-support-index
Dave Love <fx@gnu.org>
parents:
diff changeset
4228 Non-@code{nil} means, index entries are parsed as well. Index support
Dave Love <fx@gnu.org>
parents:
diff changeset
4229 is resource intensive and the internal structure holding the parsed
Dave Love <fx@gnu.org>
parents:
diff changeset
4230 information can become quite big. Therefore it can be turned off. When
Dave Love <fx@gnu.org>
parents:
diff changeset
4231 this is @code{nil} and you execute a command which requires index
Dave Love <fx@gnu.org>
parents:
diff changeset
4232 support, you will be asked for confirmation to turn it on and rescan the
Dave Love <fx@gnu.org>
parents:
diff changeset
4233 document.@refill
Dave Love <fx@gnu.org>
parents:
diff changeset
4234 @end defopt
Dave Love <fx@gnu.org>
parents:
diff changeset
4235
Dave Love <fx@gnu.org>
parents:
diff changeset
4236 @defopt reftex-index-special-chars
Dave Love <fx@gnu.org>
parents:
diff changeset
4237 List of special characters in index entries, given as strings. These
Dave Love <fx@gnu.org>
parents:
diff changeset
4238 correspond to the @code{MakeIndex} keywords
Dave Love <fx@gnu.org>
parents:
diff changeset
4239 @code{(@var{level} @var{encap} @var{actual} @var{quote} @var{escape})}.
Dave Love <fx@gnu.org>
parents:
diff changeset
4240 @end defopt
Dave Love <fx@gnu.org>
parents:
diff changeset
4241
Dave Love <fx@gnu.org>
parents:
diff changeset
4242 @defopt reftex-index-macros
Dave Love <fx@gnu.org>
parents:
diff changeset
4243 List of macros which define index entries. The structure of each entry
Dave Love <fx@gnu.org>
parents:
diff changeset
4244 is
Dave Love <fx@gnu.org>
parents:
diff changeset
4245 @lisp
26911
d7f536a01276 Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents: 25829
diff changeset
4246 (@var{macro} @var{index-tag} @var{key} @var{prefix} @var{exclude} @var{repeat})
25829
Dave Love <fx@gnu.org>
parents:
diff changeset
4247 @end lisp
Dave Love <fx@gnu.org>
parents:
diff changeset
4248
Dave Love <fx@gnu.org>
parents:
diff changeset
4249 @var{macro} is the macro. Arguments should be denoted by empty braces,
Dave Love <fx@gnu.org>
parents:
diff changeset
4250 as for example in @samp{\index[]@{*@}}. Use square brackets to denote
Dave Love <fx@gnu.org>
parents:
diff changeset
4251 optional arguments. The star marks where the index key is.@refill
Dave Love <fx@gnu.org>
parents:
diff changeset
4252
Dave Love <fx@gnu.org>
parents:
diff changeset
4253 @var{index-tag} is a short name of the index. @samp{idx} and @samp{glo}
Dave Love <fx@gnu.org>
parents:
diff changeset
4254 are reserved for the default index and the glossary. Other indices can
Dave Love <fx@gnu.org>
parents:
diff changeset
4255 be defined as well. If this is an integer, the Nth argument of the
Dave Love <fx@gnu.org>
parents:
diff changeset
4256 macro holds the index tag.@refill
Dave Love <fx@gnu.org>
parents:
diff changeset
4257
Dave Love <fx@gnu.org>
parents:
diff changeset
4258 @var{key} is a character which is used to identify the macro for input
Dave Love <fx@gnu.org>
parents:
diff changeset
4259 with @code{reftex-index}. @samp{?i}, @samp{?I}, and @samp{?g} are
Dave Love <fx@gnu.org>
parents:
diff changeset
4260 reserved for default index and glossary.@refill
Dave Love <fx@gnu.org>
parents:
diff changeset
4261
Dave Love <fx@gnu.org>
parents:
diff changeset
4262 @var{prefix} can be a prefix which is added to the @var{key} part of the
Dave Love <fx@gnu.org>
parents:
diff changeset
4263 index entry. If you have a macro
Dave Love <fx@gnu.org>
parents:
diff changeset
4264 @code{\newcommand@{\molec@}[1]@{#1\index@{Molecules!#1@}}, this prefix
Dave Love <fx@gnu.org>
parents:
diff changeset
4265 should be @samp{Molecules!}.@refill
Dave Love <fx@gnu.org>
parents:
diff changeset
4266
Dave Love <fx@gnu.org>
parents:
diff changeset
4267 @var{exclude} can be a function. If this function exists and returns a
Dave Love <fx@gnu.org>
parents:
diff changeset
4268 non-nil value, the index entry at point is ignored. This was
Dave Love <fx@gnu.org>
parents:
diff changeset
4269 implemented to support the (deprecated) @samp{^} and @samp{_} shortcuts
Dave Love <fx@gnu.org>
parents:
diff changeset
4270 in the LaTeX2e @code{index} package.@refill
Dave Love <fx@gnu.org>
parents:
diff changeset
4271
26911
d7f536a01276 Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents: 25829
diff changeset
4272 @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
4273 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
4274 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
4275 indexing from the phrase buffer.@refill
d7f536a01276 Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents: 25829
diff changeset
4276
25829
Dave Love <fx@gnu.org>
parents:
diff changeset
4277 The final entry may also be a symbol. It must have an association in
Dave Love <fx@gnu.org>
parents:
diff changeset
4278 the variable @code{reftex-index-macros-builtin} to specify the main
Dave Love <fx@gnu.org>
parents:
diff changeset
4279 indexing package you are using. Legal values are currently@refill
Dave Love <fx@gnu.org>
parents:
diff changeset
4280 @example
Dave Love <fx@gnu.org>
parents:
diff changeset
4281 default @r{The LaTeX default - unnecessary to specify this one}
Dave Love <fx@gnu.org>
parents:
diff changeset
4282 multind @r{The multind.sty package}
Dave Love <fx@gnu.org>
parents:
diff changeset
4283 index @r{The index.sty package}
Dave Love <fx@gnu.org>
parents:
diff changeset
4284 index-shortcut @r{The index.sty packages with the ^ and _ shortcuts.}
Dave Love <fx@gnu.org>
parents:
diff changeset
4285 @r{Should not be used - only for old documents}
Dave Love <fx@gnu.org>
parents:
diff changeset
4286 @end example
Dave Love <fx@gnu.org>
parents:
diff changeset
4287 Note that AUCTeX sets these things internally for @b{Ref@TeX{}} as well,
Dave Love <fx@gnu.org>
parents:
diff changeset
4288 so with a sufficiently new version of AUCTeX, you should not set the
Dave Love <fx@gnu.org>
parents:
diff changeset
4289 package here.
Dave Love <fx@gnu.org>
parents:
diff changeset
4290 @end defopt
Dave Love <fx@gnu.org>
parents:
diff changeset
4291
Dave Love <fx@gnu.org>
parents:
diff changeset
4292 @defopt reftex-index-default-macro
Dave Love <fx@gnu.org>
parents:
diff changeset
4293 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
4294 This is a list with @code{(@var{macro-key} @var{default-tag})}.
25829
Dave Love <fx@gnu.org>
parents:
diff changeset
4295
Dave Love <fx@gnu.org>
parents:
diff changeset
4296 @var{macro-key} is a character identifying an index macro - see
Dave Love <fx@gnu.org>
parents:
diff changeset
4297 @code{reftex-index-macros}.
Dave Love <fx@gnu.org>
parents:
diff changeset
4298
Dave Love <fx@gnu.org>
parents:
diff changeset
4299 @var{default-tag} is the tag to be used if the macro requires a
Dave Love <fx@gnu.org>
parents:
diff changeset
4300 @var{tag} argument. When this is @code{nil} and a @var{tag} is needed,
Dave Love <fx@gnu.org>
parents:
diff changeset
4301 @b{Ref@TeX{}} will ask for it. When this is the empty string and the
Dave Love <fx@gnu.org>
parents:
diff changeset
4302 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
4303 omitted.@refill
25829
Dave Love <fx@gnu.org>
parents:
diff changeset
4304 @end defopt
Dave Love <fx@gnu.org>
parents:
diff changeset
4305
Dave Love <fx@gnu.org>
parents:
diff changeset
4306 @defopt reftex-index-default-tag
Dave Love <fx@gnu.org>
parents:
diff changeset
4307 Default index tag. When working with multiple indexes, RefTeX queries
Dave Love <fx@gnu.org>
parents:
diff changeset
4308 for an index tag when creating index entries or displaying a specific
Dave Love <fx@gnu.org>
parents:
diff changeset
4309 index. This variable controls the default offered for these queries.
Dave Love <fx@gnu.org>
parents:
diff changeset
4310 The default can be selected with @key{RET} during selection or
Dave Love <fx@gnu.org>
parents:
diff changeset
4311 completion. Legal values of this variable are:@refill
Dave Love <fx@gnu.org>
parents:
diff changeset
4312 @example
Dave Love <fx@gnu.org>
parents:
diff changeset
4313 nil @r{Do not provide a default index}
Dave Love <fx@gnu.org>
parents:
diff changeset
4314 "tag" @r{The default index tag given as a string, e.g. "idx"}
Dave Love <fx@gnu.org>
parents:
diff changeset
4315 last @r{The last used index tag will be offered as default}
Dave Love <fx@gnu.org>
parents:
diff changeset
4316 @end example
Dave Love <fx@gnu.org>
parents:
diff changeset
4317 @end defopt
Dave Love <fx@gnu.org>
parents:
diff changeset
4318
Dave Love <fx@gnu.org>
parents:
diff changeset
4319 @defopt reftex-index-math-format
Dave Love <fx@gnu.org>
parents:
diff changeset
4320 Format of index entries when copied from inside math mode. When
Dave Love <fx@gnu.org>
parents:
diff changeset
4321 @code{reftex-index-selection-or-word} is executed inside TeX math mode,
Dave Love <fx@gnu.org>
parents:
diff changeset
4322 the index key copied from the buffer is processed with this format
Dave Love <fx@gnu.org>
parents:
diff changeset
4323 string through the @code{format} function. This can be used to add the
Dave Love <fx@gnu.org>
parents:
diff changeset
4324 math delimiters (e.g. @samp{$}) to the string. Requires the
Dave Love <fx@gnu.org>
parents:
diff changeset
4325 @file{texmathp.el} library which is part of AUCTeX.@refill
Dave Love <fx@gnu.org>
parents:
diff changeset
4326 @end defopt
Dave Love <fx@gnu.org>
parents:
diff changeset
4327
27195
d7311a9cb223 version 4.10
Carsten Dominik <dominik@science.uva.nl>
parents: 26911
diff changeset
4328 @defopt reftex-index-phrase-file-extension
d7311a9cb223 version 4.10
Carsten Dominik <dominik@science.uva.nl>
parents: 26911
diff changeset
4329 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
4330 to the base name of the master file.
d7311a9cb223 version 4.10
Carsten Dominik <dominik@science.uva.nl>
parents: 26911
diff changeset
4331 @end defopt
d7311a9cb223 version 4.10
Carsten Dominik <dominik@science.uva.nl>
parents: 26911
diff changeset
4332
26911
d7f536a01276 Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents: 25829
diff changeset
4333 @defopt reftex-index-phrases-logical-and-regexp
d7f536a01276 Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents: 25829
diff changeset
4334 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
4335 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
4336 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
4337 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
4338 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
4339 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
4340 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
4341 @end defopt
d7f536a01276 Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents: 25829
diff changeset
4342
d7f536a01276 Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents: 25829
diff changeset
4343 @defopt reftex-index-phrases-logical-or-regexp
d7f536a01276 Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents: 25829
diff changeset
4344 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
4345 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
4346 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
4347 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
4348 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
4349 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
4350 @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
4351 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
4352 @end defopt
d7f536a01276 Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents: 25829
diff changeset
4353
d7f536a01276 Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents: 25829
diff changeset
4354 @defopt reftex-index-phrases-search-whole-words
d7f536a01276 Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents: 25829
diff changeset
4355 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
4356 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
4357 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
4358 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
4359 @end defopt
d7f536a01276 Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents: 25829
diff changeset
4360
d7f536a01276 Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents: 25829
diff changeset
4361 @defopt reftex-index-phrases-case-fold-search
d7f536a01276 Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents: 25829
diff changeset
4362 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
4363 case.@refill
d7f536a01276 Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents: 25829
diff changeset
4364 @end defopt
d7f536a01276 Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents: 25829
diff changeset
4365
d7f536a01276 Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents: 25829
diff changeset
4366 @defopt reftex-index-phrases-skip-indexed-matches
d7f536a01276 Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents: 25829
diff changeset
4367 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
4368 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
4369 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
4370 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
4371 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
4372 @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
4373 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
4374 case, that match will be ignored.@refill
d7f536a01276 Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents: 25829
diff changeset
4375 @end defopt
d7f536a01276 Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents: 25829
diff changeset
4376
d7f536a01276 Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents: 25829
diff changeset
4377 @defopt reftex-index-phrases-wrap-long-lines
d7f536a01276 Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents: 25829
diff changeset
4378 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
4379 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
4380 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
4381 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
4382 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
4383 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
4384 @end defopt
d7f536a01276 Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents: 25829
diff changeset
4385
d7f536a01276 Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents: 25829
diff changeset
4386 @defopt reftex-index-phrases-sort-prefers-entry
d7f536a01276 Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents: 25829
diff changeset
4387 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
4388 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
4389 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
4390 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
4391 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
4392 @end defopt
d7f536a01276 Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents: 25829
diff changeset
4393
d7f536a01276 Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents: 25829
diff changeset
4394 @defopt reftex-index-phrases-sort-in-blocks
d7f536a01276 Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents: 25829
diff changeset
4395 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
4396 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
4397 re-arranged only within blocks.
d7f536a01276 Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents: 25829
diff changeset
4398 @end defopt
d7f536a01276 Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents: 25829
diff changeset
4399
d7f536a01276 Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents: 25829
diff changeset
4400 @defopt reftex-index-phrases-map
d7f536a01276 Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents: 25829
diff changeset
4401 Keymap for the Index Phrases buffer.
d7f536a01276 Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents: 25829
diff changeset
4402 @end defopt
d7f536a01276 Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents: 25829
diff changeset
4403
d7f536a01276 Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents: 25829
diff changeset
4404 @defopt reftex-index-phrases-mode-hook
d7f536a01276 Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents: 25829
diff changeset
4405 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
4406 @code{reftex-index-phrases-mode}.@refill
d7f536a01276 Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents: 25829
diff changeset
4407 @end defopt
d7f536a01276 Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents: 25829
diff changeset
4408
25829
Dave Love <fx@gnu.org>
parents:
diff changeset
4409 @defopt reftex-index-section-letters
Dave Love <fx@gnu.org>
parents:
diff changeset
4410 The letters which denote sections in the index. Usually these are all
Dave Love <fx@gnu.org>
parents:
diff changeset
4411 capital letters. Don't use any downcase letters. Order is not
Dave Love <fx@gnu.org>
parents:
diff changeset
4412 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
4413 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
4414 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
4415 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
4416 these capital letters or @kbd{!} will jump to that section.@refill
25829
Dave Love <fx@gnu.org>
parents:
diff changeset
4417 @end defopt
Dave Love <fx@gnu.org>
parents:
diff changeset
4418
Dave Love <fx@gnu.org>
parents:
diff changeset
4419 @defopt reftex-index-include-context
Dave Love <fx@gnu.org>
parents:
diff changeset
4420 Non-@code{nil} means, display the index definition context in the
Dave Love <fx@gnu.org>
parents:
diff changeset
4421 @file{*Index*} buffer. This flag may also be toggled from the
Dave Love <fx@gnu.org>
parents:
diff changeset
4422 @file{*Index*} buffer with the @kbd{c} key.
Dave Love <fx@gnu.org>
parents:
diff changeset
4423 @end defopt
Dave Love <fx@gnu.org>
parents:
diff changeset
4424
Dave Love <fx@gnu.org>
parents:
diff changeset
4425 @defopt reftex-index-follow-mode
Dave Love <fx@gnu.org>
parents:
diff changeset
4426 Non-@code{nil} means, point in @file{*Index*} buffer will cause other
Dave Love <fx@gnu.org>
parents:
diff changeset
4427 window to follow. The other window will show the corresponding part of
Dave Love <fx@gnu.org>
parents:
diff changeset
4428 the document. This flag can be toggled from within the @file{*Index*}
Dave Love <fx@gnu.org>
parents:
diff changeset
4429 buffer with the @kbd{f} key.
Dave Love <fx@gnu.org>
parents:
diff changeset
4430 @end defopt
Dave Love <fx@gnu.org>
parents:
diff changeset
4431
Dave Love <fx@gnu.org>
parents:
diff changeset
4432 @deffn Keymap reftex-index-map
Dave Love <fx@gnu.org>
parents:
diff changeset
4433 The keymap which is active in the @file{*Index*} buffer
Dave Love <fx@gnu.org>
parents:
diff changeset
4434 (@pxref{Index Support}).@refill
Dave Love <fx@gnu.org>
parents:
diff changeset
4435 @end deffn
Dave Love <fx@gnu.org>
parents:
diff changeset
4436
Dave Love <fx@gnu.org>
parents:
diff changeset
4437 @node Options (Viewing Cross-References), Options (Finding Files), Options (Index Support), Options
Dave Love <fx@gnu.org>
parents:
diff changeset
4438 @section Viewing Cross-References
Dave Love <fx@gnu.org>
parents:
diff changeset
4439 @cindex Options, viewing cross-references
Dave Love <fx@gnu.org>
parents:
diff changeset
4440 @cindex Viewing cross-references, options
Dave Love <fx@gnu.org>
parents:
diff changeset
4441
Dave Love <fx@gnu.org>
parents:
diff changeset
4442 @defopt reftex-view-crossref-extra
Dave Love <fx@gnu.org>
parents:
diff changeset
4443 Macros which can be used for the display of cross references.
Dave Love <fx@gnu.org>
parents:
diff changeset
4444 This is used when `reftex-view-crossref' is called with point in an
Dave Love <fx@gnu.org>
parents:
diff changeset
4445 argument of a macro. Note that crossref viewing for citations,
Dave Love <fx@gnu.org>
parents:
diff changeset
4446 references (both ways) and index entries is hard-coded. This variable
Dave Love <fx@gnu.org>
parents:
diff changeset
4447 is only to configure additional structures for which crossreference
Dave Love <fx@gnu.org>
parents:
diff changeset
4448 viewing can be useful. Each entry has the structure
Dave Love <fx@gnu.org>
parents:
diff changeset
4449 @example
Dave Love <fx@gnu.org>
parents:
diff changeset
4450 (@var{macro-re} @var{search-re} @var{highlight}).
Dave Love <fx@gnu.org>
parents:
diff changeset
4451 @end example
Dave Love <fx@gnu.org>
parents:
diff changeset
4452 @var{macro-re} is matched against the macro. @var{search-re} is the
Dave Love <fx@gnu.org>
parents:
diff changeset
4453 regexp used to search for cross references. @samp{%s} in this regexp is
37999
8e7df927fd92 Updated to version 4.16
Carsten Dominik <dominik@science.uva.nl>
parents: 37404
diff changeset
4454 replaced with with the macro argument at point. @var{highlight} is an
25829
Dave Love <fx@gnu.org>
parents:
diff changeset
4455 integer indicating which subgroup of the match should be highlighted.
Dave Love <fx@gnu.org>
parents:
diff changeset
4456 @end defopt
Dave Love <fx@gnu.org>
parents:
diff changeset
4457
Dave Love <fx@gnu.org>
parents:
diff changeset
4458 @defopt reftex-auto-view-crossref
Dave Love <fx@gnu.org>
parents:
diff changeset
4459 Non-@code{nil} means, initially turn automatic viewing of crossref info
Dave Love <fx@gnu.org>
parents:
diff changeset
4460 on. Automatic viewing of crossref info normally uses the echo area.
Dave Love <fx@gnu.org>
parents:
diff changeset
4461 Whenever point is on the argument of a @code{\ref} or @code{\cite}
Dave Love <fx@gnu.org>
parents:
diff changeset
4462 macro, and no other message is being displayed, the echo area will
Dave Love <fx@gnu.org>
parents:
diff changeset
4463 display information about that cross reference. You can also set the
Dave Love <fx@gnu.org>
parents:
diff changeset
4464 variable to the symbol @code{window}. In this case a small temporary
Dave Love <fx@gnu.org>
parents:
diff changeset
4465 window is used for the display. This feature can be turned on and of
Dave Love <fx@gnu.org>
parents:
diff changeset
4466 from the menu (Ref->Options).@refill
Dave Love <fx@gnu.org>
parents:
diff changeset
4467 @end defopt
Dave Love <fx@gnu.org>
parents:
diff changeset
4468
Dave Love <fx@gnu.org>
parents:
diff changeset
4469 @defopt reftex-idle-time
Dave Love <fx@gnu.org>
parents:
diff changeset
4470 Time (secs) Emacs has to be idle before automatic crossref display is
Dave Love <fx@gnu.org>
parents:
diff changeset
4471 done.@refill
Dave Love <fx@gnu.org>
parents:
diff changeset
4472 @end defopt
Dave Love <fx@gnu.org>
parents:
diff changeset
4473
Dave Love <fx@gnu.org>
parents:
diff changeset
4474 @defopt reftex-cite-view-format
Dave Love <fx@gnu.org>
parents:
diff changeset
4475 Citation format used to display citation info in the message area. See
Dave Love <fx@gnu.org>
parents:
diff changeset
4476 the variable @code{reftex-cite-format} for possible percent
Dave Love <fx@gnu.org>
parents:
diff changeset
4477 escapes.@refill
Dave Love <fx@gnu.org>
parents:
diff changeset
4478 @end defopt
Dave Love <fx@gnu.org>
parents:
diff changeset
4479
Dave Love <fx@gnu.org>
parents:
diff changeset
4480 @defopt reftex-revisit-to-echo
Dave Love <fx@gnu.org>
parents:
diff changeset
4481 Non-@code{nil} means, automatic citation display will revisit files if
Dave Love <fx@gnu.org>
parents:
diff changeset
4482 necessary. When nil, citation display in echo area will only be active
Dave Love <fx@gnu.org>
parents:
diff changeset
4483 for cached echo strings (see @code{reftex-cache-cite-echo}), or for
Dave Love <fx@gnu.org>
parents:
diff changeset
4484 BibTeX database files which are already visited by a live associated
Dave Love <fx@gnu.org>
parents:
diff changeset
4485 buffers.@refill
Dave Love <fx@gnu.org>
parents:
diff changeset
4486 @end defopt
Dave Love <fx@gnu.org>
parents:
diff changeset
4487
Dave Love <fx@gnu.org>
parents:
diff changeset
4488 @defopt reftex-cache-cite-echo
Dave Love <fx@gnu.org>
parents:
diff changeset
4489 Non-@code{nil} means, the information displayed in the echo area for
Dave Love <fx@gnu.org>
parents:
diff changeset
4490 cite macros (see variable @code{reftex-auto-view-crossref}) is cached and
Dave Love <fx@gnu.org>
parents:
diff changeset
4491 saved along with the parsing information. The cache survives document
Dave Love <fx@gnu.org>
parents:
diff changeset
4492 scans. In order to clear it, use @kbd{M-x reftex-reset-mode}.
Dave Love <fx@gnu.org>
parents:
diff changeset
4493 @end defopt
Dave Love <fx@gnu.org>
parents:
diff changeset
4494
Dave Love <fx@gnu.org>
parents:
diff changeset
4495 @node Options (Finding Files), Options (Optimizations), Options (Viewing Cross-References), Options
Dave Love <fx@gnu.org>
parents:
diff changeset
4496 @section Finding Files
Dave Love <fx@gnu.org>
parents:
diff changeset
4497 @cindex Options, Finding Files
Dave Love <fx@gnu.org>
parents:
diff changeset
4498 @cindex Finding files, options
Dave Love <fx@gnu.org>
parents:
diff changeset
4499
Dave Love <fx@gnu.org>
parents:
diff changeset
4500 @defopt reftex-texpath-environment-variables
Dave Love <fx@gnu.org>
parents:
diff changeset
4501 List of specifications how to retrieve the search path for TeX files.
Dave Love <fx@gnu.org>
parents:
diff changeset
4502 Several entries are possible.@refill
Dave Love <fx@gnu.org>
parents:
diff changeset
4503 @itemize @minus
Dave Love <fx@gnu.org>
parents:
diff changeset
4504 @item
Dave Love <fx@gnu.org>
parents:
diff changeset
4505 If an element is the name of an environment variable, its content is
Dave Love <fx@gnu.org>
parents:
diff changeset
4506 used.@refill
Dave Love <fx@gnu.org>
parents:
diff changeset
4507 @item
Dave Love <fx@gnu.org>
parents:
diff changeset
4508 If an element starts with an exclamation mark, it is used as a command
Dave Love <fx@gnu.org>
parents:
diff changeset
4509 to retrieve the path. A typical command with the kpathsearch library
Dave Love <fx@gnu.org>
parents:
diff changeset
4510 would be @w{@code{"!kpsewhich -show-path=.tex"}}.
Dave Love <fx@gnu.org>
parents:
diff changeset
4511 @item
Dave Love <fx@gnu.org>
parents:
diff changeset
4512 Otherwise the element itself is interpreted as a path.
Dave Love <fx@gnu.org>
parents:
diff changeset
4513 @end itemize
Dave Love <fx@gnu.org>
parents:
diff changeset
4514 Multiple directories can be separated by the system dependent
Dave Love <fx@gnu.org>
parents:
diff changeset
4515 @code{path-separator}. Directories ending in @samp{//} or @samp{!!} will
Dave Love <fx@gnu.org>
parents:
diff changeset
4516 be expanded recursively. See also @code{reftex-use-external-file-finders}.
Dave Love <fx@gnu.org>
parents:
diff changeset
4517 @end defopt
Dave Love <fx@gnu.org>
parents:
diff changeset
4518
Dave Love <fx@gnu.org>
parents:
diff changeset
4519 @defopt reftex-bibpath-environment-variables
Dave Love <fx@gnu.org>
parents:
diff changeset
4520 List of specifications how to retrieve the search path for BibTeX
Dave Love <fx@gnu.org>
parents:
diff changeset
4521 files. Several entries are possible.@refill
Dave Love <fx@gnu.org>
parents:
diff changeset
4522 @itemize @minus
Dave Love <fx@gnu.org>
parents:
diff changeset
4523 @item
Dave Love <fx@gnu.org>
parents:
diff changeset
4524 If an element is the name of an environment variable, its content is
Dave Love <fx@gnu.org>
parents:
diff changeset
4525 used.@refill
Dave Love <fx@gnu.org>
parents:
diff changeset
4526 @item
Dave Love <fx@gnu.org>
parents:
diff changeset
4527 If an element starts with an exclamation mark, it is used as a command
Dave Love <fx@gnu.org>
parents:
diff changeset
4528 to retrieve the path. A typical command with the kpathsearch library
Dave Love <fx@gnu.org>
parents:
diff changeset
4529 would be @w{@code{"!kpsewhich -show-path=.bib"}}.
Dave Love <fx@gnu.org>
parents:
diff changeset
4530 @item
Dave Love <fx@gnu.org>
parents:
diff changeset
4531 Otherwise the element itself is interpreted as a path.
Dave Love <fx@gnu.org>
parents:
diff changeset
4532 @end itemize
Dave Love <fx@gnu.org>
parents:
diff changeset
4533 Multiple directories can be separated by the system dependent
Dave Love <fx@gnu.org>
parents:
diff changeset
4534 @code{path-separator}. Directories ending in @samp{//} or @samp{!!} will
Dave Love <fx@gnu.org>
parents:
diff changeset
4535 be expanded recursively. See also @code{reftex-use-external-file-finders}.
Dave Love <fx@gnu.org>
parents:
diff changeset
4536 @end defopt
Dave Love <fx@gnu.org>
parents:
diff changeset
4537
Dave Love <fx@gnu.org>
parents:
diff changeset
4538 @defopt reftex-file-extensions
Dave Love <fx@gnu.org>
parents:
diff changeset
4539 Association list with file extensions for different file types.
Dave Love <fx@gnu.org>
parents:
diff changeset
4540 This is a list of items, each item is like:
Dave Love <fx@gnu.org>
parents:
diff changeset
4541 @code{(@var{type} . (@var{def-ext} @var{other-ext} ...))}
Dave Love <fx@gnu.org>
parents:
diff changeset
4542 @example
Dave Love <fx@gnu.org>
parents:
diff changeset
4543 @var{type}: @r{File type like @code{"bib"} or @code{"tex"}.}
Dave Love <fx@gnu.org>
parents:
diff changeset
4544 @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
4545 @var{other-ext}: @r{Any number of other legal extensions for this file type.}
Dave Love <fx@gnu.org>
parents:
diff changeset
4546 @end example
Dave Love <fx@gnu.org>
parents:
diff changeset
4547 When a files is searched and it does not have any of the legal extensions,
Dave Love <fx@gnu.org>
parents:
diff changeset
4548 we try the default extension first, and then the naked file name.@refill
Dave Love <fx@gnu.org>
parents:
diff changeset
4549 @end defopt
Dave Love <fx@gnu.org>
parents:
diff changeset
4550
Dave Love <fx@gnu.org>
parents:
diff changeset
4551 @defopt reftex-search-unrecursed-path-first
Dave Love <fx@gnu.org>
parents:
diff changeset
4552 Non-@code{nil} means, search all specified directories before trying
Dave Love <fx@gnu.org>
parents:
diff changeset
4553 recursion. Thus, in a path @samp{.//:/tex/}, search first @samp{./},
Dave Love <fx@gnu.org>
parents:
diff changeset
4554 then @samp{/tex/}, and then all subdirectories of @samp{./}. If this
Dave Love <fx@gnu.org>
parents:
diff changeset
4555 option is @code{nil}, the subdirectories of @samp{./} are searched
Dave Love <fx@gnu.org>
parents:
diff changeset
4556 before @samp{/tex/}. This is mainly for speed - most of the time the
Dave Love <fx@gnu.org>
parents:
diff changeset
4557 recursive path is for the system files and not for the user files. Set
Dave Love <fx@gnu.org>
parents:
diff changeset
4558 this to @code{nil} if the default makes @b{Ref@TeX{}} finding files with
Dave Love <fx@gnu.org>
parents:
diff changeset
4559 equal names in wrong sequence.@refill
Dave Love <fx@gnu.org>
parents:
diff changeset
4560 @end defopt
Dave Love <fx@gnu.org>
parents:
diff changeset
4561
Dave Love <fx@gnu.org>
parents:
diff changeset
4562 @defopt reftex-use-external-file-finders
Dave Love <fx@gnu.org>
parents:
diff changeset
4563 Non-@code{nil} means, use external programs to find files. Normally,
Dave Love <fx@gnu.org>
parents:
diff changeset
4564 @b{Ref@TeX{}} searches the paths given in the environment variables
Dave Love <fx@gnu.org>
parents:
diff changeset
4565 @code{TEXINPUTS} and @code{BIBINPUTS} to find TeX files and BibTeX
Dave Love <fx@gnu.org>
parents:
diff changeset
4566 database files. With this option turned on, it calls an external
Dave Love <fx@gnu.org>
parents:
diff changeset
4567 program specified in the option @code{reftex-external-file-finders}
Dave Love <fx@gnu.org>
parents:
diff changeset
4568 instead. As a side effect, the variables
Dave Love <fx@gnu.org>
parents:
diff changeset
4569 @code{reftex-texpath-environment-variables} and
Dave Love <fx@gnu.org>
parents:
diff changeset
4570 @code{reftex-bibpath-environment-variables} will be ignored.
Dave Love <fx@gnu.org>
parents:
diff changeset
4571 @end defopt
Dave Love <fx@gnu.org>
parents:
diff changeset
4572
Dave Love <fx@gnu.org>
parents:
diff changeset
4573 @defopt reftex-external-file-finders
Dave Love <fx@gnu.org>
parents:
diff changeset
4574 Association list with external programs to call for finding files. Each
Dave Love <fx@gnu.org>
parents:
diff changeset
4575 entry is a cons cell @w{@code{(@var{type} . @var{program})}}.
Dave Love <fx@gnu.org>
parents:
diff changeset
4576 @var{type} is either @code{"tex"} or @code{"bib"}. @var{program} is a
Dave Love <fx@gnu.org>
parents:
diff changeset
4577 string containing the external program to use with any arguments.
Dave Love <fx@gnu.org>
parents:
diff changeset
4578 @code{%f} will be replaced by the name of the file to be found. Note
Dave Love <fx@gnu.org>
parents:
diff changeset
4579 that these commands will be executed directly, not via a shell. Only
Dave Love <fx@gnu.org>
parents:
diff changeset
4580 relevant when @code{reftex-use-external-file-finders} is
Dave Love <fx@gnu.org>
parents:
diff changeset
4581 non-@code{nil}.@refill
Dave Love <fx@gnu.org>
parents:
diff changeset
4582 @end defopt
Dave Love <fx@gnu.org>
parents:
diff changeset
4583
Dave Love <fx@gnu.org>
parents:
diff changeset
4584 @page
Dave Love <fx@gnu.org>
parents:
diff changeset
4585 @node Options (Optimizations), Options (Fontification), Options (Finding Files), Options
Dave Love <fx@gnu.org>
parents:
diff changeset
4586 @section Optimizations
Dave Love <fx@gnu.org>
parents:
diff changeset
4587 @cindex Options, optimizations
Dave Love <fx@gnu.org>
parents:
diff changeset
4588 @cindex Optimizations, options
Dave Love <fx@gnu.org>
parents:
diff changeset
4589
Dave Love <fx@gnu.org>
parents:
diff changeset
4590 @defopt reftex-keep-temporary-buffers
Dave Love <fx@gnu.org>
parents:
diff changeset
4591 Non-@code{nil} means, keep buffers created for parsing and lookup.
Dave Love <fx@gnu.org>
parents:
diff changeset
4592 @b{Ref@TeX{}} sometimes needs to visit files related to the current
Dave Love <fx@gnu.org>
parents:
diff changeset
4593 document. We distinguish files visited for@refill
Dave Love <fx@gnu.org>
parents:
diff changeset
4594 @table @asis
Dave Love <fx@gnu.org>
parents:
diff changeset
4595 @item PARSING
Dave Love <fx@gnu.org>
parents:
diff changeset
4596 Parts of a multifile document loaded when (re)-parsing the
Dave Love <fx@gnu.org>
parents:
diff changeset
4597 document.@refill
Dave Love <fx@gnu.org>
parents:
diff changeset
4598 @item LOOKUP
Dave Love <fx@gnu.org>
parents:
diff changeset
4599 BibTeX database files and TeX files loaded to find a reference, to
Dave Love <fx@gnu.org>
parents:
diff changeset
4600 display label context, etc.@refill
Dave Love <fx@gnu.org>
parents:
diff changeset
4601 @end table
Dave Love <fx@gnu.org>
parents:
diff changeset
4602 The created buffers can be kept for later use, or be thrown away
Dave Love <fx@gnu.org>
parents:
diff changeset
4603 immediately after use, depending on the value of this variable:@refill
Dave Love <fx@gnu.org>
parents:
diff changeset
4604
Dave Love <fx@gnu.org>
parents:
diff changeset
4605 @table @code
Dave Love <fx@gnu.org>
parents:
diff changeset
4606 @item nil
Dave Love <fx@gnu.org>
parents:
diff changeset
4607 Throw away as much as possible.
Dave Love <fx@gnu.org>
parents:
diff changeset
4608 @item t
Dave Love <fx@gnu.org>
parents:
diff changeset
4609 Keep everything.
Dave Love <fx@gnu.org>
parents:
diff changeset
4610 @item 1
Dave Love <fx@gnu.org>
parents:
diff changeset
4611 Throw away buffers created for parsing, but keep the ones created for
Dave Love <fx@gnu.org>
parents:
diff changeset
4612 lookup.@refill
Dave Love <fx@gnu.org>
parents:
diff changeset
4613 @end table
Dave Love <fx@gnu.org>
parents:
diff changeset
4614
Dave Love <fx@gnu.org>
parents:
diff changeset
4615 If a buffer is to be kept, the file is visited normally (which is
Dave Love <fx@gnu.org>
parents:
diff changeset
4616 potentially slow but will happen only once). If a buffer is to be thrown
Dave Love <fx@gnu.org>
parents:
diff changeset
4617 away, the initialization of the buffer depends upon the variable
Dave Love <fx@gnu.org>
parents:
diff changeset
4618 @code{reftex-initialize-temporary-buffers}.@refill
Dave Love <fx@gnu.org>
parents:
diff changeset
4619 @end defopt
Dave Love <fx@gnu.org>
parents:
diff changeset
4620
Dave Love <fx@gnu.org>
parents:
diff changeset
4621 @defopt reftex-initialize-temporary-buffers
Dave Love <fx@gnu.org>
parents:
diff changeset
4622 Non-@code{nil} means do initializations even when visiting file
Dave Love <fx@gnu.org>
parents:
diff changeset
4623 temporarily. When @code{nil}, @b{Ref@TeX{}} may turn off find-file hooks and
Dave Love <fx@gnu.org>
parents:
diff changeset
4624 other stuff to briefly visit a file. When @code{t}, the full default
Dave Love <fx@gnu.org>
parents:
diff changeset
4625 initializations are done (@code{find-file-hook} etc.). Instead of
Dave Love <fx@gnu.org>
parents:
diff changeset
4626 @code{t} or @code{nil}, this variable may also be a list of hook
Dave Love <fx@gnu.org>
parents:
diff changeset
4627 functions to do a minimal initialization.@refill
Dave Love <fx@gnu.org>
parents:
diff changeset
4628 @end defopt
Dave Love <fx@gnu.org>
parents:
diff changeset
4629
Dave Love <fx@gnu.org>
parents:
diff changeset
4630 @defopt reftex-no-include-regexps
Dave Love <fx@gnu.org>
parents:
diff changeset
4631 List of regular expressions to exclude certain input files from parsing.
Dave Love <fx@gnu.org>
parents:
diff changeset
4632 If the name of a file included via @code{\include} or @code{\input} is
Dave Love <fx@gnu.org>
parents:
diff changeset
4633 matched by any of the regular expressions in this list, that file is not
Dave Love <fx@gnu.org>
parents:
diff changeset
4634 parsed by @b{Ref@TeX{}}.
Dave Love <fx@gnu.org>
parents:
diff changeset
4635 @end defopt
Dave Love <fx@gnu.org>
parents:
diff changeset
4636
Dave Love <fx@gnu.org>
parents:
diff changeset
4637 @defopt reftex-enable-partial-scans
Dave Love <fx@gnu.org>
parents:
diff changeset
4638 Non-@code{nil} means, re-parse only 1 file when asked to re-parse.
Dave Love <fx@gnu.org>
parents:
diff changeset
4639 Re-parsing is normally requested with a @kbd{C-u} prefix to many @b{Ref@TeX{}}
Dave Love <fx@gnu.org>
parents:
diff changeset
4640 commands, or with the @kbd{r} key in menus. When this option is
Dave Love <fx@gnu.org>
parents:
diff changeset
4641 @code{t} in a multifile document, we will only parse the current buffer,
Dave Love <fx@gnu.org>
parents:
diff changeset
4642 or the file associated with the label or section heading near point in a
Dave Love <fx@gnu.org>
parents:
diff changeset
4643 menu. Requesting re-parsing of an entire multifile document then
Dave Love <fx@gnu.org>
parents:
diff changeset
4644 requires a @kbd{C-u C-u} prefix or the capital @kbd{R} key in
Dave Love <fx@gnu.org>
parents:
diff changeset
4645 menus.@refill
Dave Love <fx@gnu.org>
parents:
diff changeset
4646 @end defopt
Dave Love <fx@gnu.org>
parents:
diff changeset
4647
Dave Love <fx@gnu.org>
parents:
diff changeset
4648 @defopt reftex-save-parse-info
Dave Love <fx@gnu.org>
parents:
diff changeset
4649 Non-@code{nil} means, save information gathered with parsing in files.
Dave Love <fx@gnu.org>
parents:
diff changeset
4650 The file @file{MASTER.rel} in the same directory as @file{MASTER.tex} is
Dave Love <fx@gnu.org>
parents:
diff changeset
4651 used to save the information. When this variable is @code{t},
Dave Love <fx@gnu.org>
parents:
diff changeset
4652 @itemize @minus
Dave Love <fx@gnu.org>
parents:
diff changeset
4653 @item
Dave Love <fx@gnu.org>
parents:
diff changeset
4654 accessing the parsing information for the first time in an editing
Dave Love <fx@gnu.org>
parents:
diff changeset
4655 session will read that file (if available) instead of parsing the
Dave Love <fx@gnu.org>
parents:
diff changeset
4656 document.@refill
Dave Love <fx@gnu.org>
parents:
diff changeset
4657 @item
Dave Love <fx@gnu.org>
parents:
diff changeset
4658 exiting Emacs or killing a buffer in reftex-mode will cause a new
Dave Love <fx@gnu.org>
parents:
diff changeset
4659 version of the file to be written.@refill
Dave Love <fx@gnu.org>
parents:
diff changeset
4660 @end itemize
Dave Love <fx@gnu.org>
parents:
diff changeset
4661 @end defopt
Dave Love <fx@gnu.org>
parents:
diff changeset
4662
27195
d7311a9cb223 version 4.10
Carsten Dominik <dominik@science.uva.nl>
parents: 26911
diff changeset
4663 @defopt reftex-parse-file-extension
d7311a9cb223 version 4.10
Carsten Dominik <dominik@science.uva.nl>
parents: 26911
diff changeset
4664 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
4665 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
4666 @end defopt
d7311a9cb223 version 4.10
Carsten Dominik <dominik@science.uva.nl>
parents: 26911
diff changeset
4667
25829
Dave Love <fx@gnu.org>
parents:
diff changeset
4668 @defopt reftex-allow-automatic-rescan
Dave Love <fx@gnu.org>
parents:
diff changeset
4669 Non-@code{nil} means, @b{Ref@TeX{}} may rescan the document when this seems
Dave Love <fx@gnu.org>
parents:
diff changeset
4670 necessary. Applies (currently) only in rare cases, when a new label
Dave Love <fx@gnu.org>
parents:
diff changeset
4671 cannot be placed with certainty into the internal label list.
Dave Love <fx@gnu.org>
parents:
diff changeset
4672 @end defopt
Dave Love <fx@gnu.org>
parents:
diff changeset
4673
Dave Love <fx@gnu.org>
parents:
diff changeset
4674 @defopt reftex-use-multiple-selection-buffers
Dave Love <fx@gnu.org>
parents:
diff changeset
4675 Non-@code{nil} means use a separate selection buffer for each label
Dave Love <fx@gnu.org>
parents:
diff changeset
4676 type. These buffers are kept from one selection to the next and need
Dave Love <fx@gnu.org>
parents:
diff changeset
4677 not to be created for each use - so the menu generally comes up faster.
Dave Love <fx@gnu.org>
parents:
diff changeset
4678 The selection buffers will be erased (and therefore updated)
Dave Love <fx@gnu.org>
parents:
diff changeset
4679 automatically when new labels in its category are added. See the
Dave Love <fx@gnu.org>
parents:
diff changeset
4680 variable @code{reftex-auto-update-selection-buffers}.@refill
Dave Love <fx@gnu.org>
parents:
diff changeset
4681 @end defopt
Dave Love <fx@gnu.org>
parents:
diff changeset
4682
Dave Love <fx@gnu.org>
parents:
diff changeset
4683 @defopt reftex-auto-update-selection-buffers
Dave Love <fx@gnu.org>
parents:
diff changeset
4684 Non-@code{nil} means, selection buffers will be updated automatically.
Dave Love <fx@gnu.org>
parents:
diff changeset
4685 When a new label is defined with @code{reftex-label}, all selection
Dave Love <fx@gnu.org>
parents:
diff changeset
4686 buffers associated with that label category are emptied, in order to
Dave Love <fx@gnu.org>
parents:
diff changeset
4687 force an update upon next use. When @code{nil}, the buffers are left
Dave Love <fx@gnu.org>
parents:
diff changeset
4688 alone and have to be updated by hand, with the @kbd{g} key from the
Dave Love <fx@gnu.org>
parents:
diff changeset
4689 label selection process. The value of this variable will only have any
Dave Love <fx@gnu.org>
parents:
diff changeset
4690 effect when @code{reftex-use-multiple-selection-buffers} is
Dave Love <fx@gnu.org>
parents:
diff changeset
4691 non-@code{nil}.@refill
Dave Love <fx@gnu.org>
parents:
diff changeset
4692 @end defopt
Dave Love <fx@gnu.org>
parents:
diff changeset
4693
Dave Love <fx@gnu.org>
parents:
diff changeset
4694 @node Options (Fontification), Options (Misc), Options (Optimizations), Options
Dave Love <fx@gnu.org>
parents:
diff changeset
4695 @section Fontification
Dave Love <fx@gnu.org>
parents:
diff changeset
4696 @cindex Options, fontification
Dave Love <fx@gnu.org>
parents:
diff changeset
4697 @cindex Fontification, options
Dave Love <fx@gnu.org>
parents:
diff changeset
4698
Dave Love <fx@gnu.org>
parents:
diff changeset
4699 @defopt reftex-use-fonts
Dave Love <fx@gnu.org>
parents:
diff changeset
4700 Non-@code{nil} means, use fonts in label menu and on-the-fly help.
Dave Love <fx@gnu.org>
parents:
diff changeset
4701 Font-lock must be loaded as well to actually get fontified
Dave Love <fx@gnu.org>
parents:
diff changeset
4702 display. After changing this option, a rescan may be necessary to
Dave Love <fx@gnu.org>
parents:
diff changeset
4703 activate it.@refill
Dave Love <fx@gnu.org>
parents:
diff changeset
4704 @end defopt
Dave Love <fx@gnu.org>
parents:
diff changeset
4705
Dave Love <fx@gnu.org>
parents:
diff changeset
4706 @defopt reftex-refontify-context
Dave Love <fx@gnu.org>
parents:
diff changeset
4707 Non-@code{nil} means, re-fontify the context in the label menu with
Dave Love <fx@gnu.org>
parents:
diff changeset
4708 font-lock. This slightly slows down the creation of the label menu. It
Dave Love <fx@gnu.org>
parents:
diff changeset
4709 is only necessary when you definitely want the context fontified.@refill
Dave Love <fx@gnu.org>
parents:
diff changeset
4710
Dave Love <fx@gnu.org>
parents:
diff changeset
4711 This option may have 3 different values:
Dave Love <fx@gnu.org>
parents:
diff changeset
4712 @table @code
Dave Love <fx@gnu.org>
parents:
diff changeset
4713 @item nil
Dave Love <fx@gnu.org>
parents:
diff changeset
4714 Never refontify.
Dave Love <fx@gnu.org>
parents:
diff changeset
4715 @item t
Dave Love <fx@gnu.org>
parents:
diff changeset
4716 Always refontify.
Dave Love <fx@gnu.org>
parents:
diff changeset
4717 @item 1
Dave Love <fx@gnu.org>
parents:
diff changeset
4718 Refontify when necessary, e.g. with old versions of the x-symbol
Dave Love <fx@gnu.org>
parents:
diff changeset
4719 package.@refill
Dave Love <fx@gnu.org>
parents:
diff changeset
4720 @end table
Dave Love <fx@gnu.org>
parents:
diff changeset
4721 The option is ignored when @code{reftex-use-fonts} is @code{nil}.@refill
Dave Love <fx@gnu.org>
parents:
diff changeset
4722 @end defopt
Dave Love <fx@gnu.org>
parents:
diff changeset
4723
Dave Love <fx@gnu.org>
parents:
diff changeset
4724 @defopt reftex-highlight-selection
Dave Love <fx@gnu.org>
parents:
diff changeset
4725 Non-@code{nil} means, highlight selected text in selection and
Dave Love <fx@gnu.org>
parents:
diff changeset
4726 @file{*toc*} buffers. Normally, the text near the cursor is the
Dave Love <fx@gnu.org>
parents:
diff changeset
4727 @emph{selected} text, and it is highlighted. This is the entry most
Dave Love <fx@gnu.org>
parents:
diff changeset
4728 keys in the selection and @file{*toc*} buffers act on. However, if you
Dave Love <fx@gnu.org>
parents:
diff changeset
4729 mainly use the mouse to select an item, you may find it nice to have
Dave Love <fx@gnu.org>
parents:
diff changeset
4730 mouse-triggered highlighting @emph{instead} or @emph{as well}. The
Dave Love <fx@gnu.org>
parents:
diff changeset
4731 variable may have one of these values:@refill
Dave Love <fx@gnu.org>
parents:
diff changeset
4732
Dave Love <fx@gnu.org>
parents:
diff changeset
4733 @example
Dave Love <fx@gnu.org>
parents:
diff changeset
4734 nil @r{No highlighting.}
Dave Love <fx@gnu.org>
parents:
diff changeset
4735 cursor @r{Highlighting is cursor driven.}
Dave Love <fx@gnu.org>
parents:
diff changeset
4736 mouse @r{Highlighting is mouse driven.}
Dave Love <fx@gnu.org>
parents:
diff changeset
4737 both @r{Both cursor and mouse trigger highlighting.}
Dave Love <fx@gnu.org>
parents:
diff changeset
4738 @end example
Dave Love <fx@gnu.org>
parents:
diff changeset
4739
Dave Love <fx@gnu.org>
parents:
diff changeset
4740 Changing this variable requires to rebuild the selection and *toc*
Dave Love <fx@gnu.org>
parents:
diff changeset
4741 buffers to become effective (keys @kbd{g} or @kbd{r}).@refill
Dave Love <fx@gnu.org>
parents:
diff changeset
4742 @end defopt
Dave Love <fx@gnu.org>
parents:
diff changeset
4743
Dave Love <fx@gnu.org>
parents:
diff changeset
4744 @defopt reftex-cursor-selected-face
Dave Love <fx@gnu.org>
parents:
diff changeset
4745 Face name to highlight cursor selected item in toc and selection buffers.
Dave Love <fx@gnu.org>
parents:
diff changeset
4746 See also the variable @code{reftex-highlight-selection}.@refill
Dave Love <fx@gnu.org>
parents:
diff changeset
4747 @end defopt
Dave Love <fx@gnu.org>
parents:
diff changeset
4748 @defopt reftex-mouse-selected-face
Dave Love <fx@gnu.org>
parents:
diff changeset
4749 Face name to highlight mouse selected item in toc and selection buffers.
Dave Love <fx@gnu.org>
parents:
diff changeset
4750 See also the variable @code{reftex-highlight-selection}.@refill
Dave Love <fx@gnu.org>
parents:
diff changeset
4751 @end defopt
Dave Love <fx@gnu.org>
parents:
diff changeset
4752 @defopt reftex-file-boundary-face
Dave Love <fx@gnu.org>
parents:
diff changeset
4753 Face name for file boundaries in selection buffer.
Dave Love <fx@gnu.org>
parents:
diff changeset
4754 @end defopt
Dave Love <fx@gnu.org>
parents:
diff changeset
4755 @defopt reftex-label-face
Dave Love <fx@gnu.org>
parents:
diff changeset
4756 Face name for labels in selection buffer.
Dave Love <fx@gnu.org>
parents:
diff changeset
4757 @end defopt
Dave Love <fx@gnu.org>
parents:
diff changeset
4758 @defopt reftex-section-heading-face
Dave Love <fx@gnu.org>
parents:
diff changeset
4759 Face name for section headings in toc and selection buffers.
Dave Love <fx@gnu.org>
parents:
diff changeset
4760 @end defopt
Dave Love <fx@gnu.org>
parents:
diff changeset
4761 @defopt reftex-toc-header-face
Dave Love <fx@gnu.org>
parents:
diff changeset
4762 Face name for the header of a toc buffer.
Dave Love <fx@gnu.org>
parents:
diff changeset
4763 @end defopt
Dave Love <fx@gnu.org>
parents:
diff changeset
4764 @defopt reftex-bib-author-face
Dave Love <fx@gnu.org>
parents:
diff changeset
4765 Face name for author names in bib selection buffer.
Dave Love <fx@gnu.org>
parents:
diff changeset
4766 @end defopt
Dave Love <fx@gnu.org>
parents:
diff changeset
4767 @defopt reftex-bib-year-face
Dave Love <fx@gnu.org>
parents:
diff changeset
4768 Face name for year in bib selection buffer.
Dave Love <fx@gnu.org>
parents:
diff changeset
4769 @end defopt
Dave Love <fx@gnu.org>
parents:
diff changeset
4770 @defopt reftex-bib-title-face
Dave Love <fx@gnu.org>
parents:
diff changeset
4771 Face name for article title in bib selection buffer.
Dave Love <fx@gnu.org>
parents:
diff changeset
4772 @end defopt
Dave Love <fx@gnu.org>
parents:
diff changeset
4773 @defopt reftex-bib-extra-face
Dave Love <fx@gnu.org>
parents:
diff changeset
4774 Face name for bibliographic information in bib selection buffer.
Dave Love <fx@gnu.org>
parents:
diff changeset
4775 @end defopt
Dave Love <fx@gnu.org>
parents:
diff changeset
4776 @defopt reftex-select-mark-face
Dave Love <fx@gnu.org>
parents:
diff changeset
4777 Face name for marked entries in the selection buffers.
Dave Love <fx@gnu.org>
parents:
diff changeset
4778 @end defopt
Dave Love <fx@gnu.org>
parents:
diff changeset
4779 @defopt reftex-index-header-face
Dave Love <fx@gnu.org>
parents:
diff changeset
4780 Face name for the header of an index buffer.
Dave Love <fx@gnu.org>
parents:
diff changeset
4781 @end defopt
Dave Love <fx@gnu.org>
parents:
diff changeset
4782 @defopt reftex-index-section-face
Dave Love <fx@gnu.org>
parents:
diff changeset
4783 Face name for the start of a new letter section in the index.
Dave Love <fx@gnu.org>
parents:
diff changeset
4784 @end defopt
Dave Love <fx@gnu.org>
parents:
diff changeset
4785 @defopt reftex-index-tag-face
Dave Love <fx@gnu.org>
parents:
diff changeset
4786 Face name for index names (for multiple indices).
Dave Love <fx@gnu.org>
parents:
diff changeset
4787 @end defopt
Dave Love <fx@gnu.org>
parents:
diff changeset
4788 @defopt reftex-index-face
Dave Love <fx@gnu.org>
parents:
diff changeset
4789 Face name for index entries.
Dave Love <fx@gnu.org>
parents:
diff changeset
4790 @end defopt
Dave Love <fx@gnu.org>
parents:
diff changeset
4791
Dave Love <fx@gnu.org>
parents:
diff changeset
4792 @node Options (Misc), , Options (Fontification), Options
Dave Love <fx@gnu.org>
parents:
diff changeset
4793 @section Miscellaneous
Dave Love <fx@gnu.org>
parents:
diff changeset
4794 @cindex Options, misc
Dave Love <fx@gnu.org>
parents:
diff changeset
4795
Dave Love <fx@gnu.org>
parents:
diff changeset
4796 @defopt reftex-extra-bindings
Dave Love <fx@gnu.org>
parents:
diff changeset
4797 Non-@code{nil} means, make additional key bindings on startup. These
Dave Love <fx@gnu.org>
parents:
diff changeset
4798 extra bindings are located in the users @samp{C-c letter}
39267
a8c0a02f6129 Spelling corrections.
Richard M. Stallman <rms@gnu.org>
parents: 38003
diff changeset
4799 map. @xref{Key Bindings}.@refill
25829
Dave Love <fx@gnu.org>
parents:
diff changeset
4800 @end defopt
Dave Love <fx@gnu.org>
parents:
diff changeset
4801
Dave Love <fx@gnu.org>
parents:
diff changeset
4802 @defopt reftex-plug-into-AUCTeX
Dave Love <fx@gnu.org>
parents:
diff changeset
4803 Plug-in flags for AUCTeX interface. This variable is a list of
Dave Love <fx@gnu.org>
parents:
diff changeset
4804 5 boolean flags. When a flag is non-@code{nil}, @b{Ref@TeX{}}
Dave Love <fx@gnu.org>
parents:
diff changeset
4805 will@refill
Dave Love <fx@gnu.org>
parents:
diff changeset
4806
Dave Love <fx@gnu.org>
parents:
diff changeset
4807 @example
Dave Love <fx@gnu.org>
parents:
diff changeset
4808 - supply labels in new sections and environments (flag 1)
Dave Love <fx@gnu.org>
parents:
diff changeset
4809 - supply arguments for macros like @code{\label} (flag 2)
Dave Love <fx@gnu.org>
parents:
diff changeset
4810 - supply arguments for macros like @code{\ref} (flag 3)
Dave Love <fx@gnu.org>
parents:
diff changeset
4811 - supply arguments for macros like @code{\cite} (flag 4)
Dave Love <fx@gnu.org>
parents:
diff changeset
4812 - supply arguments for macros like @code{\index} (flag 5)
Dave Love <fx@gnu.org>
parents:
diff changeset
4813 @end example
Dave Love <fx@gnu.org>
parents:
diff changeset
4814
Dave Love <fx@gnu.org>
parents:
diff changeset
4815 You may also set the variable itself to t or nil in order to turn all
Dave Love <fx@gnu.org>
parents:
diff changeset
4816 options on or off, respectively.@*
Dave Love <fx@gnu.org>
parents:
diff changeset
4817 Supplying labels in new sections and environments applies when creating
Dave Love <fx@gnu.org>
parents:
diff changeset
4818 sections with @kbd{C-c C-s} and environments with @kbd{C-c C-e}.@*
Dave Love <fx@gnu.org>
parents:
diff changeset
4819 Supplying macro arguments applies when you insert such a macro
Dave Love <fx@gnu.org>
parents:
diff changeset
4820 interactively with @kbd{C-c @key{RET}}.@*
Dave Love <fx@gnu.org>
parents:
diff changeset
4821 See the AUCTeX documentation for more information.
Dave Love <fx@gnu.org>
parents:
diff changeset
4822 @end defopt
Dave Love <fx@gnu.org>
parents:
diff changeset
4823
Dave Love <fx@gnu.org>
parents:
diff changeset
4824 @defopt reftex-revisit-to-follow
Dave Love <fx@gnu.org>
parents:
diff changeset
4825 Non-@code{nil} means, follow-mode will revisit files if necessary.
Dave Love <fx@gnu.org>
parents:
diff changeset
4826 When nil, follow-mode will be suspended for stuff in unvisited files.
Dave Love <fx@gnu.org>
parents:
diff changeset
4827 @end defopt
Dave Love <fx@gnu.org>
parents:
diff changeset
4828
Dave Love <fx@gnu.org>
parents:
diff changeset
4829 @defopt reftex-allow-detached-macro-args
Dave Love <fx@gnu.org>
parents:
diff changeset
4830 Non-@code{nil} means, allow arguments of macros to be detached by
Dave Love <fx@gnu.org>
parents:
diff changeset
4831 whitespace. When this is @code{t}, the @samp{aaa} in @w{@samp{\bbb
Dave Love <fx@gnu.org>
parents:
diff changeset
4832 [xxx] @{aaa@}}} will be considered an argument of @code{\bb}. Note that
Dave Love <fx@gnu.org>
parents:
diff changeset
4833 this will be the case even if @code{\bb} is defined with zero or one
Dave Love <fx@gnu.org>
parents:
diff changeset
4834 argument.@refill
Dave Love <fx@gnu.org>
parents:
diff changeset
4835 @end defopt
Dave Love <fx@gnu.org>
parents:
diff changeset
4836
Dave Love <fx@gnu.org>
parents:
diff changeset
4837 @node Keymaps and Hooks, Changes, Options, Top
Dave Love <fx@gnu.org>
parents:
diff changeset
4838 @section Keymaps and Hooks
Dave Love <fx@gnu.org>
parents:
diff changeset
4839 @cindex Keymaps
Dave Love <fx@gnu.org>
parents:
diff changeset
4840
Dave Love <fx@gnu.org>
parents:
diff changeset
4841 @b{Ref@TeX{}} has the usual general keymap and load-- and mode-hook.
Dave Love <fx@gnu.org>
parents:
diff changeset
4842
Dave Love <fx@gnu.org>
parents:
diff changeset
4843 @deffn Keymap reftex-mode-map
Dave Love <fx@gnu.org>
parents:
diff changeset
4844 The keymap for @b{Ref@TeX{}} mode.
Dave Love <fx@gnu.org>
parents:
diff changeset
4845 @end deffn
Dave Love <fx@gnu.org>
parents:
diff changeset
4846
Dave Love <fx@gnu.org>
parents:
diff changeset
4847 @deffn {Normal Hook} reftex-load-hook
Dave Love <fx@gnu.org>
parents:
diff changeset
4848 Normal hook which is being run when loading @file{reftex.el}.
Dave Love <fx@gnu.org>
parents:
diff changeset
4849 @end deffn
Dave Love <fx@gnu.org>
parents:
diff changeset
4850
Dave Love <fx@gnu.org>
parents:
diff changeset
4851 @deffn {Normal Hook} reftex-mode-hook
Dave Love <fx@gnu.org>
parents:
diff changeset
4852 Normal hook which is being run when turning on @b{Ref@TeX{}} mode.@refill
Dave Love <fx@gnu.org>
parents:
diff changeset
4853 @end deffn
Dave Love <fx@gnu.org>
parents:
diff changeset
4854
26911
d7f536a01276 Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents: 25829
diff changeset
4855 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
4856 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
4857 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
4858 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
4859 options for a specific part of @b{Ref@TeX{}}.@refill
25829
Dave Love <fx@gnu.org>
parents:
diff changeset
4860
Dave Love <fx@gnu.org>
parents:
diff changeset
4861 @node Changes, , Keymaps and Hooks, Top
Dave Love <fx@gnu.org>
parents:
diff changeset
4862 @chapter Changes
Dave Love <fx@gnu.org>
parents:
diff changeset
4863 @cindex Changes
Dave Love <fx@gnu.org>
parents:
diff changeset
4864
Dave Love <fx@gnu.org>
parents:
diff changeset
4865 Here is a list of recent changes to @b{Ref@TeX{}}.
Dave Love <fx@gnu.org>
parents:
diff changeset
4866
Dave Love <fx@gnu.org>
parents:
diff changeset
4867 @ignore
Dave Love <fx@gnu.org>
parents:
diff changeset
4868 @noindent @b{Version 1.00}
Dave Love <fx@gnu.org>
parents:
diff changeset
4869 @itemize @bullet
Dave Love <fx@gnu.org>
parents:
diff changeset
4870 @item
Dave Love <fx@gnu.org>
parents:
diff changeset
4871 released on 7 Jan 1997.
Dave Love <fx@gnu.org>
parents:
diff changeset
4872 @end itemize
Dave Love <fx@gnu.org>
parents:
diff changeset
4873
Dave Love <fx@gnu.org>
parents:
diff changeset
4874 @noindent @b{Version 1.04}
Dave Love <fx@gnu.org>
parents:
diff changeset
4875 @itemize @bullet
Dave Love <fx@gnu.org>
parents:
diff changeset
4876 @item
Dave Love <fx@gnu.org>
parents:
diff changeset
4877 Macros as wrappers, AMSTeX support, delayed context parsing for
Dave Love <fx@gnu.org>
parents:
diff changeset
4878 new labels.@refill
Dave Love <fx@gnu.org>
parents:
diff changeset
4879 @end itemize
Dave Love <fx@gnu.org>
parents:
diff changeset
4880
Dave Love <fx@gnu.org>
parents:
diff changeset
4881 @noindent @b{Version 1.05}
Dave Love <fx@gnu.org>
parents:
diff changeset
4882 @itemize @bullet
Dave Love <fx@gnu.org>
parents:
diff changeset
4883 @item
Dave Love <fx@gnu.org>
parents:
diff changeset
4884 XEmacs port.
Dave Love <fx@gnu.org>
parents:
diff changeset
4885 @end itemize
Dave Love <fx@gnu.org>
parents:
diff changeset
4886
Dave Love <fx@gnu.org>
parents:
diff changeset
4887 @noindent @b{Version 1.07}
Dave Love <fx@gnu.org>
parents:
diff changeset
4888 @itemize @bullet
Dave Love <fx@gnu.org>
parents:
diff changeset
4889 @item
Dave Love <fx@gnu.org>
parents:
diff changeset
4890 @b{Ref@TeX{}} gets its own menu.
Dave Love <fx@gnu.org>
parents:
diff changeset
4891 @end itemize
Dave Love <fx@gnu.org>
parents:
diff changeset
4892
Dave Love <fx@gnu.org>
parents:
diff changeset
4893 @noindent @b{Version 1.09}
Dave Love <fx@gnu.org>
parents:
diff changeset
4894 @itemize @bullet
Dave Love <fx@gnu.org>
parents:
diff changeset
4895 @item
Dave Love <fx@gnu.org>
parents:
diff changeset
4896 Support for @code{tex-main-file}, an analogue for
Dave Love <fx@gnu.org>
parents:
diff changeset
4897 @code{TeX-master}.@refill
Dave Love <fx@gnu.org>
parents:
diff changeset
4898 @item
Dave Love <fx@gnu.org>
parents:
diff changeset
4899 MS-DOS support.
Dave Love <fx@gnu.org>
parents:
diff changeset
4900 @end itemize
Dave Love <fx@gnu.org>
parents:
diff changeset
4901
Dave Love <fx@gnu.org>
parents:
diff changeset
4902 @noindent @b{Version 2.00}
Dave Love <fx@gnu.org>
parents:
diff changeset
4903 @itemize @bullet
Dave Love <fx@gnu.org>
parents:
diff changeset
4904 @item
Dave Love <fx@gnu.org>
parents:
diff changeset
4905 Labels can be derived from context (default for sections).
Dave Love <fx@gnu.org>
parents:
diff changeset
4906 @item
Dave Love <fx@gnu.org>
parents:
diff changeset
4907 Configuration of label insertion and label referencing revised.
Dave Love <fx@gnu.org>
parents:
diff changeset
4908 @item
Dave Love <fx@gnu.org>
parents:
diff changeset
4909 Crossref fields in BibTeX database entries.
Dave Love <fx@gnu.org>
parents:
diff changeset
4910 @item
Dave Love <fx@gnu.org>
parents:
diff changeset
4911 @code{reftex-toc} introduced (thanks to Stephen Eglen).
Dave Love <fx@gnu.org>
parents:
diff changeset
4912 @end itemize
Dave Love <fx@gnu.org>
parents:
diff changeset
4913
Dave Love <fx@gnu.org>
parents:
diff changeset
4914 @noindent @b{Version 2.03}
Dave Love <fx@gnu.org>
parents:
diff changeset
4915 @itemize @bullet
Dave Love <fx@gnu.org>
parents:
diff changeset
4916 @item
Dave Love <fx@gnu.org>
parents:
diff changeset
4917 @code{figure*}, @code{table*}, @code{sidewaysfigure/table} added to
Dave Love <fx@gnu.org>
parents:
diff changeset
4918 default environments.@refill
Dave Love <fx@gnu.org>
parents:
diff changeset
4919 @item
Dave Love <fx@gnu.org>
parents:
diff changeset
4920 @code{reftex-bibfile-ignore-list} introduced (thanks to Rory Molinari).
Dave Love <fx@gnu.org>
parents:
diff changeset
4921 @item
Dave Love <fx@gnu.org>
parents:
diff changeset
4922 New functions @code{reftex-arg-label}, @code{reftex-arg-ref},
Dave Love <fx@gnu.org>
parents:
diff changeset
4923 @code{reftex-arg-cite}.@refill
Dave Love <fx@gnu.org>
parents:
diff changeset
4924 @item
Dave Love <fx@gnu.org>
parents:
diff changeset
4925 Emacs/XEmacs compatibility reworked. XEmacs 19.15 now is
Dave Love <fx@gnu.org>
parents:
diff changeset
4926 required.@refill
Dave Love <fx@gnu.org>
parents:
diff changeset
4927 @item
Dave Love <fx@gnu.org>
parents:
diff changeset
4928 @code{reftex-add-to-label-alist} (to be called from AUCTeX style
Dave Love <fx@gnu.org>
parents:
diff changeset
4929 files).@refill
Dave Love <fx@gnu.org>
parents:
diff changeset
4930 @item
Dave Love <fx@gnu.org>
parents:
diff changeset
4931 Finding context with a hook function.
Dave Love <fx@gnu.org>
parents:
diff changeset
4932 @item
Dave Love <fx@gnu.org>
parents:
diff changeset
4933 Sorting BibTeX entries (new variable:
Dave Love <fx@gnu.org>
parents:
diff changeset
4934 @code{reftex-sort-bibtex-matches}).
Dave Love <fx@gnu.org>
parents:
diff changeset
4935 @end itemize
Dave Love <fx@gnu.org>
parents:
diff changeset
4936
Dave Love <fx@gnu.org>
parents:
diff changeset
4937 @noindent @b{Version 2.05}
Dave Love <fx@gnu.org>
parents:
diff changeset
4938 @itemize @bullet
Dave Love <fx@gnu.org>
parents:
diff changeset
4939 @item
Dave Love <fx@gnu.org>
parents:
diff changeset
4940 Support for @file{custom.el}.
Dave Love <fx@gnu.org>
parents:
diff changeset
4941 @item
Dave Love <fx@gnu.org>
parents:
diff changeset
4942 New function @code{reftex-grep-document} (thanks to Stephen Eglen).
Dave Love <fx@gnu.org>
parents:
diff changeset
4943 @end itemize
Dave Love <fx@gnu.org>
parents:
diff changeset
4944
Dave Love <fx@gnu.org>
parents:
diff changeset
4945 @noindent @b{Version 2.07}
Dave Love <fx@gnu.org>
parents:
diff changeset
4946 @itemize @bullet
Dave Love <fx@gnu.org>
parents:
diff changeset
4947 @item
Dave Love <fx@gnu.org>
parents:
diff changeset
4948 New functions @code{reftex-search-document},
Dave Love <fx@gnu.org>
parents:
diff changeset
4949 @code{reftex-query-replace-document}.
Dave Love <fx@gnu.org>
parents:
diff changeset
4950 @end itemize
Dave Love <fx@gnu.org>
parents:
diff changeset
4951
Dave Love <fx@gnu.org>
parents:
diff changeset
4952 @noindent @b{Version 2.11}
Dave Love <fx@gnu.org>
parents:
diff changeset
4953 @itemize @bullet
Dave Love <fx@gnu.org>
parents:
diff changeset
4954 @item
Dave Love <fx@gnu.org>
parents:
diff changeset
4955 Submitted for inclusion to Emacs and XEmacs.
Dave Love <fx@gnu.org>
parents:
diff changeset
4956 @end itemize
Dave Love <fx@gnu.org>
parents:
diff changeset
4957
Dave Love <fx@gnu.org>
parents:
diff changeset
4958 @noindent @b{Version 2.14}
Dave Love <fx@gnu.org>
parents:
diff changeset
4959 @itemize @bullet
Dave Love <fx@gnu.org>
parents:
diff changeset
4960 @item
Dave Love <fx@gnu.org>
parents:
diff changeset
4961 Variable @code{reftex-plug-into-AUCTeX} simplifies cooperation with
Dave Love <fx@gnu.org>
parents:
diff changeset
4962 AUCTeX.@refill
Dave Love <fx@gnu.org>
parents:
diff changeset
4963 @end itemize
Dave Love <fx@gnu.org>
parents:
diff changeset
4964
Dave Love <fx@gnu.org>
parents:
diff changeset
4965 @noindent @b{Version 2.17}
Dave Love <fx@gnu.org>
parents:
diff changeset
4966 @itemize @bullet
Dave Love <fx@gnu.org>
parents:
diff changeset
4967 @item
Dave Love <fx@gnu.org>
parents:
diff changeset
4968 Label prefix expands % escapes with current file name and other stuff.
Dave Love <fx@gnu.org>
parents:
diff changeset
4969 @item
Dave Love <fx@gnu.org>
parents:
diff changeset
4970 Citation format now with % escapes. This is not backward
Dave Love <fx@gnu.org>
parents:
diff changeset
4971 compatible!@refill
Dave Love <fx@gnu.org>
parents:
diff changeset
4972 @item
Dave Love <fx@gnu.org>
parents:
diff changeset
4973 TEXINPUTS variable recognized when looking for input files.
Dave Love <fx@gnu.org>
parents:
diff changeset
4974 @item
Dave Love <fx@gnu.org>
parents:
diff changeset
4975 Context can be the nth argument of a macro.@refill
Dave Love <fx@gnu.org>
parents:
diff changeset
4976 @item
Dave Love <fx@gnu.org>
parents:
diff changeset
4977 Searching in the select buffer is now possible (@kbd{C-s} and
Dave Love <fx@gnu.org>
parents:
diff changeset
4978 @kbd{C-r}).@refill
Dave Love <fx@gnu.org>
parents:
diff changeset
4979 @item
Dave Love <fx@gnu.org>
parents:
diff changeset
4980 Display and derive-label can use two different context methods.
Dave Love <fx@gnu.org>
parents:
diff changeset
4981 @item
Dave Love <fx@gnu.org>
parents:
diff changeset
4982 AMSmath @code{xalignat} and @code{xxalignat} added.
Dave Love <fx@gnu.org>
parents:
diff changeset
4983 @end itemize
Dave Love <fx@gnu.org>
parents:
diff changeset
4984
Dave Love <fx@gnu.org>
parents:
diff changeset
4985 @noindent @b{Version 3.00}
Dave Love <fx@gnu.org>
parents:
diff changeset
4986 @itemize @bullet
Dave Love <fx@gnu.org>
parents:
diff changeset
4987 @item
Dave Love <fx@gnu.org>
parents:
diff changeset
4988 @b{Ref@TeX{}} should work better for very large projects:
Dave Love <fx@gnu.org>
parents:
diff changeset
4989 @item
Dave Love <fx@gnu.org>
parents:
diff changeset
4990 The new parser works without creating a master buffer.
Dave Love <fx@gnu.org>
parents:
diff changeset
4991 @item
Dave Love <fx@gnu.org>
parents:
diff changeset
4992 Rescanning can be limited to a part of a multifile document.
Dave Love <fx@gnu.org>
parents:
diff changeset
4993 @item
Dave Love <fx@gnu.org>
parents:
diff changeset
4994 Information from the parser can be stored in a file.
Dave Love <fx@gnu.org>
parents:
diff changeset
4995 @item
Dave Love <fx@gnu.org>
parents:
diff changeset
4996 @b{Ref@TeX{}} can deal with macros having a naked label as an argument.
Dave Love <fx@gnu.org>
parents:
diff changeset
4997 @item
Dave Love <fx@gnu.org>
parents:
diff changeset
4998 Macros may have white space and newlines between arguments.
Dave Love <fx@gnu.org>
parents:
diff changeset
4999 @item
Dave Love <fx@gnu.org>
parents:
diff changeset
5000 Multiple identical section headings no longer confuse
Dave Love <fx@gnu.org>
parents:
diff changeset
5001 @code{reftex-toc}.@refill
Dave Love <fx@gnu.org>
parents:
diff changeset
5002 @item
Dave Love <fx@gnu.org>
parents:
diff changeset
5003 @b{Ref@TeX{}} should work correctly in combination with buffer-altering
Dave Love <fx@gnu.org>
parents:
diff changeset
5004 packages like outline, folding, x-symbol, iso-cvt, isotex, etc.@refill
Dave Love <fx@gnu.org>
parents:
diff changeset
5005 @item
Dave Love <fx@gnu.org>
parents:
diff changeset
5006 All labeled environments discussed in @emph{The LaTeX Companion} by
Dave Love <fx@gnu.org>
parents:
diff changeset
5007 Goossens, Mittelbach & Samarin, Addison-Wesley 1994) are part of
Dave Love <fx@gnu.org>
parents:
diff changeset
5008 @b{Ref@TeX{}}'s defaults.@refill
Dave Love <fx@gnu.org>
parents:
diff changeset
5009 @end itemize
Dave Love <fx@gnu.org>
parents:
diff changeset
5010
Dave Love <fx@gnu.org>
parents:
diff changeset
5011 @noindent @b{Version 3.03}
Dave Love <fx@gnu.org>
parents:
diff changeset
5012 @itemize @bullet
Dave Love <fx@gnu.org>
parents:
diff changeset
5013 @item
Dave Love <fx@gnu.org>
parents:
diff changeset
5014 Support for the LaTeX package @code{xr}, for inter-document
Dave Love <fx@gnu.org>
parents:
diff changeset
5015 references.@refill
Dave Love <fx@gnu.org>
parents:
diff changeset
5016 @item
Dave Love <fx@gnu.org>
parents:
diff changeset
5017 A few (minor) Mule-related changes.
Dave Love <fx@gnu.org>
parents:
diff changeset
5018 @item
Dave Love <fx@gnu.org>
parents:
diff changeset
5019 Fixed bug which could cause @emph{huge} @file{.rel} files.
Dave Love <fx@gnu.org>
parents:
diff changeset
5020 @item
Dave Love <fx@gnu.org>
parents:
diff changeset
5021 Search for input and @file{.bib} files with recursive path definitions.
Dave Love <fx@gnu.org>
parents:
diff changeset
5022 @end itemize
Dave Love <fx@gnu.org>
parents:
diff changeset
5023
Dave Love <fx@gnu.org>
parents:
diff changeset
5024 @noindent @b{Version 3.04}
Dave Love <fx@gnu.org>
parents:
diff changeset
5025 @itemize @bullet
Dave Love <fx@gnu.org>
parents:
diff changeset
5026 @item
Dave Love <fx@gnu.org>
parents:
diff changeset
5027 Fixed BUG in the @emph{xr} support.
Dave Love <fx@gnu.org>
parents:
diff changeset
5028 @end itemize
Dave Love <fx@gnu.org>
parents:
diff changeset
5029
Dave Love <fx@gnu.org>
parents:
diff changeset
5030 @noindent @b{Version 3.05}
Dave Love <fx@gnu.org>
parents:
diff changeset
5031 @itemize @bullet
Dave Love <fx@gnu.org>
parents:
diff changeset
5032 @item
Dave Love <fx@gnu.org>
parents:
diff changeset
5033 Compatibility code now first checks for XEmacs feature.
Dave Love <fx@gnu.org>
parents:
diff changeset
5034 @end itemize
Dave Love <fx@gnu.org>
parents:
diff changeset
5035
Dave Love <fx@gnu.org>
parents:
diff changeset
5036 @noindent @b{Version 3.07}
Dave Love <fx@gnu.org>
parents:
diff changeset
5037 @itemize @bullet
Dave Love <fx@gnu.org>
parents:
diff changeset
5038 @item
Dave Love <fx@gnu.org>
parents:
diff changeset
5039 @code{Ref} menu improved.
Dave Love <fx@gnu.org>
parents:
diff changeset
5040 @end itemize
Dave Love <fx@gnu.org>
parents:
diff changeset
5041
Dave Love <fx@gnu.org>
parents:
diff changeset
5042 @noindent @b{Version 3.10}
Dave Love <fx@gnu.org>
parents:
diff changeset
5043 @itemize @bullet
Dave Love <fx@gnu.org>
parents:
diff changeset
5044 @item
Dave Love <fx@gnu.org>
parents:
diff changeset
5045 Fixed a bug which made reftex 3.07 fail on [X]Emacs version 19.
Dave Love <fx@gnu.org>
parents:
diff changeset
5046 @item
Dave Love <fx@gnu.org>
parents:
diff changeset
5047 Removed unimportant code which caused OS/2 Emacs to crash.
Dave Love <fx@gnu.org>
parents:
diff changeset
5048 @item
Dave Love <fx@gnu.org>
parents:
diff changeset
5049 All customization variables now accessible from menu.
Dave Love <fx@gnu.org>
parents:
diff changeset
5050 @end itemize
Dave Love <fx@gnu.org>
parents:
diff changeset
5051
Dave Love <fx@gnu.org>
parents:
diff changeset
5052 @noindent @b{Version 3.11}
Dave Love <fx@gnu.org>
parents:
diff changeset
5053 @itemize @bullet
Dave Love <fx@gnu.org>
parents:
diff changeset
5054 @item
Dave Love <fx@gnu.org>
parents:
diff changeset
5055 Fixed bug which led to naked label in (e.g.) footnotes.
Dave Love <fx@gnu.org>
parents:
diff changeset
5056 @item
Dave Love <fx@gnu.org>
parents:
diff changeset
5057 Added scroll-other-window functions to RefTeX-Select.
Dave Love <fx@gnu.org>
parents:
diff changeset
5058 @end itemize
Dave Love <fx@gnu.org>
parents:
diff changeset
5059
Dave Love <fx@gnu.org>
parents:
diff changeset
5060 @noindent @b{Version 3.12}
Dave Love <fx@gnu.org>
parents:
diff changeset
5061 @itemize @bullet
Dave Love <fx@gnu.org>
parents:
diff changeset
5062 @item
Dave Love <fx@gnu.org>
parents:
diff changeset
5063 There are 3 new keymaps for customization: @code{reftex-toc-map},
Dave Love <fx@gnu.org>
parents:
diff changeset
5064 @code{reftex-select-label-map}, @code{reftex-select-bib-map}.
Dave Love <fx@gnu.org>
parents:
diff changeset
5065 @item
Dave Love <fx@gnu.org>
parents:
diff changeset
5066 Refontification uses more standard font-lock stuff.
Dave Love <fx@gnu.org>
parents:
diff changeset
5067 @item
Dave Love <fx@gnu.org>
parents:
diff changeset
5068 When no BibTeX database files are specified, citations can also use
Dave Love <fx@gnu.org>
parents:
diff changeset
5069 @code{\bibitem} entries from a @code{thebibliography} environment.@refill
Dave Love <fx@gnu.org>
parents:
diff changeset
5070 @end itemize
Dave Love <fx@gnu.org>
parents:
diff changeset
5071
Dave Love <fx@gnu.org>
parents:
diff changeset
5072 @noindent @b{Version 3.14}
Dave Love <fx@gnu.org>
parents:
diff changeset
5073 @itemize @bullet
Dave Love <fx@gnu.org>
parents:
diff changeset
5074 @item
Dave Love <fx@gnu.org>
parents:
diff changeset
5075 Selection buffers can be kept between selections: this is faster.
Dave Love <fx@gnu.org>
parents:
diff changeset
5076 See new variable @code{reftex-use-multiple-selection-buffers}.@refill
Dave Love <fx@gnu.org>
parents:
diff changeset
5077 @item
Dave Love <fx@gnu.org>
parents:
diff changeset
5078 Prefix interpretation of reftex-view-crossref changed.
Dave Love <fx@gnu.org>
parents:
diff changeset
5079 @item
Dave Love <fx@gnu.org>
parents:
diff changeset
5080 Support for the @code{varioref} package (@kbd{v} key in selection
Dave Love <fx@gnu.org>
parents:
diff changeset
5081 buffer).@refill
Dave Love <fx@gnu.org>
parents:
diff changeset
5082 @end itemize
Dave Love <fx@gnu.org>
parents:
diff changeset
5083
Dave Love <fx@gnu.org>
parents:
diff changeset
5084 @noindent @b{Version 3.16}
Dave Love <fx@gnu.org>
parents:
diff changeset
5085 @itemize @bullet
Dave Love <fx@gnu.org>
parents:
diff changeset
5086 @item
Dave Love <fx@gnu.org>
parents:
diff changeset
5087 New hooks @code{reftex-format-label-function},
Dave Love <fx@gnu.org>
parents:
diff changeset
5088 @code{reftex-format-ref-function}, @code{reftex-format-cite-function}.@refill
Dave Love <fx@gnu.org>
parents:
diff changeset
5089 @item
Dave Love <fx@gnu.org>
parents:
diff changeset
5090 TeXInfo documentation completed.
Dave Love <fx@gnu.org>
parents:
diff changeset
5091 @item
Dave Love <fx@gnu.org>
parents:
diff changeset
5092 Some restrictions in Label inserting and referencing removed.
Dave Love <fx@gnu.org>
parents:
diff changeset
5093 @item
Dave Love <fx@gnu.org>
parents:
diff changeset
5094 New variable @code{reftex-default-bibliography}.
Dave Love <fx@gnu.org>
parents:
diff changeset
5095 @end itemize
Dave Love <fx@gnu.org>
parents:
diff changeset
5096
Dave Love <fx@gnu.org>
parents:
diff changeset
5097 @noindent @b{Version 3.17}
Dave Love <fx@gnu.org>
parents:
diff changeset
5098 @itemize @bullet
Dave Love <fx@gnu.org>
parents:
diff changeset
5099 @item
Dave Love <fx@gnu.org>
parents:
diff changeset
5100 Additional bindings in selection and @file{*toc*} buffers. @kbd{g}
Dave Love <fx@gnu.org>
parents:
diff changeset
5101 redefined.
Dave Love <fx@gnu.org>
parents:
diff changeset
5102 @item
Dave Love <fx@gnu.org>
parents:
diff changeset
5103 New command @code{reftex-save-all-document-buffers}.
Dave Love <fx@gnu.org>
parents:
diff changeset
5104 @item
Dave Love <fx@gnu.org>
parents:
diff changeset
5105 Magic word matching made more intelligent.
Dave Love <fx@gnu.org>
parents:
diff changeset
5106 @item
Dave Love <fx@gnu.org>
parents:
diff changeset
5107 Selection process can switch to completion (with @key{TAB}).
Dave Love <fx@gnu.org>
parents:
diff changeset
5108 @item
Dave Love <fx@gnu.org>
parents:
diff changeset
5109 @code{\appendix} is now recognized and influences section numbering.
Dave Love <fx@gnu.org>
parents:
diff changeset
5110 @item
Dave Love <fx@gnu.org>
parents:
diff changeset
5111 File commentary shortened considerably (use Info documentation).
Dave Love <fx@gnu.org>
parents:
diff changeset
5112 @item
Dave Love <fx@gnu.org>
parents:
diff changeset
5113 New option @code{reftex-no-include-regexps} to skip some include files.
Dave Love <fx@gnu.org>
parents:
diff changeset
5114 @item
Dave Love <fx@gnu.org>
parents:
diff changeset
5115 New option @code{reftex-revisit-to-follow}.
Dave Love <fx@gnu.org>
parents:
diff changeset
5116 @end itemize
Dave Love <fx@gnu.org>
parents:
diff changeset
5117
Dave Love <fx@gnu.org>
parents:
diff changeset
5118 @noindent @b{Version 3.18}
Dave Love <fx@gnu.org>
parents:
diff changeset
5119 @itemize @bullet
Dave Love <fx@gnu.org>
parents:
diff changeset
5120 @item
Dave Love <fx@gnu.org>
parents:
diff changeset
5121 The selection now uses a recursive edit, much like minibuffer input.
Dave Love <fx@gnu.org>
parents:
diff changeset
5122 This removes all restrictions during selection. E.g. you can now
Dave Love <fx@gnu.org>
parents:
diff changeset
5123 switch buffers at will, use the mouse etc.@refill
Dave Love <fx@gnu.org>
parents:
diff changeset
5124 @item
Dave Love <fx@gnu.org>
parents:
diff changeset
5125 New option @code{reftex-highlight-selection}.
Dave Love <fx@gnu.org>
parents:
diff changeset
5126 @item
37999
8e7df927fd92 Updated to version 4.16
Carsten Dominik <dominik@science.uva.nl>
parents: 37404
diff changeset
5127 @kbd{mouse-2} can be used to select in selection and @file{*toc*}
25829
Dave Love <fx@gnu.org>
parents:
diff changeset
5128 buffers.@refill
Dave Love <fx@gnu.org>
parents:
diff changeset
5129 @item
Dave Love <fx@gnu.org>
parents:
diff changeset
5130 Fixed some problems regarding the interaction with VIPER mode.
Dave Love <fx@gnu.org>
parents:
diff changeset
5131 @item
Dave Love <fx@gnu.org>
parents:
diff changeset
5132 Follow-mode is now only used after point motion.
Dave Love <fx@gnu.org>
parents:
diff changeset
5133 @item
Dave Love <fx@gnu.org>
parents:
diff changeset
5134 @b{Ref@TeX{}} now finally does not fontify temporary files anymore.
Dave Love <fx@gnu.org>
parents:
diff changeset
5135 @end itemize
Dave Love <fx@gnu.org>
parents:
diff changeset
5136
Dave Love <fx@gnu.org>
parents:
diff changeset
5137 @noindent @b{Version 3.19}
Dave Love <fx@gnu.org>
parents:
diff changeset
5138 @itemize @bullet
Dave Love <fx@gnu.org>
parents:
diff changeset
5139 @item
Dave Love <fx@gnu.org>
parents:
diff changeset
5140 Fixed bug with AUCTeX @code{TeX-master}.
Dave Love <fx@gnu.org>
parents:
diff changeset
5141 @end itemize
Dave Love <fx@gnu.org>
parents:
diff changeset
5142
Dave Love <fx@gnu.org>
parents:
diff changeset
5143 @noindent @b{Version 3.21}
Dave Love <fx@gnu.org>
parents:
diff changeset
5144 @itemize @bullet
Dave Love <fx@gnu.org>
parents:
diff changeset
5145 @item
Dave Love <fx@gnu.org>
parents:
diff changeset
5146 New options for all faces used by @b{Ref@TeX{}}. They're in the
Dave Love <fx@gnu.org>
parents:
diff changeset
5147 customization group @code{reftex-fontification-configurations}.@refill
Dave Love <fx@gnu.org>
parents:
diff changeset
5148 @end itemize
Dave Love <fx@gnu.org>
parents:
diff changeset
5149
Dave Love <fx@gnu.org>
parents:
diff changeset
5150 @noindent @b{Version 3.22}
Dave Love <fx@gnu.org>
parents:
diff changeset
5151 @itemize @bullet
Dave Love <fx@gnu.org>
parents:
diff changeset
5152 @item
Dave Love <fx@gnu.org>
parents:
diff changeset
5153 Fixed bug with empty context strings.
Dave Love <fx@gnu.org>
parents:
diff changeset
5154 @item
Dave Love <fx@gnu.org>
parents:
diff changeset
5155 @code{reftex-mouse-view-crossref} is now bound by default at
37999
8e7df927fd92 Updated to version 4.16
Carsten Dominik <dominik@science.uva.nl>
parents: 37404
diff changeset
5156 @kbd{S-mouse-2}.@refill
25829
Dave Love <fx@gnu.org>
parents:
diff changeset
5157 @end itemize
Dave Love <fx@gnu.org>
parents:
diff changeset
5158
Dave Love <fx@gnu.org>
parents:
diff changeset
5159 @noindent @b{Version 3.23}
Dave Love <fx@gnu.org>
parents:
diff changeset
5160 @itemize @bullet
Dave Love <fx@gnu.org>
parents:
diff changeset
5161 @item
Dave Love <fx@gnu.org>
parents:
diff changeset
5162 Parse files @file{MASTER.rel} made compatible between Emacs and XEmacs.
Dave Love <fx@gnu.org>
parents:
diff changeset
5163 @item
Dave Love <fx@gnu.org>
parents:
diff changeset
5164 @code{kill-emacs-hook} and @code{kill-buffer-hook} now write the parse
Dave Love <fx@gnu.org>
parents:
diff changeset
5165 file.
Dave Love <fx@gnu.org>
parents:
diff changeset
5166 @item
Dave Love <fx@gnu.org>
parents:
diff changeset
5167 The cursor inside a @code{\ref} or @code{\cite} macro can now trigger
Dave Love <fx@gnu.org>
parents:
diff changeset
5168 automatic display of crossref information in the echo area. See
Dave Love <fx@gnu.org>
parents:
diff changeset
5169 variable @code{reftex-auto-view-crossref}.
Dave Love <fx@gnu.org>
parents:
diff changeset
5170 @item
Dave Love <fx@gnu.org>
parents:
diff changeset
5171 AUCTeX interface updates:
Dave Love <fx@gnu.org>
parents:
diff changeset
5172 @itemize @minus
Dave Love <fx@gnu.org>
parents:
diff changeset
5173 @item
Dave Love <fx@gnu.org>
parents:
diff changeset
5174 AUCTeX 9.9c and later notifies @b{Ref@TeX{}} about new sections.
Dave Love <fx@gnu.org>
parents:
diff changeset
5175 @item
Dave Love <fx@gnu.org>
parents:
diff changeset
5176 @b{Ref@TeX{}} notifies AUCTeX about new labels.
Dave Love <fx@gnu.org>
parents:
diff changeset
5177 @item
Dave Love <fx@gnu.org>
parents:
diff changeset
5178 @code{TeX-arg-ref} no longer used (introduction was unnecessary).
Dave Love <fx@gnu.org>
parents:
diff changeset
5179 @item
Dave Love <fx@gnu.org>
parents:
diff changeset
5180 @code{reftex-arg-label} and @code{reftex-arg-cite} fixed up.
Dave Love <fx@gnu.org>
parents:
diff changeset
5181 @item
Dave Love <fx@gnu.org>
parents:
diff changeset
5182 Settings added to @b{Ref@TeX{}} via style files remain local.
Dave Love <fx@gnu.org>
parents:
diff changeset
5183 @end itemize
Dave Love <fx@gnu.org>
parents:
diff changeset
5184 @item
Dave Love <fx@gnu.org>
parents:
diff changeset
5185 Fixed bug with @code{reftex-citation} in non-latex buffers.
Dave Love <fx@gnu.org>
parents:
diff changeset
5186 @item
Dave Love <fx@gnu.org>
parents:
diff changeset
5187 Fixed bug with syntax table and context refontification.
Dave Love <fx@gnu.org>
parents:
diff changeset
5188 @item
Dave Love <fx@gnu.org>
parents:
diff changeset
5189 Safety-net for name change of @code{font-lock-reference-face}.
Dave Love <fx@gnu.org>
parents:
diff changeset
5190 @end itemize
Dave Love <fx@gnu.org>
parents:
diff changeset
5191
Dave Love <fx@gnu.org>
parents:
diff changeset
5192 @noindent @b{Version 3.24}
Dave Love <fx@gnu.org>
parents:
diff changeset
5193 @itemize @bullet
Dave Love <fx@gnu.org>
parents:
diff changeset
5194 @item
Dave Love <fx@gnu.org>
parents:
diff changeset
5195 New option @code{reftex-revisit-to-echo}.
Dave Love <fx@gnu.org>
parents:
diff changeset
5196 @item
Dave Love <fx@gnu.org>
parents:
diff changeset
5197 Interface with X-Symbol (>=2.6) is now complete and stable.
Dave Love <fx@gnu.org>
parents:
diff changeset
5198 @item
Dave Love <fx@gnu.org>
parents:
diff changeset
5199 Adapted to new outline, which uses overlays.
Dave Love <fx@gnu.org>
parents:
diff changeset
5200 @item
Dave Love <fx@gnu.org>
parents:
diff changeset
5201 File names in @code{\bibliography} may now have the @code{.bib}
Dave Love <fx@gnu.org>
parents:
diff changeset
5202 extension.@refill
Dave Love <fx@gnu.org>
parents:
diff changeset
5203 @item
Dave Love <fx@gnu.org>
parents:
diff changeset
5204 Fixed Bug with parsing "single file" from master file buffer.
Dave Love <fx@gnu.org>
parents:
diff changeset
5205 @end itemize
Dave Love <fx@gnu.org>
parents:
diff changeset
5206
Dave Love <fx@gnu.org>
parents:
diff changeset
5207 @noindent @b{Version 3.25}
Dave Love <fx@gnu.org>
parents:
diff changeset
5208 @itemize @bullet
Dave Love <fx@gnu.org>
parents:
diff changeset
5209 @item
Dave Love <fx@gnu.org>
parents:
diff changeset
5210 Echoing of citation info caches the info for displayed entries.
Dave Love <fx@gnu.org>
parents:
diff changeset
5211 New option @code{reftex-cache-cite-echo}.@refill
Dave Love <fx@gnu.org>
parents:
diff changeset
5212 @item
Dave Love <fx@gnu.org>
parents:
diff changeset
5213 @kbd{M-x reftex-reset-mode} now also removes the file with parsing
Dave Love <fx@gnu.org>
parents:
diff changeset
5214 info.@refill
Dave Love <fx@gnu.org>
parents:
diff changeset
5215 @item
Dave Love <fx@gnu.org>
parents:
diff changeset
5216 Default of @code{reftex-revisit-to-follow} changed to nil.
Dave Love <fx@gnu.org>
parents:
diff changeset
5217 @end itemize
Dave Love <fx@gnu.org>
parents:
diff changeset
5218
Dave Love <fx@gnu.org>
parents:
diff changeset
5219 @noindent @b{Version 3.26}
Dave Love <fx@gnu.org>
parents:
diff changeset
5220 @itemize @bullet
Dave Love <fx@gnu.org>
parents:
diff changeset
5221 @item
Dave Love <fx@gnu.org>
parents:
diff changeset
5222 [X]Emacs 19 no longer supported. Use 3.22 for Emacs 19.
Dave Love <fx@gnu.org>
parents:
diff changeset
5223 @item
Dave Love <fx@gnu.org>
parents:
diff changeset
5224 New hooks @code{reftex-translate-to-ascii-function},
Dave Love <fx@gnu.org>
parents:
diff changeset
5225 @code{reftex-string-to-label-function}.@refill
Dave Love <fx@gnu.org>
parents:
diff changeset
5226 @item
Dave Love <fx@gnu.org>
parents:
diff changeset
5227 Made sure automatic crossref display will not visit/scan files.
Dave Love <fx@gnu.org>
parents:
diff changeset
5228 @end itemize
Dave Love <fx@gnu.org>
parents:
diff changeset
5229
Dave Love <fx@gnu.org>
parents:
diff changeset
5230 @noindent @b{Version 3.27}
Dave Love <fx@gnu.org>
parents:
diff changeset
5231 @itemize @bullet
Dave Love <fx@gnu.org>
parents:
diff changeset
5232 @item
Dave Love <fx@gnu.org>
parents:
diff changeset
5233 Macros can define @emph{neutral} labels, just like @code{\label}
Dave Love <fx@gnu.org>
parents:
diff changeset
5234 itself.@refill
Dave Love <fx@gnu.org>
parents:
diff changeset
5235 @item
Dave Love <fx@gnu.org>
parents:
diff changeset
5236 New option @code{reftex-allow-detached-macro-args}, default @code{nil}!
Dave Love <fx@gnu.org>
parents:
diff changeset
5237 @end itemize
Dave Love <fx@gnu.org>
parents:
diff changeset
5238
Dave Love <fx@gnu.org>
parents:
diff changeset
5239 @noindent @b{Version 3.28}
Dave Love <fx@gnu.org>
parents:
diff changeset
5240 @itemize @bullet
Dave Love <fx@gnu.org>
parents:
diff changeset
5241 @item
Dave Love <fx@gnu.org>
parents:
diff changeset
5242 Auto view crossref for XEmacs uses @code{post-command-hook} to restart the
Dave Love <fx@gnu.org>
parents:
diff changeset
5243 timer, since itimer restart is not reliable.@refill
Dave Love <fx@gnu.org>
parents:
diff changeset
5244 @item
Dave Love <fx@gnu.org>
parents:
diff changeset
5245 Option @code{reftex-bibfile-ignore-list} renamed to @code{-regexps}.
Dave Love <fx@gnu.org>
parents:
diff changeset
5246 @item
Dave Love <fx@gnu.org>
parents:
diff changeset
5247 Expansion of recursive tex and bib path rewritten.
Dave Love <fx@gnu.org>
parents:
diff changeset
5248 @item
Dave Love <fx@gnu.org>
parents:
diff changeset
5249 Fixed problem where @b{Ref@TeX{}} did not scan unsaved buffers.
Dave Love <fx@gnu.org>
parents:
diff changeset
5250 @item
Dave Love <fx@gnu.org>
parents:
diff changeset
5251 Fixed bug with section numbering after *-red sections.
Dave Love <fx@gnu.org>
parents:
diff changeset
5252 @end itemize
Dave Love <fx@gnu.org>
parents:
diff changeset
5253
Dave Love <fx@gnu.org>
parents:
diff changeset
5254 @noindent @b{Version 3.30}
Dave Love <fx@gnu.org>
parents:
diff changeset
5255 @itemize @bullet
Dave Love <fx@gnu.org>
parents:
diff changeset
5256 @item
Dave Love <fx@gnu.org>
parents:
diff changeset
5257 In @code{reftex-citation}, the regular expression used to scan BibTeX
Dave Love <fx@gnu.org>
parents:
diff changeset
5258 files can be specified using completion on known citation keys.
Dave Love <fx@gnu.org>
parents:
diff changeset
5259 @item
Dave Love <fx@gnu.org>
parents:
diff changeset
5260 New keys @kbd{a} and @kbd{A} in BibTeX selection process to cite @emph{all}
Dave Love <fx@gnu.org>
parents:
diff changeset
5261 entries.
Dave Love <fx@gnu.org>
parents:
diff changeset
5262 @item
Dave Love <fx@gnu.org>
parents:
diff changeset
5263 New command @code{reftex-renumber-simple-labels} to renumber simple
Dave Love <fx@gnu.org>
parents:
diff changeset
5264 labels like @samp{eq:13} sequentially through a document.
Dave Love <fx@gnu.org>
parents:
diff changeset
5265 @end itemize
Dave Love <fx@gnu.org>
parents:
diff changeset
5266 @noindent @b{Version 3.33}
Dave Love <fx@gnu.org>
parents:
diff changeset
5267 @itemize @bullet
Dave Love <fx@gnu.org>
parents:
diff changeset
5268 @item
Dave Love <fx@gnu.org>
parents:
diff changeset
5269 Multiple selection buffers are now hidden buffers (they start with a
Dave Love <fx@gnu.org>
parents:
diff changeset
5270 SPACE).
Dave Love <fx@gnu.org>
parents:
diff changeset
5271 @item
Dave Love <fx@gnu.org>
parents:
diff changeset
5272 Fixed bug with file search when TEXINPUTS environment variable is empty.
Dave Love <fx@gnu.org>
parents:
diff changeset
5273 @end itemize
Dave Love <fx@gnu.org>
parents:
diff changeset
5274 @noindent @b{Version 3.34}
Dave Love <fx@gnu.org>
parents:
diff changeset
5275 @itemize @bullet
Dave Love <fx@gnu.org>
parents:
diff changeset
5276 @item
Dave Love <fx@gnu.org>
parents:
diff changeset
5277 Additional flag in @code{reftex-derive-label-parameters} do make only
Dave Love <fx@gnu.org>
parents:
diff changeset
5278 lowercase labels (default @code{t}).
Dave Love <fx@gnu.org>
parents:
diff changeset
5279 @item
Dave Love <fx@gnu.org>
parents:
diff changeset
5280 All @file{.rel} files have a final newline to avoid queries.
Dave Love <fx@gnu.org>
parents:
diff changeset
5281 @item
Dave Love <fx@gnu.org>
parents:
diff changeset
5282 Single byte representations of accented European letters (ISO-8859-1)
Dave Love <fx@gnu.org>
parents:
diff changeset
5283 are now legal in labels.
Dave Love <fx@gnu.org>
parents:
diff changeset
5284 @end itemize
Dave Love <fx@gnu.org>
parents:
diff changeset
5285 @noindent @b{Version 3.35}
Dave Love <fx@gnu.org>
parents:
diff changeset
5286 @itemize @bullet
Dave Love <fx@gnu.org>
parents:
diff changeset
5287 @item
Dave Love <fx@gnu.org>
parents:
diff changeset
5288 ISO 8859 Latin-1 chars are converted to ASCII to derive better labels.
Dave Love <fx@gnu.org>
parents:
diff changeset
5289 This takes back the related changes in 3.34 for safety reasons.@refill
Dave Love <fx@gnu.org>
parents:
diff changeset
5290 @end itemize
Dave Love <fx@gnu.org>
parents:
diff changeset
5291 @noindent @b{Version 3.36}
Dave Love <fx@gnu.org>
parents:
diff changeset
5292 @itemize @bullet
Dave Love <fx@gnu.org>
parents:
diff changeset
5293 @item
Dave Love <fx@gnu.org>
parents:
diff changeset
5294 New value @code{window} for option @code{reftex-auto-view-crossref}.
Dave Love <fx@gnu.org>
parents:
diff changeset
5295 @end itemize
Dave Love <fx@gnu.org>
parents:
diff changeset
5296 @noindent @b{Version 3.38}
Dave Love <fx@gnu.org>
parents:
diff changeset
5297 @itemize @bullet
Dave Love <fx@gnu.org>
parents:
diff changeset
5298 @item
Dave Love <fx@gnu.org>
parents:
diff changeset
5299 @code{reftex-view-crossref} no longer moves to find a macro. Point has
Dave Love <fx@gnu.org>
parents:
diff changeset
5300 to be on the macro argument.
Dave Love <fx@gnu.org>
parents:
diff changeset
5301 @end itemize
Dave Love <fx@gnu.org>
parents:
diff changeset
5302 @noindent @b{Version 3.41}
Dave Love <fx@gnu.org>
parents:
diff changeset
5303 @itemize @bullet
Dave Love <fx@gnu.org>
parents:
diff changeset
5304 @item
Dave Love <fx@gnu.org>
parents:
diff changeset
5305 New options @code{reftex-texpath-environment-variables},
Dave Love <fx@gnu.org>
parents:
diff changeset
5306 @code{reftex-use-external-file-finders},
Dave Love <fx@gnu.org>
parents:
diff changeset
5307 @code{reftex-external-file-finders},
Dave Love <fx@gnu.org>
parents:
diff changeset
5308 @code{reftex-search-unrecursed-path-first}.
Dave Love <fx@gnu.org>
parents:
diff changeset
5309 @item
Dave Love <fx@gnu.org>
parents:
diff changeset
5310 @emph{kpathsearch} support. See new options and
Dave Love <fx@gnu.org>
parents:
diff changeset
5311 @code{reftex-bibpath-environment-variables}.
Dave Love <fx@gnu.org>
parents:
diff changeset
5312 @end itemize
Dave Love <fx@gnu.org>
parents:
diff changeset
5313 @noindent @b{Version 3.42}
Dave Love <fx@gnu.org>
parents:
diff changeset
5314 @itemize @bullet
Dave Love <fx@gnu.org>
parents:
diff changeset
5315 @item
Dave Love <fx@gnu.org>
parents:
diff changeset
5316 File search further refined. New option @code{reftex-file-extensions}.
Dave Love <fx@gnu.org>
parents:
diff changeset
5317 @item
Dave Love <fx@gnu.org>
parents:
diff changeset
5318 @file{*toc*} buffer can show the file boundaries of a multifile
Dave Love <fx@gnu.org>
parents:
diff changeset
5319 document, all labels and associated context. New keys @kbd{i}, @kbd{l},
Dave Love <fx@gnu.org>
parents:
diff changeset
5320 and @kbd{c}. New options @code{reftex-toc-include-labels},
Dave Love <fx@gnu.org>
parents:
diff changeset
5321 @code{reftex-toc-include-context},
Dave Love <fx@gnu.org>
parents:
diff changeset
5322 @code{reftex-toc-include-file-boundaries}. @refill
Dave Love <fx@gnu.org>
parents:
diff changeset
5323 @end itemize
Dave Love <fx@gnu.org>
parents:
diff changeset
5324 @noindent @b{Version 3.43}
Dave Love <fx@gnu.org>
parents:
diff changeset
5325 @itemize @bullet
Dave Love <fx@gnu.org>
parents:
diff changeset
5326 @item
Dave Love <fx@gnu.org>
parents:
diff changeset
5327 Viewing cross-references generalized. Now works on @code{\label},
Dave Love <fx@gnu.org>
parents:
diff changeset
5328 @code{\ref}, @code{\cite}, @code{\bibitem}, @code{\index}, variations of
Dave Love <fx@gnu.org>
parents:
diff changeset
5329 these, and from BibTeX buffers.@refill
Dave Love <fx@gnu.org>
parents:
diff changeset
5330 @item
Dave Love <fx@gnu.org>
parents:
diff changeset
5331 New option @code{reftex-view-crossref-extra}.@refill
Dave Love <fx@gnu.org>
parents:
diff changeset
5332 @item
Dave Love <fx@gnu.org>
parents:
diff changeset
5333 Support for the additional sectioning commands @code{\addchap} and
Dave Love <fx@gnu.org>
parents:
diff changeset
5334 @code{\addsec} which are defined in the LaTeX KOMA-Script classes.@refill
Dave Love <fx@gnu.org>
parents:
diff changeset
5335 @item
Dave Love <fx@gnu.org>
parents:
diff changeset
5336 Files in @code{reftex-default-bibliography} will be searched along
Dave Love <fx@gnu.org>
parents:
diff changeset
5337 @code{BIBINPUTS} path.@refill
Dave Love <fx@gnu.org>
parents:
diff changeset
5338 @item
Dave Love <fx@gnu.org>
parents:
diff changeset
5339 Reading a parse file now checks consistency.
Dave Love <fx@gnu.org>
parents:
diff changeset
5340 @end itemize
26911
d7f536a01276 Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents: 25829
diff changeset
5341 @end ignore
25829
Dave Love <fx@gnu.org>
parents:
diff changeset
5342 @noindent @b{Version 4.00}
Dave Love <fx@gnu.org>
parents:
diff changeset
5343 @itemize @bullet
Dave Love <fx@gnu.org>
parents:
diff changeset
5344 @item
Dave Love <fx@gnu.org>
parents:
diff changeset
5345 RefTeX has been split into several smaller files which are autoloaded on
Dave Love <fx@gnu.org>
parents:
diff changeset
5346 demand.
Dave Love <fx@gnu.org>
parents:
diff changeset
5347 @item
Dave Love <fx@gnu.org>
parents:
diff changeset
5348 Index support, along with many new options.
Dave Love <fx@gnu.org>
parents:
diff changeset
5349 @item
Dave Love <fx@gnu.org>
parents:
diff changeset
5350 The selection of keys for @code{\ref} and @code{\cite} now allows to
Dave Love <fx@gnu.org>
parents:
diff changeset
5351 select multiple items by marking entries with the @kbd{m} key.
Dave Love <fx@gnu.org>
parents:
diff changeset
5352 @item
Dave Love <fx@gnu.org>
parents:
diff changeset
5353 Fancyref support.
Dave Love <fx@gnu.org>
parents:
diff changeset
5354 @end itemize
Dave Love <fx@gnu.org>
parents:
diff changeset
5355 @noindent @b{Version 4.01}
Dave Love <fx@gnu.org>
parents:
diff changeset
5356 @itemize @bullet
Dave Love <fx@gnu.org>
parents:
diff changeset
5357 @item
Dave Love <fx@gnu.org>
parents:
diff changeset
5358 New command @code{reftex-index-globally} to index a word in many
Dave Love <fx@gnu.org>
parents:
diff changeset
5359 places in the document. Also available from the index buffer with
Dave Love <fx@gnu.org>
parents:
diff changeset
5360 @kbd{&}.
Dave Love <fx@gnu.org>
parents:
diff changeset
5361 @item
Dave Love <fx@gnu.org>
parents:
diff changeset
5362 The first item in a @code{reftex-label-alist} entry may now also be a parser
Dave Love <fx@gnu.org>
parents:
diff changeset
5363 function to do non-standard parsing.
Dave Love <fx@gnu.org>
parents:
diff changeset
5364 @item
Dave Love <fx@gnu.org>
parents:
diff changeset
5365 @code{reftex-auto-view-crossref} no longer interferes with
Dave Love <fx@gnu.org>
parents:
diff changeset
5366 @code{pop-up-frames} (patch from Stefan Monnier).
Dave Love <fx@gnu.org>
parents:
diff changeset
5367 @end itemize
Dave Love <fx@gnu.org>
parents:
diff changeset
5368 @noindent @b{Version 4.02}
Dave Love <fx@gnu.org>
parents:
diff changeset
5369 @itemize @bullet
Dave Love <fx@gnu.org>
parents:
diff changeset
5370 @item
Dave Love <fx@gnu.org>
parents:
diff changeset
5371 macros ending in @samp{refrange} are considered to contain references.
Dave Love <fx@gnu.org>
parents:
diff changeset
5372 @item
Dave Love <fx@gnu.org>
parents:
diff changeset
5373 Index entries made with @code{reftex-index-selection-or-word} in TeX
Dave Love <fx@gnu.org>
parents:
diff changeset
5374 math mode automatically get enclosing @samp{$} to preserve math mode. See
Dave Love <fx@gnu.org>
parents:
diff changeset
5375 new option @code{reftex-index-math-format}. Requires AUCTeX.
Dave Love <fx@gnu.org>
parents:
diff changeset
5376 @end itemize
Dave Love <fx@gnu.org>
parents:
diff changeset
5377 @noindent @b{Version 4.04}
Dave Love <fx@gnu.org>
parents:
diff changeset
5378 @itemize @bullet
Dave Love <fx@gnu.org>
parents:
diff changeset
5379 @item
Dave Love <fx@gnu.org>
parents:
diff changeset
5380 New option @code{reftex-index-default-tag} implements a default for queries.
Dave Love <fx@gnu.org>
parents:
diff changeset
5381 @end itemize
Dave Love <fx@gnu.org>
parents:
diff changeset
5382 @noindent @b{Version 4.06}
Dave Love <fx@gnu.org>
parents:
diff changeset
5383 @itemize @bullet
Dave Love <fx@gnu.org>
parents:
diff changeset
5384 @item
Dave Love <fx@gnu.org>
parents:
diff changeset
5385 @code{reftex-section-levels} can contain a function to compute the level
Dave Love <fx@gnu.org>
parents:
diff changeset
5386 of a sectioning command.
Dave Love <fx@gnu.org>
parents:
diff changeset
5387 @item
Dave Love <fx@gnu.org>
parents:
diff changeset
5388 Multiple @code{thebibliography} environments recognized.
Dave Love <fx@gnu.org>
parents:
diff changeset
5389 @end itemize
26911
d7f536a01276 Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents: 25829
diff changeset
5390 @noindent @b{Version 4.09}
d7f536a01276 Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents: 25829
diff changeset
5391 @itemize @bullet
d7f536a01276 Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents: 25829
diff changeset
5392 @item
d7f536a01276 Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents: 25829
diff changeset
5393 New option @code{reftex-toc-max-level} to limit the depth of the toc.
39267
a8c0a02f6129 Spelling corrections.
Richard M. Stallman <rms@gnu.org>
parents: 38003
diff changeset
5394 New key binding @kbd{t} in the @file{*toc*} buffer to change this
26911
d7f536a01276 Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents: 25829
diff changeset
5395 setting.@refill
d7f536a01276 Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents: 25829
diff changeset
5396 @item
d7f536a01276 Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents: 25829
diff changeset
5397 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
5398 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
5399 these phrases and assist indexing all matches.@refill
d7f536a01276 Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents: 25829
diff changeset
5400 @item
d7f536a01276 Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents: 25829
diff changeset
5401 The variables @code{reftex-index-macros} and
d7f536a01276 Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents: 25829
diff changeset
5402 @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
5403 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
5404 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
5405 need to be adapted.@refill
d7f536a01276 Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents: 25829
diff changeset
5406 @item
d7f536a01276 Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents: 25829
diff changeset
5407 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
5408 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
5409 @item
d7f536a01276 Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents: 25829
diff changeset
5410 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
5411 entries for @samp{"begin@{theorem@}"} in
d7f536a01276 Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents: 25829
diff changeset
5412 @code{reftex-setion-levels}.@refill
d7f536a01276 Update to reftex 4.9
Carsten Dominik <dominik@science.uva.nl>
parents: 25829
diff changeset
5413 @end itemize
27195
d7311a9cb223 version 4.10
Carsten Dominik <dominik@science.uva.nl>
parents: 26911
diff changeset
5414 @noindent @b{Version 4.10}
d7311a9cb223 version 4.10
Carsten Dominik <dominik@science.uva.nl>
parents: 26911
diff changeset
5415 @itemize @bullet
d7311a9cb223 version 4.10
Carsten Dominik <dominik@science.uva.nl>
parents: 26911
diff changeset
5416 @item
d7311a9cb223 version 4.10
Carsten Dominik <dominik@science.uva.nl>
parents: 26911
diff changeset
5417 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
5418 with @file{reftex-vars.el} on DOS machines.
d7311a9cb223 version 4.10
Carsten Dominik <dominik@science.uva.nl>
parents: 26911
diff changeset
5419 @item
d7311a9cb223 version 4.10
Carsten Dominik <dominik@science.uva.nl>
parents: 26911
diff changeset
5420 New options @code{reftex-parse-file-extension} and
d7311a9cb223 version 4.10
Carsten Dominik <dominik@science.uva.nl>
parents: 26911
diff changeset
5421 @code{reftex-index-phrase-file-extension}.
d7311a9cb223 version 4.10
Carsten Dominik <dominik@science.uva.nl>
parents: 26911
diff changeset
5422 @end itemize
27604
0b645a4a64fa RefTeX 4.11
Carsten Dominik <dominik@science.uva.nl>
parents: 27195
diff changeset
5423 @noindent @b{Version 4.11}
0b645a4a64fa RefTeX 4.11
Carsten Dominik <dominik@science.uva.nl>
parents: 27195
diff changeset
5424 @itemize @bullet
0b645a4a64fa RefTeX 4.11
Carsten Dominik <dominik@science.uva.nl>
parents: 27195
diff changeset
5425 @item
0b645a4a64fa RefTeX 4.11
Carsten Dominik <dominik@science.uva.nl>
parents: 27195
diff changeset
5426 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
5427 @end itemize
29772
265fdb06f294 Update to reftex 4 14
Carsten Dominik <dominik@science.uva.nl>
parents: 29713
diff changeset
5428 @noindent @b{Version 4.12}
265fdb06f294 Update to reftex 4 14
Carsten Dominik <dominik@science.uva.nl>
parents: 29713
diff changeset
5429 @itemize @bullet
265fdb06f294 Update to reftex 4 14
Carsten Dominik <dominik@science.uva.nl>
parents: 29713
diff changeset
5430 @item
265fdb06f294 Update to reftex 4 14
Carsten Dominik <dominik@science.uva.nl>
parents: 29713
diff changeset
5431 Support for @file{bibentry} citation style.
265fdb06f294 Update to reftex 4 14
Carsten Dominik <dominik@science.uva.nl>
parents: 29713
diff changeset
5432 @end itemize
34403
6679ef9b33fe RefTeX 4.15 update
Carsten Dominik <dominik@science.uva.nl>
parents: 30009
diff changeset
5433 @noindent @b{Version 4.15}
6679ef9b33fe RefTeX 4.15 update
Carsten Dominik <dominik@science.uva.nl>
parents: 30009
diff changeset
5434 @itemize @bullet
6679ef9b33fe RefTeX 4.15 update
Carsten Dominik <dominik@science.uva.nl>
parents: 30009
diff changeset
5435 @item
6679ef9b33fe RefTeX 4.15 update
Carsten Dominik <dominik@science.uva.nl>
parents: 30009
diff changeset
5436 Small bug fixes.
6679ef9b33fe RefTeX 4.15 update
Carsten Dominik <dominik@science.uva.nl>
parents: 30009
diff changeset
5437 @item
6679ef9b33fe RefTeX 4.15 update
Carsten Dominik <dominik@science.uva.nl>
parents: 30009
diff changeset
5438 Improved interaction with Emacs LaTeX mode.
6679ef9b33fe RefTeX 4.15 update
Carsten Dominik <dominik@science.uva.nl>
parents: 30009
diff changeset
5439 @end itemize
25829
Dave Love <fx@gnu.org>
parents:
diff changeset
5440
Dave Love <fx@gnu.org>
parents:
diff changeset
5441 @node Index, , , Top
Dave Love <fx@gnu.org>
parents:
diff changeset
5442 @unnumbered Index
Dave Love <fx@gnu.org>
parents:
diff changeset
5443 @printindex cp
Dave Love <fx@gnu.org>
parents:
diff changeset
5444
Dave Love <fx@gnu.org>
parents:
diff changeset
5445 @summarycontents
Dave Love <fx@gnu.org>
parents:
diff changeset
5446 @contents
Dave Love <fx@gnu.org>
parents:
diff changeset
5447 @bye
Dave Love <fx@gnu.org>
parents:
diff changeset
5448