Hilfe:Syntaxhighlight

Syntaxhighlight („Syntaxhervorhebung“) ist eine Erweiterung der MediaWiki-Software zur Darstellung von Programm-Quelltexten auf Wiki-Seiten. Die Quelltexte werden ihrer Syntax entsprechend farblich dargestellt.^[1] Im Dunkelmodus werden stark abweichende Farben angezeigt (Beispiel: diese Hilfeseite).

Basis-Syntax zur Erstellung von Quelltexten:

<syntaxhighlight lang="php">
<?php
  echo "Hallo Welt!";
?>
</syntaxhighlight>

Ausgabe:

<?php
  echo "Hallo Welt!";
?>

Hinzu kommt die Angabe optionaler Parameter.

<syntaxhighlight lang="">
</syntaxhighlight>

Zunächst hatte das Element <source> geheißen; bis 2009 war dies das bevorzugte Tag. Nachdem in HTML5 ein Multimedia-Element gleichen Namens eingeführt worden war, wurde die Präferenz getauscht. Weil <source> im dargestellten HTML-Beispiel vorkommen könnte, sollte nur noch das kollisionsfreie <syntaxhighlight> verwendet werden. Die deutschsprachige Wikipedia hat <source> seit Jahren eliminiert. Inzwischen ist dieses Element vollständig weggefallen, eine fälschliche Verwendung wird in eine Wartungskategorie eingetragen.

Die Schreibrichtung des Codes ist immer explizit von links nach rechts, auch wenn eingebunden in einen Textbereich, der von rechts nach links (englisch: right to left, RTL) schreibt.

Die Angabe von lang ist Pflichtparameter. Optional gibt es außerdem:

inline

<syntaxhighlight lang="css" inline>

Damit kann formatierter Computercode innerhalb eines Absatzes erzeugt werden. Beispiel: „Dies ist ein Test um zu zeigen, dass beispielsweise CSS-Code table {display:none;} inline dargestellt werden kann.“

highlight

<syntaxhighlight lang="php" highlight="1,3-5,8" line>

Die Zeilen 1, 3 bis 5 und 8 werden hellgelb unterlegt.

<?php
  echo "Hallo Welt!";
  echo "Hallo Welt!";
  echo "Hallo Welt!";
  echo "Hallo Welt!";
  echo "Hallo Welt!";
  echo "Hallo Welt!";
?>

line

<syntaxhighlight lang="php" line>

Die Zeilen werden durchnummeriert.

<?php
  echo "Hallo Welt!";
  echo "Hallo Welt!";
  echo "Hallo Welt!";
  echo "Hallo Welt!";
  echo "Hallo Welt!";
  echo "Hallo Welt!";
?>

Die GeSHi-Funktionalität, jede fünfte Zeilennummer hervorzuheben, war 2016 noch nicht wiederhergestellt worden.

start

<syntaxhighlight lang="php" start="10" line highlight="2">

Die Zeilen werden durchnummeriert, die Zeilenzählung beginnt bei 10.

<?php
  echo "Hallo Welt!";
?>

Kann gemeinsam mit highlight verwendet werden, jedoch wird die erste sichtbare Zeile als highlight=1 gezählt unabhängig von der start-Nummerierung.

copy

<syntaxhighlight lang="php" copy>

Am rechten Rand wird ein Button zum Kopieren des Codes in die Zwischenablage angezeigt.

<?php
  echo "Hallo Welt!";
?>

style

<syntaxhighlight style="margin-left: 6em;" lang="html">

Standard-Attribut in HTML.

• Beispiel: Hier, um einen ganzen Block entsprechend dem Kontext um 6em einzurücken:

<syntaxhighlight style="margin-left: 6em;" lang="html">

enclose

<syntaxhighlight enclose="none" lang="css">

Veralteter Parameter, der als enclose="none" gerade dem inline entsprach.

enclose= konnte früher noch weitere Werte annehmen (etwa "div"), die heute keine Bedeutung mehr haben.

strict

Mit der Zuweisung strict="1" konnte die zugrundeliegende Software angewiesen werden, die Programmiersprache standardgemäß auszulegen, falls dafür eine gesonderte Definition verfügbar ist. Unter Pygments ist dies aber vermutlich nicht mehr wirksam.

Die folgenden Sprachen werden von dieser Erweiterung unterstützt (Auszug):^[2][3]

Die nachstehenden Codes gab es mit GeSHi, nicht mehr mit Pygments:

Es kann über den Parameter style= die aktuelle Einbindung angepasst werden, etwa Rahmen oder Einrückung.

• Seit Mitte 2012^[4] werden die Blöcke nicht mehr als <div> eingefügt, sondern (wenn nicht mit inline markiert) als <pre> mit dem hier standardmäßig vorgesehenen Rahmen.
  • Das ist bei einem mehrzeiligen Block sinnvoll; bei nur ein oder zwei Zeilen kann dies aber störend wirken.
  • style="border: none; padding: 0;"
    reduziert die Dekoration weitestmöglich.
• Seit 2015 ist beim inline-Style (und ganz allgemein) der Zeilenumbruch erlaubt; das umrahmte Feld eignet sich aber nicht dazu, auf mehrere Zeilen verteilt zu werden, und insbesondere bei Assembler-Sprachen kann das Einpassen längerer Zeilen in die momentane Bildschirmbreite sehr störend sein.
  • style="white-space:nowrap" verhindert das.

Seit Mitte 2015 werden nur noch die Elemente <pre> und <code> ausgeliefert.

Zu benutzerspezifischen Anpassungen siehe Skin/CSS.

• Ein interessantes Feature unter pygments; kann aber sehr anstrengend werden – die nachfolgende CSS-Sequenz macht auf Syntaxfehler aufmerksam:

.mw-highlight .err {
   border: #FF0000 1px solid;
}

Weltweit einheitlich wird angepasst:

• modules/pygments.generated.css – Dekoration der einzelnen Syntaxkonstrukte (Kommentar, Operator, Zeichenkette etc.)
• modules/pygments.wrapper.css – Darstellung des Codes im Kontext der Wiki-Seite (Einrückung, Hervorhebungen)

Benutzer können nach diesem Vorbild ihre eigenen Gewohnheiten wirken lassen.

Bei der Vorlagenprogrammierung mittels #tag: ist auf die Reihenfolge der Parameter zu achten. Es muss zwingend als erster Parameter der Content übergeben werden. Anschließend können die Angaben zur Sprache und dem umschließenden HTML-Tag erfolgen. Zudem dürfen keine Zeilenumbrüche zwischen den einzelnen Parametern enthalten sein.

{{#tag:syntaxhighlight|{{{code}}}|lang={{#if:{{{language|}}}|{{{language}}}|diff}}}}

Anschließend kann eine so entworfene Vorlage mit den Parametern

{{Vorlagenname
 |language=
 |code=
}}

eingebunden werden. Ein Beispiel für eine solche Verwendung ist die Vorlage „Patch“.

• Des Weiteren ist zu beachten, dass der Parameter code selbst direkt kein Pipezeichen enthalten darf (wie immer in der Vorlagenprogrammierung), dieses muss dann ggf. durch ein {{!}} ersetzt werden (Beispiel).

Der Code kann auch aus einer vollständigen Seite eingebunden werden:

{{#tag: syntaxhighlight | {{Modul:Hello}} | lang=lua}}

liefert

 local p = {} 
function p.hello(frame)
    local name = frame.args[1]
    if not name then 
        name = 'Welt' 
    end
    return  'Hallo, ' .. name .. '! Dies ist Lua!' 
end 
return p

Seiten mit nicht erkanntem Sprachcode oder anderen ungültigen Werten werden in der Kategorie:Wikipedia:Seite mit Syntaxhervorhebungsfehlern aufgelistet.

Sie werden über MediaWiki:Syntaxhighlight-error-category, MediaWiki:Syntaxhighlight-source-category und MediaWiki:Syntaxhighlight-enclose-category definiert.

Bis zum 25. Juni 2015 wurde das Paket GeSHi benutzt, seitdem pygments.

Um nicht alle Pfade und Definitionen und Bezeichner umstellen zu müssen, nennt sich die Erweiterung aber weiterhin „GeSHi“, und Identifikatoren behalten diesen Namensbestandteil.

Die Umstellung wurde erforderlich, weil es keine Upstream-Wartung und Pflege bei GeSHi mehr gab.

Weitere Informationen

MediaWiki: Extension:SyntaxHighlight GeSHi – Freie Wikisoftware (englisch)

Phabricator – Workboard: #syntaxhighlight

• Hilfe:Syntaxhighlight/VisualEditor – Beschreibung, wie Syntax-Code-Blöcke mit dem VisualEditor eingefügt oder bearbeitet werden können.

Listen unterstützter Sprachen (englisch)

• mw:Extension:SyntaxHighlight GeSHi #Supported languages
  • pygments-IDs (PHP)
    • MW-Alias (PHP)
• pygments.org

Extern

• pygments.org

1. ↑ Falls du in deinen Einstellungen die Option Vorschau ohne Neuladen der Seite anzeigen ausgewählt hast, wird Syntaxhighlight in der Vorschau einer Seite nicht angezeigt. Sie muss dann gespeichert werden, um sichtbar zu sein.
2. ↑ Die aktuelle Liste ist immer bei der Originaldokumentation
3. ↑ Bei Dialekten und Varianten wird der gleiche optische Effekt meist auch mit der Stamm-Sprache erreicht.
4. ↑ phab:T21416 (Bugzilla:19416), rev:113190