Go to file
Stephen Niedzielski de76ab59c1 [Special:Preferences] [PHP] Add skin version user preference and configs
Add a Vector-specific user preference to Special:Preferences for
toggling skin version, either Legacy Vector or the latest Vector.

The presentation of the new preference section and the default values
for anonymous, new, and existing accounts are configurable via
$wgVectorShowSkinPreferences, $wgVectorDefaultSkinVersion (to be used by
the feature manager in T244481),
$wgVectorDefaultSkinVersionForExistingAccounts, and
$wgVectorDefaultSkinVersionForNewAccounts. These configurations default
to the fullest experience so that third-party configuration is minimal.
See skin.json for details. The configurations are each tested in
VectorHooksTest.php.

When presentation is enabled, the new preference appears as a checkbox;
enabled is Legacy mode and disable is latest. There are a number of
unfortunate details:

- Showing and hiding a checkbox is supported by OOUI. Showing and hiding
  a whole section (Vector skin preferences, in this case) is not so this
  additional client JavaScript functionality is added in Core (see
  Iaf68b238a8ac7a4fb22b9ef5d6c5a3394ee2e377).
- Stylization as a checkbox is wanted. However, the implied storage type
  for OOUI checkboxes is a boolean. This is not wanted in the event that
  another skin version is added (e.g., '3' or 'alpha'). As a workaround,
  the preference is converted from a boolean to a version string ('1' or
  '2') on save in Hooks::onPreferencesFormPreSave() and from a version
  string to a checkbox enable / disable string ('1' or '0') in
  onGetPreferences(). There a number of test cases to help cover these
  concerning details.

Documentation for overriding the skin version as a URL query parameter
is provided in anticipation of T244481.

Bug: T242381
Bug: T245793
Depends-On: Iaf68b238a8ac7a4fb22b9ef5d6c5a3394ee2e377
Depends-On: Ifc2863fca9cd9efd11ac30c780420e8d89e8cb22
Change-Id: I177dad88fc982170641059b6a4f53fbb38eefad6
2020-02-26 12:56:10 -07:00
.phan Upgrade to newer phan 2019-03-20 19:37:59 -07:00
.storybook Add storybook to Vector 2020-01-31 16:59:15 +08:00
dev-scripts Add storybook to Vector 2020-01-31 16:59:15 +08:00
i18n [Special:Preferences] [PHP] Add skin version user preference and configs 2020-02-26 12:56:10 -07:00
includes [Special:Preferences] [PHP] Add skin version user preference and configs 2020-02-26 12:56:10 -07:00
resources Remove Webkit search cancel button for cross-browser consistency 2020-02-18 22:30:19 -08:00
screenshots Add skin screenshot for the installer 2017-08-11 15:37:34 -04:00
skinStyles hygiene: Make LESS imports non-ambigious 2019-10-25 20:54:49 +00:00
stories Add storybook to Vector 2020-01-31 16:59:15 +08:00
tests/phpunit [Special:Preferences] [PHP] Add skin version user preference and configs 2020-02-26 12:56:10 -07:00
.eslintrc.json build: Update linters 2019-10-31 21:43:20 +00:00
.gitignore Add storybook to Vector 2020-01-31 16:59:15 +08:00
.gitreview Use track=1 instead of defaultbranch=master in .gitreview 2016-10-24 17:30:32 -07:00
.phpcs.xml Add method scope visibility 2018-11-01 21:01:32 +01:00
.stylelintrc.json build: Bump devDependencies to latest 2018-02-26 10:29:23 -08:00
CODE_OF_CONDUCT.md build: Updating mediawiki/mediawiki-codesniffer to 22.0.0 2018-09-04 01:45:34 +00:00
composer.json build: Updating composer dependencies 2020-01-30 20:11:34 +00:00
COPYING Use the plain-text GPL and fix 'license-name' to match SPDX conventions 2015-01-29 17:04:29 +01:00
Doxyfile docs: Generate documentation with Doxygen 2020-02-24 16:49:38 +00:00
Gruntfile.js build: Replace JSDuck with JSDoc 2020-02-14 10:29:00 -07:00
hooks.txt Remove 'SkinVectorStyleModules' hook 2018-01-26 10:33:47 -08:00
jsdoc.json build: Replace JSDuck with JSDoc 2020-02-14 10:29:00 -07:00
package-lock.json build: Replace JSDuck with JSDoc 2020-02-14 10:29:00 -07:00
package.json build: Replace JSDuck with JSDoc 2020-02-14 10:29:00 -07:00
README.md [Special:Preferences] [PHP] Add skin version user preference and configs 2020-02-26 12:56:10 -07:00
skin.json [Special:Preferences] [PHP] Add skin version user preference and configs 2020-02-26 12:56:10 -07:00
variables.less hygiene: Make LESS imports non-ambigious 2019-10-25 20:54:49 +00:00

Vector Skin

Installation

See https://www.mediawiki.org/wiki/Skin:Vector.

Configuration options

See skin.json.

Development

Coding conventions

We strive for compliance with MediaWiki conventions:

https://www.mediawiki.org/wiki/Manual:Coding_conventions

Additions and deviations from those conventions that are more tailored to this project are noted at:

https://www.mediawiki.org/wiki/Reading/Web/Coding_conventions

URL query parameters

  • useskinversion: Like useskin but for overriding the Vector skin version user preference and configuration.

Skin preferences

Vector defines skin-specific user preferences. These are exposed on Special:Preferences when the VectorShowSkinPreferences configuration is enabled. The user's preference state for skin preferences is used for skin previews and any other operation unless specified otherwise.

Version

Vector defines a "version" preference to enable users who prefer the December 2019 version of Vector to continue to do so without any visible changes. This version is called "Legacy Vector." The related preference defaults are configurable via the configurations prefixed with VectorDefaultSkinVersion. Version preference and configuration may be overridden by the useskinversion URL query parameter.