Extension:SyntaxHighlight - MediaWiki
Jump to content
From mediawiki.org
Translate this page
Languages:
Bahasa Indonesia
Tiếng Việt
Türkçe
català
dansk
magyar
norsk nynorsk
polski
português
português do Brasil
suomi
čeština
беларуская (тарашкевіца)
русский
татарча / tatarça
українська
中文
한국어
This extension
comes with MediaWiki 1.21
and later, so you do not need to download it. The remaining configuration instructions must still be followed.
For syntax highlighting in wikitext editors, such as the source editor, see the
CodeMirror
extension or the userscripts of
Remember the dot
and
Cacycle
MediaWiki extensions manual
SyntaxHighlight
Release status:
stable
Implementation
Tag
Description
Allows source code to be syntax highlighted on wiki pages
Author(s)
Brooke Vibber
Tim Starling
Rob Church,
Ori Livneh
Latest version
continuous updates
Compatibility policy
Master maintains backward compatibility.
MediaWiki
1.25+
Database changes
No
Parameters
$wgSyntaxHighlightMaxLines
$wgPygmentizePath
$wgSyntaxHighlightMaxBytes
Tags
<
syntaxhighlight
Hooks used
ApiFormatHighlight
ContentAlterParserOutput
ParserFirstCallInit
ResourceLoaderRegisterModules
SoftwareInfo
Licence
GNU General Public License 2.0 or later
Download extension
Git
Browse repository
GitHub
Gerrit code review
Git commit log
Download source tarball
README
Translate the SyntaxHighlight extension
Issues
Open tasks
Report a bug
The
SyntaxHighlight
extension, formerly known as SyntaxHighlight_GeSHi, provides rich formatting of
source code
using the
<
syntaxhighlight
tag.
It is powered by the
Pygments
library and supports hundreds of different programming languages and file formats.
Like the
<
pre
and
poem
tags, the text is rendered exactly as it was typed, preserving any white space.
The SyntaxHighlight extension does not work on wiki installations
hardened
using
Hardened-PHP
due to the lack of
proc_open
shell_exec
and other functions.
See
T250763
The
<
syntaxhighlight
tag has become
expensive
since 1.39 for 5,000 or some other extreme amount of syntaxhighlight tags in a single page such as for Wikibooks.
Increase webserver timeout value in environments in extreme cases.
(See
T316858
.)
Usage
Once installed, you can use "syntaxhighlight" tags on wiki pages. For example,
def
quick_sort
arr
):
less
[]
pivot_list
[]
more
[]
if
len
arr
<=
return
arr
else
pass
is the result of the following wikitext markup:
syntaxhighlight
lang
"python"
line
def
quick_sort
arr
):
less
[]
pivot_list
[]
more
[]
if
len
arr
<=
return
arr
else
pass
syntaxhighlight
To use on source code that is
transcluded
, for example from a module call, use the
#tag
parser and
safesubst:
{{
#tag
syntaxhighlight
|{{
safesubst
Module:Sandbox/userName/myModule
}}|
lang
lua
}}
Prior to MediaWiki 1.16, the extension used the tag
<
source
This is still supported, but is deprecated.
<
syntaxhighlight
should always be used.
Styling
If the displayed code is too big, you can adjust it by putting the following into the
MediaWiki:Common.css
page in your wiki (create it if it does not exist):
/* CSS placed here will be applied to all skins */
mw-highlight
pre
font-size
90
/* Insert additional CSS styling here */
Encasing code blocks in borders can be done by inserting a line like
border
1px
dashed
blue
in the section above.
Control over
font family
used can also be exercised by inserting a line like
font-family
"Courier New"
monospace
into the section above.
A practical method to generate CSS code in bulk that corresponds to one of the color schemes supported by Pygments is to run the following command from within the MediaWiki installation folder.
This example is for the
stata-dark
color scheme:
./extensions/SyntaxHighlight_GeSHi/pygments/pygmentize
-S
stata-dark
-f
html
sed
's/^/.mw-highlight /'
This will output a large chunk of CSS that looks something like:
mw-highlight
pre
line-height
125
mw-highlight
td
linenos
normal
color
inherit
background-color
transparent
padding-left
px
padding-right
px
mw-highlight
span
linenos
color
inherit
background-color
transparent
padding-left
px
padding-right
px
mw-highlight
td
linenos
special
color
#000000
background-color
#ffffc0
padding-left
px
padding-right
px
mw-highlight
span
linenos
special
color
#000000
background-color
#ffffc0
padding-left
px
padding-right
px
mw-highlight
hll
background-color
#49483e
mw-highlight
color
#777
font-style
italic
/* Comment */
mw-highlight
err
color
#A61717
background-color
#E3D2D2
/* Error */
mw-highlight
esc
color
#CCC
/* Escape */
/* ... and so on ... */
These CSS lines can then be copy-pasted into a site-wide CSS page such as MediaWiki:Common.css, or a skin-specific one such as MediaWiki:Vector.css.
Syntax highlighting error category
The extension adds pages that have a bad
lang
attribute in a
<
syntaxhighlight
tag to a
tracking category
The message key
MediaWiki:syntaxhighlight-error-category
determines the category name; on this wiki it is
Category:Pages with syntax highlighting errors
The most common error that leads to pages being tagged with this category is a
<
syntaxhighlight
tag with no
lang
attribute at all, because older versions of this extension supported the definition of
$wgSyntaxHighlightDefaultLang
These can typically either be replaced with
<
pre
, or
lang
"text"
can be added to the tag.
For example:
syntaxhighlight
lang
"text"
...
syntaxhighlight
The category may also be added, and the content will not be highlighted, if there are more than 1,000 lines or more than 100 kB text.
Parameters
lang
The
lang
name
attribute defines what lexer should be used.
The language affects how the extension highlights the source code.
See
#Supported languages
for details of supported languages.
def
quick_sort
arr
):
less
[]
syntaxhighlight
lang
"python"
...
syntaxhighlight
Specifying an invalid or unknown name will tag the page with a tracking category.
See the section
#Syntax highlighting error category
in this page for details.
line
The
line
attribute enables line numbers.
def
quick_sort
arr
):
less
[]
syntaxhighlight
lang
"python"
line
...
syntaxhighlight
start
The
start
attribute (in combination with
line
) defines the first line number of the code block.
For example,
line
start
"55"
will make line numbering start at line 55.
def
quick_sort
arr
):
less
[]
syntaxhighlight
lang
"python"
line
start
"55"
...
syntaxhighlight
linelinks
MediaWiki version:
1.36
Gerrit change 653142
The
linelinks
attribute (in combination with
line
) adds link anchors to each line of the code block.
You can click on the line numbers to get a link that highlights the selected line, and use them in internal and external links.
You can also hold
⇧ Shift
and click on another line number to get a link that highlights the selected range of lines (
Since
MediaWiki 1.42
change 1007640
).
When JavaScript is disabled, single-line highlights can be created and existing ones jump to the right location, but the highlight is missing; however, range highlights don’t work at all, so consider using single-line highlights only for accessibility if meaningfully possible.
The value of the attribute is used as a prefix for the anchors, to distinguish multiple code blocks on one page.
def
quick_sort
arr
):
less
[]
pivot_list
[]
more
[]
if
len
arr
<=
return
arr
else
pass
Click here to jump to and highlight line 3 in the code block above.
Click here to jump to and highlight lines 2-4 in the code block above.
syntaxhighlight
lang
"python"
line
linelinks
"example"
...
syntaxhighlight
[[#
example-3
...
]]
[[#
example-2--example-4
...
]]
highlight
The
highlight
attribute specifies one or more lines that should be marked (by highlighting those lines with a different background color).
You can specify multiple line numbers separated by commas (for example,
highlight
"1,4,8"
) or ranges using two line numbers and a hyphen (for example,
highlight
"5-7"
).
The line number specification ignores any renumbering of the displayed line numbers with the
start
attribute.
def
quick_sort
arr
):
less
[]
pivot_list
[]
more
[]
if
len
arr
<=
return
arr
is the result of:
syntaxhighlight
lang
"python"
line
start
"3"
highlight
"1,5-7"
...
syntaxhighlight
inline
MediaWiki version:
1.26
The attribute indicates that the source code should be inline as part of a paragraph (as opposed to being its own block).
(introduced in 1.26)
Using the "enclose" parameter is deprecated; if set to "none", it should be replaced with inline; otherwise, it can be removed entirely.
Line breaks can occur at any space between the opening and closing tags unless the source code is marked non-breakable with
class
"nowrap"
(on those wikis that support it; see below) or
style
"white-space:nowrap"
For example:
The following
lambda
is a
lambda expression
in Python.
Is the result of:
The following
syntaxhighlight
lang
"python"
inline
lambda
syntaxhighlight
is a
[[
Lambda (programming)
lambda expression
]]
in Python.
class
When
inline
is used,
class
"nowrap"
(on those wikis that support it; not on MediaWiki itself) specifies that line breaks should not occur at spaces within the code block.
For example:
Without
class
"nowrap"
xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx
lambda
xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx
With
style
"white-space:nowrap"
xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx
lambda
xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx
style
The
style
attribute allows CSS attributes to be included directly.
This is equivalent to enclosing the block in a
<
div
(not
<
span
) tag.
The
tab‑size
attribute cannot be specified this way; it requires an enclosing
<
span
tag as described below under
Advanced
For example:
def
quick_sort
arr
):
less
[]
pivot_list
[]
more
[]
if
len
arr
<=
return
arr
else
pass
Is the result of:
syntaxhighlight
lang
"python"
style
"border: 3px dashed blue;"
def
quick_sort
arr
):
less
[]
pivot_list
[]
more
[]
if
len
arr
<=
return
arr
else
pass
syntaxhighlight
copy
MediaWiki version:
1.43
The
copy
attribute adds a button link that copies the content to the clipboard when clicked.
This attribute cannot be used together with the
inline
attribute. If both are specified,
copy
will be ignored.
For example:
def
quick_sort
arr
):
less
[]
Is the result of:
syntaxhighlight
lang
"python"
copy
def
quick_sort
arr
):
less
[]
syntaxhighlight
Supported languages
<
syntaxhighlight
using Pygments now includes a native
wikitext
lexer since version
2.15.0
Pygments
library provides syntax-highlighting for hundreds of programming languages and file formats through its built-in regex-based lexing mechanism termed
lexers
Generally,
lang
uses the lowercase version of the language name, but many languages also have aliases or "short names" as they are called in the Pygments documentation; see
Pygments lexers
and
SyntaxHighlight.lexers.php
Languages previously supported by GeSHi have been mapped to equivalent Pygments lexers, see
SyntaxHighlightGeSHiCompat.php
As of January 2020, the
list of programming languages
supported by Pygments is:
Programming languages
ActionScript
Ada
Agda (incl. literate)
Alloy
AMPL
ANTLR
APL
AppleScript
Assembly (various)
Asymptote
Augeas
AutoIt
Awk
BBC Basic
Befunge
BlitzBasic
Boa
Boo
Boogie
BrainFuck
C, C++ (incl. dialects like Arduino)
C#
Chapel
Charm++ CI
Cirru
Clay
Clean
Clojure
CoffeeScript
ColdFusion
Common Lisp
Component Pascal
Coq
Croc (MiniD)
Cryptol (incl. Literate Cryptol)
Crystal
Cypher
Cython
Dart
DCPU-16
Delphi
Dylan (incl. console)
Eiffel
Elm
Emacs Lisp
Email
Erlang (incl. shell sessions)
Ezhil
Factor
Fancy
Fantom
Fennel
FloScript
Forth
Fortran
FreeFEM++
F#
GAP
Gherkin (Cucumber)
GLSL shaders
Golo
Gosu
Groovy
Haskell (incl. Literate Haskell)
HLSL
HSpec
Hy
IDL
Idris (incl. Literate Idris)
Igor Pro
Io
Jags
Java
JavaScript
Jasmin
Jcl
Julia
Kotlin
Lasso (incl. 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 (incl. console sessions and tracebacks)
QBasic
Racket
Raku a.k.a. Perl 6
REBOL
Red
Redcode
Rexx
Ride
Ruby (incl. irb sessions)
Rust
S, S-Plus, R
Scala
Scdoc
Scheme
Scilab
SGF
Shell scripts (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 languages
Angular templates
Cheetah templates
ColdFusion
Django / Jinja templates
ERB (Ruby templating)
Evoque
Genshi (the Trac template language)
Handlebars
JSP (Java Server Pages)
Liquid
Myghty (the HTML::Mason based framework)
Mako (the Myghty successor)
Slim
Smarty templates (PHP templating)
Tea
Twig
Other markup
Apache config files
Apache Pig
BBCode
CapDL
Cap'n Proto
CMake
Csound scores
CSS
Debian control files
Diff files
Dockerfiles
DTD
EBNF
E-mail headers
Extempore
Flatline
Gettext catalogs
Gnuplot script
Groff markup
Hexdumps
HTML
HTTP sessions
IDL
Inform
INI-style config files
IRC logs (irssi style)
Isabelle
JSGF notation
JSON, JSON-LD
Lean theorem prover
Lighttpd config files
Linux kernel log (dmesg)
LLVM assembly
LSL scripts
Makefiles
MoinMoin/Trac Wiki markup
MQL
MySQL
NCAR command language
Nginx config files
Nix language
NSIS scripts
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 grammars
USD (Universal Scene Description)
Varnish configs
VGL
Vim Script
WDiff
Windows batch files
XML
XSLT
YAML
Windows Registry files
Since MediaWiki 1.37 more lexers were added with the update of pygments to version 2.10.0 as detailed with
T280117
ansys
apdl
asc
gcode
golang === go
gsql
jslt
julia-repl
kuin
meson
nestedtext
nodejsrepl
nt
omg-idl
output
pem
procfile
pwsh
smithy
teal
thingsdb
ti
wast
wat
Lexers previously supported by GeSHi
Below is a partial list of languages that GeSHi could highlight, with strike-through for languages no longer supported after the switch to Pygments.
Lexers previously supported by GeSHi
Code
Language
4cs
GADV 4CS
6502acme
MOS 6502 (6510) ACME Cross Assembler
6502kickass
MOS 6502 (6510) Kick Assembler
6502tasm
MOS 6502 (6510) TASM/64TASS
68000devpac
Motorola 68000 - HiSoft Devpac ST 2 Assembler
abap
ABAP
actionscript
ActionScript
actionscript3
ActionScript3
ada
Ada
algol68
ALGOL 68
apache
Apache Configuration
applescript
AppleScript
apt_sources
Apt sources
arm
ARM
Assembler
asm
Assembly
asp
Active Server Pages (ASP)
asymptote
Asymptote
autoconf
Autoconf
autohotkey
AutoHotkey
autoit
AutoIt
avisynth
AviSynth
awk
AWK
bascomavr
BASCOM AVR
bash
Bash
basic4gl
Basic4GL
bf
Brainfuck
bibtex
BibTeX
blitzbasic
Blitz BASIC
bnf
Backus–Naur Form
boo
Boo
c_loadrunner
C Loadrunner
c_mac
C (Mac)
caddcl
AutoCAD DCL
cadlisp
AutoLISP
cfdg
CFDG
cfm
ColdFusion Markup Language
chaiscript
ChaiScript
cil
Common Intermediate Language (CIL)
clojure
Clojure
cmake
CMake
cobol
COBOL
coffeescript
CoffeeScript
cpp
C++
cpp-qt
C++ (Qt toolkit)
csh
C shell
csharp
C#
css
Cascading Style Sheets (CSS)
cuesheet
Cue sheet
dart
Dart
dcl
Data Control Language
dcpu16
DCPU-16
dcs
Data Conversion System
delphi
Delphi
diff
Diff
div
DIV
dosbatch
DOS batch file
dot
DOT
ebnf
Extended Backus–Naur Form
ecmascript
ECMAScript
eiffel
Eiffel
email
Email (mbox / eml / RFC format)
epc
Enerscript
erlang
Erlang
euphoria
Euphoria
f1
Formula One
falcon
Falcon
fo
FO
fortran
Fortran
freebasic
FreeBASIC
freeswitch
FreeSWITCH
fsharp
Fsharp
gambas
Gambas
gdb
GDB
genero
Genero
genie
Genie
gettext
gettext
glsl
OpenGL Shading Language (GLSL)
gml
Game Maker Language (GML)
gnuplot
gnuplot
go
Go
groovy
Groovy
gwbasic
GW-BASIC
haskell
Haskell
haxe
Haxe
hicest
HicEst
hq9plus
HQ9+
html4strict
HTML
(use "html" instead)
html5
HTML5
(use "html" instead)
icon
Icon
idl
Uno IDL
ini
INI
inno
Inno
intercal
INTERCAL
io
Io
java
Java
java5
Java(TM) 2 Platform Standard Edition 5.0
javascript
JavaScript
jquery
jQuery
kixtart
KiXtart
klonec
Klone C
klonecpp
Klone C++
kotlin
Kotlin
ksh
Korn shell
latex
LaTeX
lb
Liberty BASIC
ldif
LDAP Data Interchange Format
lisp
Lisp
llvm
LLVM
locobasic
Locomotive BASIC
logtalk
Logtalk
lolcode
LOLCODE
lotusformulas
Formula language
lotusscript
LotusScript
lscript
LightWave 3D
lsl2
Linden Scripting Language
lua
Lua
magiksf
Magik
m68k
Motorola 68000 Assembler
make
make
mapbasic
MapBasic
matlab
MATLAB M
mirc
mIRC scripting language
mmix
MMIX
modula2
Modula-2
modula3
Modula-3
mpasm
Microchip Assembler
mxml
MXML
mysql
MySQL
nagios
Nagios
netrexx
NetRexx
newlisp
NewLISP
nsis
Nullsoft Scriptable Install System (NSIS)
oberon2
Oberon-2
objc
Objective-C
objeck
Objeck
ocaml
OCaml
ocaml-brief
OCaml
octave
Octave
oobas
LibreOffice/OpenOffice.org Basic
oorexx
Object REXX
oracle11
Oracle 11 SQL
oracle8
Oracle 8 SQL
oxygene
Oxygene
oz
Oz
parasail
ParaSail
parigp
PARI/GP
pascal
Pascal
pcre
Perl Compatible Regular Expressions
per
per
perl
pl
Perl
perl6
pl6
raku
Perl 6
pf
PF
php
PHP
php-brief
PHP
(deprecated in
phab:T94292
– no colors, odd framing)
pic16
PIC assembly language
pike
Pike
pixelbender
Pixel Bender
pli
PL/I
plsql
PL/SQL
postgresql
PostgreSQL
postscript
PostScript
povray
Persistence of Vision Raytracer
powerbuilder
PowerBuilder
powershell
Windows PowerShell
proftpd
ProFTPD
progress
OpenEdge Advanced Business Language
prolog
Prolog
properties
Properties file
providex
ProvideX
purebasic
PureBasic
pycon
Python
pys60
PyS60
python
py
python3
py3
Python
python2
py2
Python 2
qbasic
QBasic/QuickBASIC
rails
Rails
rebol
Rebol
reg
Windows Registry
rexx
Rexx
robots
robots.txt
rpmspec
RPM Spec files
rsplus
ruby
Ruby
sas
SAS
scala
Scala
scheme
Scheme
sh
shell
shell-session
Shell Script
(POSIX)
scilab
Scilab
sdlbasic
SdlBasic
smalltalk
Smalltalk
smarty
Smarty
spark
SPARK
sparql
SPARQL
sql
SQL
stonescript
StoneScript (Scripting language for
ShiVa3D
systemverilog
SystemVerilog
tcsh
Tcsh
tcl
Tcl
teraterm
Tera Term
text
Plain text
thinbasic
thinBasic
ts
TypeScript
tsql
Transact-SQL
typoscript
TypoScript
unicon
Unicon
upc
Unified Parallel C
urbi
URBI
uscript
UnrealScript
vala
Vala
vb
Visual Basic
vbnet
Visual Basic .NET
vedit
VEDIT
verilog
Verilog
vhdl
VHDL
vim
Vim script
visualfoxpro
Visual FoxPro
visualprolog
Visual Prolog
whitespace
Whitespace
whois
Whois
winbatch
Winbatch
xml
XML
xorg_conf
Xorg.conf
yaml
YAML
xpp
Microsoft Dynamics AX
z80
ZiLOG Z80 Assembler
zxbasic
ZXBasic
Installation
This extension
comes with MediaWiki 1.21
and later, so you do not need to download it. The remaining configuration instructions must still be followed.
Despite its update to Pygments (and away from GeSHi) and despite its updated name, this extension internally still uses the former file names as stated below.
and move the extracted
SyntaxHighlight_GeSHi
folder to your
extensions/
directory.
Developers and code contributors should install the extension
from Git
instead, using:
cd
extensions/
git
clone
Only when installing from Git, run
Composer
to install PHP dependencies, by issuing
composer install --no-dev
in the extension directory.
(See
T173141
for potential complications.)
Add the following code at the bottom of your
LocalSettings.php
file:
wfLoadExtension
'SyntaxHighlight_GeSHi'
);
In
Linux
, set execute permissions for the
pygmentize
binary. You can use an FTP client or the following shell command to do so:
chmod
a+x
/path/to/extensions/SyntaxHighlight_GeSHi/pygments/pygmentize
Done
– Navigate to
Special:Version
on your wiki to verify that the extension is successfully installed.
Vagrant installation:
If using
Vagrant
, install with
vagrant roles enable syntaxhighlight --provision
When installing from
Git
, please note that starting from MediaWiki 1.26, and ending with MediaWiki 1.31 this extension requires
Composer
So, after installation from Git change to the directory containing the extension e.g.
"../extensions/SyntaxHighlight_GeSHi/"
and run
composer
install
--no-dev
, or when updating:
composer
update
--no-dev
Alternatively as well as preferably add the line
"extensions/SyntaxHighlight_GeSHi/composer.json"
to the "composer.local.json" file in the root directory of your wiki like e.g.
"extra"
"merge-plugin"
"include"
"extensions/SyntaxHighlight_GeSHi/composer.json"
Now run
composer
update
--no-dev
That's it.
Warning:
When uploading the extension via FTP be sure to upload the
pygments/pygmentize
file with the transfer type
binary
Configuration
$wgSyntaxHighlightMaxLines
$wgSyntaxHighlightMaxBytes
Optional
For performance reasons, blobs or pages (JS, Lua and CSS pages) larger than these values will not be highlighted.
(introduced in 1.40)
Linux
$wgPygmentizePath
Optional
Absolute path to
pygmentize
of the Pygments package. The extension bundles the Pygments package and
$wgPygmentizePath
points to the bundled version by default, but you can point to a different version, if you want to. For example:
$wgPygmentizePath
"/usr/local/bin/pygmentize"
Windows
If you are hosting your MediaWiki on a Windows machine, you have to set the path for the Pygmentize.exe
$wgPygmentizePath
"c:
\\
Python27
\\
Scripts
\\
pygmentize.exe"
If there is no
pygmentize.exe
run
easy_install Pygments
from command line inside the
Scripts
folder to generate the file.
If you are using the bundled pygmentize binary (extensions/SyntaxHighlight_GeSHi/pygments/pygmentize), make sure your webserver is permitted to execute it.
If your host does not allow you to add executables to your web directory, install python-pygments and add
$wgPygmentizePath
pygmentize
to
LocalSettings.php
Troubleshooting
After updating to MediaWiki v1.26 and above, some users started reporting problems with the extension. There could be cases, when some languages, such as
Lua
might not get highlighted and by turning on
debugging
, MediaWiki would throw out the error,
Notice: Failed to invoke Pygments: /usr/bin/env: python3: No such file or directory
Try pointing
$wgPygmentizePath
in
LocalSettings.php
towards an external pygmentize binary.
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 (
source /virtualenv/python/3.5/bin/activate
). After this, the Pygments
module can be added
to the Python app, for which navigate to the virtual environment path (
cd virtualenv/python/3.5/bin/
), download and install Pygments (
./pip 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:
virtualenv/python/3.5/bin/pygmentize
See
phab:T128993
on this for further suggestions and information.
SELinux can also prevent the extension from running with an error similar to
type=AVC msg=audit(1609598265.169:225924): avc: denied { execute } for pid=2360888 comm="bash" name="pygmentize" dev="dm-0" ino=50814399 scontext=system_u:system_r:httpd_t:s0 tcontext=unconfined_u:object_r:httpd_user_content_t:s0 tclass=file permissive=0
in your audit.log. This can be allowed with
setsebool -P httpd_unified 1
In earlier versions of this extension, Windows would sometimes fail with an _Py_HashRandomization_Init error. This was a
bug
with the Windows environment not being passed to python executions. A fix was released in 1.40, with backports to 1.38 and 1.39.
VisualEditor integration
The plugin enables direct editing with
VisualEditor
A popup is opened when a user wants to edit
syntaxhighlight
sections.
For this to work, VisualEditor must be installed and configured from the latest Git version, same for Parsoid.
The feature may not work with older Parsoid versions.
See
Extension:SyntaxHighlight/VisualEditor
for details.
Using with MediaWiki-Docker
See
MediaWiki-Docker/Extension/SyntaxHighlight
for instructions on configuring a
MediaWiki-Docker
environment for SyntaxHighlight usage, development, and testing.
Advanced
Unlike the
<
pre
and
<
code
tags, HTML character entities such as
need not (and should not) have the
character escaped as
&
Like the
<
pre
tag but unlike the
<
code
tag, tags within the range (other than its own closing tag) need not have the
symbol escaped as
<
, nor does
Wikitext
need to be escaped with a
<
nowiki
tag.
Furthermore, while
<
pre
assumes tab stops every 8 characters and renders tabs using actual spaces when the rendered text is copied,
<
syntaxhighlight
uses 4-space tab stops (except Internet Explorer, which uses 8) and preserves the tab characters in the rendered text.
Tab stop length for
<
syntaxhighlight
may be adjusted using a
<
span
style=""
tag nested inside it that specifies the
tab-size
(its own
style
attribute cannot be used to specify the tab stops, and
<
div
cannot be used instead):
<
span
style
"-moz-tab-size:
nn
; -o-tab-size:
nn
; tab-size:
nn
;"
The
-moz-
prefix is required for Firefox (from version 4.0 to version 90), and the
-o-
prefix is required for Opera (from version 10.60 to version 15).
The wiki editing box assumes 8-space tabs. This applies only to actual saved pages; previews generated through an edit box or
Special:ExpandTemplates
may differ.
See also
Instructions on updating the pygments version used by SyntaxHighlight
Instructions on setting up SyntaxHighlight in a MediaWiki-Docker development environment
Pygments – Python syntax highlighter
Extensions dependent on this one:
Extension:SyntaxHighlightPages
– highlights pages based on title suffixes.
Alternative extensions:
Extension:Highlightjs Integration
– syntax highlighter that uses HighlightJS library (includes support for some languages that are missing from Pygments, such as Maxima).
Extension:ExternalContent
– embed external content, such as code from GitHub, GitLab, and Bitkeeper repos with automatic rendering of Markdown files; and using syntax highlighting via the Prism.js library for nearly 300 supported languages. Content indexed by CirrusSearch
Footnotes
See topic
"problem of syntaxhighlight vs code transclusion"
phab:T104109#3879800
lexer: splits the source into tokens, fragments of the source that have a token type that determines what the text represents semantically (e.g., keyword, string, or comment).
There is a lexer for every language or markup format that Pygments supports.
See
devmo:Web/CSS/tab-size
This extension is being used on one or more
Wikimedia projects
. This probably means that the extension is stable and works well enough to be used by such high-traffic websites. Look for this extension's name in Wikimedia's
CommonSettings.php
and
InitialiseSettings.php
configuration files to see where it's installed. A full list of the extensions installed on a particular wiki can be seen on the wiki's
Special:Version
page.
This extension is included in the following wiki farms/hosts and/or packages:
BlueSpice
Canasta
Debian
Fandom
Miraheze
MyWikis
ProWiki
semantic::core
ShoutWiki
wiki.gg
Retrieved from "
Categories
Extensions bundled with MediaWiki 1.21
Stable extensions
Tag extensions
ApiFormatHighlight extensions
ContentAlterParserOutput extensions
ParserFirstCallInit extensions
ResourceLoaderRegisterModules extensions
SoftwareInfo extensions
GPL licensed extensions
Extensions in Wikimedia version control
All extensions
Extensions requiring Composer with git
Extensions used on Wikimedia
Extensions included in BlueSpice
Extensions included in Canasta
Extensions available as Debian packages
Extensions included in Fandom
Extensions included in Miraheze
Extensions included in MyWikis
Extensions included in ProWiki
Extensions included in semantic::core
Extensions included in ShoutWiki
Extensions included in wiki.gg
Syntax highlighting extensions
GeSHi extensions
Extensions with VisualEditor support
Hidden categories:
Extensions with master compatibility policy
Extensions with manual MediaWiki version
Extension
SyntaxHighlight
Add topic
US