Go to file
jdlrobson aba173efc6 Remove non-standard components folder
For skins, all templates should be in the same folder. This
is for security reasons, to limit access of templates to files
that are not templates. This also adds consistency with other skins
where templates are all in the same subdirectory. It also allows
us to reduce the creation of TemplateParser instances.

Note: All styles and scripts should be in the resources folder but this
is not rectified by this patchset. Will be done in follow ups following
more discussion.

This begins this work in the least disruptive way possible and drops
the README note to avoid this pattern growing.

Bug: T292558
Change-Id: I4c2e115451c0a76c742734730712814c1f1d838d
2021-10-06 20:13:48 +00:00
.phan Remove Echo phan config as MobileFrontend doesn't depend upon Echo 2019-10-22 23:08:50 +02:00
.storybook Use MediaWiki UI version 2 from core in Minerva 2021-07-20 11:59:23 -07:00
.vscode Selenium: Setup Visual Studio code debugging 2020-07-08 07:49:13 -07:00
dev-scripts Use MediaWiki UI version 2 from core in Minerva 2021-07-20 11:59:23 -07:00
i18n Localisation updates from https://translatewiki.net. 2021-10-06 09:30:23 +02:00
includes Remove non-standard components folder 2021-10-06 20:13:48 +00:00
minerva.less Minerva uses centralized link styling colors 2021-09-02 14:55:24 +00:00
resources Remove non-standard components folder 2021-10-06 20:13:48 +00:00
screenshots
skinStyles Revert "Search header should be vertically centered, not top aligned." 2021-09-29 08:30:03 +00:00
stories Add alt attribute to logo 2021-09-22 02:01:42 +00:00
tests DownloadAsPdf follow ups 2021-09-28 10:49:58 -07:00
.eslintignore build: Replace Grunt with npm scripts for eslint, stylelint, and banana-checker 2021-04-13 21:09:32 +00:00
.eslintrc.js build: Replace Grunt with npm scripts for eslint, stylelint, and banana-checker 2021-04-13 21:09:32 +00:00
.gitignore build: Updating mediawiki/mediawiki-codesniffer to 33.0.0 2020-11-05 16:18:11 +00:00
.gitreview
.nvmrc .nvmrc: Update to Node 12.21.0 as CI has migrated 2021-06-04 14:42:37 -07:00
.phpcs.xml build: Updating dependencies 2021-03-12 08:17:22 +00:00
.rubocop.yml
.rubocop_todo.yml Update RuboCop Ruby gem 2017-12-06 16:58:29 +01:00
.stylelintignore build: Replace Grunt with npm scripts for eslint, stylelint, and banana-checker 2021-04-13 21:09:32 +00:00
.stylelintrc.json build: Updating stylelint-config-wikimedia to 0.11.1 2021-09-05 00:55:47 +00:00
.svgo.config.js build: Upgrade 'svgo' to latest and re-crush SVGs 2021-04-20 17:45:18 +00:00
bundlesize.config.json Increase mediawiki ui icon and button bundlesizes 2021-09-13 22:12:54 +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 composer dependencies 2021-09-10 13:32:50 +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
jsdoc.json Hygiene: enable syntax highlighting in JSDoc comments 2018-07-31 09:08:35 +00:00
package-lock.json build: Updating stylelint-config-wikimedia to 0.11.1 2021-09-05 00:55:47 +00:00
package.json build: Updating stylelint-config-wikimedia to 0.11.1 2021-09-05 00:55:47 +00:00
Rakefile
README.md Remove non-standard components folder 2021-10-06 20:13:48 +00:00
skin.json Remove non-standard components folder 2021-10-06 20:13:48 +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.

$wgMinervaShowCategories

  • Type: Array
  • Default:
  [
    'base' => false,
    'beta' => true,
  ]

Controls whether the category button should be displayed.

$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.

  • Type: Array
  • Default:
  [
    'base' => true,
  ]

When enabled a donate link will be added to the main menu. The donate link uses the sitesupport and sitesupport-url mediawiki messages.

$wgMinervaPageActions

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

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

$wgMinervaPageIssuesNewTreatment

  • Type: Array
  • Default:
  [
    'base' => false,
    'beta' => true,
  ]

Controls whether page issues should be replaced with a "Page issues" link (false) or displayed inline (true).

$wgMinervaTalkAtTop

  • Type: Array
  • Default:
  [
    'beta' => false,
    'base' => false,
    'amc' => true,
  ]

Controls whether the talk option should be displayed at the top of the page. This will work for all pages except the main page.

$wgMinervaHistoryInPageActions

  • Type: Array
  • Default:
  [
    'beta' => false,
    'base' => false,
    'amc' => true,
  ]

Controls whether the history link appears in the page actions menu.

$wgMinervaAdvancedMainMenu

  • Type: Array
  • Default:
  [
    'beta' => false,
    'base' => false,
    'amc' => true,
  ]

Controls whether the main menu is expanded to contain recent changes and various options that require login are removed. Note, should be enabled alongside $wgMinervaPersonalMenu to avoid losing access to features (in particular logout button).

$wgMinervaPersonalMenu

  • Type: Array
  • Default:
  [
    'beta' => false,
    'base' => false,
    'amc' => true,
  ]

Controls whether a personal menu appears in the header chrome. This menu contains pages such as Special:Watchlist. Note, should be enabled alongside $wgMinervaAdvancedMainMenu to avoid duplicating links to functionality as many of the links duplicate links in the standard main menu. Note a sandbox link will be present if the extension SandboxLink is enabled.

$wgMinervaOverflowInPageActions

  • Type: Array
  • Default:
  [
    'beta' => false,
    'base' => false,
    'amc' => false,
  ]

Controls whether the overflow link appears in the page actions menu.

Controls whether the share feature should be added to the page actions menu.


#### $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:

```js
  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').