File: allout.el.html
Allout outline minor mode provides extensive outline formatting and manipulation beyond standard Emacs outline mode. Some features:
- Classic outline-mode topic-oriented navigation and exposure adjustment
- Topic-oriented editing including coherent topic and subtopic
creation, promotion, demotion, cut/paste across depths, etc.
- Incremental search with dynamic exposure and reconcealment of text
- Customizable bullet format -- enables programming-language specific
outlining, for code-folding editing. (Allout code itself is to try it;
formatted as an outline -- do ESC-x eval-buffer in allout.el; but
Emacs local file variables need to be enabled when the
file was visited -- see enable-local-variables.)
- Configurable per-file initial exposure settings
- Symmetric-key and key-pair topic encryption. Encryption is via the
Emacs 'epg' library. See allout-toggle-current-subtree-encryption
docstring.
- Automatic topic-number maintenance
- "Hot-spot" operation, for single-keystroke maneuvering and
exposure control (see the allout-mode docstring)
- Easy rendering of exposed portions into numbered, latex, indented, etc
outline styles
- Careful attention to whitespace -- enabling blank lines between items
and maintenance of hanging indentation (in paragraph auto-fill and
across topic promotion and demotion) of topic bodies consistent with
indentation of their topic header.
and more.
See the allout-mode(var)/allout-mode(fun) function's docstring for an introduction to the
mode.
Directions to the latest development version and helpful notes are available at https://myriadicity.net/software-and-systems/craft/emacs-allout .
The outline menubar additions provide quick reference to many of the
features. See the docstring of the variables allout-layout and
allout-auto-activation for details on automatic activation of
allout-mode(var)/allout-mode(fun) as a minor mode.
Note -- the lines beginning with ;;;_ are outline topic headers.
Customize allout-auto-activation to enable, then revisit this
buffer to give it a whirl.
ken manheimer (ken dot manheimer at gmail dot com)
Defined variables (76)
allout-after-copy-or-kill-hook | Normal hook run after copying outline text.. |
allout-after-save-decrypt | Internal variable, is nil or has the value of two points: |
allout-auto-activation | Configure allout outline mode auto-activation. |
allout-auto-save-temporarily-disabled | Non-nil while topic encryption is pending and auto-saving was active. |
allout-beginning-of-line-cycles | If non-nil, M-x allout-beginning-of-line will cycle through smart-placement options. |
allout-bob-regexp | Like ‘allout-line-boundary-regexp’, for headers at beginning of buffer. |
allout-body-line-style | Font and size of entries for LaTeX formatting of an outline. |
allout-bullets-string | A string dictating the valid set of outline topic bullets. |
allout-bullets-string-len | Length of current buffers’ ‘allout-plain-bullets-string’. |
allout-command-counter | Counter that monotonically increases in ‘allout-mode’ buffers. |
allout-command-prefix | Key sequence to be used as prefix for outline mode command key bindings. |
allout-default-layout | Default allout outline layout specification. |
allout-depth-one-regexp | Regular expression to match a heading line prefix for depth one. |
allout-depth-specific-regexp | Regular expression to match a heading line prefix for a particular depth. |
allout-distinctive-bullets-string | Persistent outline header bullets used to distinguish special topics. |
allout-doublecheck-at-and-shallower | Validate apparent topics of this depth and shallower as being non-aberrant. |
allout-enable-file-variable-adjustment | If non-nil, some allout outline actions edit Emacs local file var text. |
allout-encrypt-unencrypted-on-saves | If non-nil, topics pending encryption are encrypted during buffer saves. |
allout-encryption-ciphertext-rejection-ceiling | Limit on number of times encryption ciphertext is rejected. |
allout-encryption-ciphertext-rejection-regexps | Variable for regexps matching plaintext to remove before encryption. |
allout-encryption-plaintext-sanitization-regexps | List of regexps whose matches are removed from plaintext before encryption. |
allout-end-of-line-cycles | If non-nil, M-x allout-end-of-line will cycle through smart-placement options. |
allout-explicitly-deactivated | If t, ‘allout-mode’s last deactivation was deliberate. |
allout-exposure-category | Symbol for use as allout invisible-text overlay category. |
allout-exposure-change-functions | Abnormal hook run after allout outline subtree exposure changes. |
allout-file-xref-bullet | Bullet signifying file cross-references, for ‘allout-resolve-xref’. |
allout-flattened-numbering-abbreviation | If non-nil, ‘allout-flatten-exposed-to-buffer’ abbreviates topic |
allout-former-auto-filler | Name of modal fill function being wrapped by ‘allout-auto-fill’. |
allout-head-line-style | Font and size of entries for LaTeX formatting of an outline. |
allout-header-prefix | Leading string which helps distinguish topic headers. |
allout-header-subtraction | Allout-header prefix length to subtract when computing topic depth. |
allout-indent | LaTeX formatted depth-indent spacing. |
allout-inhibit-aberrance-doublecheck | Internal state, for momentarily inhibits aberrance doublecheck. |
allout-inhibit-auto-fill | If non-nil, auto-fill will be inhibited in the allout buffers. |
allout-inhibit-auto-fill-on-headline | If non-nil, auto-fill will be inhibited while on topic’s header line. |
allout-just-did-undo | Non-nil just after undo commands, until allout-post-command-business. |
allout-label-style | Font and size of labels for LaTeX formatting of an outline. |
allout-layout | Buffer-specific setting for allout layout. |
allout-line-boundary-regexp | ‘allout-regexp’ prepended with a newline for the search target. |
allout-line-skip | Space between lines for LaTeX formatting of an outline. |
allout-mode | Non-nil if Allout mode is enabled. |
allout-mode-hook | Hook run when allout mode starts. |
allout-mode-leaders | Specific allout-prefix leading strings per major modes. |
allout-mode-map | Keymap for ‘allout-mode’. |
allout-mode-map-value | Keymap for allout outline minor mode. |
allout-mode-prior-settings | Internal ‘allout-mode’ use; settings to be resumed on mode deactivation. |
allout-number-pages | Non-nil turns on page numbering for LaTeX formatting of an outline. |
allout-numbered-bullet | String designating bullet of topics that have auto-numbering; nil for none. |
allout-old-style-prefixes | When non-nil, use only old-and-crusty ‘outline-mode’ ‘*’ topic prefixes. |
allout-outside-normal-auto-fill-function | Value of ‘normal-auto-fill-function’ outside of allout mode. |
allout-plain-bullets-string | The bullets normally used in outline topic prefixes. |
allout-plain-bullets-string-len | Length of ‘allout-plain-bullets-string’, updated by ‘allout-set-regexp’. |
allout-post-goto-bullet | Outline internal var, for ‘allout-pre-command-business’ hot-spot operation. |
allout-post-undo-hook | Normal hook run after undo activity. |
allout-prefixed-keybindings | Allout-mode key bindings that are prefixed with ‘allout-command-prefix’. |
allout-presentation-padding | Presentation-format white-space padding factor, for greater indent. |
allout-primary-bullet | Bullet used for top-level outline topics. |
allout-recent-depth | Depth of the last topic prefix encountered. |
allout-recent-end-of-subtree | Buffer point last returned by ‘allout-end-of-current-subtree’. |
allout-recent-prefix-beginning | Buffer point of the start of the last topic prefix encountered. |
allout-recent-prefix-end | Buffer point of the end of the last topic prefix encountered. |
allout-regexp | Regular expression to match the beginning of a heading line. |
allout-reindent-bodies | Non-nil enables auto-adjust of topic body hanging indent with depth shifts. |
allout-show-bodies | If non-nil, show entire body when exposing a topic, rather than just the header. |
allout-structure-added-functions | Abnormal hook run after adding items to an Allout outline. |
allout-structure-deleted-functions | Abnormal hook run after deleting subtrees from an Allout outline. |
allout-structure-shifted-functions | Abnormal hook run after shifting items in an Allout outline. |
allout-stylish-prefixes | Do fancy stuff with topic prefix bullets according to level, etc. |
allout-this-command-hid-text | Non-nil if the most recent ‘allout-mode’ command hid any text. |
allout-title | Expression to evaluate to determine the title for LaTeX formatted copy. |
allout-title-style | Font and size of titles for LaTeX formatting of an outline. |
allout-topic-encryption-bullet | Bullet signifying encryption of the entry’s body. |
allout-unprefixed-keybindings | Allout-mode functions bound to keys without any added prefix. |
allout-use-hanging-indents | If non-nil, topic body text auto-indent defaults to indent of the header. |
allout-use-mode-specific-leader | When non-nil, use mode-specific topic-header prefixes. |
allout-version | Version of currently loaded allout.el package. |