wikimedia/mediawiki-skins-MinervaNeue
1
0
Fork 0
mirror of https://gerrit.wikimedia.org/r/mediawiki/skins/MinervaNeue synced 2024-11-27 23:50:30 +00:00
Code Issues Packages Projects Releases Wiki Activity

Doc: move config type and defaults near identity

Browse source 
The readme describes all of Minerva's configs and includes a type and
what the default value is at the end of each section. Since the
descriptions for some configs is lengthy, moving the type and default
next to each config's name gives a consistent location for the
information and allows for quick look up without parsing.

Change-Id: I1583c11c80d9b775d93f59302eb2666b754fb412
This commit is contained in:
Stephen Niedzielski 2018-06-28 10:33:11 -05:00 committed by Jdlrobson
parent 4bf2156a2e
commit fde1c1084c
1 changed files with 19 additions and 20 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

39
README.md
View file

@ -22,38 +22,40 @@ The following configuration options will apply only to the default mobile skin -
#### $wgMinervaAlwaysShowLanguageButton #### $wgMinervaAlwaysShowLanguageButton
Whether to show the language switcher button even if no languages are available
for the page.
* Type: `Boolean` * Type: `Boolean`
* Default: `true` * Default: `true`
Whether to show the language switcher button even if no languages are available
for the page.
#### $wgMinervaEnableSiteNotice #### $wgMinervaEnableSiteNotice
* Type: `Boolean`
* Default: `false`
Controls whether site notices should be shown. Controls whether site notices should be shown.
See <https://www.mediawiki.org/wiki/Manual:$wgSiteNotice>. See <https://www.mediawiki.org/wiki/Manual:$wgSiteNotice>.
#### $wgMinervaApplyKnownTemplateHacks
* Type: `Boolean` * Type: `Boolean`
* Default: `false` * Default: `false`
#### $wgMinervaApplyKnownTemplateHacks
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. 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: `Boolean`
* Default: `false`
#### $wgMinervaPageActions #### $wgMinervaPageActions
Controls which page actions, if any, are displayed. Allowed: `edit`, `watch`, `talk`, and
`switch-language`.
* Type: `Array` * Type: `Array`
* Default: `['edit', 'talk', 'watch', 'switch-language']` * Default: `['edit', 'talk', 'watch', 'switch-language']`
Controls which page actions, if any, are displayed. Allowed: `edit`, `watch`, `talk`, and
`switch-language`.
#### $wgMinervaCustomLogos #### $wgMinervaCustomLogos
* Type: `Array`
* Default: `[]`
Make the logos configurable. Make the logos configurable.
Currently, `copyright`, `copyright-fallback`, `copyright-width`, and `copyright-height` elements are Currently, `copyright`, `copyright-fallback`, `copyright-width`, and `copyright-height` elements are
@ -91,18 +93,18 @@ Example with fallback URL:
] ]
``` ```
* Type: `Array`
* Default: `[]`
#### $wgMinervaAlwaysShowLanguageButton #### $wgMinervaAlwaysShowLanguageButton
Whether to show the language switcher button even if no languages are available for the page.
* Type: `Boolean` * Type: `Boolean`
* Default: `true` * Default: `true`
Whether to show the language switcher button even if no languages are available for the page.
#### $wgMinervaABSamplingRate #### $wgMinervaABSamplingRate
* Type: `Number`
* Default: `0`
On a scale of 0 to 1, determines the chance a user has of entering an AB test. 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 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 test have an equal chance of entering bucket "A" or "B", the remaining users fall into the
@ -129,6 +131,3 @@ Group membership can be debugged from the console via:
And since session ID is an input in calculating the group, reassignment occurs And since session ID is an input in calculating the group, reassignment occurs
when clearing it: `mw.storage.session.remove('mwuser-sessionId')`. when clearing it: `mw.storage.session.remove('mwuser-sessionId')`.
* Type: `Number`
* Default: `0`