Skip to content

Use more consistent language and extended search - #2799

Merged
WorldLanguages merged 20 commits into
ScratchAddons:masterfrom
mxmou:consistent-language
Jul 28, 2021
Merged

Use more consistent language and extended search#2799
WorldLanguages merged 20 commits into
ScratchAddons:masterfrom
mxmou:consistent-language

Conversation

@mxmou

@mxmou mxmou commented Jun 16, 2021

Copy link
Copy Markdown
Member

Resolves #2243

Changes

  • Makes some addon names shorter (Change how the addon names are named #2764).
  • Changes most addon names to nouns (Change how the addon names are named #2764).
  • Changes addon names and descriptions to use consistent words for parts of Scratch, and generally specifies the locations of added UI features more accurately. Removes some unnecessary mentions of Scratch.
  • Enables extended search in fuse.js, mainly to allow things like searching for "record video" to get "video recorder". "Smart block switching" no longer works, but a better solution for that is telling users to remove some keywords and link words when there are no results. Note that different fields (name, description, ...) are searched separately, which is not ideal but it's how fuse.js currently works. I'm not sure if there is a good way to work around that.

No Title Case though. It would cause reading the list of addons to take longer because you stop for a moment at Each Capitalized Word.

Reason for changes

To make addon names and descriptions more consistent.

Tests

You can still search for the previous addon names and get results.

Comment thread addons/60fps/addon.json Outdated
Comment thread addons/account-settings-capitalize/addon.json Outdated
Comment thread addons/blocks2image/addon.json Outdated
Comment thread addons/blocks2image/addon.json Outdated
Comment thread addons/confirm-actions/addon.json Outdated
Comment thread addons/feature-unshared/addon.json Outdated
Comment thread addons/fix-uploaded-svgs/addon.json Outdated
Comment thread addons/initialise-sprite-position/addon.json Outdated
Comment thread addons/my-ocular/addon.json Outdated
Comment thread addons/studio-tools/addon.json Outdated
@apple502j apple502j added priority: 3 Medium priority. Includes bugs and useful features scope: addon Related to one or multiple addons scope: webpages Related to the web pages (settings page, pop-up, etc) labels Jun 17, 2021
Comment thread addons/2d-color-picker/addon.json Outdated
Comment thread addons/animated-thumb/addon.json
Comment thread addons/better-featured-project/addon.json Outdated
Comment thread addons/blocks2image/addon.json
Comment thread addons/comments-linebreaks/addon.json Outdated
Comment thread addons/confirm-actions/addon.json
Comment thread addons/discuss-button/addon.json
Comment thread addons/editor-stepping/addon.json Outdated
Comment thread addons/forum-quote-code-beautifier/addon.json Outdated
Comment thread addons/forum-time-zones/addon.json Outdated
Comment thread addons/bitmap-copy/addon.json Outdated
Comment thread addons/blocks2image/addon.json
Comment thread addons/curator-link/addon.json Outdated
Comment thread addons/drag-drop/addon.json
Comment thread addons/mute-project/addon.json Outdated
@cobaltt7

Copy link
Copy Markdown
Contributor

About the searching one field at a time bug, maybe you could make it search the addon textContent instead of any one field?

@mxmou

mxmou commented Jun 23, 2021

Copy link
Copy Markdown
Member Author

About the searching one field at a time bug, maybe you could make it search the addon textContent instead of any one field?

I did consider concatenating the fields, but that would make it impossible to assign different weights to individual fields. Maybe making name & description and English name & English description single fields would work.

@Hans5958

Hans5958 commented Jun 24, 2021

Copy link
Copy Markdown
Member

Is it possible for some names to just use the names made as the ID, such as editor-stepping has a name of just "Editor Stepping," with a proper description?

@mxmou

mxmou commented Jun 24, 2021

Copy link
Copy Markdown
Member Author

Is it possible for some names to just use the names made as the ID, such as editor-stepping has a name of just "Editor Stepping," with a proper description?

Many addon IDs contain the word "editor", which probably shouldn't be part of their names (with the exception of editor dark mode because website dark mode also exists).

@Hans5958

Copy link
Copy Markdown
Member

Many addon IDs contain the word "editor", which probably shouldn't be part of their names

Keep in mind that this not just limited to just editor. The addon remix-tree-button is shortened to just "Remix tree button," which is exactly what I wanted it to be.

About the exact case, I guess the "editor" is not used as a prefix for some addons and is an adjective that describes the word "stepping" (so a stepping feature in the editor), so I think this is valid.

Comment thread addons/load-extensions/addon.json Outdated
Comment thread addons/message-filters/addon.json Outdated
Comment thread addons/my-ocular/addon.json Outdated
@WorldLanguages

Copy link
Copy Markdown
Member

Okay, let's try to get this merged

If anyone disagrees with a change, it should be reverted and the addon name should stay as-is in master, possibly still with a verb in front. It doesn't make sense to block 90% of changes just because of confirm-actions, 60fps, my-ocular, and few others.

I personally don't like "confirmations" as an addon name but after reading it a bunch of times, it sounds decent.

I believe an addon with "integration" in its name needs to show the full domain of the service in the addon name, since the only purpose of the addon is to integrate that service and it must remain clear by reading the addon name. Addons that use ScratchDB to get data are not "integrations". my-ocular is the only addon whose single purpose is to integrate an external service. So the name for the ocular addon should be either Show ocular.jeffalo.net statuses and post reactions (current release and current master) or ocular.jeffalo.net integration. If you want ocular integration or anything else, open a new PR just for that.

@mxmou

mxmou commented Jul 24, 2021

Copy link
Copy Markdown
Member Author

I believe an addon with "integration" in its name needs to show the full domain of the service in the addon name, since the only purpose of the addon is to integrate that service and it must remain clear by reading the addon name. Addons that use ScratchDB to get data are not "integrations". my-ocular is the only addon whose single purpose is to integrate an external service. So the name for the ocular addon should be either Show ocular.jeffalo.net statuses and post reactions (current release and current master) or ocular.jeffalo.net integration. If you want ocular integration or anything else, open a new PR just for that.

Would adding a badge saying "Uses data from (my-)ocular.jeffalo.net" next to the addon name be a good alternative?

@WorldLanguages

Copy link
Copy Markdown
Member

Would adding a badge saying "Uses data from (my-)ocular.jeffalo.net" next to the addon name be a good alternative?

No. The addon is an integration. What's so wrong about putting the full domain in the addon name?
Honestly, I doubt this would be a thing to discuss if ocular had its own dedicated domain (not subdomain), and was simply ocular.gg integration, instead of the long ocular.jeffalo.net integration.

@Hans5958

Hans5958 commented Jul 25, 2021

Copy link
Copy Markdown
Member

If ScratchDB is listed anywhere without its full domain, what gives ocular can't do the same?

(Also probably ScratchStats)

@mxmou

mxmou commented Jul 25, 2021

Copy link
Copy Markdown
Member Author

Would adding a badge saying "Uses data from (my-)ocular.jeffalo.net" next to the addon name be a good alternative?

No. The addon is an integration. What's so wrong about putting the full domain in the addon name?
Honestly, I doubt this would be a thing to discuss if ocular had its own dedicated domain (not subdomain), and was simply ocular.gg integration, instead of the long ocular.jeffalo.net integration.

So an addon that changed the search bar to use Google would be called "google.com integration"? And the TurboWarp player "turbowarp.org integration"?

Addon names should be short, and using short names for things helps with that.

If ScratchDB is listed anywhere without its full domain, what gives ocular can't do the same?

(Also probably ScratchStats)

ScratchStats is actually called ScratchStats.com, so that's the correct way to refer to it. ScratchDB is just ScratchDB, and no addon name or description mentions scratchdb.lefty.one - I think it makes sense to always use the name, not the domain, of external websites when possible.

@Hans5958

Copy link
Copy Markdown
Member

I need to also point out that Jefallo's banners only wrote ocular as the standalone name. So, what gives?

@WorldLanguages

Copy link
Copy Markdown
Member

If ScratchDB is listed anywhere without its full domain, what gives ocular can't do the same?

(Also probably ScratchStats)

Those two are the first results on Google when searching for their name. "Ocular" is a word by itself and you'll probably get dictionary definitions and health related websites.
Also, no addon's main purpose is integrating ScratchDB (and none actually sends any server requests to ScratchStats.com)

@mxmou

mxmou commented Jul 26, 2021

Copy link
Copy Markdown
Member Author

Those two are the first results on Google when searching for their name. "Ocular" is a word by itself and you'll probably get dictionary definitions and health related websites.

That isn't a problem - the addon name doesn't have to tell everything and the full domain can be in the description.

@cobaltt7

cobaltt7 commented Jul 26, 2021 via email

Copy link
Copy Markdown
Contributor

@WorldLanguages

Copy link
Copy Markdown
Member

“Also, no addon's main purpose is integrating ScratchDB” what about the profile stats addon?

Well, call that an integration if you want, but data from ScratchDB is just data from Scratch which is then processed. The profile statistics addon is useful even if you're the only person in the world consuming ScratchDB, but ocular integration is useless if others don't see your statuses or reactions.

@mxmou

mxmou commented Jul 26, 2021

Copy link
Copy Markdown
Member Author

“Also, no addon's main purpose is integrating ScratchDB” what about the profile stats addon?

Well, call that an integration if you want, but data from ScratchDB is just data from Scratch which is then processed. The profile statistics addon is useful even if you're the only person in the world consuming ScratchDB, but ocular integration is useless if others don't see your statuses or reactions.

I don't think that changes how ocular needs to be referred to. It's called ocular, not ocular.jeffalo.net - even ocular (https://ocular.jeffalo.net/) integration would be better, but addon descriptions don't exist for no reason.

@Hans5958

Hans5958 commented Jul 27, 2021

Copy link
Copy Markdown
Member

Again, we should start shortening the names and put additional context on the description.

PS. Is there a verdict for the Alt+GreenFlag mess?


Additional edit

"Ocular" is a word by itself and you'll probably get dictionary definitions and health related websites.

This is done in the context of Scratch, so that does not quite matter. Again, Jeffalo advertises ocular as "ocular" inside the Scratch forums.

@mxmou

mxmou commented Jul 27, 2021

Copy link
Copy Markdown
Member Author

PS. Is there a verdict for the Alt+GreenFlag mess?

I decided to not change that addon when I made this PR because I thought #2784 would be merged, but it wasn't, so I'll change the name now (probably removing Alt+GreenFlag and adding "project").

@WorldLanguages
WorldLanguages merged commit 5c12df4 into ScratchAddons:master Jul 28, 2021
@WorldLanguages

Copy link
Copy Markdown
Member

One detail I didn't pay attention to before merging: do users know what block context menus are? The mention of right-clicking has been removed:

image

Also, using the feels weird here.

@mxmou

mxmou commented Jul 28, 2021

Copy link
Copy Markdown
Member Author

@WorldLanguages If using "context menu" is a problem, is "right click menu" better? Or "right click context menu"?

I think you're right about "the".

@WorldLanguages

Copy link
Copy Markdown
Member

Okay, so I suggest:

  1. Adding right click context menu to the "word dictionary" on addon manifest docs :P
  2. Remove "the" and use the 4 word term above

@Hans5958

Copy link
Copy Markdown
Member

Opened #3155 since there is no clear majority on that.

@mxmou
mxmou deleted the consistent-language branch July 29, 2021 15:56
@WorldLanguages

Copy link
Copy Markdown
Member

I also opened #3162 regarding "context menu"

@mxmou mxmou mentioned this pull request Feb 25, 2022
@Samq64 Samq64 mentioned this pull request Aug 23, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

priority: 3 Medium priority. Includes bugs and useful features scope: addon Related to one or multiple addons scope: webpages Related to the web pages (settings page, pop-up, etc)

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Use consistent names for parts of Scratch customizable block colors and custom block shape have inconsistent naming

7 participants