Regal:Programmierung: Vorlage:SingleCode/Doku

	Diese Vorlage benutzt eine komplexe Syntax des Media-Wiki-Templatesystems. Bitte unternimm keine Veränderungen an diesem Template, solange Du Dir nicht absolut darüber im Klaren bist, wie dieses Template funktioniert. Sei darauf vorbereitet, dass sich Deine Veränderungen an diesem Template negativ auf Seiten oder andere Templates auswirken können, die dieses Template verwenden. Tests an diesem Template sollten ausschließlich auf der Spielwiesenvorlage vorgenommen werden.

Verwendung

Diese Vorlage stellt Code mit Syntax-Hervorhebung für eine Programmiersprache oder nur die Ausgabe an. Sie ist eine Vereinfachung von Regal:Programmierung: Vorlage:MultiCode und orientiert sich an dieser Vorlage; auf die Verwendung der Klappbox wird verzichtet.

Anzeige

Dies ist ein C#-Beispiel.

public class Beispielklasse
{
  int help;
}

Ausgabe

Hilfe     Text     Kommentar
-----     ----     ---------
a = 1     dann     weiter
b > 2

Dies ist eine kursive Abschlusszeile.

Diese Anzeige wird durch folgende Eingabe erreicht:

{{:Regal:Programmierung: Vorlage:SingleCode|
|kopf=Dies ist ein '''C#-Beispiel'''.
|fuss=''Dies ist eine kursive Abschlusszeile.''
|line=line
|lang=csharp
|code=public class Beispielklasse
{
  int help;
}
|output=Hilfe     Text     Kommentar
-----     ----     ---------
a = 1     dann     weiter
b > 2
}}

Parameter

Pflicht-Parameter ohne Namen

(1) die allgemeine Vorgabe für die Anzeige
- valid oder v – grüner Hintergrund, OK-Icon
- error oder e – roter Hintergrund, Cancel-Icon
- Standard – blauer Hintergrund, kein besonderer Hinweis
  Diese Variante wird in allen Fällen verwendet, in denen weder "e/error" noch "v/valid" angegeben wird; der erste Parameter kann auch leer sein (wie im obigen Beispiel).

Optionale Parameter für den "Rahmen" der Anzeige

Die folgenden Parameter können wahlweise angegeben oder weggelassen werden. Nur aus Gründen der Übersichtlichkeit wird empfohlen, sie am Anfang zusammenzufassen.

kopf – Am Anfang des Rahmens wird eine Kopfzeile ausgegeben; diese kann mit Wiki-Syntax beispielsweise fett formatiert werden.
Bei valid oder error wird eine Kopfzeile als Begründung dringend empfohlen; das Icon wird als Zusatz zur Kopfzeile angezeigt.
fuss – Am Ende des Rahmens wird eine Fußzeile ausgegeben; diese kann ebenfalls mit Wiki-Syntax formatiert werden.

Optionale Parameter für die genaue Anzeige

Die folgenden Parameter beeinflussen den jeweiligen Quell- bzw. Ausgabetext.

lang – Programmiersprache, nach der der Quelltext formatiert werden soll.
Für die Syntax-Hervorhebung wird das SyntaxHighlighting mit GeSHi verwendet; auf dieser Seite stehen unter Supported languages die zur Verfügung stehenden Programmiersprachen.
code – der eigentliche Quelltext
line=line (in dieser Schreibweise) – Im Code-Abschnitt werden die Zeilen nummeriert.
Es wird empfohlen, dies nur in Ausnahmefällen zu benutzen, weil nummerierter Code nur umständlich mit Copy & Paste übernommen werden kann.
output – Dies zeigt das Ergebnis einer Maßnahme an, z. B. einer Berechnung. Dieser Abschnitt wird als einfacher Text mit Schreibmschinenschrift formatiert (genauer: er benutzt die Syntax-Hervorhebung mit lang=text). Hervorhebung durch Wiki-Syntax ist nicht möglich.

Hinweise

Bei C, C++, C# u.a. kann das Pipe-Zeichen | nicht als Teil des Codes verwendet werden. Stattdessen muss {{!}} für | bzw. {{!!}} für || eingegeben werden (siehe das o. g. Beispiel).

Die Vorlage SingleCode wird in Anlehnung an die Darstellung der Vorlage MultiCode für einfache Situationen angeboten.

Anstelle der Vorlage SingleCode kann Regal:Programmierung: Vorlage:Code verwendet werden. Diese wird in vielen Projekten benutzt und bietet weitere Möglichkeiten:
- Die Programmiersprache für den Code wird angezeigt.
- Es gibt Varianten zur Darstellung des Codes.
- Unter anderem ist HTML-Rendering möglich.
- Bei Bedarf kann der Ausgabe-Text formatiert werden.

Noch einfachere Varianten für die Code-Darstellung gibt es so:
- Vorlage:Syntax – mit Syntax-Hervorhebung ohne Ausgabe-Fenster, keine Kopf- oder Fußzeile, wahlweise Umrandung
- <pre>Codc-Auszug</pre> – einfache, unformatierte Darstellung