Vorlage:Dokumentation

Dokumentation ansehen ‖ bearbeiten ‖ Versionsverlauf ‖ Cache leeren

Änderungswarnung

Diese Vorlage ist in vielen Seiten eingebunden und wird regelmäßig verwendet. Bitte sei dir bewusst, dass selbst kleine Änderungen unerwartete Auswirkungen haben können. Wenn du Verbesserungsvorschläge hast, teile sie bitte zunächst auf der Diskussionsseite, bevor du Änderungen vornimmst.

Dies ist die zentrale Vorlage zur Einbindung von Dokumentationen für:

Vorlagen (Namensraum 10)
Module (Namensraum 828)
… sowie deren zugehörige Unterseiten vom Typ /Doku

Verwendung

Auf Vorlagen-Seiten:

Für die grundsätzliche Einbindung der Unterseite /Doku genügt der folgende, einfache Vorlagenaufruf:

{{Dokumentation}}

Optional mit Parametern:

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

Auf `/Doku`-Seiten

Auf Unterseiten reicht ebenfalls die Verwendung von:

{{Dokumentation}}

Dies empfielt sich gerade bei der Benutzung im Modul-Namensraum, da sonst keine Darstellung des Headers erfolgen kann.

Unterstützte Parameter

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

Bindet /Doku automatisch ein, sofern vorhanden
Zeigt <templatedata>-Block, wenn vorhanden
Fügt Kategorien automatisch hinzu:
- Hauptseite: Kategorie:Vorlage mit Dokumentation / Kategorie:Kategorie:Modul mit Dokumentation

Achtung:

Diese Vorlage ersetzt ebenfalls vollständig die bisherige Vorlage {{Moduldokumentation}}.

Siehe auch

Modul Dokumentation – zugehöriges Modul
Vorlage:Dokumentation/Beispiel – Einbinden von Beispiel-Boxen in Dokumentationen
Hilfeseite zur Vorlagenprogrammierung – allgemeine Hilfe zur Vorlagenprogrammierung