]> git.eshelyaron.com Git - emacs.git/commitdiff
* doc/emacs/text.texi (Outline Minor Mode): Add a note about value 'insert'.
authorJuri Linkov <juri@linkov.net>
Wed, 13 Sep 2023 16:49:29 +0000 (19:49 +0300)
committerJuri Linkov <juri@linkov.net>
Wed, 13 Sep 2023 16:49:29 +0000 (19:49 +0300)
* lisp/outline.el (outline-minor-mode-use-buttons): Add a note and
a comment about the value 'insert' (bug#65874).

doc/emacs/text.texi
lisp/outline.el

index 7037c8c943a21a33b2bb586c2f24179694b0a0af..0691cc7b78b38109e7eefddcde2bd650aaea6a5f 100644 (file)
@@ -1020,10 +1020,11 @@ addition to ellipsis, to show that a section is hidden.  Clicking the
 mouse on the button toggles display of the section.  If the value of
 this variable is @code{insert}, the buttons are inserted directly into
 the buffer text, so @key{RET} on the button will also toggle display
-of the section, like a mouse click does.  If the value is
-@code{in-margins}, Outline minor mode will use the window margins to
-indicate that a section is hidden.  The buttons are customizable as icons
-(@pxref{Icons}).
+of the section, like a mouse click does.  Using the value @code{insert}
+is not recommended in editable buffers because it modifies them.
+If the value is @code{in-margins}, Outline minor mode will use the
+window margins to indicate that a section is hidden.  The buttons are
+customizable as icons (@pxref{Icons}).
 
 @vindex outline-minor-mode-cycle
   If the @code{outline-minor-mode-cycle} user option is
index 97a51c9b92a5ece144e039bf240882cd83e681cb..d8dd491212e1a158eeeeed4a1d47b5b21e2227ad 100644 (file)
@@ -314,12 +314,15 @@ These buttons can be used to hide and show the body under the heading.
 When the value is `insert', additional placeholders for buttons are
 inserted to the buffer, so buttons are not only clickable,
 but also typing `RET' on them can hide and show the body.
+Using the value `insert' is not recommended in editable
+buffers because it modifies them.
 When the value is `in-margins', then clickable buttons are
 displayed in the margins before the headings.
 When the value is `t', clickable buttons are displayed
 in the buffer before the headings.  The values `t' and
 `in-margins' can be used in editing buffers because they
 don't modify the buffer."
+  ;; The value `insert' is not intended to be customizable.
   :type '(choice (const :tag "Do not use outline buttons" nil)
                  (const :tag "Show outline buttons in margins" in-margins)
                  (const :tag "Show outline buttons in buffer" t))