summaryrefslogtreecommitdiff
path: root/doc/lispref/display.texi
diff options
context:
space:
mode:
authorLars Ingebrigtsen <larsi@gnus.org>2022-08-26 14:27:25 +0200
committerLars Ingebrigtsen <larsi@gnus.org>2022-08-26 20:00:10 +0200
commit997103bb879bb7aee36a99be39fb771daa7999de (patch)
treeb4d97f0002406915e741db5da1e60d29cbb2ad87 /doc/lispref/display.texi
parent233c91d32adff3978931fbc78c27ef1d1560cf96 (diff)
downloademacs-997103bb879bb7aee36a99be39fb771daa7999de.tar.gz
emacs-997103bb879bb7aee36a99be39fb771daa7999de.tar.bz2
emacs-997103bb879bb7aee36a99be39fb771daa7999de.zip
Clarify the :box attributes in Face Attributes lispref node
* doc/lispref/display.texi (Face Attributes): Mention that the elements are optional (bug#50699).
Diffstat (limited to 'doc/lispref/display.texi')
-rw-r--r--doc/lispref/display.texi19
1 files changed, 11 insertions, 8 deletions
diff --git a/doc/lispref/display.texi b/doc/lispref/display.texi
index fde7274d591..bb2b2d98a36 100644
--- a/doc/lispref/display.texi
+++ b/doc/lispref/display.texi
@@ -2623,14 +2623,17 @@ Draw a box with lines of width 1, in the foreground color.
Draw a box with lines of width 1, in color @var{color}.
@item @code{(:line-width (@var{vwidth} . @var{hwidth}) :color @var{color} :style @var{style})}
-This way you can explicitly specify all aspects of the box. The values
-@var{vwidth} and @var{hwidth} specifies respectively the width of the
-vertical and horizontal lines to draw; they default to (1 . 1).
-A negative horizontal or vertical width @minus{}@var{n} means to draw a line
-of width @var{n} that occupies the space of the underlying text, thus
-avoiding any increase in the character height or width. For simplification
-the width could be specified with only a single number @var{n} instead
-of a list, such case is equivalent to @code{((abs @var{n}) . @var{n})}.
+You can explicitly specify all aspects of the box with a plist on this
+form. Any element in this plist can be omitted.
+
+The values @var{vwidth} and @var{hwidth} specifies respectively the
+width of the vertical and horizontal lines to draw; they default to (1
+. 1). A negative horizontal or vertical width @minus{}@var{n} means
+to draw a line of width @var{n} that occupies the space of the
+underlying text, thus avoiding any increase in the character height or
+width. For simplification the width could be specified with only a
+single number @var{n} instead of a list, such case is equivalent to
+@code{((abs @var{n}) . @var{n})}.
The value @var{style} specifies whether to draw a 3D box. If it is
@code{released-button}, the box looks like a 3D button that is not