RIXML Documentation

TitleFormatted

RIXML 2.5 Element

Required

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.

Source:release-notes-2.5
Schema:RIXML-Common-2_5.xsd:2294

Where It Fits

Canonical Path

Research/Product/Content/TitleFormatted

Definition

Typestring
Namespacehttp://www.rixml.org/2017/9/RIXML
Min Occurs1
Max Occurs1

Attributes

No attributes defined for this element

Children

No child elements defined

Example

<TitleFormatted />

Version History

Unchanged since introduction in RIXML 2.4

Business Rules

MUST

TitleFormatted element must be optional within Content elements

bug-fixvalidationcontent-management
SHOULD

When using formatted mirror elements like TitleFormatted, the content should be identical to the main tags aside from the formatting

content-consistencyhtml-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

TitleMAY

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.12Embedding HTML content

Contrasts With1 relationship

TitleINFORMATIVE

TitleFormatted permits limited HTML markup for the product title while Title prohibits all markup

RIXML Research Data Dictionary v2.5.1, p.37TitleFormatted (Optional, String)

Constrains1 relationship

ContentMAY

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.30Should be optional