Vorlage:Docparam/doc: Unterschied zwischen den Versionen

Hilfe

Aktuelle Version vom 26. Juni 2024, 22:30 Uhr

Diese Seite enthält Informationen zur Verwendung für Vorlage:Docparam.

Vorlage für die standardisierte Formatierung von Vorlagen-Parametern in Vorlagen-Dokumentation.

Verwendung

{{Docparam|name=Parameter|req=yes|desc=Beschreibung}}

Parameter

<unbenannt1> oder name

Name des/der Parameter. Bestimmte Zeichen werden automatisch übersetzt, um alternative Optionen oder Parameterbereiche festzulegen.

Übersetzte Zeichenfolgen (diese müssen von Leerzeichen umschlossen sein):

>> wird umgewandelt in " bis "; wird verwendet, um Parameterbereiche anzugeben (z. B. "spiel1 bis spiel5").
// wird umgewandelt in " oder "; verwendet für alternative Auswahl (z. B. "<unbenannt1> oder Name").
++ wird umgewandelt in ", " (ein Komma mit einem nachgestellten Leerzeichen);
verwendet für die Auflistung von Parametern, die verschieden sind, sich aber gleich auswirken (z. B. "inhaltA1, inhaltB1").

default, default2

Standardwert(e) des Parameters.

desc

Beschreibung des Parameters

(Standard: "yes")

req

Gibt an, ob dieser Parameter für die Funktion der Vorlage erforderlich ist.

Verfügbare Optionen:

no: Völlig optional.
semi: Parameter ist unter bestimmten Umständen erforderlich, in anderen jedoch optional.

Für eine Reihe von Parametern (festgelegt durch bis , bedeutet dies, dass mindestens einer von ihnen erforderlich ist.

yes: Immer notwendig.

Kopiervorlage

{{Docparam|name=|req=|default=|desc=

}}

Beispiele

Einfach

{{Docparam|name=parameter|req=yes|default=|desc=
Beschreibung
}}

ergibt

parameter

Beschreibung

Erweitert

{{Docparam|name=parameter // alternative ++ ähnlich1 >> ähnlich3|req=no|default=Voreinstellung|desc=
Beschreibung
}}

ergibt

(Standard: "Voreinstellung")

parameter oder alternative, ähnlich1 bis ähnlich3

Beschreibung

@@ Zeile 1: / Zeile 1: @@
-<noinclude>{{Documentationpage}}</noinclude>
+<noinclude>{{Dokumentationsseite}}</noinclude>
-Template for standardized formatting of template parameters in [[:Category:Template documentation|template documentation]].
+Vorlage für die standardisierte Formatierung von Vorlagen-Parametern in [[:Kategorie:Dokumentation|Vorlagen-Dokumentation]].
-==Usage==
+== Verwendung ==
-<pre>{{Docparam|name=parameter|req=yes|desc=description}}</pre>
+<pre>{{Docparam|name=Parameter|req=yes|desc=Beschreibung}}</pre>
-===Parameters===
+=== Parameter ===
-{{Docparam|name=<unnamed 1> // name|req=yes|default=|desc=
+{{Docparam|name=&lt;unbenannt1> // name|req=yes|default=|desc=
-Name of the parameter(s). Certain strings are automatically translated to allow for specification of alternative choices or parameter ranges.
+Name des/der Parameter. Bestimmte Zeichen werden automatisch übersetzt, um alternative Optionen oder Parameterbereiche festzulegen.
-Translated strings (all of these need to be enclosed by spaces):
+Übersetzte Zeichenfolgen (diese müssen von Leerzeichen umschlossen sein):
-* <code>>></code> is converted to a dash with spaces around it (" - "); used to indicate parameter ranges (e.g. "game1 - game5").
+* <code>>></code> wird umgewandelt in "<code> bis </code>"; wird verwendet, um Parameterbereiche anzugeben (z. B. "spiel1 bis spiel5").
-* <code>//</code> is converted to " or "; used for alternative choices (e.g. "<unnamed 1> or title").
+* <code>//</code> wird umgewandelt in "<code> oder </code>"; verwendet für alternative Auswahl (z. B. "&lt;unbenannt1> oder Name").
-* <code>++</code> is converted to a comma with a trailing space (", "); used for listing parameters which are separate but work the same (e.g. "contentA1, contentB1").
+* <code>++</code> wird umgewandelt in "<code>, </code>" (ein Komma mit einem nachgestellten Leerzeichen);<br />verwendet für die Auflistung von Parametern, die verschieden sind, sich aber gleich auswirken (z. B. "inhaltA1, inhaltB1").
 }}
 {{Docparam|name=default ++ default2|req=no|default=|desc=
-The default value(s) of the parameter.
+Standardwert(e) des Parameters.
 }}
 {{Docparam|name=desc|req=yes|default=|desc=
-Description of the parameter.
+Beschreibung des Parameters
 }}
 {{Docparam|name=req|req=semi|default=yes|desc=
-Specifies whether this parameter is required for the template to function.
+Gibt an, ob dieser Parameter für die Funktion der Vorlage erforderlich ist.
-Available options:
+Verfügbare Optionen:
-*''no'': Completely optional.
+*''no'': Völlig optional.
-*''semi'': Parameter is required in certain circumstances but optional in others. For a range of parameters (set via <code>up to</code>, this means that at least one of them is required.
+*''semi'': Parameter ist unter bestimmten Umständen erforderlich, in anderen jedoch optional.
-*''yes'': Always required.
+:: Für eine Reihe von Parametern (festgelegt durch <code> bis </code>, bedeutet dies, dass mindestens einer von ihnen erforderlich ist.
+*''yes'': Immer notwendig.
 }}
-==Copy/paste==
+== Kopiervorlage ==
 <pre>
 {{Docparam|name=|req=|default=|desc=
@@ Zeile 39: / Zeile 40: @@
 </pre>
-==Examples==
+== Beispiele ==
-===Simple===
+=== Einfach ===
 <pre>
 {{Docparam|name=parameter|req=yes|default=|desc=
-Description
+Beschreibung
 }}
 </pre>
-results in:
+;ergibt:
 {{Docparam|name=parameter|req=yes|default=|desc=
-Description
+Beschreibung
 }}
-===Advanced===
+=== Erweitert ===
 <pre>
-{{Docparam|name=parameter // alternative ++ similar1 >> similar3|req=no|default=default setting|desc=
+{{Docparam|name=parameter // alternative ++ ähnlich1 >> ähnlich3|req=no|default=Voreinstellung|desc=
-Description
+Beschreibung
 }}
 </pre>
-results in:
+;ergibt
-{{Docparam|name=parameter // alternative ++ similar1 >> similar3|req=no|default=default setting|desc=
+{{Docparam|name=parameter // alternative ++ ähnlich1 >> ähnlich3|req=no|default=Voreinstellung|desc=
-Description
+Beschreibung
 }}
+<includeonly>
+<!--  Please place categories and interwiki links for the template at this position -->
+[[Kategorie:Vorlagen: Formatierung|Docparam]]
+[[en:Template:Docparam]]
+[[fr:Modèle:Docparam]]
+[[ja:Template:Docparam]]
+[[ru:Шаблон:Docparam]]
+</includeonly>