mediawiki-extensions-Gadgets/README
Kunal Mehta 519f30355e Implement Gadgets definition namespace repo
Implements:
* Gadget definition content and content handler
* Basic validation for gadget definition content
* GadgetDefinitionNamespace implementation of GadgetRepo
* DataUpdates upon editing/deletion of Gadget definition pages
* EditFilterMerged hook for improved error messages
* 'GadgetsRepoClass' option to switch GadgetRepo implementation used
* Lazy-load the GadgetResourceLoaderModule class so we don't need to
load each individual gadget object unless its needed

Note that Special:Gadgets's export feature intentionally doesn't work
yet, and will be fixed in a follow up patch.

Bug: T106177
Change-Id: Ib11db5fb0f7b46793bfa956cf1367f1dc1059b1c
2015-11-20 12:01:21 -06:00

44 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.
<https://www.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.27 or later. To get a version
compatible with earlier MediaWiki release, visit
https://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.
== Configuration settings ==
* $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.