Tulong:Documenting templates

Mula Wiktionary
Jump to navigation Jump to search

Mga padron at mga module ay masyadong malakas na tampok ng MediaWiki, ngunit maaaring maging nakakalito sa mga bagong gumagamit at kahit na karanasan ang mga gumagamit ay maaaring magkaroon ng kahirapan sa paggawa ng kahulugan ng mas kumplikadong mga bago. Dapat samakatuwid sila ay sinamahan ng mga papeles upang mapabuti ang kakayahang magamit. Dapat ipaliwanag dokumentasyon kung ano ang ginagawa ng isang template o module at kung paano gamitin ito. Para sa mga template sa partikular, dapat itong maging sapat na simple na ang isang gumagamit nang hindi kumpletong kaalaman tungkol sa intricacies ng mga syntax template - na kung saan ay nagsasama ng maraming karanasan na taga-ambag na ituon ang kanilang pansin sa ibang lugar - Maaaring gamitin ito ng tama. Ito ay lalong totoo sa kaso ng mga template napaka-malawak na ginamit.

Halimbawa[baguhin]

Tingnan ang mabigat-ginamit Padron: en-pangngalan para sa isang halimbawa ng detalyadong papeles padron. Tandaan na ang mismong template ay protektado, ngunit ang dokumentasyon subpage, Padron:en-noun/documentation ay walang kambil at maaari pa ring mai-edit. Ang ilang mga padron, isa dokumentasyon pahina

Kapag maraming mga padron nagtutulungan o mga katulad na katulad gayon ito ay madalas na mas malinaw at mas madali para mapanatili ang isang solong pahina na dokumentasyon na mga dokumento ang mga ito nang sama-sama. Ang pinakasimpleng paraan upang gawin ito ay upang makagawa ng isang kumpletong dokumentasyon pahina sa isa sa mga padron, at pagkatapos ay gumawa ng "pag-redirect" mula sa mga pahina ng dokumentasyon ang iba pang mga padron. Tingnan ang Padron: nl-conj-linggo at Padron: nl-conj-st para sa isang halimbawa ng ganitong prinsipyo.

Paggamit[baguhin]

Ang nangungunang mga linya ay magpapakita ng mensahe na nagpapaliwanag ng kasalukuyang pahina at isang link sa mga padron o pangunahing pahina ng module na iyon. Ipasok ang dokumentasyon pagkatapos ng tuktok linya at mga kategorya at interwikis sa ilalim ng naaangkop na line komento - umaalis sa komento sa lugar, sa gayon na ang layout ay napanatili kapag ang pahina ay nai-edit sa hinaharap. Pagkatapos ay i-save ang subpage.