Vorlagendokumentation
|
|---|
| Hinweis: Die obige Vorlage wird ggf. komplett, gar nicht oder nur teilweise angezeigt. |
| Rufe Vorlage:Dokumentation/Dok auf, um diese Dokumentation zu bearbeiten. (Wie funktioniert das?) |
| Bearbeiter können auf den Sandbox- und Testseiten dieser Vorlage experimentieren. |
Beschreibung
Diese Vorlage wird verwendet, um Beschreibungen auf anderen Vorlagenseiten einzufügen.
Syntax
Füge <noinclude>{{Dokumentation}}</noinclude> am Ende einer Vorlagenseite ein.
Verwendung
Auf der Vorlagenseite
So wird die Dokumentationsvorlage verwendet:
VORLAGENCODE
<includeonly>Kategorien, die nur über die Vorlage hinzugefügt werden sollen</includeonly>
<noinclude>{{Dokumentation}}</noinclude>
Wenn deine Vorlage aus einem unvollständigen div-Element oder einer unvollständigen Tabelle besteht, empfiehlt es sich, die Tags vor {{Dokumentation}} zu schließen (innerhalb der noinclude-Tags).
Ein Zeilenumbruch vor {{Dokumentation}} kann ebenfalls nützlich sein, um zu verhindern, dass sich die nachfolgende Dokumentationsvorlage im vorherigen Code „verheddert“.
Auf der Dokumentationsseite
Die Dokumentationsseite befindet sich normalerweise auf der /Dok-Unterseite für eine Vorlage, aber eine andere Seite kann mit dem ersten Parameter der Vorlage angegeben werden (siehe Syntax).
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 <code>{{t|Vorlagenname}}</code> ein.
== Beispiel ==
<code><nowiki>{{Vorlagenname|Input}}</nowiki></code>
Wird zu...
{{Vorlagenname|Input}}
<includeonly>Kategorien, die nur über die Vorlage hinzugefügt werden sollen</includeonly>
<noinclude>[[Kategorie:Vorlagendokumentation]]</noinclude>
Die Abschnitte Beschreibung/Syntax/Beispiel kannst du beliebig verändern und um weitere Abschnitte wie „Siehe auch“ oder anderes erweitern.
Beachte, dass im obigen Beispiel auch die Vorlage Vorlage:T verwendet wird.