Skip to content

Commit

Permalink
resolves #2511 document the nobreak, nowrap, and pre-wrap built-in roles
Browse files Browse the repository at this point in the history
also document the impact the use of the fallback font has on the nobreak and nowrap roles
  • Loading branch information
mojavelinux committed May 23, 2024
1 parent 8a639b5 commit 0a50fd5
Showing 1 changed file with 11 additions and 0 deletions.
11 changes: 11 additions & 0 deletions docs/modules/theme/pages/role.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -163,6 +163,17 @@ small:: The `small` role maps the font size to the `$base-font-size-small` value
underline:: The `underline` role adds the underline decoration.
line-through:: The `line-through` role adds the strikethrough decoration.
subtitle:: The `subtitle` role is used to configure the font properties of the subtitle of a section title.
nobreak:: The `nobreak` role prevents words within the span of text from being broken.
This role does not otherwise modify the appearance of the text.
If the fallback font is used for any character in the span, it will introduce a break opportunity at that character.
This happens since the PDF generator creates a separate fragment to change fonts, and fragment boundaries are a break opportunity.
nowrap:: The `nowrap` role prevents the span of text from wrapping unless the entire span does not fit on a whole line.
This role does not otherwise modify the appearance of the text.
If the fallback font is used for any character in the span, it will introduce a break opportunity at that character.
This happens since the PDF generator creates a separate fragment to change fonts, and fragment boundaries are a break opportunity.
pre-wrap:: The `pre-wrap` role prevents sequences of space and space-like characters from being collapsed (i.e., all spaces are preserved).
This role does not otherwise modify the appearance of the text.
Note that if the space characters fall at the boundary of a line wrap, those space characters will be dropped.
// end::user-formatting[]
// tag::para-roles[]
text-justify:: Aligns the text to the left margin with justification.
Expand Down

0 comments on commit 0a50fd5

Please sign in to comment.