Vikipedija:Šablonai
|
Čia pateiktas pasiūlymas oficialioms Vikipedijos taisyklėms ar tvarkai. Prašome pasisakyti aptarimo puslapyje. |
Šablonai yra MediaWiki elementai, įstatomi į kitus puslapius. Tam naudojami riestiniai skliaustai („{{Šablonas}}“).
Reikalavimai šablonams redaguoti
Vieta redaguoti
Paprastai šablonai patenka į šablonų vardų sritį. Tačiau juos galima laikyti ir kitose vardų srityse, išskyrus tas, kurios skirtos enciklopediniam turiniui laikyti (straipsnių ir sąrašų; išimtį sudaro šablonai, naudojami „Pagrindinis puslapis“), bei įvairias aptarimų vardų sritis. Tokiu atveju paprastai tai bus kurio nors puslapio subpuslapiai. Jei šablonas sukurtas tam, kad būtų naudojamas tik viename puslapyje, dažnai protinga jį laikyti būtent to puslapio subpuslapyje.
Paprastumas redaguoti
Reikia stengtis, kad kiekvienas šablonas būtų kuo paprastesnis: kad būtų kuo lengviau jį tiek modifikuoti, tiek ir naudoti.
Dėl to paprastai vienas šablonas turi atlikti tik vieną funkciją. Pavyzdžiui, neverta kurti šablono, kuris būtų naudojamas tiek šaltiniui pateikti, tiek ir jo nebuvimui nurodyti.
Jei galima, patartina, kad šabloną būtų galima naudoti ir be parametrų.
Nedubliavimas redaguoti
Paprastai reikėtų nekurti skirtingų šablonų, kurie atlieką tą patį. Tai apsunkina šablonų naudojimą bei keitimą.
Nebenaudojamus šablonus reikėtų ištrinti, paversti nukreipimais į analogiškus naudojamus, arba atitinkamai pažymėti. Pažymėjimas ypač naudotinas jei šablonai turi kokią nors istorinę vertę (pavyzdžiui, be jų nepavyktų suprasti daugelio pakeitimų), vertimas nukreipimu itin rekomenduotinas, kai kreipinių į šabloną likę daug, bet jie dėl nukreipimo nenustos veikti (kitaip tariant, naudojami tie patys parametrai).
Vieningumas redaguoti
Panašios paskirties šablonai ir patys turėtų būti panašūs. Pavyzdžiui, jei visi straipsnio trūkumus nurodantys skydeliai yra stačiakampio formos, nereikėtų kurti analogiškų skydelių, kurie yra trapecijos formos.
Neretai vieningumą galima užtikrinti sukuriant šabloną (metašabloną), naudojamą kitiems šablonams kurti.
Dokumentacija redaguoti
Šablonai turi būti dokumentuojami. Turi būti aišku, kam šablonas skirtas. Jei šablonas turi parametrų, turėtų būti galima nustatyti, kokie jie yra, ką jie daro, ar jie privalomi.
Kartais šablonai gali būti save dokumentuojantys. Pavyzdžiui, akivaizdu, kad skydelis, kuriame parašyta, kad juo pažymėtame straipsnyje trūksta šaltinių, dedamas ten, kur trūksta šaltinių. Reikėtų, kad šablono paskirtį kuo tiksliau (nors ir trumpai) nurodytų jo pavadinimas.
Jei šablonas priskiria puslapius, kuriuose yra, kokiai nors kategorijai, tai turėtų būti paminėta tos kategorijos aprašyme.
Kategorizavimas redaguoti
Kiekvienas šablonas, skirtas naudoti ne viename puslapyje (bent šablonai, skirti naudoti straipsniuose), turėtų patekti į kategoriją „Kategorija:Šablonai“ ar kurią nors iš jos subkategorijų.