Vikipedija:Šablono dokumentacija

Puslapis iš Vikipedijos, laisvosios enciklopedijos.
Peršokti į: navigacija, paiešką

Šablonai yra labai galinga MediaWiki funkcija, tačiau gali būti neaiški ir naujiems naudotojams, ir patyrusiems, jeigu jie naudoja sudėtingesnius šablonus. Dėl to šablonai turėtų būti pateikiami kartu su dokumentacija, kad būtų aiškiau, kaip juos reikia naudoti.

Šablono dokumentacija turėtų paaiškinti, ką šablonas daro ir kaip jį reikia naudoti. Ji turėtų būti paprasta, kad naudotojas be jokių šablono sintaksės žinių galėtų jį naudoti teisingai, ypač to reikia, jeigu šablonas yra plačiai naudojamas.

Kas turėtų būti dokumentacijoje[redaguoti vikitekstą]

  • Šablono tikslas: ką jis daro (jeigu tai ne akivaizdu).
  • Šablono parametrai: ar jie numeruojami, pavadinami ar nebūtini, jeigu taip, kokie būtų pagal nutylėjimą ir kokį tada jie turėtų efektą.
  • Šablono naudojimo pavyzdžiai: reikia nurodyti tikslų šablono vikitekstą, kuris turėtų būti naudojamas.

Vikitekstas bus parodytas dokumentacijoje jį apgaubus <code>...</code> žyme. Tokiu atveju jį bus galima labai lengvai kopijuoti tiesiai iš pačio šablono puslapio.

  • Susiję šablonai: jeigu šablonas yra šablonų grupės narys, reikėtų įtraukti nuorodas į juos.
  • Kategorijos: kaip ir dokumentacija, kategorijos šablone turi būti apgaubtos po <noinclude>...</noinclude> žyme arba po <includeonly>...</includeonly> žyme, jeigu yra pateikiamos dokumentacijos puslapyje. Šablonų kategorijas galite rasti Kategorija:Šablonai puslapyje.

Šablono dokumentacija dažnai yra įdedama į šablono subpuslapį, kuris tada yra įtraukiamas šablono puslapio pabaigoje. Tai dažnai atskiria sudėtingą šablono kodą nuo dokumentacijos, be to, dokumentaciją tada tampa lengviau keisti.

Bet kokio šablono dokumentacija turėtų būti apgaubta <noinclude>...</noinclude> žyme, taip ji nepasirodys puslapyje, kuriame šablonas yra naudojamas.

Kaip reikia sukurti dokumentacijos subpuslapį[redaguoti vikitekstą]

Šablono dokumentacijos puslapiai dėl nuoseklumo turėtų būti pavadinti pagal žemiau pateiktą logiką.

Pavyzdžiui, jums reikia sukurti šabloną Šablonas:X. Sukurkite subpuslapį su tokiu pavadinimu: Šablonas:X/doc ir įklijuokite į jį šį standartinį vikitekstą:

{{Documentation subpage}}
<!-- KATEGORIJAS prašome rašyti į puslapio pabaigą, o INTERVIKI į Vikiduomenis -->

=== Panaudojimas ===

=== Nuorodos ===

<includeonly>
<!-- KATEGORIJAS prašome rašyti čia -->

</includeonly>

Išsaugokite aprašytą dokumentaciją ir grįžkite į patį šabloną, Šablonas:X, jį taip pat aprašę, jo pabaigoje taip pat pridėkite šį kodą:

<noinclude>
{{Dokumentacija}}
<!--Please add this template's categories to the /doc subpage, not here - thanks!-->
</noinclude>

Taip šablono dokumentacija bus įtraukta į patį šabloną, jo puslapio pabaigoje.