important

important — An admonition set off from the text

Synopsis

important ::=

Sequence of:
- One of:
  - Sequence of:
    
    Interleave of:
    
    title?
    
    titleabbrev?
    
    info? (db.titleforbidden.info)
  - info (db.titleonly.info)
- One or more of:
  - annotation
  - bridgehead
  - remark
  - revhistory
  - Indexing inlines
    
    indexterm (db.indexterm.endofrange)
    
    indexterm (db.indexterm.singular)
    
    indexterm (db.indexterm.startofrange)
  - Admonition elements
    
    caution
    
    important
    
    note
    
    tip
    
    warning
  - Formal elements
    
    equation
    
    example
    
    figure
    
    table (db.cals.table)
    
    table (db.html.table)
  - Graphic elements
    
    mediaobject
    
    screenshot
  - HTML Form elements
    
    html:form
  - 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
    
    fieldsynopsis
    
    funcsynopsis
    
    methodsynopsis
  - Technical elements
    
    constraintdef
    
    msgset
    
    procedure
    
    productionset
    
    task
  - Verbatim elements
    
    literallayout
    
    programlisting
    
    programlistingco
    
    screen
    
    screenco
    
    synopsis

Attributes

Common attributes and common linking attributes.

Additional Constraints

caution must not occur in the descendants of important
important must not occur in the descendants of important
note must not occur in the descendants of important
tip must not occur in the descendants of important
warning must not occur in the descendants of important

Description

An important element is an admonition set off from the main text.

In some types of documentation, the semantics of admonitions are clearly defined (caution might imply the possibility of harm to equipment whereas warning might imply harm to a person), but DocBook makes no such assertions.

Processing expectations

Formatted as a displayed block. It often outputs the generated text “Important” or some other visible indication of the type of admonition, especially if a title is not present. Sometimes outputs a graphical icon or other symbol as well.

Children

The following elements occur in important: address, anchor, annotation, bibliolist, blockquote, bridgehead, calloutlist, caution, classsynopsis, cmdsynopsis, constraintdef, constructorsynopsis, destructorsynopsis, epigraph, equation, example, fieldsynopsis, figure, formalpara, funcsynopsis, glosslist, html:form, 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, mediaobject, methodsynopsis, msgset, note, orderedlist, 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, variablelist, warning.

Examples

<article xmlns='http://docbook.org/ns/docbook'>
<title>Example important</title>

<important>
<para>No user-servicable parts inside. Breaking this seal voids all warranties.
</para>
</important>

</article>

Important

No user-servicable parts inside. Breaking this seal voids all warranties.

ChangeLog

This alpha reference page is $Revision: 7120 $ published Sun, 22 Jul 2007.