Hilfe:Vorlagendokumentation

aus Wikisource, der freien Quellensammlung
Zur Navigation springen Zur Suche springen

Die Dokumentation einer Vorlage erfolgt am Beginn ihrer Diskussionsseite. Dabei sollten die folgenden Punkte erläutert werden:

  • Funktion: Zunächst ist anzugeben, welche Aufgabe die Vorlage hat und zu welcher Gelegenheit sie verwendet wird.
  • Parameter: Wenn die Vorlage beeinflusst werden kann, ist eine genaue Beschreibung der verwendbaren Argumente wichtig.
  • Beispiele: Wie das sprichwörtliche Bild, das mehr als tausend Worte sagt, sind Muster zur Verdeutlichung der möglichen Verwendungsweisen geeignet.
  • Kopiervorlagen: Es erleichtert den Einsatz einer Vorlage, wenn häufig vorkommende Aufrufe einfach zu übernehmen sind.
  • Bemerkungen: Besonderheiten, mögliche Fehlerbedingungen oder andere nicht offensichtliche Eigenschaften sollten erwähnt werden.

Hinter dem Abschnitt mit der Dokumentation wird der Dikussionsteil mit einer entsprechenden Überschrift eingeleitet.

In die Vorlage ist mittels der Vorlage Vorlagendokumentation ein Hinweis auf die Dokumentation einzubauen.
Dazu wird unmittelbar nach dem letzten Zeichen der Vorlage ohne ein Leerzeichen oder eine Zeilenschaltung (<CR>, <CRLF>) <noinclude>{{Vorlagendokumentation}}</noinclude> eingefügt.

Beispiel[Bearbeiten]

Funktion:

...

Parameter:

Mit m(andatory) gekennzeichnete Parameter sind erforderlich. Mit o(ptional) markierte Parameter können entfallen.

  • Parameter 1 (m/o): ...
  • Parameter name (m/o): ...

Benannte Parameter müssen in der Form name=wert angegeben werden.
Dies gilt auch für unbenannte Parameter, wenn der Wert ein Gleichheitszeichen enthält: 1=we=rt

Beispiele:

...

Kopiervorlagen:

...
Bemerkungen:

...

  • Siehe auch: ...
  • Weitere Information zu Vorlagen gibt es auf einer Hilfe-Seite.

Diskussion


Kopiervorlage[Bearbeiten]

<div style="margin:1em; padding:1em; border:solid 1px #4000ff; background-color:#FFFFFF">
<div style="font-size:120%;color:#4040ff;background-color:#ffffff;">'''Funktion:'''</div>
---- 
...
<div style="font-size:120%;color:#4040ff;background-color:#ffffff;">'''Parameter:'''</div>
----
Mit '''m'''(andatory) gekennzeichnete Parameter sind erforderlich.
Mit '''o'''(ptional) markierte Parameter können entfallen.
*'''Parameter 1 (m/o):''' ...
*'''Parameter ''name'' (m/o):''' ...
Benannte Parameter müssen in der Form <code>name=wert</code> angegeben werden.<br />
Dies gilt auch für unbenannte Parameter, wenn der Wert
ein Gleichheitszeichen enthält: <code>1=we=rt</code>
<div style="font-size:120%;color:#4040ff;background-color:#ffffff;">'''Beispiele:'''</div>
----
...
<div style="font-size:120%;color:#4040ff;background-color:#ffffff;">'''Kopiervorlagen:'''</div>
----
<pre>...</pre>
<div style="font-size:120%;color:#4040ff;background-color:#ffffff;">'''Bemerkungen:'''</div>
----
...
*Siehe auch: ...
*Weitere Information zu Vorlagen gibt es auf einer [[Hilfe:Vorlagen|Hilfe-Seite]].
</div>
==Diskussion==