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