Clarify the documentation of 'left/right-fringe' display spec

* doc/lispref/display.texi (Other Display Specs, Fringe Bitmaps):
Clarify how the optional FACE parameter of the left-fringe and
right-fringe display spec is used.  Reported by Gregory Heytings
<ghe@sdf.org>.
This commit is contained in:
Eli Zaretskii 2020-07-05 18:30:21 +03:00
parent d453cee177
commit 247dcb4b1b

View file

@ -4277,9 +4277,10 @@ a display specification has the form
@noindent @noindent
@var{fringe} is either the symbol @code{left-fringe} or @var{fringe} is either the symbol @code{left-fringe} or
@code{right-fringe}. @var{bitmap} is a symbol identifying the bitmap @code{right-fringe}. @var{bitmap} is a symbol identifying the bitmap
to display. The optional @var{face} names a face whose foreground to display. The optional @var{face} names a face whose foreground and
color is used to display the bitmap; this face is automatically merged background colors are to be used to display the bitmap; this face is
with the @code{fringe} face. automatically merged with the @code{fringe} face. If @var{face} is
omitted, that means to use the @code{default} face.
For instance, to display an arrow in the left fringe, using the For instance, to display an arrow in the left fringe, using the
@code{warning} face, you could say something like: @code{warning} face, you could say something like:
@ -4983,8 +4984,9 @@ Margins}).
This display specification on any character of a line of text causes This display specification on any character of a line of text causes
the specified @var{bitmap} be displayed in the left or right fringes the specified @var{bitmap} be displayed in the left or right fringes
for that line, instead of the characters that have the display for that line, instead of the characters that have the display
specification. The optional @var{face} specifies the colors to be specification. The optional @var{face} specifies the face whose
used for the bitmap. @xref{Fringe Bitmaps}, for the details. colors are to be used for the bitmap display. @xref{Fringe Bitmaps},
for the details.
@item (space-width @var{factor}) @item (space-width @var{factor})
This display specification affects all the space characters within the This display specification affects all the space characters within the