Nukular Wiki
Registrieren
Advertisement

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“.

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 <code>{{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|{{PAGENAME}}]]</noinclude>

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

Advertisement