From 0a50fd54e9703a7063c057f3fe855fb5a4183f2a Mon Sep 17 00:00:00 2001 From: Dan Allen Date: Thu, 23 May 2024 01:55:22 -0600 Subject: [PATCH] resolves #2511 document the nobreak, nowrap, and pre-wrap built-in roles also document the impact the use of the fallback font has on the nobreak and nowrap roles --- docs/modules/theme/pages/role.adoc | 11 +++++++++++ 1 file changed, 11 insertions(+) diff --git a/docs/modules/theme/pages/role.adoc b/docs/modules/theme/pages/role.adoc index 958228ca6..6ae497bdd 100644 --- a/docs/modules/theme/pages/role.adoc +++ b/docs/modules/theme/pages/role.adoc @@ -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.