Vorlage:Dokumentation

Dokumentation

Diese Vorlage ist vielfach eingebunden. Wenn du die Auswirkungen genau kennst, kannst du sie bearbeiten. Meist ist es jedoch sinnvoll, Änderungswünsche erst mit den jeweiligen Bearbeitern dieser Vorlage abzustimmen.

Diese Vorlage zeigt eine Dokumentationsbox, wie du sie gerade siehst. Sie bindet den Text von der Unterseite [[<Seitenname>/Doku]] ein.

Übrigens: Die PlusPedia ist NICHT die Wikipedia.
Wir sind ein gemeinnütziger Verein, PlusPedia ist werbefrei. Wir freuen uns daher über eine kleine Spende!

1 Begründung

Die Trennung von Programmcode und Dokumentation macht den Quelltext übersichtlicher.

2 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-Tags 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>

/Druck <noinclude>{{Dokumentation/Druckversion}}</noinclude>

/Editnotice <noinclude>{{Dokumentation/Editnoticeseite}}</noinclude>

/Unterseite <noinclude>{{Dokumentation/Unterseite}}</noinclude>

3 Besonderheiten

Wenn sich die Vorlage im Benutzernamensraum befindet, werden die Metadaten nicht eingebunden und weder die Vorlage noch die Unterseite werden in Kategorien einsortiert.

3.1 Unterseiten

/Meta: Eine solche Unterseite ist vor allem für vollgesperrte Seiten gedacht, die ansonsten nicht interwikifiziert werden könnten. Diese Unterseite nimmt Interwiki-Links sowie Kategorisierungen auf.
/XML: Wenn die Vorlage neben der Dokumentation noch eine XML-Beschreibung für den Vorlagenmeister hat, wird ein entsprechender Hinweis ausgegeben.
/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.
/Druck: Eine spezielle Version der Vorlage, die zusammen mit der Buchfunktion benutzt wird.
/Editnotice: Eine spezieller Hinweis, der beim Bearbeiten angezeigt wird.

4 Unterseiten anlegen

Wenn man seine monobook.css um

.metadata { display:block !important; }

erweitert, bekommt man auf Vorlagenseiten mit Dokumentation Links zum einfacheren Anlegen der Unterseiten angezeigt.

Bei Fragen zu dieser Vorlage kannst du dich an die Vorlagenwerkstatt wenden oder in der Quelle nachschauen (bisher ist das meist die Vorlage in der Wikipedia).