projectdoc Toolbox

Renders a box with a tip for the reader.

Audience

Categories

Tags

Box
Standard

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 tip box is used as follows:

Positive suggestion that helps users apply information described in a module to meet their specific needs.
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 Tip Box

This is a tip for the user.

Show Icon

The checkbox allows to remove the icon from the box.

The title of the Tip Box

This is a tip for the user.

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.	Box Standard
Deprecated Box Macro	Renders a box containing a deprecation warning for the reader.	Box Extra
Example Box Macro	Renders an example within a box.	Box Extra
Info Box Macro	Renders a box containing an info message.	Box Extra
Note Box Macro	Renders something to note by the reader.	Box Standard
Question Box Macro	Renders a box containing an open question.	Box Extra
References Box Macro	Renders a box with references to further information.	Box Extra
Version Box Macro	Renders information related to a version.	Box

Space shortcuts

Page tree

Docs

Support

Free Blueprints

Tooling for Blueprints

Free Extensions

Spaces

Plugins for Maven

Incubator

Libraries for Java

Incubator

Add-ons for Confluence

Tools

Support

Team

Legal

Properties

Title

Show Icon

Tags

Details

Hint to use this box with K15t Scroll-Office

Related macros

About

Keep up-to-date!

Powered by