pivot/README.md

# MediaWiki Pivot Skin

[![CircleCI](https://circleci.com/gh/Hutchy68/pivot.svg?style=shield)](https://circleci.com/gh/Hutchy68/pivot)
[![Scrutinizer Code Quality](https://scrutinizer-ci.com/g/Hutchy68/pivot/badges/quality-score.png?b=master)](https://scrutinizer-ci.com/g/Hutchy68/pivot/?branch=master)

A [MediaWiki](http://www.mediawiki.org) skin that focuses on mobile first but will pivot to all viewports with elegance. Supports responsive layouts and has classes predefined for [Semantic MediaWiki](http://semantic-mediawiki.org/wiki/Semantic_MediaWiki). Built on the [Zurb Foundation 5](http://foundation.zurb.com) CSS framework.

Read the docs below (short version) or see [pivot.wikiproject.net](https://pivot.wikiproject.net) for more detailed docs with FAQs and examples of use.

## Download

First, copy the Pivot source files into your MediaWiki skins directory (see [skinning](https://www.mediawiki.org/wiki/Manual:Skinning) for general information on MediaWiki skins). You can either download the files and extract them from:

    https://github.com/hutchy68/pivot/archive/master.zip

You should extract that into a folder named `pivot` in your `skins` directory.

Alternatively, you can use git to clone the repository, which makes it very easy to update the code, using:

    git clone https://github.com/hutchy68/pivot.git

After that, you can issue `git pull` to update the code at anytime.

## Setup

Once the skin is in place add the following line to your `LocalSettings.php` file.

    wfLoadSkin( 'pivot' );

This will activate Pivot in your installation. At this point you can select it as a user skin in your user preferences.

To activate Pivot for all users and anonymous visitors, you need to set the `$wgDefaultSkin` variable and set it to `pivot`.

    $wgDefaultSkin = "pivot";

## Configurations

Use following features in `LocalSettings.php` to change the behavior. 

- `'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 to enable Foundation tabs markup in wiki pages.
- `'showHelpUnderTools' => true` a Link to "Help" will be created under "Tools".
- `'showRecentChangesUnderTool's => true` a Link to "recent changes" will be created under "Tools".
- `'wikiName' => &$GLOBALS['wgSitename']` default is the sitename. Set to display a short version without changing the systems wikiname.
- `'wikiNameDesktop' => &$GLOBALS['wgSitename']` default sitename. Set to display a longer name in desktop view.
- `'navbarIcon' => false` no icon in mobile view, `true` to use the global set logopath image of the wiki.
- `'preloadFontAwesome' => false` set to true to preload Font Awesome as a `<head>` element. Useful to overcome MIME type server configurations not set correctly.
- `'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 on content pages only.
- `'useAddThisShare' => ''` default empty string, do not use AddThis share, `your_addthis_specific_div_class_string` will insert the share toolbox div directly under page title, but before the tagline with your custom div class.
- `'useAddThisFollow' => ''` default empty string, do not use AddThis follow, `your_addthis_specific_div_class_string` will insert the follow toolbox div in the `right-footer` area before icon or text output with your custom div class.

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:

	$wgPivotFeatures = array(
		'showActionsForAnon' => true,
		'fixedNavBar' => false,
		'usePivotTabs' => false,
		'showHelpUnderTools' => true,
		'showRecentChangesUnderTools' => true,
		'wikiName' => &$GLOBALS['wgSitename'],
		'wikiNameDesktop' => &$GLOBALS['wgSitename'],
		'navbarIcon' => false,
		'preloadFontAwesome' => false,
		'showFooterIcons' => true,
		'addThisPUBID' => '',
		'useAddThisShare' => '',
		'useAddThisFollow' => ''
	);


### Notes on other skins

As you build a wiki out with Pivot you will likely use the responsive grid from Foundation. This is key to making a responsive wiki, and is one of the largest _migration_ requirements when you want to move a wiki that previously used Vector (and likely a lot of tables for layout) to Pivot. Once you do this, the ability of a user to select whatever skin will be removed. If you take full advantage of Pivot in your templates the lack of the Foundation grid will make viewing the wiki using [Vector](http://wikiapiary.com/wiki/Skin:Vector) or [MonoBook](http://wikiapiary.com/wiki/Skin:MonoBook) very difficult.

Because of this, it is suggested that you set the `$wgSkipSkins` variable to make sure that everyone sees the site as you intended it. This removes other skins from being user selectable options.

    # Pivot is specific, so lets disable other skins
    $wgSkipSkins = array( 'chick', 'cologneblue', 'modern', 'myskin', 'nostalgia', 'simple', 'standard', 'filament', 'monobook', 'vector' );

You may also want to allow users to set a User CSS if they want to tweak things inside of Pivot. This is entirely optional.

    # Allow User CSS, mostly for skin testing
    $wgAllowUserCss = true;

## Using Pivot

Questions, open an issue in this repo on Github.
initial commit of all files 2015-10-01 16:00:26 +02:00			`# MediaWiki Pivot Skin`

Setup CircleCI for testing 2020-12-11 15:18:53 +01:00			`[![CircleCI](https://circleci.com/gh/Hutchy68/pivot.svg?style=shield)](https://circleci.com/gh/Hutchy68/pivot)`
scrutinizer badge 2015-11-04 05:28:47 +01:00			`[![Scrutinizer Code Quality](https://scrutinizer-ci.com/g/Hutchy68/pivot/badges/quality-score.png?b=master)](https://scrutinizer-ci.com/g/Hutchy68/pivot/?branch=master)`

Missed a word 2015-10-01 16:50:22 +02:00			`A [MediaWiki](http://www.mediawiki.org) skin that focuses on mobile first but will pivot to all viewports with elegance. Supports responsive layouts and has classes predefined for [Semantic MediaWiki](http://semantic-mediawiki.org/wiki/Semantic_MediaWiki). Built on the [Zurb Foundation 5](http://foundation.zurb.com) CSS framework.`
initial commit of all files 2015-10-01 16:00:26 +02:00
More fixes for CSS of MW 1.32, need to verify earlier MW versions 2019-03-13 02:13:05 +01:00			`Read the docs below (short version) or see [pivot.wikiproject.net](https://pivot.wikiproject.net) for more detailed docs with FAQs and examples of use.`

initial commit of all files 2015-10-01 16:00:26 +02:00			`## Download`

			`First, copy the Pivot source files into your MediaWiki skins directory (see [skinning](https://www.mediawiki.org/wiki/Manual:Skinning) for general information on MediaWiki skins). You can either download the files and extract them from:`

update to the readme.md file 2015-10-01 16:06:23 +02:00			`https://github.com/hutchy68/pivot/archive/master.zip`
initial commit of all files 2015-10-01 16:00:26 +02:00
			You should extract that into a folder named `pivot` in your `skins` directory.

			`Alternatively, you can use git to clone the repository, which makes it very easy to update the code, using:`

			`git clone https://github.com/hutchy68/pivot.git`

			After that, you can issue `git pull` to update the code at anytime.

			`## Setup`

			Once the skin is in place add the following line to your `LocalSettings.php` file.

Updating CHANGELOG.md, add COPYING, last improvements to css and Pivot.skin.php 2017-03-12 21:48:13 +01:00			`wfLoadSkin( 'pivot' );`
initial commit of all files 2015-10-01 16:00:26 +02:00
			`This will activate Pivot in your installation. At this point you can select it as a user skin in your user preferences.`

			To activate Pivot for all users and anonymous visitors, you need to set the `$wgDefaultSkin` variable and set it to `pivot`.

			`$wgDefaultSkin = "pivot";`

Configurations are not beta anymore, they are all functional 2015-10-04 01:12:39 +02:00			`## Configurations`
initial commit of all files 2015-10-01 16:00:26 +02:00
			Use following features in `LocalSettings.php` to change the behavior.

improvements, update to readme.md with config settings 2015-10-04 01:09:14 +02:00			- `'showActionsForAnon' => true` displays page actions for non-logged-in visitors.
Update README.md 2018-02-28 13:54:37 +01:00			- `'fixedNavBar' => false` will allow the NavBar to scroll with the content, `true` will lock the NavBar.
			- `'usePivotTabs' => false` set to true to enable Foundation tabs markup in wiki pages.
improvements, update to readme.md with config settings 2015-10-04 01:09:14 +02:00			- `'showHelpUnderTools' => true` a Link to "Help" will be created under "Tools".
			- `'showRecentChangesUnderTool's => true` a Link to "recent changes" will be created under "Tools".
Update README.md 2018-02-28 13:54:37 +01:00			- `'wikiName' => &$GLOBALS['wgSitename']` default is the sitename. Set to display a short version without changing the systems wikiname.
			- `'wikiNameDesktop' => &$GLOBALS['wgSitename']` default sitename. Set to display a longer name in desktop view.
Fixes for AddThis, test for content pages for social share, updates to changelog and readme 2017-03-21 14:37:11 +01:00			- `'navbarIcon' => false` no icon in mobile view, `true` to use the global set logopath image of the wiki.
Update README.md 2018-02-28 13:54:37 +01:00			- `'preloadFontAwesome' => false` set to true to preload Font Awesome as a `<head>` element. Useful to overcome MIME type server configurations not set correctly.
improvements, update to readme.md with config settings 2015-10-04 01:09:14 +02:00			- `'showFooterIcons' => false` will show text in place of footer icons, `true` will output the icons as globally set.
Fixes for AddThis, test for content pages for social share, updates to changelog and readme 2017-03-21 14:37:11 +01:00			- `'addThisPUBID' => ''` empty string will not fire the AddThis script, `'ra-##-#######'` publisher ID will allow the run the AddThis script in async on content pages only.
			- `'useAddThisShare' => ''` default empty string, do not use AddThis share, `your_addthis_specific_div_class_string` will insert the share toolbox div directly under page title, but before the tagline with your custom div class.
			- `'useAddThisFollow' => ''` default empty string, do not use AddThis follow, `your_addthis_specific_div_class_string` will insert the follow toolbox div in the `right-footer` area before icon or text output with your custom div class.
missing some instructions from README.md 2017-03-20 19:35:05 +01:00
Fixes for AddThis, test for content pages for social share, updates to changelog and readme 2017-03-21 14:37:11 +01:00			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:
initial commit of all files 2015-10-01 16:00:26 +02:00
Fixes for AddThis, test for content pages for social share, updates to changelog and readme 2017-03-21 14:37:11 +01:00			`$wgPivotFeatures = array(`
improvements, update to readme.md with config settings 2015-10-04 01:09:14 +02:00			`'showActionsForAnon' => true,`
			`'fixedNavBar' => false,`
Update README.md 2018-02-28 13:54:37 +01:00			`'usePivotTabs' => false,`
improvements, update to readme.md with config settings 2015-10-04 01:09:14 +02:00			`'showHelpUnderTools' => true,`
			`'showRecentChangesUnderTools' => true,`
			`'wikiName' => &$GLOBALS['wgSitename'],`
			`'wikiNameDesktop' => &$GLOBALS['wgSitename'],`
			`'navbarIcon' => false,`
Update README.md 2018-02-28 13:54:37 +01:00			`'preloadFontAwesome' => false,`
			`'showFooterIcons' => true,`
improvements, update to readme.md with config settings 2015-10-04 01:09:14 +02:00			`'addThisPUBID' => '',`
Fixes for AddThis, test for content pages for social share, updates to changelog and readme 2017-03-21 14:37:11 +01:00			`'useAddThisShare' => '',`
			`'useAddThisFollow' => ''`
Update README.md 2018-02-28 13:54:37 +01:00			`);`
initial commit of all files 2015-10-01 16:00:26 +02:00

			`### Notes on other skins`

update to the readme.md file 2015-10-01 16:06:23 +02:00			As you build a wiki out with Pivot you will likely use the responsive grid from Foundation. This is key to making a responsive wiki, and is one of the largest _migration_ requirements when you want to move a wiki that previously used Vector (and likely a lot of tables for layout) to Pivot. Once you do this, the ability of a user to select whatever skin will be removed. If you take full advantage of Pivot in your templates the lack of the Foundation grid will make viewing the wiki using [Vector](http://wikiapiary.com/wiki/Skin:Vector) or [MonoBook](http://wikiapiary.com/wiki/Skin:MonoBook) very difficult.
initial commit of all files 2015-10-01 16:00:26 +02:00
			Because of this, it is suggested that you set the `$wgSkipSkins` variable to make sure that everyone sees the site as you intended it. This removes other skins from being user selectable options.

			`# Pivot is specific, so lets disable other skins`
			`$wgSkipSkins = array( 'chick', 'cologneblue', 'modern', 'myskin', 'nostalgia', 'simple', 'standard', 'filament', 'monobook', 'vector' );`

			`You may also want to allow users to set a User CSS if they want to tweak things inside of Pivot. This is entirely optional.`

			`# Allow User CSS, mostly for skin testing`
			`$wgAllowUserCss = true;`

			`## Using Pivot`

Setup CircleCI for testing 2020-12-11 15:18:53 +01:00			`Questions, open an issue in this repo on Github.`