Difference between revisions of "Template:Code/doc"
(Created page with "TO BE WRITTEN") |
m |
||
| (14 intermediate revisions by the same user not shown) | |||
| Line 1: | Line 1: | ||
| − | + | The template {{tlg|code}} wraps a short span of text in {{tag|syntaxhighlight|open}} tags (see [[mw:Extension:SyntaxHighlight|Extension SyntaxHighlight]]). | |
| + | |||
| + | == Usage == | ||
| + | |||
| + | It should be used for short samples; longer content should use {{tag|pre}} or {{tag|syntaxhighlight}}. See [[wikipedia:Help:Wiki markup|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: {{tlg|code=yes|nolink=yes|code|1{{=}}date{{=}}30 Feb 2010}}. | ||
| + | |||
| + | The template uses the {{tag|syntaxhighlight|open}} tag with the attribute {{code|inline{{=}}1}}. This works like the combination of the {{tag|code|open}} and {{tag|wiki|open}} tags, applied to the expanded wikitext. For example, {{nowrap|<code><nowiki>{{code|some '''wiki''' text}}</nowiki></code>}} will {{strong|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, {{tlg|code=yes|nolink=yes|code}} generally looks best and is easiest to read when it is explicitly spaced apart from the regular text: | ||
| + | : {{code|foo <nowiki>{{code|bar baz}}</nowiki> quux.}} | ||
| + | is well spaced: | ||
| + | :foo {{code|bar baz}} 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|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="width:100%;" | ||
| + | ! 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 {{tlg|code=yes|nolink=yes|code}}; for longer, free‐form blocks of code, which can contain templates such as {{tlg|code=yes|var}} and {{tlg|code=yes|samp}}, use {{tag|code}} as a wrapper instead of this template. | ||
| + | |||
| + | Templates used inside {{tlg|code=yes|nolink=yes|code}} expose the rendered HTML - this can be useful. | ||
| + | |||
| + | [[Category:Templates]][[Category:Semantic markup templates]][[Category:Templates documentation]] | ||
Latest revision as of 16:59, 21 July 2020
The template {{code}} wraps a short span of text in <syntaxhighlight> tags (see Extension SyntaxHighlight).
Usage
It 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.
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 inline=1. This works like the combination of the <code> and <wiki> 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:Code/doc|Template:Code/doc]]}} call
Use <nowiki>…</nowiki> around the template name to avoid this problem:
a '"`UNIQ--nowiki-00000005-QINU`"' 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 '"`UNIQ--nowiki-00000007-QINU`"' quux.
is well spaced:
- foo
bar bazquux.
versus:
foo '"`UNIQ--nowiki-0000000A-QINU`"' quux.
which is going to be visually confusing for many:
- foo
bar bazquux.
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 Extension:SyntaxHighlight. 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 |
|---|---|
| Lorem {{code|ipsum '''dolor'''}} sit amet | Lorem ipsum '''dolor''' 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 int foo(const std::string& bar, const std::vector<long double*>& baz); 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}}}. | If the code contains an equals sign, such as 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 {{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.