mediawiki-extensions-Popups/extension.json
Jon Robson 59c6b8e88f Reference previews should use Popups registration
* Adds a new webpack entry point for references previews
* Reference related code in src/index.js is moved to new
file resources/ext.popups.referencePreviews/index.js

The changes:
* References previews now in its own module ext.popups.referencePreviews
* Loaded via getCustomPopupTypes
* OWNERS.md files make clear which team owns which part of the code.

Bug: T326692
Change-Id: Iea8a5b9221c0b1fd41e40bff2cbe01e42124d53f
2024-01-16 11:38:08 +01:00

222 lines
6.7 KiB
JSON

{
"name": "Popups",
"namemsg": "popups-message",
"author": [
"Prateek Saxena",
"[https://www.mediawiki.org/wiki/Reading/Web/Team Readers Web Team]",
"Yair Rand"
],
"url": "https://www.mediawiki.org/wiki/Extension:Popups",
"descriptionmsg": "popups-desc",
"license-name": "GPL-2.0-or-later",
"requires": {
"MediaWiki": ">= 1.42.0"
},
"AutoloadNamespaces": {
"Popups\\": "includes/"
},
"ConfigRegistry": {
"popups": "GlobalVarConfig::newInstance"
},
"Hooks": {
"BeforePageDisplay": "PopupsHooks",
"ResourceLoaderGetConfigVars": "PopupsHooks",
"GetPreferences": "PopupsHooks",
"UserGetDefaultOptions": "PopupsHooks",
"MakeGlobalVariablesScript": "PopupsHooks",
"LocalUserCreated": "PopupsHooks"
},
"HookHandlers": {
"PopupsHooks": {
"class": "Popups\\PopupsHooks",
"services": [
"UserOptionsManager"
]
}
},
"MessagesDirs": {
"Popups": [
"i18n"
]
},
"attributes": {
"EventLogging": {
"Schemas": {
"ReferencePreviewsPopups": "/analytics/legacy/referencepreviewspopups/1.1.0",
"VirtualPageView": "/analytics/legacy/virtualpageview/1.0.0"
}
}
},
"config": {
"PopupsVirtualPageViews": {
"description": "@var bool: Whether the extension should log virtual pageviews.",
"value": false
},
"PopupsHideOptInOnPreferencesPage": {
"description": "@var bool: Whether the option to enable/disable Page Previews should be hidden on Preferences page. False by default",
"value": false
},
"PopupsOptInDefaultState": {
"description": "@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",
"value": "1"
},
"PopupsOptInStateForNewAccounts": {
"description": "@var string:['1'|'0'] Default Page Previews visibility for newly created accounts (from Q2 2018). For more info see @T191888",
"value": "1"
},
"PopupsConflictingNavPopupsGadgetName": {
"description": "@var string: Navigation popups gadget name",
"value": "Navigation_popups"
},
"PopupsConflictingRefTooltipsGadgetName": {
"description": "@var string: Name of a gadget that would cause duplicate reference preview popups. Known conflicting gadgets include \"ReferenceTooltips\", \"CiteTooltip\" alias \"RefTooltip\", \"ReferencePopups\", and \"tooltipRef\" (see T274353).",
"value": "ReferenceTooltips"
},
"PopupsGateway": {
"description": "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",
"value": "mwApiPlain"
},
"PopupsRestGatewayEndpoint": {
"description": "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",
"value": "/api/rest_v1/page/summary/"
},
"PopupsReferencePreviews": {
"description": "Feature flag to enable or disable the separate popup type for references created via the Cite extension's <ref> tag.",
"value": true
},
"PopupsStatsvSamplingRate": {
"description": "Sampling rate for logging performance data to statsv.",
"value": 0
},
"PopupsPageDisabled": {
"description": "List of pages that should not show Popups. Includes subpages. These pages are subject to the HTML cache policy of the wiki. A purge on these pages maybe needed to see the effect of this configuration variable. Every excluded page should be defined by a canonical name, eg: Special:Userlogin",
"value": [
"Special:CreateAccount",
"Special:GlobalRenameRequest",
"Special:Userlogin",
"Special:MergeAccount",
"Special:ChangeCredentials",
"Special:OAuthListConsumers",
"Special:GlobalUserRights",
"Special:Notifications",
"Special:UserRights",
"Special:Upload",
"Special:VipsTest",
"Special:ApiFeatureUsage",
"Special:ExpandTemplates",
"Special:GadgetUsage",
"Special:GraphSandbox",
"Special:TemplateSandbox",
"Special:MostLinkedFiles",
"Special:Book"
]
},
"PopupsTextExtractsIntroOnly": {
"description": "Whether we should extract intro text only or full page text. This is only applicable when using PopupsGateway=mwApiPlain.",
"value": true
}
},
"ResourceModules": {
"ext.popups.icons": {
"class": "MediaWiki\\ResourceLoader\\OOUIIconPackModule",
"selectorWithoutVariant": ".popups-icon--{name}",
"icons": [
"infoFilled",
"settings"
]
},
"ext.popups.images": {
"selector": ".popups-icon--{name}",
"class": "MediaWiki\\ResourceLoader\\ImageModule",
"images": {
"preview-generic": {
"file": {
"ltr": "resources/ext.popups.images/sad-face-ltr.svg",
"rtl": "resources/ext.popups.images/sad-face-rtl.svg"
}
},
"footer": {
"file": {
"ltr": "resources/ext.popups.images/footer-ltr.svg",
"rtl": "resources/ext.popups.images/footer-rtl.svg"
}
}
}
},
"ext.popups": {
"packageFiles": [
{
"name": "resources/ext.popups/types.json",
"callback": "Popups\\PopupsHooks::getCustomPopupTypes"
},
"resources/ext.popups/index.js"
]
},
"ext.popups.referencePreviews": {
"styles": [
"resources/ext.popups.referencePreviews/referencePreview.less"
],
"scripts": [
"resources/dist/referencePreviews.js",
"resources/ext.popups.referencePreviews/index.js"
]
},
"ext.popups.main": {
"scripts": [
"resources/dist/index.js"
],
"styles": [
"src/ui/index.less"
],
"messages": [
"popups-settings-title",
"popups-settings-option-page",
"popups-settings-option-page-description",
"popups-settings-option-reference",
"popups-settings-option-reference-description",
"popups-settings-save",
"popups-settings-cancel",
"popups-settings-enable",
"popups-settings-icon-gear-title",
"popups-settings-help",
"popups-settings-help-ok",
"popups-preview-no-preview",
"popups-preview-footer-read",
"popups-preview-disambiguation",
"popups-preview-disambiguation-link",
"popups-refpreview-reference",
"popups-refpreview-book",
"popups-refpreview-journal",
"popups-refpreview-news",
"popups-refpreview-note",
"popups-refpreview-web",
"popups-refpreview-collapsible-placeholder"
],
"dependencies": [
"web2017-polyfills",
"ext.popups.images",
"mediawiki.experiments",
"mediawiki.jqueryMsg",
"mediawiki.storage",
"mediawiki.Title",
"mediawiki.Uri",
"mediawiki.user",
"mediawiki.util",
"codex-search-styles"
]
}
},
"ResourceFileModulePaths": {
"localBasePath": "",
"remoteExtPath": "Popups"
},
"ServiceWiringFiles": [
"includes/ServiceWiring.php"
],
"DefaultUserOptions": {
"popupsreferencepreviews": 0,
"popups-reference-previews": 0
},
"manifest_version": 2
}