From: Lars Ingebrigtsen <larsi@gnus.org>
Date: Tue, 22 Mar 2022 22:36:24 +0000 (+0100)
Subject: Document outline-default-state
X-Git-Tag: emacs-29.0.90~1931^2~978
X-Git-Url: http://git.eshelyaron.com/gitweb/?a=commitdiff_plain;h=40def769fa9007f0a8da3f9e05063575c9a06be6;p=emacs.git

Document outline-default-state

* doc/emacs/text.texi (Outline Visibility): Mention
outline-default-state.
---

diff --git a/doc/emacs/text.texi b/doc/emacs/text.texi
index 9f152f1cc14..fa8eaf09245 100644
--- a/doc/emacs/text.texi
+++ b/doc/emacs/text.texi
@@ -1259,6 +1259,17 @@ and related functions treat hidden text, @pxref{Query Replace}.)
 You can also automatically make text visible as you navigate in it by
 using Reveal mode (@kbd{M-x reveal-mode}), a buffer-local minor mode.
 
+@vindex outline-default-state
+  The @code{outline-default-state} variable controls what headings
+will be visible after Outline mode is turned on.  If non-@code{nil},
+some headings are initially outlined.  If equal to a number, show only
+headings up to and including the corresponding level.  If equal to
+@code{outline-show-all}, all text of buffer is shown.  If equal to
+@code{outline-show-only-headings}, show only headings, whatever their
+level is.  If equal to a lambda function or function name, this
+function is expected to toggle headings visibility, and will be called
+without arguments after the mode is enabled.
+
 @node Outline Views
 @subsection Viewing One Outline in Multiple Views
 
diff --git a/etc/NEWS b/etc/NEWS
index 0223188acc0..51df594a443 100644
--- a/etc/NEWS
+++ b/etc/NEWS
@@ -388,6 +388,7 @@ displayed, if any.
 
 ** Outline Mode
 
++++
 *** Support for customizing the default visibility state of headings.
 Customize the user option 'outline-default-state' to define what
 headings will be visible after Outline mode is turned on.  When equal