Vorlage:Dokumentation

aus GenWiki, dem genealogischen Lexikon zum Mitmachen.

Wechseln zu: Navigation, Suche
[Bearbeiten] Dokumentation

Die Trennung von Programmcode und Dokumentation macht den Quelltext einer Vorlage übersichtlicher und entlastet vor allem den Parser.

Anwendung

Man schreibt <noinclude>{{Dokumentation}}</noinclude> an das Ende einer Vorlage.[1]

In der zum Zwecke der Dokumentation zu erstellenenden Unterseite /Doku der Vorlage beginnt man mit:

<noinclude>{{Dokumentation/Dokuseite}}</noinclude>[2]

und lässt anschließend den Text folgen, der die Vorlage und ihre Anwendung dokumentiert.

Beispiel

In diesem fiktiven Beispiel soll die Vorlage den Namen ABC bekommen.

Vorlage

Name: Vorlage:ABC

<includeonly>...Programmcode der Vorlage...</includeonly><noinclude>
{{Dokumentation}}
</noinclude>

Dokumentation

Name: Vorlage:ABC/Doku

<noinclude>{{Dokumentation/Dokuseite}}</noinclude>
Diese Vorlage dient dazu ...
== Parameter ==
1. ...
== Beispiel ==
=== Aufruf ===
<code><nowiki>{{ABC|...}}</nowiki></code>
=== Anzeige ===
{{ABC|...}}



  1. Hierdurch wird die in der Unterseite /Doku befindliche Dokumentation der Vorlage eingebunden.
  2. Hierdurch wird in einer Infobox auf die Vorlage verwiesen (gewissermaßen der Rücksprung auf die eigentliche Vorlage) und die (Unter)Seite als Vorlagendokumentation kategorisiert.
Persönliche Werkzeuge