Vorlage:Kurzdokumentation


Dokumentation


Dokumentation ansehenbearbeitenVersionsverlaufCache leeren
Seite geschützt
Das Bild zeigt das Logo der Auszeichnungssprache CSS.
Vorlage nutzt TemplateStyles

Diese Vorlage dient dazu, Dokumentationen als Kurzversionen direkt auf der Vorlagenseite einzubauen. Dies ist ein für kleine Vorlagen, die nicht häufig geändert werden, vorgesehene Abkürzung und sollte mit Bedacht gewählt werden.

Achtung:Für Vorlagen, deren Dokumentations-Inhalt sich häufiger ändert oder die komplex sind empfiehlt sich weiterhin die Nutzung der Vorlage {{Dokumentation}}, da sie eine bessere Übersicht und Darstellung bietet.

Verwendung Bearbeiten

Die Vorlage wird ohne Parameter in den <noinclude>…</noinlcude> Block eingebunden und erzeugt eine Optische Trennung, sowie die Auto-Kategoriesierung der Vorlage. Der Dokuemtationsinhalt folgt innerhalb des Blocks.

Beispiel und Kopiervorlage Bearbeiten

<noinclude>
{{Kurzdokumentation}}
Der Inhalt der Dokumentation…
</noinclude>

Wartung Bearbeiten

Die Vorlage soll nur in den Namensräumen Vorlage: und Modul: eingesetzt werden.

Fehlerhafte Einbindungen werden aufgelistet in der Kategorie: Vorlagenfehler/Vorlage:Kurzdokumentation – aktuell keine   (vor 8 Stunden) Aktualisieren