Go to file
Ed Sanders 527e018af1 Remove all use of IIFEs across Minerva codebase
These will make JSDoc easier to configure later and is
better suited to ES6 module format.
The dependency injection pattern can be retained by moving
the import to the top of the file.

Change-Id: I0fe692eb7066e52815ef3d21724c7439d82b2c5f
2024-06-28 18:54:38 +00:00
.phan Add soft dependency on Minerva to Vector 2024-03-21 21:05:47 +00:00
.vscode
adr (Almost) no more CSS variables in minerva 2024-06-11 11:44:47 -07:00
dev-scripts Remove storybook and update nvm version 2023-03-31 09:39:56 -07:00
i18n Localisation updates from https://translatewiki.net. 2024-06-26 09:23:54 +02:00
includes Merge "Improve Minerva drop-shadows in dark-mode" 2024-06-12 16:02:29 +00:00
minerva.less (Almost) no more CSS variables in minerva 2024-06-11 11:44:47 -07:00
resources Remove all use of IIFEs across Minerva codebase 2024-06-28 18:54:38 +00:00
screenshots
skinStyles Temporary fix for enabling Mobile VisualEditor in night mode 2024-06-20 16:36:51 -04:00
tests tests: Use renamed class BundleSizeTestBase 2024-06-12 20:37:51 +02:00
.eslintignore Add --color-link--visited to night mode palette 2024-02-16 09:35:19 -05:00
.eslintrc.json build: Updating composer dependencies 2022-05-21 19:11:15 +00:00
.gitignore Allow us to write Jest tests! 2024-02-13 23:45:26 +00:00
.gitreview
.nvmrc .nvmrc: Update now we're using Node 18 2024-01-11 10:50:43 -05:00
.phpcs.xml Improve PHP code style 2024-02-28 08:59:17 +00:00
.stylelintignore build: Add coverage folder to .stylelintignore 2024-03-01 22:36:41 +01:00
.stylelintrc.json build: Update linters 2024-01-24 22:02:12 +00:00
.svgo.config.js build: Update SVGO to v3.0.2 2023-07-25 00:31:36 +00:00
bundlesize.config.json Merge "Create dark-mode launch banner component" 2024-05-24 20:22:56 +00:00
CODE_OF_CONDUCT.md
composer.json build: Updating dependencies 2024-05-06 04:45:08 +00:00
COPYING
Doxyfile
jest.config.js Allow us to write Jest tests! 2024-02-13 23:45:26 +00:00
jest.setup.js Allow us to write Jest tests! 2024-02-13 23:45:26 +00:00
jsdoc.json Remove all use of IIFEs across Minerva codebase 2024-06-28 18:54:38 +00:00
package-lock.json build: Updating dependencies 2024-05-06 04:45:08 +00:00
package.json build: Updating dependencies 2024-04-23 14:32:08 +00:00
README.md Merge "Remove MinervaKnownTemplateHacks" 2024-04-25 19:25:36 +00:00
skin.json Temporary fix for enabling Mobile VisualEditor in night mode 2024-06-20 16:36:51 -04: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.

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

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

$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 = 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').

$wgMinervaNightMode

  • Type: array
  • Default:
  [
    'base' => false,
  ]

Temporary feature flag for enabling the night mode feature.

$wgMinervaNightModeOptions

  • Type: array
  • Default:
  [
    "exclude" => [
        "mainpage" => false,
        "querystring" => [],
        "namespaces" => [],
        "pagetitles" => []
    ]
  ]

Allows the disabling of the night theme on certain pages. NOTE: Vector skin must be enabled to use this functionality.