29 |
|
|
30 |
(eval-when-compile (require 'cl)) |
(eval-when-compile (require 'cl)) |
31 |
(eval-and-compile |
(eval-and-compile |
32 |
|
(defvar reftex-tables-dirty) |
33 |
(defun reftex-set-dirty (symbol value) |
(defun reftex-set-dirty (symbol value) |
34 |
(setq reftex-tables-dirty t) |
(setq reftex-tables-dirty t) |
35 |
(set symbol value))) |
(set symbol value))) |
102 |
|
|
103 |
("enumerate" ?i "item:" "~\\ref{%s}" item |
("enumerate" ?i "item:" "~\\ref{%s}" item |
104 |
(regexp "items?" "Punkte?")) |
(regexp "items?" "Punkte?")) |
105 |
|
|
106 |
("equation" ?e "eq:" "~(\\ref{%s})" t |
("equation" ?e "eq:" "~(\\ref{%s})" t |
107 |
(regexp "equations?" "eqs?\\." "eqn\\." "Gleichung\\(en\\)?" "Gl\\.")) |
(regexp "equations?" "eqs?\\." "eqn\\." "Gleichung\\(en\\)?" "Gl\\.")) |
108 |
("eqnarray" ?e "eq:" nil eqnarray-like) |
("eqnarray" ?e "eq:" nil eqnarray-like) |
109 |
|
|
110 |
("figure" ?f "fig:" "~\\ref{%s}" caption |
("figure" ?f "fig:" "~\\ref{%s}" caption |
111 |
(regexp "figure?[sn]?" "figs?\\." "Abbildung\\(en\\)?" "Abb\\.")) |
(regexp "figure?[sn]?" "figs?\\." "Abbildung\\(en\\)?" "Abb\\.")) |
112 |
("figure*" ?f nil nil caption) |
("figure*" ?f nil nil caption) |
113 |
|
|
114 |
("table" ?t "tab:" "~\\ref{%s}" caption |
("table" ?t "tab:" "~\\ref{%s}" caption |
115 |
(regexp "tables?" "tab\\." "Tabellen?")) |
(regexp "tables?" "tab\\." "Tabellen?")) |
116 |
("table*" ?t nil nil caption) |
("table*" ?t nil nil caption) |
117 |
|
|
118 |
("\\footnote[]{}" ?n "fn:" "~\\ref{%s}" 2 |
("\\footnote[]{}" ?n "fn:" "~\\ref{%s}" 2 |
119 |
(regexp "footnotes?" "Fussnoten?")) |
(regexp "footnotes?" "Fussnoten?")) |
120 |
|
|
121 |
("any" ?\ " " "~\\ref{%s}" nil) |
("any" ?\ " " "~\\ref{%s}" nil) |
122 |
|
|
123 |
;; 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: |
209 |
`?t' should point to a textual citation (citation as a noun). |
`?t' should point to a textual citation (citation as a noun). |
210 |
`?p' should point to a parenthetical citation.") |
`?p' should point to a parenthetical citation.") |
211 |
|
|
212 |
(defconst reftex-index-macros-builtin |
(defconst reftex-index-macros-builtin |
213 |
'((default "Default \\index and \\glossary macros" |
'((default "Default \\index and \\glossary macros" |
214 |
(("\\index{*}" "idx" ?i "" nil t) |
(("\\index{*}" "idx" ?i "" nil t) |
215 |
("\\glossary{*}" "glo" ?g "" nil t))) |
("\\glossary{*}" "glo" ?g "" nil t))) |
221 |
(Index-Shortcut "index.sty with \\shortindexingon" |
(Index-Shortcut "index.sty with \\shortindexingon" |
222 |
(("\\index[]{*}" 1 ?i "" nil t) |
(("\\index[]{*}" 1 ?i "" nil t) |
223 |
("\\index*[]{*}" 1 ?I "" nil nil) |
("\\index*[]{*}" 1 ?I "" nil nil) |
224 |
("^[]{*}" 1 ?^ "" texmathp t) |
("^[]{*}" 1 ?^ "" texmathp t) |
225 |
("_[]{*}" 1 ?_ "" texmathp nil)))) |
("_[]{*}" 1 ?_ "" texmathp nil)))) |
226 |
"Builtin stuff for reftex-index-macros. |
"Builtin stuff for reftex-index-macros. |
227 |
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 |
233 |
(defgroup reftex nil |
(defgroup reftex nil |
234 |
"LaTeX label and citation support." |
"LaTeX label and citation support." |
235 |
:tag "RefTeX" |
:tag "RefTeX" |
236 |
:link '(url-link :tag "Home Page" |
:link '(url-link :tag "Home Page" |
237 |
"http://zon.astro.uva.nl/~dominik/Tools/") |
"http://zon.astro.uva.nl/~dominik/Tools/") |
238 |
:link '(emacs-commentary-link :tag "Commentary in reftex.el" "reftex.el") |
:link '(emacs-commentary-link :tag "Commentary in reftex.el" "reftex.el") |
239 |
:link '(custom-manual "(reftex)Top") |
:link '(custom-manual "(reftex)Top") |
328 |
automatic recentering is turned on. When the frame gets destroyed, automatic |
automatic recentering is turned on. When the frame gets destroyed, automatic |
329 |
recentering is turned off again. |
recentering is turned off again. |
330 |
|
|
331 |
This feature can be turned on and off from the menu |
This feature can be turned on and off from the menu |
332 |
\(Ref->Options)." |
\(Ref->Options)." |
333 |
:group 'reftex-table-of-contents-browser |
:group 'reftex-table-of-contents-browser |
334 |
:type '(choice |
:type '(choice |
335 |
(const :tag "never" nil) |
(const :tag "never" nil) |
336 |
(const :tag "always" t) |
(const :tag "always" t) |
337 |
(const :tag "in dedicated frame only" frame))) |
(const :tag "in dedicated frame only" frame))) |
338 |
|
|
339 |
(defcustom reftex-toc-split-windows-horizontally nil |
(defcustom reftex-toc-split-windows-horizontally nil |
340 |
"*Non-nil means, create TOC window by splitting window horizontally." |
"*Non-nil means, create TOC window by splitting window horizontally." |
341 |
:group 'reftex-table-of-contents-browser |
:group 'reftex-table-of-contents-browser |
427 |
'(amsmath endnotes fancybox floatfig longtable picinpar |
'(amsmath endnotes fancybox floatfig longtable picinpar |
428 |
rotating sidecap subfigure supertab wrapfig LaTeX) |
rotating sidecap subfigure supertab wrapfig LaTeX) |
429 |
"Default label alist specifications. LaTeX should always be the last entry. |
"Default label alist specifications. LaTeX should always be the last entry. |
430 |
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 |
431 |
constant `reftex-label-alist-builtin'. Check that constant for a full list |
constant `reftex-label-alist-builtin'. Check that constant for a full list |
432 |
of options." |
of options." |
433 |
:group 'reftex-defining-label-environments |
:group 'reftex-defining-label-environments |
626 |
(defcustom reftex-section-prefixes '((0 . "part:") (1 . "cha:") (t . "sec:")) |
(defcustom reftex-section-prefixes '((0 . "part:") (1 . "cha:") (t . "sec:")) |
627 |
"Prefixes for section labels. |
"Prefixes for section labels. |
628 |
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', |
629 |
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 |
630 |
current section level. |
current section level. |
631 |
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) |
632 |
Possible keys are sectioning macro names like `chapter', section levels |
Possible keys are sectioning macro names like `chapter', section levels |
688 |
(regexp) |
(regexp) |
689 |
(repeat :tag "List" |
(repeat :tag "List" |
690 |
(string :tag "prefix (with colon)")))) |
(string :tag "prefix (with colon)")))) |
691 |
|
|
692 |
(defcustom reftex-special-environment-functions nil |
(defcustom reftex-special-environment-functions nil |
693 |
"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. |
694 |
These are special functions to detect \"environments\" which do not |
These are special functions to detect \"environments\" which do not |
734 |
(let ((pos (point)) p1) |
(let ((pos (point)) p1) |
735 |
(save-excursion |
(save-excursion |
736 |
;; 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 |
737 |
(if (re-search-backward |
(if (re-search-backward |
738 |
\"^[ \\t]*\\\\(\\\\\\\\\\\\(ex\\\\|a\\\\|b\\\\|c\\\\|d\\\\|e\\\\|f\\\\)g?\\\\.\\\\)\" bound t) |
\"^[ \\t]*\\\\(\\\\\\\\\\\\(ex\\\\|a\\\\|b\\\\|c\\\\|d\\\\|e\\\\|f\\\\)g?\\\\.\\\\)\" bound t) |
739 |
(progn |
(progn |
740 |
(setq p1 (match-beginning 1)) |
(setq p1 (match-beginning 1)) |
744 |
nil |
nil |
745 |
;; OK, we got it |
;; OK, we got it |
746 |
(cons \"linguex\" p1))) |
(cons \"linguex\" p1))) |
747 |
;; Return nil for not found |
;; Return nil for not found |
748 |
nil)))) |
nil)))) |
749 |
|
|
750 |
3. Tell RefTeX to use this function |
3. Tell RefTeX to use this function |
943 |
|
|
944 |
(defcustom reftex-vref-is-default nil |
(defcustom reftex-vref-is-default nil |
945 |
"*Non-nil means, the varioref macro \\vref is used as default. |
"*Non-nil means, the varioref macro \\vref is used as default. |
946 |
In the selection buffer, the `v' key toggles the reference macro between |
In the selection buffer, the `v' key toggles the reference macro between |
947 |
`\\ref' and `\\vref'. The value of this variable determines the default |
`\\ref' and `\\vref'. The value of this variable determines the default |
948 |
which is active when entering the selection process. |
which is active when entering the selection process. |
949 |
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 |
953 |
|
|
954 |
(defcustom reftex-fref-is-default nil |
(defcustom reftex-fref-is-default nil |
955 |
"*Non-nil means, the fancyref macro \\fref is used as default. |
"*Non-nil means, the fancyref macro \\fref is used as default. |
956 |
In the selection buffer, the `V' key toggles the reference macro between |
In the selection buffer, the `V' key toggles the reference macro between |
957 |
`\\ref', `\\fref' and `\\Fref'. The value of this variable determines |
`\\ref', `\\fref' and `\\Fref'. The value of this variable determines |
958 |
the default which is active when entering the selection process. |
the default which is active when entering the selection process. |
959 |
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 |
977 |
|
|
978 |
(defcustom reftex-format-ref-function nil |
(defcustom reftex-format-ref-function nil |
979 |
"Function which produces the string to insert as a reference. |
"Function which produces the string to insert as a reference. |
980 |
Normally should be nil, because the format to insert a reference can |
Normally should be nil, because the format to insert a reference can |
981 |
already be specified in `reftex-label-alist'. |
already be specified in `reftex-label-alist'. |
982 |
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' |
983 |
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 |
1058 |
%i institution %j journal %k key %m month |
%i institution %j journal %k key %m month |
1059 |
%n number %o organization %p pages %P first page |
%n number %o organization %p pages %P first page |
1060 |
%r address %s school %u publisher %t title |
%r address %s school %u publisher %t title |
1061 |
%v volume %y year |
%v volume %y year |
1062 |
%B booktitle, abbreviated %T title, abbreviated |
%B booktitle, abbreviated %T title, abbreviated |
1063 |
|
|
1064 |
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 |
1065 |
display, and for (setq reftex-comment-citations t). |
display, and for (setq reftex-comment-citations t). |
1066 |
|
|
1067 |
%< as a special operator kills punctuation and space around it after the |
%< as a special operator kills punctuation and space around it after the |
1068 |
string has been formatted. |
string has been formatted. |
1069 |
|
|
1070 |
A pair of square brackets indicates an optional argument, and RefTeX |
A pair of square brackets indicates an optional argument, and RefTeX |
1079 |
strings. |
strings. |
1080 |
In order to configure this variable, you can either set |
In order to configure this variable, you can either set |
1081 |
`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 |
1082 |
the predefined styles. The predefined symbols are those which have an |
the predefined styles. The predefined symbols are those which have an |
1083 |
association in the constant `reftex-cite-format-builtin'. |
association in the constant `reftex-cite-format-builtin'. |
1084 |
E.g.: (setq reftex-cite-format 'natbib)" |
E.g.: (setq reftex-cite-format 'natbib)" |
1085 |
:group 'reftex-citation-support |
:group 'reftex-citation-support |
1173 |
|
|
1174 |
(defcustom reftex-format-cite-function nil |
(defcustom reftex-format-cite-function nil |
1175 |
"Function which produces the string to insert as a citation. |
"Function which produces the string to insert as a citation. |
1176 |
Normally should be nil, because the format to insert a reference can |
Normally should be nil, because the format to insert a reference can |
1177 |
already be specified in `reftex-cite-format'. |
already be specified in `reftex-cite-format'. |
1178 |
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 |
1179 |
DEFAULT FORMAT, which is taken from `reftex-cite-format'. The function |
DEFAULT FORMAT, which is taken from `reftex-cite-format'. The function |
1256 |
:group 'reftex-index-support |
:group 'reftex-index-support |
1257 |
:set 'reftex-set-dirty |
:set 'reftex-set-dirty |
1258 |
:type `(list |
:type `(list |
1259 |
(repeat |
(repeat |
1260 |
:inline t |
:inline t |
1261 |
(list :value ("" "idx" ?a "" nil) |
(list :value ("" "idx" ?a "" nil) |
1262 |
(string :tag "Macro with args") |
(string :tag "Macro with args") |
1283 |
This is a list with (MACRO-KEY DEFAULT-TAG). |
This is a list with (MACRO-KEY DEFAULT-TAG). |
1284 |
|
|
1285 |
MACRO-KEY: Character identifying an index macro - see `reftex-index-macros'. |
MACRO-KEY: Character identifying an index macro - see `reftex-index-macros'. |
1286 |
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. |
1287 |
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. |
1288 |
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 |
1289 |
macro is optional, the TAG argument will be omitted." |
macro is optional, the TAG argument will be omitted." |
1424 |
|
|
1425 |
(defcustom reftex-index-include-context nil |
(defcustom reftex-index-include-context nil |
1426 |
"*Non-nil means, display the index definition context in the index buffer. |
"*Non-nil means, display the index definition context in the index buffer. |
1427 |
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." |
1428 |
:group 'reftex-index-support |
:group 'reftex-index-support |
1429 |
:type 'boolean) |
:type 'boolean) |
1430 |
|
|
1447 |
argument of a macro. Note that crossref viewing for citations, |
argument of a macro. Note that crossref viewing for citations, |
1448 |
references (both ways) and index entries is hard-coded. This variable |
references (both ways) and index entries is hard-coded. This variable |
1449 |
is only to configure additional structures for which crossreference |
is only to configure additional structures for which crossreference |
1450 |
viewing can be useful. Each entry has the structure |
viewing can be useful. Each entry has the structure |
1451 |
|
|
1452 |
\(MACRO-RE SEARCH-RE HIGHLIGHT). |
\(MACRO-RE SEARCH-RE HIGHLIGHT). |
1453 |
|
|
1468 |
displayed, the echo area will display information about that cross |
displayed, the echo area will display information about that cross |
1469 |
reference. You can also set the variable to the symbol `window'. In |
reference. You can also set the variable to the symbol `window'. In |
1470 |
this case a small temporary window is used for the display. |
this case a small temporary window is used for the display. |
1471 |
This feature can be turned on and off from the menu |
This feature can be turned on and off from the menu |
1472 |
\(Ref->Options)." |
\(Ref->Options)." |
1473 |
:group 'reftex-viewing-cross-references |
:group 'reftex-viewing-cross-references |
1474 |
:type '(choice (const :tag "off" nil) |
:type '(choice (const :tag "off" nil) |
1514 |
- 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. |
1515 |
- 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 |
1516 |
to retrieve the path. A typical command with the kpathsearch library would |
to retrieve the path. A typical command with the kpathsearch library would |
1517 |
be `!kpsewhich -show-path=.tex'. |
be `!kpsewhich -show-path=.tex'. |
1518 |
- Otherwise the element itself is interpreted as a path. |
- Otherwise the element itself is interpreted as a path. |
1519 |
Multiple directories can be separated by the system dependent `path-separator'. |
Multiple directories can be separated by the system dependent `path-separator'. |
1520 |
Directories ending in `//' or `!!' will be expanded recursively. |
Directories ending in `//' or `!!' will be expanded recursively. |
1529 |
- 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. |
1530 |
- 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 |
1531 |
to retrieve the path. A typical command with the kpathsearch library would |
to retrieve the path. A typical command with the kpathsearch library would |
1532 |
be `!kpsewhich -show-path=.bib'. |
be `!kpsewhich -show-path=.bib'. |
1533 |
- Otherwise the element itself is interpreted as a path. |
- Otherwise the element itself is interpreted as a path. |
1534 |
Multiple directories can be separated by the system dependent `path-separator'. |
Multiple directories can be separated by the system dependent `path-separator'. |
1535 |
Directories ending in `//' or `!!' will be expanded recursively. |
Directories ending in `//' or `!!' will be expanded recursively. |
1574 |
TEXINPUTS and BIBINPUTS to find TeX files and BibTeX database files. |
TEXINPUTS and BIBINPUTS to find TeX files and BibTeX database files. |
1575 |
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 |
1576 |
option `reftex-external-file-finders' instead. As a side effect, |
option `reftex-external-file-finders' instead. As a side effect, |
1577 |
the variables `reftex-texpath-environment-variables' and |
the variables `reftex-texpath-environment-variables' and |
1578 |
`reftex-bibpath-environment-variables' will be ignored." |
`reftex-bibpath-environment-variables' will be ignored." |
1579 |
:group 'reftex-finding-files |
:group 'reftex-finding-files |
1580 |
:type 'boolean) |
:type 'boolean) |
1665 |
(defcustom reftex-save-parse-info nil |
(defcustom reftex-save-parse-info nil |
1666 |
"*Non-nil means, save information gathered with parsing in a file. |
"*Non-nil means, save information gathered with parsing in a file. |
1667 |
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 |
1668 |
information. When this variable is t, |
information. When this variable is t, |
1669 |
- accessing the parsing information for the first time in an editing session |
- accessing the parsing information for the first time in an editing session |
1670 |
will read that file (if available) instead of parsing the document. |
will read that file (if available) instead of parsing the document. |
1671 |
- 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 |
1858 |
may require a restart of Emacs in order to become effective." |
may require a restart of Emacs in order to become effective." |
1859 |
:group 'reftex-miscellaneous-configurations |
:group 'reftex-miscellaneous-configurations |
1860 |
:group 'LaTeX |
:group 'LaTeX |
1861 |
:type '(choice |
:type '(choice |
1862 |
(const :tag "No plug-ins" nil) |
(const :tag "No plug-ins" nil) |
1863 |
(const :tag "All possible plug-ins" t) |
(const :tag "All possible plug-ins" t) |
1864 |
(list |
(list |