addParserOutput should consult skin and call setSections when setting options relating to table of contents
Closed, ResolvedPublicBUG REPORT
Actions

Description

Separating the table of contents from the content has led to various bugs T311529, T307256, T305123, T316947. Many more issues likely still exist that we are just not aware of.

The main issue here is the addParserOutput method does not consult the skin when generating default options. Perhaps it should?

TODO

Update addParserOutput or ParserOptions constructor(s) to retreive skin options and set table of contents default options correctly.
Remove technical debt we've accumulated - direct calls to setSections listed here https://codesearch.wmcloud.org/deployed/?q=-%3EsetSections%5C(&i=nope&files=&excludeFiles=&repos=
make sure setSections is called as part of addParserOutput

Developer notes

See https://gerrit.wikimedia.org/r/c/mediawiki/core/+/829229 for a first attempt

Details

Subject	Repo	Branch	Lines +/-
Use default ParserOutput::getText() options for injectTOC	mediawiki/extensions/FlaggedRevs	master	+2 -6
Use default ParserOutput::getText() options for injectTOC	mediawiki/core	master	+1 -10
OutputPage::addParserOutputText(): use default ParserOutput options from skin	mediawiki/core	master	+8 -0

Customize query in gerrit

Related Objects

Mentioned In: T325562: Pull OutputPage::setSections($parserOutput->getSections()) into OutputPage::addParserOutputMetadata()
T316007: TOC is shown unstyled and inline on Special:EditWatchlist
T316947: FlaggedRevisions incorrectly displays table of contents on Vector 2022 for flagged pages
Mentioned Here: T325562: Pull OutputPage::setSections($parserOutput->getSections()) into OutputPage::addParserOutputMetadata()
T305123: Showing Table of contents sometimes requires reload (Vector 22, wmf.5)
T307256: ToC is not shown during Preview when using the standard WikiEditor
T311529: New Vector TOC is not shown when viewing a diff with preview
T316947: FlaggedRevisions incorrectly displays table of contents on Vector 2022 for flagged pages

Event Timeline

Jdlrobson created this task.Sep 8 2022, 3:51 PM

Restricted Application added a subscriber: Aklapper. · View Herald TranscriptSep 8 2022, 3:51 PM

Jdlrobson triaged this task as High priority.Sep 8 2022, 3:51 PM

Jdlrobson updated the task description. (Show Details)

Jdlrobson mentioned this in T316947: FlaggedRevisions incorrectly displays table of contents on Vector 2022 for flagged pages.

Jdlrobson added subscribers: matmarex, cscott, ssastry.

cscott mentioned this in T316007: TOC is shown unstyled and inline on Special:EditWatchlist.Sep 8 2022, 6:44 PM

Change 830931 had a related patch set uploaded (by C. Scott Ananian; author: C. Scott Ananian):

[mediawiki/core@master] OutputPage::addParserOutputText(): use default ParserOutput options from skin

https://gerrit.wikimedia.org/r/830931

gerritbot added a project: Patch-For-Review.Sep 8 2022, 7:37 PM

Change 830936 had a related patch set uploaded (by C. Scott Ananian; author: C. Scott Ananian):

[mediawiki/core@master] Use default parser output options for injectTOC

https://gerrit.wikimedia.org/r/830936

Change 830937 had a related patch set uploaded (by C. Scott Ananian; author: C. Scott Ananian):

[mediawiki/extensions/FlaggedRevs@master] Use default ParserOutput::getText() options for injectTOC

https://gerrit.wikimedia.org/r/830937

There are two closely related issues here: one is the default value for injectTOC (and for that matter, skin) in ParserOutput::getText(), which can be set to an appropriate default by OutputPage::addParserOutput()/::addParserOutputText().

The other one is that addParserOutputMetadata doesn't set the section data. So practically every call to OutputPage::addParserOutput() is preceded by a call to OutputPage::setSections( $parserOutput->getSections()). It seems like we should really fold that into addParserOutput... but I suspect there are probably cases where we *don't* want to overwrite the section data, so I'm going to split that refactor into a separate task.

Jdlrobson added a project: User-Jdlrobson.Sep 9 2022, 5:41 PM

Change 830931 merged by jenkins-bot:

[mediawiki/core@master] OutputPage::addParserOutputText(): use default ParserOutput options from skin

https://gerrit.wikimedia.org/r/830931

ReleaseTaggerBot added a project: MW-1.40-notes (1.40.0-wmf.1; 2022-09-12).Sep 9 2022, 7:00 PM

Change 830936 merged by jenkins-bot:

[mediawiki/core@master] Use default ParserOutput::getText() options for injectTOC

https://gerrit.wikimedia.org/r/830936

Jdlrobson updated the task description. (Show Details)Sep 12 2022, 6:29 PM

Jdlrobson added a project: Web-Team-Backlog (Needs Prioritization (Tech)).

Jdlrobson moved this task from Backlog to Waiting on other teams on the Web-Team-Backlog (Needs Prioritization (Tech)) board.

Change 830937 merged by jenkins-bot:

[mediawiki/extensions/FlaggedRevs@master] Use default ParserOutput::getText() options for injectTOC

https://gerrit.wikimedia.org/r/830937

Maintenance_bot removed a project: Patch-For-Review.Sep 13 2022, 1:30 AM

@cscott is the remaining work on this ticket requiring any work or assistance from web team ?

Jdlrobson moved this task from Waiting on other teams to Tracking (Temporarily) on the Web-Team-Backlog (Needs Prioritization (Tech)) board.Oct 26 2022, 10:24 PM

ovasileva added a project: Content-Transform-Team.Dec 15 2022, 5:14 PM

• JMcLeod_WMF added a project: Content-Transform-Team-WIP.Dec 16 2022, 6:25 PM

• JMcLeod_WMF assigned this task to cscott.Dec 19 2022, 4:18 PM

• JMcLeod_WMF moved this task from Backlog to In Progress on the Content-Transform-Team-WIP board.

cscott mentioned this in T325562: Pull OutputPage::setSections($parserOutput->getSections()) into OutputPage::addParserOutputMetadata().Dec 19 2022, 4:23 PM

I believe the important work in this patch was complete back in September. I've opened T325562: Pull OutputPage::setSections($parserOutput->getSections()) into OutputPage::addParserOutputMetadata() for the cleanup refactoring work, which is low priority.

ovasileva subscribed.Dec 20 2022, 9:10 PM

addParserOutput should consult skin and call setSections when setting options relating to table of contentsClosed, ResolvedPublicBUG REPORTActions