RIXML Documentation

AbstractFormatted

RIXML 2.5 Element

Required

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.

Source:data-dictionary-2.5.1
Schema:RIXML-Common-2_5.xsd:2314

Where It Fits

Canonical Path

Research/Product/Content/AbstractFormatted

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

<AbstractFormatted />

Version History

Unchanged since introduction in RIXML 2.4

Business Rules

SHOULD

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

content-consistencyhtml-formatting
SHOULD

Abstract content must be limited to a few paragraphs or bullets highlighting key points covered in the report

content-guideline
SHOULD

AbstractFormatted element should have a maximum length of 3000 characters

best-practicelength-constraint
SHOULD

The AbstractFormatted element content should not exceed 3000 characters

content-lengthrecommendation

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

AbstractMAY

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

Contrasts With2 relationships

AbstractINFORMATIVE

AbstractFormatted supports limited HTML markup for product summaries while Abstract restricts all markup

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

AbstractINFORMATIVE

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.38AbstractFormatted (Optional, String)