User:Wirklich/Documentation

From Wikimedia Commons, the free media repository
Jump to navigation Jump to search

Diese Seite samt Unterseiten bildet eine selbstdokumentierende Vorlage. Durch Einbindung einer Unterseite in die Vorlage, die ihrerseits die Vorlage einbindet, wird sowohl der Wikitext-Quellcode als auch die Auswirkung einer Änderung sofort nach dem Speichern in der Vorlagenseite angezeigt.

Dadurch entfällt das mühsame und fehlerbehaftete Ändern der Dokumentation, wenn die Vorlage geändert wird. Außerdem wird gerne darauf vergessen, die Dokumentation nachzuziehen.

Alles, was du tun musst, ist den Text User:wirklich/ aus allen Unterseiten von Documentation zu entfernen und die Vorlage Documentation samt Unterseiten in deinem Wiki anzulegen. Ich bleibe hier auf meinen Userinnenseiten, daher steht überall User:wirklich/, wo im Vorlagennamensraum nichts stehen würde.

An der Seite Preload-Belegung für die Erstellung einer Dokumentationsunterseite habe ich ziemlich lange gefeilt, bis ich mit dem Ergebnis zufrieden war. Wenn du dich mit der Syntax von Preload-Seiten näher befassen willst, habe ich hier einige Erkenntnisse gesammelt.

Nutzen kannst du die Vorlagendokumentation wie untenstehend beschrieben.

Vorlagendokumentation

Anzeigen • Bearbeiten • Versionen • Cache löschen

diese Vorlage habe ich aus der Vorlagendokumentation auf Commons erstellt, nicht benötigte Teile habe ich entfernt, um die Übersichtlichkeit zu verbessern und das Verständnis zu erleichtern

{{!}} ist ein magisches Wort und erzeugt das Pipe-Zeichen | (der senkrechte Strich, der in der MediaWiki-Syntax ständig benötigt wird)

Die Zeichenfolge {{{!}} darf nicht getrennt werden, weil dies zu {| umgewandelt wird und somit eine Tabellezeile erzeugt.

Einbinden der Dokumentationsunterseite User:Wirklich/Documentation/doc, wenn sie existiert • dieser Text dient als Orientierungshilfe und wird nicht eingebunden

Beginn der Dokumentationsunterseite User:Wirklich/Documentation/doc

Diese Vorlage zeigt eine Dokumentationsbox, wie du sie gerade siehst. Sie bindet den Text von der Unterseite [[<Vorlagenname>/doc]] ein.

Begründung[edit]

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[edit]

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[edit]

Ende der Dokumentationsunterseite User:Wirklich/Documentation/doc

Und so schaut es aus, wenn keine doc-Unterseite vorhanden ist: User:wirklich/Documentation/nodoc

Unterseiten
Links auf diese Seite
Alle Wirklich-Seiten
Retrieved from "https://commons.wikimedia.org/w/index.php?title=User:Wirklich/Documentation&oldid=268402544"