Vorlage:Vorlagendokumentation

Dokumentation dieser Vorlage (eingebunden von Vorlage Diskussion:Vorlagendokumentation/Dokumentation):

Diese Vorlage dient der Dokumentation von Vorlagen, sie bindet eine Unterseite ein und führt dazu, dass sie so aussieht wie die Seite, die gerade angezeigt wird. Sie sollte verwendet werden statt eine Dokumentation direkt in die Vorlage einzubauen, um den Server zu entlasten.

Um eine Vorlage zu dokumentieren sollte wie folgt vorgegangen werden:

1. Im Diskussionsnamensraum eine Unterseite mit dem Namen „Dokumentation“ anlegen (Heißt eine Vorlage „Vorlage:Beispiel“, so muss die Dokumentation auf der Seite „Vorlage Diskussion:Beispiel/Dokumentation“ angelegt werden
2. In der Vorlage selbst wird <noinclude>{{Vorlagendokumentation}}</noinclude> eingefügt.

Beispiel

Die Vorlage:Beispiel sieht wie folgt aus:

Dies ist ein Beispiel für {{{1}}}

Eine Dokumentation der Vorlage wurde unter Vorlage Diskussion:Beispiel/Diskussion geschrieben:

Diese Vorlage sollte verwendet werden um Beispiele für etwas anzugeben.

==Parameter==
#Wofür das Beispiel ist

==Kategorien==
Diese Vorlage bindet keine Kategorien ein.

==Beispiel==
<pre>{{Beispiel|verschiedenes}}</pre>

wird zu:

{{Beispiel|verschiedenes}}

<includeonly>[[Kategorie:Vorlage]]</includeonly>

Die Vorlage:Beispiel wird nun wie folgt ergänzt:

<noinclude>{{Vorlagendokumentation}}
</noinclude>Dies ist ein Beispiel. Folgender Parameter wurde angegeben: {{{1}}}

Was eine Dokumentation beinhalten sollte

• Wofür ist die Vorlage geeignet?
• Was macht die Vorlage?
• Welche Parameter unterstützt die Vorlage?
• Sortiert die Vorlage den Artikel automatisch in Kategorien ein? Wenn ja, welche?
• Entwicklerhinweise (für komplizierte Vorlagen, die wegen vieler Funktionen unleserlich ist)
• Kategorien für die Vorlage. Die Kategorieangaben müssen in einem <includeonly>-Block eingeschlossen sein.