 Kopie des alten Systems
|
|
Dies ist eine alte Kopie des GenWiki und spiegelt den Stand vom 8. Mai 2022 wider. This is an old copy of the GenWiki and reflects the status as of May 8, 2022. Please visit us at wiki.genealogy.net |
Vorlage:Dokumentation
aus GenWiki, dem genealogischen Lexikon zum Mitmachen.
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|...}}
- ↑ Hierdurch wird die in der Unterseite /Doku befindliche Dokumentation der Vorlage eingebunden.
- ↑ 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.
