Vorlage:TemplateData/Doku: Unterschied zwischen den Versionen

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) Default `0` ☐ Example `1` ☑	Boolean	suggested
Sortierschlüssel	`sort`	Abweichend vom Titel der Vorlage; namentlich für Demonstrationszwecke Default Titel der Vorlage	Line	optional

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öglicheiten, während die Aufbereitung im VisualEditor aussieht wie bisher.

Verbesserte Präsentation

Wartung

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

Kategorie:Vorlage:mit TemplateData

Siehe auch

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

@@ Zeile 1: / Zeile 1: @@
 <noinclude>{{Dokumentation/Dokuseite}}</noinclude>
-{{TemplateData|top}}
+{{TemplateData|JSON=
-<templatedata>
+{ "description": "Hinweis für Dokumentationsseiten von Vorlagen auf [[Hilfe:TemplateData|TemplateData]]-Generierung",
-{ "description": "Hinweis für Dokumentationsseiten von Vorlagen auf TemplateData-Generierung",
+   "params": { "1":
-   "params": { "sort":
+              { "label":       "JSON-Code",
+                "description": "(veraltend) Quelltext des JSON-Objekts, eingeschlossen in &lt;templatedata&gt;-Tags",
+                "type":        "string",
+                "suggested":   true
+              },
+              "JSON":
+              { "label":       "JSON-Code",
+                "description": "Quelltext des JSON-Objekts, ohne &lt;templatedata&gt;-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":
                { "label":       "Sortierschlüssel",
-                 "description": "Abweichend vom Titel der Vorlage; namentlich für Demonstrationszwecke und auf Hilfeseiten",
+                 "description": "Abweichend vom Titel der Vorlage; namentlich für Demonstrationszwecke",
-                 "type":        "string",
+                 "type":        "line",
                  "required":    false,
                  "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.
-</templatedata>
-Temporärer Parameter zum Experimentieren:
+=== Verbesserte Präsentation ===
-; 1
+{{#lst:Wikipedia:Lua/Modul/TemplateData/de|JSONenhanced}}
-: <code>bottom</code> → unten anordnen
-: <code>top</code> → Rahmen-Design oben
-: ohne Angabe: zurzeit <code>bottom</code> – langfristig <code>top</code>
+== Wartung ==
 Um einen besseren Überblick als mit [[Special:PagesWithProp/templatedata]] möglich zu erhalten, werden die Einbindungen vermerkt in:
 * [[:Kategorie:Vorlage:mit TemplateData]]
+== Siehe auch ==
+* [[Hilfe:TemplateData]] – Allgemeines
+* [[Hilfe:TemplateData/JSON]] – Fortgeschrittenes
 <includeonly>
-[[Kategorie:Vorlage:mit Kategorisierung]]
+{{Lua-Vorlage|TemplateData #f}}
-[[Kategorie:Vorlage:für Vorlagen]]
+[[Kategorie:Vorlage:Hinweis für Vorlagen]]
+[[Kategorie:Vorlage:mit Kategorisierung/Vorlage]]
 </includeonly>