Vorlage:Dokumentation

aus FreewarWiki, der Referenz für Freewar
Wechseln zu: Navigation, Suche

[Bearbeiten] Dokumentation

Diese Vorlage erzeugt einen Dokumentationsbaustein wie diesen hier. Sie bindet den Text der Unterseite „/Dokumentation“ ein.

Diese Vorlage sollte möglichst in allen Vorlagen verwendet werden.

Sinn dieser Vorlage

Wird eine Vorlage in einer Seite aufgerufen, so wird der gesamte Vorlagentext neu ausgewertet - samt der Dokumentation, die durch das Setzen des „noinclude“-Tags ohnehin wieder weggelassen wird. Zudem werden im FreewarWiki Vorlagen verwendet, die teilweise tausendfach eingebunden sind. Eine Änderung an diesen Vorlagen, beispielsweise eine Verbesserung im Dokumentationstext innerhalb einer Vorlage, erzeugt dies eine lange Auftragswarteschlange und somit eine hohe Serverlast.

Durch die Trennung von Quellcode und Dokumentation schafft man nicht nur Übersicht sondern entlastet auch das Wiki: Dadurch, dass die Dokumentation in einer Unterseite steht wird sie bei einem Vorlagenaufruf nicht mitgeladen. Auch eine Änderung des Dokumentationstextes ist problemlos möglich und erzeugt keine endlos lange Auftragswarteschlange.

Benutzung

Diese Vorlage erwartet keine Parameter. Es reicht, wenn man <noinclude>{{Dokumentation}}</noinclude> ans Ende einer Vorlage schreibt und die Dokumentationsseite [[<Seitenname>/Dokumentation]] erstellt. Achte gegebenenfalls darauf, dass du zwischen dem Vorlagentext und der Dokumentationseinbindung keinen Zeilenumbruch setzt, da dies unter Umständen das Aussehen der eingebundenen Vorlage stark beeinflussen kann.