You are viewing an old version of this page. View the current version.

Compare with Current View Page History

Version 1 Next »

projectdoc Toolbox

Short Description
Renders something to note by the reader.
Audience
Categories
Tags
Iteration
Production

Description

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:

The title of the Note Box

 

This a note for the reader.

Show Icon

The checkbox allows to remove the icon from the box.

The title of the Note Box

This a note for the reader.

Related macros

Here is a list of alternative boxes to use for your texts:

NameShort DescriptionTags
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.
Note Box Macro
Renders something to note by the reader.
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

 

 

  • No labels