summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorEli Zaretskii <eliz@gnu.org>2016-03-25 13:37:58 +0300
committerEli Zaretskii <eliz@gnu.org>2016-03-25 13:37:58 +0300
commit422c3dadce6dbd33ced2024782438af68c5756de (patch)
tree3fde898794f9e1fab1e3521d683c0d34abd9aaa2
parent90fb9b38dd4a386a71cdf7c3bf6b42292db43c42 (diff)
Minor copyedits of documentation for temporary displays
* doc/emacs/windows.texi (Temporary Displays): Improve indexing. Minor changes in wording. (Window Choice, Displaying Buffers, Pop Up Window): Disambiguate index entries for 'display-buffer'. * etc/NEWS: Minor rewording of the entry about temporary displays.
-rw-r--r--doc/emacs/windows.texi38
-rw-r--r--etc/NEWS10
2 files changed, 28 insertions, 20 deletions
diff --git a/doc/emacs/windows.texi b/doc/emacs/windows.texi
index e40162031f..7587f885a2 100644
--- a/doc/emacs/windows.texi
+++ b/doc/emacs/windows.texi
@@ -206,7 +206,7 @@ Choice}, for how Emacs picks or creates the window to use.
Select buffer @var{bufname} in another window
(@code{switch-to-buffer-other-window}).
-@findex display-buffer
+@findex display-buffer @r{(command)}
@item C-x 4 C-o @var{bufname} @key{RET}
@kindex C-x 4 C-o
Display buffer @var{bufname} in some window, without trying to select
@@ -345,7 +345,6 @@ user's attention will be diverted to that buffer. These commands
usually work by calling @code{switch-to-buffer} internally
(@pxref{Select Buffer}).
-@findex display-buffer
Some commands try to display intelligently, trying not to take
over the selected window, e.g., by splitting off a new window and
displaying the desired buffer there. Such commands, which include the
@@ -379,7 +378,7 @@ Several of these commands are bound in the @kbd{C-x 5} prefix key.
@node Window Choice
@subsection How @code{display-buffer} works
-@findex display-buffer
+@findex display-buffer, detailed description
The @code{display-buffer} command (as well as commands that call it
internally) chooses a window to display by following the steps given
@@ -449,6 +448,8 @@ mentioned in the next section.
@node Temporary Displays
@subsection Displaying non-editable buffers.
+@cindex pop-up windows
+@cindex temporary windows
Some buffers are shown in windows for perusal rather than for editing.
Help commands (@pxref{Help}) typically use a buffer called @file{*Help*}
@@ -456,19 +457,19 @@ for that purpose, minibuffer completion (@pxref{Completion}) uses a
buffer called @file{*Completions*} instead. Such buffers are usually
displayed only for a short period of time.
- Normally, Emacs chooses the window for such temporary displays via
+ Normally, Emacs chooses the window for such temporary displays via
@code{display-buffer} as described above. The @file{*Completions*}
-buffer, on the other hand, is preferably displayed in a window at the
+buffer, on the other hand, is normally displayed in a window at the
bottom of the selected frame, regardless of the number of windows
already shown on that frame.
- If you prefer Emacs to display a temporary buffer in a different
-fashion, the recommended approach is to customize the variable
+ If you prefer Emacs to display a temporary buffer in a different
+fashion, we recommend to customize the variable
@code{display-buffer-alist} (@pxref{Choosing Window,,Choosing a Window
-for Display, elisp, The Emacs Lisp Reference Manual}). For example, to
-display @file{*Completions*} by splitting a window as described in the
-previous section, use the following form in your initialization file
-(@pxref{Init File}):
+for Display, elisp, The Emacs Lisp Reference Manual}). For example,
+to display @file{*Completions*} by splitting a window as described in
+the previous section, use the following form in your initialization
+file (@pxref{Init File}):
@example
@group
@@ -478,15 +479,18 @@ previous section, use the following form in your initialization file
@end group
@end example
- The @file{*Completions*} buffer is also special in the sense that
-Emacs usually tries to make its window just as large as to display all
-of its contents. To resize windows showing other temporary displays
-like, for example, the @file{*Help*} buffer accordingly, you have to
-explicitly invoke the minor mode (@pxref{Minor Modes})
+@findex temp-buffer-resize-mode
+ The @file{*Completions*} buffer is also special in the sense that
+Emacs usually tries to make its window just as large as necessary to
+display all of its contents. To resize windows showing other
+temporary displays like, for example, the @file{*Help*} buffer
+accordingly, turn on the minor mode (@pxref{Minor Modes})
@code{temp-buffer-resize-mode} (@pxref{Temporary Displays,,Temporary
Displays, elisp, The Emacs Lisp Reference Manual}).
- The maximum size of windows resized by @code{temp-buffer-resize-mode}
+@vindex temp-buffer-max-height
+@vindex temp-buffer-max-width
+ The maximum size of windows resized by @code{temp-buffer-resize-mode}
can be controlled by customizing the options
@code{temp-buffer-max-height} and @code{temp-buffer-max-width}
(@pxref{Temporary Displays,,Temporary Displays, elisp, The Emacs Lisp
diff --git a/etc/NEWS b/etc/NEWS
index 35f93410e8..96ec1f1ddf 100644
--- a/etc/NEWS
+++ b/etc/NEWS
@@ -1927,10 +1927,14 @@ frames.
and 'window-divider-default-right-width'.
+++
-*** The minibuffer completions window is now displayad at the bottom of
-the selected frame and always fit to its buffer. The Emacs manual
+*** The window displaying the '*Completions*' buffer with minibuffer
+completion candidates is now shown at the bottom of the selected
+frame. The size of that window is always as large as required to
+display all the candidates, except when limited by the minimum size
+of the other windows on that frame; those other windows are resized
+to provide space for the '*Completions*' display. The Emacs manual
describes how to customize 'display-buffer-alist' to get back the old
-behavior.
+behavior, see the node "Temporary Displays" there.
---
** Tearoff menus and detachable toolbars for Gtk+ have been removed.