mirror of
https://gerrit.wikimedia.org/r/mediawiki/extensions/Gadgets
synced 2024-11-24 15:33:42 +00:00
dbc8ef531f
Because I'm lazy to do everything twice, README now points to on-wiki docs for definition format.
43 lines
1.8 KiB
Plaintext
43 lines
1.8 KiB
Plaintext
--------------------------------------------------------------------------
|
|
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
|
|
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.
|
|
|
|
== 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 ==
|
|
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 ==
|
|
|
|
* 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.
|
|
* Uses BeforePageDisplay hook, thus only works with MonoBook based skins;
|
|
specifically, does not work with CologneBlue.
|
|
* 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)
|