874d9c9e3b
From TypeScript's do's and don'ts:[0] Don’t ever use the types Number, String, Boolean, or Object. These types refer to non-primitive boxed objects that are almost never used appropriately in JavaScript code. Although Minerva only uses JSDocs at this time which seemingly doesn't care about casing[1], we should endeavor to use the proper return types. This patch lowercases typing to indicate primitive / boxed type as appropriate.[2] As a special case, function types are uppercased for compatibility with TypeScript type checking. Also, JQuery types are of type "JQuery". The global JQuery object's identifier is "jQuery". This patch uppercases J's where appropriate. Lastly, replace unsupported type "Integer" with "number" and a comment. [0] https://www.typescriptlang.org/docs/handbook/declaration-files/do-s-and-don-ts.html#general-types [1] https://github.com/jsdoc3/jsdoc/issues/1046#issuecomment-126477791 [2] find resources tests -iname \*.js| xargs -rd\\n sed -ri ' s%\{\s*(number|string|boolean|object|null|undefined)%{\L\1%gi; s%\{\s*function%{Function%g; s%\{\s*jquery%{JQuery%gi; s%\{\s*integer\s*\}%{number} An integer.%gi ' Change-Id: I6cbac15940e4501aee7ede8f421b77ffd027170d |
||
---|---|---|
dev-scripts | ||
i18n | ||
includes | ||
minerva.less | ||
resources | ||
screenshots | ||
skinStyles | ||
tests | ||
.eslintrc.json | ||
.gitignore | ||
.gitreview | ||
.phpcs.xml | ||
.rubocop.yml | ||
.rubocop_todo.yml | ||
.stylelintrc.json | ||
.svgo.yml | ||
CODE_OF_CONDUCT.md | ||
composer.json | ||
COPYING | ||
Doxyfile | ||
Gemfile | ||
Gemfile.lock | ||
Gruntfile.js | ||
jsdoc.json | ||
MinervaNeue.php | ||
package-lock.json | ||
package.json | ||
Rakefile | ||
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.
$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 footercopyright-fallback
is the URL of the fallback logo displayed on non-supported browsers like IE8 or Opera Minicopyright-width
(optional) is the width in pixels of the copyright image you want to displaycopyright-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(
'WME.PageIssuesAB',
mw.config.get( 'wgMinervaABSamplingRate', 0 ),
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')
.