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

с
нема опис на уредувањето
с (троа превод)
сНема опис на уредувањето
{{како-да|ВП:ДОК}}
 
[[Помош:Шаблон|Шаблоните]] се многу моќна алатка на [[MediaWikiМедијаВики]], но во исто време збунувачки за новите корисници, па дури и поискусните корисници со потешкотии го разбираат значењето на покомплексните шаблони. Шаблоните треба да бидат проследени со соодветна '''[[документација]]''' за да се објасни и зголеми нивната употреба.
 
Документацијата треба да објасни зошто служи и како се користи шаблонот. Треба да биде едноставна за да може и корисниците без некои пошироки познавања на синтаксата на шаблонот, во кои спаѓаат и многу искусни уредувачи кои своето внимание го имаат фокусирано на друго место, да може правилно и успешно да го користат. Ова посебно е важно за шаблоните кои се користат многу често.
* '''Пример за употреба'''. Прикажете го точниот викитекс кој треба да се користи и резултатот од него. Вики текстот може да биде затворен со &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]]).
* Соодветни '''[[Википедија:Категоризација|категории]]''' и '''[[Википедија:ИнтервикимедиаИнтервики линковиврски|интервики]] линковиврски''', where applicable. Like the documentation, these must be contained within &lt;noinclude>...&lt;/noinclude> tags. Many template categories are available, go to [[:Category:Wikipedia templates]] to browse through them.
 
Template documentation is often placed in a [[Wikipedia:Subpage|subpage]] of the template itself, which is then [[Wikipedia:Transclusion|transcluded]] at the end of the template page. This separates the often complex template code from the documentation, making the documentation easier to edit. It also allows templates to be [[Wikipedia:Protection policy|protected]] where necessary, while allowing anyone to edit the documentation. This method is sometimes referred to as the "template doc page pattern".