diff options
| author | Glenn Morris | 2012-04-20 21:49:43 -0400 |
|---|---|---|
| committer | Glenn Morris | 2012-04-20 21:49:43 -0400 |
| commit | 0b27932b2d99659ee808dbfee6adf1236a05efa0 (patch) | |
| tree | 9c0fc65487ce87dc39b267495f813a1d273bc689 | |
| parent | 384ec638e66805159d4fae86921a914dacc22dad (diff) | |
| download | emacs-0b27932b2d99659ee808dbfee6adf1236a05efa0.tar.gz emacs-0b27932b2d99659ee808dbfee6adf1236a05efa0.zip | |
Small edits for doc/lispref/windows.texi
* doc/lispref/windows.texi (Basic Windows, Windows and Frames, Window Sizes)
(Resizing Windows, Deleting Windows, Selecting Windows)
(Choosing Window Options, Horizontal Scrolling): Copyedits.
(Splitting Windows, Deleting Windows): Fix ignore-window-parameters logic.
(Selecting Windows, Choosing Window Options): Markup fixes.
| -rw-r--r-- | doc/lispref/ChangeLog | 7 | ||||
| -rw-r--r-- | doc/lispref/windows.texi | 44 |
2 files changed, 29 insertions, 22 deletions
diff --git a/doc/lispref/ChangeLog b/doc/lispref/ChangeLog index 8ffd87be6a2..ace1d2bb76f 100644 --- a/doc/lispref/ChangeLog +++ b/doc/lispref/ChangeLog | |||
| @@ -1,5 +1,12 @@ | |||
| 1 | 2012-04-21 Glenn Morris <rgm@gnu.org> | 1 | 2012-04-21 Glenn Morris <rgm@gnu.org> |
| 2 | 2 | ||
| 3 | * windows.texi (Basic Windows, Windows and Frames, Window Sizes) | ||
| 4 | (Resizing Windows, Deleting Windows, Selecting Windows) | ||
| 5 | (Choosing Window Options, Horizontal Scrolling): Copyedits. | ||
| 6 | (Splitting Windows, Deleting Windows): | ||
| 7 | Fix ignore-window-parameters logic. | ||
| 8 | (Selecting Windows, Choosing Window Options): Markup fixes. | ||
| 9 | |||
| 3 | * elisp.texi, vol1.texi, vol2.texi: Bump VERSION and DATE. | 10 | * elisp.texi, vol1.texi, vol2.texi: Bump VERSION and DATE. |
| 4 | 11 | ||
| 5 | * minibuf.texi (Intro to Minibuffers): | 12 | * minibuf.texi (Intro to Minibuffers): |
diff --git a/doc/lispref/windows.texi b/doc/lispref/windows.texi index 8df32785036..da29d528f1b 100644 --- a/doc/lispref/windows.texi +++ b/doc/lispref/windows.texi | |||
| @@ -50,7 +50,7 @@ is displayed in windows. | |||
| 50 | @section Basic Concepts of Emacs Windows | 50 | @section Basic Concepts of Emacs Windows |
| 51 | @cindex window | 51 | @cindex window |
| 52 | 52 | ||
| 53 | A @dfn{window} is a area of the screen which is used to display a | 53 | A @dfn{window} is a area of the screen that is used to display a |
| 54 | buffer (@pxref{Buffers}). In Emacs Lisp, windows are represented by a | 54 | buffer (@pxref{Buffers}). In Emacs Lisp, windows are represented by a |
| 55 | special Lisp object type. | 55 | special Lisp object type. |
| 56 | 56 | ||
| @@ -298,8 +298,8 @@ child of its parent. | |||
| 298 | 298 | ||
| 299 | The functions @code{window-next-sibling} and | 299 | The functions @code{window-next-sibling} and |
| 300 | @code{window-prev-sibling} should not be confused with the functions | 300 | @code{window-prev-sibling} should not be confused with the functions |
| 301 | @code{next-window} and @code{previous-window} which respectively | 301 | @code{next-window} and @code{previous-window}, which return the next |
| 302 | return the next and previous window in the cyclic ordering of windows | 302 | and previous window, respectively, in the cyclic ordering of windows |
| 303 | (@pxref{Cyclic Window Ordering}). | 303 | (@pxref{Cyclic Window Ordering}). |
| 304 | 304 | ||
| 305 | You can use the following functions to find the first live window on | 305 | You can use the following functions to find the first live window on |
| @@ -377,7 +377,7 @@ line (@pxref{Mode Line Format}). | |||
| 377 | 377 | ||
| 378 | Emacs provides several functions for finding the height and width of | 378 | Emacs provides several functions for finding the height and width of |
| 379 | a window. Except where noted, Emacs reports window heights and widths | 379 | a window. Except where noted, Emacs reports window heights and widths |
| 380 | as integer numbers of lines and columns respectively. On a graphical | 380 | as integer numbers of lines and columns, respectively. On a graphical |
| 381 | display, each ``line'' and ``column'' actually corresponds to the | 381 | display, each ``line'' and ``column'' actually corresponds to the |
| 382 | height and width of a ``default'' character specified by the frame's | 382 | height and width of a ``default'' character specified by the frame's |
| 383 | default font. Thus, if a window is displaying text with a different | 383 | default font. Thus, if a window is displaying text with a different |
| @@ -620,7 +620,7 @@ window. | |||
| 620 | 620 | ||
| 621 | The optional argument @var{max-height}, if non-@code{nil}, specifies | 621 | The optional argument @var{max-height}, if non-@code{nil}, specifies |
| 622 | the maximum total height that this function can give @var{window}. | 622 | the maximum total height that this function can give @var{window}. |
| 623 | The optional argument @var{min-height}, if no-@code{nil}, specifies | 623 | The optional argument @var{min-height}, if non-@code{nil}, specifies |
| 624 | the minimum total height that it can give, which overrides the | 624 | the minimum total height that it can give, which overrides the |
| 625 | variable @code{window-min-height}. | 625 | variable @code{window-min-height}. |
| 626 | 626 | ||
| @@ -724,7 +724,7 @@ properties of the window selected within @var{window}'s frame. | |||
| 724 | 724 | ||
| 725 | The behavior of this function may be altered by the window parameters | 725 | The behavior of this function may be altered by the window parameters |
| 726 | of @var{window}, so long as the variable | 726 | of @var{window}, so long as the variable |
| 727 | @code{ignore-window-parameters} is non-@code{nil}. If the value of | 727 | @code{ignore-window-parameters} is @code{nil}. If the value of |
| 728 | the @code{split-window} window parameter is @code{t}, this function | 728 | the @code{split-window} window parameter is @code{t}, this function |
| 729 | ignores all other window parameters. Otherwise, if the value of the | 729 | ignores all other window parameters. Otherwise, if the value of the |
| 730 | @code{split-window} window parameter is a function, that function is | 730 | @code{split-window} window parameter is a function, that function is |
| @@ -1063,7 +1063,7 @@ combination. @xref{Splitting Windows}. | |||
| 1063 | 1063 | ||
| 1064 | The behavior of this function may be altered by the window parameters | 1064 | The behavior of this function may be altered by the window parameters |
| 1065 | of @var{window}, so long as the variable | 1065 | of @var{window}, so long as the variable |
| 1066 | @code{ignore-window-parameters} is non-@code{nil}. If the value of | 1066 | @code{ignore-window-parameters} is @code{nil}. If the value of |
| 1067 | the @code{delete-window} window parameter is @code{t}, this function | 1067 | the @code{delete-window} window parameter is @code{t}, this function |
| 1068 | ignores all other window parameters. Otherwise, if the value of the | 1068 | ignores all other window parameters. Otherwise, if the value of the |
| 1069 | @code{delete-window} window parameter is a function, that function is | 1069 | @code{delete-window} window parameter is a function, that function is |
| @@ -1080,7 +1080,7 @@ defaults to the selected window. The return value is @code{nil}. | |||
| 1080 | 1080 | ||
| 1081 | The behavior of this function may be altered by the window parameters | 1081 | The behavior of this function may be altered by the window parameters |
| 1082 | of @var{window}, so long as the variable | 1082 | of @var{window}, so long as the variable |
| 1083 | @code{ignore-window-parameters} is non-@code{nil}. If the value of | 1083 | @code{ignore-window-parameters} is @code{nil}. If the value of |
| 1084 | the @code{delete-other-windows} window parameter is @code{t}, this | 1084 | the @code{delete-other-windows} window parameter is @code{t}, this |
| 1085 | function ignores all other window parameters. Otherwise, if the value | 1085 | function ignores all other window parameters. Otherwise, if the value |
| 1086 | of the @code{delete-other-windows} window parameter is a function, | 1086 | of the @code{delete-other-windows} window parameter is a function, |
| @@ -1120,8 +1120,8 @@ means operate on that frame. | |||
| 1120 | 1120 | ||
| 1121 | Note that this argument does not have the same meaning as in other | 1121 | Note that this argument does not have the same meaning as in other |
| 1122 | functions which scan all live windows (@pxref{Cyclic Window | 1122 | functions which scan all live windows (@pxref{Cyclic Window |
| 1123 | Ordering}). Specifically, the values @code{t} and @code{nil} have the | 1123 | Ordering}). Specifically, the meanings of @code{t} and @code{nil} here |
| 1124 | opposite of their meanings in those other functions. | 1124 | are the opposite of what they are in those other functions. |
| 1125 | @end deffn | 1125 | @end deffn |
| 1126 | 1126 | ||
| 1127 | @node Selecting Windows | 1127 | @node Selecting Windows |
| @@ -1172,11 +1172,11 @@ the buffer list. | |||
| 1172 | This macro selects @var{window}, executes @var{forms} in sequence, then | 1172 | This macro selects @var{window}, executes @var{forms} in sequence, then |
| 1173 | restores the previously selected window and current buffer. The ordering | 1173 | restores the previously selected window and current buffer. The ordering |
| 1174 | of recently selected windows and the buffer list remain unchanged unless | 1174 | of recently selected windows and the buffer list remain unchanged unless |
| 1175 | you deliberately change them within @var{forms}, for example, by calling | 1175 | you deliberately change them within @var{forms}; for example, by calling |
| 1176 | @code{select-window} with argument @var{norecord} @code{nil}. | 1176 | @code{select-window} with argument @var{norecord} @code{nil}. |
| 1177 | 1177 | ||
| 1178 | The order of recently selected windows and the buffer list are not | 1178 | This macro does not change the order of recently selected windows or |
| 1179 | changed by this macro. | 1179 | the buffer list. |
| 1180 | @end defmac | 1180 | @end defmac |
| 1181 | 1181 | ||
| 1182 | @defun frame-selected-window &optional frame | 1182 | @defun frame-selected-window &optional frame |
| @@ -1186,7 +1186,7 @@ within that frame. @var{frame} should be a live frame; if omitted or | |||
| 1186 | @end defun | 1186 | @end defun |
| 1187 | 1187 | ||
| 1188 | @defun set-frame-selected-window frame window &optional norecord | 1188 | @defun set-frame-selected-window frame window &optional norecord |
| 1189 | This function makes @code{window} the window selected within the frame | 1189 | This function makes @var{window} the window selected within the frame |
| 1190 | @var{frame}. @var{frame} should be a live frame; if omitted or | 1190 | @var{frame}. @var{frame} should be a live frame; if omitted or |
| 1191 | @code{nil}, it defaults to the selected frame. @var{window} should be | 1191 | @code{nil}, it defaults to the selected frame. @var{window} should be |
| 1192 | a live window; if omitted or @code{nil}, it defaults to the selected | 1192 | a live window; if omitted or @code{nil}, it defaults to the selected |
| @@ -1806,14 +1806,14 @@ desired buffer) or @code{nil} (which means the splitting failed). | |||
| 1806 | @end defopt | 1806 | @end defopt |
| 1807 | 1807 | ||
| 1808 | @defun split-window-sensibly window | 1808 | @defun split-window-sensibly window |
| 1809 | This function tries to split @code{window}, and return the newly | 1809 | This function tries to split @var{window}, and return the newly |
| 1810 | created window. If @code{window} cannot be split, it returns | 1810 | created window. If @var{window} cannot be split, it returns |
| 1811 | @code{nil}. | 1811 | @code{nil}. |
| 1812 | 1812 | ||
| 1813 | This function obeys the usual rules that determine when a window may | 1813 | This function obeys the usual rules that determine when a window may |
| 1814 | be split (@pxref{Splitting Windows}). It first tries to split by | 1814 | be split (@pxref{Splitting Windows}). It first tries to split by |
| 1815 | placing the new window below, subject to the restriction imposed by | 1815 | placing the new window below, subject to the restriction imposed by |
| 1816 | @code{split-height-threshold} (see below) in addition to any other | 1816 | @code{split-height-threshold} (see below), in addition to any other |
| 1817 | restrictions. If that fails, it tries to split by placing the new | 1817 | restrictions. If that fails, it tries to split by placing the new |
| 1818 | window to the right, subject to @code{split-width-threshold} (see | 1818 | window to the right, subject to @code{split-width-threshold} (see |
| 1819 | below). If that fails, and the window is the only window on its | 1819 | below). If that fails, and the window is the only window on its |
| @@ -1945,7 +1945,7 @@ to display @var{buffer}. | |||
| 1945 | 1945 | ||
| 1946 | If @var{args} is an alist, it specifies frame parameters for the new | 1946 | If @var{args} is an alist, it specifies frame parameters for the new |
| 1947 | frame. If @var{args} is a list whose @sc{car} is a symbol, then | 1947 | frame. If @var{args} is a list whose @sc{car} is a symbol, then |
| 1948 | @code{(car @var{args})} is called as a function to actually create and | 1948 | @code{(car @var{args})} is a function to actually create and |
| 1949 | set up the frame; it is called with @var{buffer} as first argument, and | 1949 | set up the frame; it is called with @var{buffer} as first argument, and |
| 1950 | @code{(cdr @var{args})} as additional arguments. | 1950 | @code{(cdr @var{args})} as additional arguments. |
| 1951 | 1951 | ||
| @@ -1963,7 +1963,7 @@ This variable holds frame parameters for | |||
| 1963 | 1963 | ||
| 1964 | @defopt same-window-buffer-names | 1964 | @defopt same-window-buffer-names |
| 1965 | A list of buffer names for buffers that should be displayed in the | 1965 | A list of buffer names for buffers that should be displayed in the |
| 1966 | selected window. If the buffer's name is in this list, | 1966 | selected window. If a buffer's name is in this list, |
| 1967 | @code{display-buffer} handles the buffer by switching to it in the | 1967 | @code{display-buffer} handles the buffer by switching to it in the |
| 1968 | selected window. | 1968 | selected window. |
| 1969 | @end defopt | 1969 | @end defopt |
| @@ -2818,8 +2818,8 @@ times the normal character width. How many characters actually | |||
| 2818 | disappear off to the left depends on their width, and could vary from | 2818 | disappear off to the left depends on their width, and could vary from |
| 2819 | line to line. | 2819 | line to line. |
| 2820 | 2820 | ||
| 2821 | Because we read from side to side in the ``inner loop,'' and from top | 2821 | Because we read from side to side in the ``inner loop'', and from top |
| 2822 | to bottom in the ``outer loop,'' the effect of horizontal scrolling is | 2822 | to bottom in the ``outer loop'', the effect of horizontal scrolling is |
| 2823 | not like that of textual or vertical scrolling. Textual scrolling | 2823 | not like that of textual or vertical scrolling. Textual scrolling |
| 2824 | involves selection of a portion of text to display, and vertical | 2824 | involves selection of a portion of text to display, and vertical |
| 2825 | scrolling moves the window contents contiguously; but horizontal | 2825 | scrolling moves the window contents contiguously; but horizontal |
| @@ -3139,7 +3139,7 @@ old one. | |||
| 3139 | 3139 | ||
| 3140 | If the frame which @var{configuration} was saved from is dead, all this | 3140 | If the frame which @var{configuration} was saved from is dead, all this |
| 3141 | function does is restore the three variables @code{window-min-height}, | 3141 | function does is restore the three variables @code{window-min-height}, |
| 3142 | @code{window-min-width} and @code{minibuffer-scroll-window}. In this | 3142 | @code{window-min-width} and @code{minibuffer-scroll-window}. In this |
| 3143 | case, the function returns @code{nil}. Otherwise, it returns @code{t}. | 3143 | case, the function returns @code{nil}. Otherwise, it returns @code{t}. |
| 3144 | 3144 | ||
| 3145 | Here is a way of using this function to get the same effect | 3145 | Here is a way of using this function to get the same effect |