Create Task
Maniphest T307823

Improve how ToC is rendered to allow adding discussion enhancements
Closed, ResolvedPublic
Actions

Description

This task involves the work required to improve how the new ToC is rendered to allow adding DiscussionTools enhancements to it.

Requirements

We can add HTML markup to the ToC, and have Vector 2022 display it.

Open questions

  • 1. What – if any – concerns does the Web Team have about implementing the ===Requirements above? See comments from Jon in T305576#7838809.

Testing instructions

Verify that the discussion topic metadata appears in the Vector 2022 table of contents on discussion pages. (see mockups on T309463)

Done

  • Answers to all ===Open questions are documented
  • ===Requirements are implemented

Details

SubjectRepoBranchLines +/-
Enhance vector-2022 table of contentsmediawiki/extensions/DiscussionToolsmaster+82 -14
Support additional content in table of contentsmediawiki/skins/Vectormaster+3 -0
Customize query in gerrit

Related Objects
Search...

Event Timeline

ppelberg created this task.May 7 2022, 12:09 AM
ppelberg moved this task from Backlog to Triaged on the DiscussionTools board.
ppelberg moved this task from Untriaged to This Fiscal Year on the Editing-team board.
ppelberg mentioned this in T305576: [SPIKE] Define work to be done before discussion-specific ToC is production ready.
ppelberg added a project: Goal.Jul 21 2022, 11:39 PM
ovasileva subscribed.Jul 22 2022, 1:55 PM
ppelberg edited projects, added Editing-team (Kanban Board); removed Editing-team.Jul 26 2022, 4:33 PM
ppelberg moved this task from Incoming to Ready to Be Worked On on the Editing-team (Kanban Board) board.
matmarex added a comment.Jul 27 2022, 4:31 PM

The old proof-of-concept implementation is here, for reference:

It would still work, but it was meant to go with my proposed implementation for T307251, which might not get merged after all. We might want to wait to see how that is resolved first.

matmarex moved this task from Ready to Be Worked On to Blocked / Needs More Work on the Editing-team (Kanban Board) board.Aug 2 2022, 5:48 PM

Currently waiting to see what happens in T307251, to avoid having to reimplement this several times if the favored solution for that task changes.

matmarex added a project: TPP-Phase1.Aug 9 2022, 4:54 PM
matmarex moved this task from Tickets for Consideration to Page Frame on the TPP-Phase1 board.Aug 9 2022, 5:01 PM
matmarex moved this task from Blocked / Needs More Work to Ready to Be Worked On on the Editing-team (Kanban Board) board.Aug 17 2022, 10:16 PM

Work on T307251 seems finished, and the solution there seems to work as-is with the old proof-of-concept implementation here. I think we can just promote it to real implementation.

gerritbot added a comment.Aug 17 2022, 10:22 PM

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

[mediawiki/skins/Vector@master] Support additional content in table of contents

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

gerritbot added a project: Patch-For-Review.Aug 17 2022, 10:22 PM

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

[mediawiki/extensions/DiscussionTools@master] Enhance vector-2022 table of contents

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

gerritbot added a comment.Aug 18 2022, 5:31 PM

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

[mediawiki/extensions/DiscussionTools@master] Enhance vector-2022 table of contents

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

Jdlrobson subscribed.Aug 18 2022, 5:43 PM

We talked about this in the editing team sync and web team are happy for editing team to review this one.

matmarex added a comment.Aug 18 2022, 11:27 PM

Requirements

The requirements below are borrowed from what @matmarex proposed in T305576#7846004.

  1. Add a PHP hook in SkinComponentTableOfContents to allow DiscussionTools to add HTML fragments to each ToC line

This ended up not being necessary, we can sneak our additions into the existing ToC data using existing hooks.

  1. Modify Vector to output this

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

  1. Modify the JavaScript API from the previous item to also support this

Done in T307251

matmarex claimed this task.Aug 18 2022, 11:27 PM
matmarex moved this task from Ready to Be Worked On to Code Review on the Editing-team (Kanban Board) board.
ppelberg mentioned this in T309463: [Talk pages] Polish the design for the table of contents shown on talk pages.Aug 22 2022, 7:00 PM
gerritbot added a comment.Aug 26 2022, 8:57 PM

Change 773661 merged by jenkins-bot:

[mediawiki/skins/Vector@master] Support additional content in table of contents

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

gerritbot added a comment.Aug 26 2022, 8:57 PM

Change 778316 merged by jenkins-bot:

[mediawiki/extensions/DiscussionTools@master] Enhance vector-2022 table of contents

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

ReleaseTaggerBot added a project: MW-1.39-notes (1.39.0-wmf.27; 2022-08-29).Aug 26 2022, 9:00 PM
Sdkb unsubscribed.Aug 27 2022, 1:17 AM
matmarex moved this task from Code Review to QA on the Editing-team (Kanban Board) board.Aug 30 2022, 12:47 PM
matmarex added a project: Editing QA.
matmarex updated the task description. (Show Details)Aug 31 2022, 8:51 PM
matmarex updated the task description. (Show Details)Aug 31 2022, 8:54 PM
EAkinloose subscribed.Aug 31 2022, 11:32 PM

❓Discussion topic metadata appears in the Vector 2022 table of contents on discussion pages. However, #3 change of the proposed design detailed in T309463 is to Run # of comments on after topic title (read: not on new line). The # of comments is still displayed on a new line. @matmarex am I missing something?

Let me know if the behaviour is expected.

Screenshot 2022-09-01 at 00.25.02.png (1×3 px, 521 KB)

ppelberg added a comment.Sep 1 2022, 7:39 PM
In T307823#8204787, @EAkinloose wrote:

❓Discussion topic metadata appears in the Vector 2022 table of contents on discussion pages. However, #3 change of the proposed design detailed in T309463 is to Run # of comments on after topic title (read: not on new line). The # of comments is still displayed on a new line. @matmarex am I missing something?

Let me know if the behaviour is expected.

Screenshot 2022-09-01 at 00.25.02.png (1×3 px, 521 KB)

Great spot, @EAkinloose.

Per what we discussed during today's standup, we're going to:

  • REVISE the ToC implementation so that the # comment(s) count always appears on a new line, beneath the section heading to which the count is related
  • REMOVE the parentheses that currently surround the (# comment(s)) count
  • CHANGE the language that appears atop the ToC from Contents to Discussions
NOTE: the changes I've named above will happen in T309463.
ppelberg added a comment.Sep 1 2022, 7:44 PM

With T307823#8206958 in mind, @EAkinloose do you think this ticket is Ready for sign off?

EAkinloose edited projects, added Verified; removed Editing QA.Sep 15 2022, 3:52 PM
In T307823#8206968, @ppelberg wrote:

With T307823#8206958 in mind, @EAkinloose do you think this ticket is Ready for sign off?

We are all good 👌🏿

EAkinloose moved this task from QA to Ready for Sign Off on the Editing-team (Kanban Board) board.Sep 15 2022, 3:52 PM
ppelberg closed this task as Resolved.Sep 22 2022, 4:36 PM
Content licensed under Creative Commons Attribution-ShareAlike (CC BY-SA) 4.0 unless otherwise noted; code licensed under GNU General Public License (GPL) 2.0 or later and other open source licenses. By using this site, you agree to the Terms of Use, Privacy Policy, and Code of Conduct. · Wikimedia Foundation · Privacy Policy · Code of Conduct · Terms of Use · Disclaimer · CC-BY-SA · GPL · Credits