Template:Code/doc: Difference between revisions

Jump to navigation Jump to search

Template:Code/doc (view source)

Revision as of 01:52, 23 February 2025

5,206 bytes added ,  23 February
→‎See also: already covered by the navbox
VisualWikitext
m (Text replacement - "Powerpedia" to "Saintapedia")
(→‎See also: already covered by the navbox)
Line 1: Line 1:
{{Documentation subpage}}
{{Documentation subpage}}
{{tc}}
<!-- Add categories where indicated at the bottom of this page and interwikis at Wikidata -->
The intent of this template is that {{Code|{{tlx|Code|<wikicode>}}}} results in the same thing as the rather less elegant {{code|<nowiki>&lt;code>&lt;nowiki><wikicode>&lt;/nowiki>&lt;/code></nowiki>}}.
{{#ifeq: {{PAGENAME}}|{{ROOTPAGENAME}}|{{High-risk}}}}
{{Expensive}}


However, the wikipedia version of this template ({{W|Template:Code}}) relies on an extension that is not currently installed on Saintapedia, and so it doesn't work when directly ported over. A substitute without using that extension requires that the wikicode be entered inside {{Tag|nowiki}} tags if you do not want the wikicode to be interpreted. So the end result is {{Code|{{tlx|Code|<nowiki>&lt;nowiki><wikicode>&lt;/nowiki></nowiki>}}}} (resulting in {{Code|<nowiki><wikicode></nowiki>}}), which is less elegant that the intended use of the template, but perhaps not quite as bad as the no-template alternative.
==Usage==
Wraps a short span of text in <code><nowiki><syntaxhighlight></nowiki></code> tags (see [[mw:Extension:SyntaxHighlight]]). 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.
 
If the content includes an equals sign (=), you must specify the parameter explicitly: {{tji|code|2=1:int i = 0;}}.
 
The template uses the {{tag|syntaxhighlight|o}} tag with the attribute <code>inline=1</code>. This works like the combination of the {{tag|code|o}} and {{tag|nowiki|o}} tags,  applied to the expanded wikitext. For example, {{tji|code|<nowiki>some '''wiki''' text</nowiki>}} will '''''not''''' render the word "wiki" in bold, and will render the tripled-single-quotes:


==Usage==
:{{code|some '''wiki''' text}}
 
If the above example is declared as wikitext (via {{tji|code|<nowiki>some '''wiki''' text</nowiki>|lang:wikitext}}, the output is rendered as follows:
 
:{{code|some '''wiki''' text|lang=wikitext}}
 
However, {{tji|code|<nowiki>a {{template}} call</nowiki>|lang:wikitext}} will still invoke the template:
 
:{{code|a {{template}} call|lang=wikitext}}
 
Use {{tag|nowiki}} around the template name to avoid this problem:
 
:{{code|a <nowiki>{{template}}</nowiki> call|lang=wikitext}}
 
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 &nbsp;<nowiki>{{code|bar baz}}</nowiki>&nbsp; quux.|lang=wikitext}}
is well spaced:
:foo &nbsp;{{code|bar baz}}&nbsp; quux.
versus:
:{{code|foo <nowiki>{{code|bar baz}}</nowiki> quux.|wikitext}}
which is less visually clear:
: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]]. This option defaults to {{para|lang|text}}, i.e. no highlighting. Valid values include {{para|lang|wikitext}} for wikitext, {{para|lang|html}} for HTML, along with many other languages including {{code|php}}, {{code|perl}}, {{code|css}}, {{code|javascript}}, {{code|mysql}}. Attempting to use an invalid value for lang will cause the page to be added to [[:Category:Pages with syntax highlighting errors]], and no syntax highlighting will be present in the output. {{code|html4strict}} and {{code|html5}} used to be valid values - however, {{para|lang|html}} should be used instead.
 
This template does not need to be [[Wikipedia:Template substitution|substituted]].
 
===Examples===
 
{{markup
|<nowiki>Lorem {{code|ipsum '''dolor'''}} sit amet</nowiki>
|Lorem {{code|ipsum '''dolor'''}} sit amet
 
|<nowiki>Lorem {{code|ipsum '''dolor'''|wikitext}} sit amet</nowiki>
|Lorem {{code|ipsum '''dolor'''|wikitext}} 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}}}; see also [[:bugzilla:5138]].</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}}}; see also [[:bugzilla:5138]].
}}
 
===Included templates===
Embedded templates do not function as expected inside {{tl|code}}; for longer, free-form blocks of code, which can contain templates such as {{tl|var}} and {{tl|samp}}, use {{tag|code}} as a wrapper instead of this template.
 
Templates used inside {{tl|code}} expose the rendered HTML— this can be useful. For example:
<div style="overflow:auto;">
{{markup
|1=<nowiki>{{code|
{{cite web |title=Title |url=http://example.org}}
|lang=html
}}</nowiki>
|2={{code|
{{cite web |title=Title |url=http://example.org}}
|lang=html
}}
}}
</div>
The above example shows the HTML rendered by the citation template, including the hidden metadata.
 
== Expensive Parser Function warning ==
This template internally uses [[mw:Extension:SyntaxHighlight]], which is considered an 'expensive parser function' (see [[WP:EXPENSIVE]]). If used on a page which uses more than 500 expensive parser functions, the output of subsequent uses of this template will be presented using {{tag|code}} formatting (without any syntax highlighting) instead.
 
== TemplateData ==
{{Format TemplateData|<templatedata>
{
"description": "An inline source code string.",
"format": "inline",
"params": {
"1": {
"label": "Code",
"aliases": ["code"],
"description": "The code to display.",
"required": true,
"type": "string"
},
"2": {
"label": "Language",
"aliases": ["lang"],
"description": "The programming language of the source code. List of valid values is at: [[mw:Extension:SyntaxHighlight#Supported_languages]]",
"default": "text",
"suggested": true,
"type": "string"
},
"class": {
"label": "Class",
"type": "string"
},
"style": {
"label": "CSS Style",
"type": "string"
}
}
}
</templatedata>}}
 
== See also ==
* {{tl|mono}}, monospaced font only
* [[Help:Wiki markup]]
* Language-specific wrapper templates:
** {{tl|jscode}}, defaults to 'javascript'
** {{tl|luacode}}, defaults to 'lua' (for modules)
** {{tl|tlcode}}, defaults to 'wikitext' (for templates)
 
{{Semantic markup templates|show}}
 
<includeonly>{{Sandbox other||
<!-- Categories below this line; interwikis at Wikidata -->
[[Category:Programming typing-aid templates]]
[[Category:Semantic markup templates]]
[[Category:Wikipedia XHTML tag-replacing templates]]


{| border=1
}}</includeonly>
! Markup !! Result
|- valign=top
|{{Code|{{tlx|Code|<nowiki>&lt;nowiki>'''Bold'''&lt;/nowiki></nowiki>}}}}
|{{Code|<nowiki>'''Bold'''</nowiki>}}
|- valign=top
|{{Code|{{tlx|Code|<nowiki>'''Bold'''</nowiki>}}}}
|{{Code|'''Bold'''}}
|}
Anonymous user
Retrieved from "https://saintapedia.org/wiki/Special:MobileDiff/9900"

Navigation menu