Variable: TeX-fold-begin-end-spec-list

TeX-fold-begin-end-spec-list is a customizable variable defined in tex-fold.el.

Value

((("↴" . "↲") ("itemize" "enumerate" "description" "frame"))
 ((TeX-fold-format-titled-block . "◼") ("block"))
 ((TeX-fold-format-titled-alertblock . "◼") ("alertblock"))
 ((TeX-fold-format-theorem-environment . "□") ("proof"))
 ((TeX-fold-format-theorem-environment . "◼")
  ("abstract" "acknowledgment" "algorithm" "assumptions" "claim"
   "commentary" "fact" "note" "questions" ("answer" "ans")
   ("conclusion" "conc") ("condition" "cond") ("conjecture" "conj")
   ("corollary" "cor") ("criterion" "crit")
   ("definition" "def" "defn") ("example" "ex") ("exercise" "exer")
   ("lemma" "lem") ("notation" "not") ("problem" "prob")
   ("proposition" "prop") ("question" "ques") ("remark" "rem" "rmk")
   ("summary" "sum") ("terminology" "term") ("theorem" "thm"))))

Documentation

Replacement specifier list for \begin{env} and \end{env} macros.

This option is relevant only if the replacement specifiers in TeX-fold-macro-spec-list for "begin" and "end" macros are the defaults, namely TeX-fold-begin-display and TeX-fold-end-display.

Each item is a list consisting of two elements:

The first element is a cons cell, with car and cdr the display
specifications for \begin{...} and \end{...} macros, respectively.
Each specification is either

  - a string, used as the fold display string, or

  - a function, called with the (unabbreviated) environment name and a
    list consisting of the remaining mandatory macro arguments, that
    returns a string.

The second element is a list of environment types, which are either

- the environment name, e.g., "remark", or

- a list with first element an environment name and remaining elements
  any abbreviated environment names, e.g., ("remark" "rem" "rmk").

This variable was added, or its default value changed, in auctex version 14.0.8.

Source Code

;; Defined in ~/.emacs.d/elpa/auctex-14.1.2/tex-fold.el
;;;; begin/end

(defcustom TeX-fold-begin-end-spec-list
  '((("↴" . "↲")
     ("itemize" "enumerate" "description" "frame"))
    ((TeX-fold-format-titled-block . "◼")
     ("block"))
    ((TeX-fold-format-titled-alertblock . "◼")
     ("alertblock"))
    ((TeX-fold-format-theorem-environment . "□")
     ("proof"))
    ((TeX-fold-format-theorem-environment . "◼")
     ("abstract"
      "acknowledgment"
      "algorithm"
      "assumptions"
      "claim"
      "commentary"
      "fact"
      "note"
      "questions"
      ("answer" "ans")
      ("conclusion" "conc")
      ("condition" "cond")
      ("conjecture" "conj")
      ("corollary" "cor")
      ("criterion" "crit")
      ("definition" "def" "defn")
      ("example" "ex")
      ("exercise" "exer")
      ("lemma" "lem")
      ("notation" "not")
      ("problem" "prob")
      ("proposition" "prop")
      ("question" "ques")
      ("remark" "rem" "rmk")
      ("summary" "sum")
      ("terminology" "term")
      ("theorem" "thm"))))
  "Replacement specifier list for \\begin{env} and \\end{env} macros.

This option is relevant only if the replacement specifiers in
`TeX-fold-macro-spec-list' for \"begin\" and \"end\" macros are the
defaults, namely `TeX-fold-begin-display' and `TeX-fold-end-display'.

Each item is a list consisting of two elements:

The first element is a cons cell, with car and cdr the display
specifications for \\begin{...} and \\end{...}  macros, respectively.
Each specification is either

  - a string, used as the fold display string, or

  - a function, called with the (unabbreviated) environment name and a
    list consisting of the remaining mandatory macro arguments, that
    returns a string.

The second element is a list of environment types, which are either

- the environment name, e.g., \"remark\", or

- a list with first element an environment name and remaining elements
  any abbreviated environment names, e.g., (\"remark\" \"rem\" \"rmk\")."
  :type '(repeat
          (group
           (cons (choice (string :tag "Display String for \\begin{...}")
                         (function :tag "Function to execute for \\begin{...}"))
                 (choice (string :tag "Display String for \\end{...}")
                         (function :tag "Function to execute for \\end{...}")))
           (repeat :tag "Environment Types"
                   (choice (string :tag "Environment")
                           (cons :tag "Environment and Abbreviations"
                                 (string :tag "Environment")
                                 (repeat :tag "Abbreviations"
                                         (string :tag "Abbreviation")))))))
  :package-version '(auctex . "14.0.8"))