important

important — An admonition set off from the text

Synopsis

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.

See Also

caution, note, tip, 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 $.