साँचा:Code/doc
{{
साँचा:namespace detect
| type = notice
| image = 
| imageright =
| class =
| style = margin-bottom:1.0em;
| textstyle =
| text = साँचा:strong for साँचा:terminate sentence
It contains usage information, categories and other content that is not part of the original साँचा page.
| small =
| smallimage =
| smallimageright =
| smalltext =
| subst =
| date =
| name =
}}
Usage
Wraps a short span of text in <syntaxhighlight> tags (see mw:Extension:SyntaxHighlight GeSHi). This template should be used for short samples; longer content should use साँचा:tag or साँचा:tag. See Help:Wiki markup for an explanation of what the various tags do.साँचा:clarify
If the content includes an equals sign (=), you must specify the parameter explicitly: {{code|1=date=30 Feb 2010}}.
The template uses the <syntaxhighlight> tag with the attribute enclose="none". This works like the combination of the <code> and <nowiki> tags, applied to the expanded wikitext. For example, {{code|some '''wiki''' text}} will not render the word "wiki" in bold, and will render the tripled-single-quotes:
However, {{code|a {{template}} call}} will still invoke the template:
Use साँचा:tag around the template name to avoid this problem:
When used inline with regular text, साँचा:tnull generally looks best and is easiest to read when it is explicitly spaced apart from the regular text:
is well spaced:
- foo साँचा:code quux.
versus:
which is going to be visually confusing for many:
- foo साँचा:code quux.
because "foo" and "साँचा:code" will seem more closely associated than "साँचा:code" and "साँचा:code"; 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, or more explicitly as साँचा:para) to specify a language for Extension:SyntaxHighlight GeSHi. This option defaults to plain-text, i.e. no highlighting. There is no highlighting option for wikitext as a markup language, though साँचा:code and साँचा:code are valid values, as are साँचा:code, साँचा:code, साँचा:code, साँचा:code, साँचा:code 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 substituted.
Examples
| input | output |
|---|---|
Lorem {{code|ipsum '''dolor'''}} sit amet
|
Lorem साँचा:code sit amet |
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.
|
The declaration साँचा:code is the prototype for a function defined later. |
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]].
|
If the code contains an equals sign, such as साँचा:code, you must identify the first parameter explicitly as {{{1}}} or {{{code}}}; see also bugzilla:5138. |
See also
- साँचा:tl - for preventing the parsing of wiki markup and HTML in the content, e.g. in source code examples
- साँचा:tl - for larger blocks of source code and other pre-formatted text
- साँचा:tl - for using HTML elements ("tags") in prose, e.g. source code examples
- साँचा:tl - for computer and mathematics variables
- साँचा:tl - same as साँचा:tnull but differentiates better between "I" (upper-case "i") and "l" (lower-case "L")
- साँचा:tl - for indicating user input
- साँचा:tl - for example output
- साँचा:tl - for indicating the input of specific keystrokes, e.g. साँचा:key press
- Help:Wiki markup