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

200 lines
7.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",
Remove BetaFeature code Popups is out of beta feature and this code is no longer needed. Removing code is the happiest activity a developer can do. Other changes: * Remove redundant type field on extension.json (If not set, the extension will default to the "other" section.) * Repurpose `name` with `namemsg` and make use of existing i18n messages Bug: T193053 Change-Id: Iea832cd1f37b0e7df6ff95efd66e4a1ff2a9004e
2018-04-26 20:43:05 +00:00
"namemsg": "popups-message",
Add extension.json, empty php entry point Bug: T87961 Change-Id: I52e93fd290b1e5d8438467896a159fc7230c5813
2015-07-02 10:00:21 +00:00
"author": [
"Prateek Saxena",
Update extension authors Change-Id: Iee16b902247396ed9fc849d433f0a0d6fb2f85e7
2018-05-04 23:32:51 +00:00
"[https://www.mediawiki.org/wiki/Reading/Web/Team Readers Web Team]",
Add extension.json, empty php entry point Bug: T87961 Change-Id: I52e93fd290b1e5d8438467896a159fc7230c5813
2015-07-02 10:00:21 +00:00
"Yair Rand"
],
"url": "https://www.mediawiki.org/wiki/Extension:Popups",
"descriptionmsg": "popups-desc",
Use SPDX 3.0 license identifier SPDX released version 3 of their license list (<https://spdx.org/licenses/>), which changed the FSF licenses to explicitly end in -only or -or-later instead of relying on an easy to miss + symbol. Bug: T183858 Change-Id: If21be3dd6d81dbeb30911bbe3be29e20b55bf6da
2018-03-02 23:33:58 +00:00
"license-name": "GPL-2.0-or-later",
Hygiene: Update required MediaWiki version Per I28003c5898d64031e1efb212cb0bec58ff44b958 Popups require at least MediaWiki version 1.30. Documentation should respect that Change-Id: Ifc87ac5cdcf61ae54cefe3f6ccab7aac5c52e0a6
2017-07-24 14:12:03 +00:00
"requires": {
extension.json: Remove space before colon Change-Id: Iec606d9769b00e9653fa36e00a3798f80cd9c7f7
2018-01-10 13:38:30 +00:00
"MediaWiki": ">= 1.30.0"
Hygiene: Update required MediaWiki version Per I28003c5898d64031e1efb212cb0bec58ff44b958 Popups require at least MediaWiki version 1.30. Documentation should respect that Change-Id: Ifc87ac5cdcf61ae54cefe3f6ccab7aac5c52e0a6
2017-07-24 14:12:03 +00:00
},
Add extension.json, empty php entry point Bug: T87961 Change-Id: I52e93fd290b1e5d8438467896a159fc7230c5813
2015-07-02 10:00:21 +00:00
"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",
Send disabled event when user disables Page Preview Changes: - introduced new UserPreferencesChangeHandler class that listens to PreferencesFormPreSave hook - introduced wrapper for EventLogging extension plus NullLogger when EventLogging extension is not availalbe - when user changes PagePreview to disabled system will trigger disabled event Bug: T167365 Change-Id: I63faecb0495eb30a9fc2763e7ddf3944baf7f55a
2017-07-06 18:16:05 +00:00
"Popups\\PopupsGadgetsIntegration": "includes/PopupsGadgetsIntegration.php",
"Popups\\UserPreferencesChangeHandler": "includes/UserPreferencesChangeHandler.php",
"Popups\\EventLogging\\EventLogger": "includes/EventLogging/EventLogger.php",
"Popups\\EventLogging\\NullLogger": "includes/EventLogging/NullLogger.php",
"Popups\\EventLogging\\MWEventLogger": "includes/EventLogging/MWEventLogger.php",
"Popups\\EventLogging\\EventLoggerFactory": "includes/EventLogging/EventLoggerFactory.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": {
"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
],
"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
],
extension.json: Remove space before colon Change-Id: Iec606d9769b00e9653fa36e00a3798f80cd9c7f7
2018-01-10 13:38:30 +00:00
"PreferencesFormPreSave": [
Send disabled event when user disables Page Preview Changes: - introduced new UserPreferencesChangeHandler class that listens to PreferencesFormPreSave hook - introduced wrapper for EventLogging extension plus NullLogger when EventLogging extension is not availalbe - when user changes PagePreview to disabled system will trigger disabled event Bug: T167365 Change-Id: I63faecb0495eb30a9fc2763e7ddf3944baf7f55a
2017-07-06 18:16:05 +00:00
"Popups\\UserPreferencesChangeHandler::onPreferencesFormPreSave"
],
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"
Change the PopupsVisibility state to visible to match anon experience PagePreviews are visible to anonymous users, we would like to match the same experience, when user creates a new account. On account creation we mark PagePreviews settings to ON or OFF (configurable via PopupsOptInStateForNewAccounts settings). With that approach we can provide the best experience for new users, and keep existing users happy (not enabling feature by default for everyone). Bug: T191888 Change-Id: I39f42aa7268ce59c51f038048025ccf1bdf16481
2018-05-09 21:21:30 +00:00
],
"LocalUserCreated": [
"Popups\\PopupsHooks::onLocalUserCreated"
Add a beta feature switch for reference previews Bug: T215896 Change-Id: I6a4cc2103d594dc11f62da247891d3f190619899
2019-02-20 16:43:15 +00:00
],
"GetBetaFeaturePreferences": [
"Popups\\PopupsHooks::onGetBetaFeaturePreferences"
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": {
Update to a newer Schema:Popups When ?debug=1, we send eventlogging with previewType=reference. This is only supported by a newer schema than we had specified. Change-Id: Ic7558820df5945ccf287ca2211311b2bf0bf5219
2019-09-23 14:18:08 +00:00
"Popups": 18904225,
Record pageviews where Reference Previews is enabled We want to know the side of this population in pageviews, in order to produce proportional metrics later. Bug: T214493 Change-Id: I940872870754e85d19688f3855d6857e65b982b1
2019-10-24 20:47:15 +00:00
"ReferencePreviewsPopups": 19489344,
Bump VirtualPageView schema to 17780078 This should be a noop since edits only relate to documentation changes but is done to avoid confusion Change-Id: I9b4a4924a301e0cdec617d89b9b7d817941a95ef
2018-03-29 21:55:04 +00:00
"VirtualPageView": 17780078
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": {
Hygiene: Page view -> Pageview Pageview is consistent with verbiage used by Research and Analytics Engineering in their reports and documentation, e.g. https://wikitech.wikimedia.org/wiki/Analytics/Pageviews. Bug: T184793 Change-Id: I8ae085b4af85aa72f234f3db27f0cac2c4d014e5
2018-02-21 18:28:56 +00:00
"@PopupsVirtualPageViews": "@var bool: Whether the extension should log virtual pageviews.",
Capture page view-like interactions * New action added PREVIEW_SEEN * The action will be used to signal that a page view needs to be recorded. * PREVIEW_SEEN is a delayed action which is triggered as a side-effect of the previewShow action. It is only dispatched if the user is still previewing the same card and the page related to the card has preview type `page` * The pageview changelistener is added when $wgPopupsVirtualPageViews is set to true. * The page view changelistener listens for page views and logs them using EventLogging when needed using https://meta.wikimedia.org/wiki/Schema:VirtualPageView Note: * Currently if a user has enabled the DNT header, the event will not be logged. There is ongoing discussion on the ticket and fixing this will be addressed separately. * Only title and referrer are logged in the initial version. The task demands that "namespace" is logged but this information is not provided by the summary endpoints we use so will need to be added later (if indeed needed) either via a change to that endpoint of by using JavaScript to parse the URL. Bug: T184793 Change-Id: Id1fe34e4bdada3a41f0d888a753af366d4756590
2018-02-08 22:11:44 +00:00
"PopupsVirtualPageViews": false,
Remove BetaFeature code Popups is out of beta feature and this code is no longer needed. Removing code is the happiest activity a developer can do. Other changes: * Remove redundant type field on extension.json (If not set, the extension will default to the "other" section.) * Repurpose `name` with `namemsg` and make use of existing i18n messages Bug: T193053 Change-Id: Iea832cd1f37b0e7df6ff95efd66e4a1ff2a9004e
2018-04-26 20:43:05 +00:00
"@PopupsHideOptInOnPreferencesPage": "@var bool: Whether the option to enable/disable Page Previews should be hidden on Preferences page. False by default",
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": false,
Change the PopupsVisibility state to visible to match anon experience PagePreviews are visible to anonymous users, we would like to match the same experience, when user creates a new account. On account creation we mark PagePreviews settings to ON or OFF (configurable via PopupsOptInStateForNewAccounts settings). With that approach we can provide the best experience for new users, and keep existing users happy (not enabling feature by default for everyone). Bug: T191888 Change-Id: I39f42aa7268ce59c51f038048025ccf1bdf16481
2018-05-09 21:21:30 +00:00
"@PopupsOptInDefaultState": "@var string:['1'|'0'] Default Page Previews visibility for old accounts. Has to be a string as a compatibility with beta feature settings. For more info see @T191888",
Remove hard dependency on BetaFeatures Also fix typos in config file. Bug: T161829 Change-Id: I91fd695ab9d2e4b142c67884f5e8c83f3142d240
2017-03-30 19:37:52 +00:00
"PopupsOptInDefaultState": "0",
Change the PopupsVisibility state to visible to match anon experience PagePreviews are visible to anonymous users, we would like to match the same experience, when user creates a new account. On account creation we mark PagePreviews settings to ON or OFF (configurable via PopupsOptInStateForNewAccounts settings). With that approach we can provide the best experience for new users, and keep existing users happy (not enabling feature by default for everyone). Bug: T191888 Change-Id: I39f42aa7268ce59c51f038048025ccf1bdf16481
2018-05-09 21:21:30 +00:00
"@PopupsOptInStateForNewAccounts": "@var string:['1'|'0'] Default Page Previews visibility for newly created accounts (from Q2 2018). For more info see @T191888",
"PopupsOptInStateForNewAccounts": "0",
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
"@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",
Implement html/rest.js gateway which handles HTML Restbase responses Refactor existing Restbase gateway and extract shared logic into shared Restbase provider. Also introduced new createNullModel() which defines an empty preview model. Additionally improve naming in new gateways/formatter so function names are more explicity. * Htmlize() became formatPlainTextExtract() as it should be used only with plain text extracts * removeEllipsis() became removeTrailingEllipsis() as it removes only trailing ellipsis. * src/gateway/index.js defines gateways by configuration name stored in extension.json Bug: T165018 Change-Id: Ibe54dddfc1080e94814d1562d41e85cb6b43bfc1 Depends-On: I4f42c61b155a37c5dd42bc40034583865abd5d7a
2017-06-08 13:29:57 +00:00
"@PopupsGateway": "Which gateway to use for fetching Popups data. Available options: [mwApiPlain|restbasePlain|restbaseHTML]. Full and always up to date list is available in src/gateway/index.js",
"PopupsGateway": "mwApiPlain",
RESTBase url is configurable Allow developers to use different endpoints for summaries = developer happiness This is useful for the following use cases: * A developer wants to test against a production endpoint via CORS * A developer has setup an API where REST is hosted elsewhere e.g. http://localhost:6927/en.wikipedia.org/v1/ * A user wants to create their own REST summary compatible endpoint * A wiki e.g. wikidata wants to use a different endpoint which is compatible with the summary endpoint. We are unlikely to use it ourselves on Wikimedia wikis (the default should suffice) but this will be a powerful tool for When not configured this will continue to work as per normal Change-Id: I8a7e12fbc43cddbac678e0d7b81d1e877b747b22
2018-03-07 20:15:30 +00:00
"@PopupsRestGatewayEndpoint": "Specify a REST endpoint where summaries should be sourced from. Endpoint must meet the spec at https://www.mediawiki.org/wiki/Specs/Summary/1.2.0",
"PopupsRestGatewayEndpoint": "/api/rest_v1/page/summary/",
Add feature flag to disable reference previews by default This is a prerequisit for the later patch Ie0ccb03. Any JavaScript code can check this feature flag via mw.config.get( 'wgPopupsReferencePreviews' ) Bug: T213415 Change-Id: I17687c62cc8d738a4eb41738c9ce6662a5ec68d8
2019-01-21 10:24:33 +00:00
"@PopupsReferencePreviews": "Temporary feature flag to disable reference previews during developement.",
Enable reference popups by default It is more convinient to have the feature enabled by default and set it to false on the production servers. This makes it easier to use and test by CI. Depends-On: I36b4fb7615de5ff6670b70345abf7436538a6828 Change-Id: Iad3bc723e1dd5f79e770c9a2f66190ebcd7c8b9d
2019-01-24 09:27:41 +00:00
"PopupsReferencePreviews": true,
Add a beta feature switch for reference previews Bug: T215896 Change-Id: I6a4cc2103d594dc11f62da247891d3f190619899
2019-02-20 16:43:15 +00:00
"@PopupsReferencePreviewsBetaFeature": "Make Reference Previews a Beta feature.",
"PopupsReferencePreviewsBetaFeature": true,
Remove A/B testing code No longer needed. We can't turn something off again for people now they expect it to exist. Clarified usage instructions of PopupsEventLogging to make sure it's more scary given the implications Bug: T173952 Change-Id: I7be005b79da498d8e7b7df8f18b60c1327636a2c
2018-05-03 21:22:11 +00:00
"@PopupsEventLogging": "Whether we should log events. Note if this is enabled without using that variable events will be logged for all users without any sampling! Be careful!",
Popups A/B test infrastructure Introduce PopupsAnonsExperimentalGroupSize config variable. This defines a population size who will be subject to experimentation. If the group size is undefined or 0 (default) and PopupsBetaFeature is false (default value) Popups will be enabled for everyone. If it is any other value, half that group will see page previews. Drop the config variable PopupsSchemaSamplingRate - we will now only EventLog when an experiment is occuring. This means we can simplify the MWEventLogger class as shouldLog will always be truthy. Given server side eventlogging is only used for preference changes traffic should be low and not need sampling. Introduce getUserBucket which determines whether a user is in a bucket on, off or control based on the value of PopupsAnonsExperimentalGroupSize. Add tests showing how these buckets are calculated. Caution: A kill switch wgPopupsEventLogging is provided for safety. It defaults to false. Before merging, please check if any config changes are necessary. Bug: T171853 Change-Id: If2a0c5fceae78262c44cb522af38a925cc5919d3
2017-08-10 17:55:26 +00:00
"PopupsEventLogging": false,
Log events to statsv for monitoring PagePreviews performance For logging to work: 1. $wgWMEStatsdBaseUri needs to point to a valid statsv endpoint, e.g. 'https://en.wikipedia.org/beacon/statsv'. 2. $wgPopupsStatsvSamplingRate needs to be set. Note that the codebase already contains the EventLogging functionality, which is configured separately. Separately configuring different logging mechanisms allows us to avoid sampling mistakes that may arise while choosing one or the other. For example, let's say we want to use EventLogging for 10% of users and statsv for 5%. We'd sample all users into two buckets: 50/50. And then we'd have to set the sampling rates as 20% and 10% respectively, only because of the bucketing above. To avoid this kind of complications, separate sampling rates are used for each logging mechanism. This, of course, may result in situations where a session is logged via both EventLogging and statsv. 3. The WikimediaEvents extension needs to be installed. The extension adds the `ext.wikimediaEvents` module to the output page. The logging functionality is delegated to this module. Notable changes: * The FETCH_START and FETCH_END actions are converted to a timed action. * The experiments stub used in tests has been extracted to the stubs file. Logged data is visualized at https://grafana.wikimedia.org/dashboard/db/reading-web-page-previews Bug: T157111 Change-Id: If3f1a06f1f623e8e625b6c30a48b7f5aa9de24db
2017-03-07 00:27:38 +00:00
"@PopupsStatsvSamplingRate": "Sampling rate for logging performance data to statsv.",
Disable Previews on blacklisted pages Introduce a config variable `PopupsPageBlacklist`. Previews code won't be shipped to pages listed in the config variable. Bug: T170169 Change-Id: Ia8342b55c682f444ba79e959dcc1180527a31374
2017-07-28 18:58:13 +00:00
"PopupsStatsvSamplingRate": 0,
Use canonical name for NS_SPECIAL titles when checking the blacklist Changes - when verifying title use canonical names for pages in special namespace - improve unit tests to verify canonical names and translated titles Bug: T170169 Change-Id: I49592133eb8286eacf04fd3034df091f7ef2aa50
2017-08-24 20:51:39 +00:00
"@PopupsPageBlacklist": "Blacklisted pages are subject to the HTML cache policy of the wiki. A purge on a blacklisted page maybe needed to see the effect of this configuration variable. Every blacklisted page should be defined by a canonical name, eg: Special:Userlogin",
"PopupsPageBlacklist": [ "Special:Userlogin", "Special:CreateAccount" ]
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",
"images": {
Generate cog icon via ResourceLoaderImage module * Merge mwe-popups-icon with mwe-popups-settings-icon * Remove PNG - now generated by the ResourceLoader module * Adjust popup footer paddings/widths and store them in variables * RTL and LTR compatible Bug: T133956 Change-Id: I14ccd7b6731e9ec49f9959411fd17f7c9fdf43be
2017-04-20 21:59:57 +00:00
"popups-settings": "resources/ext.popups.images/cog.svg",
Custom page preview for disambiguation pages Creating a different page preview for disambiguation pages. This patch: - modifies the Preview model to accept a new 'type' property - modifies the Restbase Gateway to pass the 'type' prop to the Preview model - creates a new template to accept both generic/disambig previews - modifies the renderer to render the new template - generates icons for new template through resource loader - adds new i18n strings - modifies event-logging "preview seen" event to send new "disambiguation" previewType - updates event logging schema version - adds tests for Preview model and renderer for new preview type - does way too much? yes, yes it does. Bug: T168392 Change-Id: Idc936cc3eabbdd99a3d98f43c66b4cdbb7d24917
2018-03-07 11:10:53 +00:00
"popups-close": "resources/ext.popups.images/close.svg",
Update OOUI icons to latest versions * web.svg was deprecated in favour of browser.svg. * Update sad-face.svg based on OOUI speechBubble-ltr/rtl * Apply preview-generic/disambiguation grey colour using CSS. Change-Id: I8feea1b526ff85c4ffdee21ef42c616e72881e76
2019-04-12 12:22:37 +00:00
"preview-generic": {
"file": {
"ltr": "resources/ext.popups.images/sad-face-ltr.svg",
"rtl": "resources/ext.popups.images/sad-face-rtl.svg"
}
},
All images are served by ResourceLoaderImageModule This moves the footer icon into the ResourceLoaderImage module providing us a consistent way of serving image assets. This means we no longer need to provide PNGs for icons However, given mw-ui-icon-large is not large enough for the given use case we do have to wrestle with icon styles and override them to get the desired result. I think this is a small price to pay given icons are now discoverable Change-Id: I38b62c01fd930dcbfb73b95e6128885cb483f86e
2018-04-03 23:32:40 +00:00
"footer": {
"file": {
"ltr": "resources/ext.popups.images/footer-ltr.svg",
"rtl": "resources/ext.popups.images/footer-rtl.svg"
}
},
Standardise disambiguation icon All icons should be 20 by 20 by standard. (Previously it was 24 by 24) Bug: T190558 Change-Id: I0956c9c31f1606f0a77b4be29bde5a56b5c5ebb8
2018-03-23 18:45:40 +00:00
"preview-disambiguation": {
"file": {
Update OOUI icons to latest versions * web.svg was deprecated in favour of browser.svg. * Update sad-face.svg based on OOUI speechBubble-ltr/rtl * Apply preview-generic/disambiguation grey colour using CSS. Change-Id: I8feea1b526ff85c4ffdee21ef42c616e72881e76
2019-04-12 12:22:37 +00:00
"ltr": "resources/ext.popups.images/articles-ltr.svg",
"rtl": "resources/ext.popups.images/articles-rtl.svg"
Standardise disambiguation icon All icons should be 20 by 20 by standard. (Previously it was 24 by 24) Bug: T190558 Change-Id: I0956c9c31f1606f0a77b4be29bde5a56b5c5ebb8
2018-03-23 18:45:40 +00:00
}
Add default OOUI reference icon to all reference popups I tried hard to keep the CSS as small and robust as possible. The icon will be align with the text by adding a negativ margin. With that we also decided against using RTL and LTR specific icons that are positioned at the edge of the canvas for now. Bug: T213907 Change-Id: I98888114e1c50e249cf31e71749323bd4f69da3f
2019-01-24 17:48:13 +00:00
},
Add all reference type icons and messages These icons are currently unused because the gateway does not deliver the necessary information. This will be used starting with I6223cbb. This patch aims to introduce all resources needed by the later. Bug: T214908 Change-Id: Ie0c3c059222700169f2605c3123554c74d974256
2019-02-16 09:13:23 +00:00
"reference-generic": "resources/ext.popups.images/reference.svg",
"reference-book": {
"file": {
"ltr": "resources/ext.popups.images/book-ltr.svg",
"rtl": "resources/ext.popups.images/book-rtl.svg"
}
},
"reference-journal": {
"file": {
"ltr": "resources/ext.popups.images/journal-ltr.svg",
"rtl": "resources/ext.popups.images/journal-rtl.svg"
}
},
"reference-news": {
"file": {
"ltr": "resources/ext.popups.images/newspaper-ltr.svg",
"rtl": "resources/ext.popups.images/newspaper-rtl.svg"
}
},
Update OOUI icons to latest versions * web.svg was deprecated in favour of browser.svg. * Update sad-face.svg based on OOUI speechBubble-ltr/rtl * Apply preview-generic/disambiguation grey colour using CSS. Change-Id: I8feea1b526ff85c4ffdee21ef42c616e72881e76
2019-04-12 12:22:37 +00:00
"reference-web": {
"file": {
"ltr": "resources/ext.popups.images/browser-ltr.svg",
"rtl": "resources/ext.popups.images/browser-rtl.svg"
}
}
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
}
},
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": {
Remove popups from critical rendering path Instead load it via mw.loader.using We retain the module name ext.popups as this will be present in cached HTML, however now it will load the bulk of the code inside ext.popups.main Bug: T176211 Change-Id: Ibe212721807d3698dc45ef46b2dbde15ca9d2f70
2017-10-16 20:09:56 +00:00
"scripts": [
"resources/ext.popups/index.js"
]
},
"ext.popups.main": {
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
"styles": [
Hygiene: split LESS into components Bug: T165036 Change-Id: I916f27138b5abe6b9fe23719cffb10f20e604b89
2018-03-27 19:10:48 +00:00
"src/ui/index.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-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-preview-no-preview",
Custom page preview for disambiguation pages Creating a different page preview for disambiguation pages. This patch: - modifies the Preview model to accept a new 'type' property - modifies the Restbase Gateway to pass the 'type' prop to the Preview model - creates a new template to accept both generic/disambig previews - modifies the renderer to render the new template - generates icons for new template through resource loader - adds new i18n strings - modifies event-logging "preview seen" event to send new "disambiguation" previewType - updates event logging schema version - adds tests for Preview model and renderer for new preview type - does way too much? yes, yes it does. Bug: T168392 Change-Id: Idc936cc3eabbdd99a3d98f43c66b4cdbb7d24917
2018-03-07 11:10:53 +00:00
"popups-preview-footer-read",
"popups-preview-disambiguation",
Add reference preview type This adds support for preview popups on reference/footnotes from the Cite extension. For that a new preview type was introduced and integrated into the existing structures. The essential starting points were this code comes into action are added behind the feature flag introduced in the previous patches. Bug: T213415 Change-Id: Ie0ccb03117bd654373d0f458b62cc52018361c67
2018-12-12 18:37:19 +00:00
"popups-preview-disambiguation-link",
Consistently talk about "Reference" instead of "Footnote" During story time on 2019-03-12 it was decided to consistently talk about "References" in all messages. Main motivation is that this is the term the community is most familiar with, and it is also the term that is used in reference section headings most of the time. Bug: T215063 Change-Id: Iaab8d2c0da1546a3c9d27bc8e2e1c784050ed135
2019-03-12 16:23:46 +00:00
"popups-refpreview-reference",
Add all reference type icons and messages These icons are currently unused because the gateway does not deliver the necessary information. This will be used starting with I6223cbb. This patch aims to introduce all resources needed by the later. Bug: T214908 Change-Id: Ie0c3c059222700169f2605c3123554c74d974256
2019-02-16 09:13:23 +00:00
"popups-refpreview-book",
"popups-refpreview-journal",
"popups-refpreview-news",
"popups-refpreview-web",
Consistently talk about "Reference" instead of "Footnote" During story time on 2019-03-12 it was decided to consistently talk about "References" in all messages. Main motivation is that this is the term the community is most familiar with, and it is also the term that is used in reference section headings most of the time. Bug: T215063 Change-Id: Iaab8d2c0da1546a3c9d27bc8e2e1c784050ed135
2019-03-12 16:23:46 +00:00
"popups-refpreview-jump-to-reference"
Switch to Schema:Popups revid 15597282 Bug: T131315 Change-Id: I2ed18e00afb3e355327b417e68e5930b46d49086
2016-05-16 20:32:11 +00:00
],
"dependencies": [
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",
Replace deprecated mw.RegExp.escape() with mw.util.escapeRegExp() The signature mw.RegExp.escape() is deprecated since MediaWiki 1.34. By the way, this is the 4th or even 5th time in my short career this tiny, single line (!) helper function is moved around and I need to update all my code. This felt already ridiculous when it happened the 2nd time. Change-Id: I4d05a49120aff64ebc316d0af7736c62385d9307
2019-10-17 07:37:24 +00:00
"mediawiki.jqueryMsg",
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.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",
Replace deprecated mw.RegExp.escape() with mw.util.escapeRegExp() The signature mw.RegExp.escape() is deprecated since MediaWiki 1.34. By the way, this is the 4th or even 5th time in my short career this tiny, single line (!) helper function is moved around and I need to update all my code. This felt already ridiculous when it happened the 2nd time. Change-Id: I4d05a49120aff64ebc316d0af7736c62385d9307
2019-10-17 07:37:24 +00:00
"mediawiki.user",
"mediawiki.util"
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"
},
Hygiene: Dependency Injection for Popups Changes: - removed ugly PopupsContext::getInstance - removed ugly PopupsContextTestWrapper helper - defined all services inside ServiceWirings - fixed unit tests to test classes directly or use MediawikiServices Change-Id: Ie27e28bb07aebe01014848c290369b1b1f098e9b
2017-07-21 17:06:08 +00:00
"ServiceWiringFiles": [
"includes/ServiceWirings.php"
],
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