projectdoc Toolbox

Renders a box containing a caution message.

Audience
Categories
Tags

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:

The title of the Caution Box

 

This is a caution message.

Show Icon

The checkbox allows to remove the icon from the box.

The title of the Caution Box

This is a caution message.

Tags

Tag the box to use for transclusion.

By default the tag caution-box is added.

Since 2.3

 

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:

NameShort DescriptionTags
Deprecated Box Macro
Renders a box containing a deprecation warning for the reader.
Example Box Macro
Renders an example within a box.
Fault Box Macro
Renders a box containing a fault message reported by a team member for the author.
Feedback Box Macro
Renders a box containing a feedback message from a reader with write privilege.
Generic Box Macro
Generic boxes help to easily define one's own boxes to apply certain CSS styles to them.
Box
Info Box Macro
Renders a box containing an info message.
Note Box Macro
Renders something to note by the reader.
Pending Box Macro
Renders a box containing a pending message to be handled later by the author.
Question Box Macro
Renders a box containing an open question.
References Box Macro
Renders a box with references to further information.
Tip Box Macro
Renders a box with a tip for the reader.
Version Box MacroBox