Vorlage:Dokumentation/Dokumentation

[Aktualisieren | Hilfe]

Dies ist die Dokumentation, sie wird auf der Vorlagenseite eingebunden. Siehe Vorlage:Dokumentation für weitere Informationen.

Diese Vorlage dient der einheitlichen Darstellung von Dokumentationen für alle Vorlagen und Module. Eine Dokumentation muss immer geschrieben werden.

Anwendung

Am Ende von jeder Vorlage wird diese Vorlage wie folgt eingebunden: <noinclude>{{Dokumentation}}</noinclude>. Daraufhin erscheint eine leere Dokumentation und der rot hinterlegte Hinweis, eine neue Dokumentation anzulegen. Die Vorlage erscheint dann automatisch in der Kategorie:Vorlagen ohne Dokumentation.

[Erstellen | Versionen | Aktualisieren] Dokumentation Zum Gebrauch von Vorlagen siehe die Vorlagen-Hilfe.

Diese Vorlage hat keine Dokumentation. Wenn du weißt, wie die Vorlage funktioniert, dann dokumentiere sie bitte.

Um die Dokumentation anzulegen, klickt man einfach auf den Link. Das öffnet die Unterseite /Dokumentation der Vorlage im Bearbeitungsmodus und füllt sie mit einem Textgerüst. Dort ersetzt man die Kommentare mit dem Dokumentationstext, der Navigationsbox und evtl. Interwikilinks. Der Aufbau des Dokumentationstextes ist in der Vorlagenhilfe beschrieben. Das Textgerüst kommt aus der Vorlage:Dokumentationsvorbelegung. Sobald die Dokumentation existiert, verschwindet die Vorlage aus der Kategorie:Vorlagen ohne Dokumentation.

Bei Modulen wird die leere Dokumentation und der rot hinterlegte Hinweis automatisch durch MediaWiki:Scribunto-doc-page-show und MediaWiki:scribunto-doc-page-does-not-exist angezeigt, im Modul selbst ist dazu nichts einzutragen. Auch Module ohne Dokumentation erscheinen in der Kategorie:Vorlagen ohne Dokumentation.

[Erstellen | Versionen | Aktualisieren] Dokumentation Zum Gebrauch von Lua-Modulen siehe die Modul-Hilfe.

Dieses Modul hat keine Dokumentation. Wenn du weißt, wie es funktioniert, dann erstelle sie bitte.

Parameter

{{Dokumentation|type=|baddoc=|lua=|demo=}}

Parameter	Bedeutung
type=	Optional: Der Typ der Dokumentation, wenn er sich nicht aus dem Namensraum ergibt. Mögliche Werte: Vorlage, Modul. Der Typ steuert den angezeigten Text, der sich bei Vorlagen und Modulen unterscheidet.
baddoc=	Optional: Wenn Dieser Parameter bei einer Vorlage mit existierender Dokumentation belegt wird (z.B. mit baddoc=1), wird die Dokumentation rot hinterlegt und der Kategorie:Vorlagen mit unzureichender Dokumentation zugeordnet.
lua=	Optional: Dieser Parameter kann bei einer Vorlage mit existierender Dokumentation hinzugefügt werden, indem dort das Lua-Modul angegeben wird, das die Vorlage aufruft, z.B. lua=Sprite. Das Modul wird dann am Ende der Vorlagendokumentation angezeigt.
demo=	Optional: Wenn Dieser Parameter belegt wird (z.B. mit demo=1), wird die Seite keiner Kategorie zugeordnet.