Vorlage:Dokumentation/Doku: Unterschied zwischen den Versionen
wp>Uwe Lück K (→Benutzung: Grammatik) |
wp>Revolus (Dinge, wo die meisten aufhören werden zu lesen entfernt; Ansporn zur Benutzung erhöht; Anlegehilfe hinzugefügt) |
||
| 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 | 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 == | ||
| Zeile 33: | Zeile 33: | ||
; <code>/Test</code> | ; <code>/Test</code> | ||
: Ein Hinweis wird auch für Testunterseiten ausgegeben. | : Ein Hinweis wird auch für Testunterseiten ausgegeben. | ||
== Unterseiten anlegen == | |||
{| cellspacing="8" cellpadding="0" class="rahmenfarbe1 centered" style="font-size: 100%; border-style: solid; margin-top: 2px; margin-bottom: 2px; background-color: #eeeeff;" | |||
|- | |||
| | |||
<inputbox> | |||
type=create | |||
default=Vorlage:<Name der Vorlage>/Doku | |||
buttonlabel=Dokumentationsseite anlegen | |||
preload=Vorlage:Dokumentation/preload-doku | |||
editintro=Vorlage:Dokumentation/intro-doku | |||
bgcolor=#eeeeff | |||
break=no | |||
</inputbox> | |||
<inputbox> | |||
type=create | |||
default=Vorlage:<Name der Vorlage>/Meta | |||
buttonlabel=Metadatenseite anlegen | |||
preload=Vorlage:Dokumentation/preload-meta | |||
editintro=Vorlage:Dokumentation/intro-meta | |||
bgcolor=#eeeeff | |||
break=no | |||
</inputbox> | |||
<inputbox> | |||
type=create | |||
default=Vorlage:<Name der Vorlage>/Test | |||
buttonlabel=Wartungs- und Testseite anlegen | |||
preload=Vorlage:Dokumentation/preload-test | |||
editintro=Vorlage:Dokumentation/intro-test | |||
bgcolor=#eeeeff | |||
break=no | |||
</inputbox> | |||
|} | |||
Version vom 26. Dezember 2007, 21:50 Uhr
|
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 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: Bei jeder Anwendung wird der gesammte Vorlagentext immer wieder neu ausgewertet, samt der Dokumentation, die im Endeffekt eh 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> an den Anfang einer Vorlage schreibt und die entsprechende Dokumentationsseite erstellt. Eine Unterseite namens /Meta soll dann die Metadaten für die Vorlage enthalten. Zu den Metadaten gehören die Kategorien und Interwikilinks. Nach dem Erstellen der Dokumentation werden einem Erstellungshilfen bereitgestellt (preload).
In den Unterseiten stellen folgende Codezeilen den Rückbezug sicher
- /Doku
<noinclude>{{Dokumentation/Dokuseite}}</noinclude> - /Meta
<noinclude>{{Dokumentation/Metaseite}}</noinclude> <includeonly> … Meta … </includeonly> - /Test
<noinclude>{{Dokumentation/Testseite}}</noinclude> - /Wartung
<noinclude>{{Dokumentation/Wartungsseite}}</noinclude>
Besonderheiten
Wenn sich die Vorlage im Benutzernamensraum befindet, werden die Metadaten nicht eingebunden und weder die Vorlage, noch die Unterseite, werden in Kategorien einsortiert.
Unterseiten
/XML- Wenn die Vorlage neben der Dokumentation noch eine XML-Beschreibung für den Vorlagenmeister hat, wird ein entsprechender Hinweis ausgegeben (→ XML-Hinweis).
/Wartung- Sollte es eine Wartungsseite für die Vorlage geben, so wird ebenfalls ein Hinweis ausgegeben (→ Wartungshinweis).
/Test- Ein Hinweis wird auch für Testunterseiten ausgegeben.