Vorlage:TemplateData/param

aus Wikipedia, der freien Enzyklopädie
Zur Navigation springen Zur Suche springen


Dokumentation

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

Vorlagenparameter

ID1
Technischer Parametername, der bevorzugt auch bei Einbindung der Vorlage in den Quelltext eingefügt werden sollte.
Beispiel
Aufzug
Kurznamelabel
Kurze, eindeutige Klartext-Bezeichnung. Der technische Parametername könnte unverständlich sein. Multilinguale Zeichenkette.
Standard
Der technische Parametername.
Beispiel
Das Wort „Kurzname“ hier.
Beschreibungdescription
Beschreibung des Parameters; Bedeutung, Formate, erlaubte Werte. Multilinguale Zeichenkette.
Beispiel
Diese Parameterbeschreibung hier.
Typtype
Datentyp des Parameters
Vorgeschlagene Werte
Standard
unknown
Beispiel
string
Pflichtrequired
Parameter ist erforderlich (Status).
Standard
0
Beispiel
1
Empfohlensuggested
Parameter wird im Formular angeboten und in den Quelltext eingefügt (Status).
Standard
0
Beispiel
1
Vorgeschlagene Wertesuggestedvalues
Vorgeschlagene Werte, angegeben mittels Template:TemplateData/suggestedvalues.
Vorgabedefault
Vorgabewert in der Programmierung, falls bei der Vorlagen-Einbindung nicht angegeben bzw. leer. Nicht bei Pflichtparametern möglich.
Beispielexample
Ein charakteristischer Beispielwert. Multilinguale Zeichenkette.
AutoWertautovalue
Wird von Werkzeugen in den Quelltext eingefügt, falls nicht explizit ein Wert zugewiesen wurde.
Veraltetdeprecated
Der Parameter ist veraltet (Status), ggf. weitere Hinweise dazu. boolean oder Multilinguale Zeichenkette.
Aliassealiases
Aliasnamen, angegeben mittels Template:TemplateData/aliases.
Beispiel
Fahrstuhl
Geerbtinherits
Nicht explizite Angaben sollen von einem anderen Parameter übernommen werden. Dieser technische Parametername ist anzugeben.
CSSstyle
CSS-Definitionen zur Gestaltung dieser Parameterbeschreibung (keine Wirkung auf die Einbindung).

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

Vorlagenparameter

Diese Vorlage bevorzugt Blockformatierung von Parametern.

ParameterBeschreibungTypStatus
ID1

Technischer Parametername, der bevorzugt auch bei Einbindung der Vorlage in den Quelltext eingefügt werden sollte.

Beispiel
Aufzug
Einzeiliger Texterforderlich
Kurznamelabel

Kurze, eindeutige Klartext-Bezeichnung. Der technische Parametername könnte unverständlich sein. Multilinguale Zeichenkette.

Standard
Der technische Parametername.
Beispiel
Das Wort „Kurzname“ hier.
Mehrzeiliger Textvorgeschlagen
Beschreibungdescription

Beschreibung des Parameters; Bedeutung, Formate, erlaubte Werte. Multilinguale Zeichenkette.

Beispiel
Diese Parameterbeschreibung hier.
Mehrzeiliger Textvorgeschlagen
Typtype

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 Textvorgeschlagen
Pflichtrequired

Parameter ist erforderlich (Status).

Standard
0
Beispiel
1
Wahrheitswertvorgeschlagen
Empfohlensuggested

Parameter wird im Formular angeboten und in den Quelltext eingefügt (Status).

Standard
0
Beispiel
1
Wahrheitswertvorgeschlagen
Vorgeschlagene Wertesuggestedvalues

Vorgeschlagene Werte, angegeben mittels Template:TemplateData/suggestedvalues.

Mehrzeiliger Textoptional
Vorgabedefault

Vorgabewert in der Programmierung, falls bei der Vorlagen-Einbindung nicht angegeben bzw. leer. Nicht bei Pflichtparametern möglich.

Mehrzeiliger Textoptional
Beispielexample

Ein charakteristischer Beispielwert. Multilinguale Zeichenkette.

Mehrzeiliger Textoptional
AutoWertautovalue

Wird von Werkzeugen in den Quelltext eingefügt, falls nicht explizit ein Wert zugewiesen wurde.

Mehrzeiliger Textoptional
Veraltetdeprecated

Der Parameter ist veraltet (Status), ggf. weitere Hinweise dazu. boolean oder Multilinguale Zeichenkette.

Mehrzeiliger Textoptional
Aliassealiases

Aliasnamen, angegeben mittels Template:TemplateData/aliases.

Beispiel
Fahrstuhl
Mehrzeiliger Textoptional
Geerbtinherits

Nicht explizite Angaben sollen von einem anderen Parameter übernommen werden. Dieser technische Parametername ist anzugeben.

Einzeiliger Textoptional
CSSstyle

CSS-Definitionen zur Gestaltung dieser Parameterbeschreibung (keine Wirkung auf die Einbindung).

Mehrzeiliger Textoptional

Kopiervorlage

[Quelltext bearbeiten]
{{TemplateData/param
|
|label=
|description=
|type=
|required=
|suggested=
|suggestedvalues=
|default=
|example=
|autovalue=
|deprecated=
|aliases=
|inherits=
|style=
}}
{{TemplateData/param
|lift
|label=Lift
|description=Number and model of lift systems
|type=content
|required=0
|suggested=1
|example=1 Otis
}}

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.