Note Box Macro

Renders something to note by the reader.

Audience
Author
Categories
Box / Reader
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 note box is used as follows:

Neutral or positive clarification that applies only in special cases, or that qualifies important points.

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:

Show Icon

The checkbox allows to remove the icon from the box.

Tags

Tag the box to use for transclusion.

By default the tag note-box is added.

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
Caution Box Macro
Renders a box containing a caution message.
Deprecated Box Macro
Renders a box containing a deprecation warning for the reader.
Example Box Macro
Renders an example within a box.
Info Box Macro
Renders a box containing an info message.
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 Macro
Renders information related to a version.
Box