Šablon:Dokumentacija
 | Ovaj šablon koristi sljedeće Lua module: |
 | Ovaj šablon koristi TemplateStyles: |
Dokumentacija šablona služi za informiranje i instruktiranje korisnika o njegovoj svrsi, sintaksi i upotrebi. Za većinu šablona se dokumentacija nalazi na podstranici /dok, dok se neke kraće dokumentacije nalaze na istoj stranici, unesene kao vrijednost parametra |content=.
Zaglavlje dokumentacijske kutijice sadrži linkove za pristupanje, uređivanje, osvježavanje (pri ažuriranju), te zapisu historije te podstranice. Podnožje dokumentacijske kutijice sadrži linkove za eksperimentiranje sa šablonom, koji se preporučuju koristiti ako se šablon koristi na mnogo stranica.
Specifičnosti lokalnog šablona
[uredi kod]- Poruka u praznom okviru
Stranica šablona na engleskoj Wikipediji (enwiki) vjerojatno sadrži adekvatnu dokumentaciju koja može poslužiti kako korisnicima šablona, tako i potencijalnim autorima lokalne dokumentacije. Radi povećanja pristupačnosti – ukoliko lokalna /dok stranica još ne postoji, šablon će preko Wikipodataka utvrditi postoji li enwiki ekvivalent te prema njemu u sklopu sljedeće poruke pružiti poveznicu:
- Ovaj šablon trenutno nema dokumentaciju. Kliknite na "izradi" da biste je izradili. Pogledajte [dokumentaciju] na engleskoj Wikipediji.
Nakon što se dokumentacija šablona izradi na lokalnom projektu, ta se poruka više ne prikazuje.
Upotreba
[uredi kod]Dokumentacija se postavlja na stranicu šablona unutar noinclude tagova: <noinclude>{{dokumentacija}}</noinclude>.
Ako se cijela dokumentacija želi unesti na stranici šablona (ne na njegovoj podstranici /dok), za to se može koristiti parametar |content=.