SynopsisFormatted
RIXML 2.5 Element
A concise formatted statement describing the research product subject, limited to approximately 300 characters with HTML markup support. Designed for abbreviated display scenarios with enhanced formatting capabilities.
A very brief statement of the subject addressed in the product. This is typically only a few lines and would be appropriate for highly abbreviated displays. Suggested maximum length is 300 characters. Limited markup permitted - HTML code for paragraph, ordered lists and unordered lists with list items, bold, underline, and italics.
Usage
Optional element for providing brief, formatted product descriptions in space-constrained interfaces. Should be used when Synopsis alone is insufficient for proper content presentation requiring visual formatting.
Business Context
Essential for research aggregation platforms and mobile interfaces where space is limited but formatting enhances readability. Supports quick product identification and selection in research discovery workflows.
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
<SynopsisFormatted />Version History
Unchanged since introduction in RIXML 2.4
Business Rules
When using formatted mirror elements like TitleFormatted, the content should be identical to the main tags aside from the formatting
Synopsis content must be limited to a few lines and be appropriate for highly abbreviated displays
SynopsisFormatted element should have a maximum length of 300 characters
The SynopsisFormatted element content should not exceed 300 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 synopsis and title, 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
SynopsisFormatted serves as an alternative to Synopsis 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
SynopsisFormatted enables limited HTML markup for brief product statements while Synopsis permits no markup
RIXML Research Data Dictionary v2.5.1, p.37— SynopsisFormatted (Optional, String)
SynopsisFormatted permits HTML markup while Synopsis does not, representing formatted and unformatted versions of the same content
RIXML Research Data Dictionary v2.5.1, p.38— SynopsisFormatted (Optional, String)