Admonitions (notes, warnings, tips, etc.)

Admonitions (sometimes called "safety messages" or "hazard statements" is an umbrella term used for the note, important, notice, caution, warning, danger and tip elements.

Paligo includes a variety of admonition elements that you can use:

Note

This is a note element

The note is normally used for general information that you want to stand out.

Caution

This is a caution element

The caution element can be used however you need, but has a certain significance in some industry standards.

Warning

This is a warning element

The warning element can be used however you need, but has a certain significance in some industry standards.

Danger

This is a danger element

Danger is a custom Paligo element. It is actually a warning element with its Role attribute set to Danger. It can be used for any purpose, but is designed for content that describes situations that could result in physical injury or death.

Tip

This is a tip

Tips are designed for giving readers helpful advice and suggestions.

Important

This is an important element

The important element is for adding extra emphasis to general information.

Notice

This is a notice element

"Notice" is a variant of note used in certain industry standards (especially manufacturing). If used, it is generally regarded as being of more importance than a regular note.

To learn how to use the admonition elements, see Notes, warnings, and tips.

Parent

Can be used in most block elements.

Children

An optional title, and most common block elements.

DocBook definitions of admonitions

The notice and danger elements are custom Paligo elements. The other admonition elements are from DocBook XML. Use the following links to view the DocBook descriptions of the elements:

tip

note

important

caution

warning

In this section: