Fandom


Information icon 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 wurde entwickelt für alle Vorlagen, die ausführlich dokumentiert werden.

Die Trennung von Programmcode und Dokumentation machen den Quelltext übersichtlicher und entlasten 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.

In den Unterseiten stellen folgende Codezeilen den Rückbezug sicher

/Doku <noinclude>{{Dokumentation/Dokuseite}}</noinclude>
/Test <noinclude>{{Dokumentation/Testseite}}</noinclude>
/Unterseite <noinclude>{{Dokumentation/Unterseite}}</noinclude>


*Achtung: Manche der oben angegebenen Links sind Affiliate-Links. Das heißt, Fandom verdient eine Provision, wenn ihr über einen dieser Links etwas kauft. Euch entstehen dadurch keine zusätzlichen Kosten. Nutzung von Community-Inhalten gemäß CC-BY-SA , sofern nicht anders angegeben.