Vorlage:TemplateData/Parameter

Aus Cowboy’s Wiki
Zur Navigation springen Zur Suche springen


Dokumentation

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": Vorlage:TemplateData/Aliasse
      },
   
     "description":
          { 
       "label": "Beschreibung",
       "description": "Beschreibung des Parameters; Bedeutung, Formate, erlaubte Werte. Multilinguale Zeichenkette.",
       "type": "string",
       "suggested": true,
       "example": "Diese Parameterbeschreibung hier.",
       "aliases": Vorlage:TemplateData/Aliasse
      },
   
     "type":
          { 
       "label": "Typ",
       "description": "Datentyp des Parameters.<noexport><br /> Einer von:\n* <code>boolean</code> – Boolesch (ja/nein)\n* <code>content</code> – Inhalt (Wikitext)\n* <code>date</code> – Datum\n* <code>line</code> – Zeile\n* <code>number</code> – Nummer (Zahl)\n* <code>string</code> – Zeichenfolge\n* <code>url</code> – URL\n* <code style='white-space:nowrap'>wiki-file-name</code> – Bezeichner einer Mediendatei ''ohne'' vorangestelltes <code>Datei:</code>\n* <code style='white-space:nowrap'>wiki-page-name</code> – Seitenname (auch in einem anderen Projekt)\n* <code style='white-space:nowrap'>wiki-template-name</code> – Vorlage ''ohne'' vorangestelltes <code>Vorlage:</code>\n* <code style='white-space:nowrap'>wiki-user-name</code> – Benutzername ''ohne'' vorangestelltes <code>Benutzer:</code>\n<div style='clear:both'></div></noexport>",
       "type": "line",
       "suggested": true,
       "default": "unknown",
       "example": "string",
       "aliases": Vorlage:TemplateData/Aliasse
      },
   
     "required":
          { 
       "label": "Pflicht",
       "description": "Parameter ist erforderlich (Status).",
       "type": "boolean",
       "suggested": true,
       "default": "0",
       "example": "1",
       "aliases": Vorlage:TemplateData/Aliasse
      },
   
     "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": Vorlage:TemplateData/Aliasse
      },
   
     "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": Vorlage:TemplateData/Aliasse
      },
   
     "example":
          { 
       "label": "Beispiel",
       "description": "Ein charakteristischer Beispielwert. Multilinguale Zeichenkette.",
       "type": "string",
       "aliases": Vorlage:TemplateData/Aliasse
      },
   
     "autovalue":
          { 
       "label": "AutoWert",
       "description": "Wird von Werkzeugen in den Quelltext eingefügt, falls nicht explizit ein Wert zugewiesen wurde.",
       "type": "string",
       "aliases": Vorlage:TemplateData/Aliasse
      },
   
     "deprecated":
          { 
       "label": "Veraltet",
       "description": "Der Parameter ist veraltet (Status), ggf. weitere Hinweise dazu. <code>boolean</code> oder Multilinguale Zeichenkette.",
       "type": "string",
       "aliases": Vorlage:TemplateData/Aliasse
      },
   
     "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": Vorlage:TemplateData/Aliasse
      },
   
     "inherits":
          { 
       "label": "Geerbt",
       "description": "Nicht explizite Angaben sollen von einem anderen Parameter übernommen werden. Dieser technische Parametername ist anzugeben.",
       "type": "line",
       "aliases": Vorlage:TemplateData/Aliasse
      },
   
     "style":
          { 
       "label": "CSS",
       "description": "CSS-Definitionen zur Gestaltung dieser Parameterbeschreibung (keine Wirkung auf die Einbindung).",
       "type": "string"
      }
},
  "format": "block"
}

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=2021-09-19
}}

Dazu auch

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

Siehe auch

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.