Aide:Créer des gadgets

Les administrateurs peuvent définir des gadgets utilisables par tous les utilisateurs, grâce à l’extension PHP installée par Bugzilla. Un gadget est un ensemble de scripts (Javascript et feuilles de style CSS) permettant d'ajouter une fonctionnalité ou de personnaliser l'interface.

Certains gadgets avancés peuvent nécessiter un paramétrage via l'utilisation de scripts personnels (Voir Personnaliser l'interface).

Points techniques

La création de gadgets exige quelques connaissances techniques. Voir les livres suivants :

• Programmation JavaScript pour la programmation Javascript (*.js),
• Le langage CSS pour les feuilles de style (*.css),
• Le langage HTML pour la manipulation/génération des balises HTML par script.

Il est également utile de connaître l'ordre dans lequel les scripts sont lus et exécutés par le navigateur :

1. Les gadgets en premier,
2. Ensuite les scripts communs MediaWiki:Common.css et MediaWiki:Common.js,
3. Puis les scripts de l'habillage (MediaWiki:Monobook.css et MediaWiki:Monobook.js pour Monobook),
4. Enfin, les scripts personnels (Utilisateur:nom/monobook.css et Utilisateur:nom/monobook.js, pour l'habillage Monobook).

Seuls les administrateurs sont autorisés à ajouter de nouveau gadgets, car ceux-ci doivent respecter quelques critères : fonctionner avec la plupart des navigateurs, réelle utilité afin de limiter la liste des gadgets disponibles.

Création du gadget

Un gadget utilise plusieurs scripts (Javascript et feuilles de style CSS).

L'utilité de diviser un gadget en plusieurs scripts Javascript est de pouvoir réutiliser certaines fonctions génériques avec d'autres gadgets.

Le script du gadget peut dans un premier temps être placé dans le script personnel. Pour mettre au point un gadget, il peut être utile d'activer le gadget de débuggage de scripts.

Une fois que le gadget est au point, il peut être publié pour le rendre disponible dans la page des préférences.

Publier le gadget

Publier un gadget consiste à modifier certaines pages spéciales pour le rendre disponible dans la page des préférences de tous les utilisateurs.

Un gadget possède :

• un nom unique permettant d'identifier les fichiers qui le compose,
• un descriptif court visible dans la page des préférences et la page spéciale des gadgets,
• un ensemble de fichiers définissant les scripts Javascript et feuilles de style CSS.

De plus, il est placé dans une section. Une section possède :

• Un nom unique,
• Une description visible dans la page des préférences et la page spéciale des gadgets.

La publication d'un gadget suit les étapes suivantes, décrites ci-après :

1. Nommer les fichiers du gadgets,
2. Créer la description courte du gadget,
3. Si nécessaire, créer la description d'une nouvelle section,
4. Déclarer le gadget et la liste des fichiers utilisés.

Les fichiers du gadget

Tous les fichiers utilisés par le gadget doivent avoir un nom commençant par "MediaWiki:Gadget-" suivi du nom unique du gadget, et de l'extension appropriée (.js pour du Javascript, .css pour du CSS).

Exemple : Le gadget nommé CoinsArrondis utilise la feuille de style MediaWiki:Gadget-CoinsArrondis.css.

Description du gadget

La description du gadget est contenue dans la page dont le nom commence par "MediaWiki:Gadget-" suivi du nom unique du gadget.

Exemple : La description du gadget nommé CoinsArrondis est définie dans la page MediaWiki:Gadget-CoinsArrondis.

Description de section

Un gadget appartient à une section dont la description est contenue dans la page dont le nom commence par "MediaWiki:Gadget-section-" suivi du nom unique de la section.

Exemple : La description de la section General est définie dans la page MediaWiki:Gadget-section-General.

Déclarer le gadget

La page MediaWiki:Gadgets-definition contient la définition de tous les gadgets.

Chaque ligne de cette page doit avoir l'une des syntaxes suivantes :

== section ==

Début d'une section.

# commentaire

Une ligne commençant par # est un commentaire. Toute la ligne est ignorée. Cette syntaxe permet de désactiver certains gadgets défectueux temporairement.

* nom|fichier|fichier...

Une ligne de définition de gadget. Cette ligne commence par une étoile, suivi du nom unique du gadget, suivi d'une liste de nom de fichier précédé d'une barre verticale. Les noms de fichier apparaissent sans le préfixe "MediaWiki:Gadget-".

Exemple :

# La version actuelle de MediaWiki ne supporte pas les noms de gadget et section comportant des caractères spéciaux ou accentués

== General ==
* CoinsArrondis|CoinsArrondis.css
* FlecheHaut|FlecheHaut.js
* DirectPageLink|Common.js|DirectPageLink.js

Procédure

Pour simplifier la publication, il est recommandé de :

1. Commencer par déclarer le gadget dans MediaWiki:Gadgets-definition, en créant si besoin une nouvelle section,
2. Aller sur la page spéciale des gadgets,
3. Créer les différentes pages dont le lien apparaît en rouge sur cette page spéciale (description de gadget et de section, fichiers utilisés par le gadget).

Exemples

Catégorie:MediaWiki:Fonction Monobook en JavaScript