Template:Dokumentation/Dok

Beschreibung
Diese Vorlage wird verwendet, um Beschreibungen auf anderen Vorlagenseiten einzufügen.

Syntax
Füge  am Ende einer Vorlagenseite ein.

Auf der Vorlagenseite
So wird die Dokumentationsvorlage verwendet:

VORLAGENCODE Kategorien, die nur über die Vorlage hinzugefügt werden sollen

Wenn deine Vorlage aus einem unvollständigen div-Element oder einer unvollständigen Tabelle besteht, empfiehlt es sich, die Tags vor  zu schließen (innerhalb der noinclude-Tags).

Ein Zeilenumbruch vor  kann ebenfalls nützlich sein, um zu verhindern, dass sich die nachfolgende Dokumentationsvorlage im vorherigen Code „verheddert“.

Beispiel
In der Regel steht so etwas wie der folgende Text auf der Seite, die die Dokumentation für eine Vorlage enthält:

Beschreibung
Diese Vorlage wird verwendet, um dieses oder jenes zu tun.

Syntax
Füge  ein.

Beispiel
Wird zu

Kategorien, die nur über die Vorlage hinzugefügt werden sollen

Die Abschnitte Beschreibung/Syntax/Beispiel kannst du beliebig verändern und um weitere Abschnitte wie „Siehe auch“ oder anderes erweitern.