Admonitions
Admonitions set information apart from the running text. There are five kinds. On GitHub they appear as normal text with ::: lines – the content stays readable.
The five kinds
note
Note – neutral additional information.
tip
Tip – a shortcut or recommendation that saves time.
info
Info – background knowledge that is not strictly necessary.
warning
Warning – careful, otherwise something unexpected happens (e.g. data is overwritten).
danger
Danger – can destroy data or take the shop down.
Custom title
Get there faster
Press Ctrl + K in the Administration to open the search.
Read before updating
Version 1.0 stores notices differently from 1.1. Create a backup before updating.
Content in admonitions
Admonitions may contain any other element:
Prerequisites
Before you start, you need:
- Administrator rights
- An active licence
| Shopware | Plugin |
|---|---|
| 6.6 | 1.0 |
| 6.7 | 1.1 |
Which box when?
| Kind | Use | Frequency |
|---|---|---|
note | Additions | occasionally |
tip | Shortcuts | occasionally |
info | Background | rarely |
warning | Risk with consequences | only when needed |
danger | Data loss, outage | very rarely |
note
Too many boxes lose their effect. Rule of thumb: at most two per screen.