Re: Proposal for an improved `help-for-help'

[Stefan Kangas]

Dmitry Gutov <dgutov@yandex.ru> writes:

>> We could mention Backspace in the text there, or we could add
>> PgUp/PgDn, for example
>
> Either/both would be an improvement.

I think adding PageUp/PageDown and displaying that is the best idea
here, so I have now done that on master.

This change is orthogonal to which keys we actually show in help, but I
propose suggesting these instead of SPC and DEL.  But I am unsure how to
do that.  In the manual we have:

    ‘C-v’
    ‘<PageDown>’
    ‘<next>’
         Scroll the display one screen forward, and move point onscreen if
         necessary (‘scroll-up-command’).  *Note Scrolling::.

    ‘M-v’
    ‘<PageUp>’
    ‘<prior>’
         Scroll one screen backward, and move point onscreen if necessary
         (‘scroll-down-command’).  *Note Scrolling::.

So there are two symbols for PgUp/PgDn.  If I type `C-h k' followed by
my Page Down key, I see that it is called "<next>" here.  But the
beginner-friendly name for that key would be "<PageDown>".

So does that mean that the below diff correct?  And is there a need to
handle `PageDown' and `PageUp' in addition to `next' and `prior'?


diff --git a/lisp/help-macro.el b/lisp/help-macro.el
index 6a0e11574c..663b14d3d1 100644
--- a/lisp/help-macro.el
+++ b/lisp/help-macro.el
@@ -174,9 +174,9 @@ make-help-screen
                                              (point-max))
                                             ""
                                           (concat  ", or "
-
(help--key-description-fontified "\s") ; SPC
+
(help--key-description-fontified (kbd "<PageDown>"))
                                                    " or "
-
(help--key-description-fontified "\d") ; DEL
+
(help--key-description-fontified (kbd "<PageUp>"))
                                                    " to scroll"))))
                            char (aref key 0)))

diff --git a/lisp/help.el b/lisp/help.el
index e143501081..8d6279de8f 100644
--- a/lisp/help.el
+++ b/lisp/help.el
@@ -232,9 +232,9 @@ 'help
   (purecopy "Type a help option: [abcCdefFgiIkKlLmnprstvw.]
C-[cdefmnoptw] or ?")
   (concat
    "\(Type "
-   (help--key-description-fontified "\s") ; SPC
+   (help--key-description-fontified (kbd "<PageDown>"))
    " or "
-   (help--key-description-fontified "\d") ; DEL
+   (help--key-description-fontified (kbd "<PageUp>"))
    " to scroll, "
    (help--key-description-fontified "\C-s")
    " to search, or \\<help-map>\\[help-quit] to exit.)"