Vorlage:Dokumentation/Doku

Diese Seite ist die Dokumentations-Unterseite der Vorlage:Dokumentation.

Eigenschaften der Vorlage
„Dokumentation“

Projekt	[[{{{projekt}}}]]
Vorlagentyp	Formatvorlage‎
Namensraum	geeignet für Vorlagen
automat. Kategorie	Vorlage:nicht dokumentiert
abhängig von	Bearbeiten, (!, !)
alternativ	[[Vorlage:{{{weitere}}}|{{{weitere}}}]]
Bitte binde diese Vorlage nur mit Substitution ein.
Bitte vor Änderung dieser vielfach verwendeten Vorlage die Zustimmung der Gemeinschaft im Skriptorium einholen!

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

Diese Vorlage sollte bei allen Vorlagen verwendet werden.

Nutzen

Die Trennung von Programmcode und Dokumentation macht den Quelltext übersichtlicher und entlastet vor allem den Parser: Bei jeder Anwendung wird der gesamte Vorlagentext immer wieder neu ausgewertet, samt der Dokumentation, die im Endeffekt ohnehin wieder weggelassen wird. Trotzdem werden noinclude-Tags vor den tatsächlichen Einbindungen ausgewertet, so dass man die Pre-expand include size drastisch drücken kann, wenn man die Dokumentationen in Unterseiten schreibt. Daher sollte die Beschreibung immer aus der eigentlichen Vorlage ausgelagert werden. Somit ermöglicht man die Nutzung von mehr Vorlagen pro Artikelseite.

Verwendung

In den meisten Fällen reicht es, 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 Erstellungshilfen bereitgestellt durch sogenannte preload-Seiten.

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>

Parameter

Diese Vorlage hat einen Parameter.

nr

Nummer des Namensraums für welchen die dokumentierte Vorlage hauptsächlich vorgesehen ist; wird verwendet um einen Link auf die Linkliste zu erzeugen, mit der die Verwendung der Vorlage im betreffenden Namensraum überprüft werden kann; die akzeptierten Werte und zugehörige Namensräume sind:

• [ohne Angabe] = Artikel
• 1 = Artikel-Diskussion
• 2 = Benutzer
• 4 = Wikisource
• 6 = Datei
• 10 = Vorlage
• 14 = Kategorie

Besonderheiten

Unterseiten

/Meta

Eine solche Unterseite ist vor allem für voll- und halbgesperrte Seiten gedacht, die ansonsten nicht interwikifiziert werden könnten.

/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.