Wechseln zu:Navigation, Suche
Wiki
KKeine Bearbeitungszusammenfassung
KKeine Bearbeitungszusammenfassung
Zeile 15: Zeile 15:
{{!}} style="padding:0; width:100%;" {{!}}
{{!}} style="padding:0; width:100%;" {{!}}
<span style="font-size: 9px; line-height:4px;"><ul>
<span style="font-size: 9px; line-height:4px;"><ul>
<li>[{{fullurl:Spezial:Linkliste/{{FULLPAGENAME}}|hideredirs=1&hidelinks=1}} Verwendungen] dieser Vorlage</li>
<!--<li>[{{fullurl:Spezial:Linkliste/{{FULLPAGENAME}}|hideredirs=1&hidelinks=1}} Verwendungen] dieser Vorlage</li>-->
<li> Diese Dokumentation befindet sich [[{{SUBJECTPAGENAME}}/Doku|auf einer eingebundenen Unterseite]] <span style="font-size:85%; margin-left:1em;">&#91; [{{fullurl:{{SUBJECTPAGENAME}}/Doku|action=edit}} Bearbeiten]&#93;</span>.</li>
<li> Diese Dokumentation befindet sich [[{{SUBJECTPAGENAME}}/Doku|auf einer eingebundenen Unterseite]] <span style="font-size:85%; margin-left:1em;">&#91; [{{fullurl:{{SUBJECTPAGENAME}}/Doku|action=edit}} Bearbeiten]&#93;</span>.</li>
{{#ifexist: {{SUBJECTPAGENAME}}/Meta
{{#ifexist: {{SUBJECTPAGENAME}}/Meta
Zeile 33: Zeile 33:
}}
}}
<li>[[Spezial:Präfixindex/{{SUBJECTPAGENAME}}/|Liste der Unterseiten]].</li>
<li>[[Spezial:Präfixindex/{{SUBJECTPAGENAME}}/|Liste der Unterseiten]].</li>
<li class="plainlinks">[{{fullurl:toollabs:templatecount/index.php|lang=de&namespace={{NAMESPACENUMBER}}&name={{PAGENAMEE}}}} Anzahl der Einbindungen]</li>
<!-- <li class="plainlinks">[{{fullurl:toollabs:templatecount/index.php|lang=de&namespace={{NAMESPACENUMBER}}&name={{PAGENAMEE}}}} Anzahl der Einbindungen]</li> -->
</ul></span></span>
</ul></span></span>
{{!}}}
{{!}}}

Version vom 7. März 2019, 12:11 Uhr

Diese Vorlage zeigt eine Dokumentationsbox, wie sie gerade zu sehen ist. 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> an den Anfang einer Vorlage schreibt und die Dokumentationsseite [[<Seitenname>/Doku]] erstellt. Eine Unterseite namens /Meta kann dann die Metadaten für die Vorlage enthalten (hierzu bitte den Abschnitt Besonderheiten lesen), ansonsten können diese mit in die noinclude-tags am Ende der Vorlage platziert werden. 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>
/Druck <noinclude>{{Dokumentation/Druckversion}}</noinclude>

Bei technischen Fragen zu dieser Vorlage kannst du dich an die Vorlagenwerkstatt wenden.

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

/Meta
Eine solche Unterseite ist vor allem für vollgesperrte Seiten gedacht, die ansonsten nicht interwikifiziert werden könnten.
/XML
Wenn die Vorlage neben der Dokumentation noch eine XML-Beschreibung für den Vorlagenmeister hat, wird ein entsprechender Hinweis ausgegeben.
/Wartung
Sollte es eine Wartungsseite für die Vorlage geben, so wird ebenfalls ein Hinweis ausgegeben.
/Test
Ein Hinweis wird auch für Testunterseiten ausgegeben.
/Druck
Eine spezielle Version der Vorlage, die zusammen mit der Buchfunktion benutzt wird.

Unterseiten anlegen

<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=Test- und Beispielseite anlegen
preload=Vorlage:Dokumentation/preload-test
editintro=Vorlage:Dokumentation/intro-test
bgcolor=#eeeeff
break=no

</inputbox> <inputbox>

type=create
default=Vorlage:<Name der Vorlage>/Wartung
buttonlabel=Wartungsseite anlegen
preload=Vorlage:Dokumentation/preload-wartung
editintro=Vorlage:Dokumentation/intro-wartung
bgcolor=#eeeeff
break=no

</inputbox> <inputbox>

type=create
default=Vorlage:<Name der Vorlage>/Druck
buttonlabel=Druckversion anlegen
preload=Vorlage:Dokumentation/preload-druck
editintro=Vorlage:Dokumentation/druck-wartung
bgcolor=#eeeeff
break=no

</inputbox>

Wenn man seine monobook.css um <source enclose="div" lang="css">.metadata { display:block !important; }</source> erweitert, bekommt man auf Vorlagenseiten mit Dokumentation Links zum einfacheren Anlegen der Unterseiten angezeigt.


Bei technischen Fragen zu dieser Vorlage kannst du dich an die Vorlagenwerkstatt wenden.

Inhaltliche Fragen und Vorschläge gehören zunächst auf die Diskussionsseite.