Vorlage:Dokumentation

[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.

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

<noinclude>{{Dokumentation/Dokuseite}}</noinclude>

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|...}}

---