Hilfe:syntaxhighlight

aus Wikipedia, der freien Enzyklopädie
Wechseln zu: Navigation, Suche

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]

Syntax[Bearbeiten | Quelltext bearbeiten]

Syntax zur Erstellung von Quelltexten:

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

Ausgabe:

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

Alternativ kann auch <source> genutzt werden, falls das zu markierende Beispiel ein Tag <syntaxhighlight> enthält. Bis 2009 war <source> das bevorzugte Element. Nachdem in HTML5 ein Multimedia-Element gleichen Namens eingeführt worden war, wurde die Präferenz getauscht; die deutschsprachige Wikipedia hat es weitgehend eliminiert. Zwar ist ohnehin keine unmittelbare Verwendung derartiger HTML-Elemente in einem Wikitext möglich, aber Bearbeiter sollten nicht durch gleichnamige Elemente völlig unterschiedlicher Bedeutung verwirrt werden. Und <source> könnte im dargestellten HTML-Beispiel vorkommen.

Parameter[Bearbeiten | Quelltext bearbeiten]

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 inline lang="css">
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 line highlight="1,3-5,8" lang="php">
Die Zeilen 1, 3 bis 5 und 8 werden hellgelb unterlegt.
1 <?php
2   echo "Hallo Welt!";
3   echo "Hallo Welt!";
4   echo "Hallo Welt!";
5   echo "Hallo Welt!";
6   echo "Hallo Welt!";
7   echo "Hallo Welt!";
8 ?>

line
<syntaxhighlight line lang="php">
Die Zeilen werden durchnummeriert.
1 <?php
2   echo "Hallo Welt!";
3   echo "Hallo Welt!";
4   echo "Hallo Welt!";
5   echo "Hallo Welt!";
6   echo "Hallo Welt!";
7   echo "Hallo Welt!";
8 ?>

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

start
<syntaxhighlight line start="10" lang="php">
Die Zeilen werden durchnummeriert, die Zeilenzählung beginnt bei 10.
10 <?php
11   echo "Hallo Welt!";
12 ?>
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 entspricht.
enclose= konnte früher noch weitere Werte annehmen (etwa "div"), die heute keine Bedeutung mehr haben.

Sprachen[Bearbeiten | Quelltext bearbeiten]

Unterstützte Sprachen[Bearbeiten | Quelltext bearbeiten]

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

Code Sprache
abap ABAP
abnf ABNF
actionscript
as
ActionScript
actionscript3
as3
ActionScript3
ada
ada95
ada2005
Ada
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
befunge Befunge
bf
brainfuck
Brainfuck
bibtex BibTeX
blitzbasic
b3d
bplus
Blitz BASIC
bnf Backus-Naur-Form  * pygments
boo Boo
c C
cadlisp AutoLISP
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
dtd DTD
dylan Dylan
dylan-console
dylan-repl
Dylan-Console  * pygments
ebnf Extended Backus–Naur Form
eiffel Eiffel
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
gambas Gambas
gap GAP
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)
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
mapbasic MapBasic
matlab MATLAB (M)
matlabsession MatlabSession
mako Mako (Mako (template engine) [en])
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
perl
pl
Perl
perl6
pl6
Perl 6 (Perl 6 [en])
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
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
red Red (Red (programming language) [en])
redcde Redcode (Asm)
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)
scala Scala
scheme
scm
Scheme
scilab Scilab
sdlbasic SDL-Basic
sh
bash
ksh
shell
Shell (mit Kornshell)
shell-session
console
ShellSession
smalltalk Smalltalk
smarty Smarty
sml SML
snobol SNOBOL (SNOBOL [en])
sparql SPARQL
squid
squidconf
squid.conf
Squid (Konfig.)
sql SQL
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])
xml XML
yaml YAML
xpp Microsoft Dynamics AX
xquery
xqy
xq
xql
xqm
XQuery
xslt XSLT
z80 ZiLOG Z80<Asm

Unter Pygments zurzeit nicht mehr unterstützt[Bearbeiten | Quelltext bearbeiten]

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
dot DOT (GraphViz)
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)
Kürzel Sprache
gml Game Maker Language (GML)
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
Kürzel Sprache
parasail ParaSail
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

Entgegen der MediaWiki-Liste nicht unterstützte Sprachen[Bearbeiten | Quelltext bearbeiten]

Nicht funktionierende Codes 
Kürzel Sprache
cfdg CFDG
div DIV
e e
en:E (programming language)
euphoria Euphoria
genero Genero
oz Oz
spark SPARK

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.

Anpassungen[Bearbeiten | Quelltext bearbeiten]

Einzelne Verwendung[Bearbeiten | Quelltext bearbeiten]

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.

Benutzer[Bearbeiten | Quelltext bearbeiten]

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[Bearbeiten | Quelltext bearbeiten]

Weltweit einheitlich wird angepasst:

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

Vorlagenprogrammierung[Bearbeiten | Quelltext bearbeiten]

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[Bearbeiten | Quelltext bearbeiten]

Seiten mit nicht erkanntem Sprachcode werden in der Kategorie:Wikipedia:Seite mit Syntaxhervorhebungsfehlern aufgelistet.

Sie wird über MediaWiki:syntaxhighlight-error-category definiert.

GeSHi[Bearbeiten | Quelltext bearbeiten]

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[Bearbeiten | Quelltext bearbeiten]

 MediaWiki: Extension:SyntaxHighlight GeSHi – Technische Informationen (englisch)
Phabricator – Workboard: #syntaxhighlight

Listen unterstützter Sprachen (englisch)

Extern

Anmerkungen[Bearbeiten | Quelltext bearbeiten]

  1. Falls du in deinen Einstellungen die Option Vorschau sofort 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