Vorlage:Dokumentation/Doku

Diese Seite ist die Dokumentations-Unterseite der Vorlage:Dokumentation.

Diese Vorlage zeigt eine Dokumentationsbox wie du sie gerade siehst. Sie bindet den Text von der Unterseite [[<Seitenname>/Doku]] ein.

Diese Vorlage sollte bei allen Vorlagen Verwendung finden.

Begründung

Die Trennung von Programmcode und Dokumentation trägt zur besseren Übersichtlichkeit bei.

Der Hauptgrund ist jedoch, dass dadurch der Parser entlastet wird. Die Wikipedia setzt die Vorlagen nicht effizient in Bytecode um. Bei jeder Anwendung wird der gesammte Vorlagentext immer wieder neu ausgewertet, samt der Dokumentation, die im Endeffekt eh wieder weggelassen wird. Nichtsdestotrotz werden <noinclude>s vor den tatsächlichen Einbindungen ausgewertet, so dass man die "Pre-expand include size" drastisch drücken kann, wenn man die Dokumentationen in Unterseiten schreibt. Daher sollte die Beschreibung immer aus der eigentlichen Vorlage ausgelagert werden.

Benutzung

Diese Vorlage erwartet keine Parameter. Es reicht, wenn du <noinclude>{{Dokumentation}}</noinclude> an den Anfang einer Vorlage schreibst und die entsprechende Dokumentationsseite erstellst. In einer Unterseite namens /Meta soll dann die Metadaten für die Vorlage enthalten. Zu den Metadaten gehören die Kategorien und Interwikilinks. Nach dem Erstellen der Dokumentation werden einem Erstellungshilfen bereitgestellt.

in den Unterseiten

stellen folgende Codezeilen den Rückbezug sicher

• /Doku <noinclude>{{Dokumentation/Dokuseite}}</noinclude>
• /Meta <noinclude>{{Dokumentation/Metaseite}}</noinclude> <includeonly> ... Meta ... </includeonly>
• /Test {{Dokumentation/Testseite}}

Besonderheiten

Wenn sich die Vorlage im Benutzernamensraum befindet, werden die Metadaten nicht eingebunden und weder die Vorlage, noch die Unterseite, werden in Kategorien einsortiert.

Unterseiten

/XML

Wenn die Vorlage neben der Dokumentation noch eine XML-Beschreibung für den Vorlagenmeister hat, wird ein entsprechender Hinweis ausgegeben (→ XML-Hinweis).

/Wartung

Sollte es eine Wartungsseite für die Vorlage geben, so wird ebenfalls ein Hinweis ausgegeben (→ Wartungshinweis).

/Test

Ein Hinweis wird auch für Testunterseiten ausgegeben.