Page MenuHomePhabricator

Update mw:Help:Extension:Kartographer/Icons with maki 7.0.0
Closed, ResolvedPublic5 Estimated Story Points

Description

Task

Update the section "List of icons" on this help page on mediawiki.org so that it reflects the 7.0.0 maki icon set (comparison maki icons 0.5.0 vs. 7.0.0):

  • Create copy of page at beta cluster with new icons. --> https://de.wikipedia.beta.wmflabs.org/wiki/Hilfe:Extension:Kartographer/Icons
  • Add new icons: Upload new icons to wiki commons. --> T315228
  • update all visuals & update the label names where needed --> we are using a template that would only need an updated icons list
  • remove the sentence: Wikimedia uses an old version of Maki, specifically version 0.5.0 (See task T141304).
  • Document how the deprecated icon names are aliased to newer icons --> We will not display the alternative titles of the maki icons in the table, but link to the overview: https://meta.wikimedia.org/wiki/WMDE_Technical_Wishes/Geoinformation#Update_maki_icons.
  • We will not translate the icon names, but will make sure users can add translations on their own. --> Templates used with subst.
  • Remove old list of icons from template before announcing the changes so nobody accidentally copies over the old data.
  • Ping a translation admin (e.g. our own Adam) to update the page if needed

We can prepare this change and sync the "deploy" of it with the feature itself. When the icons are part fo the code ( T302861 ) they will still not be live until we manualy deploy that new version. The wikipage could also be worked on in our user namespace and then we copy it over when we deploy the code.

Dates

Ideally, we would update the icons on the help page shortly before the deployment. Reason: We want to announce the change in Tech News before the deployment, and there, I'd link to that page so people see what it is about.

The page should be updated before TDB – that's when ComCom plans to announce the icon update on Tech News.

Test page (for review)

https://de.wikipedia.beta.wmflabs.org/wiki/Hilfe:Extension:Kartographer/Icons

Technical implementation (for tech review)

We wrote a lua script that creates a map and a table with all the maki icons. Decided against the old overview because that was not responsive.

We are using the script to create the wikitext (via subst) and add that to the help page. This way users can easily adapt the table with e.g. descriptions and translations. We are adding the link to the script on the page for documentation.

We made the icon name validation more relaxed so that new icon names containing numbers and upper case letters are working (patch).

Event Timeline

Lena_WMDE set the point value for this task to 5.Jul 13 2022, 12:31 PM

We've created a POC Lua template to generate the grid. Could also do something similar for the wikitext table. The icon list should come from a json configuration page.

Module: https://www.mediawiki.org/wiki/Module:Sandbox/Adamw/Maki_icon_grid
Example usage: https://www.mediawiki.org/wiki/User:Adamw/Sandbox/Maki_grid_template

Once the test page and Lua module have been code-reviewed, we should put this task in Stalled and block on T302861 deployment to the beta cluster.

I would change the name of the template from Maki icon grid to Maki icon overview and the function name grid to map because the function creates a map that contains all the icons. The form could in theory also be something else than a grid.

current: {{#invoke:Maki icon grid|grid}}
my suggestion: {{#invoke:Maki icon overview|map}}

Would that work for you @awight?

I am also reconsidering your idea to use the maki version number as a parameter. It would make the switch easier. But is there a use case where we would need the old overview also after the update? 🤔

I changed the maki icon version to 7 to see if the commons files are fine. Since there are a few icon names in the list that do not have a representative at commons it looks like we mixed something up. I guess we should make sure we have the same icons at commons that we included in the code and then update the list in the lua script accordingly. 🤓

thiemowmde subscribed.

it looks like we mixed something up.

We did. See T315228#8198306 for details.

@ECohen_WMDE Can you suggest a nicer marker background color, or should we stick with the neutral default?

Also, we could use the "large" icons and put more space between grid points.

@ECohen_WMDE Can you suggest a nicer marker background color, or should we stick with the neutral default?

Good idea! Can you make them all Base20 or #54595d. Then they will still be neutral but will be easier to see. Thanks!

If it's not much effort, then large with more space would be nicer. Otherwise, it's alright to leave as is.

Nice! I think the color is looking good.

Is it possible to also space out the markers more? I think the larger size is nicer to look at the icons, but without the additional spacing it's a bit cramped. Would either add the space if possible, or otherwise go back to medium size.

Is it possible to also space out the markers more? I think the larger size is nicer to look at the icons, but without the additional spacing it's a bit cramped. Would either add the space if possible, or otherwise go back to medium size.

I've added some spacing and played around with width, height, and column count until it looks reasonable on my display.

I have a naive understanding of on-wiki topics, but I'd still recommend that we don't encourage subst—editors are capable of finding this themselves, and our template by no means requires this usage (the ones that are used with subst usually do *require* being used this way, for example because they add timestamps). I have some new thoughts about how to easily provide documentation, which I'll add to the Lua module.

An update about i18n: the listing table now accepts optional arguments which can be used to document icons. For example, a simple usage

{{Maki icon list}}

can include documentation by adding parameters like this:

{{Maki icon list
 | animal-shelter = Domestic animal medical and adoption center.
}}

Also, our table columns are not translatable. I realized that we should be including these as messages in the Kartographer extension.

Change 829750 had a related patch set uploaded (by Awight; author: Awight):

[mediawiki/extensions/Kartographer@master] Include messages used in Maki icon documentation

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

I've included some built-in documentation explaining how to use the Lua module, including how to add descriptions for icons if desired:
https://de.wikipedia.beta.wmflabs.org/wiki/Modul:Maki_icon_overview

Change 829750 merged by jenkins-bot:

[mediawiki/extensions/Kartographer@master] Include messages used in Maki icon documentation

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

Change 830881 had a related patch set uploaded (by Awight; author: Awight):

[mediawiki/extensions/Kartographer@master] Drop an unused message

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

Change 830881 merged by jenkins-bot:

[mediawiki/extensions/Kartographer@master] Drop an unused message

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

WMDE-Fisch moved this task from Demo to Done on the WMDE-TechWish-Sprint-2022-08-31 board.
WMDE-Fisch subscribed.

Review summary:
Test page looks good. Can be used in production when we deploy. One follow up issue with the icons not loading initially will be dealt with in a separate ticket.

Review summary:
Test page looks good. Can be used in production when we deploy. One follow up issue with the icons not loading initially will be dealt with in a separate ticket.

@WMDE-Fisch Should we reopen this task as long as https://www.mediawiki.org/wiki/Help:Extension:Kartographer/Icons has not been updated?

That update should be scheduled for Monday, Sept 19, in the morning.