ParserOutput::setSections() currently takes a untyped array as argument. It should instead take something like an array<SectionMetadata> to provide stronger typing on the value and structure (where SectionMetadata is a value object).
Probably add something like ::setSectionMetadata(...new type...) and then have ::getSections() return $this->sectionMetadata->getLegacyArray() and also use the legacy array in the serialization for back compat.
| Status | Subtype | Assigned | Task | ||
|---|---|---|---|---|---|
| Open | None | T272987 Parsoid read views for DiscussionTools | |||
| Open | None | T297840 Populate ParserCache with Parsoid output as a post-edit hook | |||
| Open | None | T310511 Metadata comparison testing between Parsoid and the legacy parser | |||
| Open | None | T310512 Parsoid and the legacy parser should emit exactly the same ParserOutput metadata | |||
| Open | None | T305159 Improve coverage of the ContentMetadataCollector interface | |||
| Resolved | None | T296025 ParserOutput::setSections() should be more structured | |||
| Open | None | T324035 Add "title" as a property of TOCData |
From @Jdlrobson:
Probably best documentation we have is on wiki right now https://www.mediawiki.org/wiki/Manual:SkinMustache.php
but I’d love to have something better (that’s validating in CI) for documenting this as it’s effectively a stable API.
the legacy array in the serialization for back compat.
sounds great.
Note, if you want to drop/change the serialization in future, we'll need to coordinate regarding the template datsa specification we send to skins using Mustache. We have a plan for this, but haven't had a need to do it just yet!
Change 828104 had a related patch set uploaded (by Subramanya Sastry; author: Subramanya Sastry):
[mediawiki/services/parsoid@master] WIP: Declare a first-class object for section metadata
Change 829083 had a related patch set uploaded (by Subramanya Sastry; author: Subramanya Sastry):
[mediawiki/core@master] Generate/set/get SectionMetaData objects instead of arrays
Change 828104 merged by jenkins-bot:
[mediawiki/services/parsoid@master] Declare a first-class object for section metadata
Change 837692 had a related patch set uploaded (by Subramanya Sastry; author: Subramanya Sastry):
[mediawiki/vendor@master] Bump wikimedia/parsoid to 0.17.0-a2
Change 837692 merged by jenkins-bot:
[mediawiki/vendor@master] Bump wikimedia/parsoid to 0.17.0-a2
Test wiki created on Patch demo by Matma Rex using patch(es) linked to this task:
https://patchdemo.wmflabs.org/wikis/1ca3d80c4b/wiki/Talk:DiscussionTools
Test wiki on Patch demo by Matma Rex using patch(es) linked to this task was deleted:
Test wiki created on Patch demo by Matma Rex using patch(es) linked to this task:
https://patchdemo.wmflabs.org/wikis/637dfdccca/wiki/Talk:DiscussionTools?useskin=vector-2022
Change 829083 merged by jenkins-bot:
[mediawiki/core@master] Generate/set/get TOCData/SectionMetadata objects instead of arrays