Wikipédia:Sablonkészítési útmutató

A Wikipédiából, a szabad enciklopédiából
(Wikipédia:Elnevezési szokások (sablonok) szócikkből átirányítva)
Jump to navigation Jump to search
Wikipédia:Sablonkészítési útmutató 

Ezen a lapon a magyar Wikipédián érvényben lévő sablonkészítési szokásokat találod meg. Sablonok készítésekor mindenképpen vedd figyelembe őket, ha valamivel nem értesz egyet, vagy nem érted, előbb érdeklődj a Sablonműhely vitalapján vagy a Kocsmafal műszaki szekciójában, mielőtt pont fordítva kezdenél el valamit csinálni. Ha nem az útmutatónak megfelelően készíted el a sablonjaidat, ne lepődj meg, ha azt átnevezik vagy átszerkesztik. De a legfontosabb: mielőtt belevágsz, nézd meg, hogy nincs-e már az adott célra sablon, hogy elkerüld a felesleges munkát és az esetleges utómunkát. Második legfontosabb dolog, ami talán fontosabb, mint az előző, hogy sose másolj egy az egyben sablonokat más wikikből.

A sablon neve[szerkesztés]

A sablon nevének egyértelműen le kell írnia, hogy a sablon mire is használható. Fordítás esetén ne a külföldi wikin található nevét használd, vagy fordítsd le tükörfordítással, hanem magyarul add meg. Csak abban az esetben hagyd meg az eredeti nevet, ha a sablont tömegesen másoljuk az adott wikiből (ilyen például a {{cite web}}(?) és a {{taxobox}}(?)). Mielőtt ilyet tennél, kérj tanácsot a Sablonműhely vitalapján vagy a Kocsmafal műszaki szekciójában. Ha nem áll fenn ez a helyzet, tartózkodj az idegen nevek használatától. Az idegen wikiből való másolás megkönnyítésére készíthető burkolósablon, erről bővebben a Burkolósablon c. fejezetben olvashatsz. Ha nem szeretnénk burkolósablont készíteni, két dolgot tehetsz: elhelyezhetsz egy üzenetet az angol sablonnév alatt, a magyar változatra hivatkozva, vagy kérheted az adminisztrátorokat, hogy védjék le a nevet a létrehozás ellen.

Ha van az adott sablontípusra egységesített név, akkor annak a figyelembevételével nevezd el. Mivel lehetőség van a magyar ékezetek használatára, élj velük, még véletlenül se hagyd le őket. Ha például a Mucsajröcsögei Autógyár termékeiről csinálsz egy navigációs sablont, akkor annak Sablon:A Mucsajröcsögei Autógyár termékei legyen a neve, és ne

  • Sablon:Mucsajrocsogei
  • Sablon:Mucsajröcsögei
  • Sablon:Mucsajröcsögei Autógyár
  • Sablon:Autógyár termékek
  • Sablon:Mucsajautok

vagy más, kevésbé leíró szöveg. A név sose CamelCase alakú legyen, azaz pl. ne Sablon:MagyarBigyók legyen, hanem Sablon:Magyar bigyók.

Egységes nevek[szerkesztés]

Jelenleg az alábbi sablonfajtákra van érvényes névszabályozás:

  • Infoboxoknál: (valami) infobox (Az infobox kisbetűvel, a valami egyes számban)
  • Felhasználói lapos dobozkák (userboxok): Sablon:Userbox/(valami)
  • Angol képnevek a {{Zászló}}(?) sablonhoz: Sablon:Zászló/(név)

Allaposított adattároló sablonok[szerkesztés]

  • Települések és egyéb közigazgatási egységek népessége: Sablon:Népesség/(szócikk címe)
  • Szoftver legfrissebb stabil verziója: Sablon:Legfrissebb stabil verzió/(szócikk címe)
  • Szoftver legfrissebb fejlesztői verziója: Sablon:Legfrissebb fejlesztői verzió/(szócikk címe)

Általános javaslatok a sablonok szerkesztéséhez[szerkesztés]

  • Ha lehetséges, sablonok készítésénél wikikódot használj, így a lap azok számára is értelmezhetőek maradnak, akik nem ismerik a HTML-t. Amennyiben a kívánt eredmény máshogy nem érhető el, csak akkor használd az utóbbit.
  • Kerüld az elavult HTML-tagek és attribútumok használatát, például a <font>-tal történő formázást, egy-két kivételes esettől eltekintve (pl. táblázat készítése esetén a colspan és a rowspan) mindig helyettesíthető CSS használatával.
  • Bonyolultabb sablonok szerkesztése előtt hasznos információkhoz juthatsz a ParserFunctions MediaWiki-kiegészítő leírásából (elemzőfüggvények)!
  • A szócikkekben használt sablonoknál (tehát amelyek nem karbantartósablonok vagy szerkeszői lapon használt userboxok) nagyon ügyelj arra, hogy sose kategorizálják a szócikkeket, az ilyen ugyanis megzavarja a botok működését és a nem elég figyelmes szerkesztőket, valamint a HotCatet és hasonló segédeszközöket. Ez különösen a navboxokra és az infoboxokra érvényes, ezek szerepelnek legtöbbször a szócikkekben.
  • Paraméterek módosítása esetén, amennyiben létezik, mindig frissítsd a Sablonmesterhez szükséges XML-leírólapot, különben az ki fogja szedni a számára ismeretlen paraméterek előfordulásait.
  • Sablon átnevezésekor megfelelően gondoskodnod kell a Sablonmester XML-jéről is. Két lehetőség van:
    1. Ha meg akarod tartani a régi nevet, létre kell hoznod mindkét név alá pontosan ugyanazt az XML-t (az átirányítás itt nem fog működni!). Hátránya: minden egyes változtatást végre kell hajtani mindkét XML-ben. Előnye: a régi név elérhető marad, így azok a szerkesztők, akik azon a néven ismerték, a jövőben is megtalálják.
    2. Megszünteted a régi név használatát, ekkor csak az új név alá kell XML. Ilyen esetben szólj a régi sablon készítőjének és azoknak a szerkesztőknek, akik a leggyakrabban használják, hogy megváltozott a neve.

Paraméterek[szerkesztés]

A sablon paramétereinek elnevezésekor az alábbi szabályokat kell figyelembe venni:

  • kisbetűvel kezdődjenek (kivéve tulajdonnevek esetén)
  • a paraméter szavait elválasztó karakter szóköz legyen, és ne aláhúzás „_” karakter
  • a paraméter neve pontosan írja le, hogy az mire való, azaz ha a város neve a paraméter, akkor a város neve formát használd, és ne pl. a vneve változatot, ami megtévesztő lehet. (Nem utal konkrétan arra, hogy mit is kell tartalmaznia.) Mivel a paraméterek nevei tartalmazhatnak magyar ékezetes betűket, ezért ahol kell, használd őket (tehát ne varos neve legyen);
  • a paraméter nevében ne legyen helyesírási hiba (pl. í helyett i vagy hibás külön-/egybeírás), mert ez sok szócikkben jelenhet meg, és akadályozza a helyesírást javító botgazdák munkáját;
  • ha egy paraméter értéke felsorolás is lehet (pl. egy film főszereplői), akkor is rendszerint a főszereplő formát használjuk a főszereplők helyett;
  • idegen nyelvű wikipédiából való fordítás esetén mindig fordítsd le a paraméterek nevét magyarra. Ha a használt sablon példányai tömegesen vannak átmásolva a magyar nyelvű szócikkekbe, akkor érdemes burkolósablont használni;
  • amennyiben szócikk belsejébe vagy egyéb folyószövegbe szánt sablont készítesz, érdemes elhagynod a paraméterneveket. Ilyenkor a paraméterekre az {{{1}}}, {{{2}}} stb. szöveggel hivatkozhatsz, és a sablon elhelyezésekor vagy a {{sablon|első paraméter értéke|második paraméter értéke| … }}, vagy a {{sablon|1=első paraméter értéke|2=második paraméter értéke| … }} formát használhatod (a két változat eredménye megegyezik). Ha a paraméter értékében várható „=” karakter, akkor a sablondokumentációba (lásd lentebb) érdemes egy figyelmeztetést elhelyezni, hogy feltétlenül rakják ki a „1=” részeket, oda is, amelyik értékben nincs, mivel ilyenkor az egyenlő karakter előtti részt veszi a MediaWiki értelmezője a paraméter neveként, ami hibákhoz vezethet.

Színhasználat[szerkesztés]

A sablonok helyes felépítése mellett nagyon fontosak a használt színek is. Egy tökéletesen felépített sablont is tönkretehet az, ha ilyen színeket használunk a fejlécben, vagy saját ízlésünk szerint választunk háttérszínt egy táblázatnak. Infoboxoknál, navboxoknál és táblázatoknál a háttér színét mindig #f9f9f9-re állítsd, a keret pedig 1 pixel nagyságú, egyenletes (solid), #aaaaaa színű legyen, a szöveg pedig fekete (#000000).

Sablontípusok jellemzői[szerkesztés]

Infoboxok[szerkesztés]

  • Az új, egységesített infoboxok készítését ezen útmutató alapján csináld:
  • Ha egy adatnál a mértékegység/utószöveg ugyanaz, vagy könnyen átváltható, akkor rögzítsd le azt a sablonban (tehát ne a felhasználónak kelljen beírni a km, m², /év stb. szövegeket). Ha lehet (főként mértékegységek esetében), wikilinket is rakj rá. Sablon fordítása esetén ügyelj arra, hogy más wikik esetben ez a szabály nincs érvényesítve.
  • A képek megadásánál külön paraméterben kérd be a kép nevét, és ha méretezhető képet akarsz, akkor a kép méretét. Sose hagyd, hogy a kép előtagot a felhasználónak kelljen beírni. (Ehhez használható az {{Infobox/Kép}}, vagy {{Infobox/Két kép}} sablon, dokumentációjukat lásd a fenn linkelt lapon)
  • Ügyelj arra, hogy a lehető legtöbb mező opcionális legyen. Ha egy fejezetben nincs kötelező mező, akkor ügyelj arra is, hogy a fejezet címe ne jelenjen meg, ha nincs megadva egyetlen mező sem.

Navboxok[szerkesztés]

Az eligazítást segítő sablonoknál a következőket kell figyelembe venni:

  • A sablon becsukható legyen, és a szócikk megjelenésekor legyen bezárt állapotban.
  • Ha a sablonba egyre több szócikkre kerül hivatkozás, és nagysága már zavaró lehet, akkor szét kell bontani. Nem szabad, hogy például ekkora navboxok készüljenek,
  • A navboxok a {{navbox}}(?) vagy álló sablon esetén {{navoszlop}}(?) sablonnal készüljenek. A fejléc színét csak akkor változtasd meg, ha nagyon szükséges, és ügyelj arra, hogy az ne legyen rikító, a szöveg- és háttérszín pedig ne különbözzön élesen egymástól, pl. ne a citromsárga-lila páros).

Userboxsablonok[szerkesztés]

A userboxsablonokat a {{Userbox/új}}(?) sablonnal kell készíteni, valamint lehetővé kell tenni, hogy az azt használó szerkesztők egyedi kinézettel helyezhessék el azokat a saját felhasználói lapjukon. Mintának lásd a Userboxsablonok kategóriában található sablonokat. További szabályok:

  • csak a populárisabb témákkal kapcsolatos userboxok kategorizáljanak, tehát ha élsz-halsz az atlanti-óceáni nyálkahalért, az még önmagában nem zárja ki a userboxkészítést, de ne készíts hozzá kategóriát.
  • ha tényleg nagyon egyedi sablont készítesz, jobban teszed, ha csak a saját felhasználói lapodra másold be.

Figyelmeztető, tájékoztató sablonok[szerkesztés]

A sablonegységesítés jegyében ha szócikkre, képre, sablonra vagy kategóriára helyezhető figyelmeztető vagy tájékoztató jellegű sablont szeretnél készíteni, használd az {{ambox}}(?) sablont. Az útmutatót megtalálod a dokumentációs allapján.

Burkolósablonok[szerkesztés]

A burkolósablonok célja, hogy megkönnyítse a szerkesztőknek a más wikik szócikkeiben található sablonpéldányok felhasználását. Ilyen esetekben a felhasználónak nem kell átírnia a sablon, valamint a paraméterek neveit, csupán néhány változtatást kell véghez vinnie (pl. az angol formátumú dátumok hivatkozását el kell távolítani, mivel a magyar Wikipédiában nem úgy működik, mint ahogy kellene). Burkolósablonnak nincs értelme a kevés (kevesebb, mint 5) paramétert tartalmazó sablonok, például a navboxok, valamint a paraméternév-nélküli sablonok esetében.

Készítésük nagyon egyszerű. A mintához egy háromparaméteres, Kiscica nevű sablont használunk fel. Ha a sablont az alábbi módon használjuk:

{{Kiscica
|neve=
|életkora=
|színe=
}}

, továbbá ha az eredeti, angol Wikipédiában található Kitten sablon így használható:

{{Kitten
|name=
|age=
|color=
}}

, akkor a burkolósablont így kell elkészíteni a magyar Wikipédiában, Kitten néven:

{{Kiscica
|neve={{{name|}}}
|életkora={{{age|}}}
|színe={{{color|}}}
}}

Az ilyen sablonok megjelölésére használd a {{burkolósablon}}(?) sablont.

<noinclude> részek[szerkesztés]

A sablonok <noinclude> részében olyan kód található, amely csak a sablon lapján fog megjelenni, a beillesztés helyén nem. Az ilyen részekbe kell elhelyezni a dokumentációt, magának a sablonnak a kategorizálását, a figyelmeztető sablonokat stb.

A sablon dokumentálása[szerkesztés]

Mindegyik sablonhoz illik dokumentációt készíteni, ez kifejezetten igaz azokra, amelyek számos paraméterrel rendelkeznek vagy nem egyértelmű a használatuk. A <noinclude> részben elhelyezett {{Sablondokumentáció}}(?) sablon segítségével megjelenik egy link a sablon leírólapján (dokumentációs allap létrehozása), ha erre kattintasz, bejön az elkészítendő dokumentáció váza. Mindegyik sablonhoz szokás üres mintát biztosítani, továbbá minden egyes paraméterhez legyen egy legalább egysoros leírás: mire és hogyan használható.

Kategóriák[szerkesztés]

A sablont mindig a megfelelő kategóriába helyezd el, maximum kettőbe vagy háromba. Például a {{magyar település infobox}}(?) elhelyezhető a Települések infoboxsablonjai és a Magyarországgal kapcsolatos sablonok kategóriákba.

XML allapok[szerkesztés]

Ha elkészítesz egy új, sok paraméteres sablont, más szerkesztők számára könnyebbé teheted a szerkesztését, ha használhatóvá teszed a Sablonmester nevű segédeszközzel (Beállításaim → Segédeszközök fül). Nagyobb infoboxok esetén kifejezetten hasznos, hiszen nincs szükség a paraméterek nevének megjegyzésére. Ehhez egy XML-dokumentumra van szükség. Felépítéséről bővebben a Sablonmester leírásánál olvashatsz róla, vagy megnézhetsz pár bonyolult, és kevésbé bonyolult mintát:

Ha szeretnéd használni a sablonodat a Sablonmesterrel, de nem tudod, mi fán terem az XML-készítés, akkor szólj a Sablonműhely vitalapján a szándékodról.

További tudnivalók[szerkesztés]

  • Ha jegyzetnek szeretnél paramétert adni, akkor a következő formát kell használnod a hibás <ref>{{{1}}}</ref> helyett: {{#tag:ref| {{{1}}} }}
  • Ugyanez érvényes az imagemapre is.
  • A sablon ne tartalmazzon portál-, Commons- és hasonló sablonokat.
  • Ha egy sablont szeretnél működés közben vizsgálni, elhelyezhetsz benne olyan kódot, ami bizonyos szempontok szerint kilistázza a szócikkeket egy kategóriába. Ehhez a Tesztelés alatt álló sablon kategóriát használhatod. (További segítség a kategória leírólapján).
  • Ne hozz létre feltételes listaelemet, mert külön listába fog kerülni! m:Help:Newlines and spaces#Automatic newline

Eszközök[szerkesztés]

Lásd még[szerkesztés]