important

important — An admonition set off from the text

Synopsis

Content Model

important ::=

Sequence of:
- One of:
  - Sequence of:
    Interleave of:
    title?
    titleabbrev?
    info? (db.titleforbidden.info)
  - info (db.titleonly.info)
- One or more of:
  - 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)
  - 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
  - variablelist
  - warning

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

Important 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.

Parents

These elements contain important: annotation, answer, appendix, article, bibliodiv, bibliography, bibliolist, blockquote, callout, calloutlist, caption (db.caption), caution, chapter, colophon, constraintdef, dedication, entry, example, figure, footnote, glossary, glossdef, glossdiv, glosslist, html:fieldset, html:form, important, index, indexdiv, informalexample, informalfigure, itemizedlist, legalnotice, listitem, msgexplan, msgtext, note, orderedlist, para, partintro, preface, procedure, qandadiv, qandaset, question, refsect1, refsect2, refsect3, refsection, refsynopsisdiv, revdescription, sect1, sect2, sect3, sect4, sect5, section, setindex, sidebar, simplesect, step, taskprerequisites, taskrelated, tasksummary, td, textobject, th, tip, toc, tocdiv, variablelist, warning.

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: 1.4 $ published $Date: 2005/10/31 12:31:54 $.


imageobject		index