Zum Inhalt springen

Vorlage:Syntax/Doku

Aus Wikibooks

< Vorlage:Syntax

Zweck dieser Vorlage

Mit dieser Vorlage wird Quelltext einer Programmiersprache mit Syntax-Hervorhebung angezeigt. Es ersetzt die folgenden Code-Darstellungen:

<syntaxhighlight lang="xxx">Quelltext</syntaxhighlight>
<source lang="xxx">Quelltext</source>^[1]

Aufruf

Dies ist ein Beispiel für eine Eingabe:

{{syntax|lang=sql|border=1|lines=on|code=
SELECT ID, Name, Vorname
  from Table1
 where Name STARTING WITH 'A'; }}

So wird dies als SQL-Code dargestellt:

SELECT ID, Name, Vorname
  from Table1
 where Name STARTING WITH 'A';

Parameter

Die Parameter können in beliebiger Reihenfolge angegeben werden. Sie haben folgende Bedeutung:

lang (Pflicht): Dies gibt die Programmiersprache („language“) an, nach deren Regeln Schlüsselwörter und konstante Werte markiert werden sollen.

code (Pflicht): Dies enthält den Quelltext, der hervorgehoben werden soll. Zeilenumbruch wird so übernommen, wie er eingegeben wird.

border (Option)

Damit kann ein Rahmen um den Quelltext gesetzt werden.

Ohne diesen Parameter wird kein Rahmen gesetzt.
Mit dem Wert border=1 wird ein einfacher durchgehender Rahmen angezeigt (wie im Beispiel).
Mit dem Wert border=2 wird ein einfacher gestrichelter Rahmen angezeigt (analog zum Beispiel).
Es ist auch eine vollständige Rahmen-Definition möglich:
border=4px dashed red
Dabei werden Rahmenstärke, Stil und Farbe angegeben. Erläuterungen dazu stehen in der CSS-Referenz.

lines (Option): Mit diesem Parameter (beliebiger Wert) werden die Zeilen im Quelltext nummeriert.
Es wird empfohlen, dies nur in Ausnahmefällen zu benutzen, weil nummerierter Code nur umständlich mit Copy & Paste übernommen werden kann.

Hinweise

Die zulässigen Programmiersprachen stehen auf Supported languages.

Name und Verwendung der Vorlage sollen <source lang="xxx"> möglichst intuitiv ersetzen.

Ursprünglich diente die Vorlage dazu, die Schrift innerhalb eines <syntaxhighlight>-Abschnitts zu vergrößern, weil nach den MediaWiki-Einstellungen die Standardschrift zu klein angezeigt wurde. Dieser Gesichtspunkt ist inzwischen entfallen. Aber die Vorlage ist weiterhin für einheitliche Darstellung von Quellcode geeignet.

Folgende Vorlagen dienen ähnlichen Verwendungszwecken:

↑ <source lang="xxx"> ist sowieso veraltet und sollte durch <syntaxhighlight lang="xxx"> ersetzt werden.

Abgerufen von „https://de.wikibooks.org/w/index.php?title=Vorlage:Syntax/Doku&oldid=599139“