Kaldari has uploaded a new change for review. https://gerrit.wikimedia.org/r/260085
Change subject: Converting README to Markdown file and adding config documentation ...................................................................... Converting README to Markdown file and adding config documentation Change-Id: I24814b8236cef0eaf7b9e0628d92912cbc2924a6 --- D README A README.md 2 files changed, 43 insertions(+), 43 deletions(-) git pull ssh://gerrit.wikimedia.org:29418/mediawiki/extensions/Gadgets refs/changes/85/260085/1 diff --git a/README b/README deleted file mode 100644 index ac85d70..0000000 --- a/README +++ /dev/null @@ -1,43 +0,0 @@ --------------------------------------------------------------------------- -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. diff --git a/README.md b/README.md new file mode 100644 index 0000000..5273c19 --- /dev/null +++ b/README.md @@ -0,0 +1,43 @@ +Gadgets +============= + +The Gadgets extension provides a way for users to pick JavaScript or CSS +based "gadgets" that other wiki users provide. + +See https://www.mediawiki.org/wiki/Extension:Gadgets for more documentation. + +The Gadgets extension was originally written by Daniel Kinzler in 2007 +and is released under the GNU General Public Licence (GPL). + +Prerequisites +------------- +This version of Gadgets requires MediaWiki 1.27 or later. To get a version +compatible with an earlier MediaWiki release, visit +[ExtensionDistributor/Gadgets](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 +------------- +* `$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. +* `$wgSpecialGadgetUsageActiveUsers`: configures whether or not to show active + user stats on Special:GadgetUsage. True by default. -- To view, visit https://gerrit.wikimedia.org/r/260085 To unsubscribe, visit https://gerrit.wikimedia.org/r/settings Gerrit-MessageType: newchange Gerrit-Change-Id: I24814b8236cef0eaf7b9e0628d92912cbc2924a6 Gerrit-PatchSet: 1 Gerrit-Project: mediawiki/extensions/Gadgets Gerrit-Branch: master Gerrit-Owner: Kaldari <[email protected]> _______________________________________________ MediaWiki-commits mailing list [email protected] https://lists.wikimedia.org/mailman/listinfo/mediawiki-commits
