Fandom


Vorlagen-Dokumentation für die obige Vorlage (eventuell versteckt oder unsichtbar)
Emblem-important
Diese Vorlage ist mehrfach eingebunden!
Bitte überprüfe deine Änderungen sorgfältig, bevor du abspeicherst. Alternativ ist es jedoch sinnvoll, Änderungswünsche erst auf der Diskussionsseite abzustimmen.

Diese Vorlage wird verwendet, um Dokumentationsinhalte in Vorlagenseiten einzubinden. Sie zeigt eine Dokumentationsbox, wie du sie gerade siehst, und bindet den Text von der Unterseite [[<Seitenname>/Doku]] ein. Die 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

Auf der Vorlagenseite

Diese Vorlage erwartet keine Parameter. Es reicht, wenn man <noinclude>{{Dokumentation}}</noinclude> ans Ende einer Vorlage schreibt und die Dokumentationsseite [[<Seitenname>/Doku]] erstellt. Alle Metadaten für die Vorlage, zu denen Kategorien und Interwikilinks zählen, gehören in die Dokumentation.

Kopiervorlage
…Vorlagencode…
<includeonly>Kategorielinks, die von der Vorlage in die Seiten eingefügt werden sollen</includeonly>
<noinclude>{{Dokumentation}}</noinclude>

Dabei ist zu beachten, dass vor dem <noinclude>{{Dokumentation}}</noinclude> gegebenenfalls noch <table> oder <div> Tags geschlossen werden müssen oder mit {{clear}} das Umfließen von Blockelementen abgestellt werden muss.

Auf der Dokumentations-Unterseite

Das Aussehen der Dokumentation soll möglichst einheitlich sein. Daher verwende einfach folgende Mustervorlage, die in die Unterseite kopiert wird. Ändere danach einfach alle nötigen Informationen.

Kopiervorlage
Mit dieser Vorlage können allgemeine Grundinformationen über (Thema) übersichtlich dargestellt werden. Dazu wird <code>{{<Vorlage>}}</code> inklusive der benötigten Parameter am Anfang der entsprechenden Seite hinzugefügt.

Die meisten Parameter sind dabei optional und müssen nicht definiert sein. Empfehlungen dazu und eine Beschreibung siehe unten.

== Kopiervorlage ==
Der komplette einzusetzen Code mitsamt aller Parameter. Bitte den Code zwischen den pre-Tag setzen.

== Parameter ==
{|class="wikitable" width="100%"
!Name
!Pflicht
!Beschreibung
|-
|Parameter1
|ja/nein
|Beschreibung
|-
…
|}

== Siehe auch ==
* Falls ähnliche Vorlagen existieren:
* Hier eine Auflistung

<includeonly>Kategorielinks für die Vorlage</includeonly>
<noinclude>[[Kategorie:Dokumentation|{{PAGENAME}}]]</noinclude>

Unterseite anlegen

Trage hier den Namen der Vorlage ein, für die eine Dokumentation angelegt werden soll. Dabei wird automatisch die Mustervorlage oben eingeladen.


Diese Dokumentation befindet sich auf einer eingebundenen Unterseite. (Wie funktioniert das?)
Nutzung von Community-Inhalten gemäß CC-BY-SA , sofern nicht anders angegeben.