underlineElementElementElement functions can be customized with set and show rules.
Element
Element functions can be customized with
set and show rules.Underlines text.
Example
This is #underline[important].
ParameterParameterParameters are input values for functions. Specify them in parentheses after the function name.
Parameter
Parameters are input values for functions. Specify them in parentheses after the function name.
underline(,,,,,)->How to stroke the line.
If set to auto, takes on the text's color and a thickness defined in
the current font.
Show example
Take #underline(
stroke: 1.5pt + red,
offset: 2pt,
[care],
)
Default value:
autoThe position of the line relative to the baseline, read from the font
tables if auto.
Show example
#underline(offset: 5pt)[
The Tale Of A Faraway Line I
]
Default value:
autoextentSettableSettableSettable parameters can be set using the set rule, changing the default value used thereafter.
extentSettable
Settable
Settable parameters can be set using the
set rule, changing the default value used thereafter.The amount by which to extend the line beyond (or within if negative) the content.
Show example
#align(center,
underline(extent: 2pt)[Chapter 1]
)
Default value:
0ptevadeSettableSettableSettable parameters can be set using the set rule, changing the default value used thereafter.
evadeSettable
Settable
Settable parameters can be set using the
set rule, changing the default value used thereafter.Whether the line skips sections in which it would collide with the glyphs.
Show example
This #underline(evade: true)[is great].
This #underline(evade: false)[is less great].
Default value:
truebackgroundSettableSettableSettable parameters can be set using the set rule, changing the default value used thereafter.
backgroundSettable
Settable
Settable parameters can be set using the
set rule, changing the default value used thereafter.Whether the line is placed behind the content it underlines.
Show example
#set underline(stroke: (thickness: 1em, paint: maroon, cap: "round"))
#underline(background: true)[This is stylized.] \
#underline(background: false)[This is partially hidden.]
Default value:
falsebodyRequiredRequiredRequired parameters must be specified when calling the function.PositionalPositionalPositional parameters can be set by specifying them in order, omitting the parameter name.
bodyRequired
Required
Required parameters must be specified when calling the function.
Positional
Positional
Positional parameters can be set by specifying them in order, omitting the parameter name.
The content to underline.