Function: allout-outlinify-sticky

allout-outlinify-sticky is an autoloaded, interactive and byte-compiled function defined in allout.el.gz.

Signature

(allout-outlinify-sticky &optional ARG)

Documentation

Activate outline mode and establish file var so it is started subsequently.

See allout-layout and customization of allout-auto-activation for details on preparing Emacs for automatic allout activation.

Probably introduced at or before Emacs version 29.1.

Key Bindings

Aliases

outlineify-sticky (obsolete since 29.1) outlinify-sticky (obsolete since 29.1)

Source Code

;; Defined in /usr/src/emacs/lisp/allout.el.gz
;;;###autoload
(defun allout-outlinify-sticky (&optional _arg)
  "Activate outline mode and establish file var so it is started subsequently.

See `allout-layout' and customization of `allout-auto-activation'
for details on preparing Emacs for automatic allout activation."
  (interactive "P")
  (if (allout-mode-p) (allout-mode))    ; deactivate so we can re-activate...
  (allout-mode)

  (save-excursion
    (goto-char (point-min))
    (if (allout-goto-prefix)
	t
      (allout-open-topic 2)
      (insert (substitute-command-keys
               (concat "Dummy outline topic header -- see"
                       " `allout-mode' docstring: \\[describe-mode]")))
      (allout-adjust-file-variable
       "allout-layout" (or allout-layout '(-1 : 0))))))