Vorlage:Doc

Datei:Template-info.png Dokumentation

[säubern]

Zur Verwendung, muss eine Unterseite der Vorlage doc erstellt werden - stellt {{doc/start}} an den Beginn der Dokumentation und {{doc/end}} an das Ende.

Geht zurück zur Hauptvorlagen Seite und fügt <noinclude>{{doc}}</noinclude> in eine neue Zeile nach dem Ende der Vorlage. /doc Seiten werden automatisch zu Kategorie:Vorlagendokumentation hinzugefügt.

Optionale Parameter

clear

Falls die Hauptvorlagenseite schwebende Inhalte besitzt und eine Überlappung über die Dokumentation unerwünscht ist, stellt {{doc/start|clear}} anstatt {{doc/start}} auf die Dokumentationsseite.
Dies ist auch sinnvoll für Vorlagen, die <includeonly> nicht verwenden, da es etwas Raum zwischen Vorlage und der Dokumentationsbox schafft.

nodoc=1

Falls eine Vorlage keine Dokumentation besitzt und nicht bekannt ist, wie sie verwendet wird, sollte {{doc/start|nodoc=1}} (oder falls die Vorlage auch ein clear benötigt, {{doc/start|clear|nodoc=1}}) anstatt von {{doc/start}} auf die Dokumentationsseite gestellt werden.
Der Hintergrund der Dokumentation wird rot und dadurch etwas auffälliger werden. Die Seite wird Kategorie:Vorlagen ohne Dokumentation hinzugefügt.

baddoc=1

Ähnlich wie nodoc, wird dies dazu verwendet um Vorlagen zu markieren, welche eine eher schlechte Dokumentation besitzen. Dies kann bedeuten, dass nicht genügend Beispiele aufgeführt oder alle Funktionen ordentlich erklärt werden.

Der Hintergrund der Dokumentation wird gelb und dadurch etwas auffälliger. Die Seite wird Kategorie:Vorlagen mit schlechter Dokumentation hinzugefügt.

Falls nodoc und baddoc verwendet werden, wird baddoc ignoriert.