Vorlage:Dokumentation/Doku
Aus Kitakien
K (Tippfehler) |
K (Metadaten nach /meta) |
||
| Zeile 18: | Zeile 18: | ||
Wenn die Vorlage neben der Dokumentation noch eine XML-Beschreibung (Unterseite ''<code>/XML</code>'') für den [[Benutzer:Revvar/VM|Vorlagenmeister]] hat, wird ein entsprechender Hinweis ausgegeben (→ [[Vorlage:XML-Hinweis|XML-Hinweis]]). Sollte es eine [[Hilfe:Infoboxen#Automatische Prüfung von Infoboxen-Parametern|Wartungsseite]] (Unterseite ''<code>/Wartung</code>'') für die Vorlage geben, so wird ebenfalls ein Hinweis ausgegeben (→ [[Vorlage:Wartungshinweis|Wartungshinweis]]). | Wenn die Vorlage neben der Dokumentation noch eine XML-Beschreibung (Unterseite ''<code>/XML</code>'') für den [[Benutzer:Revvar/VM|Vorlagenmeister]] hat, wird ein entsprechender Hinweis ausgegeben (→ [[Vorlage:XML-Hinweis|XML-Hinweis]]). Sollte es eine [[Hilfe:Infoboxen#Automatische Prüfung von Infoboxen-Parametern|Wartungsseite]] (Unterseite ''<code>/Wartung</code>'') für die Vorlage geben, so wird ebenfalls ein Hinweis ausgegeben (→ [[Vorlage:Wartungshinweis|Wartungshinweis]]). | ||
| - | |||
| - | |||
| - | |||
| - | |||
| - | |||
| - | |||
| - | |||
| - | |||
| - | |||
| - | |||
| - | |||
| - | |||
| - | |||
| - | |||
| - | |||
| - | |||
| - | |||
| - | |||
| - | |||
| - | |||
| - | |||
Version vom 03:02, 9. Nov. 2007
| Datei:Information icon.svg | Diese Seite ist eine Untervorlage von Vorlage:Dokumentation. |
Diese Vorlage zeigt eine Dokumentationsbox wie du sie gerade siehst. Sie bindet den Text von der Unterseite [[<Seitenname>/doc]] ein.
Diese Vorlage sollte bei allen Vorlagen Verwendung finden.
Begründung
Die Trennung von Programmcode und Dokumentation trägt zur besseren Übersichtlichkeit bei.
Der Hauptgrund ist jedoch, dass dadurch der Parser entlastet wird. Die Wikipedia setzt die Vorlagen nicht effizient in Bytecode um. Bei jeder Anwendung wird der gesammte Vorlagentext immer wieder neu ausgewertet, samt der Dokumentation, die im Endeffekt eh wieder weggelassen wird. Nichtsdestotrotz 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.
Benutzung
Diese Vorlage erwartet keine Parameter. Es reicht, wenn du <noinclude>{{Dokumentation}}</noinclude> an den Anfang einer Vorlage schreibst und die entsprechende Dokumentationsseite erstellst. Diese sollte in einem <includeonly>-Abschnitt auch die Metadaten für die Vorlage enthalten. Zu den Metadaten gehören die Kategorien und Interwikilinks.
Besonderheiten
Wenn die Vorlage neben der Dokumentation noch eine XML-Beschreibung (Unterseite /XML) für den Vorlagenmeister hat, wird ein entsprechender Hinweis ausgegeben (→ XML-Hinweis). Sollte es eine Wartungsseite (Unterseite /Wartung) für die Vorlage geben, so wird ebenfalls ein Hinweis ausgegeben (→ Wartungshinweis).
