]> git.eshelyaron.com Git - emacs.git/commitdiff
Document outline-default-state
authorLars Ingebrigtsen <larsi@gnus.org>
Tue, 22 Mar 2022 22:36:24 +0000 (23:36 +0100)
committerLars Ingebrigtsen <larsi@gnus.org>
Tue, 22 Mar 2022 22:36:24 +0000 (23:36 +0100)
* doc/emacs/text.texi (Outline Visibility): Mention
outline-default-state.

doc/emacs/text.texi
etc/NEWS

index 9f152f1cc1403573f08b4714ff7aabadf4b031b3..fa8eaf092454052c18f0b72d12c1cc475e13d3ae 100644 (file)
@@ -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
 
index 0223188acc083a53c99c08ad400bf1acb2e26397..51df594a443452675a85b10d3b964818cd53e7f8 100644 (file)
--- 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