Vorlage:Vorlagendokumentation

Aus C3MAWiki

(Um diese Anleitung zu verstehen, solltest du die Hilfe zu Vorlagen gelesen haben.) Wenn du selbst eine Vorlage erstellst, solltest du auf jeden Fall diese Vorlagendokumentation einbinden.

Parameter

Beschreibung

Eine kurze (oder auch längere) Erklärung des Sinns der Vorlage.

Parameter

Eine Beschreibung jedes einzelnen Parameters, jeweils unter einer Überschrift 3. Ordnung (siehe Beispiel). Du kannst diesen Parameter auch weglassen, wenn deine Vorlage keine Parameter benutzt.

Beispiel

Ein Beispiel für die Anwendung der Vorlage. Am besten mit <pre> und </pre> umschließen.

Ergebnis

Was kommt bei dem Beispiel raus? Meist reicht es, den Wert von Beispiel ohne die <pre>s zu benutzen.

Kategorie

Eine Kategorie für die Vorlage, sonst landet sie unter Kategorie:Vorlage ohne Kategorie.

Beispiel

{{Vorlagendokumentation
|Beschreibung=Dies ist meine lustige erste Vorlage.
|Parameter=
=== Schuhgröße ===
Füge hier deine Schuhgröße ein.

=== Sternzeichen ===
Gib ein Sternzeichen an. Dieser Parameter ist optional, falls du noch nicht geboren wurdest.
|Beispiel=
<tt>{{Testvorlage|Schuhgröße=42|Sternzeichen=Jungfrau}}</tt>
|Ergebnis=
Diese(r) Jungfrau hat Schuhgröße 42
}}

Ergebnis

Das jetzt hier zu dokumentieren wäre total krank und unübersichtlich. Du siehst ja an diesem Text hier, wie's aussieht.