Schoffer: Beispiel/Dokumentation

2011-03-15T15:24:43Z

Beispiel/Dokumentation

Neue Seite

==Verwendungszweck==

Diese Vorlage dient dazu, (Code-)Beispiele in eine einheitliche Form zu bringen. Bei Bedarf kann die Vorlage geändert werden, so dass sich alle Beispiele mit einem Handgriff in ihrer Form ändern lassen.

Der Erläuterungstext sollte sich nur auf das Beispiel selbst beziehen. Allgemeine Erläuterungen zum Thema bitte im Fließtext außerhalb der Beispiel-Box unterbringen. In der bisherigen SELFHTML-Ausgabe 8.x bezieht sich der Abschnitt „Erläuterung:“ oftmals nicht direkt auf das Beispiel, sondern allgemein auf das behandelte Thema und sollte in angemessener Weise in den Fließtext übernommen werden.

Bei Beispielen, für die eine „So sieht's aus“-Ansicht verfügbar sein soll, kann der optionale Parameter zeige=… eingefügt werden. Derzeit sollte als Parameterwert ein Dummy-Wert eingetragen werden (zeige=dummy). Das Erstellen des eigentlichen Anzeige-Beispiels ist, um Missbrauch zu verhindern, den Beispiele-Administratoren vorbehalten.

==Anwendung==

Diese Vorlage ist modular aufgebaut. Zu ihr gehören weitere Vorlagen, mit der sich in beliebiger Reihenfolge Beispiel-Text- und Erläuterungsmodule zusammenfügen lassen.

<pre><nowiki>{{Beispiel|
Module
}}</nowiki></pre>

Verfügbare Module sind:
* <code><nowiki>{{BeispielCode|...}}</nowiki></code> für Code aller Art
* <code><nowiki>{{BeispielWiki|...}}</nowiki></code> für alles was sich mit Wiki-Syntax erstellen lässt
* <code><nowiki>{{BeispielText|...}}</nowiki></code> für Erläuterungstext

Es gibt zwei optionale Parameter:
* <code>titel=...</code> für eine Ergänzung der Überschrift
* <code>zeige=...</code> für den Verweis auf ein anklickbares "So sieht's aus"

=== Beispiele für die Parameter ===
==== mit erweiterter Überschrift ====
<pre>{{Beispiel|titel=mit erweiterter Überschrift|
{{BeispielCode|...}}
}}
</pre>

{{Beispiel|titel=mit erweiterter Überschrift|
{{BeispielCode|...}}
}}

==== anklickbar ====

Um ein Beispiel anklickbar zu gestalten ist die Berechtigung ''Beispiele-Administratoren'' notwendig. Wer diese Berechtigung nicht hat, und (s)ein Beispiel anklickbar gestaltet haben möchte, sollte <code>zeige=dummy</code> setzen – '''bitte nicht''' vorgreifend einen <code>Beispiel:</code>-Dateinamen selbständig vergeben. Derzeit ist vorgesehen, dass sich dann die ''Beispiele-Administratoren'' manuell um die Anklickbarkeit kümmern. Siehe auch [[Hilfe:Beispiele‎]].

<pre>{{Beispiel|zeige=Beispiel:Beispiel.txt|
{{BeispielCode|...}}
}}
</pre>

{{Beispiel|zeige=Beispiel:Beispiel.txt|
{{BeispielCode|...}}
}}

==== mit erweiterter Überschrift, anklickbar ====
<pre>{{Beispiel|
titel = mit erweiterter Überschrift|
zeige = Beispiel:Beispiel.txt|

{{BeispielCode|...}}
}}
</pre>

{{Beispiel|
titel = mit erweiterter Überschrift|
zeige = Beispiel:Beispiel.txt|

{{BeispielCode|...}}
}}

=== Beispiele für die Module ===
==== Code-Modul ====
Der anzuzeigende Code sollte entweder in <pre>, <nowiki> oder <source> eingefasst werden.

===== <pre> =====
Es kann nur einfacher Text eingegeben werden. Alle HTML-eigenen Zeichen können normal geschrieben werden. Wenn ein </pre> Bestandteil des anzuzeigenden Codes ist, so ist es als <code>&lt;/pre></code> zu notieren.

<pre>{{Beispiel|titel = mit <pre>|
{{BeispielCode|

<pre>

<p class="foo">bar baz</p>
<pre> ... &lt;/pre>
</pre>

}}
}}</pre>

{{Beispiel|titel = mit <pre>|
{{BeispielCode|

<pre>

<p class="foo">bar baz</p>
<pre> ... </pre>
</pre>

}}
}}

===== <nowiki> =====
Im Gegensatz zu <pre> kann man <nowiki> problemlos verlassen, um Wiki-Formatierungen einzubauen.

<pre>{{Beispiel|titel = mit <nowiki>|
{{BeispielCode|

<nowiki>
<p class="foo">bar baz </nowiki>'''und ein fett hervorgehobener Teil'''<nowiki></p>
</nowiki>

}}
}}</pre>

{{Beispiel|titel = mit <nowiki>|
{{BeispielCode|

<nowiki>
<p class="foo">bar baz </nowiki>'''und ein fett hervorgehobener Teil'''<nowiki></p>
</nowiki>

}}
}}

===== <source> =====
Mit diesem Element kann man Code automatisch mit Syntaxhervorhebung anreichern lassen. Verwendbare Parameter:
* <code>lang="??"</code>: Sprache des Codes. '''Eine Liste der Werte bekommt man bei Eingabe eines falschen Wertes angezeigt''' (Vorschau-Funktion verwenden!)
* <code>line</code>: schaltet die Zeilennummerierung ein.
* <code>line start="??"</code>: Zeilennummerierung beginnt ab …
* <code>highlight="??"</code>: welche Zeilen sollen hervorgehoben werden. Zählung beginnt immer mit 1, auch bei Verwendung von <code>line start=...</code>. Die Zeilennummern können kommagetrennt entweder einzeln oder als Bereich mit Bindestrich angegeben werden.

<pre>{{Beispiel|titel = mit <source>|
{{BeispielCode|

<source lang="html4strict">
<p class="foo">bar baz</p>
</source>

}}
}}</pre>

{{Beispiel|titel = mit <source>|
{{BeispielCode|

<source lang="html4strict">
<p class="foo">bar baz</p>
</source>

}}
}}

==== Wiki-Modul ====
Es kann beliebige Wiki-Syntax verwendet werden. Allerdings sind zwei Besonderheiten zu beachten. Wenn der Inhalt ein Gleichheitszeichen (=) enthält, muss wie beim nachfolgenden Tabellen-Beispiel (wegen border=1) am Anfang ein 1= eingefügt werden. Ansonsten gibt es eine Warnmeldung. Problematisch ist auch das Pipe-Zeichen (|) für das eine Ersatzschreibweise verwendet werden muss: [[Hilfe:Vorlagen#Problem:_Senkrechter_Strich_in_Parametern]].

<pre>{{Beispiel|
{{BeispielWiki|titel=mit Einrückung|
vorn
ein-
ge-
rückt
}}
}}</pre>

{{Beispiel|titel=mit Einrückung|
{{BeispielWiki|
vorn
ein-
ge-
rückt
}}
}}

<pre>{{Beispiel|titel=mit Liste|
{{BeispielWiki|
* auf-
* ge-
* zählt
}}
}}</pre>

{{Beispiel|titel=mit Liste|
{{BeispielWiki|
* auf-
* ge-
* zählt
}}
}}

<pre>{{Beispiel|titel=mit Tabelle|
{{BeispielWiki|1=
<table border="1"><tr>
<td>Orangen</td>
<td>Äpfel</td>
</tr><tr>
<td>Brot</td>
<td>Kuchen</td>
</tr><tr>
<td>Butter</td>
<td>Eiskrem</td>
</tr></table>
}}
}}</pre>

{{Beispiel|titel=mit Tabelle|
{{BeispielWiki|1=
<table border="1"><tr>
<td>Orangen</td>
<td>Äpfel</td>
</tr><tr>
<td>Brot</td>
<td>Kuchen</td>
</tr><tr>
<td>Butter</td>
<td>Eiskrem</td>
</tr></table>
}}
}}

<pre>{{Beispiel|titel=mit Tabelle in Pipe-Syntax|
{{BeispielWiki|1=
{{(!}} border="1"
{{!}}Orangen
{{!}}Äpfel
{{!-}}
{{!}}Brot
{{!}}Kuchen
{{!-}}
{{!}}Butter
{{!}}Eiskrem
{{!)}}
}}
}}</pre>

{{Beispiel|titel=mit Tabelle in Pipe-Syntax|
{{BeispielWiki|1=
{{(!}} border="1"
{{!}}Orangen
{{!}}Äpfel
{{!-}}
{{!}}Brot
{{!}}Kuchen
{{!-}}
{{!}}Butter
{{!}}Eiskrem
{{!)}}
}}
}}

==== Kommentar-Modul ====
Dient zur Erläuterung des Beispiels. Bezüglich Gleichheitszeichen (=) und Pipe-Symbol (|) gelten die selben Hinweise wie beim [[#Wiki-Modul|Wiki-Modul]].

<pre>{{Beispiel|titel=mit Erklärung|
{{BeispielCode|...}}
{{BeispielText|Kommentar zum Code}}
}}
</pre>

{{Beispiel|titel=mit Erklärung|
{{BeispielCode|...}}
{{BeispielText|Kommentar zum Code}}
}}

==== Mehrfache Modulanwendung ====
Module können in beliebiger Reihenfolge und Anzahl eingefügt werden. Zwischen den Modulen kann eine Leerzeile eingefügt werden, mehr als eine zerreißt die Box.

<pre>
{{Beispiel|titel=- mehrteilig|

{{BeispielCode|<pre></pre>}}

{{BeispielText|Kommentar zum ersten Code-Teil}}

{{BeispielCode|<pre></pre>}}

{{BeispielText|Kommentar zum zweiten Code-Teil}}

{{BeispielWiki|
* eine
* Liste
}}

{{BeispielText|Kommentar zur Liste}}

}}</pre>

{{Beispiel|titel=- mehrteilig|

{{BeispielCode|<pre></pre>}}

{{BeispielText|Kommentar zum ersten Code-Teil}}

{{BeispielCode|<pre></pre>}}

{{BeispielText|Kommentar zum zweiten Code-Teil}}

{{BeispielWiki|
* eine
* Liste
}}

{{BeispielText|Kommentar zur Liste}}

}}

Vorlage:Beispiel/Dokumentation - Versionsgeschichte

Schoffer: Beispiel/Dokumentation