Vorlage:Dokumentation/Doku: Unterschied zwischen den Versionen
Vorlage:Dokumentation/Doku (Quelltext anzeigen)
Version vom 2. Januar 2008, 00:19 Uhr
, 2. Januar 2008Rechtschreibung
wp>Revolus K (Hab da was verwechselt) |
wp>Wiegels K (Rechtschreibung) |
||
| Zeile 1: | Zeile 1: | ||
<noinclude>{{Dokumentation/Dokuseite}} | <noinclude>{{Dokumentation/Dokuseite}} | ||
</noinclude>Diese Vorlage zeigt eine Dokumentationsbox wie du sie gerade siehst. Sie bindet den Text von der Unterseite <code><nowiki>[[<Seitenname>/Doku]]</nowiki></code> ein. | </noinclude>Diese Vorlage zeigt eine Dokumentationsbox, wie du sie gerade siehst. Sie bindet den Text von der Unterseite <code><nowiki>[[<Seitenname>/Doku]]</nowiki></code> ein. | ||
Diese Vorlage sollte bei allen Vorlagen Verwendung finden. | Diese Vorlage sollte bei allen Vorlagen Verwendung finden. | ||
| Zeile 9: | Zeile 9: | ||
Die Trennung von Programmcode und Dokumentation trägt zur besseren Übersichtlichkeit bei. | Die Trennung von Programmcode und Dokumentation trägt zur besseren Übersichtlichkeit bei. | ||
Der Hauptgrund ist jedoch, dass dadurch der Parser entlastet wird: Bei jeder Anwendung wird der gesammte Vorlagentext immer wieder neu ausgewertet, samt der Dokumentation, die im Endeffekt eh wieder weggelassen wird. Trotzdem werden <code><noinclude></code>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 | Der Hauptgrund ist jedoch, dass dadurch der Parser entlastet wird: Bei jeder Anwendung wird der gesammte Vorlagentext immer wieder neu ausgewertet, samt der Dokumentation, die im Endeffekt eh wieder weggelassen wird. Trotzdem werden <code><noinclude></code>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 == | == Benutzung == | ||