User:Wirklich/Documentation/doc

Diese Seite ist die Dokumentations-Unterseite der Seite User:Wirklich/Documentation.

Diese Vorlage zeigt eine Dokumentationsbox, wie du sie gerade siehst. Sie bindet den Text von der Unterseite [[<Vorlagenname>/doc]] 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>{{Documentation}}</noinclude> ans Ende der Vorlage <Vorlagenname> schreibt und die Dokumentationsseite [[<Vorlagenname>/doc]] erstellt.

Nach dem Einbinden der Documentation-Vorlage erscheint ein Link zum Erstellen der Dokumentationsunterseite

• Dokumentationsunterseite <Vorlagenname>/doc erstellen

wenn du diesen anklickst, wird die Unterseite mit einer vorausgefüllten Beschreibung angelegt. Anschließend braucht die Beschreibung nur noch ausgefüllt zu werden, z.B. die Parametertabelle und ein kurzer Text über die Funktionsweise der Vorlage, und schon ist die Dokumentation fertig.

Wenn du die Dokumentationsunterseite durch Anklicken des Links in der hellblauen Box erstellst, erhältst du eine leere Seite.

Die Dokumentationsunterseite <Vorlagenname>/doc ist nicht vorhanden.

---

Unterseiten anlegen

---

Unterseiten

• Wirklich/Documentation/doc

Verwendungen dieser Vorlage

• User:Wirklich/Documentation/layout ‎ (← links | edit)
• User:Wirklich/Documentation (transclusion) ‎ (← links | edit)
• User:Wirklich/Documentation/nodoc ‎ (← links | edit)