Vorlage:Dokumentation/Doku: Unterschied zwischen den Versionen

Dinge, wo die meisten aufhören werden zu lesen entfernt; Ansporn zur Benutzung erhöht; Anlegehilfe hinzugefügt
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. 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 <code>&lt;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.
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>&lt;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>
|}
Anonymer Benutzer