Vorlage:Dokumentation

Aus MoBaDaten
Version vom 13. Juli 2019, 21:50 Uhr von WGK.derdicke (Diskussion | Beiträge)
(Unterschied) ← Nächstältere Version | Aktuelle Version (Unterschied) | Nächstjüngere Version → (Unterschied)
Wechseln zu: Navigation, Suche
Stop hand nuvola.svg Diese Vorlage zeigt eine Dokumentationsbox wie du sie im weiteren Verlauf gerade siehst. Sie bindet den Text von der Unterseite [[<Seitenname>/Doku]] ein.
Dokumentation Edit font awesome grey.svg
Information icon.svg Dies ist die Dokumentation der Unterseite Vorlage:Dokumentation/Doku

Diese Vorlage sollte bei allen Vorlagen verwendet werden.

1 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.


2 Benutzung

Diese Vorlage erwartet keine Parameter. Es reicht, wenn man an das Ende einer Vorlage schreibt:

<noinclude>{{Dokumentation}}</noinclude>

...und folgende Dokumentations-Unterseite erstellt:

[[<Seitenname>/Doku]]

In der Dokumentations-Unterseite stellt folgender,an den Anfang der Doku gestellte Eintrag den Rückbezug zu der Vorlage sicher:

<noinclude>{{Info}}</noinclude>