View source for Template:SyntaxHighlight

<languages/>
{{bundled|1.21}}
{{note|1=<translate><!--T:1--> For syntax highlighting of wikitext when using the source editor, see the <tvar|CodeMirror>{{ll|Extension:CodeMirror|CodeMirror}}</> extension or the userscripts of [[<tvar|user1>User:Remember the dot/Syntax highlighter</>|Remember the dot]] and [[<tvar|user2>:en:User:Cacycle/wikEd</>|Cacycle]].</translate>|2=reminder}}
{{Extension
|name      = SyntaxHighlight
|status    = stable
|type      = tag
|hook1     = ContentGetParserOutput
|hook2     = ParserFirstCallInit
|hook3     = ApiFormatHighlight
|hook4     = ResourceLoaderRegisterModules
|author    = <nowiki/>
* Brion Vibber,
* Tim Starling,
* Rob Church,
* Ori Livneh
|image     = SyntaxHighlighting with Pygments.png
|imagesize = 375px
|version   = continuous updates
|update    = 
|mediawiki = 1.25+
|license   = GPL-2.0-or-later
|download  = {{WikimediaDownload|SyntaxHighlight_GeSHi}}
|needs-updatephp = No
|readme    = {{git file|action=raw|project=mediawiki/extensions/SyntaxHighlight_GeSHi|branch=HEAD|file=README|text=README}}
|changelog = 
|description = <translate><!--T:2--> Allows source code to be syntax highlighted on the wiki pages</translate>
|parameters= <nowiki/>
* $wgPygmentizePath
* $wgSyntaxHighlightModels
|rights    =
|example   =
|phabricator = syntaxhighlight
|CheckUsageNameOverride = SyntaxHighlight
|tags = &lt;syntaxhighlight>
|pagedrive1 = true
}}
<translate>
<!--T:3-->
The '''SyntaxHighlight''' extension, formerly known as SyntaxHighlight_GeSHi, provides rich formatting of [[w:source code|source code]] using the <tvar|syntaxhighlight><code><nowiki><syntaxhighlight></nowiki></code></> tag.</translate>
<translate>
<!--T:4-->
It is powered by the [<tvar|url>http://pygments.org</> Pygments] library and supports hundreds of different programming languages and file formats.

<!--T:5-->
Like the <tvar|pre><code><nowiki><pre></nowiki></code></> and <tvar|poem><code><{{ll|Extension:Poem|poem}}></code></> tags, the text is rendered exactly as it was typed, preserving any white space.

== Usage == <!--T:8-->

<!--T:9-->
Once installed, you can use "syntaxhighlight" tags on wiki pages. For example,
</translate>

<syntaxhighlight lang="Python" line='line'>
def quickSort(arr):
	less = []
	pivotList = []
	more = []
	if len(arr) <= 1:
		return arr
	else:
		pass
</syntaxhighlight>

<translate>
<!--T:10-->
is the result of the following wikitext markup:
</translate>

<source lang="Python">
<syntaxhighlight lang="Python" line='line'>
def quickSort(arr):
	less = []
	pivotList = []
	more = []
	if len(arr) <= 1:
		return arr
	else:
		pass
</syntaxhighlight>
</source>

<translate>
<!--T:11-->
In older versions (before MediaWiki 1.16), the extension used the tag <tvar|source><code><nowiki><source></nowiki></code></>.</translate>
<translate>
<!--T:12-->
This is still supported, but <tvar|syntaxhighlight><code><nowiki><syntaxhighlight></nowiki></code></> may help avoid conflicts if your source code itself contains <tvar|source><code><nowiki><source></nowiki></code></> tags (for example XML).

== Styling == <!--T:13-->

<!--T:14-->
If the displayed code is too big, you can adjust it by putting the following into the <tvar|css><samp>MediaWiki:Common.css</samp></> page in your wiki (create it if it does not exist):
</translate>

<syntaxhighlight lang="CSS">
/* <translate><!--T:106--> CSS placed here will be applied to all skins</translate> */
.mw-highlight pre {
	font-size: 90%;
}
</syntaxhighlight>

<translate>
<!--T:15-->
Encasing code blocks in borders can be done by inserting a line like <tvar|css><code>border: 1px dashed blue;</code></> in the section above.</translate>
<translate>
<!--T:16-->
Control over ''font family'' used can also be exercised by inserting a line like <tvar|css><code>font-family: "Courier New", monospace;</code></> into the section above.

== Syntax highlighting error category == <!--T:17-->

<!--T:18-->
The extension adds pages that have a bad <tvar|lang><code>lang</code></> attribute in a <tvar|source><code><nowiki><source></nowiki></code></> or <tvar|syntaxhighlight><code><nowiki><syntaxhighlight></nowiki></code></> tag to a [[<tvar|link>Special:MyLanguage/Help:Tracking categories</>|tracking category]].</translate>
<translate>
<!--T:19-->
The message key <tvar|msg>[[MediaWiki:syntaxhighlight-error-category]]</> determines the category name; on this wiki it is <tvar|category>[[:Category:{{MediaWiki:syntaxhighlight-error-category}}]]</>.

<!--T:20-->
The most common error that leads to pages being tagged with this category is a <tvar|syntaxhighlight><code><nowiki><syntaxhighlight></nowiki></code></> or <tvar|source><code><nowiki><source></nowiki></code></> tag with no <tvar|lang><code>lang</code></> attribute at all, because older versions of this extension supported the definition of "$wgSyntaxHighlightDefaultLang".</translate>
<translate>
<!--T:21-->
These can typically either be replaced with <tvar|pre><code><nowiki><pre></nowiki></code></>, or <tvar|bash><code>lang="bash"</code></> or <tvar|text><code>lang="text"</code></> can be added to the tag.

<!--T:120-->
The category may also be added, and the content will not be highlighted, if there are more than 1000 lines or more than 100 kB text.<tvar|1><ref>[[phab:T104109#3879800]]</ref></>

== Parameters == <!--T:24-->

=== lang === <!--T:25-->

<!--T:26-->
The <tvar|lang><code>lang="<var>name</var>"</code></> attribute defines what lexer should be used.</translate>
<translate>
<!--T:27-->
The language affects how the extension highlights the source code.</translate>
<translate>
<!--T:29-->
See the section [[<tvar|section>#Supported_languages</>|Supported languages]] for details of supported languages.
</translate>

<syntaxhighlight lang="Python">
def quickSort(arr):
    less = []
</syntaxhighlight>
<pre>
<syntaxhighlight lang="Python">
..
</syntaxhighlight>
</pre>

<translate>
<!--T:30-->
Specifying an invalid or unknown name will tag the page with a tracking category.</translate>
<translate>
<!--T:31-->
See the section [[<tvar|section>#Syntax highlighting error category</>|Syntax highlighting error category]] in this page for details.

=== line === <!--T:32-->

<!--T:33-->
The <tvar|line><code>line</code></> attribute enables line numbers.
</translate>

<syntaxhighlight lang="Python" line="1">
def quickSort(arr):
	less = []
</syntaxhighlight>
<pre>
<syntaxhighlight lang="Python" line>
..
</syntaxhighlight>
</pre>

<translate>
=== start === <!--T:34-->

<!--T:35-->
The <tvar|start><code>start</code></> attribute (in combination with <tvar|line><code>line</code></>) defines the first line number of the code block.</translate>
<translate>
<!--T:36-->
For example, <tvar|start><code>line start="55"</code></> will make line numbering start at 55.
</translate>

<syntaxhighlight lang="Python" line start="55">
def quickSort(arr):
    less = []
</syntaxhighlight>
<pre>
<syntaxhighlight lang="Python" line start="55">
..
</syntaxhighlight>
</pre>

<translate>
=== highlight === <!--T:37-->

<!--T:38-->
The <tvar|highlight><code>highlight</code></> attribute specifies one or more lines that should be marked (by highlighting those lines with a different background color).</translate>
<translate>
<!--T:39-->
You can specify multiple line numbers separated by commas (for example, <tvar|highlight><code>highlight="1,4,8"</code></>) or ranges using two line numbers and a hyphen (for example, <tvar|highlight2><code>highlight="5-7"</code></>).</translate>
<translate>
<!--T:40-->
Note that the line number specification ignores any renumbering of the displayed line numbers with the <tvar|start><code>start</code></> attribute.
</translate>

<syntaxhighlight lang="Python" highlight="1,5-7" start=3 line>
def quickSort(arr):
    less = []
    pivotList = []
    more = []
    if len(arr) <= 1:
        return arr
</syntaxhighlight>

<translate>
<!--T:41-->
is the result of
</translate>

<pre>
<syntaxhighlight lang="Python" highlight="1,5-7" start='3' line>
..
</syntaxhighlight>
</pre>

<translate>
=== inline === <!--T:42-->
</translate>
{{MW_1.26|and after}}
<translate>
<!--T:43-->
The attribute indicates that the source code should be inline as part of a paragraph (as opposed to being its own block).</translate>
<translate>
<!--T:44-->
This option is available starting with MediaWiki 1.26.</translate>
<translate>
<!--T:45-->
For backwards-compatibility, an <tvar|enclose><code>enclose="none"</code></> attribute results in the same behavior.

<!--T:46-->
Note that line breaks can occur at any space between the opening and closing tags unless the source code is marked non-breakable with <tvar|class><code>class="nowrap"</code></> (on those wikis that support it; see below) or <tvar|style><code>style=white-space:nowrap</code></>.

<!--T:47-->
For example:

<!--T:48-->
<tvar|code><syntaxhighlight lang="Python" inline>lambda x: x * 2</syntaxhighlight></> is a [[w:Lambda (programming)|lambda expression]] in Python.

<!--T:49-->
Is the result of:
</translate>

<pre>
<translate><!--T:50--> <tvar|code><syntaxhighlight lang="Python" inline>lambda x: x * 2</syntaxhighlight></> is a [[w:Lambda (programming)|lambda expression]] in Python.</translate>
</pre>

<translate>
=== class === <!--T:51-->

<!--T:52-->
When <tvar|inline><code>inline</code></> is used, <tvar|nowrap><code>class="nowrap"</code></> (on those wikis that support it; not on MediaWiki itself) specifies that line breaks should not occur at spaces within the code block.

<!--T:53-->
For example:

<!--T:54-->
Without <tvar|nowrap><code>class="nowrap"</code></>:
</translate>

<div style="max-width:800px; border:1px solid #ccc ">
xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx<syntaxhighlight lang="Python" inline>lambda x: x * 2</syntaxhighlight>xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx
</div>
With <code>style="white-space:nowrap"</code>:
<div style="max-width:800px; border:1px solid #ccc">
xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx<syntaxhighlight lang="Python" inline style="white-space:nowrap">lambda x: x * 2</syntaxhighlight>xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx
</div>

<translate>
=== style === <!--T:55-->

<!--T:56-->
The <tvar|style><code>style</code></> attribute allows CSS attributes to be included directly.</translate>
<translate>
<!--T:57-->
This is equivalent to enclosing the block in a <tvar|div><code><nowiki><div></nowiki></code></> (not <tvar|span><code><nowiki><span></nowiki></code></>) tag.</translate>
<translate>
<!--T:58-->
The <tvar|size><code>tab‑size</code></> attribute cannot be specified this way; it requires an enclosing <tvar|span><code><nowiki><span></nowiki></code></> tag as described below under [[<tvar|anchor>#Advanced</>|Advanced]].

<!--T:59-->
For example:
</translate>

<syntaxhighlight lang="Python" style="border:3px dashed blue">
def quickSort(arr):
	less = []
	pivotList = []
	more = []
	if len(arr) <= 1:
		return arr
	else:
		pass
</syntaxhighlight>

<translate>
<!--T:60-->
Is the result of:
</translate>

<source lang="Python">
<syntaxhighlight lang="Python" style="border:3px dashed blue">
def quickSort(arr):
	less = []
	pivotList = []
	more = []
	if len(arr) <= 1:
		return arr
	else:
		pass
</syntaxhighlight>
</source>

<translate>
== Supported languages == <!--T:61-->

<!--T:62-->
The Pygments library provides support for hundreds of computer languages and file formats.</translate>
<translate>
<!--T:118-->
[<tvar|url>http://pygments.org/languages/</> full list] is:
</translate>
*
=== Programming languages ===
<blockquote>
{{flatlist|
* ActionScript
* Ada
* ANTLR
* AppleScript
* Assembly
* Asymptote
* Awk
* Befunge
* Boo
* BrainFuck
* C / C++
* C#
* Clojure
* CoffeeScript
* ColdFusion
* Common Lisp
* Coq
* Cryptol
* Crystal
* Cython
* D
* Dart
* Delphi
* Dylan
* Elm
* Erlang
* Ezhil
* Factor
* Fancy
* Fortran
* F#
* GAP
* Gherkin (Cucumber)
* GL shaders
* Groovy
* Haskell
* IDL
* Io
* Java
* JavaScript
* Lasso
* LLVM
* Logtalk
* Lua
* Matlab
* MiniD
* Modelica
* Modula-2
* MuPad
* Nemerle
* Nimrod
* Objective-C
* Objective-J
* Octave
* OCaml
* PHP
* Perl
* PovRay
* PostScript
* PowerShell
* Prolog
* Python 2.x and 3.x 
* REBOL
* Red
* Redcode
* Ruby
* Rust
* S, S-Plus and R
* Scala
* Scheme
* Scilab
* Smalltalk
* SNOBOL
* Tcl
* Vala
* Verilog
* VHDL
* Visual Basic.NET
* Visual FoxPro
* XQuery
* Zephir
}}
</blockquote>
=== Template languages ===
<blockquote>
{{flatlist|
* Cheetah templates
* Django / Jinja templates
* ERB
* Genshi
* JSP
* Myghty
* Mako
* Smarty templates
* Tea
}}
</blockquote>
=== Other markup ===
<blockquote>
{{flatlist|
* Apache config files
* Bash shell scripts
* BBCode
* CMake
* CSS
* Debian control files
* Diff files
* DTD
* Gettext catalogs
* Gnuplot script
* Groff markup
* HTML
* HTTP sessions
* INI-style config files
* IRC logs (irssi style)
* JSON
* Lighttpd config files
* Makefiles
* MoinMoin/Trac Wiki markup
* MySQL
* Nginx config files
* POV-Ray scenes
* Ragel
* Redcode
* ReST
* Robot Framework
* RPM spec files
* SQL
* Squid configuration
* TeX
* tcsh
* Vim Script
* Windows batch files
* XML
* XSLT
* YAML
}}
</blockquote>

<translate>
<!--T:65-->
For accurate language codes, see [<tvar|external-link2>http://pygments.org/docs/lexers/</> complete details in the Pygments document] and there are some mappings for some language names which were supported by GeSHi ([<tvar|external-link3>https://github.com/wikimedia/mediawiki-extensions-SyntaxHighlight_GeSHi/blob/master/includes/SyntaxHighlightGeSHiCompat.php</> full list]).
</translate>

{{tip|1=<translate><!--T:66--> Pygments does not yet provide a "wikitext" or "mediawiki" lexer <tvar|phab>([[phab:T29828]])</>.</translate> <translate><!--T:67--> Use "html", "xml", or "[<tvar|url>http://pygments.org/docs/lexers/#pygments.lexers.markup.MoinWikiLexer</> moin]" instead.</translate>}}

<translate>
<!--T:68-->
Below is a partial list of languages that GeSHi could highlight, with strike-through for languages no longer supported after the switch to Pygments.
</translate>

{{collapse top| title=<translate><!--T:69--> Previously supported lexers</translate> }}
{| class="wikitable" style="float:{{dir|{{pagelang}}|right|left}}"
!<translate><!--T:107--> Code</translate>||<translate><!--T:108--> Language</translate>
|-
|<del><code>4cs</code></del>||4CS
|-
|<code>6502acme</code>||MOS 6502 (6510) ACME Cross Assembler
|-
|<code>6502kickass</code>||MOS 6502 (6510) Kick Assembler
|-
|<code>6502tasm</code>||MOS 6502 (6510) TASM/64TASS
|-
|<code>68000devpac</code>||Motorola 68000 - HiSoft Devpac ST 2 Assembler
|-
|<code>abap</code>||[[w:ABAP|ABAP]]
|-
|<code>actionscript</code>||[[w:ActionScript|ActionScript]]
|-
|<code>actionscript3</code>||[[w:ActionScript3|ActionScript3]]
|-
|<code>ada</code>||[[w:Ada (programming language)|Ada]]
|-
|<del><code>algol68</code></del>||[[w:ALGOL 68|ALGOL 68]]
|-
|<code>apache</code>||[[w:Apache HTTP Server|Apache Configuration]]
|-
|<code>applescript</code>||[[w:AppleScript|AppleScript]]
|-
|<code>apt_sources</code>||[[w:Apt sources|Apt sources]]
|-
|<code>arm</code>||[[w:ARM architecture|ARM]] Assembler
|-
|<code>asm</code>||[[w:Assembly language|Assembly]]
|-
|<code>asp</code>||[[w:Active Server Pages|Active Server Pages (ASP)]]
|-
|<code>asymptote</code>||[[w:Asymptote (vector graphics language)|Asymptote]]
|-
|<del><code>autoconf</code></del>||[[w:Autoconf|Autoconf]]
|-
|<code>autohotkey</code>||[[w:AutoHotkey|AutoHotkey]]
|-
|<code>autoit</code>||[[w:AutoIt|AutoIt]]
|-
|<del><code>avisynth</code></del>||[[w:AviSynth|AviSynth]]
|-
|<code>awk</code>||[[w:AWK|AWK]]
|-
|<code>bascomavr</code>||BASCOM AVR
|-
|<code>bash</code>||[[w:Bash (Unix shell)|Bash]]
|-
|<code>basic4gl</code>||[[w:Basic4GL|Basic4GL]]
|-
|<code>bf</code>||[[w:Brainfuck|Brainfuck]]
|-
|<code>bibtex</code>||[[w:BibTeX|BibTeX]]
|-
|<code>blitzbasic</code>||[[w:Blitz BASIC|Blitz BASIC]]
|-
|<code>bnf</code>||[[w:Backus–Naur Form|Backus–Naur Form]]
|-
|<code>boo</code>||[[w:Boo (programming language)|Boo]]
|-
|<code>c</code>||[[w:C (programming language)|C]]
|-
|<code>c_loadrunner</code>||C Loadrunner
|-
|<code>c_mac</code>||C (Mac)
|-
|<del><code>caddcl</code></del>||[[w:Dialog Control Language|AutoCAD DCL]]
|-
|<code>cadlisp</code>||[[w:AutoLISP|AutoLISP]]
|-
|<code>cfdg</code>||CFDG
|-
|<code>cfm</code>||[[w:ColdFusion Markup Language|ColdFusion Markup Language]]
|-
|<code>chaiscript</code>||[[w:ChaiScript|ChaiScript]]
|-
|<del><code>cil</code></del>||[[w:Common_Intermediate_Language|Common Intermediate Language (CIL)]]
|-
|<code>clojure</code>||[[w:Clojure|Clojure]]
|-
|<code>cmake</code>||[[w:CMake|CMake]]
|-
|<code>cobol</code>||[[w:COBOL|COBOL]]
|-
|<code>coffeescript</code>||[[w:CoffeeScript|CoffeeScript]]
|-
|<code>cpp</code>||[[w:C++|C++]]
|-
|<code>cpp-qt</code>||[[w:Qt (toolkit)|C++ (Qt toolkit)]]
|-
|<code>csh</code>||[[w:C Shell|C shell]]
|-
|<code>csharp</code>||[[w:C Sharp (programming language)|C#]]
|-
|<code>css</code>||[[w:Cascading Style Sheets|Cascading Style Sheets (CSS)]]
|-
|<del><code>cuesheet</code></del>||[[w:Cue sheet (computing)|Cue sheet]]
|-
|<code>d</code>||[[w:D (programming language)|D]]
|-
|<code>dart</code>||[[w:Dart (programming language)|Dart]]
|-
|<code>dcl</code>||[[w:Data Control Language|Data Control Language]]
|-
|<code>dcpu16</code>||[[w:DCPU-16|DCPU-16]]
|-
|<del><code>dcs</code></del>||Data Conversion System
|-
|<code>delphi</code>||[[w:Delphi programming language|Delphi]]
|-
|<code>diff</code>||[[w:Diff|Diff]]
|-
|<code>div</code>||DIV
|-
|<code>dosbatch</code>||[[w:DOS batch file|DOS batch file]]
|-
|<del><code>dot</code></del>||[[w:DOT (graph description language)|DOT]]
|-
|<del><code>e</code></del>||[[w:E (programming language)|E]]
|-
|<code>ebnf</code>||[[w:Backus–Naur Form|Extended Backus–Naur Form]]
|-
|<code>ecmascript</code>||[[w:ECMAScript|ECMAScript]]
|-
|<code>eiffel</code>||[[w:Eiffel (programming language)|Eiffel]]
|-
|<del><code>email</code></del>||Email (mbox \ eml \ RFC format)
|-
|<del><code>epc</code></del>||Enerscript
|-
|<code>erlang</code>||[[w:Erlang (programming language)|Erlang]]
|-
|<code>euphoria</code>||[[w:Euphoria (programming language)|Euphoria]]
|-
|<del><code>f1</code></del>||Formula One
|-
|<del><code>falcon</code></del>||[[w:Falcon (programming language)|Falcon]]
|-
|<del><code>fo</code></del>||FO
|-
|<code>fortran</code>||[[w:Fortran|Fortran]]
|-
|<code>freebasic</code>||[[w:FreeBASIC|FreeBASIC]]
|-
|<del><code>freeswitch</code></del>||[[w:FreeSWITCH|FreeSWITCH]]
|-
|<code>fsharp</code>||[[w:Fsharp|Fsharp]]
|-
|<code>gambas</code>||[[w:Gambas programming language|Gambas]]
|-
|<del><code>gdb</code></del>||[[w:GDB|GDB]]
|-
|<code>genero</code>||Genero
|-
|<del><code>genie</code></del>||[[w:Genie (programming language)|Genie]]
|-
|<code>gettext</code>||[[w:gettext|gettext]]
|-
|<code>glsl</code>||[[w:GLSL|OpenGL Shading Language (GLSL)]]
|-
|<del><code>gml</code></del>||[[w:Game Maker Language|Game Maker Language (GML)]]
|-
|<code>gnuplot</code>||[[w:gnuplot|gnuplot]]
|-
|<code>go</code>||[[w:Go (programming language)|Go]]
|-
|<code>groovy</code>||[[w:Groovy (programming language)|Groovy]]
|-
|<code>gwbasic</code>||[[w:GW-BASIC|GW-BASIC]]
|-
|<code>haskell</code>||[[w:Haskell (programming language)|Haskell]]
|-
|<code>haxe</code>||[[w:Haxe|Haxe]]
|-
|<del><code>hicest</code></del>||HicEst
|-
|<del><code>hq9plus</code></del>||[[w:HQ9+|HQ9+]]
|-
|<code>html4strict</code>||[[w:HTML|HTML]]
|-
|<code>html5</code>||[[w:HTML5|HTML5]]
|-
|<del><code>icon</code></del>||[[w:Icon (programming language)|Icon]]
|-
|<code>idl</code>||[[w:Universal Network Objects|Uno IDL]]
|-
|<code>ini</code>||[[w:INI file|INI]]
|-
|<del><code>inno</code></del>||[[w:Inno Setup|Inno]]
|-
|<del><code>intercal</code></del>||[[w:INTERCAL|INTERCAL]]
|-
|<code>io</code>||[[w:Io (programming language)|Io]]
|-
|<code>j</code>||[[w:J (programming language)|J]]
|-
|<code>java</code>||[[w:Java (programming language)|Java]]
|-
|<code>java5</code>||[[w:Java (programming language)|Java(TM) 2 Platform Standard Edition 5.0 ]]
|-
|<code>javascript</code>||[[w:JavaScript|JavaScript]]
|-
|<code>jquery</code>||[[w:jQuery|jQuery]]
|-
|<del><code>kixtart</code></del>||[[w:KiXtart|KiXtart]]
|-
|<del><code>klonec</code></del>||Klone C
|-
|<del><code>klonecpp</code></del>||Klone C++
|-
|<code>kotlin</code>||[[w:Kotlin (programming language)|Kotlin]]
|-
|<code>ksh</code>||[[w:Korn Shell|Korn shell]]
|-
|<code>latex</code>||[[w:LaTeX|LaTeX]]
|-
|<del><code>lb</code></del>||[[w:Liberty BASIC|Liberty BASIC]]
|-
|<del><code>ldif</code></del>||[[w:LDAP Data Interchange Format|LDAP Data Interchange Format]]
|-
|<code>lisp</code>||[[w:Lisp (programming language)|Lisp]]
|-
|<code>llvm</code>||[[w:LLVM|LLVM]]
|-
|<code>locobasic</code>||[[w:Locomotive BASIC|Locomotive BASIC]]
|-
|<code>logtalk</code>||[[w:Logtalk|Logtalk]]
|-
|<del><code>lolcode</code></del>||[[w:LOLCODE|LOLCODE]]
|-
|<del><code>lotusformulas</code></del>||[[w:Formula language|Formula language]]
|-
|<del><code>lotusscript</code></del>||[[w:LotusScript|LotusScript]]
|-
|<del><code>lscript</code></del>||[[w:LScript|LightWave 3D]]
|-
|<del><code>lsl2</code></del>||[[w:Linden Scripting Language|Linden Scripting Language]]
|-
|<code>lua</code>||[[w:Lua (programming language)|Lua]]
|-
|<del><code>magiksf</code></del>||[[w:Magik (programming language)|Magik]]
|-
|<code>m68k</code>||[[w:Motorola 68000|Motorola 68000 Assembler]]
|-
|<code>make</code>||[[w:Make (software)|make]]
|-
|<code>mapbasic</code>||[[w:MapBasic|MapBasic]]
|-
|<code>matlab</code>||[[w:MATLAB|MATLAB M]]
|-
|<del><code>mirc</code></del>||[[w:mIRC scripting language|mIRC scripting language]]
|-
|<code>mmix</code>||[[w:MMIX|MMIX]]
|-
|<code>modula2</code>||[[w:Modula-2|Modula-2]]
|-
|<del><code>modula3</code></del>||[[w:Modula-3|Modula-3]]
|-
|<code>mpasm</code>||[[w:PIC microcontroller|Microchip Assembler]]
|-
|<code>mxml</code>||[[w:MXML|MXML]]
|-
|<code>mysql</code>||[[w:MySQL|MySQL]]
|-
|<del><code>nagios</code></del>||[[w:Nagios|Nagios]]
|-
|<code>netrexx</code>||[[w:NetRexx|NetRexx]]
|-
|<code>newlisp</code>||[[w:NewLISP|NewLISP]]
|-
|<code>nsis</code>||[[w:Nullsoft Scriptable Install System|Nullsoft Scriptable Install System (NSIS)]]
|-
|<code>oberon2</code>||[[w:Oberon-2 (programming language)|Oberon-2]]
|-
|<code>objc</code>||[[w:Objective-C|Objective-C]]
|-
|<del><code>objeck</code></del>||[[w:Objeck (programming language)|Objeck]]
|-
|<code>ocaml</code>||[[w:OCaml|OCaml]]
|-
|<code>ocaml-brief</code>||[[w:OCaml|OCaml]]
|-
|<code>octave</code>||[[w:Octave programming language|Octave]]
|-
|<code>oobas</code>||[[w:StarOffice Basic|OpenOffice.org Basic]]
|-
|<code>oorexx</code>||[[w:Object REXX|Object REXX]]
|-
|<code>oracle11</code>||[[w:PL/SQL|Oracle 11 SQL]]
|-
|<code>oracle8</code>||[[w:PL/SQL|Oracle 8 SQL]]
|-
|<del><code>oxygene</code></del>||[[w:Oxygene (programming language)|Oxygene]]
|-
|<code>oz</code>||[[w:Oz (programming language)|Oz]]
|-
|<del><code>parasail</code></del>||[[w:ParaSail (programming language)|ParaSail]]
|-
|<del><code>parigp</code></del>||[[w:PARI/GP|PARI/GP]]
|-
|<code>pascal</code>||[[w:Pascal (programming language)|Pascal]]
|-
|<del><code>pcre</code></del>||[[w:Perl Compatible Regular Expressions|Perl Compatible Regular Expressions]]
|-
|<del><code>per</code></del>||per
|-
|<code>perl</code>||[[w:Perl|Perl]]
|-
|<code>perl6</code>||[[w:Perl 6|Perl 6]]
|-
|<del><code>pf</code></del>||[[w:PF (firewall)|PF]]
|-
|<code>php</code>||[[w:PHP|PHP]]
|-
|<code>php-brief</code>||[[w:PHP|PHP]] ''([[phab:T94292 |deprecated]] &ndash; no colors, odd framing)''
|-
|<code>pic16</code>||[[w:PIC microcontroller|PIC assembly language]]
|-
|<code>pike</code>||[[w:Pike (programming language)|Pike]]
|-
|<del><code>pixelbender</code></del>||[[w:Adobe Pixel Bender|Pixel Bender]]
|-
|<del><code>pli</code></del>||[[w:PL/I|PL/I]]
|-
|<code>plsql</code>||[[w:PL/SQL|PL/SQL]]
|-
|<code>postgresql</code>||[[w:PostgreSQL|PostgreSQL]]
|-
|<code>postscript</code>||[[w:PostScript|PostScript]]
|-
|<code>povray</code>||[[w:POV-Ray|Persistence of Vision Raytracer]]
|-
|<del><code>powerbuilder</code></del>||[[w:PowerBuilder|PowerBuilder]]
|-
|<code>powershell</code>||[[w:Windows PowerShell|Windows PowerShell]]
|-
|<del><code>proftpd</code></del>||[[w:ProFTPD|ProFTPD]]
|-
|<code>progress</code>||[[w:OpenEdge Advanced Business Language|OpenEdge Advanced Business Language]]
|-
|<code>prolog</code>||[[w:Prolog|Prolog]]
|-
|<code>properties</code>||[[w:.properties|Properties file]]
|-
|<del><code>providex</code></del>||[[w:ProvideX|ProvideX]]
|-
|<code>purebasic</code>||[[w:PureBasic|PureBasic]]
|-
|<code>pycon</code>||[[w:Python (programming language)|Python]]
|-
|<code>pys60</code>||[[w:Python for S60|PyS60]]
|-
|<code>python</code><br /><code>py</code>||[[w:Python (programming language)|Python]]
|-
|<code>python3</code><br /><code>py3</code>||[[w:Python (programming language)|Python3]]
|-
|<del><code>q</code></del>||[[w:Q (equational programming language)|Q]]
|-
|<code>qbasic</code>||[[w:QBasic|QBasic/QuickBASIC]]
|-
|<code>rails</code>||[[w:Ruby on Rails|Rails]]
|-
|<code>rebol</code>||[[w:Rebol|Rebol]]
|-
|<code>reg</code>||[[w:Windows Registry|Windows Registry]]
|-
|<code>rexx</code>||[[w:Rexx|Rexx]]
|-
|<del><code>robots</code></del>||[[w:Robots exclusion standard|robots.txt]]
|-
|<code>rpmspec</code>||[[w:RPM Package Manager|RPM Spec files]]
|-
|<code>rsplus</code>||[[w:R (programming language)|R]]
|-
|<code>ruby</code>||[[w:Ruby (programming language)|Ruby]]
|-
|<del><code>sas</code></del>||[[w:SAS (software)|SAS]]
|-
|<code>scala</code>||[[w:Scala_(programming_language)|Scala]]
|-
|<code>scheme</code>||[[w:Scheme (programming language)|Scheme]]
|-
|<code>sh</code><br /><code>shell</code><br /><code>shell-session</code>||[[w:Shell script|Shell Script]]
|-
|<code>scilab</code>||[[w:Scilab|Scilab]]
|-
|<code>sdlbasic</code>||[[w:SdlBasic|SdlBasic]]
|-
|<code>smalltalk</code>||[[w:Smalltalk|Smalltalk]]
|-
|<code>smarty</code>||[[w:Smarty|Smarty]]
|-
|<code>spark</code>||[[w:SPARK (programming language)|SPARK]]
|-
|<code>sparql</code>||[[w:SPARQL|SPARQL]]
|-
|<code>sql</code>||[[w:SQL|SQL]]
|-
|<del><code>stonescript</code></del>||StoneScript (Scripting language for [[w:ShiVa|ShiVa3D]])
|-
|<code>systemverilog</code>||[[w:SystemVerilog|SystemVerilog]]
|-
|<code>tcsh</code>||[[w:Tcsh|Tcsh]]
|-
|<code>tcl</code>||[[w:Tcl|Tcl]]
|-
|<del><code>teraterm</code></del>||[[w:Tera Term|Tera Term]]
|-
|<code>text</code>||[[w:Plain text|Plain text]]
|-
|<code>thinbasic</code>||[[w:thinBasic|thinBasic]]
|-
|<code>ts</code>||[[w:TypeScript|TypeScript]]
|-
|<code>tsql</code>||[[w:Transact-SQL|Transact-SQL]]
|-
|<del><code>typoscript</code></del>||[[w:TYPO3|TypoScript]]
|-
|<del><code>unicon</code></del>||[[w:Unicon (programming language)|Unicon]]
|-
|<code>upc</code>||[[w:Unified Parallel C|Unified Parallel C]]
|-
|<code>urbi</code>||[[w:URBI|URBI]]
|-
|<del><code>uscript</code></del>||[[w:UnrealScript|UnrealScript]]
|-
|<code>vala</code>||[[w:Vala_(programming_language)|Vala]]
|-
|<code>vb</code>||[[w:Visual Basic|Visual Basic]]
|-
|<code>vbnet</code>||[[w:Visual Basic .NET|Visual Basic .NET]]
|-
|<del><code>vedit</code></del>||[[w:VEDIT|VEDIT]]
|-
|<code>verilog</code>||[[w:Verilog|Verilog]]
|-
|<code>vhdl</code>||[[w:VHDL|VHDL]]
|-
|<code>vim</code>||[[w:Vim script|Vim script]]
|-
|<code>visualfoxpro</code>||[[w:Visual FoxPro|Visual FoxPro]]
|-
|<code>visualprolog</code>||[[w:Visual Prolog|Visual Prolog]]
|-
|<del><code>whitespace</code></del>||[[w:Whitespace (programming_language)|Whitespace]]
|-
|<del><code>whois</code></del>||[[w:Whois|Whois]]
|-
|<code>winbatch</code>||[[w:Winbatch|Winbatch]]
|-
|<code>xml</code>||[[w:XML|XML]]
|-
|<del><code>xorg_conf</code></del>||[[w:Xorg.conf|Xorg.conf]]
|-
|<code>yaml</code>||[[w:YAML|YAML]]
|-
|<code>xpp</code>||[[w:Microsoft Dynamics AX|Microsoft Dynamics AX]]
|-
|<code>z80</code>||[[w:Zilog Z80|ZiLOG Z80 Assembler]]
|-
|<code>zxbasic</code>||ZXBasic
|}
<div style="clear:both"></div>
{{collapse bottom}}

<translate>
== Installation == <!--T:70-->
</translate>
{{Note|1=<translate><!--T:116--> The version of this extension bundled with [[MediaWiki 1.31]] requires [<tvar|python>https://www.python.org</> Python] version 3 (<code>python3</code>) to be installed on the server. This is a change from the version bundled with [[MediaWiki 1.30]], which used Python version 2 (<code>python</code>). Note that the <code>python3</code> binary must be installed in the execution PATH of the PHP interpreter.</translate>}}
{{Note|1=<translate><!--T:71--> 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.</translate>}}
{{ExtensionInstall
|SyntaxHighlight_GeSHi
|composer=yes
|registration=1
|custom-steps=<nowiki/>
<translate>
<!--T:72-->
* In '''Linux''', set execute permissions for the ''pygmentize'' binary.</translate> <translate><!--T:121--> You can use an FTP client or the following shell command to do so:</translate>

<syntaxhighlight lang="Bash">
chmod a+x /path/to/extensions/SyntaxHighlight_GeSHi/pygments/pygmentize
</syntaxhighlight>
}}
{{Note|1=<translate><!--T:73--> When installing from [[<tvar|link>Special:MyLanguage/Git</>|Git]], please note that starting from MediaWiki 1.26, and ending with MediaWiki 1.31 this extension requires [[<tvar|link2>Special:MyLanguage/Composer</>|Composer]].</translate><br /><br /><translate><!--T:74--> So, after installation from Git change to the directory containing the extension e.g. <tvar|directory>"../extensions/SyntaxHighlight_GeSHi/"</> and run <tvar|install><code>composer install --no-dev</code></>, or when updating: <tvar|update><code>composer update --no-dev</code></>.</translate><br /><br /><translate><!--T:75--> Alternatively as well as preferably add the line <tvar|line><code>"extensions/SyntaxHighlight_GeSHi/composer.json"</code></> to the "composer.local.json" file in the root directory of your wiki like e.g.</translate>
<syntaxhighlight lang="JSON">
{
	"extra": {
		"merge-plugin": {
			"include": [
				"extensions/SyntaxHighlight_GeSHi/composer.json"
			]
		}
	}
}
</syntaxhighlight>
<translate>
<!--T:76-->
Now run <tvar|update><code>composer update --no-dev</code></>.</translate> Voilà!
}}
{{Warning|1=<translate><!--T:77--> When uploading the extension via FTP be sure to upload the ''pygments/pygmentize'' file with the transfer type ''binary''.</translate>}}

<translate>
=== Configuration === <!--T:78-->
</translate>

;Linux:

* <translate><!--T:79--> <tvar|setting><code>$wgPygmentizePath</code></> (optional): Absolute path to ''pygmentize'' of the Pygments package.</translate> <translate><!--T:80--> The extension bundles the Pygments package and <tvar|setting><code>$wgPygmentizePath</code></> points to the bundled version by default, but you can point to a different version, if you want to.</translate> <translate><!--T:81--> For example: <tvar|setting><code>$wgPygmentizePath = "/usr/local/bin/pygmentize";</code></>.</translate>
* <translate><!--T:82--> <tvar|setting><code>$wgSyntaxHighlightModels</code></>: Configure the default lexer for some wiki pages.</translate> <translate><!--T:83--> By default this will highlight javascript and css pages.</translate> <translate><!--T:84--> Additional content models can be configured by extensions (e.g. Lua, JSON, ..).</translate>  <translate><!--T:126--> Example:</translate><br />&nbsp;<code><nowiki>$wgSyntaxHighlightModels[CONTENT_MODEL_SCRIBUNTO] = 'lua';</nowiki></code>

;Windows:

* <translate><!--T:85--> If you are hosting your MediaWiki on a Windows machine, you have to set the path for the Pygmentize.exe <tvar|setting><code>$wgPygmentizePath = "c:\\Python27\\Scripts\\pygmentize.exe";</code></></translate>
** <translate><!--T:86--> If there is no <tvar|pygmentize><code>pygmentize.exe</code></> run <tvar|install><code>easy_install Pygments</code></> from command line inside the <tvar|scripts><code>Scripts</code></> folder to generate the file.</translate>

<translate>
<!--T:87-->
If you are using the bundled pygmentize binary (<tvar|location>extensions/SyntaxHighlight_GeSHi/pygments/pygmentize</>), make sure your webserver is permitted to execute it.</translate>
<translate>
<!--T:88-->
If your host does not allow you to add executables to your web directory, install python-pygments and add <tvar|setting><code>$wgPygmentizePath = pygmentize</code></> to LocalSettings.php.
</translate>

;<translate><!--T:89--> Troubleshooting</translate>:

<translate>
<!--T:90-->
After updating to MediaWiki v1.26 and above, some users started reporting problems with the extension.</translate> <translate><!--T:117--> There could be cases, when some languages, such as ''Lua'' might not get highlighted and by turning on [[<tvar|debug>Special:MyLanguage/Manual:How to debug</>|debugging]], MediaWiki would throw out the error, <tvar|error><code>Notice: Failed to invoke Pygments: /usr/bin/env: python3: No such file or directory</code></>.</translate>

* <translate><!--T:91--> Try pointing <tvar|setting><code>$wgPygmentizePath</code></> in LocalSettings.php towards an external pygmentize binary.</translate>
:* 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 (<code>source /virtualenv/python/3.5/bin/activate</code>). After this, the Pygments [https://clients.temok.com/knowledgebase.php?action=displayarticle&id=524 module can be added] to the Python app, for which navigate to the virtual environment path (<code>cd virtualenv/python/3.5/bin/</code>), download and install Pygments (<code>./pip install Pygments</code>) 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: <code>virtualenv/python/3.5/bin/pygmentize</code>
* <translate><!--T:92--> See the [<tvar|url>https://phabricator.wikimedia.org/T128993</> phabricator task] on this for further suggestions and information.</translate>

<translate>
=== VisualEditor integration === <!--T:93-->

<!--T:94-->
The plugin enables direct editing with [[<tvar|link>Special:MyLanguage/Extension:VisualEditor</>|VisualEditor]].</translate>
<translate>
<!--T:95-->
A popup is opened when a user wants to edit <tvar|source><code>source</code></> or <tvar|syntaxhighlight><code>syntaxhighlight</code></> sections.</translate>
<translate>
<!--T:96-->
For this to work, VisualEditor must be installed and configured from the latest git version, same for Parsoid.</translate>
<translate>
<!--T:97-->
The feature randomly does not work with older Parsoid versions.
</translate>
<translate>
<!--T:114-->
See [[<tvar|veinstructions>Extension:SyntaxHighlight/VisualEditor</>]] for details
</translate>

{{anchor|Advanced}}
<translate>
== Advanced == <!--T:98-->

<!--T:99-->
Unlike the <tvar|pre><code><nowiki><pre></nowiki></code></> and <tvar|code><code><nowiki><code></nowiki></code></> tags, HTML character entities such as <code>&amp;nbsp;</code> need not (and should not) have the <tvar|and><code>&</code></> character escaped as <code>&amp;amp;</code>.</translate>
<translate>
<!--T:100-->
Like the <tvar|pre><code><nowiki><pre></nowiki></code></> tag but unlike the <tvar|code><code><nowiki><code></nowiki></code></> tag, tags within the range (other than its own closing tag) need not have the <tvar|less><code><</code></> symbol escaped as <tvar|less2><code>&amp;lt;</code></>, nor does wikitext need to be escaped with a <tvar|nowiki><code>&lt;nowiki></code></> tag.

<!--T:101-->
Furthermore, while <tvar|pre><code><nowiki><pre></nowiki></code></> assumes tab stops every 8 characters and renders tabs using actual spaces when the rendered text is copied, <tvar|syntaxhighlight><code><nowiki><syntaxhighlight></nowiki></code></> uses 4-space tab stops (except Internet Explorer, which uses 8) and preserves the tab characters in the rendered text; the latter may be changed using an enclosing <tvar|span><code>&lt;span style="-moz-tab-size:''nn''; -o-tab-size:''nn''; tab-size:''nn'';"></code></> tag (not <tvar|div><code><nowiki><div></nowiki></code></>, and not using its own <tvar|style><code>style</code></> attribute).</translate>
<translate>
<!--T:102-->
The <tvar|moz><code>-moz-</code></> prefix is required for Firefox (from version 4.0), and the <tvar|prefix-o><code>-o-</code></> prefix is required for Opera (from version 10.60 to version 15).</translate><ref>http://developer.mozilla.org/en-US/docs/Web/CSS/tab-size</ref> (<translate><!--T:103--> Note that the wiki editing box assumes 8-space tabs.</translate>)
<translate>
<!--T:104-->
This applies only to actual saved pages; previews generated through an edit box or <tvar|special>[[Special:ExpandTemplates]]</> may differ.

== See also == <!--T:105-->
</translate>

* [http://pygments.org/ Pygments – Python syntax highlighter]
<translate>
<!--T:122-->
* Extensions dependent on this one:
</translate>
** {{ll|Extension:SyntaxHighlightPages}} &ndash; <translate><!--T:123--> highlights pages based on title suffixes.</translate>
** {{ll|Extension:ViewFiles}} &ndash; <translate><!--T:124--> makes files specified by the system administrator accessible via a special page.</translate>
<translate>
<!--T:125-->
* Alternative extensions:
</translate>
** {{ll|Extension:GoogleCodePrettify}} &ndash; <translate><!--T:111--> syntax highlighter that uses Google Code Prettify library.</translate>
** {{ll|Extension:SyntaxHighlighter}} &ndash; <translate><!--T:112--> syntax highlighter that uses SyntaxHighlighter library.</translate>

<translate>
==Footnotes== <!--T:115-->
</translate>
<references />

{{OnWikimedia}}

[[Category:Syntax highlighting extensions{{#translation:}}]]
[[Category:GeSHi extensions{{#translation:}}]]
[[Category:Extensions with VisualEditor support{{#translation:}}]]
[[Category:RejectParserCacheValue extensions{{#translation:}}]]