Page MenuHomePhabricator

Hide Vector 2022 Tools and Appearance menus when Edit Check has the potential to activate
Closed, ResolvedPublic

Description

This task involves the work of hiding Vector 2022's Tools and Appearance menus for a subset of people while they are editing with the visual editor (desktop).

This work is prompted by a need for two things to be true for volunteers:

  1. They feel like they have sufficient space (width) to make changes
  2. They are able to see Edit Checks in close proximity to the content they're related to without any part of the editable content being obfuscated/affected

Story

As someone who is new to editing Wikipedia and who is attempting to make a change that causes an Edit Check to activate, I need to be able to A) understand what change/content the Check I'm seeing is related to, B) continue focusing on what I had been before the Check appeared, and C) have sufficient space/width to work within so that I can make changes that are aligned with project policies in an environment I feel comfortable working within

Requirements

WARNING: the Editing Team will need to consult with the Web Team before the below can be considered finalized.
  1. For people who are i) logged out, ii) have made ≤100 cumulative edits and are editing at a Wikipedia project in a namespace where Edit Check is available:
    1. Hide the Tools and Appearance menus when they open the visual editor on desktop, regardless of whether they have a user preference set to show these menus in all other circumstances/contexts
    2. Make it impossible for people to "pin" the Tools and Appearance menus when this stte is entered
    3. Show the Tools and Appearance menus when people exit the visual editor, provided they have a user preference set to show these menus
  2. In implementing "1.A." no changes ought to be made to the user preferences people have set
NOTE: all of the above should last the full duration of the edit session

Open questions

  • 1. What methods of "opening the visual editor" ought to cause the Tools and Appearance menus to be hidden?
  • 2. At what point during the transition from someone opening the visual editor (desktop) and the visual editor being ready are the Tools and Appearance menus meant to be hidden?
  • 3. What ought to happen when someone cancels an edit session? How – if at all – should this experience vary by when people abort an edit session? E.g. before the editing interface fully loads? After someone has made some changes and before they attempt to publish them? Etc.

User experience

TBD

Related Objects

Event Timeline

ppelberg renamed this task from Hide Tools and Appearance menus for junior contributors while editing to Hide Tools and Appearance menus when Edit Check has the potential to activate.Nov 19 2024, 11:49 PM
ppelberg renamed this task from Hide Tools and Appearance menus when Edit Check has the potential to activate to Hide Vector 2022 Tools and Appearance menus when Edit Check has the potential to activate.
ppelberg updated the task description. (Show Details)

Change #1093386 had a related patch set uploaded (by DLynch; author: DLynch):

[mediawiki/extensions/VisualEditor@master] Hide vector sidebar while editor is active with editcheck enabled

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

^ That's the hack version that doesn't rely on any sort of official API.

Test wiki created on Patch demo by DLynch (WMF) using patch(es) linked to this task:
http://patchdemo.wmcloud.org/wikis/67145bdf90/w/

When I load the patchdemo, I see that the Appearance menu is disabled but the Tools option looks enabled on the toolbar, which does expand to show the "move to sidebar" option and only when I click on it, it removes the option from the toolbar. Also, when I intentionally hide both the Appearance menu and Tools menu in the read mode and then re-open VE they both appear enabled there. Here is the experience that I am observing:
https://drive.google.com/file/d/1BO5dvJlsNiLrbK05650qfzc5-hppI0eD/view

@Ryasmeen that's all about as-expected for the current state of that patch.

  • You have a quite wide window, and so the sidebar vanishing doesn't make a difference to you. We could potentially either have the edit check sidebar move outside the editing surface if the space is available, or toggle Vector 2022 into "wide" mode to actually use that space.
  • The tools and appearances menus will both stay enabled if they weren't in the sidebar already, because you can still use them there -- they only get disabled when they were in the sidebar because their contents are missing. I'd expect that when we get an actual API for this they'll not need to be disabled during the editing session because they'll be able to be functional.
  • I didn't consider someone opening the non-disabled menus and moving them to the sidebar. Might be worth seeing whether that can be hidden by the hack as well.

Test wiki on Patch demo by DLynch (WMF) using patch(es) linked to this task was deleted:

http://patchdemo.wmcloud.org/wikis/67145bdf90/w/

Test wiki on Patch demo by DLynch (WMF) using patch(es) linked to this task was deleted:

http://patchdemo.wmcloud.org/wikis/030497f074/w/

Test wiki on Patch demo by DLynch (WMF) using patch(es) linked to this task was deleted:

http://patchdemo.wmcloud.org/wikis/8ecc0b7b7d/w/

Sorry, that took me a minute to get a few different patches working together. Just to confirm after that, this is the one that actually demonstrates the hack-patch: https://patchdemo.wmcloud.org/wikis/8ecfce5007/wiki/Douglas_Adams

I updated it to be doing less. It now just hides the sidebar and doesn't try to do anything at all with toggling the state of the sidebar items. It does, however, only hide the sidebar if your screen is narrow enough that the sidebar would be cutting in to the content width.

(Actually editing on that patchdemo will fail, incidentally, because the config patch that turns on all the experimental features wound up turning on something with a bug. I've got a separate patch up that'll fix that.)

Test wiki created on Patch demo by DChan (WMF) using patch(es) linked to this task:
http://patchdemo.wmcloud.org/wikis/646efd9453/w/

I didn't consider someone opening the non-disabled menus and moving them to the sidebar. Might be worth seeing whether that can be hidden by the hack as well.

@DLynch, were you able to investigate this? If so, what did you find?

I ask the above agreeing with what @Ryasmeen noted in T379443#10341946 about it being unexpected/confusing for the menus disappearing entirely when people tap Move to sidebar.

were you able to investigate this? If so, what did you find?

Since the latest patchdemo was made: I've got it so that the "move to sidebar" buttons in the menus are hidden when the sidebar is hidden. There's still no way to access them if they're already in the sidebar when you start your edit, but you won't be able to make them completely vanish during an edit (apart from by resizing your window, which is uncommon).

Change #1056630 had a related patch set uploaded (by DLynch; author: DLynch):

[mediawiki/extensions/VisualEditor@master] EditCheck: move checks to a sidebar

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

Change #1093386 abandoned by DLynch:

[mediawiki/extensions/VisualEditor@master] Hide vector sidebar while editor is active with editcheck enabled

Reason:

Merged into the main multicheck patch

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

Change #1056630 merged by jenkins-bot:

[mediawiki/extensions/VisualEditor@master] EditCheck: move checks to a sidebar

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

Change #1102885 had a related patch set uploaded (by DLynch; author: DLynch):

[mediawiki/extensions/VisualEditor@wmf/1.44.0-wmf.6] EditCheck: move checks to a sidebar

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

DLynch moved this task from Inbox to QA on the Editing-team (Kanban Board) board.
DLynch added a project: Editing QA.

Change #1102885 merged by jenkins-bot:

[mediawiki/extensions/VisualEditor@wmf/1.44.0-wmf.6] EditCheck: move checks to a sidebar

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

Mentioned in SAL (#wikimedia-operations) [2024-12-12T21:45:43Z] <tgr@deploy2002> Started scap sync-world: Backport for [[gerrit:1102885|EditCheck: move checks to a sidebar (T341308 T379443)]]

Mentioned in SAL (#wikimedia-operations) [2024-12-12T22:02:16Z] <tgr@deploy2002> tgr, kemayo: Backport for [[gerrit:1102885|EditCheck: move checks to a sidebar (T341308 T379443)]] synced to the testservers (https://wikitech.wikimedia.org/wiki/Mwdebug)

Mentioned in SAL (#wikimedia-operations) [2024-12-12T22:14:56Z] <tgr@deploy2002> Finished scap sync-world: Backport for [[gerrit:1102885|EditCheck: move checks to a sidebar (T341308 T379443)]] (duration: 29m 12s)

Ryasmeen edited projects, added Verified; removed Editing QA.

were you able to investigate this? If so, what did you find?

Since the latest patchdemo was made: I've got it so that the "move to sidebar" buttons in the menus are hidden when the sidebar is hidden. There's still no way to access them if they're already in the sidebar when you start your edit, but you won't be able to make them completely vanish during an edit (apart from by resizing your window, which is uncommon).

I have verified the following scenarios:

  1. The "move to sidebar" buttons in the menus are hidden when the sidebar is hidden.
  2. There is no way to access the Tools and Appearance menus when you start your edit or when a check is presented in edit check mode.
  3. In Read mode, the Menus will stay visible as long as the sidebar is not hidden.

Test wiki on Patch demo by DLynch (WMF) using patch(es) linked to this task was deleted:

http://patchdemo.wmcloud.org/wikis/8ecfce5007/w/

Test wiki on Patch demo by DLynch (WMF) using patch(es) linked to this task was deleted:

http://patchdemo.wmcloud.org/wikis/7ebe13a367/w/

Test wiki on Patch demo by DChan (WMF) using patch(es) linked to this task was deleted:

https://patchdemo.wmcloud.org/wikis/646efd9453/w/