Vorlage:Documentation/doc: Unterschied zwischen den Versionen

Aus Minecraft Gameserver Wiki
Wechseln zu: Navigation, Suche
K
Zeile 1: Zeile 1:
;Description
+
;Beschreibung
:This template is used to insert descriptions on template pages.
+
:Diese Vorlage fügt Beschreibungen und Dokumentationen auf Vorlagenseiten ein.
 
;Syntax
 
;Syntax
:Type <code><nowiki><noinclude></nowiki><nowiki></noinclude></nowiki></code> at the end of the template page.
+
:Füge <code><nowiki><noinclude>{{documentation}}</nowiki><nowiki></noinclude></nowiki></code> am Ende der Vorlagenseite ein.
  
==General usage==
+
==Allgemeine Verwendung==
===On the Template page===
+
===Auf der Vorlagenseite===
 
<pre>
 
<pre>
Template code<includeonly>Any categories to be inserted into articles by the template</includeonly><noinclude>
+
Vorlagencode
 +
<includeonly>Alle Kategorien, denen die Artikel auf denen die Vorlage eingebettet ist, hinzugefügt werden sollen</includeonly><noinclude>
 
{{documentation}}</noinclude>
 
{{documentation}}</noinclude>
 
</pre>
 
</pre>
  
Note that, depending on the template, you may need to add a clear or complete a table/div just before <code><nowiki>{{documentation}}</nowiki></code> is inserted (within the noinclude tags).
+
Denke daran dass auf manchen Vorlagenseiten (abhängig von der Vorlage) ein <code><nowiki>clear</code></nowiki> hinzugefügt oder eine Tabelle oder ein <code><nowiki><div></code></nowiki> tag geschlossen werden muss.
  
The line break is also useful as it helps prevent the documentation template "running into" previous code.
+
Alternativ kann man auch einen Zeilenumbruch verwenden, um sicherzustellen dass die Dokumentation nicht "zwischen" dem Vorlagencode auf der Artikelseite eingefügt wird.
  
===On the Template/doc page===
+
===Auf der Vorlage/doc Seite===
 
<pre>
 
<pre>
;Description
+
;Beschreibung
:This template is used to do something.
+
:Diese Vorlage macht etwas ganz Tolles.
 
;Syntax
 
;Syntax
:Type <code></code> somewhere.
+
:Schreibe <code></code>.
;Sample output
+
;Vorlagentest
:<code>&lt;nowiki>&lt;/nowiki></code> gives...
+
:<code>&lt;nowiki>&lt;/nowiki></code> produziert...
 
:
 
:
  
<includeonly>Any categories for the template itself</includeonly><noinclude>[[Category:Template documentation|{{PAGENAME}}]]</noinclude>
+
<includeonly>Nur Kategorien für die Vorlage selbst</includeonly><noinclude>[[Category:Template documentation|{{PAGENAME}}]]</noinclude>
 
</pre>
 
</pre>
  
Use any or all of the above description/syntax/sample output sections. You may also want to add "see also" or further usage information sections.
+
Benutze einige oder alle der oben vorgeschlagenen Unterrubriken. Je nach Komplexität der Vorlage empfiehlt es sich auch, mit einer "Siehe auch" Rubrik auf andere ähnliche Vorlagen oder Artikelseiten hinzuweisen.
 
 
Note that the above example also uses the and [[Template:T/piece]] templates.
 
  
 
<includeonly></includeonly><noinclude></noinclude>
 
<includeonly></includeonly><noinclude></noinclude>

Version vom 28. September 2013, 21:21 Uhr

Beschreibung
Diese Vorlage fügt Beschreibungen und Dokumentationen auf Vorlagenseiten ein.
Syntax
Füge <noinclude>{{documentation}}</noinclude> am Ende der Vorlagenseite ein.

Allgemeine Verwendung

Auf der Vorlagenseite

Vorlagencode
<includeonly>Alle Kategorien, denen die Artikel auf denen die Vorlage eingebettet ist, hinzugefügt werden sollen</includeonly><noinclude>
{{documentation}}</noinclude>

Denke daran dass auf manchen Vorlagenseiten (abhängig von der Vorlage) ein clear</code> hinzugefügt oder eine Tabelle oder ein <div></code> tag geschlossen werden muss.

Alternativ kann man auch einen Zeilenumbruch verwenden, um sicherzustellen dass die Dokumentation nicht "zwischen" dem Vorlagencode auf der Artikelseite eingefügt wird.

Auf der Vorlage/doc Seite

;Beschreibung
:Diese Vorlage macht etwas ganz Tolles.
;Syntax
:Schreibe <code></code>.
;Vorlagentest
:<code><nowiki></nowiki></code> produziert...
:

<includeonly>Nur Kategorien für die Vorlage selbst</includeonly><noinclude>[[Category:Template documentation|{{PAGENAME}}]]</noinclude>

Benutze einige oder alle der oben vorgeschlagenen Unterrubriken. Je nach Komplexität der Vorlage empfiehlt es sich auch, mit einer "Siehe auch" Rubrik auf andere ähnliche Vorlagen oder Artikelseiten hinzuweisen.