[Summary view] [Print] [Text view]

   1  --------------------------------------------------------------------------
   2  README for the Gadgets extension
   3  Copyright © 2007 Daniel Kinzler
   4  Licenses: GNU General Public Licence (GPL)
   5            GNU Free Documentation License (GFDL)
   6  --------------------------------------------------------------------------
   7  
   8  The Gadgets extension provides a way for users to pick JavaScript or CSS
   9  based "gadgets" that other wiki users provide.
  10  
  11  <https://www.mediawiki.org/wiki/Extension:Gadgets>
  12  
  13  The Gadgets extension was originally written by Daniel Kinzler in 2007
  14  and is released under the GNU General Public Licence (GPL).
  15  The internationalization files may contain contributions by several people;
  16  they should be mentioned in each file individually.
  17  
  18  == Prerequisites ==
  19  This version of Gadgets requires MediaWiki 1.19 or later. To get a version
  20  compatible with earlier MediaWiki release, visit
  21      https://www.mediawiki.org/wiki/Special:ExtensionDistributor/Gadgets
  22  
  23  == Installing ==
  24  Copy the Gadgets directory into the extensions folder of your
  25  MediaWiki installation. Then add the following lines to your
  26  LocalSettings.php file (near the end):
  27  
  28    require_once( "$IP/extensions/Gadgets/Gadgets.php" );
  29  
  30  == Usage ==
  31  See http://www.mediawiki.org/wiki/Extension:Gadgets#Usage
  32  
  33  == Caveats ==
  34  
  35  * Gadgets do not apply to Special:Preferences, Special:UserLogin and
  36    Special:ResetPass so users can always disable any broken gadgets they
  37    may have enabled, and malicious gadgets will be unable to steal passwords.
  38  * Uses BeforePageDisplay hook, thus only works with MonoBook based skins;
  39    specifically, does not work with CologneBlue.
  40  * Gadget code is included after user code - that means that user JS has no
  41    access to things defined in gadgets, and user CSS is overwritten by CSS
  42    from gadgets. (pending a better way to insert things into the HTML head)