Page MenuHomePhabricator

Change the tutorial to be a customizable message (instead of an image)
Closed, ResolvedPublic

Description

Currently the tutorial presented to the user in the first step has to be an image. That probably works for Wikimedia Commons, but is extremely troublesome for other smaller wikis that cannot afford the time and resources to design the tutorial properly. Additionally, any changes to the tutorial require the community to go through the hassle of updating the image, which is much slower than simply changing some wikitext. A much simpler approach would be to simply make an option for the tutorial to be just a piece of wikitext. That would also make the wizard more consistent with other upload methods, that always use MW messages to explain upload rules on the wiki.

We had this problem on Nonsensopedia (https://nonsa.pl/), in the end we hacked on the extension's code to load a message instead of an image (you can find a code diff here).

I propose removing the image-based tutorial and making it simply a piece of wikitext/system message. That would still allow for images to be used if someone really wanted to do that and would simplify the tutorial code greatly.

As for whether this solution works and fits in with the rest of the UI… it does, IMO:

image.png (923×986 px, 198 KB)

Event Timeline

Restricted Application added a subscriber: Aklapper. · View Herald Transcript

We'll probably want to migrate it to just be a standard message only, and if need be just move the images into the messages on commons. That way they can migrate to using the strings properly without actually losing anything...

Probably not worth doing from the start, though. That's apt to get messy.

Aklapper renamed this task from Make an option for the tutorial to be a customizable message to Make an option for the tutorial to be a customizable message (instead of an image).Jul 23 2019, 1:14 PM

On a second thought, my proposed solution isn't a very good one. The tutorial can be customized per-campaign and restricting it to a single MW message would mean losing that feature.

Instead the setting should let the user set any wikitext for the tutorial. This way they can transclude any template in the tutorial.

While trying to do this, I encountered a serious bug with how UploadWizard parses its configuration settings, I will have to fix that first. See task T228771 for details.

Change 525124 had a related patch set uploaded (by Ostrzyciel; owner: Ostrzyciel):
[mediawiki/extensions/UploadWizard@master] First attempt at making an option to use templates instead of images in the tutorial. Work in progress, has to wait for T228771 to be fixed.

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

Ostrzyciel renamed this task from Make an option for the tutorial to be a customizable message (instead of an image) to Change the tutorial to be a customizable message (instead of an image).Feb 16 2021, 5:18 PM
Ostrzyciel updated the task description. (Show Details)

Change 525124 abandoned by Ostrzyciel:
[mediawiki/extensions/UploadWizard@master] Make an option to use templates instead of images in the tutorial

Reason:
Will be moved to the MediaUploader extension

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

Change 671196 had a related patch set uploaded (by Ostrzyciel; owner: Ostrzyciel):
[mediawiki/extensions/MediaUploader@master] Change tutorial to be wikitext

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

Change 671196 merged by jenkins-bot:
[mediawiki/extensions/MediaUploader@master] Change the tutorial to be wikitext

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