Variable: org-fold-core--specs

org-fold-core--specs is a buffer-local variable defined in org-fold-core.el.gz.

Documentation

Folding specs defined in current buffer.

Each spec is a list (SPEC-SYMBOL SPEC-PROPERTIES). SPEC-SYMBOL is the symbol representing the folding spec. SPEC-PROPERTIES is an alist defining folding spec properties.

If a text region is folded using multiple specs, only the folding spec listed earlier is used.

The following properties are known:
- :ellipsis :: must be nil or string to show when text is folded
                      using this spec.
- :global :: non-nil means that folding state will be preserved
                      when copying folded text between buffers.
- :isearch-ignore :: non-nil means that folded text is not searchable
                      using isearch.
- :isearch-open :: non-nil means that isearch can reveal text hidden
                      using this spec. This property does nothing
                      when isearch-ignore property is non-nil.
- :front-sticky :: non-nil means that text prepended to the folded text
                      is automatically folded.
- :rear-sticky :: non-nil means that text appended to the folded text
                      is folded.
- :visible :: non-nil means that folding spec visibility is not
                       managed. Instead, visibility settings in
                       buffer-invisibility-spec will be used as is.
                       Note that changing this property from nil to t may
                       clear the setting in buffer-invisibility-spec.
- :font-lock :: non-nil means that newlines after the fold should
                       be re-fontified upon folding/unfolding. See
                       org-activate-folds.
- :alias :: a list of aliases for the SPEC-SYMBOL.
- :fragile :: Must be a function accepting two arguments.
                       Non-nil means that changes in region may cause
                       the region to be revealed. The region is
                       revealed after changes if the function returns
                       non-nil.
                       The function called after changes are made with
                       two arguments: cons (beg . end) representing the
                       folded region and spec symbol.

Source Code

;; Defined in /usr/src/emacs/lisp/org/org-fold-core.el.gz
;;; Core functionality

;;;; Folding specs

(defvar-local org-fold-core--specs '((org-fold-visible
                         (:visible . t)
                         (:alias . (visible)))
                        (org-fold-hidden
			 (:ellipsis . "...")
                         (:isearch-open . t)
                         (:alias . (hidden))))
  "Folding specs defined in current buffer.

Each spec is a list (SPEC-SYMBOL SPEC-PROPERTIES).
SPEC-SYMBOL is the symbol representing the folding spec.
SPEC-PROPERTIES is an alist defining folding spec properties.

If a text region is folded using multiple specs, only the folding spec
listed earlier is used.

The following properties are known:
- :ellipsis         :: must be nil or string to show when text is folded
                      using this spec.
- :global           :: non-nil means that folding state will be preserved
                      when copying folded text between buffers.
- :isearch-ignore   :: non-nil means that folded text is not searchable
                      using isearch.
- :isearch-open     :: non-nil means that isearch can reveal text hidden
                      using this spec.  This property does nothing
                      when `isearch-ignore' property is non-nil.
- :front-sticky     :: non-nil means that text prepended to the folded text
                      is automatically folded.
- :rear-sticky      :: non-nil means that text appended to the folded text
                      is folded.
- :visible          :: non-nil means that folding spec visibility is not
                       managed.  Instead, visibility settings in
                       `buffer-invisibility-spec' will be used as is.
                       Note that changing this property from nil to t may
                       clear the setting in `buffer-invisibility-spec'.
- :font-lock        :: non-nil means that newlines after the fold should
                       be re-fontified upon folding/unfolding.  See
                       `org-activate-folds'.
- :alias            :: a list of aliases for the SPEC-SYMBOL.
- :fragile          :: Must be a function accepting two arguments.
                       Non-nil means that changes in region may cause
                       the region to be revealed.  The region is
                       revealed after changes if the function returns
                       non-nil.
                       The function called after changes are made with
                       two arguments: cons (beg . end) representing the
                       folded region and spec symbol.")