Modul:Dokumentation/Doku

Dies ist die Dokumentationsseite für Modul:Dokumentation

Zweck Bearbeiten

Dieses Modul steuert die gesamte Ausgabe der zentralen Vorlage {{Vorlage:Dokumentation}} im Wikonia-Wiki.

Es zeigt automatisch den Dokumentationskopf, Hinweisboxen, die eigentliche Dokumentation (aus der gleichnamigen Unterseite /Doku) sowie ggf. einen <templatedata>-Block.

Verwendung Bearbeiten

Das Modul wird nicht direkt eingebunden, sondern über die Vorlage:

{{Dokumentation
 | lua = 1
 | css = 1
 | subst = kann
 | risiko = warnung
}}

Unterstützte Parameter Bearbeiten

Parameter	Wirkung	Mögliche Werte
`lua`	Zeigt Lua-Hinweisbox an	`1` (Standardtext) oder Liste: `Modul:Foo, Modul:Bar`
`css`	Zeigt CSS-Hinweisbox an	`1`
`subst`	Zeigt Hinweis zur Substitution	`kann`, `soll`, `muss`, `darf nicht`
`risiko`	Zeigt Hinweis auf Änderungsrisiko	`none`, `achtung`, `kritisch`

Automatische Funktionen Bearbeiten

Bindet /Doku automatisch ein, sofern vorhanden
Zeigt <templatedata>-Block, wenn vorhanden
Fügt Kategorien automatisch hinzu:

Hauptseite: Vorlage mit Dokumentation / Modul mit Dokumentation /Doku: Vorlagendokumentation / Moduldokumentation

Hinweis Bearbeiten

Dieses Modul ersetzt eine Vielzahl an Hilfskonstruktionen aus älteren Systemen. Die dazugehörige Vorlage {{Vorlage:Dokumentation}} sollte immer verwendet werden.