View source for Template:Syntaxhighlight/doc

{{Documentation subpage}}
{{Expensive}}
{{tlr|syntaxhilight|syntax highlight}}
{{tsh|sxhl|synhl|synhi}}
<!-- PLEASE ADD CATEGORIES AND INTERWIKIS AT THE BOTTOM OF THIS PAGE -->

Simple wrapper around the {{xtag|syntaxhighlight}} tag to show [[Syntax highlighting|syntax-highlighted]] text. Unlike {{tag|syntaxhighlight|o}}, text that does not fit on the screen will be [[text wrap|wrapped]].

==Usage==
{{tlx|Syntaxhighlight|''code''|''lang''}}

* ''code'' will become the contents of the syntax highlighted block.
* ''lang'' is the language used for syntax highlighting. Use {{para|lang|wikitext}} for [[Help:wikitext|wikitext]] (wikimarkup). Other supported languages are [[#Supported languages|listed below]].

For inline mode, use {{tlx|code}} instead. (Despite the name, it generates {{tag|syntaxhighlight|o|attribs=inline}}, not {{tag|code|o}}.)

The {{tag|syntaxhighlight|o}} tag used by this template is an [[WP:EXPENSIVE|expensive parser function call]], so, if it is used on a page with 500 or more 'expensive' parser functions, all subsequent instances of this template after the 500th expensive function use on that page will be rendered as {{tag|code|link=y}} blocks (without syntax highlighting).

==Supported languages==
{{main|mw: Extension: SyntaxHighlight#Supported languages}}

{{Incomplete list}}

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

{{clear}}

==Examples==

===JavaScript example===
<syntaxhighlight lang="wikitext" inline>{{syntaxhighlight|lang=javascript|code=const elem = document.getElementById("para"); elem.style.color = "green";}}</syntaxhighlight>
{{syntaxhighlight|lang=javascript|code=const elem = document.getElementById("para"); elem.style.color = "green";}}

===Necessary unescaping of source code from another page===

{{demo|<nowiki>{{syntaxhighlight|{{#invoke:DecodeEncode|decode|s={{msgnw:Template:Engvar/doc/infobox demo}}}}|lang=wikitext}}</nowiki>}}

==TemplateData==
{{templatedata header}}

<templatedata>
{
	"params": {
		"code": {
			"aliases": [
				"1"
			],
			"description": "The code that will be displayed",
			"required": true,
			"type": "content"
		},
		"lang": {
			"aliases": [
				"2"
			],
			"description": "The language of the code",
			"type": "string",
			"default": "text",
			"suggested": true
		},
		"border": {
			"description": "Set this to \"no\" to remove the border",
			"autovalue": "no"
		}
	},
	"description": "Simple wrapper around the <syntaxhighlight> tag to show syntax-highlighted text. Unlike <syntaxhighlight>, text that does not fit on the screen will be wrapped. For inline mode, use {{code}} instead."
}
</templatedata>

== Notes ==
* Sometimes, an error regarding [[mediawikiwiki:Strip marker|scriptmarker]]{{Clarify|reason=What's "scriptmarker"? The link points to "strip marker", so perhaps it's an eggcorn.|date=March 2026}} exposed may occur when using these templates. If you encounter this issue, please manually highlight your code using [[wikitext]].

==See also==
{{Semantic markup templates|show}}
<includeonly>{{Sandbox other||
<!-- Categories below this line -->
[[Category:Text-specific formatting and function templates]]
}}</includeonly>