Skip to content

Latest commit

 

History

History
85 lines (51 loc) · 3.92 KB

README.md

File metadata and controls

85 lines (51 loc) · 3.92 KB
Raw

MediaWiki Jforeground Skin

MediaWiki skin that focuses on putting your content in the foreground. Supports responsive layouts and has classes predefined for Semantic MediaWiki. Built on the Zurb Foundation CSS framework.

require_once( "$IP/skins/jforeground/jforeground.php" );

This will activate Jforeground in the installation.

Make sure to activate Jforeground for all users and anonymous visitors, you need to set the $wgDefaultSkin variable and set it to jforeground.

$wgDefaultSkin = "jforeground";

Configuration

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

  • showActionsForAnon => true displays page actions for non-logged-in visitors.
  • NavWrapperType => 'divonly': only a div with id navwrapper will be created. '0' - no div will be created (old behavior), other values will be used as class.
  • showHelpUnderTools => true a Link to "Help" will be created under "Tools".
  • showRecentChangesUnderTools => true a Link to "recent changes" will be created under "Tools".
  • wikiName => 'Alternate WikiName' sets top navbar name to a different output of the wiki's name. Useful if your $wgSitename is long but need to keep it for other purposes.
  • navbarIcon => true to display an icon in the top navbar. See below for more information.
  • 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 => 0 suppresses the output of footer icons. Set to true or 1 to display them.
  • addThisFollowPUBID => 'your-id' add an id to display Follow Us horizontal bar of icons from various social media sites available on addThis.

These are the default values:

$wgjForegroundFeatures = array(      
    'showActionsForAnon' => false, // hide actions button for anonymous users
    'NavWrapperType' => 'divonly',
    'showHelpUnderTools' => true,
    'showRecentChangesUnderTools' => true,
    'wikiName' => 'Joomla! Documentation<sup>&#8482;</sup>',
    'navbarIcon' => 1,
    'IeEdgeCode' => 1,
    'showFooterIcons' => 1,
    'addThisFollowPUBID' => 'ra-{code from addthis}'

);

Usage of NavWrapperType

With a setting like:

'NavWrapperType' => 'divonly'

and the created div called navwrapper anonymous visitors can change the setting of navbar (fixed or sticky) by User-Script (Firefox-extensions like greasemonkey or scriptish), users can take a gadget or their JavaScript, CSS ... :

$('#navwrapper').addClass('sticky');

Or you set class in LocalSettings.php with:

'NavWrapperType' => 'contain-to-grid fixed'

and visitors will be able to remove this class by their own JavaScript or gadget ...

Navbar Icon

With a setting like:

'navbarIcon' => true

A top navbar icon will be set using the current image set by $wgLogo in LocalSettings.php. See http://www.mediawiki.org/wiki/Manual:$wgLogo for more information about $wgLogo.

The icon will be resized to fit into a maximum width of 64px x 36px wide or a 16:9 ratio.

AddThis Buttons

With a setting like:

'addThisFollowPUBID' => 'yourAddThis-PubID'

Important, this feature uses the free or paid version of the http://addthis.com horizontal Follow Buttons only. Choose which social media FollowUs buttons(Twitter, Facebook, YouTube, etc.) and at the bottom of the screen locate the script. Within the script you will see something similar ...#pubid=ra-5378f4902d02197">. Everything after the = sign and up to the "> is your Publisher ID. To turn on social follow icons, insert your publisher id:

'addThisFollowPUBID' => 'ra-5378f4902d02197'

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

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