Jdlrobson has uploaded a new change for review. ( https://gerrit.wikimedia.org/r/357316 )
Change subject: Docs: Separate Minerva and MobileFrontend config options in README ...................................................................... Docs: Separate Minerva and MobileFrontend config options in README Change-Id: Ibdb124a76a9312f156b645d8e23531cbc5cd7e42 --- M README.md 1 file changed, 76 insertions(+), 69 deletions(-) git pull ssh://gerrit.wikimedia.org:29418/mediawiki/extensions/MobileFrontend refs/changes/16/357316/1 diff --git a/README.md b/README.md index 94fcdcd..64b78dc 100644 --- a/README.md +++ b/README.md @@ -87,6 +87,9 @@ Configuration options --------------------- +### MobileFrontend +The following configuration options will apply to all skins operating in useformat=mobile mode. + #### $wgMFEnableXAnalyticsLogging Whether or not to enable the use of the X-Analytics HTTP response header. This @@ -96,14 +99,6 @@ * Type: `Boolean` * Default: `false` - -#### $wgMinervaAlwaysShowLanguageButton - -Whether to show the language switcher button even if no languages are available -for the page. - -* Type: `Boolean` -* Default: `true` #### $wgMFAppPackageId @@ -224,14 +219,6 @@ * Type: `Boolean` * Default: `false` -#### $wgMinervaEnableSiteNotice - -Controls whether site notices should be shown. -See <https://www.mediawiki.org/wiki/Manual:$wgSiteNotice>. - -* Type: `Boolean` -* Default: `false` - #### $wgMFTidyMobileViewSections Controls whether API `action=mobileview` should have every HTML section tidied @@ -332,21 +319,6 @@ 'ppprop' => 'displaytitle', ] ``` - -#### $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. - -* Type: `Boolean` -* Default: `false` - -#### $wgMinervaPageActions - -Controls which page actions, if any, are displayed. Allowed: `edit`, `watch`, `talk`, and -`switch-language`. - -* Type: `Array` -* Default: `['edit', 'talk', 'watch', 'switch-language']` #### $wgMFQueryPropModules @@ -492,36 +464,6 @@ * Type: `String|null` * Default: `null` -#### $wgMinervaCustomLogos - -Make the logos configurable. - -Currently, `copyright`, `copyright-width`, and `copyright-height` elements are -supported. - -* `copyright` is the URL of the logo displayed in the header and footer -* `copyright-width` (optional) is the width in pixels of the copyright image - you want to display -* `copyright-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: -```php -[ - 'copyright' => '/images/mysite_copyright_logo.png', - 'copyright-width' => 100, - 'copyright-height' => 15, -] -``` - -* Type: `Array` -* Default: `[]` - #### $wgMobileFrontendLogo Path to the logo used in the login/signup form. The standard height is `72px` @@ -552,14 +494,6 @@ * Type: `String` * Default: `'SkinMinerva'` - -#### $wgMinervaAlwaysShowLanguageButton - -Whether to show the language switcher button even if no languages are available for the page. - -* Type: `Boolean` -* Default: `true` - #### $wgMFNamespacesWithoutCollapsibleSections @@ -687,3 +621,76 @@ "image/svg+xml", ] ``` + +### Minerva +The following configuration options will apply only to the default mobile skin - Minerva. + +#### $wgMinervaAlwaysShowLanguageButton + +Whether to show the language switcher button even if no languages are available +for the page. + +* Type: `Boolean` +* Default: `true` + +#### $wgMinervaEnableSiteNotice + +Controls whether site notices should be shown. +See <https://www.mediawiki.org/wiki/Manual:$wgSiteNotice>. + +* Type: `Boolean` +* 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. + +* Type: `Boolean` +* Default: `false` + +#### $wgMinervaPageActions + +Controls which page actions, if any, are displayed. Allowed: `edit`, `watch`, `talk`, and +`switch-language`. + +* Type: `Array` +* Default: `['edit', 'talk', 'watch', 'switch-language']` + +#### $wgMinervaCustomLogos + +Make the logos configurable. + +Currently, `copyright`, `copyright-width`, and `copyright-height` elements are +supported. + +* `copyright` is the URL of the logo displayed in the header and footer +* `copyright-width` (optional) is the width in pixels of the copyright image + you want to display +* `copyright-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: +```php +[ + 'copyright' => '/images/mysite_copyright_logo.png', + 'copyright-width' => 100, + 'copyright-height' => 15, +] +``` + +* Type: `Array` +* Default: `[]` + +#### $wgMinervaAlwaysShowLanguageButton + +Whether to show the language switcher button even if no languages are available for the page. + +* Type: `Boolean` +* Default: `true` + -- To view, visit https://gerrit.wikimedia.org/r/357316 To unsubscribe, visit https://gerrit.wikimedia.org/r/settings Gerrit-MessageType: newchange Gerrit-Change-Id: Ibdb124a76a9312f156b645d8e23531cbc5cd7e42 Gerrit-PatchSet: 1 Gerrit-Project: mediawiki/extensions/MobileFrontend Gerrit-Branch: master Gerrit-Owner: Jdlrobson <[email protected]> _______________________________________________ MediaWiki-commits mailing list [email protected] https://lists.wikimedia.org/mailman/listinfo/mediawiki-commits
