Vorlage:Dokumentation
- Diese Dokumentation wird von einer Unterseite eingebunden.
- Die Metadaten (Kategorien und Interwikis) werden von einer Unterseite eingebunden (bearbeiten).
- Verwendung der Vorlage in Artikeln.
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.
Inhaltsverzeichnis
Begründung
Die Trennung von Programmcode und Dokumentation trägt zur besseren Übersichtlichkeit bei.
Der Hauptgrund ist jedoch, dass dadurch der Parser entlastet wird: Bei jeder Anwendung wird der gesamte Vorlagentext immer wieder neu ausgewertet, samt der Dokumentation, die im Endeffekt eh wieder weggelassen wird. Trotzdem 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. Somit ermöglicht man die Nutzung von mehr Vorlagen pro Artikelseite.
Benutzung
Diese Vorlage erwartet keine Parameter. Es reicht, wenn man <noinclude>
{{Dokumentation}} </noinclude> ans Ende einer Vorlage schreibt und die entsprechende Dokumentationsseite erstellt. Eine Unterseite namens /Meta kann dann die Metadaten für die Vorlage enthalten (hierzu bitte den Abschnitt Besonderheiten lesen), ansonsten können diese mit in die noinclude-tags am Ende der Vorlage platziert werden. Zu den Metadaten gehören die Kategorien und Interwikilinks. Nach dem Erstellen der Dokumentation werden einem Erstellungshilfen bereitgestellt (preload).
In den Unterseiten stellen folgende Codezeilen den Rückbezug sicher
- /Doku
<noinclude>
{{ Dokumentation/Dokuseite
}} </noinclude>
- /Meta
<noinclude>
{{ Dokumentation/Metaseite
}} </noinclude><includeonly> … Meta … </includeonly>
- /Test
<noinclude>
{{ Dokumentation/Testseite
}} </noinclude>
- /Wartung
<noinclude>
{{ Dokumentation/Wartungsseite
}} </noinclude>
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
/Meta- Eine solche Unterseite ist vorallem für vollgesperrte Seiten gedacht, die ansonsten nicht interwikifiziert werden könnten.
/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.
