Diese Vorlage wird verwendet, um Dokumentationsinhalte in Vorlagenseiten einzubinden. Sie 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[]
Auf der Vorlagenseite[]
Diese Vorlage erwartet keine Parameter. Es reicht, wenn man <noinclude>{{Dokumentation}}</noinclude> ans Ende einer Vorlage schreibt und die Dokumentationsseite [[<Seitenname>/Doku]] erstellt.
Seitenstruktur:
Vorlagencode<includeonly>Kategorielinks, die von der Vorlage in die Seiten eingefügt werden sollen</includeonly><noinclude>
{{Dokumentation}}</noinclude>
Dabei ist zu beachten, dass vor dem <noinclude>{{Dokumentation}}</noinclude> gegebenenfalls noch <table> oder <div> Tags geschlossen werden müssen oder mit {{clear}} das Umfließen von Blockelementen abgestellt werden muss.
Auf der Dokumentations-Unterseite[]
<noinclude>{{Dokumentation/Dokuseite}}
</noinclude>;Beschreibung
:Diese Vorlage wird verwendet für ...
;Syntax
:Ergänze <code>{{t|Vorlagenname}}</code> an der Stelle ...
;Darstellungsbeispiel
:<code><nowiki>{{Vorlagenname|foo}}</nowiki></code> erzeugt ...
:{{Vorlagenname|foo}}
<includeonly>Kategorielinks für die Vorlage</includeonly>
<noinclude>[[Kategorie:Vorlage:nur Dokumentation|{{PAGENAME}}]]</noinclude>
Das obige Beispiel verwendet außerdem Vorlage:T und Vorlage:T/piece.