Definice „udělátka” - gadgetu

Každá řádka na stránce MediaWiki:Gadgets-definition, která začíná znakem "*" (hvězdička – asterisk), se interpretuje jako definice „udělátka” (gadgetu) a může vypadat kupř. takto:

* mygadget [parametry] | názvy stránek se snippety

První pole (v příkladu "mygadget") je interní název gadgetu. Popisek stránky nastavení pochází ze stránky s rozhraním (MediaWiki:Gadget-mygadget), kam lze napsat vlastní název a krátký popis, což také umožňuje použití wikitextového značení.

Parametry:

[ResourceLoader | parametr1 | parametr2 | ... parametrN]

Příznak ResourceLoader je povinný, pokud gadget neobsahuje pouze styly. Možnosti, které jsou "flags" (vlajky, praporky), stačí mít k zapnutí napsaný pouze jejich název. Za možnostmi, které vyžadují hodnotu, následuje znaménko rovnosti a seznam hodnot oddělených čárkami. Všechny prázdné znaky jsou volitelné a lze je vynechat.

[ResourceLoader | myflag | mykey = value1, value2, value3 ]

Příklady:

* mygadget[ResourceLoader]|mygadget.js|mygadget.css

nebo

* mygadget[ResourceLoader|package]| mygadget.js | mygadget-Foo.js | mygadget-data.json | mygadget.css

nebo

* mygadget[ ResourceLoader | rights=foo, bar ] | mygadget.js | mygadget.css

{
	"settings": {
		"rights": [ "foo", "bar" ],
		"default": false,
		"package": false,
		"hidden": false,
		"skins": [],
		"actions": [],
		"category": ""
	},
	"module": {
		"scripts": [ "mygadget.js" ],
		"styles": [ "mygadget.css" ],
		"datas": [],
		"peers": [],
		"dependencies": [],
		"messages": [],
		"type": ""
	}
}

Parametry

Pro své gadgety můžete zadat další závislosti, například:

* mygadget[ResourceLoader|dependencies=jquery.ui, jquery.effects.clip]|mygadget.js|mygadget.css

Zde požádáme ResourceLoader, aby načetl moduly jquery.ui a jquery.effects.clip s kódem mygadget. Upozorňujeme, že gadgety nemohou záviset na skriptech ze stránek, statických souborech nebo externích URL adresách, pouze na modulech, které jsou již registrovány v ResourceLoaderu. Aby skript ze stránky závisel na jiném skriptu ze stránky, měl by být každý z nich gadget, který se zaregistruje jako modul v ResourceLoaderu. Poté lze pomocí následující syntaxe nastavit závislosti:

* childgadget[ResourceLoader|dependencies=ext.gadget.parentgadget]|childgadget.js

Chcete-li povolit miniaplikaci ve výchozím nastavení, použijte "default":

* mygadget[ResourceLoader|default|dependencies=mediawiki.util]|mygadget.js|mygadget.css

* ImprovedDeletion [rights=delete] | ImprovedDeletion.js

Díky tomu je gadget k dispozici pouze uživatelům, kteří mohou stránky mazat.

Upozorňujeme, že omezení jsou založena na oprávněních, nikoli na uživatelských skupinách, jako jsou administrátoři nebo byrokraté. Zde je několik skutečných příkladů:

* modrollback [ResourceLoader |rights=rollback] |modrollback.js
* geonotice [ResourceLoader |default |rights=viewmywatchlist] |geonotice.js
* Ajax_sysop [ResourceLoader |rights=patrol, rollback, markbotedits, delete]|Ajax_sysop.js

Uživatelská práva

$wgGroupPermissions['interface-admin']['gadgets-edit'] = true;
$wgGroupPermissions['interface-admin']['gadgets-definition-edit'] = true;

Stránky

Zbývající pole v řádku definice odkazují na zdrojové stránky JavaScriptu, CSS nebo JSON, které tvoří modul gadgetu. Ty jsou uloženy ve jmenném prostoru MediaWiki jako zprávy rozhraní (v tomto příkladu MediaWiki:Gadget-mygadget.js a MediaWiki:Gadget-mygadget.css). Názvy stránek musí končit na ".css", ".js" nebo ".json".

Gadget může používat libovolný počet zdrojových stránek, např.:

 * frobinator[ResourceLoader]|frob.js|frob.css|pretty.css
 * l33t[ResourceLoader]|l33t.js
 * foobar[ResourceLoader|package]|foo.js|bar.js|foobar-data.json

Upozorňujeme, že pokud váš kód obsahuje řetězce, které by mohly být interpretovány jako syntax wiki (např. kód podpisu ~~~~), můžete kód uzavřít do ‎<nowiki>...‎</nowiki> a tyto tagy umístit do komentářů JavaScriptu nebo CSS, aby nebyly při použití interpretovány.

Příklad viz 12. a poslední řádek kódu MediaWiki:Gadget-formWizard-core.js.

Sekce

Seznam miniaplikací v MediaWiki:Gadgets-definition lze rozdělit do sekcí pomocí řádků, které začínají a končí dvěma nebo více znaky "=" (rovná se), a které uzavírají název systémové zprávy definující název sekce, například:

 == interface-gadgets ==
 ...
 == editing-gadgets ==
 ...

Tím by se definovaly dvě nové sekce s názvy definovanými na stránkách MediaWiki:Gadget-section-interface-gadgets a MediaWiki:Gadget-section-editing-gadgets.