unofficial mirror of bug-gnu-emacs@gnu.org 
 help / color / mirror / code / Atom feed
From: JD Smith <jdtsmith@gmail.com>
To: Eli Zaretskii <eliz@gnu.org>
Cc: 68236@debbugs.gnu.org
Subject: bug#68236: [PATCH] help.el: allow help-quick to use local commands/quick-sections
Date: Thu, 4 Jan 2024 20:28:27 -0500	[thread overview]
Message-ID: <4CB34A88-87DE-4347-A886-4BF8D4998E67@gmail.com> (raw)
In-Reply-To: <83sf3dw699.fsf@gnu.org>



> On Jan 4, 2024, at 8:57 AM, Eli Zaretskii <eliz@gnu.org> wrote:
> 
>> From: JD Smith <jdtsmith@gmail.com>
>> Date: Thu, 4 Jan 2024 08:45:50 -0500
>> Cc: 68236@debbugs.gnu.org
>> 
>> On Jan 4, 2024, at 2:39 AM, Eli Zaretskii <eliz@gnu.org> wrote:
>> 
>> Please describe in more detail how would people use this for their
>> personal "quick help", because I don't think I understand well enough
>> what you have in mind.
>> 
>> For example, an org user may
>> 
>> (add-to-list 'help-quick-sections
>>             '("Org"
>>      (org-ctrl-c-star . "Compute table/change heading ")
>>      (org-ctrl-c-ret . "Table hline/insert heading")))
>> 
>> so that from org-buffers, C-h C-q adds a new section:
>> 
>> Org                                  
>> C-c *   Compute table/change heading 
>> C-c RET Table hline/insert heading   
>> 
>> Most likely users willing to customize `help-quick-sections’ would remove existing sections with
>> commands they know well.  
>> 
>> In any case, such a change will need suitable changes for
>> documentation.
>> 
>> Do you mean documentation for the `help-quick-sections' variable?  How about turning this into a
>> defcustom?  This would allow more advanced users to fully customize what “quick help” they want.
> 
> If we are going to expose help-quick-sections as a defcustom, then I
> don't understand why we need to change the code at all.  Is the idea
> that sections will depend on the current buffer?  If so, then we just
> need to add an element to the list members which will store the
> major-mode for which the member is relevant.
> 
> Or what am I missing?

Right now the code does

  (with-current-buffer (get-buffer-create "*Quick Help*")

right away, then checks `where-is-internal' for each listed command in `help-quick-sections'.  So only global bindings (and bindings available in help-mode) are accessible for display.  My patch simply delays switching to *Quick Help* buffer, so that binding information can be gathered from the local buffer from which quick help was summoned.  Note that help-quick omits any bindings that are nil, as well as any empty sections.  So adding sections to the defcustom that do not apply (=have no bindings) in some buffer is not a problem.  




  reply	other threads:[~2024-01-05  1:28 UTC|newest]

Thread overview: 13+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2024-01-04  3:08 bug#68236: [PATCH] help.el: allow help-quick to use local commands/quick-sections JD Smith
2024-01-04  7:39 ` Eli Zaretskii
2024-01-04 13:45   ` JD Smith
2024-01-04 13:57     ` Eli Zaretskii
2024-01-05  1:28       ` JD Smith [this message]
2024-01-05  8:40         ` Eli Zaretskii
2024-01-05 17:00           ` JD Smith
2024-01-10 12:51           ` Stefan Kangas
2024-01-10 13:53             ` Eli Zaretskii
2024-01-10 15:46             ` JD Smith
2024-01-10 15:50               ` Stefan Kangas
2024-01-10 15:58               ` Eli Zaretskii
2024-01-10 22:49                 ` JD Smith

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=4CB34A88-87DE-4347-A886-4BF8D4998E67@gmail.com \
    --to=jdtsmith@gmail.com \
    --cc=68236@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).