„Segítség:Sablondokumentáció” változatai közötti eltérés

nincs szerkesztési összefoglaló
Nincs szerkesztési összefoglaló
* 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.
 
* '''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 {{bszín|sablon:sablon infó|#006000}} é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? ==
 
Az egyszerűbb megoldás, ha simán beírod a Sablon információ szövegét, a kategóriákat és az interwikilinkeket a sablon végén elhelyezett <tt><nowiki><noinclude>...</noinclude></nowiki></tt> blokkba, hogy csak a sablon saját lapján jelenjen meg, a sablon használatakor ne. (Ügyelj rá, hogy a <tt><nowiki><noinclude></nowiki></tt> ne új sorban kezdődjön, hanem az utolsó nem üres sor végén! Máskülönben a sablon használatakor több üres hely lesz utána, mint szeretnéd.) Ha a sablon a saját lapján csúnyán jelenik meg (például mert nincsenek megadva a paraméterek, amik a megjelenését szabályozzák), beleteheted a kódját egy <tt><nowiki><includeonly>...</includeonly></nowiki></tt> blokkba (de a Sablon információt nem!), hogy csak beillesztéskor jelenjen meg, a sablon saját lapján ne.
'''Lásd például''' [[Sablon:Abc infó]], [[Sablon:ABC sablonok listája]] sablont.
 
 
== Hogyan írj Sablonsablon információt? ==
 
* Az egyszerűbb megoldás, ha simán beírod a Sablon információ szövegét, a kategóriákat és az interwikilinkeket a sablon végén elhelyezett <tt><nowiki><noinclude>...</noinclude></nowiki></tt> blokkba, hogy csak a sablon saját lapján jelenjen meg, a sablon használatakor ne. (Ügyelj rá, hogy a <tt><nowiki><noinclude></nowiki></tt> ne új sorban kezdődjön, hanem az utolsó nem üres sor végén! Máskülönben a sablon használatakor több üres hely lesz utána, mint szeretnéd.) Ha a sablon a saját lapján csúnyán jelenik meg (például mert nincsenek megadva a paraméterek, amik a megjelenését szabályozzák), beleteheted a kódját egy <tt><nowiki><includeonly>...</includeonly></nowiki></tt> blokkba (de a Sablon információt nem!), hogy csak beillesztéskor jelenjen meg, a sablon saját lapján ne.
 
A bonyolultabb megoldás a Sablon információs allap használata, ilyenkor a Sablon információ a ''Sablon:Sablonneve/inf'' lapról lesz beillesztve. Ennek számos előnye van:
 
Hátránya viszont, hogy a sablonokat tartalmazó kategóriák könnyen elavulttá válhatnak, mert a Sablon információs lapon végrehajtott változtatások csak akkor jelennek meg a kategórialapokon, ha a dokumentálandó sablont is megváltoztatja valaki.
 
* Ha több hasonló sablonhoz készítettél [[Sablon:Abc infó]]-hez hasonló ifósablont, akkor használata és az egyedi eltéréseket a lap tetejére írod. Majd alá beílleszted a minden sablonra vonatkozó {{sl|sl-infó}} sablont.
 
Sablon információs allap használatához a sablon végére a <tt><nowiki><noinclude>{{sablondokumentáció}}</noinclude></nowiki></tt> szöveget írd be. (Ilyenkor is ügyelj rá, hogy a <tt><nowiki><noinclude></nowiki></tt> ne új sorban kezdődjön!)
220 725

szerkesztés