Mercurial > emacs
annotate lisp/textmodes/reftex-vars.el @ 59994:3e0903b0d56d
*** empty log message ***
author | Kim F. Storm <storm@cua.dk> |
---|---|
date | Tue, 08 Feb 2005 23:50:46 +0000 |
parents | 9bad65481674 |
children | 58a53f588384 cb67264d6096 |
rev | line source |
---|---|
38422
7a94f1c588c4
Some fixes to follow coding conventions.
Pavel Janík <Pavel@Janik.cz>
parents:
37998
diff
changeset
|
1 ;;; reftex-vars.el --- configuration variables for RefTeX |
59534
9bad65481674
2005-01-14 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
52401
diff
changeset
|
2 ;; Copyright (c) 1997, 1998, 1999, 2003, 2004 Free Software Foundation, Inc. |
27035 | 3 |
46612
7522419c4db0
Updated to reftex 4.17
Carsten Dominik <dominik@science.uva.nl>
parents:
46155
diff
changeset
|
4 ;; Author: Carsten Dominik <dominik@science.uva.nl> |
59534
9bad65481674
2005-01-14 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
52401
diff
changeset
|
5 ;; Version: 4.26 |
27035 | 6 |
7 ;; This file is part of GNU Emacs. | |
8 | |
9 ;; GNU Emacs is free software; you can redistribute it and/or modify | |
10 ;; it under the terms of the GNU General Public License as published by | |
11 ;; the Free Software Foundation; either version 2, or (at your option) | |
12 ;; any later version. | |
13 | |
14 ;; GNU Emacs is distributed in the hope that it will be useful, | |
15 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of | |
52170
27340819ef07
Updated to version 4.21
Carsten Dominik <dominik@science.uva.nl>
parents:
49599
diff
changeset
|
16 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE See the |
27035 | 17 ;; GNU General Public License for more details. |
18 | |
19 ;; You should have received a copy of the GNU General Public License | |
52170
27340819ef07
Updated to version 4.21
Carsten Dominik <dominik@science.uva.nl>
parents:
49599
diff
changeset
|
20 ;; along with GNU Emacs; see the file COPYING If not, write to the |
27035 | 21 ;; Free Software Foundation, Inc., 59 Temple Place - Suite 330, |
22 ;; Boston, MA 02111-1307, USA. | |
25280 | 23 |
38422
7a94f1c588c4
Some fixes to follow coding conventions.
Pavel Janík <Pavel@Janik.cz>
parents:
37998
diff
changeset
|
24 ;;; Commentary: |
7a94f1c588c4
Some fixes to follow coding conventions.
Pavel Janík <Pavel@Janik.cz>
parents:
37998
diff
changeset
|
25 |
7a94f1c588c4
Some fixes to follow coding conventions.
Pavel Janík <Pavel@Janik.cz>
parents:
37998
diff
changeset
|
26 ;;; Code: |
7a94f1c588c4
Some fixes to follow coding conventions.
Pavel Janík <Pavel@Janik.cz>
parents:
37998
diff
changeset
|
27 |
26910
489a5439b988
* reftex.el (reftex-compile-variables): respect new structure of
Carsten Dominik <dominik@science.uva.nl>
parents:
25804
diff
changeset
|
28 (eval-when-compile (require 'cl)) |
47898
c33a2b08adc7
Move reftex-set-dirty here from reftex.el.
Markus Rost <rost@math.uni-bielefeld.de>
parents:
47287
diff
changeset
|
29 (eval-and-compile |
c33a2b08adc7
Move reftex-set-dirty here from reftex.el.
Markus Rost <rost@math.uni-bielefeld.de>
parents:
47287
diff
changeset
|
30 (defun reftex-set-dirty (symbol value) |
c33a2b08adc7
Move reftex-set-dirty here from reftex.el.
Markus Rost <rost@math.uni-bielefeld.de>
parents:
47287
diff
changeset
|
31 (setq reftex-tables-dirty t) |
c33a2b08adc7
Move reftex-set-dirty here from reftex.el.
Markus Rost <rost@math.uni-bielefeld.de>
parents:
47287
diff
changeset
|
32 (set symbol value))) |
25280 | 33 |
34 ;; Define the two constants which are needed during compilation | |
35 | |
36 (eval-and-compile | |
37 (defconst reftex-label-alist-builtin | |
38 '( | |
39 ;; Some aliases, mostly for backward compatibility | |
40 (Sideways "Alias for -->rotating" (rotating)) | |
41 (AMSTeX "amsmath with eqref macro" | |
42 ((nil ?e nil "~\\eqref{%s}") | |
43 amsmath)) | |
44 | |
45 ;; Individual package defaults | |
46 (amsmath "AMS-LaTeX math environments" | |
47 (("align" ?e nil nil eqnarray-like) | |
48 ("gather" ?e nil nil eqnarray-like) | |
49 ("multline" ?e nil nil t) | |
50 ("flalign" ?e nil nil eqnarray-like) | |
51 ("alignat" ?e nil nil alignat-like) | |
52 ("xalignat" ?e nil nil alignat-like) | |
53 ("xxalignat" ?e nil nil alignat-like) | |
54 ("subequations" ?e nil nil t))) | |
55 | |
56 (endnotes "The \\endnote macro" | |
57 (("\\endnote[]{}" ?N "en:" "~\\ref{%s}" 2 | |
58 (regexp "endnotes?" "notes?" "Anmerkung\\(en\\)?" "Anm\\.")))) | |
59 | |
60 (fancybox "The Beqnarray environment" | |
61 (("Beqnarray" ?e nil nil eqnarray-like))) | |
62 | |
63 (floatfig "The floatingfigure environment" | |
64 (("floatingfigure" ?f nil nil caption))) | |
65 | |
66 (longtable "The longtable environment" | |
67 (("longtable" ?t nil nil caption))) | |
68 | |
69 (picinpar "The figwindow and tabwindow environments" | |
70 (("figwindow" ?f nil nil 1) | |
71 ("tabwindow" ?f nil nil 1))) | |
72 | |
73 (rotating "Sidewaysfigure and table" | |
74 (("sidewaysfigure" ?f nil nil caption) | |
75 ("sidewaystable" ?t nil nil caption))) | |
76 | |
77 (sidecap "CSfigure and SCtable" | |
78 (("SCfigure" ?f nil nil caption) | |
79 ("SCtable" ?t nil nil caption))) | |
80 | |
81 (subfigure "Subfigure environments/macro" | |
82 (("subfigure" ?f nil nil caption) | |
83 ("subfigure*" ?f nil nil caption) | |
84 ("\\subfigure[]{}" ?f nil nil 1))) | |
85 | |
86 (supertab "Supertabular environment" | |
87 (("supertabular" ?t nil nil "\\tablecaption{"))) | |
88 | |
89 (wrapfig "The wrapfigure environment" | |
90 (("wrapfigure" ?f nil nil caption))) | |
91 | |
92 ;; The LaTeX core stuff | |
93 (LaTeX "LaTeX default environments" | |
94 (("section" ?s "%S" "~\\ref{%s}" (nil . t) | |
95 (regexp "parts?" "chapters?" "chap\\." "sections?" "sect?\\." | |
52170
27340819ef07
Updated to version 4.21
Carsten Dominik <dominik@science.uva.nl>
parents:
49599
diff
changeset
|
96 "paragraphs?" "par\\." |
27340819ef07
Updated to version 4.21
Carsten Dominik <dominik@science.uva.nl>
parents:
49599
diff
changeset
|
97 "\\\\S" "\247" "Teile?" "Kapitel" "Kap\\." "Abschnitte?" |
27340819ef07
Updated to version 4.21
Carsten Dominik <dominik@science.uva.nl>
parents:
49599
diff
changeset
|
98 "appendi\\(x\\|ces\\)" "App\\." "Anh\"?ange?" "Anh\\.")) |
25280 | 99 |
100 ("enumerate" ?i "item:" "~\\ref{%s}" item | |
101 (regexp "items?" "Punkte?")) | |
52170
27340819ef07
Updated to version 4.21
Carsten Dominik <dominik@science.uva.nl>
parents:
49599
diff
changeset
|
102 |
25280 | 103 ("equation" ?e "eq:" "~(\\ref{%s})" t |
104 (regexp "equations?" "eqs?\\." "eqn\\." "Gleichung\\(en\\)?" "Gl\\.")) | |
105 ("eqnarray" ?e "eq:" nil eqnarray-like) | |
52170
27340819ef07
Updated to version 4.21
Carsten Dominik <dominik@science.uva.nl>
parents:
49599
diff
changeset
|
106 |
25280 | 107 ("figure" ?f "fig:" "~\\ref{%s}" caption |
108 (regexp "figure?[sn]?" "figs?\\." "Abbildung\\(en\\)?" "Abb\\.")) | |
109 ("figure*" ?f nil nil caption) | |
52170
27340819ef07
Updated to version 4.21
Carsten Dominik <dominik@science.uva.nl>
parents:
49599
diff
changeset
|
110 |
25280 | 111 ("table" ?t "tab:" "~\\ref{%s}" caption |
112 (regexp "tables?" "tab\\." "Tabellen?")) | |
113 ("table*" ?t nil nil caption) | |
52170
27340819ef07
Updated to version 4.21
Carsten Dominik <dominik@science.uva.nl>
parents:
49599
diff
changeset
|
114 |
25280 | 115 ("\\footnote[]{}" ?n "fn:" "~\\ref{%s}" 2 |
116 (regexp "footnotes?" "Fussnoten?")) | |
52170
27340819ef07
Updated to version 4.21
Carsten Dominik <dominik@science.uva.nl>
parents:
49599
diff
changeset
|
117 |
25280 | 118 ("any" ?\ " " "~\\ref{%s}" nil) |
119 | |
120 ;; The label macro is hard coded, but it *could* be defined like this: | |
121 ;;("\\label{*}" nil nil nil nil) | |
122 )) | |
123 | |
124 ) | |
125 "The default label environment descriptions. | |
126 Lower-case symbols correspond to a style file of the same name in the LaTeX | |
127 distribution. Mixed-case symbols are convenience aliases.") | |
128 | |
129 (defconst reftex-cite-format-builtin | |
130 '((default "Default macro \\cite{%l}" | |
59534
9bad65481674
2005-01-14 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
52401
diff
changeset
|
131 "\\cite[]{%l}") |
25280 | 132 (natbib "The Natbib package" |
59534
9bad65481674
2005-01-14 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
52401
diff
changeset
|
133 ((?\C-m . "\\cite[][]{%l}") |
9bad65481674
2005-01-14 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
52401
diff
changeset
|
134 (?t . "\\citet[][]{%l}") |
9bad65481674
2005-01-14 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
52401
diff
changeset
|
135 (?T . "\\citet*[][]{%l}") |
9bad65481674
2005-01-14 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
52401
diff
changeset
|
136 (?p . "\\citep[][]{%l}") |
9bad65481674
2005-01-14 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
52401
diff
changeset
|
137 (?P . "\\citep*[][]{%l}") |
25280 | 138 (?e . "\\citep[e.g.][]{%l}") |
139 (?s . "\\citep[see][]{%l}") | |
140 (?a . "\\citeauthor{%l}") | |
141 (?A . "\\citeauthor*{%l}") | |
46612
7522419c4db0
Updated to reftex 4.17
Carsten Dominik <dominik@science.uva.nl>
parents:
46155
diff
changeset
|
142 (?y . "\\citeyear{%l}") |
7522419c4db0
Updated to reftex 4.17
Carsten Dominik <dominik@science.uva.nl>
parents:
46155
diff
changeset
|
143 (?n . "\\nocite{%l}"))) |
52170
27340819ef07
Updated to version 4.21
Carsten Dominik <dominik@science.uva.nl>
parents:
49599
diff
changeset
|
144 (amsrefs "The AMSRefs package" |
27340819ef07
Updated to version 4.21
Carsten Dominik <dominik@science.uva.nl>
parents:
49599
diff
changeset
|
145 ((?\C-m . "\\cite{%l}") |
27340819ef07
Updated to version 4.21
Carsten Dominik <dominik@science.uva.nl>
parents:
49599
diff
changeset
|
146 (?p . "\\cite{%l}") |
27340819ef07
Updated to version 4.21
Carsten Dominik <dominik@science.uva.nl>
parents:
49599
diff
changeset
|
147 (?P . "\\cites{%l}") |
27340819ef07
Updated to version 4.21
Carsten Dominik <dominik@science.uva.nl>
parents:
49599
diff
changeset
|
148 (?t . "\\ocite{%l}") |
27340819ef07
Updated to version 4.21
Carsten Dominik <dominik@science.uva.nl>
parents:
49599
diff
changeset
|
149 (?T . "\\ocites{%l}") |
27340819ef07
Updated to version 4.21
Carsten Dominik <dominik@science.uva.nl>
parents:
49599
diff
changeset
|
150 (?y . "\\ycite{%l}") |
27340819ef07
Updated to version 4.21
Carsten Dominik <dominik@science.uva.nl>
parents:
49599
diff
changeset
|
151 (?Y . "\\ycites{%l}") |
27340819ef07
Updated to version 4.21
Carsten Dominik <dominik@science.uva.nl>
parents:
49599
diff
changeset
|
152 (?a . "\\citeauthor{%l}") |
27340819ef07
Updated to version 4.21
Carsten Dominik <dominik@science.uva.nl>
parents:
49599
diff
changeset
|
153 (?A . "\\citeauthory{%l}") |
27340819ef07
Updated to version 4.21
Carsten Dominik <dominik@science.uva.nl>
parents:
49599
diff
changeset
|
154 (?f . "\\fullcite{%l}") |
27340819ef07
Updated to version 4.21
Carsten Dominik <dominik@science.uva.nl>
parents:
49599
diff
changeset
|
155 (?F . "\\fullocite{%l}") |
27340819ef07
Updated to version 4.21
Carsten Dominik <dominik@science.uva.nl>
parents:
49599
diff
changeset
|
156 (?n . "\\nocite{%l}"))) |
29775
31536c6cf2e3
* textmodes/reftex.el (reftex-find-citation-regexp-format):
Carsten Dominik <dominik@science.uva.nl>
parents:
27604
diff
changeset
|
157 (bibentry "The Bibentry package" |
31536c6cf2e3
* textmodes/reftex.el (reftex-find-citation-regexp-format):
Carsten Dominik <dominik@science.uva.nl>
parents:
27604
diff
changeset
|
158 "\\bibentry{%l}") |
25280 | 159 (harvard "The Harvard package" |
59534
9bad65481674
2005-01-14 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
52401
diff
changeset
|
160 ((?\C-m . "\\cite[]{%l}") |
9bad65481674
2005-01-14 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
52401
diff
changeset
|
161 (?p . "\\cite[]{%l}") |
25280 | 162 (?t . "\\citeasnoun{%l}") |
163 (?n . "\\citeasnoun{%l}") | |
164 (?s . "\\possessivecite{%l}") | |
165 (?e . "\\citeaffixed{%l}{?}") | |
166 (?y . "\\citeyear{%l}") | |
167 (?a . "\\citename{%l}"))) | |
168 (chicago "The Chicago package" | |
59534
9bad65481674
2005-01-14 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
52401
diff
changeset
|
169 ((?\C-m . "\\cite[]{%l}") |
9bad65481674
2005-01-14 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
52401
diff
changeset
|
170 (?t . "\\citeN[]{%l}") |
25280 | 171 (?T . "\\shortciteN{%l}") |
59534
9bad65481674
2005-01-14 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
52401
diff
changeset
|
172 (?p . "\\cite[]{%l}") |
25280 | 173 (?P . "\\shortcite{%l}") |
174 (?a . "\\citeA{%l}") | |
175 (?A . "\\shortciteA{%l}") | |
176 (?y . "\\citeyear{%l}"))) | |
177 (astron "The Astron package" | |
59534
9bad65481674
2005-01-14 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
52401
diff
changeset
|
178 ((?\C-m . "\\cite[]{%l}") |
9bad65481674
2005-01-14 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
52401
diff
changeset
|
179 (?p . "\\cite[]{%l}" ) |
25280 | 180 (?t . "%2a (\\cite{%l})"))) |
181 (author-year "Do-it-yourself Author-year" | |
182 ((?\C-m . "\\cite{%l}") | |
183 (?t . "%2a (%y)\\nocite{%l}") | |
184 (?p . "(%2a %y\\nocite{%l})"))) | |
185 (locally "Full info in parenthesis" | |
186 "(%2a %y, %j %v, %P, %e: %b, %u, %s %<)") | |
187 ) | |
188 "Builtin versions of the citation format. | |
189 The following conventions are valid for all alist entries: | |
190 `?\C-m' should always point to a straight \\cite{%l} macro. | |
191 `?t' should point to a textual citation (citation as a noun). | |
192 `?p' should point to a parenthetical citation.") | |
193 | |
52170
27340819ef07
Updated to version 4.21
Carsten Dominik <dominik@science.uva.nl>
parents:
49599
diff
changeset
|
194 (defconst reftex-index-macros-builtin |
25280 | 195 '((default "Default \\index and \\glossary macros" |
26910
489a5439b988
* reftex.el (reftex-compile-variables): respect new structure of
Carsten Dominik <dominik@science.uva.nl>
parents:
25804
diff
changeset
|
196 (("\\index{*}" "idx" ?i "" nil t) |
489a5439b988
* reftex.el (reftex-compile-variables): respect new structure of
Carsten Dominik <dominik@science.uva.nl>
parents:
25804
diff
changeset
|
197 ("\\glossary{*}" "glo" ?g "" nil t))) |
25280 | 198 (multind "The multind.sty package" |
26910
489a5439b988
* reftex.el (reftex-compile-variables): respect new structure of
Carsten Dominik <dominik@science.uva.nl>
parents:
25804
diff
changeset
|
199 (("\\index{}{*}" 1 ?i "" nil t))) |
25280 | 200 (index "The index.sty package" |
52170
27340819ef07
Updated to version 4.21
Carsten Dominik <dominik@science.uva.nl>
parents:
49599
diff
changeset
|
201 (("\\index[]{*}" 1 ?i "" nil t) |
27340819ef07
Updated to version 4.21
Carsten Dominik <dominik@science.uva.nl>
parents:
49599
diff
changeset
|
202 ("\\index*[]{*}" 1 ?I "" nil nil))) |
25280 | 203 (Index-Shortcut "index.sty with \\shortindexingon" |
26910
489a5439b988
* reftex.el (reftex-compile-variables): respect new structure of
Carsten Dominik <dominik@science.uva.nl>
parents:
25804
diff
changeset
|
204 (("\\index[]{*}" 1 ?i "" nil t) |
52170
27340819ef07
Updated to version 4.21
Carsten Dominik <dominik@science.uva.nl>
parents:
49599
diff
changeset
|
205 ("\\index*[]{*}" 1 ?I "" nil nil) |
27340819ef07
Updated to version 4.21
Carsten Dominik <dominik@science.uva.nl>
parents:
49599
diff
changeset
|
206 ("^[]{*}" 1 ?^ "" texmathp t) |
27340819ef07
Updated to version 4.21
Carsten Dominik <dominik@science.uva.nl>
parents:
49599
diff
changeset
|
207 ("_[]{*}" 1 ?_ "" texmathp nil)))) |
25280 | 208 "Builtin stuff for reftex-index-macros. |
209 Lower-case symbols correspond to a style file of the same name in the LaTeX | |
210 distribution. Mixed-case symbols are convenience aliases.") | |
211 ) | |
212 | |
213 ;; Configuration Variables and User Options for RefTeX ------------------ | |
214 | |
215 (defgroup reftex nil | |
216 "LaTeX label and citation support." | |
217 :tag "RefTeX" | |
52170
27340819ef07
Updated to version 4.21
Carsten Dominik <dominik@science.uva.nl>
parents:
49599
diff
changeset
|
218 :link '(url-link :tag "Home Page" |
27340819ef07
Updated to version 4.21
Carsten Dominik <dominik@science.uva.nl>
parents:
49599
diff
changeset
|
219 "http://zon.astro.uva.nl/~dominik/Tools/") |
25280 | 220 :link '(emacs-commentary-link :tag "Commentary in reftex.el" "reftex.el") |
221 :link '(custom-manual "(reftex)Top") | |
222 :prefix "reftex-" | |
223 :group 'tex) | |
224 | |
46612
7522419c4db0
Updated to reftex 4.17
Carsten Dominik <dominik@science.uva.nl>
parents:
46155
diff
changeset
|
225 |
25280 | 226 ;; Table of contents configuration -------------------------------------- |
227 | |
228 (defgroup reftex-table-of-contents-browser nil | |
229 "A multifile table of contents browser." | |
230 :group 'reftex) | |
231 | |
46612
7522419c4db0
Updated to reftex 4.17
Carsten Dominik <dominik@science.uva.nl>
parents:
46155
diff
changeset
|
232 (defcustom reftex-include-file-commands '("include" "input") |
7522419c4db0
Updated to reftex 4.17
Carsten Dominik <dominik@science.uva.nl>
parents:
46155
diff
changeset
|
233 "LaTeX commands which input another file. |
7522419c4db0
Updated to reftex 4.17
Carsten Dominik <dominik@science.uva.nl>
parents:
46155
diff
changeset
|
234 The file name is expected after the command, either in braces or separated |
7522419c4db0
Updated to reftex 4.17
Carsten Dominik <dominik@science.uva.nl>
parents:
46155
diff
changeset
|
235 by whitespace." |
7522419c4db0
Updated to reftex 4.17
Carsten Dominik <dominik@science.uva.nl>
parents:
46155
diff
changeset
|
236 :group 'reftex-table-of-contents-browser |
7522419c4db0
Updated to reftex 4.17
Carsten Dominik <dominik@science.uva.nl>
parents:
46155
diff
changeset
|
237 :type '(repeat string)) |
7522419c4db0
Updated to reftex 4.17
Carsten Dominik <dominik@science.uva.nl>
parents:
46155
diff
changeset
|
238 |
7522419c4db0
Updated to reftex 4.17
Carsten Dominik <dominik@science.uva.nl>
parents:
46155
diff
changeset
|
239 (defcustom reftex-max-section-depth 12 |
7522419c4db0
Updated to reftex 4.17
Carsten Dominik <dominik@science.uva.nl>
parents:
46155
diff
changeset
|
240 "Maximum depth of section levels in document structure. |
7522419c4db0
Updated to reftex 4.17
Carsten Dominik <dominik@science.uva.nl>
parents:
46155
diff
changeset
|
241 Standard LaTeX needs default is 7, but there are packages for which this |
7522419c4db0
Updated to reftex 4.17
Carsten Dominik <dominik@science.uva.nl>
parents:
46155
diff
changeset
|
242 needs to be larger." |
7522419c4db0
Updated to reftex 4.17
Carsten Dominik <dominik@science.uva.nl>
parents:
46155
diff
changeset
|
243 :group 'reftex-table-of-contents-browser |
7522419c4db0
Updated to reftex 4.17
Carsten Dominik <dominik@science.uva.nl>
parents:
46155
diff
changeset
|
244 :type 'integer) |
7522419c4db0
Updated to reftex 4.17
Carsten Dominik <dominik@science.uva.nl>
parents:
46155
diff
changeset
|
245 |
7522419c4db0
Updated to reftex 4.17
Carsten Dominik <dominik@science.uva.nl>
parents:
46155
diff
changeset
|
246 ;; LaTeX section commands and level numbers |
7522419c4db0
Updated to reftex 4.17
Carsten Dominik <dominik@science.uva.nl>
parents:
46155
diff
changeset
|
247 (defcustom reftex-section-levels |
7522419c4db0
Updated to reftex 4.17
Carsten Dominik <dominik@science.uva.nl>
parents:
46155
diff
changeset
|
248 '( |
7522419c4db0
Updated to reftex 4.17
Carsten Dominik <dominik@science.uva.nl>
parents:
46155
diff
changeset
|
249 ("part" . 0) |
7522419c4db0
Updated to reftex 4.17
Carsten Dominik <dominik@science.uva.nl>
parents:
46155
diff
changeset
|
250 ("chapter" . 1) |
7522419c4db0
Updated to reftex 4.17
Carsten Dominik <dominik@science.uva.nl>
parents:
46155
diff
changeset
|
251 ("section" . 2) |
7522419c4db0
Updated to reftex 4.17
Carsten Dominik <dominik@science.uva.nl>
parents:
46155
diff
changeset
|
252 ("subsection" . 3) |
7522419c4db0
Updated to reftex 4.17
Carsten Dominik <dominik@science.uva.nl>
parents:
46155
diff
changeset
|
253 ("subsubsection" . 4) |
7522419c4db0
Updated to reftex 4.17
Carsten Dominik <dominik@science.uva.nl>
parents:
46155
diff
changeset
|
254 ("paragraph" . 5) |
7522419c4db0
Updated to reftex 4.17
Carsten Dominik <dominik@science.uva.nl>
parents:
46155
diff
changeset
|
255 ("subparagraph" . 6) |
7522419c4db0
Updated to reftex 4.17
Carsten Dominik <dominik@science.uva.nl>
parents:
46155
diff
changeset
|
256 ("addchap" . -1) ; KOMA-Script |
7522419c4db0
Updated to reftex 4.17
Carsten Dominik <dominik@science.uva.nl>
parents:
46155
diff
changeset
|
257 ("addsec" . -2) ; KOMA-Script |
7522419c4db0
Updated to reftex 4.17
Carsten Dominik <dominik@science.uva.nl>
parents:
46155
diff
changeset
|
258 ;;; ("minisec" . -7) ; KOMA-Script |
7522419c4db0
Updated to reftex 4.17
Carsten Dominik <dominik@science.uva.nl>
parents:
46155
diff
changeset
|
259 ) |
7522419c4db0
Updated to reftex 4.17
Carsten Dominik <dominik@science.uva.nl>
parents:
46155
diff
changeset
|
260 "Commands and levels used for defining sections in the document. |
7522419c4db0
Updated to reftex 4.17
Carsten Dominik <dominik@science.uva.nl>
parents:
46155
diff
changeset
|
261 This is an alist with each element like (COMMAND-NAME . LEVEL). |
7522419c4db0
Updated to reftex 4.17
Carsten Dominik <dominik@science.uva.nl>
parents:
46155
diff
changeset
|
262 The car of each cons cell is the name of the section macro (without |
7522419c4db0
Updated to reftex 4.17
Carsten Dominik <dominik@science.uva.nl>
parents:
46155
diff
changeset
|
263 the backslash). The cdr is a number indicating its level. A negative |
7522419c4db0
Updated to reftex 4.17
Carsten Dominik <dominik@science.uva.nl>
parents:
46155
diff
changeset
|
264 level means the same level as the positive value, but the section will |
7522419c4db0
Updated to reftex 4.17
Carsten Dominik <dominik@science.uva.nl>
parents:
46155
diff
changeset
|
265 never get a number. The cdr may also be a function which will be called |
52170
27340819ef07
Updated to version 4.21
Carsten Dominik <dominik@science.uva.nl>
parents:
49599
diff
changeset
|
266 to after the section-re matched to determine the level. |
27340819ef07
Updated to version 4.21
Carsten Dominik <dominik@science.uva.nl>
parents:
49599
diff
changeset
|
267 This list is also used for promotion and demption of sectioning commands. |
27340819ef07
Updated to version 4.21
Carsten Dominik <dominik@science.uva.nl>
parents:
49599
diff
changeset
|
268 If you are using a document class which has several sets of sectioning |
27340819ef07
Updated to version 4.21
Carsten Dominik <dominik@science.uva.nl>
parents:
49599
diff
changeset
|
269 commands, promotion only works correctly if this list is sorted first |
27340819ef07
Updated to version 4.21
Carsten Dominik <dominik@science.uva.nl>
parents:
49599
diff
changeset
|
270 by set, then within each set by level. The promotion commands always |
27340819ef07
Updated to version 4.21
Carsten Dominik <dominik@science.uva.nl>
parents:
49599
diff
changeset
|
271 select the nearest entry with the correct new level." |
46612
7522419c4db0
Updated to reftex 4.17
Carsten Dominik <dominik@science.uva.nl>
parents:
46155
diff
changeset
|
272 :group 'reftex-table-of-contents-browser |
7522419c4db0
Updated to reftex 4.17
Carsten Dominik <dominik@science.uva.nl>
parents:
46155
diff
changeset
|
273 :set 'reftex-set-dirty |
7522419c4db0
Updated to reftex 4.17
Carsten Dominik <dominik@science.uva.nl>
parents:
46155
diff
changeset
|
274 :type '(repeat |
7522419c4db0
Updated to reftex 4.17
Carsten Dominik <dominik@science.uva.nl>
parents:
46155
diff
changeset
|
275 (cons (string :tag "sectioning macro" "") |
52170
27340819ef07
Updated to version 4.21
Carsten Dominik <dominik@science.uva.nl>
parents:
49599
diff
changeset
|
276 (choice |
27340819ef07
Updated to version 4.21
Carsten Dominik <dominik@science.uva.nl>
parents:
49599
diff
changeset
|
277 (number :tag "level " 0) |
27340819ef07
Updated to version 4.21
Carsten Dominik <dominik@science.uva.nl>
parents:
49599
diff
changeset
|
278 (symbol :tag "function " my-level-func))))) |
46612
7522419c4db0
Updated to reftex 4.17
Carsten Dominik <dominik@science.uva.nl>
parents:
46155
diff
changeset
|
279 |
26910
489a5439b988
* reftex.el (reftex-compile-variables): respect new structure of
Carsten Dominik <dominik@science.uva.nl>
parents:
25804
diff
changeset
|
280 (defcustom reftex-toc-max-level 100 |
489a5439b988
* reftex.el (reftex-compile-variables): respect new structure of
Carsten Dominik <dominik@science.uva.nl>
parents:
25804
diff
changeset
|
281 "*The maximum level of toc entries which will be included in the TOC. |
489a5439b988
* reftex.el (reftex-compile-variables): respect new structure of
Carsten Dominik <dominik@science.uva.nl>
parents:
25804
diff
changeset
|
282 Section headings with a bigger level will be ignored. In RefTeX, chapters |
489a5439b988
* reftex.el (reftex-compile-variables): respect new structure of
Carsten Dominik <dominik@science.uva.nl>
parents:
25804
diff
changeset
|
283 are level 1, sections are level 2 etc. |
489a5439b988
* reftex.el (reftex-compile-variables): respect new structure of
Carsten Dominik <dominik@science.uva.nl>
parents:
25804
diff
changeset
|
284 This variable can be changed from within the *toc* buffer with the `t' key." |
489a5439b988
* reftex.el (reftex-compile-variables): respect new structure of
Carsten Dominik <dominik@science.uva.nl>
parents:
25804
diff
changeset
|
285 :group 'reftex-table-of-contents-browser |
489a5439b988
* reftex.el (reftex-compile-variables): respect new structure of
Carsten Dominik <dominik@science.uva.nl>
parents:
25804
diff
changeset
|
286 :type 'integer) |
489a5439b988
* reftex.el (reftex-compile-variables): respect new structure of
Carsten Dominik <dominik@science.uva.nl>
parents:
25804
diff
changeset
|
287 |
47050
904fd28be439
Update to RefTeX 4.19
Carsten Dominik <dominik@science.uva.nl>
parents:
46683
diff
changeset
|
288 (defcustom reftex-part-resets-chapter nil |
904fd28be439
Update to RefTeX 4.19
Carsten Dominik <dominik@science.uva.nl>
parents:
46683
diff
changeset
|
289 "*Non-nil means, \\part is like any other sectioning command. |
904fd28be439
Update to RefTeX 4.19
Carsten Dominik <dominik@science.uva.nl>
parents:
46683
diff
changeset
|
290 This means, part numbers will be included in the numbering of chapters, and |
904fd28be439
Update to RefTeX 4.19
Carsten Dominik <dominik@science.uva.nl>
parents:
46683
diff
changeset
|
291 chapter counters will be reset for each part. |
904fd28be439
Update to RefTeX 4.19
Carsten Dominik <dominik@science.uva.nl>
parents:
46683
diff
changeset
|
292 When nil (the default), parts are special, do not reset the chapter counter |
904fd28be439
Update to RefTeX 4.19
Carsten Dominik <dominik@science.uva.nl>
parents:
46683
diff
changeset
|
293 and also do not show up in chapter numbers." |
904fd28be439
Update to RefTeX 4.19
Carsten Dominik <dominik@science.uva.nl>
parents:
46683
diff
changeset
|
294 :group 'reftex-table-of-contents-browser |
904fd28be439
Update to RefTeX 4.19
Carsten Dominik <dominik@science.uva.nl>
parents:
46683
diff
changeset
|
295 :type 'boolean) |
904fd28be439
Update to RefTeX 4.19
Carsten Dominik <dominik@science.uva.nl>
parents:
46683
diff
changeset
|
296 |
904fd28be439
Update to RefTeX 4.19
Carsten Dominik <dominik@science.uva.nl>
parents:
46683
diff
changeset
|
297 |
52170
27340819ef07
Updated to version 4.21
Carsten Dominik <dominik@science.uva.nl>
parents:
49599
diff
changeset
|
298 (defcustom reftex-auto-recenter-toc 'frame |
27340819ef07
Updated to version 4.21
Carsten Dominik <dominik@science.uva.nl>
parents:
49599
diff
changeset
|
299 "*Non-nil means, turn automatic recentering of *TOC* window on. |
27340819ef07
Updated to version 4.21
Carsten Dominik <dominik@science.uva.nl>
parents:
49599
diff
changeset
|
300 When active, the *TOC* window will always show the section you |
47050
904fd28be439
Update to RefTeX 4.19
Carsten Dominik <dominik@science.uva.nl>
parents:
46683
diff
changeset
|
301 are currently working in. Recentering happens whenever Emacs is idle for |
904fd28be439
Update to RefTeX 4.19
Carsten Dominik <dominik@science.uva.nl>
parents:
46683
diff
changeset
|
302 more than `reftex-idle-time' seconds. |
52170
27340819ef07
Updated to version 4.21
Carsten Dominik <dominik@science.uva.nl>
parents:
49599
diff
changeset
|
303 |
27340819ef07
Updated to version 4.21
Carsten Dominik <dominik@science.uva.nl>
parents:
49599
diff
changeset
|
304 Value t means, turn on immediately when RefTeX gets started. Then, |
27340819ef07
Updated to version 4.21
Carsten Dominik <dominik@science.uva.nl>
parents:
49599
diff
changeset
|
305 recentering will work for any toc window created during the session. |
27340819ef07
Updated to version 4.21
Carsten Dominik <dominik@science.uva.nl>
parents:
49599
diff
changeset
|
306 |
27340819ef07
Updated to version 4.21
Carsten Dominik <dominik@science.uva.nl>
parents:
49599
diff
changeset
|
307 Value 'frame (the default) means, turn automatic recentering on only while the |
27340819ef07
Updated to version 4.21
Carsten Dominik <dominik@science.uva.nl>
parents:
49599
diff
changeset
|
308 dedicated TOC frame does exist, and do the recentering only in that frame. So |
27340819ef07
Updated to version 4.21
Carsten Dominik <dominik@science.uva.nl>
parents:
49599
diff
changeset
|
309 when creating that frame (with \"d\" key in an ordinary TOC window), the |
27340819ef07
Updated to version 4.21
Carsten Dominik <dominik@science.uva.nl>
parents:
49599
diff
changeset
|
310 automatic recentering is turned on. When the frame gets destroyed, automatic |
27340819ef07
Updated to version 4.21
Carsten Dominik <dominik@science.uva.nl>
parents:
49599
diff
changeset
|
311 recentering is turned off again. |
27340819ef07
Updated to version 4.21
Carsten Dominik <dominik@science.uva.nl>
parents:
49599
diff
changeset
|
312 |
27340819ef07
Updated to version 4.21
Carsten Dominik <dominik@science.uva.nl>
parents:
49599
diff
changeset
|
313 This feature can be turned on and off from the menu |
27340819ef07
Updated to version 4.21
Carsten Dominik <dominik@science.uva.nl>
parents:
49599
diff
changeset
|
314 \(Ref->Options)." |
47050
904fd28be439
Update to RefTeX 4.19
Carsten Dominik <dominik@science.uva.nl>
parents:
46683
diff
changeset
|
315 :group 'reftex-table-of-contents-browser |
52170
27340819ef07
Updated to version 4.21
Carsten Dominik <dominik@science.uva.nl>
parents:
49599
diff
changeset
|
316 :type '(choice |
27340819ef07
Updated to version 4.21
Carsten Dominik <dominik@science.uva.nl>
parents:
49599
diff
changeset
|
317 (const :tag "never" nil) |
27340819ef07
Updated to version 4.21
Carsten Dominik <dominik@science.uva.nl>
parents:
49599
diff
changeset
|
318 (const :tag "always" t) |
52173
087951846e21
(reftex-auto-recenter-toc): Fix typo.
Markus Rost <rost@math.uni-bielefeld.de>
parents:
52170
diff
changeset
|
319 (const :tag "in dedicated frame only" frame))) |
52170
27340819ef07
Updated to version 4.21
Carsten Dominik <dominik@science.uva.nl>
parents:
49599
diff
changeset
|
320 |
46612
7522419c4db0
Updated to reftex 4.17
Carsten Dominik <dominik@science.uva.nl>
parents:
46155
diff
changeset
|
321 (defcustom reftex-toc-split-windows-horizontally nil |
7522419c4db0
Updated to reftex 4.17
Carsten Dominik <dominik@science.uva.nl>
parents:
46155
diff
changeset
|
322 "*Non-nil means, create TOC window by splitting window horizontally." |
7522419c4db0
Updated to reftex 4.17
Carsten Dominik <dominik@science.uva.nl>
parents:
46155
diff
changeset
|
323 :group 'reftex-table-of-contents-browser |
7522419c4db0
Updated to reftex 4.17
Carsten Dominik <dominik@science.uva.nl>
parents:
46155
diff
changeset
|
324 :type 'boolean) |
7522419c4db0
Updated to reftex 4.17
Carsten Dominik <dominik@science.uva.nl>
parents:
46155
diff
changeset
|
325 |
52170
27340819ef07
Updated to version 4.21
Carsten Dominik <dominik@science.uva.nl>
parents:
49599
diff
changeset
|
326 (defcustom reftex-toc-split-windows-fraction .3 |
27340819ef07
Updated to version 4.21
Carsten Dominik <dominik@science.uva.nl>
parents:
49599
diff
changeset
|
327 "*Fraction of the width or height of the frame to be used for TOC window. |
27340819ef07
Updated to version 4.21
Carsten Dominik <dominik@science.uva.nl>
parents:
49599
diff
changeset
|
328 See also `reftex-toc-split-windows-horizontally'." |
46612
7522419c4db0
Updated to reftex 4.17
Carsten Dominik <dominik@science.uva.nl>
parents:
46155
diff
changeset
|
329 :group 'reftex-table-of-contents-browser |
7522419c4db0
Updated to reftex 4.17
Carsten Dominik <dominik@science.uva.nl>
parents:
46155
diff
changeset
|
330 :type 'number) |
7522419c4db0
Updated to reftex 4.17
Carsten Dominik <dominik@science.uva.nl>
parents:
46155
diff
changeset
|
331 |
52170
27340819ef07
Updated to version 4.21
Carsten Dominik <dominik@science.uva.nl>
parents:
49599
diff
changeset
|
332 (defvar reftex-toc-split-windows-horizontally-fraction 0.5 |
27340819ef07
Updated to version 4.21
Carsten Dominik <dominik@science.uva.nl>
parents:
49599
diff
changeset
|
333 "This variable is obsolete, use `reftex-toc-split-windows-fraction' instead.") |
27340819ef07
Updated to version 4.21
Carsten Dominik <dominik@science.uva.nl>
parents:
49599
diff
changeset
|
334 |
25280 | 335 (defcustom reftex-toc-keep-other-windows t |
336 "*Non-nil means, split the selected window to display the *toc* buffer. | |
337 This helps to keep the window configuration, but makes the *toc* small. | |
338 When nil, all other windows except the selected one will be deleted, so | |
339 that the *toc* window fills half the frame." | |
340 :group 'reftex-table-of-contents-browser | |
341 :type 'boolean) | |
342 | |
343 (defcustom reftex-toc-include-file-boundaries nil | |
344 "*Non-nil means, include file boundaries in *toc* buffer. | |
345 This flag can be toggled from within the *toc* buffer with the `F' key." | |
346 :group 'reftex-table-of-contents-browser | |
347 :type 'boolean) | |
348 | |
349 (defcustom reftex-toc-include-labels nil | |
350 "*Non-nil means, include labels in *toc* buffer. | |
351 This flag can be toggled from within the *toc* buffer with the `l' key." | |
352 :group 'reftex-table-of-contents-browser | |
353 :type 'boolean) | |
354 | |
355 (defcustom reftex-toc-include-index-entries nil | |
356 "*Non-nil means, include index entries in *toc* buffer. | |
357 This flag can be toggled from within the *toc* buffer with the `i' key." | |
358 :group 'reftex-table-of-contents-browser | |
359 :type 'boolean) | |
360 | |
52170
27340819ef07
Updated to version 4.21
Carsten Dominik <dominik@science.uva.nl>
parents:
49599
diff
changeset
|
361 (defcustom reftex-toc-confirm-promotion 2 |
27340819ef07
Updated to version 4.21
Carsten Dominik <dominik@science.uva.nl>
parents:
49599
diff
changeset
|
362 "*Non-nil means, promotion/demotion commands first prompt for confirmation. |
27340819ef07
Updated to version 4.21
Carsten Dominik <dominik@science.uva.nl>
parents:
49599
diff
changeset
|
363 When nil, the command is executed immediately. When this is an integer |
27340819ef07
Updated to version 4.21
Carsten Dominik <dominik@science.uva.nl>
parents:
49599
diff
changeset
|
364 N, ask for confirmation only if N or more section commands are going to be |
27340819ef07
Updated to version 4.21
Carsten Dominik <dominik@science.uva.nl>
parents:
49599
diff
changeset
|
365 changed." |
27340819ef07
Updated to version 4.21
Carsten Dominik <dominik@science.uva.nl>
parents:
49599
diff
changeset
|
366 :group 'reftex-table-of-contents-browser |
27340819ef07
Updated to version 4.21
Carsten Dominik <dominik@science.uva.nl>
parents:
49599
diff
changeset
|
367 :type '(choice |
27340819ef07
Updated to version 4.21
Carsten Dominik <dominik@science.uva.nl>
parents:
49599
diff
changeset
|
368 (const :tag "Never" nil) |
27340819ef07
Updated to version 4.21
Carsten Dominik <dominik@science.uva.nl>
parents:
49599
diff
changeset
|
369 (const :tag "Always" t) |
27340819ef07
Updated to version 4.21
Carsten Dominik <dominik@science.uva.nl>
parents:
49599
diff
changeset
|
370 (number :tag "When more than N sections" :value 2))) |
27340819ef07
Updated to version 4.21
Carsten Dominik <dominik@science.uva.nl>
parents:
49599
diff
changeset
|
371 |
25280 | 372 (defcustom reftex-toc-include-context nil |
373 "*Non-nil means, include context with labels in the *toc* buffer. | |
374 Context will only be shown when labels are visible as well. | |
375 This flag can be toggled from within the *toc* buffer with the `c' key." | |
376 :group 'reftex-table-of-contents-browser | |
377 :type 'boolean) | |
378 | |
379 (defcustom reftex-toc-follow-mode nil | |
380 "*Non-nil means, point in *toc* buffer will cause other window to follow. | |
381 The other window will show the corresponding part of the document. | |
382 This flag can be toggled from within the *toc* buffer with the `f' key." | |
383 :group 'reftex-table-of-contents-browser | |
384 :type 'boolean) | |
385 | |
386 (defcustom reftex-revisit-to-follow nil | |
387 "*Non-nil means, follow-mode will revisit files if necessary. | |
388 When nil, follow-mode will be suspended for stuff in unvisited files." | |
389 :group 'reftex-table-of-contents-browser | |
390 :group 'reftex-referencing-labels | |
391 :type 'boolean) | |
392 | |
393 (defcustom reftex-toc-mode-hook nil | |
394 "Mode hook for reftex-toc-mode." | |
395 :group 'reftex-table-of-contents-browser | |
396 :type 'hook) | |
397 | |
398 ;; Label Support Configuration | |
399 | |
400 (defgroup reftex-label-support nil | |
401 "Support for creation, insertion and referencing of labels in LaTeX." | |
402 :group 'reftex) | |
403 | |
404 (defgroup reftex-defining-label-environments nil | |
405 "Definition of environments and macros to do with label." | |
406 :group 'reftex-label-support) | |
407 | |
408 (defcustom reftex-default-label-alist-entries | |
409 '(amsmath endnotes fancybox floatfig longtable picinpar | |
52170
27340819ef07
Updated to version 4.21
Carsten Dominik <dominik@science.uva.nl>
parents:
49599
diff
changeset
|
410 rotating sidecap subfigure supertab wrapfig LaTeX) |
25280 | 411 "Default label alist specifications. LaTeX should always be the last entry. |
52170
27340819ef07
Updated to version 4.21
Carsten Dominik <dominik@science.uva.nl>
parents:
49599
diff
changeset
|
412 The value of this variable is a list of symbols with associations in the |
25280 | 413 constant `reftex-label-alist-builtin'. Check that constant for a full list |
414 of options." | |
415 :group 'reftex-defining-label-environments | |
416 :set 'reftex-set-dirty | |
417 :type `(set | |
52170
27340819ef07
Updated to version 4.21
Carsten Dominik <dominik@science.uva.nl>
parents:
49599
diff
changeset
|
418 :indent 4 |
25280 | 419 :inline t |
420 :greedy t | |
421 ,@(mapcar | |
52170
27340819ef07
Updated to version 4.21
Carsten Dominik <dominik@science.uva.nl>
parents:
49599
diff
changeset
|
422 (lambda (x) |
27340819ef07
Updated to version 4.21
Carsten Dominik <dominik@science.uva.nl>
parents:
49599
diff
changeset
|
423 (list 'const :tag (concat (symbol-name (nth 0 x)) |
27340819ef07
Updated to version 4.21
Carsten Dominik <dominik@science.uva.nl>
parents:
49599
diff
changeset
|
424 ": " (nth 1 x)) |
27340819ef07
Updated to version 4.21
Carsten Dominik <dominik@science.uva.nl>
parents:
49599
diff
changeset
|
425 (nth 0 x))) |
25280 | 426 reftex-label-alist-builtin))) |
427 | |
428 (defcustom reftex-label-alist nil | |
429 "Alist with information on environments for \\label-\\ref use. | |
430 | |
431 This docstring is easier to understand after reading the configuration | |
432 examples in `reftex.el'. Looking at the builtin defaults in the constant | |
433 `reftex-label-alist-builtin' may also be instructive. | |
434 | |
435 Set this variable to define additions and changes to the default. The only | |
436 things you MUST NOT change is that `?s' is the type indicator for section | |
437 labels, and SPC for the `any' label type. These are hard-coded at other | |
438 places in the code. | |
439 | |
440 The value of the variable must be a list of items. Each item is a list | |
441 itself and has the following structure: | |
442 | |
443 (ENV-OR-MACRO TYPE-KEY LABEL-PREFIX REFERENCE-FORMAT CONTEXT-METHOD | |
26910
489a5439b988
* reftex.el (reftex-compile-variables): respect new structure of
Carsten Dominik <dominik@science.uva.nl>
parents:
25804
diff
changeset
|
444 (MAGIC-WORD ... ) TOC-LEVEL) |
25280 | 445 |
446 Each list entry describes either an environment carrying a counter for use | |
447 with \\label and \\ref, or a LaTeX macro defining a label as (or inside) | |
448 one of its arguments. The elements of each list entry are: | |
449 | |
450 ENV-OR-MACRO | |
451 Name of the environment (like \"table\") or macro (like \"\\\\myfig\"). | |
452 For macros, indicate the macro arguments for best results, as in | |
453 \"\\\\myfig[]{}{}{*}{}\". Use square brackets for optional arguments, | |
454 a star to mark the label argument, if any. The macro does not have to | |
455 have a label argument - you could also use \\label{..} inside one of | |
456 its arguments. | |
457 Special names: `section' for section labels, `any' to define a group | |
458 which contains all labels. | |
459 | |
460 This may also be a function to do local parsing and identify point | |
46155
67fceef3c084
(reftex-label-alist): Fix typo.
Juanma Barranquero <lekktu@gmail.com>
parents:
38422
diff
changeset
|
461 to be in a non-standard label environment. The function must take |
25280 | 462 an argument BOUND and limit backward searches to this value. It |
463 should return either nil or a cons cell (FUNCTION . POSITION) with | |
464 the function symbol and the position where the special environment | |
465 starts. See the Info documentation for an example. | |
466 | |
467 Finally this may also be nil if the entry is only meant to change | |
468 some settings associated with the type indicator character (see below). | |
469 | |
470 TYPE-KEY | |
471 Type indicator character, like `?t', must be a printable ASCII character. | |
472 The type indicator is a single character which defines a label type. | |
473 Any label inside the environment or macro is assumed to belong to this | |
474 type. The same character may occur several times in this list, to cover | |
475 cases in which different environments carry the same label type (like | |
476 `equation' and `eqnarray'). | |
477 If the type indicator is nil and the macro has a label argument {*}, | |
37998
706af946b1e7
* reftex-ref.el (reftex-select-label-help): Added "z" key
Carsten Dominik <dominik@science.uva.nl>
parents:
34402
diff
changeset
|
478 the macro defines neutral labels just like \\label. In this case |
25280 | 479 the reminder of this entry is ignored. |
480 | |
481 LABEL-PREFIX | |
482 Label prefix string, like \"tab:\". | |
483 The prefix is a short string used as the start of a label. It may be the | |
484 empty string. The prefix may contain the following `%' escapes: | |
485 %f Current file name with directory and extension stripped. | |
486 %F Current file name relative to directory of master file. | |
59534
9bad65481674
2005-01-14 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
52401
diff
changeset
|
487 %m Master file name, directory and extension stripped. |
9bad65481674
2005-01-14 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
52401
diff
changeset
|
488 %M Directory name (without path) where master file is located. |
25280 | 489 %u User login name, on systems which support this. |
490 %S A section prefix derived with variable `reftex-section-prefixes'. | |
491 | |
492 Example: In a file `intro.tex', \"eq:%f:\" will become \"eq:intro:\"). | |
493 | |
494 REFERENCE-FORMAT | |
495 Format string for reference insert in buffer. `%s' will be replaced by | |
496 the label. | |
497 When the format starts with `~', the `~' will only be inserted if | |
498 there is not already a whitespace before point. | |
499 | |
500 CONTEXT-METHOD | |
501 Indication on how to find the short context. | |
502 - If nil, use the text following the \\label{...} macro. | |
503 - If t, use | |
504 - the section heading for section labels. | |
505 - text following the \\begin{...} statement of environments. | |
506 (not a good choice for environments like eqnarray or enumerate, | |
507 where one has several labels in a single environment). | |
508 - text after the macro name (starting with the first arg) for macros. | |
509 - If an integer, use the nth argument of the macro. As a special case, | |
510 1000 means to get text after the last macro argument. | |
511 - If a string, use as regexp to search *backward* from the label. Context | |
512 is then the text following the end of the match. E.g. putting this to | |
513 \"\\\\\\\\caption[[{]\" will use the caption in a figure or table | |
514 environment. | |
515 \"\\\\\\\\begin{eqnarray}\\\\|\\\\\\\\\\\\\\\\\" works for eqnarrays. | |
516 - If any of `caption', `item', `eqnarray-like', `alignat-like', this | |
517 symbol will internally be translated into an appropriate regexp | |
518 (see also the variable `reftex-default-context-regexps'). | |
519 - If a function, call this function with the name of the environment/macro | |
520 as argument. On call, point will be just after the \\label macro. The | |
521 function is expected to return a suitable context string. It should | |
522 throw an exception (error) when failing to find context. | |
523 As an example, here is a function returning the 10 chars following | |
524 the label macro as context: | |
525 | |
526 (defun my-context-function (env-or-mac) | |
527 (if (> (point-max) (+ 10 (point))) | |
528 (buffer-substring (point) (+ 10 (point))) | |
529 (error \"Buffer too small\"))) | |
530 | |
531 Label context is used in two ways by RefTeX: For display in the label | |
532 menu, and to derive a label string. If you want to use a different | |
533 method for each of these, specify them as a dotted pair. | |
534 E.g. `(nil . t)' uses the text after the label (nil) for display, and | |
535 text from the default position (t) to derive a label string. This is | |
536 actually used for section labels. | |
537 | |
538 MAGIC-WORDS | |
539 List of magic words which identify a reference to be of this type. | |
540 If the word before point is equal to one of these words when calling | |
541 `reftex-reference', the label list offered will be automatically | |
542 restricted to labels of the correct type. | |
543 If the first element of this wordlist is the symbol `regexp', the | |
544 strings are interpreted as regular expressions. RefTeX will add | |
545 a \"\\\\W\" to the beginning and other stuff to the end of the regexp. | |
546 | |
26910
489a5439b988
* reftex.el (reftex-compile-variables): respect new structure of
Carsten Dominik <dominik@science.uva.nl>
parents:
25804
diff
changeset
|
547 TOC-LEVEL |
489a5439b988
* reftex.el (reftex-compile-variables): respect new structure of
Carsten Dominik <dominik@science.uva.nl>
parents:
25804
diff
changeset
|
548 The integer level at which this environment should be added to the |
489a5439b988
* reftex.el (reftex-compile-variables): respect new structure of
Carsten Dominik <dominik@science.uva.nl>
parents:
25804
diff
changeset
|
549 table of contents. See also `reftex-section-levels'. A positive |
489a5439b988
* reftex.el (reftex-compile-variables): respect new structure of
Carsten Dominik <dominik@science.uva.nl>
parents:
25804
diff
changeset
|
550 value will number the entries mixed with the sectioning commands of |
489a5439b988
* reftex.el (reftex-compile-variables): respect new structure of
Carsten Dominik <dominik@science.uva.nl>
parents:
25804
diff
changeset
|
551 the same level. A negative value will make unnumbered entries. |
489a5439b988
* reftex.el (reftex-compile-variables): respect new structure of
Carsten Dominik <dominik@science.uva.nl>
parents:
25804
diff
changeset
|
552 Useful only for theorem-like environments, will be ignored for macros. |
489a5439b988
* reftex.el (reftex-compile-variables): respect new structure of
Carsten Dominik <dominik@science.uva.nl>
parents:
25804
diff
changeset
|
553 When omitted or nil, no TOC entries will be made. |
489a5439b988
* reftex.el (reftex-compile-variables): respect new structure of
Carsten Dominik <dominik@science.uva.nl>
parents:
25804
diff
changeset
|
554 |
25280 | 555 If the type indicator characters of two or more entries are the same, RefTeX |
556 will use | |
557 - the first non-nil format and prefix | |
558 - the magic words of all involved entries. | |
559 | |
560 Any list entry may also be a symbol. If that has an association in | |
561 `reftex-label-alist-builtin', the cddr of that association is spliced into the | |
562 list. However, builtin defaults should normally be set with the variable | |
563 `reftex-default-label-alist-entries." | |
564 :group 'reftex-defining-label-environments | |
565 :set 'reftex-set-dirty | |
566 :type | |
567 `(repeat | |
568 (choice :tag "Package or Detailed " | |
569 :value ("" ?a nil nil nil nil) | |
570 (list :tag "Detailed Entry" | |
571 :value ("" ?a nil nil nil nil) | |
572 (choice :tag "Environment or \\macro " | |
573 (const :tag "Ignore, just use typekey" nil) | |
574 (string "") | |
52170
27340819ef07
Updated to version 4.21
Carsten Dominik <dominik@science.uva.nl>
parents:
49599
diff
changeset
|
575 (symbol :tag "Special parser" my-parser)) |
27340819ef07
Updated to version 4.21
Carsten Dominik <dominik@science.uva.nl>
parents:
49599
diff
changeset
|
576 (choice :tag "Type specification " |
27340819ef07
Updated to version 4.21
Carsten Dominik <dominik@science.uva.nl>
parents:
49599
diff
changeset
|
577 (const :tag "unspecified, like in \\label" nil) |
27340819ef07
Updated to version 4.21
Carsten Dominik <dominik@science.uva.nl>
parents:
49599
diff
changeset
|
578 (character :tag "Char " ?a)) |
25280 | 579 (choice :tag "Label prefix string " |
580 (const :tag "Default" nil) | |
581 (string :tag "String" "lab:")) | |
582 (choice :tag "Label reference format" | |
583 (const :tag "Default" nil) | |
584 (string :tag "String" "~\\ref{%s}")) | |
585 (choice :tag "Context method " | |
52170
27340819ef07
Updated to version 4.21
Carsten Dominik <dominik@science.uva.nl>
parents:
49599
diff
changeset
|
586 (const :tag "Default position" t) |
27340819ef07
Updated to version 4.21
Carsten Dominik <dominik@science.uva.nl>
parents:
49599
diff
changeset
|
587 (const :tag "After label" nil) |
27340819ef07
Updated to version 4.21
Carsten Dominik <dominik@science.uva.nl>
parents:
49599
diff
changeset
|
588 (number :tag "Macro arg nr" 1) |
27340819ef07
Updated to version 4.21
Carsten Dominik <dominik@science.uva.nl>
parents:
49599
diff
changeset
|
589 (regexp :tag "Regexp" "") |
27340819ef07
Updated to version 4.21
Carsten Dominik <dominik@science.uva.nl>
parents:
49599
diff
changeset
|
590 (const :tag "Caption in float" caption) |
27340819ef07
Updated to version 4.21
Carsten Dominik <dominik@science.uva.nl>
parents:
49599
diff
changeset
|
591 (const :tag "Item in list" item) |
27340819ef07
Updated to version 4.21
Carsten Dominik <dominik@science.uva.nl>
parents:
49599
diff
changeset
|
592 (const :tag "Eqnarray-like" eqnarray-like) |
27340819ef07
Updated to version 4.21
Carsten Dominik <dominik@science.uva.nl>
parents:
49599
diff
changeset
|
593 (const :tag "Alignat-like" alignat-like) |
27340819ef07
Updated to version 4.21
Carsten Dominik <dominik@science.uva.nl>
parents:
49599
diff
changeset
|
594 (symbol :tag "Function" my-func)) |
27340819ef07
Updated to version 4.21
Carsten Dominik <dominik@science.uva.nl>
parents:
49599
diff
changeset
|
595 (repeat :tag "Magic words" :extra-offset 2 (string)) |
27340819ef07
Updated to version 4.21
Carsten Dominik <dominik@science.uva.nl>
parents:
49599
diff
changeset
|
596 (option (choice :tag "Make TOC entry " |
27340819ef07
Updated to version 4.21
Carsten Dominik <dominik@science.uva.nl>
parents:
49599
diff
changeset
|
597 (const :tag "No entry" nil) |
27340819ef07
Updated to version 4.21
Carsten Dominik <dominik@science.uva.nl>
parents:
49599
diff
changeset
|
598 (integer :tag "Level" :value -3)))) |
25280 | 599 (choice |
600 :tag "Package" | |
601 :value AMSTeX | |
602 ,@(mapcar | |
52170
27340819ef07
Updated to version 4.21
Carsten Dominik <dominik@science.uva.nl>
parents:
49599
diff
changeset
|
603 (lambda (x) |
27340819ef07
Updated to version 4.21
Carsten Dominik <dominik@science.uva.nl>
parents:
49599
diff
changeset
|
604 (list 'const :tag (concat (symbol-name (nth 0 x))) |
27340819ef07
Updated to version 4.21
Carsten Dominik <dominik@science.uva.nl>
parents:
49599
diff
changeset
|
605 (nth 0 x))) |
27340819ef07
Updated to version 4.21
Carsten Dominik <dominik@science.uva.nl>
parents:
49599
diff
changeset
|
606 reftex-label-alist-builtin))))) |
25280 | 607 |
608 (defcustom reftex-section-prefixes '((0 . "part:") (1 . "cha:") (t . "sec:")) | |
609 "Prefixes for section labels. | |
610 When the label prefix given in an entry in `reftex-label-alist' contains `%S', | |
52170
27340819ef07
Updated to version 4.21
Carsten Dominik <dominik@science.uva.nl>
parents:
49599
diff
changeset
|
611 this list is used to determine the correct prefix string depending on the |
25280 | 612 current section level. |
613 The list is an alist, with each entry of the form (KEY . PREFIX) | |
614 Possible keys are sectioning macro names like `chapter', section levels | |
52170
27340819ef07
Updated to version 4.21
Carsten Dominik <dominik@science.uva.nl>
parents:
49599
diff
changeset
|
615 \(as given in `reftex-section-levels'), and t for the default." |
25280 | 616 :group 'reftex-defining-label-environments |
617 :type '(repeat | |
52170
27340819ef07
Updated to version 4.21
Carsten Dominik <dominik@science.uva.nl>
parents:
49599
diff
changeset
|
618 (cons :value (0 . "") |
27340819ef07
Updated to version 4.21
Carsten Dominik <dominik@science.uva.nl>
parents:
49599
diff
changeset
|
619 (choice |
27340819ef07
Updated to version 4.21
Carsten Dominik <dominik@science.uva.nl>
parents:
49599
diff
changeset
|
620 (string :tag "macro name") |
27340819ef07
Updated to version 4.21
Carsten Dominik <dominik@science.uva.nl>
parents:
49599
diff
changeset
|
621 (integer :tag "section level") |
27340819ef07
Updated to version 4.21
Carsten Dominik <dominik@science.uva.nl>
parents:
49599
diff
changeset
|
622 (const :tag "default" t)) |
27340819ef07
Updated to version 4.21
Carsten Dominik <dominik@science.uva.nl>
parents:
49599
diff
changeset
|
623 (string :tag "Prefix")))) |
25280 | 624 |
625 (defcustom reftex-default-context-regexps | |
626 '((caption . "\\\\\\(rot\\)?caption\\*?[[{]") | |
627 (item . "\\\\item\\(\\[[^]]*\\]\\)?") | |
628 (eqnarray-like . "\\\\begin{%s}\\|\\\\\\\\") | |
629 (alignat-like . "\\\\begin{%s}{[0-9]*}\\|\\\\\\\\")) | |
630 "Alist with default regular expressions for finding context. | |
631 The form (format regexp (regexp-quote environment)) is used to calculate | |
632 the final regular expression - so %s will be replaced with the environment | |
633 or macro." | |
634 :group 'reftex-defining-label-environments | |
635 :type '(repeat (cons (symbol) (regexp)))) | |
59534
9bad65481674
2005-01-14 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
52401
diff
changeset
|
636 |
9bad65481674
2005-01-14 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
52401
diff
changeset
|
637 (defcustom reftex-trust-label-prefix nil |
9bad65481674
2005-01-14 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
52401
diff
changeset
|
638 "Non-nil means, trust the label prefix when determining label type. |
9bad65481674
2005-01-14 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
52401
diff
changeset
|
639 It is customary to use special label prefixes to distinguish different label |
9bad65481674
2005-01-14 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
52401
diff
changeset
|
640 types. The label prefixes have no syntactic meaning in LaTeX (unless |
9bad65481674
2005-01-14 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
52401
diff
changeset
|
641 special packages like fancyref) are being used. RefTeX can and by |
9bad65481674
2005-01-14 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
52401
diff
changeset
|
642 default does parse around each label to detect the correct label type, |
9bad65481674
2005-01-14 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
52401
diff
changeset
|
643 but this process can be slow when a document contains thousands of |
9bad65481674
2005-01-14 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
52401
diff
changeset
|
644 labels. If you use label prefixes consistently, you may speed up |
9bad65481674
2005-01-14 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
52401
diff
changeset
|
645 document parsing by setting this variable to a non-nil value. RefTeX |
9bad65481674
2005-01-14 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
52401
diff
changeset
|
646 will then compare the label prefix with the prefixes found in |
9bad65481674
2005-01-14 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
52401
diff
changeset
|
647 `reftex-label-alist' and derive the correct label type in this way. |
9bad65481674
2005-01-14 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
52401
diff
changeset
|
648 Possible values for this option are: |
9bad65481674
2005-01-14 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
52401
diff
changeset
|
649 |
9bad65481674
2005-01-14 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
52401
diff
changeset
|
650 t This means to trust any label prefixes found. |
9bad65481674
2005-01-14 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
52401
diff
changeset
|
651 regexp If a regexp, only prefixes matched by the regexp are trusted. |
9bad65481674
2005-01-14 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
52401
diff
changeset
|
652 list List of accepted prefixes, as strings. The colon is part of |
9bad65481674
2005-01-14 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
52401
diff
changeset
|
653 the prefix, e.g. (\"fn:\" \"eqn:\" \"item:\"). |
9bad65481674
2005-01-14 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
52401
diff
changeset
|
654 nil Never trust a label prefix. |
9bad65481674
2005-01-14 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
52401
diff
changeset
|
655 |
9bad65481674
2005-01-14 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
52401
diff
changeset
|
656 The only disadvantage of using this feature is that the label context |
9bad65481674
2005-01-14 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
52401
diff
changeset
|
657 displayed in the label selection buffer along with each label is |
9bad65481674
2005-01-14 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
52401
diff
changeset
|
658 simply some text after the label definition. This is no problem if you |
9bad65481674
2005-01-14 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
52401
diff
changeset
|
659 place labels keeping this in mind (e.g. *before* the equation, *at |
9bad65481674
2005-01-14 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
52401
diff
changeset
|
660 the beginning* of a fig/tab caption ...). Anyway, it is probably best |
9bad65481674
2005-01-14 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
52401
diff
changeset
|
661 to use the regexp or the list value types to fine-tune this feature. |
9bad65481674
2005-01-14 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
52401
diff
changeset
|
662 For example, if your document contains thousands of footnotes with |
9bad65481674
2005-01-14 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
52401
diff
changeset
|
663 labels fn:xxx, you may want to set this variable to the value \"^fn:$\" or |
9bad65481674
2005-01-14 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
52401
diff
changeset
|
664 \(\"fn:\"). Then RefTeX will still do extensive parsing for any |
9bad65481674
2005-01-14 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
52401
diff
changeset
|
665 non-footnote labels." |
9bad65481674
2005-01-14 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
52401
diff
changeset
|
666 :group 'reftex-defining-label-environments |
9bad65481674
2005-01-14 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
52401
diff
changeset
|
667 :type '(choice |
9bad65481674
2005-01-14 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
52401
diff
changeset
|
668 (const :tag "Always" t) |
9bad65481674
2005-01-14 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
52401
diff
changeset
|
669 (const :tag "Never" nil) |
9bad65481674
2005-01-14 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
52401
diff
changeset
|
670 (regexp) |
9bad65481674
2005-01-14 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
52401
diff
changeset
|
671 (repeat :tag "List" |
9bad65481674
2005-01-14 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
52401
diff
changeset
|
672 (string :tag "prefix (with colon)")))) |
52170
27340819ef07
Updated to version 4.21
Carsten Dominik <dominik@science.uva.nl>
parents:
49599
diff
changeset
|
673 |
25280 | 674 (defcustom reftex-special-environment-functions nil |
675 "List of functions to be called when trying to figure out current environment. | |
676 These are special functions to detect \"environments\" which do not | |
677 start with \\begin and end with \\end. Some LaTeX packages seem to | |
678 use such non-standard ways to set up environment-like constructs. The | |
679 purpose of each function in this list is to detect if point is | |
680 currently inside such a special \"environment\". If the environment | |
681 carries a label, you must also set up an entry for it in | |
682 `reftex-label-alist'. | |
683 | |
684 The function should check if point is currently in the special | |
685 environment it was written to detect. If so, the function must return | |
686 a cons cell (NAME . POSITION). NAME is the name of the environment | |
687 detected and POSITION is the buffer position where the environment | |
688 starts. The function must return nil on failure to detect the | |
689 environment. | |
690 | |
691 The function must take an argument BOUND. If non-nil, BOUND is a | |
692 boundary for backwards searches which should be observed. | |
693 | |
694 Here is an example. The LaTeX package linguex.sty defines list macros | |
695 `\\ex.', `\\a.', etc for lists which are terminated by `\\z.' or an empty | |
696 line. | |
697 | |
698 \\ex. \\label{ex:12} Some text in an exotic language ... | |
699 \\a. \\label{ex:13} more stuff | |
700 \\b. \\label{ex:14} still more stuff | |
701 | |
702 ... more text after the empty line terminating all lists | |
703 | |
704 And here is the setup for RefTeX: | |
705 | |
706 1. Define a dummy environment for this in `reftex-label-alist'. Dummy means, | |
707 make up an environment name even though it is not used with \\begin and | |
708 \\end. Here we use \"linguex\" as this name. | |
709 | |
710 (setq reftex-label-alist | |
711 '((\"linguex\" ?x \"ex:\" \"~\\\\ref{%s}\" nil (\"Example\" \"Ex.\")))) | |
712 | |
713 2. Write a function to detect the list macros and the determinators as well. | |
714 | |
715 (defun my-detect-linguex-list (bound) | |
716 (let ((pos (point)) p1) | |
717 (save-excursion | |
718 ;; Search for any of the linguex item macros at the beginning of a line | |
52170
27340819ef07
Updated to version 4.21
Carsten Dominik <dominik@science.uva.nl>
parents:
49599
diff
changeset
|
719 (if (re-search-backward |
25280 | 720 \"^[ \\t]*\\\\(\\\\\\\\\\\\(ex\\\\|a\\\\|b\\\\|c\\\\|d\\\\|e\\\\|f\\\\)g?\\\\.\\\\)\" bound t) |
721 (progn | |
722 (setq p1 (match-beginning 1)) | |
723 ;; Make sure no empty line or \\z. is between us and the item macro | |
724 (if (re-search-forward \"\\n[ \\t]*\\n\\\\|\\\\\\\\z\\\\.\" pos t) | |
725 ;; Return nil because list was already closed | |
726 nil | |
727 ;; OK, we got it | |
728 (cons \"linguex\" p1))) | |
52170
27340819ef07
Updated to version 4.21
Carsten Dominik <dominik@science.uva.nl>
parents:
49599
diff
changeset
|
729 ;; Return nil for not found |
25280 | 730 nil)))) |
731 | |
732 3. Tell RefTeX to use this function | |
733 | |
734 (setq reftex-special-environment-functions '(my-detect-linguex-list)) | |
735 " | |
736 :group 'reftex-defining-label-environments | |
737 :type 'hook) | |
738 | |
739 ;; Label insertion | |
740 | |
741 (defgroup reftex-making-and-inserting-labels nil | |
742 "Options on how to create new labels." | |
743 :group 'reftex-label-support) | |
744 | |
745 (defcustom reftex-insert-label-flags '("s" "sft") | |
746 "Flags governing label insertion. First flag DERIVE, second flag PROMPT. | |
747 | |
748 If DERIVE is t, RefTeX will try to derive a sensible label from context. | |
749 A section label for example will be derived from the section heading. | |
750 The conversion of the context to a legal label is governed by the | |
751 specifications given in `reftex-derive-label-parameters'. | |
752 If RefTeX fails to derive a label, it will prompt the user. | |
753 If DERIVE is nil, the label generated will consist of the prefix and a | |
754 unique number, like `eq:23'. | |
755 | |
756 If PROMPT is t, the user will be prompted for a label string. The prompt will | |
757 already contain the prefix, and (if DERIVE is t) a default label derived from | |
758 context. When PROMPT is nil, the default label will be inserted without | |
759 query. | |
760 | |
761 So the combination of DERIVE and PROMPT controls label insertion. Here is a | |
762 table describing all four possibilities: | |
763 | |
764 DERIVE PROMPT ACTION | |
765 ------------------------------------------------------------------------- | |
766 nil nil Insert simple label, like eq:22 or sec:13. No query. | |
767 nil t Prompt for label. | |
768 t nil Derive a label from context and insert without query. | |
769 t t Derive a label from context and prompt for confirmation. | |
770 | |
771 Each flag may be set to t, nil, or a string of label type letters | |
772 indicating the label types for which it should be true. The strings work | |
773 like character classes. | |
774 Thus, the combination may be set differently for each label type. The | |
775 default settings \"s\" and \"sft\" mean: Derive section labels from headings | |
52170
27340819ef07
Updated to version 4.21
Carsten Dominik <dominik@science.uva.nl>
parents:
49599
diff
changeset
|
776 \(with confirmation). Prompt for figure and table labels. Use simple labels |
25280 | 777 without confirmation for everything else. |
778 The available label types are: s (section), f (figure), t (table), i (item), | |
779 e (equation), n (footnote), N (endnote), plus any definitions in | |
780 `reftex-label-alist'." | |
781 :group 'reftex-making-and-inserting-labels | |
782 :type '(list (choice :tag "Derive label from context" | |
783 (const :tag "always" t) | |
784 (const :tag "never" nil) | |
785 (string :tag "selected label types" "")) | |
786 (choice :tag "Prompt for label string " | |
787 :entry-format " %b %v" | |
788 (const :tag "always" t) | |
789 (const :tag "never" nil) | |
790 (string :tag "selected label types" "")))) | |
791 | |
792 (defcustom reftex-string-to-label-function 'reftex-string-to-label | |
793 "Function to turn an arbitrary string into a legal label. | |
794 RefTeX's default function uses the variable `reftex-derive-label-parameters'." | |
795 :group 'reftex-making-and-inserting-labels | |
796 :type 'symbol) | |
797 | |
798 (defcustom reftex-translate-to-ascii-function 'reftex-latin1-to-ascii | |
799 "Filter function which will process a context string before it is used | |
800 to derive a label from it. The intended application is to convert ISO or | |
801 Mule characters into something legal in labels. The default function | |
802 removes the accents from Latin-1 characters. X-Symbol (>=2.6) sets this | |
803 variable to the much more general `x-symbol-translate-to-ascii'." | |
804 :group 'reftex-making-and-inserting-labels | |
805 :type 'symbol) | |
806 | |
807 (defcustom reftex-derive-label-parameters '(3 20 t 1 "-" | |
808 ("the" "on" "in" "off" "a" "for" "by" "of" "and" "is" "to") t) | |
809 "Parameters for converting a string into a label. | |
810 This variable is a list of the following items. | |
811 | |
812 NWORDS Number of words to use. | |
813 MAXCHAR Maximum number of characters in a label string. | |
814 ILLEGAL nil: Throw away any words containing characters illegal in labels. | |
815 t: Throw away only the illegal characters, not the whole word. | |
816 ABBREV nil: Never abbreviate words. | |
817 t: Always abbreviate words (see `reftex-abbrev-parameters'). | |
818 not t and not nil: Abbreviate words if necessary to shorten | |
819 label string below MAXCHAR. | |
820 SEPARATOR String separating different words in the label. | |
821 IGNOREWORDS List of words which should not be part of labels. | |
822 DOWNCASE t: Downcase words before using them." | |
823 :group 'reftex-making-and-inserting-labels | |
824 :type '(list (integer :tag "Number of words " 3) | |
825 (integer :tag "Maximum label length " 20) | |
826 (choice :tag "Illegal characters in words" | |
827 (const :tag "throw away entire word" nil) | |
828 (const :tag "throw away single chars" t)) | |
829 (choice :tag "Abbreviate words " | |
830 (const :tag "never" nil) | |
831 (const :tag "always" t) | |
832 (const :tag "when label is too long" 1)) | |
833 (string :tag "Separator between words " "-") | |
834 (repeat :tag "Ignore words" | |
835 :entry-format " %i %d %v" | |
836 (string :tag "")) | |
52170
27340819ef07
Updated to version 4.21
Carsten Dominik <dominik@science.uva.nl>
parents:
49599
diff
changeset
|
837 (option (boolean :tag "Downcase words ")))) |
25280 | 838 |
839 (defcustom reftex-label-illegal-re "[^-a-zA-Z0-9_+=:;,.]" | |
840 "Regexp matching characters not legal in labels." | |
841 :group 'reftex-making-and-inserting-labels | |
842 :type '(regexp :tag "Regular Expression")) | |
843 | |
844 (defcustom reftex-abbrev-parameters '(4 2 "^aeiou" "aeiou") | |
845 "Parameters for abbreviation of words. | |
846 This variable is a list of the following items. | |
847 | |
848 MIN-CHARS Minimum number of characters remaining after abbreviation. | |
849 MIN-KILL Minimum number of characters to remove when abbreviating words. | |
850 BEFORE Character class before abbrev point in word. | |
851 AFTER Character class after abbrev point in word." | |
852 :group 'reftex-making-and-inserting-labels | |
853 :type '(list | |
854 (integer :tag "Minimum chars per word" 4) | |
855 (integer :tag "Shorten by at least " 2) | |
856 (string :tag "cut before char class " "^saeiou") | |
857 (string :tag "cut after char class " "aeiou"))) | |
858 | |
859 (defcustom reftex-format-label-function nil | |
860 "Function which produces the string to insert as a label definition. | |
861 Normally should be nil, unless you want to do something fancy. | |
862 The function will be called with two arguments, the LABEL and the DEFAULT | |
37998
706af946b1e7
* reftex-ref.el (reftex-select-label-help): Added "z" key
Carsten Dominik <dominik@science.uva.nl>
parents:
34402
diff
changeset
|
863 FORMAT, which usually is `\\label{%s}'. The function should return the |
25280 | 864 string to insert into the buffer." |
865 :group 'reftex-making-and-inserting-labels | |
866 :type 'function) | |
867 | |
868 ;; Label referencing | |
869 | |
870 (defgroup reftex-referencing-labels nil | |
871 "Options on how to reference labels." | |
872 :group 'reftex-label-support) | |
873 | |
874 (eval-and-compile | |
875 (defconst reftex-tmp | |
876 '((const :tag "on" t) | |
877 (const :tag "off" nil) | |
878 (string :tag "Selected label types")))) | |
879 | |
880 (defcustom reftex-label-menu-flags '(t t nil nil nil nil t nil) | |
881 "List of flags governing the label menu makeup. | |
882 The flags are: | |
883 | |
884 TABLE-OF-CONTENTS Show the labels embedded in a table of context. | |
885 SECTION-NUMBERS Include section numbers (like 4.1.3) in table of contents. | |
886 COUNTERS Show counters. This just numbers the labels in the menu. | |
887 NO-CONTEXT Non-nil means do NOT show the short context. | |
888 FOLLOW Follow full context in other window. | |
889 SHOW-COMMENTED Show labels from regions which are commented out. | |
890 MATCH-IN-TOC Obsolete flag. | |
891 SHOW FILES Show begin and end of included files. | |
892 | |
893 Each of these flags can be set to t or nil, or to a string of type letters | |
894 indicating the label types for which it should be true. These strings work | |
895 like character classes in regular expressions. Thus, setting one of the | |
896 flags to \"sf\" makes the flag true for section and figure labels, nil | |
897 for everything else. Setting it to \"^sf\" makes it the other way round. | |
898 The available label types are: s (section), f (figure), t (table), i (item), | |
899 e (equation), n (footnote), plus any definitions in `reftex-label-alist'. | |
900 | |
901 Most options can also be switched from the label menu itself - so if you | |
902 decide here to not have a table of contents in the label menu, you can still | |
903 get one interactively during selection from the label menu." | |
904 :group 'reftex-referencing-labels | |
905 :type | |
906 `(list | |
907 (choice :tag "Embed in table of contents " ,@reftex-tmp) | |
908 (choice :tag "Show section numbers " ,@reftex-tmp) | |
909 (choice :tag "Show individual counters " ,@reftex-tmp) | |
910 (choice :tag "Hide short context " ,@reftex-tmp) | |
911 (choice :tag "Follow context in other window " ,@reftex-tmp) | |
912 (choice :tag "Show commented labels " ,@reftex-tmp) | |
52170
27340819ef07
Updated to version 4.21
Carsten Dominik <dominik@science.uva.nl>
parents:
49599
diff
changeset
|
913 (choice :tag "Obsolete flag, Don't use. " ,@reftex-tmp) |
25280 | 914 (choice :tag "Show begin/end of included files" ,@reftex-tmp))) |
915 | |
916 (defcustom reftex-multiref-punctuation '((?, . ", ") (?- . "--") (?+ . " and ")) | |
917 "Punctuation strings for multiple references. | |
918 When marking is used in the selection buffer to select several references, | |
919 this variable associates the 3 marking characters `,-+' with prefix strings | |
37998
706af946b1e7
* reftex-ref.el (reftex-select-label-help): Added "z" key
Carsten Dominik <dominik@science.uva.nl>
parents:
34402
diff
changeset
|
920 to be inserted into the buffer before the corresponding \\ref macro. |
25280 | 921 This is used to string together whole reference sets, like |
922 `eqs. 1,2,3-5,6 and 7' in a single call to `reftex-reference'. See manual." | |
923 :group 'reftex-referencing-labels | |
924 :type '(repeat (cons (character) (string)))) | |
925 | |
926 (defcustom reftex-vref-is-default nil | |
927 "*Non-nil means, the varioref macro \\vref is used as default. | |
52170
27340819ef07
Updated to version 4.21
Carsten Dominik <dominik@science.uva.nl>
parents:
49599
diff
changeset
|
928 In the selection buffer, the `v' key toggles the reference macro between |
25280 | 929 `\\ref' and `\\vref'. The value of this variable determines the default |
930 which is active when entering the selection process. | |
931 Instead of nil or t, this may also be a string of type letters indicating | |
932 the label types for which it should be true." | |
933 :group 'reftex-referencing-labels | |
934 :type `(choice :tag "\\vref is default macro" ,@reftex-tmp)) | |
935 | |
936 (defcustom reftex-fref-is-default nil | |
937 "*Non-nil means, the fancyref macro \\fref is used as default. | |
52170
27340819ef07
Updated to version 4.21
Carsten Dominik <dominik@science.uva.nl>
parents:
49599
diff
changeset
|
938 In the selection buffer, the `V' key toggles the reference macro between |
25280 | 939 `\\ref', `\\fref' and `\\Fref'. The value of this variable determines |
940 the default which is active when entering the selection process. | |
941 Instead of nil or t, this may also be a string of type letters indicating | |
942 the label types for which it should be true." | |
943 :group 'reftex-referencing-labels | |
944 :type `(choice :tag "\\fref is default macro" ,@reftex-tmp)) | |
945 | |
946 (defcustom reftex-level-indent 2 | |
947 "*Number of spaces to be used for indentation per section level." | |
948 :group 'reftex-referencing-labels | |
949 :type 'integer) | |
950 | |
951 (defcustom reftex-guess-label-type t | |
952 "*Non-nil means, `reftex-reference' will try to guess the label type. | |
953 To do that, RefTeX will look at the word before the cursor and compare it with | |
954 the words given in `reftex-label-alist'. When it finds a match, RefTeX will | |
955 immediately offer the correct label menu - otherwise it will prompt you for | |
956 a label type. If you set this variable to nil, RefTeX will always prompt." | |
957 :group 'reftex-referencing-labels | |
958 :type 'boolean) | |
959 | |
960 (defcustom reftex-format-ref-function nil | |
961 "Function which produces the string to insert as a reference. | |
52170
27340819ef07
Updated to version 4.21
Carsten Dominik <dominik@science.uva.nl>
parents:
49599
diff
changeset
|
962 Normally should be nil, because the format to insert a reference can |
25280 | 963 already be specified in `reftex-label-alist'. |
37998
706af946b1e7
* reftex-ref.el (reftex-select-label-help): Added "z" key
Carsten Dominik <dominik@science.uva.nl>
parents:
34402
diff
changeset
|
964 This hook also is used by the special commands to insert `\\vref' and `\\fref' |
25280 | 965 references, so even if you set this, your setting will be ignored by |
966 the special commands. | |
967 The function will be called with two arguments, the LABEL and the DEFAULT | |
37998
706af946b1e7
* reftex-ref.el (reftex-select-label-help): Added "z" key
Carsten Dominik <dominik@science.uva.nl>
parents:
34402
diff
changeset
|
968 FORMAT, which normally is `~\\ref{%s}'. The function should return the |
25280 | 969 string to insert into the buffer." |
970 :group 'reftex-referencing-labels | |
971 :type 'function) | |
972 | |
973 (defcustom reftex-select-label-mode-hook nil | |
974 "Mode hook for reftex-select-label-mode." | |
975 :group 'reftex-referencing-labels | |
976 :type 'hook) | |
977 | |
978 ;; BibteX citation configuration ---------------------------------------- | |
979 | |
980 (defgroup reftex-citation-support nil | |
981 "Support for referencing bibliographic data with BibTeX." | |
982 :group 'reftex) | |
983 | |
46612
7522419c4db0
Updated to reftex 4.17
Carsten Dominik <dominik@science.uva.nl>
parents:
46155
diff
changeset
|
984 (defcustom reftex-bibliography-commands '("bibliography" "nobibliography") |
7522419c4db0
Updated to reftex 4.17
Carsten Dominik <dominik@science.uva.nl>
parents:
46155
diff
changeset
|
985 "LaTeX commands which specify the BibTeX databases to use with the document." |
7522419c4db0
Updated to reftex 4.17
Carsten Dominik <dominik@science.uva.nl>
parents:
46155
diff
changeset
|
986 :group 'reftex-citation-support |
7522419c4db0
Updated to reftex 4.17
Carsten Dominik <dominik@science.uva.nl>
parents:
46155
diff
changeset
|
987 :type '(repeat string)) |
7522419c4db0
Updated to reftex 4.17
Carsten Dominik <dominik@science.uva.nl>
parents:
46155
diff
changeset
|
988 |
7522419c4db0
Updated to reftex 4.17
Carsten Dominik <dominik@science.uva.nl>
parents:
46155
diff
changeset
|
989 |
25280 | 990 (defvar reftex-bibfile-ignore-list nil) ; compatibility |
991 (defcustom reftex-bibfile-ignore-regexps nil | |
992 "*List of regular expressions to exclude files in \\bibliography{..}. | |
993 File names matched by these regexps will not be parsed by RefTeX. | |
994 Intended for files which contain only `@string' macro definitions and the | |
995 like, which are ignored by RefTeX anyway." | |
996 :group 'reftex-citation-support | |
997 :set 'reftex-set-dirty | |
998 :type '(repeat (regexp))) | |
999 | |
1000 (defcustom reftex-default-bibliography nil | |
1001 "*List of BibTeX database files which should be used if none are specified. | |
1002 When `reftex-citation' is called from a document which has neither a | |
37998
706af946b1e7
* reftex-ref.el (reftex-select-label-help): Added "z" key
Carsten Dominik <dominik@science.uva.nl>
parents:
34402
diff
changeset
|
1003 `\\bibliography{..}' statement nor a `thebibliography' environment, |
25280 | 1004 RefTeX will scan these files instead. Intended for using `reftex-citation' |
1005 in non-LaTeX files. The files will be searched along the BIBINPUTS or TEXBIB | |
1006 path." | |
1007 :group 'reftex-citation-support | |
1008 :type '(repeat (file))) | |
1009 | |
1010 (defcustom reftex-sort-bibtex-matches 'reverse-year | |
1011 "*Sorting of the entries found in BibTeX databases by reftex-citation. | |
1012 Possible values: | |
1013 nil Do not sort entries. | |
1014 'author Sort entries by author name. | |
1015 'year Sort entries by increasing year. | |
1016 'reverse-year Sort entries by decreasing year." | |
1017 :group 'reftex-citation-support | |
1018 :type '(choice (const :tag "not" nil) | |
1019 (const :tag "by author" author) | |
1020 (const :tag "by year" year) | |
1021 (const :tag "by year, reversed" reverse-year))) | |
1022 | |
1023 (defcustom reftex-cite-format 'default | |
1024 "*The format of citations to be inserted into the buffer. | |
1025 It can be a string or an alist or a symbol. In the simplest case this | |
1026 is just the string \"\\cite{%l}\", which is also the default. See the | |
1027 definition of `reftex-cite-format-builtin' for more complex examples. | |
1028 | |
1029 If `reftex-cite-format' is a string, it will be used as the format. | |
1030 In the format, the following percent escapes will be expanded. | |
1031 | |
1032 %l The BibTeX label of the citation. | |
46612
7522419c4db0
Updated to reftex 4.17
Carsten Dominik <dominik@science.uva.nl>
parents:
46155
diff
changeset
|
1033 %a List of author names, see also `reftex-cite-punctuation'. |
25280 | 1034 %2a Like %a, but abbreviate more than 2 authors like Jones et al. |
1035 %A First author name only. | |
1036 %e Works like %a, but on list of editor names. (%2e and %E work a well) | |
1037 | |
1038 It is also possible to access all other BibTeX database fields: | |
1039 %b booktitle %c chapter %d edition %h howpublished | |
1040 %i institution %j journal %k key %m month | |
1041 %n number %o organization %p pages %P first page | |
1042 %r address %s school %u publisher %t title | |
52170
27340819ef07
Updated to version 4.21
Carsten Dominik <dominik@science.uva.nl>
parents:
49599
diff
changeset
|
1043 %v volume %y year |
25280 | 1044 %B booktitle, abbreviated %T title, abbreviated |
1045 | |
1046 Usually, only %l is needed. The other stuff is mainly for the echo area | |
1047 display, and for (setq reftex-comment-citations t). | |
1048 | |
52170
27340819ef07
Updated to version 4.21
Carsten Dominik <dominik@science.uva.nl>
parents:
49599
diff
changeset
|
1049 %< as a special operator kills punctuation and space around it after the |
25280 | 1050 string has been formatted. |
1051 | |
59534
9bad65481674
2005-01-14 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
52401
diff
changeset
|
1052 A pair of square brackets indicates an optional argument, and RefTeX |
9bad65481674
2005-01-14 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
52401
diff
changeset
|
1053 will prompt for the values of these arguments. |
9bad65481674
2005-01-14 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
52401
diff
changeset
|
1054 |
25280 | 1055 Beware that all this only works with BibTeX database files. When |
1056 citations are made from the \\bibitems in an explicit thebibliography | |
1057 environment, only %l is available. | |
1058 | |
1059 If `reftex-cite-format' is an alist of characters and strings, the user | |
1060 will be prompted for a character to select one of the possible format | |
1061 strings. | |
1062 In order to configure this variable, you can either set | |
1063 `reftex-cite-format' directly yourself or set it to the SYMBOL of one of | |
52170
27340819ef07
Updated to version 4.21
Carsten Dominik <dominik@science.uva.nl>
parents:
49599
diff
changeset
|
1064 the predefined styles. The predefined symbols are those which have an |
25280 | 1065 association in the constant `reftex-cite-format-builtin'. |
1066 E.g.: (setq reftex-cite-format 'natbib)" | |
1067 :group 'reftex-citation-support | |
1068 :type | |
1069 `(choice | |
1070 :format "%{%t%}: \n%[Value Menu%] %v" | |
1071 (radio :tag "Symbolic Builtins" | |
1072 :indent 4 | |
1073 :value default | |
1074 ,@(mapcar | |
1075 (lambda (x) | |
1076 (list 'const :tag (concat (symbol-name (nth 0 x)) | |
1077 ": " (nth 1 x)) | |
1078 (nth 0 x))) | |
1079 reftex-cite-format-builtin)) | |
1080 (string :tag "format string" "\\cite{%l}") | |
1081 (repeat :tag "key-ed format strings" | |
1082 :value ((?\r . "\\cite{%l}") | |
1083 (?t . "\\cite{%l}") (?p . "\\cite{%l}")) | |
1084 (cons (character :tag "Key character" ?\r) | |
1085 (string :tag "Format string" ""))))) | |
1086 | |
59534
9bad65481674
2005-01-14 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
52401
diff
changeset
|
1087 (defcustom reftex-cite-prompt-optional-args 'maybe |
9bad65481674
2005-01-14 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
52401
diff
changeset
|
1088 "*Non-nil means, prompt for empty optional arguments in cite macros. |
9bad65481674
2005-01-14 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
52401
diff
changeset
|
1089 When an entry in `reftex-cite-format' ist given with square brackets to |
9bad65481674
2005-01-14 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
52401
diff
changeset
|
1090 indicate optional arguments (for example \\cite[][]{%l}), RefTeX can |
9bad65481674
2005-01-14 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
52401
diff
changeset
|
1091 prompt for values. Possible values are: |
9bad65481674
2005-01-14 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
52401
diff
changeset
|
1092 |
9bad65481674
2005-01-14 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
52401
diff
changeset
|
1093 nil Never prompt for optional arguments |
9bad65481674
2005-01-14 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
52401
diff
changeset
|
1094 t Always prompt |
9bad65481674
2005-01-14 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
52401
diff
changeset
|
1095 maybe Prompt only if `reftex-citation' was called with C-u prefix arg |
9bad65481674
2005-01-14 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
52401
diff
changeset
|
1096 |
9bad65481674
2005-01-14 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
52401
diff
changeset
|
1097 Unnecessary empty optional arguments are removed before insertion into |
9bad65481674
2005-01-14 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
52401
diff
changeset
|
1098 the buffer. See `reftex-cite-cleanup-optional-args'." |
9bad65481674
2005-01-14 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
52401
diff
changeset
|
1099 :group 'reftex-citation-support |
9bad65481674
2005-01-14 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
52401
diff
changeset
|
1100 :type '(choice |
9bad65481674
2005-01-14 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
52401
diff
changeset
|
1101 (const :tag "Always" t) |
9bad65481674
2005-01-14 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
52401
diff
changeset
|
1102 (const :tag "When called with prefix arg" maybe) |
9bad65481674
2005-01-14 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
52401
diff
changeset
|
1103 (const :tag "Never" nil))) |
9bad65481674
2005-01-14 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
52401
diff
changeset
|
1104 |
9bad65481674
2005-01-14 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
52401
diff
changeset
|
1105 (defcustom reftex-cite-cleanup-optional-args t |
9bad65481674
2005-01-14 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
52401
diff
changeset
|
1106 "*Non-nil means, remove unnecessary empty optional arguments in cite macros. |
9bad65481674
2005-01-14 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
52401
diff
changeset
|
1107 The cite macros provided by some packages (for example |
9bad65481674
2005-01-14 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
52401
diff
changeset
|
1108 natbib) allow specifying two optional arguments, one for a prefix to |
9bad65481674
2005-01-14 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
52401
diff
changeset
|
1109 the citation, and a second for a postfix. When only one optional |
9bad65481674
2005-01-14 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
52401
diff
changeset
|
1110 argument is given, it is interpreted as postfix. When this option is |
9bad65481674
2005-01-14 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
52401
diff
changeset
|
1111 t, RefTeX removes unnecessary empty optional arguments from the cite |
9bad65481674
2005-01-14 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
52401
diff
changeset
|
1112 macro before insertion. For example, it will change |
9bad65481674
2005-01-14 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
52401
diff
changeset
|
1113 \\cite[][]{Jones} -> \\cite{Jones} |
9bad65481674
2005-01-14 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
52401
diff
changeset
|
1114 \\cite[][Chapter 1]{Jones} -> \\cite[Chapter 1]{Jones} |
9bad65481674
2005-01-14 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
52401
diff
changeset
|
1115 \\cite[see][]{Jones} -> \\cite[see][]{Jones} |
9bad65481674
2005-01-14 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
52401
diff
changeset
|
1116 \\cite[see][Chapter 1]{Jones} -> \\cite{Jones} |
9bad65481674
2005-01-14 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
52401
diff
changeset
|
1117 Is is possible that other packages have other conventions about which |
9bad65481674
2005-01-14 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
52401
diff
changeset
|
1118 optional argument is interpreted how - that is why this cleaning up |
9bad65481674
2005-01-14 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
52401
diff
changeset
|
1119 can be turned off." |
9bad65481674
2005-01-14 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
52401
diff
changeset
|
1120 :group 'reftex-citation-support |
9bad65481674
2005-01-14 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
52401
diff
changeset
|
1121 :type 'boolean) |
9bad65481674
2005-01-14 Carsten Dominik <dominik@science.uva.nl>
Carsten Dominik <dominik@science.uva.nl>
parents:
52401
diff
changeset
|
1122 |
25280 | 1123 (defcustom reftex-comment-citations nil |
1124 "*Non-nil means add a comment for each citation describing the full entry. | |
1125 The comment is formatted according to `reftex-cite-comment-format'." | |
1126 :group 'reftex-citation-support | |
1127 :type 'boolean) | |
1128 | |
1129 (defcustom reftex-cite-comment-format | |
1130 "%% %2a %y, %j %v, %P, %b, %e, %u, %s %<\n" | |
1131 "Citation format used for commented citations. Must NOT contain %l. | |
1132 See the variable `reftex-cite-format' for possible percent escapes." | |
1133 :group 'reftex-citation-support | |
1134 :type 'string) | |
1135 | |
1136 (defcustom reftex-cite-view-format "%2a %y, %T, %B, %j %v:%P, %s %<" | |
1137 "Citation format used to display citation info in the message area. | |
1138 Must NOT contain %l. See the variable `reftex-cite-format' for | |
1139 possible percent escapes." | |
1140 :group 'reftex-citation-support | |
1141 :group 'reftex-viewing-cross-references | |
1142 :type 'string) | |
1143 | |
1144 (defcustom reftex-cite-punctuation '(", " " \\& " " {\\it et al.}") | |
1145 "Punctuation for formatting of name lists in citations. | |
1146 This is a list of 3 strings. | |
1147 1. normal names separator, like \", \" in Jones, Brown and Miller | |
1148 2. final names separator, like \" and \" in Jones, Brown and Miller | |
1149 3. The \"et al\" string, like \" {\\it et al.}\" in Jones {\\it et al.}" | |
1150 :group 'reftex-citation-support | |
1151 :type '(list | |
1152 (string :tag "Separator for names ") | |
1153 (string :tag "Separator for last name in list") | |
1154 (string :tag "string used as et al. "))) | |
1155 | |
1156 (defcustom reftex-format-cite-function nil | |
1157 "Function which produces the string to insert as a citation. | |
52170
27340819ef07
Updated to version 4.21
Carsten Dominik <dominik@science.uva.nl>
parents:
49599
diff
changeset
|
1158 Normally should be nil, because the format to insert a reference can |
25280 | 1159 already be specified in `reftex-cite-format'. |
1160 The function will be called with two arguments, the CITATION KEY and the | |
1161 DEFAULT FORMAT, which is taken from `reftex-cite-format'. The function | |
1162 should return the string to insert into the buffer." | |
1163 :group 'reftex-citation-support | |
1164 :type 'function) | |
1165 | |
1166 (defcustom reftex-select-bib-mode-hook nil | |
1167 "Mode hook for reftex-select-bib-mode." | |
1168 :group 'reftex-citation-support | |
1169 :type 'hook) | |
1170 | |
1171 ;; Index Support Configuration | |
1172 | |
1173 (defgroup reftex-index-support nil | |
1174 "Support for viewing and editing the index." | |
1175 :group 'reftex) | |
1176 | |
1177 (defcustom reftex-support-index t | |
1178 "*Non-nil means, index entries are parsed as well. | |
1179 Index support is resource intensive and the internal structure holding the | |
1180 parsed information can become quite big. Therefore it can be turned off. | |
1181 When this is nil and you execute a command which requires index support, | |
1182 you will be asked for confirmation to turn it on and rescan the document." | |
1183 :group 'reftex-index-support | |
1184 :type 'boolean) | |
1185 | |
1186 (defcustom reftex-index-special-chars '("!" "|" "@" "\"" "\\") | |
1187 "Special characters in index entries. The value is a list of five strings. | |
1188 These correspond to the makeindex keywords LEVEL ENCAP ACTUAL QUOTE ESCAPE." | |
1189 :group 'reftex-index-support | |
1190 :type '(list | |
52170
27340819ef07
Updated to version 4.21
Carsten Dominik <dominik@science.uva.nl>
parents:
49599
diff
changeset
|
1191 (string :tag "LEVEL separator") |
27340819ef07
Updated to version 4.21
Carsten Dominik <dominik@science.uva.nl>
parents:
49599
diff
changeset
|
1192 (string :tag "ENCAP char ") |
27340819ef07
Updated to version 4.21
Carsten Dominik <dominik@science.uva.nl>
parents:
49599
diff
changeset
|
1193 (string :tag "ACTUAL char ") |
27340819ef07
Updated to version 4.21
Carsten Dominik <dominik@science.uva.nl>
parents:
49599
diff
changeset
|
1194 (string :tag "QUOTE char ") |
27340819ef07
Updated to version 4.21
Carsten Dominik <dominik@science.uva.nl>
parents:
49599
diff
changeset
|
1195 (string :tag "ESCAPE char "))) |
25280 | 1196 |
1197 (defcustom reftex-index-macros nil | |
1198 "Macros which define index entries. The structure is | |
1199 | |
52170
27340819ef07
Updated to version 4.21
Carsten Dominik <dominik@science.uva.nl>
parents:
49599
diff
changeset
|
1200 \(MACRO INDEX-TAG KEY PREFIX EXCLUDE REPEAT) |
25280 | 1201 |
1202 MACRO is the macro. Arguments should be denoted by empty braces like | |
1203 \\index[]{*}. Use square brackets to denote optional arguments. The star | |
1204 marks where the index key is. | |
1205 | |
1206 INDEX-TAG is a short name of the index. \"idx\" and \"glo\" are | |
1207 reserved for the default index and the glossary. Other indices can be | |
1208 defined as well. If this is an integer, the Nth argument of the macro | |
1209 holds the index tag. | |
1210 | |
1211 KEY is a character which is used to identify the macro for input with | |
1212 \\[reftex-index]. ?i, ?I, and ?g are reserved for default index and glossary. | |
1213 | |
1214 PREFIX can be a prefix which is added to the KEY part of the index entry. | |
1215 If you have a macro \\newcommand{\\molec}[1]{#1\\index{Molecules!#1}}, this | |
1216 prefix should be \"Molecules!\". See the manual for details. | |
1217 | |
1218 EXCLUDE can be a function. If this function exists and returns a non-nil | |
1219 value, the index entry at point is ignored. This was implemented to support | |
1220 the (deprecated) `^' and `_' shortcuts in the LaTeX2e `index' package. | |
1221 | |
26910
489a5439b988
* reftex.el (reftex-compile-variables): respect new structure of
Carsten Dominik <dominik@science.uva.nl>
parents:
25804
diff
changeset
|
1222 REPEAT, if non-nil, means the index macro does not typeset the entry in |
489a5439b988
* reftex.el (reftex-compile-variables): respect new structure of
Carsten Dominik <dominik@science.uva.nl>
parents:
25804
diff
changeset
|
1223 the text, so that the text has to be repeated outside the index macro. |
489a5439b988
* reftex.el (reftex-compile-variables): respect new structure of
Carsten Dominik <dominik@science.uva.nl>
parents:
25804
diff
changeset
|
1224 Needed for `reftex-index-selection-or-word' and for indexing from the |
489a5439b988
* reftex.el (reftex-compile-variables): respect new structure of
Carsten Dominik <dominik@science.uva.nl>
parents:
25804
diff
changeset
|
1225 phrase buffer. |
489a5439b988
* reftex.el (reftex-compile-variables): respect new structure of
Carsten Dominik <dominik@science.uva.nl>
parents:
25804
diff
changeset
|
1226 |
25280 | 1227 The final entry may also be a symbol if this entry has a association |
1228 in the variable `reftex-index-macros-builtin' to specify the main | |
1229 indexing package you are using. Legal values are currently | |
1230 default The LaTeX default - unnecessary to specify this one | |
1231 multind The multind.sty package | |
1232 index The index.sty package | |
1233 index-shortcut The index.sty packages with the ^ and _ shortcuts. | |
1234 Should not be used - only for old documents. | |
1235 Note that AUCTeX sets these things internally for RefTeX as well, so | |
1236 with a sufficiently new version of AUCTeX, you should not set the | |
1237 package here." | |
1238 :group 'reftex-index-support | |
1239 :set 'reftex-set-dirty | |
1240 :type `(list | |
52170
27340819ef07
Updated to version 4.21
Carsten Dominik <dominik@science.uva.nl>
parents:
49599
diff
changeset
|
1241 (repeat |
27340819ef07
Updated to version 4.21
Carsten Dominik <dominik@science.uva.nl>
parents:
49599
diff
changeset
|
1242 :inline t |
27340819ef07
Updated to version 4.21
Carsten Dominik <dominik@science.uva.nl>
parents:
49599
diff
changeset
|
1243 (list :value ("" "idx" ?a "" nil) |
27340819ef07
Updated to version 4.21
Carsten Dominik <dominik@science.uva.nl>
parents:
49599
diff
changeset
|
1244 (string :tag "Macro with args") |
27340819ef07
Updated to version 4.21
Carsten Dominik <dominik@science.uva.nl>
parents:
49599
diff
changeset
|
1245 (choice :tag "Index Tag " |
27340819ef07
Updated to version 4.21
Carsten Dominik <dominik@science.uva.nl>
parents:
49599
diff
changeset
|
1246 (string) |
27340819ef07
Updated to version 4.21
Carsten Dominik <dominik@science.uva.nl>
parents:
49599
diff
changeset
|
1247 (integer :tag "Macro arg Nr" :value 1)) |
27340819ef07
Updated to version 4.21
Carsten Dominik <dominik@science.uva.nl>
parents:
49599
diff
changeset
|
1248 (character :tag "Access Key ") |
27340819ef07
Updated to version 4.21
Carsten Dominik <dominik@science.uva.nl>
parents:
49599
diff
changeset
|
1249 (string :tag "Key Prefix ") |
27340819ef07
Updated to version 4.21
Carsten Dominik <dominik@science.uva.nl>
parents:
49599
diff
changeset
|
1250 (symbol :tag "Exclusion hook ") |
26910
489a5439b988
* reftex.el (reftex-compile-variables): respect new structure of
Carsten Dominik <dominik@science.uva.nl>
parents:
25804
diff
changeset
|
1251 (boolean :tag "Repeat Outside "))) |
52170
27340819ef07
Updated to version 4.21
Carsten Dominik <dominik@science.uva.nl>
parents:
49599
diff
changeset
|
1252 (option |
27340819ef07
Updated to version 4.21
Carsten Dominik <dominik@science.uva.nl>
parents:
49599
diff
changeset
|
1253 :tag "Package:" |
27340819ef07
Updated to version 4.21
Carsten Dominik <dominik@science.uva.nl>
parents:
49599
diff
changeset
|
1254 (choice :tag "Package" |
27340819ef07
Updated to version 4.21
Carsten Dominik <dominik@science.uva.nl>
parents:
49599
diff
changeset
|
1255 :value index |
27340819ef07
Updated to version 4.21
Carsten Dominik <dominik@science.uva.nl>
parents:
49599
diff
changeset
|
1256 ,@(mapcar |
27340819ef07
Updated to version 4.21
Carsten Dominik <dominik@science.uva.nl>
parents:
49599
diff
changeset
|
1257 (lambda (x) |
27340819ef07
Updated to version 4.21
Carsten Dominik <dominik@science.uva.nl>
parents:
49599
diff
changeset
|
1258 (list 'const :tag (concat (symbol-name (nth 0 x)) |
27340819ef07
Updated to version 4.21
Carsten Dominik <dominik@science.uva.nl>
parents:
49599
diff
changeset
|
1259 ": " (nth 1 x)) |
27340819ef07
Updated to version 4.21
Carsten Dominik <dominik@science.uva.nl>
parents:
49599
diff
changeset
|
1260 (nth 0 x))) |
27340819ef07
Updated to version 4.21
Carsten Dominik <dominik@science.uva.nl>
parents:
49599
diff
changeset
|
1261 reftex-index-macros-builtin))))) |
25280 | 1262 |
26910
489a5439b988
* reftex.el (reftex-compile-variables): respect new structure of
Carsten Dominik <dominik@science.uva.nl>
parents:
25804
diff
changeset
|
1263 (defcustom reftex-index-default-macro '(?i "idx") |
25280 | 1264 "The default index macro for \\[reftex-index-selection-or-word]. |
26910
489a5439b988
* reftex.el (reftex-compile-variables): respect new structure of
Carsten Dominik <dominik@science.uva.nl>
parents:
25804
diff
changeset
|
1265 This is a list with (MACRO-KEY DEFAULT-TAG). |
25280 | 1266 |
1267 MACRO-KEY: Character identifying an index macro - see `reftex-index-macros'. | |
52170
27340819ef07
Updated to version 4.21
Carsten Dominik <dominik@science.uva.nl>
parents:
49599
diff
changeset
|
1268 DEFAULT-TAG: This is the tag to be used if the macro requires a TAG argument. |
25280 | 1269 When this is nil and a TAG is needed, RefTeX will ask for it. |
1270 When this is the empty string and the TAG argument of the index | |
26910
489a5439b988
* reftex.el (reftex-compile-variables): respect new structure of
Carsten Dominik <dominik@science.uva.nl>
parents:
25804
diff
changeset
|
1271 macro is optional, the TAG argument will be omitted." |
25280 | 1272 :group 'reftex-index-support |
1273 :type '(list | |
52170
27340819ef07
Updated to version 4.21
Carsten Dominik <dominik@science.uva.nl>
parents:
49599
diff
changeset
|
1274 (character :tag "Character identifying default macro") |
27340819ef07
Updated to version 4.21
Carsten Dominik <dominik@science.uva.nl>
parents:
49599
diff
changeset
|
1275 (choice :tag "Default index tag " |
27340819ef07
Updated to version 4.21
Carsten Dominik <dominik@science.uva.nl>
parents:
49599
diff
changeset
|
1276 (const nil) |
27340819ef07
Updated to version 4.21
Carsten Dominik <dominik@science.uva.nl>
parents:
49599
diff
changeset
|
1277 (string)))) |
25280 | 1278 |
1279 (defcustom reftex-index-default-tag "idx" | |
1280 "Default index tag. | |
1281 When working with multiple indexes, RefTeX queries for an index tag when | |
1282 creating index entries or displaying a specific index. This variable controls | |
1283 the default offered for these queries. The default can be selected with RET | |
1284 during selection or completion. Legal values of this variable are: | |
1285 | |
1286 nil Do not provide a default index | |
1287 \"tag\" The default index tag given as a string, e.g. \"idx\". | |
1288 last The last used index tag will be offered as default." | |
1289 :group 'reftex-index-support | |
1290 :type '(choice | |
52170
27340819ef07
Updated to version 4.21
Carsten Dominik <dominik@science.uva.nl>
parents:
49599
diff
changeset
|
1291 (const :tag "no default" nil) |
27340819ef07
Updated to version 4.21
Carsten Dominik <dominik@science.uva.nl>
parents:
49599
diff
changeset
|
1292 (const :tag "last used " 'last) |
27340819ef07
Updated to version 4.21
Carsten Dominik <dominik@science.uva.nl>
parents:
49599
diff
changeset
|
1293 (string :tag "index tag " "idx"))) |
25280 | 1294 |
1295 (defcustom reftex-index-math-format "$%s$" | |
1296 "Format of index entries when copied from inside math mode. | |
1297 When `reftex-index-selection-or-word' is executed inside TeX math mode, | |
1298 the index key copied from the buffer is processed with this format string | |
1299 through the `format' function. This can be used to add the math delimiters | |
52170
27340819ef07
Updated to version 4.21
Carsten Dominik <dominik@science.uva.nl>
parents:
49599
diff
changeset
|
1300 \(e.g. `$') to the string. |
25280 | 1301 Requires the `texmathp.el' library which is part of AUCTeX." |
1302 :group 'reftex-index-support | |
1303 :type 'string) | |
1304 | |
27192
f70a80cecdd3
New version number.
Carsten Dominik <dominik@science.uva.nl>
parents:
27035
diff
changeset
|
1305 (defcustom reftex-index-phrase-file-extension ".rip" |
f70a80cecdd3
New version number.
Carsten Dominik <dominik@science.uva.nl>
parents:
27035
diff
changeset
|
1306 "File extension for the index phrase file. |
f70a80cecdd3
New version number.
Carsten Dominik <dominik@science.uva.nl>
parents:
27035
diff
changeset
|
1307 This extension will be added to the base name of the master file." |
f70a80cecdd3
New version number.
Carsten Dominik <dominik@science.uva.nl>
parents:
27035
diff
changeset
|
1308 :group 'reftex-index-support |
f70a80cecdd3
New version number.
Carsten Dominik <dominik@science.uva.nl>
parents:
27035
diff
changeset
|
1309 :type 'string) |
f70a80cecdd3
New version number.
Carsten Dominik <dominik@science.uva.nl>
parents:
27035
diff
changeset
|
1310 |
26910
489a5439b988
* reftex.el (reftex-compile-variables): respect new structure of
Carsten Dominik <dominik@science.uva.nl>
parents:
25804
diff
changeset
|
1311 (defcustom reftex-index-phrases-logical-and-regexp " *&& *" |
489a5439b988
* reftex.el (reftex-compile-variables): respect new structure of
Carsten Dominik <dominik@science.uva.nl>
parents:
25804
diff
changeset
|
1312 "Regexp matching the `and' operator for index arguments in phrases file. |
489a5439b988
* reftex.el (reftex-compile-variables): respect new structure of
Carsten Dominik <dominik@science.uva.nl>
parents:
25804
diff
changeset
|
1313 When several index arguments in a phrase line are separated by this |
489a5439b988
* reftex.el (reftex-compile-variables): respect new structure of
Carsten Dominik <dominik@science.uva.nl>
parents:
25804
diff
changeset
|
1314 operator, each part will generate an index macro. So each match of |
489a5439b988
* reftex.el (reftex-compile-variables): respect new structure of
Carsten Dominik <dominik@science.uva.nl>
parents:
25804
diff
changeset
|
1315 the search phrase will produce *several* different index entries. |
489a5439b988
* reftex.el (reftex-compile-variables): respect new structure of
Carsten Dominik <dominik@science.uva.nl>
parents:
25804
diff
changeset
|
1316 |
489a5439b988
* reftex.el (reftex-compile-variables): respect new structure of
Carsten Dominik <dominik@science.uva.nl>
parents:
25804
diff
changeset
|
1317 Note: make sure this does no match things which are not separators. |
489a5439b988
* reftex.el (reftex-compile-variables): respect new structure of
Carsten Dominik <dominik@science.uva.nl>
parents:
25804
diff
changeset
|
1318 This logical `and' has higher priority than the logical `or' specified in |
489a5439b988
* reftex.el (reftex-compile-variables): respect new structure of
Carsten Dominik <dominik@science.uva.nl>
parents:
25804
diff
changeset
|
1319 `reftex-index-phrases-logical-or-regexp'." |
489a5439b988
* reftex.el (reftex-compile-variables): respect new structure of
Carsten Dominik <dominik@science.uva.nl>
parents:
25804
diff
changeset
|
1320 :group 'reftex-index-support |
489a5439b988
* reftex.el (reftex-compile-variables): respect new structure of
Carsten Dominik <dominik@science.uva.nl>
parents:
25804
diff
changeset
|
1321 :type 'regexp) |
489a5439b988
* reftex.el (reftex-compile-variables): respect new structure of
Carsten Dominik <dominik@science.uva.nl>
parents:
25804
diff
changeset
|
1322 |
489a5439b988
* reftex.el (reftex-compile-variables): respect new structure of
Carsten Dominik <dominik@science.uva.nl>
parents:
25804
diff
changeset
|
1323 (defcustom reftex-index-phrases-logical-or-regexp " *|| *" |
489a5439b988
* reftex.el (reftex-compile-variables): respect new structure of
Carsten Dominik <dominik@science.uva.nl>
parents:
25804
diff
changeset
|
1324 "Regexp matching the `or' operator for index arguments in phrases file. |
489a5439b988
* reftex.el (reftex-compile-variables): respect new structure of
Carsten Dominik <dominik@science.uva.nl>
parents:
25804
diff
changeset
|
1325 When several index arguments in a phrase line are separated by this |
489a5439b988
* reftex.el (reftex-compile-variables): respect new structure of
Carsten Dominik <dominik@science.uva.nl>
parents:
25804
diff
changeset
|
1326 operator, the user will be asked to select one of them at each match |
489a5439b988
* reftex.el (reftex-compile-variables): respect new structure of
Carsten Dominik <dominik@science.uva.nl>
parents:
25804
diff
changeset
|
1327 of the search phrase. The first index arg will be the default - a |
489a5439b988
* reftex.el (reftex-compile-variables): respect new structure of
Carsten Dominik <dominik@science.uva.nl>
parents:
25804
diff
changeset
|
1328 number key 1-9 must be pressed to switch to another. |
489a5439b988
* reftex.el (reftex-compile-variables): respect new structure of
Carsten Dominik <dominik@science.uva.nl>
parents:
25804
diff
changeset
|
1329 |
489a5439b988
* reftex.el (reftex-compile-variables): respect new structure of
Carsten Dominik <dominik@science.uva.nl>
parents:
25804
diff
changeset
|
1330 Note: make sure this does no match things which are not separators. |
489a5439b988
* reftex.el (reftex-compile-variables): respect new structure of
Carsten Dominik <dominik@science.uva.nl>
parents:
25804
diff
changeset
|
1331 The logical `and' specified in `reftex-index-phrases-logical-or-regexp' |
489a5439b988
* reftex.el (reftex-compile-variables): respect new structure of
Carsten Dominik <dominik@science.uva.nl>
parents:
25804
diff
changeset
|
1332 has higher priority than this logical `or'." |
489a5439b988
* reftex.el (reftex-compile-variables): respect new structure of
Carsten Dominik <dominik@science.uva.nl>
parents:
25804
diff
changeset
|
1333 :group 'reftex-index-support |
489a5439b988
* reftex.el (reftex-compile-variables): respect new structure of
Carsten Dominik <dominik@science.uva.nl>
parents:
25804
diff
changeset
|
1334 :type 'regexp) |
489a5439b988
* reftex.el (reftex-compile-variables): respect new structure of
Carsten Dominik <dominik@science.uva.nl>
parents:
25804
diff
changeset
|
1335 |
489a5439b988
* reftex.el (reftex-compile-variables): respect new structure of
Carsten Dominik <dominik@science.uva.nl>
parents:
25804
diff
changeset
|
1336 (defcustom reftex-index-phrases-search-whole-words t |
489a5439b988
* reftex.el (reftex-compile-variables): respect new structure of
Carsten Dominik <dominik@science.uva.nl>
parents:
25804
diff
changeset
|
1337 "*Non-nil means phrases search will look for whole words, not subwords. |
489a5439b988
* reftex.el (reftex-compile-variables): respect new structure of
Carsten Dominik <dominik@science.uva.nl>
parents:
25804
diff
changeset
|
1338 This works by requiring word boundaries at the beginning and end of |
489a5439b988
* reftex.el (reftex-compile-variables): respect new structure of
Carsten Dominik <dominik@science.uva.nl>
parents:
25804
diff
changeset
|
1339 the search string. When the search phrase already has a non-word-char |
489a5439b988
* reftex.el (reftex-compile-variables): respect new structure of
Carsten Dominik <dominik@science.uva.nl>
parents:
25804
diff
changeset
|
1340 at one of these points, no word boundary is required there." |
489a5439b988
* reftex.el (reftex-compile-variables): respect new structure of
Carsten Dominik <dominik@science.uva.nl>
parents:
25804
diff
changeset
|
1341 :group 'reftex-index-support |
489a5439b988
* reftex.el (reftex-compile-variables): respect new structure of
Carsten Dominik <dominik@science.uva.nl>
parents:
25804
diff
changeset
|
1342 :type 'boolean) |
489a5439b988
* reftex.el (reftex-compile-variables): respect new structure of
Carsten Dominik <dominik@science.uva.nl>
parents:
25804
diff
changeset
|
1343 |
489a5439b988
* reftex.el (reftex-compile-variables): respect new structure of
Carsten Dominik <dominik@science.uva.nl>
parents:
25804
diff
changeset
|
1344 (defcustom reftex-index-phrases-case-fold-search t |
489a5439b988
* reftex.el (reftex-compile-variables): respect new structure of
Carsten Dominik <dominik@science.uva.nl>
parents:
25804
diff
changeset
|
1345 "*Non-nil means, searching for index phrases will ignore case." |
489a5439b988
* reftex.el (reftex-compile-variables): respect new structure of
Carsten Dominik <dominik@science.uva.nl>
parents:
25804
diff
changeset
|
1346 :group 'reftex-index-support |
489a5439b988
* reftex.el (reftex-compile-variables): respect new structure of
Carsten Dominik <dominik@science.uva.nl>
parents:
25804
diff
changeset
|
1347 :type 'boolean) |
489a5439b988
* reftex.el (reftex-compile-variables): respect new structure of
Carsten Dominik <dominik@science.uva.nl>
parents:
25804
diff
changeset
|
1348 |
46612
7522419c4db0
Updated to reftex 4.17
Carsten Dominik <dominik@science.uva.nl>
parents:
46155
diff
changeset
|
1349 (defcustom reftex-index-verify-function nil |
7522419c4db0
Updated to reftex 4.17
Carsten Dominik <dominik@science.uva.nl>
parents:
46155
diff
changeset
|
1350 "A function which is called at each match during global indexing. |
7522419c4db0
Updated to reftex 4.17
Carsten Dominik <dominik@science.uva.nl>
parents:
46155
diff
changeset
|
1351 If the function returns nil, the current match is skipped." |
7522419c4db0
Updated to reftex 4.17
Carsten Dominik <dominik@science.uva.nl>
parents:
46155
diff
changeset
|
1352 :group 'reftex-index-support |
7522419c4db0
Updated to reftex 4.17
Carsten Dominik <dominik@science.uva.nl>
parents:
46155
diff
changeset
|
1353 :type '(choice |
52170
27340819ef07
Updated to version 4.21
Carsten Dominik <dominik@science.uva.nl>
parents:
49599
diff
changeset
|
1354 (const :tag "No verification" nil) |
27340819ef07
Updated to version 4.21
Carsten Dominik <dominik@science.uva.nl>
parents:
49599
diff
changeset
|
1355 (function))) |
46612
7522419c4db0
Updated to reftex 4.17
Carsten Dominik <dominik@science.uva.nl>
parents:
46155
diff
changeset
|
1356 |
26910
489a5439b988
* reftex.el (reftex-compile-variables): respect new structure of
Carsten Dominik <dominik@science.uva.nl>
parents:
25804
diff
changeset
|
1357 (defcustom reftex-index-phrases-skip-indexed-matches nil |
489a5439b988
* reftex.el (reftex-compile-variables): respect new structure of
Carsten Dominik <dominik@science.uva.nl>
parents:
25804
diff
changeset
|
1358 "*Non-nil means, skip matches which appear to be indexed already. |
489a5439b988
* reftex.el (reftex-compile-variables): respect new structure of
Carsten Dominik <dominik@science.uva.nl>
parents:
25804
diff
changeset
|
1359 When doing global indexing from the phrases buffer, searches for some |
489a5439b988
* reftex.el (reftex-compile-variables): respect new structure of
Carsten Dominik <dominik@science.uva.nl>
parents:
25804
diff
changeset
|
1360 phrases may match at places where that phrase was already indexed. In |
489a5439b988
* reftex.el (reftex-compile-variables): respect new structure of
Carsten Dominik <dominik@science.uva.nl>
parents:
25804
diff
changeset
|
1361 particular when indexing an already processed document again, this |
489a5439b988
* reftex.el (reftex-compile-variables): respect new structure of
Carsten Dominik <dominik@science.uva.nl>
parents:
25804
diff
changeset
|
1362 will even be the norm. When this variable is non-nil, RefTeX checks if |
52170
27340819ef07
Updated to version 4.21
Carsten Dominik <dominik@science.uva.nl>
parents:
49599
diff
changeset
|
1363 the match is inside an index macro argument, or if an index macro is directly |
26910
489a5439b988
* reftex.el (reftex-compile-variables): respect new structure of
Carsten Dominik <dominik@science.uva.nl>
parents:
25804
diff
changeset
|
1364 before or after the phrase. If that is the case, that match will |
489a5439b988
* reftex.el (reftex-compile-variables): respect new structure of
Carsten Dominik <dominik@science.uva.nl>
parents:
25804
diff
changeset
|
1365 be ignored." |
489a5439b988
* reftex.el (reftex-compile-variables): respect new structure of
Carsten Dominik <dominik@science.uva.nl>
parents:
25804
diff
changeset
|
1366 :group 'reftex-index-support |
489a5439b988
* reftex.el (reftex-compile-variables): respect new structure of
Carsten Dominik <dominik@science.uva.nl>
parents:
25804
diff
changeset
|
1367 :type 'boolean) |
489a5439b988
* reftex.el (reftex-compile-variables): respect new structure of
Carsten Dominik <dominik@science.uva.nl>
parents:
25804
diff
changeset
|
1368 |
489a5439b988
* reftex.el (reftex-compile-variables): respect new structure of
Carsten Dominik <dominik@science.uva.nl>
parents:
25804
diff
changeset
|
1369 (defcustom reftex-index-phrases-wrap-long-lines nil |
489a5439b988
* reftex.el (reftex-compile-variables): respect new structure of
Carsten Dominik <dominik@science.uva.nl>
parents:
25804
diff
changeset
|
1370 "*Non-nil means, when indexing from the phrases buffer, wrap lines. |
489a5439b988
* reftex.el (reftex-compile-variables): respect new structure of
Carsten Dominik <dominik@science.uva.nl>
parents:
25804
diff
changeset
|
1371 Inserting indexing commands in a line makes the line longer - often |
489a5439b988
* reftex.el (reftex-compile-variables): respect new structure of
Carsten Dominik <dominik@science.uva.nl>
parents:
25804
diff
changeset
|
1372 so long that it does not fit onto the screen. When this variable is |
489a5439b988
* reftex.el (reftex-compile-variables): respect new structure of
Carsten Dominik <dominik@science.uva.nl>
parents:
25804
diff
changeset
|
1373 non-nil, newlines will be added as necessary before and/or after the |
489a5439b988
* reftex.el (reftex-compile-variables): respect new structure of
Carsten Dominik <dominik@science.uva.nl>
parents:
25804
diff
changeset
|
1374 indexing command to keep lines short. However, the matched text |
489a5439b988
* reftex.el (reftex-compile-variables): respect new structure of
Carsten Dominik <dominik@science.uva.nl>
parents:
25804
diff
changeset
|
1375 phrase and its index command will always end up on a single line.") |
489a5439b988
* reftex.el (reftex-compile-variables): respect new structure of
Carsten Dominik <dominik@science.uva.nl>
parents:
25804
diff
changeset
|
1376 |
489a5439b988
* reftex.el (reftex-compile-variables): respect new structure of
Carsten Dominik <dominik@science.uva.nl>
parents:
25804
diff
changeset
|
1377 (defcustom reftex-index-phrases-sort-prefers-entry nil |
489a5439b988
* reftex.el (reftex-compile-variables): respect new structure of
Carsten Dominik <dominik@science.uva.nl>
parents:
25804
diff
changeset
|
1378 "*Non-nil means when sorting phrase lines, the explicit index entry is used. |
489a5439b988
* reftex.el (reftex-compile-variables): respect new structure of
Carsten Dominik <dominik@science.uva.nl>
parents:
25804
diff
changeset
|
1379 Phrase lines in the phrases buffer contain a search phrase, and |
489a5439b988
* reftex.el (reftex-compile-variables): respect new structure of
Carsten Dominik <dominik@science.uva.nl>
parents:
25804
diff
changeset
|
1380 sorting is normally based on these. Some phrase lines also have |
489a5439b988
* reftex.el (reftex-compile-variables): respect new structure of
Carsten Dominik <dominik@science.uva.nl>
parents:
25804
diff
changeset
|
1381 an explicit index argument specified. When this variable is non-nil, |
489a5439b988
* reftex.el (reftex-compile-variables): respect new structure of
Carsten Dominik <dominik@science.uva.nl>
parents:
25804
diff
changeset
|
1382 the index argument will be used for sorting." |
489a5439b988
* reftex.el (reftex-compile-variables): respect new structure of
Carsten Dominik <dominik@science.uva.nl>
parents:
25804
diff
changeset
|
1383 :group 'reftex-index-support |
489a5439b988
* reftex.el (reftex-compile-variables): respect new structure of
Carsten Dominik <dominik@science.uva.nl>
parents:
25804
diff
changeset
|
1384 :type 'boolean) |
489a5439b988
* reftex.el (reftex-compile-variables): respect new structure of
Carsten Dominik <dominik@science.uva.nl>
parents:
25804
diff
changeset
|
1385 |
489a5439b988
* reftex.el (reftex-compile-variables): respect new structure of
Carsten Dominik <dominik@science.uva.nl>
parents:
25804
diff
changeset
|
1386 (defcustom reftex-index-phrases-sort-in-blocks t |
489a5439b988
* reftex.el (reftex-compile-variables): respect new structure of
Carsten Dominik <dominik@science.uva.nl>
parents:
25804
diff
changeset
|
1387 "*Non-nil means, empty and comment lines separate phrase buffer into blocks. |
489a5439b988
* reftex.el (reftex-compile-variables): respect new structure of
Carsten Dominik <dominik@science.uva.nl>
parents:
25804
diff
changeset
|
1388 Sorting will then preserve blocks, so that lines are re-arranged only |
489a5439b988
* reftex.el (reftex-compile-variables): respect new structure of
Carsten Dominik <dominik@science.uva.nl>
parents:
25804
diff
changeset
|
1389 within blocks." |
489a5439b988
* reftex.el (reftex-compile-variables): respect new structure of
Carsten Dominik <dominik@science.uva.nl>
parents:
25804
diff
changeset
|
1390 :group 'reftex-index-support |
489a5439b988
* reftex.el (reftex-compile-variables): respect new structure of
Carsten Dominik <dominik@science.uva.nl>
parents:
25804
diff
changeset
|
1391 :type 'boolean) |
489a5439b988
* reftex.el (reftex-compile-variables): respect new structure of
Carsten Dominik <dominik@science.uva.nl>
parents:
25804
diff
changeset
|
1392 |
25280 | 1393 (defcustom reftex-index-section-letters "ABCDEFGHIJKLMNOPQRSTUVWXYZ" |
1394 "The letters which denote sections in the index. | |
1395 Usually these are all capital letters. Don't use any downcase letters. | |
1396 Order is not significant, the index will be sorted by whatever the sort | |
1397 function thinks is correct. | |
1398 In addition to these letters, RefTeX will create a group `!' which | |
1399 contains all entries sorted below the lowest specified letter. | |
1400 In the index buffer, pressing any of these capital letters or `!' will jump | |
1401 to that section." | |
1402 :group 'reftex-index-support | |
1403 :type '(string :tag "Capital letters")) | |
1404 | |
1405 (defcustom reftex-index-include-context nil | |
1406 "*Non-nil means, display the index definition context in the index buffer. | |
52170
27340819ef07
Updated to version 4.21
Carsten Dominik <dominik@science.uva.nl>
parents:
49599
diff
changeset
|
1407 This flag may also be toggled from the index buffer with the `c' key." |
25280 | 1408 :group 'reftex-index-support |
1409 :type 'boolean) | |
1410 | |
1411 (defcustom reftex-index-follow-mode nil | |
1412 "*Non-nil means, point in *Index* buffer will cause other window to follow. | |
1413 The other window will show the corresponding part of the document. | |
1414 This flag can be toggled from within the *Index* buffer with the `f' key." | |
1415 :group 'reftex-table-of-contents-browser | |
1416 :type 'boolean) | |
1417 | |
1418 ;; Viewing Cross References | |
1419 | |
1420 (defgroup reftex-viewing-cross-references nil | |
1421 "Displaying cross references and citations." | |
1422 :group 'reftex) | |
1423 | |
1424 (defcustom reftex-view-crossref-extra nil | |
1425 "Macros which can be used for the display of cross references. | |
1426 This is used when `reftex-view-crossref' is called with point in an | |
1427 argument of a macro. Note that crossref viewing for citations, | |
1428 references (both ways) and index entries is hard-coded. This variable | |
1429 is only to configure additional structures for which crossreference | |
52170
27340819ef07
Updated to version 4.21
Carsten Dominik <dominik@science.uva.nl>
parents:
49599
diff
changeset
|
1430 viewing can be useful. Each entry has the structure |
25280 | 1431 |
52170
27340819ef07
Updated to version 4.21
Carsten Dominik <dominik@science.uva.nl>
parents:
49599
diff
changeset
|
1432 \(MACRO-RE SEARCH-RE HIGHLIGHT). |
25280 | 1433 |
1434 MACRO-RE is matched against the macro. SEARCH-RE is the regexp used | |
1435 to search for cross references. `%s' in this regexp is replaced with | |
1436 with the macro argument at point. HIGHLIGHT is an integer indicating | |
1437 which subgroup of the match should be highlighted." | |
1438 :group 'reftex-viewing-cross-references | |
1439 :type '(repeat (group (regexp :tag "Macro Regexp ") | |
52170
27340819ef07
Updated to version 4.21
Carsten Dominik <dominik@science.uva.nl>
parents:
49599
diff
changeset
|
1440 (string :tag "Search Regexp ") |
27340819ef07
Updated to version 4.21
Carsten Dominik <dominik@science.uva.nl>
parents:
49599
diff
changeset
|
1441 (integer :tag "Highlight Group")))) |
25280 | 1442 |
1443 (defcustom reftex-auto-view-crossref t | |
1444 "*Non-nil means, initially turn automatic viewing of crossref info on. | |
1445 Automatic viewing of crossref info normally uses the echo area. | |
47050
904fd28be439
Update to RefTeX 4.19
Carsten Dominik <dominik@science.uva.nl>
parents:
46683
diff
changeset
|
1446 Whenever point is idle for more than `reftex-idle-time' seconds on the |
904fd28be439
Update to RefTeX 4.19
Carsten Dominik <dominik@science.uva.nl>
parents:
46683
diff
changeset
|
1447 argument of a \\ref or \\cite macro, and no other message is being |
904fd28be439
Update to RefTeX 4.19
Carsten Dominik <dominik@science.uva.nl>
parents:
46683
diff
changeset
|
1448 displayed, the echo area will display information about that cross |
904fd28be439
Update to RefTeX 4.19
Carsten Dominik <dominik@science.uva.nl>
parents:
46683
diff
changeset
|
1449 reference. You can also set the variable to the symbol `window'. In |
904fd28be439
Update to RefTeX 4.19
Carsten Dominik <dominik@science.uva.nl>
parents:
46683
diff
changeset
|
1450 this case a small temporary window is used for the display. |
52170
27340819ef07
Updated to version 4.21
Carsten Dominik <dominik@science.uva.nl>
parents:
49599
diff
changeset
|
1451 This feature can be turned on and off from the menu |
27340819ef07
Updated to version 4.21
Carsten Dominik <dominik@science.uva.nl>
parents:
49599
diff
changeset
|
1452 \(Ref->Options)." |
25280 | 1453 :group 'reftex-viewing-cross-references |
1454 :type '(choice (const :tag "off" nil) | |
52170
27340819ef07
Updated to version 4.21
Carsten Dominik <dominik@science.uva.nl>
parents:
49599
diff
changeset
|
1455 (const :tag "in Echo Area" t) |
27340819ef07
Updated to version 4.21
Carsten Dominik <dominik@science.uva.nl>
parents:
49599
diff
changeset
|
1456 (const :tag "in Other Window" window))) |
25280 | 1457 |
1458 (defcustom reftex-idle-time 1.2 | |
47050
904fd28be439
Update to RefTeX 4.19
Carsten Dominik <dominik@science.uva.nl>
parents:
46683
diff
changeset
|
1459 "*Time (secs) Emacs has to be idle before automatic crossref display is done. |
904fd28be439
Update to RefTeX 4.19
Carsten Dominik <dominik@science.uva.nl>
parents:
46683
diff
changeset
|
1460 Applies also to toc recentering." |
25280 | 1461 :group 'reftex-viewing-cross-references |
1462 :type 'number) | |
1463 | |
1464 (defcustom reftex-revisit-to-echo nil | |
1465 "*Non-nil means, automatic citation display will revisit files if necessary. | |
1466 When nil, citation display in echo area will only be active for cached | |
1467 entries and for BibTeX database files with live associated buffers." | |
1468 :group 'reftex-viewing-cross-references | |
1469 :type 'boolean) | |
1470 | |
1471 (defcustom reftex-cache-cite-echo t | |
1472 "*Non-nil means, the information displayed in the echo area for cite macros | |
1473 is cached and even saved along with the parsing information. The cache | |
1474 survives document scans. In order to clear it, use M-x reftex-reset-mode." | |
1475 :group 'reftex-viewing-cross-references | |
1476 :type 'boolean) | |
1477 | |
1478 (defcustom reftex-display-copied-context-hook nil | |
1479 "Normal Hook which is run before context is displayed anywhere. Designed | |
1480 for X-Symbol, but may have other uses as well." | |
1481 :group 'reftex-viewing-cross-references | |
1482 :group 'reftex-referencing-labels | |
1483 :type 'hook) | |
1484 | |
1485 ;; Finding Files -------------------------------------------------------- | |
1486 | |
1487 (defgroup reftex-finding-files nil | |
1488 "Finding files on search paths." | |
1489 :group 'reftex) | |
1490 | |
1491 (defcustom reftex-texpath-environment-variables '("TEXINPUTS") | |
1492 "*List of specifications how to retrieve the search path for TeX files. | |
1493 Several entries are possible. | |
1494 - If an element is the name of an environment variable, its content is used. | |
1495 - If an element starts with an exclamation mark, it is used as a command | |
1496 to retrieve the path. A typical command with the kpathsearch library would | |
52170
27340819ef07
Updated to version 4.21
Carsten Dominik <dominik@science.uva.nl>
parents:
49599
diff
changeset
|
1497 be `!kpsewhich -show-path=.tex'. |
25280 | 1498 - Otherwise the element itself is interpreted as a path. |
1499 Multiple directories can be separated by the system dependent `path-separator'. | |
1500 Directories ending in `//' or `!!' will be expanded recursively. | |
1501 See also `reftex-use-external-file-finders'." | |
1502 :group 'reftex-finding-files | |
1503 :set 'reftex-set-dirty | |
1504 :type '(repeat (string :tag "Specification"))) | |
1505 | |
1506 (defcustom reftex-bibpath-environment-variables '("BIBINPUTS" "TEXBIB") | |
1507 "*List of specifications how to retrieve search path for .bib database files. | |
1508 Several entries are possible. | |
1509 - If an element is the name of an environment variable, its content is used. | |
1510 - If an element starts with an exclamation mark, it is used as a command | |
1511 to retrieve the path. A typical command with the kpathsearch library would | |
52170
27340819ef07
Updated to version 4.21
Carsten Dominik <dominik@science.uva.nl>
parents:
49599
diff
changeset
|
1512 be `!kpsewhich -show-path=.bib'. |
25280 | 1513 - Otherwise the element itself is interpreted as a path. |
1514 Multiple directories can be separated by the system dependent `path-separator'. | |
1515 Directories ending in `//' or `!!' will be expanded recursively. | |
1516 See also `reftex-use-external-file-finders'." | |
1517 :group 'reftex-citation-support | |
1518 :group 'reftex-finding-files | |
1519 :set 'reftex-set-dirty | |
1520 :type '(repeat (string :tag "Specification"))) | |
1521 | |
1522 (defcustom reftex-file-extensions '(("tex" . (".tex" ".ltx")) | |
52170
27340819ef07
Updated to version 4.21
Carsten Dominik <dominik@science.uva.nl>
parents:
49599
diff
changeset
|
1523 ("bib" . (".bib"))) |
25280 | 1524 "*Association list with file extensions for different file types. |
1525 This is a list of items, each item is like: (TYPE . (DEF-EXT OTHER-EXT ...)) | |
1526 | |
1527 TYPE: File type like \"bib\" or \"tex\". | |
1528 DEF-EXT: The default extension for that file type, like \".tex\" or \".bib\". | |
1529 OTHER-EXT: Any number of other legal extensions for this file type. | |
1530 | |
1531 When a files is searched and it does not have any of the legal extensions, | |
37998
706af946b1e7
* reftex-ref.el (reftex-select-label-help): Added "z" key
Carsten Dominik <dominik@science.uva.nl>
parents:
34402
diff
changeset
|
1532 we try the default extension first, and then the naked file name. |
706af946b1e7
* reftex-ref.el (reftex-select-label-help): Added "z" key
Carsten Dominik <dominik@science.uva.nl>
parents:
34402
diff
changeset
|
1533 |
706af946b1e7
* reftex-ref.el (reftex-select-label-help): Added "z" key
Carsten Dominik <dominik@science.uva.nl>
parents:
34402
diff
changeset
|
1534 If you are using AUCTeX, you also need to add new extensions to |
706af946b1e7
* reftex-ref.el (reftex-select-label-help): Added "z" key
Carsten Dominik <dominik@science.uva.nl>
parents:
34402
diff
changeset
|
1535 TeX-file-extensions." |
25280 | 1536 :group 'reftex-finding-files |
1537 :type '(repeat (cons (string :tag "File type") | |
52170
27340819ef07
Updated to version 4.21
Carsten Dominik <dominik@science.uva.nl>
parents:
49599
diff
changeset
|
1538 (repeat (string :tag "Extension"))))) |
25280 | 1539 |
1540 (defcustom reftex-search-unrecursed-path-first t | |
1541 "*Non-nil means, search all specified directories before trying recursion. | |
1542 Thus, in a path \".//:/tex/\", search first \"./\", then \"/tex/\" and then | |
1543 all subdirectories of \"./\". If this option is nil, the subdirectories of | |
1544 \"./\" are searched before \"/tex/\". This is mainly for speed - most of the | |
1545 time the recursive path is for the system files and not for the user files. | |
1546 Set this to nil if the default makes RefTeX finding files with equal names | |
1547 in wrong sequence." | |
1548 :group 'reftex-finding-files | |
1549 :type 'boolean) | |
1550 | |
1551 (defcustom reftex-use-external-file-finders nil | |
1552 "*Non-nil means, use external programs to find files. | |
1553 Normally, RefTeX searches the paths given in the environment variables | |
1554 TEXINPUTS and BIBINPUTS to find TeX files and BibTeX database files. | |
1555 With this option turned on, it calls an external program specified in the | |
1556 option `reftex-external-file-finders' instead. As a side effect, | |
52170
27340819ef07
Updated to version 4.21
Carsten Dominik <dominik@science.uva.nl>
parents:
49599
diff
changeset
|
1557 the variables `reftex-texpath-environment-variables' and |
25280 | 1558 `reftex-bibpath-environment-variables' will be ignored." |
1559 :group 'reftex-finding-files | |
1560 :type 'boolean) | |
1561 | |
1562 (defcustom reftex-external-file-finders '(("tex" . "kpsewhich -format=.tex %f") | |
52170
27340819ef07
Updated to version 4.21
Carsten Dominik <dominik@science.uva.nl>
parents:
49599
diff
changeset
|
1563 ("bib" . "kpsewhich -format=.bib %f")) |
25280 | 1564 "*Association list with external programs to call for finding files. |
1565 Each entry is a cons cell (TYPE . PROGRAM). | |
1566 TYPE is either \"tex\" or \"bib\". PROGRAM is the external program to use with | |
1567 any arguments. %f will be replaced by the name of the file to be found. | |
1568 Note that these commands will be executed directly, not via a shell. | |
1569 Only relevant when `reftex-use-external-file-finders' is non-nil." | |
1570 :group 'reftex-finding-files | |
1571 :type '(repeat (cons (string :tag "File type") | |
52170
27340819ef07
Updated to version 4.21
Carsten Dominik <dominik@science.uva.nl>
parents:
49599
diff
changeset
|
1572 (string :tag "Program ")))) |
25280 | 1573 |
1574 ;; Tuning the parser ---------------------------------------------------- | |
1575 | |
1576 (defgroup reftex-optimizations-for-large-documents nil | |
1577 "Configuration of parser speed and memory usage." | |
1578 :group 'reftex) | |
1579 | |
1580 (defcustom reftex-keep-temporary-buffers 1 | |
1581 "*Non-nil means, keep buffers created for parsing and lookup. | |
1582 RefTeX sometimes needs to visit files related to the current document. | |
1583 We distinguish files visited for | |
1584 PARSING: Parts of a multifile document loaded when (re)-parsing the document. | |
1585 LOOKUP: BibTeX database files and TeX files loaded to find a reference, | |
1586 to display label context, etc. | |
1587 The created buffers can be kept for later use, or be thrown away immediately | |
1588 after use, depending on the value of this variable: | |
1589 | |
1590 nil Throw away as much as possible. | |
1591 t Keep everything. | |
1592 1 Throw away buffers created for parsing, but keep the ones created | |
1593 for lookup. | |
1594 | |
1595 If a buffer is to be kept, the file is visited normally (which is potentially | |
1596 slow but will happen only once). | |
1597 If a buffer is to be thrown away, the initialization of the buffer depends | |
1598 upon the variable `reftex-initialize-temporary-buffers'." | |
1599 :group 'reftex-optimizations-for-large-documents | |
1600 :type '(choice | |
1601 (const :tag "Throw away everything" nil) | |
1602 (const :tag "Keep everything" t) | |
1603 (const :tag "Keep lookup buffers only" 1))) | |
1604 | |
1605 (defcustom reftex-initialize-temporary-buffers nil | |
1606 "*Non-nil means do initializations even when visiting file temporarily. | |
1607 When nil, RefTeX may turn off find-file hooks and other stuff to briefly | |
1608 visit a file. | |
1609 When t, the full default initializations are done (find-file-hook etc.). | |
1610 Instead of t or nil, this variable may also be a list of hook functions to | |
1611 do a minimal initialization." | |
1612 :group 'reftex-optimizations-for-large-documents | |
1613 :type '(choice | |
1614 (const :tag "Read files literally" nil) | |
1615 (const :tag "Fully initialize buffers" t) | |
1616 (repeat :tag "Hook functions" :value (nil) | |
1617 (function-item)))) | |
1618 | |
1619 (defcustom reftex-no-include-regexps '("\\.pstex_t\\'") | |
1620 "*List of regular expressions to exclude certain input files from parsing. | |
1621 If the name of a file included via \\include or \\input is matched by any | |
1622 of the regular expressions in this list, that file is not parsed by RefTeX." | |
1623 :group 'reftex-optimizations-for-large-documents | |
1624 :type '(repeat (regexp))) | |
1625 | |
1626 (defcustom reftex-enable-partial-scans nil | |
1627 "*Non-nil means, re-parse only 1 file when asked to re-parse. | |
1628 Re-parsing is normally requested with a `C-u' prefix to many RefTeX commands, | |
1629 or with the `r' key in menus. When this option is t in a multifile document, | |
1630 we will only parse the current buffer, or the file associated with the label | |
1631 or section heading near point in a menu. Requesting re-parsing of an entire | |
1632 multifile document then requires a `C-u C-u' prefix or the capital `R' key | |
1633 in menus." | |
1634 :group 'reftex-optimizations-for-large-documents | |
1635 :type 'boolean) | |
1636 | |
1637 (defcustom reftex-allow-automatic-rescan t | |
1638 "*Non-nil means, RefTeX may rescan the document when this seems necessary. | |
1639 Currently this applies only to rescanning after label insertion, when | |
1640 the new label cannot be inserted correctly into the internal label | |
1641 list." | |
1642 :group 'reftex-optimizations-for-large-documents | |
1643 :type 'boolean) | |
1644 | |
1645 (defcustom reftex-save-parse-info nil | |
1646 "*Non-nil means, save information gathered with parsing in a file. | |
1647 The file MASTER.rel in the same directory as MASTER.tex is used to save the | |
52170
27340819ef07
Updated to version 4.21
Carsten Dominik <dominik@science.uva.nl>
parents:
49599
diff
changeset
|
1648 information. When this variable is t, |
25280 | 1649 - accessing the parsing information for the first time in an editing session |
1650 will read that file (if available) instead of parsing the document. | |
1651 - exiting Emacs or killing a buffer in reftex-mode will cause a new version | |
1652 of the file to be written." | |
1653 :group 'reftex-optimizations-for-large-documents | |
1654 :type 'boolean) | |
1655 | |
27192
f70a80cecdd3
New version number.
Carsten Dominik <dominik@science.uva.nl>
parents:
27035
diff
changeset
|
1656 (defcustom reftex-parse-file-extension ".rel" |
f70a80cecdd3
New version number.
Carsten Dominik <dominik@science.uva.nl>
parents:
27035
diff
changeset
|
1657 "*File extension for the file in which parser information is stored. |
f70a80cecdd3
New version number.
Carsten Dominik <dominik@science.uva.nl>
parents:
27035
diff
changeset
|
1658 This extension is added to the base name of the master file." |
f70a80cecdd3
New version number.
Carsten Dominik <dominik@science.uva.nl>
parents:
27035
diff
changeset
|
1659 :group 'reftex-optimizations-for-large-documents |
f70a80cecdd3
New version number.
Carsten Dominik <dominik@science.uva.nl>
parents:
27035
diff
changeset
|
1660 :type 'string) |
f70a80cecdd3
New version number.
Carsten Dominik <dominik@science.uva.nl>
parents:
27035
diff
changeset
|
1661 |
25280 | 1662 (defcustom reftex-use-multiple-selection-buffers nil |
1663 "*Non-nil means use a separate selection buffer for each label type. | |
1664 These buffers are kept from one selection to the next and need not to be | |
1665 created for each use - so the menu generally comes up faster. The | |
1666 selection buffers will be erased (and therefore updated) automatically | |
1667 when new labels in its category are added. See the variable | |
1668 `reftex-auto-update-selection-buffers'." | |
1669 :group 'reftex-optimizations-for-large-documents | |
1670 :group 'reftex-referencing-labels | |
1671 :type 'boolean) | |
1672 | |
1673 (defcustom reftex-auto-update-selection-buffers t | |
1674 "*Non-nil means, selection buffers will be updated automatically. | |
1675 When a new label is defined with `reftex-label', all selection buffers | |
1676 associated with that label category are emptied, in order to force an | |
1677 update upon next use. When nil, the buffers are left alone and have to be | |
1678 updated by hand, with the `g' key from the label selection process. | |
1679 The value of this variable will only have any effect when | |
1680 `reftex-use-multiple-selection-buffers' is non-nil." | |
1681 :group 'reftex-optimizations-for-large-documents | |
1682 :group 'reftex-referencing-labels | |
1683 :type 'boolean) | |
1684 | |
1685 ;; Fontification and Faces ---------------------------------------------- | |
1686 | |
1687 (defgroup reftex-fontification-configurations nil | |
1688 "Options concerning the faces used in RefTeX." | |
1689 :group 'reftex) | |
1690 | |
1691 (defcustom reftex-use-fonts t | |
1692 "*Non-nil means, use fonts in *toc* and selection buffers. | |
1693 Font-lock must be loaded as well to actually get fontified display. | |
1694 When changing this option, a rescan may be necessary to activate the change." | |
1695 :group 'reftex-fontification-configurations | |
1696 :type 'boolean) | |
1697 | |
1698 (defcustom reftex-refontify-context 1 | |
1699 "*Non-nil means, re-fontify the context in the label menu with font-lock. | |
1700 This slightly slows down the creation of the label menu. It is only necessary | |
1701 when you definitely want the context fontified. | |
1702 | |
1703 This option may have 3 different values: | |
1704 nil Never refontify. | |
1705 t Always refontify. | |
1706 1 Refontify when absolutely necessary, e.g. when old versions of X-Symbol. | |
1707 The option is ignored when `reftex-use-fonts' is nil." | |
1708 :group 'reftex-fontification-configurations | |
1709 :group 'reftex-referencing-labels | |
1710 :type '(choice | |
1711 (const :tag "Never" nil) | |
1712 (const :tag "Always" t) | |
1713 (const :tag "When necessary" 1))) | |
1714 | |
1715 (defcustom reftex-highlight-selection 'cursor | |
1716 "*Non-nil mean, highlight selected text in selection and *toc* buffers. | |
1717 Normally, the text near the cursor is the selected text, and it is | |
1718 highlighted. This is the entry most keys in the selction and *toc* | |
1719 buffers act on. However, if you mainly use the mouse to select an | |
1720 item, you may find it nice to have mouse-triggered highlighting | |
1721 instead or as well. The variable may have one of these values: | |
1722 | |
1723 nil No highlighting. | |
1724 cursor Highlighting is cursor driven. | |
1725 mouse Highlighting is mouse driven. | |
1726 both Both cursor and mouse trigger highlighting. | |
1727 | |
1728 Changing this variable requires to rebuild the selection and *toc* buffers | |
1729 to become effective (keys `g' or `r')." | |
1730 :group 'reftex-fontification-configurations | |
1731 :type '(choice | |
52170
27340819ef07
Updated to version 4.21
Carsten Dominik <dominik@science.uva.nl>
parents:
49599
diff
changeset
|
1732 (const :tag "Never" nil) |
27340819ef07
Updated to version 4.21
Carsten Dominik <dominik@science.uva.nl>
parents:
49599
diff
changeset
|
1733 (const :tag "Cursor driven" cursor) |
27340819ef07
Updated to version 4.21
Carsten Dominik <dominik@science.uva.nl>
parents:
49599
diff
changeset
|
1734 (const :tag "Mouse driven" mouse) |
27340819ef07
Updated to version 4.21
Carsten Dominik <dominik@science.uva.nl>
parents:
49599
diff
changeset
|
1735 (const :tag "Mouse and Cursor driven." both))) |
25280 | 1736 |
1737 (defcustom reftex-cursor-selected-face 'highlight | |
1738 "Face name to highlight cursor selected item in toc and selection buffers. | |
1739 See also the variable `reftex-highlight-selection'." | |
1740 :group 'reftex-fontification-configurations | |
1741 :type 'symbol) | |
1742 (defcustom reftex-mouse-selected-face 'secondary-selection | |
1743 "Face name to highlight mouse selected item in toc and selection buffers. | |
1744 See also the variable `reftex-highlight-selection'." | |
1745 :group 'reftex-fontification-configurations | |
1746 :type 'symbol) | |
1747 (defcustom reftex-file-boundary-face 'font-lock-comment-face | |
1748 "Face name for file boundaries in selection buffer." | |
1749 :group 'reftex-fontification-configurations | |
1750 :type 'symbol) | |
1751 (defcustom reftex-label-face 'font-lock-constant-face | |
1752 "Face name for labels in selection buffer." | |
1753 :group 'reftex-fontification-configurations | |
1754 :type 'symbol) | |
1755 (defcustom reftex-section-heading-face 'font-lock-function-name-face | |
1756 "Face name for section headings in toc and selection buffers." | |
1757 :group 'reftex-fontification-configurations | |
1758 :type 'symbol) | |
1759 (defcustom reftex-toc-header-face 'font-lock-comment-face | |
1760 "Face name for the header of a toc buffer." | |
1761 :group 'reftex-fontification-configurations | |
1762 :type 'symbol) | |
1763 (defcustom reftex-bib-author-face 'font-lock-keyword-face | |
1764 "Face name for author names in bib selection buffer." | |
1765 :group 'reftex-fontification-configurations | |
1766 :type 'symbol) | |
1767 (defcustom reftex-bib-year-face 'font-lock-comment-face | |
1768 "Face name for year in bib selection buffer." | |
1769 :group 'reftex-fontification-configurations | |
1770 :type 'symbol) | |
1771 (defcustom reftex-bib-title-face 'font-lock-function-name-face | |
1772 "Face name for article title in bib selection buffer." | |
1773 :group 'reftex-fontification-configurations | |
1774 :type 'symbol) | |
1775 (defcustom reftex-bib-extra-face 'font-lock-comment-face | |
1776 "Face name for bibliographic information in bib selection buffer." | |
1777 :group 'reftex-fontification-configurations | |
1778 :type 'symbol) | |
1779 (defcustom reftex-select-mark-face 'bold | |
1780 "Face name for marked entries in the selection buffers." | |
1781 :group 'reftex-fontification-configurations | |
1782 :type 'symbol) | |
1783 (defcustom reftex-index-header-face 'font-lock-comment-face | |
1784 "Face name for the header of an index buffer." | |
1785 :group 'reftex-fontification-configurations | |
1786 :type 'symbol) | |
1787 (defcustom reftex-index-section-face 'font-lock-function-name-face | |
1788 "Face name for the start of a new letter section in the index." | |
1789 :group 'reftex-fontification-configurations | |
1790 :type 'symbol) | |
1791 (defcustom reftex-index-tag-face 'font-lock-keyword-face | |
1792 "Face name for index names (for multiple indices)." | |
1793 :group 'reftex-fontification-configurations | |
1794 :type 'symbol) | |
1795 (defcustom reftex-index-face 'font-lock-constant-face | |
1796 "Face name for index entries." | |
1797 :group 'reftex-fontification-configurations | |
1798 :type 'symbol) | |
1799 | |
1800 (defcustom reftex-pre-refontification-functions nil | |
1801 "X-Symbol specific hook. | |
1802 Functions get two arguments, the buffer from where the command started and a | |
1803 symbol indicating in what context the hook is called." | |
1804 :group 'reftex-fontification-configurations | |
1805 :type 'hook) | |
1806 | |
1807 ;; Miscellaneous configurations ----------------------------------------- | |
1808 | |
1809 (defgroup reftex-miscellaneous-configurations nil | |
1810 "Collection of further configurations." | |
1811 :group 'reftex) | |
1812 | |
1813 (defcustom reftex-extra-bindings nil | |
1814 "Non-nil means, make additional key bindings on startup. | |
1815 These extra bindings are located in the users `C-c letter' map." | |
1816 :group 'reftex-miscellaneous-configurations | |
1817 :type 'boolean) | |
1818 | |
1819 (defcustom reftex-plug-into-AUCTeX nil | |
1820 "*Plug-in flags for AUCTeX interface. | |
1821 This variable is a list of 4 boolean flags. When a flag is non-nil, | |
1822 RefTeX will | |
1823 | |
1824 - supply labels in new sections and environments (flag 1) | |
1825 - supply arguments for macros like `\\label'. (flag 2) | |
1826 - supply arguments for macros like `\\ref'. (flag 3) | |
1827 - supply arguments for macros like `\\cite'. (flag 4) | |
1828 - supply arguments for macros like `\\index'. (flag 5) | |
1829 | |
1830 You may also set the variable itself to t or nil in order to turn all | |
1831 plug-ins on or off, respectively. | |
1832 \\<LaTeX-mode-map>Supplying labels in new sections and environments applies when creating | |
1833 sections with \\[LaTeX-section] and environments with \\[LaTeX-environment]. | |
1834 Supplying macro arguments applies when you insert such a macro interactively | |
1835 with \\[TeX-insert-macro]. | |
1836 See the AUCTeX documentation for more information. | |
1837 RefTeX uses `fset' to take over the function calls. Changing the variable | |
1838 may require a restart of Emacs in order to become effective." | |
1839 :group 'reftex-miscellaneous-configurations | |
1840 :group 'LaTeX | |
52170
27340819ef07
Updated to version 4.21
Carsten Dominik <dominik@science.uva.nl>
parents:
49599
diff
changeset
|
1841 :type '(choice |
27340819ef07
Updated to version 4.21
Carsten Dominik <dominik@science.uva.nl>
parents:
49599
diff
changeset
|
1842 (const :tag "No plug-ins" nil) |
27340819ef07
Updated to version 4.21
Carsten Dominik <dominik@science.uva.nl>
parents:
49599
diff
changeset
|
1843 (const :tag "All possible plug-ins" t) |
27340819ef07
Updated to version 4.21
Carsten Dominik <dominik@science.uva.nl>
parents:
49599
diff
changeset
|
1844 (list |
27340819ef07
Updated to version 4.21
Carsten Dominik <dominik@science.uva.nl>
parents:
49599
diff
changeset
|
1845 :tag "Individual choice" |
27340819ef07
Updated to version 4.21
Carsten Dominik <dominik@science.uva.nl>
parents:
49599
diff
changeset
|
1846 :value (t t t t t) |
27340819ef07
Updated to version 4.21
Carsten Dominik <dominik@science.uva.nl>
parents:
49599
diff
changeset
|
1847 (boolean :tag "supply label in new sections and environments") |
27340819ef07
Updated to version 4.21
Carsten Dominik <dominik@science.uva.nl>
parents:
49599
diff
changeset
|
1848 (boolean :tag "supply argument for macros like `\\label' ") |
27340819ef07
Updated to version 4.21
Carsten Dominik <dominik@science.uva.nl>
parents:
49599
diff
changeset
|
1849 (boolean :tag "supply argument for macros like `\\ref' ") |
27340819ef07
Updated to version 4.21
Carsten Dominik <dominik@science.uva.nl>
parents:
49599
diff
changeset
|
1850 (boolean :tag "supply argument for macros like `\\cite' ") |
27340819ef07
Updated to version 4.21
Carsten Dominik <dominik@science.uva.nl>
parents:
49599
diff
changeset
|
1851 (boolean :tag "supply argument for macros like `\\index' ") |
27340819ef07
Updated to version 4.21
Carsten Dominik <dominik@science.uva.nl>
parents:
49599
diff
changeset
|
1852 ))) |
25280 | 1853 |
1854 (defcustom reftex-allow-detached-macro-args nil | |
1855 "*Non-nil means, allow arguments of macros to be detached by whitespace. | |
1856 When this is t, `aaa' will be considered as argument of \\bb in the following | |
1857 construct: \\bbb [xxx] {aaa}." | |
1858 :group 'reftex-miscellaneous-configurations | |
1859 :type 'boolean) | |
1860 | |
1861 | |
1862 (defcustom reftex-load-hook nil | |
1863 "Hook which is being run when loading reftex.el." | |
1864 :group 'reftex-miscellaneous-configurations | |
1865 :type 'hook) | |
1866 | |
1867 (defcustom reftex-mode-hook nil | |
1868 "Hook which is being run when turning on RefTeX mode." | |
1869 :group 'reftex-miscellaneous-configurations | |
1870 :type 'hook) | |
1871 | |
52170
27340819ef07
Updated to version 4.21
Carsten Dominik <dominik@science.uva.nl>
parents:
49599
diff
changeset
|
1872 |
47898
c33a2b08adc7
Move reftex-set-dirty here from reftex.el.
Markus Rost <rost@math.uni-bielefeld.de>
parents:
47287
diff
changeset
|
1873 (provide 'reftex-vars) |
c33a2b08adc7
Move reftex-set-dirty here from reftex.el.
Markus Rost <rost@math.uni-bielefeld.de>
parents:
47287
diff
changeset
|
1874 |
52401 | 1875 ;;; arch-tag: 9591ea34-ef39-4431-90b7-c115eaf5e16f |
25280 | 1876 ;;; reftex-vars.el ends here |