<abstract>

An abstract summarizes the content of the topic; it appears at the start of the topic. It can contain multiple short descriptions, as well as block-level content such as paragraphs, lists, and tables.

Usage information

The <abstract> element is designed for use in the following circumstances:

  • The initial paragraph of a topic contains lists, tables, or other block-level elements that are not permitted in the content model of <shortdesc>.
  • Only a portion of the content of the initial paragraph is suitable for a link preview or hover text.
  • A topic needs to contain multiple short descriptions, to facilitate conditional processing.

When the initial paragraph is suitable as a link preview, authors should simply place the content in a <shortdesc> element rather than in an <abstract> element.

Rendering expectations

When a contained <shortdesc> occurs within phrase-level content, processors treat it as phrase-level content and do not create a separate paragraph when the topic is rendered. When the contained <shortdesc> occurs as a peer to paragraph-level content, processors treat it as block-level content and create a separate paragraph when the topic is rendered. When multiple <shortdesc> elements are included in an <abstract>, they are concatenated when used for link previews or link summaries (separated by spaces).

Content model

(Text | <audio> | <dl> | <div> | <example> | <fig> | <image> | <lines> | <lq> | <note> | <object> | <ol> | <p> | <pre> | <simpletable> | <sl> | <table> | <ul> | <video> | <cite> | <include> | <keyword> | <ph> | <q> | <term> | <text> | <tm> | <xref> | <data> | <foreign> | <shortdesc> | <draft-comment> | <fn> | <indexterm> | <required-cleanup>)*

Contained by

<topic>

Zero or more of the following

Contained by

Inheritance

- topic/abstract

The <abstract> element is a base element type. It is defined in the topic module.

Attributes

The following attributes are available on this element: universal attributes.

The following attributes are available on this element: universal attributes.

Examples

This section is non-normative.

This section contains examples of how the <abstract> element can be used.

Example 1. <abstract> with phrase-level short description

The following code sample shows an <abstract> element that contains a short description, as well as additional phrase-level content:

<abstract>
  <shortdesc>
      Use the wonderful Widget to automatically vacuum your house.
  </shortdesc> It requires a 1800 lithium ion battery.
</abstract>

While the complete content of the <abstract> element is rendered as the first paragraph of the topic, only the content of the <shortdesc> element is used for a link preview and hover text.

Example 2. <abstract> with block-level short description

The following code sample shows an <abstract> element that contains a short description, as well as additional block-level content: 

<abstract>
  <shortdesc>
      You have many options for arranging lodging in Brussels: hotels, bed and
      breakfasts, youth hostels, and flats. You can select from a wide price range.
  </shortdesc>
  <p>The following table explains the symbols that are used to indicate the price
     categories of the lodging options:</p>
  <simpletable>
    <! -- ... -->
  </simpletable>
</abstract>
Example 3. <abstract> with multiple short descriptions

The following code sample shows an <abstract> element that contains multiple short descriptions, which will be filtered when the topic is processed:

<abstract>
  <shortdesc platform="free-version">
      The free version of the platform provides a single e-mail list, storage 
      for up to one gigabyte of files, and will support up to 100 users.
  </shortdesc>
  <shortdesc platform="premium-version">
      The premium version of the platform provides multiple e-mails lists, 
      storage for up to 30 gigabytes of files, and will support up to 400 users.
  </shortdesc>
</abstract>