Tema mobile GolemWiki
Go to file
Piotr Miazga 209becf63d PageActions menu should use Builder pattern
The PageActions menu shouldn't be built inside SkinMinerva class.
All menus should be build in similar way so it's easier to understand
how different parts of the system work. This will allow us to easily
track different menu elements/move elements between different menus.

Additionally we should allow extensions/3rd party to modify both the
toolbar and overflow menus.

Changes:
 - Removed PageActions logic from SkinMinerva class
 - introduced new PageActions/Director to build page actions menu
 - introduced Builders for toolbar, and different types of overflow
 menu
 - because Overflow menu elements require the
 BaseTemplate::data['nav_urls] array, instead building all links,
 pass the array when building PageActions menu. Code for getting
 menu entries had to be rewritten (use $navUrls array instead of
 $this->tpl['nav_urls'];
 - ServiceWirings file contains logic on what to pass to
 PageActions/Director class (which builders)
 - PageActionsMenuEntry setTitle() and setNodeID() returns $this
 so we can use method chaining. Only a syntax sugar.
 - if AMC is not available/Overflow menu is disabled via config,
 system will pass EmptyOverflowBuilder. System will not add
 "show more" icon to toolbar menu when $overflowBuilder returns
 empty set of options.
 - both ToolbarBulder and OverflowMenuBuilders (except
 EmptyOverflowBuilder) will run 'MobileMenu' hook. Extensions should
 listen to hook, and inject it's own menu entries at their leisure.

Required follow-ups:
 - SkinMinerva provides isAllowedAction() method which is used
 both in the skin code and in Toolbar builder. We should extract
 that method into separate service
 - SkinMinerva provides getHistoryUrl() method which is used
 both in the skin code and in Toolbar builder. We should provide
 MinervaUrls service that knows how to build custom mobile URLs.

Bug: T221792
Change-Id: Ie08c4b61cea60c3a42fbf796a39360feea22bc33
2019-06-05 21:07:40 +02:00
dev-scripts Hygiene: remove unused pre-commit script 2018-09-18 17:01:31 +00:00
i18n Localisation updates from https://translatewiki.net. 2019-06-02 22:00:52 +02:00
includes PageActions menu should use Builder pattern 2019-06-05 21:07:40 +02:00
minerva.less Adds AMC styles for action=history page 2019-05-22 14:24:43 +02:00
resources Adding a reflist.less file to hold Template:Reflist specific styles 2019-06-03 14:27:50 +02:00
screenshots Add skin screenshot for the installer 2017-08-11 15:36:05 -04:00
skinStyles Fix z-index issue with button on action=history page 2019-05-27 16:48:09 +02:00
tests Hygiene: SkinUserPageHelper should support Title = null 2019-06-04 17:17:58 +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
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: Upgrade eslint-config-wikimedia 0.12.0, drop grunt-jsonlint 2019-05-06 13:52:00 -07:00
README.md Change MinervaSchemaMainMenuClickTrackingSampleRate default in README 2019-04-23 01:25:15 +00:00
Rakefile Port browser tests from MobileFrontend to Minerva 2017-07-11 14:11:03 -07:00
composer.json build: Updating mediawiki/mediawiki-codesniffer to 24.0.0 2019-02-07 07:51:12 +00:00
jsdoc.json Hygiene: enable syntax highlighting in JSDoc comments 2018-07-31 09:08:35 +00:00
package.json build: Upgrade wdio-mocha-framework to be node10 compatible 2019-06-03 14:58:56 -07:00
skin.json Merge "JSON content: Fix table margins" 2019-05-09 17:31:21 +00:00

README.md

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