Vorlage:Dokumentation: Unterschied zwischen den Versionen

{{#ifexist: Vorlage:Dokumentation/Doku| 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> am Anfang einer Vorlage schreibt und die Dokumentationsseite [[<Seitenname>/Doku]] erstellt. }}

{{#switch:{{#ifeq:/10

1|{{#expr:1+1}}}}

1|{{#expr:1+1}}}} }}

%7B%7B%7Bseite%7D%7D%7D|Vorlage:Dokumentation }}&namespace=1 Verwendung] der Vorlage auf Artikel-Diskussionsseiten.

%7B%7B%7Bseite%7D%7D%7D|Vorlage:Dokumentation }}&namespace=2 Verwendung] der Vorlage auf Benutzerseiten.

%7B%7B%7Bseite%7D%7D%7D|Vorlage:Dokumentation }}&namespace=3 Verwendung] der Vorlage auf Benutzer-Diskussionsseiten.

%7B%7B%7Bseite%7D%7D%7D|Vorlage:Dokumentation }}&namespace=4 Verwendung] der Vorlage auf Systemseiten.

%7B%7B%7Bseite%7D%7D%7D|Vorlage:Dokumentation }}&namespace=6 Verwendung] der Vorlage bei Dateien.

%7B%7B%7Bseite%7D%7D%7D|Vorlage:Dokumentation }}&namespace=10 Verwendung] der Vorlage auf Vorlagenseiten.

%7B%7B%7Bseite%7D%7D%7D|Vorlage:Dokumentation }}&namespace=10 Verwendung] der Vorlage auf Vorlagen-Diskussionsseiten.

%7B%7B%7Bseite%7D%7D%7D|Vorlage:Dokumentation }}&namespace=14 Verwendung] der Vorlage auf Kategorieseiten.

%7B%7B%7Bseite%7D%7D%7D|Vorlage:Dokumentation }}&namespace=0 Verwendung] der Vorlage in Artikeln. }} Diese Dokumentation befindet sich auf einer eingebundenen Unterseite (Bearbeiten/Versionen). Liste der Unterseiten.