Aide:Gadgets

Cette fonctionnalité n'est pas disponible par défaut, mais elle peut être activée sur requête.

Les gadgets fournissent du CSS et JS personnalisés aux utilisateurs qui choisissent de les utiliser. Contrairement aux CSS et JS de la communauté, qui sont chargés pour tous les utilisateurs, les CSS et JS des gadgets ne sont vus que par les utilisateurs qui ont activé le gadget. Les gadgets sont spécifiques à chaque communauté ; les utilisateurs peuvent les activer ou les désactiver dans leur préférences dans « Gadgets ».

Un exemple de section Gadgets dans Spécial:Préférences

Les gadgets sont un moyen de fournir aux utilisateurs des expériences facultatives à l'échelle du site. Cependant, gardez à l'esprit que les utilisateurs anonymes ne peuvent pas activer les gadgets ou désactiver les gadgets activées par défaut.

Demander l'extension

Par défaut, la plupart des communautés de Fandom n'utilisent pas de gadgets. Les gadgets sont alimentés par une extension ; toute communauté qui souhaite utiliser des gadgets doit contacter un Représentant de Wiki sur Discussions pour demander l'activation de l'extension sur cette communauté.

Liste des gadgets

Un exemple de Spécial:Gadgets

Pour voir la liste des gadgets d'une communauté, allez sur Spécial:Gadgets. Cette page spéciale fournira également des liens pour modifier la description des gadgets, affichera une liste des fichiers utilisés par chaque gadget et montrera tous les droits requis par chaque gadget. Notez que vous ne pouvez pas activer ou désactiver les gadgets sur cette page ; vous devez aller dans Spécial:Préférences pour activer ou désactiver les gadgets que vous utilisez.

Les wikis dont l'extension Gadgets n'est pas activée afficheront une page d'erreur sur Spécial:Gadgets, car elle n'existe pas.

Créer un gadget

Définition du gadget

Un exemple de définition de MediaWiki:Gadgets

La première étape de la création d'un gadget est de le définir. Pour ce faire, modifiez MediaWiki:Gadgets-definition sur votre communauté. Chaque gadget est défini par une entrée dans une liste à puces, donc chaque ligne doit commencer par *. Le formatage de la définition des gadgets est le suivant :

* nom_du_gadget [options] | fichier1 | fichier2 | etc.

• nom_du_gadget doit être unique et est sensible à la casse. Il doit commencer par une lettre latine de base ([A-Za-z]) et peut être suivi d'un nombre quelconque de lettres, de chiffres ([0-9]), de tirets (-), de soulignements (_), de deux points (:) et de points (.).
• Voir § Options du gadget pour une explication sur les options.
• Voir § Fichiers du gadget pour une explication sur file1, file2, etc.

Si votre wiki comporte de nombreux gadgets, il peut être utile de diviser la liste en sections en utilisant des ==en-têtes==. Par exemple, la liste suivante de quatre gadgets est divisée en deux sections : utilitaires et visuel. Comme les noms de gadgets, les titres de sections sont également sensibles à la casse et doivent être uniques.

==Utilitaires==
* Utilitaire1 [ResourceLoader] | NiceUtility.js
* Utilitaire2 [ResourceLoader|rights=rollback] | RollbackUtil.js | RollbackUtil.css

==visuel==
* Thème1 [type=styles] | CoolTheme.css
* Thème2 [type=styles] | FireTheme.css

Description du gadget

Par défaut, les utilisateurs verront votre gadget présenté dans Spécial:Préférences sous la forme ⧼gadget-nom_du_gadget_name⧽. Il ne 'agit pas d'une description très utile. Vous pouvez modifier cette description en allant dans MediaWiki:Gadget-nom_du_gadget sur votre wiki. Vous pouvez également vous rendre sur la liste des gadgets dans Spécial:Gadgets et cliquer sur le lien "Modifier" à côté de chaque définition de gadget.

Les descriptions des gadgets doivent être raisonnables. Une description utile explique tout ce que l'utilisateur verra différemment ou aura accès s'il active le gadget. N'oubliez pas que les gadgets ont pour but de donner à vos utilisateurs la possibilité de modifier leur expérience. Pour ce faire, ils ont besoin d'informations précises.

Les titres de section peuvent également être modifiés pour être plus conviviaux. Dans l'exemple ci-dessus, pour modifier l'intitulé utilités, il suffit d'aller dans MediaWiki:Gadget-section-utilités ou de cliquer sur le lien "Modifier" à côté de l'intitulé de la section dans Spécial:Gadgets.

Options du gadget

La définition d'un gadget peut inclure des options qui précisent davantage comment charger le gadget ou qui peut l'activer. Chaque option doit être séparée par un caractère barre verticale |. Les options qui ne prennent aucun paramètre, comme ResourceLoader, peuvent simplement être incluses seules ; les options qui prennent des paramètres doivent être incluses avec un signe égal suivi d'une liste de paramètres séparés par des virgules, comme rights=rollback,delete.

Le tableau ci-dessous énumère les options de gadgets disponibles pour les communautés Fandom.

Nom	Paramètres	Description
ResourceLoader	Aucun	Marque les scripts du gadget comme étant compatibles avec ResourceLoader. Cette option est requise pour tout gadget qui charge au moins un fichier JS, sinon Spécial:Gadgets affichera une erreur et le JS ne se chargera pas.
dependencies	Noms des modules ResourceLoader séparés par des virgules	Notez que cette option n'a aucun effet si le gadget ne possède aucune ressource compatible avec ResourceLoader (c'est-à-dire aucun style et aucun script non marqué comme compatible).
rights	Noms de privilèges séparés par des virgules	Désactiver et masquer le gadget dans les préférences pour les utilisateurs qui ne disposent pas de ces privilèges. Notez que les droits des utilisateurs ne sont pas des groupes d'utilisateurs ; la liste complète des droits des utilisateurs est disponible à l'adresse Spécial:Liste des droits de groupe.
default	Aucun	Tout gadget défini par défaut DOIT adhérer à les règles de personnalisation. Active le gadget par défaut pour tout le monde, y compris les utilisateurs anonymes. Seuls les utilisateurs enregistrés peuvent désactiver ce gadget.
type	styles ou general	Utilisez type=styles pour les gadgets qui ne chargent que des fichiers CSS. Cela chargera le CSS par le biais de la page HTML, ce qui est plus rapide que le comportement de chargement JavaScript par défaut. Notez que type=styles ne chargera pas de fichiers JS dans le gadget.

Fichiers du gadget

Le gagne-pain d'un gadget sont les fichiers qu'il charge lorsqu'il est activé. Chaque page CSS ou JS qu'un gadget charge doit être préfixée par MediaWiki:Gadget-. Dans l'exemple ci-dessus, Utilitaire2 définit deux fichiers, "RollbackUtil.js" et "RollbackUtil.css", qui se trouvent respectivement dans MediaWiki:Gadget-RollbackUtil.js et MediaWiki:Gadget-RollbackUtil.css. Une bonne règle de base est d'utiliser le même nom pour le gadget et les fichiers, mais, comme nous l'avons montré, ce n'est pas une obligation.

À part le préfixe Gadget-, les fichiers CSS et JS du gadget fonctionnent comme n'importe quel autre fichier CSS ou JS. À ce titre, veuillez noter que les fichiers JS de gadgets doivent être approuvés par le Processus de vérification du JavaScript avant d'être mis en ligne pour tout le monde. En termes d'ordre de chargement, les gadgets sont chargés après les autres codes de la communauté locale, mais avant le code personnel.

Un gadget peut charger autant de pages que souhaité, mais il est rare de charger plus d'une page JS et une page CSS. Chaque fichier doit être précédé dans la définition du gadget par un caractère barre verticale |. Toute page CSS ou JS d'un gadget peut également être chargée par plusieurs gadgets.Comme les autres pages du site, les gadgets ne peuvent être écrits qu'en utilisant du JS ou du CSS.

Voir aussi

• Extension:Gadgets – sur MediaWiki.org, sur laquelle est basée cette page.
• Aide:Extensions – Un guide à propos de toutes les extensions proposées par Fandom.

Plus d'aide

• Parcourez et recherchez d'autres pages d'aide sur Aide:Contenu
• Visitez le Centre des communautés pour plus d'aide
• Consultez Aide:Contacter Fandom pour savoir comment signaler des erreurs ou des points à éclaircir sur cet article