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