Benutzerin:ɞɞ/Documentation
Vorlagendokumentation
Ich habe die Vorlagen auf Commons, in der englischen und in der deutschen Wikipedia kombiniert, Teile entfernt, die ich nicht benötige, um die Übersichtlichkeit zu verbessern und das Verständnis zu erleichtern.
Meine Vorlagendoku zeigt in der Vorlagenseite den Wikitext an, der die Vorlage erzeugt, wobei der Text direkt aus der Vorlage eingebunden wird. Das bedeutet, dass sich die Dokumentation automatisch aktualisiert, wenn die Vorlage geändert wird. Sobald die Vorlagendokumentation in eine Vorlage eingebunden wird, wirst du darauf hingewiesen, dass eine Unterseite /doc erforderlich ist. Dieser Name ist fest vorgegeben, da ich den Aufwand für eine Variationsmöglichkeit (derzeit) nicht treiben und die Vorlagendokumentation so einfach wie möglich gestalten wollte.
Weiters wird wenn möglich ein Anwendungsbeispiel eingebunden, sodass du nach der Änderung der Vorlage sofort die Auswirkung siehst, ohne die Seite verlassen zu müssen. Alles, was du tun musst, ist die doc-Unterseite über den angebotenen Link erstellen, damit die Vorlage/preload-doc beim Anlegen benutzt wird (an dieser Seite habe ich eine ganze Weile getüftelt, bis sie genau das tut, was ich will; es ist durchaus möglich, dass ich weitere Verbesserungen vornehmen werde). Den Text für die Dokumentation musst du natürlich selbst eintippen, den kann mein Programm nicht vorhersagen.
Einbinden der Dokumentationsunterseite Benutzerin:ɞɞ/Documentation/doc, wenn sie existiert ·
dieser Text dient als Orientierungshilfe und wird nicht eingebunden
Die Vorlage {{Documentation}} zeigt eine Dokumentationsbox, wie du sie gerade siehst. Sie bindet den Text von der Unterseite [[<Seitenname>/doc]] ein.
Begründung[Bearbeiten]
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.
- Diese Dokumentation aktualisiert sich automatisch und bindet den jeweils aktuellen Wikicode der Vorlage in die Dokumentationsseite ein.
Verwendung[Bearbeiten]
{{Documentation}}
Parameter[Bearbeiten]
- keine
|
|
Wenn die Unterseite /doc nicht vorhanden ist[Bearbeiten]
Du hast die Vorlagendokumentation mit dem Befehl {{Documentation}} eingebunden
Damit die Dokumentation wie vorgesehen funktioniert, ist es erforderlich, dass du für deine Vorlage {{Documentation}} die Unterseite {{Documentation/doc}} anlegst, das kannst du mit der Box unterhalb dieses Text durchführen, es wird eine vorausgefüllte Seite basierend auf der Seite {{Documentation/preload-doc}} erzeugt. Eine leere Seite kannst du mit dem Link anlegen.