TitleFormatted
RIXML 2.5 Element
An element that contains the primary title of a research product with limited HTML markup permitted. Fixed in version 2.5 to be properly optional as intended, correcting a schema bug where the minOccurs=0 attribute was missing in version 2.4.
This is the primary title of the product. Limited markup permitted - HTML code for paragraph, ordered lists and unordered lists with list items, bold, underline, and italics.
Usage
Used within Content elements when formatted title presentation is needed. Now correctly optional (minOccurs=0) as specified in the Data Dictionary. Allows HTML markup for paragraph, ordered lists, unordered lists with items, bold, underline, and italics formatting.
Business Context
Provides publishers flexibility in presenting research titles with rich formatting while maintaining the plain text Title as the primary identifier. The cardinality fix ensures proper schema validation and optional implementation as designed.
Specification Guide
Overview
TitleFormatted is an optional mirror of the Title element that carries the primary product title with limited inline HTML markup permitted for richer presentation. It exists so that publishers can preserve emphasis, line breaks, lists and other visual styling in titles without injecting markup into the plain-text Title field, which would otherwise risk inconsistent rendering across consuming platforms (sources: data-dictionary-2.4 p.12, release-notes-2.4 p.20, data-dictionary-2.5.1 p.12). It is one of a family of formatted mirror elements introduced together — alongside SubTitleFormatted, AbstractFormatted and SynopsisFormatted — that signal to aggregators and vendors that the value contains HTML markup [RIXML Release Notes v2.4 p.20].
Usage
TitleFormatted appears as an optional child (cardinality 0..1) of Content, used alongside the required plain-text Title. It is also available within ContentDetails for alternative-language variants [RIXML Release Notes v2.5 p.30].
When present, its textual content should match Title verbatim, differing only by the addition of permitted HTML formatting tags [RIXML Research Data Dictionary v2.5.1 p.12]. The allowed markup is restricted to a small set: paragraphs (<P>), ordered and unordered lists with items (<OL>, <UL>, <LI>), bold (<B>), underline (<U>) and italics (<I>); list nesting is permitted [RIXML Release Notes v2.4 p.20].
Publishers may provide both Title and TitleFormatted to accommodate consumers with differing markup capabilities — recipients are free to choose which to render (sources: data-dictionary-2.4 p.12, release-notes-2.4 p.20).
Rules
- MUSTTitleFormatted must be optional (minOccurs=0) within Content; this was a schema defect in v2.4 (where it was inadvertently required) and was corrected in v2.5.[RIXML Quarterly Update 2013 Q1 p.2]↗ [RIXML Release Notes v2.5 p.30] [RIXML Quarterly Update 2017 Q2 p.8]↗
- SHOULDThe content of TitleFormatted should be identical to the content of Title, differing only by the inclusion of permitted HTML formatting markup.[RIXML Research Data Dictionary v2.4 p.12] [RIXML Research Data Dictionary v2.5.1 p.12]
- MUSTOnly a restricted set of HTML tags may appear inside TitleFormatted: paragraph (
<P>), ordered list (<OL>), unordered list (<UL>), list item (<LI>), bold (<B>), underline (<U>) and italics (<I>). List nesting is permitted.[RIXML Release Notes v2.4 p.20] - MAYPublishers may provide both Title and TitleFormatted to accommodate consumers with different markup-handling capabilities.[RIXML Release Notes v2.4 p.20] [RIXML Research Data Dictionary v2.4 p.12]
Relationships
- child-ofContent — TitleFormatted is an optional child of Content (cardinality 0..1).
- child-ofContentDetails — TitleFormatted also appears within ContentDetails for alternative-language variants of the title, with the same optional cardinality.
- mirrorsTitle — TitleFormatted mirrors Title, carrying the same textual content but permitting limited HTML markup. Title remains the required plain-text title; TitleFormatted is the optional formatted counterpart.
- siblingSubTitleFormatted — Belongs to the same family of formatted mirror elements introduced in v2.4, together with AbstractFormatted and SynopsisFormatted.
- siblingAbstractFormatted — Sibling formatted mirror element introduced alongside TitleFormatted in v2.4.
- siblingSynopsisFormatted — Sibling formatted mirror element introduced alongside TitleFormatted in v2.4.
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
<TitleFormatted />Version History
Unchanged since introduction in RIXML 2.4
v2.4 — Introduced. TitleFormatted was added as part of the new family of formatted mirror text elements (together with SubTitleFormatted, AbstractFormatted, SynopsisFormatted and a Biography formatted variant) to give publishers a sanctioned place to embed limited HTML markup in titles without compromising the plain-text Title [RIXML Release Notes v2.4 p.20].
v2.4 — Schema defect. Although the Data Dictionary described the element as optional, the 2.4 schema omitted minOccurs="0", effectively making it required. This was acknowledged in the 2013 Q1 quarterly update and flagged for correction [RIXML Quarterly Update 2013 Q1 p.2]↗.
v2.5 — Cardinality fix. The schema was corrected so that TitleFormatted is properly optional (minOccurs="0") both within Content and within ContentDetails language variants, aligning the schema with the documented intent (sources: release-notes-2.5 p.30, quarterly-2017-q2 p.8, quarterly-2017-q3 p.8).
Business Rules
TitleFormatted element must be optional within Content elements
When using formatted mirror elements like TitleFormatted, the content should be identical to the main tags aside from the formatting
Design Decisions
Fixed cardinality bug by making TitleFormatted element optional with minOccurs=0 attribute
The element was intended to be optional as documented in the Data Dictionary but the schema implementation was missing the minOccurs=0 attribute, creating a discrepancy
RIXML Release Notes v2.5, p.30
Mirror elements with 'Formatted' suffix were added to support HTML markup in text fields
Publishers were embedding HTML markup in freeform text fields like title 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
TitleFormatted serves as an alternative to Title 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
TitleFormatted permits limited HTML markup for the product title while Title prohibits all markup
RIXML Research Data Dictionary v2.5.1, p.37— TitleFormatted (Optional, String)
Constrains1 relationship
TitleFormatted element cardinality correction makes it properly optional within Content elements, fixing a schema bug from version 2.4
RIXML Release Notes v2.5, p.30— Should be optional