procyberian/emacs
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Clarify documentation of wrap-prefix and line-prefix.

Browse source 
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.
This commit is contained in:
Eli Zaretskii 2011-11-26 16:07:22 +02:00
parent a3dcc84e76
commit 579ebf8ff0
3 changed files with 26 additions and 13 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

5
doc/lispref/ChangeLog
View file

@ -1,5 +1,10 @@
2011-11-26 Eli Zaretskii <eliz@gnu.org>
* display.texi (Truncation):
* text.texi (Special Properties): Describe what a stretch-glyph is
instead of using that term without explanation. Make the
cross-references more accurate.
* display.texi (Usual Display): Update the description,
cross-references, and indexing related to display of control
characters and raw bytes.

18
doc/lispref/display.texi
View file

@ -193,10 +193,12 @@ a window, that forces truncation.
@defvar wrap-prefix
If this buffer-local variable is non-@code{nil}, it defines a
``prefix'' that is prepended to every continuation line at
display-time. (If lines are truncated, the wrap-prefix is never
used.) It may be a string, an image, or a stretch-glyph; the value is
interpreted in the same way as a @code{display} text property.
@xref{Display Property}.
display time. (If lines are truncated, the wrap-prefix is never
used.) It may be a string or an image (@pxref{Other Display Specs}),
or a stretch of whitespace such as specified by the @code{:width} or
@code{:align-to} display properties (@pxref{Specified Space}). The
value is interpreted in the same way as a @code{display} text
property. @xref{Display Property}.
A wrap-prefix may also be specified for regions of text, using the
@code{wrap-prefix} text or overlay property. This takes precedence
@ -206,9 +208,11 @@ over the @code{wrap-prefix} variable. @xref{Special Properties}.
@defvar line-prefix
If this buffer-local variable is non-@code{nil}, it defines a
``prefix'' that is prepended to every non-continuation line at
display-time. It may be a string, an image, or a stretch-glyph; the
value is interpreted in the same way as a @code{display} text
property. @xref{Display Property}.
display time. It may be a string or an image (@pxref{Other Display
Specs}), or a stretch of whitespace such as specified by the
@code{:width} or @code{:align-to} display properties (@pxref{Specified
Space}). The value is interpreted in the same way as a @code{display}
text property. @xref{Display Property}.
A line-prefix may also be specified for regions of text using the
@code{line-prefix} text or overlay property. This takes precedence

16
doc/lispref/text.texi
View file

@ -3191,10 +3191,12 @@ controls the total height of the display line ending in that newline.
@item wrap-prefix
If text has a @code{wrap-prefix} property, the prefix it defines will
be added at display-time to the beginning of every continuation line
be added at display time to the beginning of every continuation line
due to text wrapping (so if lines are truncated, the wrap-prefix is
never used). It may be a string, an image, or a stretch-glyph such as
used by the @code{display} text-property. @xref{Display Property}.
never used). It may be a string or an image (@pxref{Other Display
Specs}), or a stretch of whitespace such as specified by the
@code{:width} or @code{:align-to} display properties (@pxref{Specified
Space}).
A wrap-prefix may also be specified for an entire buffer using the
@code{wrap-prefix} buffer-local variable (however, a
@ -3203,9 +3205,11 @@ the @code{wrap-prefix} variable). @xref{Truncation}.
@item line-prefix
If text has a @code{line-prefix} property, the prefix it defines will
be added at display-time to the beginning of every non-continuation
line. It may be a string, an image, or a stretch-glyph such as used
by the @code{display} text-property. @xref{Display Property}.
be added at display time to the beginning of every non-continuation
line. It may be a string or an image (@pxref{Other Display
Specs}), or a stretch of whitespace such as specified by the
@code{:width} or @code{:align-to} display properties (@pxref{Specified
Space}).
A line-prefix may also be specified for an entire buffer using the
@code{line-prefix} buffer-local variable (however, a