mediawiki/pivot
1
0
Fork 0
mirror of https://github.com/Hutchy68/pivot.git synced 2024-11-22 02:19:03 +01:00
Code Issues Releases Wiki Activity

Merge pull request #21 from Hutchy68/readme-update

Browse Source 
missing some instructions from README.md
This commit is contained in:
Tom Hutchison 2017-03-20 14:36:24 -04:00 committed by GitHub
commit 36c97ff4df
1 changed files with 11 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

14
README.md
View File

@ -36,21 +36,27 @@ To activate Pivot for all users and anonymous visitors, you need to set the `$wg
Use following features in `LocalSettings.php` to change the behavior. Use following features in `LocalSettings.php` to change the behavior.
- `'showActionsForAnon' => true` displays page actions for non-logged-in visitors. - `'showActionsForAnon' => true` displays page actions for non-logged-in visitors.
- `'fixedNavBar' => false` will allow the NavBar to scroll with the content, `true` will lock the NavBar.
- `'usePivotTabs' => false` set to true will enable Foundation 5 tab coding to pass thru HTML sanitizer.
- `'showHelpUnderTools' => true` a Link to "Help" will be created under "Tools". - `'showHelpUnderTools' => true` a Link to "Help" will be created under "Tools".
- `'showRecentChangesUnderTool's => true` a Link to "recent changes" will be created under "Tools". - `'showRecentChangesUnderTool's => true` a Link to "recent changes" will be created under "Tools".
- `'IeEdgeCode' => 1` will produce a meta tag with "X-UA-Compatible" content="IE=edge", `2` will sent a header, `0` nothing will be done - `'wikiName' => &$GLOBALS['wgSitename']` set a shorter wiki name which doesn't change the real name used when creating the wiki.
- `'fixedNavBar' => false` will allow the NavBar to scroll with the content, `true` will lock the NavBar. - `'wikiNameDesktop' => &$GLOBALS['wgSitename']` set a longer wiki name for desktop view. Helpful when used in conjunction with `wikiName` or default `$wgSitename`.
- `'navbarIcon' => false` no icon in mobile view, `true` to use the global set logopath image of the wiki. - `'navbarIcon' => false` no icon in mobile view, `true` to use the global set logopath image of the wiki.
- `'IeEdgeCode' => 1` will produce a meta tag with "X-UA-Compatible" content="IE=edge", `2` will sent a header, `0` nothing will be done
- `'showFooterIcons' => false` will show text in place of footer icons, `true` will output the icons as globally set. - `'showFooterIcons' => false` will show text in place of footer icons, `true` will output the icons as globally set.
- `'addThisPUBID' => ''` empty string will not fire the AddThis script, `'ra-##-#######'` publisher ID will allow the run the AddThis script in async. - `'addThisPUBID' => ''` empty string will not fire the AddThis script, `'ra-##-#######'` publisher ID will allow the run the AddThis script in async.
- `'useAddThisShare' => false` default, do not use AddThis share, `true` will insert the share toolbox div directly under page title, but before the tagline. - `'useAddThisShare' => false` default, do not use AddThis share, `true` will insert the share toolbox div directly under page title, but before the tagline.
- `'useAddThisFollow' => false` default, do not use AddThis follow, `true` will insert the follow toolbox div in the `right-footer` area before icon or text output. - `'useAddThisFollow' => false` default, do not use AddThis follow, `true` will insert the follow toolbox div in the `right-footer` area before icon or text output.
These are the default values and the example of the array to change the defaults. Add the following after `wfLoadSkin( 'pivot' );` in `LocalSettings.php` to change the feature defaults: For a more detailed explanation of each feature, see the https://pivot.wikiproject.net/wiki/Pivot_features page.
$wgPivotFeatures = array( These are the default values and the example of the array to change the defaults. Add the following after `wfLoadSkin( 'pivot' );` in `LocalSettings.php` then change the feature defaults:
$wgPivotFeaturesDefaults = array(
'showActionsForAnon' => true, 'showActionsForAnon' => true,
'fixedNavBar' => false, 'fixedNavBar' => false,
'usePivotTabs' => false,
'showHelpUnderTools' => true, 'showHelpUnderTools' => true,
'showRecentChangesUnderTools' => true, 'showRecentChangesUnderTools' => true,
'wikiName' => &$GLOBALS['wgSitename'], 'wikiName' => &$GLOBALS['wgSitename'],