mediawiki-extensions-Gadgets/README

43 lines
1.8 KiB
Plaintext
Raw Normal View History

--------------------------------------------------------------------------
README for the Gadgets extension
Copyright © 2007 Daniel Kinzler
Licenses: GNU General Public Licence (GPL)
GNU Free Documentation License (GFDL)
--------------------------------------------------------------------------
The Gadgets extension provides a way for users to pick JavaScript or CSS
based "gadgets" that other wiki users provide.
<http://mediawiki.org/wiki/Extension:Gadgets>
The Gadgets extension was originally written by Daniel Kinzler in 2007
2008-02-04 08:08:43 +00:00
and is released under the GNU General Public Licence (GPL).
The internationalization files may contain contributions by several people;
they should be mentioned in each file individually.
2010-11-11 18:46:54 +00:00
== Prerequisites ==
This version of Gadgets requires MediaWiki 1.17 or later. To get a version
compatible with earlier MediaWiki release, visit
http://www.mediawiki.org/wiki/Special:ExtensionDistributor/Gadgets
== Installing ==
2008-02-04 08:08:43 +00:00
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):
require_once( "$IP/extensions/Gadgets/Gadgets.php" );
== Usage ==
See http://www.mediawiki.org/wiki/Extension:Gadgets#Usage
== Caveats ==
2010-11-11 18:46:54 +00:00
* 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.
2008-02-04 08:08:43 +00:00
* Uses BeforePageDisplay hook, thus only works with MonoBook based skins;
specifically, does not work with CologneBlue.
2008-02-04 08:08:43 +00:00
* Gadget code is included after user code - that means that user JS has no
access to things defined in gadgets, and user CSS is overwritten by CSS
from gadgets. (pending a better way to insert things into the HTML head)