Skip to content

Commit

Permalink
Moving translating info to separate page
Browse files Browse the repository at this point in the history
  • Loading branch information
Felienne authored Sep 15, 2021
1 parent 23d371d commit af398b0
Showing 1 changed file with 0 additions and 54 deletions.
54 changes: 0 additions & 54 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -1,57 +1,3 @@
Contributing to Hedy
======================

Hedy is now available in Dutch, French, English, Brazilian Portugese, Greek Mandarin, Hungarian and Spanish, but we'd love to support more languages!

Help Hedy with translations (easy, no programming needed!)
------------

The easiest way to translate Hedy is by using or translation UI website!

Simply go to https://www.hedycode.com/translate/en/new and translate our texts that are shown on the left in the boxes on the right. When you are done, you can use the three download button at the end of the page, and [send us the files](mailto:[email protected]).

![image](https://user-images.githubusercontent.com/1003685/116811756-3ed55f80-ab4b-11eb-881a-85677a30ef5e.png)

You can also use this interface to extend or repair existing translations, then you have to use the iso code of the langage that you want to work with in the url instead of new, f.e. https://www.hedycode.com/translate/en/es for Spanish. That will show the existing translated texts for you to update. After you have made changes again download the files and send them to us per email.


Help Hedy with translations (in the code base, some coding experience needed)
------------

If you would like to add a new translation, there are four places where files are located that need to be translated:

1) The folder [level-defaults](https://github.com/Felienne/hedy/blob/main/coursedata/level-defaults/) has a file for each language. That file controls what the landing page for each levels looks like. It is probably easiest to copy the [English file](https://github.com/Felienne/hedy/blob/main/coursedata/level-defaults/en.yaml), rename it and translate that. Tip: example variables can be translated too, that is probably helpful for learners!

2) In the folder [texts](https://github.com/Felienne/hedy/tree/main/coursedata/texts) there is a file for each language too. That file translate UI-elements like menu headers, and, important, the error messages Hedy programmers will see. As above, copying the [English file](https://github.com/Felienne/hedy/blob/main/coursedata/texts/en.yaml) and translate that.

3) The [folder](https://github.com/Felienne/hedy/tree/main/coursedata/adventures) that control the assignments kids see in the user interface for each of the levels. While not mandatory, the assignments in this section are of help for kids to better explore each level. If you do not translate them, the English version will be shown.

4) *optional* The folder [main](https://github.com/Felienne/hedy/tree/main/main) controls the web pages around Hedy. [start](https://github.com/Felienne/hedy/blob/main/main/start-en.md) holds the content of the start page, and there are page with press, contact info too. These do not necessariyl have to be translated, if you don't people will then see the English version, but kids can still program in their own native language.


Translated all of that?

Two more small things to do!

1) Add your language to the [menu](https://github.com/Felienne/hedy/blob/main/main/menu.json).

2) Now go to [app.py](https://github.com/Felienne/hedy/blob/main/app.py) and add your language to this list:

```
ALL_LANGUAGES = {
'en': 'English',
'nl': 'Nederlands',
'es': 'Español',
'fr': 'Français',
'pt_br': 'Português',
'de': 'Deutsch',
'it': 'Italiano'
}
```

In some places, we are missing translations to the existing language. You can find those locations as [issues](https://github.com/Felienne/hedy/issues?q=is%3Aissue+is%3Aopen+label%3A%22translation+needed%22)


Run Hedy code on your machine
------------

Expand Down

0 comments on commit af398b0

Please sign in to comment.