SPFE Documentation | Collections > EPPO-simple Demos > Admonition Demo

Admonition Demo

This page demonstrates the use of admonitions. The admonitions shown here are from the note-caution-warning set available in the EPPO-simple structures collection. This set contains the admonitions most often used in software documentation The collection also includes the note set, which just contains a note admonition, a danger-warning-caution-notice set, most often used in hardware documentation, and a generic admonition.

The model of these admonitions is very simple. If you require more complex admonitions you can create your own admonition structure to use in your topic types.

<note>
    <title>This is something to take note of</title>
    <p>Take note of this.</p>
</note>

The signal word “Note” (or whatever other word is specified by the script) will be added at the presentation stage. Similarly, any graphic associated with this class of admonition will be added (if specified) at the presentation stage.

The caution admonition is the same, except that the root element is caution.

<caution>
    <title>Be cautious about this</title>
    <p>This is something to be cautious about.</p>
</caution>

The caution admonition is the same, except that the root element is warning.

<warning>
    <title>Watch out!</title>
    <p>This could hurt real bad.</p>
</warning>

All these forms are considered variants of the generic admonition structure. Therefore the default synthesis scripts convert them to a generic admonition of the appropriate type.