AbstractFormatted
RIXML 2.5 Element
A formatted summary of research product information that permits limited HTML markup. Supports essential formatting elements including paragraphs, ordered and unordered lists, bold, underline, and italics. Maximum recommended length of 3000 characters.
A summary of the information contained in the product. Highlights the salient issues in the document or provides a brief description of the event. Suggested maximum length is 3000 characters. Limited markup permitted - HTML code for paragraph, ordered lists and unordered lists with list items, bold, underline, and italics.
Usage
Optional element used to provide enhanced presentation of abstract content when basic text formatting is insufficient. Typically used alongside the plain-text Abstract element to offer formatting options for display systems that support HTML rendering.
Business Context
Enables research publishers to provide richer presentation of key product summaries while maintaining compatibility with systems that require plain text. Critical for research distribution platforms that need to present content with visual emphasis and structure.
Specification Guide
Overview
AbstractFormatted is an optional, formatted mirror of the Abstract element that carries the same product summary content but permits a limited set of HTML markup tags for richer presentation. It sits inside the Content block of a Product and exists so that publishers can express paragraphs, lists, and basic emphasis without polluting the plain-text Abstract or breaking XML well-formedness (source: data-dictionary-2.5.1, p.12; source: release-notes-2.4, p.20).
Usage
Use AbstractFormatted as an optional child of Content (cardinality 0..1), typically alongside the plain-text Abstract so that consumers which cannot render HTML still receive a usable summary, while HTML-capable consumers can display the formatted version (sources: data-dictionary-2.5.1 p.38, release-notes-2.4 p.20).
The content should mirror the Abstract — same informational summary highlighting the key points of the report — differing only in the addition of permitted HTML markup. The recommended maximum length is 3000 characters including markup (sources: data-dictionary-2.5.1 p.37–38, data-dictionary-2.4 p.12).
It is one of a family of *Formatted mirror elements that also includes TitleFormatted, SubTitleFormatted, and SynopsisFormatted, all of which follow the same conventions.
Rules
- MUSTThe HTML markup inside AbstractFormatted is restricted to a basic set: paragraph (
<p>), unordered list (<ul>), ordered list (<ol>), list item (<li>), bold (<b>), underline (<u>), and italics (<i>). Other HTML tags are not permitted.[RIXML Release Notes v2.4 p.20] - SHOULDThe content of AbstractFormatted should be identical to that of Abstract apart from the formatting tags, so that the plain and formatted variants stay in sync.[RIXML Research Data Dictionary v2.5.1 p.12] [RIXML Research Data Dictionary v2.4 p.12]
- SHOULDAbstractFormatted content should not exceed 3000 characters (including markup), keeping the abstract concise and aligned with the limit applied to Abstract.[RIXML Research Data Dictionary v2.5.1 p.37] [RIXML Research Data Dictionary v2.5.1 p.38] [RIXML Research Data Dictionary v2.4 p.12]
- SHOULDThe abstract content (in both Abstract and AbstractFormatted) should be limited to a few paragraphs or bullets highlighting the key points covered in the report.[RIXML Research Data Dictionary v2.5.1 p.18]
- MAYPublishers MAY provide both unformatted and formatted versions of summary text by populating Abstract together with AbstractFormatted (and similarly for title, subtitle and synopsis), allowing consumers to choose the variant their system supports.[RIXML Release Notes v2.4 p.20]
- MAYNested lists are permitted within AbstractFormatted when using the allowed
<ul>/<ol>/<li>markup.[RIXML Release Notes v2.4 p.21]
Relationships
- mirrorsAbstract — AbstractFormatted is the formatted counterpart of Abstract; both convey the same summary, but AbstractFormatted permits limited HTML markup while Abstract remains plain text.
- child-ofContent — AbstractFormatted is an optional child element of Content (cardinality 0..1).
- sibling-patternTitleFormatted — AbstractFormatted follows the same
*Formattedmirror pattern as TitleFormatted, SubTitleFormatted, and SynopsisFormatted. - sibling-patternSynopsisFormatted — Companion formatted element used together with AbstractFormatted inside Content when publishers wish to provide formatted summary text throughout the product.
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
<AbstractFormatted />Version History
Unchanged since introduction in RIXML 2.4
AbstractFormatted was introduced in RIXML 2.4 as part of the new family of *Formatted Text-Blocks* (alongside TitleFormatted, SubTitleFormatted, SynopsisFormatted, and BiographyFormatted). The motivation was that publishers had begun embedding HTML inside the plain-text summary fields, which threatened XML well-formedness and produced inconsistent rendering across consumers (source: release-notes-2.4, p.20; source: data-dictionary-2.5.1, p.12).
In RIXML 2.5 / 2.5.1 the element is carried forward unchanged in semantics: optional, located under Content, same permitted HTML tag set, and the same 3000-character guidance (source: data-dictionary-2.5.1, pp.37–38).
Business Rules
When using formatted mirror elements like TitleFormatted, the content should be identical to the main tags aside from the formatting
Abstract content must be limited to a few paragraphs or bullets highlighting key points covered in the report
AbstractFormatted element should have a maximum length of 3000 characters
The AbstractFormatted element content should not exceed 3000 characters
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 abstract and synopsis, 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
AbstractFormatted serves as an alternative to Abstract when HTML formatting is needed, containing identical content with markup
RIXML Research Data Dictionary v2.5.1, p.12— Embedding HTML content
Contrasts With2 relationships
AbstractFormatted supports limited HTML markup for product summaries while Abstract restricts all markup
RIXML Research Data Dictionary v2.5.1, p.37— AbstractFormatted (Optional, String)
AbstractFormatted permits HTML markup while Abstract does not, representing formatted and unformatted versions of the same content
RIXML Research Data Dictionary v2.5.1, p.38— AbstractFormatted (Optional, String)