MediaWiki 1.30.2

[autoinstallsdev/mediawiki.git] / extensions / WikiEditor / README

diff --git a/extensions/WikiEditor/README b/extensions/WikiEditor/README
new file mode 100644 (file)
index 0000000..e50b695
--- /dev/null
+++ b/extensions/WikiEditor/README
@@ -0,0 +1,20 @@
+# WikiEditor provides enhancements to the MediaWiki edit page
+
+# This extension requires MediaWiki 1.17+ because it makes use of ResourceLoader.
+
+# Example LocalSettings.php additions
+
+require_once( "$IP/extensions/WikiEditor/WikiEditor.php" );
+
+# Before configuring this extension, see WikiEditor.php and become familiar with the initial state and structure of the
+# $wgWikiEditorFeatures configuration variable. Essentially it's an array of arrays, keyed by feature name, each
+# containing global and user keys with boolean values. "global" indicates that it should be turned on for everyone
+# always, while user indicates that users should be allowed to turn it on or off in their user preferences.
+
+# To enable a preference by default but still allow users to disable it in preferences, use something like...
+
+$wgDefaultUserOptions['usebetatoolbar'] = 1;
+
+# Release 1.21 removes the $wgWikiEditorToolbarClickTracking config variable
+# and with it support for tracking clicks on WikiEditor features via the
+# ClickTracking extension.