Variable: reftex-plug-into-AUCTeX

reftex-plug-into-AUCTeX is a customizable variable defined in reftex-vars.el.gz.

Value

nil

Documentation

Plug-in flags for AUCTeX interface.

This variable is a list of 5 boolean flags. When a flag is non-nil, RefTeX will

  - supply labels in new sections and environments (flag 1)
  - supply arguments for macros like \label. (flag 2)
  - supply arguments for macros like \ref. (flag 3)
  - supply arguments for macros like \cite. (flag 4)
  - supply arguments for macros like \index. (flag 5)

You may also set the variable itself to t or nil in order to turn all plug-ins on or off, respectively. Supplying labels in new sections and environments applies when creating sections with C-c C-s (LaTeX-section) and environments with C-c C-e (LaTeX-environment). Supplying macro arguments applies when you insert such a macro interactively with C-c RET (TeX-insert-macro). See the AUCTeX documentation for more information. RefTeX uses fset to take over the function calls. Changing the variable may require a restart of Emacs in order to become effective.

Source Code

;; Defined in /usr/src/emacs/lisp/textmodes/reftex-vars.el.gz
(defcustom reftex-plug-into-AUCTeX nil
  "Plug-in flags for AUCTeX interface.
This variable is a list of 5 boolean flags.  When a flag is non-nil,
RefTeX will

  - supply labels in new sections and environments  (flag 1)
  - supply arguments for macros like `\\label'.      (flag 2)
  - supply arguments for macros like `\\ref'.        (flag 3)
  - supply arguments for macros like `\\cite'.       (flag 4)
  - supply arguments for macros like `\\index'.      (flag 5)

You may also set the variable itself to t or nil in order to turn all
plug-ins on or off, respectively.
\\<LaTeX-mode-map>Supplying labels in new sections and environments applies when creating
sections with \\[LaTeX-section] and environments with \\[LaTeX-environment].
Supplying macro arguments applies when you insert such a macro interactively
with \\[TeX-insert-macro].
See the AUCTeX documentation for more information.
RefTeX uses `fset' to take over the function calls.  Changing the variable
may require a restart of Emacs in order to become effective."
  :group 'reftex-miscellaneous-configurations
  :group 'LaTeX
  :type '(choice
          (const :tag "No plug-ins" nil)
          (const :tag "All possible plug-ins" t)
          (list
           :tag "Individual choice"
           :value (t t t t t)
           (boolean :tag "supply label in new sections and environments")
           (boolean :tag "supply argument for macros like `\\label'     ")
           (boolean :tag "supply argument for macros like `\\ref'       ")
           (boolean :tag "supply argument for macros like `\\cite'      ")
           (boolean :tag "supply argument for macros like `\\index'     "))))