aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorEli Zaretskii2017-03-04 17:58:03 +0200
committerEli Zaretskii2017-03-04 17:58:03 +0200
commita314c1ff05741efe788a054a4661e80c624e3b71 (patch)
tree814e300602e73cb9d875edd93cfc204a7548ddff
parentf366f6e6701fa12fd228614c39ab006caa6ac010 (diff)
downloademacs-a314c1ff05741efe788a054a4661e80c624e3b71.tar.gz
emacs-a314c1ff05741efe788a054a4661e80c624e3b71.zip
Clarify documentation of 'raise' and 'height' display specs
* doc/lispref/display.texi (Other Display Specs): Clarify the effect of 'height' display spec on the following 'raise'. (Bug#25824)
-rw-r--r--doc/lispref/display.texi25
1 files changed, 15 insertions, 10 deletions
diff --git a/doc/lispref/display.texi b/doc/lispref/display.texi
index b8599abd149..84e7deb692e 100644
--- a/doc/lispref/display.texi
+++ b/doc/lispref/display.texi
@@ -4666,16 +4666,21 @@ a form. Emacs evaluates it to get the new height, with the symbol
4666 4666
4667@item (raise @var{factor}) 4667@item (raise @var{factor})
4668This kind of display specification raises or lowers the text 4668This kind of display specification raises or lowers the text
4669it applies to, relative to the baseline of the line. 4669it applies to, relative to the baseline of the line. It is mainly
4670 4670meant to support display of subscripts and superscripts.
4671@var{factor} must be a number, which is interpreted as a multiple of the 4671
4672height of the affected text. If it is positive, that means to display 4672The @var{factor} must be a number, which is interpreted as a multiple
4673the characters raised. If it is negative, that means to display them 4673of the height of the affected text. If it is positive, that means to
4674lower down. 4674display the characters raised. If it is negative, that means to
4675 4675display them lower down.
4676If the text also has a @code{height} display specification, that does 4676
4677not affect the amount of raising or lowering, which is based on the 4677Note that if the text also has a @code{height} display specification,
4678faces used for the text. 4678which was specified before (i.e.@: to the left of) @code{raise}, the
4679latter will affect the amount of raising or lowering in pixels,
4680because that is based on the height of the text being raised.
4681Therefore, if you want to display a sub- or superscript that is
4682smaller than the normal text height, consider specifying @code{raise}
4683before @code{height}.
4679@end table 4684@end table
4680 4685
4681@c We put all the '@code{(when ...)}' on one line to encourage 4686@c We put all the '@code{(when ...)}' on one line to encourage