Википедија:Документирање на предлошки: Разлика помеѓу преработките

[[Википедија:ШаблониПредлошки|ШаблонитеПредлошките]] (порано наречени „шаблони“) се многу моќна алатка на [[МедијаВики]], но во исто време збунувачки за новите корисници, па дури и поискусните корисници со потешкотии го разбираат значењето на покомплекснитепосложените шаблонипредлошки. ШаблонитеПредлошките треба да бидат проследени со соодветна '''[[документација]]''' за да се објасни и зголеми нивната употреба.

Документацијата треба да објасни зошто служи и како се користи шаблонотпредлошката. Треба да биде едноставна за да може и корисниците без некои пошироки познавања на синтаксата на шаблонотпредлошката, во кои спаѓаат и многу искусни уредувачи кои своето внимание го имаат фокусирано на друго место, да може правилно и успешно да го користат. Ова посебно е важно за шаблонитепредлошките кои се користат многу често.

* Основната '''намена''' на шаблонотпредлошката: што прави, и (ако не е очигледно) зошто треба тоа да го направи. Ако постојат други шаблонипредлошки со слично име или намена, добро би било истото да се наведе во документацијата, за да се намалат можностите за погрешно користење на некој од нив.

* Било кои '''[[Помош:Шаблони#Параметри|параметри]]''' кои шаблонотпредлошката ги прима, објаснете дали се или нумерирани или именувани, без разлика дали се опционални (и ако е така, која би била општата, почетна вредност) и каков ефект тие имаат. Ако параметарот може да прима само одредени вредности (како „да“ и „не“, на пример), мора да биде број или е ограничен на било кој друг начин, сето тоа треба да се наведе.

* '''Пример за употреба'''. Прикажете го точниот викитекс кој треба да се користи и резултатот од него. Вики текстот може да биде затворен со &lt;tt>...&lt;/tt> ознаките за да биде видлив и <tt>лесен за копирање, како што е ова</tt>. Ако шаблонотпредлошката се користи на повеќе други начини (со или без опционалните параметри, на пример), обезбедете повеќе примери. Добар начин да се направи ова е да се трансклудира самиотсамата шаблоншредлошка во документацијата неколку пати, со различни параметри, и листа на искористените параметри користени во секој случај.

* '''Поврзани шаблонипредлошки'''. If the template is one of a series of templates, include links to these – in particular, ensure that every template in the series is linked from each of the others, as this makes navigation easier. (A separate navigation template may be useful for this purpose; see for example [[Template:Protection templates]]).

* [[Википедија:Високоризични шаблонипредлошки]]

* [[ШаблонTemplate:template doc page transcluded]]

* [[ШаблонTemplate:template doc page viewed directly]]

[[Категорија:Документација за шаблонипредлошки| ]]