comparison lisp/textmodes/reftex.el @ 18220:36a61aa59b9d

(tex-main-file, outline-minor-mode): Add defvars.

18219:aaeaae005e98

;; reftex.el --- Minor mode for doing \label, \ref and \cite in LaTeX
;; Copyright (c) 1997 Free Software Foundation, Inc.

;; Author:     Carsten Dominik <[e-mail]>
;; Keywords:   tex

  :group 'reftex-label-support)


(defcustom reftex-label-alist nil
  "Alist with information on environments for \\label-\\ref use.
See the definition of reftex-label-alist-builtin for examples. This variable
should define additions and changes to the default.  The only things you MUST
NOT change is that '?s' is the type indicator for section labels and SPACE is
for the 'any' label type. These are hard-coded at other places in the code.

Changes to this variable after reftex.el has been loaded become only
effective when RefTeX is reset with \\[reftex-reset-mode].

Each list entry is a list describing an environment or macro carrying a
label. The elements of each list entry are:

0.  Name of the environment (like \"table\") or macro (like \"\\\\myfig\").
    Special names: `section' for section labels, `any' to define a group
    which contains all labels.
    This may also be nil if this entry is only meant to change some settings
    associated with the type indicator character (see below).

1.  Type indicator character, like ?t.
    The type indicator is a single character used in prompts for
    label types. It must be a printable character. The same character
    may occur several times in this list, to cover cases in which different
    environments carry the same label type (like equation and eqnarray).

2.  Label prefix string, like \"tab:\".
    The prefix is a short string used as the start of a label. It may be the
    empty string.

3.  Format string for reference insert in buffer. Each %s will be replaced by
    the label (yes, several %s can be in there, so that you can set this to:
    \"\\ref{%s} on page~\\pageref{%s}\").
    When the format starts with ~, whitespace before point will be removed so
    that the reference cannot be separated from the word before it.

4.  Indication on how to find the short context.
    - If `nil', use the text following the \\label{...} macro.
    - If `t', use
       - text following the \\begin{...} statement of environments
         (not a good choice in in eqnarray or enumerate environments!)
       - the section heading for section labels.
       - the begin of the macro for macros.
    - If a string, use as regexp to search *backward* from the label. Context
      is then the text following the end of the match. E.g. putting this to
      \"\\\\\\\\caption{\" will use the beginning of the caption in a figure
      or table environment. \"\\\\\\\\begin{eqnarray}\\\\|\\\\\\\\\\\\\\\\\"
      works for eqnarrays.
    - If a function, call this function with the name of the environment/macro
      as argument. On call, point will be just after the \\label macro. The
      function is expected to return a suitable context string. It should
      throw an exception (error) when failing to find context.
      Consider the following example, which would return the 10 characters
      following the label as context:

        (defun my-context-function (env-or-mac)
          (if (> (point-max) (+ 10 (point)))
              (buffer-substring (point) (+ 10 (point)))
            (error \"Buffer too small\")))

    Setting the variable reftex-use-text-after-label-as-context to t overrides
    the setting here.

5.  List of magic words which identify a reference to be of this type. If the
    word before point is equal to one of these words when calling
    reftex-reference, the label list offered will be automatically restricted
    to labels of the correct type.

If the type indicator characters of two or more entries are the same, RefTeX
will use
 - the first non-nil format and prefix
 - the magic words of all involved entries.

Any list entry may also be a symbol. If that has an association in
reftex-label-alist-builtin, the cdr of that association is spliced into the
list. See the AMSTeX configuration example in the comment section of
reftex.el."
  :group 'reftex-defining-label-environments
  :set 'reftex-set-dirty
  :type '(list 
   :convert-widget 
    (lambda (widget) 

;; This list is used to tie, untie, and reset these symbols.
(defconst reftex-multifile-symbols
  '(reftex-label-numbers-symbol reftex-list-of-labels-symbol
                               reftex-bibfile-list-symbol))

;; Silence warnings about TeX-master, which is defined in AUCTeX
(defvar TeX-master)

;; Alist connecting master file names with the corresponding lisp symbols
(defvar reftex-master-index-list nil)

;; Last index used for a master file
(defvar reftex-multifile-index 0)

18220:36a61aa59b9d

;; reftex.el --- Minor mode for doing \label, \ref and \cite in LaTeX

;; Copyright (c) 1997 Free Software Foundation, Inc.

;; Author:     Carsten Dominik <[e-mail]>
;; Keywords:   tex

  :group 'reftex-label-support)


(defcustom reftex-label-alist nil
  "Alist with information on environments for \\label-\\ref use.
See the definition of `reftex-label-alist-builtin' for examples.  This variable
should define additions and changes to the default.  The only things you MUST
NOT change is that `?s' is the type indicator for section labels and SPACE is
for the 'any' label type.  These are hard-coded at other places in the code.

Changes to this variable after RefTeX has been loaded only become
effective when RefTeX is reset with \\[reftex-reset-mode].

Each list entry is a list describing an environment or macro carrying a
label.  The elements of each list entry are:

0.  Name of the environment (like \"table\") or macro (like \"\\\\myfig\").
    Special names: `section' for section labels, `any' to define a group
    which contains all labels.
    This may also be nil if this entry is only meant to change some settings
    associated with the type indicator character (see below).

1.  Type indicator character, like ?t.
    The type indicator is a single character used in prompts for
    label types.  It must be a printable character.  The same character
    may occur several times in this list, to cover cases in which different
    environments carry the same label type (like equation and eqnarray).

2.  Label prefix string, like \"tab:\".
    The prefix is a short string used as the start of a label.  It may be the
    empty string.

3.  Format string for reference insert in buffer.  Each `%s' will be
    replaced by the label (you can use more than one several `%s', so
    that you can set this to: \"\\ref{%s} on page~\\pageref{%s}\").
    When the format starts with `~', whitespace before point will be
    removed so that the reference cannot be separated from the word
    before it.

4.  Indication on how to find the short context.
    - If nil, use the text following the \\label{...} macro.
    - If t, use
       - text following the \\begin{...} statement of environments
         (not a good choice in in eqnarray or enumerate environments!)
       - the section heading for section labels.
       - the begin of the macro for macros.
    - If a string, use as regexp to search *backward* from the label.  Context
      is then the text following the end of the match.  E.g. putting this to
      \"\\\\\\\\caption{\" will use the beginning of the caption in a figure
      or table environment.  \"\\\\\\\\begin{eqnarray}\\\\|\\\\\\\\\\\\\\\\\"
      works for eqnarrays.
    - If a function, call this function with the name of the environment/macro
      as argument.  On call, point will be just after the \\label macro.  The
      function is expected to return a suitable context string.  It should
      throw an exception (error) when failing to find context.
      Consider the following example, which would return the 10 characters
      following the label as context:

        (defun my-context-function (env-or-mac)
          (if (> (point-max) (+ 10 (point)))
              (buffer-substring (point) (+ 10 (point)))
            (error \"Buffer too small\")))

    Setting the variable `reftex-use-text-after-label-as-context' to t
    overrides the setting here.

5.  List of magic words which identify a reference to be of this type.  If the
    word before point is equal to one of these words when calling
    `reftex-reference', the label list offered will be automatically restricted
    to labels of the correct type.

If the type indicator characters of two or more entries are the same, RefTeX
will use
 - the first non-nil format and prefix
 - the magic words of all involved entries.

Any list entry may also be a symbol.  If that has an association in
reftex-label-alist-builtin, the cdr of that association is spliced into the
list.  See the AMSTeX configuration example in the comment section of
`reftex.el'."
  :group 'reftex-defining-label-environments
  :set 'reftex-set-dirty
  :type '(list 
   :convert-widget 
    (lambda (widget) 

;; This list is used to tie, untie, and reset these symbols.
(defconst reftex-multifile-symbols
  '(reftex-label-numbers-symbol reftex-list-of-labels-symbol
                               reftex-bibfile-list-symbol))

;; Silence warnings about TeX-master, which is defined in AUCTeX.
(defvar TeX-master)

;; Silence additional warnings.
(defvar tex-main-file)
(defvar outline-minor-mode)

;; Alist connecting master file names with the corresponding Lisp symbols.
(defvar reftex-master-index-list nil)

;; Last index used for a master file
(defvar reftex-multifile-index 0)