Go to file
Stephen Niedzielski 815f3386e3 Update: add secondary page actions submenu in AMC mode
When advanced mobile contributions mode is enabled and
`$wgMinervaOverflowInPageActions` is set, show a secondary overflow menu
on main namespace articles and user namespace pages. The menu content
varies for each namespace. The new submenu is *disabled* by default,
even when AMC is active. This feature should not be deployed until
instrumentation is available.

The secondary menu is rendered in PHP using the existing menu system
with some changes to the template. The checkbox hack is needed for no-
JavaScript keyboard navigation until :focus-within is supported. CSS
additions are documented in the source.

All client side toolbar execution occurs in Toolbar.js. Enhancements are
documented in the source.

Minor changes to the existing download button:
- Move download and edit button initialization to Toolbar.
- Update copy (not visible) from "Download" to "Download PDF".
- When the overflow menu is present, use the "hasText" / label style.

Wikimedia UI icons are copied from OOUI at d00a0ac and seem useful to
expose as HTTP URIs (not data URIs).

The overflow menu does not show for pages provided by the content proxy
since its entries depend on $tpl->data['nav_urls'] being populated.

Bug: T216418
Depends-On: I0781151a8232b6a7b52f79a34298afcecb8e4271
Change-Id: I4b50a0e519024a7ab91dae6ab40b23cf14a03861
2019-04-19 14:51:17 +00:00
dev-scripts Hygiene: remove unused pre-commit script 2018-09-18 17:01:31 +00:00
i18n Update: add secondary page actions submenu in AMC mode 2019-04-19 14:51:17 +00:00
includes Update: add secondary page actions submenu in AMC mode 2019-04-19 14:51:17 +00:00
minerva.less Update: add secondary page actions submenu in AMC mode 2019-04-19 14:51:17 +00:00
resources Update: add secondary page actions submenu in AMC mode 2019-04-19 14:51:17 +00:00
screenshots Add skin screenshot for the installer 2017-08-11 15:36:05 -04:00
skinStyles Remove .background-size() mixin usage 2019-04-03 18:02:48 -07:00
tests Provide a code structure for menus handling and add Advanced menu 2019-04-16 13:19:51 +02:00
.eslintrc.json Hygiene: improve ESLint globals readability 2019-02-21 07:54:04 -07:00
.gitignore Adding initial webdriver.io test 2019-04-08 16:05:22 -07:00
.gitreview Use track=1 instead of defaultbranch=master in .gitreview 2016-10-24 17:30:30 -07:00
.phpcs.xml build: Update sniff list in .phpcs.xml 2018-12-08 15:34:19 +01:00
.rubocop.yml Port browser tests from MobileFrontend to Minerva 2017-07-11 14:11:03 -07:00
.rubocop_todo.yml Update RuboCop Ruby gem 2017-12-06 16:58:29 +01:00
.stylelintrc.json Remove .background-size() mixin usage 2019-04-03 18:02:48 -07:00
.svgo.yml Hygiene: Bring missing SVGO config file from MobileFrontend 2017-08-30 23:14:55 +00:00
CODE_OF_CONDUCT.md build: Updating mediawiki/mediawiki-codesniffer to 22.0.0 2018-09-04 01:31:06 +00:00
composer.json build: Updating mediawiki/mediawiki-codesniffer to 24.0.0 2019-02-07 07:51:12 +00:00
COPYING Add COPYING 2018-04-15 16:13:17 -07:00
Doxyfile Add MinervaNeue Doxyfile 2017-08-15 15:31:57 +00:00
Gemfile Update RuboCop Ruby gem 2017-12-06 16:58:29 +01:00
Gemfile.lock Update RuboCop Ruby gem 2017-12-06 16:58:29 +01:00
Gruntfile.js build: Run stylelint also for css 2019-02-16 15:28:41 +01:00
jsdoc.json Hygiene: enable syntax highlighting in JSDoc comments 2018-07-31 09:08:35 +00:00
package.json Run Minerva browser tests against the mobile domain 2019-04-11 15:43:52 +00:00
Rakefile Port browser tests from MobileFrontend to Minerva 2017-07-11 14:11:03 -07:00
README.md Update: add secondary page actions submenu in AMC mode 2019-04-19 14:51:17 +00:00
skin.json Update: add secondary page actions submenu in AMC mode 2019-04-19 14:51:17 +00: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.

$wgMinervaCountErrors

  • Type: Boolean
  • Default: false

Whether to count client side errors in statsv.

$wgMinervaErrorLogSamplingRate

  • Type: Integer
  • Default: 0

Whether to log client side errors to EventLogging. If 0, error logging is disabled. If 0.5, 50% of all client side errors will be logged to the EventLogging client. If 1, all errors will be logged to the EventLogging client, thus when enabling this care should be taken that your setup is bug free in order to not overwhelm the EventLogging server.

$wgMinervaShowCategoriesButton

  • Type: Array
  • Default:
  [
    'base' => false,
    'beta' => true,
  ]

Controls whether the category button should be displayed.

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

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

$wgMinervaOverflowInPageActions

  • Type: Array
  • Default:
  [
    'beta' => false,
    'base' => false,
    'amc' => false,
  ]

Controls whether the overflow link appears in the page actions menu.

$wgMinervaShowShareButton

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

Controls whether the share feature should be added to the page actions menu.

$wgMinervaEnableBackToTop

  • Type: Array
  • Default:
  [
    'base' => false,
    'beta' => true,
  ]

Controls whether the a back to top button should appear in the bottom right of the screen when scrolling.

$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 footer
  • copyright-fallback is the URL of the fallback logo displayed on non-supported browsers like IE8 or Opera Mini
  • 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:

[
  '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({
    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').

$wgMinervaSchemaMainMenuClickTrackingSampleRate

Defines the sampling rate for the MobileWebMainMenuClickTracking schema.

  • Type: Number
  • Default: 0.5