RIXML Documentation

Content

RIXML 2.5 Element

Level OneRequired

Required container element holding research product content information including titles, abstracts, and resource files. Must contain exactly one Resource element for Level One compliance.

Usage

Required element within Product, appearing exactly once. Must contain one Resource element and optional content description elements like Title, Abstract, and Synopsis.

Business Context

Central to research content organization and delivery, providing structured access to research documents and metadata for distribution and consumption workflows.

Source:level-one-2.5
Schema:RIXML-2_5.xsd:40

Specification Guide

Overview

Content is the primary container within a Product that holds the research product's descriptive metadata (titles, subtitles, abstracts, synopses) together with one or more Resource references to the actual deliverable files or URLs. It bridges human-readable content description and machine-accessible payload, enabling consumers to discover, preview, and retrieve the research item across distribution platforms (sources: data-dictionary-2.4 p.34, user-guide-2.3 p.22, data-dictionary-2.5.1 p.38).

Usage

Content is a required child of Product and appears exactly once per product (sources: user-guide-2.3 p.22, level-one-2.3 p.9). Its only mandatory child is Title; optional descriptive children include SubTitle, Abstract (suggested maximum 3000 characters), Synopsis (suggested maximum 300 characters for abbreviated displays), and their formatted counterparts TitleFormatted, SubTitleFormatted, AbstractFormatted, and SynopsisFormatted, which support limited HTML markup for rich display (sources: user-guide-2.1 p.22, user-guide-2.2 p.22, data-dictionary-2.4 p.12). From v2.5.1, ContentDetailsAlternativeLanguages may also be included to support multilingual content descriptions [data-dictionary-2.5.1 p.38]. Content must contain at least one Resource pointing to the research deliverable (PDF, HTML, audio, URL, etc.). General (non–Level One) usage permits multiple Resource children to represent different formats, languages, or delivery mechanisms of the same research idea, in which case one primaryIndicator should be set to Yes [data-dictionary-2.4 p.12]. Linkback deployments typically include two resources — one for the linkback URL and one for the underlying content file [linkback-implementation-guide p.6].

Rules

  • MUSTContent MUST appear exactly once as a direct child of every Product.[RIXML User Guide v2.3 p.15] [RIXML User Guide v2.3 p.22] [RIXML Research Data Dictionary v2.4 p.34]
  • MUSTContent MUST contain a Title element; other descriptive children (SubTitle, Abstract, Synopsis, and their formatted variants) are optional.[RIXML User Guide v2.1 p.22] [RIXML User Guide v2.2 p.22] [RIXML Research Data Dictionary v2.4 p.34]
  • MUSTContent MUST contain at least one Resource element, and where multiple resources are present one of them SHOULD have primaryIndicator set to Yes.[RIXML Research Data Dictionary v2.4 p.12] [Company Report (Advanced) Sample v2.4]
  • MUSTFor Level One compliance, Content MUST contain exactly one Resource element describing the payload file (typically a PDF).[RIXML Level One Addendum v2.2 p.14] [RIXML Level One Addendum v2.3 p.9] [RIXML Level One Addendum v2.4 p.9] [RIXML Level One Addendum v2.5 p.9]
  • SHOULDAbstract within Content has a suggested maximum length of 3000 characters and Synopsis a suggested maximum of 300 characters; these are guidance limits rather than schema-enforced constraints.[RIXML User Guide v2.1 p.22] [RIXML User Guide v2.2 p.22] [RIXML User Guide v2.3 p.22] [RIXML Research Data Dictionary v2.5.1 p.38]
  • SHOULDTitleFormatted within Content SHOULD be treated as optional; the v2.4 schema incorrectly declared it required, and this was corrected in v2.5.[RIXML Quarterly Update 2013 Q1 p.2] [RIXML Release Notes v2.5 p.30]
  • SHOULDWhen Content is rendered through vendor-supplied viewers (e.g. in linkback deployments), providers and vendors SHOULD coordinate during planning and perform end-to-end display testing across all supported viewing methods to ensure correct rendering.[RIXML Investment Research Linkback Technical Implementation Guide v1.0 p.8]

Relationships

Where It Fits

Definition

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

Attributes

No attributes defined for this element

Children

Descriptionstring0..1
optionalSince 2.1
Titlestring1..1

This is the primary title of the product. No markup permitted.

requiredSince 2.1
TitleFormattedstring0..1

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.

optionalSince 2.4
SubTitlestring0..1

This is the sub title of the product. No markup permitted.

optionalSince 2.1

This is the sub title of the product. Limited markup permitted - HTML code for paragraph, ordered lists and unordered lists with list items, bold, underline, and italics.

optionalSince 2.4
Abstractstring0..1

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. No markup permitted.

optionalSince 2.1

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.

optionalSince 2.4
Synopsisstring0..1

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. No markup permitted.

optionalSince 2.1

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.

optionalSince 2.4
Resource(complex)0..unbounded
optionalSince 2.1
optionalSince 2.5

Example

<Content>
  <Title> ... </Title>
</Content>

Version History

2.1
+Introduced
2.4
+Added children: TitleFormatted, SubTitleFormatted, AbstractFormatted, SynopsisFormatted
2.5
+Added children: ContentDetailsAlternativeLanguages

Content has been a stable, required container under Product since at least RIXML v2.1, exposing Title, optional SubTitle, Abstract (≤3000 chars suggested), Synopsis (≤300 chars suggested), an optional Description, and one or more Resource children [user-guide-2.1 p.22]. - v2.2 / v2.3: Wording and aggregation diagrams confirmed Content as required exactly once within Product (sources: user-guide-2.2 p.22, user-guide-2.3 p.15). - v2.4: Introduced/clarified formatted variants — TitleFormatted, SubTitleFormatted, AbstractFormatted, SynopsisFormatted — supporting basic HTML markup alongside their plain-text equivalents [data-dictionary-2.4 p.12]. A schema bug incorrectly marked TitleFormatted as required within Content [quarterly-2013-q1 p.2]. - v2.5: Corrected the TitleFormatted cardinality so that it is properly optional within Content [release-notes-2.5 p.30]. - v2.5.1: Added ContentDetailsAlternativeLanguages as an optional child, enabling multilingual titles, abstracts and synopses [data-dictionary-2.5.1 p.38]. - v3.0 (draft): Working-group discussions consider enhancing Content for component-level tagging (charts, sections), per-resource identification within a single research item, and audience-customised titles/abstracts to support multimedia and targeted distribution [meeting-2024-spring p.23]. A separate v3.0 proposal recorded in the winter 2024 meeting suggested removing several package-layer containers (Source, Context, Content, Legal and others) due to limited adoption [meeting-2024-winter p.22]; this is a working-group discussion item and not a finalised decision.

Semantic Relationships

Evidences1 relationship

ResourceMUST

Resource element provides reference to the actual research report, whether as PDF, audio file, or other media format that contains the research content

RIXML Implementation Guide v2.5.1, p.17Level One

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