96 |
|
|
97 |
("enumerate" ?i "item:" "~\\ref{%s}" item |
("enumerate" ?i "item:" "~\\ref{%s}" item |
98 |
(regexp "items?" "Punkte?")) |
(regexp "items?" "Punkte?")) |
99 |
|
|
100 |
("equation" ?e "eq:" "~(\\ref{%s})" t |
("equation" ?e "eq:" "~(\\ref{%s})" t |
101 |
(regexp "equations?" "eqs?\\." "eqn\\." "Gleichung\\(en\\)?" "Gl\\.")) |
(regexp "equations?" "eqs?\\." "eqn\\." "Gleichung\\(en\\)?" "Gl\\.")) |
102 |
("eqnarray" ?e "eq:" nil eqnarray-like) |
("eqnarray" ?e "eq:" nil eqnarray-like) |
103 |
|
|
104 |
("figure" ?f "fig:" "~\\ref{%s}" caption |
("figure" ?f "fig:" "~\\ref{%s}" caption |
105 |
(regexp "figure?[sn]?" "figs?\\." "Abbildung\\(en\\)?" "Abb\\.")) |
(regexp "figure?[sn]?" "figs?\\." "Abbildung\\(en\\)?" "Abb\\.")) |
106 |
("figure*" ?f nil nil caption) |
("figure*" ?f nil nil caption) |
107 |
|
|
108 |
("table" ?t "tab:" "~\\ref{%s}" caption |
("table" ?t "tab:" "~\\ref{%s}" caption |
109 |
(regexp "tables?" "tab\\." "Tabellen?")) |
(regexp "tables?" "tab\\." "Tabellen?")) |
110 |
("table*" ?t nil nil caption) |
("table*" ?t nil nil caption) |
111 |
|
|
112 |
("\\footnote[]{}" ?n "fn:" "~\\ref{%s}" 2 |
("\\footnote[]{}" ?n "fn:" "~\\ref{%s}" 2 |
113 |
(regexp "footnotes?" "Fussnoten?")) |
(regexp "footnotes?" "Fussnoten?")) |
114 |
|
|
115 |
("any" ?\ " " "~\\ref{%s}" nil) |
("any" ?\ " " "~\\ref{%s}" nil) |
116 |
|
|
117 |
;; 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: |
174 |
`?t' should point to a textual citation (citation as a noun). |
`?t' should point to a textual citation (citation as a noun). |
175 |
`?p' should point to a parenthetical citation.") |
`?p' should point to a parenthetical citation.") |
176 |
|
|
177 |
(defconst reftex-index-macros-builtin |
(defconst reftex-index-macros-builtin |
178 |
'((default "Default \\index and \\glossary macros" |
'((default "Default \\index and \\glossary macros" |
179 |
(("\\index{*}" "idx" ?i "" nil t) |
(("\\index{*}" "idx" ?i "" nil t) |
180 |
("\\glossary{*}" "glo" ?g "" nil t))) |
("\\glossary{*}" "glo" ?g "" nil t))) |
186 |
(Index-Shortcut "index.sty with \\shortindexingon" |
(Index-Shortcut "index.sty with \\shortindexingon" |
187 |
(("\\index[]{*}" 1 ?i "" nil t) |
(("\\index[]{*}" 1 ?i "" nil t) |
188 |
("\\index*[]{*}" 1 ?I "" nil nil) |
("\\index*[]{*}" 1 ?I "" nil nil) |
189 |
("^[]{*}" 1 ?^ "" texmathp t) |
("^[]{*}" 1 ?^ "" texmathp t) |
190 |
("_[]{*}" 1 ?_ "" texmathp nil)))) |
("_[]{*}" 1 ?_ "" texmathp nil)))) |
191 |
"Builtin stuff for reftex-index-macros. |
"Builtin stuff for reftex-index-macros. |
192 |
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 |
198 |
(defgroup reftex nil |
(defgroup reftex nil |
199 |
"LaTeX label and citation support." |
"LaTeX label and citation support." |
200 |
:tag "RefTeX" |
:tag "RefTeX" |
201 |
:link '(url-link :tag "Home Page" |
:link '(url-link :tag "Home Page" |
202 |
"http://strw.leidenuniv.nl/~dominik/Tools/") |
"http://strw.leidenuniv.nl/~dominik/Tools/") |
203 |
:link '(emacs-commentary-link :tag "Commentary in reftex.el" "reftex.el") |
:link '(emacs-commentary-link :tag "Commentary in reftex.el" "reftex.el") |
204 |
:link '(custom-manual "(reftex)Top") |
:link '(custom-manual "(reftex)Top") |
285 |
'(amsmath endnotes fancybox floatfig longtable picinpar |
'(amsmath endnotes fancybox floatfig longtable picinpar |
286 |
rotating sidecap subfigure supertab wrapfig LaTeX) |
rotating sidecap subfigure supertab wrapfig LaTeX) |
287 |
"Default label alist specifications. LaTeX should always be the last entry. |
"Default label alist specifications. LaTeX should always be the last entry. |
288 |
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 |
289 |
constant `reftex-label-alist-builtin'. Check that constant for a full list |
constant `reftex-label-alist-builtin'. Check that constant for a full list |
290 |
of options." |
of options." |
291 |
:group 'reftex-defining-label-environments |
:group 'reftex-defining-label-environments |
519 |
(defcustom reftex-section-prefixes '((0 . "part:") (1 . "cha:") (t . "sec:")) |
(defcustom reftex-section-prefixes '((0 . "part:") (1 . "cha:") (t . "sec:")) |
520 |
"Prefixes for section labels. |
"Prefixes for section labels. |
521 |
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', |
522 |
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 |
523 |
current section level. |
current section level. |
524 |
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) |
525 |
Possible keys are sectioning macro names like `chapter', section levels |
Possible keys are sectioning macro names like `chapter', section levels |
544 |
or macro." |
or macro." |
545 |
:group 'reftex-defining-label-environments |
:group 'reftex-defining-label-environments |
546 |
:type '(repeat (cons (symbol) (regexp)))) |
:type '(repeat (cons (symbol) (regexp)))) |
547 |
|
|
548 |
(defcustom reftex-special-environment-functions nil |
(defcustom reftex-special-environment-functions nil |
549 |
"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. |
550 |
These are special functions to detect \"environments\" which do not |
These are special functions to detect \"environments\" which do not |
590 |
(let ((pos (point)) p1) |
(let ((pos (point)) p1) |
591 |
(save-excursion |
(save-excursion |
592 |
;; 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 |
593 |
(if (re-search-backward |
(if (re-search-backward |
594 |
\"^[ \\t]*\\\\(\\\\\\\\\\\\(ex\\\\|a\\\\|b\\\\|c\\\\|d\\\\|e\\\\|f\\\\)g?\\\\.\\\\)\" bound t) |
\"^[ \\t]*\\\\(\\\\\\\\\\\\(ex\\\\|a\\\\|b\\\\|c\\\\|d\\\\|e\\\\|f\\\\)g?\\\\.\\\\)\" bound t) |
595 |
(progn |
(progn |
596 |
(setq p1 (match-beginning 1)) |
(setq p1 (match-beginning 1)) |
600 |
nil |
nil |
601 |
;; OK, we got it |
;; OK, we got it |
602 |
(cons \"linguex\" p1))) |
(cons \"linguex\" p1))) |
603 |
;; Return nil for not found |
;; Return nil for not found |
604 |
nil)))) |
nil)))) |
605 |
|
|
606 |
3. Tell RefTeX to use this function |
3. Tell RefTeX to use this function |
793 |
this variable associates the 3 marking characters `,-+' with prefix strings |
this variable associates the 3 marking characters `,-+' with prefix strings |
794 |
to be inserted into the buffer before the corresponding \\ref macro. |
to be inserted into the buffer before the corresponding \\ref macro. |
795 |
This is used to string together whole reference sets, like |
This is used to string together whole reference sets, like |
796 |
`eqs. 1,2,3-5,6 and 7' in a single call to `reftex-reference'. See manual." |
`eqs. 1,2,3-5,6 and 7' in a single call to `reftex-reference'. See manual." |
797 |
:group 'reftex-referencing-labels |
:group 'reftex-referencing-labels |
798 |
:type '(repeat (cons (character) (string)))) |
:type '(repeat (cons (character) (string)))) |
799 |
|
|
800 |
(defcustom reftex-vref-is-default nil |
(defcustom reftex-vref-is-default nil |
801 |
"*Non-nil means, the varioref macro \\vref is used as default. |
"*Non-nil means, the varioref macro \\vref is used as default. |
802 |
In the selection buffer, the `v' key toggles the reference macro between |
In the selection buffer, the `v' key toggles the reference macro between |
803 |
`\\ref' and `\\vref'. The value of this variable determines the default |
`\\ref' and `\\vref'. The value of this variable determines the default |
804 |
which is active when entering the selection process. |
which is active when entering the selection process. |
805 |
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 |
809 |
|
|
810 |
(defcustom reftex-fref-is-default nil |
(defcustom reftex-fref-is-default nil |
811 |
"*Non-nil means, the fancyref macro \\fref is used as default. |
"*Non-nil means, the fancyref macro \\fref is used as default. |
812 |
In the selection buffer, the `V' key toggles the reference macro between |
In the selection buffer, the `V' key toggles the reference macro between |
813 |
`\\ref', `\\fref' and `\\Fref'. The value of this variable determines |
`\\ref', `\\fref' and `\\Fref'. The value of this variable determines |
814 |
the default which is active when entering the selection process. |
the default which is active when entering the selection process. |
815 |
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 |
833 |
|
|
834 |
(defcustom reftex-format-ref-function nil |
(defcustom reftex-format-ref-function nil |
835 |
"Function which produces the string to insert as a reference. |
"Function which produces the string to insert as a reference. |
836 |
Normally should be nil, because the format to insert a reference can |
Normally should be nil, because the format to insert a reference can |
837 |
already be specified in `reftex-label-alist'. |
already be specified in `reftex-label-alist'. |
838 |
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' |
839 |
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 |
908 |
%i institution %j journal %k key %m month |
%i institution %j journal %k key %m month |
909 |
%n number %o organization %p pages %P first page |
%n number %o organization %p pages %P first page |
910 |
%r address %s school %u publisher %t title |
%r address %s school %u publisher %t title |
911 |
%v volume %y year |
%v volume %y year |
912 |
%B booktitle, abbreviated %T title, abbreviated |
%B booktitle, abbreviated %T title, abbreviated |
913 |
|
|
914 |
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 |
915 |
display, and for (setq reftex-comment-citations t). |
display, and for (setq reftex-comment-citations t). |
916 |
|
|
917 |
%< as a special operator kills punctuation and space around it after the |
%< as a special operator kills punctuation and space around it after the |
918 |
string has been formatted. |
string has been formatted. |
919 |
|
|
920 |
Beware that all this only works with BibTeX database files. When |
Beware that all this only works with BibTeX database files. When |
926 |
strings. |
strings. |
927 |
In order to configure this variable, you can either set |
In order to configure this variable, you can either set |
928 |
`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 |
929 |
the predefined styles. The predefined symbols are those which have an |
the predefined styles. The predefined symbols are those which have an |
930 |
association in the constant `reftex-cite-format-builtin'. |
association in the constant `reftex-cite-format-builtin'. |
931 |
E.g.: (setq reftex-cite-format 'natbib)" |
E.g.: (setq reftex-cite-format 'natbib)" |
932 |
:group 'reftex-citation-support |
:group 'reftex-citation-support |
984 |
|
|
985 |
(defcustom reftex-format-cite-function nil |
(defcustom reftex-format-cite-function nil |
986 |
"Function which produces the string to insert as a citation. |
"Function which produces the string to insert as a citation. |
987 |
Normally should be nil, because the format to insert a reference can |
Normally should be nil, because the format to insert a reference can |
988 |
already be specified in `reftex-cite-format'. |
already be specified in `reftex-cite-format'. |
989 |
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 |
990 |
DEFAULT FORMAT, which is taken from `reftex-cite-format'. The function |
DEFAULT FORMAT, which is taken from `reftex-cite-format'. The function |
1067 |
:group 'reftex-index-support |
:group 'reftex-index-support |
1068 |
:set 'reftex-set-dirty |
:set 'reftex-set-dirty |
1069 |
:type `(list |
:type `(list |
1070 |
(repeat |
(repeat |
1071 |
:inline t |
:inline t |
1072 |
(list :value ("" "idx" ?a "" nil) |
(list :value ("" "idx" ?a "" nil) |
1073 |
(string :tag "Macro with args") |
(string :tag "Macro with args") |
1094 |
This is a list with (MACRO-KEY DEFAULT-TAG). |
This is a list with (MACRO-KEY DEFAULT-TAG). |
1095 |
|
|
1096 |
MACRO-KEY: Character identifying an index macro - see `reftex-index-macros'. |
MACRO-KEY: Character identifying an index macro - see `reftex-index-macros'. |
1097 |
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. |
1098 |
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. |
1099 |
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 |
1100 |
macro is optional, the TAG argument will be omitted." |
macro is optional, the TAG argument will be omitted." |
1225 |
|
|
1226 |
(defcustom reftex-index-include-context nil |
(defcustom reftex-index-include-context nil |
1227 |
"*Non-nil means, display the index definition context in the index buffer. |
"*Non-nil means, display the index definition context in the index buffer. |
1228 |
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." |
1229 |
:group 'reftex-index-support |
:group 'reftex-index-support |
1230 |
:type 'boolean) |
:type 'boolean) |
1231 |
|
|
1248 |
argument of a macro. Note that crossref viewing for citations, |
argument of a macro. Note that crossref viewing for citations, |
1249 |
references (both ways) and index entries is hard-coded. This variable |
references (both ways) and index entries is hard-coded. This variable |
1250 |
is only to configure additional structures for which crossreference |
is only to configure additional structures for which crossreference |
1251 |
viewing can be useful. Each entry has the structure |
viewing can be useful. Each entry has the structure |
1252 |
|
|
1253 |
(MACRO-RE SEARCH-RE HIGHLIGHT). |
(MACRO-RE SEARCH-RE HIGHLIGHT). |
1254 |
|
|
1269 |
information about that cross reference. You can also set the variable |
information about that cross reference. You can also set the variable |
1270 |
to the symbol `window'. In this case a small temporary window is |
to the symbol `window'. In this case a small temporary window is |
1271 |
used for the display. |
used for the display. |
1272 |
This feature can be turned on and of from the menu |
This feature can be turned on and of from the menu |
1273 |
(Ref->Options)." |
(Ref->Options)." |
1274 |
:group 'reftex-viewing-cross-references |
:group 'reftex-viewing-cross-references |
1275 |
:type '(choice (const :tag "off" nil) |
:type '(choice (const :tag "off" nil) |
1314 |
- 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. |
1315 |
- 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 |
1316 |
to retrieve the path. A typical command with the kpathsearch library would |
to retrieve the path. A typical command with the kpathsearch library would |
1317 |
be `!kpsewhich -show-path=.tex'. |
be `!kpsewhich -show-path=.tex'. |
1318 |
- Otherwise the element itself is interpreted as a path. |
- Otherwise the element itself is interpreted as a path. |
1319 |
Multiple directories can be separated by the system dependent `path-separator'. |
Multiple directories can be separated by the system dependent `path-separator'. |
1320 |
Directories ending in `//' or `!!' will be expanded recursively. |
Directories ending in `//' or `!!' will be expanded recursively. |
1329 |
- 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. |
1330 |
- 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 |
1331 |
to retrieve the path. A typical command with the kpathsearch library would |
to retrieve the path. A typical command with the kpathsearch library would |
1332 |
be `!kpsewhich -show-path=.bib'. |
be `!kpsewhich -show-path=.bib'. |
1333 |
- Otherwise the element itself is interpreted as a path. |
- Otherwise the element itself is interpreted as a path. |
1334 |
Multiple directories can be separated by the system dependent `path-separator'. |
Multiple directories can be separated by the system dependent `path-separator'. |
1335 |
Directories ending in `//' or `!!' will be expanded recursively. |
Directories ending in `//' or `!!' will be expanded recursively. |
1374 |
TEXINPUTS and BIBINPUTS to find TeX files and BibTeX database files. |
TEXINPUTS and BIBINPUTS to find TeX files and BibTeX database files. |
1375 |
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 |
1376 |
option `reftex-external-file-finders' instead. As a side effect, |
option `reftex-external-file-finders' instead. As a side effect, |
1377 |
the variables `reftex-texpath-environment-variables' and |
the variables `reftex-texpath-environment-variables' and |
1378 |
`reftex-bibpath-environment-variables' will be ignored." |
`reftex-bibpath-environment-variables' will be ignored." |
1379 |
:group 'reftex-finding-files |
:group 'reftex-finding-files |
1380 |
:type 'boolean) |
:type 'boolean) |
1465 |
(defcustom reftex-save-parse-info nil |
(defcustom reftex-save-parse-info nil |
1466 |
"*Non-nil means, save information gathered with parsing in a file. |
"*Non-nil means, save information gathered with parsing in a file. |
1467 |
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 |
1468 |
information. When this variable is t, |
information. When this variable is t, |
1469 |
- accessing the parsing information for the first time in an editing session |
- accessing the parsing information for the first time in an editing session |
1470 |
will read that file (if available) instead of parsing the document. |
will read that file (if available) instead of parsing the document. |
1471 |
- 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 |
1658 |
may require a restart of Emacs in order to become effective." |
may require a restart of Emacs in order to become effective." |
1659 |
:group 'reftex-miscellaneous-configurations |
:group 'reftex-miscellaneous-configurations |
1660 |
:group 'LaTeX |
:group 'LaTeX |
1661 |
:type '(choice |
:type '(choice |
1662 |
(const :tag "No plug-ins" nil) |
(const :tag "No plug-ins" nil) |
1663 |
(const :tag "All possible plug-ins" t) |
(const :tag "All possible plug-ins" t) |
1664 |
(list |
(list |