File: tex-fold.el.html
This file provides support for hiding and unhiding TeX, LaTeX, ConTeXt, Texinfo and similar macros and environments inside of AUCTeX.
Caveats:
The display string of content which should display part of itself
is made by copying the text from the buffer together with its text
properties. If fontification has not happened when this is done
(e.g. because of lazy or just-in-time font locking) the intended
fontification will not show up. Maybe this could be improved by
using some sort of "lazy folding" or refreshing the window upon
scrolling. As a workaround fontification of the whole buffer
currently is forced before folding it.
Defined variables (32)
TeX-fold--spec-type | Type spec used by TeX-fold defcustoms. |
TeX-fold-alert-color | Color for alert text. |
TeX-fold-auto | If non-nil, fold macros automatically after ‘TeX-insert-macro’. |
TeX-fold-auto-reveal | Predicate to open a fold when entered. |
TeX-fold-auto-reveal-commands | List of commands that may cause a fold to be revealed. |
TeX-fold-begin-end-spec-list | Replacement specifier list for \begin{env} and \end{env} macros. |
TeX-fold-bib-files | List of BibTeX files from which to extract citation keys. |
TeX-fold-close-quote | Folded verison of closing quote. |
TeX-fold-command-prefix | Prefix key to use for commands in TeX Fold mode. |
TeX-fold-ellipsis | String used as display string for overlays instead of a zero-length string. |
TeX-fold-env-spec-list | List of display strings and environments to fold. |
TeX-fold-env-spec-list-internal | Internal list of display strings and environments to fold. |
TeX-fold-folded-face | Face for the display string of folded content. |
TeX-fold-force-fontify | Force the buffer to be fully fontified by folding it. |
TeX-fold-help-echo-max-length | Maximum length of help echo message for folded overlays. |
TeX-fold-macro-spec-list | List of replacement specifiers and macros to fold. |
TeX-fold-macro-spec-list-internal | Internal list of display strings and macros to fold. |
TeX-fold-math-spec-list | List of display strings and math macros to fold. |
TeX-fold-math-spec-list-internal | Internal list of display strings and math macros to fold. |
TeX-fold-mode | Non-nil if Tex-Fold mode is enabled. |
TeX-fold-mode-hook | Hook run after entering or leaving ‘TeX-fold-mode’. |
TeX-fold-mode-map | Keymap for ‘TeX-fold-mode’. |
TeX-fold-open-quote | Folded version of opening quote. |
TeX-fold-preserve-comments | If non-nil do not fold in comments. |
TeX-fold-quotes-on-insert | Non-nil means to automatically fold LaTeX quotes when they are inserted. |
TeX-fold-region-functions | List of additional functions to call when folding a region. |
TeX-fold-type-list | List of item types to consider when folding. |
TeX-fold-unfold-around-mark | Unfold text around the mark, if active. |
TeX-fold-unfolded-face | Face for folded content when it is temporarily opened. |
TeX-fold-unspec-env-display-string | Display string for unspecified environments. |
TeX-fold-unspec-macro-display-string | Display string for unspecified macros. |
TeX-fold-unspec-use-name | If non-nil use the name of an unspecified item as display string. |
Defined functions (11)
TeX-fold--helper-display | (ENV ARGS SPEC-RETRIEVER) |
TeX-fold--last-name | (NAME) |
TeX-fold-alert-display | (TEXT &rest ARGS) |
TeX-fold-auto-reveal-p | (MODE) |
TeX-fold-buffer-substring | (START END) |
TeX-fold-macro | () |
TeX-fold-macro-nth-arg | (N MACRO-START &optional MACRO-END DELIMS) |
TeX-fold-mode | (&optional ARG) |
TeX-fold-remove-overlays | (OVERLAYS) |
TeX-fold-section | () |
tex-fold-mode | (&optional ARG) |
Defined faces (2)
TeX-fold-folded-face | Face for the display string of folded content. |
TeX-fold-unfolded-face | Face for folded content when it is temporarily opened. |