Renders a box containing a caution message.
According to Single Sourcing - Building Modular Documentation (Kurt Ament) authors should stick to the industry standard of using note, tip, warning, and caution boxes.
The caution box is used as follows:
Negative alert that a particular action can result in data loss, data corruption, security problems, or performance problems.
Kurt Ament. Single Sourcing - Building Modular Documentation. 2003
Properties
The macro provides the following properties for configuration.
Title
The title is an optional parameter.
Here is an example with title:
This is a caution message.
Show Icon
The checkbox allows to remove the icon from the box.
This is a caution message.
Tags
Tag the box to use for transclusion.
By default the tag caution-box is added.
Transclusion for boxes is supported since version 2.3.
Details
Hint to use this box with K15t Scroll-Office
To export a page using this macro with K15t Scroll Office the Print Quirk Modes should be enabled.
Related macros
Here is a list of alternative boxes to use for your texts:
| Name | Short Description | Tags |
|---|---|---|
Renders a box containing a deprecation warning for the reader. |
||
Renders an example within a box. |
||
Renders a box containing a fault message reported by a team member for the author. |
||
Renders a box containing a feedback message from a reader with write privilege. |
||
Generic boxes help to easily define one's own boxes to apply certain CSS styles to them. |
||
Renders a box containing an info message. |
||
Renders something to note by the reader. |
||
Renders a box containing a pending message to be handled later by the author. |
||
Renders a box containing an open question. |
||
Renders a box with references to further information. |
||
Renders a box with a tip for the reader. |
||
Renders information related to a version. |