Vorlage:TemplateData/Doku

TemplateData

Verbesserte Darstellung und automatische Generierung einer TemplateData-Tabelle für Dokumentationsseiten.

Vorlagenparameter

Parameter		Beschreibung	Typ	Status
templatedata	1	(veraltend) Quelltext des JSON-Objekts, eingeschlossen in <templatedata>-Tags	Mehrzeiliger Text	veraltet Wird nicht empfohlen
JSON-Code	JSON	Quelltext des JSON-Objekts, ohne <templatedata>-Tags	Mehrzeiliger Text	vorgeschlagen
Inhalts­verzeichnis	TOC	Inhaltsverzeichnis nach der allgemeinen Zweckbeschreibung einfügen; ggf. vor einer Parameterliste (Beispiel) Standard 0 ☐ Beispiel 1 ☑	Wahrheitswert	vorgeschlagen
Vertikales Limit	vertical	Höhenbegrenzung der Parameterliste; wird bei Überschreitung scrollbar Beispiel 80em	Einzeiliger Text	optional
Sortier­schlüssel	sort	Abweichend vom Titel der Vorlage; namentlich für Demonstrationszwecke Standard Titel der Vorlage	Einzeiliger Text	optional
Metadoku	meta	Einbindung über Meta-Dokumentation Standard 0 ☐ Beispiel 1 ☑	Wahrheitswert	optional

Format: block

Importierter Inhalt

Dieseer Inhalt wurde von einem anderen Wiki-Projekt^* importiert und für Wikonia adaptiert. Wir wissen die Arbeit der ursprünglichen Autorinnen und Autoren zu schätzen und bedanken uns bei mit diesem kleinen Hinweis.

* Importquelle: Deutschsprachige Wikipedia

Einleitung

Diese Vorlage in kombination mit dem Modul erweitert die Standard-TemplateData-Ausgabe von MediaWiki um eine übersichtliche, optisch strukturierte Darstellung der Vorlagenparameter. Es wurde ursprünglich auf Basis einer älteren Implementierung der Wikipedia entwickelt und für Wikonia technisch sowie gestalterisch modernisiert.

Ziel ist es, die Pflege der Vorlagendokumentation zu vereinfachen und sowohl im Wikitext als auch im VisualEditor eine klar nutzbare, konsistente Darstellung zu bieten – ohne doppelte Inhaltsführung oder manuelle Formatierungsarbeit.

Historischer Kontext

Dieses Modul basiert funktional auf frühen Ansätzen aus der Wikipedia, wurde jedoch in mehreren Punkten überarbeitet, vereinfacht und modernisiert. Die Version für Wikonia konzentriert sich auf klare Darstellung, geringere Komplexität und bessere Wartbarkeit.

Verbesserte Darstellung

Das TemplateData-Modul bietet erweiterte Formatierungs- und Strukturierungsmöglichkeiten für description-Felder und andere TemplateData-Elemente.

Wikilinks

• Normale interne Links ([[…]]) können im Beschreibungstext genutzt werden.
• Im VisualEditor wird der reine Linktitel angezeigt.

Weblinks

• Offene URLs werden automatisch verlinkt.
• Betitelte Weblinks ([URL Titel]) erscheinen im VisualEditor als reine URL, um das Kopieren zu erleichtern.

Formatierungen

• Kursiv-/Fettschrift mit Apostrophen ist erlaubt und wirkt nur auf die Dokumentationsseite.
• Im VisualEditor wird stets Normalschrift angezeigt.
• Unterstützte HTML-Entities: <, >, &, ",   sowie numerische Entities.

HTML-Tags

• HTML-Tags werden in der Dokumentation normal interpretiert.
• Beim Export in den VisualEditor werden nicht unterstützte Elemente entfernt.

Bereiche ohne VE-Export

Mit:

<noexport> … </noexport>

können komplexere Anleitungen, Beispiele oder längere Abschnitte ausschließlich in der Dokumentation angezeigt werden.

Vorlagen innerhalb von TemplateData

• Vorlagen können in description und anderen Feldern genutzt werden.
• Es ist darauf zu achten, dass expandierte Vorlagen nicht mit der JSON-Syntax kollidieren.

Zusatzfunktionen

Das Modul bietet mehrere erweiterte Möglichkeiten zur Darstellung der Parameterliste:

• Farblich markierte Parameterzeilen anhand ihres Status
• Sortierung nach Wichtigkeit statt alphabetisch
• Zwischenüberschriften innerhalb der Parametertabelle
• Scrollbare Tabellen bei vielen Parametern
• Individuelle Hervorhebungen einzelner Parameter
• Direkte Verlinkbarkeit jedes Parameters über templatedata:name
• Automatische Wartungskategorie bei fehlenden Beschriftungen oder strukturellen Fehlern
• Optionale Nutzung zentraler, mehrsprachiger Dokumentationsquellen

Wartung

Für eine Übersicht aller Vorlagen mit TemplateData-Einträgen kann die Spezialseite verwendet werden:

• Special:PagesWithProp/templatedata

Zusätzliche Hinweise zur Fehlererkennung werden automatisch über eine Wartungskategorie erzeugt.

• Kategorie:Vorlage mit TemplateData
• Fehlerhafte Einbindungen werden aufgelistet in der Kategorie: Vorlagenfehler/Vorlage:TemplateData – aktuell keine – ignoriert 1   (vor 8 Stunden) Aktualisieren

Siehe auch

• Hilfe:TemplateData – Allgemeine Informationen
• Hilfe:TemplateData/JSON – Fortgeschrittene Informationen
• Hilfe:Vorlagenprogrammierung/Doku – Allgemeine Hinweise zur Dokumentation