Mercurial > emacs
changeset 86051:8872c78278fa
(Help Functions): Document new macro `with-help-window'.
| author | Martin Rudalics <rudalics@gmx.at> |
|---|---|
| date | Tue, 13 Nov 2007 07:50:04 +0000 |
| parents | b31897bf625c |
| children | a9aea64ae4ab |
| files | doc/lispref/help.texi |
| diffstat | 1 files changed, 11 insertions(+), 0 deletions(-) [+] |
line wrap: on
line diff
--- a/doc/lispref/help.texi Tue Nov 13 07:46:25 2007 +0000 +++ b/doc/lispref/help.texi Tue Nov 13 07:50:04 2007 +0000 @@ -687,6 +687,17 @@ 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