1 |
;;; reftex-vars.el --- configuration variables for RefTeX |
;;; reftex-vars.el --- configuration variables for RefTeX |
2 |
;; Copyright (c) 1997, 1998, 1999, 2000 Free Software Foundation, Inc. |
;; Copyright (c) 1997, 1998, 1999, 2000 Free Software Foundation, Inc. |
3 |
|
|
4 |
;; Author: Carsten Dominik <dominik@strw.LeidenUniv.nl> |
;; Author: Carsten Dominik <dominik@science.uva.nl> |
5 |
;; Version: 4.16 |
;; Version: 4.18 |
6 |
|
|
7 |
;; This file is part of GNU Emacs. |
;; This file is part of GNU Emacs. |
8 |
|
|
26 |
;;; Code: |
;;; Code: |
27 |
|
|
28 |
(eval-when-compile (require 'cl)) |
(eval-when-compile (require 'cl)) |
29 |
(provide 'reftex-vars) |
(eval-and-compile |
30 |
|
(defun reftex-set-dirty (symbol value) |
31 |
|
(setq reftex-tables-dirty t) |
32 |
|
(set symbol value))) |
33 |
|
|
34 |
;; Define the two constants which are needed during compilation |
;; Define the two constants which are needed during compilation |
35 |
|
|
99 |
|
|
100 |
("enumerate" ?i "item:" "~\\ref{%s}" item |
("enumerate" ?i "item:" "~\\ref{%s}" item |
101 |
(regexp "items?" "Punkte?")) |
(regexp "items?" "Punkte?")) |
102 |
|
|
103 |
("equation" ?e "eq:" "~(\\ref{%s})" t |
("equation" ?e "eq:" "~(\\ref{%s})" t |
104 |
(regexp "equations?" "eqs?\\." "eqn\\." "Gleichung\\(en\\)?" "Gl\\.")) |
(regexp "equations?" "eqs?\\." "eqn\\." "Gleichung\\(en\\)?" "Gl\\.")) |
105 |
("eqnarray" ?e "eq:" nil eqnarray-like) |
("eqnarray" ?e "eq:" nil eqnarray-like) |
106 |
|
|
107 |
("figure" ?f "fig:" "~\\ref{%s}" caption |
("figure" ?f "fig:" "~\\ref{%s}" caption |
108 |
(regexp "figure?[sn]?" "figs?\\." "Abbildung\\(en\\)?" "Abb\\.")) |
(regexp "figure?[sn]?" "figs?\\." "Abbildung\\(en\\)?" "Abb\\.")) |
109 |
("figure*" ?f nil nil caption) |
("figure*" ?f nil nil caption) |
110 |
|
|
111 |
("table" ?t "tab:" "~\\ref{%s}" caption |
("table" ?t "tab:" "~\\ref{%s}" caption |
112 |
(regexp "tables?" "tab\\." "Tabellen?")) |
(regexp "tables?" "tab\\." "Tabellen?")) |
113 |
("table*" ?t nil nil caption) |
("table*" ?t nil nil caption) |
114 |
|
|
115 |
("\\footnote[]{}" ?n "fn:" "~\\ref{%s}" 2 |
("\\footnote[]{}" ?n "fn:" "~\\ref{%s}" 2 |
116 |
(regexp "footnotes?" "Fussnoten?")) |
(regexp "footnotes?" "Fussnoten?")) |
117 |
|
|
118 |
("any" ?\ " " "~\\ref{%s}" nil) |
("any" ?\ " " "~\\ref{%s}" nil) |
119 |
|
|
120 |
;; The label macro is hard coded, but it *could* be defined like this: |
;; The label macro is hard coded, but it *could* be defined like this: |
139 |
(?s . "\\citep[see][]{%l}") |
(?s . "\\citep[see][]{%l}") |
140 |
(?a . "\\citeauthor{%l}") |
(?a . "\\citeauthor{%l}") |
141 |
(?A . "\\citeauthor*{%l}") |
(?A . "\\citeauthor*{%l}") |
142 |
(?y . "\\citeyear{%l}"))) |
(?y . "\\citeyear{%l}") |
143 |
|
(?n . "\\nocite{%l}"))) |
144 |
(bibentry "The Bibentry package" |
(bibentry "The Bibentry package" |
145 |
"\\bibentry{%l}") |
"\\bibentry{%l}") |
146 |
(harvard "The Harvard package" |
(harvard "The Harvard package" |
178 |
`?t' should point to a textual citation (citation as a noun). |
`?t' should point to a textual citation (citation as a noun). |
179 |
`?p' should point to a parenthetical citation.") |
`?p' should point to a parenthetical citation.") |
180 |
|
|
181 |
(defconst reftex-index-macros-builtin |
(defconst reftex-index-macros-builtin |
182 |
'((default "Default \\index and \\glossary macros" |
'((default "Default \\index and \\glossary macros" |
183 |
(("\\index{*}" "idx" ?i "" nil t) |
(("\\index{*}" "idx" ?i "" nil t) |
184 |
("\\glossary{*}" "glo" ?g "" nil t))) |
("\\glossary{*}" "glo" ?g "" nil t))) |
190 |
(Index-Shortcut "index.sty with \\shortindexingon" |
(Index-Shortcut "index.sty with \\shortindexingon" |
191 |
(("\\index[]{*}" 1 ?i "" nil t) |
(("\\index[]{*}" 1 ?i "" nil t) |
192 |
("\\index*[]{*}" 1 ?I "" nil nil) |
("\\index*[]{*}" 1 ?I "" nil nil) |
193 |
("^[]{*}" 1 ?^ "" texmathp t) |
("^[]{*}" 1 ?^ "" texmathp t) |
194 |
("_[]{*}" 1 ?_ "" texmathp nil)))) |
("_[]{*}" 1 ?_ "" texmathp nil)))) |
195 |
"Builtin stuff for reftex-index-macros. |
"Builtin stuff for reftex-index-macros. |
196 |
Lower-case symbols correspond to a style file of the same name in the LaTeX |
Lower-case symbols correspond to a style file of the same name in the LaTeX |
202 |
(defgroup reftex nil |
(defgroup reftex nil |
203 |
"LaTeX label and citation support." |
"LaTeX label and citation support." |
204 |
:tag "RefTeX" |
:tag "RefTeX" |
205 |
:link '(url-link :tag "Home Page" |
:link '(url-link :tag "Home Page" |
206 |
"http://strw.leidenuniv.nl/~dominik/Tools/") |
"http://strw.leidenuniv.nl/~dominik/Tools/") |
207 |
:link '(emacs-commentary-link :tag "Commentary in reftex.el" "reftex.el") |
:link '(emacs-commentary-link :tag "Commentary in reftex.el" "reftex.el") |
208 |
:link '(custom-manual "(reftex)Top") |
:link '(custom-manual "(reftex)Top") |
209 |
:prefix "reftex-" |
:prefix "reftex-" |
210 |
:group 'tex) |
:group 'tex) |
211 |
|
|
212 |
|
|
213 |
;; Table of contents configuration -------------------------------------- |
;; Table of contents configuration -------------------------------------- |
214 |
|
|
215 |
(defgroup reftex-table-of-contents-browser nil |
(defgroup reftex-table-of-contents-browser nil |
216 |
"A multifile table of contents browser." |
"A multifile table of contents browser." |
217 |
:group 'reftex) |
:group 'reftex) |
218 |
|
|
219 |
|
(defcustom reftex-include-file-commands '("include" "input") |
220 |
|
"LaTeX commands which input another file. |
221 |
|
The file name is expected after the command, either in braces or separated |
222 |
|
by whitespace." |
223 |
|
:group 'reftex-table-of-contents-browser |
224 |
|
:type '(repeat string)) |
225 |
|
|
226 |
|
(defcustom reftex-max-section-depth 12 |
227 |
|
"Maximum depth of section levels in document structure. |
228 |
|
Standard LaTeX needs default is 7, but there are packages for which this |
229 |
|
needs to be larger." |
230 |
|
:group 'reftex-table-of-contents-browser |
231 |
|
:type 'integer) |
232 |
|
|
233 |
|
;; LaTeX section commands and level numbers |
234 |
|
(defcustom reftex-section-levels |
235 |
|
'( |
236 |
|
("part" . 0) |
237 |
|
("chapter" . 1) |
238 |
|
("section" . 2) |
239 |
|
("subsection" . 3) |
240 |
|
("subsubsection" . 4) |
241 |
|
("paragraph" . 5) |
242 |
|
("subparagraph" . 6) |
243 |
|
("subsubparagraph" . 7) |
244 |
|
("addchap" . -1) ; KOMA-Script |
245 |
|
("addsec" . -2) ; KOMA-Script |
246 |
|
;;; ("minisec" . -7) ; KOMA-Script |
247 |
|
) |
248 |
|
"Commands and levels used for defining sections in the document. |
249 |
|
This is an alist with each element like (COMMAND-NAME . LEVEL). |
250 |
|
The car of each cons cell is the name of the section macro (without |
251 |
|
the backslash). The cdr is a number indicating its level. A negative |
252 |
|
level means the same level as the positive value, but the section will |
253 |
|
never get a number. The cdr may also be a function which will be called |
254 |
|
to after the section-re matched to determine the level." |
255 |
|
:group 'reftex-table-of-contents-browser |
256 |
|
:set 'reftex-set-dirty |
257 |
|
:type '(repeat |
258 |
|
(cons (string :tag "sectioning macro" "") |
259 |
|
(choice |
260 |
|
(number :tag "level " 0) |
261 |
|
(symbol :tag "function " my-level-func))))) |
262 |
|
|
263 |
(defcustom reftex-toc-max-level 100 |
(defcustom reftex-toc-max-level 100 |
264 |
"*The maximum level of toc entries which will be included in the TOC. |
"*The maximum level of toc entries which will be included in the TOC. |
265 |
Section headings with a bigger level will be ignored. In RefTeX, chapters |
Section headings with a bigger level will be ignored. In RefTeX, chapters |
268 |
:group 'reftex-table-of-contents-browser |
:group 'reftex-table-of-contents-browser |
269 |
:type 'integer) |
:type 'integer) |
270 |
|
|
271 |
|
(defcustom reftex-part-resets-chapter nil |
272 |
|
"*Non-nil means, \\part is like any other sectioning command. |
273 |
|
This means, part numbers will be included in the numbering of chapters, and |
274 |
|
chapter counters will be reset for each part. |
275 |
|
When nil (the default), parts are special, do not reset the chapter counter |
276 |
|
and also do not show up in chapter numbers." |
277 |
|
:group 'reftex-table-of-contents-browser |
278 |
|
:type 'boolean) |
279 |
|
|
280 |
|
|
281 |
|
(defcustom reftex-auto-recenter-toc nil |
282 |
|
"*Non-nil means, initially turn automatic recentering of toc on. |
283 |
|
When active, the *TOC* buffer will always show the section you |
284 |
|
are currently working in. Recentering happens whenever Emacs is idle for |
285 |
|
more than `reftex-idle-time' seconds. |
286 |
|
This feature can be turned on and off from the menu |
287 |
|
(Ref->Options)." |
288 |
|
:group 'reftex-table-of-contents-browser |
289 |
|
:type 'boolean) |
290 |
|
|
291 |
|
(defcustom reftex-toc-split-windows-horizontally nil |
292 |
|
"*Non-nil means, create TOC window by splitting window horizontally." |
293 |
|
:group 'reftex-table-of-contents-browser |
294 |
|
:type 'boolean) |
295 |
|
|
296 |
|
(defcustom reftex-toc-split-windows-horizontally-fraction .5 |
297 |
|
"*Fraction of the horizontal width of the frame to be used for TOC window. |
298 |
|
Only relevant when `reftex-toc-split-windows-horizontally' is non-nil." |
299 |
|
:group 'reftex-table-of-contents-browser |
300 |
|
:type 'number) |
301 |
|
|
302 |
(defcustom reftex-toc-keep-other-windows t |
(defcustom reftex-toc-keep-other-windows t |
303 |
"*Non-nil means, split the selected window to display the *toc* buffer. |
"*Non-nil means, split the selected window to display the *toc* buffer. |
304 |
This helps to keep the window configuration, but makes the *toc* small. |
This helps to keep the window configuration, but makes the *toc* small. |
365 |
'(amsmath endnotes fancybox floatfig longtable picinpar |
'(amsmath endnotes fancybox floatfig longtable picinpar |
366 |
rotating sidecap subfigure supertab wrapfig LaTeX) |
rotating sidecap subfigure supertab wrapfig LaTeX) |
367 |
"Default label alist specifications. LaTeX should always be the last entry. |
"Default label alist specifications. LaTeX should always be the last entry. |
368 |
The value of this variable is a list of symbols with associations in the |
The value of this variable is a list of symbols with associations in the |
369 |
constant `reftex-label-alist-builtin'. Check that constant for a full list |
constant `reftex-label-alist-builtin'. Check that constant for a full list |
370 |
of options." |
of options." |
371 |
:group 'reftex-defining-label-environments |
:group 'reftex-defining-label-environments |
414 |
which contains all labels. |
which contains all labels. |
415 |
|
|
416 |
This may also be a function to do local parsing and identify point |
This may also be a function to do local parsing and identify point |
417 |
to be in a a non-standard label environment. The function must take |
to be in a non-standard label environment. The function must take |
418 |
an argument BOUND and limit backward searches to this value. It |
an argument BOUND and limit backward searches to this value. It |
419 |
should return either nil or a cons cell (FUNCTION . POSITION) with |
should return either nil or a cons cell (FUNCTION . POSITION) with |
420 |
the function symbol and the position where the special environment |
the function symbol and the position where the special environment |
559 |
(nth 0 x))) |
(nth 0 x))) |
560 |
reftex-label-alist-builtin))))) |
reftex-label-alist-builtin))))) |
561 |
|
|
|
(defcustom reftex-max-section-depth 12 |
|
|
"Maximum depth of section levels in document structure. |
|
|
Standard LaTeX needs default is 7, but there are packages for which this |
|
|
needs to be larger." |
|
|
:group 'reftex-defining-label-environments |
|
|
:type 'integer) |
|
|
|
|
|
;; LaTeX section commands and level numbers |
|
|
(defcustom reftex-section-levels |
|
|
'( |
|
|
("part" . 0) |
|
|
("chapter" . 1) |
|
|
("section" . 2) |
|
|
("subsection" . 3) |
|
|
("subsubsection" . 4) |
|
|
("paragraph" . 5) |
|
|
("subparagraph" . 6) |
|
|
("subsubparagraph" . 7) |
|
|
("addchap" . -1) ; KOMA-Script |
|
|
("addsec" . -2) ; KOMA-Script |
|
|
;;; ("minisec" . -7) ; KOMA-Script |
|
|
) |
|
|
"Commands and levels used for defining sections in the document. |
|
|
This is an alist with each element like (COMMAND-NAME . LEVEL). |
|
|
The car of each cons cell is the name of the section macro (without |
|
|
the backslash). The cdr is a number indicating its level. A negative |
|
|
level means the same level as the positive value, but the section will |
|
|
never get a number. The cdr may also be a function which will be called |
|
|
to after the section-re matched to determine the level." |
|
|
:group 'reftex-defining-label-environments |
|
|
:set 'reftex-set-dirty |
|
|
:type '(repeat |
|
|
(cons (string :tag "sectioning macro" "") |
|
|
(choice |
|
|
(number :tag "level " 0) |
|
|
(symbol :tag "function " my-level-func))))) |
|
|
|
|
562 |
(defcustom reftex-section-prefixes '((0 . "part:") (1 . "cha:") (t . "sec:")) |
(defcustom reftex-section-prefixes '((0 . "part:") (1 . "cha:") (t . "sec:")) |
563 |
"Prefixes for section labels. |
"Prefixes for section labels. |
564 |
When the label prefix given in an entry in `reftex-label-alist' contains `%S', |
When the label prefix given in an entry in `reftex-label-alist' contains `%S', |
565 |
this list is used to determine the correct prefix string depending on the |
this list is used to determine the correct prefix string depending on the |
566 |
current section level. |
current section level. |
567 |
The list is an alist, with each entry of the form (KEY . PREFIX) |
The list is an alist, with each entry of the form (KEY . PREFIX) |
568 |
Possible keys are sectioning macro names like `chapter', section levels |
Possible keys are sectioning macro names like `chapter', section levels |
587 |
or macro." |
or macro." |
588 |
:group 'reftex-defining-label-environments |
:group 'reftex-defining-label-environments |
589 |
:type '(repeat (cons (symbol) (regexp)))) |
:type '(repeat (cons (symbol) (regexp)))) |
590 |
|
|
591 |
(defcustom reftex-special-environment-functions nil |
(defcustom reftex-special-environment-functions nil |
592 |
"List of functions to be called when trying to figure out current environment. |
"List of functions to be called when trying to figure out current environment. |
593 |
These are special functions to detect \"environments\" which do not |
These are special functions to detect \"environments\" which do not |
633 |
(let ((pos (point)) p1) |
(let ((pos (point)) p1) |
634 |
(save-excursion |
(save-excursion |
635 |
;; Search for any of the linguex item macros at the beginning of a line |
;; Search for any of the linguex item macros at the beginning of a line |
636 |
(if (re-search-backward |
(if (re-search-backward |
637 |
\"^[ \\t]*\\\\(\\\\\\\\\\\\(ex\\\\|a\\\\|b\\\\|c\\\\|d\\\\|e\\\\|f\\\\)g?\\\\.\\\\)\" bound t) |
\"^[ \\t]*\\\\(\\\\\\\\\\\\(ex\\\\|a\\\\|b\\\\|c\\\\|d\\\\|e\\\\|f\\\\)g?\\\\.\\\\)\" bound t) |
638 |
(progn |
(progn |
639 |
(setq p1 (match-beginning 1)) |
(setq p1 (match-beginning 1)) |
643 |
nil |
nil |
644 |
;; OK, we got it |
;; OK, we got it |
645 |
(cons \"linguex\" p1))) |
(cons \"linguex\" p1))) |
646 |
;; Return nil for not found |
;; Return nil for not found |
647 |
nil)))) |
nil)))) |
648 |
|
|
649 |
3. Tell RefTeX to use this function |
3. Tell RefTeX to use this function |
827 |
(choice :tag "Hide short context " ,@reftex-tmp) |
(choice :tag "Hide short context " ,@reftex-tmp) |
828 |
(choice :tag "Follow context in other window " ,@reftex-tmp) |
(choice :tag "Follow context in other window " ,@reftex-tmp) |
829 |
(choice :tag "Show commented labels " ,@reftex-tmp) |
(choice :tag "Show commented labels " ,@reftex-tmp) |
830 |
(choice :tag "Obsolete flag, Don't use. " ,@reftex-tmp) |
(choice :tag "Obsolete flag. Don't use. " ,@reftex-tmp) |
831 |
(choice :tag "Show begin/end of included files" ,@reftex-tmp))) |
(choice :tag "Show begin/end of included files" ,@reftex-tmp))) |
832 |
|
|
833 |
(defcustom reftex-multiref-punctuation '((?, . ", ") (?- . "--") (?+ . " and ")) |
(defcustom reftex-multiref-punctuation '((?, . ", ") (?- . "--") (?+ . " and ")) |
842 |
|
|
843 |
(defcustom reftex-vref-is-default nil |
(defcustom reftex-vref-is-default nil |
844 |
"*Non-nil means, the varioref macro \\vref is used as default. |
"*Non-nil means, the varioref macro \\vref is used as default. |
845 |
In the selection buffer, the `v' key toggles the reference macro between |
In the selection buffer, the `v' key toggles the reference macro between |
846 |
`\\ref' and `\\vref'. The value of this variable determines the default |
`\\ref' and `\\vref'. The value of this variable determines the default |
847 |
which is active when entering the selection process. |
which is active when entering the selection process. |
848 |
Instead of nil or t, this may also be a string of type letters indicating |
Instead of nil or t, this may also be a string of type letters indicating |
852 |
|
|
853 |
(defcustom reftex-fref-is-default nil |
(defcustom reftex-fref-is-default nil |
854 |
"*Non-nil means, the fancyref macro \\fref is used as default. |
"*Non-nil means, the fancyref macro \\fref is used as default. |
855 |
In the selection buffer, the `V' key toggles the reference macro between |
In the selection buffer, the `V' key toggles the reference macro between |
856 |
`\\ref', `\\fref' and `\\Fref'. The value of this variable determines |
`\\ref', `\\fref' and `\\Fref'. The value of this variable determines |
857 |
the default which is active when entering the selection process. |
the default which is active when entering the selection process. |
858 |
Instead of nil or t, this may also be a string of type letters indicating |
Instead of nil or t, this may also be a string of type letters indicating |
876 |
|
|
877 |
(defcustom reftex-format-ref-function nil |
(defcustom reftex-format-ref-function nil |
878 |
"Function which produces the string to insert as a reference. |
"Function which produces the string to insert as a reference. |
879 |
Normally should be nil, because the format to insert a reference can |
Normally should be nil, because the format to insert a reference can |
880 |
already be specified in `reftex-label-alist'. |
already be specified in `reftex-label-alist'. |
881 |
This hook also is used by the special commands to insert `\\vref' and `\\fref' |
This hook also is used by the special commands to insert `\\vref' and `\\fref' |
882 |
references, so even if you set this, your setting will be ignored by |
references, so even if you set this, your setting will be ignored by |
898 |
"Support for referencing bibliographic data with BibTeX." |
"Support for referencing bibliographic data with BibTeX." |
899 |
:group 'reftex) |
:group 'reftex) |
900 |
|
|
901 |
|
(defcustom reftex-bibliography-commands '("bibliography" "nobibliography") |
902 |
|
"LaTeX commands which specify the BibTeX databases to use with the document." |
903 |
|
:group 'reftex-citation-support |
904 |
|
:type '(repeat string)) |
905 |
|
|
906 |
|
|
907 |
(defvar reftex-bibfile-ignore-list nil) ; compatibility |
(defvar reftex-bibfile-ignore-list nil) ; compatibility |
908 |
(defcustom reftex-bibfile-ignore-regexps nil |
(defcustom reftex-bibfile-ignore-regexps nil |
909 |
"*List of regular expressions to exclude files in \\bibliography{..}. |
"*List of regular expressions to exclude files in \\bibliography{..}. |
947 |
In the format, the following percent escapes will be expanded. |
In the format, the following percent escapes will be expanded. |
948 |
|
|
949 |
%l The BibTeX label of the citation. |
%l The BibTeX label of the citation. |
950 |
%a List of author names, see also `reftex-cite-punctuation. |
%a List of author names, see also `reftex-cite-punctuation'. |
951 |
%2a Like %a, but abbreviate more than 2 authors like Jones et al. |
%2a Like %a, but abbreviate more than 2 authors like Jones et al. |
952 |
%A First author name only. |
%A First author name only. |
953 |
%e Works like %a, but on list of editor names. (%2e and %E work a well) |
%e Works like %a, but on list of editor names. (%2e and %E work a well) |
957 |
%i institution %j journal %k key %m month |
%i institution %j journal %k key %m month |
958 |
%n number %o organization %p pages %P first page |
%n number %o organization %p pages %P first page |
959 |
%r address %s school %u publisher %t title |
%r address %s school %u publisher %t title |
960 |
%v volume %y year |
%v volume %y year |
961 |
%B booktitle, abbreviated %T title, abbreviated |
%B booktitle, abbreviated %T title, abbreviated |
962 |
|
|
963 |
Usually, only %l is needed. The other stuff is mainly for the echo area |
Usually, only %l is needed. The other stuff is mainly for the echo area |
964 |
display, and for (setq reftex-comment-citations t). |
display, and for (setq reftex-comment-citations t). |
965 |
|
|
966 |
%< as a special operator kills punctuation and space around it after the |
%< as a special operator kills punctuation and space around it after the |
967 |
string has been formatted. |
string has been formatted. |
968 |
|
|
969 |
Beware that all this only works with BibTeX database files. When |
Beware that all this only works with BibTeX database files. When |
975 |
strings. |
strings. |
976 |
In order to configure this variable, you can either set |
In order to configure this variable, you can either set |
977 |
`reftex-cite-format' directly yourself or set it to the SYMBOL of one of |
`reftex-cite-format' directly yourself or set it to the SYMBOL of one of |
978 |
the predefined styles. The predefined symbols are those which have an |
the predefined styles. The predefined symbols are those which have an |
979 |
association in the constant `reftex-cite-format-builtin'. |
association in the constant `reftex-cite-format-builtin'. |
980 |
E.g.: (setq reftex-cite-format 'natbib)" |
E.g.: (setq reftex-cite-format 'natbib)" |
981 |
:group 'reftex-citation-support |
:group 'reftex-citation-support |
1033 |
|
|
1034 |
(defcustom reftex-format-cite-function nil |
(defcustom reftex-format-cite-function nil |
1035 |
"Function which produces the string to insert as a citation. |
"Function which produces the string to insert as a citation. |
1036 |
Normally should be nil, because the format to insert a reference can |
Normally should be nil, because the format to insert a reference can |
1037 |
already be specified in `reftex-cite-format'. |
already be specified in `reftex-cite-format'. |
1038 |
The function will be called with two arguments, the CITATION KEY and the |
The function will be called with two arguments, the CITATION KEY and the |
1039 |
DEFAULT FORMAT, which is taken from `reftex-cite-format'. The function |
DEFAULT FORMAT, which is taken from `reftex-cite-format'. The function |
1116 |
:group 'reftex-index-support |
:group 'reftex-index-support |
1117 |
:set 'reftex-set-dirty |
:set 'reftex-set-dirty |
1118 |
:type `(list |
:type `(list |
1119 |
(repeat |
(repeat |
1120 |
:inline t |
:inline t |
1121 |
(list :value ("" "idx" ?a "" nil) |
(list :value ("" "idx" ?a "" nil) |
1122 |
(string :tag "Macro with args") |
(string :tag "Macro with args") |
1143 |
This is a list with (MACRO-KEY DEFAULT-TAG). |
This is a list with (MACRO-KEY DEFAULT-TAG). |
1144 |
|
|
1145 |
MACRO-KEY: Character identifying an index macro - see `reftex-index-macros'. |
MACRO-KEY: Character identifying an index macro - see `reftex-index-macros'. |
1146 |
DEFAULT-TAG: This is the tag to be used if the macro requires a TAG argument. |
DEFAULT-TAG: This is the tag to be used if the macro requires a TAG argument. |
1147 |
When this is nil and a TAG is needed, RefTeX will ask for it. |
When this is nil and a TAG is needed, RefTeX will ask for it. |
1148 |
When this is the empty string and the TAG argument of the index |
When this is the empty string and the TAG argument of the index |
1149 |
macro is optional, the TAG argument will be omitted." |
macro is optional, the TAG argument will be omitted." |
1224 |
:group 'reftex-index-support |
:group 'reftex-index-support |
1225 |
:type 'boolean) |
:type 'boolean) |
1226 |
|
|
1227 |
|
(defcustom reftex-index-verify-function nil |
1228 |
|
"A function which is called at each match during global indexing. |
1229 |
|
If the function returns nil, the current match is skipped." |
1230 |
|
:group 'reftex-index-support |
1231 |
|
:type '(choice |
1232 |
|
(const :tag "No verification" nil) |
1233 |
|
(function))) |
1234 |
|
|
1235 |
(defcustom reftex-index-phrases-skip-indexed-matches nil |
(defcustom reftex-index-phrases-skip-indexed-matches nil |
1236 |
"*Non-nil means, skip matches which appear to be indexed already. |
"*Non-nil means, skip matches which appear to be indexed already. |
1237 |
When doing global indexing from the phrases buffer, searches for some |
When doing global indexing from the phrases buffer, searches for some |
1282 |
|
|
1283 |
(defcustom reftex-index-include-context nil |
(defcustom reftex-index-include-context nil |
1284 |
"*Non-nil means, display the index definition context in the index buffer. |
"*Non-nil means, display the index definition context in the index buffer. |
1285 |
This flag may also be toggled from the index buffer with the `c' key." |
This flag may also be toggled from the index buffer with the `c' key." |
1286 |
:group 'reftex-index-support |
:group 'reftex-index-support |
1287 |
:type 'boolean) |
:type 'boolean) |
1288 |
|
|
1305 |
argument of a macro. Note that crossref viewing for citations, |
argument of a macro. Note that crossref viewing for citations, |
1306 |
references (both ways) and index entries is hard-coded. This variable |
references (both ways) and index entries is hard-coded. This variable |
1307 |
is only to configure additional structures for which crossreference |
is only to configure additional structures for which crossreference |
1308 |
viewing can be useful. Each entry has the structure |
viewing can be useful. Each entry has the structure |
1309 |
|
|
1310 |
(MACRO-RE SEARCH-RE HIGHLIGHT). |
(MACRO-RE SEARCH-RE HIGHLIGHT). |
1311 |
|
|
1321 |
(defcustom reftex-auto-view-crossref t |
(defcustom reftex-auto-view-crossref t |
1322 |
"*Non-nil means, initially turn automatic viewing of crossref info on. |
"*Non-nil means, initially turn automatic viewing of crossref info on. |
1323 |
Automatic viewing of crossref info normally uses the echo area. |
Automatic viewing of crossref info normally uses the echo area. |
1324 |
Whenever point is on the argument of a \\ref or \\cite macro, and no |
Whenever point is idle for more than `reftex-idle-time' seconds on the |
1325 |
other message is being displayed, the echo area will display |
argument of a \\ref or \\cite macro, and no other message is being |
1326 |
information about that cross reference. You can also set the variable |
displayed, the echo area will display information about that cross |
1327 |
to the symbol `window'. In this case a small temporary window is |
reference. You can also set the variable to the symbol `window'. In |
1328 |
used for the display. |
this case a small temporary window is used for the display. |
1329 |
This feature can be turned on and of from the menu |
This feature can be turned on and off from the menu |
1330 |
(Ref->Options)." |
(Ref->Options)." |
1331 |
:group 'reftex-viewing-cross-references |
:group 'reftex-viewing-cross-references |
1332 |
:type '(choice (const :tag "off" nil) |
:type '(choice (const :tag "off" nil) |
1334 |
(const :tag "in Other Window" window))) |
(const :tag "in Other Window" window))) |
1335 |
|
|
1336 |
(defcustom reftex-idle-time 1.2 |
(defcustom reftex-idle-time 1.2 |
1337 |
"*Time (secs) Emacs has to be idle before automatic crossref display is done." |
"*Time (secs) Emacs has to be idle before automatic crossref display is done. |
1338 |
|
Applies also to toc recentering." |
1339 |
:group 'reftex-viewing-cross-references |
:group 'reftex-viewing-cross-references |
1340 |
:type 'number) |
:type 'number) |
1341 |
|
|
1372 |
- If an element is the name of an environment variable, its content is used. |
- If an element is the name of an environment variable, its content is used. |
1373 |
- If an element starts with an exclamation mark, it is used as a command |
- If an element starts with an exclamation mark, it is used as a command |
1374 |
to retrieve the path. A typical command with the kpathsearch library would |
to retrieve the path. A typical command with the kpathsearch library would |
1375 |
be `!kpsewhich -show-path=.tex'. |
be `!kpsewhich -show-path=.tex'. |
1376 |
- Otherwise the element itself is interpreted as a path. |
- Otherwise the element itself is interpreted as a path. |
1377 |
Multiple directories can be separated by the system dependent `path-separator'. |
Multiple directories can be separated by the system dependent `path-separator'. |
1378 |
Directories ending in `//' or `!!' will be expanded recursively. |
Directories ending in `//' or `!!' will be expanded recursively. |
1387 |
- If an element is the name of an environment variable, its content is used. |
- If an element is the name of an environment variable, its content is used. |
1388 |
- If an element starts with an exclamation mark, it is used as a command |
- If an element starts with an exclamation mark, it is used as a command |
1389 |
to retrieve the path. A typical command with the kpathsearch library would |
to retrieve the path. A typical command with the kpathsearch library would |
1390 |
be `!kpsewhich -show-path=.bib'. |
be `!kpsewhich -show-path=.bib'. |
1391 |
- Otherwise the element itself is interpreted as a path. |
- Otherwise the element itself is interpreted as a path. |
1392 |
Multiple directories can be separated by the system dependent `path-separator'. |
Multiple directories can be separated by the system dependent `path-separator'. |
1393 |
Directories ending in `//' or `!!' will be expanded recursively. |
Directories ending in `//' or `!!' will be expanded recursively. |
1432 |
TEXINPUTS and BIBINPUTS to find TeX files and BibTeX database files. |
TEXINPUTS and BIBINPUTS to find TeX files and BibTeX database files. |
1433 |
With this option turned on, it calls an external program specified in the |
With this option turned on, it calls an external program specified in the |
1434 |
option `reftex-external-file-finders' instead. As a side effect, |
option `reftex-external-file-finders' instead. As a side effect, |
1435 |
the variables `reftex-texpath-environment-variables' and |
the variables `reftex-texpath-environment-variables' and |
1436 |
`reftex-bibpath-environment-variables' will be ignored." |
`reftex-bibpath-environment-variables' will be ignored." |
1437 |
:group 'reftex-finding-files |
:group 'reftex-finding-files |
1438 |
:type 'boolean) |
:type 'boolean) |
1523 |
(defcustom reftex-save-parse-info nil |
(defcustom reftex-save-parse-info nil |
1524 |
"*Non-nil means, save information gathered with parsing in a file. |
"*Non-nil means, save information gathered with parsing in a file. |
1525 |
The file MASTER.rel in the same directory as MASTER.tex is used to save the |
The file MASTER.rel in the same directory as MASTER.tex is used to save the |
1526 |
information. When this variable is t, |
information. When this variable is t, |
1527 |
- accessing the parsing information for the first time in an editing session |
- accessing the parsing information for the first time in an editing session |
1528 |
will read that file (if available) instead of parsing the document. |
will read that file (if available) instead of parsing the document. |
1529 |
- exiting Emacs or killing a buffer in reftex-mode will cause a new version |
- exiting Emacs or killing a buffer in reftex-mode will cause a new version |
1716 |
may require a restart of Emacs in order to become effective." |
may require a restart of Emacs in order to become effective." |
1717 |
:group 'reftex-miscellaneous-configurations |
:group 'reftex-miscellaneous-configurations |
1718 |
:group 'LaTeX |
:group 'LaTeX |
1719 |
:type '(choice |
:type '(choice |
1720 |
(const :tag "No plug-ins" nil) |
(const :tag "No plug-ins" nil) |
1721 |
(const :tag "All possible plug-ins" t) |
(const :tag "All possible plug-ins" t) |
1722 |
(list |
(list |
1747 |
:group 'reftex-miscellaneous-configurations |
:group 'reftex-miscellaneous-configurations |
1748 |
:type 'hook) |
:type 'hook) |
1749 |
|
|
1750 |
|
(provide 'reftex-vars) |
1751 |
|
|
1752 |
;;; reftex-vars.el ends here |
;;; reftex-vars.el ends here |