Page MenuHomePhabricator

Design: Determine 'Guided Tour' Requirements
Open, Needs TriagePublic

Description

UPDATE: This ticket has been changed since it was originally written. After discussing "Guided Tour" with Moriel, I have made some changes (see below).

As a developer, I want to know the expected behavior of the Guided Tour extension on WhoWroteThat, so that I can implement a user-friendly experience.

This ticket is dependent on findings from T227160.

Requirements:
• Determine user flow and behavior for the Guided Tour extension of WhoWroteThat for various scenarios, including the following: a) how, when, and where the user first sees the "Guided Tour" pop-up, and b) how and when the user can turn off the pop-up notification
• Pop-up should be visually noticeable/distinct from article text (this is taken from user testing info, in which one user did not see the pop-up right away)

Event Timeline

ifried created this task.Jun 27 2019, 9:16 PM
Restricted Application added a subscriber: Aklapper. · View Herald TranscriptJun 27 2019, 9:16 PM
ifried updated the task description. (Show Details)Jun 28 2019, 10:50 PM
ifried updated the task description. (Show Details)Jul 2 2019, 8:08 PM

@Mooeypoo I wanted to confirm that this wont be the actual GuidedTour since the code is outside of MediaWiki. Will we be able to style it however we like?

I was thinking of it from the "what happens after you've installed the browser extension" situation. It should take you to a page (that we know has WhoColor data) and teach them how to activate the tool. There isn't anything else that we need to guide them with apart from telling them where the link is going to live (something we aren't sure about yet?).

Mooeypoo added a comment.EditedJul 3 2019, 3:16 AM

Actually, I've been reading about how we might be able to reach into the available global variables in the DOM with a browser extension. Since we know it only runs on Wikipedia sites, if we can do that, we will have access to the mw variable, which means we can use resource loader to load (and use!) Guided Tour.

If we can do that, it'll save us the programming of Yet Another Popup™, will produce an experience that wiki users are already familiar with, well save us loads of trouble with interface stuff like right to left issues, and will save us quite a lot of maintenance.

It's definitely worth testing to see if this works.

If not, I recommend the most simple popup possible, to reduce effort here.

Just to be clear before anyone jumps ahead of the train (of thought;) we need to check into whether this is feasible and follows our security and privacy standards.

I'm sure anything can be hacked, but from the cursory reading I've done, and since the extension we are building doesn't need access to the browser API itself and only requires reading and manipulating the DOM, like a gadget, there might be a way to get this context without compromising security.

If not, I recommend the most simple popup possible, to reduce effort here.

Understood. I'll wait till you're done investigating.

Honestly, I'm hoping we can do it so we can also use ooui pop-ups in general. From my experience, they're vastly superior to anything else out there when it comes to proper positioning within cross directional text with cross directional interface, which is pretty necessary for wikis.

I'll create a ticket to investigate this further.

Thanks @Mooeypoo! Quick question, is it possible to have markup inside OOUI popups like headings and stuff, as is the case with GuidedTours?

Thanks @Mooeypoo! Quick question, is it possible to have markup inside OOUI popups like headings and stuff, as is the case with GuidedTours?

Yeah, the $content of the popup is fully customizable, you can add whatever DOM you want and style it in CSS. The popup itself is "just" an "empty shell" with some options for header/footer.

I opened a ticket for investigating this here: T227160: Investigate whether WhoWroteThat browser extension can have access to the `window` global on MediaWiki sites

ifried updated the task description. (Show Details)Jul 3 2019, 7:07 PM