Wikipédia:Sablonok

A Wikipédiából, a szabad enciklopédiából
(Wikipédia:Hogyan használd a sablonokat? szócikkből átirányítva)
Wikipédia:Sablonok 
Curly Brackets.svg

A sablonok olyan lapok, melyek célja gyakran használt, a ritkán vagy egyáltalán nem változó, esetenként bonyolultan létrehozható, több lapon használt szövegrészletek (például táblázatok, információs dobozok, forráshivatkozások) tárolása azért, hogy a szócikkszerkesztőknek ne kelljen újra és újra begépelniük őket, frissítés esetén lapok százai helyett egyetlen helyen kelljen módosítani, valamint a szócikkek forrásában ne szerepeljenek a bonyolult kódot igénylő szerkezetek. Vagyis pont azt csinálják, amire a nevük utal: a sablonos, ismétlődő helyzetekre kínálnak sablonos, ismétlődő megoldásokat.

A sablonok további előnye, hogy bonyolult, összetett elemeket helyezhetünk el velük a szócikkekben és más lapokon, miközben a wikikód egyszerű és könnyen áttekinthető marad.

A sablonokat saját névterükben, a Sablon: névtérben helyezzük el, de használhatunk sablonként bármelyik más névtérből származó lapokat is. Tartalmukat úgy lehet más lapokon (szócikkekben, közösségi lapokon, de akár más sablonokban) elhelyezni, hogy a nevüket kettős kapcsos zárójelek ({{ és }}) közé írjuk. (A Sablon: névtérben elhelyezett sablonok névterét nem kell kiírni, tehát {{sablon:valami}} helyett elegendő {{valami}}-t írni.) Tartalmazhatnak ún. paramétereket, melyek segítségével változó szövegrészeket hozhatunk létre (például paraméter lehet egy város információit tároló sablonban a város neve vagy a lakók száma). Ezen paraméterek értékeit a sablon elhelyezésének helyén lehet (vagy kell) megadni.

A sablonok használata[szerkesztés | forrásszöveg szerkesztése]

Sablonok tartalmát más lapokon a nevüket kapcsos zárójelek, azaz {{ és }} közé (a {-et az AltGr+B-vel vagy Alt+123-mal, míg a }-et AltGr+M-mel vagy Alt+125-tel írhatsz, vagy kattints a szerkesztő-eszköztár Button plantilla.png ikonjára) írva lehet elhelyezni:

{{Sablonnév}}

Sablonként nem csak a Sablon: névtérben található lapok használhatóak, ilyen esetben a névteret is oda kell írni a név elé. (Pl. ha a Wikipédia:Szerkessz bátran! lapot szeretnéd elhelyezni, akkor a {{Wikipédia:Szerkessz bátran!}} szöveget kell beírnod, ha a szócikk névtérből illesztesz be lapot, akkor pedig a szócikk neve elé kell írni egy kettőspontot, azaz ha a StarCraft lap szövegét akarod elhelyezni, akkor a {{:StarCraft}} szöveget kell beírnod a lap szerkesztésekor.)

A sablonok nevei mindig nagybetűvel kezdődnek, és kis- és nagybetűérzékenyek, azaz míg az {{azonnali}} és az {{Azonnali}} ugyanarra a sablonra hivatkoznak (amennyiben az első betű kisbetű, automatikusan nagyra cserélődik), addig az {{Azonnali}} és az {{AzOnNaLi}} két különböző sablont jelent.

Az alábbi ábra betekintést nyújt, hogy a wikikódelemző-motor (ami a wikikódot HTML-kóddá alakítja, ennek megjelenítésére már a böngésző is képes), hogyan is végzi a sablonok behelyettesítését.

A sablonok működése.png
1. lépés: a wikikód-elemző motor megkeresi a szövegben elhelyezett sablonokat, majd betölti azok tartalmát. (Esetünkben csak a Sablon:Tesztet)
2. lépés: További feldolgozás után az így keletkező szöveget beilleszti a szócikk szövegébe. Ez a szöveg HTML-kóddá való alakítás után a lap megtekintésekor fog megjelenni, míg a szócikk forrásában ugyanúgy a wikikódú változat és a sablonhivatkozás marad meg.

(Valójában a {{Teszt}}(?) sablon létezik, és egészen más a tartalma, ez csak egy elvi példa.) A fenti színes téglalapot is egy sablonnal hoztuk létre; ha érdekel a működése, ennek a szakasznak a forrásában megtekintheted.

Paraméteres sablonok[szerkesztés | forrásszöveg szerkesztése]

A sablonok tartalmazhatnak úgynevezett paramétereket. Ezek arra valók, hogy az egyébként fixen megadott sablonszövegbe olyan részeket rakjunk be, melyek tartalmát a sablont a használat helyén elhelyező szerkesztő adhatja meg.

Magában a sablon kódjában a paraméterek nevükkel három kapcsos zárójel közé rakva jelennek meg. Paraméter lehet névtelen vagy más néven számozott (azaz {{{1}}}, {{{2}}} stb.), vagy névvel ellátott (pl. {{{kiadási év}}}, {{{népesség}}} stb.).

Arról, hogy egy sablonnál milyen paraméterek használhatóak, és melyik paraméter milyen értéket vehet fel, az adott sablon leírólapján található sablondokumentációban olvashatsz. Vannak kötelező paraméterek, melyeket muszáj megadni, ha azt szeretnénk, hogy a sablon helyesen jelenjen meg. Az opcionális paraméterek általában olyan kiegészítő információkat tartalmaznak, melyek hiányában a sablon még mindig használható marad.

A sablon használatának helyén ezen paraméterek értékét nevük és egy egyenlőségjel írása után tudjuk megadni. Egymástól, és a sablon nevétől a pipe karakterrel (függőleges vonal: „|”, az AltGr+W vagy az Alt+124 segítségével írható) választhatóak el:

{{Sablon neve|paraméter1=értéke|paraméter2=értéke}}

Névtelen paraméterek esetén nem szükséges kiírni a számokat, az elsőként megadott szöveg az {{{1}}} értéke lesz, a második a {{{2}}}-é, és így tovább:

{{Sablon neve|érték1|érték2}}

Akkor is elhagyható a névtelen paraméterek neve, ha a névtelen és a névvel ellátott paramétereket keverjük. Ilyenkor érdemes a névtelen paramétereket előre rakni, hogy más szerkesztők számára is áttekinthető maradjon a sablon. Amennyiben nem keverjük őket, a névtelen paraméterek az előfordulásuk sorrendjében kapnak értéket, továbbá a névvel ellátott paraméterek jelenléte nem befolyásolja őket:

{{Sablon neve|érték1|tesztparaméter=valamilyen érték|érték2}}

A fenti példánál az {{{1}}} értéke „érték1”, míg a {{{2}}} értéke „érték2”, míg a {{{tesztparaméter}}} értéke „valamilyen érték” lesz.

Amennyiben a névtelen paramétereket nem az adott sorrendben szeretnénk megadni, vagy valamelyiket ki akarjuk hagyni, a paraméter számát kötelező megadni:

{{Sablon neve|2=érték2|7=ez is valami}}

Akkor is kötelező megadni a névtelen paraméter számát, ha a paraméter értéke egyenlőségjelet (=) tartalmaz, mert ha nem ezt tennénk, akkor az egyenlőségjel előtti szöveg lenne a paraméter értéke, és az esetleges további paraméterek elcsúsznának:

Hibás változat:
{{Sablon neve|e=mc2|érték2}}
Ennél a változatnál az {{{e}}} paraméter értéke „mc2”, míg az {{{1}}} értéke „érték2
Jó változat:
{{Sablon neve|1=e=mc2|érték2}}
Ennél a változatnál az {{{1}}} paraméter értéke „e=mc2”, míg a {{{2}}} értéke „érték2

Az alábbi ábra betekintést nyújt, hogy a wikikódelemző motor (ami a wikikódot a böngésző által megjeleníthető HTML-kóddá alakítja) hogyan is végzi a paraméterek feldolgozását.

A sablonparaméterezés működése.png
1. lépés: a wikikódelemző motor megkeresi a szövegben elhelyezett sablonokat, majd betölti azok tartalmát. (Esetünkben csak a Sablon:Tesztet.)
2. lépés: ha a sablon rendelkezik paraméterekkel, és megadta azok értékeit a szerkesztő, akkor behelyettesíti azokat a sablon szövegébe (jelen esetben a kékkel jelölt {{{népesség}}}-et lecseréli a népesség= után megadott 17575-re), majd további feldolgozás után az így keletkező szöveget beilleszti a szócikk szövegébe. Ez a szöveg HTML-kóddá való alakítása után a lap megtekintésekor fog megjelenni, míg a szócikk forrásában ugyanúgy a wikikódú változat és a sablonhivatkozás marad meg.

Speciális használati módok[szerkesztés | forrásszöveg szerkesztése]

A sablonok két speciális használati móddal rendelkeznek.

Szubsztolás[szerkesztés | forrásszöveg szerkesztése]

Az első és a gyakrabban használt módszer az, mikor „beillesztjük” vagy „bemásoljuk” a sablon tartalmát. Ez azt jelenti, hogy a lap szerkesztésekor még a sablonra hivatkozunk, azonban miután elmentjük, már nem a sablonhivatkozás lesz a szócikk forrásában, hanem helyette a sablon tartalma kerül beillesztésre. Ez olyan sablonok esetében használható, melyek valamilyen váz kitöltésében vagy tartalom elhelyezésében segítenek (pl. a sorozatok egységes bevezetőjének megírásához használható {{epizódbevezető}}(?) sablon), vagy gyakran változó tartalommal rendelkeznek, és az elhelyezés helyén az elhelyezés pillanatában meglévő változatot szeretnénk megtartani (pl. üdvözlősablonok, figyelmeztetősablonok, blokkértesítésre szolgáló sablonok esetében). Sablon beillesztéséhez a sablonhivatkozás elhelyezésekor egyszerűen a sablon neve elé kell írni a „beilleszt:”, a „bemásol:”, vagy az angol „subst:” szöveget. Paraméterek ugyanúgy használhatóak itt is. Az alábbi módon működik:

{{beilleszt:Sablon neve|paraméter1=érték1|paraméter2=érték2}}

A lap elmentése után ha legközelebb megnyitjuk szerkesztésre a lapot, már nem a {{beilleszt:Sablon neve|paraméter1=érték1|paraméter2=érték2}} szöveget láthatjuk a szócikk szövegében, hanem a beillesztett sablon (esetünkben a Sablon neve nevű sablon) tartalmát, a megadott paramétereknek megfelelően.

Msgnw előtag[szerkesztés | forrásszöveg szerkesztése]

A második, és igen ritkán használt módszer a sablon neve elé illesztett msgnw: előtag. Ekkor maga a sablon kódja fog megjelenni a lap megtekintésekor, ugyanakkor a szócikk forrásában továbbra is az msgnw: előtaggal ellátott sablonhivatkozás marad (tehát nem cserélődik le a sablon tartalmára, mint a beillesztés esetén). A használata a következő:

{{msgnw:Sablon neve|paraméter1=érték1|paraméter2=érték2}}

Névtérválasztás[szerkesztés | forrásszöveg szerkesztése]

Több oka is van, amiért a sablonjainkat célszerű a Sablon: névtérben elhelyezni, és ha nincs nyomós okunk másként tenni, akkor illik ehhez a szokáshoz tartanunk magunkat:

  • Csak a sablonnévtérben levő sablonok beillesztésekor hagyható el a névtér a sablon nevéből.
  • Csak a sablonnévtérben elhelyezett sablonok módosítása üríti ki az összes őket tartalmazó lapot a szerver gyorsítótárából, biztosítva ezzel a percre kész megjelenésüket.
  • A külön sablonnévtér használata áttekinthetővé teszi a Wikipédiát.
  • A szócikknévtérhez hasonlóan ebben a névtérben is be van kapcsolva a lapváltozatok ellenőrzése, így a sablonjaink bizonyos fokig védve vannak a vandalizmustól és kísérletezéstől.

Egy jellemző kivétel ez alól a szabály alól az allapok használata sablonként.

Allapok használata sablonként[szerkesztés | forrásszöveg szerkesztése]

Közösségi lapokon, vitalapokon szokás egyes témákat, megbeszéléseket, szavazásokat, illetve a tudnivalókat tartalmazó lapfejlécet sablonként beilleszteni allapokról. Ezáltal a főlap szerkesztéskor mindig áttekinthető marad, és az összetartozó lapokat is közös néven tarthatjuk, később pedig az archívumokban való turkálás nélkül is könnyen megtaláljuk. Gondoltad volna például, hogy a gyakran elburjánzó Wikipédia:Törlésre javasolt lapok vagy a Wikipédia:Javaslat tisztségviselők megválasztására lap valójában milyen rövid, ha megnyitjuk szerkesztésre?

Alkalmazására példa:

{{Wikipédia:Törlésre javasolt lapok/abcd}}

Figyelem! Ezt a módszert a szócikkeknél nem alkalmazzuk.

Sablontípusok[szerkesztés | forrásszöveg szerkesztése]

Navigációs sablonok[szerkesztés | forrásszöveg szerkesztése]

A navigációs sablonok az egy témakörhöz tartozó cikkeket gyűjtik össze, hogy könnyebb legyen eligazodni, navigálni a cikkek között.

Két típusa van, a {{navbox}}(?) és a {{navoszlop}}(?):

  • A navbox olyan navigációs sablon, mely a szócikkek alján helyezkedik el, ezek általában azonos témákhoz tartozó szócikkeket gyűjtenek össze, pl. a {{Quentin Tarantino}} sablon a filmrendező filmjeit, az {{Európai fővárosok}} sablon Európa fővárosait.
  • A navoszlopok a navboxok variációi, itt a kisebb témaköröket lehet például felsorolni egy nagy témakör alá. Ilyen például a magyar helyesírás témaköreit összefoglaló {{helyesírás}}(?) sablon. A navoszlopok a szócikkben jobb oldalt jelennek meg.

Infoboxok[szerkesztés | forrásszöveg szerkesztése]

Minta település
Becenév: Minta becenév
Mottó: Minta mottó
Közigazgatás
Ország  Magyarország
Régió Minta régió
Megye Pest
Kistérség Minta kistérség
Jogállás város
Népesség
Teljes népesség ismeretlen +/-
Földrajzi adatok
Időzóna CET, UTC+1

A paraméterekkel rendelkező sablonok bonyolultabb formái az ún. infoboxok, ezek a szócikkek jobb oldalán elhelyezett, fő adatokat összefoglaló, színes dobozok. Előnyük, hogy egységesen lehet megadni információt azonos típusú, de más tartalmú adatokkal. Jobb oldalt példát láthatsz az infoboxokra: a {{magyar település infobox}}(?) néhány kitöltött paraméterrel. Az infoboxok segítenek kialakítani a szócikkek egységes, de informatív kinézetét.

Ez a kód kerül a szócikkbe:

{{Magyar település infobox
|név                 = Minta település
|mottó               = Minta mottó
|becenév             = Minta becenév
|régió               = Minta régió
|megye               = Pest
|kistérség           = Minta kistérség
|rang                = város
...
}}

Az infoboxok egy igen speciális típusai a taxonok rendszertani helyét szemléltető taxoboxok, melyek használatáról bővebben a {{Taxobox}}(?) oldalon olvashatsz.

Egyéb sablonok[szerkesztés | forrásszöveg szerkesztése]

A szócikkekben az infoboxokon és a navigációs sablonokon kívül lehetnek még más sablonok is elhelyezve, ezekre néhány gyakorlati példa:

A vitalapokon más jellegű sablonokat használunk:

  • a {{cikktörténet}}(?) sablon például összefoglalja a szócikkel történt változtatásokat (kiemelési eljárás, főoldali szereplés, vitalaparchívumok linkje)
  • az {{archívum}}(?) sablon segítségével lehet archíválni a túlságosan hosszúra nyúlt vitalapokat úgy, hogy továbbra is látható módon megmaradjon a vitalap korábbi tartalma, és ne a laptörténetből kelljen böngészni.
  • a különféle segélysablonokkal lehet a szerkesztők figyelmét a vitalapon felvetett, a szócikkel kapcsolatos problémákra; a {{tartalmi segély}}(?) sablon például akkor használható, ha olyan tartalmi problémát tesz szóvá valaki, amin mindenképpen segíteni kéne, mert a cikk színvonalát nagyban rontja, amíg nincs megoldva.

A közösségnek szóló oldalakon (Wikipédia-névtér) speciális sablonokat használunk, például az {{irányelv}}(?) sablon arra figyelmeztet, hogy az oldal, amit épp olvasol, a közösség szavazással elfogadott irányelve.

A szerkesztői oldalakon szerepelhetnek figyelmeztető jellegű sablonok, például {{blokkolt azonosító}}(?) - ezeket általában az adminisztrátorok helyezik el. A szerkesztők saját maguk is helyezhetnek el sablonokat, például különféle userboxokat, melyek különféle jellemzőket, tulajdonságokat, állításokat tartalmaznak a szerkesztőre vonatkozóan, például a {{Userbox/Star Trek}} sablont, ha kihelyezed a szerkesztői lapodra, arra hívod fel a többiek figyelmét, hogy kedveled a Star Trek című sorozatot.

A szerkesztői vitalapokon sajátos sablonok helyezhetőek el. Ilyenek például az üdvözlősablonok, melyek segítségével új felhasználókat lehet üdvözölni. Az {{archívum}}(?) sablon itt is használható a vitalap tartalmának megőrzéséhez. Ide helyezendőek a szerkesztőt figyelmeztető sablonok is, például ha valaki más weblap tartalmát másolta be szócikknek, akkor a {{subst:Nemásolj}} sablonnal lehet figyelmeztetni. A szerkesztői vitalapokon használatos üdvözlő- és figyelmeztető sablonokat mindig subst: előtaggal kell elhelyezni.

Sablon idézése más lapokon[szerkesztés | forrásszöveg szerkesztése]

Ha csak prezentálni szeretnénk egy sablon megjelenését, vagy csak fel akarjuk rá hívni a figyelmet, a következőképpen járjunk el:

  • Az {{sl}}(?) sablon segítségével készíthetsz olyan hivatkozást, amiből egyértelmű, hogy sablonról van szó, rá is mutat a sablon oldalára, és kis emelt kérdőjellel – ha van – az illető sablon dokumentációját is belinkeli (ha a Látszert az egérrel a kérdőjel fölé visszük, meg is mutatja a dokumentáció első bekezdéseit):
    {{sl|akármi}}
    

Új sablon készítése[szerkesztés | forrásszöveg szerkesztése]

Egy új üzenet létrehozásához egyszerűen hozz létre egy Sablon névtérbeli hivatkozást, mint például [[Sablon:Teszt]], és szerkeszd a lapot úgy, hogy az általad kívánt szöveget tartalmazza.

  1. Mielőtt létrehozol egy új sablont, jól gondold át, milyen nevet adsz neki, hogy a lehető legrövidebben és legpontosabban mutassa, hogy mire való a sablon. Az elnevezés legyen rövid, de egyértelmű. A név igazodjon a magyar helyesírás szabályaihoz, például a Sablon:Repcsigeptip helyett a Sablon:Repülőgéptípus infobox a helyes név, amennyiben infoboxról van szó.
  2. Mielőtt sablonkészítésre adnád a fejed, nézd meg a Kategória:Sablonok kategóriában, vagy hasonló témájú szócikkekben, hogy nincs-e már hasonló sablon készen. A sablonduplikátumok nem segítik az egységes kinézet és tartalom politikáját.
  3. Fontold meg, milyen rövidítést érdemes alkalmazni, és hivatkozz a főlapon az átirányításokra a {{rövidítés}}(?) sablon segítségével! Jó ha egy sablonnak van egy teljesen érthető, magyar neve, és egy könnyen memorizálható rövid neve, amiről átirányítás vezet a teljes, hivatalos névhez. (Ezeket utóbb bot fogja javítani a megfelelő lapokon.)
  4. A sablonegységesítés és egységes sablonhasználat szellemében, ahelyett, hogy egy az egyben átveszel egy sablont más Wikipédiákból, inkább készíts egy új sablont a {{navbox}}(?), {{navoszlop}}(?) és {{infobox}} használatával. Ha segítség kell a Wikipédia:Kocsmafal (műszaki) oldalon kérhetsz. Az angol paraméternevű, sokféle és bonyolult kóddal dolgozó sablonok helyett az áttekinthető és egységes saját sablonjaink sokkal jobbak, könnyebben kezelhetőek és javításukhoz, bővítésükhöz nem kell szakavatott sablongurunak lenni.

A sablonok kipróbálására használd a Sablonhomokozót vagy egy saját allapot!

Csak emlékeztetőül: ezután a teszteléshez egy másik oldalra, például a Homokozóba a {{Sablonhomokozó}} szöveget kell beillesztened.

Sablondokumentáció és kategorizálás[szerkesztés | forrásszöveg szerkesztése]

Készíts az új sablonhoz dokumentációt! Ez azért nagyon fontos, hogy mindenki pontosan láthassa, mire és hogyan használható egy adott sablon. A sablondokumentáció leírja a sablon célját, a használat módját, és mintát is közöl a sablonról, illetve egy szócikkbe másolható mintát is mutat. Ez különösen a paraméteres sablonok esetében nagyon hasznos, mivel megkönnyíti azok gyors bemásolását a szócikkbe. Bonyolultabb sablonok esetén az egyes paraméterek külön magyarázatát is ide lehet leírni. A sablondokumentáció képes kezelni a sablon kategóriáit és wikiközi hivatkozásait is.

A sablondokumentáció pontos készítésének módjáról itt olvashatsz: Wikipédia:Sablondokumentáció

Ne felejtsd el a sablont elhelyezni a megfelelő kategóriában, lehetőleg a sablondokumentáció megfelelő szakaszában, és ne a sablon oldalán magán. Ha mégis ott helyezed el, ne felejtsd el <noinclude></noinclude> kód közé tenni.

Sablonmester[szerkesztés | forrásszöveg szerkesztése]

A Sablonmester működés közben

A Sablonmester egy olyan kiegészítő alkalmazás, mely a szerkesztőablak menüsorába beépülve megkönnyíti a sablonok használatát, hiszen nem kell külön ablakban megnyitni a sablonokat ahhoz, hogy be tudjuk másolni a dokumentációból a mintát.

A sablonmestert a Beállításaim menü Segédeszközök fülében lehet bekapcsolni. A sablonmesterrel használható sablonok listáját ide kattintva találod meg. Az egyes sablonok oldalain külön figyelmeztetés található, ha a sablon használható Sablonmesterrel.

Sablonok törlése[szerkesztés | forrásszöveg szerkesztése]

Sablont azonnali törlésre jelölni csak úgy szabad, ha egyetlen lapon sincs beillesztve!

Lásd még[szerkesztés | forrásszöveg szerkesztése]

Az összes sablon[szerkesztés | forrásszöveg szerkesztése]

Az összes sablon listája itt található meg.