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