(Generierte Dokumentation)


Informationen zu dieser Dokumentation
[Bearbeiten] Dokumentation
Hinweis für Dokumentationsseiten von Vorlagen auf TemplateData-Generierung

Vorlagenparameter

ParameterBeschreibungTypStatus
templatedata1
(veraltend) Quelltext des JSON-Objekts, eingeschlossen in <templatedata>-Tags
Mehrzeiliger Textoptional
JSON-CodeJSON
Quelltext des JSON-Objekts, ohne <templatedata>-Tags
Mehrzeiliger Textvorgeschlagen
Inhalts­verzeichnisTOC
Inhaltsverzeichnis nach der allgemeinen Zweckbeschreibung einfügen; ggf. vor einer Parameterliste (Beispiel)
Standard
0
Beispiel
1
Wahrheitswertvorgeschlagen
Vertikales Limitvertical
Höhenbegrenzung der Parameterliste; wird bei Überschreitung scrollbar
Beispiel
80em
Einzeiliger Textoptional
Sortier­schlüsselsort
Abweichend vom Titel der Vorlage; namentlich für Demonstrationszwecke
Standard
Titel der Vorlage
Einzeiliger Textoptional
Metadokumeta
Einbindung über Meta-Dokumentation
Standard
0
Beispiel
1
Wahrheitswertoptional

Format: block

Hinweis für Dokumentationsseiten von Vorlagen auf TemplateData-Generierung

Vorlagenparameter

Diese Vorlage bevorzugt Blockformatierung von Parametern.

ParameterBeschreibungTypStatus
templatedata1

(veraltend) Quelltext des JSON-Objekts, eingeschlossen in <templatedata>-Tags

Mehrzeiliger Textoptional
JSON-CodeJSON

Quelltext des JSON-Objekts, ohne <templatedata>-Tags

Mehrzeiliger Textvorgeschlagen
Inhalts&shy;verzeichnisTOC

Inhaltsverzeichnis nach der allgemeinen Zweckbeschreibung einfügen; ggf. vor einer Parameterliste

Standard
0
Beispiel
1
Wahrheitswertvorgeschlagen
Vertikales Limitvertical

Höhenbegrenzung der Parameterliste; wird bei Überschreitung scrollbar

Beispiel
80em
Einzeiliger Textoptional
Sortier&shy;schlüsselsort

Abweichend vom Titel der Vorlage; namentlich für Demonstrationszwecke

Standard
Titel der Vorlage
Einzeiliger Textoptional
Metadokumeta

Einbindung über Meta-Dokumentation

Standard
0
Beispiel
1
Wahrheitswertoptional

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.

Wartung

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

Siehe auch



Fragen zu dieser Vorlage kannst Du auf der Diskussions-Seite der Vorlage stellen.