wikimedia/mediawiki-extensions-Popups
1
0
Fork 0
mirror of https://gerrit.wikimedia.org/r/mediawiki/extensions/Popups synced 2024-11-28 09:20:31 +00:00
Code Issues Packages Projects Releases Wiki Activity
mediawiki-extensions-Popups/extension.json

127 lines
4.1 KiB
JSON
Raw Normal View History

Add extension.json, empty php entry point Bug: T87961 Change-Id: I52e93fd290b1e5d8438467896a159fc7230c5813
2015-07-02 10:00:21 +00:00
{
"name": "Popups",
"author": [
"Prateek Saxena",
"Yair Rand"
],
"url": "https://www.mediawiki.org/wiki/Extension:Popups",
"descriptionmsg": "popups-desc",
"license-name": "GPL-2.0+",
"type": "betafeatures",
"AutoloadClasses": {
Hygiene: Move Popups.hooks into includes folder Lets keep all extenion PHP files in one folder Change-Id: I225019b895df038c1d43a082ac4244053d0b96dd
2017-02-14 19:22:55 +00:00
"Popups\\PopupsHooks": "includes/PopupsHooks.php",
Disable Page Previews preferences when NavPopups are enabled Changes: - introduced PopupsGadgetsIntegration class handles all checks - show help message on Preferences page when NavPopups is enabled - unit test everything Bug: T151058 Change-Id: Ia474b1b30378efe84dedf3ad47c1f833e88d69b5
2017-01-04 16:33:40 +00:00
"Popups\\PopupsContext": "includes/PopupsContext.php",
"Popups\\PopupsGadgetsIntegration": "includes/PopupsGadgetsIntegration.php"
Add extension.json, empty php entry point Bug: T87961 Change-Id: I52e93fd290b1e5d8438467896a159fc7230c5813
2015-07-02 10:00:21 +00:00
},
"ConfigRegistry": {
"popups": "GlobalVarConfig::newInstance"
},
"Hooks": {
"GetBetaFeaturePreferences": [
Hygiene: Move Popups.hooks into includes folder Lets keep all extenion PHP files in one folder Change-Id: I225019b895df038c1d43a082ac4244053d0b96dd
2017-02-14 19:22:55 +00:00
"Popups\\PopupsHooks::onGetBetaPreferences"
Add extension.json, empty php entry point Bug: T87961 Change-Id: I52e93fd290b1e5d8438467896a159fc7230c5813
2015-07-02 10:00:21 +00:00
],
"BeforePageDisplay": [
Hygiene: Move Popups.hooks into includes folder Lets keep all extenion PHP files in one folder Change-Id: I225019b895df038c1d43a082ac4244053d0b96dd
2017-02-14 19:22:55 +00:00
"Popups\\PopupsHooks::onBeforePageDisplay"
Add extension.json, empty php entry point Bug: T87961 Change-Id: I52e93fd290b1e5d8438467896a159fc7230c5813
2015-07-02 10:00:21 +00:00
],
"ResourceLoaderTestModules": [
Hygiene: Move Popups.hooks into includes folder Lets keep all extenion PHP files in one folder Change-Id: I225019b895df038c1d43a082ac4244053d0b96dd
2017-02-14 19:22:55 +00:00
"Popups\\PopupsHooks::onResourceLoaderTestModules"
Add extension.json, empty php entry point Bug: T87961 Change-Id: I52e93fd290b1e5d8438467896a159fc7230c5813
2015-07-02 10:00:21 +00:00
],
"ResourceLoaderGetConfigVars": [
Hygiene: Move Popups.hooks into includes folder Lets keep all extenion PHP files in one folder Change-Id: I225019b895df038c1d43a082ac4244053d0b96dd
2017-02-14 19:22:55 +00:00
"Popups\\PopupsHooks::onResourceLoaderGetConfigVars"
Add link preview feature to mobile beta mode Linkpreview will try to fetch a text extract using the api and, if this doesn't fail, show the extract as a drawer with a button "Continue to article". If the query fails, it will redirect the user to the article directly. Bug: T113243 Depends-On: I6d8c5b80e70c3d8d1a92a70cc91e1b90d598cb0f Change-Id: Idbaae9fe2decd89b73e623a25fbd39464c316fb2
2016-01-29 17:06:33 +00:00
],
Introduce Opt-In option on user preferences page This changes introduces new option on Special:Preferences page that allows users to enable/disable Page Previews feature. By default feature is disabled. Temporarily option in Preferences page is smoke and mirrors as switching logic is still WIP. Bug: T146889 Change-Id: Ifdd17ce265d2d4c7583433ed4991443c563f1fe3
2016-12-13 20:38:26 +00:00
"GetPreferences": [
Hygiene: Move Popups.hooks into includes folder Lets keep all extenion PHP files in one folder Change-Id: I225019b895df038c1d43a082ac4244053d0b96dd
2017-02-14 19:22:55 +00:00
"Popups\\PopupsHooks::onGetPreferences"
Hygiene: use UserGetDefaultOptions instead of ExtensionRegistration Changes: - removed onExtensionRegistration and related TODOs - introduced onUserGetDefaultOptions hook Change-Id: I6648802c19d90df36a211d6494033aca30c078ca
2017-01-10 01:28:57 +00:00
],
"UserGetDefaultOptions": [
Hygiene: Move Popups.hooks into includes folder Lets keep all extenion PHP files in one folder Change-Id: I225019b895df038c1d43a082ac4244053d0b96dd
2017-02-14 19:22:55 +00:00
"Popups\\PopupsHooks::onUserGetDefaultOptions"
Send blob to everyone As before, we need to send the Page Previews blob that logged out users can enable/disable previews. Changes: * Unconditionally add the ext.popups RL module to the output. * Send the value of Popups\PopupsContext#isEnabledByUser to the client as $wgPopupsIsEnabledByUser. * Make mw.popups#isEnabled return $wgPopupsIsEnabledByUser if the user is logged in. Bug: T146889 Change-Id: Id2ccfaa81a327e222fff400f4a5f22f96c99ea31
2016-12-21 12:35:35 +00:00
],
"MakeGlobalVariablesScript": [
Hygiene: Move Popups.hooks into includes folder Lets keep all extenion PHP files in one folder Change-Id: I225019b895df038c1d43a082ac4244053d0b96dd
2017-02-14 19:22:55 +00:00
"Popups\\PopupsHooks::onMakeGlobalVariablesScript"
Add extension.json, empty php entry point Bug: T87961 Change-Id: I52e93fd290b1e5d8438467896a159fc7230c5813
2015-07-02 10:00:21 +00:00
]
},
"MessagesDirs": {
"Popups": [
"i18n"
]
},
Move EventLogging schema registration into extension.json Change-Id: I9dea6584d5e811d761542f207a5f63357479d644 Depends-On: I01aa2887a9b98c2ef52cacc3a892390a72b4a3ba
2015-12-23 00:46:45 +00:00
"EventLoggingSchemas": {
Hygiene: Remove checkin instrumentation The "checkin" part of the Popups schema was superseded by the ReadingDepth schema, the implementation of which is tracked by T155639. As well as removing all checkin-related code, update the Popups schema to the latest version - the version that doesn't have the checkin property. Bug: T155639 Depends-On: I762ec3fc91decf3cffa869dbd783faf62f01329a Change-Id: If764917b6e121e1f9db980a4efa30c0f7a166197
2017-02-22 11:36:54 +00:00
"Popups": 16364296
Move EventLogging schema registration into extension.json Change-Id: I9dea6584d5e811d761542f207a5f63357479d644 Depends-On: I01aa2887a9b98c2ef52cacc3a892390a72b4a3ba
2015-12-23 00:46:45 +00:00
},
Add extension.json, empty php entry point Bug: T87961 Change-Id: I52e93fd290b1e5d8438467896a159fc7230c5813
2015-07-02 10:00:21 +00:00
"config": {
"@PopupsBetaFeature": "@var bool: Whether the extension should be enabled as an opt-in beta feature. If true, the BetaFeatures extension must be installed. False by default.",
"PopupsBetaFeature": false,
Hygiene: Rename SchemaPopupsSamplingRate The SchemaPopupsSamplingRate config variable is inconsistently named and even forwarded to the client as wgPopupsSchemaPopupsSamplingRate. Changes: * SchemaPopupsSamplingRate -> PopupsSchemaSamplingRate * Forward PopupsSchemaSamplingRate to the client as $wgPopupsSchemaSamplingRate. Bug: T146889 Bug: T146434 Change-Id: I80d6a0abccf462e2eb0fd96af6849b5e82b49c26
2017-01-15 18:50:04 +00:00
"@PopupsSchemaSamplingRate": "@var number: Sample rate for logging events to Schema:Popups.",
"PopupsSchemaSamplingRate": 0,
Implement necessary wiring for preferences Changes: - introduce unit tests - don't send module for anonymous users - renamed Module to Context - remove Config dependency from Popups.hooks.php Bug: T146889 Change-Id: I3cbcdc1303411b28b613afa6dd1a00b410891471
2016-12-16 02:47:52 +00:00
"@PopupsHideOptInOnPreferencesPage": "@var bool: Whether the option to senable/disable Page Previews should be hidden on Preferences page. Please note if PopupsBetaFeature is set to true this option will be always hidden. False by default",
"PopupsHideOptInOnPreferencesPage": false,
"@PopupsOptInDefaultState" : "@var string:['1'|'0'] Default Page Previews visibility. Has to be a string as a compatibility with beta feature settings",
Move conflicting NavPopups gadget name into config var Changes: - removed hardcoded comflicting Navigation Popups gadget name - introduced a config variable to specify conflicting gadget name Bug: T151058 Change-Id: Ief5c6f90ec6dd6c074931f7d9ff20297d4718fe5
2017-01-11 21:52:07 +00:00
"PopupsOptInDefaultState" : "0",
"@PopupsConflictingNavPopupsGadgetName": "@var string: Navigation popups gadget name",
Add support for RESTBase endpoint consumption * Introduce the new config variable `PopupsAPIUseRESTBase`. * Create a gateway interface that exposes the getPageSummary method. Both MediaWiki API gateway and RESTBase gateway implement this interface. Bug: T123445 Change-Id: I71a8a848f3143fa4a0dfd4ca182ee086903110bc
2017-01-31 22:34:27 +00:00
"PopupsConflictingNavPopupsGadgetName": "Navigation_popups",
"@PopupsAPIUseRESTBase": "Whether to use RESTBase rather than the MediaWiki API for fetching Popups data.",
Allow bucketing anons * Logged in users bypass bucketing. They keep working as before. * When Page Previews is configured as a beta feature, logged out users won't see the feature. * If an anonymous user has enabled/disabled the feature using the settings cog then they will see or not see the feature depending on the value of their setting. * The other anonymous users are bucketed. By default 90% of these users see the feature, the other 10% don't. These numbers can be controlled by the config variable `wgPopupsAnonsEnabledSamplingRate`. Bug: T157700 Change-Id: I5307587b10f4849c4e82d3b064ff759121c2de67
2017-02-27 19:31:34 +00:00
"PopupsAPIUseRESTBase": false,
"@PopupsAnonsEnabledSamplingRate": "Sampling rate for showing popups to anonymous users.",
"PopupsAnonsEnabledSamplingRate": 0.9
Add link preview feature to mobile beta mode Linkpreview will try to fetch a text extract using the api and, if this doesn't fail, show the extract as a drawer with a button "Continue to article". If the query fails, it will redirect the user to the article directly. Bug: T113243 Depends-On: I6d8c5b80e70c3d8d1a92a70cc91e1b90d598cb0f Change-Id: Idbaae9fe2decd89b73e623a25fbd39464c316fb2
2016-01-29 17:06:33 +00:00
},
Prepare Popups for adding of mobile specific Popups implementation For the work on T113243, the Popups extension should be structured in a more flexible way. This is achieved with this change. Following has changed: * The main/core logic of Popups now lives in ext.popups.core to be shareable between implementations * The desktop specific logic lives in ext.popups.desktop now, the frontend init code in ext.popups.desktopTarget and the desktop renderer in ext.popups.renderer.desktopRenderer This change doesn't change the functionality of Popups. Change-Id: I72121e0a1e4b2952f85dc1bc8cf59d06b8d22f47
2016-01-29 16:48:24 +00:00
"ResourceModules": {
Hovercards: Improve layout of settings dialog to design spec Improving Hovercards' settings dialog to fulfill design specification. Also fixing HTML structure by removing invalid `radiogroup` element and adding missing `</div>` element, fixing related QUnit test. Changes: * Add close icon instead of using text * Style header as a table for alignment * Remove redundant "OK" button and have it replace "Save" instead * Update text of "OK" button to "Done" * Fix description for translation of "Done" button * Fix qunit and selenium tests * Remove unnecessary markup and less * Add mediawiki-ui-button and mediawiki-ui-icon dependencies * Shrink dialog width some per design spec * Fix dialog horizontal position calculation to remove hard-coded value Bug: T138612 Change-Id: I7395e3438836149becdd576942bdaf6f21b4163f
2016-06-24 16:25:20 +00:00
"ext.popups.images": {
"selector": ".mw-ui-icon-{name}:before",
"class": "ResourceLoaderImageModule",
"prefix": "mw-ui",
"images": {
"popups-close": "resources/ext.popups.images/close.svg"
}
},
Remove ResourceLoaderRegisterModules hook handler We should endeavour to define Resource Loader modules in one place, extension.json. Adding them to the output, however... Changes: * Remove ResourceLoaderRegisterModules hook handler. * Move all dependencies, messages, templates, and styles into "empty" RL module definitions in extension.json so that they don't have to be looked up later. Change-Id: I7ec963e3296de8f411e90079ab13b97c6eba4916
2016-11-08 07:57:30 +00:00
"ext.popups": {
Use Redux and Redux Thunk Changes: * Create the ext.popups.lib module, which contains redux@3.6.0 and redux-thunk@2.1.0. * Rely on the Resource Loader's minification and mangling (?) mechanisms. * Create an asynchronous bootstrap script, which creates a Redux store when the User Agent is idle. Change-Id: Ib7168217a5673bb2a8378eb30d6aa45043c66e62
2016-11-08 10:05:40 +00:00
"scripts": [
Tooling: Separate built resources from RL resources In order to automatically verify in CI that the built assets are up to date with the commited sources, we need to keep the built assets in a folder separate from the RL assets. * Rename the compiled assets folder to industry standard `dist` Change-Id: I8c5898f9bb29fee7164a7038b835a5f7efd33dbc
2017-02-13 13:47:59 +00:00
"resources/dist/index.js"
Use Redux and Redux Thunk Changes: * Create the ext.popups.lib module, which contains redux@3.6.0 and redux-thunk@2.1.0. * Rely on the Resource Loader's minification and mangling (?) mechanisms. * Create an asynchronous bootstrap script, which creates a Redux store when the User Agent is idle. Change-Id: Ib7168217a5673bb2a8378eb30d6aa45043c66e62
2016-11-08 10:05:40 +00:00
],
Remove ResourceLoaderRegisterModules hook handler We should endeavour to define Resource Loader modules in one place, extension.json. Adding them to the output, however... Changes: * Remove ResourceLoaderRegisterModules hook handler. * Move all dependencies, messages, templates, and styles into "empty" RL module definitions in extension.json so that they don't have to be looked up later. Change-Id: I7ec963e3296de8f411e90079ab13b97c6eba4916
2016-11-08 07:57:30 +00:00
"templates": {
previews: Add generic fallback preview Changes: * Make the gateway handle missing pages, which are characterised by the MediaWiki API response having both the missing property set to truthy and the page not having any revisions. * Add the preview-empty template and associated "mwe-popups-is-empty" CSS class, which describe what an empty preview contains and how it should look. Supporting changes: * Move the original preview template into the ext.popups module. Bug: T151054 Change-Id: Ife75bf9c6bafdfe0a6cc3e20eea853b4ac8f951b
2016-11-29 12:34:52 +00:00
"preview.mustache": "resources/ext.popups/templates/preview.mustache",
"preview-empty.mustache": "resources/ext.popups/templates/preview-empty.mustache",
Move settings template to ext.popups Change-Id: I98ccb96f6662a4263245cee9d48faf976fbb154e
2016-12-12 18:13:27 +00:00
"settings.mustache": "resources/ext.popups/templates/settings.mustache"
Remove ResourceLoaderRegisterModules hook handler We should endeavour to define Resource Loader modules in one place, extension.json. Adding them to the output, however... Changes: * Remove ResourceLoaderRegisterModules hook handler. * Move all dependencies, messages, templates, and styles into "empty" RL module definitions in extension.json so that they don't have to be looked up later. Change-Id: I7ec963e3296de8f411e90079ab13b97c6eba4916
2016-11-08 07:57:30 +00:00
},
"styles": [
previews: Tidy up styles I59ac2e32 removed support for non-SVG capable UAs but didn't remove all of the associated styles. Additional changes: * Give the inner container a name, "mwe-popups-container", so that it can be styled with reduced specificity. Supporting changes: * Move the "core" styles into the ext.popups module. Bug: T151054 Change-Id: I8deb6e76daf6f33fcb6f496129e6baf9e6793231
2016-11-29 12:14:38 +00:00
"resources/ext.popups/styles/ext.popups.core.less",
Remove unused code in repo The existence of these files was causing me much confusion as I thought they were still being used in the mpga branch. If this is note the case they should be removed to make the repo easier to understand. Changes: * Move the ext.popups.animation.less into ext.popups since that's where its shipped. * Remove files which are not being used. * Since csslint now runs on ext.popups.animation.less fix the linting issues (previously linting was not occuring) Change-Id: Iae0a78d0b8a13353de70794b67387f2c3bab44c6
2017-02-02 22:31:03 +00:00
"resources/ext.popups/styles/ext.popups.animation.less",
Move settings images and styles to ext.popups/ From ext.popups.desktop. Change-Id: I55955d1506138e26d24fb9ebaf20ac3e168941ba
2016-12-12 17:06:22 +00:00
"resources/ext.popups/styles/ext.popups.settings.less"
Prepare Popups for adding of mobile specific Popups implementation For the work on T113243, the Popups extension should be structured in a more flexible way. This is achieved with this change. Following has changed: * The main/core logic of Popups now lives in ext.popups.core to be shareable between implementations * The desktop specific logic lives in ext.popups.desktop now, the frontend init code in ext.popups.desktopTarget and the desktop renderer in ext.popups.renderer.desktopRenderer This change doesn't change the functionality of Popups. Change-Id: I72121e0a1e4b2952f85dc1bc8cf59d06b8d22f47
2016-01-29 16:48:24 +00:00
],
Remove ResourceLoaderRegisterModules hook handler We should endeavour to define Resource Loader modules in one place, extension.json. Adding them to the output, however... Changes: * Remove ResourceLoaderRegisterModules hook handler. * Move all dependencies, messages, templates, and styles into "empty" RL module definitions in extension.json so that they don't have to be looked up later. Change-Id: I7ec963e3296de8f411e90079ab13b97c6eba4916
2016-11-08 07:57:30 +00:00
"messages": [
"popups-settings-title",
"popups-settings-description",
"popups-settings-option-simple",
"popups-settings-option-simple-description",
"popups-settings-option-advanced",
"popups-settings-option-advanced-description",
"popups-settings-option-off",
"popups-settings-save",
"popups-settings-cancel",
"popups-settings-enable",
"popups-settings-help",
"popups-settings-help-ok",
previews: Add generic fallback preview Changes: * Make the gateway handle missing pages, which are characterised by the MediaWiki API response having both the missing property set to truthy and the page not having any revisions. * Add the preview-empty template and associated "mwe-popups-is-empty" CSS class, which describe what an empty preview contains and how it should look. Supporting changes: * Move the original preview template into the ext.popups module. Bug: T151054 Change-Id: Ife75bf9c6bafdfe0a6cc3e20eea853b4ac8f951b
2016-11-29 12:34:52 +00:00
"popups-send-feedback",
"popups-preview-no-preview",
"popups-preview-footer-read"
Switch to Schema:Popups revid 15597282 Bug: T131315 Change-Id: I2ed18e00afb3e355327b417e68e5930b46d49086
2016-05-16 20:32:11 +00:00
],
"dependencies": [
Specify es5-shim as a dependency Popups uses Object.keys, and Redux uses ES5. We need to specify a dependency on the shim so that it works on ES3 browsers. See https://phabricator.wikimedia.org/T159164#3069821 The shim will only be loaded when needed, thanks to the es5-skip: * https://github.com/wikimedia/mediawiki/blob/ccd0fca/resources/src/es5-skip.js Bug: T159164 Change-Id: Ib6aa31f985577c5a2704caeb252e67d68607e177
2017-03-03 10:54:30 +00:00
"es5-shim",
Add close button to settings dialog * Load the close icon (previously was not loaded) * Take opportunity to simplify selectors in setting panel and remove unnecessary id selectors * Correct size of header to be consistent with mediawiki ui icon Note: there's a slight movement in the heading text's position presumably due to inconsistiencies between the text inside the Done/Save buttons Bug: T154645 Change-Id: Icd978b45051c43f24ee1c9a8574a961b942082f1
2017-02-01 19:49:31 +00:00
"ext.popups.images",
Allow bucketing anons * Logged in users bypass bucketing. They keep working as before. * When Page Previews is configured as a beta feature, logged out users won't see the feature. * If an anonymous user has enabled/disabled the feature using the settings cog then they will see or not see the feature depending on the value of their setting. * The other anonymous users are bucketed. By default 90% of these users see the feature, the other 10% don't. These numbers can be controlled by the config variable `wgPopupsAnonsEnabledSamplingRate`. Bug: T157700 Change-Id: I5307587b10f4849c4e82d3b064ff759121c2de67
2017-02-27 19:31:34 +00:00
"mediawiki.experiments",
Add BOOT action Changes: * Make grunt:qunit run all QUnit tests in those modules whose names being with "ext.popups". * Add ext.popups/index.js, which initialises the mw.popups namespace. * Add ext.popups/userSettings.js, which contains the code that deals with interacting with the User Agent's storage. * Add ext.popups/experiment.js, which contains the code that that decides whether or not the user is in the experiment condition. * Add tests for both units, converting existing tests where appropriate. * Remove the associated code from ext.popups.core/ext.popups.core.js. * Finally, dispatch the BOOT action against the store in ext.popups/boot.js. Change-Id: I697207677304bd49c7cfe1d37bb0a4af7810f387
2016-11-08 19:42:21 +00:00
"mediawiki.storage",
Add LINK_DWELL and LINK_ABANDON actions Supporting changes: * Add mw.popups.processLinks. * Extract the existing unit tests for mw.popups.selectPopupElements and mw.popups.getTitle. * Fix Grunt QUnit timeout. Change-Id: I325bcb15abc6e0b745d78b7308a346a034ab2988
2016-11-09 11:57:24 +00:00
"mediawiki.Title",
Remove ResourceLoaderRegisterModules hook handler We should endeavour to define Resource Loader modules in one place, extension.json. Adding them to the output, however... Changes: * Remove ResourceLoaderRegisterModules hook handler. * Move all dependencies, messages, templates, and styles into "empty" RL module definitions in extension.json so that they don't have to be looked up later. Change-Id: I7ec963e3296de8f411e90079ab13b97c6eba4916
2016-11-08 07:57:30 +00:00
"mediawiki.jqueryMsg",
"mediawiki.ui.button",
"mediawiki.ui.icon",
Make implicit dependency on mw.Uri explicit Change-Id: Ica6b16fc3f246e02d7f3b446953cd51bd99e3595
2016-12-12 07:01:25 +00:00
"mediawiki.Uri",
Add missing ext.eventLogging.Schema dependency Bug: T156333 Change-Id: I9daa38db4fada95d5c34415b2615c9c96790ca9d
2017-02-14 14:02:13 +00:00
"jquery.hidpi",
"ext.eventLogging.Schema"
Switch to Schema:Popups revid 15597282 Bug: T131315 Change-Id: I2ed18e00afb3e355327b417e68e5930b46d49086
2016-05-16 20:32:11 +00:00
]
Prepare Popups for adding of mobile specific Popups implementation For the work on T113243, the Popups extension should be structured in a more flexible way. This is achieved with this change. Following has changed: * The main/core logic of Popups now lives in ext.popups.core to be shareable between implementations * The desktop specific logic lives in ext.popups.desktop now, the frontend init code in ext.popups.desktopTarget and the desktop renderer in ext.popups.renderer.desktopRenderer This change doesn't change the functionality of Popups. Change-Id: I72121e0a1e4b2952f85dc1bc8cf59d06b8d22f47
2016-01-29 16:48:24 +00:00
}
},
"ResourceFileModulePaths": {
"localBasePath": "",
"remoteExtPath": "Popups"
},
Add extension.json, empty php entry point Bug: T87961 Change-Id: I52e93fd290b1e5d8438467896a159fc7230c5813
2015-07-02 10:00:21 +00:00
"manifest_version": 1
}
Reference in a new issue Copy permalink