Page MenuHomePhabricator

Create a help page for TemplateWizard
Closed, ResolvedPublic3 Estimated Story Points

Description

Let's do this on mw.org in accordance with our other extension help pages. And this will give us a flow board to collect feedback. \o/

Event Timeline

Niharika set the point value for this task to 3.Mar 20 2018, 11:05 PM

I have a selenium script for producing screenshots in multiple languages. Is this useful?

What would be good ones to include? Template-editing form for sure, and probably search results e.g.:

search_ar.png (450×800 px, 20 KB)

Would it be too much to have custom templates in each language? Would make the screenshots look nicer. If the template (and search term etc.) are l10n messages, we can have it generate screenshots for all languages in which the required messages exist.

@Samwilson Yeah, template form (showing addition and removal of fields), search results, date-widget, autocomplete for page and image fields, inserted template etc. would be good ones to have screenshots for.
I like the idea of including more languages but having screenshots for every language might be a bit of a stretch. Is there a way to configure the page so that it shows the screenshots for a given language when the page is viewed in that language?
We should also make sure that the help page itself is translated in as many languages as possible.

Does this task include adding a help link to the TemplateWizard dialog window? We used to have one, and I know there's been some discussion about where it should go, but I can't remember what the outcome was and can't find a ticket for it.

As far as screenshots go, I think we'll get better more realistic ones by waiting till it's in production and we can use real data, and making-do with demos until then. It's possible to carry on down the automation route I've been investigating (including generating template examples in multiple languages via Wikidata) but it feels like more work than it's worth at the moment.

I've made some more edits to the help page, but it's not quite done yet. Still, some review would be good if anyone's got a mo'. https://www.mediawiki.org/wiki/Help:Extension:TemplateWizard

@Samwilson We decided to move the help link to the bottom of the search screen. See mock. Let's keep it separate from this task though. I don't think we estimated this task with that in mind. Also we'll probably run into all sorts of design troubles. I created a task for that at T200450: Add help link to bottom of TemplateWizard search screen.

It looks quite good for a start. I agree that we'll get better screenshots when this is in production or test wiki. We can live without the automated screenshots for now. The ones we have up right now are good enough.

I think this page could benefit from a brief video to show how the wizard works, once we can get it on testwiki or prod.

Yes, I think a video is a good idea, and better screenshots. Should we just leave this task for the time being, or close it and create another more specific one to tackle later?

We can update the page as things progress. We have a pretty good help page for now.