Vorlage:Dokumentation
Vorlage Dokumentation [Bearbeiten]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 die Metadaten für die Vorlage enthalten. Zu den Metadaten gehören vor allem die Kategorien; die Interwiki-Links sollten künftig möglichst über Wikidata eingetragen werden. In der Regel werden Metadaten an das Ende der Doku-Unterseite gesetzt werden; dies und weitere Inhalte der Doku-Unterseite werden auf Hilfe:Vorlagen/ Erklären beschrieben.
Zu den Metadaten beachte auch den Abschnitt Besonderheiten.
Besonderheiten
Wenn sich die Vorlage im Benutzernamensraum befindet, werden die Metadaten nicht eingebunden und weder die Vorlage noch die Unterseite werden in Kategorien einsortiert. In diesem Fall sind die Metadaten mit <noinclude> in der Definition der Vorlage ans Ende zu setzen (neben {{Dokumentation}}.
Unterseiten
/Doku- Diese Unterseite gehört immer zur Dokumentation einer Vorlage.
/Meta- Eine solche Unterseite ist vor allem für vollgesperrte Seiten gedacht, die ansonsten nicht interwikifiziert werden könnten. Aus historischen Gründen gibt es sie auch für viele weitere Vorlagen.
/Druck- Eine spezielle Version der Vorlage, die zusammen mit der Buchfunktion benutzt wird.
Vorlagen-Spezifikation
Vorlage, die eine Dokumentation aus der „Doku“-Unterseite einbindet.
| Parameter | Beschreibung | Typ | Status | |||
|---|---|---|---|---|---|---|
| Keine Parameter angegeben | ||||||
Hinweis: Diese Vorlagen-Spezifikation wurde mit Hilfe der Parsererweiterung <templatedata> erstellt. Siehe Vorlage:TemplateData für eine Erklärung, wie du <templatedata> auf Wikibooks verwenden kannst.
<templatedata> wird unter anderem vom VisualEditor verwendet. Eine ausführliche Hilfe zu dieser Parsererweiterung findest auf der Seite Help:TemplateData.
- Verwendung der Vorlage
- Diese Dokumentation befindet sich auf einer eingebundenen Unterseite.
- Die Metadaten (Kategorien und Interwikis) werden von einer Unterseite eingebunden.
- Liste der Unterseiten.