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 verwendet werden.

Begründung

Die Trennung von Programmcode und Dokumentation macht den Quelltext übersichtlicher und entlastet vor allem den Parser: Bei jeder Anwendung wird der gesamte Vorlagentext immer wieder neu ausgewertet, samt der Dokumentation, die im Endeffekt ohnehin 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 Dokumentationsseite [[<Seitenname>/Doku]] 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>

/Druck <noinclude>{{Dokumentation/Druckversion}}</noinclude>

/Editnotice <noinclude>{{Dokumentation/Editnoticeseite}}</noinclude>

/Unterseite <noinclude>{{Dokumentation/Unterseite}}</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 vor allem 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.

/Wartung

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

/Test

Ein Hinweis wird auch für Testunterseiten ausgegeben.

/Druck

Eine spezielle Version der Vorlage, die zusammen mit der Buchfunktion benutzt wird.

/Editnotice

Eine spezieller Hinweis, der beim Bearbeiten angezeigt wird.

Unterseiten anlegen

Wenn man seine monobook.css um

.metadata { display:block !important; }
.metadata-inline { display:inline !important; }

erweitert, bekommt man auf Vorlagenseiten mit Dokumentation Links zum einfacheren Anlegen bzw. Bearbeiten der Unterseiten angezeigt.