RIXML Documentation

Synopsis

RIXML 2.5 Element

Level OneRequired

Optional string element providing brief summary of the research product. Designed to be shorter than Abstract but longer than Title, offering concise overview suitable for quick content assessment.

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.

Usage

Optional child of Content element that can appear at most once. Contains concise string summary that should be shorter than abstract but more detailed than title information.

Business Context

Facilitates rapid content screening and decision-making in research consumption workflows by providing succinct previews that enable efficient filtering and prioritization of research materials.

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

Where It Fits

Canonical Path

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

<Synopsis />

Version History

Unchanged since introduction in RIXML 2.2

Business Rules

SHOULD

Synopsis content must be limited to a few lines and be appropriate for highly abbreviated displays

content-guideline
SHOULD

Synopsis element should have a maximum length of 300 characters

best-practicelength-constraint

Design Decisions

The Synopsis element should contain a very brief overview limited to a few lines suitable for highly abbreviated displays

This length constraint ensures the Synopsis is appropriate for use in contexts like mouse-over displays where space is extremely limited

RIXML Research Data Dictionary v2.5.1, p.18

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

Narrows1 relationship

AbstractINFORMATIVE

Synopsis provides a very brief overview suitable for abbreviated displays, while Abstract offers a more detailed summary with key points and highlights

RIXML Research Data Dictionary v2.5.1, p.18Synopsis

Contrasts With2 relationships

SynopsisFormattedINFORMATIVE

SynopsisFormatted enables limited HTML markup for brief product statements while Synopsis permits no markup

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

SynopsisFormattedINFORMATIVE

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