Vorlage:Dokumentation/Doku: Unterschied zwischen den Versionen

aus GenWiki, dem genealogischen Lexikon zum Mitmachen.
Zur Navigation springen Zur Suche springen
Keine Bearbeitungszusammenfassung
Keine Bearbeitungszusammenfassung
 
Zeile 6: Zeile 6:
== Anwendung ==
== Anwendung ==


Man schreibt <code>&lt;noinclude><nowiki>{{Dokumentation}}</nowiki>&lt;/noinclude></code> an das Ende einer Vorlage.
Man schreibt <code>&lt;noinclude><nowiki>{{Dokumentation}}</nowiki>&lt;/noinclude></code> an das Ende einer Vorlage.<ref>Hierdurch wird die in der Unterseite '''/Doku''' befindliche Dokumentation der Vorlage eingebunden.</ref>


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


<code>&lt;noinclude><nowiki>{{Dokumentation/Dokuseite}}</nowiki>&lt;/noinclude></code>
<code>&lt;noinclude><nowiki>{{Dokumentation/Dokuseite}}</nowiki>&lt;/noinclude></code><ref>Hierdurch wird in einer Infobox auf die Vorlage verwiesen (gewissermaßen der Rücksprung auf die eigentliche Vorlage) und die (Unter)Seite als [[:Kategorie:Vorlagendokumentation|Vorlagendokumentation]] kategorisiert.</ref>


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.
Zeile 39: Zeile 39:
:<code><nowiki>=== Anzeige ===</nowiki></code><br />
:<code><nowiki>=== Anzeige ===</nowiki></code><br />
:<code><nowiki>{{ABC|...}}</nowiki></code><br />
:<code><nowiki>{{ABC|...}}</nowiki></code><br />
----
<references />

Aktuelle Version vom 3. Februar 2011, 22:09 Uhr

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