6.5. Admonitions
An admonition, that is, a warning, a tip, a notice, etc, is a blockquote
element which has a
class
attribute containing
"role-ADMONITION
", where
role-ADMONITION
is one of the following class
names:
Class name | Description |
---|---|
role-note |
This is just a note. |
role-attention |
Please pay extra attention to this note. |
role-caution |
Care is required when proceeding. |
role-danger |
Important! Be aware of this before doing anything else. |
role-fastpath |
This note will speed you on your way. |
role-important |
This note is important. |
role-notice |
Indicates a potential situation which, if not avoided, might result in an undesirable result or state. |
role-remember |
Don't forget to do what this note says. |
role-restriction |
You can't do what this note says. |
role-tip |
This is a fine little tip. |
role-trouble |
Provides information about how to remedy a trouble situation. |
role-warning |
Indicates a potentially hazardous situation. |
Example:
1 2 3 4 5 6 7 | <blockquote class="role-important"> <h4>How to check your oil</h4> <p>You need to check your car’s oil before any long trip to avoid major damage.</p> <p>The process for how to check your oil is simple and involves using the dip stick to see levels and test quality.</p> </blockquote> |
is rendered as:
How to check your oil
You need to check your car’s oil before any long trip to avoid major damage.
The process for how to check your oil is simple and involves using the dip stick to see levels and test quality.