„Segítség:Sablondokumentáció” változatai közötti eltérés
Tartalom törölve Tartalom hozzáadva
KeFe (vitalap | szerkesztései) |
KeFe (vitalap | szerkesztései) |
||
4. sor:
{{Wk-stílus}}
{{TOC right}}
== Mi szerepeljen a
* Mindenekelőtt '''a sablon célja''': mit csinál a sablon, és (ha nem magától értetődő) mi értelme azt csinálni. Ha van idevágó irányelv, útmutató vagy segítség lap, említsd meg. Ha vannak erre a feladatra más sablonok is, említsd meg őket és mondd meg, miben különbözik ez a sablon a többitől; így kisebb az esélye, hogy a rossz sablont használja valaki.
* A sablon '''paraméterei'''. Írd le, hogy milyen paramétereket lehet használni, mik a névtelen paraméterek, mely paraméterek opcionálisak és mi az alapértelmezett értékük (ha van). Ha van valami kötelező vagy jellemző használati módja az egyes paramétereknek (pl. csak szám lehet; ha belső linket akarsz, kézzel kell beleírni), add meg azt is.
* '''Példák'''. Adj néhány példát, hogyan kell használni, és az mit eredményez. Ha a sablonnak sok paramétere van, csinálj egy konkrét értékek nélküli, másolható mintát a <tt><nowiki><tt>...</tt></nowiki></tt> vagy a <tt><nowiki><pre>...</pre></nowiki></tt> használatával.
* '''Kapcsolódó sablonok''': ha a sablon több, együtt használandó vagy hasonló funkciójú sablon egyike, mindig linkelj a többi sablonra, hogy megkönnyítsd a navigációt. Ha elég sok sablonról van szó, érdemes külön egy közös sablon:sablon infó és egy navigációs sablont csinálni erre a feladatra. (Lásd például az angol [[:en:Template:Protection templates|Protection templates]] sablont.) A sablonok megadásához érdemes az {{sl|sl}} sablont használni.
== Hogyan írj Sablon információt? ==
| |||