summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorEli Zaretskii <eliz@gnu.org>2011-11-26 16:07:22 +0200
committerEli Zaretskii <eliz@gnu.org>2011-11-26 16:07:22 +0200
commit579ebf8ff0b7693754fb27bbea4fceb4410df0e8 (patch)
treeabeb64f0f997cdf52456ffcb99640a1e5220aae6
parenta3dcc84e76ab44bf0855a1392a7e0b9bde45e1c3 (diff)
downloademacs-579ebf8ff0b7693754fb27bbea4fceb4410df0e8.tar.gz
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.
-rw-r--r--doc/lispref/ChangeLog5
-rw-r--r--doc/lispref/display.texi18
-rw-r--r--doc/lispref/text.texi16
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 @@
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.
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.
@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
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.
@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