Vorlage:Dokumentation
Diese Vorlage zeigt eine Dokumentationsbox, wie du sie gerade siehst. Sie bindet den Text von der Unterseite [[<Seitenname>/Doku]] ein.
Begründung
Die Trennung von Programmcode und Dokumentation macht den Quelltext übersichtlicher.
Benutzung
Diese Vorlage erwartet keine Parameter. Es reicht, wenn man <noinclude>{{Dokumentation}}
</noinclude> ans Ende einer Vorlage schreibt und die Dokumentationsseite [[<Seitenname>/Doku]] erstellt. Eine Unterseite namens /Meta kann dann die Metadaten für die Vorlage enthalten (hierzu bitte den Abschnitt Besonderheiten lesen), ansonsten können diese mit in die Noinclude-Tag am Ende der Vorlage platziert werden. Zu den Metadaten gehören die Kategorien und Interwikilinks. Nach dem Erstellen der Dokumentation werden einem Erstellungshilfen bereitgestellt (preload).
In den Unterseiten stellen folgende Codezeilen den Rückbezug sicher
- /Doku
<noinclude>{{Dokumentation/Dokuseite}}</noinclude>- /Meta
<noinclude>{{Dokumentation/Metaseite}}</noinclude><includeonly> … Meta … </includeonly>- /Test
<noinclude>{{Dokumentation/Testseite}}</noinclude>- /Wartung
<noinclude>{{Dokumentation/Wartungsseite}}</noinclude>- /Editnotice
<noinclude>{{Dokumentation/Editnoticeseite}}</noinclude>- /Unterseite
<noinclude>{{Dokumentation/Unterseite}}</noinclude>
Besonderheiten
Wenn sich die Vorlage im Benutzernamensraum befindet, werden die Metadaten nicht eingebunden und weder die Vorlage noch die Unterseite werden in Kategorien einsortiert.
Unterseiten
/Meta- Eine solche Unterseite ist vor allem für vollgesperrte Seiten gedacht, die ansonsten nicht kategorisiert werden könnten. Diese Unterseite nimmt Kategorisierungen auf.
/Wartung- Sollte es eine Wartungsseite für die Vorlage geben, so wird ebenfalls ein Hinweis ausgegeben.
/Test- Ein Hinweis wird auch für Testunterseiten ausgegeben.
/Editnotice- Eine spezieller Hinweis, der beim Bearbeiten angezeigt wird.
Unterseiten anlegen
| Bei technischen Fragen zu dieser Vorlage kannst du dich an den Administrator wenden. Inhaltliche Fragen und Vorschläge gehören zunächst auf die Diskussionsseite. |
|
|