Template:Syntaxhighlight/doc

This is a documentation subpage for Template:Syntaxhighlight.
It may contain usage information, categories and other content that is not part of the original template page.

__EXPECTED_UNCONNECTED_PAGE__

Due to a server limit of 500 "expensive parser function" calls (e.g. #ifexist:, PAGESIZE:, and PAGESINCATEGORY:), this template will only work properly if the page using it has not already exceeded the limit. When the limit is exceeded, the page using this template or module is categorised in Category:Pages with too many expensive parser function calls. (further information)

Redirects

{{syntaxhilight}}
{{syntax highlight}}

Shortcuts

Simple wrapper around the <syntaxhighlight> tag to show syntax-highlighted text. Unlike <syntaxhighlight>, text that does not fit on the screen will be wrapped.

Usage

{{Syntaxhighlight|code|lang}}

code will become the contents of the syntax highlighted block.
lang is the language used for syntax highlighting. Use |lang=wikitext for wikitext (wikimarkup). Other supported languages are listed below.

For inline mode, use {{code}} instead. (Despite the name, it generates <syntaxhighlight inline>, not <code>.)

The <syntaxhighlight> tag used by this template is an 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 <code>...</code> blocks (without syntax highlighting).

Supported languages

Main article: mw: Extension: SyntaxHighlight#Supported languages

Code	Language
`4cs`	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 assembly
`abap`	ABAP
`actionscript`	ActionScript
`actionscript3`	ActionScript3
`ada`	Ada
`algol68`	ALGOL 68
`apache`	Apache configuration
`applescript`	AppleScript
`apt_sources`	APT sources
`arm`	ARM assembly
`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`	C
`c_loadrunner`	C Loadrunner
`c_mac`	C (Mac)
`caddcl`	AutoCAD Dialog Control Language (DCL)
`cadlisp`	AutoLISP
`cfdg`	CFDG
`cfm`	ColdFusion Markup Language
`chaiscript`	ChaiScript
`cil`	Common Intermediate Language (CIL)
`clojure`	Clojure
`clp`	Control Language Program
`cmake`	CMake
`cobol`	COBOL
`coffeescript`	CoffeeScript
`cpp`	C++
`cpp-qt`	C++ (Qt toolkit)
`csharp`	C#
`css`	Cascading Style Sheets (CSS)
`cuesheet`	Cue sheet
`d`	D
`dcl`	DIGITAL Command Language
`dcpu16`	DCPU-16
`dcs`	Data Conversion System
`delphi`	Delphi
`diff`	Diff
`div`	DIV
`dos`	DOS batch file
`dot`	DOT
`e`	E
`ecmascript`	ECMAScript
`eiffel`	Eiffel
`email`	Email (mbox \ eml \ RFC format)
`epc`	Enerscript
`erlang`	Erlang
`euphoria`	Euphoria
`f1`	Formula One
`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+
`html`	HTML
`icon`	Icon
`idl`	Uno IDL
`ini`	INI
`inno`	Inno
`intercal`	INTERCAL
`io`	Io
`j`	J
`java`	Java
`java5`	Java(TM) 2 Platform Standard Edition 5.0
`javascript`	JavaScript
`jcl`	Job Control Language
`kixtart`	KiXtart
`klonec`	Klone C
`klonecpp`	Klone C++
`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 assembly
`make`	make
`mapbasic`	MapBasic
`matlab`	MATLAB M
`mirc`	mIRC scripting language
`mmix`	MMIX
`modula2`	Modula-2
`modula3`	Modula-3
`mpasm`	Microchip assembly
`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
`ocl`	Operational Control Language
`octave`	Octave
`oobas`	OpenOffice 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`	Perl
`perl6`	Raku
`pf`	PF
`php`	PHP
`php-brief`	PHP
`pic16`	PIC assembly
`pike`	Pike
`pixelbender`	Pixel Bender
`pli`	PL/I
`plsql`	PL/SQL
`postgresql`	PostgreSQL
`povray`	Persistence of Vision Raytracer
`powerbuilder`	PowerBuilder
`powershell`	PowerShell
`proftpd`	ProFTPD
`progress`	OpenEdge Advanced Business Language
`prolog`	Prolog
`properties`	Properties file
`providex`	ProvideX
`purebasic`	PureBasic
`pycon`	Python
`pys60`	PyS60
`python`	Python
`q`	Q
`qbasic`	QBasic–QuickBASIC
`ragel`	Ragel
`rails`	Rails
`rebol`	Rebol
`reg`	Windows Registry
`rexx`	Rexx
`robots`	robots.txt
`rpg`	RPG
`rpgii`	RPG II
`rpgiii`	RPG III
`rpg400`	RPG/400
`rpgiv`	RPG IV
`rpmspec`	RPM Spec files
`rsplus`	R
`ruby`	Ruby
`sas`	SAS
`scala`	Scala
`scheme`	Scheme
`scilab`	Scilab
`sdlbasic`	SdlBasic
`smalltalk`	Smalltalk
`smarty`	Smarty
`spark`	SPARK
`sparql`	SPARQL
`sql`	SQL
`stonescript`	StoneScript (scripting language for ShiVa3D)
`systemverilog`	SystemVerilog
`tcl`	Tcl
`teraterm`	Tera Term
`text`	Plain text
`thinbasic`	thinBasic
`tsql`	Transact-SQL
`typoscript`	TypoScript
`unicon`	Unicon
`upc`	Unified Parallel C
`urbi`	URBI
`uscript`	UnrealScript
`vala`	Vala
`vb`	Visual Basic (classic)
`vbnet`	Visual Basic (.NET)
`vedit`	VEDIT
`verilog`	Verilog
`vhdl`	VHDL
`vim`	Vim script
`visualfoxpro`	Visual FoxPro
`visualprolog`	Visual Prolog
`whitespace`	Whitespace
`whois`	Whois
`wikitext`	Help:Wikitext
`winbatch`	Winbatch
`xml`	XML
`xorg_conf`	Xorg.conf
`yaml`	YAML
`xpp`	Microsoft Dynamics AX
`z80`	Zilog Z80 assembly
`zxbasic`	ZXBasic (Sinclair BASIC derivative)

Examples

JavaScript example

{{syntaxhighlight|lang=javascript|code=const elem = document.getElementById("para"); elem.style.color = "green";}}

const elem = document.getElementById("para"); elem.style.color = "green";

Necessary unescaping of source code from another page

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

{{infobox
| title       = Personal likes
| above       = Demo: using [[WP:ENGVAR|WP:Engvar]] in templates
| abovestyle  = background:#ddd; font-weight:normal; font-size:smaller;
| headerstyle = background:lemonchiffon
| label1      = Home country
| data1       = {{{home country|}}}
| header2     = {{engvar|defaultWord=Favourite |defaultLang=en-GB | engvar={{{engvar|auto}}}
                        |en-US=Favorite }} things
| label3      = {{engvar|defaultWord=Colour |defaultLang=en-GB | engvar={{{engvar|auto}}}
                        |en-US=Color }}
| data3       = {{{color|}}}
| label4      = {{engvar|defaultWord=Football |defaultLang=en-GB | engvar={{{engvar|auto}}}
                        |en-US=Soccer |en-AU=Association Football}} team
| data4       = {{{team|}}}
| below       = In this demo 'article', the template parameter is set: {{para|1=engvar|2={{{engvar|(unspecified)}}}}}
| belowstyle  = background:#ddd;
}}

TemplateData

This is the TemplateData for this template used by TemplateWizard, VisualEditor and other tools. See a monthly parameter usage report for Template:Syntaxhighlight in articles based on its TemplateData.

TemplateData for Syntaxhighlight

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.

Template parameters
Parameter		Description	Type	Status
code	`code` `1`	The code that will be displayed	Content	required
lang	`lang` `2`	The language of the code Default text	String	suggested
border	`border`	Set this to "no" to remove the border Auto value `no`	Unknown	optional

Notes

Sometimes, an error regarding scriptmarker^{[clarification needed]} exposed may occur when using these templates. If you encounter this issue, please manually highlight your code using wikitext.

Usage

This template can be used to make a standard navigation box. It is intended for use within another template that standardises the title and contents of the box (see Template:ShipNavbox). This template SHOULD NOT be used directly within articles, as it creates a maintenance burden to do so whenever the contents of the box have to be updated.

The purpose of this template is to standardise the attributes of all navigation boxes, for example, their colours and other CSS attributes. The template is fairly simple, and could be extended to add other features in the future. Using this template allows changes to be implemented much quicker and easier than editing each template separately.

Syntax

{{navbox
|state      = uncollapsed, collapsed, plain, autocollapse (default)
|name       = mandatory - name of the template
|style      = optional - style for the whole table
|title      = mandatory - navbox header
|gtitleN    = optional - title of N-th group of items
|styleN     = optional - style for groupN; i.e. text-align
|groupN     = mandatory - list of groups of items
|fstyle     = optional - style for footer ; i.e. text-align
|footer     = optional - navbox footer
}}

Groups: Currently there is no technical limit to the maximum number of groups.
- Groups of items can be added as parameters: group1, group2, group3, ... up to groupN.
Group title: Each group has its own title parameter: gtitle1, gtitle2, gtitle3, ... up to gtitleN. Note that the default width for the first column is 15%.
Group style: Style may also be customised to each group in: style1, style2, style3, ... up to styleN.
- Note that neither the title nor the items have any wiki-links built into the template. As a result, users of the template are free to use wiki-links as they wish.
Line breaks: Line-breaks (<br />) are unnecessary, as text wrapping is done automatically by the template. This also includes links and text in gtitleN and groupN.
Bullets: Create unordered lists with lines beginning with *.
Pipe links: Because of the nature of template syntax, it may be necessary to use Template:! ({{!}}).

States

Autocollapse: By default, the state of a navbox is "autocollapsed". This means that if the number of navboxes in a page exceeds the maximum allocation of the collapsible navboxes, then the remaining navboxes are collapsed automatically. For more information (or to change the setting), see MediaWiki:Common.js.
- Currently, the autocollapse allocation is 2 (see MediaWiki:Common.js). This means that if there are 3 navboxes in a page, the third and subsequent navboxes will be collapsed automatically.
Uncollapsed: Forces the navbox to be displayed.
- All of the navboxes in this documentation are in the uncollapsed state.
Collapsed: The reverse of uncollapsed. Forces the navbox to be hidden instead.
- Navboxes with a height of more than 300 pixels will also be collapsed automatically. For more information (or to change the setting), see MediaWiki:Common.js.
Plain: Removes the "show/hide" link.

Sub-groups

For larger navboxes, it may be necessary to include sub-groups within a particular group of items. It is also possible to collapsible navboxes within the parent navbox, see Collapsible sub-groups.
To create sub-groups within {{navbox}}, certain parameters are to be included:
- The parent navbox group (i.e. group2 in the example below) requires the type parameter (gtype2 = Subgroup).
- The nested navbox (sub-group) requires the inclusion of the sub-group parameter (subgroup = yes). This enables the template to differentiate between the sub-group and the parent navbox.

{{navbox
|name    =
|title   =
|gtitle1 =
|group1  =
|gtitle2 =  
|gtype2  = Subgroup (mandatory)
|group2  = 
  {{navbox
  |subgroup = yes (mandatory)
  |gtitle1  = 
  |group1   =
  |gtitle2  = 
  |group2   = 
  }}
}}

Collapsible sub-groups

For extremely long navboxes, it is recommended to use collapsible navboxes within the parent navbox. Further sub-groups can then be added to these collapsible navboxes.
To create collapsible sub-groups within {{navbox}}, these parameters need to be included:
- The parent navbox is almost always uncollapsed (state=uncollapsed).
- The parent navbox group (i.e. group1 in the example below) requires the type parameter (gtype1 = Subgroup).
- The nested collapsible navbox requires the inclusion of the collapsible parameter (collapsible = yes). This enables the template to differentiate between the collapsible navbox and the parent navbox.
- The nested collapsible navbox is forcefully collapsed (state=collapsed).

{{navbox
|state  = uncollapsed
|name   = 
|gtype1 = Subgroup
|group1 = 
  {{navbox
  |collapsible = yes
  |state   = collapsed
  |title   = 
  |gtitle1 = 
  |group1  = 
  |gtitle2 = 
  |group2  = 
  }}
}}

Use of images

The use of images in navboxes is permitted, but please resize the images to keep them small. Inventory-sized images (25-30 pixels) are recommended.
Please use {{t|plink}} to create links with images. Use {{t|plink}} for any case where text is not desired after the link. It functions the same as {{t|plink}}, but it does not produce a wikilink in text. Use {{t|chatl}} to link chatheads. These templates create links for both the image and text (except for {{t|plink}}) using far less wikicode than the standard syntax.

Link and file share the same name

{{plink|Item}}

File name differs from the link

{{plink|Item|File}}

Link and file share the same name, but different text is desired to display

{{plink|Item|alt=Text}}

File name differs from the link and different text is desired to display

{{plink|Item|File|alt=Text}}

Categorising

Navboxes are very useful for transcluding categories onto a large number of pages that share both a trait and the navigation box. For example: Template:ShipNavbox transcludes Category:Ships onto every page that uses it.

There are 2 methods of categorising pages with navboxes:

The first way is with {{t|Ctg}}. This is the preferred method, and can be used in most cases. The rules and operations for the Category handler template are very simple; however, they are enough to produce the desired results on most pages.

Categorisation should only be used on a template for large-scale addition. It is unhelpful, for example, to use a rule that only applies to 1 page.

Examples

To see the following navboxes in action, see Template:Navbox.

Single line navbox with centered list

{{navbox
|name    = 
|title   = 
|style1  = text-align:center
|group1  =
}}

Navbox with standard footer

{{navbox
|name    = 
|title   = 
|gtitle1 = 
|group1  = 
|footer  = Centered footer
}}

Navbox with styled footer

{{navbox
|name    = 
|title   = 
|gtitle1 = 
|group1  = 
|fstyle  = text-align:right
|footer  = Right-aligned footer
}}

Multiple line navbox

{{navbox
|name    = 
|title   = 
|gtitle1 = Group title 1
|group1  = 
|gtitle2 = Group title 2
|group2  = 
|gtitle3 = Group title 3
|group3  = 
}}

Collapsed navbox

{{navbox
|state   = collapsed
|name    = 
|title   = 
|style1  = text-align:center
|group1  = 
}}

Plain navbox with Tnavbar

{{navbox
|state   = plain
|name    = 
|title   = 
|style1  = text-align:center
|group1  = 
}}

Plain navbox without Tnavbar

{{navbox
|state   = plain
|title   = 
|style1  = text-align:center
|group1  = 
}}

Complicated navbox

{{navbox
|state   = uncollapsed
|name    = 
|title   = 
|gtitle1 = Level 1 Title 1
|group1  = 
|gtitle2 = Level 1 Title 2
|group2  = 
|gtitle3 = Level 1 Title 3
|group3  = 
|gtitle4 = Level 1 Title 4
|group4  = 
|gtitle5 = Level 1 Title 5
|gtype5  = Subgroup
|group5  = 
  {{navbox
  |subgroup = Yes
  |gtitle1  = Level 2 Title 1
  |group1   =
  |gtitle2  = Level 2 Title 2
  |group2   =
  |gtitle3  = Level 2 Title 3
  |gtype3   = Subgroup
  |group3   = 
    {{navbox
    |subgroup = Yes
    |gtitle1  = Level 3 Title 1
    |group1   =
    |gtitle2  = Level 3 Title 2
    |group2   =
    }}
  |gtitle4  = Level 2 Title 4
  |group4   = 
  }}
|gtitle6 = Level 1 Title 6
|group6  = 
|gtitle7 = Level 1 Title 7
|group7  = 
|fstyle  = 
|footer  = 
}}

Preventing unwanted documentation

The Navbox template's documentation is automatically transcluded under the navbox on any Template namespace page. It is not transcluded when used as a sub-group or collapsible sub-group template (subgroup= yes or collapsible=yes).

Should the documentation appear when it is unwanted, it can be hidden by setting the doc parameter doc=no on the template. In most cases, the doc parameter is NOT used and the parameter is removed completely.

Template:Syntaxhighlight/doc

Contents

Usage

Supported languages

Examples

JavaScript example

Necessary unescaping of source code from another page

TemplateData

Notes

See also

Usage

Syntax

States

Sub-groups

Collapsible sub-groups

Use of images

Categorising

Examples

Single line navbox with centered list

Navbox with standard footer

Navbox with styled footer

Multiple line navbox

Collapsed navbox

Plain navbox with Tnavbar

Plain navbox without Tnavbar

Complicated navbox

Preventing unwanted documentation