Wikipedia:Sjabloondokumentasie: Verskil tussen weergawes
Content deleted Content added
Wawiel (besprekings | bydraes) k bywerking |
Wawiel (besprekings | bydraes) k redigering |
||
Lyn 1:
{{Wikipedia-gebruiksgids|WP:SDOK}}
[[Hulp:Sjabloon|Sjablone]] is 'n kragtige kenmerk van [[MediaWiki]], maar dit kan verwarrend wees vir nuwe
Sjabloondokumentasie moet verduidelik wat die sjabloon doen en hoe om dit te gebruik. Dit moet eenvoudig genoeg wees sodat 'n
== Wat om in te sluit ==
Sjabloondokumentasie behoort die volgende in te sluit:
* Die '''basiese doel'''
* Die sjabloon se '''[[Hulp:Sjabloon#Parameters|parameters]]'''
* '''Voorbeelde
* '''Sjabloondata'''
* '''Verwante sjablone'''
* '''[[Wikipedia:Kategorisering|Kategorieë]]'''
Die Engelse Wikipedia is 'n bron van sjablone vir honderde ander Wikipedia's en susterprojekte. Baie maal is sjablone ten volle selfstandig, so die proses is eenvoudig: die inhoud word net so oor gekopieer na die nuwe
== Waar om dit te plaas ==
Sjabloondokumentasie word meermale in 'n [[Wikipedia:
Enige soort dokumentasie op 'n
== Hoe om 'n
Veronderstel jou sjabloon word <code>Sjabloon:X</code> genoem. Skep 'n
<!---------------------------------------------------------------------------------------
Neem kennis: Die onderstaande kodeblok is gepoieer en geplak vanaf [[Sjabloon:Dokumentasie/vooraflaai]];
Lyn 88:
</source>
Die boonste reël sal 'n boodskap vertoon wat die huidige bladsy omskryf en 'n skakel na die
Plaas die dokumentasie na die boonste reël en kategorieë onder die gepaste kommentaarreël – los die kommentaar in plek, sodat die uitleg behoue bly indien die bladsy in die toekoms geredigeer word. Verwante sjablone,
Stoor die
{{Kleur|black|[--laaste reël van jou sjabloonkode--]}}<nowiki><noinclude>
{{Dokumentasie}}
<!--Plaas asseblief hierdie sjabloon se kategorieë by die /doc-
</noinclude></nowiki>
Dit sal aan die onderkant van die
'''Belangrik'''
Indien die sjabloon reeds beskerm word, vra 'n [[Wikipedia:Administrators|administrateur]] om dit te doen of vra 'n redigering aan op die sjabloon se besprekingsblad. As dokumentasie en kategorieë reeds in 'n afdeling bestaan, omsluit in {{tag|noinclude}}-etikette, skuif hulle na die
Indien kode eers op die
Jy kan kies om die besprekingsblad van die /doc-
== Blanko ==
Lyn 122:
== Kategorieë en interwiki-skakels ==
* '''Om die sjabloon self in 'n kategorie te plaas'''
* '''Om 'n interwiki-skakel vir die sjabloon self te skep'''
* '''Om die ''doc''
* '''Om die sjabloon 'n artikel in 'n kategorie te laat plaas'''
<!-- -->
== /sandput en /toetsgevalle ==
Alvorens veranderinge aan 'n sjabloon aangebring word, sal dit voordelig wees om eers die sjabloonkode na 'n sandput te kopieer en 'n paar toetsgevalle teen dit te laat loop, aangesien die sjabloon moontlike op duisende ander blaaie gebruik word. Indien jy
== Verskeie sjablone, een
Wanneer verskeie sjablone saam werk of baie eenders is, is dit soms duideliker en eenvoudiger om een
== {{Anker|Indien geen dokumentasie nodig is nie}} Indien geen dokumentasie nodig is nie ==
<!--
Wanneer 'n sjabloon soos hier vertoon, met 'n bladsy sal skakel wat as dokumentasie kan dien, is aparte dokumentasie oorbodig en hoef nie geskep te word nie. Sien byvoorbeeld 'n saadjiesjabloon wat, indien vertoon word, sal koppel aan [[Wikipedia:Saadjie]]. Dit is egter 'n skaars geval.
Line 145 ⟶ 142:
* Skakels na sjablone soos {{sjp|Taalaanduiding|fr|Frans}} kan ingevoeg word deur {{sjp|sjp|Taalaanduiding|fr|Frans}} te skryf. Sien {{sj|sjp}} vir soortgelyke sjablone.
* HTML-etikette soos {{tag|ref|params=group{{=}}"note"}} kan maklik ingevoeg word met {{sj|tag}}. Hierdie voorbeeld is geskryf as {{sjp|tag|ref|params{{=}}group{{=}}"note"}}
* Isgelykaantekens '''='''
* Moenie die enkele {{tag|nowiki|s}}-etiket vergeet nie. [[<nowiki />{{tag|nowiki|s}}voorbeeld]] word [[<nowiki />voorbeeld]], en [<nowiki></nowiki>{{tag|nowiki|s}}http://af.wikipedia.org geen skakel] is [<nowiki></nowiki>http://af.wikipedia.org geen skakel]. Sien [[WP:NOWIKI]] vir die besonderhede.
* Vir 'n skakel na 'n kategorie, gebruik {{sj|kat}}. Byvoorbeeld, {{sjp|kat|Sjablone}} word {{kat|Sjablone}}.
* Om kategorisering van die /sandput- en /toetsgevalle-
<source lang="xml+smarty" style="overflow:auto;">
<includeonly>{{Sandput ander||
Line 157 ⟶ 154:
== Sien ook ==
* {{sj|Dokumentasie}} – Bring die dokumentasie oor na die
* {{sj|Dokumentasie subblad}} – Verduidelik dat wat volg is dokumentasie, en skakel ook met die
* [[m:Help:Template#Noinclude, includeonly, and onlyinclude|{{tag|noinclude|o}} en {{tag|includeonly|o}}]]
* {{sj|Verbeter dokumentasie}}
|