Vorlage:TemplateData/Parameter

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
Abruf
Kurznamelabel
Kurz
Label
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
Beschreibung des Parameters; Bedeutung, Formate, erlaubte Werte. Multilinguale Zeichenkette.
Beispiel
Diese Parameterbeschreibung hier.
Typtype
Typ
Datentyp des Parameters.
Vorgeschlagene Werte
Standard
unknown
Beispiel
string
Pflichtrequired
Pflicht
Parameter ist erforderlich (Status).
Standard
0
Beispiel
1
Empfohlensuggested
Empfohlen
Empfehlung
Vorschlag
Parameter wird im Formular angeboten und in den Quelltext eingefügt (Status).
Standard
0
Beispiel
1
Wertesuggestedvalues
Werte
Vorschläge für Werte, angegeben mittels Vorlage:TemplateData/Werte
Vorgabedefault
Vorgabe
Standard
Default
Vorgabewert in der Programmierung, falls bei der Vorlagen-Einbindung nicht angegeben bzw. leer. Nicht bei Pflichtparametern möglich.
Beispielexample
Beispiel
Ein charakteristischer Beispielwert. Multilinguale Zeichenkette.
AutoWertautovalue
AutoWert
Autowert
Wird von Werkzeugen in den Quelltext eingefügt, falls nicht explizit ein Wert zugewiesen wurde.
Veraltetdeprecated
Veraltet
Obsolet
Der Parameter ist veraltet (Status), ggf. weitere Hinweise dazu. boolean oder Multilinguale Zeichenkette.
Aliassealiases
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.
Beispiel
Nebenstehend: „Aliasse“ und „Alias“
Geerbtinherits
Geerbt
Erbt
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
Abruf
Einzeiliger Texterforderlich
Kurznamelabel Kurz Label

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

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

Beispiel
Diese Parameterbeschreibung hier.
Mehrzeiliger Textvorgeschlagen
Typtype Typ

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 Pflicht

Parameter ist erforderlich (Status).

Standard
0
Beispiel
1
Wahrheitswertvorgeschlagen
Empfohlensuggested Empfohlen Empfehlung Vorschlag

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

Standard
0
Beispiel
1
Wahrheitswertvorgeschlagen
Wertesuggestedvalues Werte

Vorschläge für Werte, angegeben mittels Vorlage:TemplateData/Werte

Mehrzeiliger Textoptional
Vorgabedefault Vorgabe Standard Default

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

Mehrzeiliger Textoptional
Beispielexample Beispiel

Ein charakteristischer Beispielwert. Multilinguale Zeichenkette.

Mehrzeiliger Textoptional
AutoWertautovalue AutoWert Autowert

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

Mehrzeiliger Textoptional
Veraltetdeprecated Veraltet Obsolet

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

Mehrzeiliger Textoptional
Aliassealiases 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.

Beispiel
Nebenstehend: „Aliasse“ und „Alias“
Mehrzeiliger Textoptional
Geerbtinherits Geerbt Erbt

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/Parameter
|
|Kurz=
|Beschreibung=
|Typ=
|Pflicht=
|Empfohlen=
|Vorgabe=
|Beispiel=
|AutoWert=
|Veraltet=
|Aliasse=
|Geerbt=
|style=
}}
{{TemplateData/Parameter
|Abruf
|Kurz=Abrufdatum
|Beschreibung=Abrufdatum im Format <code>JJJJ-MM-TT</code>
|Typ=date
|Pflicht=nein
|Empfohlen=ja
|Beispiel=2024-11-04
}}

Dazu auch

  • Beispiel im Kontext von: {{TemplateData/JSON}}
  • Quelltext dieser Dokumentationsseite, der die Methodik nutzt.
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:

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.