Vorlage:TemplateData

TemplateData

(Generierte Dokumentation)

[Werkzeuge][Bearbeiten]

Dokumentation

TemplateData

Hinweis für Dokumentationsseiten von Vorlagen auf TemplateData-Generierung

 

⧼templatedata-doc-params⧽

⧼templatedata-doc-param-name⧽		⧼templatedata-doc-param-desc⧽	⧼templatedata-doc-param-type⧽	⧼templatedata-doc-param-status⧽
templatedata	1	(veraltend) Quelltext des JSON-Objekts, eingeschlossen in <templatedata>-Tags	⧼templatedata-doc-param-type-string⧽	⧼templatedata-doc-param-status-optional⧽
JSON-Code	JSON	Quelltext des JSON-Objekts, ohne <templatedata>-Tags	⧼templatedata-doc-param-type-string⧽	⧼templatedata-doc-param-status-suggested⧽
Inhalts­verzeichnis	TOC	Inhaltsverzeichnis nach der allgemeinen Zweckbeschreibung einfügen; ggf. vor einer Parameterliste (Beispiel) ⧼templatedata-doc-param-default⧽ 0 ☐ ⧼templatedata-doc-param-example⧽ 1 ☑	⧼templatedata-doc-param-type-boolean⧽	⧼templatedata-doc-param-status-suggested⧽
Vertikales Limit	vertical	Höhenbegrenzung der Parameterliste; wird bei Überschreitung scrollbar ⧼templatedata-doc-param-example⧽ 80em	⧼templatedata-doc-param-type-line⧽	⧼templatedata-doc-param-status-optional⧽
Sortier­schlüssel	sort	Abweichend vom Titel der Vorlage; namentlich für Demonstrationszwecke ⧼templatedata-doc-param-default⧽ Titel der Vorlage	⧼templatedata-doc-param-type-line⧽	⧼templatedata-doc-param-status-optional⧽
Metadoku	meta	Einbindung über Meta-Dokumentation ⧼templatedata-doc-param-default⧽ 0 ☐ ⧼templatedata-doc-param-example⧽ 1 ☑	⧼templatedata-doc-param-type-boolean⧽	⧼templatedata-doc-param-status-optional⧽

Format: block

<templatedata>{"format":"block","description":"Hinweis für Dokumentationsseiten von Vorlagen auf TemplateData-Generierung","paramOrder":["1","JSON","TOC","vertical","sort","meta"],

"params":{ "1":{"suggested":false,"type":"string","description":"(veraltend) Quelltext des JSON-Objekts, eingeschlossen in <templatedata>-Tags","label":"templatedata"},

"JSON":{"suggested":true,"type":"string","description":"Quelltext des JSON-Objekts, ohne <templatedata>-Tags","label":"JSON-Code"},

"TOC":{"suggested":true,"type":"boolean","description":"Inhaltsverzeichnis nach der allgemeinen Zweckbeschreibung einfügen; ggf. vor einer Parameterliste","label":"Inhaltsverzeichnis","example":"1","default":"0"},

"vertical":{"suggested":false,"type":"line","description":"Höhenbegrenzung der Parameterliste; wird bei Überschreitung scrollbar","label":"Vertikales Limit","example":"80em"},

"sort":{"suggested":false,"type":"line","description":"Abweichend vom Titel der Vorlage; namentlich für Demonstrationszwecke","label":"Sortierschlüssel","default":"Titel der Vorlage"},

"meta":{"suggested":false,"type":"boolean","description":"Einbindung über Meta-Dokumentation","label":"Metadoku","example":"1","default":"0"} }

}</templatedata>

Vorlagendokumentationsseite verbessern – MediaWiki ungenügend

Zu Ostern 2017 wurde eine Erweiterung der MediaWiki-Funktionalität für die Präsentation von Vorlagendokumentationsseiten bereitgestellt. Auf den Vorlagendokumentationsseiten mussten sehr oft zwei Parameterdokumentationen parallel gepflegt werden: eine mit Verlinkungen und optisch aufbereiteter Darstellung komplexer Zusammenhänge, auch verlinkter Bezugnahme von Parametern untereinander – und eine zweite, oft gleichen Inhalts, ohne Verlinkungen und als einfacher Text, nur für den VisualEditor.

Diese Doppelarbeit wird nunmehr vermieden. Die Version für die Dokumentationsseite erhält zusätzliche Möglichkeiten, während die Aufbereitung im VisualEditor aussieht wie bisher.

Verbesserte Präsentation

{{#lst:Wikipedia:Lua/Modul/TemplateData/de|JSONenhanced}}

Wartung

Um einen besseren Überblick als mit Special:PagesWithProp/templatedata möglich zu erhalten, werden die Einbindungen vermerkt in:

• Kategorie:Vorlage:mit TemplateData
• Vorlage:Vorlagenfehler-Wartungskat

Siehe auch

• Hilfe:TemplateData – Allgemeines
• Hilfe:TemplateData/JSON – Fortgeschrittenes

Lua

Datei:Lua-logo-nolabel.svg

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: TemplateData #f

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.

• 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.