View source for Template:Code/doc

{{Documentation subpage}}
__NOTOC__

==Usage==
Wraps a short span of text in {{tag|syntaxhighlight|o}} tags (see [[mw:Extension:SyntaxHighlight]]). This template should be used for short samples; longer content should use {{tag|pre}} or {{tag|syntaxhighlight}}. See [[wikipedia:Help:Wiki markup]] for an explanation of what the various tags do.

If the content includes an equals sign (=), you must specify the parameter explicitly: <code><nowiki>{{code|1=date=30 Feb 2010}}</nowiki></code>.

The template uses the {{tag|syntaxhighlight|o}} tag with the attribute {{code|inline=1}}. This works like the combination of the {{tag|code|o}} and {{tag|nowiki|o}} tags, applied to the expanded wikitext. For example, <code><nowiki>{{code|some '''wiki''' text}}</nowiki></code> will '''''not''''' render the word "wiki" in bold, and will render the tripled-single-quotes:

: {{code|some '''wiki''' text}}

However, <code><nowiki>{{code|a {{template}} call}}</nowiki></code> will still invoke the template:

:{{code|a {{template}} call}}

Use {{tag|nowiki}} around the template name to avoid this problem:

:{{code|a <nowiki>{{template}}</nowiki> call}}

When used inline with regular text, {{tlc|code}} generally looks best and is easiest to read when it is explicitly spaced apart from the regular text:
:{{code|foo &nbsp;<nowiki>{{code|bar baz}}</nowiki>&nbsp; quux.}}
is well spaced:
:foo &nbsp;{{code|bar baz}}&nbsp; quux.
versus:
:{{code|foo <nowiki>{{code|bar baz}}</nowiki> quux.}}
which is going to be visually confusing for many:
:foo {{code|bar baz}} quux.
because "foo" and "{{code|bar}}" will seem more closely associated than "{{code|bar}}" and "{{code|baz}}"; the width of the space character in a monospaced font is almost always larger than in a proportional font.

Use parameter {{{2}}} (unnamed, as {{para|2}}, or more explicitly as {{para|lang}}) to specify a language for [[mw:Extension:SyntaxHighlight]]. This option defaults to plain-text, i.e. no highlighting.  There is no highlighting option for wikitext as a markup language, though {{code|html4strict}} and {{code|html5}} are valid values, as are {{code|php}}, {{code|perl}}, {{code|css}}, {{code|javascript}}, {{code|mysql}} and many others. Attempting to use an invalid one causes a list of valid ones to be displayed in place of the template output, when the page is previewed or saved.

This template does not need to be [[Wikipedia:Template substitution|substituted]].

===Examples===
{| class="wikitable" style="margin:auto"
|-
! Markup !! Renders As
|-
|<nowiki>Lorem {{code|ipsum '''dolor'''}} sit amet</nowiki> || Lorem {{code|ipsum '''dolor'''}} sit amet
|-
|<nowiki>The declaration {{code |lang=cpp |int foo(const std::string& bar, const std::vector<long double*>& baz);}} is the prototype for a function defined later.</nowiki> || The declaration {{code |lang=cpp |int foo(const std::string& bar, const std::vector<long double*>& baz);}} is the prototype for a function defined later.
|-
|<nowiki>If the code contains an [[equals sign]], such as {{code |lang=javascript |code=var img = document.getElementsByTagName("img");}}, you must identify the first parameter explicitly as {{{1}}} or {{{code}}}</nowiki> || If the code contains an [[equals sign]], such as {{code |lang=javascript |code=var img = document.getElementsByTagName("img");}}, you must identify the first parameter explicitly as {{{1}}} or {{{code}}}.
|}

=== Included templates ===
Embedded templates do not function as expected inside {{tlb|code}}; for longer, free-form blocks of code, which can contain templates such as {{tl|var}} and {{tl|samp}}, use {{tag|code}} as a wrapper instead of this template.

Templates used inside {{tlc|code}} expose the rendered HTML— this can be useful. For example:
{| class="wikitable" style="margin:auto"
|-
! Markup !! Renders As
|-
|1=<nowiki>{{code|
{{Role|uke=someone|seme=someone else}}
}}</nowiki>
|2={{code|
{{Role|uke=someone|seme=someone else}}
}}
|}

The above example shows the HTML rendered by the {{tl|Role}} template, including the hidden metadata.

== Other formatting templates ==
* {{c|Formatting Templates}}

== TemplateData ==
<templatedata>
{
	"description": "An inline source code string.",
	"format": "inline",
	"params": {
		"1": {
			"label": "Code",
			"aliases": ["code"],
			"description": "The code to display.",
			"required": true,
			"type": "string"
		},
		"2": {
			"label": "Language",
			"aliases": ["lang"],
			"description": "The programming language of the source code. List of valid values is at: [[mw:Extension:SyntaxHighlight#Supported_languages]]",
			"default": "text",
			"suggested": true,
			"type": "string"
		},
		"class": {
			"label": "Class",
			"type": "string"
		},
		"id": {
			"label": "ID",
			"type": "string"
		},
		"style": {
			"label": "CSS Style",
			"type": "string"
		}
	}
}
</templatedata>

<includeonly>{{sandbox other||{{testcases other||

<!-- Categories below this line, please -->
[[Category:Templates]]
[[Category:Documentation formatting templates]]
}}}}</includeonly>