File: outline.el.html

This package is a major mode for editing outline-format documents.

An outline can be abstracted to show headers at any given level, with all stuff below hidden. See the Emacs manual for details.

Defined variables (32)

outline--button-iconsA list of pre-computed button icons.
outline--cycle-buffer-stateInternal variable used for tracking buffer cycle state.
outline--margin-widthCurrent margin width.
outline--use-rtlNon-nil when direction of clickable buttons is right-to-left.
outline-blank-lineNon-nil means to leave an unhidden blank line before headings.
outline-default-line-countMinimal number of lines for a heading to be outlined.
outline-default-long-lineMinimal number of characters in a line for a heading to be outlined.
outline-default-rulesDetermines visibility of subtree starting at ‘outline-default-state’ level.
outline-default-stateIf non-nil, some headings are initially outlined.
outline-font-lock-keywordsAdditional expressions to highlight in Outline mode.
outline-heading-alistAlist associating a heading for every possible level.
outline-heading-end-regexpRegular expression to match the end of a heading line.
outline-imenu-generic-expressionValue for ‘imenu-generic-expression’ in Outline mode.
outline-isearch-open-invisible-functionFunction called if ‘isearch’ finishes in an invisible overlay.
outline-levelFunction of no args to compute a header’s nesting level in an outline.
outline-margin-widthDefault margin width.
outline-minor-modeNon-nil if Outline minor mode is enabled.
outline-minor-mode-cycleEnable visibility-cycling commands on headings in ‘outline-minor-mode’.
outline-minor-mode-cycle-filterControl where on a heading the visibility-cycling commands are bound to keys.
outline-minor-mode-cycle-mapKeymap used as a parent of the ‘outline-minor-mode’ keymap.
outline-minor-mode-highlightWhether to highlight headings in ‘outline-minor-mode’ using font-lock keywords.
outline-minor-mode-hookHook run after entering or leaving ‘outline-minor-mode’.
outline-minor-mode-mapKeymap for ‘outline-minor-mode’.
outline-minor-mode-prefixPrefix key to use for Outline commands in Outline minor mode.
outline-minor-mode-use-buttonsWhether to display clickable buttons on the headings.
outline-mode-abbrev-tableAbbrev table for ‘outline-mode’.
outline-mode-hookThis hook is run when outline mode starts.
outline-mode-mapKeymap for ‘outline-mode’.
outline-mode-syntax-tableSyntax table for ‘outline-mode’.
outline-regexpRegular expression to match the beginning of a heading.
outline-search-functionFunction to search the next outline heading.
outline-view-change-hookNormal hook to be run after outline visibility changes.

Defined functions (79)

hide-body()
hide-entry()
hide-leaves()
hide-other()
hide-region-body(START END)
hide-subtree(&optional EVENT)
outline--cycle-state()
outline--end-of-previous()
outline--fix-buttons(&optional BEG END)
outline--fix-up-all-buttons(FROM TO)
outline--hidden-headings-paths()
outline--hidden-headings-restore-paths(PATHS CURRENT-PATH)
outline--insert-button(TYPE)
outline--remove-buttons(BEG END)
outline--show-headings-up-to-level(LEVEL)
outline-apply-default-state()
outline-back-to-heading(&optional INVISIBLE-OK)
outline-backward-same-level(ARG)
outline-cycle(&optional EVENT)
outline-cycle-buffer(&optional LEVEL)
outline-demote(&optional WHICH)
outline-end-of-heading()
outline-end-of-subtree()
outline-flag-region(FROM TO FLAG)
outline-flag-subtree(FLAG)
outline-font-lock-face()
outline-forward-same-level(ARG)
outline-get-last-sibling()
outline-get-next-sibling()
outline-has-subheading-p()
outline-head-from-level(LEVEL HEAD &optional ALIST)
outline-headers-as-kill(BEG END)
outline-hide-body()
outline-hide-by-heading-regexp(REGEXP)
outline-hide-entry()
outline-hide-leaves()
outline-hide-other()
outline-hide-region-body(START END)
outline-hide-sublevels(LEVELS)
outline-hide-subtree(&optional EVENT)
outline-insert-heading()
outline-invent-heading(HEAD UP)
outline-invisible-p(&optional POS)
outline-isearch-open-invisible(OVERLAY)
outline-level()
outline-map-region(FUN BEG END)
outline-mark-subtree()
outline-minor-mode(&optional ARG)
outline-minor-mode-cycle--bind(MAP KEY BINDING &optional FILTER)
outline-mode()
outline-move-subtree-down(&optional ARG)
outline-move-subtree-up(&optional ARG)
outline-next-heading()
outline-next-preface()
outline-next-visible-heading(ARG)
outline-on-heading-p(&optional INVISIBLE-OK)
outline-previous-heading()
outline-previous-visible-heading(ARG)
outline-promote(&optional WHICH)
outline-reveal-toggle-invisible(O HIDEP)
outline-revert-buffer-rehighlight()
outline-revert-buffer-restore-visibility()
outline-search-level(&optional BOUND MOVE BACKWARD LOOKING-AT)
outline-search-text-property(PROPERTY &optional VALUE BOUND MOVE BACKWARD LOOKING-AT)
outline-show-all()
outline-show-branches()
outline-show-by-heading-regexp(REGEXP)
outline-show-children(&optional LEVEL)
outline-show-entry()
outline-show-heading()
outline-show-only-headings()
outline-show-subtree(&optional EVENT)
outline-toggle-children()
outline-up-heading(ARG &optional INVISIBLE-OK)
show-all()
show-branches()
show-children(&optional LEVEL)
show-entry()
show-subtree(&optional EVENT)

Defined faces (8)

outline-1Level 1.
outline-2Level 2.
outline-3Level 3.
outline-4Level 4.
outline-5Level 5.
outline-6Level 6.
outline-7Level 7.
outline-8Level 8.