mirror of
https://gerrit.wikimedia.org/r/mediawiki/extensions/Gadgets
synced 2024-11-14 19:14:45 +00:00
03ae3a0ff1
* By convention, JavaScript and CSS files on disk are almost always named with a leading lowercase. It is good to have parallelism with on-wiki page names (such as while uploading git-managed source files on disk). With the introduction of packaged gadgets (T198758), it is preferable to write require('./data.json') rather than require('./Data.json') * There could be existing pages like MediaWiki:Gadget-Foo.js and MediaWiki:Gadget-foo.js. During the migration, both titles would conflictingly have the same move destination Gadget:Foo.js. Bug: T300000 Change-Id: I2172112caf06cf37ff8808808feb06991010fee9 |
||
---|---|---|
.phan | ||
i18n | ||
includes | ||
tests/phpunit | ||
.eslintrc.json | ||
.gitignore | ||
.gitreview | ||
.phpcs.xml | ||
CODE_OF_CONDUCT.md | ||
composer.json | ||
COPYING | ||
extension.json | ||
Gadgets.alias.php | ||
Gadgets.namespaces.php | ||
Gruntfile.js | ||
package-lock.json | ||
package.json | ||
README.md |
Gadgets
The Gadgets extension provides a way for users to pick JavaScript or CSS based "gadgets" that other wiki users provide.
See https://www.mediawiki.org/wiki/Extension:Gadgets for more documentation.
The Gadgets extension was originally written by Daniel Kinzler in 2007 and is released under the GNU General Public Licence (GPL).
Prerequisites
This version of Gadgets requires MediaWiki 1.27 or later. To get a version compatible with an earlier MediaWiki release, visit ExtensionDistributor/Gadgets.
Installing
Copy the Gadgets directory into the extensions folder of your MediaWiki installation. Then add the following lines to your LocalSettings.php file (near the end):
wfLoadExtension( 'Gadgets' );
Usage
See https://www.mediawiki.org/wiki/Extension:Gadgets#Usage
Caveats
- Gadgets do not apply to Special:Preferences, Special:UserLogin and Special:ResetPass so users can always disable any broken gadgets they may have enabled, and malicious gadgets will be unable to steal passwords.
Configuration
$wgGadgetsRepoClass
: configures which GadgetRepo implementation will be used to source gadgets from. Currently, "MediaWikiGadgetsDefinitionRepo" is the recommended setting and default. The "GadgetDefinitionNamespaceRepo" is not ready for production usage yet.$wgSpecialGadgetUsageActiveUsers
: configures whether or not to show active user stats on Special:GadgetUsage. True by default.