Vorlage:Docparam/doc

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