Wikipedija:Dokumentacija predloge: Razlika med redakcijama

* '''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 <nowiki><code> in </code></nowiki> da <code>izgleda takole</code>. Pri bolj zapletenih predlogah je koristno vključiti nekaj kombinacij parametrov in poleg njih še predlogo samo. Za zgled glej [[Predloga:Vandalizem/dok|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.

 

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 <code><nowiki><noinclude>...</noinclude></nowiki></code>. Kot nakazuje ime, se tekst znotraj teh oznak ne [[Wikipedija:Vključitev|vključi]] poleg kode predloge. Zaželjeno je, da se dokumentacija nahaja na [[Wikipedija:Podstran|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.

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

 

 

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

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 <code><nowiki>[[Kategorija:Ime kategorije]]</nowiki></code> znotraj sekcije <code><nowiki><includeonly></nowiki></code>...<code><nowiki></includeonly></nowiki></code> na podstrani ''dok''.