The abstract element occurs between the topic title and the topic body, as the initial content of a topic. It can contain paragraph-level content as well as one or more shortdesc elements which can be used for providing link previews or summaries. The <abstract> element cannot be overridden by maps, but its contained <shortdesc> elements can be, for the purpose of creating link summaries or previews.
Use the <abstract> element when the initial paragraph of a topic is unsuitable for use as a link preview or for summaries, because, for example, it contains lists or tables, or because only a portion of the paragraph is suitable. Note that when the initial paragraph is suitable as a summary, that content should be placed in a <shortdesc> element rather than in an <abstract> element. The <abstract> element allows for a wider range of content in your initial paragraph, such as lists and tables, and allows you to identify portions of the <abstract> content as useful for previews or summaries by embedding the <shortdesc> element within <abstract>.
When the contained <shortdesc> occurs within phrase-level content, it is treated as phrase-level content and should not create a separate paragraph on output of the topic. When the contained <shortdesc> occurs as a peer to paragraph-level content, it is treated as block-level content and should create a separate paragraph on output of the topic. When multiple <shortdesc> elements are included in an <abstract>, they are concatenated in output of link previews or summaries (separated by spaces).
Doctype | Content model |
---|---|
topic (base), topic (technical content) | topic |
concept, glossary, glossentry, glossgroup | topic, concept |
ditabase | topic, concept, task, reference |
reference | topic, reference |
task (strict), task (general), machineryTask | topic, task |
learningAssessment | topic, learningBase, learningAssessment |
learningContent | topic, learningBase, task, concept, reference, learningSummary, learningAssessment, learningContent |
learningOverview | topic, learningBase, learningOverview |
learningPlan | topic, learningBase, learningPlan |
learningSummary | topic, learningBase, learningSummary |
<abstract>The abstract is being used to provide more complex content. <shortdesc>The shortdesc must be directly contained by the abstract.</shortdesc> The abstract can put text around the shortdesc. </abstract>
<abstract><p>The abstract is being used to provide more complex content.</p> <shortdesc>The shortdesc must be directly contained by the abstract.</shortdesc> <p>The abstract can put text around the shortdesc.</p> </abstract>
The abstract is being used to provide more complex content.
The shortdesc must be directly contained by the abstract.
The abstract can put text around the shortdesc.
<abstract>The abstract is being used to provide more complex content. <shortdesc>The shortdesc must be directly contained by the abstract.</shortdesc> <p>The abstract can put text around the shortdesc.</p> <shortdesc>There can be more than one shortdesc.</shortdesc> </abstract>
The abstract is being used to provide more complex content. The shortdesc must be directly contained by the abstract.
The abstract can put text around the shortdesc.
There can be more than one shortdesc.
Name | Description | Data Type | Default Value | Required? |
---|---|---|---|---|
univ-atts attribute group (includes select-atts, id-atts, and localization-atts groups) | A set of related attributes, described in univ-atts attribute group | |||
global-atts attribute group (xtrf, xtrc) | A set of related attributes, described in global-atts attribute group | |||
class, outputclass | Common attributes described in Other common DITA attributes |
Return to main page.
OASIS DITA Version 1.2 -- OASIS Standard, 1 December 2010
Copyright © OASIS Open 2005, 2010. All Rights Reserved.