important

$Revision: 1666 $

$Date: 2002-06-12 07:19:37 -0400 (Wed, 12 Jun 2002) $

important — An admonition set off from the text

Synopsis

Content Model

important ::=
(title?,
 (%admon.mix;)+)

Attributes

Common attributes

Parameter Entities

The following parameter entities contain important:

Parameter Entities
`%admon.class;`	`%bookcomponent.content;`	`%component.mix;`
`%divcomponent.mix;`	`%highlights.mix;`	`%legalnotice.mix;`
`%listpreamble.mix;`	`%para.mix;`	`%qandaset.mix;`
`%refcomponent.mix;`	`%revdescription.mix;`	`%sidebar.mix;`
`%tabentry.mix;`	`%tbl.entry.mdl;`	`%textobject.mix;`

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: answer, appendix, article, bibliodiv, bibliography, blockquote, callout, caption, chapter, colophon, dedication, entry, glossary, glossdiv, highlights, index, itemizedlist, legalnotice, listitem, msgexplan, msgtext, 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, variablelist.

Children

The following elements occur in important: address, anchor, beginpage, bibliolist, blockquote, bridgehead, calloutlist, classsynopsis, cmdsynopsis, constructorsynopsis, destructorsynopsis, equation, example, fieldsynopsis, figure, formalpara, funcsynopsis, glosslist, graphic, graphicco, indexterm, informalequation, informalexample, informalfigure, informaltable, itemizedlist, literallayout, mediaobject, mediaobjectco, methodsynopsis, orderedlist, para, procedure, programlisting, programlistingco, remark, screen, screenco, screenshot, segmentedlist, sidebar, simpara, simplelist, synopsis, table, title, variablelist.

Examples

<!DOCTYPE important PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
          "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd">
<important>
<para>
No user-servicable parts inside. Breaking this seal voids all warranties.
</para>
</important>

Important

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


imageobjectco		index