Documentation Helpers

Tip

::: tip
This is a tip
:::

TIP

This is a tip

Note

::: note
This is a note
:::

NOTE

This is a note

Warning

::: warning
This is a warning
:::

WARNING

This is a warning

Danger

::: danger
This is a dangerous warning
:::

DANGER

This is a dangerous warning

Details

::: details
This is a details block, which does not work in IE / Edge
:::

This is a details block, which does not work in IE / Edge

Definition

::: definition
This contains a definition of something
:::

DEFINITION

This contains a definition of something

Example

::: example
An example, also available as examples
:::

EXAMPLE

An example, also available as examples

Constraint

::: constraint
This contains a constraint definition
:::

CONSTRAINT

This contains a constraint definition

Wise Owl

::: owl
A wise text, customizable and inspired by wisdom
:::
Owl

A wise text, customizable and inspired by wisdom

Under Construction

::: underconstruction
This page is under construction, this says
:::
WrenchThis part is under construction.

This page is under construction, this says

Badges and Dots

Abandoned, New, Planned

This feature is no longer supported ABANDONED

This feature is no longer new NEW

This feature is no longer planned PLANNED

This information is live data LIVE!

<abandoned/>
<new/>
<planned/>
<live/>

Flags

Only valid in Germany Flag DE DE or in the united Kingdom Flag GB GB or USA Flag US US only

<flag country="DE"/>

Errror, Warnings and Info Dots in Reports

Report gives errors, warnings and infos.

<error/>
<warning/>
<info/>

Flags things as REQUIRED or RECOMMENDED.

<required/>
<recommended/>

Reference Dots

Pictures and graphics may contain numbers like 1 or 2 that can be referenced in the text.

<ref1/>
<ref2/>
Last Update:
Contributors: dr Kai U. Heitmann