wikimedia/mediawiki-extensions-RelatedArticles
1
0
Fork 0
mirror of https://gerrit.wikimedia.org/r/mediawiki/extensions/RelatedArticles synced 2024-11-28 02:00:17 +00:00
Code Issues Packages Projects Releases Wiki Activity
mediawiki-extensions-Relate.../extension.json

172 lines
4.6 KiB
JSON
Raw Normal View History

Use extension registration Add extension.json and populate it with information from both RelatedArticles.php and the RelatedArticles extension wiki page [0]. Migrate the hook handlers to static functions operating on static data rather than having a single, global instance of RelatedArticles so that the hook handler definitions can be added to extension.json easily. N.B. During testing the handlers for both the SkinBuildSidebar and SkinTemplateToolboxEnd appeared to have the same effect so the TODO was removed but not the handler for the former. Additional changes include: * RelatedArticles.class.php -> includes/RelatedArticles.php * RelatedArticles -> RelatedArticles\Hooks * Documenting all of the methods of RelatedArticles\Hooks [0] https://www.mediawiki.org/wiki/Extension:RelatedArticles Bug: T87965 Change-Id: I9944b9186746386ee18ca28657bb547c00ae2b8c
2015-10-02 19:46:48 +00:00
{
"name": "RelatedArticles",
Remove EventLogging/A-B test code from RelatedArticles With RelatedArticlesEnabledBucketSize now removed, installation of this extension will turn it on for 100% users without any mechanism to turn it off. Additional changes: * Bump version * Add Readers team to contributors Bug: T202306 Change-Id: I7dc270a06dd3afd4e894c8298165d6d6d4fda8d6
2018-09-13 18:40:42 +00:00
"version": "3.1.0",
Use extension registration Add extension.json and populate it with information from both RelatedArticles.php and the RelatedArticles extension wiki page [0]. Migrate the hook handlers to static functions operating on static data rather than having a single, global instance of RelatedArticles so that the hook handler definitions can be added to extension.json easily. N.B. During testing the handlers for both the SkinBuildSidebar and SkinTemplateToolboxEnd appeared to have the same effect so the TODO was removed but not the handler for the former. Additional changes include: * RelatedArticles.class.php -> includes/RelatedArticles.php * RelatedArticles -> RelatedArticles\Hooks * Documenting all of the methods of RelatedArticles\Hooks [0] https://www.mediawiki.org/wiki/Extension:RelatedArticles Bug: T87965 Change-Id: I9944b9186746386ee18ca28657bb547c00ae2b8c
2015-10-02 19:46:48 +00:00
"author": [
Remove EventLogging/A-B test code from RelatedArticles With RelatedArticlesEnabledBucketSize now removed, installation of this extension will turn it on for 100% users without any mechanism to turn it off. Additional changes: * Bump version * Add Readers team to contributors Bug: T202306 Change-Id: I7dc270a06dd3afd4e894c8298165d6d6d4fda8d6
2018-09-13 18:40:42 +00:00
"[https://www.mediawiki.org/wiki/Reading/Web/Team Readers Web Team]",
Use extension registration Add extension.json and populate it with information from both RelatedArticles.php and the RelatedArticles extension wiki page [0]. Migrate the hook handlers to static functions operating on static data rather than having a single, global instance of RelatedArticles so that the hook handler definitions can be added to extension.json easily. N.B. During testing the handlers for both the SkinBuildSidebar and SkinTemplateToolboxEnd appeared to have the same effect so the TODO was removed but not the handler for the former. Additional changes include: * RelatedArticles.class.php -> includes/RelatedArticles.php * RelatedArticles -> RelatedArticles\Hooks * Documenting all of the methods of RelatedArticles\Hooks [0] https://www.mediawiki.org/wiki/Extension:RelatedArticles Bug: T87965 Change-Id: I9944b9186746386ee18ca28657bb547c00ae2b8c
2015-10-02 19:46:48 +00:00
"Roland Unger",
"Hans Musil",
Add Related Articles section to Minerva If the page has related articles, is in mainspace, isn't the main page, and the output is being rendered with the MinervaBeta skin then a "Related Articles" section is added to the page just before the footer. Separate loading the information necessary to render the pages, choosing the renderer, and rendering the data so that multiple skins - currently Minerva and Vector per the mocks - not just multiple resolutions can all be handled the same way: * The bootstrap script (ext.relatedArticles.readMore.bootstrap/index.js) for fetches the page image and Wikidata description; loading the renderer module; and, finally, notifying the renderer module that it should render the data, which it does by emitting "ext.relatedArticles.readMore.init" event using mw#track * The Minerva renderer subscribes to the event and, when it's fired, renders the data by passing it to the WatchstarPageList view Bug: T113635 Change-Id: I651342bdf9796938fa7051828dd13bc6fe774783
2015-10-07 13:12:42 +00:00
"Matthias Mullie",
"Sam Smith"
Use extension registration Add extension.json and populate it with information from both RelatedArticles.php and the RelatedArticles extension wiki page [0]. Migrate the hook handlers to static functions operating on static data rather than having a single, global instance of RelatedArticles so that the hook handler definitions can be added to extension.json easily. N.B. During testing the handlers for both the SkinBuildSidebar and SkinTemplateToolboxEnd appeared to have the same effect so the TODO was removed but not the handler for the former. Additional changes include: * RelatedArticles.class.php -> includes/RelatedArticles.php * RelatedArticles -> RelatedArticles\Hooks * Documenting all of the methods of RelatedArticles\Hooks [0] https://www.mediawiki.org/wiki/Extension:RelatedArticles Bug: T87965 Change-Id: I9944b9186746386ee18ca28657bb547c00ae2b8c
2015-10-02 19:46:48 +00:00
],
"url": "https://www.mediawiki.org/wiki/Extension:RelatedArticles",
"descriptionmsg": "relatedarticles-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: Id06c20eb9e1d97b6b8aa1fd2195ec1002066690d
2018-03-02 23:35:10 +00:00
"license-name": "GPL-2.0-only",
Mark extension as Beta Feature Change-Id: I33d2c1cd7c868e98874328216b16627a7c47dbc4
2016-01-15 13:20:46 +00:00
"type": "betafeatures",
Require MediaWiki 1.31 in extension.json for AutoloadNamespaces AutoloadNamespaces is a new feature in 1.31 Change-Id: I0ee5de22a50d8aec3bd0f52744119de074651158
2018-07-07 10:00:25 +00:00
"requires": {
"MediaWiki": ">= 1.31.0"
},
Switch to PSR-4 autoloader Change-Id: I1add76d094ea8a122442bfe06fbd67c3c819b9fa
2018-06-12 01:34:07 +00:00
"AutoloadNamespaces": {
"RelatedArticles\\": "includes/"
Use extension registration Add extension.json and populate it with information from both RelatedArticles.php and the RelatedArticles extension wiki page [0]. Migrate the hook handlers to static functions operating on static data rather than having a single, global instance of RelatedArticles so that the hook handler definitions can be added to extension.json easily. N.B. During testing the handlers for both the SkinBuildSidebar and SkinTemplateToolboxEnd appeared to have the same effect so the TODO was removed but not the handler for the former. Additional changes include: * RelatedArticles.class.php -> includes/RelatedArticles.php * RelatedArticles -> RelatedArticles\Hooks * Documenting all of the methods of RelatedArticles\Hooks [0] https://www.mediawiki.org/wiki/Extension:RelatedArticles Bug: T87965 Change-Id: I9944b9186746386ee18ca28657bb547c00ae2b8c
2015-10-02 19:46:48 +00:00
},
"ExtensionMessagesFiles": {
"RelatedArticlesMagic": "RelatedArticles.i18n.magic.php"
},
"Hooks": {
extension.json: Simplify hook calls as we only ever use one Change-Id: Ie835cac5df0697829dcf6f1796d9c4331512a8fc
2020-05-11 19:47:11 +00:00
"ParserFirstCallInit": "RelatedArticles\\Hooks::onParserFirstCallInit",
"OutputPageParserOutput": "RelatedArticles\\Hooks::onOutputPageParserOutput",
"MakeGlobalVariablesScript": "RelatedArticles\\Hooks::onMakeGlobalVariablesScript",
"BeforePageDisplay": "RelatedArticles\\Hooks::onBeforePageDisplay",
"ResourceLoaderGetConfigVars": "RelatedArticles\\Hooks::onResourceLoaderGetConfigVars",
"SkinAfterContent": "RelatedArticles\\Hooks::onSkinAfterContent"
Use extension registration Add extension.json and populate it with information from both RelatedArticles.php and the RelatedArticles extension wiki page [0]. Migrate the hook handlers to static functions operating on static data rather than having a single, global instance of RelatedArticles so that the hook handler definitions can be added to extension.json easily. N.B. During testing the handlers for both the SkinBuildSidebar and SkinTemplateToolboxEnd appeared to have the same effect so the TODO was removed but not the handler for the former. Additional changes include: * RelatedArticles.class.php -> includes/RelatedArticles.php * RelatedArticles -> RelatedArticles\Hooks * Documenting all of the methods of RelatedArticles\Hooks [0] https://www.mediawiki.org/wiki/Extension:RelatedArticles Bug: T87965 Change-Id: I9944b9186746386ee18ca28657bb547c00ae2b8c
2015-10-02 19:46:48 +00:00
},
"MessagesDirs": {
"RelatedArticles": [
"i18n"
]
},
Update extension.json to manifest version 2 Bug: T241892 Change-Id: I9c7156df3220389e7fbf94375e9fdb753458f16e
2020-01-04 18:33:29 +00:00
"manifest_version": 2,
Add Related Articles section to Minerva If the page has related articles, is in mainspace, isn't the main page, and the output is being rendered with the MinervaBeta skin then a "Related Articles" section is added to the page just before the footer. Separate loading the information necessary to render the pages, choosing the renderer, and rendering the data so that multiple skins - currently Minerva and Vector per the mocks - not just multiple resolutions can all be handled the same way: * The bootstrap script (ext.relatedArticles.readMore.bootstrap/index.js) for fetches the page image and Wikidata description; loading the renderer module; and, finally, notifying the renderer module that it should render the data, which it does by emitting "ext.relatedArticles.readMore.init" event using mw#track * The Minerva renderer subscribes to the event and, when it's fired, renders the data by passing it to the WatchstarPageList view Bug: T113635 Change-Id: I651342bdf9796938fa7051828dd13bc6fe774783
2015-10-07 13:12:42 +00:00
"ResourceModules": {
Migrate Cards code to RelatedArticles * Move across all files * Rename ext-card- prefix to ext-related-articles- prefix ** Since all code using these prefixes is JS we do not have to worry about cached HTML Bug: T137021 Change-Id: I784fd132c36329fa0dcc49fe2804460061940347
2017-06-06 23:38:57 +00:00
"ext.relatedArticles.cards": {
"targets": [
"desktop",
"mobile"
],
"dependencies": [
"oojs",
"mediawiki.util",
"ext.relatedArticles.lib"
],
"scripts": [
"resources/ext.relatedArticles.cards/init.js",
"resources/ext.relatedArticles.cards/CardModel.js",
"resources/ext.relatedArticles.cards/CardView.js",
Remove CardsGateway (unused) Bug: T167647 Change-Id: I7e2a7777a5f28991d77deab520a55d3bd242104b
2017-06-14 20:10:01 +00:00
"resources/ext.relatedArticles.cards/CardListView.js"
Migrate Cards code to RelatedArticles * Move across all files * Rename ext-card- prefix to ext-related-articles- prefix ** Since all code using these prefixes is JS we do not have to worry about cached HTML Bug: T137021 Change-Id: I784fd132c36329fa0dcc49fe2804460061940347
2017-06-06 23:38:57 +00:00
],
"styles": [
"resources/ext.relatedArticles.cards/styles.less"
Remove muhogan templates and module Removes the muhogan module along with the templates and replacing them with jQuery DOM construction. Bug: T219846 Change-Id: I246f9c46ea2cc5721ddd57efcf58fae9fd947c58
2019-04-09 16:13:19 +00:00
]
Migrate Cards code to RelatedArticles * Move across all files * Rename ext-card- prefix to ext-related-articles- prefix ** Since all code using these prefixes is JS we do not have to worry about cached HTML Bug: T137021 Change-Id: I784fd132c36329fa0dcc49fe2804460061940347
2017-06-06 23:38:57 +00:00
},
"ext.relatedArticles.lib": {
"targets": [
"desktop",
"mobile"
],
"scripts": [
"resources/ext.relatedArticles.lib/CSS.escape/css.escape.js"
]
},
Make RelatedArticles soft-depend on Cards RelatedArticles tries to load the 'ext.cards' module and if it succeeds it continues with showing the related articles on the page. Dependency: I6661527175eb889cec4193b18fa18207f332b4fc Bug: T117108 Change-Id: I33936a3e9cd5d1f0296e48fd1c2bba77fff4e466
2015-11-16 10:40:03 +00:00
"ext.relatedArticles.readMore.gateway": {
Add Related Articles section to Minerva If the page has related articles, is in mainspace, isn't the main page, and the output is being rendered with the MinervaBeta skin then a "Related Articles" section is added to the page just before the footer. Separate loading the information necessary to render the pages, choosing the renderer, and rendering the data so that multiple skins - currently Minerva and Vector per the mocks - not just multiple resolutions can all be handled the same way: * The bootstrap script (ext.relatedArticles.readMore.bootstrap/index.js) for fetches the page image and Wikidata description; loading the renderer module; and, finally, notifying the renderer module that it should render the data, which it does by emitting "ext.relatedArticles.readMore.init" event using mw#track * The Minerva renderer subscribes to the event and, when it's fired, renders the data by passing it to the WatchstarPageList view Bug: T113635 Change-Id: I651342bdf9796938fa7051828dd13bc6fe774783
2015-10-07 13:12:42 +00:00
"scripts": [
Make RelatedArticles soft-depend on Cards RelatedArticles tries to load the 'ext.cards' module and if it succeeds it continues with showing the related articles on the page. Dependency: I6661527175eb889cec4193b18fa18207f332b4fc Bug: T117108 Change-Id: I33936a3e9cd5d1f0296e48fd1c2bba77fff4e466
2015-11-16 10:40:03 +00:00
"resources/ext.relatedArticles.readMore.gateway/RelatedPagesGateway.js"
Add Related Articles section to Minerva If the page has related articles, is in mainspace, isn't the main page, and the output is being rendered with the MinervaBeta skin then a "Related Articles" section is added to the page just before the footer. Separate loading the information necessary to render the pages, choosing the renderer, and rendering the data so that multiple skins - currently Minerva and Vector per the mocks - not just multiple resolutions can all be handled the same way: * The bootstrap script (ext.relatedArticles.readMore.bootstrap/index.js) for fetches the page image and Wikidata description; loading the renderer module; and, finally, notifying the renderer module that it should render the data, which it does by emitting "ext.relatedArticles.readMore.init" event using mw#track * The Minerva renderer subscribes to the event and, when it's fired, renders the data by passing it to the WatchstarPageList view Bug: T113635 Change-Id: I651342bdf9796938fa7051828dd13bc6fe774783
2015-10-07 13:12:42 +00:00
],
"dependencies": [
Fall back to CirrusSearch's morelike: feature When no related articles have been specified by an editor we instead hit request pages similar to the current page using the CirrusSearch extension's "morelike:" feature [0]. Changes: * Config variable introduced RelatedArticlesUseCirrusSearch which allows you to turn on use of the CirrusSearch API. * Introduce a RelatedPagesGateway for dealing with making the API call and returning consistent results * Move the "simple" API call for hydrating related pages fetched from the wgRelatedArticles configuration variable into RelatedPagesGateway * Reduce the bootstrap module to just a bootstrap module! Bug: T116707 Change-Id: Ia0ced1d7ae57c0939d1f5af275aa9d393f1420b1
2015-11-03 23:39:48 +00:00
"oojs"
Add Related Articles section to Minerva If the page has related articles, is in mainspace, isn't the main page, and the output is being rendered with the MinervaBeta skin then a "Related Articles" section is added to the page just before the footer. Separate loading the information necessary to render the pages, choosing the renderer, and rendering the data so that multiple skins - currently Minerva and Vector per the mocks - not just multiple resolutions can all be handled the same way: * The bootstrap script (ext.relatedArticles.readMore.bootstrap/index.js) for fetches the page image and Wikidata description; loading the renderer module; and, finally, notifying the renderer module that it should render the data, which it does by emitting "ext.relatedArticles.readMore.init" event using mw#track * The Minerva renderer subscribes to the event and, when it's fired, renders the data by passing it to the WatchstarPageList view Bug: T113635 Change-Id: I651342bdf9796938fa7051828dd13bc6fe774783
2015-10-07 13:12:42 +00:00
],
"targets": [
"mobile",
"desktop"
]
},
"ext.relatedArticles.readMore.bootstrap": {
ext.relatedArticles.readMore.bootstrap: Convert to 'packageFiles' This enables use of module.exports and require() within the module, and makes it easy to bundle additional data and scripts generated by the server (without needing to subclass FileModule in PHP). In particular, to bundle mw.config values with the module. Currently the extension is adding these to the <head> of all articles which delays rendering of the article content, and the time to when JS can start to be fetched. See <https://phabricator.wikimedia.org/T219342#5116773>. Bug: T219342 Change-Id: I3f174418af8bfd83b0faabe484226e323714cb5b
2019-05-25 21:13:29 +00:00
"localBasePath": "resources/ext.relatedArticles.readMore.bootstrap",
"remoteExtPath": "RelatedArticles/resources/ext.relatedArticles.readMore.bootstrap",
"packageFiles": [
Remove 'wgRelatedArticles*CirrusSearch' from page view HTML Bundle these with the module that needs it instead, this means 1. It is naturally only downloaded on pages where it is needed. 2. It doesn't block download/parse/render of the article HTML. 3. It doesn't delay time to mw.loader.load() for interactive functionality. Bug: T219342 Change-Id: I5c6809392b0621bd0d58049597f6c0306e572607
2019-05-25 21:18:58 +00:00
"index.js",
Update extension.json to manifest version 2 Bug: T241892 Change-Id: I9c7156df3220389e7fbf94375e9fdb753458f16e
2020-01-04 18:33:29 +00:00
{
"name": "data.json",
"config": {
"useCirrusSearch": "RelatedArticlesUseCirrusSearch",
"onlyUseCirrusSearch": "RelatedArticlesOnlyUseCirrusSearch",
"descriptionSource": "RelatedArticlesDescriptionSource"
}
}
Add Related Articles section to Minerva If the page has related articles, is in mainspace, isn't the main page, and the output is being rendered with the MinervaBeta skin then a "Related Articles" section is added to the page just before the footer. Separate loading the information necessary to render the pages, choosing the renderer, and rendering the data so that multiple skins - currently Minerva and Vector per the mocks - not just multiple resolutions can all be handled the same way: * The bootstrap script (ext.relatedArticles.readMore.bootstrap/index.js) for fetches the page image and Wikidata description; loading the renderer module; and, finally, notifying the renderer module that it should render the data, which it does by emitting "ext.relatedArticles.readMore.init" event using mw#track * The Minerva renderer subscribes to the event and, when it's fired, renders the data by passing it to the WatchstarPageList view Bug: T113635 Change-Id: I651342bdf9796938fa7051828dd13bc6fe774783
2015-10-07 13:12:42 +00:00
],
"dependencies": [
Use mw.experiment to enable related pages only to subset of users Changes: - introduced new config variable: RelatedArticlesEnabledSamplingRate - do not trigger RelatedArticles clientside scripts if feature is disabled - do not log events when navigator.sendBeacon is not available Bug: T156039 Change-Id: I7e9773131c5b9aea9e9fb554d4508842cdedede7
2017-01-27 21:10:46 +00:00
"mediawiki.experiments",
"mediawiki.user",
Fall back to CirrusSearch's morelike: feature When no related articles have been specified by an editor we instead hit request pages similar to the current page using the CirrusSearch extension's "morelike:" feature [0]. Changes: * Config variable introduced RelatedArticlesUseCirrusSearch which allows you to turn on use of the CirrusSearch API. * Introduce a RelatedPagesGateway for dealing with making the API call and returning consistent results * Move the "simple" API call for hydrating related pages fetched from the wgRelatedArticles configuration variable into RelatedPagesGateway * Reduce the bootstrap module to just a bootstrap module! Bug: T116707 Change-Id: Ia0ced1d7ae57c0939d1f5af275aa9d393f1420b1
2015-11-03 23:39:48 +00:00
"mediawiki.api",
Do not load related articles on diff comparision pages Bug: T122076 Change-Id: I1dc00b3bd76053d353dc31137c4c15a10286184e
2015-12-29 02:55:43 +00:00
"mediawiki.Uri",
Use mw.viewport to check when to load related pages Does not change distance threshold. Bug: T135607 Change-Id: I82dfa78e93f4bb7a8a28d038470265e7fd30c423
2016-08-30 18:01:48 +00:00
"mediawiki.viewport",
RelatedArticles load after half window scroll Only triggers RelatedArticles module load and query after user has scrolled through half the document height. Bug: T116838 Change-Id: If290988fb7cc187cad37dd4a8a2c4f38abed9bb9
2015-12-05 17:44:15 +00:00
"ext.relatedArticles.readMore.gateway",
Use mw.util.debounce jquery.throttle-debounce is deprecated. Bug: T213426 Change-Id: Ieffe20f44003e7dbb992e88c7927a14629da2db4
2019-10-24 18:49:04 +00:00
"mediawiki.util"
Add Related Articles section to Minerva If the page has related articles, is in mainspace, isn't the main page, and the output is being rendered with the MinervaBeta skin then a "Related Articles" section is added to the page just before the footer. Separate loading the information necessary to render the pages, choosing the renderer, and rendering the data so that multiple skins - currently Minerva and Vector per the mocks - not just multiple resolutions can all be handled the same way: * The bootstrap script (ext.relatedArticles.readMore.bootstrap/index.js) for fetches the page image and Wikidata description; loading the renderer module; and, finally, notifying the renderer module that it should render the data, which it does by emitting "ext.relatedArticles.readMore.init" event using mw#track * The Minerva renderer subscribes to the event and, when it's fired, renders the data by passing it to the WatchstarPageList view Bug: T113635 Change-Id: I651342bdf9796938fa7051828dd13bc6fe774783
2015-10-07 13:12:42 +00:00
],
"targets": [
"mobile",
"desktop"
]
Hygiene: lazy-load event logging code This allows us to decouple the event logging code from the `ext.relatedArticles.readMore' module. As a result we'll be able to log events without loading the above mentioned module. Bug: T157375 Change-Id: I55cf4f40cafc88d6baeb5cc1b41fc2d6bcd2fbb9
2017-02-23 22:02:50 +00:00
},
"ext.relatedArticles.readMore": {
"dependencies": [
Remove EventLogging/A-B test code from RelatedArticles With RelatedArticlesEnabledBucketSize now removed, installation of this extension will turn it on for 100% users without any mechanism to turn it off. Additional changes: * Bump version * Add Readers team to contributors Bug: T202306 Change-Id: I7dc270a06dd3afd4e894c8298165d6d6d4fda8d6
2018-09-13 18:40:42 +00:00
"mediawiki.util"
Hygiene: lazy-load event logging code This allows us to decouple the event logging code from the `ext.relatedArticles.readMore' module. As a result we'll be able to log events without loading the above mentioned module. Bug: T157375 Change-Id: I55cf4f40cafc88d6baeb5cc1b41fc2d6bcd2fbb9
2017-02-23 22:02:50 +00:00
],
"scripts": [
"resources/ext.relatedArticles.readMore/index.js"
],
"styles": [
"resources/ext.relatedArticles.readMore/readMore.less"
],
"skinStyles": {
"default": "resources/ext.relatedArticles.readMore/readMore.default.less",
Don't try to register "" as a style path, that breaks ResourceLoader Bug: T248090 Change-Id: Ic1475003f9f00c3593736be1421c93b8b7f5c30f
2020-03-19 15:05:47 +00:00
"minerva": "resources/ext.relatedArticles.readMore/readMore.minerva.less"
Hygiene: lazy-load event logging code This allows us to decouple the event logging code from the `ext.relatedArticles.readMore' module. As a result we'll be able to log events without loading the above mentioned module. Bug: T157375 Change-Id: I55cf4f40cafc88d6baeb5cc1b41fc2d6bcd2fbb9
2017-02-23 22:02:50 +00:00
},
"messages": [
"relatedarticles-read-more-heading"
],
"targets": [
"desktop",
"mobile"
]
Add Related Articles section to Minerva If the page has related articles, is in mainspace, isn't the main page, and the output is being rendered with the MinervaBeta skin then a "Related Articles" section is added to the page just before the footer. Separate loading the information necessary to render the pages, choosing the renderer, and rendering the data so that multiple skins - currently Minerva and Vector per the mocks - not just multiple resolutions can all be handled the same way: * The bootstrap script (ext.relatedArticles.readMore.bootstrap/index.js) for fetches the page image and Wikidata description; loading the renderer module; and, finally, notifying the renderer module that it should render the data, which it does by emitting "ext.relatedArticles.readMore.init" event using mw#track * The Minerva renderer subscribes to the event and, when it's fired, renders the data by passing it to the WatchstarPageList view Bug: T113635 Change-Id: I651342bdf9796938fa7051828dd13bc6fe774783
2015-10-07 13:12:42 +00:00
}
},
Use QUnitTestModule instead of deprecated ResourceLoaderTestModules Bug: T232875 Change-Id: I5612a9be65f4d4adf4912645856540dbb04d2b34
2020-05-11 19:46:12 +00:00
"QUnitTestModule": {
"localBasePath": "tests/qunit",
"remoteExtPath": "RelatedArticles/tests/qunit",
"scripts": [
"ext.relatedArticles.cards/CardModel.test.js",
"ext.relatedArticles.cards/CardView.test.js",
"ext.relatedArticles.readMore.gateway/RelatedPagesGateway.test.js"
],
"dependencies": [
"ext.relatedArticles.cards",
"ext.relatedArticles.readMore.gateway"
]
},
Fall back to CirrusSearch's morelike: feature When no related articles have been specified by an editor we instead hit request pages similar to the current page using the CirrusSearch extension's "morelike:" feature [0]. Changes: * Config variable introduced RelatedArticlesUseCirrusSearch which allows you to turn on use of the CirrusSearch API. * Introduce a RelatedPagesGateway for dealing with making the API call and returning consistent results * Move the "simple" API call for hydrating related pages fetched from the wgRelatedArticles configuration variable into RelatedPagesGateway * Reduce the bootstrap module to just a bootstrap module! Bug: T116707 Change-Id: Ia0ced1d7ae57c0939d1f5af275aa9d393f1420b1
2015-11-03 23:39:48 +00:00
"config": {
Update extension.json to manifest version 2 Bug: T241892 Change-Id: I9c7156df3220389e7fbf94375e9fdb753458f16e
2020-01-04 18:33:29 +00:00
"RelatedArticlesCardLimit": {
"description": "Maximum number of articles that should be shown in RelatedArticles widget. This limit is derived from limits in TextExtracts and PageImages extensions. Number should be between 1 and 20.",
"value": 3
},
"RelatedArticlesUseCirrusSearch": {
"value": false
},
"RelatedArticlesOnlyUseCirrusSearch": {
"value": false
},
"RelatedArticlesDescriptionSource": {
"description": "Source to get the page description from (string, or false to not fetch the description). Possible values: wikidata, textextracts, pagedescription.",
"value": false
},
"RelatedArticlesFooterWhitelistedSkins": {
"description": "List of skin names (e.g. 'minerva') where related articles will be shown in the footer.",
"value": []
}
Fall back to CirrusSearch's morelike: feature When no related articles have been specified by an editor we instead hit request pages similar to the current page using the CirrusSearch extension's "morelike:" feature [0]. Changes: * Config variable introduced RelatedArticlesUseCirrusSearch which allows you to turn on use of the CirrusSearch API. * Introduce a RelatedPagesGateway for dealing with making the API call and returning consistent results * Move the "simple" API call for hydrating related pages fetched from the wgRelatedArticles configuration variable into RelatedPagesGateway * Reduce the bootstrap module to just a bootstrap module! Bug: T116707 Change-Id: Ia0ced1d7ae57c0939d1f5af275aa9d393f1420b1
2015-11-03 23:39:48 +00:00
},
"ConfigRegistry": {
Add event logging to read more * Schema is located at https://meta.wikimedia.org/wiki/Schema:RelatedArticles. * Track 'ready', 'seen', and 'clicked' events. * The sampling rate can be set using the RelatedArticlesLoggingSamplingRate variable. If the variable is not set, sampling will be disabled. The default sampling rate is 0.01. * Events are tracked using a unique user session token. Dependency: Iea00d534371353c3ae5c06c74a08aa10cb60047b Bug: T114303 Change-Id: I649d0817cbd10ad734989da548d20ad33e7f7360
2015-10-29 17:58:30 +00:00
"RelatedArticles": "GlobalVarConfig::newInstance"
Fall back to CirrusSearch's morelike: feature When no related articles have been specified by an editor we instead hit request pages similar to the current page using the CirrusSearch extension's "morelike:" feature [0]. Changes: * Config variable introduced RelatedArticlesUseCirrusSearch which allows you to turn on use of the CirrusSearch API. * Introduce a RelatedPagesGateway for dealing with making the API call and returning consistent results * Move the "simple" API call for hydrating related pages fetched from the wgRelatedArticles configuration variable into RelatedPagesGateway * Reduce the bootstrap module to just a bootstrap module! Bug: T116707 Change-Id: Ia0ced1d7ae57c0939d1f5af275aa9d393f1420b1
2015-11-03 23:39:48 +00:00
},
Add Related Articles section to Minerva If the page has related articles, is in mainspace, isn't the main page, and the output is being rendered with the MinervaBeta skin then a "Related Articles" section is added to the page just before the footer. Separate loading the information necessary to render the pages, choosing the renderer, and rendering the data so that multiple skins - currently Minerva and Vector per the mocks - not just multiple resolutions can all be handled the same way: * The bootstrap script (ext.relatedArticles.readMore.bootstrap/index.js) for fetches the page image and Wikidata description; loading the renderer module; and, finally, notifying the renderer module that it should render the data, which it does by emitting "ext.relatedArticles.readMore.init" event using mw#track * The Minerva renderer subscribes to the event and, when it's fired, renders the data by passing it to the WatchstarPageList view Bug: T113635 Change-Id: I651342bdf9796938fa7051828dd13bc6fe774783
2015-10-07 13:12:42 +00:00
"ResourceFileModulePaths": {
"localBasePath": "",
"remoteExtPath": "RelatedArticles"
}
Use extension registration Add extension.json and populate it with information from both RelatedArticles.php and the RelatedArticles extension wiki page [0]. Migrate the hook handlers to static functions operating on static data rather than having a single, global instance of RelatedArticles so that the hook handler definitions can be added to extension.json easily. N.B. During testing the handlers for both the SkinBuildSidebar and SkinTemplateToolboxEnd appeared to have the same effect so the TODO was removed but not the handler for the former. Additional changes include: * RelatedArticles.class.php -> includes/RelatedArticles.php * RelatedArticles -> RelatedArticles\Hooks * Documenting all of the methods of RelatedArticles\Hooks [0] https://www.mediawiki.org/wiki/Extension:RelatedArticles Bug: T87965 Change-Id: I9944b9186746386ee18ca28657bb547c00ae2b8c
2015-10-02 19:46:48 +00:00
}
Reference in a new issue Copy permalink