548e94da98
Added to MediaWiki core last year with I9fca9fdf9b7623b1. This fixes a confusing assertion in page-issues/index.test.js, where for "insertBannersOrNotice()" it was asserting that the HTML contain "⧼skin-minerva-issue-learn-more⧽", where the ⧼ character indicates the message is not found (i.e. an error). The test had to be written this way in order to pass, because the skins.minerva.scripts module was not actually loaded, and thus its templates and messages are not present either. This lack was filled in by index.js for mw.templates, but not mw.messages. By adopting private require(), these workarounds can all be removed. == Motivation == In change I3a4024ccf90e505581, I'm working on improving the testrunner config to enforce uselang=qqx on all tests. This is passing except for GrowthExperiments and Minerva, both of which have the above workarounds in place that caused a message to be undefined, and then kept in the assertion expectation. When using uselang=qqx, values are returned as (key) instead of ⧼key⧽, which exposes these message existence errors. By removing this workaround, the test will simply import the module in the test as normal, thus the messages will exist, and thus it will expect (key), and thus it will continue to pass even after enforcing uselang=qqx. Change-Id: Ib68f45d93a7054ed8bd35fc5644e2852f2f90248 |
||
---|---|---|
.phan | ||
.vscode | ||
adr | ||
dev-scripts | ||
i18n | ||
includes | ||
minerva.less | ||
resources | ||
screenshots | ||
skinStyles | ||
tests | ||
.eslintignore | ||
.eslintrc.json | ||
.gitignore | ||
.gitreview | ||
.nvmrc | ||
.phpcs.xml | ||
.stylelintignore | ||
.stylelintrc.json | ||
.svgo.config.js | ||
bundlesize.config.json | ||
CODE_OF_CONDUCT.md | ||
composer.json | ||
COPYING | ||
Doxyfile | ||
jest.config.js | ||
jest.setup.js | ||
jsdoc.json | ||
package-lock.json | ||
package.json | ||
README.md | ||
skin.json |
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.
$wgMinervaDonateLink
- 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.