wikimedia/mediawiki-extensions-Description2
1
0
Fork 1
mirror of https://gerrit.wikimedia.org/r/mediawiki/extensions/Description2 synced 2024-11-23 22:33:34 +00:00
Code Issues Packages Projects Releases Wiki Activity
mediawiki-extensions-Descri.../extension.json

72 lines
1.5 KiB
JSON
Raw Permalink Normal View History

Version 0.4.0 -- cleanup, extension registration support, etc. * Old i18n shim removed * extension.json added * PHP code moved into the new Description2 class * Old PHP entry point still exists for b/c with older installations, but MW 1.25 or newer is now required Change-Id: I0670c203b62dcf500ded1b82957e473edf864fb1
2017-06-08 12:32:58 +00:00
{
"name": "Description2",
Add composer for CI, and fix CS errors Also move class to its own namespace. Bug: T183532 Change-Id: I5a89efd3f162d73e247543c86967562a949a3bf4
2017-11-02 09:14:52 +00:00
"version": "0.4.1",
Version 0.4.0 -- cleanup, extension registration support, etc. * Old i18n shim removed * extension.json added * PHP code moved into the new Description2 class * Old PHP entry point still exists for b/c with older installations, but MW 1.25 or newer is now required Change-Id: I0670c203b62dcf500ded1b82957e473edf864fb1
2017-06-08 12:32:58 +00:00
"author": [
"[http://danf.ca/mw/ Daniel Friesen]"
],
"url": "https://www.mediawiki.org/wiki/Extension:Description2",
"descriptionmsg": "description2-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: Iccd10bb2facec3698afb9d67cd533762a2e53275
2018-01-04 10:58:03 +00:00
"license-name": "GPL-2.0-or-later",
Version 0.4.0 -- cleanup, extension registration support, etc. * Old i18n shim removed * extension.json added * PHP code moved into the new Description2 class * Old PHP entry point still exists for b/c with older installations, but MW 1.25 or newer is now required Change-Id: I0670c203b62dcf500ded1b82957e473edf864fb1
2017-06-08 12:32:58 +00:00
"type": "other",
Set MediaWiki 1.31 as minimum requirement in extension.json Added an old, but not to-outdated required version to keep a minimum requirement Change-Id: I7ffdf9c3246614521853c70fef6a2f0c105d7d3c
2021-12-10 12:18:23 +00:00
"requires": {
Implement a RemexHtml-based provider (requires 1.38) This patch has been in testing on ark.wiki.gg (with the platform's approval) for a few months now, and has yielded us significantly better extracts than the live algorithm. It brings Description2 closer to TextExtracts' level, but without its constraints. TextExtracts does not enable us to override descriptions as we see fit, requires internal API calls, and uses HtmlFormatter which has its own slew of problems. I'm also raising MW requirement to 1.38: this change has not been tested with older versions, and I removed uses of old `getProperty` in favour of `getPageProperty` to clean up the code. I doubt this really matters much: support for 1.35 is about to end (if it hasn't already), and 1.38 itself is already EoL. It also appears that lately this extension only received forward-compatibility patches. New provider leverages RemexHtml (used in core MediaWiki and Parsoid) to parse and process a page's HTML. For performance reasons (but also bit of practicality - it's unlikely that description derival needs full page text...) any HTML after the first <h1-6> heading is dropped and not parsed. However, this is just a precaution, on ARK we haven't noticed any performance degradation. Two new configuration variables are added: - `$wgUseSimpleDescriptionAlgorithm` (proposed default: false) determines which extract provider is used. `true` is the previous algorithm. `false` is the new Remex implementation. - `$wgDescriptionRemoveElements` is an array of tag names and/or class names to strip out when generating extracts. This is only supported in the Remex provider, and would be hard to retrofit into the previous algorithm. Depends-On: I04b00f99085f07f773212ee3eca8470eece34e9e Change-Id: I8e6bf1f17443feac89f07e728d395e5a525bd4d1
2024-01-02 17:33:05 +00:00
"MediaWiki": ">= 1.38.0"
Set MediaWiki 1.31 as minimum requirement in extension.json Added an old, but not to-outdated required version to keep a minimum requirement Change-Id: I7ffdf9c3246614521853c70fef6a2f0c105d7d3c
2021-12-10 12:18:23 +00:00
},
Version 0.4.0 -- cleanup, extension registration support, etc. * Old i18n shim removed * extension.json added * PHP code moved into the new Description2 class * Old PHP entry point still exists for b/c with older installations, but MW 1.25 or newer is now required Change-Id: I0670c203b62dcf500ded1b82957e473edf864fb1
2017-06-08 12:32:58 +00:00
"config": {
Truncate descriptions to a certain length With this change, generated descriptions are cut at 300 characters, without breaking words when possible, and with an ellipsis added in case the cut happened mid-sentence. The `Description2::getFirstChars` function was borrowed from TextExtracts with minor alterations (added comment for their regex, and removed `>` from word healing given it's unclear why it's been included). New configuration variable `$wgDescriptionMaxChars` (proposed default: 300, which seems like a sensible amount) controls this behaviour. This has been in testing on ark.wiki.gg (with the platform's approval, which I'm glad for) since early September. Without this change, we had a few pages with little sections having a huge part of their body text thrown into the `description` meta tag... Depends-On: I585f2c0046571310aad67f3ba148c4f22aaae49f Change-Id: I04b00f99085f07f773212ee3eca8470eece34e9e
2023-12-04 20:02:52 +00:00
"EnableMetaDescriptionFunctions": false,
Implement a RemexHtml-based provider (requires 1.38) This patch has been in testing on ark.wiki.gg (with the platform's approval) for a few months now, and has yielded us significantly better extracts than the live algorithm. It brings Description2 closer to TextExtracts' level, but without its constraints. TextExtracts does not enable us to override descriptions as we see fit, requires internal API calls, and uses HtmlFormatter which has its own slew of problems. I'm also raising MW requirement to 1.38: this change has not been tested with older versions, and I removed uses of old `getProperty` in favour of `getPageProperty` to clean up the code. I doubt this really matters much: support for 1.35 is about to end (if it hasn't already), and 1.38 itself is already EoL. It also appears that lately this extension only received forward-compatibility patches. New provider leverages RemexHtml (used in core MediaWiki and Parsoid) to parse and process a page's HTML. For performance reasons (but also bit of practicality - it's unlikely that description derival needs full page text...) any HTML after the first <h1-6> heading is dropped and not parsed. However, this is just a precaution, on ARK we haven't noticed any performance degradation. Two new configuration variables are added: - `$wgUseSimpleDescriptionAlgorithm` (proposed default: false) determines which extract provider is used. `true` is the previous algorithm. `false` is the new Remex implementation. - `$wgDescriptionRemoveElements` is an array of tag names and/or class names to strip out when generating extracts. This is only supported in the Remex provider, and would be hard to retrofit into the previous algorithm. Depends-On: I04b00f99085f07f773212ee3eca8470eece34e9e Change-Id: I8e6bf1f17443feac89f07e728d395e5a525bd4d1
2024-01-02 17:33:05 +00:00
"DescriptionMaxChars": 300,
"DescriptionAlgorithm": "MediaWiki\\Extension\\Description2\\RemexDescriptionProvider",
"DescriptionRemoveElements": [
"table",
"div",
"script",
"style",
"figure",
"input",
"div.infobox",
"div.ambox",
"div.dmbox",
"ul.gallery",
".mw-editsection",
"sup.reference",
"ul.references",
".error",
".nomobile",
".noprint",
".noexcerpt",
".sortkey"
]
Version 0.4.0 -- cleanup, extension registration support, etc. * Old i18n shim removed * extension.json added * PHP code moved into the new Description2 class * Old PHP entry point still exists for b/c with older installations, but MW 1.25 or newer is now required Change-Id: I0670c203b62dcf500ded1b82957e473edf864fb1
2017-06-08 12:32:58 +00:00
},
Add composer for CI, and fix CS errors Also move class to its own namespace. Bug: T183532 Change-Id: I5a89efd3f162d73e247543c86967562a949a3bf4
2017-11-02 09:14:52 +00:00
"ConfigRegistry": {
"Description2": "GlobalVarConfig::newInstance"
},
Extract description algorithm into a new class Separating the extract algorithm from integration code. This results in a slightly cleaner code structure (at least in my opinion) and enables adding alternate algorithms without devolving into spaghetti. The DescriptionProvider (name of the new base interface) is exposed as a service through dependency injection to avoid factories. The implementation can be swapped at service instantiation time. Depends-On: I73c61ce045dcf31ac1ca5888f1548de8fd8b56ff Change-Id: I97fd065c9554837747021ba9fff26005e33270f4
2023-12-04 19:54:13 +00:00
"ServiceWiringFiles": [
"includes/ServiceWiring.php"
],
Use namespace autoloading instead of manually tracking classes This extension's classes have already been namespaced. Perhaps wrongly, but I don't see any showstoppers against using PSR-4 autoloading here. Change-Id: I484feeb51beab0c2e06c9f958a1c15c40853b967
2023-12-04 19:44:37 +00:00
"AutoloadNamespaces": {
"MediaWiki\\Extension\\Description2\\": "includes/"
Version 0.4.0 -- cleanup, extension registration support, etc. * Old i18n shim removed * extension.json added * PHP code moved into the new Description2 class * Old PHP entry point still exists for b/c with older installations, but MW 1.25 or newer is now required Change-Id: I0670c203b62dcf500ded1b82957e473edf864fb1
2017-06-08 12:32:58 +00:00
},
"ExtensionMessagesFiles": {
"Description2Magic": "Description2.i18n.magic.php"
},
"MessagesDirs": {
"Description2": [
"i18n"
]
},
Switch to hook handlers and inject ConfigFactory Moving hooks into a separate class, and using dependency injection for configuration. Due to hook interfaces being added in MW 1.35, this change also raises the MediaWiki requirement to >1.35.0. This patch is a part of my RemexHtml deriver chain (split into multiple patches to avoid a single commit altering almost the entirety of the codebase), which raises the floor to 1.38 later. There's not really a point in merging this if the rest of the patch chain is declined. Depends-On: I484feeb51beab0c2e06c9f958a1c15c40853b967 Change-Id: I73c61ce045dcf31ac1ca5888f1548de8fd8b56ff
2023-12-04 19:46:20 +00:00
"HookHandlers": {
"Description2": {
"class": "MediaWiki\\Extension\\Description2\\Hooks",
"services": [
Extract description algorithm into a new class Separating the extract algorithm from integration code. This results in a slightly cleaner code structure (at least in my opinion) and enables adding alternate algorithms without devolving into spaghetti. The DescriptionProvider (name of the new base interface) is exposed as a service through dependency injection to avoid factories. The implementation can be swapped at service instantiation time. Depends-On: I73c61ce045dcf31ac1ca5888f1548de8fd8b56ff Change-Id: I97fd065c9554837747021ba9fff26005e33270f4
2023-12-04 19:54:13 +00:00
"ConfigFactory",
"Description2.DescriptionProvider"
Switch to hook handlers and inject ConfigFactory Moving hooks into a separate class, and using dependency injection for configuration. Due to hook interfaces being added in MW 1.35, this change also raises the MediaWiki requirement to >1.35.0. This patch is a part of my RemexHtml deriver chain (split into multiple patches to avoid a single commit altering almost the entirety of the codebase), which raises the floor to 1.38 later. There's not really a point in merging this if the rest of the patch chain is declined. Depends-On: I484feeb51beab0c2e06c9f958a1c15c40853b967 Change-Id: I73c61ce045dcf31ac1ca5888f1548de8fd8b56ff
2023-12-04 19:46:20 +00:00
]
}
},
Version 0.4.0 -- cleanup, extension registration support, etc. * Old i18n shim removed * extension.json added * PHP code moved into the new Description2 class * Old PHP entry point still exists for b/c with older installations, but MW 1.25 or newer is now required Change-Id: I0670c203b62dcf500ded1b82957e473edf864fb1
2017-06-08 12:32:58 +00:00
"Hooks": {
Switch to hook handlers and inject ConfigFactory Moving hooks into a separate class, and using dependency injection for configuration. Due to hook interfaces being added in MW 1.35, this change also raises the MediaWiki requirement to >1.35.0. This patch is a part of my RemexHtml deriver chain (split into multiple patches to avoid a single commit altering almost the entirety of the codebase), which raises the floor to 1.38 later. There's not really a point in merging this if the rest of the patch chain is declined. Depends-On: I484feeb51beab0c2e06c9f958a1c15c40853b967 Change-Id: I73c61ce045dcf31ac1ca5888f1548de8fd8b56ff
2023-12-04 19:46:20 +00:00
"OutputPageParserOutput": "Description2",
"ParserAfterTidy": "Description2",
"ParserFirstCallInit": "Description2"
Version 0.4.0 -- cleanup, extension registration support, etc. * Old i18n shim removed * extension.json added * PHP code moved into the new Description2 class * Old PHP entry point still exists for b/c with older installations, but MW 1.25 or newer is now required Change-Id: I0670c203b62dcf500ded1b82957e473edf864fb1
2017-06-08 12:32:58 +00:00
},
"manifest_version": 1
}
Reference in a new issue Copy permalink