Overview
This example plugin has no functionality. It shows which formatting options are available in plugin documentation and serves authors as a template.
The sources live in the portal repo under examples/darstellungs-beispiel/docs/.
What you will find here
| Page | Content |
|---|---|
| Text formatting | Headings, emphasis, quotes, footnotes, keyboard shortcuts |
| Lists | Bullet lists, numbered lists, nesting, checklists |
| Admonitions | Note, tip, info, warning, danger |
| Tables | Alignment, wide tables, formatting in cells |
| Images | Screenshots, wide graphics, captions |
| Long guide | Long page with anchors, table of contents and collapsible sections |
For developers, the developer guide shows code blocks, diagrams and a long API reference.
Ground rules for good user docs
- Structure by task, not by menu item: “Limit a notice in time” rather than “Field Valid until”.
- Admin paths in bold, separated by
›: Settings › System › Caches & indexes. - No code in the user guide – technical details belong in the developer guide.
- One screenshot per step if the place is hard to find.