Extension:SyntaxHighlight/de

Die SyntaxHighlight-Erweiterung, früher bekannt als SyntaxHighlight_GeSHi, stellt reiche Formatierung von Quellcode bei der Verwendung des Tags  bereit. Sie wird von der Library Pygments angetrieben und unterstützt Hunderte von Programmiersprachen und Dateiformaten.

Genau wie die Tags  und   wird der Text genau so dargestellt, wie er getippt wurde und bewahrt so jegliche Leerzeichen.

Verwendung
Einmal installiert, kann man den "syntaxhighlight"-Tag auf Wikiseiten verwenden. Zum Beispiel

ist das Ergebnis des folgenden Wikitext-Markups:

In älteren Versionen (vor MediaWiki 1.16) benutzte die Erweiterung den Tag. Dieser wird noch immer unterstützt, jedoch hilft  Konflikte zu vermeiden, wenn der Quellcode selbst   Tags enthält (z.B. XML).

Gestaltung
Wenn der angezeigte Code zu groß ist, kann dieser angepasst werden, indem folgendes in die MediaWiki:Common.css Seite in Ihrem Wiki getan wird (wenn diese nicht existiert, muss sie erzeugt werden):

Um Codeblocks in Kanten einzuschließen, muss eine Zeile wie  in die Sektion oben eingefügt werden. Kontrolle über die verwendete Schriftartfamilie kann durch Einfügen einer Zeile wie  in die obere Sektion ausgeübt werden.

Kategorie für Syntaxhervorhebungsfehler
Die Erweiterung fügt Seiten, die ein fehlerhaftes -Attribut in einem  - oder  -Tag haben zu einer tracking category hinzu. Der Nachrichtenschlüssel MediaWiki:syntaxhighlight-error-category bestimmt den Kategorienamen; auf diesem Wiki ist das Category:.

Der häufigste Fehler, der dazu führt, dass Seiten zu dieser Kategorie hinzugefügt werden ist ein  oder   Tag ganz ohne   Attribut, da ältere Versionen dieser Erweiterung die Definition von "$wgSyntaxHighlightDefaultLang" unterstützten. Diese können üblicherweise entweder durch  ersetzt werden oder   oder   kann zum Tag hinzugefügt werden.

Die Kategorie kann auch zugewiesen werden und der Inhalt nicht hervorgehoben werden, wenn der Text länger als 1000 Zeilen oder größer als 100 kB ist.

lang
Das  Attribut definiert, welcher Lexer verwendet werden soll. Die Auswahl der Sprache beeinflusst, wie der Quellcode hervorgehoben wird. Details zu unterstützten Sprachen finden sich im Abschnitt Unterstützte Sprachen.

Wenn ein ungültiger oder unbekannter Name verwendet wird, wird die Seite der Wartungskategorie zugeordnet. Für Details siehe den Abschnitt Kategorie mit Syntaxhervorhebungsfehlern.

line
Das  Attribut aktiviert Zeilennummern.

start
Das  Attribut (in Kombination mit  ) definiert die erste Zeilennummer des Codeblocks. Zum Beispiel bewirkt  hier, dass die Nummerierung bei der Zahl 55 beginnt.

highlight
Das -Attribut definiert eine oder mehr Zeilen, die markiert werden sollen (indem diese Zeilen mit einer anderen Hintergrundfarbe hervorgehoben werden). Man kann mehrere Zeilennummern kommasepariert (zum Beispiel ) angeben oder Bereiche, indem man zwei Zeilennummern mit einem Bindestrich angibt (zum Beispiel  ). Zu beachten ist, dass die Zeilennummernangabe jegliche Renummerierung der angezeigten Zeilne durch das -Attribut ignoriert.

ist das Ergebnis von

inline
Das Attribut weist darauf hin, dass der Quellcode Fließtext als Teil des Paragraphen sein soll (statt ein eigener Block zu sein). Diese Option ist ab MediaWiki 1.26 verfügbar. Das -Attribut resultiert für Abwärtskompatibilität im gleichen Verhalten.

Zu beachten ist, dass Zeilenumbrüche an irgendeiner Stelle zwischen dem Öffnen und Schließen der Tags stehen können, außer der Quellcode ist mit  (auf Wikis die dies unterstützen, siehe unten) oder   als nicht umbrechbar markiert.

Zum Beispiel:

Der folgende  ist ein Lambdra-Ausdruck in Python.

ist das Ergebnis von:

Der folgende  ist ein Lambda-Ausdruck in Python.

class
Wenn  benutzt wird, bewirkt   (auf Wikis, die es unterstützen; nicht auf MediaWiki selbst), dass keine Zeilenumbrücke bei Leerzeichen innerhalb des Codeblocks auftreten sollten.

Zum Beispiel:

Ohne :

xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx With : xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx

style
Das -Attribut erlaubt es, CSS-Atribute direkt einzubinden. Das ist das Gleiche, wie den Block in ein -(nicht  -)Tag einzuschließen. Das -Attribut kann nicht auf diese Weise gesetzt werden; es benötigt ein umschließendes  -Tag, so wie unter Advanced beschrieben.

Zum Beispiel:

ist das Ergebnis von:

Unterstützte Sprachen
Die Pygments-Bibliothek bietet Unterstützung für hunderte Programmiersprachen und Dateiformate. Die vollständige Liste mit Stand Januar 2020:

Programmiersprachen
ActionScript

Ada

Agda (inkl. literate)

Alloy

AMPL

ANTLR

APL

AppleScript

Assembly (verschiedene)

Asymptote

Augeas

AutoIt

Awk

BBC Basic

Befunge

BlitzBasic

Boa

Boo

Boogie

BrainFuck

C, C++ (inkl. Dialekte wie Arduino)

C#

Chapel

Charm++ CI

Cirru

Clay

Clean

Clojure

CoffeeScript

ColdFusion

Common Lisp

Component Pascal

Coq

Croc (MiniD)

Cryptol (inkl. Literate Cryptol)

Crystal

Cypher

Cython

D

Dart

DCPU-16

Delphi

Dylan (inkl. console)

Eiffel

Elm

Emacs Lisp

Email

Erlang (inkl. Shell-Sitzungen)

Ezhil

Factor

Fancy

Fantom

Fennel

FloScript

Fortran

FreeFEM++

F#

GAP

Gherkin (Cucumber)

GLSL Shader

Golo

Gosu

Groovy

Haskell (inkl. Literate Haskell)

HLSL

HSpec

Hy

IDL

Idris (inkl. Literate Idris)

Igor Pro

Io

Jags

Java

JavaScript

Jasmin

Jcl

Julia

Kotlin

Lasso (inkl. templating)

Limbo

LiveScript

Logtalk

Logos

Lua

Mathematica

Matlab

Modelica

Modula-2

Monkey

Monte

MoonScript

Mosel

MuPad

NASM

Nemerle

NesC

NewLISP

Nimrod

Nit

Notmuch

NuSMV

Objective-C

Objective-J

Octave

OCaml

Opa

OpenCOBOL

ParaSail

Pawn

PHP

Perl 5

Pike

Pony

PovRay

PostScript

PowerShell

Praat

Prolog

Python (inkl. Konsolensitzungen und Tracebacks)

QBasic

Racket

Raku a.k.a. Perl 6

REBOL

Red

Redcode

Rexx

Ride

Ruby (inkl. irb sessions)

Rust

S, S-Plus, R

Scala

Scdoc

Scheme

Scilab

SGF

Shell-Skripte (Bash, Tcsh, Fish)

Shen

Silver

Slash

Slurm

Smalltalk

SNOBOL

Snowball

Solidity

SourcePawn

Stan

Standard ML

Stata

Swift

Swig

SuperCollider

Tcl

Tera Term language

TypeScript

TypoScript

USD

Unicon

Urbiscript

Vala

VBScript

Verilog, SystemVerilog

VHDL

Visual Basic.NET

Visual FoxPro

Whiley

Xtend

XQuery

Zeek

Zephir

Zig

Template-Sprachen
Angular Templates

Cheetah Templats

ColdFusion

Django/Jinja Templates

ERB (Ruby templating)

Evoque

Genshi (die Trac Template Language)

Handlebars

JSP (Java Server Pages)

Liquid

Myghty (das HTML::Mason basierte Framework)

Mako (der Nachfolger von Myghty)

Slim

Smarty Templates (PHP templating)

Tea

Twig

Andere Markup-Sprachen
Apache Konfigurationsdateien

Apache Pig

BBCode

CapDL

Cap'n Proto

CMake

Csound Partituren

CSS

Debian Kontrolldateien

Diff-Dateien

Dockerfiles

DTD

EBNF

E-Mail Kopfzeilen

Extempore

Flatline

Gettext-Kataloge

Gnuplot-Skript

Groff-Markup

Hexdumps

HTML

HTTP-Sitzungen

IDL

Inform

INI-style config files

IRC logs (irssi style)

Isabelle

JSGF notation

JSON, JSON-LD

Lean theorem prover

Lighttpd config files

Linux Kernel logs (dmesg)

LLVM assembly

LSL-Skripte

Makefiles

MoinMoin/Trac Wiki Markup

MQL

MySQL

NCAR Befehlssprache

Nginx Konfigurationsdateien

Nix-Sprache

NSIS-Skripte

Notmuch

POV-Ray scenes

Puppet

QML

Ragel

Redcode

ReST

Roboconf

Robot Framework

RPM spec files

Rql

RSL

Scdoc

SPARQL

SQL, also MySQL, SQLite

Squid configuration

TADS 3

Terraform

TeX

Thrift

TOML

Treetop-Grammatiken

USD (Universal Scene Description)

Varnish-Configs

VGL

Vim Script

WDiff

Windows-Batch-Dateien

XML

XSLT

YAML

Windows Registry-Dateien

Für genaue Sprachcodes, siehe komplette Details im Pygments-Dokument und es gibt auch ein paar Zuordnungen für Sprachnamen, welche von GeSHi unterstützt wurden (vollständige Liste)

Anschließend folgt eine unvollständige Liste mit Sprachen, die GeSHi hervorheben konnte. Sprachen, die seit der Umstellung auf Pygments nicht mehr unterstützt werden, sind durchgestrichen.

Konfiguration

 * Linux:


 * (optional): Absoluter Pfad zu "pygmentize" aus dem Pygments-Paket. Die Erweiterung beinhaltet das Pygments-Paket und  zeigt standardmäßig auf die mitgelieferte Version. Man kann jedoch auf eine andere Version zeigen, wenn man will. Zum Beispiel:.
 * : Setzt den Standard-Lexer für einige Wikiseiten. Standardmäßig wird dies JavaScript und CSS-Seiten highlighten. Zusätzliche Content-Modelle können mittels Erweiterungen konfiguriert werden (z.B. Lua, JSON, ...). Beispiel:


 * Windows:


 * Wenn das Mediawiki auf einer Windows-Maschine gehostet wird, muss der Pfad zur Pygmentize.exe gesetzt werden:
 * Wenn es keine  gibt, muss   per Kommandozeile von innerhalb des  -Verzeichnisses ausgeführt werden, um die Datei zu erzeugen.

Wenn die mitgelieferte pygmentize-Binary (extensions/SyntaxHighlight_GeSHi/pygments/pygmentize) verwendet wird, muss sichergestellt werden, dass der Webserver die Berechtigung hat, sie auszuführen. Wenn der Host es nicht gestattet, ausführbare Dateien im Webverzeichnis zu hinterlegen, muss python-pygments installiert werden und  in LocalSettings.php gesetzt werden.


 * Fehlerbehebung:

Einige Benutzer berichteten von Problemen mit der Erweiterung nach einem Update auf MediaWiki 1.26 oder höher. Es gab Fälle, wenn Sprachen wie "Lua" nicht hervorgehoben wurden und wenn Debugging angeschaltet wurde, schmiss MediaWiki den Fehler.


 * Versuche,  in der LocalSettings.php auf eine externe pygmentize-Binary zeigen zu lassen.
 * In shared hosting environments with cPanel, this can be done by setting up a new Python application through the "Setup Python App" menu, and activating the virtual environment for the app through SSH . After this, the Pygments module can be added to the Python app, for which navigate to the virtual environment path, download and install Pygments and then activate the module by adding "Pygments" under the "Existing applications" section of the "Setup Python App" menu. This will create the required file at path:


 * Dieser Phabricator Task enthält weitere Vorschläge und Informationen.

VisualEditor-Integration
Das Plugin ermöglicht direktes Editieren mit VisualEditor. Es öffnet sich ein PopUp, wenn ein User  oder  -Abschnitte bearbeiten will. Damit das funktioniert, muss VisualEditor von der neuesten Git-Version installiert und konfiguriert werden. Gleiches gilt für Parsoid. Diese Feature funktioniert willkürlich nicht mit älteren Parsoid-Versionen. Für Details, siehe Extension:SyntaxHighlight/VisualEditor

Erweitert
Anders als bei - und  -Tags muss (und sollte) hier bei HTML-Zeichen-Gebilden wie   das  -Zeichen nicht mittels   escaped werden. Wie beim -Tag, aber anders als beim  -Tag, muss bei Tags im Bereich (außer dem eigenen schließenden Tag) weder das  -Symbol als   escaped werden, noch muss Wikitext mit einem  -Tag escaped werden.

Während  davon ausgeht, dass alle 8 Zeichen ein Tabstopp auftritt und Tabs tatsächlich mittels Leerzeichen dargestellt werden, wenn der gerenderte Text kopiert wird, benutzt   Tabstopps aus nur 4 Leerzeichen (außer Internet Explorer, welcher 8 benutzt) und bewahrt die Tabstopp-Zeichen im gerenderten Text; letzteres Verhalten kann durch Einschließen in ein  -Tag geändert werden (nicht   und nicht durch Verwendung eines eigenen  -Attributs) Das -Präfis wird für Firefox (ab Version 4.0) benötigt und das  -Präfix wird für Opera (ab Version 10.60 bis Version 15) benötigt. (Beachten: Das Wiki-Editor-Kästchen geht von 8-Leerzeichen-Tabs aus.) Dies bezieht sich nur auf tastächlich auch gespeicherte Seiten; Vorschauen, die durch ein Editieren-Kästchen oder Special:ExpandTemplates erzeugt wurden, können abweichen.

Siehe auch

 * Pygments – Python syntax highlighter
 * Erweiterungen, die von dieser abhängen:
 * – hebt Seiten basierend auf Titel-Suffixen hervor.
 * Alternative Erweiterungen:
 * – Syntaxhervorhebung, die die "Google Code Prettify"-Bibliothek verwendet.
 * – Syntaxhervorhebung, die die "SyntaxHighlighter"-Bibliothek verwendet.