Fix grammar and wording - #4325
Conversation
Signed-off-by: RedGuy12 <paul@reid-family.org>
| Scratch Addons is a WebExtension (supports both Chrome and Firefox). Scratch Addons' mission is to combine all existing Scratch extensions, userscripts and userstyles into a single easy-to-access place, while still letting users choose which ones to enable. | ||
| Scratch Addons is a WebExtension supporting both Chrome and Firefox. Scratch Addons' mission is to combine all existing Scratch extensions, userscripts, and userstyles into a single easy-to-access place, while still letting users choose which ones to enable. | ||
|
|
||
| ### What's actually an "addon"? | ||
|
|
||
| An addon is similar to an extension or a userscript, but they use special APIs provided by the Scratch Addons extension. These APIs allow addons to run scripts on a Scratch page (userscripts), run scripts on the background (persistent scripts), or apply styles to the Scratch website (userstyles). | ||
| An addon is similar to an extension or a userscript, but they use special APIs provided by the Scratch Addons extension. These APIs allow addons to run scripts on a Scratch page (userscripts) or apply styles to the Scratch website (userstyles). | ||
|
|
||
| Userscripts and persistent scripts can use the `addon.*` JavaScript APIs, which allow them to obtain Scratch-related information (for example, get the current logged in user) and also use extension APIs (like sending notifications). | ||
| Userscripts can use the `addon.*` JavaScript APIs, which allow them to obtain Scratch-related information (for example, get the currently logged-in user) and also use extension APIs (like sending notifications). |
There was a problem hiding this comment.
FAQ has an open pr to make it less techy
There was a problem hiding this comment.
We should move this somewhere. The README is too long with it. The reason I put it on FAQ is so later we can remove it from the README.
There was a problem hiding this comment.
it's fine imo. there are many readmes that are way longer
There was a problem hiding this comment.
Those long README are those that don't have wiki or other types of documentation (see youtube-dl). We have exaustive amount of documentation but we put it on the README. If README can go simpler than I rather.
The README could be also used for advertisement like the website.
| { | ||
| "name": "Better emojis", | ||
| "description": "Replaces the emojis in comments on the website with improved vector designs.", | ||
| "name": "Vectorized emojis", |
There was a problem hiding this comment.
"Better" is very opinionated.
There was a problem hiding this comment.
"Vectorize" is not a word people use often.
There was a problem hiding this comment.
"Vector" is too technical. "HD emojis" or "High quality emojis" sound better.
There was a problem hiding this comment.
"High quality" would suggest that the design of the emojis isn't changed.
There was a problem hiding this comment.
so what do i do? for this and for material-forum-editor-buttons
There was a problem hiding this comment.
I think something like "Alternative emoji design" could be used for this one (and "alternative icons in forum post editor" for material-editor-buttons).
| { | ||
| "name": "Grab single block with Ctrl key", | ||
| "description": "Adds the ability to drag a single block out of the middle of a script (instead of the entire stack attached below it) while holding the Ctrl key.", | ||
| "name": "Single block grab", |
There was a problem hiding this comment.
but then its a verb
There was a problem hiding this comment.
Single block grabbing is a noun phrase?
| "name": "Enhanced full screen", | ||
| "description": "Fixes some undesired effects in the project player's full screen mode, opens it in your browser's full screen mode, and hides the green flag toolbar.", | ||
| "name": "Browse-native full screen", | ||
| "description": "Fixes some undesired effects in the project player's full screen mode, opens it in your browser's full screen mode, and/or hides the green flag toolbar.", |
| { | ||
| "name": "ocular integration", | ||
| "description": "Shows ocular statuses and forum post reactions. Uses my-ocular.jeffalo.net to obtain data.", | ||
| "description": "Shows ocular statuses and forum post reactions.", |
There was a problem hiding this comment.
| "description": "Shows ocular statuses and forum post reactions.", | |
| "description": "Shows ocular statuses and forum post reactions. Uses my-ocular.jeffalo.net to obtain data.", |
| { | ||
| "name": "Profile statistics", | ||
| "description": "Shows statistics from ScratchDB on user profiles.", | ||
| "description": "Shows statistics on user profiles.", |
There was a problem hiding this comment.
| "description": "Shows statistics on user profiles.", | |
| "description": "Shows statistics from ScratchDB on user profiles.", |
There was a problem hiding this comment.
Probably because he added it on the credits? I don't know, but it's better to expose it better.
Signed-off-by: RedGuy12 <paul@reid-family.org>
Signed-off-by: RedGuy12 <paul@reid-family.org>
| "name": "Hide Tutorials button", | ||
| "description": "Hides the Tutorials button in the editor menu bar.", | ||
| "name": "Hidden \"Tutorials\" button", | ||
| "description": "Hides the \"Tutorials\" button from the editor menu bar.", |
There was a problem hiding this comment.
Seems counterintuitive because in hindsight, it could imply something it just adds a hidden button (and we think like, why?), and not hide the button itself.
There was a problem hiding this comment.
This also applies to other "hide XYZ" addons.
| "name": "More links", | ||
| "description": "Adds links for URLs pointing outside scratch.mit.edu.", | ||
| "name": "More clickable links", | ||
| "description": "Makes URLs pointing outside scratch.mit.edu clickable.", |
There was a problem hiding this comment.
I suppose links are clickable in the first place?
There was a problem hiding this comment.
Yeah, "clickable" part is redundant.
mxmou
left a comment
There was a problem hiding this comment.
Descriptions of addons that allow something to be customized should probably begin with "allows you to change" and not "changes".
| }, | ||
| "scratchAddonsThemeDescription": { | ||
| "message": "This allows you to switch between light and dark themes for this settings page, and the extension's popup." | ||
| "message": "This allows you to switch between light and dark themes for this settings page and the extension's popup." |
There was a problem hiding this comment.
Could "extension popup" be used instead for consistency?
| { | ||
| "name": "Profile page banner", | ||
| "description": "Turns the featured project on any user's profile into a nice-looking banner.", | ||
| "description": "Turns the featured project on any user's profile into a larger banner.", |
| "name": "Better forum quoter", | ||
| "description": "Select text in a forum post and click quote in the bottom right corner to only quote the select text.", | ||
| "name": "Partial forum post quoter", | ||
| "description": "Allows you to only quote text you have selected when you press \"quote\", if there is text selected.", |
There was a problem hiding this comment.
Is "if there is text selected" necessary?
There was a problem hiding this comment.
Unnecessary IMO, it's obvious that you can't quote selected text if you select nothing.
There was a problem hiding this comment.
i went back on forth on this one, i didn't want it to sound like you can't quote anything without text selected
There was a problem hiding this comment.
I don't think it would sound like that. We don't remove features unless it explicitly says so.
| { | ||
| "type": "notice", | ||
| "text": "On macOS, use the Option key instead of the Alt key and Command key instead of the Control key.", | ||
| "text": "On macOS, use the \"Option\" key instead of the \"Alt\" key and \"Command\" key instead of the \"Ctrl\" key.", |
There was a problem hiding this comment.
| "text": "On macOS, use the \"Option\" key instead of the \"Alt\" key and \"Command\" key instead of the \"Ctrl\" key.", | |
| "text": "On macOS, use the \"Option\" key instead of the \"Alt\" key and \"Cmd\" key instead of the \"Ctrl\" key.", |
| { | ||
| "name": "Save blocks as image", | ||
| "description": "Right click the code area to export blocks as SVG/PNG images.", | ||
| "description": "Adds options to right-click menus to export blocks as SVG/PNG images.", |
There was a problem hiding this comment.
| "description": "Adds options to right-click menus to export blocks as SVG/PNG images.", | |
| "description": "Adds options to the code area right-click menu to export blocks as SVG/PNG images.", |
| "name": "Old studio layout", | ||
| "description": "Reverts the layout of the studio page back to the one used before the studio update or the one previously available as part of the Scratch 2.0 \u2192 3.0 addon.", | ||
| "name": "2.0 studio layout", | ||
| "description": "Reverts the layout of the studio page to look like Scratch 2.0 or how it looked using the \"Scratch 2.0 \u2192 3.0\" addon.", |
There was a problem hiding this comment.
Don't use "Scratch 2.0" to refer to 2.0-styled (scratchr2) pages.
| { | ||
| "name": "Paint costume by default", | ||
| "description": "Changes the default action of \"Choose a Sprite/Costume/Backdrop/Sound\" buttons, which open the library by default.", | ||
| "name": "\"Paint costume\" by default", |
There was a problem hiding this comment.
"Paint costume" is not the name of any Scratch feature, so it doesn't need quotes.
| { | ||
| "name": "Scratch Notifier", | ||
| "description": "Notifications on new Scratch messages. Click the notification to go straight to the message (comment, project, etc.)", | ||
| "description": "Receive notifications when you get new Scratch messages. Click the notification to go straight to the message (comment, project, etc.)", |
There was a problem hiding this comment.
You removed imperative from a lot of other addon descriptions - is it really appropriate here?
| "name": "YouTube full screen", | ||
| "description": "Enables the full screen button in Scratch's YouTube video player.", | ||
| "name": "YouTube fullscreen", | ||
| "description": "Enables the fullscreen button in Scratch's YouTube video player.", |
| "name": "True forums YouTube links", | ||
| "description": "Replaces links to the embedded site with real YouTube links.", | ||
| "description": "Replaces links to Scratch's YouTube embed page with real YouTube links.", |
There was a problem hiding this comment.
Should be consistent with youtube-fullscreen.
|
If we're changing capitalization and quotes, could #2799 (comment) be addressed fully? |
apple502j
left a comment
There was a problem hiding this comment.
Schema validation failures, word changes, and credit fixes (should not have prepositions)
| { | ||
| "name": "Do not shift pasted items", | ||
| "description": "Paste copied items at their original position instead of shifted slightly in the costume editor.", | ||
| "name": "Unshifted pasted items", |
There was a problem hiding this comment.
Old name is better; the addon does not "unshift", it just prevents it from shifting. (Same way people don't say "uneaten cake".)
| { | ||
| "name": "Extra key support", | ||
| "description": "Adds more keys to the \"key () pressed?\" and \"when () key pressed\" block dropdowns, such as enter, dot, comma, and more.", | ||
| "description": "Adds more keys to the \"key () pressed?\" and \"when () key pressed\" block dropdowns, such as \"Enter\", period (full stop), comma, and more.", |
There was a problem hiding this comment.
The letter is called "dot" in computing context, not "period" or "full stop", according to "en period wikipedia full stop com".
| { | ||
| "type": "warning", | ||
| "text": "The \"Shift keys\" include keys which typically require the Shift key and a number key, like hashtag, exclamation mark and more. These keys only work with the \"when () key pressed\" block and do not work on all operating systems or keyboard layouts.", | ||
| "text": "The \"Shift keys\" include keys which typically require the Shift key and a number key, like hashtag (pound) and exclamation point. These keys only work with the \"when () key pressed\" block and do not work on all operating systems or keyboard layouts.", |
There was a problem hiding this comment.
| "text": "The \"Shift keys\" include keys which typically require the Shift key and a number key, like hashtag (pound) and exclamation point. These keys only work with the \"when () key pressed\" block and do not work on all operating systems or keyboard layouts.", | |
| "text": "The \"Shift keys\" include keys which typically require the Shift key and a number key, like hashtag and exclamation point. These keys only work with the \"when () key pressed\" block and do not work on all operating systems or keyboard layouts.", |
"Pound" is often used to refer to £ sign.
| { | ||
| "name": "Do not automatically run duplicated blocks", | ||
| "description": "Fixes a bug in the Scratch editor, where duplicating a block and attaching it to a script causes the script to run.", | ||
| "name": "Not-automatically-ran duplicated blocks", |
There was a problem hiding this comment.
This is not German. Do not hyphenate words, it's okay not to nounify in this case.
| }, | ||
| { | ||
| "name": "ScratchDB", | ||
| "url": "http://scratchdb.lefty.one/v3/docs/", |
There was a problem hiding this comment.
| "url": "http://scratchdb.lefty.one/v3/docs/", | |
| "link": "https://scratchdb.lefty.one/v3/docs/", |
| }, | ||
| { | ||
| "name": "my-ocular.jeffalo.net", | ||
| "link": "https://ocular.jeffalo.net", |
There was a problem hiding this comment.
| "link": "https://ocular.jeffalo.net", | |
| "link": "https://ocular.jeffalo.net/", |
| { | ||
| "name": "my-ocular.jeffalo.net", | ||
| "link": "https://ocular.jeffalo.net", | ||
| "note": "to obtain data", |
There was a problem hiding this comment.
| "note": "to obtain data", | |
| "note": "data source", |
| { | ||
| "name": "ScratchDB", | ||
| "link": "http://scratchdb.lefty.one/v3/docs/", | ||
| "note": "for information", |
There was a problem hiding this comment.
| "note": "for information", | |
| "note": "statistics data", |
| { | ||
| "name": "ScratchDB", | ||
| "url": "http://scratchdb.lefty.one/v3/docs/", | ||
| "note": "for information", |
There was a problem hiding this comment.
| "note": "for information", | |
| "note": "search result", |
|
Use more consistent language 2: Electric Boogaloo |
Co-authored-by: apple502j <33279053+apple502j@users.noreply.github.com>
|
ok you can close this i can’t finish this
(i'd close it but i'm locked out of gh website)
|
|
@RedGuy12 You already closed this two months ago. |
|
i sent that two months ago why did it just now post |
|
Many weird notifications today - looks like some actions on the GitHub website took 2 months to reflect...? |
|
I have an unread ghost message from around that time too... |



also some stuff for consistency and remove opinionated stuff