Cowboy: Neu angelegt

2025-09-14T22:21:43Z

Neu angelegt

Neue Seite

<noinclude>{{Dokumentation/Dokuseite}}</noinclude>
{{TemplateData|JSON=
{{TemplateData/JSON
|Beschreibung=Einzelne '''Parameter'''-Beschreibung für '''[[Hilfe:TemplateData|TemplateData]]''' im [[JavaScript Object Notation|JSON]]-Format generieren
|Parameter=
{{TemplateData/Parameter|1
|Kurz=ID
|Beschreibung=Technischer Parametername, der bevorzugt auch bei Einbindung der Vorlage in den Quelltext eingefügt werden sollte.
|Typ=line
|Pflicht=ja
|Beispiel=Abruf
}}
{{TemplateData/Parameter|label
|Kurz=Kurzname
|Beschreibung=Kurze, eindeutige Klartext-Bezeichnung. Der [[#templatedata:1|technische Parametername]] könnte unverständlich sein. [[Vorlage:TemplateData/I18N|Multilinguale Zeichenkette]].
|Typ=I18N
|Empfohlen=ja
|Beispiel=Das Wort „Kurzname“ hier.
|Vorgabe=Der technische Parametername.
|Aliasse={{TemplateData/Aliasse|Kurz|Label}}
}}
{{TemplateData/Parameter|description
|Kurz=Beschreibung
|Beschreibung=Beschreibung des Parameters; Bedeutung, Formate, erlaubte Werte. [[Vorlage:TemplateData/I18N|Multilinguale Zeichenkette]].
|Typ=I18N
|Empfohlen=ja
|Beispiel=Diese Parameterbeschreibung hier.
|Aliasse={{TemplateData/Aliasse|Beschreibung}}
}}
{{TemplateData/Parameter|type
|Kurz=Typ
|Beschreibung=[[Hilfe:TemplateData/Anwendung#Datentypen|Datentyp]] des Parameters.
|Typ=line
|Empfohlen=ja
|Werte={{TemplateData/Werte
| {{TemplateData/Wert|boolean
|Info=[[Hilfe:TemplateData/Anwendung#boolean|{{int:templatedata-doc-param-type-boolean}}]] (ja/nein)}}
| {{TemplateData/Wert|content
|Info=[[Hilfe:TemplateData/Anwendung#wikitext|{{int:templatedata-doc-param-type-content}}]] ([[Wikitext]])}}
| {{TemplateData/Wert|date
|Info=[[Hilfe:TemplateData/Anwendung#date|{{int:templatedata-doc-param-type-date}}]]}}
| {{TemplateData/Wert|line
|Info=[[Hilfe:TemplateData/Anwendung#line|{{int:templatedata-doc-param-type-line}}]]}}
| {{TemplateData/Wert|number
|Info=[[Hilfe:TemplateData/Anwendung#number|{{int:templatedata-doc-param-type-number}}]] (Zahl)}}
| {{TemplateData/Wert|string
|Info=[[Hilfe:TemplateData/Anwendung#string|{{int:templatedata-doc-param-type-string}}]]}}
| {{TemplateData/Wert|url
|Info=[[Hilfe:TemplateData/Anwendung#url|{{int:templatedata-doc-param-type-url}}]] ([[Uniform Resource Locator]])}}
| {{TemplateData/Wert|wiki-file-name
|Info=[[Hilfe:TemplateData/Anwendung#file|{{int:templatedata-doc-param-type-wiki-file-name}}]] – Bezeichner einer Mediendatei ''ohne'' vorangestelltes <code>Datei:</code>}}
| {{TemplateData/Wert|wiki-page-name
|Info=[[Hilfe:TemplateData/Anwendung#page|{{int:templatedata-doc-param-type-wiki-page-name}}]] (auch in einem anderen Projekt)}}
| {{TemplateData/Wert|wiki-template-name
|Info=[[Hilfe:TemplateData/Anwendung#template|{{int:templatedata-doc-param-type-wiki-template-name}}]] ''ohne'' vorangestelltes <code>Vorlage:</code>}}
| {{TemplateData/Wert|wiki-user-name
|Info=[[Hilfe:TemplateData/Anwendung#user|{{int:templatedata-doc-param-type-wiki-user-name}}]] – Benutzerkonto ''ohne'' vorangestelltes <code>Benutzer:</code>}}
}}
|Beispiel=string
|Vorgabe=unknown
|Aliasse={{TemplateData/Aliasse|Typ}}
}}
{{TemplateData/Parameter|required
|Kurz=Pflicht
|Beschreibung=Parameter ist [[Hilfe:TemplateData/Anwendung#required|erforderlich]] ({{int:templatedata-doc-param-status}}).
|Typ=boolean
|Empfohlen=ja
|Beispiel=1
|Vorgabe=0
|Aliasse={{TemplateData/Aliasse|Pflicht}}
}}
{{TemplateData/Parameter|suggested
|Kurz=Empfohlen
|Beschreibung=Parameter wird im Formular [[Hilfe:TemplateData/Anwendung#suggested|angeboten]] und in den Quelltext eingefügt ({{int:templatedata-doc-param-status}}).
|Typ=boolean
|Empfohlen=ja
|Beispiel=1
|Vorgabe=0
|Aliasse={{TemplateData/Aliasse|Empfohlen|Empfehlung|Vorschlag}}
}}
{{TemplateData/Parameter|suggestedvalues
|Kurz=Werte
|Beschreibung=Vorschläge für Werte, angegeben mittels [[Vorlage:TemplateData/Werte]]
|Typ=string
|Aliasse={{TemplateData/Aliasse|Werte}}
}}
{{TemplateData/Parameter|default
|Kurz=Vorgabe
|Beschreibung=Vorgabewert in der Programmierung, falls bei der Vorlagen-Einbindung nicht angegeben bzw. leer. Nicht bei Pflichtparametern möglich.
|Typ=string
|Aliasse={{TemplateData/Aliasse|Vorgabe|Standard|Default}}
}}
{{TemplateData/Parameter|example
|Kurz=Beispiel
|Beschreibung=Ein charakteristischer Beispielwert. [[Vorlage:TemplateData/I18N|Multilinguale Zeichenkette]].
|Typ=string
|Aliasse={{TemplateData/aliases|Beispiel}}
}}
{{TemplateData/Parameter|autovalue
|Kurz=AutoWert
|Beschreibung=Wird von Werkzeugen in den Quelltext eingefügt, falls nicht explizit ein Wert zugewiesen wurde.
|Typ=string
|Aliasse={{TemplateData/Aliasse|AutoWert|Autowert}}
}}
{{TemplateData/Parameter|deprecated
|Kurz=Veraltet
|Beschreibung=Der Parameter ist veraltet ({{int:templatedata-doc-param-status}}), ggf. weitere Hinweise dazu. <code>boolean</code> oder [[Vorlage:TemplateData/I18N|Multilinguale Zeichenkette]].
|Typ=string
|Aliasse={{TemplateData/Aliasse|Veraltet|Obsolet}}
}}
{{TemplateData/Parameter|aliases
|Kurz=Aliasse
|Beschreibung=Aliasnamen, angegeben mittels [[Vorlage:TemplateData/Aliasse]]. Bevorzugt sollte der [[#templatedata:1|technische Parametername]] verwendet werden; meist handelt es sich bei den Aliasnamen um veraltete Bezeichner, die projektweit eliminiert werden sollen.
|Typ=string
|Beispiel=Nebenstehend: „Aliasse“ und „Alias“
|Aliasse={{TemplateData/Aliasse|Aliasse|Alias}}
}}
{{TemplateData/Parameter|inherits
|Kurz=Geerbt
|Beschreibung=Nicht explizite Angaben sollen von einem anderen Parameter übernommen werden. Dieser [[#templatedata:1|technische Parametername]] ist anzugeben.
|Typ=line
|Aliasse={{TemplateData/Aliasse|Geerbt|Erbt}}
}}
{{TemplateData/Parameter|style
|Kurz=CSS
|Beschreibung=[[Cascading Style Sheets|CSS]]-Definitionen zur Gestaltung dieser Parameterbeschreibung (keine Wirkung auf die Einbindung).
|Typ=string
}}
|Format=block
}}
|TOC=1}}

== Kopiervorlage ==
<syntaxhighlight lang="wikitext" copy>
{{TemplateData/Parameter
|
|Kurz=
|Beschreibung=
|Typ=
|Pflicht=
|Empfohlen=
|Vorgabe=
|Beispiel=
|AutoWert=
|Veraltet=
|Aliasse=
|Geerbt=
|style=
}}
</syntaxhighlight>

== Beispiel ==
{{#tag:pre|
{{TemplateData/Parameter
{{!}}Abruf
{{!}}Kurz=Abrufdatum
{{!}}Beschreibung=Abrufdatum im Format <code>JJJJ-MM-TT</code>
{{!}}Typ=date
{{!}}Pflicht=nein
{{!}}Empfohlen=ja
{{!}}Beispiel={{#time:Y-m-d}}
}}
}}

Dazu auch
* Beispiel im Kontext von: <code>{{[[Vorlage:TemplateData/JSON#Beispiel |TemplateData/JSON]]}}</code>
* Quelltext dieser Dokumentationsseite, der die Methodik nutzt.

== Siehe auch ==
* [[Hilfe:TemplateData/JSON]] – Beschreibung der generellen Syntax in [[JavaScript Object Notation|JSON]]
* [[Vorlage:TemplateData/JSON]] – übergeordnete Vorlage, von der diese Untervorlage eingebunden wird
* [[Vorlage:TemplateData/param]] – internationalisierte Form dieser Vorlage
<includeonly>
{{Dokumentation/Lua|JSONutil #encodeComponent}}

[[Kategorie:Vorlage:Vorlagendokumentation/TemplateData|Parameter]]
</includeonly>

Vorlage:TemplateData/Parameter/Doku - Versionsgeschichte

Cowboy: Neu angelegt