Vorlage:Dokumentation

Dokumentation zu dieser Vorlage

---

Verwendungszweck

Diese Vorlage dient zur Anzeige einer Unterseite mit der Dokumentation zu einem Textbaustein oder einer Formatvorlage. Dadurch werden Programmcode, Dokumentation dazu und Diskussion darüber sauber getrennt.

Begründung

• Befand sich die Dokumentation ursprünglich im Textbaustein bzw. in der Formatvorlage selbst, so macht die Trennung von Programmcode und Dokumentation den Quelltext übersichtlicher.
• Kleine Änderung in der Dokumentation führen nicht dazu, dass die einbindenden Seiten neu generiert werden müssen.
• In der Versionsgeschichte der Vorlagenseite erscheinen nur noch Änderungen, die den Programmcode betreffen.
• Befand sich die Dokumentation ursprünglich auf der Diskussionsseite des Textbausteins bzw. der Formatvorlage, so wird durch die Trennung von Diskussion und Dokumentation genau zwischen Meinung und Sache unterschieden.
• In der Versionsgeschichte der Diskussionsseite erscheinen nur noch Änderungen, die die Diskussion betreffen.
• In der Versionsgeschichte der Dokumentationsseite erscheinen nur noch Änderungen, die die Dokumentation betreffen.

Benutzung der Vorlage Dokumentation

• Diese Vorlage erwartet keine Parameter.
• Bei einem Textbaustein bzw. einer Formatvorlage muss der programmierte Code in <includeonly> sowie </includeonly> eingeschlossen werden.
• Nach dem </includeonly> erfolgt dann die Anzeige der Dokumentation und die Kategoriezuordnung.
• Dazu wird <noinclude>{{Dokumentation}}</noinclude> hinzugefügt.
• Die Kategoriezuordnung kann nach dem {{Dokumentation}}, muss aber vor dem </noinclude> eingefügt werden.
• Nach dem Speichern wird ein Link zu der Unterseite mit der Dokumentation angezeigt.
• Die Unterseite mit der Dokumentation [[<Vorlage>/Doku]] kann erstellt werden.

Hinweise für die Unterseite mit der Dokumentation

• Mit dem Einsatz der Vorlage Dokumentation gemäß obiger Vorgehensweise in einem Textbaustein bzw. einer Formatvorlage bekommt man Unterstützung für das Erstellen und Anzeigen von Unterseiten mit Dokumentation.
• Ist die Unterseite mit der Dokumentation noch nicht vorhanden, so wird ein Link zu der Unterseite mit der Dokumentation angezeigt.
• Ist die Unterseite mit der Dokumentation schon vorhanden, so wird zudem die Dokumentation zum Textbaustein bzw. zur Formatvorlage angezeigt.
• Auf der Unterseite mit der Dokumentation wird zunächst <noinclude>{{Dokumentation/Link}}</noinclude> eingefügt
• Damit wird über der Dokumentation ein Link zur korrespondierenden Vorlage angezeigt.
• Die eigentliche Dokumentation der Vorlage kann danach eingefügt werden.
• Die Kategoriezuordnung der Dokumentationsseite kann direkt nach dem {{Dokumentation/Link}}, muss aber unbedingt vor dem </noinclude> hinzugefügt werden.