2015-04-07 19:52:32 +00:00
{
"name" : "Vector" ,
2020-04-28 21:16:21 +00:00
"version" : "1.0.0" ,
2015-04-07 19:52:32 +00:00
"author" : [
2021-12-15 22:40:35 +00:00
"[https://www.mediawiki.org/wiki/Reading/Web/Team Readers Web Team]" ,
2015-04-07 19:52:32 +00:00
"Trevor Parscal" ,
"Roan Kattouw" ,
2021-12-15 22:40:35 +00:00
"Alex Hollender" ,
"Bernard Wang" ,
"Clare Ming" ,
"Jan Drewniak" ,
"Jon Robson" ,
"Nick Ray" ,
"Sam Smith" ,
"Stephen Niedzielski" ,
"Volker E."
2015-04-07 19:52:32 +00:00
] ,
"url" : "https://www.mediawiki.org/wiki/Skin:Vector" ,
"descriptionmsg" : "vector-skin-desc" ,
2022-02-09 19:23:09 +00:00
"namemsg" : "vector-specialversion-name" ,
2018-02-16 18:41:02 +00:00
"license-name" : "GPL-2.0-or-later" ,
2015-04-07 19:52:32 +00:00
"type" : "skin" ,
2015-09-23 15:31:56 +00:00
"requires" : {
2021-09-16 18:00:05 +00:00
"MediaWiki" : ">= 1.38.0"
2015-09-23 15:31:56 +00:00
} ,
2015-04-07 19:52:32 +00:00
"ValidSkinNames" : {
2021-09-09 22:13:48 +00:00
"vector-2022" : {
2022-02-06 22:43:56 +00:00
"class" : "Vector\\SkinVector22" ,
2021-09-09 22:13:48 +00:00
"args" : [
{
"name" : "vector-2022" ,
"templateDirectory" : "includes/templates" ,
2022-01-20 22:14:19 +00:00
"template" : "skin" ,
2021-09-09 22:13:48 +00:00
"responsive" : true ,
"link" : {
"text-wrapper" : {
"tag" : "span"
2022-03-29 15:50:10 +00:00
}
2021-09-09 22:13:48 +00:00
} ,
2022-03-29 15:50:10 +00:00
"bodyClasses" : [
"skin-vector" ,
"skin-vector-search-vue"
] ,
2022-01-20 22:14:19 +00:00
"scripts" : [
"skins.vector.user" ,
"skins.vector.js" ,
"skins.vector.es6"
] ,
"styles" : [
"mediawiki.ui.button" ,
"skins.vector.styles" ,
"skins.vector.user.styles" ,
"skins.vector.icons" ,
"mediawiki.ui.icon"
2022-02-04 16:04:10 +00:00
] ,
2021-09-09 22:13:48 +00:00
"messages" : [
"tooltip-p-logo" ,
"vector-opt-out-tooltip" ,
"vector-opt-out" ,
"vector-action-toggle-sidebar" ,
"vector-main-menu-tooltip" ,
"vector-jumptosearch" ,
"vector-jumptocontent" ,
2022-03-15 16:34:59 +00:00
"vector-toc-beginning" ,
2022-03-15 16:28:25 +00:00
"vector-toc-heading" ,
2021-09-09 22:13:48 +00:00
"search" ,
"searchbutton" ,
"searcharticle" ,
"searchsuggest-search" ,
"sitesubtitle" ,
"sitetitle" ,
"tagline"
]
}
]
} ,
2020-04-28 21:16:21 +00:00
"vector" : {
2022-01-20 22:14:19 +00:00
"class" : "Vector\\SkinVectorLegacy" ,
2020-07-09 16:42:33 +00:00
"@args" : "See SkinVector::__construct for more detail." ,
2020-04-28 21:16:21 +00:00
"args" : [
{
"name" : "vector" ,
2022-01-20 22:14:19 +00:00
"template" : "skin-legacy" ,
2021-08-27 15:47:15 +00:00
"templateDirectory" : "includes/templates" ,
2021-08-13 18:21:52 +00:00
"responsive" : true ,
2021-09-09 22:13:48 +00:00
"link" : {
"text-wrapper" : {
"tag" : "span"
}
} ,
2022-01-20 22:14:19 +00:00
"scripts" : [
"skins.vector.legacy.js"
] ,
"styles" : [
"skins.vector.styles.legacy"
] ,
2020-08-05 08:22:22 +00:00
"messages" : [
2020-09-04 19:18:57 +00:00
"tooltip-p-logo" ,
2020-08-05 20:27:38 +00:00
"vector-opt-out-tooltip" ,
"vector-opt-out" ,
"navigation-heading" ,
2020-08-05 08:22:22 +00:00
"vector-action-toggle-sidebar" ,
2021-08-25 15:24:58 +00:00
"vector-main-menu-tooltip" ,
2020-08-05 08:22:22 +00:00
"vector-jumptonavigation" ,
"vector-jumptosearch" ,
2020-09-08 23:20:58 +00:00
"vector-jumptocontent" ,
2021-06-02 22:57:43 +00:00
"search" ,
2021-09-16 18:00:05 +00:00
"searchbutton" ,
"searcharticle" ,
2021-09-16 19:27:10 +00:00
"searchsuggest-search" ,
2020-08-05 08:22:22 +00:00
"sitesubtitle" ,
"sitetitle" ,
"tagline"
2021-09-09 22:13:48 +00:00
]
2020-04-28 21:16:21 +00:00
}
]
}
2015-04-07 19:52:32 +00:00
} ,
2018-05-20 18:58:47 +00:00
"SkinLessImportPaths" : {
2022-01-12 19:37:48 +00:00
"vector-2022" : "resources/mediawiki.less" ,
2018-05-20 18:58:47 +00:00
"vector" : "resources/mediawiki.less"
} ,
2015-04-07 19:52:32 +00:00
"MessagesDirs" : {
"Vector" : [
"i18n"
]
} ,
2020-02-20 16:37:33 +00:00
"AutoloadNamespaces" : {
2020-04-18 02:59:38 +00:00
"Vector\\" : "includes/"
2020-02-20 16:37:33 +00:00
} ,
[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-01-23 21:53:09 +00:00
"ConfigRegistry" : {
"vector" : "GlobalVarConfig::newInstance"
} ,
2017-06-30 19:21:16 +00:00
"Hooks" : {
2021-12-14 21:59:16 +00:00
"ResourceLoaderSiteModulePages" : "Vector\\Hooks::onResourceLoaderSiteModulePages" ,
"ResourceLoaderSiteStylesModulePages" : "Vector\\Hooks::onResourceLoaderSiteStylesModulePages" ,
2020-07-14 13:07:09 +00:00
"SkinPageReadyConfig" : "Vector\\Hooks::onSkinPageReadyConfig" ,
2020-06-18 12:52:00 +00:00
"LocalUserCreated" : "Vector\\Hooks::onLocalUserCreated" ,
2020-07-15 21:27:09 +00:00
"OutputPageBodyAttributes" : "Vector\\Hooks::onOutputPageBodyAttributes" ,
"MakeGlobalVariablesScript" : "Vector\\Hooks::onMakeGlobalVariablesScript"
2017-06-30 19:21:16 +00:00
} ,
2015-07-24 00:05:26 +00:00
"@note" : "When modifying skins.vector.styles definition, make sure the installer still works" ,
2015-04-07 19:52:32 +00:00
"ResourceModules" : {
2021-12-14 21:59:16 +00:00
"skins.vector.user" : {
"class" : "Vector\\ResourceLoader\\VectorResourceLoaderUserModule"
} ,
"skins.vector.user.styles" : {
"class" : "Vector\\ResourceLoader\\VectorResourceLoaderUserStylesModule"
} ,
2021-02-12 00:50:31 +00:00
"skins.vector.search" : {
2022-01-31 21:43:32 +00:00
"es6" : true ,
2021-02-12 00:50:31 +00:00
"dependencies" : [
2021-02-12 18:07:18 +00:00
"mediawiki.Uri" ,
2021-06-02 20:40:20 +00:00
"wvui-search"
2021-02-12 00:50:31 +00:00
] ,
"packageFiles" : [
"resources/skins.vector.search/skins.vector.search.js" ,
"resources/skins.vector.search/instrumentation.js" ,
2022-02-14 20:12:03 +00:00
"resources/skins.vector.search/fetch.js" ,
2022-02-02 21:17:56 +00:00
"resources/skins.vector.search/restSearchClient.js" ,
2021-02-12 00:50:31 +00:00
"resources/skins.vector.search/App.vue" ,
{
"name" : "resources/skins.vector.search/config.json" ,
"callback" : "Vector\\Hooks::getVectorWvuiSearchResourceLoaderConfig"
}
] ,
"messages" : [
2021-05-26 21:13:43 +00:00
"searchbutton" ,
2021-02-12 00:50:31 +00:00
"searchresults" ,
2021-09-30 20:52:16 +00:00
"vector-searchsuggest-containing"
2021-02-12 00:50:31 +00:00
]
} ,
2020-03-11 22:35:38 +00:00
"skins.vector.styles.legacy" : {
"class" : "ResourceLoaderSkinModule" ,
2020-09-14 22:16:58 +00:00
"features" : {
"normalize" : true ,
"elements" : true ,
2021-07-29 20:51:44 +00:00
"logo" : true ,
2021-08-18 18:29:28 +00:00
"content-media" : true ,
2021-07-29 20:51:44 +00:00
"content-links" : true ,
2022-01-25 16:08:49 +00:00
"content-links-external" : false ,
2020-09-14 22:16:58 +00:00
"interface" : true ,
2021-07-29 20:51:44 +00:00
"interface-message-box" : true ,
"interface-category" : true ,
"content-tables" : true ,
"i18n-ordered-lists" : true ,
"i18n-all-lists-margins" : true ,
"i18n-headings" : true
2020-09-14 22:16:58 +00:00
} ,
2020-03-11 22:35:38 +00:00
"targets" : [
"desktop" ,
"mobile"
] ,
2021-02-02 10:04:37 +00:00
"styles" : [
"resources/common/common.less" ,
"resources/skins.vector.styles.legacy/skin-legacy.less"
]
2020-03-11 22:35:38 +00:00
} ,
2015-07-24 00:05:26 +00:00
"skins.vector.styles" : {
2019-11-12 19:09:26 +00:00
"class" : "ResourceLoaderSkinModule" ,
2020-09-14 22:16:58 +00:00
"features" : {
"normalize" : true ,
"elements" : true ,
2021-07-27 15:19:08 +00:00
"content-links" : true ,
2022-01-25 16:08:49 +00:00
"content-links-external" : false ,
2021-03-30 22:09:54 +00:00
"content-media" : true ,
2021-07-27 15:19:08 +00:00
"content-tables" : true ,
2020-09-14 22:16:58 +00:00
"interface" : true ,
2021-07-27 15:19:08 +00:00
"interface-message-box" : true ,
2021-03-30 22:09:54 +00:00
"interface-category" : true ,
"i18n-ordered-lists" : true ,
"i18n-all-lists-margins" : true ,
"i18n-headings" : true
2020-09-14 22:16:58 +00:00
} ,
2020-01-11 04:40:49 +00:00
"targets" : [
"desktop" ,
"mobile"
] ,
2021-02-02 10:04:37 +00:00
"styles" : [
"resources/common/common.less" ,
"resources/skins.vector.styles/skin.less"
2021-08-25 20:16:33 +00:00
] ,
"lessMessages" : [
"parentheses-start" ,
"parentheses-end"
2021-02-02 10:04:37 +00:00
]
2015-07-24 00:05:26 +00:00
} ,
2021-09-14 16:53:35 +00:00
"skins.vector.icons.js" : {
"selectorWithVariant" : ".mw-ui-icon-wikimedia-{name}-{variant}:before" ,
"selectorWithoutVariant" : ".mw-ui-icon-wikimedia-{name}:before" ,
"useDataURI" : false ,
"defaultColor" : "#000" ,
"class" : "ResourceLoaderOOUIIconPackModule" ,
"variants" : [ ] ,
"icons" : [
2021-09-24 21:00:32 +00:00
"edit" ,
"editLock" ,
2021-11-15 23:09:51 +00:00
"halfStar" ,
"history" ,
"speechBubbles" ,
"star" ,
"unStar" ,
2021-09-24 21:00:32 +00:00
"wikiText"
2021-09-14 16:53:35 +00:00
]
} ,
2021-02-01 22:56:31 +00:00
"skins.vector.icons" : {
"selectorWithVariant" : ".mw-ui-icon-wikimedia-{name}-{variant}:before" ,
"selectorWithoutVariant" : ".mw-ui-icon-wikimedia-{name}:before" ,
"useDataURI" : false ,
2021-03-22 22:59:18 +00:00
"defaultColor" : "#000" ,
2021-02-01 22:56:31 +00:00
"class" : "ResourceLoaderOOUIIconPackModule" ,
2021-12-01 19:49:12 +00:00
"variants" : {
"progressive" : {
"color" : "#36c" ,
"global" : true
}
} ,
2021-02-01 22:56:31 +00:00
"icons" : [
2021-04-30 02:54:54 +00:00
"language" ,
2021-06-24 19:13:20 +00:00
"ellipsis" ,
2021-06-02 22:57:43 +00:00
"userAvatar" ,
2021-06-03 22:09:29 +00:00
"userTalk" ,
2021-11-23 17:07:21 +00:00
"sandbox" ,
2021-06-02 22:57:43 +00:00
"search" ,
2021-06-03 22:09:29 +00:00
"settings" ,
"labFlask" ,
"unStar" ,
2022-01-12 23:26:02 +00:00
"watchlist" ,
2021-06-03 22:09:29 +00:00
"userContributions" ,
"logIn" ,
2021-08-24 16:54:41 +00:00
"logOut" ,
2021-09-03 12:37:29 +00:00
"imageGallery" ,
2022-02-07 19:20:17 +00:00
"userGroup" ,
"downTriangle"
2021-02-01 22:56:31 +00:00
]
} ,
2021-10-20 18:58:49 +00:00
"skins.vector.es6" : {
"es6" : true ,
"packageFiles" : [
"resources/skins.vector.es6/main.js" ,
"resources/skins.vector.es6/searchToggle.js" ,
2021-10-26 23:37:56 +00:00
"resources/skins.vector.es6/stickyHeader.js" ,
"resources/skins.vector.es6/scrollObserver.js" ,
"resources/skins.vector.es6/AB.js" ,
2022-01-21 20:15:34 +00:00
"resources/skins.vector.es6/tableOfContents.js" ,
"resources/skins.vector.es6/sectionObserver.js" ,
2022-02-08 21:14:33 +00:00
"resources/skins.vector.es6/deferUntilFrame.js" ,
2021-10-26 23:37:56 +00:00
{
"name" : "resources/skins.vector.es6/config.json" ,
"callback" : "Vector\\Hooks::getVectorResourceLoaderConfig"
}
] ,
"dependencies" : [
2021-12-21 22:00:04 +00:00
"mediawiki.user" ,
2021-10-26 23:37:56 +00:00
"skins.vector.icons.js" ,
"mediawiki.page.ready" ,
2021-11-15 23:09:51 +00:00
"mediawiki.page.watch.ajax" ,
2021-10-26 23:37:56 +00:00
"mediawiki.util" ,
"mediawiki.experiments"
2021-10-20 18:58:49 +00:00
]
} ,
2015-04-07 19:52:32 +00:00
"skins.vector.js" : {
2020-04-10 15:24:13 +00:00
"packageFiles" : [
2020-05-14 20:54:15 +00:00
"resources/skins.vector.js/skin.js" ,
2020-07-14 13:07:09 +00:00
{
"name" : "resources/skins.vector.js/config.json" ,
"callback" : "Vector\\Hooks::getVectorResourceLoaderConfig"
} ,
2021-02-24 23:30:16 +00:00
"resources/skins.vector.js/dropdownMenus.js" ,
2020-06-30 22:39:09 +00:00
"resources/skins.vector.js/sidebar.js" ,
2020-05-11 21:29:56 +00:00
"resources/skins.vector.legacy.js/collapsibleTabs.js" ,
2020-09-11 20:50:04 +00:00
"resources/skins.vector.legacy.js/vector.js" ,
2021-03-01 21:32:25 +00:00
"resources/skins.vector.js/languageButton.js" ,
2021-10-20 18:58:49 +00:00
"resources/skins.vector.js/searchLoader.js"
2020-05-11 21:29:56 +00:00
] ,
"dependencies" : [
2021-09-14 16:53:35 +00:00
"skins.vector.icons.js" ,
2020-07-14 13:07:09 +00:00
"mediawiki.page.ready" ,
"mediawiki.util"
2020-08-04 12:02:50 +00:00
] ,
"messages" : [ "vector-search-loader" ]
2020-05-11 21:29:56 +00:00
} ,
"skins.vector.legacy.js" : {
"packageFiles" : [
2020-05-14 20:54:15 +00:00
"resources/skins.vector.legacy.js/skin-legacy.js" ,
2020-05-11 21:29:56 +00:00
"resources/skins.vector.legacy.js/collapsibleTabs.js" ,
"resources/skins.vector.legacy.js/vector.js"
2015-04-07 19:52:32 +00:00
] ,
"dependencies" : [
2020-07-14 13:07:09 +00:00
"mediawiki.page.ready" ,
2019-10-04 00:06:46 +00:00
"mediawiki.util"
2015-04-07 19:52:32 +00:00
]
}
} ,
"ResourceFileModulePaths" : {
"localBasePath" : "" ,
"remoteSkinPath" : "Vector"
} ,
"ResourceModuleSkinStyles" : {
2021-09-09 22:13:48 +00:00
"vector-2022" : {
"+ext.echo.styles.alert" : "skinStyles/ext.echo.styles.alert.less" ,
"+mediawiki.action.view.redirectPage" : "skinStyles/mediawiki.action.view.redirectPage.less" ,
"+mediawiki.notification" : "skinStyles/mediawiki.notification.less" ,
"+oojs-ui-core.styles" : "skinStyles/ooui.less" ,
"mediawiki.special" : "skinStyles/mediawiki.special.less" ,
"+ext.relatedArticles.readMore" : "skinStyles/ext.relatedArticles.readMore.less" ,
2022-01-10 22:41:38 +00:00
"+ext.uls.compactlinks" : "skinStyles/ext.uls.compactlinks.less" ,
"+ext.uls.interface" : "skinStyles/ext.uls.interface.less"
2021-09-09 22:13:48 +00:00
} ,
2015-04-07 19:52:32 +00:00
"vector" : {
2021-06-02 22:57:43 +00:00
"+ext.echo.styles.alert" : "skinStyles/ext.echo.styles.alert.less" ,
2015-04-07 19:52:32 +00:00
"jquery.tipsy" : "skinStyles/jquery.tipsy.less" ,
2019-10-16 22:44:40 +00:00
"jquery.ui" : [
2015-04-07 19:52:32 +00:00
"skinStyles/jquery.ui/jquery.ui.core.css" ,
2019-10-16 22:44:40 +00:00
"skinStyles/jquery.ui/jquery.ui.theme.css" ,
"skinStyles/jquery.ui/jquery.ui.accordion.css" ,
"skinStyles/jquery.ui/jquery.ui.autocomplete.css" ,
"skinStyles/jquery.ui/jquery.ui.button.css" ,
"skinStyles/jquery.ui/jquery.ui.datepicker.css" ,
"skinStyles/jquery.ui/jquery.ui.dialog.css" ,
"skinStyles/jquery.ui/jquery.ui.menu.css" ,
"skinStyles/jquery.ui/jquery.ui.progressbar.css" ,
"skinStyles/jquery.ui/jquery.ui.resizable.css" ,
"skinStyles/jquery.ui/jquery.ui.selectable.css" ,
"skinStyles/jquery.ui/jquery.ui.slider.css" ,
"skinStyles/jquery.ui/jquery.ui.tabs.css" ,
"skinStyles/jquery.ui/jquery.ui.tooltip.css"
2015-04-07 19:52:32 +00:00
] ,
2017-06-15 13:05:39 +00:00
"+mediawiki.action.view.redirectPage" : "skinStyles/mediawiki.action.view.redirectPage.less" ,
2015-05-04 16:29:18 +00:00
"+mediawiki.notification" : "skinStyles/mediawiki.notification.less" ,
2016-02-29 16:59:59 +00:00
"+oojs-ui-core.styles" : "skinStyles/ooui.less" ,
2019-06-20 18:14:27 +00:00
"mediawiki.special" : "skinStyles/mediawiki.special.less" ,
2021-12-03 19:36:15 +00:00
"+ext.relatedArticles.readMore" : "skinStyles/ext.relatedArticles.readMore.less" ,
2022-01-10 22:41:38 +00:00
"+ext.uls.compactlinks" : "skinStyles/ext.uls.compactlinks.less" ,
"+ext.uls.interface" : "skinStyles/ext.uls.interface.less"
2015-04-07 19:52:32 +00:00
}
} ,
"config" : {
2020-11-23 22:55:35 +00:00
"VectorSearchHost" : {
"value" : "" ,
"description" : "Override default search API. Can be used with $wgDisableTextSearch and $wgSearchForwardUrl to mimic user experience on production."
} ,
2020-01-11 04:40:49 +00:00
"VectorUseIconWatch" : {
"value" : true
} ,
2021-01-06 21:50:19 +00:00
"VectorMaxWidthOptions" : {
"value" : {
"exclude" : {
"mainpage" : false ,
"querystring" : {
"action" : "history" ,
"diff" : "*"
} ,
"namespaces" : [
-1 ,
14
]
} ,
"include" : [
"Special:Preferences"
]
} ,
"description" : "options for configuring where where max-width should and should not apply. More details can be found in Hooks::shouldDisableMaxWidth PHP documentation."
} ,
2020-01-11 04:40:49 +00:00
"VectorResponsive" : {
2021-01-29 01:53:27 +00:00
"value" : false ,
2022-01-20 22:14:19 +00:00
"description" : "@var boolean turn Vector-2022 into a responsive skin by applying a view port and disabling the min-width"
[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-01-23 21:53:09 +00:00
} ,
"VectorDefaultSkinVersionForExistingAccounts" : {
2020-05-04 13:25:38 +00:00
"value" : "1" ,
2020-04-28 21:02:15 +00:00
"description" : "@var string:['2'|'1'] The version ('2' for latest, '1' for legacy) of the Vector skin to use when an existing user has not specified a preference. This configuration is not used for new accounts (see VectorDefaultSkinVersionForNewAccounts) and is impermanent. In the future, this field may contains versions such as \"beta\" which when specified and the BetaFeatures extension is installed, and the user is enrolled, the latest version is used otherwise legacy. The value is _not_ persisted."
[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-01-23 21:53:09 +00:00
} ,
"VectorDefaultSkinVersionForNewAccounts" : {
2022-03-31 03:47:57 +00:00
"value" : null ,
"description" : "@var string|null The version ('2' for latest, '1' for legacy) of the Vector skin to **set** for newly created user accounts. **The value is persisted as a user preference.** This configuration is not used for preexisting accounts (see VectorDefaultSkinVersionForExistingAccounts) and only ever executed once at new account creation time. If it is null, no user preference will be set."
2020-07-07 08:59:14 +00:00
} ,
2020-11-26 00:58:10 +00:00
"VectorWvuiSearchOptions" : {
"value" : {
"showThumbnail" : true ,
2021-06-30 12:51:04 +00:00
"showDescription" : true
2020-11-26 00:58:10 +00:00
}
} ,
2020-07-07 08:59:14 +00:00
"VectorDefaultSidebarVisibleForAuthorisedUser" : {
"value" : true
} ,
"VectorDefaultSidebarVisibleForAnonymousUser" : {
"value" : false
Implement Page, Workspace, Content, and Article Toolbar Containers
This patch closely follows the desired guidelines/desired
styles Alex Hollender has put forth in his prototype, but uses
multiple containers to achieve this look since our DOM order/structure
is different than the DOM structure in the prototype. The following
containers are used, but unlike his prototype, they are sometimes used
more than once:
* Page Container: Contains every other container and limits the overall
max-width of the white part of the page.
* Workspace Container: Contains the sidebar and content container. The
sidebar is displaced ~30 pixels to the start (left) of the workspace
container at all times.
* Content Container: Contains the content. The max-width of this changes
depending on whether you are on a special page/history page vs. other
pages.
* Article Toolbar Container: Contains the article toolbar. The max-width
of this is always the same as the max-width of the article content as we
don't want the toolbar to move when going from the article page to the
history/special page.
Changes to be aware:
* To test locally, `$wgVectorLayoutMaxWidth = true;`. This design is
temporarily feature flagged and defaults to being "off".
* Note that layout-max-width.less is a temporary file made to meet the
feature flag requirement of T246420 (intended to derisk the deployment).
After the deploy, we should merge most if not all of the rules into
layout.less where the max-width design will become the default.
* Per Jon's code review comment, I have relaxed the indenting of
skin.mustache to make the diff easier to reason about. If desired, the
correct indenting can be achieved in a (much less risky) follow-up
commit.
Bug: T246420
Bug: T153043
Change-Id: Ie49f629bc705850c6996164a516957476c034048
2020-06-23 18:02:32 +00:00
} ,
2020-08-18 21:30:25 +00:00
"VectorLanguageInHeader" : {
2021-04-07 15:56:41 +00:00
"value" : {
2022-01-28 19:55:39 +00:00
"logged_in" : true ,
"logged_out" : true
2021-04-07 15:56:41 +00:00
} ,
"description" : "@var array Moves the language links from the sidebar into a menu beside the page title. Also moves the indicators to the line below, next to the tagline (siteSub)."
2020-08-18 21:30:25 +00:00
} ,
2021-12-03 23:33:21 +00:00
"VectorLanguageInMainPageHeader" : {
"value" : {
"logged_in" : false ,
"logged_out" : false
} ,
"description" : "@var When `VectorLanguageInHeader` is enabled, determines whether the Main Page's language button should be at the top or bottom of the content. The default position on the main page is at the bottom."
} ,
2021-12-07 20:28:58 +00:00
"VectorLanguageAlertInSidebar" : {
"value" : {
"logged_in" : false ,
"logged_out" : false
} ,
"description" : "@var When `VectorLanguageAlertInSidebar` is enabled, the language switch alert box is shown in the sidebar."
} ,
2021-04-29 00:47:25 +00:00
"VectorLanguageInHeaderTreatmentABTest" : {
"value" : false ,
"description" : "@var boolean Enables or disables the language in header treatment A/B test. See https://phabricator.wikimedia.org/T280825 and associated tasks for additional detail."
} ,
2021-08-04 17:54:35 +00:00
"VectorStickyHeader" : {
"value" : {
2022-01-28 17:46:48 +00:00
"logged_in" : true ,
2021-08-04 17:54:35 +00:00
"logged_out" : false
} ,
"description" : "@var array Enables a persistent header that allows quick access to user links, editing tools, search and other links while scrolling down a page"
2021-04-30 02:54:54 +00:00
} ,
2021-10-26 21:34:05 +00:00
"VectorStickyHeaderEdit" : {
"value" : {
2021-11-17 20:54:02 +00:00
"logged_in" : false ,
2021-10-26 21:34:05 +00:00
"logged_out" : false
} ,
"description" : "@var array Enables the edit icons if $wgVectorStickyHeader is true."
} ,
2021-10-26 23:37:56 +00:00
"VectorWebABTestEnrollment" : {
"value" : {
2021-12-09 19:34:44 +00:00
"name" : "vector.sticky_header" ,
2021-10-26 23:37:56 +00:00
"enabled" : false ,
"buckets" : {
"unsampled" : {
2021-12-10 19:18:49 +00:00
"samplingRate" : 0.1
2021-10-26 23:37:56 +00:00
} ,
"control" : {
2021-12-10 19:18:49 +00:00
"samplingRate" : 0.3
2021-10-26 23:37:56 +00:00
} ,
"stickyHeaderDisabled" : {
2021-12-10 19:18:49 +00:00
"samplingRate" : 0.3
2021-10-26 23:37:56 +00:00
} ,
2022-03-17 23:01:17 +00:00
"stickyHeaderEnabledTreatment" : {
2021-12-10 19:18:49 +00:00
"samplingRate" : 0.3
2021-10-26 23:37:56 +00:00
}
}
} ,
2022-03-17 23:01:17 +00:00
"description" : "An associative array of A/B test configs keyed by parameters noted in mediawiki.experiments.js. There must be an `unsampled` bucket that represents a population excluded from the experiment. Additionally, the treatment bucket(s) must include a case-insensitive `treatment` substring in their name (e.g. `treatment`, `stickyHeaderTreatment`, `sticky-header-treatment`)"
2021-10-26 23:37:56 +00:00
} ,
2020-07-15 21:27:09 +00:00
"VectorDisableSidebarPersistence" : {
"value" : false ,
"description" : "@var boolean Temporary feature flag that disables saving the sidebar expanded/collapsed state as a user-preference (triggered via clicking the main menu icon). This is intended as a temporary kill-switch in the event that the DB is overloaded with writes to the user_options table."
2021-12-14 19:58:54 +00:00
} ,
"VectorTableOfContents" : {
"value" : {
2021-12-15 17:51:44 +00:00
"default" : false
2021-12-14 19:58:54 +00:00
} ,
"description" : "@var When `VectorTableOfContents` is enabled, the sticky table of contents is shown."
2022-02-18 00:19:50 +00:00
} ,
2022-03-15 16:34:59 +00:00
"VectorTableOfContentsBeginning" : {
"value" : true ,
"description" : "@var boolean Temporary feature flag that controls link to beginning of article."
} ,
2022-02-18 00:19:50 +00:00
"VectorTableOfContentsCollapseAtCount" : {
"value" : 20 ,
"description" : "@var When `VectorTableOfContents` is enabled, the minimum number of headings required to collapse all headings in the sticky table of contents by default."
2020-01-11 04:40:49 +00:00
}
2015-06-08 20:20:52 +00:00
} ,
2020-02-20 16:37:33 +00:00
"ServiceWiringFiles" : [
"includes/ServiceWiring.php"
] ,
2020-01-11 04:40:49 +00:00
"manifest_version" : 2
2015-04-07 19:52:32 +00:00
}
