View source for Template:Code/doc

{{Documentation subpage}}
<!-- Add categories where indicated at the bottom of this page and interwikis at Wikidata -->
{{#ifeq: {{PAGENAME}}|{{ROOTPAGENAME}}|{{High-risk}}}}
{{Expensive}}

==Usage==
Wraps a short span of text in {{xtag|syntaxhighlight|p}} tags. 

This template should only be used for short samples; longer content should use {{tag|syntaxhighlight|o}} or {{tlx|syntaxhighlight}}. See [[Help:Wiki markup]] for an explanation of what the various tags do, for example {{tlx|code|some text}} will render:

:{{code|some text}}

If the content includes an equals sign (=), you should escape it using {{tlx|{{=}}}} or, if doing so is unworkable, specify the parameter explicitly (such as with {{tlx|code|2=1=int i = 0;}}).

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

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

If the above example is declared as wikitext (via {{tlx|code|some <nowiki>'''wiki'''</nowiki> text|lang{{=}}wikitext}}), the output is rendered as follows:

:{{code|some '''wiki''' text|lang=wikitext}}

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

:{{code|a {{template}} call|lang=wikitext}}

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

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

When used inline with regular text, {{tnull|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.|lang=wikitext}}
is well spaced:
:foo &nbsp;{{code|bar baz}}&nbsp; quux.
versus:
:{{code|foo <nowiki>{{code|bar baz}}</nowiki> quux.|wikitext}}
which is less visually clear:
: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 unnamed parameter {{para|2}}, or more explicitly as {{para|lang}} to specify a language for [[mw:Extension:SyntaxHighlight]]. This option defaults to {{para|lang|text}}, i.e. no highlighting. Valid values include {{para|lang|wikitext}} for wikitext, {{para|lang|html}} for HTML, along with many other languages including {{code|php}}, {{code|perl}}, {{code|css}}, {{code|javascript}}, {{code|mysql}}. Attempting to use an invalid value for lang will cause the page to be added to [[:Category:Pages with syntax highlighting errors]], and no syntax highlighting will be present in the output. {{code|html4strict}} and {{code|html5}} used to be valid values - however, {{para|lang|html}} should be used instead.

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

==Examples==

{{markup
|<nowiki>Lorem {{code|ipsum '''dolor'''}} sit amet</nowiki>
|Lorem {{code|ipsum '''dolor'''}} sit amet

|<nowiki>Lorem {{code|ipsum '''dolor'''|wikitext}} sit amet</nowiki>
|Lorem {{code|ipsum '''dolor'''|wikitext}} 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}}}; see also [[:bugzilla:5138]].</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}}}; see also [[:bugzilla:5138]].
}}

==Included templates==
Embedded templates do not function as expected inside {{tl|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 {{tl|code}} expose the rendered HTML— this can be useful. For example:
<div style="overflow:auto;">
{{markup
|1=<nowiki>{{code|
{{cite web |title=Title |url=http://example.org}}
|lang=html
}}</nowiki>
|2={{code|
{{cite web |title=Title |url=http://example.org}}
|lang=html
}}
}}
</div>
The above example shows the HTML rendered by the citation template, including the hidden metadata.

== Expensive Parser Function warning ==
This template internally uses [[mw:Extension:SyntaxHighlight]], which is considered an 'expensive parser function' (see [[WP:EXPENSIVE]]). If used on a page which uses more than 500 expensive parser functions, the output of subsequent uses of this template will be presented using {{tag|code}} formatting (without any syntax highlighting) instead.

== TemplateData ==
{{Format TemplateData|<templatedata>
{
    "description": "An inline source code string with automatic syntax highlighting.",
    "format": "inline",
    "params": {
        "1": {
            "label": "Code",
            "aliases": [
                "code"
            ],
            "description": "The code to display.",
            "required": true,
            "type": "content"
        },
        "2": {
            "label": "Language",
            "aliases": [
                "lang"
            ],
            "description": "The programming language of the source code. List of valid values is at: [[mw:Extension:SyntaxHighlight#Supported_languages]]. The suggested values are a subset of those.",
            "default": "text",
            "suggested": true,
            "type": "string",
            "suggestedvalues": [
                "asm",
                "bash",
                "batch",
                "c",
                "cmake",
                "cobol",
                "csv",
                "csharp",
                "css",
                "delphi",
                "diff",
                "docker",
                "go",
                "graphql",
                "haskell",
                "html",
                "ini",
                "java",
                "javascript",
                "json",
                "latex",
                "lua",
                "makefile",
                "markdown",
                "matlab",
                "objective-c",
                "perl",
                "php",
                "postscript",
                "powershell",
                "python",
                "qsharp",
                "r",
                "reg",
                "ruby",
                "rust",
                "shell",
                "sql",
                "swift",
                "text",
                "typescript",
                "visualbasic",
                "wikitext",
                "xml",
                "yaml"
            ]
        },
        "class": {
            "label": "Class attribute",
            "type": "string"
        },
        "style": {
            "label": "CSS style attribute",
            "type": "string"
        }
    }
}
</templatedata>}}

== See also ==
* {{tl|mono}}, monospaced font only
* [[Help:Wikitext]]
* Language-specific wrapper templates:
** {{tl|JavaScript code}}, defaults to 'javascript'
** {{tl|Wikitext code}}, defaults to 'wikitext' (for templates)

{{Semantic markup templates|show}}

<includeonly>{{Sandbox other||
<!-- Categories below this line; interwikis at Wikidata -->
[[Category:Programming typing-aid templates]]
[[Category:Semantic markup templates]]
[[Category:Wikipedia HTML tag-replacing templates]]

}}</includeonly>