Vorlage:Dokumentation/Footer/Doku
Zweck Bearbeiten
Diese Vorlage ergänzt Dokumentationsseiten von Vorlagen und Modulen um einen strukturierten Footer-Bereich. Sie stellt wichtige Hinweise bereit, die vor oder während der Bearbeitung hilfreich sind, z. B.:
- Wo sollten Änderungen und Vorschläge diskutiert werden?
- Wie kann man schnell herausfinden, wo die Vorlage verwendet wird?
- Existieren Demo- oder Test-Unterseiten?
- Wurde für die Seite ein Versionsschutz gesetzt?
- Nutzt die Vorlage TemplateStyles?
Die Vorlage ist bewusst so gebaut, dass sie am Ende der Dokumentationsseite eingebunden wird — idealerweise automatisch über die Vorlage {{Dokumentation}}.
Einbindung Bearbeiten
Die Vorlage wird nicht direkt auf jeder Dokumentationsseite eingebunden. Stattdessen sollte sie über die Hauptvorlage {{Dokumentation}} automatisch am Ende angezeigt werden.
Dies vermeidet Redundanz und sorgt für eine einheitliche Darstellung in allen Dokumentationen.
Einbindung Bearbeiten
- Automatisch: Wird über Vorlage:Dokumentation am Seitenende eingebunden (empfohlen).
- Manuell (nur Ausnahmefälle):
{{Dokumentation/Footer|subpages=0|issubpage=0}}
Parameter Bearbeiten
| Name | Typ | Standard | Wirkung |
|---|---|---|---|
subpages |
bool (leer/1) | leer | Zeigt den Link „Liste der Unterseiten“ an, wenn nicht leer. |
issubpage |
bool (leer/1) | leer | Blendet den Hinweis ein, dass die aktuelle Seite eine Unterseite von {{SUBJECTSPACE}}:{{BASEPAGENAME}} (eine Ebene höher) ist.
|
Hinweise zum Verhalten Bearbeiten
- Die Vorlage erkennt anhand des Namensraums, ob es sich um eine Vorlage oder ein Modul handelt, und passt Formulierungen entsprechend an.
- Hinweise auf Unterseiten (z. B.
/Demo,/Test,/styles.css) werden nur angezeigt, wenn diese Unterseiten tatsächlich existieren. - Die Anzeige des Versionsschutzes erfolgt automatisch über
{{PROTECTIONLEVEL:edit}}. - CirrusSearch wird für die Ermittlung von Transklusionen verwendet (via Modul:DokuTools).
Beispielausgabe Bearbeiten
Einbindung über Hauptvorlage (Standard) Bearbeiten
Eine standardmäßige Dokumentationsseite mit Footer könnte wie folgt aussehen:
{{Dokumentation}}
<!-- Eingebunndener Dokumentationstext aus /Doku -->
Der Footer erscheint automatisch darunter.
Die Parameter können der Dokumentationsvorlage übergeben werden, diese schleift sie direkt durch. {{Dokumentation|subpages=1}} für den Hinweis auf Unterseiten, bzw. {{Dokumentation|issubpage=1}} für den Hinweis, dass es sich um eine Unterseite handelt.
Unterdrücken Bearbeiten
Bei der Einbindung durch die Vorlage {{Dokumentation}}, lässt sich die Ausgabe mit hilfe des Parameters nofooter unterdrücken, wenn dies in Ausnahmefällen notwendig ist, zum Beispiel bei mehrfach-Transklusionen. Weitere INformationen dazu findest du in der Dokumentation der Hauptvorlage.
Manuell (Kurzdoku) Bearbeiten
Alternativ muss bei einer Kurzdoku (ohne Einbindung der Unterseite) der Footer manuell gesetzt werden.
{{Kurzdokumentation}}
<!-- Der gesamte Text der Dokumentation -->
{{Dokumentation/Footer}}