SubTitleFormatted
RIXML 2.5 Element
This is the sub title of the product.
This is the sub title of the product. Limited markup permitted - HTML code for paragraph, ordered lists and unordered lists with list items, bold, underline, and italics.
Specification Guide
Overview
SubTitleFormatted is an optional child of Content that carries the product subtitle with limited HTML markup, mirroring the plain-text SubTitle element. It exists so publishers can convey richer visual presentation of subtitles to consuming platforms without polluting the plain-text SubTitle field with markup that some consumers cannot process (sources: data-dictionary-2.4 p.12, release-notes-2.4 p.20, data-dictionary-2.5.1 p.12).
Usage
Use SubTitleFormatted as an optional child of Content (cardinality 0..1) alongside the unformatted SubTitle. Publishers typically populate both: SubTitle with plain text for systems that cannot render markup, and SubTitleFormatted with the same content wrapped in basic HTML for systems that can. The semantic content of both elements should be identical, differing only in markup [RIXML Research Data Dictionary v2.5.1 p.12]. Permitted markup is limited to a small set of basic HTML tags — paragraphs (<P>), ordered and unordered lists (<OL>, <UL>, <LI>), bold (<B>), underline (<U>), and italics (<I>) — and list nesting is permitted [RIXML Release Notes v2.4 p.20].
Rules
- SHOULDThe content of SubTitleFormatted should be identical to SubTitle aside from the HTML formatting markup.[RIXML Research Data Dictionary v2.5.1 p.12]
- MUSTOnly basic HTML markup is permitted in SubTitleFormatted: paragraph, ordered list, unordered list, list item, bold, underline, and italics tags.[RIXML Release Notes v2.4 p.20]
- MAYPublishers may provide both SubTitle and SubTitleFormatted in the same Content block to support consumers with differing markup capabilities.[RIXML Release Notes v2.4 p.20]
- MAYList nesting is permitted within SubTitleFormatted when using HTML list markup.[RIXML Release Notes v2.4 p.21]
Relationships
- mirrorsSubTitle — SubTitleFormatted is the formatted mirror of SubTitle, carrying the same semantic subtitle content but permitting limited HTML markup, whereas SubTitle accepts no markup.
- child-ofContent — Appears as an optional child element (0..1) of Content.
- siblingTitleFormatted — Part of the family of formatted mirror elements introduced together — TitleFormatted, SubTitleFormatted, AbstractFormatted, and SynopsisFormatted — all of which follow the same markup conventions.
- siblingAbstractFormatted — Companion formatted mirror element governed by the same markup rules and design rationale.
- siblingSynopsisFormatted — Companion formatted mirror element governed by the same markup rules and design rationale.
Where It Fits
Definition
| Type | string |
| Namespace | http://www.rixml.org/2017/9/RIXML |
| Min Occurs | 1 |
| Max Occurs | 1 |
Attributes
No attributes defined for this element
Children
No child elements defined
Example
<SubTitleFormatted />Version History
Unchanged since introduction in RIXML 2.4
SubTitleFormatted was introduced in RIXML 2.4 as part of the Formatted Text-Blocks feature, which added a family of mirror elements (TitleFormatted, SubTitleFormatted, AbstractFormatted, SynopsisFormatted, and BiographyFormatted) to give publishers a sanctioned place to embed HTML markup [RIXML Release Notes v2.4 p.20]. The element carries through unchanged into 2.5, where the data dictionary reiterates the mirror-content guidance and the limited markup set (source: data-dictionary-2.5.1, pp.12, 37).
Business Rules
When using formatted mirror elements like TitleFormatted, the content should be identical to the main tags aside from the formatting
Design Decisions
Mirror elements with 'Formatted' suffix were added to support HTML markup in text fields
Publishers were embedding HTML markup in freeform text fields like subtitle and abstract, which could impact XML well-formedness and display unpredictably across platforms. The formatted mirror elements provide a designated place for HTML content while maintaining clean text in the original elements
RIXML Research Data Dictionary v2.5.1, p.12
Semantic Relationships
Replaces1 relationship
SubTitleFormatted serves as an alternative to SubTitle when HTML formatting is needed, containing identical content with markup
RIXML Research Data Dictionary v2.5.1, p.12— Embedding HTML content
Contrasts With1 relationship
SubTitleFormatted allows limited HTML markup for the product subtitle whereas SubTitle accepts no markup
RIXML Research Data Dictionary v2.5.1, p.37— SubTitleFormatted (Optional, String)