Skip to content

Commit 128f699

Browse files
authored
update the translate page (#4878)
1 parent f41343f commit 128f699

File tree

2 files changed

+53
-22
lines changed

2 files changed

+53
-22
lines changed
29.1 KB
Loading

docs/translate.md

Lines changed: 53 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -4,51 +4,82 @@
44

55
### ~ hint
66

7+
#### Help translate
8+
79
Looking to help translate the site for **[microbit.org](http://microbit.org)**? Try http://translate.microbit.org/ to help the Microbit Foundation!
810

911
### ~
1012

1113
## #target-files
1214

13-
The following lists provide a guide to which translation files and folders relate to the **MakeCode for @boardname@** editor. The links here are to the [English](https://crowdin.com/project/kindscript/en#) source files just to show you the location of the files in the folder structure. Of course, you will translate in your selected language instead.
15+
When you select your language from the [MakeCode](https://crowdin.com/project/makecode) project home page, you'll find all of the localization files for MakeCode shown in a folder tree. The strings to translate for the @boardname@ are found in the files under the **microbit** folder for the current language.
1416

15-
### Editor
17+
![microbit strings files](/static/mb/translate/crowdin-folder.png)
1618

17-
Files related to the editor:
18-
* [strings.json](https://crowdin.com/translate/kindscript/32/en-en) - Strings common and shared by all MakeCode editors
19+
Localization files are present in two different forms, JSON and markdown. The JSON files (those you see with the **.json** ending in their names) contain localizable strings related to both the editor UI and the text shown on the programming code blocks. All of the markdown files (those with **.md** at the end of their names) are documents for reference, projects, tutorials, help information, etc.
1920

20-
![strings.json file in Crowdin UI](/static/mb/translate/stringsfile.png)
21+
The files listed in the following sections provide a guide to how each of the translation files and folders relate to the **MakeCode for @boardname@** editor. The links here are to the [English](https://crowdin.com/project/kindscript/en#) source files just to show you the location of the files in the folder structure. Of course, you will translate in your selected language instead.
22+
23+
### Editor
2124

22-
* [target-strings.json](https://crowdin.com/translate/kindscript/1922/en-en) - Strings custom to the @boardname@ editor interface
25+
There a a few files that are specific to the MakeCode editor itself. These contain strings for the editor UI and the simulator. They are essential to translate and should be prioritized before the other files.
2326

24-
![target-strings.json file in Crowdin UI](/static/mb/translate/targetstringsfile.png)
27+
| File | Description |
28+
| - | - |
29+
| [strings.json](https://crowdin.com/translate/kindscript/32/en-en) | Common strings that shared by all MakeCode editors<br><br/>**Note**: This file is located at the MakeCode project's root folder<br/>rather than under **microbit** |
30+
| [target-strings.json](https://crowdin.com/translate/kindscript/1922/en-en) | Strings custom to the @boardname@ editor interface |
31+
| [sim-strings.json](https://crowdin.com/translate/makecode/1923/en-en) | Strings for the @boardname@ simulator |
32+
<br/>
2533

2634
This is an example of the editor with it's interface elements localized:
2735

2836
![Translated editor elements](/static/mb/translate/target-strings.jpg)
2937

3038
### Blocks
3139

32-
* [core-jsdoc-strings.json](https://crowdin.com/translate/kindscript/66/en-en) - Description text for code elements of the [basic](/reference/basic) and core [blocks](/blocks)
33-
* [core-strings.json](https://crowdin.com/translate/kindscript/65/en-en) - Display text for the [basic](/reference/basic) and core [blocks](/reference/blocks)
34-
* [radio-jsdoc-strings.json](https://crowdin.com/translate/kindscript/64/en-en) - Description text for code elements of the [radio](/reference/radio) blocks
35-
* [radio-strings.json](https://crowdin.com/translate/kindscript/63/en-en) - Display text for the [radio](/reference/radio) blocks
36-
* [radio-broadcast-jsdoc-strings.json](https://crowdin.com/translate/kindscript/5032/en-en) - Description text for code elements of the radio broadcast blocks
37-
* [radio-broadcast-strings.json](https://crowdin.com/translate/kindscript/5030/en-en) - Display text for the radio broadcast blocks
38-
* [servo-jsdoc-strings.json](https://crowdin.com/translate/kindscript/5036/en-en) - Description text for code elements of the [servo](/reference/servos) blocks
39-
* [servo-strings.json](https://crowdin.com/translate/kindscript/5034/en-ens) - Display text for the [servo](/reference/servos) blocks
40-
* [bluetooth-jsdoc-strings.json](https://crowdin.com/translate/kindscript/60/en-en) - Description text for code elements of the [bluetooth](/reference/bluetooth) blocks
41-
* [bluetooth-strings.json](https://crowdin.com/translate/kindscript/59/en-en) - Display text for the [bluetooth](/reference/bluetooth) blocks
42-
43-
![screenshot of library file in Crowdin UI](/static/mb/translate/libsfiles.png)
44-
45-
Here are some translated blocks:
40+
The strings for the programming code blocks all have names in the form of '_name_-strings.json' and '_name_-jsdoc-strings.json'. The _name_ part of the filename often refers to which set of blocks or the extension tht the blocks come from.
41+
42+
| File | Description |
43+
| - | - |
44+
| [core-jsdoc-strings.json](https://crowdin.com/translate/kindscript/66/en-en) | Description text for code elements of the [basic](/reference/basic) and core [blocks](/blocks)<br/><br/>**Note**: this file contains strings for the fundamental set of coding<br/>blocks and should be prioritized over the other strings files for blocks |
45+
| [core-strings.json](https://crowdin.com/translate/kindscript/65/en-en) | Display text for the [basic](/reference/basic) and core [blocks](/reference/blocks)<br/><br/>**Note**: this file contains strings for the fundamental set of coding<br/>blocks and should be prioritized over the other strings files for blocks |
46+
| [radio-jsdoc-strings.json](https://crowdin.com/translate/kindscript/64/en-en) | Description text for code elements of the [radio](/reference/radio) blocks |
47+
| [radio-strings.json](https://crowdin.com/translate/kindscript/63/en-en) | Display text for the [radio](/reference/radio) blocks |
48+
| [radio-broadcast-jsdoc-strings.json](https://crowdin.com/translate/kindscript/5032/en-en) | Description text for code elements of the radio broadcast blocks |
49+
| [radio-broadcast-strings.json](https://crowdin.com/translate/kindscript/5030/en-en) | Display text for the radio broadcast blocks |
50+
| [servo-jsdoc-strings.json](https://crowdin.com/translate/kindscript/5036/en-en) | Description text for code elements of the [servo](/reference/servos) blocks |
51+
| [servo-strings.json](https://crowdin.com/translate/kindscript/5034/en-ens) | Display text for the [servo](/reference/servos) blocks |
52+
| [bluetooth-jsdoc-strings.json](https://crowdin.com/translate/kindscript/60/en-en) | Description text for code elements of the [bluetooth](/reference/bluetooth) blocks
53+
| [bluetooth-strings.json](https://crowdin.com/translate/kindscript/59/en-en) | Display text for the [bluetooth](/reference/bluetooth) blocks |
54+
| [devices-jsdoc-strings.json](https://crowdin.com/translate/makecode/62/en-en) | Description text for code elements of the _connected devices_ blocks |
55+
| [devices-strings.json](https://crowdin.com/translate/makecode/61/en-en) | Display text for the _connected devices_ blocks |
56+
| [flashlog-jsdoc-strings.json](https://crowdin.com/translate/kindscript/60/en-en) | Description text for code elements of the _flashlog_ blocks |
57+
| [flashlog-strings.json](https://crowdin.com/translate/kindscript/59/en-en) | Display text for the _flashlog_ blocks |
58+
| [datalogger-jsdoc-strings.json](https://crowdin.com/translate/kindscript/11254/en-en) | Description text for code elements of the [datalogger](/reference/datalogger) blocks |
59+
| [datalogger-strings.json](https://crowdin.com/translate/kindscript/11252/en-en) | Display text for the [datalogger](/reference/datalogger) blocks |
60+
| [jacdac-jsdoc-strings.json](https://crowdin.com/translate/kindscript/7862/en-en) | Description text for code elements of the _jacdac_ blocks
61+
| [jacdac-strings.json](https://crowdin.com/translate/kindscript/7860/en-en) | Display text for the _jacdac_ blocks |
62+
| [color-jsdoc-strings.json](https://crowdin.com/translate/kindscript/11836/en-en) | Description text for code elements of the _color_ blocks
63+
| [color-strings.json](https://crowdin.com/translate/kindscript/11834/en-en) | Display text for the _color_ blocks |
64+
| [microphone-jsdoc-strings.json](https://crowdin.com/translate/kindscript/10230/en-en) | Description text for code elements of the _microphone_ blocks
65+
| [microphone-strings.json](https://crowdin.com/translate/kindscript/10228/en-en) | Display text for the _microphone_ blocks |
66+
| [settings-jsdoc-strings.json](https://crowdin.com/translate/kindscript/10872/en-en) | Description text for code elements of the _settings_ blocks
67+
| [settings-strings.json](https://crowdin.com/translate/kindscript/10870/en-en) | Display text for the _settings_ blocks |
68+
<br/>
69+
70+
Here are some examples of translated blocks:
4671

4772
![Translated block text](/static/mb/translate/block-text.jpg)
4873

4974
### Document pages
5075

51-
* [docs](https://crowdin.com/translate/kindscript/en#/microbit/docs) - Documentation pages for projects, courses, lessons, and code block reference
76+
Document pages contain the text for any markdown page available on the MakeCode editor site. These include code block reference, projects, tutorials, how to information, etc.
77+
78+
| File | Description |
79+
| - | - |
80+
| [docs](https://crowdin.com/translate/kindscript/en#/microbit/docs) | Documentation pages for projects, courses, lessons, and code block reference |
81+
| [libs](https://crowdin.com/translate/kindscript/en#/microbit/libs) | Documentation pages for code block reference and other information related to <br/> built-in extensions like _servo_ and _datalogger_ |
82+
<br/>
5283

5384
Here's an example of a translated document page for a course lesson:
5485

0 commit comments

Comments
 (0)