diff options
| author | Eli Zaretskii | 2011-11-26 16:07:22 +0200 |
|---|---|---|
| committer | Eli Zaretskii | 2011-11-26 16:07:22 +0200 |
| commit | 579ebf8ff0b7693754fb27bbea4fceb4410df0e8 (patch) | |
| tree | abeb64f0f997cdf52456ffcb99640a1e5220aae6 /doc | |
| parent | a3dcc84e76ab44bf0855a1392a7e0b9bde45e1c3 (diff) | |
| download | emacs-579ebf8ff0b7693754fb27bbea4fceb4410df0e8.tar.gz emacs-579ebf8ff0b7693754fb27bbea4fceb4410df0e8.zip | |
Clarify documentation of wrap-prefix and line-prefix.
doc/lispref/display.texi (Truncation):
doc/lispref/text.texi (Special Properties): Describe what a stretch-glyph is
instead of using that term without explanation. Make the
cross-references more accurate.
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/lispref/ChangeLog | 5 | ||||
| -rw-r--r-- | doc/lispref/display.texi | 18 | ||||
| -rw-r--r-- | doc/lispref/text.texi | 16 |
3 files changed, 26 insertions, 13 deletions
diff --git a/doc/lispref/ChangeLog b/doc/lispref/ChangeLog index 72efbee0b5a..37de62be976 100644 --- a/doc/lispref/ChangeLog +++ b/doc/lispref/ChangeLog | |||
| @@ -1,5 +1,10 @@ | |||
| 1 | 2011-11-26 Eli Zaretskii <eliz@gnu.org> | 1 | 2011-11-26 Eli Zaretskii <eliz@gnu.org> |
| 2 | 2 | ||
| 3 | * display.texi (Truncation): | ||
| 4 | * text.texi (Special Properties): Describe what a stretch-glyph is | ||
| 5 | instead of using that term without explanation. Make the | ||
| 6 | cross-references more accurate. | ||
| 7 | |||
| 3 | * display.texi (Usual Display): Update the description, | 8 | * display.texi (Usual Display): Update the description, |
| 4 | cross-references, and indexing related to display of control | 9 | cross-references, and indexing related to display of control |
| 5 | characters and raw bytes. | 10 | characters and raw bytes. |
diff --git a/doc/lispref/display.texi b/doc/lispref/display.texi index 2032ecdc5bc..a9921d7443d 100644 --- a/doc/lispref/display.texi +++ b/doc/lispref/display.texi | |||
| @@ -193,10 +193,12 @@ a window, that forces truncation. | |||
| 193 | @defvar wrap-prefix | 193 | @defvar wrap-prefix |
| 194 | If this buffer-local variable is non-@code{nil}, it defines a | 194 | If this buffer-local variable is non-@code{nil}, it defines a |
| 195 | ``prefix'' that is prepended to every continuation line at | 195 | ``prefix'' that is prepended to every continuation line at |
| 196 | display-time. (If lines are truncated, the wrap-prefix is never | 196 | display time. (If lines are truncated, the wrap-prefix is never |
| 197 | used.) It may be a string, an image, or a stretch-glyph; the value is | 197 | used.) It may be a string or an image (@pxref{Other Display Specs}), |
| 198 | interpreted in the same way as a @code{display} text property. | 198 | or a stretch of whitespace such as specified by the @code{:width} or |
| 199 | @xref{Display Property}. | 199 | @code{:align-to} display properties (@pxref{Specified Space}). The |
| 200 | value is interpreted in the same way as a @code{display} text | ||
| 201 | property. @xref{Display Property}. | ||
| 200 | 202 | ||
| 201 | A wrap-prefix may also be specified for regions of text, using the | 203 | A wrap-prefix may also be specified for regions of text, using the |
| 202 | @code{wrap-prefix} text or overlay property. This takes precedence | 204 | @code{wrap-prefix} text or overlay property. This takes precedence |
| @@ -206,9 +208,11 @@ over the @code{wrap-prefix} variable. @xref{Special Properties}. | |||
| 206 | @defvar line-prefix | 208 | @defvar line-prefix |
| 207 | If this buffer-local variable is non-@code{nil}, it defines a | 209 | If this buffer-local variable is non-@code{nil}, it defines a |
| 208 | ``prefix'' that is prepended to every non-continuation line at | 210 | ``prefix'' that is prepended to every non-continuation line at |
| 209 | display-time. It may be a string, an image, or a stretch-glyph; the | 211 | display time. It may be a string or an image (@pxref{Other Display |
| 210 | value is interpreted in the same way as a @code{display} text | 212 | Specs}), or a stretch of whitespace such as specified by the |
| 211 | property. @xref{Display Property}. | 213 | @code{:width} or @code{:align-to} display properties (@pxref{Specified |
| 214 | Space}). The value is interpreted in the same way as a @code{display} | ||
| 215 | text property. @xref{Display Property}. | ||
| 212 | 216 | ||
| 213 | A line-prefix may also be specified for regions of text using the | 217 | A line-prefix may also be specified for regions of text using the |
| 214 | @code{line-prefix} text or overlay property. This takes precedence | 218 | @code{line-prefix} text or overlay property. This takes precedence |
diff --git a/doc/lispref/text.texi b/doc/lispref/text.texi index f320b386445..fc12939bec5 100644 --- a/doc/lispref/text.texi +++ b/doc/lispref/text.texi | |||
| @@ -3191,10 +3191,12 @@ controls the total height of the display line ending in that newline. | |||
| 3191 | 3191 | ||
| 3192 | @item wrap-prefix | 3192 | @item wrap-prefix |
| 3193 | If text has a @code{wrap-prefix} property, the prefix it defines will | 3193 | If text has a @code{wrap-prefix} property, the prefix it defines will |
| 3194 | be added at display-time to the beginning of every continuation line | 3194 | be added at display time to the beginning of every continuation line |
| 3195 | due to text wrapping (so if lines are truncated, the wrap-prefix is | 3195 | due to text wrapping (so if lines are truncated, the wrap-prefix is |
| 3196 | never used). It may be a string, an image, or a stretch-glyph such as | 3196 | never used). It may be a string or an image (@pxref{Other Display |
| 3197 | used by the @code{display} text-property. @xref{Display Property}. | 3197 | Specs}), or a stretch of whitespace such as specified by the |
| 3198 | @code{:width} or @code{:align-to} display properties (@pxref{Specified | ||
| 3199 | Space}). | ||
| 3198 | 3200 | ||
| 3199 | A wrap-prefix may also be specified for an entire buffer using the | 3201 | A wrap-prefix may also be specified for an entire buffer using the |
| 3200 | @code{wrap-prefix} buffer-local variable (however, a | 3202 | @code{wrap-prefix} buffer-local variable (however, a |
| @@ -3203,9 +3205,11 @@ the @code{wrap-prefix} variable). @xref{Truncation}. | |||
| 3203 | 3205 | ||
| 3204 | @item line-prefix | 3206 | @item line-prefix |
| 3205 | If text has a @code{line-prefix} property, the prefix it defines will | 3207 | If text has a @code{line-prefix} property, the prefix it defines will |
| 3206 | be added at display-time to the beginning of every non-continuation | 3208 | be added at display time to the beginning of every non-continuation |
| 3207 | line. It may be a string, an image, or a stretch-glyph such as used | 3209 | line. It may be a string or an image (@pxref{Other Display |
| 3208 | by the @code{display} text-property. @xref{Display Property}. | 3210 | Specs}), or a stretch of whitespace such as specified by the |
| 3211 | @code{:width} or @code{:align-to} display properties (@pxref{Specified | ||
| 3212 | Space}). | ||
| 3209 | 3213 | ||
| 3210 | A line-prefix may also be specified for an entire buffer using the | 3214 | A line-prefix may also be specified for an entire buffer using the |
| 3211 | @code{line-prefix} buffer-local variable (however, a | 3215 | @code{line-prefix} buffer-local variable (however, a |