abstract

abstract — A summary.

Synopsis

abstract ::=

Sequence of:
- One of:
  - Sequence of:
    - Interleave of:
      - title?
      - titleabbrev?
    - info? (db.titleforbidden.info)
  - info (db.titleonly.info)
- One or more of:
  - annotation
  - bridgehead
  - formalgroup
  - remark
  - revhistory
  - Indexing inlines
    indexterm (db.indexterm.endofrange)
    indexterm (db.indexterm.singular)
    indexterm (db.indexterm.startofrange)
  - Admonition elements
    caution
    danger
    important
    note
    tip
    warning
  - Formal elements
    equation
    example
    figure
    table (db.cals.table)
    table (db.html.table)
  - Graphic elements
    mediaobject
    screenshot
  - Informal elements
    informalequation
    informalexample
    informalfigure
    informaltable (db.cals.informaltable)
    informaltable (db.html.informaltable)
  - List elements
    bibliolist
    calloutlist
    glosslist
    itemizedlist
    orderedlist
    procedure
    qandaset
    segmentedlist
    simplelist
    variablelist
  - Paragraph elements
    anchor
    formalpara
    para
    simpara
  - Publishing elements
    address
    blockquote
    epigraph
    sidebar
  - Synopsis elements
    classsynopsis
    cmdsynopsis
    constructorsynopsis
    destructorsynopsis
    enumsynopsis
    fieldsynopsis
    funcsynopsis
    macrosynopsis
    methodsynopsis
    packagesynopsis
    typedefsynopsis
    unionsynopsis
  - Technical elements
    constraintdef
    msgset
    procedure
    productionset
    task
  - Verbatim elements
    literallayout
    programlisting
    programlistingco
    screen
    screenco
    synopsis

Attributes

Common attributes and common linking attributes.

No additional attributes.

Additional Constraints

If this element is the root element, it must have a version attribute.

Description

An abstract can occur in most components of DocBook. It is expected to contain some sort of summary of the content with which it is associated (by containment).

Processing expectations

Formatted as a displayed block. Sometimes suppressed. Often presented in alternate outputs.

Attributes

Common attributes and common linking attributes.

any attribute: Any attribute in any other explicit namespace

Parents

These elements contain abstract: biblioentry, bibliomixed, bibliomset, biblioset, info (db.info), info (db.titleforbidden.info), info (db.titleonly.info), info (db.titleonlyreq.info), info (db.titlereq.info), merge.

Children

The following elements occur in abstract: address, anchor, annotation, bibliolist, blockquote, bridgehead, calloutlist, caution, classsynopsis, cmdsynopsis, constraintdef, constructorsynopsis, danger, destructorsynopsis, enumsynopsis, epigraph, equation, example, fieldsynopsis, figure, formalgroup, formalpara, funcsynopsis, glosslist, important, indexterm (db.indexterm.endofrange), indexterm (db.indexterm.singular), indexterm (db.indexterm.startofrange), info (db.titleforbidden.info), info (db.titleonly.info), informalequation, informalexample, informalfigure, informaltable (db.cals.informaltable), informaltable (db.html.informaltable), itemizedlist, literallayout, macrosynopsis, mediaobject, methodsynopsis, msgset, note, orderedlist, packagesynopsis, para, procedure, productionset, programlisting, programlistingco, qandaset, remark, revhistory, screen, screenco, screenshot, segmentedlist, sidebar, simpara, simplelist, synopsis, table (db.cals.table), table (db.html.table), task, tip, title, titleabbrev, typedefsynopsis, unionsynopsis, variablelist, warning.

Examples

 1 |<article xmlns='http://docbook.org/ns/docbook'>
   |<info>
   |  <title>Example abstract</title>
   |  <abstract>
 5 |    <para>In brief, …
   |    </para>
   |  </abstract>
   |</info>
   | 
10 |<para>…</para>
   | 
   |</article>