Manuel:Interface/Gadgets-definition

MediaWiki:Gadgets-definition est la page qui définit les gadgets disponibles pour les utilisateurs à Gadgets, un onglet dans Special:Preferences fourni par Extension:Gadgets . Pour plus de détails, voir Extension:Gadgets .

Format

Chaque ligne de la page MediaWiki:Gadgets-definition doit commencer par un caractère astérisque "*" qui définit un gadget. La ligne a le format suivant :

* mygadget [Options] | Noms de page

Le premier champ ("mygadget" dans l'exemple) est le nom interne du gadget. Le titre de la page des préférences vient d'une page de message d'interface, où le vrai nom et une courte description peuvent être fournis et le balisage du wikicode est autorisé.

Le nom interne doit commencer par une lettre de l'alphabet latin de base ([A-Za-z]) et peut être suivie de n'importe quel nombre de lettres, de chiffres ([0-9]), de tirets (-), de traits de soulignement (_) ou de points (.). La raison de cette limitation est que le nom interne doit être aussi valide qu'un nom de formulaire HTML, qu'une clé de message d'interface MediaWiki, et qu'un nom de module ResourceLoader.

Format des options :

[ResourceLoader | option1 | option2 | ... optionN]

La marque du ResourceLoader est nécessaire sauf si le gadget ne contient que des styles. Les options qui ont le rôle de drapeau, n'ont besoin que d'avoir leur nom présent pour indiquer qu'elles sont positionnées. Les options qui nécessitent une valeur sont suivies d'un signe égal et une liste de valeurs séparées par une virgule. Tous les espaces sont facultatifs et peuvent être omis.

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

Exemples :

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

ou

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

ou

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

Sections

Gadgets-definition peut contenir des sections, mais aucune distinction n'est faite entre les différents niveaux de rubriques. Les titres ne sont pas utilisés directement pour l'affichage, mais renvoient à un message MediaWiki pour ce titre de section commençant par MediaWiki:Gadget-section-. Ainsi, ==LanguageSupport== fait référence à MediaWiki:Gadget-section-LanguageSupport, et le contenu de ce message (ou des sous-pages localisées, MediaWiki:Gadget-section-LanguageSupport/fr etc.) sera affiché à l'utilisateur dans Special:Preferences.