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

110 lines
2.9 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",
Release 2.1.0 Bug: T121052 Change-Id: I46c7f99b1a54eabf4f8304727f6ea7684f038e14
2015-12-14 17:37:29 +00:00
"version": "2.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": [
"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",
"license-name": "GPL-2.0",
Mark extension as Beta Feature Change-Id: I33d2c1cd7c868e98874328216b16627a7c47dbc4
2016-01-15 13:20:46 +00:00
"type": "betafeatures",
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
"AutoloadClasses": {
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
"RelatedArticles\\Hooks": "includes/Hooks.php",
[Hygiene] Reorganise hooks to reflect placements There are two positions where the list of related articles is rendered: the sidebar, and the the footer. Move the hook handlers related to rendering the former to RelatedArticles\SidebarHooks and those related to rendering the latter to RelatedArticles\FooterHooks. Change-Id: Idde57905d828e63309bfdc360a3a09e64e291304
2015-12-02 11:10:04 +00:00
"RelatedArticles\\SidebarHooks": "includes/SidebarHooks.php",
"RelatedArticles\\FooterHooks": "includes/FooterHooks.php"
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": {
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
"ResourceLoaderTestModules": [
[Hygiene] Reorganise hooks to reflect placements There are two positions where the list of related articles is rendered: the sidebar, and the the footer. Move the hook handlers related to rendering the former to RelatedArticles\SidebarHooks and those related to rendering the latter to RelatedArticles\FooterHooks. Change-Id: Idde57905d828e63309bfdc360a3a09e64e291304
2015-12-02 11:10:04 +00:00
"RelatedArticles\\Hooks::onResourceLoaderTestModules"
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
],
[Hygiene] Reorganise hooks to reflect placements There are two positions where the list of related articles is rendered: the sidebar, and the the footer. Move the hook handlers related to rendering the former to RelatedArticles\SidebarHooks and those related to rendering the latter to RelatedArticles\FooterHooks. Change-Id: Idde57905d828e63309bfdc360a3a09e64e291304
2015-12-02 11:10:04 +00:00
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
"ParserFirstCallInit": [
"RelatedArticles\\Hooks::onParserFirstCallInit"
],
Remove CustomData dependency Since CustomData was written ParserOutput now supports the setting and getting of properties. This patch switches RelatedArticles to use that. I'm not sure if any other extensions depend on CustomData but it seems to have served its purpose. Bug: T114915 Change-Id: I30bd17fd8c43422fe7ab6f58a74565674e15ba1d
2015-10-08 00:21:13 +00:00
"OutputPageParserOutput": [
"RelatedArticles\\Hooks::onOutputPageParserOutput"
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
],
[Hygiene] Reorganise hooks to reflect placements There are two positions where the list of related articles is rendered: the sidebar, and the the footer. Move the hook handlers related to rendering the former to RelatedArticles\SidebarHooks and those related to rendering the latter to RelatedArticles\FooterHooks. Change-Id: Idde57905d828e63309bfdc360a3a09e64e291304
2015-12-02 11:10:04 +00:00
Use SidebarBeforeOutput hook instead of echo'ing HTML Ewwwww. This also fixes display in MonoBook. Change-Id: I5c50722285a0dcf8af09674e3dd80e37128b279a
2016-07-30 03:34:40 +00:00
"SidebarBeforeOutput": [
"RelatedArticles\\SidebarHooks::onSidebarBeforeOutput"
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
],
[Hygiene] Reorganise hooks to reflect placements There are two positions where the list of related articles is rendered: the sidebar, and the the footer. Move the hook handlers related to rendering the former to RelatedArticles\SidebarHooks and those related to rendering the latter to RelatedArticles\FooterHooks. Change-Id: Idde57905d828e63309bfdc360a3a09e64e291304
2015-12-02 11:10:04 +00:00
Make RelatedArticles available as a beta feature Hide the related articles from the sidebar if ReadMore is enabled. Otherwise leave as is because it's used in WikiVoyage. Bug: T117444 Change-Id: I3879ae1e53de301b0d3f5f2c066f8e8de7c1c223
2015-11-19 03:49:46 +00:00
"GetBetaFeaturePreferences": [
[Hygiene] Reorganise hooks to reflect placements There are two positions where the list of related articles is rendered: the sidebar, and the the footer. Move the hook handlers related to rendering the former to RelatedArticles\SidebarHooks and those related to rendering the latter to RelatedArticles\FooterHooks. Change-Id: Idde57905d828e63309bfdc360a3a09e64e291304
2015-12-02 11:10:04 +00:00
"RelatedArticles\\FooterHooks::onGetBetaFeaturePreferences"
Make RelatedArticles available as a beta feature Hide the related articles from the sidebar if ReadMore is enabled. Otherwise leave as is because it's used in WikiVoyage. Bug: T117444 Change-Id: I3879ae1e53de301b0d3f5f2c066f8e8de7c1c223
2015-11-19 03:49:46 +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
"MakeGlobalVariablesScript": [
[Hygiene] Reorganise hooks to reflect placements There are two positions where the list of related articles is rendered: the sidebar, and the the footer. Move the hook handlers related to rendering the former to RelatedArticles\SidebarHooks and those related to rendering the latter to RelatedArticles\FooterHooks. Change-Id: Idde57905d828e63309bfdc360a3a09e64e291304
2015-12-02 11:10:04 +00:00
"RelatedArticles\\FooterHooks::onMakeGlobalVariablesScript"
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
],
"BeforePageDisplay": [
[Hygiene] Reorganise hooks to reflect placements There are two positions where the list of related articles is rendered: the sidebar, and the the footer. Move the hook handlers related to rendering the former to RelatedArticles\SidebarHooks and those related to rendering the latter to RelatedArticles\FooterHooks. Change-Id: Idde57905d828e63309bfdc360a3a09e64e291304
2015-12-02 11:10:04 +00:00
"RelatedArticles\\FooterHooks::onBeforePageDisplay"
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
],
"EventLoggingRegisterSchemas": [
[Hygiene] Reorganise hooks to reflect placements There are two positions where the list of related articles is rendered: the sidebar, and the the footer. Move the hook handlers related to rendering the former to RelatedArticles\SidebarHooks and those related to rendering the latter to RelatedArticles\FooterHooks. Change-Id: Idde57905d828e63309bfdc360a3a09e64e291304
2015-12-02 11:10:04 +00:00
"RelatedArticles\\FooterHooks::onEventLoggingRegisterSchemas"
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
],
"ResourceLoaderGetConfigVars": [
[Hygiene] Reorganise hooks to reflect placements There are two positions where the list of related articles is rendered: the sidebar, and the the footer. Move the hook handlers related to rendering the former to RelatedArticles\SidebarHooks and those related to rendering the latter to RelatedArticles\FooterHooks. Change-Id: Idde57905d828e63309bfdc360a3a09e64e291304
2015-12-02 11:10:04 +00:00
"RelatedArticles\\FooterHooks::onResourceLoaderGetConfigVars"
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
],
"ResourceLoaderRegisterModules": [
[Hygiene] Reorganise hooks to reflect placements There are two positions where the list of related articles is rendered: the sidebar, and the the footer. Move the hook handlers related to rendering the former to RelatedArticles\SidebarHooks and those related to rendering the latter to RelatedArticles\FooterHooks. Change-Id: Idde57905d828e63309bfdc360a3a09e64e291304
2015-12-02 11:10:04 +00:00
"RelatedArticles\\FooterHooks::onResourceLoaderRegisterModules"
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"
]
},
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
"manifest_version": 1,
"ResourceModules": {
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": {
"scripts": [
"resources/ext.relatedArticles.readMore.bootstrap/index.js"
],
"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
"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",
"jquery.throttle-debounce"
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"
]
}
},
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": {
Configure footer and sidebar placements Changes: * Rename $wgRelatedArticlesShowReadMore to $wgRelatedArticlesShowInFooter * Add $wgRelatedArticlesShowInSidebar, which is truthy by default, and short circuit the SkinBuildSidebar and SkinTemplateToolboxEnd hook handlers if it is falsy Bug: T119926 Change-Id: Idf04bf3221ba44d7b898160764fbd6ba83561abb
2015-12-02 11:17:00 +00:00
"RelatedArticlesShowInSidebar": true,
"RelatedArticlesShowInFooter": false,
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
"RelatedArticlesUseCirrusSearch": false,
Optionally disable Read More using extension data By default, the Read More feature tries to use editor-curated articles before using the CirrusSearch morelike: feature. Add a configuration variable that disables the former behaviour but leave the default in place. Changes: * Add the wgReadMoreOnlyUseCirrusSearch configuration variable, which defaults to false, and pass it in to mw.relatedArticles.RelatedPagesGateway at construction time * Add the onlyUseCirrusSearch parameter to mw.relatedArticles.RelatedPagesGateway, which controls whether to ignore the editorCuratedArticles parameter Bug: T117443 Change-Id: I0dfa67f4a68e8dc17302fef7ebf8d23c0c1d892c
2015-11-11 15:30:19 +00:00
"RelatedArticlesOnlyUseCirrusSearch": false,
Allow blacklisting skins for showing ReadMore in footer Introduce a new config variable `RelatedArticlesFooterBlacklistedSkins` to control skins that are allowed to show ReadMore in the footer. As before Minerva beta mode is always allowed to show. Depends-on: I366c8656a0f14a7069053b2e6199caac20471ea4 Depends-on: Ie4ac3c11e81eeea9f5b4a7161a64477cb5d60f07 Bug: T144047 Change-Id: I1663ab25083d9d907f288e60d506831bebb67945
2016-09-16 14:36:05 +00:00
"RelatedArticlesLoggingSamplingRate": 0.01,
"@RelatedArticlesFooterBlacklistedSkins": "List of skin names (e.g. 'minerva') where related articles won't be shown in the footer. If absent related articles will show in stable on Minerva or beta on all other skins.",
"RelatedArticlesFooterBlacklistedSkins": []
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