Commit a5373305 authored by Martin Rudalics's avatar Martin Rudalics
Browse files

(Help Functions): Document new macro `with-help-window'.

parent ff98e024
2007-11-13 Martin Rudalics <>
* help.texi (Help Functions): Document new macro `with-help-window'.
2007-11-10 Paul Pogonyshev <>
* searching.texi (Replacing Match): Describe new
......@@ -687,6 +687,17 @@ This macro is used in the command @code{help-for-help} which is the
binding of @kbd{C-h C-h}.
@end defmac
@defmac with-help-window buffer-name body@dots{}
This macro evaluates the @var{body} forms inserting any output they
produce into a buffer named @var{buffer-name}. @code{with-help-window}
behaves like @code{with-output-to-temp-buffer} (@pxref{Temporary
Displays}) but does more accurately restore the previous window
configuration when quitting Help. It also generates the message
informing the user how to quit and scroll the help window by itself.
Hence you will regret it if you use @code{print-help-return-message} in
the body of this macro.
@end defmac
@defopt three-step-help
If this variable is non-@code{nil}, commands defined with
@code{make-help-screen} display their @var{help-line} strings in the
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment