Vorlage:TemplateData/param

[Werkzeuge][Bearbeiten]

Dokumentation

TemplateData

Einzelne Parameter-Beschreibung für TemplateData im JSON-Format generieren

• en
  Generate single parameter description for TemplateData as JSON source code

Vorlagenparameter

Parameter		Beschreibung	Typ	Status
ID	1	Technischer Parametername, der bevorzugt auch bei Einbindung der Vorlage in den Quelltext eingefügt werden sollte. en Parameter name used for programming. Beispiel Aufzug	Zeile	erforderlich
Kurzname	label	Kurze, eindeutige Klartext-Bezeichnung. Der technische Parametername könnte unverständlich sein. Multilinguale Zeichenkette. en Short and unique name for the parameter. The parameter name used for programming might be cryptic. Multilingual text. Standard Der technische Parametername. Beispiel Das Wort „Kurzname“ hier.	Zeichenfolge	vorgeschlagen
Beschreibung	description	Beschreibung des Parameters; Bedeutung, Formate, erlaubte Werte. Multilinguale Zeichenkette. en Description of the parameter; meaning, requested format, permitted values. Beispiel Diese Parameterbeschreibung hier.	Zeichenfolge	vorgeschlagen
Typ	type	Datentyp des Parameters en Data type of the parameter Vorgeschlagene Werte boolean–Boolesch (ja/nein) content–Inhalt (Wikitext) date–Datum line–Zeile number–Nummer (Zahl) string–Zeichenfolge url–URL (Uniform Resource Locator) wiki-file-name–Bezeichner einer Mediendate ohne vorangestelltes Datei: wiki-page-name–Seitenname (auch in einem anderen Projekt) wiki-template-name–Vorlage ohne vorangestelltes Vorlage: wiki-user-name–Nick ohne vorangestelltes Benutzer: Standard unknown Beispiel string	Zeile	vorgeschlagen
Pflicht	required	Parameter ist erforderlich (Status). en Parameter is necessary for functionality and must not use a default value. Standard 0 ☐ Beispiel 1 ☑	Boolesch	vorgeschlagen
Empfohlen	suggested	Parameter wird im Formular angeboten und in den Quelltext eingefügt (Status). en Parameter will be offered in form and parameter name will be inserted into source text (Status). Standard 0 ☐ Beispiel 1 ☑	Boolesch	vorgeschlagen
Vorgeschlagene Werte	suggestedvalues	Vorgeschlagene Werte, angegeben mittels Template:TemplateData/suggestedvalues. en Suggested values, to be provided by Template:TemplateData/suggestedvalues.	Zeichenfolge	optional
Vorgabe	default	Vorgabewert in der Programmierung, falls bei der Vorlagen-Einbindung nicht angegeben bzw. leer. Nicht bei Pflichtparametern möglich. en Standard value assumed in programming if not specified in transclusion or empty. Must not be used with required parameters.	Zeichenfolge	optional
Beispiel	example	Ein charakteristischer Beispielwert. Multilinguale Zeichenkette. en One typical example value.	Zeichenfolge	optional
AutoWert	autovalue	Wird von Werkzeugen in den Quelltext eingefügt, falls nicht explizit ein Wert zugewiesen wurde. en Will be inserted into source text if no value has been provided.	Zeichenfolge	optional
Veraltet	deprecated	Der Parameter ist veraltet (Status), ggf. weitere Hinweise dazu. boolean oder Multilinguale Zeichenkette. en This parameter is obsolete (Status), perhaps more information about. boolean or multilingual text.	Zeichenfolge	optional
Aliasse	aliases	Aliasnamen, angegeben mittels Template:TemplateData/aliases. en Alias names, to be provided by Template:TemplateData/aliases. Beispiel Fahrstuhl	Zeichenfolge	optional
Geerbt	inherits	Nicht explizite Angaben sollen von einem anderen Parameter übernommen werden. Dieser technische Parametername ist anzugeben. en Not explicitly specified information shall be taken from another parameter. That name used for programming is to be provided.	Zeile	optional
CSS	style	CSS-Definitionen zur Gestaltung dieser Parameterbeschreibung (keine Wirkung auf die Einbindung). en CSS definitions for presentation of this documentation without any effect on transclusion.	Zeichenfolge	optional

Format: block

Einzelne Parameter-Beschreibung für TemplateData im JSON-Format generieren

Vorlagenparameter

Diese Vorlage bevorzugt Blockformatierung von Parametern.

Parameter		Beschreibung	Typ	Status
ID	1	Technischer Parametername, der bevorzugt auch bei Einbindung der Vorlage in den Quelltext eingefügt werden sollte. Beispiel Aufzug	Zeile	erforderlich
Kurzname	label	Kurze, eindeutige Klartext-Bezeichnung. Der technische Parametername könnte unverständlich sein. Multilinguale Zeichenkette. Standard Der technische Parametername. Beispiel Das Wort „Kurzname“ hier.	Zeichenfolge	vorgeschlagen
Beschreibung	description	Beschreibung des Parameters; Bedeutung, Formate, erlaubte Werte. Multilinguale Zeichenkette. Beispiel Diese Parameterbeschreibung hier.	Zeichenfolge	vorgeschlagen
Typ	type	Datentyp des Parameters Vorgeschlagene Werte boolean content date line number string url wiki-file-name wiki-page-name wiki-template-name wiki-user-name Standard unknown Beispiel string	Zeile	vorgeschlagen
Pflicht	required	Parameter ist erforderlich (Status). Standard 0 Beispiel 1	Boolesch	vorgeschlagen
Empfohlen	suggested	Parameter wird im Formular angeboten und in den Quelltext eingefügt (Status). Standard 0 Beispiel 1	Boolesch	vorgeschlagen
Vorgeschlagene Werte	suggestedvalues	Vorgeschlagene Werte, angegeben mittels Template:TemplateData/suggestedvalues.	Zeichenfolge	optional
Vorgabe	default	Vorgabewert in der Programmierung, falls bei der Vorlagen-Einbindung nicht angegeben bzw. leer. Nicht bei Pflichtparametern möglich.	Zeichenfolge	optional
Beispiel	example	Ein charakteristischer Beispielwert. Multilinguale Zeichenkette.	Zeichenfolge	optional
AutoWert	autovalue	Wird von Werkzeugen in den Quelltext eingefügt, falls nicht explizit ein Wert zugewiesen wurde.	Zeichenfolge	optional
Veraltet	deprecated	Der Parameter ist veraltet (Status), ggf. weitere Hinweise dazu. boolean oder Multilinguale Zeichenkette.	Zeichenfolge	optional
Aliasse	aliases	Aliasnamen, angegeben mittels Template:TemplateData/aliases. Beispiel Fahrstuhl	Zeichenfolge	optional
Geerbt	inherits	Nicht explizite Angaben sollen von einem anderen Parameter übernommen werden. Dieser technische Parametername ist anzugeben.	Zeile	optional
CSS	style	CSS-Definitionen zur Gestaltung dieser Parameterbeschreibung (keine Wirkung auf die Einbindung).	Zeichenfolge	optional

Kopiervorlage

{{TemplateData/param
|
|label=
|description=
|type=
|required=
|suggested=
|suggestedvalues=
|default=
|example=
|autovalue=
|deprecated=
|aliases=
|inherits=
|style=
}}

Beispiel

{{TemplateData/param
|lift
|label=Lift
|description=Number and model of lift systems
|type=content
|required=0
|suggested=1
|example=1 Otis
}}

Siehe auch

• Hilfe:TemplateData/JSON – Beschreibung der generellen Syntax in JSON
• Vorlage:TemplateData/json – übergeordnete Vorlage, von der diese Untervorlage eingebunden wird
• Vorlage:TemplateData/Parameter – lokalisierte Form dieser Vorlage

Werkzeuge

Bei technischen Fragen zu dieser Vorlage kannst du dich auch an die Vorlagenwerkstatt wenden. Inhaltliche Fragen und Vorschläge gehören zunächst auf die Diskussionsseite. Sie können ggf. auch an eine passende Redaktion, Portal usw. gerichtet werden.

• Verwendungen dieser Vorlage
• Cirrus-Suche zu Einbindungen dieser Vorlage (zunächst nur ANR) mit weiteren Möglichkeiten
• Anzahl der Einbindungen
• Liste der Unterseiten.
• Diese Dokumentation befindet sich auf einer eingebundenen Unterseite [Bearbeiten].
• Test-/Beispielseite erstellen.
• giftbot/vorlagenparser: CSV herunterladen (ANR).