Vorlage:Dokumentation/Doku

Aus Kitakien

Datei:Information icon.svg

Diese Seite ist eine Untervorlage von Vorlage:Dokumentation.

Diese Vorlage zeigt eine Dokumentationsbox wie du sie gerade siehst. Sie bindet den Text von der Unterseite [[<Seitenname>/doc]] ein. Diese Vorlage sollte bei allen Vorlagen Verwendung finden; die Beschreibung sollte immer aus der eigentlichen Vorlage ausgelagert werden.

Benutzung

Diese Vorlage erwartet keine Parameter. Es reicht, wenn du <noinclude>{{Dokumentation}}</noinclide> an den Anfang einer Vorlage schreibst und die entsprechende Dokumentationsseite erstellst. Diese sollte in einem <includeonly>-Abschnitt auch die Metadaten für die Vorlage enthalten. Zu den Metadaten gehören die Kategorieren und Interwikilinks.

Besonderheiten

Wenn die Vorlage neben der Dokumentation noch eine XML-Beschreibung (Unterseite /XML) für den Vorlagenmeister hat, wird ein entsprechender Hinweis ausgegeben (→ XML-Hinweis). Sollte es eine Wartungsseite (Unterseite /Wartung) für die Vorlage geben, so wird ebenfalls ein Hinweis ausgegeben (→ Wartungshinweis).en:Template:Documentation/doc