Dokumentation

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

Vorlagenparameter

Parameter		Beschreibung	Typ	Status
ID	`1`	Technischer Parametername, der bevorzugt auch bei Einbindung der Vorlage in den Quelltext eingefügt werden sollte. Beispiel Abruf	Einzeiliger Text	erforderlich
Kurzname	`label` Kurz Label	Kurze, eindeutige Klartext-Bezeichnung. Der technische Parametername könnte unverständlich sein. Multilinguale Zeichenkette. Standard Der technische Parametername. Beispiel Das Wort „Kurzname“ hier.	Mehrzeiliger Text	vorgeschlagen
Beschreibung	`description` Beschreibung	Beschreibung des Parameters; Bedeutung, Formate, erlaubte Werte. Multilinguale Zeichenkette. Beispiel Diese Parameterbeschreibung hier.	Mehrzeiliger Text	vorgeschlagen
Typ	`type` Typ	Datentyp des Parameters. Vorgeschlagene Werte `boolean`–Wahrheitswert (ja/nein) `content`–Wikitext (Wikitext) `date`–Datum `line`–Einzeiliger Text `number`–Zahlenwert (Zahl) `string`–Mehrzeiliger Text `url`–URL (Uniform Resource Locator) `wiki-file-name`–Datei – Bezeichner einer Mediendatei ohne vorangestelltes `Datei:` `wiki-page-name`–Seitenname (auch in einem anderen Projekt) `wiki-template-name`–Vorlage ohne vorangestelltes `Vorlage:` `wiki-user-name`–Benutzer – Benutzerkonto ohne vorangestelltes `Benutzer:` Standard unknown Beispiel string	Einzeiliger Text	vorgeschlagen
Pflicht	`required` Pflicht	Parameter ist erforderlich (Status). Standard `0` Beispiel `1`	Wahrheitswert	vorgeschlagen
Empfohlen	`suggested` Empfohlen Empfehlung Vorschlag	Parameter wird im Formular angeboten und in den Quelltext eingefügt (Status). Standard `0` Beispiel `1`	Wahrheitswert	vorgeschlagen
Werte	`suggestedvalues` Werte	Vorschläge für Werte, angegeben mittels Vorlage:TemplateData/Werte	Mehrzeiliger Text	optional
Vorgabe	`default` Vorgabe Standard Default	Vorgabewert in der Programmierung, falls bei der Vorlagen-Einbindung nicht angegeben bzw. leer. Nicht bei Pflichtparametern möglich.	Mehrzeiliger Text	optional
Beispiel	`example` Beispiel	Ein charakteristischer Beispielwert. Multilinguale Zeichenkette.	Mehrzeiliger Text	optional
AutoWert	`autovalue` AutoWert Autowert	Wird von Werkzeugen in den Quelltext eingefügt, falls nicht explizit ein Wert zugewiesen wurde.	Mehrzeiliger Text	optional
Veraltet	`deprecated` Veraltet Obsolet	Der Parameter ist veraltet (Status), ggf. weitere Hinweise dazu. `boolean` oder Multilinguale Zeichenkette.	Mehrzeiliger Text	optional
Aliasse	`aliases` Aliasse Alias	Aliasnamen, angegeben mittels Vorlage:TemplateData/Aliasse. Bevorzugt sollte der technische Parametername verwendet werden; meist handelt es sich bei den Aliasnamen um veraltete Bezeichner, die projektweit eliminiert werden sollen. Beispiel Nebenstehend: „Aliasse“ und „Alias“	Mehrzeiliger Text	optional
Geerbt	`inherits` Geerbt Erbt	Nicht explizite Angaben sollen von einem anderen Parameter übernommen werden. Dieser technische Parametername ist anzugeben.	Einzeiliger Text	optional
CSS	`style`	CSS-Definitionen zur Gestaltung dieser Parameterbeschreibung (keine Wirkung auf die Einbindung).	Mehrzeiliger Text	optional

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 Abruf	Einzeiliger Text	erforderlich
Kurzname	`label` `Kurz` `Label`	Kurze, eindeutige Klartext-Bezeichnung. Der technische Parametername könnte unverständlich sein. Multilinguale Zeichenkette. Standard Der technische Parametername. Beispiel Das Wort „Kurzname“ hier.	Mehrzeiliger Text	vorgeschlagen
Beschreibung	`description` `Beschreibung`	Beschreibung des Parameters; Bedeutung, Formate, erlaubte Werte. Multilinguale Zeichenkette. Beispiel Diese Parameterbeschreibung hier.	Mehrzeiliger Text	vorgeschlagen
Typ	`type` `Typ`	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	Einzeiliger Text	vorgeschlagen
Pflicht	`required` `Pflicht`	Parameter ist erforderlich (Status). Standard 0 Beispiel 1	Wahrheitswert	vorgeschlagen
Empfohlen	`suggested` `Empfohlen` `Empfehlung` `Vorschlag`	Parameter wird im Formular angeboten und in den Quelltext eingefügt (Status). Standard 0 Beispiel 1	Wahrheitswert	vorgeschlagen
Werte	`suggestedvalues` `Werte`	Vorschläge für Werte, angegeben mittels Vorlage:TemplateData/Werte	Mehrzeiliger Text	optional
Vorgabe	`default` `Vorgabe` `Standard` `Default`	Vorgabewert in der Programmierung, falls bei der Vorlagen-Einbindung nicht angegeben bzw. leer. Nicht bei Pflichtparametern möglich.	Mehrzeiliger Text	optional
Beispiel	`example` `Beispiel`	Ein charakteristischer Beispielwert. Multilinguale Zeichenkette.	Mehrzeiliger Text	optional
AutoWert	`autovalue` `AutoWert` `Autowert`	Wird von Werkzeugen in den Quelltext eingefügt, falls nicht explizit ein Wert zugewiesen wurde.	Mehrzeiliger Text	optional
Veraltet	`deprecated` `Veraltet` `Obsolet`	Der Parameter ist veraltet (Status), ggf. weitere Hinweise dazu. boolean oder Multilinguale Zeichenkette.	Mehrzeiliger Text	optional
Aliasse	`aliases` `Aliasse` `Alias`	Aliasnamen, angegeben mittels Vorlage:TemplateData/Aliasse. Bevorzugt sollte der technische Parametername verwendet werden; meist handelt es sich bei den Aliasnamen um veraltete Bezeichner, die projektweit eliminiert werden sollen. Beispiel Nebenstehend: „Aliasse“ und „Alias“	Mehrzeiliger Text	optional
Geerbt	`inherits` `Geerbt` `Erbt`	Nicht explizite Angaben sollen von einem anderen Parameter übernommen werden. Dieser technische Parametername ist anzugeben.	Einzeiliger Text	optional
CSS	`style`	CSS-Definitionen zur Gestaltung dieser Parameterbeschreibung (keine Wirkung auf die Einbindung).	Mehrzeiliger Text	optional

Kopiervorlage

{{TemplateData/Parameter
|
|Kurz=
|Beschreibung=
|Typ=
|Pflicht=
|Empfohlen=
|Vorgabe=
|Beispiel=
|AutoWert=
|Veraltet=
|Aliasse=
|Geerbt=
|style=
}}

Beispiel

{{TemplateData/Parameter
|Abruf
|Kurz=Abrufdatum
|Beschreibung=Abrufdatum im Format <code>JJJJ-MM-TT</code>
|Typ=date
|Pflicht=nein
|Empfohlen=ja
|Beispiel=2024-11-22
}}

Dazu auch

Beispiel im Kontext von: {{TemplateData/JSON}}
Quelltext dieser Dokumentationsseite, der die Methodik nutzt.

Siehe auch

Hilfe:TemplateData/JSON – Beschreibung der generellen Syntax in JSON
Vorlage:TemplateData/JSON – übergeordnete Vorlage, von der diese Untervorlage eingebunden wird
Vorlage:TemplateData/param – internationalisierte Form dieser Vorlage

Lua

	Diese Vorlage wurde ganz oder teilweise mit Hilfe der Programmiersprache Lua erstellt.
	Die Module sind mit `#invoke` eingebunden. In der Dokumentation der einzelnen Module finden sich auch weitere Hinweise zu Rückfragen.

Verwendetes Modul:

JSONutil #encodeComponent

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).

Vorlage:TemplateData/Parameter