extensions/Gadgets/README.md

   1 Gadgets
   2 =============
   3
   4 The Gadgets extension provides a way for users to pick JavaScript or CSS
   5 based "gadgets" that other wiki users provide.
   6
   7 See https://www.mediawiki.org/wiki/Extension:Gadgets for more documentation.
   8
   9 The Gadgets extension was originally written by Daniel Kinzler in 2007
  10 and is released under the GNU General Public Licence (GPL).
  11
  12 Prerequisites
  13 -------------
  14 This version of Gadgets requires MediaWiki 1.27 or later. To get a version
  15 compatible with an earlier MediaWiki release, visit
  16 [ExtensionDistributor/Gadgets](https://www.mediawiki.org/wiki/Special:ExtensionDistributor/Gadgets).
  17
  18 Installing
  19 -------------
  20 Copy the Gadgets directory into the extensions folder of your
  21 MediaWiki installation. Then add the following lines to your
  22 LocalSettings.php file (near the end):
  23
  24         wfLoadExtension( 'Gadgets' );
  25
  26 Usage
  27 -------------
  28 See https://www.mediawiki.org/wiki/Extension:Gadgets#Usage
  29
  30 Caveats
  31 -------------
  32 * Gadgets do not apply to Special:Preferences, Special:UserLogin and
  33   Special:ResetPass so users can always disable any broken gadgets they
  34   may have enabled, and malicious gadgets will be unable to steal passwords.
  35
  36 Configuration
  37 -------------
  38 * `$wgGadgetsRepoClass`:  configures which GadgetRepo implementation will be used
  39   to source gadgets from. Currently, "MediaWikiGadgetsDefinitionRepo" is the
  40   recommended setting and default. The "GadgetDefinitionNamespaceRepo" is not
  41   ready for production usage yet.
  42 * `$wgSpecialGadgetUsageActiveUsers`:  configures whether or not to show active
  43   user stats on Special:GadgetUsage. True by default.