Vorlage:Dokumentation/Doku

Aus MosaPedia

Wechseln zu: Navigation, Suche
Dokumentations-Unterseite Diese Seite ist die Dokumentations-Unterseite der Vorlage:Dokumentation.


Die Vorlage Dokumentation ist ein Helfer zur Unterstützung der Vorlagen-Dokumentation in Unterseiten.

Zweck

Zu einer Vorlage:XYZ wird die Dokumentation in eine Unterseite Vorlage:XYZ/Doku ausgelagert und (nur beim direkten Betrachten der Vorlage) von dieser eingebunden.

Vorteile:

  • Die Trennung von Programmcode und Dokumentation macht den Quelltext übersichtlicher.
  • Die Dokumentation kann bearbeitet werden, während die Vorlage selbst gesperrt ist.
  • Nach dem Bearbeiten der Dokumentation ist kein Neuaufbau von Seiten erforderlich, die die Vorlage einbinden. (Bei häufigen Bearbeitungen bzw. häufig eingebundenen Vorlagen reduziert dies die Serverlast.)

Funktion

Das Einfügen von {{Dokumentation}} in eine Vorlage:XYZ bewirkt folgendes:

  • Wenn die Seite Vorlage:XYZ/Doku existiert, wird diese eingebunden.
  • Falls die Doku-Unterseite (noch) nicht existiert, wird Vorlage:XYZ zur Kategorie: Vorlage:nicht dokumentiert hinzugefügt.

Damit beides nur beim direkten Betrachten der Vorlage:XYZ stattfindet, muss die Einbindung {{Dokumentation}} von <noinclude>...</noinclude> eingeschlossen werden.

(Mehr zum Thema Vorlageneinbindung unter http://www.mediawiki.org/wiki/Help:Templates/de und http://www.mediawiki.org/wiki/Help:Transclusion.)

Benutzung

Um zu einer Vorlage:XYZ eine ausgelagerte Dokumentation hinzuzufügen,

  1. füge
    <noinclude>{{Dokumentation}}</noinclude>
    in die Vorlage:XYZ ein (üblicherweise am Ende),
  2. erstelle die Dokumentations-Unterseite Vorlage:XYZ/Doku.


Persönliche Werkzeuge