Abstract

Overview

Abstract is an optional plain-text element within Content that holds a comprehensive summary of a research product, intended to be longer and more detailed than Synopsis but substantially shorter than the full content. It typically conveys key findings, conclusions, recommendations, or highlights — often a few paragraphs or bullet points repurposed from the report's own executive summary — and serves as the primary discovery surface that lets consumers evaluate research relevance before opening the full document (sources: data-dictionary-2.5.1 p.18, level-one-2.5 p.9, release-notes-2.5 p.24). A parallel AbstractFormatted element exists for cases where embedded markup is required; Abstract itself is plain text only [data-dictionary-2.5.1 p.37].

Usage

Abstract is an optional child of Content with cardinality 0..1 through RIXML 2.x, containing plain-text content with a suggested maximum length of 3000 characters (sources: data-dictionary-2.5.1 p.36, user-guide-2.1 p.22, level-one-2.5 p.9). Typical practice is to copy the report's existing summary, highlights, or key-points section verbatim, keeping the content to a few paragraphs or bullets that capture the primary investment thesis, findings, or conclusions [data-dictionary-2.5.1 p.18]. The element is well suited to search indexing, content previews, alert systems, and any workflow where consumers need to triage research before committing to a full read. Where formatted (HTML) markup is required for display, publishers should supply AbstractFormatted alongside (or instead of) Abstract; the two are content-equivalent variants distinguished only by markup support (sources: data-dictionary-2.5.1 p.37, release-notes-2.4 p.20). From v2.5 onward, multilingual abstracts are carried via ContentDetailsAlternativeLanguages, each language variant tagged accordingly [release-notes-2.5 p.24].

Rules

• SHOULDAbstract content should not exceed a suggested maximum of 3000 characters.[RIXML Research Data Dictionary v2.5.1 p.36] [RIXML Research Suite Data Dictionary v3.0 (DRAFT) p.25]↗ [RIXML User Guide v2.1 p.22] [RIXML User Guide v2.2 p.22]
• SHOULDAbstract should be limited to a few paragraphs or bullet points that highlight the key points covered in the report, typically reusing the report's existing summary or highlights section.[RIXML Research Data Dictionary v2.5.1 p.18] [Best Practices for Publishing RIXML p.22]
• MUSTHTML markup must not be embedded directly in Abstract (or Synopsis); use AbstractFormatted when formatting is required, since HTML in the plain-text element can break XML well-formedness and renders as gibberish on consumers that don't process markup.[Best Practices for Publishing RIXML p.15] [RIXML Research Data Dictionary v2.5.1 p.37]
• MUSTWhen the parallel AbstractFormatted is used, embedded markup must be limited to the approved subset (P, UL, OL, LI, B, U, I) and special characters must be escaped or wrapped in CDATA to preserve XML validity.[RIXML Quarterly Update 2012 Q3 p.3]↗
• MAYFrom RIXML v2.5, Abstract supports multiple language variants supplied through ContentDetailsAlternativeLanguages, enabling multilingual research distribution.[RIXML Release Notes v2.5 p.24] [RIXML Quarterly Update 2017 Q2 p.8]↗
• INFORMATIVEIn the v3.0 draft, Abstract is restructured as a required child of an AbstractList container with multiples allowed, and gains audience-targeting and format-coding attributes so that publishers can supply distinct abstracts per audience segment.[RIXML Research Suite Data Dictionary v3.0 (DRAFT) p.25]↗ [RIXML All-Member Meeting June 2023 p.25]↗ [RIXML All-Member Meeting Spring 2024 p.23]↗
• SHOULDPublishers should provide both the plain-text Abstract and the formatted AbstractFormatted variant so that consumers with differing display capabilities can render the content appropriately.[Company Report (Advanced) Sample v2.4]↗

Relationships

• child-ofContent — Abstract is an optional child of Content, appearing at most once per Content block in RIXML 2.x.
• contrasts-withSynopsis — Abstract provides a detailed multi-paragraph summary (suggested up to 3000 characters), while Synopsis is a very brief statement (suggested up to 300 characters) suited to abbreviated displays. Both convey the same core message at different levels of detail.
• paired-withAbstractFormatted — AbstractFormatted is the markup-enabled counterpart to Abstract. The two carry equivalent content; AbstractFormatted permits the approved HTML subset for display, while Abstract remains plain text only.
• localized-byContentDetailsAlternativeLanguages — From v2.5, alternative-language variants of Abstract are supplied through ContentDetailsAlternativeLanguages rather than by repeating the element directly.
• co-occurs-withTitle — Abstract sits alongside Title, SubTitle, and Synopsis in the Content block; together these form the discoverable metadata surface of a research product.