Rename the plugin to "Pym.js Embeds" in most places.

Automattic / pym-shortcode

A WordPress solution to embed iframes that are responsive horizontally and vertically using the NPR Visuals Team's https://blog.apps.npr.org/pym.js/

https://wordpress.org/plugins/pym-shortcode/

GNU General Public License v2.0

14 stars 7 forks source link

Rename the plugin to "Pym.js Embeds" in most places. #42

Closed benlk closed 5 years ago

benlk commented 5 years ago

This name is chosen becuse it lacks the clunkiness of "shortcode and block".

In an email from Alyson Hurt, NPR Visuals Team member:

I'm afraid I don't know enough about WordPress and user/developer community expectations to be able to weigh in with an informed opinion on the naming question. All that said, your suggestion of "Pym.js embeds" gets around the shortcode vs. block question entirely and might be a reasonable way to go.

And that's good enough for me.

Resolves https://github.com/INN/pym-shortcode/issues/39

kaylima commented 5 years ago

@benlk is there a reason you're choosing "Pym.js embeds" instead of "Pym embeds" (sans the .js)?

benlk commented 5 years ago

I don't have a considered reason for choosing "Pym.js Embeds" over "Pym Embeds". Do you think "Pym Embeds" would be better?

benlk commented 5 years ago

Further thoughts:

Pym Embeds:

follows existing "Pym Shortcode" naming scheme
less awkward to say, saves two syllables
less-drastic rename
style guidelines for this plugin's docs are simpler, because we won't have conflicting presentations of "Pym.js" in "Pym.js Embeds" referring to the plugin vs "Pym.js" referring to the library.

Pym.js Embeds

Highlights that this is a JavaScript thing, setting the expectation that it's somewhat technical
Uses same branding as NPR's library, for better SEO

@alykat Does NPR have guidelines for Pym.js branding? The docs at http://blog.apps.npr.org/pym.js/ seem to use "Pym" and "Pym.js" and "pym.js" fairly interchangeably, notably calling users of the library "Pym users" in the 1.3.2 release note.

alykat commented 5 years ago

No formal guidelines on our end. We tend to use "Pym" as internal shorthand, but "pym.js" (capitalized or lowercase) is more precise, especially when addressing a broader audience that may not already know what it is.

benlk commented 5 years ago

Search results for "pym wordpress" and "pym.js wordpress" both have this plugin listed in the top 5 on DuckDuckGo and Google, so I'm not too concerned about SEO.

I agree with Aly's point that "Pym.js" is the more-precise name.