Vorlage:TemplateData/param
Zur Navigation springen
Zur Suche springen
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.
| Einzeiliger Text | erforderlich |
Kurzname | label | Kurze, eindeutige Klartext-Bezeichnung. Der technische Parametername könnte unverständlich sein. Multilinguale Zeichenkette.
| Mehrzeiliger Text | vorgeschlagen |
Beschreibung | description | Beschreibung des Parameters; Bedeutung, Formate, erlaubte Werte. Multilinguale Zeichenkette.
| Mehrzeiliger Text | vorgeschlagen |
Typ | type | Datentyp des Parameters
| Einzeiliger Text | vorgeschlagen |
Pflicht | required | Parameter ist erforderlich (Status).
| Wahrheitswert | vorgeschlagen |
Empfohlen | suggested | Parameter wird im Formular angeboten und in den Quelltext eingefügt (Status).
| Wahrheitswert | vorgeschlagen |
Vorgeschlagene Werte | suggestedvalues | Vorgeschlagene Werte, angegeben mittels Template:TemplateData/suggestedvalues. | Mehrzeiliger Text | optional |
Vorgabe | default | Vorgabewert in der Programmierung, falls bei der Vorlagen-Einbindung nicht angegeben bzw. leer. Nicht bei Pflichtparametern möglich. | Mehrzeiliger Text | optional |
Beispiel | example | Ein charakteristischer Beispielwert. Multilinguale Zeichenkette. | Mehrzeiliger Text | optional |
AutoWert | autovalue | Wird von Werkzeugen in den Quelltext eingefügt, falls nicht explizit ein Wert zugewiesen wurde. | Mehrzeiliger Text | optional |
Veraltet | deprecated | Der Parameter ist veraltet (Status), ggf. weitere Hinweise dazu. boolean oder Multilinguale Zeichenkette. | Mehrzeiliger Text | optional |
Aliasse | aliases | Aliasnamen, angegeben mittels Template:TemplateData/aliases.
| Mehrzeiliger Text | optional |
Geerbt | inherits | 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/param | |label= |description= |type= |required= |suggested= |suggestedvalues= |default= |example= |autovalue= |deprecated= |aliases= |inherits= |style= }}
Beispiel
[Quelltext bearbeiten]{{TemplateData/param |lift |label=Lift |description=Number and model of lift systems |type=content |required=0 |suggested=1 |example=1 Otis }}
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/Parameter – lokalisierte Form dieser Vorlage
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).