फलकम्:Code
{{{1}}}
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 <pre>...</pre>
or <syntaxhighlight>...</syntaxhighlight>
. See Help:Wiki markup for an explanation of what the various tags do.[clarification needed]
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:
some '''wiki''' text
However, {{code|a {{template}} call}}
will still invoke the template:
a [[:फलकम्:Template]] call
Use <nowiki>...</nowiki>
around the template name to avoid this problem:
a {{template}} call
When used inline with regular text, {{code}}
generally looks best and is easiest to read when it is explicitly spaced apart from the regular text:
foo {{code|bar baz}} quux.
is well spaced:
- foo
bar baz
quux.
versus:
foo {{code|bar baz}} quux.
which is going to be visually confusing for many:
- foo
bar baz
quux.
because "foo" and "bar
" will seem more closely associated than "bar
" and "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 |2=
, or more explicitly as |lang=
) to specify a language for mw: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 html4strict
and html5
are valid values, as are php
, perl
, css
, javascript
, 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 substituted.
Examples
[सम्पादयतु]Markup | Renders asस्क्रिप्ट त्रुटि: "For loop" ऐसा कोई मॉड्यूल नहीं है। |
---|---|
Included templates
[सम्पादयतु]Embedded templates do not function as expected inside {{code}}; for longer, free-form blocks of code, which can contain templates such as {{var}} and {{samp}}, use <code>...</code>
as a wrapper instead of this template.
Templates used inside {{code}} expose the rendered HTML— this can be useful. For example:
Markup | Renders asस्क्रिप्ट त्रुटि: "For loop" ऐसा कोई मॉड्यूल नहीं है। |
---|---|
The above example shows the HTML rendered by the citation template, including the hidden metadata.
See also
[सम्पादयतु]- {{strong}} – for semantically indicating strong emphasis instead of simple typographical boldfacing
- {{strongbad}} – same as
{{strong}}
but red like this: Never use{{strongbad}}
in articles. - {{stronggood}} – same as
{{strongbad}}
but green like this: Only use{{stronggood}}
on non-article pages. - {{em}} – similar template for semantically indicating mild emphasis instead of simple typographical italicization
- {{var}} – same as {{varserif}} use for all variables other than I (upper-case i) and l (lower-case L), for which use {{varserif}}
- {{varserif}} – same as {{var}} but uses serif font, especially for distinguishing between I (upper-case i) and l (lower-case L) as variables
- {{wikivar}} – for displaying wikicode variables and magicwords as they would appear in source code, e.g.
{{PAGENAME}}
,{{DEFAULTSORT:Lastname, Firstname}}
- {{para}} – for displaying wiki template parameters (
|title=
) or parameters and values (|year=2008
) - {{tlx}} and related – for displaying entire templates (with or without parameters and values) as code
- {{tag}} – for using HTML elements ("tags") in prose, e.g. source code examples
- {{nowiki}} – for preventing the parsing of wiki markup and HTML in the content, e.g. in source code examples
- {{code}} – for computer source code (
{{var}}
and other templates cannot be used inside it; in that case use<code>...</code>
as the wrapper, not{{code}}
) - {{syntaxhighlight}} or {{sxhl}} – wrapper for
<syntaxhighlight>...</syntaxhighlight>
, but will wrap overflowing text - {{deprecated code}} or {{dc}} – for deprecated source code in template documentation, articles on HTML specs, etc.
- {{pre}} – for larger blocks of source code and other pre-formatted text
- {{bq}} – for indented blocks of content, such as block quotations, examples, poems, etc.
- {{kbd}} – for indicating user input
- {{key press}} – for indicating the input of specific keystrokes, e.g. स्क्रिप्ट त्रुटि: "key" ऐसा कोई मॉड्यूल नहीं है।स्क्रिप्ट त्रुटि: "key" ऐसा कोई मॉड्यूल नहीं है।
- {{PlayStation key press}} – for indicating PS-style gamepad key presses, e.g. ✕
- {{samp}} – for example output
- Help:Wiki markup