Vorlage:TemplateDataGenerator/Doku
Zur Navigation springen
Zur Suche springen
Erstellt aus der Vorlagenprogrammierung ein Grundgerüst für die Dokumentation der vorkommenden Parameter mittels TemplateData.
Vorlagenparameter
Parameter | Beschreibung | Typ | Status | |
---|---|---|---|---|
Sortierung | sort 1 | Alphabetische Sortierung, wenn Ziffer 1 angegeben | Wahrheitswert | optional |
Kopiervorlage
[Quelltext bearbeiten]{{subst:TemplateDataGenerator}}
Anwendung
[Quelltext bearbeiten]Die Einbindung gemäß Kopiervorlage wird in die Einleitung der zum Bearbeiten geöffneten Dokumentationsseite kopiert und Vorschau zeigen ausgelöst. Es erscheint ein JSON-Objekt usw. mit allen vorkommenden Parametern. Dieses wird kopiert und ersetzt die Einbindung; anschließend kann es weiter ausgefüllt und angepasst werden. Das würde auch geschehen, wenn man die Seite versehentlich speichert; es belastet aber nur unnötig die Versionsgeschichte.
- Grundsätzlich ist eine bereits gespeicherte Version der Vorlagenprogrammierung als Oberseite erforderlich.
- Untervorlagen lassen sich nicht analysieren; diese sind aber interne Angelegenheit der Programmierung und werden nicht mit interaktiven Werkzeugen in Seiten eingefügt.
- Mit dem Wert
1
kann die alphabetische Sortierung der Parameterliste bewirkt werden.- Standardmäßig wird die im Quelltext vorgefundene Reihenfolge benutzt, was oft eine intuitiv sinnvolle Abfolge entsprechend der Darstellung nach Expansion ergibt.
- Wenn die ersten beiden Zeichen eines Parameternamens Großbuchstaben sind, wird als
"label"
der Name in Kleinbuchstaben eingefügt, beginnend mit einem Großbuchstaben.