Sjabloon:Kode/doc
Hierdie is 'n {{dokumentasie}}-bladsy vir Sjabloon:Kode. Dit bevat gebruiksinligting, kategorieë en ander inhoud wat nie deel is van die oorspronklike sjabloonbladsy nie. |
Omsluit 'n kort gedeelte van teks in <syntaxhighlight>
-etikette (sien mw:Extension:SyntaxHighlight). Die sjabloon moet gebruik word vir kort voorbeelde; vir langer teks moet <pre>...</pre>
of <syntaxhighlight>...</syntaxhighlight>
gebruik word. Sien Hulp:Wiki markup vir 'n verduideliking van wat die onderskeie etikette doen.
Indien die inhoud 'n isgelykaanteken (=) bevat, moet die parameter eksplisiet as volg gedefinieer word: {{kode|1=date=30 Feb 2010}}
.
Die sjabloon gebruik die <syntaxhighlight>
-etiket met die eienskap inline=1
. Dit werk net soos die kombinasie van die <code>
en <nowiki>
etikette wat toegepas word op die uitgebreide wikitext. Byvoorbeeld, {{kode|bietjie '''wiki''' teks}}
sal nie die woord "wiki" in vetgedruk weergee nie maar eerder die drie enkelaanhalingstekens:
bietjie '''wiki''' teks
{{kode|'n {{sjabloon}}-oproep}}
sal egter steeds die sjabloon oproep:
'n [[:Sjabloon:Sjabloon]]-oproep
Gebruik <nowiki>...</nowiki>
weerskante van die sjabloonnaam om die probleem te voorkom:
a {{sjabloon}}-oproep
Indien inlyn gebruik word met gewone teks, sal {{kode}}
oor die algemeen beter vertoon en is ook die maklikste om te lees wanneer dit eksplisiet apart van die gewone teks gespasieer word:
foo {{kode|bar baz}} quux.
is goed gespasieer:
- foo
bar baz
quux.
teenoor:
foo {{kode|bar baz}} quux.
wat visueel verwarrend vir baie kan wees:
- foo
bar baz
quux.
aangesien "foo" en "bar
" nouer geassosieer sal blyk te wees as "bar
" en "baz
"; die wydte van die spasiekarakter in 'n mono-gespasieerde font is byna telkens groter as in 'n proporsionele font.
Gebruik parameter {{{2}}} (naamloos, as |2=
, of meer eksplisiet as |taal=
) om die taal vir mw:Extension:SyntaxHighlight GeSHi te spesifiseer. Hierdie opsie is by verstek plain-text, bv. geen uitligging nie. Daar bestaan nie 'n uitliggingsopsie vir wikitext as markeertaal nie, hoewel html4strict
en html5
geldige waardes is, net soos php
, perl
, css
, javascript
, mysql
en nog vele ander. Pogings om ongeldige waardes te gebruik veroorsaak 'n lys van geldiges wat vertoon sal word in plek van die sjabloonuitset wanneer die bladsy voorbesigtig of gestoor word.
Hierdie sjabloon hoef nie gesubstitueer te word nie.
Voorbeelde
wysigMarkeerteks | Weergegee as |
---|---|
Lorem {{kode|ipsum '''dolor'''}} sit amet |
Lorem |
Die verklaring {{kode |taal=cpp |int foo(const std::string& bar, const std::vector<long double*>& baz);}} is die prototipe vir 'n funksie wat later gedefinieer sal word. |
Die verklaring |
Indien die kode 'n [[isgelykaanteken]] bevat, soos {{kode |taal=javascript |kode=var img = document.getElementsByTagName("img");}}, moet die eerste parameter eksplisiet as {{{1}}} of {{{kode}}} verklaar word; sien ook [[:bugzilla:5138]]. |
Indien die kode 'n isgelykaanteken bevat, soos |
Ingeslote sjablone
wysigIngeslote sjablone werk nie soos verwag word binne {{kode}} nie; by langer vryvormkodeblokke, wat sjablone kan insluit soos {{var}} en {{samp}}, gebruik <code>...</code>
as 'n omslag in stede van hierdie sjabloon.
Sjablone wat binne {{kode}} gebruik word ontbloot die gelewerde HTML— dit kan handig te pas kom, byvoorbeeld:
Markeerteks | Weergegee as |
---|---|
{{kode| {{cite web |title=Title |url=http://example.org}} }} |
|
Die bostaande voorbeeld vertoon die HTML weergegee deur die aanhalingsjabloon, insluitend die metadata.
Sien ook
wysig