diff options
| author | Eli Zaretskii | 2020-07-05 18:30:21 +0300 |
|---|---|---|
| committer | Eli Zaretskii | 2020-07-05 18:30:21 +0300 |
| commit | 247dcb4b1b1b4ea3d50b63d41c4efa58743f610d (patch) | |
| tree | 9e2cc6d74b07f0c96e03bb1f10cd47e2f41855e7 | |
| parent | d453cee1773a27d9d30fac18de0f32e5a08d3294 (diff) | |
| download | emacs-247dcb4b1b1b4ea3d50b63d41c4efa58743f610d.tar.gz emacs-247dcb4b1b1b4ea3d50b63d41c4efa58743f610d.zip | |
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>.
| -rw-r--r-- | doc/lispref/display.texi | 12 |
1 files changed, 7 insertions, 5 deletions
diff --git a/doc/lispref/display.texi b/doc/lispref/display.texi index 707a1a8dc04..19e0fdf0b12 100644 --- a/doc/lispref/display.texi +++ b/doc/lispref/display.texi | |||
| @@ -4277,9 +4277,10 @@ a display specification has the form | |||
| 4277 | @noindent | 4277 | @noindent |
| 4278 | @var{fringe} is either the symbol @code{left-fringe} or | 4278 | @var{fringe} is either the symbol @code{left-fringe} or |
| 4279 | @code{right-fringe}. @var{bitmap} is a symbol identifying the bitmap | 4279 | @code{right-fringe}. @var{bitmap} is a symbol identifying the bitmap |
| 4280 | to display. The optional @var{face} names a face whose foreground | 4280 | to display. The optional @var{face} names a face whose foreground and |
| 4281 | color is used to display the bitmap; this face is automatically merged | 4281 | background colors are to be used to display the bitmap; this face is |
| 4282 | with the @code{fringe} face. | 4282 | automatically merged with the @code{fringe} face. If @var{face} is |
| 4283 | omitted, that means to use the @code{default} face. | ||
| 4283 | 4284 | ||
| 4284 | For instance, to display an arrow in the left fringe, using the | 4285 | For instance, to display an arrow in the left fringe, using the |
| 4285 | @code{warning} face, you could say something like: | 4286 | @code{warning} face, you could say something like: |
| @@ -4983,8 +4984,9 @@ Margins}). | |||
| 4983 | This display specification on any character of a line of text causes | 4984 | This display specification on any character of a line of text causes |
| 4984 | the specified @var{bitmap} be displayed in the left or right fringes | 4985 | the specified @var{bitmap} be displayed in the left or right fringes |
| 4985 | for that line, instead of the characters that have the display | 4986 | for that line, instead of the characters that have the display |
| 4986 | specification. The optional @var{face} specifies the colors to be | 4987 | specification. The optional @var{face} specifies the face whose |
| 4987 | used for the bitmap. @xref{Fringe Bitmaps}, for the details. | 4988 | colors are to be used for the bitmap display. @xref{Fringe Bitmaps}, |
| 4989 | for the details. | ||
| 4988 | 4990 | ||
| 4989 | @item (space-width @var{factor}) | 4991 | @item (space-width @var{factor}) |
| 4990 | This display specification affects all the space characters within the | 4992 | This display specification affects all the space characters within the |