Go to file
Stephen Niedzielski 27ea969762 Hygiene: limit ESLint inheritance
The project ESLint configuration unintentionally inherited unwanted
configuration from MediaWiki, which allows global jQuery usage. Cap the
project's ESLint hierarchy at the project root.

Change-Id: Iceda39a4eeb492446b952f597af0f153cf345206
2018-10-05 10:22:11 -06:00
dev-scripts Hygiene: remove unused pre-commit script 2018-09-18 17:01:31 +00:00
i18n Localisation updates from https://translatewiki.net. 2018-10-04 22:05:17 +02:00
includes Merge "Make Minerva section editing more like other skins" 2018-10-04 21:26:03 +00:00
minerva.less mobile.editor.ve: Simplify left/right border of toolbar on >1000px screens 2018-09-17 21:55:18 +00:00
resources Merge "Make Minerva section editing more like other skins" 2018-10-04 21:26:03 +00:00
screenshots Add skin screenshot for the installer 2017-08-11 15:36:05 -04:00
skinStyles Remove 'mobile.editor.ve' styles (move to MobileFrontend) 2018-09-17 21:55:39 +00:00
tests Remove user page CTA edit link browser test (move to MobileFrontend) [try #2] 2018-09-25 18:05:10 +00:00
.eslintrc.json Hygiene: limit ESLint inheritance 2018-10-05 10:22:11 -06:00
.gitignore Hygiene: improve ESLint config 2018-09-17 23:35:24 +00:00
.gitreview Use track=1 instead of defaultbranch=master in .gitreview 2016-10-24 17:30:30 -07:00
.phpcs.xml Fix some file names to match their class names 2018-04-15 16:12:45 -07:00
.rubocop.yml Port browser tests from MobileFrontend to Minerva 2017-07-11 14:11:03 -07:00
.rubocop_todo.yml Update RuboCop Ruby gem 2017-12-06 16:58:29 +01:00
.stylelintrc.json build: Update linters 2018-09-11 13:42:11 -07:00
.svgo.yml Hygiene: Bring missing SVGO config file from MobileFrontend 2017-08-30 23:14:55 +00:00
CODE_OF_CONDUCT.md build: Updating mediawiki/mediawiki-codesniffer to 22.0.0 2018-09-04 01:31:06 +00:00
composer.json build: Updating mediawiki/phan-taint-check-plugin to 1.5.0 2018-09-08 08:22:21 +00:00
COPYING Add COPYING 2018-04-15 16:13:17 -07:00
Doxyfile Add MinervaNeue Doxyfile 2017-08-15 15:31:57 +00:00
Gemfile Update RuboCop Ruby gem 2017-12-06 16:58:29 +01:00
Gemfile.lock Update RuboCop Ruby gem 2017-12-06 16:58:29 +01:00
Gruntfile.js Hygiene: improve ESLint config 2018-09-17 23:35:24 +00:00
jsdoc.json Hygiene: enable syntax highlighting in JSDoc comments 2018-07-31 09:08:35 +00:00
package-lock.json Hygiene: move JSDoc and SVGO to devDependencies 2018-07-19 08:10:56 -05:00
package.json build: Update linters 2018-09-11 13:42:11 -07:00
Rakefile Port browser tests from MobileFrontend to Minerva 2017-07-11 14:11:03 -07:00
README.md Move MainMenu click tracking schema from MobileFrontend to Minerva 2018-10-02 15:03:17 -07:00
skin.json Merge "Make Minerva section editing more like other skins" 2018-10-04 21:26:03 +00:00

MinervaNeue skin

The MinervaNeue skin is a responsive mobile-first skin for your mediawiki instance.

Installation

See https://www.mediawiki.org/wiki/Skin:MinervaNeue

Development

Coding conventions

Please follow the coding conventions of MobileFrontend: https://www.mediawiki.org/wiki/MobileFrontend/Coding_conventions

Config

The following configuration options will apply only to the default mobile skin - Minerva.

$wgMinervaAlwaysShowLanguageButton

  • Type: Boolean
  • Default: true

Whether to show the language switcher button even if no languages are available for the page.

$wgMinervaEnableSiteNotice

  • Type: Boolean
  • Default: false

Controls whether site notices should be shown. See https://www.mediawiki.org/wiki/Manual:$wgSiteNotice.

$wgMinervaErrorLogSamplingRate

  • Type: Integer
  • Default: 0

Whether to log client side errors to EventLogging. If 0, error logging is disabled. If 0.5, 50% of all client side errors will be logged to the EventLogging client. If 1, all errors will be logged to the EventLogging client, thus when enabling this care should be taken that your setup is bug free in order to not overwhelm the EventLogging server.

$wgMinervaApplyKnownTemplateHacks

  • Type: Boolean
  • Default: false

When enabled and hacks.less exists, hacks.less workarounds are included in stylesheet. These should only be needed for Wikimedia based wikis or wikis using common templates such as Template:Infobox on those wikis.

$wgMinervaPageActions

  • Type: Array
  • Default: ['edit', 'talk', 'watch', 'switch-language']

Controls which page actions, if any, are displayed. Allowed: edit, watch, talk, and switch-language.

$wgMinervaCustomLogos

  • Type: Array
  • Default: []

Make the logos configurable.

Currently, copyright, copyright-fallback, copyright-width, and copyright-height elements are supported.

  • copyright is the URL of the logo displayed in the header and footer
  • copyright-fallback is the URL of the fallback logo displayed on non-supported browsers like IE8 or Opera Mini
  • copyright-width (optional) is the width in pixels of the copyright image you want to display
  • copyright-height (optional) is the height in pixels of the copyright image you want to display
  • If the actual copyright dimensions are 200x30, then you may want to set the width and height to 100 and 15 respectively (in order to support retina screens).
  • Note that if -width and -height are not used sysadmin should ensure the image used is appropriately sized (suggested dimensions < 120px width and 18px height).

Example:

[
  'copyright' => '/images/mysite_copyright_logo.png',
  'copyright-width' => 100,
  'copyright-height' => 15,
]

Example with fallback URL:

[
  'copyright' => '/images/mysite_copyright_logo.svg',
  'copyright-fallback' => '/images/mysite_copyright_logo.svg.png',
  'copyright-width' => 100,
  'copyright-height' => 15,
]

$wgMinervaAlwaysShowLanguageButton

  • Type: Boolean
  • Default: true

Whether to show the language switcher button even if no languages are available for the page.

$wgMinervaABSamplingRate

  • Type: Number
  • Default: 0

On a scale of 0 to 1, determines the chance a user has of entering an AB test. A test is divided into 3 buckets, "control" "A" and "B". Users that are selected for the test have an equal chance of entering bucket "A" or "B", the remaining users fall into the "control" bucket and are excluded from the test.

1 - would run test on 100% of users (50% in A and 50% in B, 0 in control). 0.5 - would run test on 50% of users (25% in A, 25% in B, 50% in control). 0.05 - would run test on 5% of users (2.5% in A, 2.5% in B, 95% in control). 0 would disable the test and place all users in "control".

Group assignment is universal no matter how many tests are running since both wgMinervaABSamplingRate and mw.user.sessionId() are globals.

Group membership can be debugged from the console via:

  const AB = mw.mobileFrontend.require('skins.minerva.scripts/AB')
  new AB({
    testName: 'WME.PageIssuesAB',
    samplingRate: mw.config.get( 'wgMinervaABSamplingRate', 0 ),
    sessionId: mw.user.sessionId()
  }).getBucket()

And since session ID is an input in calculating the group, reassignment occurs when clearing it: mw.storage.session.remove('mwuser-sessionId').

$wgMinervaSchemaMainMenuClickTrackingSampleRate

Defines the sampling rate for the MobileWebMainMenuClickTracking schema.

  • Type: Number
  • Default: 0.5