Gamepedia Help Wiki
(Zurücksetzen der Vorlage auf die Version des default-loadout-de Wikis, Grund: /doc Unterseiten werden nicht automatisch kategorisiert)
Magiczocker (Diskussion | Beiträge)
(dokumentation entfernt (wurde nach Vorlage:Doc/doc verschoben))
Markierung: Ersetzt
 
Zeile 1: Zeile 1:
  +
<includeonly>{{Clear}}{{#ifexist: {{FULLPAGENAME}}/doc | {{/doc}} | {{Doc/missing}} }}</includeonly><noinclude>{{/doc}}</noinclude>
<noinclude>{{doc/start}}
 
Zur Verwendung, muss eine Unterseite der Vorlage '''doc''' erstellt werden - stellt {{tlx|doc/start}} an den Beginn der Dokumentation und {{tlx|doc/end}} an das Ende.
 
 
Geht zurück zur Hauptvorlagen Seite und fügt &lt;noinclude&gt;{{tlx|doc}}&lt;/noinclude&gt; in eine neue Zeile nach dem Ende der Vorlage. /doc Seiten werden automatisch zu [[:Kategorie:Vorlagendokumentation]] hinzugefügt.
 
 
== Optionale Parameter ==
 
=== clear ===
 
Falls die Hauptvorlagenseite schwebende Inhalte besitzt und eine Überlappung über die Dokumentation unerwünscht ist, stellt {{tlx|doc/start|clear}} anstatt {{tlx|doc/start}} auf die Dokumentationsseite.<br>
 
Dies ist auch sinnvoll für Vorlagen, die &lt;includeonly&gt; nicht verwenden, da es etwas Raum zwischen Vorlage und der Dokumentationsbox schafft.
 
 
=== nodoc=1 ===
 
Falls eine Vorlage keine Dokumentation besitzt und nicht bekannt ist, wie sie verwendet wird, sollte {{tlx|doc/start|nodoc{{=}}1}} (oder falls die Vorlage auch ein clear benötigt, {{tlx|doc/start|clear|nodoc{{=}}1}}) anstatt von {{tlx|doc/start}} auf die Dokumentationsseite gestellt werden.<br>
 
Der Hintergrund der Dokumentation wird rot und dadurch etwas auffälliger werden. Die Seite wird [[:Kategorie:Vorlagen ohne Dokumentation]] hinzugefügt.
 
 
=== baddoc=1 ===
 
Ähnlich wie nodoc, wird dies dazu verwendet um Vorlagen zu markieren, welche eine eher schlechte Dokumentation besitzen. Dies kann bedeuten, dass nicht genügend Beispiele aufgeführt oder alle Funktionen ordentlich erklärt werden.<br>
 
 
Der Hintergrund der Dokumentation wird gelb und dadurch etwas auffälliger. Die Seite wird [[:Kategorie:Vorlagen mit schlechter Dokumentation]] hinzugefügt.
 
 
Falls nodoc und baddoc verwendet werden, wird baddoc ignoriert.
 
</div>
 
 
[[Kategorie:Vorlagendokumentation| ]]
 
</noinclude><includeonly>{{/doc}}</includeonly>
 

Aktuelle Version vom 14. August 2019, 14:35 Uhr

Template-info.svgDokumentation

Um eine Dokumentationsseite zu erstellen, gehe zur Haupt-Vorlagenseite und schreibe <noinclude>{{Doc}}</noinclude> in eine neue Zeile nach dem ende der Vorlage, danach erstelle eine Unterseite der Vorlage mit dem Namen doc, schreibe {{Doc/start}} an den Anfang von der Dokumentation. Dokumentationsseiten werden automatisch Kategorie:Vorlagendokumentation hinzugefügt.