တမ်းပလိတ်:Code/doc
ဤစာမျက်နှာမှာ တမ်းပလိတ်:Code တမ်းပလိတ်အတွက် အသုံးပြုပုံ လက်စွဲ (documentation) ၏ စာမျက်နှာခွဲ (subpage) တစ်ခုဖြစ်သည်။ ဤစာမျက်နှာတွင် မူရင်း တမ်းပလိတ် page ၌ တစိတ်တပိုင်းအဖြစ် မပါဝင်သည့် အသုံးပြုပုံပြုနည်းနှင့် သက်ဆိုင်သည့် သတင်းအချက်များ၊ ကဏ္ဍများ နှင့် အခြားအချက်အလက်များ ပါဝင်သည်။ |
ဤတမ်းပလိတ်ကို အင်္ဂလိပ် ဝီကီပီးဒီးယား ရှိ Template:Code/doc အား တစ်စိတ်တစ်ပိုင်းဖြစ်စေ၊ အလုံးစုံဖြစ်စေ မှီငြမ်း၍ မြန်မာဘာသာသို့ ပြန်ဆိုရန် လိုအပ်နေသေးသည်။
|
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>
. 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 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 {{[[Template:{{{1}}}|{{{1}}}]]}} 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.
Examples
[ပြင်ဆင်ရန်]Markup | 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 [[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]]. |
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
[ပြင်ဆင်ရန်]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. For example:
Markup | Renders as |
---|---|
{{code| {{cite web |title=Title |url=http://example.org}} }} |
|
The above example shows the HTML rendered by the citation template, including the hidden metadata.
See also
[ပြင်ဆင်ရန်]
တမ်းပလိတ်:Semantic markup templates