Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Rename <mm-app> to <mapml-viewer> #104

Closed
Malvoz opened this issue Jun 13, 2020 · 7 comments · Fixed by #137
Closed

Rename <mm-app> to <mapml-viewer> #104

Malvoz opened this issue Jun 13, 2020 · 7 comments · Fixed by #137
Assignees

Comments

@Malvoz
Copy link
Member

Malvoz commented Jun 13, 2020

<mm-mapp> is hard to remember, and it isn't self-descriptive. I see from the commit messages in #91 that the intention was initially <mm-app>, which was later supposed to be changed to <mm-map>, but was actually changed to <mm-mapp> (notably https://geogratis.gc.ca/mapml/ still uses <mm-app>).

Can we settle on something more descriptive, that is easier to remember, and maybe more attractive to developers?
Perhaps <map-embed> or <map-viewer>?

A <map-> autonomous custom element may also an option(?), but perhaps it's best to have something more distinguishable from <map>.

@Malvoz
Copy link
Member Author

Malvoz commented Jul 30, 2020

@prushforth what's your opinion on this?

I suspect I haven't been clear enough on the severity of the accessibility issue of the built-in <map> component, and it is my opinion that it would be ethically irresponsible to promote any usage of <map> at this point. The issue (in Chrome at least) is the equivalence to blind users what <map style="display: none"> is to sighted users.

I suggest we update the README.md to include instructions and example code using <mm-mapp> (hence why I'm eager for a name change) with a note that it is the goal to have the same capabilities ported to <map>.

@prushforth
Copy link
Member

OK sorry it's taken so long to address. I am willing but believe that the porting to <map> will get forgotten or discounted.

@prushforth
Copy link
Member

@Malvoz certain influential parties have recently dumped on the whole MapML project. In consequence, I would prefer to name the custom element mapml-viewer, because I have put my guts into this one. Would you be ok with that?

@Malvoz
Copy link
Member Author

Malvoz commented Jul 31, 2020

I am willing but believe that the porting to <map> will get forgotten or discounted.

In worst case scenario, we still have a beautiful map component that is easy to use for developers.

certain influential parties have recently dumped on the whole MapML project.

Interesting, it doesn't come as a total surprise, I'd like to learn more about their reasonings. Don't think we should be discouraged.

I would prefer to name the custom element mapml-viewer, because I have put my guts into this one. Would you be ok with that?

Yes.

@prushforth
Copy link
Member

Interesting, it doesn't come as a total surprise, I'd like to learn more about their reasonings. Don't think we should be discouraged.

Thanks for your support, it means a lot.

Their reasoning is here

@prushforth
Copy link
Member

mapml-viewer it is. Ahmad, let's rename the dorkily-named mm-app to mapml-viewer, and show it some love in tests etc moving forward. Once complete, I will proceed to update geogratis with the new viewer, which is a non-trivial task.

@prushforth
Copy link
Member

We should focus our demo / index page usage on mapml-viewer. We'll keep web-map around and maintained to some degree for reference and future discussion.

@prushforth prushforth changed the title Can we settle on something better than <mm-mapp>? Rename <mm-app> to <mapml-viewer> Aug 11, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging a pull request may close this issue.

3 participants