Extension:Gadgets

Cette extension est fournie avec MediaWiki 1.18 et supérieur. Ainsi vous n'avez pas besoin de la télécharger à nouveau. Néanmoins, vous devez encore suivre les autres instructions fournies.

Manuel des extensions MediaWiki

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 (Duesentriebtalk)
MediaWiki	1.19+
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) repository contributors (GitHub) relecture du code README
Exemple	Wikimedia Commons: Gadget overview, user preferences (click "Gadgets"; you need to be logged in of course)
Paramètres $wgGadgetsRepoClass $wgSpecialGadgetUsageActiveUsers
Droits ajoutés gadgets-edit gadgets-definition-edit
Accroches utilisées BeforePageDisplay CodeEditorGetPageLanguage ContentHandlerDefaultModelFor DeleteUnknownPreferences EditFilterMergedContent GetPreferences ResourceLoaderRegisterModules UserGetDefaultOptions wgQueryPages
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

• Téléchargez et placez le(s) fichiers (s) dans un répertoire appelé Gadgets dans votre dossier extensions/.
• 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

Selection of some gadgets at the user preferences in de.wikipedia

There are two ways to define gadgets depending on the $wgGadgetsRepoClass. If It is 'MediaWikiGadgetsDefinitionRepo'(the default value), the list of available gadgets is defined on MediaWiki:Gadgets-definition. In an alternative way, Gadget definitions defined on pages in the Gadget definition namespace when $wgGadgetsRepoClass is set to 'GadgetDefinitionNamespaceRepo'. CAUTION: Migration of the existing gadget definitions is not yet supported, So you will lose previously defined gadgets after changing this option.

Once created with at least one valid gadget, gadgets defined there show up in the "Gadgets" section of Special:Preferences, so users can pick the gadgets they would like to use. An overview of the gadgets defined by MediaWiki:Gadgets-definition is also shown on Special:Gadgets, along with links to the respective system messages, for easy editing. Statistics for non-default gadget usage can be seen at Special:GadgetUsage.

Format

Utiliser MediaWiki:Gadgets-definition

Each line in MediaWiki:Gadgets-definition that starts with one or more "*" (asterisks) characters defines a gadget; it must have the following form:

 * gadget_name [options (can be omitted)] | page names

The first field ("gadget_name" in the example) is the gadget's internal name, and references a system message (MediaWiki:Gadget-gadget_name in the example) that contains a short description of the gadget, using wiki syntax.

The internal name is used as part of the name of a form field and must follow the rules defined for NAME attribute values. This means it must only use letters ([A-Za-z]) and may be followed by any number of letters, digits ([0-9]), hyphens ("-"), underscores ("_"), colons (":"), and periods (".").

Options format:

[option1 | option2 | ... optionN]

whitespace can be omitted. A single option can either consist of a single option name (in this case it is a flag option), or contain a comma-separated list of values:

option = value1, value2, value3

Examples:

 * mygadget|mygadget.js|mygadget.css

or

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

or

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

or

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

Using Gadget Definition Namespace

Creation of the Gadget definition:Mygadget page and putting in it the below JSON code have the same effect as 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.

You can add the following in your LocalSettings.php to provide the appropriate permissions for users who are within the interface-admin group.

Editing pages in the Gadget namespace requires the gadgets-edit right and editing pages in the Gadget definition namespace requires the gadgets-definition-edit right.

$wgGroupPermissions['interface-admin']['gadgets-edit'] = true;
$wgGroupPermissions['interface-admin']['gadgets-definition-edit'] = true;

Options

Name	Parameters	Description	Since
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: Enable a gadget by default without ability to disable (as modular alternative to Common.js). Gadgets that are not meant for end-users, but rather are meant to be loaded by other gadgets. For example to allow two gadgets to re-use the same internal code, or to register the "core" part of a gadget that only loads on certain pages.	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. Targeting mobile only is broken, and causes errors on desktop because ResourceLoader complains about the module not being registered, even if not loaded. See also tâche T173309.	?
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.	1.28
peers	Comma-separated module names	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)
top	None	(removed in 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.	?

You can specify extra dependencies for your gadgets, for example:

* 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. Here are some real examples:

* 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. Otherwise, plain old <script src="/w/index.php?title=MediaWiki:Gadget-gadget_name.js&action=raw&ctype=text/javascript"> will be used.

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 ==

This would define a new section, with the title defined on the page MediaWiki:Gadget-section-interface-gadgets.

ToDo

• Fulfill Basic gadgets

List of gadget scripts

This table is manually updated.

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