Vorlage:Doc/end
| Hinweis: Zum Gebrauch von Vorlagen siehe die Vorlagen-Hilfe
|
Diese Vorlage dient der einheitlichen Darstellung von Dokumentationen für alle Vorlagen.
Anwendung
Am Ende einer Vorlage wird mit den noinclude-Tags ein Bereich definiert, der beim Einbinden der Vorlage nicht beachtet wird. In diesem Bereich wird die Dokumentation mit {{/doc}} in die Vorlagenseite eingebunden, gefolgt von der zugehörigen Navigationsbox und ggf. den Interwiki-Links.
Beispiel:
<noinclude>
{{/doc}}
{{Navbox-Verlinkung}}
[[en:Template:Issue list]]
</noinclude>
Eine Dokumentation muss immer geschrieben werden. Sie wird neu erzeugt, indem man auf den roten Link klickt, der nach dem Einbinden von {{/doc}} und dem Speichern der Vorlage angezeigt wird. Er verweist auf die Unterseite /doc der jeweiligen Vorlage.
Die Dokumentation beginnt stets mit {{doc/start}} und endet mit {{doc/end}}. Dazwischen steht der gesamte Dokumentationstext. Der Aufbau der Dokumentation ist in der Vorlagenhilfe beschrieben.
{{doc/start}} markiert die Dokumentation durch automatische Zuordnung zur Kategorie:Vorlagendokumentation.
Parameter
{{doc/start|clear}}
{{doc/start|nodoc=1}}
{{doc/start|baddoc=1}}
| Parameter | Bedeutung |
|---|---|
| clear | Manche Vorlagen zeigen sich selbst auf ihrer Vorlagenseite, gefolgt von der Dokumentation. Dabei kann es vorkommen, dass die Vorlage die Dokumentation überlappt. In diesem Fall ist der optionale Parameter "clear" zu verwenden. |
| nodoc=1 | Eine Vorlage muss immer eine Dokumentation haben. Fehlt diese, wird das mit "nodoc=1" markiert. Die Dokumentation besteht dann nur aus {{doc/start|nodoc=1}} und {{doc/end}} und ist ansonsten leer. Der Parameter markiert die Dokumentation durch automatische Zuordnung zur Kategorie:Vorlagen ohne Dokumentation.
|
| baddoc=1 | Wenn eine Dokumentation zu kurz, unzureichend, oder unvollständig ist, oder nicht dem Standard entspricht, der in der Vorlagenhilfe beschrieben ist, wird sie mit "baddoc=1" markiert. Wenn sowohl nodoc als auch baddoc ausgewählt sind, wird letzteres ignoriert und nur nodoc beachtet. Der Parameter markiert die Dokumentation durch automatische Zuordnung zur Kategorie:Vorlagen mit unzureichender Dokumentation. |
