Ta stran je tehni?no navodilo . Opisuje proces ali postopke nekaterih vidikov norm in prakse v Wikipediji. To ni pravilo ali smernica Wikipedije in lahko odra?a razli?ne ravni soglasja in preverjanja .

Predloge so uporabno orodje programja MediaWiki , a imajo lahko neizku?eni uporabniki te?ave z razumevanjem in uporabo te funkcije. Zato naj bi bile predloge opremljene z dokumentacijo , ki razlaga njihovo uporabo.

Na kratko naj bi dokumentacija predloge razlo?ila, ?emu je predloga namenjena in kako jo uporabiti. Idealno naj bi bila ta razlaga razumljiva tudi ?loveku, ki ni seznanjen z delovanjem Wiki sintakse. Posebej to velja za pogosto uporabljane predloge.

Dokumentacija naj bi vsebovala:

• namen - kaj predloga ustvari in zakaj jo je potrebno uporabljati, ?e ni to o?itno
• parametre predloge - razlaga uporabe in njihove mo?ne vrednosti
• zgled uporabe - izpisana koda kot jo je treba vklju?iti v ?lanek ali na pogovorno stran, s parametri. Kodo je la?je kopirati, ?e je izpisana znotraj oznak <code> in </code> da izgleda takole . Pri bolj zapletenih predlogah je koristno vklju?iti nekaj kombinacij parametrov in poleg njih ?e predlogo samo. Za zgled glej dokumentacijo predloge Vandalizem .
• sorodne predloge - povezave do sorodnih predlog, ?e posebej ?e obstaja v nek namen cela serija predlog in/ali imajo zelo podobna imena.
• kategorije - za preglednost.

Ker se dokumentacija nana?a na predlogo samo in ne na vse strani kjer je predloga vklju?ena, jo je treba dodati na stran predloge znotraj oznak <noinclude>...</noinclude> . Kot nakazuje ime, se tekst znotraj teh oznak ne vklju?i poleg kode predloge. Za?eljeno je, da se dokumentacija nahaja na podstrani predloge in se to podstran nato vklju?i na konec strani predloge. To olaj?a razlikovanje med kodo predloge, ki je lahko zelo dolga in zapletena, ter dokumentacijo. Omogo?a tudi urejanje dokumentacije vsem, ?e je predloga iz kak?nega razloga za??itena pred urejanjem. Nenazadnje pa zmanj?a obremenitev sistema, ki mu ob vklju?evanju predloge ni potrebno procesirati ?e celotne dokumentacije.

Za preglednost naj bi bile vse dokumentacijske podstrani poimenovane po naslednjem vzorcu: vzemimo za primer, da imamo predlogo z imenom Predloga:Zgled . Podstran naj ima torej naslov Predloga:Zgled/dok .

Na ta naslov skopirajte naslednje

{{dokumentacijska podstran}}
<!-- Kategorije spadajo na dno te strani, medjezikovne povezave pa v Wikipodatke. -->

== Uporaba ==

== Glej tudi ==

<includeonly>
<!-- Kategorije spadajo sem, medjezikovne povezave pa v Wikipodatke -->

</includeonly>

Predloga na vrhu bo prikazala obvestilo, da gre za dokumentacijsko podstran, in povezavo do predloge ter uvrstila podstran v kategorijo Dokumentacijske podstrani .

Pod njo spada besedilo dokumentacije, med <includeonly>...</includeonly> pa ustrezne kategorije. Predloge naj bi bile v kategorijah razvr??ene po imenu, zato dodajte razvrstilni klju? {{PAGENAME}} . Brez tega se predloga kategorizira pod ?rko P.

Shranite podstran in se vrnite na samo predlogo, v tem primeru Predloga:Zgled. Na koncu dodajte naslednje:

[--zadnja vrstica predloge--]
<noinclude>{{Dokumentacija}}</noinclude>

To bo vklju?ilo vsebino dokumentacijske podstrani na stran od predloge. Pomembno: prvi <noinclude> mora biti v isti vrstici kot konec predloge, sicer programje upo?teva tudi prazne vrstice pri vklju?evanju predloge v ?lanke, to pa v ve?ini primerov ni za?eleno.

Lahko si tudi olaj?ate delo in za?nete s tem korakom, ker se bo v tem primeru na strani predloge pokazal okvir?ek z rde?o povezavo do dokumentacijske podstrani.

• Umestitev predloge same v ustrezno kategorijo , dodaj kodo [[Kategorija:Ime kategorije]] znotraj sekcije <includeonly> ... </includeonly> na podstrani dok .

• Ustvarjanje medjezikovne povezave za predlogo samo , pove?i s predlogami z enako funkcionalnostjo v drugih jezikih z uporabo orodja ≫dodaj povezave≪, vendar na strani same predloge, ne na dokumentacijski podstrani.

• Umestitev podstrani dok v kategorijo , dodaj kodo [[Kategorija:Ime kategorije]] znotraj sekcije <noinclude> ... </noinclude> na podstrani dok .

• Umestitev ?lanka, ki uporablja to predlogo, v ustrezno kategorijo , dodaj kodo [[Kategorija:Ime kategorije]] znotraj sekcije <includeonly> ... </includeonly> v predlogi sami.