Doc

Version vom 3. Juni 2019, 19:28 Uhr

Dokumentation

Zur Verwendung, muss eine Unterseite der Vorlage doc erstellt werden - stellt {{doc/start}} an den Beginn der Dokumentation und {{doc/end}} an das Ende.

Geht zurück zur Hauptvorlagen Seite und fügt <noinclude>{{doc}}</noinclude> in eine neue Zeile nach dem Ende der Vorlage. /doc Seiten werden automatisch zu Kategorie:Vorlagendokumentation hinzugefügt.

Inhaltsverzeichnis

1 Optionale Parameter

Optionale Parameter

clear

Falls die Hauptvorlagenseite schwebende Inhalte besitzt und eine Überlappung über die Dokumentation unerwünscht ist, stellt {{doc/start|clear}} anstatt {{doc/start}} auf die Dokumentationsseite.
Dies ist auch sinnvoll für Vorlagen, die <includeonly> 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 {{doc/start|nodoc=1}} (oder falls die Vorlage auch ein clear benötigt, {{doc/start|clear|nodoc=1}}) anstatt von {{doc/start}} auf die Dokumentationsseite gestellt werden.
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.

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.

@@ Zeile 1: / Zeile 1: @@
 <noinclude>{{doc/start}}
-To use, create a sub-page from the template called '''doc''', put {{tl|doc/start}} at the start of your documentation, and {{tl|doc/end}} at the end.
+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.
-Go back to your main template page and put &lt;noinclude&gt;{{tl|doc}}&lt;/noinclude&gt; on a newline after the end of the template. /doc pages will automatically be added to [[:Category:Documentation templates]].
+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.
-== Optional parameters ==
+== Optionale Parameter ==
 === clear ===
-If your main template page has floating content and you would like to stop it going over the documentation, put {{tlx|doc/start|clear}} instead of {{tl|doc/start}} on your documentation page.<br>
+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>
-This is also useful for templates not using &lt;includeonly&gt;, as it will put some space between the template and the documentation box.
+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 ===
-If a template has no documentation and you don't know how to use it, put {{tlx|doc/start|nodoc{{=}}1}} (or if the template needs clear as well, {{tlx|doc/start|clear|nodoc{{=}}1}}) instead of {{tl|doc/start}} on your documentation page.<br>
+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.
-The documentation's background will become red to make it more noticeable, and the page will be added to [[:Category:Templates with no documentation]].
 === 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>
-Similar to nodoc, this is used to mark templates that '''do''' have documentation, but it isn't very good. This can mean it doesn't have enough examples, doesn't explain all the functions properly, or doesn't explain the point of the template properly.<br>
-The documentation's background will become yellow to make it more noticeable, and the page will be added to [[:Category:Templates with bad documentation]].
+Der Hintergrund der Dokumentation wird gelb und dadurch etwas auffälliger. Die Seite wird [[:Kategorie:Vorlagen mit schlechter Dokumentation]] hinzugefügt.
-If both nodoc and baddoc are specified, baddoc will be ignored.
+Falls nodoc und baddoc verwendet werden, wird baddoc ignoriert.
 </div>
+[[Kategorie:Vorlagendokumentation| ]]
-[[Category:Documentation templates| ]]
 </noinclude><includeonly>{{/doc}}</includeonly>