Wikipedia:Sjabloon

'n Sjabloon of templaat is 'n manier om 'n bepaalde teks (met of sonder beelde) in een of meer artikels te vertoon deur slegs na die naam van die sjabloon te skakel. Dié skakel vereis dubbelkrulhakies {{...}} pleks van blokhakies [[...]] soos dit vir 'n skakel na 'n gewone bladsy gebruik word.

Alle sjablone verskyn in die "Sjabloon"-naamruimte. Sommige sjablone bevat opsionele parameters wat die voorkoms en inhoud daarvan verander soos verkies. Sien gerus hierdie lys van sjablone vir 'n paar voorbeelde van die verskillende soort sjablone.

Hoe skakel ek na 'n sjabloon?

Indien u 'n sjabloon, bv. Sjabloon:Lande van Asië, in 'n artikel wil plaas, kan u na die sjabloon skakel deur te tik {{Lande van Asië}}. Dit sal dan soos volg op u bladsy vertoon:

As voorbeeld van die gebruik van parameters, sien gerus Sjabloon:Landtabel vir gebruik in artikels oor Lande.

U kan ook die volledige sintaks/teks van 'n sjabloon in 'n artikel plaas deur subst: vooraan te gebruik. Die sjabloon, soos dit in die artikel verskyn, is dus plaaslik en word nie gewysig wanneer die oorspronklike sjabloon gewysig word nie.

Hoe skep ek 'n sjabloon?

Daar is baie maniere om 'n sjabloon te begin skep. Twee van die makliker maniere is die volgende:

Veronderstel u wil 'n sjabloon skep oor die riviere in Suid-Afrika. 'n Logiese naam vir so 'n sjabloon is "Riviere in Suid-Afrika" of miskien 'n korter, meer praktiese "RiviereSA".

Maak die sandput oop en tik die naam van die sjabloon, met twee krulhakies aan weerskante bv. {{RiviereSA}}. As u dan op "Wys voorskou" of "Stoor bladsy" kliek, sal dit vertoon as Sjabloon:RiviereSA. Deur op hierdie rooi skakel te kliek, sal u dan geneem word na 'n bladsy waar u die sjabloon, "RiviereSA" kan skep.
"Soek" (met die soekfunksie) na die (nie-bestaande) sjabloon. Sjablone begin altyd met die naam, "Sjabloon", so as u dus wil soek na 'n sjabloon met die naam "RiviereSA" moet u soek vir "Sjabloon:RiviereSA". Indien die sjabloon bestaan sal dit in die soekresultate vertoon. Indien nie, sal u 'n opsie kry wat lees "Vir navraag: Sjabloon:RiviereSA". As u op die rooi skakel kliek, sal u dan geneem word na 'n bladsy wat u 'n sjabloon met daardie naam kan begin.

Sjablone skryf

Om 'n goeie sjabloon te skryf vereis 'n bietjie vaardigheid en sjablone kan baie ingewikkeld wees. Indien u 'n bestaande sjabloon nie verstaan nie, moenie dit wysig nie. Dit kan die sjabloon breek en dit kan op baie bladsye (wat reeds die sjabloon gebruik) gevolge hê.

Dokumentasie en kategorisasie

Dit is ook nodig om u sjabloon te dokumenteer, byvoorbeeld deur tussen <noinclude>...</noinclude> te vertel wat die doel van die sjabloon is, watter parameters u definieer en wat hulle beteken. Ook 'n kategorie behoort toegevoeg te word.

Pas op: indien die kategorie nie tussen <noinclude>...</noinclude> geskryf is, sal al die wikibladsye wat na die sjabloon skakel ook in hierdie kategorie gesit word.

Gewoonlik is dit daarom nuttig twee kategorieë mee te gee. Een tussen <noinclude>...</noinclude> vir die sjabloon en een tussen <includeonly>...</includeonly> vir die bladsye wat dit oproep.

Parameters

Sjablone kan parameters hê. By verstek word hulle genommer. Byvoorbeeld, indien op 'n wikibladsy {{MySjabloon|olifant|jagluiperd}} geskryf word, behoort daar inwendig in die sjabloon MySjabloon twee parameters {{{1}}} en {{{2}}} te wees waaraan die waarde {{{1}}}=olifant en {{{2}}}=jagluiperd gegee word.

Merk op: Op die wikibladsy word 'n sjabloon met dubbele {{krulhakies}} opgeroep. In die sjabloon word parameters altyd met drievoudige {{{krulhakies}}} geskryf. Pas op: Indien u 'n krulhakie in die sjabloon vergeet, word daar dus 'n ander sjabloon opgeroep, pleks van 'n parameter gedefinieer... En ja, dit is moontlik om sjablone in sjablone op te roep, maar dit lei maklik tot 'n onbegryplike warboel wat 'n ander gebruiker moontlik nie sal verstaan nie.

Dit is ook moontlik om vir die parameters 'n naam te gee. Byvoorbeeld {{MySjabloon|dier1=olifant|dier2=jagluiperd}} neem aan dat in die sjabloon twee parameters {{{dier1}}} en {{{dier2}}} gebruik word. In hierdie geval maak die volgorde waarin die parameters op die wikibladsy opgegee word nie saak nie. {{MySjabloon|dier2=jagluiperd|dier1=olifant}} sal dieselfde resultaat oplewer.

Dit is ook handig om in die sjabloon 'n verstekwaarde vir die parameters te definieer. Byvoorbeeld {{{dier1|olifant}}} beteken dat die waarde van parameter dier1 gelyk is aan "olifant" tensy aan dié parameter op die wikibladsy daaraan 'n ander waarde gegee word. Dit is dikwels handig om 'n nulverstekwaarde te definieer en {{{dier1|}}} te skryf.

Ook hier geld dat 'n parameter in 'n parameter as verstek kan word ingevoeg, maar ook hier lei dit maklik tot 'n krulhakiessoep. Byvoorbeeld {{{dier2|{{{dier1|}}}}}} wil sê dat dier2 die waarde kry wat op die wikibladsy daaraan gegee word. Ontbreek dit, kry dier2 die waarde wat dier1 het. Ontbreek ook dit, dan kry dier2 die nulwaarde. (Maar moenie 'n krulhakie vergeet nie..)

Voorwaardelike funksies

In die sjabloon kan u van logiese funksies gebruik maak. Hulle word met dubbele {{hakies+#}} geskryf.

#if

Die #if- funksie bekyk of aan 'n bepaalde parameter 'n waarde gegee word. Byvoorbeeld:

{{#if: {{{dier1|}}}|ja, daar is 'n dier1|nee daar is geen dier1 nie}}

Indien op die wikibladsy aan dier1 geen waarde gegee word nie, sal die sjabloon daar "nee daar is geen dier1 nie" skryf.

#switch

Die #switch - funksie kan verskeie gevalle hanteer:

{{#switch: {{{dier1|}}}|olifant=dit het 'n slurp|tier=dit het strepe|#default=watter dier is dit?}}

Indien op die wikibladsy aan dier1 die waarde "tier" gegee word, sit die sjabloon daar "dit het strepe" neer. Indien ons daar dier1=maanlander skryf of vergeet om die parameter 'n waarde te gee, sal die sjabloon ons daar vra: "watter dier is dit?"

Tabelle

Sien gerus Hulp:Gebruik van tabelle vir tabelsintaks.

Dikwels is die doel van 'n sjabloon om 'n tabel wat op baie bladsye voorkom slegs een keer te hoef te definieer. Dit maak dit moontlik 'n uniforme tabel op al die bladsye neer te sit, byvoorbeeld vir chemiese stowwe het ons sjabloon:Chemiekas2. Die verskil teenoor 'n gewone tabel op 'n wikibladsy is dat inligting daar as sjabloonparameters ingevoer word.

Byvoorbeeld op die wikibladsy word die kookpunt as {{Chemiekas2|kookpunt=200 °C}} gegee. Die tabel self staan in die sjabloon Chemiekas2 met 'n parameter {{{kookpunt|}}} pleks van 'n vaste waarde 200 °C daarin. Byvoorbeeld:

{|class="wikitable"
|-
! Eienskap  !! Waarde
|-
| Kookpunt || {{{kookpunt|}}}
|}

Dikwels is dit wenslik om die vorm van die tabel nog meer buigbaar te definieer. Byvoorbeeld nie alle chemiese stowwe het 'n kookpunt nie. Dit is moontlik om 'n reël aan die tabel toe te voeg afhanklik van die vraag of 'n parameter 'n waarde het of nie, maar daar is 'n komplikasie. Die pypsimbool | word sowel in die CSS-tabelsintaks as in die #if/#switch-sintaks gebruik. Dié probleem kan verhoed word deur die :{{!}}-sjabloon te gebruik pleks van 'n |-simbool. Om 'n reël aan die tabel toe te voeg afhanklik van die waarde van kookpunt na 'n ander eienskap word die sintaks:

 |-
 |ander eienskap || {{{andereienskap|}}} {{#if:{{{kookpunt|}}}|&nbsp;
 {{!}}-
 {{!}} kookpunt {{!}}{{!}} {{{kookpunt|}}} |}}
 |-
 |ensomeer

Die |}} is nodig om die #if:-funksie af te sluit.

Die   is nodig om nie die tabel te versteur nie.

Sien ook

Wikipedia:Lys van sjablone