Template:Code/doc: Difference between revisions
m (+{{Uncategorized}}) |
(categorized to 'Semantic markup templates') |
||
| Line 1: | Line 1: | ||
{{Documentation subpage}} | {{Documentation subpage}} | ||
==Usage== | == Usage == | ||
Wraps a short span of text in <code><nowiki><syntaxhighlight></nowiki></code> tags (see [[mw:Extension:SyntaxHighlight GeSHi]]). This template should be used for short samples; longer content should use {{tag|pre}} or {{tag|syntaxhighlight}}. | Wraps a short span of text in <code><nowiki><syntaxhighlight></nowiki></code> tags (see [[mw:Extension:SyntaxHighlight GeSHi]]). This template should be used for short samples; longer content should use {{tag|pre}} or {{tag|syntaxhighlight}}. | ||
| Line 8: | Line 8: | ||
The template uses the <code><nowiki><syntaxhighlight></nowiki></code> tag with the attribute <code>enclose="none"</code>. This works like the combination of the <code><nowiki><code></nowiki></code> and <code><nowiki><nowiki></nowiki></code> 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: | The template uses the <code><nowiki><syntaxhighlight></nowiki></code> tag with the attribute <code>enclose="none"</code>. This works like the combination of the <code><nowiki><code></nowiki></code> and <code><nowiki><nowiki></nowiki></code> 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}} | : {{code|some '''wiki''' text}} | ||
However, <code><nowiki>{{code|a {{ | However, <code><nowiki>{{code|a {{test}} call}}</nowiki></code> will still invoke the template: | ||
:{{code|a {{ | : {{code|a {{test}} call}} | ||
Use {{tag|nowiki}} around the template name to avoid this problem: | Use {{tag|nowiki}} around the template name to avoid this problem: | ||
:{{code|a <nowiki>{{template}}</nowiki> call}} | : {{code|a <nowiki>{{template}}</nowiki> call}} | ||
When used inline with regular text, {{ | When used inline with regular text, {{tc|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.}} | : {{code|foo <nowiki>{{code|bar baz}}</nowiki> quux.}} | ||
is well spaced: | is well spaced: | ||
:foo {{code|bar baz}} quux. | : foo {{code|bar baz}} quux. | ||
versus: | versus: | ||
:{{code|foo <nowiki>{{code|bar baz}}</nowiki> quux.}} | : {{code|foo <nowiki>{{code|bar baz}}</nowiki> quux.}} | ||
which is going to be visually confusing for many: | which is going to be visually confusing for many: | ||
:foo {{code|bar baz}} quux. | : 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. | 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. | ||
| Line 32: | Line 32: | ||
This template does not need to be [[Wikipedia:Template substitution|substituted]]. | This template does not need to be [[Wikipedia:Template substitution|substituted]]. | ||
===Examples=== | === Examples === | ||
{{markup | {{markup | ||
| Line 45: | Line 45: | ||
}} | }} | ||
===Included templates=== | === Included templates === | ||
Embedded templates do not function as expected inside {{tl|code}}; for longer, free-form blocks of code, use {{tag|code}} as a wrapper instead of this template. | Embedded templates do not function as expected inside {{tl|code}}; for longer, free-form blocks of code, use {{tag|code}} as a wrapper instead of this template. | ||
| Line 51: | Line 51: | ||
<includeonly> | <includeonly> | ||
<!-- Categories go here --> | <!-- Categories go here --> | ||
[[Category:Semantic markup templates]] | |||
</includeonly> | </includeonly> | ||
Revision as of 20:37, 23 December 2015
|
This is a documentation subpage for Template:Code . |
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>.
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 {{test}} call}} will still invoke the template:
a [[Plugin:{{{1}}}/doc|{{{1}}}]] one ({{{1}}}) or two {{{2}}} Code+doc=Code/doc <hr/> pluginName: code 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
versus:
foo {{code|bar baz}} quux.
which is going to be visually confusing for many:
- foo
bar baz
because "foo" and "barbarbaz
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 html4stricthtml5phpperlcssjavascriptmysql
This template does not need to be substituted.
Examples
Included templates
Embedded templates do not function as expected inside {{code}}; for longer, free-form blocks of code, use <code>...</code> as a wrapper instead of this template.