Hilfe:Vorlagendokumentation

aus Wikisource, der freien Quellensammlung

Um eine Vorlage zu dokumentieren sollten folgende Punkte auf der Diskussionseite der Vorlage in dieser Reihenfolge sein.

• Erklärung der Parameter, wird hier genutzt um das Aussehen der Dokumentation zu zeigen.
• Kopiervorlage, wird hier genutzt um die Kopiervorlage für den gewünschten Seitenaufbau zu zeigen
• Diskussion
• Um eine neue Vorlage zu dokumentieren, braucht nur die Kopiervorlage auf die Diskussionsseite kopiert werden.
• Zusätzlich soll dieser Heinweis in die Vorlage eingebaut werden. Dies unmittelbar nach dem letzten Zeichen der Vorlage ohne ein Leerzeichen oder CR einzufügen. <noinclude>{{Vorlagendokumentation}}</noinclude>

[Bearbeiten] Erklärung der Parameter

[Bearbeiten] Kopiervorlage

== Erklärung der Parameter ==
<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>
---- 
Diese Vorlage stellt (im Projekt ... ) folgende Funktionen bereit:
* ....
* ....
<div style="font-size:120%;color:#4040ff;background-color:#ffffff;">'''Parameter:'''</div>
----

{| border="0" valign="top"|
|- 
||Parametername: || Art || Inhalt dieses Parameters
|- 
||'''Parameter 1''':|| m || Dieser Parameter gibt ...
|-
|''benannter Param''=|| o || 
|-
|}

*Bei Art bedeuten die Buchstaben m='''m'''andatory (er muß angegeben werden) o='''o'''ptional (er kann angegeben werden)

<div style="font-size:120%;color:#4040ff;background-color:#ffffff;">'''Beispiel:'''</div>
----

<nowiki>{{ZC|2|korrigiert|Band 2:Seite 157|Band 2:Seite 159|15|Reifegerste_Zimmer_2.158.jpg}}</nowiki>

*Weitere Hilfen zu Vorlagen finden sie hier [[Hilfe:Vorlagen]]
<div style="font-size:120%;color:#4040ff;background-color:#ffffff;">'''Bemerkung:'''</div>
....
----
</div>

== Kopiervorlage ==

== Diskussion ==

[Bearbeiten] Diskussion