Vorlage:TemplateData/Parameter/Doku
Zur Navigation springen
Zur Suche springen
Diese Seite ist die Dokumentations-Unterseite der Vorlage:TemplateData/Parameter.
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.
| Einzeiliger Text | erforderlich |
Kurzname | label Kurz Label | Kurze, eindeutige Klartext-Bezeichnung. Der technische Parametername könnte unverständlich sein. Multilinguale Zeichenkette.
| Mehrzeiliger Text | vorgeschlagen |
Beschreibung | description Beschreibung | Beschreibung des Parameters; Bedeutung, Formate, erlaubte Werte. Multilinguale Zeichenkette.
| Mehrzeiliger Text | vorgeschlagen |
Typ | type Typ | Datentyp des Parameters.
| Einzeiliger Text | vorgeschlagen |
Pflicht | required Pflicht | Parameter ist erforderlich (Status).
| Wahrheitswert | vorgeschlagen |
Empfohlen | suggested Empfohlen Empfehlung Vorschlag | Parameter wird im Formular angeboten und in den Quelltext eingefügt (Status).
| 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.
| 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
[Quelltext bearbeiten]{{TemplateData/Parameter | |Kurz= |Beschreibung= |Typ= |Pflicht= |Empfohlen= |Vorgabe= |Beispiel= |AutoWert= |Veraltet= |Aliasse= |Geerbt= |style= }}
Beispiel
[Quelltext bearbeiten]{{TemplateData/Parameter |Abruf |Kurz=Abrufdatum |Beschreibung=Abrufdatum im Format <code>JJJJ-MM-TT</code> |Typ=date |Pflicht=nein |Empfohlen=ja |Beispiel=2024-10-23 }}
Dazu auch
- Beispiel im Kontext von:
{{TemplateData/JSON}}
- Quelltext dieser Dokumentationsseite, der die Methodik nutzt.
Siehe auch
[Quelltext bearbeiten]- 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