Vorlage:TemplateData/Doku: Unterschied zwischen den Versionen
Zur Navigation springen
Zur Suche springen
wp>Tlustulimu K (Korrektur) |
K (19 Versionen importiert: Lua) |
||
| (10 dazwischenliegende Versionen von 5 Benutzern werden nicht angezeigt) | |||
| Zeile 1: | Zeile 1: | ||
<noinclude>{{Dokumentation/Dokuseite}}</noinclude> | <noinclude>{{Dokumentation/Dokuseite}}</noinclude> | ||
{{TemplateData| | {{TemplateData|JSON= | ||
{ "description": "Hinweis für Dokumentationsseiten von Vorlagen auf TemplateData-Generierung", | { "description": "Hinweis für Dokumentationsseiten von Vorlagen auf [[Hilfe:TemplateData|TemplateData]]-Generierung", | ||
"params": { "1": | "params": { "1": | ||
{ "label": "JSON-Code", | { "label": "JSON-Code", | ||
"description": "Quelltext des JSON-Objekts, eingeschlossen in <templatedata>-Tags", | "description": "(veraltend) Quelltext des JSON-Objekts, eingeschlossen in <templatedata>-Tags", | ||
"type": "string", | "type": "string", | ||
" | "suggested": true | ||
}, | |||
"JSON": | |||
{ "label": "JSON-Code", | |||
"description": "Quelltext des JSON-Objekts, ohne <templatedata>-Tags", | |||
"type": "string", | |||
"suggested": true | |||
}, | |||
"TOC": | |||
{ "label": "Inhaltsverzeichnis", | |||
"description": "Inhaltsverzeichnis nach der allgemeinen Zweckbeschreibung einfügen; ggf. vor einer Parameterliste<noexport> ([[Wikipedia:Lua/Modul/TemplateData/TOC|Beispiel]])</noexport>", | |||
"type": "boolean", | |||
"suggested": true, | |||
"default": "0", | |||
"example": "1" | |||
}, | }, | ||
"sort": | "sort": | ||
{ "label": "Sortierschlüssel", | { "label": "Sortierschlüssel", | ||
"description": "Abweichend vom Titel der Vorlage; namentlich für Demonstrationszwecke", | "description": "Abweichend vom Titel der Vorlage; namentlich für Demonstrationszwecke", | ||
"type": " | "type": "line", | ||
"required": false, | "required": false, | ||
"default": "Titel der Vorlage" | "default": "Titel der Vorlage" | ||
} | } | ||
} | } | ||
} | } | ||
|TOC=1}} | |||
== Vorlagendokumentationsseite verbessern – MediaWiki ungenügend == | |||
{{Achtung|1=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öglicheiten, 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: | Um einen besseren Überblick als mit [[Special:PagesWithProp/templatedata]] möglich zu erhalten, werden die Einbindungen vermerkt in: | ||
* [[:Kategorie:Vorlage:mit TemplateData]] | * [[:Kategorie:Vorlage:mit TemplateData]] | ||
[[Kategorie:Vorlage: | == Siehe auch == | ||
[[Kategorie:Vorlage: | * [[Hilfe:TemplateData]] – Allgemeines | ||
* [[Hilfe:TemplateData/JSON]] – Fortgeschrittenes | |||
<includeonly> | |||
{{Lua-Vorlage|TemplateData #f}} | |||
[[Kategorie:Vorlage:Hinweis für Vorlagen]] | |||
[[Kategorie:Vorlage:mit Kategorisierung/Vorlage]] | |||
</includeonly> | </includeonly> | ||
Aktuelle Version vom 29. Juli 2018, 18:18 Uhr
|
Diese Seite ist die Dokumentations-Unterseite der Vorlage:TemplateData. |
Hinweis für Dokumentationsseiten von Vorlagen auf TemplateData-Generierung
Template parameters
| Parameter | Description | Type | Status | |
|---|---|---|---|---|
| JSON-Code | 1 | (veraltend) Quelltext des JSON-Objekts, eingeschlossen in <templatedata>-Tags | String | suggested |
| JSON-Code | JSON | Quelltext des JSON-Objekts, ohne <templatedata>-Tags | String | suggested |
| Inhaltsverzeichnis | TOC | Inhaltsverzeichnis nach der allgemeinen Zweckbeschreibung einfügen; ggf. vor einer Parameterliste (Beispiel)
| Boolean | suggested |
| Sortierschlüssel | sort | Abweichend vom Titel der Vorlage; namentlich für Demonstrationszwecke
| Line | optional |
Vorlagendokumentationsseite verbessern – MediaWiki ungenügend
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öglicheiten, 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:
Siehe auch
- Hilfe:TemplateData – Allgemeines
- Hilfe:TemplateData/JSON – Fortgeschrittenes