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.

Syntax

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.

Kopiervorlage

<syntaxhighlight lang="">
</syntaxhighlight>

<source>

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. Ab 2020 soll dieses Element dann vollständig wegfallen, jede Verwendung wird vorbereitend darauf in einer Wartungskategorie eingetragen.

Parameter

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

inline	Art der Einbindung
highlight	Zeilen hervorheben
line	Zeilennummern anzeigen
start	Zeilennummer-Beginn
strict	Programmiersprache streng interpretieren
enclose	(Art der Einbindung)
class style id title dir	Standard-Parameter

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>

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

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

Kann nicht gemeinsam mit highlight verwendet werden.

style

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

Standard-Attribut in HTML.

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

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

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.

Sprachen

Unterstützte Sprachen

Die folgenden Sprachen werden von dieser Erweiterung unterstützt (Auszug):

Code	Sprache
abap	ABAP
abnf	ABNF
actionscript as	ActionScript
actionscript3 as3	ActionScript3
ada ada95 ada2005	Ada
amdgpu	Amdgpu  * pygments
antlr	ANTLR
apache apacheconf aconf	Apache Configuration
applescript	AppleScript
arm	ARM
asm gas	Assembler (Gas)
aspx-vb asp	Active Server Pages (ASP für Visual Basic)
asymptote asy	Asymptote
autohotkey ahk	AutoHotkey
autoit	AutoIt
awk gawk mawk nawk	AWK
basic4gl	Basic4GL (Basic4GL [en])
bat dos dosbatch winbatch batch	Batch (Winbatch [en]) * pygments
bbcode	BBCode
bdd	BDD
befunge	Befunge
bf brainfuck	Brainfuck
bibtex	BibTeX
blitzbasic b3d bplus	Blitz BASIC
bnf	Backus-Naur-Form  * pygments
boo	Boo
c	C
cadlisp	AutoLISP
cddl	Cddl  * pygments
cfm	Coldfusion Markup
chaiscript chai	ChaiScript (ChaiScript [en])
clojure clj	Clojure
clojurescript cljs	ClojureScript
cmake	CMake
cobol	COBOL
coffeescript coffee-script coffee	CoffeeScript
control debcontrol	DebianControl
coq	Coq
cpp c++	C++
cpp-qt	Qt-Bibliothek
cryptol cry	Cryptol (Cryptol [en])
csharp c#	CSharp (C#)  * pygments
css	Cascading Style Sheets (CSS)
cython pyx pyrex	Cython
d	D
dart	Dart
dcpu16	DCPU-16 (0x10c [en])
delphi pas pascal objectpascal	Delphi  * pygments
diff udiff	Diff
dot graphviz	DOT
dtd	DTD
dylan	Dylan
dylan-console dylan-repl	Dylan-Console  * pygments
ebnf	Extended Backus–Naur Form
eiffel	Eiffel
elpi	Elpi  * pygments
emacs elisp emacs-lisp	Emacs Lisp
erb	ERB
erlang	Erlang
ezhil	Ezhil (Ezhil (programming language) [en])
factor	Factor
fancy fy	Fancy (Ruby)  * pygments
fortran	Fortran
freebasic	FreeBASIC
fsharp	F-Sharp
fstar	Fstar (F* (programming language) [en])
futhark	Futhark (Futhark (programming language) [en])
gambas	Gambas
gap	GAP
gdscript gd	GDScript
genshi kid xml+genshi xml+kid	Genshi (Genshi (templating language) [en])
gettext pot po	Gettext  * pygments
gherkin cucumber	Gherkin (Ruby)
glsl	GLShader
gnuplot	gnuplot
go	Go
groff nroff man	Groff
groovy	Groovy
gwbasic	GW-BASIC
haskell hs	Haskell
haxe hx hxsl	Haxe
hexdump	Hexdump  * pygments
html html4strict html5	Hypertext Markup Language (HTML)
http	HTTP
ini cfg dosini	INI (Datei)
io	Io
irc	IRC
j	J
java java5	Java
javascript js ecmascript jquery	JavaScript
json	JSON
jsonld json-ld	JSON-LD
jsp	Jsp
kotlin	Kotlin
latex tex	LaTeX (TeX)
lighttpd lighty	Lighttpd (Conf)
lilypond	LilyPond
lisp common-lisp cl	CommonLisp
llvm	LLVM
locobasic	Locomotive BASIC
logtalk	Logtalk (Logtalk [en])
lsl	Linden Scripting Language
lua	Lua  * pygments
m68k	Motorola 68000
make makefile mf bsdmake	Makefile
mako	Mako (Mako (template engine) [en])
mapbasic	MapBasic
markdown md	Markdown
matlab	MATLAB (M)
matlabsession	MatlabSession
mathematica nb mma	Mathematica
maxima	Maxima
minid	MiniD
mmix	MMIX (Asm)
modelica	Modelica
modula2 m2	Modula-2  * pygments
moin trac-wiki	Moin Wiki
mpasm	PICmicro (Asm)
msc mscgen	MSC
mupad	MuPad
mxml	MXML (MXML [en])
myghty	Myghty (Pylons project#templating [en])
mysql	MySQL
nemerle	Nemerle (Nemerle [en])
netrexx	NetRexx (NetRexx [en])
newlisp	NewLISP
newspeak	Newspeak (Newspeak (programming language) [en])
nginx	Nginx (Konfig.)
nimrod nim	Nimrod (Nimrod (distributed computing) [en])
nsis nsi nsh	Nullsoft Scriptable Install System (NSIS)
numpy	NumPy (NumPy [en])
oberon2	Oberon-2
objc obj-c objective-c objectivec	Objective-C
objj obj-j objective-j objectivej	Objective-J (Objective-J [en])
ocaml ocaml-brief	OCaml
octave	Octave
oobas	OpenOffice Basic
oorexx	Object REXX (Object REXX [en])
openedge progress abl	OpenEdge (Progress)
oracle11	Oracle 11
oracle8	Oracle 8
peg	Peg (Parsing expression grammar [en])
perl pl	Perl
php php3 php4 php5	PHP  * pygments
php-brief	PHPBrief (deprecated – no colors, odd framing)
pic16	PICmicro (Asm)
pike	Pike
plsql	PL/SQL
postgresql postgres	PostgreSQL
postscript postscr	PostScript
psql postgresql-console postgres-console	PostgreSQL (Konsole)
pov povray	POV-Ray
powershell posh ps1 psm1	Windows PowerShell
ps1con	PowerShellSession
praat	Praat  * pygments
prolog	Prolog
promql	PromQL
properties jproperties	Java-Properties-Datei
purebasic	PureBasic
pycon	Python Konsole  * pygments
pys60	Python (S60)
python py sage	Python
pytb	PythonTraceback
python3 py3	Python3
py3tb	Python3Traceback
qbasic basic	QBasic
ragel	Ragel (Ragel [en])
rails	Rails
raku perl6 pl6	Raku
reason reasonml	Reason (Reason (programming language) [en])
red	Red (Red (programming language) [en])
redcde	Redcode (Asm)
rita	RITA  * pygments
rst rest restructuredtext	RST
robotframework	Robot Framework
rebol	Rebol
registry reg	Registry (MS Windows)
rexx arexx	REXX
rpmspec spec	RPM (Spec files)
ruby rb duby	Ruby
rbcon irb	Ruby Konsole  * pygments
rql	RQL
rust	Rust
s splus r rspluse	S (mit R)
savi	Savi  * pygments
scala	Scala
scheme scm	Scheme
scilab	Scilab
sdlbasic	SDL-Basic
sed	sed
sh bash ksh shell	Shell (mit Kornshell)
shell-session console	ShellSession
sieve	Sieve
smalltalk	Smalltalk
smarty	Smarty
sml	SML
snobol	SNOBOL (SNOBOL [en])
sophia	Sophia  * pygments
spice	Spice  * pygments
sparql	SPARQL
squid squidconf squid.conf	Squid (Konfig.)
sql	SQL
srcinfo	.SRCINFO  * pygments
systemverilog sv	SystemVerilog
tcl	Tcl
tcsh csh	Tcsh
tcshcon	TcshSession
text	Plain text
thinbasic	ThinBasic
ts typescript	TypeScript
tsql	Transact-SQL
turtle	Turtle
upc	Unified Parallel C (UPC)
urbi	Urbi (URBI [en])
urbiscript	UrbiScript (Urbiscript [en])
vala vapi	Vala
vb vbnet vb.net	Visual Basic (und Visual Basic .NET)
verilog v	Verilog
vhdl	VHDL
vim	Vim
visualfoxpro	Visual FoxPro
foxpro vfp clipper xbase	FoxPro (MS-Visual)
visualprolog	Visual Prolog (Visual Prolog [en])
webidl	WebIDL (Web IDL [en])
xml	XML
xpp	Microsoft Dynamics AX
xquery xqy xq xql xqm	XQuery
xslt	XSLT
yaml	YAML
yang	Yang (YANG [en])
z80	ZiLOG Z80<Asm

Unter Pygments zurzeit nicht mehr unterstützt

Die nachstehenden Codes gab es mit GeSHi, seit Sommer 2015 aber nicht mehr mit Pygments:

Nicht mehr unterstützte Sprachen 

Kürzel Sprache 4cs 4CS algol68 Algol 68 apt_sources Apt sources autoconf Autoconf avisynth AviSynth caddcl AutoCAD DCL AutoCAD DCL cil Common Intermediate Language cuesheet Cuesheet dcl Dialog Control Language Data Control Language dcs Data Conversion System email Email (mbox \ eml \ RFC-Format) epc Enerscript f1 Formula One falcon Falcon en:Falcon (programming language) fo FO freeswitch FreeSWITCH en:FreeSWITCH gdb GDB genie Genie en:Genie (programming language) gml Game Maker Language (GML)

Kürzel Sprache hicest HicEst hq9plus HQ9+ icon Icon inno Inno Setup intercal INTERCAL kixtart KiXtart klonec Klone C klonecpp Klone C++ lb Liberty Basic ldif LDAP Data Interchange Format lolcode LOLCODE (en) lotusformulas Formula language (en) lotusscript LotusScript lscript LScript lsl2 Linden Scripting Language magiksf magiks en:Magik (programming language) mirc mIRC modula3 Modula-3 nagios Nagios objeck Objeck oxygene Oxygene parasail ParaSail

Kürzel Sprache parigp PARI/GP (en) pcre Perl Compatible Regular Expressions per per pf PF pixelbender Adobe Pixel Bender pli PL/I powerbuilder PowerBuilder proftpd ProFTPD providex ProvideX q Q (en) robots Robots Exclusion Standard sas sas en:SAS (software) stonescript StoneScript, Skriptsprache für ShiVa teraterm Tera Term typoscript TypoScript unicon unicon en:Unicon (programming language) uscript UnrealScript vedit VEDIT whitespace Whitespace whois Whois-Protokoll xorg_conf X.Org-Server-Konfiguration

Anpassungen

Einzelne Verwendung

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

• Seit Mitte 2012 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.

Benutzer

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;
}

Mediawiki

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.

Vorlagenprogrammierung

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 =
}}

aufgerufen werden. Als Beispiel für eine solche Verwendung sei auf die Vorlage Patch verwiesen.

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

Wartung

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.

GeSHi

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