File: enriched.el.html
This file implements reading, editing, and saving files with text-properties such as faces, levels of indentation, and true line breaks distinguished from newlines just used to fit text into the window.
The file format used is the MIME text/enriched format, which is a standard format defined in internet RFC 1563. All standard annotations are supported except for <smaller> and <bigger>, which are currently not possible to display.
A separate file, enriched.txt, contains further documentation and other important information about this code. It also serves as an example file in text/enriched format. It should be in the etc directory of your Emacs distribution.
Defined variables (12)
enriched-allow-eval-in-display-props | If non-nil, allow evaluating arbitrary forms in display properties. |
enriched-annotation-format | General format of enriched-text annotations. |
enriched-annotation-regexp | Regular expression matching enriched-text annotations. |
enriched-ignore | Properties that are OK to ignore when saving text/enriched files. |
enriched-initial-annotation | What to insert at the start of a text/enriched file. |
enriched-mode | Non-nil if Enriched mode is enabled. |
enriched-mode-hook | Hook run after entering/leaving Enriched mode. |
enriched-mode-map | Keymap for Enriched mode. |
enriched-old-bindings | Store old variable values that we change when entering mode. |
enriched-par-props | Text-properties that usually apply to whole paragraphs. |
enriched-translations | List of definitions of text/enriched annotations. |
enriched-verbose | If non-nil, give status messages when reading and writing files. |
Defined functions (18)
enriched-decode | (FROM TO) |
enriched-decode-background | (FROM TO &optional COLOR) |
enriched-decode-charset | (FROM TO &optional CSET) |
enriched-decode-display-prop | (START END &optional PARAM) |
enriched-decode-foreground | (FROM TO &optional COLOR) |
enriched-encode | (FROM TO ORIG-BUF) |
enriched-encode-other-face | (OLD NEW) |
enriched-face-ans | (FACE) |
enriched-get-file-width | () |
enriched-handle-charset-prop | (OLD NEW) |
enriched-handle-display-prop | (OLD NEW) |
enriched-insert-indentation | (&optional FROM TO) |
enriched-make-annotation | (INTERNAL-ANN POSITIVE) |
enriched-map-property-regions | (PROP FUNC &optional FROM TO) |
enriched-mode | (&optional ARG) |
enriched-next-annotation | () |
enriched-remove-header | () |
enriched-toggle-markup | () |
Defined faces (2)
excerpt | Face used for text that is an excerpt from another document. This is used in Enriched mode for text explicitly marked as an excerpt. |
fixed | Face used for text that must be shown in fixed width. Currently, Emacs can only display fixed-width fonts, but this may change. This face is used for text specifically marked as fixed-width, for example in text/enriched files. |