Fritigern: /* Usage */

2011-10-21T09:28:15Z

‎Usage

Fritigern: Created page with "{{Documentation subpage}} ==Usage== Wraps a short span of text in 2011-10-21T09:26:48Z Created page with "{{Documentation subpage}}  ==Usage== Wraps a short span of text in <code><nowiki><syntaxhighlight></nowi..." New page {{Documentation subpage}}  ==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}}. See [[Help:Wiki markup]] for an explanation of what the various tags do.{{clarify|reason=[[Help:Wiki markup]] does not mention any such "source" XML tag.}} If the content includes an equals sign (=), you must specify the parameter explicitly: <code><nowiki>{{code|1=date=30 Feb 2010}}</nowiki></code>. 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}} 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, {{tnull|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 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|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]]. Finally, embedded templates do not function inside {{tnull|code}}; for longer, free-form blocks of code, which can contain templates such as {{tlx|var}} and {{tlx|samp}}, use {{tag|code}} as a wrapper instead of this template. ===Examples=== {| class="wikitable" ! style="width:50%;" | input ! style="width:50%;" | output |- | <pre style="margin:0px; white-space:normal;">Lorem {{code|ipsum '''dolor'''}} sit amet</pre> | Lorem {{code|ipsum '''dolor'''}} sit amet |- | <pre style="margin:0px; white-space:normal;">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.</pre> | 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. |- | <pre style="margin:0px; white-space:normal;">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]].</pre> | 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]]. |} <includeonly> [[Category:Programming typing-aid templates|{{PAGENAME}}]]  </includeonly>

@@ Line 3: / Line 3: @@
 ==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}}. See [[Help:Wiki markup]] for an explanation of what the various tags do.{{clarify|reason=[[Help:Wiki markup]] does not mention any such "source" XML tag.}}
+Wraps a short span of text in <code><nowiki><syntaxhighlight></nowiki></code> tags (see [http://www.mediawiki.org/wiki/Extension:SyntaxHighlight_GeSHi SyntaxHighlight GeSHi]).  This template should be used for short samples; longer content should use {{tag|pre}} or {{tag|syntaxhighlight}}. See [[Help:Wiki markup]] for an explanation of what the various tags do.{{clarify|reason=[[Help:Wiki markup]] does not mention any such "source" XML tag.}}
 If the content includes an equals sign (=), you must specify the parameter explicitly: <code><nowiki>{{code|1=date=30 Feb 2010}}</nowiki></code>.