Snap icon indicating copy to clipboard operation
Snap copied to clipboard

Translations for help screens

Open manzanillo opened this issue 3 years ago • 2 comments

Hi all,

for teachers and learners new to Snap_!_, it would be pretty helpful to have translated help screens for each block. The current solution uses images, which are hard to translate. A proposed solution would utilize and render the help screen from some kind of (un)structured file format such as markdown/xml/json.

For didactic purposes, I think, the help blocks should always contain an example of how to use the block in context (which is true for a lot but not all of the help screens right now).

Best Stefan

manzanillo avatar May 27 '21 14:05 manzanillo

I think it should support JSDoc-like comments, that would also work with custom blocks' help menus Maybe something like

Logs the message provided to console
@param txt {text} what to log
@returns {nothing}
@example
log [Hello, world!] to console // this is ScratchBlocks
@author RubenVerg

etc

I'm working on a fork to support exactly that for custom blocks.

RubenVerg avatar May 27 '21 14:05 RubenVerg

We actually have the code for this already written! Right now it does the translation offline, but we're waiting to deploy it until it's modified to do the translation on the fly so that we don't have to include all the help screens for every language with the Snap! download.

brianharvey avatar May 27 '21 15:05 brianharvey