Vorlog:TemplateData/Parameter
fatal JSON error: mw.text.jsonDecode: Syntax-Fehler
{ "description": "Einzelne '''Parameter'''-Beschreibung für '''TemplateData''' im JSON-Format generieren",
"params":
{
"1":
{
"label": "ID",
"description": "Technischer Parametername, der bevorzugt auch bei Einbindung der Vorlage in den Quelltext eingefügt werden sollte.",
"type": "line",
"required": true,
"example": "Abruf"
},
"label":
{
"label": "Kurzname",
"description": "Kurze, eindeutige Klartext-Bezeichnung. Der technische Parametername könnte unverständlich sein. Multilinguale Zeichenkette.",
"type": "string",
"suggested": true,
"default": "Der technische Parametername.",
"example": "Das Wort „Kurzname“ hier.",
"aliases": [ "Kurz",
"Label" ]
},
"description":
{
"label": "Beschreibung",
"description": "Beschreibung des Parameters; Bedeutung, Formate, erlaubte Werte. Multilinguale Zeichenkette.",
"type": "string",
"suggested": true,
"example": "Diese Parameterbeschreibung hier.",
"aliases": [ "Beschreibung" ]
},
"type":
{
"label": "Typ",
"description": "Datentyp des Parameters.",
"type": "line",
"suggested": true,
"suggestedvalues": Vorlog:TemplateData/Werte,
"default": "unknown",
"example": "string",
"aliases": [ "Typ" ]
},
"required":
{
"label": "Pflicht",
"description": "Parameter ist erforderlich (Status).",
"type": "boolean",
"suggested": true,
"default": "0",
"example": "1",
"aliases": [ "Pflicht" ]
},
"suggested":
{
"label": "Empfohlen",
"description": "Parameter wird im Formular angeboten und in den Quelltext eingefügt (Status).",
"type": "boolean",
"suggested": true,
"default": "0",
"example": "1",
"aliases": [ "Empfohlen",
"Empfehlung",
"Vorschlag" ]
},
"suggestedvalues":
{
"label": "Werte",
"description": "Vorschläge für Werte, angegeben mittels Vorlage:TemplateData/Werte",
"type": "string",
"aliases": [ "Werte" ]
},
"default":
{
"label": "Vorgabe",
"description": "Vorgabewert in der Programmierung, falls bei der Vorlagen-Einbindung nicht angegeben bzw. leer. Nicht bei Pflichtparametern möglich.",
"type": "string",
"aliases": [ "Vorgabe",
"Standard",
"Default" ]
},
"example":
{
"label": "Beispiel",
"description": "Ein charakteristischer Beispielwert. Multilinguale Zeichenkette.",
"type": "string",
"aliases": Vorlog:TemplateData/aliases
},
"autovalue":
{
"label": "AutoWert",
"description": "Wird von Werkzeugen in den Quelltext eingefügt, falls nicht explizit ein Wert zugewiesen wurde.",
"type": "string",
"aliases": [ "AutoWert",
"Autowert" ]
},
"deprecated":
{
"label": "Veraltet",
"description": "Der Parameter ist veraltet (Status), ggf. weitere Hinweise dazu. <code>boolean</code> oder Multilinguale Zeichenkette.",
"type": "string",
"aliases": [ "Veraltet",
"Obsolet" ]
},
"aliases":
{
"label": "Aliasse",
"description": "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.",
"type": "string",
"example": "Nebenstehend: „Aliasse“ und „Alias“",
"aliases": [ "Aliasse",
"Alias" ]
},
"inherits":
{
"label": "Geerbt",
"description": "Nicht explizite Angaben sollen von einem anderen Parameter übernommen werden. Dieser technische Parametername ist anzugeben.",
"type": "line",
"aliases": [ "Geerbt",
"Erbt" ]
},
"style":
{
"label": "CSS",
"description": "CSS-Definitionen zur Gestaltung dieser Parameterbeschreibung (keine Wirkung auf die Einbindung).",
"type": "string"
}
},
"format": "block"
}
Kopiervorlage
Werkeln{{TemplateData/Parameter
|
|Kurz=
|Beschreibung=
|Typ=
|Pflicht=
|Empfohlen=
|Vorgabe=
|Beispiel=
|AutoWert=
|Veraltet=
|Aliasse=
|Geerbt=
|style=
}}
Beispiel
Werkeln{{TemplateData/Parameter
|Abruf
|Kurz=Abrufdatum
|Beschreibung=Abrufdatum im Format <code>JJJJ-MM-TT</code>
|Typ=date
|Pflicht=nein
|Empfohlen=ja
|Beispiel=2024-10-26
}}
Dazu auch
- Beispiel im Kontext von:
{{TemplateData/JSON}} - Quelltext dieser Dokumentationsseite, der die Methodik nutzt.
Schau aa
Werkeln- 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