Ŝablono:Kodo/dokumentado

Tio estas helpdokumentado por la ŝablono {{Kodo}}.

Ĝi enhavas informojn pri la uzado de ŝablono, ĝiajn kategoriojn kaj eble eĉ interlingvajn ligilojn (Prefere ili estus aranĝataj per VP:VD). Kaj ĝi ne estas enhavo de la ŝablona paĝo mem.

Ĉi tiu ŝablono formatas donitan tekston per helpo de <syntaxhighlight>...</syntaxhighlight> de la etendilo mw:Extension:SyntaxHighlight GeSHi). Ĉi tiu ŝablono estu uzata por mallongaj specimenoj; pli longa enhavo uzu <pre>...</pre> aŭ <syntaxhighlight>...</syntaxhighlight>.

Ĉi tiu artikolo estas redaktata de Tlustulimu.

Por eviti la riskon de redaktokonflikto, ne redaktu la artikolon. Kontrolu la kronologion kaj forigu la ŝablonon, se necese.

Uzado

{{kodo|}}

Se la teksto enhavas egalsignon, vi devas difini la parametron eksplicite {{kodo|1=dato=30-a de Februaro 2010}}.

La ŝablono uzas la <syntaxhighlight> etikedon kun la atributo enclose="none". Tio laboras kiel la kombino de la <code> kaj <nowiki> etikedoj, aplikata al la ekspandita vikiteksto. Ekzemple, {{kodo|iu '''vikia''' teksto}} ne redonos la vorton "vikio" grase, kaj redonos la trioblajn unuopajn citilojn:

iu '''vikia''' teksto

Tamen, {{kodo|jen elvoko de {{ŝablono}}}} ankoraŭ elvokos la ŝablonon:

jen elvoko de {{[[Ŝablono:{{{1}}}|{{{1}}}]]}}

Por eviti tion, uzu <nowiki>...</nowiki> ĉirkaŭ la ŝablona nomo:

jen elvoko de {{ŝablono}}

Parametroj

…

Ekzemploj

Kodo	Rezulto
Lorem {{kodo\|ipsum '''dolor'''}} sit amet	Lorem `ipsum '''dolor'''` sit amet
La deklaro {{kodo \|lingvo=cpp \|int foo(const std::string& bar, const std::vector<long double*>& baz);}} estas la prototipo por funkcio difinita poste.	La deklaro `int foo(const std::string& bar, const std::vector<long double*>& baz);` estas la prototipo por funkcio difinita poste.
Se la kodo enhavas [[egalsigno]]n, kiel {{kodo \|lingvo=javascript \|kodo=var img = document.getElementsByTagName("img");}}, vi devas identigi la unuan parametron eksplicite kiel {{{1}}} aŭ {{{kodo}}}; vidu ankaŭ [[:bugzilla:5138]].	Se la kodo enhavas egalsignon, kel `var img = document.getElementsByTagName("img");`, vi devas identigi la unuan parametron eksplicite kiel {{{1}}} aŭ {{{kodo}}}; vidu ankaŭ bugzilla:5138.

Inkludataj ŝablonoj

Nestita ŝablono ne funkcias kiel atendita ene de {{kodo}}; por pli longaj, liber-formaj blokoj de kodo, kiuj povas enhavi ŝablonojn kiel {{var}} kaj {{samp}}, uzu <kodo>...</kodo> kiel wrapper anstataŭ ĉi tiu ŝablono.

Ŝablonoj uzataj ene de {{kodo}} expose la redonitan HTML— tio povas esti utila. Ekzemple:

Kodo	Rezulto
{{kodo\| {{citaĵo el la reto \|titolo=Titolo \|url=http://example.org}} }}	` [http://example.org Titolo].`

La supra ekzemplo montras la HTML redonitan de la citŝablono, inkludante la kaŝitajn metadatumojn.