aboutsummaryrefslogtreecommitdiffstats
path: root/doc
diff options
context:
space:
mode:
authorEli Zaretskii2016-03-25 13:37:58 +0300
committerEli Zaretskii2016-03-25 13:37:58 +0300
commit422c3dadce6dbd33ced2024782438af68c5756de (patch)
tree3fde898794f9e1fab1e3521d683c0d34abd9aaa2 /doc
parent90fb9b38dd4a386a71cdf7c3bf6b42292db43c42 (diff)
downloademacs-422c3dadce6dbd33ced2024782438af68c5756de.tar.gz
emacs-422c3dadce6dbd33ced2024782438af68c5756de.zip
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.
Diffstat (limited to 'doc')
-rw-r--r--doc/emacs/windows.texi38
1 files changed, 21 insertions, 17 deletions
diff --git a/doc/emacs/windows.texi b/doc/emacs/windows.texi
index e40162031f3..7587f885a23 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.
206Select buffer @var{bufname} in another window 206Select buffer @var{bufname} in another window
207(@code{switch-to-buffer-other-window}). 207(@code{switch-to-buffer-other-window}).
208 208
209@findex display-buffer 209@findex display-buffer @r{(command)}
210@item C-x 4 C-o @var{bufname} @key{RET} 210@item C-x 4 C-o @var{bufname} @key{RET}
211@kindex C-x 4 C-o 211@kindex C-x 4 C-o
212Display buffer @var{bufname} in some window, without trying to select 212Display 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
345usually work by calling @code{switch-to-buffer} internally 345usually work by calling @code{switch-to-buffer} internally
346(@pxref{Select Buffer}). 346(@pxref{Select Buffer}).
347 347
348@findex display-buffer
349 Some commands try to display intelligently, trying not to take 348 Some commands try to display intelligently, trying not to take
350over the selected window, e.g., by splitting off a new window and 349over the selected window, e.g., by splitting off a new window and
351displaying the desired buffer there. Such commands, which include the 350displaying 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.
379 378
380@node Window Choice 379@node Window Choice
381@subsection How @code{display-buffer} works 380@subsection How @code{display-buffer} works
382@findex display-buffer 381@findex display-buffer, detailed description
383 382
384The @code{display-buffer} command (as well as commands that call it 383The @code{display-buffer} command (as well as commands that call it
385internally) chooses a window to display by following the steps given 384internally) chooses a window to display by following the steps given
@@ -449,6 +448,8 @@ mentioned in the next section.
449 448
450@node Temporary Displays 449@node Temporary Displays
451@subsection Displaying non-editable buffers. 450@subsection Displaying non-editable buffers.
451@cindex pop-up windows
452@cindex temporary windows
452 453
453Some buffers are shown in windows for perusal rather than for editing. 454Some buffers are shown in windows for perusal rather than for editing.
454Help commands (@pxref{Help}) typically use a buffer called @file{*Help*} 455Help commands (@pxref{Help}) typically use a buffer called @file{*Help*}
@@ -456,19 +457,19 @@ for that purpose, minibuffer completion (@pxref{Completion}) uses a
456buffer called @file{*Completions*} instead. Such buffers are usually 457buffer called @file{*Completions*} instead. Such buffers are usually
457displayed only for a short period of time. 458displayed only for a short period of time.
458 459
459 Normally, Emacs chooses the window for such temporary displays via 460 Normally, Emacs chooses the window for such temporary displays via
460@code{display-buffer} as described above. The @file{*Completions*} 461@code{display-buffer} as described above. The @file{*Completions*}
461buffer, on the other hand, is preferably displayed in a window at the 462buffer, on the other hand, is normally displayed in a window at the
462bottom of the selected frame, regardless of the number of windows 463bottom of the selected frame, regardless of the number of windows
463already shown on that frame. 464already shown on that frame.
464 465
465 If you prefer Emacs to display a temporary buffer in a different 466 If you prefer Emacs to display a temporary buffer in a different
466fashion, the recommended approach is to customize the variable 467fashion, we recommend to customize the variable
467@code{display-buffer-alist} (@pxref{Choosing Window,,Choosing a Window 468@code{display-buffer-alist} (@pxref{Choosing Window,,Choosing a Window
468for Display, elisp, The Emacs Lisp Reference Manual}). For example, to 469for Display, elisp, The Emacs Lisp Reference Manual}). For example,
469display @file{*Completions*} by splitting a window as described in the 470to display @file{*Completions*} by splitting a window as described in
470previous section, use the following form in your initialization file 471the previous section, use the following form in your initialization
471(@pxref{Init File}): 472file (@pxref{Init File}):
472 473
473@example 474@example
474@group 475@group
@@ -478,15 +479,18 @@ previous section, use the following form in your initialization file
478@end group 479@end group
479@end example 480@end example
480 481
481 The @file{*Completions*} buffer is also special in the sense that 482@findex temp-buffer-resize-mode
482Emacs usually tries to make its window just as large as to display all 483 The @file{*Completions*} buffer is also special in the sense that
483of its contents. To resize windows showing other temporary displays 484Emacs usually tries to make its window just as large as necessary to
484like, for example, the @file{*Help*} buffer accordingly, you have to 485display all of its contents. To resize windows showing other
485explicitly invoke the minor mode (@pxref{Minor Modes}) 486temporary displays like, for example, the @file{*Help*} buffer
487accordingly, turn on the minor mode (@pxref{Minor Modes})
486@code{temp-buffer-resize-mode} (@pxref{Temporary Displays,,Temporary 488@code{temp-buffer-resize-mode} (@pxref{Temporary Displays,,Temporary
487Displays, elisp, The Emacs Lisp Reference Manual}). 489Displays, elisp, The Emacs Lisp Reference Manual}).
488 490
489 The maximum size of windows resized by @code{temp-buffer-resize-mode} 491@vindex temp-buffer-max-height
492@vindex temp-buffer-max-width
493 The maximum size of windows resized by @code{temp-buffer-resize-mode}
490can be controlled by customizing the options 494can be controlled by customizing the options
491@code{temp-buffer-max-height} and @code{temp-buffer-max-width} 495@code{temp-buffer-max-height} and @code{temp-buffer-max-width}
492(@pxref{Temporary Displays,,Temporary Displays, elisp, The Emacs Lisp 496(@pxref{Temporary Displays,,Temporary Displays, elisp, The Emacs Lisp