Wikipedia:Sjabloondokumentasie: Verskil tussen weergawes

* Die '''basiese doel''' van die sjabloon: wat dit doen en indien dit nie onmiddellik duidelik is nie, hoekom dit gedoen moet word. Indien daar ander sjablone bestaan met soortgelyke name of doeleindes, sal dit 'n goeie idee wees om hulle te lys en sodoende die kans te verminder dat die verkeerde sjabloon gebruik word. Sluit belangrike '''beperkings''' in, soos die gebrek aan {{tl|Navbox visibility}}Navigasiekas-sigbaarheid op die Mobiele webwerf, as 'n sjabloon slegs gebruik moet word vir sekere lande of tydstippe of ander dinge wat redigeerders kennis van moet neem alvorens hulle besluit om die sjabloon te gebruik.

* Die sjabloon se '''[[HelpHulp:TemplateSjabloon#Parameters|parameters]]''' : of hulle genommer is, name het of opsioneel is, en indien wel, wat die verstekwaardes is en watter uitwerking dit het. Indien 'n parameter slegs 'n beperkte stel waardes aanvaar of op enige manier beperk is, byvoorbeeld, indien dit net "ja", "nee", of 'n getal aanvaar, moet dit duidelik genoem word.

* '''Voorbeelde van gebruik''' : spesifiseer die presiese wikitext wat gebruik behoort te word asook die resultate wat dit sal lewer. Die wikitext kan omsluit wees in {{tag|code}} etikette om dit duideliker te maak en <code>makliker om te kopieer</code>. Indien die sjabloon byvoorbeeld op heelwat verskillende maniere gebruik kan word, met of sonder opsionele parameters, verskaf 'n reeks voorbeelde. 'n Goeie metode hiervoor is om die sjabloon self 'n paar keer in die dokumentasie te gebruik (transklusie), met verskillende parameters in elke geval. Lys dan ook die parameters elke keer. Met [[TemplateSjabloon:Xpd]] kan dit gedoen word sonder om die sjabloon se roep twee keer in die wikitext te plaas.

* '''Sjabloondata''' : Sien [[Wikipedia:TemplateData/TutorialHandleiding]].

* '''Verwante sjablone''' : indien die sjabloon een van 'n reeks sjablone is, sluit skakels tot die reeks in&nbsp;– verseker ook dat elke sjabloon in die reeks skakels van mekaar insluit om navigasie te vergemaklik. ('n Aparte navigasiesjabloon kan handig te pas kom in so 'n geval, sien: [[TemplateSjabloon:Protection templatesBeskermingsjablone]]).

* '''[[Wikipedia:CategorizationKategorisering|Kategorieë]]''' waar van toepassing ([[HelpHulp:Interwikimedia links-skakels|InterWikimedia-skakels]] moet gelys word by [[d:|Wikidata]] – meer inligting verkrygbaar by [[Wikipedia:Wikidata]]). Soos met die dokumentasie, moet kategorieë gelys word binne {{tag|noinclude}}-etikette in 'n sjabloon, of binne {{tag|includeonly}}-etikette in 'n dokumentasiebladsy. Verskeie sjabloonkategorieë is beskikbaar, sien: [[:CategoryKategorie:Wikipedia templatesSjablone]] om deur hulle te snuffel.

Sjabloondokumentasie word meermale in 'n [[Wikipedia:SubpagesSubbladsye|subbladsy]] van die sjabloon self geplaas, wat dan [[Wikipedia:TransclusionTransklusie|oorgebringingetrek]] word aan die einde van die sjabloonbladsy. Dit skei die gewoonlik komplekse sjabloonkode van die dokumentasie en maak die dokumentasie sodoende makliker om te redigeer. Dit laat ook die sjablone toe om waar nodig, [[Wikipedia:Protection policyBeskermingsbeleid|beskerm]] te word, terwyl enige een die dokumentasie kan redigeer. Die metode word soms na verwys as die "sjabloon-doc-bladsypatroon".

Enige soort dokumentasie op 'n sjabloonbladsy (insluitend [[Wikipedia:TemplateData|Sjabloondata]]) moet altyd omsluit word deur {{tag|noinclude}}-etikette, sodat dit nie vertoon word as die sjabloon op 'n ander bladsy gebruik word nie. Teks op die sjabloonbladsy dra ook by tot die hoeveelheid teks wat verwerk moet word as die sjabloon vertoon word, en vir beter werkverrigting [[Wikipedia:Template limitsSjabloonperke|beperkingeperk]] behoort te word. Deur die dokumentasie op 'n subbladsy te plaas word die probleem vermy (MediaWiki-ontwikkelaars het dit juis vir die rede <span class="plainlinks">[http://en.wikipedia.org/w/index.php?title=Wikipedia:Village_pump_(technical)&amp;diff=prev&amp;oldid=69888944 aanbeveel]</span>).

Veronderstel jou sjabloon word <code>Sjabloon:X</code> genoem. Skep 'n subbladsy met die naam <code>Sjabloon:X/doc</code>. Sien die besonderhede by {{tlsj|DocumentationDokumentasie subpagesubblad}} of begin 'n nuwe bladsy deur die volgende standaard wikitext te kopieer en plak:

<!-- PleasePlaas placeasseblief categorieskategorieë, wherewaar indicatedaangedui, ataan thedie bottomonderkant ofvan thishierdie pageblad anden interwikisinterwiki's atby Wikidata (see [[Wikipedia:Wikidata]]) -->

<include<includeonly></includeonly>only>{{sandboxSandput otherander||

<!-- CategoriesKategorieë belowonder thishierdie line,reël pleaseasseblief; interwikisinterwiki's atby Wikidata -->