Wikipédia:Sablonmester

Működés közben

Rövidítése:
WP:SM

A Sablonmester egy kiegészítő, segítségével az oldalakon levő sablonokat lehet szerkeszteni, kényelmes felületen, anélkül, hogy ismernéd, melyik paraméter mire való.

Telepítés

A Sablonmester egy JavaScript nyelven írt alkalmazás. Ahhoz, hogy használhasd, a monobook.js-edbe kell beillesztened az alábbi sort:

document.write('<script type="text/javascript" src="http://hu.wikipedia.org/w/index.php?title=User:Bdanee/sm.js&action=raw&ctype=text/javascript&dontcountme=s"> <\/script>');

A kiegészítő sikeresen lett tesztelve Firefox 2, Opera 9 és Internet Explorer 7 alatt, Monobook kinézettel.

Működése

A telepítés után a szerkesztőeszköz-sor elején (ha ki van kapcsolva, akkor is) található egy gomb „SM” felirattal. Ezzel lehet előhívni az űrlapot.

Új sablon beillesztése

Először vidd a kurzort a megfelelő pozícióra. Ezután két lehetőség van:

1. Írj egy üres sablont a szövegbe: {{Sablon neve}}, belekattintasz, vagy odaviszed a kurzort, és az SM-gombra kattintasz.
2. Rögtön kattints az SM-gombra, ennek hatására megjelenik az alkalmazás, kitöltendő űrlap nélkül. A Sablon mezőbe kell beírni a kívánt sablon nevét. Az enter letütése után már meg is jelenik az adott sablonhoz tartozó űrlap.

Meglévő sablon szerkesztése

Meglévő sablon szerkesztéséhez a kurzort a sablon szövegén belülre kell vinned. A program megkeresi a szerkeszteni kívánt sablon nevét, betölti az űrlapot és kitölti a mezőket a forráskódban található értékekkel.

A sablonszövegben található ismeretlen paraméterek is megmaradnak, ezek – ha van ilyen – felül találhatóak meg egy zöld színű gombsorként. Ha egy paraméter nevében írási hibát vétettek, akkor a probléma egy kattintással orvosolható, hiszen a gombok segítségével az ismeretlen paraméterek értéke beilleszthető a kívánt helyre, csupán bele kell kattintani a megfelelő mezőbe.

A szerkesztés befejezése

Ha kész vagy a szerkesztéssel, és szeretnéd elmenteni a sablonszövegben található változásokat, akkor kattints az „Elküld” gombra. A „Mégse” gomb használatával a változások nem mentődnek, és az eszköz bezárul.

Ha a Sablonmester elindítása után kattintasz az SM-gombra, akkor szöveget tudsz másolni a szócikk szövegéből, és egy újabb kattintással visszatérhetsz az űrlaphoz. (Kilépni nem ezzel lehet, hanem az Elküld vagy a Mégse gombbal!)

Mely sablonokkal használható?

Azt, hogy a Sablonmester mely sablonokkal használható, azaz melyikhez létezik már XML-leírás, a Sablonmesterrel használható sablonok kategóriában találhatod meg.

Fejlesztőknek

Ahhoz, hogy egy sablont ezzel az eszközzel használni lehessen, egy XML-leírásra van szükség (egy allapon, Sablon:Név/XML formában).

Ezen a címen(JavaScript) a német Benutzer:Revolus készített egy eszközt, melynek segítségével a sablon vázából XML-leírást lehet készíteni.

Az XML-sablonleírás felépítése és jelentése

A leírás az alábbi módon épül fel (csak a kötelező attribútumokkal):

 <TemplateUsage>
   <Group>
     <Parameter name="Címl" />
 
     <Parameter name="ISBN">
       <Help>Az ISBN-szám az előtte álló ISBN nélkül.</Help>
     </Parameter>
 
     <Parameter name="Hónap">
       <Value>Január</Value>
       <Value>Február</Value>
       ...
     </Parameter>
     ...
   </Group>
   ...
 </TemplateUsage>

Beillesztett szövegben, például a Help, Condition és Value elemeknél és az attribútumok, például a name vagy label esetében az alábbi karaktereket kell helyettesíteni, hogy az XML-dokumentum érvényes maradjon:

Karakter	Helyettesítés
&	&
<	&lt;
>	&gt;
"	&quot;
'	&apos;

A következő táblázattartalmazza az összes elemet és azok attribútumait. A nagy- és kisbetűknek meg kell egyezniük. Az opcionális elemek ill. attribútumok (nem kötelező) jelzéssel vannak ellátva. Az attribútumok elöre beállított (default) értékeit nem kell megadni.

Elemnév	Attribútum	Leírás
TemplateUsage		Gyökérelem, ez tartalmazza a leírást
	output	(nem kötelező) – Szabályozza, hogy hogyan nézzen ki a sablonszöveg elmentés után.
	output="collapse"	(alapértelmezett) – Ebben az esetben a sablon egy sorban fog elhelyezkedni.
	output="expand"	Ennél minden paraméter külön sorban helyezkedik el.
Group		A paraméterek egy halmazát foglalja magába. Az űrlapon mindegyik külön területen fog szerepelni. Ha a csoportosítás nem célszerű, akkor az összes paramétert egyetlen csoportba kell belerakni.
	name	(nem kötelező) – Leírja a csoport tartalmát. Ha van értéke, akkor csoportcímként fog megjelenni.
Parameter		A sablon egy paraméterének leírását tartalmazza. Csak a „Group” elem tartalmazhatja.
	name	A paraméter neve.
	label	(nem kötelező) – Másodlagos leírás, ez fog megjelenni a paraméter neve helyett az űrlapon. Például: „ISBN-szám” „isbn” helyett.
	length	(nem kötelező) – A szövegmező maximális hossza. Utóbbinak megadásánál a paraméter egy egész sort fog elfoglalni.. Sinnvoll ist die Angabe bei Parametern mit inhaltlich begrenzter Länge, wie Höhen- und Geschwindigkeitsangaben, und bei Parametern, denen in der Regel sehr lange Texte übergeben werden. Vorgabe sind 20 Zeichen.
	height	(nem kötelező) – A szövegbeviteli mező magassága. Az alapértelmezett értéke egy.
	null	(nem kötelező) – Meg lehet adni, hogy a paraméter kötelező legyen-e, vagy sem.
	null="true"	(alapértelmezett) – Az üres érték endedélyezett, nem kötelező értéket megadni.
	null="false"	A mező kitöltése kötelező. A paraméter neve az űrlapon aláhúzva látható. Az elküldés előtt a program megvizsgálja, hogy van-e érték neki megadva, és ha nem, akkor jelez.
Condition		(nem kötelező) – Egy reguláris kifejezést tartalmazhat, a paraméter értékének ennek kell megfelelnie. Az elküldés előtt a program megvizsgálja, hogy van-e érték neki megadva, és ha nem, akkor jelez. Csak a „Parameter” elem tartalmazhatja.
Default		(nem kötelező) – A „Paraméter” elem ezen eleme azt az értéket tartalmazza, amellyel a mező mindig fel lesz töltve, ha az üres.
Help		(nem kötelező) – A súgószöveget tartalmazza, amely a paraméter használatáról, az értékek megadásával kapcsolatban tartalmaz információt. Az űrlapon ez látható az állapotsoron, amikor a hozzátartozó mező aktív. Továbbá a súgószöveg tooltipként is megjelenik. Csak a „Parameter” elem tartalmazhatja.
Value		(nem kötelező) – Egy lehetséges választ tartalmaz. Az űrlapon a szövegmező helyett több adatnál egy legördülő lista jelenik meg, az összes lehetséges értékkel. Csak a „Parameter” elem tartalmazhatja.
	label	(nem kötelező) – Másodlagos név, ez fog megjelenni az űrlapon. Például „MediaWiki” „mw” helyett.

A leírás tesztelése és beillesztése

A sablon leírása az /XML allapon található. A sablon olvashatósága miatt az első sor kivételével minden sornak egy szóközzel kellene kezdődnie.

<?xml version="1.0" encoding="utf-8"?>
<!--                                                                    -->
<!-- Ez egy XML-leírás a Sablonmesterhez. -->
<!--                                                                    -->
<?mediawiki "{{XML-Figyelmeztetés|Sablon neve}}"?>
 <TemplateUsage ...>
 ...
 </TemplateUsage>

A sablon a Sablon:XML-Figyelmeztetéssel kibővítendő. Ez a sablon hivatott a szerkesztőket az XML leírás meglétéről informálni és egy linket biztosítani az XML leírás online történő ellenőrzéséhez.

Nagyobb módosítások tesztelésénél mindenképp egy, a saját névtérben lévő, allapot ajánlott használni, mivel a módosítások és egyben esetleges hibák a többi felhasználónál is jelentkezhetnek.