Documentation Helpers

Tip

::: tip
This is a tip
:::

TIP

This is a tip

Note

::: tip 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
:::

Details

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

Definition

::: tip DEFINITION
This contains a definition of something
:::

DEFINITION

This contains a definition of something

Example

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

EXAMPLE

An example, also available as examples

Constraint

::: tip CONSTRAINT
This contains a constraint definition
:::

CONSTRAINT

This contains a constraint definition

Wise Owl

::: tip WISDOM
A wise text, customizable and inspired by wisdom
:::

WISDOM

A wise text, customizable and inspired by wisdom

Under Construction

::: tip UNDER CONSTRUCTION
This page is under construction, this says
:::

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 DE or in the united Kingdom GB or USA US only

<flag country="DE"/>

Errror, Warnings and Info Dots in Reports

Report gives errors, warnings and infos.

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

Required and Recommended

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/>