Extension:Gadgets
 État de la version : stable |
|
|---|---|
 |
|
| Implémentation | MyWiki, Page spéciale, API |
| Description | Allow users to enable JS-based, user-provided gadgets from their preferences page. |
| Auteur(s) | Daniel Kinzler (Duesentriebdiscussion) |
| Politique de compatibilité | Versions ponctuelles alignées avec MediaWiki. Le master n'est pas compatible arrière. |
| MediaWiki | 1.19+ |
| Licence | Licence publique générale GNU v2.0 ou supérieur |
| Téléchargement | README |
| Exemple | Wikimedia Commons: Gadget overview, user preferences (click "Gadgets"; you need to be logged in of course) |
|
|
|
|
| Traduire l’extension Gadgets sur translatewiki.net si elle y est disponible | |
| Problèmes | Tâches ouvertes · Signaler 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 fournis.
Les gadgets sont constitués de Fragments de code de JavaScript et/ou CSS situés sur les pages de l'espace de noms 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 du code JavaScript et CSS qu'il utilise (voir la section Utilisation ci-dessous).
Comme les gadgets sont définis dans l'espace de noms MediaWiki: (la liste décrivant les gadgets comme le code lui-même), seuls les sysops (administrateurs d'interface depuis 1.32) 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 à modifier le 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
- Téléchargez et placez le(s) fichiers (s) dans un répertoire appelé
Gadgetsdans votre dossierextensions/. - Ajoutez le code suivant à la fin de votre fichier LocalSettings.php :
wfLoadExtension( 'Gadgets' );
Fait – Accédez à Special:Version sur votre wiki pour vérifier que l'extension a bien été installée.
Pour les utilisateurs de MediaWiki 1.24 ou précédents :
Les instructions ci-dessus décrivent la nouvelle procédure pour installer cette extension en utilisant wfLoadExtension().
Si vous avez besoin d'installer cette extension sur les précédentes versions de MediaWiki (1.24 ou antérieur), à la place de wfLoadExtension( 'Gadgets' );, vous devez utiliser :
require_once "$IP/extensions/Gadgets/Gadgets.php";
Utilisation
Il y a deux façons de définir les gadgets en fonction de $wgGadgetsRepoClass.
S'il est 'MediaWikiGadgetsDefinitionRepo' (valeur par défaut), la liste des gadgets disponibles est définie sur MediaWiki:Gadgets-definition.
De manière alternative, les définitions de gadget sont définies sur les pages de l'espace de noms Définition de gadget lorsque $wgGadgetsRepoClass est défini sur 'GadgetDefinitionNamespaceRepo'.
 Attention : | La migration des définitions de gadget existantes n'est pas encore prise en charge. Vous perdrez donc les gadgets précédemment définis après avoir modifié cette option. |
Une fois créés avec au moins un gadget valide, les gadgets définis s'affichent dans la section "Gadgets" de Special:Preferences, afin que les utilisateurs puissent choisir les gadgets qu'ils souhaitent utiliser. Un aperçu des gadgets définis par MediaWiki:Gadgets-definition est également affiché sur Special:Gadgets, ainsi que des liens vers les messages système respectifs, pour faciliter l'édition. Les statistiques d'utilisation des gadgets autres que par défaut sont visibles à Special:GadgetUsage.
Format
Utiliser MediaWiki:Gadgets-definition
Chaque ligne de MediaWiki:Gadgets-definition qui commence par un ou plusieurs caractères "*" (astérisques) définit un gadget ; il doit avoir la forme suivante :
* gadget_name [== Options (peut être omis) ==] | Noms de page
Le premier champ ("gadget_name" dans l'exemple) est le nom interne du gadget et fait référence à un message système (MediaWiki:Gadget-gadget_name dans l'exemple) qui contient une courte description du gadget, en utilisant la syntaxe wiki.
[A-Za-z]) et peut être suivi de n'importe quel nombre de lettres, de chiffres ([0-9]), de tirets (-), de traits de soulignement (_), de deux-points (:) et de points (.).Format des options:
[option1 | option2 | ... optionN]
les espaces peuvent être omis. Une option unique peut être constituée d'un nom d'option unique (dans ce cas, il s'agit d'une option d'indicateur) ou contenir une liste de valeurs séparées par des virgules:
option = value1, value2, value3
Exemples:
* mygadget|mygadget.js|mygadget.css
ou
* mygadget[ResourceLoader]|mygadget.js|mygadget.css
ou
* mygadget[rights=foo,bar]|mygadget.js|mygadget.css
ou
* mygadget[ ResourceLoader | rights=foo, bar ] | mygadget.js | mygadget.css
Utilisation de l'espace de noms de définition de gadget
La création de la page Gadget definition:mygadget et l'insertion du code JSON ci-dessous ont le même effet que mygadget[ ResourceLoader | rights=foo, bar ] | mygadget.js | mygadget.css.
{
"settings": {
"rights": [ "foo", "bar" ],
"default": false,
"hidden": false,
"skins": [],
"category": ""
},
"module": {
"scripts": [ "mygadget.js" ],
"styles": [ "mygadget.css" ],
"peers": [],
"dependencies": [],
"messages": [],
"type": ""
}
}
In above example, the Gadget:Mygadget.js and the Gadget:mygadget.css are used.
And remember the ResourceLoader option is always true in the gadget definition namespace.
La modification de pages dans l'espace de noms Gadget nécessite le droit gadgets-edit et la modification de pages dans l'espace de noms de définition Gadget nécessite le droit gadgets-definition-edit.
$wgGroupPermissions['interface-admin']['gadgets-edit'] = true;
$wgGroupPermissions['interface-admin']['gadgets-definition-edit'] = true;
Options
| Nom | Paramètres | Description | Depuis |
|---|---|---|---|
ResourceLoader |
None | Marks gadget's scripts as compatible with ResourceLoader. | ? |
dependencies |
Comma-separated module names | See list of default modules. Note that this option has no effect if current gadget has no ResourceLoader-compatible resources (i.e. no styles and scripts not marked as compatible). | ? |
rights |
Comma-separated privilege names | Make the gadget available (and visible in preferences) only to users who have the specified privileges. | ? |
hidden
|
None | Hide the gadget from the Preferences page. This can be used in two ways:
|
1.28 |
skins |
Comma-separated skin names | Make the gadget available (and visible in preferences) only to users who use the specified skins. Before MediaWiki 1.32 it was taking into consideration the skin set in preferences for the user, not the current displayed one (like when adding ?useskin=monobook in the URL, tâche T199478) | ? |
default |
None | Enable the gadget by default for everyone (including IPs). Registered users can still disable it in their preferences. | 1.18 |
targets
|
desktop (default), mobile or desktop,mobile
|
Set the RL target(s) for the gadget. | gerrit:60954 |
type
|
styles or general
|
Use styles for modules that only modify styling for elements already on the page (e.g. when customizing the skin, layout, or article content). It will cause the CSS files of the module to be included from the page HTML instead of being loaded via JavaScript. For details, see ResourceLoader/Migration guide (users)#Gadget type.
Note: Using |
1.28 |
peers
|
Noms de modules séparés par des virgules | Require CSS-only gadgets (which usually would be hidden). These gadgets will be loaded sooner than by dependencies, and will be loaded even if JavaScript is disabled. For details, see ResourceLoader/Migration guide (users)#Gadget peers.
|
1.29.0-wmf.11 (pre-release) |
|
None | (supprimé en 1.29) Makes the gadget to be top-loaded. This should be used sparingly, but may be needed for some initialization stuff like registering plugins with VisualEditor. | gerrit:75506 |
Vous pouvez spécifier des dépendances supplémentaires pour vos gadgets, par exemple :
* mygadget[ResourceLoader|dependencies=jquery.ui, jquery.effects.clip]|mygadget.js|mygadget.css
Here, we ask ResourceLoader to load modules jquery.ui and jquery.effects.clip with mygadget.
Note that gadgets can't depend on scripts from pages, static files or external URLs, only on modules already registered in ResourceLoader.
To make a script from a page depend on another script from a page, each should be a gadget which registers itself as a module in ResourceLoader, then they can be made to have dependencies using the following syntax:
* childgadget[ResourceLoader|dependencies=ext.gadget.parentgadget]|childgadget.js
To enable a gadget by default, use "default":
* mygadget[ResourceLoader|default|dependencies=mediawiki.util]|mygadget.js|mygadget.css
To make the gadget available only to users with appropriate permissions, set the rights option.
For example,
* ImprovedDeletion [rights=delete] | ImprovedDeletion.js
makes the gadget available only to users who can actually delete pages. Note that restrictions are based on permissions, not user groups like administrators or bureaucrats. Voici quelques exemples réels :
* modrollback[ResourceLoader|rights=rollback]|modrollback.js * UTCLiveClock[ResourceLoader|rights=purge]|UTCLiveClock.js * Ajax_sysop[ResourceLoader|rights=patrol,rollback,markbotedits,delete]|Ajax_sysop.js
ResourceLoader support
Each gadget's CSS is always loaded via the ResourceLoader.
However, older JavaScript is often incompatible with RL, so every gadget must be explicitly marked as compatible in order to have its scripts loaded by RL.
l'ancien ̩l'ancien <script src="/w/index.php?title=MediaWiki:Gadget-gadget_name.js&action=raw&ctype=text/javascript"> sera utilisé
Every gadget that at least partially uses ResourceLoader (that is, that has styles or compatible scripts) has its own RL module.
The modules are named ext.gadget.<gadget name>.
Pages
The remaining fields on the line refer to the JavaScript or CSS code that makes up the gadget, contained in system messages (MediaWiki:Gadget-mygadget.js and MediaWiki:Gadget-mygadget.css in the example); the names of those messages must end with ".js" or ".css", respectively. A gadget can use any number of code messages, specifically, common code can be put into a code message used by several gadgets, in addition to their own specific code, e.g:
* frobinator|commonStuff.js|frob.js|frob.css|pretty.css * l33t|commonStuff.js|tools.js|l33t.js
Please note that if your code contains strings that could be interpreted as wiki syntax (e.g.
the signature code ~~~~), you may want to enclose your code into <nowiki> and </nowiki> and put these tags in JavaScript or CSS comments so they're not interpreted when actually used.
See the first and last lines of MediaWiki:Gadget-externalsearch-bar.js for an example.
Sections
The list of gadgets in MediaWiki:Gadgets-definition can be broken into sections using lines that start and end with two or more "=" (equals) characters, enclosing the name of a system message that defines the section's name - for example:
== interface-gadgets ==
Cela définirait une nouvelle section, avec le titre défini sur la page MediaWiki:Gadget-section-interface-gadgets.
A faire
- Ensemble de gadgets de base
List of gadget 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
| Cette extension est utilisée par au moins un des projets Wikimédia. Cela signifie probablement que l’extension est assez stable et fonctionnelle pour être utilisée sur des sites à fort trafic. Recherchez le nom de cette extension dans le CommonSettings.php de Wikimédia et dans le fichier de configuration InitialiseSettings.php pour situer les endroits où elle est installée. Une liste complète des extensions installées sur un Wiki donné peut être visualisée sur la page Special:Version de ce wiki. |