Vorlage:Dokumentation/Doku: Unterschied zwischen den Versionen
Zur Navigation springen
Zur Suche springen
Arend (Diskussion • Beiträge) (Die Seite wurde neu angelegt: „<noinclude>{{Dokumentation/Dokuseite}} </noinclude> Die Trennung von Programmcode und Dokumentation macht den Quelltext einer Vorlage übersichtlicher und entlas...“) |
Arend (Diskussion • Beiträge) (Beispiel) |
||
| Zeile 13: | Zeile 13: | ||
und lässt anschließend den Text folgen, der die Vorlage und ihre Anwendung dokumentiert. | 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''' | |||
:<code><nowiki><includeonly>...Programmcode der Vorlage...</includeonly><noinclude></nowiki></code><br /> | |||
:<code><nowiki>{{Dokumentation}}</nowiki></code><br /> | |||
:<code><nowiki></noinclude></nowiki></code> | |||
=== Dokumentation === | |||
Name: '''Vorlage:ABC/Doku''' | |||
:<code><nowiki><noinclude>{{Dokumentation/Dokuseite}}</noinclude></nowiki></code><br /> | |||
:<code><nowiki>Diese Vorlage dient dazu ...</nowiki></code><br /> | |||
:<code><nowiki>== Parameter ==</nowiki></code><br /> | |||
:<code><nowiki>1. ...</nowiki></code><br /> | |||
:<code><nowiki>== Beispiel ==</nowiki></code><br /> | |||
:<code><nowiki>=== Aufruf ===</nowiki></code><br /> | |||
:<code><nowiki><code><nowiki>{{ABC|...}}</nowiki></code></nowiki></code><br /> | |||
:<code><nowiki>=== Anzeige ===</nowiki></code><br /> | |||
:<code><nowiki>{{ABC|...}}</nowiki></code><br /> | |||
Version vom 3. Februar 2011, 21:47 Uhr
|
Diese Seite ist die Dokumentations-Unterseite der Vorlage: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 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|...}}