Variable: reftex-derive-label-parameters

reftex-derive-label-parameters is a customizable variable defined in reftex-vars.el.gz.

Value

(3 20 t 1 "-"
   ("the" "on" "in" "off" "a" "for" "by" "of" "and" "is" "to")
   t)

Documentation

Parameters for converting a string into a label.

This variable is a list of the following items.

NWORDS Number of words to use.
MAXCHAR Maximum number of characters in a label string.
INVALID nil: Throw away any words containing characters invalid in labels.
            t: Throw away only the invalid characters, not the whole word.
ABBREV nil: Never abbreviate words.
            t: Always abbreviate words (see reftex-abbrev-parameters).
            not t and not nil: Abbreviate words if necessary to shorten
                               label string below MAXCHAR.
SEPARATOR String separating different words in the label.
IGNOREWORDS List of words which should not be part of labels.
DOWNCASE t: Downcase words before using them.

Source Code

;; Defined in /usr/src/emacs/lisp/textmodes/reftex-vars.el.gz
(defcustom reftex-derive-label-parameters '(3 20 t 1 "-"
         ("the" "on" "in" "off" "a" "for" "by" "of" "and" "is" "to") t)
  "Parameters for converting a string into a label.
This variable is a list of the following items.

NWORDS      Number of words to use.
MAXCHAR     Maximum number of characters in a label string.
INVALID     nil: Throw away any words containing characters invalid in labels.
            t:   Throw away only the invalid characters, not the whole word.
ABBREV      nil: Never abbreviate words.
            t:   Always abbreviate words (see `reftex-abbrev-parameters').
            not t and not nil: Abbreviate words if necessary to shorten
                               label string below MAXCHAR.
SEPARATOR   String separating different words in the label.
IGNOREWORDS List of words which should not be part of labels.
DOWNCASE    t:   Downcase words before using them."
  :group 'reftex-making-and-inserting-labels
  :type  '(list (integer :tag "Number of words            "  3)
                (integer :tag "Maximum label length       " 20)
                (choice  :tag "Invalid characters in words"
                         (const :tag "throw away entire word" nil)
                         (const :tag "throw away single chars" t))
                (choice  :tag "Abbreviate words           "
                         (const :tag "never" nil)
                         (const :tag "always" t)
                         (const :tag "when label is too long" 1))
                (string  :tag "Separator between words    " "-")
                (repeat  :tag "Ignore words"
                         :entry-format "           %i %d %v"
                         (string :tag ""))
                (option (boolean :tag "Downcase words          "))))