Vorlage:Dokumentation/Doku: Unterschied zwischen den Versionen
Zur Navigation springen
Zur Suche springen
Arend (Diskussion • Beiträge) (Beispiel) |
Arend (Diskussion • Beiträge) Keine Bearbeitungszusammenfassung |
||
| Zeile 22: | Zeile 22: | ||
Name: '''Vorlage:ABC''' | Name: '''Vorlage:ABC''' | ||
:<code | :<code><includeonly><nowiki>...Programmcode der Vorlage...</nowiki></includeonly><noinclude></code><br /> | ||
:<code><nowiki>{{Dokumentation}}</nowiki></code><br /> | :<code><nowiki>{{Dokumentation}}</nowiki></code><br /> | ||
:<code | :<code></noinclude></code> | ||
=== Dokumentation === | === Dokumentation === | ||
| Zeile 30: | Zeile 30: | ||
Name: '''Vorlage:ABC/Doku''' | Name: '''Vorlage:ABC/Doku''' | ||
:<code | :<code><noinclude><nowiki>{{Dokumentation/Dokuseite}}</nowiki></noinclude></code><br /> | ||
:<code><nowiki>Diese Vorlage dient dazu ...</nowiki></code><br /> | :<code><nowiki>Diese Vorlage dient dazu ...</nowiki></code><br /> | ||
:<code><nowiki>== Parameter ==</nowiki></code><br /> | :<code><nowiki>== Parameter ==</nowiki></code><br /> | ||
| Zeile 36: | Zeile 36: | ||
:<code><nowiki>== Beispiel ==</nowiki></code><br /> | :<code><nowiki>== Beispiel ==</nowiki></code><br /> | ||
:<code><nowiki>=== Aufruf ===</nowiki></code><br /> | :<code><nowiki>=== Aufruf ===</nowiki></code><br /> | ||
:<code | :<code><code><nowiki><nowiki>{{ABC|...}}</nowiki></nowiki></code></code><br /> | ||
:<code><nowiki>=== Anzeige ===</nowiki></code><br /> | :<code><nowiki>=== Anzeige ===</nowiki></code><br /> | ||
:<code><nowiki>{{ABC|...}}</nowiki></code><br /> | :<code><nowiki>{{ABC|...}}</nowiki></code><br /> | ||
Version vom 3. Februar 2011, 21:51 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|...}}