Page MenuHomePhabricator

Implement tooltips onboarding for subreferencs
Closed, ResolvedPublic

Description

Context

Implementation steps for the tooltips. After discussing some options on how we implement this best there seems to be an option we want to go for that should work for what's needed.

Implementation details
  • Use the OO.ui.ProcessDialog class to implement the dialog. The base class should already provide the style we want
  • Add the content from the mocks
  • Add the pulsing blue dot and position it with CSS to the button

For design details see T394627: VE: Tool tips and onboarding flow for sub-referencing

  • Use cookies / user options to store if the dialog was dismissed
  • Open the details dialog when the user clicks "okay, got it"

To demo this more than once, you can paste the following lines into your JavaScript console to delete the user preference and cookie.

( new mw.Api() ).saveOption( 'userjs-cite-hide-subref-help', null );
localStorage.removeItem( 'mw-cite-hide-subref-help' );

Event Timeline

Change #1182871 had a related patch set uploaded (by Svantje Lilienthal; author: Svantje Lilienthal):

[mediawiki/extensions/Cite@master] [WIP] Displaying help dialog for add details button

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

Change #1182871 merged by jenkins-bot:

[mediawiki/extensions/Cite@master] Displaying help dialog for add details button

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

As mentioned in our team meeting: We should change the onboarding tooltip link to https://meta.wikimedia.org/wiki/Special:MyLanguage/WMDE_Technical_Wishes/Sub-referencing (instead of linking to the VE section of the page) because people reading the tooltip likely want to learn more about the feature in general (as opposed to the link in T403694 where people likely want to learn more about VE usage).

Change #1187792 had a related patch set uploaded (by WMDE-Fisch; author: WMDE-Fisch):

[mediawiki/extensions/Cite@master] Change sub-ref help link to not link to sub-section

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

Change #1188714 had a related patch set uploaded (by Thiemo Kreuz (WMDE); author: Thiemo Kreuz (WMDE)):

[mediawiki/extensions/Cite@master] Fix pulsating dot not disappearing for logged in users

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

Change #1188714 merged by jenkins-bot:

[mediawiki/extensions/Cite@master] Fix pulsating dot not disappearing for logged in users

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

Change #1187792 merged by jenkins-bot:

[mediawiki/extensions/Cite@master] Change sub-ref help link to not link to sub-section

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

Change #1190189 had a related patch set uploaded (by WMDE-Fisch; author: Thiemo Kreuz (WMDE)):

[mediawiki/extensions/Cite@wmf/1.45.0-wmf.19] Fix pulsating dot not disappearing for logged in users

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

Change #1190189 merged by jenkins-bot:

[mediawiki/extensions/Cite@wmf/1.45.0-wmf.19] Fix pulsating dot not disappearing for logged in users

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

Mentioned in SAL (#wikimedia-operations) [2025-09-22T08:40:44Z] <awight@deploy1003> Started scap sync-world: Backport for [[gerrit:1190189|Fix pulsating dot not disappearing for logged in users (T403693)]]

Mentioned in SAL (#wikimedia-operations) [2025-09-22T08:46:41Z] <awight@deploy1003> awight, wmde-fisch: Backport for [[gerrit:1190189|Fix pulsating dot not disappearing for logged in users (T403693)]] synced to the testservers (see https://wikitech.wikimedia.org/wiki/Mwdebug). Changes can now be verified there.

Mentioned in SAL (#wikimedia-operations) [2025-09-22T08:53:10Z] <awight@deploy1003> Finished scap sync-world: Backport for [[gerrit:1190189|Fix pulsating dot not disappearing for logged in users (T403693)]] (duration: 12m 26s)