| Index: trunk/extensions/UsabilityInitiative/README |
| — | — | @@ -1,3 +1,60 @@ |
| 2 | 2 | # Some lines to add to LocalSettings.php to get these extensions up and running: |
| 3 | 3 | |
| 4 | | -~PLEASE UPDATE THIS DOCUMENTATION WHEN MAKING SYSTEM SETUP CHANGES~ |
| \ No newline at end of file |
| | 4 | +# Vector enhancements (CollapsibleTabs, SimpleSearch, EditWarning) |
| | 5 | +require_once( "$IP/extensions/UsabilityInitiative/Vector/Vector.php" ); |
| | 6 | + |
| | 7 | +# Vector enhancements config |
| | 8 | +# global: Enabled for everyone, users can't disable in preferences (FIXME this behavior should change) |
| | 9 | +# user: Disabled by default, users can enable in preferences |
| | 10 | +# Shown values are defaults |
| | 11 | +$wgVectorModules = array( |
| | 12 | + 'collapsibletabs' => array( 'global' => true, 'user' => false ), // Doesn't have a user pref |
| | 13 | + 'editwarning' => array( 'global' => false, 'user' => true ), |
| | 14 | + 'simplesearch' => array( 'global' => true, 'user' => false ), // Doesn't have a user pref |
| | 15 | +); |
| | 16 | +# To really enable SimpleSearch (FIXME) |
| | 17 | +$wgVectorUseSimpleSearch = true; |
| | 18 | + |
| | 19 | +# WikiEditor (Toolbar, Toc, Preview, Highlight) |
| | 20 | +require_once( "$IP/extensions/UsabilityInitiative/WikiEditor/WikiEditor.php" ); |
| | 21 | + |
| | 22 | +# WikiEditor config |
| | 23 | +$wgWikiEditorModules = array( |
| | 24 | + 'highlight' => array( 'global' => false, 'user' => true ), |
| | 25 | + 'preview' => array( 'global' => false, 'user' => true ), |
| | 26 | + 'toc' => array( 'global' => false, 'user' => true ), |
| | 27 | + 'toolbar' => array( 'global' => false, 'user' => true ), |
| | 28 | +); |
| | 29 | + |
| | 30 | +# To enable something by default but still allow users to disable it in preferences, use something like: |
| | 31 | +# FIXME this should be done more cleanly, see also above |
| | 32 | +#$wgDefaultUserOptions['usenavigabletoc'] = 1; |
| | 33 | + |
| | 34 | +# A system for making it easy for users to opt-in and out of a beta, in this |
| | 35 | +# case using vector as their skin and the enhanced toolbar |
| | 36 | +# NOTE: This extension may not be very useful for non-WMF wikis |
| | 37 | +require_once( "$IP/extensions/UsabilityInitiative/OptIn/OptIn.php" ); |
| | 38 | +# Always show the link to opt-in in the personal tools - without this, the link |
| | 39 | +# to opt-out (while opted in) will still appear (it always does) |
| | 40 | +#$wgOptInAlwaysShowPersonalLink = true; |
| | 41 | + |
| | 42 | +# Shows statistics on when users have started and ended using certain prefs |
| | 43 | +require_once("$IP/extensions/UsabilityInitiative/PrefStats/PrefStats.php"); |
| | 44 | +$wgPrefStatsTrackPrefs = array( 'skin' => 'vector', 'usebetatoolbar' => 1 ); |
| | 45 | +$wgGroupPermissions['sysop']['prefstats'] = true; |
| | 46 | +$wgPrefStatsTimeUnit = 60*60*24; |
| | 47 | + |
| | 48 | +# When working on these extensions' js and css files, you will want to do this, |
| | 49 | +# otherwise, the default will always use the combined and minified versions and |
| | 50 | +# you will have to use combine.sh every time you make a change just to see it |
| | 51 | +#$wgUsabilityInitiativeResourceMode = 'raw'; |
| | 52 | + |
| | 53 | +# Track users' contribution counts. ClickTracking (see below) needs this |
| | 54 | +# NOTE: This extension may not be very useful for non-WMF wikis |
| | 55 | +require_once( "$IP/extensions/UsabilityInitiative/UserDailyContribs/UserDailyContribs.php" ); |
| | 56 | + |
| | 57 | +# Track users' clicks in the toolbar and the left nav bar (and possibly other places as well) |
| | 58 | +# NOTE: This extension may not be very useful for non-WMF wikis |
| | 59 | +require_once("$IP/extensions/UsabilityInitiative/ClickTracking/ClickTracking.php"); |
| | 60 | +# Click tracking is disabled by default. To enable it, use something like: |
| | 61 | +#$wgClickTrackThrottle = 10; // Track 1 in every 10 clicks; set to 1 to track all clicks, -1 to disable |