Vorlage:Dokumentation/Doku

Diese Seite ist die Dokumentations-Unterseite der 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.

• Insbesondere führt eine kleine Änderung in der Dokumentation nicht dazu, dass Tausende einbindender Seiten neu generiert werden müssen.
• In der Versionsgeschichte der Programmierungsseite erscheinen nur noch Änderungen, die die wirksamen Einbindungen betreffen.

Benutzung

Diese Vorlage benötigt meist keine Parameter. Es reicht, wenn der programmierte Code in <onlyinclude> sowie </onlyinclude> eingeschlossen wird und dann {{Dokumentation}} an das Ende einer Vorlage geschrieben wird; danach kann die Dokumentationsseite [[<Seitenname>/Doku]] erstellt werden. Nach dem Generieren der Dokumentation werden Erstellungshilfen bereitgestellt (preload).

In den Unterseiten stellen folgende Codezeilen am Anfang der Seite den Rückbezug sicher:

/Doku

<noinclude>{{Dokumentation/Dokuseite}}</noinclude>

Am Ende der Seite werden die Kategorien von <includeonly></includeonly> eingeschlossen.

/Meta

<noinclude>{{Dokumentation/Metaseite}}</noinclude><includeonly> … Meta … </includeonly>

Hinweis: Diese Methode ist veraltet und wird zurückgebaut (integriert in /Doku).

/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 in Kategorien einsortiert.

Unterseiten

/Meta

Eine solche Unterseite war vor allem für vollgeschützte Seiten gedacht, die ansonsten nicht kategorisiert werden konnten, und sie sollte Interwiki-Bots das Beschreiben ermöglichen, ohne durch Halbschutz blockiert zu werden und auf den Beobachtungslisten zu stören. Diese Unterseite nahm auch Kategorisierungen auf.

• Interwiki-Links befinden sich inzwischen auf Wikidata.
• Es bleiben nur wenige Zeilen für die Kategorisierung, die inzwischen in <includeonly> eingeschlossen am Ende von /Doku eingefügt werden.
• Eine separate Unterseite lohnt nicht mehr und verkompliziert nur noch; Restbestände werden aufgelöst.
• Siehe Hilfe:Vorlagendokumentation #Meta-Daten.

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

/Editnotice

Ein spezieller Hinweis, der beim Bearbeiten angezeigt wird.

Parameter

Zurzeit wird ein Parameter für Sonderfälle angeboten:

TOC

Vorgezogenes Inhaltsverzeichnis anzeigen.

Für Vorlagendokumentationen, bei denen rechts eine hohe Tabelle erscheint (etwa Infoboxen), kann links oben der Sprung zur Dokumentation ermöglicht werden.

1 – Inhaltsverzeichnis vor dem Dokumentationsabschnitt

Interne Wartung

• Kategorie:Wikipedia:Vorlagenfehler/Vorlage:Dokumentation

Weitere Informationen

• Hilfe:Vorlagendokumentation

Interne Hiilfsvorlagen, einzeln für besondere Fälle nutzbar:

• Vorlage:Dokumentation/ruler – einheitliche Trennlinie
• Vorlage:Dokumentation/header – Große Überschrift
• Vorlage:Dokumentation/footer – Fußbereich mit standardisierten Zusatzinfos

Diese Vorlage ist vielfach eingebunden. Wenn du die Auswirkungen genau kennst, kannst du sie bearbeiten. Meist ist es jedoch sinnvoll, Änderungswünsche erst auf Vorlage Diskussion:Dokumentation abzustimmen.