AbstractThe 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, for example because 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).
[edit] Example: abstract with phrase-level short description
<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>
- Topic output
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.
- Preview/summary output The shortdesc must be directly contained by the abstract.
[edit] Example: abstract with block-level short description
<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>
- Topic output
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.
- Preview/summary output The shortdesc must be directly contained by the abstract.
[edit] Example: abstract with multiple short descriptions
<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>
- Topic output
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.
- Preview/summary output The shortdesc must be directly contained by the abstract. There can be
more than one shortdesc.
[edit] Contains
[edit] Contained by
[edit] Inheritance:
- topic/abstract
[edit] Attributes
| Name
| Description
| Data Type
| Default Value
| Required?
|
| %univ-atts; (%select-atts;, %id-atts;, %localization-atts;)
| A set of related attributes, described at %univ-atts;
| parameter entity
| PE not
applicable
| Not applicable
|
| %global-atts; (xtrf, xtrc)
| A set of related attributes, described at %global-atts;
| parameter entity
| PE not
applicable
| Not applicable
|
| class, outputclass
| Common attributes described in Other common DITA attributes
|
|
|
|
TOC: Language Specification 1.1
Parent topic: Topic elements
Previous topic: searchtitle
Next topic: shortdesc
|
|
