Variable: reftex-label-ignored-macros-and-environments

reftex-label-ignored-macros-and-environments is a customizable variable defined in reftex-vars.el.gz.

Value

nil

Documentation

List of macros and environments to be ignored when searching for labels.

The purpose is to ignore environments and macros that use keyval style label=foo arguments, but the label has a different meaning than a \label{foo}. Standard \label{...} definitions are never ignored.

E.g., TikZ defines several macros/environments where [label=foo] defines the label to be printed at some node or edge, but it's not a label used for referencing.

Note that this feature is only supported if you are using AUCTeX and the functions TeX-current-macro and LaTeX-current-environment(var)/LaTeX-current-environment(fun) are bound. Also note that this feature might slow down the reftex parsing process for large TeX files.

This variable was added, or its default value changed, in Emacs 24.4.

Source Code

;; Defined in /usr/src/emacs/lisp/textmodes/reftex-vars.el.gz
(defcustom reftex-label-ignored-macros-and-environments nil
  "List of macros and environments to be ignored when searching for labels.
The purpose is to ignore environments and macros that use keyval
style label=foo arguments, but the label has a different meaning
than a \\label{foo}.  Standard \\label{...} definitions are never
ignored.

E.g., TikZ defines several macros/environments where [label=foo]
defines the label to be printed at some node or edge, but it's
not a label used for referencing.

Note that this feature is only supported if you are using AUCTeX
and the functions `TeX-current-macro' and
`LaTeX-current-environment' are bound.  Also note that this
feature might slow down the reftex parsing process for large TeX
files."
  :version "24.4"
  :group 'reftex-defining-label-environments
  :type '(repeat string))