Teamplaid:Code/documentation
This is a documentation subpage for Teamplaid:Code. It contains usage information, categories and other content that is not part of the original teamplaid page. |
Ùsaid - Usage
deasaichWraps a short span of text in <syntaxhighlight>
tags (see mw:Extension:SyntaxHighlight). This template should be used for short samples; longer content should use <pre>...</pre>
or <syntaxhighlight>...</syntaxhighlight>
. See Help:Wikitext for an explanation of what the various tags do.[feumar soilleirachadh - 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 [[:Teamplaid: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
quux.bar baz
versus:
foo {{Code|bar baz}} quux.
which is going to be visually confusing for many:
- foo
quux.bar baz
because "foo" and "
" will seem more closely associated than "bar
" and "bar
"; the width of the space character in a monospaced font is almost always larger than in a proportional font.
baz
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
and html4strict
are valid values, as are html5
, php
, perl
, css
, javascript
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.
mysql
This template does not need to be substituted.
Eisimpleirean - Examples
deasaichMarkup | Renders as |
---|---|
Lorem {{Code|ipsum '''dolor'''}} sit amet |
Lorem 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 is the prototype for a function defined later. |
If the code contains an {{enUici|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 {{enUici|:bugzilla:5138}}. |
If the code contains an equals sign, such as , you must identify the first parameter explicitly as {{{1}}} or {{{Code}}}; see also :bugzilla:5138.
|
Included templates
deasaichEmbedded 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
|1={{Code|
{{Cite web |title=Title |url=http://example.org}}
}}
|2=<cite class="citation web">[http://example.org "Title"].</cite><span title="ctx_ver=Z39.88-2004&rft_val_fmt=info%3Aofi%2Ffmt%3Akev%3Amtx%3Abook&rft.genre=unknown&rft.btitle=Title&rft_id=http%3A%2F%2Fexample.org&rfr_id=info%3Asid%2Fgd.wiktionary.org%3ATeamplaid%3ACode%2Fdocumentation" class="Z3988"></span>'"`UNIQ--templatestyles-00000027-QINU`"'
The above example shows the HTML rendered by the citation template, including the hidden metadata.
See also
deasaich