Extension:Gadgets/fr

Manuel des extensions MediaWiki

Gadgets État de la version : stable
Implémentation	MyWiki , Page spéciale , API
Description	Permet aux utilisateurs d'activer, via la page de préférence, des gadgets fournis par les utilisateurs et codés en JavaScript.
Auteur(s)	Duesentrieb
MediaWiki	1.11+ (la version actuelle nécessite 1.17, les versions pour les MediaWiki plus anciens (1.11+) sont disponibles ici ou depuis le SVN
Licence	Licence publique générale GNU v2.0 ou supérieur
Téléchargement	Télécharger l'extension Git [?]: Télécharger la branche master de Git parcourir le dépôt (GitHub) historique des validations (commits) relecture du code LISEZMOI journal
Exemple	Wikimedia Commons: Vue d’ensemble des gadgets, préférences utilisateur (cliquez sur "Gadgets"; vous avez besoin de vous connecter d'abord bien sûr)
Paramètres $wgGadgetsRepoClass $wgSpecialGadgetUsageActiveUsers
Droits ajoutés gadgets-edit gadgets-definition-edit
Accroches utilisées ArticleSaveComplete BeforePageDisplay GetPreferences ResourceLoaderRegisterModules UnitTestsList
Traduisez l’extension Gadgets sur translatewiki.net
Vérifiez la matrice des utilisations et des versions.
Problèmes	Tâches ouvertes · Signalez un bogue

L'extension Gadgets apporte un moyen pour les utilisateurs d'utiliser des "gadgets" écrits en JavaScript ou CSS que d'autres utilisateurs du wiki ont écrits.

Les gadgets sont faits de snippets en JavaScript et/ou CSS localisés dans les pages de l'espace de nommage MediaWiki: . Chaque gadget est défini par une ligne dans MediaWiki:Gadgets-definition, fournissant un nom et une description pour le gadget, et une liste des snippets JavaScript et CSS qu'il utilise (voir la section Utilisation en dessous).

Comme les gadgets sont définis dans l'espace de nommage MediaWiki: (la liste décrivant les gadgets comme le code des snippets eux-même), seuls les administrateurs du wiki peuvent modifier le code. Et c'est une bonne chose : seuls les utilisateurs particulièrement fiables au sein de la communauté du wiki sont supposés aptes à éditer du code JavaScript utilisé par d'autres utilisateurs, dans la mesure où le JavaScript peut être facilement utilisé pour hacker des comptes ou espionner des gens.

Installation

1. Téléchargez ou parcourez le dossier Gadgets dans le dépôt SVN.
2. Copiez le dossier Gadgets dans le dossier extensions de votre installation MediaWiki.
3. Ajoutez la ligne suivante dans votre fichier LocalSettings.php (vers la fin) :

  require_once( "$IP/extensions/Gadgets/Gadgets.php" );

Utilisation

Sélection de gadgets sur la page de préférence utilisateur sur de.wikipedia

La liste des gadgets disponibles est définie dans MediaWiki:Gadgets-definition. Une fois créé avec au moins un gadget valide défini, un onglet "Gadgets" apparaît dans la page Special:Preferences, de tel sorte que des utilisateurs peuvent sélectionner les gadgets qu'ils ont envie d'utiliser. Une vue d'ensemble des gadgets définis par MediaWiki:Gadgets-definition est aussi accessible sur Special:Gadgets, avec des liens vers les messages système respectifs, pour une édition facile.

Format

Chaque ligne dans MediaWiki:Gadgets-definition qui commence par un ou plusieurs caractères * (astérisque) définit un gadget; elle doit avoir la forme suivante :

 * nom_du_gadget [options (peut être omis)] | noms de page

Le premier champs ("nom_du_gadget" dans l'exemple) est le nom interne du gadget, et fait référence à un message système (MediaWiki:Gadget-nom_du_gadget dans l'exemple) qui contient une courte description du gadget, en syntaxe wiki.

 Note : Le nom interne est utilisé comme étant une partie du nom champs de formulaire et doit suivre les règles définies pour les valeurs de l'attribut NAME. Ceci signifie qu'il doit commencer par une lettre ([A-Za-z]) et peut être suivi par n'importe quelle suite de lettres, chiffres ([0-9]), traits d’union ("-"), tirets bas ("_"), deux-points (":"), et points (".").

Format des options :

[option1 | option2 | ... optionN]

Les espaces peuvent être omis. Chaque option peut consister soit au nom de l'option seul (dans ce cas, il s'agit d'une option d'activation), ou contenir une liste de valeurs séparées par une virgule :

option = valeur1, valeur2, valeur3

Exemples :

* mongadget|mongadget.js|mongadget.css

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

* mongadget[rights=titi,toto]|mongadget.js|mongadget.css

* mongadget[ ResourceLoader | rights=titi, toto ] | mongadget.js | mongadget.css

Options

Non	Paramètres	Description	Depuis
ResourceLoader	Aucun	Marque les scripts du gadget comme étant compatible avec ResourceLoader.	?
dependencies	Noms des modules ResourceLoader séparés par une virgule	Voir la liste des modules disponibles par défaut. Notez que cette option n'a pas d'effet si le gadget en question n'a pas de ressource compatible ResourceLoader (i.e. pas de style ni de script marqué comme compatible).	?
rights	Noms des privilèges séparés par une virgule	Rend le gadget visible dans les préférences uniquement aux utilisateurs qui ont les privilèges.	?
default	Aucun	Rend le gadget actif par défaut pour tout le monde (même les IPs !). Les utilisateurs enregistrés peuvent toujours le désactiver dans leurs préférences.	1.18

Vous pouvez définir des dépendances extra pour vos gadgets, par exemple :

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

Ici, on demande au ResourceLoader de charger les modules jquery.ui et jquery.effects.clip avec mongadget. Notez que des gadgets ne peuvent pas dépendre de scripts venant de pages, de fichiers statiques ou d'URLs externes, uniquement de modules déjà enregistrés dans ResourceLoader.

Pour rendre le gadget disponible uniquement aux utilisateurs ayant les droits appropriés, configurez l'option rights. Par exemple,

* SuppressionAmelioree [rights=delete] | SuppressionAmelioree.js

rend le gadget disponible uniquement aux utilisateurs qui peuvent réellement supprimer les pages. Notez que les restrictions sont basées sur les privilèges et non sur les groupes d'utilisateur comme administrateurs ou bureaucrates. Voici de vrais exemples :

* modrollback[ResourceLoader|rights=rollback]|modrollback.js
* UTCLiveClock[ResourceLoader|rights=purge]|UTCLiveClock.js
* Ajax_sysop[ResourceLoader|rights=patrol,rollback,markbotedits,delete]|Ajax_sysop.js

Support du ResourceLoader

Toutes les CSS des gadgets sont toujours chargées via le ResourceLoader. Cependant, un JavaScript plus ancien est souvent incompatible avec le RL, donc tous les gadgets doivent explicitement être marqués comme étant compatibles afin d'avoir ses scripts chargés par RL. Sinon, le bon vieux <script src="/w/index.php?title=MediaWiki:Gadget-nom_du_gadget.js&action=raw"> sera utilisé.

Chaque gadget qui utilise au moins partiellement ResourceLoader (à savoir, qui a des styles ou scripts compatibles) a son propre module RL. Les modules sont nommés ext.gadget.<nom du gadget>.

Pages

Les champs restants sur la ligne font référence aux codes JavaScript ou CSS qui construisent le gadget, contenu dans les messages système (MediaWiki:Gadget-mongadget.js et MediaWiki:Gadget-mongadget.css dans l'exemple); les noms de ces messages doivent respectivement se terminer par .js ou .css. Un gadget peut utiliser n'importe quel nombre de messages de code, en particulier, du code commun peut être mis dans un message de code utilisé par plusieurs gadgets, en plus de leur propre code spécifique, par exemple :

 * biduleur|codeCommun.js|bidule.js|bidule.css|cool.css
 * l33t|codeCommun.js|outils.js|l33t.js

Sections

La liste des gadgets dans MediaWiki:Gadgets-definition peut être découpée en sections en utilisant des lignes qui commencent et se terminent avec deux ou plus de caractères = (égal) entourant le nom du message système qui définit le nom de la section — par exemple :

 == interface-gadgets ==

Ceci définirait une nouvelle section, avec le titre défini dans la page MediaWiki:Gadget-section-interface-gadgets.

List of gadget scripts

This table is manually updated. Images link to scripts

Gadgets	Usage
	MediaWiki.org	commons	meta	wikipedia
				en
	installed	i	i	i
UTCLiveClock.js
SearchFocus.js
Syntax highlighter
mySandbox
BugStatusUpdate
Pages gadgets
edittop.js
HomeArrow.js
Category gadgets
HotCat.js
Tab gadgets
addsection-plus.js
Sidebar gadgets
SubPages.js
UserRights.js

Voir aussi

• Extension:Gadgets/Roadmap
• Gadget Manager
• Extension:Widgets
• Snippets