unofficial mirror of bug-gnu-emacs@gnu.org 
 help / color / mirror / code / Atom feed
From: Juri Linkov <juri@linkov.net>
To: Eli Zaretskii <eliz@gnu.org>
Cc: 61062@debbugs.gnu.org
Subject: bug#61062: 29.0.60; Split Outline Mode node to Outline Minor Mode node
Date: Fri, 27 Jan 2023 09:56:52 +0200	[thread overview]
Message-ID: <861qngh0l7.fsf@mail.linkov.net> (raw)
In-Reply-To: <83fsbyfkz8.fsf@gnu.org> (Eli Zaretskii's message of "Wed, 25 Jan 2023 21:54:51 +0200")

>> Pushed, but not yet closed.  I could try to document
>> outline-minor-mode-highlight as well since its counterpart
>> outline-minor-mode-cycle was already added to the manual.
>
> It sounds like this is a problematic option, whose use could produce
> unwanted results.  Are you sure it is a good idea to document it in
> the manual?

I agree that it's not suitable for the manual.

Another question that I'm not sure about is whether it makes sense to
mention all outline-minor-mode supported modes in etc/NEWS?  I mean
that we prepared outline-minor-mode related settings in some modes,
but not enabled outline-minor-mode in these modes.

For example, we set such values as outline-search-function,
outline-level, outline-minor-mode-use-buttons, etc.
in apropos-mode and xref.  So the users could easily enable
outline-minor-mode in these modes, and it will work
without additional customization.

Does it make sense to list these modes in etc/NEWS, so users will know
where they can enable outline-minor-mode?  Probably support for
apropos-mode could be mentioned under the section Help mode,
and outline-minor-mode for xref under the section Xref?

BTW, it looks like more links could be added to the manual:

diff --git a/doc/emacs/text.texi b/doc/emacs/text.texi
index 83d5869ee64..6a943c775b2 100644
--- a/doc/emacs/text.texi
+++ b/doc/emacs/text.texi
@@ -1017,14 +1017,16 @@ Outline Minor Mode
 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.
+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
-non-@code{nil}, the @kbd{TAB} and @kbd{S-@key{TAB}} keys are enabled on the
-outline heading lines.  @kbd{TAB} cycles hiding, showing the
-sub-heading, and showing all for the current section.  @kbd{S-@key{TAB}}
-does the same for the entire buffer.
+non-@code{nil}, the @kbd{TAB} and @kbd{S-@key{TAB}} keys that cycle
+the visibility are enabled on the outline heading lines.  @kbd{TAB}
+cycles hiding, showing the sub-heading, and showing all for the
+current section.  @kbd{S-@key{TAB}} does the same for the entire
+buffer (@pxref{Outline Visibility, outline-cycle}).
 
 @node Outline Format
 @subsection Format of Outlines






  reply	other threads:[~2023-01-27  7:56 UTC|newest]

Thread overview: 7+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2023-01-25 17:31 bug#61062: 29.0.60; Split Outline Mode node to Outline Minor Mode node Juri Linkov
2023-01-25 17:51 ` Eli Zaretskii
2023-01-25 18:20   ` Juri Linkov
2023-01-25 19:54     ` Eli Zaretskii
2023-01-27  7:56       ` Juri Linkov [this message]
2023-01-27  8:15         ` Eli Zaretskii
2023-01-28 17:59           ` Juri Linkov

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

  List information: https://www.gnu.org/software/emacs/

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=861qngh0l7.fsf@mail.linkov.net \
    --to=juri@linkov.net \
    --cc=61062@debbugs.gnu.org \
    --cc=eliz@gnu.org \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
Code repositories for project(s) associated with this public inbox

	https://git.savannah.gnu.org/cgit/emacs.git

This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for read-only IMAP folder(s) and NNTP newsgroup(s).