mirror/emacs
1
0
Fork 0
mirror of https://git.savannah.gnu.org/git/emacs.git synced 2024-11-21 06:55:39 +00:00
Code Issues Releases Activity

; Improve documentation of 'line-prefix' and 'wrap-prefix'.

Browse Source 
* doc/lispref/text.texi (Special Properties): Spell out more
accurately how 'line-prefix' and 'wrap-prefix' properties should
be set.
This commit is contained in:
Eli Zaretskii 2024-07-26 14:56:14 +03:00
parent 268a2d10fc
commit 87389f9ff9
1 changed files with 25 additions and 13 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

38
doc/lispref/text.texi
View File

@ -3854,13 +3854,19 @@ controls the total height of the display line ending in that newline.
@xref{Line Height}. @xref{Line Height}.
@item wrap-prefix @item wrap-prefix
If text has a @code{wrap-prefix} property, the prefix it defines will If a region of text has a @code{wrap-prefix} property, the prefix it
be added at display time to the beginning of every continuation line defines will be added at display time to the beginning of every
due to text wrapping (so if lines are truncated, the wrap-prefix is continuation line due to text wrapping (so if lines are truncated, the
never used). It may be a string or an image (@pxref{Other Display wrap-prefix is never used). The property value may be a string or an
Specs}), or a stretch of whitespace such as specified by the image (@pxref{Other Display Specs}), or a stretch of whitespace such as
@code{:width} or @code{:align-to} display properties (@pxref{Specified specified by the @code{:width} or @code{:align-to} display properties
Space}). (@pxref{Specified Space}). Note that to have its effect, the
@code{wrap-prefix} property must be set on the entire region of text,
starting from the first character of the first line of that text and up
to the last character of the last line; otherwise, breaking the text
into lines in a different way might fail to display the prefix, because
the display engine checks for this property only immediately after
continuing a line.
A wrap-prefix may also be specified for an entire buffer using the A wrap-prefix may also be specified for an entire buffer using the
@code{wrap-prefix} buffer-local variable (however, a @code{wrap-prefix} buffer-local variable (however, a
@ -3868,12 +3874,18 @@ A wrap-prefix may also be specified for an entire buffer using the
the @code{wrap-prefix} variable). @xref{Truncation}. the @code{wrap-prefix} variable). @xref{Truncation}.
@item line-prefix @item line-prefix
If text has a @code{line-prefix} property, the prefix it defines will If a region of text has a @code{line-prefix} property, the prefix it
be added at display time to the beginning of every non-continuation defines will be added at display time to the beginning of every
line. It may be a string or an image (@pxref{Other Display non-continuation line. The property value may be a string or an image
Specs}), or a stretch of whitespace such as specified by the (@pxref{Other Display Specs}), or a stretch of whitespace such as
@code{:width} or @code{:align-to} display properties (@pxref{Specified specified by the @code{:width} or @code{:align-to} display properties
Space}). (@pxref{Specified Space}). Note that to have its effect, the
@code{line-prefix} property must be set on the entire region of text,
starting from the first character of the first line of that text and up
to the last character of the last line; otherwise, breaking the text
into lines in a different way might fail to display the prefix, because
the display engine checks for this property only when starting a new
line.
A line-prefix may also be specified for an entire buffer using the A line-prefix may also be specified for an entire buffer using the
@code{line-prefix} buffer-local variable (however, a @code{line-prefix} buffer-local variable (however, a