Example Box Macro

Renders an example within a box.

Audience
Categories
Box / Reader
Tags

Description

The box highlights an example given for clarification.

The example may or may not contain source code.

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 example-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
Renders a box containing a caution message.
Renders a box containing a deprecation warning for the reader.
Renders a box containing a fault message reported by a team member for the author.
Renders a box containing a feedback message from a reader with write privilege.
Generic boxes help to easily define one's own boxes to apply certain CSS styles to them.
Renders a box containing an info message.
Renders something to note by the reader.
Renders a box containing a pending message to be handled later by the author.
Renders a box containing an open question.
Renders a box with references to further information.
Renders a box with a tip for the reader.