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 open question.
Audience
Categories
Tags
Iteration
Production

Description

A question about the a topic to give readers the opportunity to deepen their understanding.

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

 

A question for the reader.

Show Icon

The checkbox allows to remove the icon from the box.

The title of the Question Box

A question for the reader.

Details

Open Questions

Projects often have to deal with open questions. Usually this is highlighted by the use of the Pending Box. This indicates that there is an open issue to be dealt with or information missing.

But teams are free to define the semantics for their boxes by themselves.

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