Mercurial > emacs
comparison doc/lispref/help.texi @ 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 | 0ba80d073e27 |
children | 194e0eca9ec2 |
comparison
equal
deleted
inserted
replaced
86050:b31897bf625c | 86051:8872c78278fa |
---|---|
685 | 685 |
686 This macro is used in the command @code{help-for-help} which is the | 686 This macro is used in the command @code{help-for-help} which is the |
687 binding of @kbd{C-h C-h}. | 687 binding of @kbd{C-h C-h}. |
688 @end defmac | 688 @end defmac |
689 | 689 |
690 @defmac with-help-window buffer-name body@dots{} | |
691 This macro evaluates the @var{body} forms inserting any output they | |
692 produce into a buffer named @var{buffer-name}. @code{with-help-window} | |
693 behaves like @code{with-output-to-temp-buffer} (@pxref{Temporary | |
694 Displays}) but does more accurately restore the previous window | |
695 configuration when quitting Help. It also generates the message | |
696 informing the user how to quit and scroll the help window by itself. | |
697 Hence you will regret it if you use @code{print-help-return-message} in | |
698 the body of this macro. | |
699 @end defmac | |
700 | |
690 @defopt three-step-help | 701 @defopt three-step-help |
691 If this variable is non-@code{nil}, commands defined with | 702 If this variable is non-@code{nil}, commands defined with |
692 @code{make-help-screen} display their @var{help-line} strings in the | 703 @code{make-help-screen} display their @var{help-line} strings in the |
693 echo area at first, and display the longer @var{help-text} strings only | 704 echo area at first, and display the longer @var{help-text} strings only |
694 if the user types the help character again. | 705 if the user types the help character again. |