Vorlage:Dokumentation/Doku

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

Diese Vorlage ist vielfach eingebunden. Wenn du die Auswirkungen genau kennst, kannst du sie bearbeiten. Meist ist es jedoch sinnvoll, Änderungswünsche erst auf Vorlage Diskussion:Dokumentation abzustimmen.

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

Begründung

Die Trennung von Programmcode und Dokumentation macht den Quelltext übersichtlicher.

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. Diese Unterseite nimmt Interwiki-Links sowie Kategorisierungen auf.

/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

<inputbox> type=create default=Vorlage:<Name der Vorlage>/Doku buttonlabel=Dokumentationsseite anlegen preload=Vorlage:Dokumentation/preload-doku editintro=Vorlage:Dokumentation/intro-doku break=no </inputbox> <inputbox> type=create default=Vorlage:<Name der Vorlage>/Meta buttonlabel=Metadatenseite anlegen preload=Vorlage:Dokumentation/preload-meta editintro=Vorlage:Dokumentation/intro-meta break=no </inputbox> <inputbox> type=create default=Vorlage:<Name der Vorlage>/Test buttonlabel=Test- und Beispielseite anlegen preload=Vorlage:Dokumentation/preload-test editintro=Vorlage:Dokumentation/intro-test break=no </inputbox> <inputbox> type=create default=Vorlage:<Name der Vorlage>/Wartung buttonlabel=Wartungsseite anlegen preload=Vorlage:Dokumentation/preload-wartung editintro=Vorlage:Dokumentation/intro-wartung break=no </inputbox> <inputbox> type=create default=Vorlage:<Name der Vorlage>/Druck buttonlabel=Druckversion anlegen preload=Vorlage:Dokumentation/preload-druck editintro=Vorlage:Dokumentation/intro-druck break=no </inputbox> <inputbox> type=create default=Vorlage:<Name der Vorlage>/Editnotice buttonlabel=Editnotice anlegen preload=Vorlage:Dokumentation/preload-editnotice editintro=Vorlage:Dokumentation/intro-editnotice break=no </inputbox>

Wenn man das MediaWiki:Gadget-Personendaten in den Einstellungen aktiviert, bekommt man auf Vorlagenseiten mit Dokumentation Links zum einfacheren Anlegen bzw. Bearbeiten der Unterseiten angezeigt.