ContentDetails
RIXML 2.5 Element
Comprehensive content description information for a specific language, including title, sub-title, synopsis, and abstract elements. Contains language attribute (optional, defaulting to Research element language or English), required Title field, optional SubTitle, Abstract (up to 3000 characters suggested), Synopsis (up to 300 characters suggested), and formatted versions of these fields supporting limited HTML markup.
Usage
Used within ContentDetailsAlternativeLanguages containers to provide content descriptions in specific languages. Title is required, while other descriptive fields are optional but recommended for complete content description.
Business Context
Enables multilingual research distribution by providing content descriptions in multiple languages, supporting international client bases and ensuring proper content understanding across different linguistic markets.
Specification Guide
Overview
ContentDetails is a container element that packages the descriptive and presentational text of a research product — Title, SubTitle, Synopsis, Abstract, and their formatted counterparts — for a single language context. It exists primarily to support multilingual distribution of research metadata, allowing publishers to supply title and summary text in languages other than the document's default. Each instance carries an optional language attribute (ISO 639-2) identifying the language of its contents.
Usage
ContentDetails is used inside the ContentDetailsAlternativeLanguages container, which appears within Content to hold one or more language-specific variants of the product's descriptive text. The element requires a Title child; TitleFormatted, SubTitle, SubTitleFormatted, Abstract, AbstractFormatted, Synopsis, and SynopsisFormatted are all optional but recommended for complete descriptions. Suggested length limits are 3000 characters for Abstract and 300 characters for Synopsis [RIXML Research Data Dictionary v2.5.1 p.36]. If the language attribute is omitted, the language defaults to that declared on the Research element, or to English [RIXML Research Data Dictionary v2.5.1 p.36]. The formatted variants support a limited subset of HTML markup.
Rules
- MUSTContentDetails MUST contain at least one Title child element.[RIXML Research Data Dictionary v2.5.1 p.36] [RIXML Release Notes v2.5 p.26]
- INFORMATIVEWhen the language attribute is omitted, the language defaults to the language declared on the Research element, or to English if none is declared.[RIXML Research Data Dictionary v2.5.1 p.36]
- SHOULDThe language attribute SHOULD use ISO 639-2 language codes.[RIXML Release Notes v2.5 p.26]
Relationships
- contained-byContentDetailsAlternativeLanguages — ContentDetails instances are held within ContentDetailsAlternativeLanguages, which may contain multiple ContentDetails elements — one per language variant.
- descendant-ofContent — ContentDetails ultimately describes the textual metadata of a Content item, providing localized titles, subtitles, abstracts, and synopses for that content.
- requiresTitle — ContentDetails requires a Title child; all other descriptive children are optional.
- containsSubTitle — Optionally contains a SubTitle (and its formatted variant SubTitleFormatted) in the language of this content variant.
- containsAbstract — Optionally contains an Abstract (and its formatted variant AbstractFormatted) providing a longer-form description, suggested limit 3000 characters.
- containsSynopsis — Optionally contains a Synopsis (and its formatted variant SynopsisFormatted) providing a short summary, suggested limit 300 characters.
Where It Fits
Canonical Path
Definition
| Type | ContentDetailsType |
| Namespace | http://www.rixml.org/2017/9/RIXML |
| Min Occurs | 1 |
| Max Occurs | 1 |
Attributes
Indicates the language of the Content Details. If not specified, default to value of language attribute of top Research element. If language attribute of Research element is not specified, default to English. Described using the ISO 639-2/T Code. optional |
Children
Descriptionstring0..1 |
optionalSince 2.5 |
Titlestring1..1 |
This is the primary title of the product. No markup permitted. requiredSince 2.5 |
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.5 |
SubTitlestring0..1 |
This is the sub title of the product. No markup permitted. optionalSince 2.5 |
SubTitleFormattedstring0..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.5 |
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.5 |
AbstractFormattedstring0..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.5 |
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.5 |
SynopsisFormattedstring0..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.5 |
Example
<ContentDetails>
<Title> ... </Title>
</ContentDetails>Version History
Unchanged since introduction in RIXML 2.5
ContentDetails was introduced in RIXML 2.5 as part of the globalization improvements that added multilingual support for product names and descriptions [RIXML Release Notes v2.5 p.26]. It pairs with the new ContentDetailsAlternativeLanguages container element added in the same release. The data dictionary for 2.5.1 documents the element with no functional changes from 2.5, formalizing the suggested length limits (3000 characters for Abstract, 300 for Synopsis) and the language-default behaviour [RIXML Research Data Dictionary v2.5.1 p.36].
Business Rules
When language attribute is not specified for ContentDetails, it defaults to the language attribute value of the top Research element
When the Research element language attribute is not specified, ContentDetails language defaults to English
Semantic Relationships
Constrained By2 relationships
ContentDetails language falls back to the Research element's language attribute when not explicitly specified
RIXML Research Data Dictionary v2.5.1, p.36— language (Optional, String)
When neither ContentDetails language nor Research element language is specified, the default becomes English (eng per ISO639-2LanguageType)
RIXML Research Data Dictionary v2.5.1, p.36— language (Optional, String)
Qualifies1 relationship
ContentDetailsType supports language-specific content presentation through its language attribute for multilingual publishing
RIXML Release Notes v2.5, p.25— Toward improved globalization
Broadens1 relationship
ContentDetailsAlternativeLanguages extends multilingual support by containing multiple ContentDetails elements for different language versions
RIXML Release Notes v2.5, p.26— Names in Multiple Languages