important

important — An admonition set off from the text.

Synopsis

important ::= [-]

Additional Constraints

  • caution must not occur among the children or descendants of important
  • important must not occur among the children or descendants of important
  • note must not occur among the children or descendants of important
  • tip must not occur among the children or descendants of important
  • warning must not occur among the children or descendants of important
  • If this element is the root element, it must have a version attribute.

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.

See Also

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.

Last revised by Norman Walsh on 28 Apr 2016 (git hash: 8efbb30ec1f2a59299576c057927c2032216aea4)