[ToC] table of contents in Edit mode
Open, MediumPublic
Actions

Assigned To

Authored By

	• alexhollender_WMF
	Nov 3 2021, 4:37 PM

Description

We are moving the table of contents to the side of the article text, and making it sticky (i.e. it stays in place as your scroll down the page). Currently our plan is to only do this for pages in the main namespace, in read mode. Assuming people frequently go from read mode to edit mode, it might make sense to consider this transition, in particular thinking about the visual balance/layout of the page changes between the two as major elements shift around.

NOTE: this is a similar task as T294784, but it's about edit mode instead of talk pages

Questions to answer

Do we want to show the table of contents in edit mode?

If yes:

what are the technical, design, and product considerations we need to think through?

If no:

what do we prefer?
- that space is empty
  - re-center page
  - don't re-recenter page
- that space is occupied by some other element
- that space is used to display the page full-width

Reference images

Details

Subject	Repo	Branch	Lines +/-
Handle new 'wikipage.tableOfContents' hook to update TOC dynamically	mediawiki/skins/Vector	master	+158 -5
Fire new 'wikipage.tableOfContents' hook to update TOC after save	mediawiki/extensions/DiscussionTools	master	+9 -2
ParserOption/ParserOutput flag to suppress or hide the table of contents	mediawiki/core	master	+255 -20
ApiParse: When querying TOC sections, also return whether it should be hidden	mediawiki/core	master	+1 -0
Fire new 'wikipage.tableOfContents' hook to update TOC on live preview	mediawiki/core	master	+10 -1
Fire new 'wikipage.tableOfContents' hook to update TOC after save	mediawiki/extensions/VisualEditor	master	+13 -4
EditPage: Set sections for new skin TOC when previewing	mediawiki/core	master	+1 -0

Customize query in gerrit

Related Objects
Search...

Status	Subtype	Assigned	Task
Resolved		ovasileva	T273473 [Epic] Improve the table of contents
Open		• ppelberg	T294950 [ToC] table of contents in Edit mode
Resolved		ovasileva	T307112 [Bug] Table of contents should not appear in edit mode
Duplicate		None	T307336 Table of contents not updating after edit is saved in VE
Resolved		Jdlrobson	T307251 [ToC] Show new/modified sections after publishing an edit (new floating ToC)
Resolved	BUG REPORT	matmarex	T307480 Modify VisualEditor to trigger a hook with sections data for table of contents re-rendering
Resolved		matmarex	T307256 ToC is not shown during Preview when using the standard WikiEditor

Event Timeline

• alexhollender_WMF created this task.Nov 3 2021, 4:37 PM

• alexhollender_WMF mentioned this in T294784: [ToC] table of contents on Talk pages.

• alexhollender_WMF edited projects, added Editing-team (Kanban Board); removed Epic.Nov 3 2021, 4:39 PM

• alexhollender_WMF added subscribers: • iamjessklein, • ppelberg, • KieranMcCann, RHo.

• alexhollender_WMF moved this task from Needs Analysis to Design Review on the Web-Team-Backlog (Kanbanana-FY-2021-22) board.Nov 3 2021, 4:46 PM

• iamjessklein added a subscriber: • E.S.A-Sheild.Nov 5 2021, 6:33 PM

ovasileva triaged this task as Medium priority.Nov 9 2021, 6:10 PM

@iamjessklein @ppelberg passing this over to y'all

Jdlrobson moved this task from Incoming to Table of Contents on the Desktop Improvements (Vector 2022) board.Dec 17 2021, 10:52 PM

• ppelberg moved this task from Incoming to Upcoming on the Editing-team (Kanban Board) board.Dec 22 2021, 8:09 PM

Some initial thoughts/questions:

How might the topic containers interact with the TOC?
How do archived conversations interact with the TOC?
How do different types of contributors use the TOC on Talk pages?
Are TOC more useful on highly populated Talk pages?
Is this an area where we are intentionally syncing up with the Reading (article) view or going a different direction to differentiate the experiences even further?

• ppelberg edited projects, added Design; removed Editing-team (Kanban Board).Feb 9 2022, 5:51 PM

• ppelberg added a project: Editing-team.

• ppelberg added a project: VisualEditor.

• ppelberg moved this task from To Triage to New feature on the VisualEditor board.

It would be nice if the table of contents worked for both the visual and source editors. Right now it's enabled on both and doesn't work so it should probably be disabled temporarily.

ovasileva mentioned this in T307112: [Bug] Table of contents should not appear in edit mode.Apr 28 2022, 2:35 PM

In T294950#7888070, @Lectrician1 wrote:

It would be nice if the table of contents worked for both the visual and source editors. Right now it's enabled on both and doesn't work so it should probably be disabled temporarily.

@Lectrician1 - yes, this is a bug - we're disabling this in T307112: [Bug] Table of contents should not appear in edit mode

As an editor, I strongly want the ToC to be visible whilst I'm editing, so that I can see structural changes I have made reflected in the ToC, and also detect any errors before I save.
Not having access to the ToC is a primary reason I don't ever use the 2017 Wikitext Editor.
I filed this yesterday because I really want a ToC visible in the classic 2010 WikiEditor: T307256: ToC is not shown during Preview when using the standard WikiEditor

ovasileva added a subtask: T307251: [ToC] Show new/modified sections after publishing an edit (new floating ToC).May 2 2022, 9:26 AM

ovasileva closed subtask T307112: [Bug] Table of contents should not appear in edit mode as Resolved.May 12 2022, 8:37 AM

Change 802676 had a related patch set uploaded (by Bartosz Dziewoński; author: Bartosz Dziewoński):

[mediawiki/skins/Vector@master] Handle new 'wikipage.tableOfContents' hook to update TOC dynamically

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

Change 802677 had a related patch set uploaded (by Bartosz Dziewoński; author: Bartosz Dziewoński):

[mediawiki/core@master] EditPage: Set sections for new skin TOC when previewing

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

Change 802678 had a related patch set uploaded (by Bartosz Dziewoński; author: Bartosz Dziewoński):

[mediawiki/core@master] ApiParse: When querying TOC sections, also return whether it should be shown

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

Change 802679 had a related patch set uploaded (by Bartosz Dziewoński; author: Bartosz Dziewoński):

[mediawiki/core@master] Fire new 'wikipage.tableOfContents' hook to update TOC on live preview

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

Change 802680 had a related patch set uploaded (by Bartosz Dziewoński; author: Bartosz Dziewoński):

[mediawiki/extensions/VisualEditor@master] Fire new 'wikipage.tableOfContents' hook to update TOC after save

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

Change 802681 had a related patch set uploaded (by Bartosz Dziewoński; author: Bartosz Dziewoński):

[mediawiki/extensions/DiscussionTools@master] Fire new 'wikipage.tableOfContents' hook to update TOC after save

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

The patches I'm proposing would cause the table of contents to be updated after previewing in old wikitext editor, and after saving in VisualEditor and DiscussionTools.

cscott mentioned this in T310083: ToC issues.Jun 7 2022, 3:53 PM

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

[mediawiki/core@master] ParserOption/ParserOutput flag to suppress or hide the table of contents

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

• ppelberg edited projects, added Editing-team (Kanban Board); removed Editing-team.Jun 13 2022, 5:24 PM

• ppelberg moved this task from Upcoming to Blocked / Needs More Work on the Editing-team (Kanban Board) board.

matmarex moved this task from Blocked / Needs More Work to Code Review on the Editing-team (Kanban Board) board.Jun 15 2022, 8:15 PM

Change 802677 merged by jenkins-bot:

[mediawiki/core@master] EditPage: Set sections for new skin TOC when previewing

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

Change 802678 merged by jenkins-bot:

[mediawiki/core@master] ApiParse: When querying TOC sections, also return whether it should be hidden

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

Change 802680 merged by jenkins-bot:

[mediawiki/extensions/VisualEditor@master] Fire new 'wikipage.tableOfContents' hook to update TOC after save

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

Change 802679 merged by jenkins-bot:

[mediawiki/core@master] Fire new 'wikipage.tableOfContents' hook to update TOC on live preview

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

Change 800765 merged by jenkins-bot:

[mediawiki/core@master] ParserOption/ParserOutput flag to suppress or hide the table of contents

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

Change 802681 merged by jenkins-bot:

[mediawiki/extensions/DiscussionTools@master] Fire new 'wikipage.tableOfContents' hook to update TOC after save

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

ReleaseTaggerBot added a project: MW-1.39-notes (1.39.0-wmf.23; 2022-08-01).Aug 1 2022, 8:00 PM

matmarex moved this task from Code Review to Blocked / Needs More Work on the Editing-team (Kanban Board) board.Aug 1 2022, 10:08 PM

Change 802676 abandoned by Bartosz Dziewoński:

[mediawiki/skins/Vector@master] Handle new 'wikipage.tableOfContents' hook to update TOC dynamically

Reason:

Superseded by https://gerrit.wikimedia.org/r/821748

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

Maintenance_bot removed a project: Patch-For-Review.Aug 18 2022, 11:30 PM

Jdlrobson merged a task: T315610: ToC class missing on edit page.Aug 22 2022, 5:36 AM

Jdlrobson added a subscriber: Nux.

Note that ToC is currently shown in preview, but class vector-toc-visible is not added to .mw-page-container-inner any more. Hence layout might not be ready for the toc.

Described in full in T315610.

I only forgot to mention that I have enabled the option to show preview when editing (#mw-input-wppreviewonfirst; pl: "Pokazuj podgląd strony podczas pierwszej edycji").

A screen that is showing view with enhanced layout after workaround mentioned in T315610.

Enhanced layout:
https://pl.wikipedia.org/wiki/Dyskusja_wikipedysty:Nux/Fixed_top_bar.css

Jdlrobson closed subtask T307251: [ToC] Show new/modified sections after publishing an edit (new floating ToC) as Resolved.Aug 29 2022, 5:03 PM

@Jdlrobson @Nux I'm not sure whether T315610 is really a duplicate, however, the issue you described there (and in the comment here) looks fixed to me. If you can still reproduce it, please re-open that task.

@matmarex at the current time we intentionally do not show the table of contents in edit mode. This task is about adding it.

Recent work has been to show the table of contents after an edit ( T307251) and in preview mode but we haven't addressed the case of during an edit (and don't have plans to at the current time).

I know, but T315610 was not about this. T315610 was about the preview that occurs when you're using the "Show preview on first edit" preference.

I think this task has 5 parts:

(regression) Display the Vector 2022 TOC while previewing in old wikitext editor – T307256
(regression) Display the Vector 2022 TOC while previewing in old wikitext editor with live preview enabled – [no task]
(regression) Display the Vector 2022 TOC while previewing in 2017 wikitext editor [no task]
(new feature) Display the Vector 2022 TOC while editing in visual editor – [no task]
(new feature) Display the Vector 2022 TOC while editing in 2017 wikitext editor [no task]

We (Editing-team) need to figure out which of the above we're going to work on, file subtasks for those, and close this task.

My work on this task so far (which should have been on subtasks too, but oh well) was only about 1 and 2, and I only worked on it because most of it was also needed to fix the behavior after publishing an edit (T307251).

Currently, 1 and 2 are already mostly working correctly, but nothing has been done on 3, 4 and 5.

matmarex mentioned this in T315610: ToC class missing on edit page.Aug 30 2022, 1:09 AM

matmarex added a subtask: T307256: ToC is not shown during Preview when using the standard WikiEditor.Aug 31 2022, 8:43 PM

Jdlrobson moved this task from Table of Contents to Work with other teams on the Desktop Improvements (Vector 2022) board.Sep 2 2022, 2:33 PM

matmarex mentioned this in T155723: Show table of contents when showing preview.Oct 4 2022, 3:02 PM

alistair3149 subscribed.Oct 6 2022, 5:28 PM

Patafisik mentioned this in T307256: ToC is not shown during Preview when using the standard WikiEditor.Dec 16 2022, 1:36 PM

matmarex removed matmarex as the assignee of this task.Dec 19 2022, 10:35 PM

matmarex closed subtask T307256: ToC is not shown during Preview when using the standard WikiEditor as Resolved.Dec 19 2022, 10:38 PM

This task needs to be increased in priority now that Vector 2022 is the default skin. Being unable to see the TOC when I click Edit on a long page means that I have to use Find or scrolling to navigate, both of which can be tedious and imprecise.

• ppelberg claimed this task.Jan 30 2023, 6:12 PM

• ppelberg moved this task from Ready for Sign Off to Blocked / Needs More Work on the Editing-team (Kanban Board) board.

RHo added a subscriber: nayoub.Apr 18 2023, 8:57 PM

T307256 seems to have regressed? Perhaps as a result of the zebra work?

ovasileva reopened subtask T307256: ToC is not shown during Preview when using the standard WikiEditor as Open.May 1 2023, 4:01 PM

EAkinloose closed subtask T307256: ToC is not shown during Preview when using the standard WikiEditor as Resolved.May 22 2023, 8:42 PM

matmarex moved this task from Blocked / Needs More Work to Ready for Sign Off on the Editing-team (Kanban Board) board.Jun 5 2023, 5:30 PM

@ppelberg: file the tickets @matmarex outlined in T294950#8196609.