Wikipedia:Hati za Kigezo

Vigezo ni kurasa zinazotumika sana ambazo hutengenezwa ili kuweka maudhui katika muundo wa aina moja, kurahisisha upangaji, au kurahisisha kazi zinazojirudia katika makala za Wikipedia.Ili kuhakikisha kuwa wahariri na wasomaji wanaelewa jinsi ya kutumia kigezo fulani, kurasa za hati huambatanishwa na kila kigezo—ama kwa kuingizwa moja kwa moja ndani ya ukurasa wa kigezo au kwa kutolewa kutoka kwenye ukurasa mdogo wa ziada (kwa kawaida * /doc*).

Hati hizi kwa kawaida hujumuisha maelezo ya madhumuni ya kigezo, vigezo vinavyopatikana pamoja na maelezo yake, mifano ya matumizi, makundi (categories), na maelezo mengine muhimu. Hati ya kigezo husaidia kudumisha uwazi na uthabiti katika Wikipedia hii, hasa kadri vigezo vinavyokuwa tata au kutumika zaidi. Hati hizi mara nyingi hutolewa na watengenezaji wa vigezo au watumiaji walio na uzoefu, na husimamiwa chini ya miongozo ya mtindo na kiufundi ya Wikipedia.

Muhtasari

1. Madhumuni ya Msingi Eleza kile kigezo kinachofanya. Eleza kazi yake na kwanini kinahitajika, hasa kama sio wazi mara moja. Ikiwa kuna vigezo vingine vyenye majina au majukumu yanayofanana, viorodheshe ili kuwasaidia watumiaji kuchagua sahihi. Pia jumuisha mipaka muhimu, kama vile kigezo kisichoonyesha {{Navbox visibility}} kwenye tovuti ya Simu, au ikiwa kimeundwa kwa nchi au vipindi fulani vya muda.

2. Vigezo Eleza vigezo vyote vinavyotumika na kigezo. Toa maelezo kama vigezo ni vilivyopangwa kwa nambari au majina, na eleza mipangilio yoyote isiyo ya lazima pamoja na thamani chaguo-msingi. Ikiwa kigezo kinaweza kuchukua thamani maalum tu—kama “ndiyo,” “hapana,” au nambari—hakikisha hili limeelezwa wazi.

3. Mifano ya Matumizi Toa mifano wazi ya jinsi ya kutumia kigezo. Onyesha wikitext halisi ndani ya <code>...</code> na eleza matokeo yatakayopatikana. Ikiwa kigezo kinaweza kutumika kwa njia tofauti (kwa kuweka au bila kuweka vigezo isiyalazimika), jumuisha mifano kadhaa. Njia moja nzuri ni kuonyesha maonyesho ya moja kwa moja kwa kutumia kigezo na vigezo tofauti, na orodhesha vigezo vilivyotumiwa katika kila mfano. Unaweza kutumia kifaa kama {{demo}} kufanya hivyo bila kurudia wito wa kigezo.

• 4. Lebo za "TemplateData"

Jumuisha maelezo au viungo kama Wikipedia:TemplateData/Tutorial. Hili lina msaada katika kuelewa jinsi ya kuongeza lebo za TemplateData, ambazo ni muhimu kwa uhariri na matumizi.

• 5. Vigezo Vinavyohusiana

Ikiwa kigezo ni sehemu ya mkusanyiko au seti ya vigezo vinavyohusiana, toa viungo vinavyohusiana vyote. Hii inasaidia wahariri kutumia vigezo kwa urahisi. Kigezo tofauti (kwa mfano, chaweza kuitwa {{Protection templates}}) kinaweza kuwa msaada.

• 6. Jamii

Orodhesha Jamii sahihi kwa kigezo. Tumia ... (au kwenye ukurasa wa maelezo) kuorodhesha jamii hizi. Pia jumuisha viungo vya InterWikimedia inapohitajika (kawaida huorodheshwa kwenye Wikidata).

• 7. Mahitaji Ya Ziada

Ikiwa kigezo ni rahisi, kinaweza kuhamishwa kwa Wikipedia zingine bila kazi ya ziada. Lakini ikiwa kinategemea moduli, vigezo vingine, au kinahitaji CSS maalum au HatiJava, jumuisha orodha fupi mwishoni mwa maelezo inayoelezea mahitaji haya.

Ukurasa wa majaribio

Kabla ya kufanya mabadiliko kwenye kigezo, ni vyema kwanza kunakili msimbo wa kigezo ndani ya ukurasa wa majaribio (sandbox) na kuendesha baadhi ya majaribio kwa sababu kigezo kinaweza kuonekana kwenye mamia au hata mamilioni ya kurasa. Ikiwa utaunda kurasa ndogo zilizo na majina kamili "/ukurasa wa majaribio" na "/testcases" kwa kigezo, basi kisanduku cha {{hati}} cha kijani kwenye kigezo kitautambua kiotomatiki na kuonyesha viungo vya kurasa hizo katika kichwa chake.