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, sowie während der Bearbeitung dem Wechsel zwischen der Formularansicht und der Eingabebox.

Ú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. Vorgegebene Attributwerte brauchen nicht explizit angegeben zu werden.

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. Letzere Angabe bewirkt, dass der Parameter vollständig über eine ganze Zeile gestreckt wird. 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		(optional) – Enthält einen Hilfetext, der die Verwendung des Parameters beschreibt. Im Formular wird dieser in der Statuszeile angezeigt, wenn das dazugehörige Eingabefeld aktiv ist. Des Weiteren wird die Hilfe als Tooltip angezeigt. Nur als Kindknoten von „Parameter“ erlaubt.
Value		(optional) – Erlaubt die Angabe eines Wertes, die der Parameter annehmen darf. Im Formular wird anstatt eines Texteingabefeldes bei mehreren Angaben eine Auswahlliste angezeigt, welche mit allen Value-Elementen des Parameters gefüllt ist. Existiert zu einem Parameter nur ein Value, so wird ein Ankreuzfeld (engl. Checkbox) angezeigt. Nur als Kindknoten von „Parameter“ erlaubt.
	label	(optional) – Alternative Bezeichnung, die statt des Namens im Formular angezeigt wird. Zum Beispiel: „Chefredakteur“ statt „chefred“.

Testen und Einfügen der Beschreibung

Die Vorlagenbeschreibung wird auf der Unterseite XML der Vorlagenseite hinterlegt, also Vorlage:Name/XML. Um auch in der Wikipedia eine gewisse Lesbarkeit der Vorlage zu erhalten, sollten alle Zeilen außer die erste Zeile mit einem Leerzeichen beginnen. Die erste Zeile darf hingegen so nicht beginnen.

<?xml version="1.0" encoding="utf-8"?>
<!--                                                                    -->
<!-- Dies ist die XML-Beschreibung der Vorlage für den Vorlagenmeister. -->
<!-- Mehr Infos unter [[Benutzer:Revvar/VM]].                           -->
<!--                                                                    -->
<?mediawiki "{{XML-Warnung|Name der Vorlage}}"?>
 <TemplateUsage ...>
 ...
 </TemplateUsage>

Die Vorlage selbst wird um die Vorlage:XML-Hinweis erweitert. Diese informiert die Autoren der Vorlage von der Existenz der XML-Beschreibung und bietet zusätzlich einen Link zur Online-Überprüfung der XML-Beschreibung an.

Zum Testen von größeren Modifikationen sollte unbedingt eine Unterseite des eigenen Benutzerraumes verwendet werden, da Änderungen, und damit auch Fehler, sich sofort bei anderen Nutzern auswirken können.

Validieren gegen das XML-Schema

Unter Benutzer:Revvar/VM/XML-Schema gibt es ein von Benutzer:Stf erstelltes XML-Schema für die Vorlagenbeschreibung. Damit kann überprüft werden, ob die Vorlagenbeschreibung grammatisch korrekt ist. Die Vorlage:XML-Hinweis bietet einen Link zur schnellen Online-Überprüfung der Beschreibung an.

Um die XML-Beschreibung schon offline und komfortabel am heimischen PC zu prüfen, geht man folgendermaßen vor:

Zuerst die Vorlagenbeschreibung als XML-Datei lokal speichern. Im selben Verzeichnis wie die Vorlagenbeschreibung auch das XML-Schema speichern.

1. Mit Eclipse und Web Standard Tools (WST): Dokument im Editor öffnen. XML-Schema in das Wurzelelement eintragen: <TemplateUsage xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="Revvar-VM.xsd" .... Dann Rechtsklick/Validieren (vgl. Screenshot). Eventuelle Fehler erscheinen im Probleme-Tab und werden beim Anklicken markiert.
2. Mit jEdit und XML-Plugin: Dokument im Editor öffnen. XML-Schema in das Wurzelelement eintragen (s.o.). Beim Laden und Speichern validiert jEdit automatisch; die Ergebnisse erscheinen im Fehlerfenster (unter Plugins/Error List/Error List). Beim Klicken auf einen Fehler wird die dazugehörige Stelle im Dokument markiert, vgl. Screenshot.
3. Online hier: Schema-Datei und XML-Datei auswählen und auf Validate klicken. Auf der folgenden Seite kann das Ergebnis unter Click here abgerufen werden.