Vorlage:Dokumentation/Beispiel/Doku

Zweck

Diese Viorlage erzeugt Beispieltabellen für die Darstellung von Code den zugehörigen Beispielen für Dokumentationen und Hilfeseiten.

Parameter (TemplateData)

Fügt eine Darstellung für die Ausgabe von Code ein, die das Beispiel umrahmt.

Vorlagenparameter[Vorlagendaten bearbeiten]

Diese Vorlage bevorzugt Blockformatierung von Parametern.

Parameter		Beschreibung	Typ	Status
Ausgabe	ausgabe 1	Darstellung des Codebeispiels, kann eine Vorlage enthalten.	Wikitext	erforderlich
Eingabe	eingabe 3	Der einzugebende Text/Code, bei Wikitext mit "nowiki", "pre", oder "syntaxhighlight" schützen!	Wikitext	vorgeschlagen
Darstellungsform	typ 2	Art der Darstellung, als Tabelle (vertikal, horizontal) oder reines Ergebnis-Beispiel ohne Eingabe-Spalte. Vorgeschlagene Werte horizontal vertikal ergebnis Standard ergebnis	Einzeiliger Text	vorgeschlagen
Farb-Stil	style	Die Tabelle kann in verschiedenen Stadnard-Farbwelten des Wikis dargestellt werden. Vorgeschlagene Werte doku hilfe informal Standard doku Beispiel hilfe	Unbekannt	optional
Floating der Tabelle	float	Der Textumlauf kann gesteuert werden. Vorgeschlagene Werte left right Beispiel left	Einzeiliger Text	optional

Beispiele

Da die Vorlage selbst nicht in der Vorlage sein sollte, sind die unten dargestellten Beispiel-Rahmen die eigentliche Ausgabe und markieren nicht - wie sonst gedacht - das Ausgabe-Beispiel. Wer jetzt verwirrt ist…ich bin es auch.

Nur Ergenis-Darstellung

{{Dokumentation/Beispiel|{{StandardIcon|hilfe}}}}

Erzeugt die Ausgabe im Beispiel-Rahmen

Ausgabe-Beispiel
Hilfebereich bei Wikonia

Tabellenformate

Die Tabellenformate unterstützen Ein- und Ausgabedarstellung. Daher ist hier der Parameter eingabe auch notwendig.

Achtung:

Wenn es sich um Wikitext handelt, muss der Code vor der Übergabe an die Vorlage entsprechend gegen die Ausführung geschützt werden. z. B. durch die nutzung von <nowiki>...</nowiki>, <syntaxhighligh lang="wikitext">...</syntaxhighlight> pder <pre>...</pre>

Horizontale Tabelle

{{Dokumentation/Beispiel
|typ=horizontal
|eingabe=<nowiki>{{StandardIcon|hilfe}}</nowiki>
|ausgabe={{StandardIcon|hilfe}}
}}

Erzeugt die Ausgabe in der Beispieltabelle

	Eingabe	Ergebnis
{{StandardIcon|hilfe}}		Hilfebereich bei Wikonia

Vertikale Tabelle

{{Dokumentation/Beispiel
|typ=vertikal
|eingabe=<nowiki>{{StandardIcon|hilfe}}</nowiki>
|ausgabe={{StandardIcon|hilfe}}
}}

Erzeugt die Ausgabe in der Beispieltabelle

	{{StandardIcon|hilfe}}
Eingabe
	Hilfebereich bei Wikonia
Ausgabe

Styles und Float

Mit Angabe des Parameters style kann der Darstellungs-Typ ion die korrekte FArbwelt für die Tabelle versetzt werden. Standard ist doku.

Ausgabe für den Hilfe-Bereich

{{Dokumentation/Beispiel
|typ=horizontal
|eingabe=<nowiki>{{StandardIcon|hilfe}}</nowiki>
|ausgabe={{StandardIcon|hilfe}}
|style=hilfe
}}

Erzeugt die Ausgabe in der Beispieltabelle

	Eingabe	Ergebnis
{{StandardIcon|hilfe}}		Hilfebereich bei Wikonia

Neutrale Farb-Welt

{{Dokumentation/Beispiel
|typ=horizontal
|eingabe=<nowiki>{{StandardIcon|hilfe}}</nowiki>
|ausgabe={{StandardIcon|hilfe}}
|style=informal
}}

Erzeugt die Ausgabe in der Beispieltabelle

	Eingabe	Ergebnis
{{StandardIcon|hilfe}}		Hilfebereich bei Wikonia

Float

Mithilfe des Parameters float kann das Umfließen des Textes, sowie die Ausrichtung der Tabelle geändert werden. Mögliche Werte sind left und right

Siehe auch

• Hilfe:Vorlagenprogrammierung – Einsteig in die Vorlagenprogrammierung
• Kategorie:Dokumemtationsvoralgen – zur Gestaltung von Dokumentationen