Vorlage:Dokumentation: Unterschied zwischen den Versionen

Aktuelle Version vom 3. November 2021, 06:20 Uhr

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 erwartet keine Parameter. Es reicht, wenn man <noinclude>{{Dokumentation}}</noinclude> ans Ende einer Vorlage schreibt und die Dokumentationsseite [[<Seitenname>/Doku]] erstellt. Nach dem Generieren der Dokumentation werden 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>

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

Unterseiten

/Meta

Eine solche Unterseite war vor allem für vollgesperrte 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 nicht 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.

/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

Eine spezieller Hinweis, der beim Bearbeiten angezeigt wird.

Unterseiten anlegen

Verwendungen dieser Vorlage Diese Dokumentation befindet sich auf einer eingebundenen Unterseite [Bearbeiten]. Die Kategorien werden von einer Unterseite eingebunden (Bearbeiten/Auflösen). Für diese Vorlage existiert eine Wartungsseite [Bearbeiten] zum Auffinden fehlerhafter Verwendungen. Für diese Vorlage existiert eine XML-Beschreibung [Bearbeiten] für den Vorlagenmeister. Anwendungsbeispiele und Funktionalitätsprüfungen befinden sich auf der Testseite [Bearbeiten]. Es existiert ein Bearbeitungshinweis [Bearbeiten], der beim Bearbeiten der Vorlage angezeigt wird. Liste der Unterseiten.