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 a box containing an info message.
Audience
Categories
Tags
Iteration
Production

Description

Provides a short information for the reader.

Consider if using the Tip Box or the Note Box is more appropriate, since those boxes are industry standards.

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 Info Box

 

This is an informative note for the reader.

Show Icon

The checkbox allows to remove the icon from the box.

The title of Info Box

This is an informative 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