Every construct
This page uses every construct in the dialect once. It is here to be looked at and copied from — and it is also what the conformance check builds: it must render here, build in MkDocs Material, and build in Docusaurus. If any of the three stops working, this page is where it shows.
Admonitions
Both spellings, all seven types.
A note
Ordinary information the reader should not miss.
A tip
Something that makes the task easier.
Information
Background that explains rather than instructs.
A warning
Something that will go wrong if ignored.
A danger
Something that will hurt someone or destroy data.
An example
A worked case.
A quote
Somebody else's words.
Columns
Left
Ordinary Markdown, with emphasis, code and lists:
- one
- two
Right
Columns collapse to a single column below 860 pixels, because a manual is read at the machine at least as often as at a desk.
Cards
Video with an outline
Write at: unquoted. Clicking an entry seeks the player; the same list is
readable text everywhere else, and it is stored as data so a listing can
answer "every page with a video".
A small table
| Parameter | Default | Range | Unit |
|---|---|---|---|
| P100 | 5.0 | 0.1–3600 | s |
| P101 | 50.0 | 0–599 | Hz |
| P102 | 0 | 0–3 | — |
A table from a data file
| Parameter | Name | Default | Minimum | Maximum | Unit |
|---|---|---|---|---|---|
| P100 | Acceleration ramp | 5.0 | 0.1 | 3600 | s |
| P101 | Deceleration ramp | 5.0 | 0.1 | 3600 | s |
| P102 | Maximum frequency | 50.0 | 0 | 599 | Hz |
| P103 | Minimum frequency | 0.0 | 0 | 599 | Hz |
| P104 | Motor rated current | 2.3 | 0.1 | 999 | A |
| P105 | Motor rated voltage | 400 | 0 | 690 | V |
| P106 | Motor rated speed | 1450 | 0 | 60000 | rpm |
| P107 | Control mode | 0 | 0 | 3 | |
| P108 | Restart after fault | 0 | 0 | 1 | |
| P109 | Braking resistor | 0 | 0 | 1 |
Large data belongs in a file beside the page, where a change to it is reviewable in a pull request like anything else.
A live listing
Read from the platform at the moment the page is shown, filtered by this
page's own tag. If the listing does not exist or declines to be embedded,
the page renders without it and the sync report says so — which is what you
should expect to see here, because this documentation set has no listing
called error_codes.
Links and images
Relative, exactly as the other engines expect:
See the dialect and the glossary.
An unknown block
```telemetry
device: i550
```
A block the dialect does not know is kept as written and reported in the sync report. It renders as a visible code block — a mistake somebody fixes in a minute, rather than a paragraph that is silently not there.