Function: make-help-screen

make-help-screen is a macro defined in help-macro.el.gz.

Signature

(make-help-screen FNAME HELP-LINE HELP-TEXT HELPED-MAP &optional BUFFER-NAME)

Documentation

Construct help-menu function name FNAME.

When invoked, FNAME shows HELP-LINE and reads a command using HELPED-MAP. If the command is the help character, FNAME displays HELP-TEXT and continues trying to read a command using HELPED-MAP. If HELP-TEXT contains the sequence %THIS-KEY%, that is replaced with the key sequence that invoked FNAME. When FNAME finally does get a command, it executes that command and then returns.

View in manual

Source Code

;; Defined in /usr/src/emacs/lisp/help-macro.el.gz
(defmacro make-help-screen (fname help-line help-text helped-map
                                  &optional buffer-name)
  "Construct help-menu function name FNAME.
When invoked, FNAME shows HELP-LINE and reads a command using HELPED-MAP.
If the command is the help character, FNAME displays HELP-TEXT
and continues trying to read a command using HELPED-MAP.
If HELP-TEXT contains the sequence `%THIS-KEY%', that is replaced
with the key sequence that invoked FNAME.
When FNAME finally does get a command, it executes that command
and then returns."
  (declare (indent defun))
  `(defun ,fname ()
     "Help command."
     (interactive)
     (help--help-screen ,help-line ,help-text ,helped-map ,buffer-name)))