diff --git a/lang/Add_new_language.md b/lang/Add_new_language.md index e69de29b..21121227 100644 --- a/lang/Add_new_language.md +++ b/lang/Add_new_language.md @@ -0,0 +1,173 @@ +# How-to add a new language to Prusa Firmware + +We will use Dutch as an example here. + +## Prepare Prusa Firmware + +YY = palceholder for language in upper case +yy = placehodler for language in lower case +AB = palceholder for hexadecial + +Files needs to be modified +- In `../Firmware/language.h` + + In section `/** @name Language codes (ISO639-1)*/` add the new `#define LANG_CODE_YY 0xABAB //!<'yy'`following ISO639-1 convention for YY. +https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes + + Example: + `#define LANG_CODE_NL 0x6e6c //!<'nl'` where the hex value `0x6e6c` is in ascii `nl` + +- In `../Firmware/language.c` + + In section `const char* lang_get_name_by_code(uint16_t code)` add `case LANG_CODE_NL: return _n("Language");` + + Example: + + `case LANG_CODE_NL: return _n("Nederlands");` Where `Language` is native spoken version, here `Nederlands` (Netherlands) or `Vlaams` (Belgium). This will be displayed on the LCD menu. + +- In `../lang/lang-add.sh` + + In section `cat lang_add.txt | sed 's/^/"/;s/$/"/' | while read new_s; do` add `insert_yy "$new_s" 'yy'`where yy + + Example: + `insert_yy "$new_s" 'nl'` with yy value `nl`for Dutch + +- In `../lang/lang-build.sh` + + In section `#returns hexadecial data for lang code` add a case `*yy*) echo '0xAB\0xAB'` + + Example: + `*nl*) echo '\x6c\x6e' ;;` !!! IMPORTANT that the hex values are switched so 'nl' is here in 'ln' !!! + + In generate "all" section add `generate_binary 'yy' + + Example: + `generate_binary 'nl'` + +- In `../lang/lang-check.py` + + Add in `help` the new language `yy` + + Example: + From `help="Check lang file (en|cs|de|es|fr|it|pl)")` to `help="Check lang file (en|cs|de|es|fr|nl|it|pl)")` + +- In `../lang/lang-clean.sh` + + In section echo `"lang-clean.sh started" >&2` add `clean_lang_yy` + + Example: + `clean_lang nl` + + +- In `../lang/lang-export.sh` + + In section `# if 'all' is selected, script will generate all po files and also pot file` add `./lang-export.sh yy` + + Example: + + `./lang-export.sh nl` + + In section ` # language name in english` add `*yy*) echo "Language-in-English" ;;` + + Example: + `*nl*) echo "Dutch" ;;` + + + + +- In `../lang/lang-import.sh` + + In section `#replace in languages translation` add new rule set for the language. + As the LCD screen doesn't not support äöüßéè and other special characters, it makes sense to "normalize" these. + + Example: + ``` + #replace in dutch translation according to https://nl.wikipedia.org/wiki/Accenttekens_in_de_Nederlandse_spelling +if [ "$LNG" = "nl" ]; then + #replace 'ë' with 'e' + sed -i 's/\xc3\xab/e/g' $LNG'_filtered.po' + #replace 'ï' with 'i' + sed -i 's/\xc3\xaf/i/g' $LNG'_filtered.po' + #replace 'é' with 'e' + sed -i 's/\xc3\xa9/e/g' $LNG'_filtered.po' + #replace 'è' with 'e' (left) + sed -i 's/\xc3\xa8/e/g' $LNG'_filtered.po' + #replace 'ö' with 'o' (left) + sed -i 's/\xc3\xb6/o/g' $LNG'_filtered.po' + #replace 'ê' with 'e' (left) + sed -i 's/\xc3\xaa/e/g' $LNG'_filtered.po' + #replace 'ü' with 'u' (left) + sed -i 's/\xc3\xbc/u/g' $LNG'_filtered.po' + #replace 'ç' with 'c' (left) + sed -i 's/\xc3\xa7/c/g' $LNG'_filtered.po' + #replace 'á' with 'a' (left) + sed -i 's/\xc3\xa1/a/g' $LNG'_filtered.po' + #replace 'à' with 'a' (left) + sed -i 's/\xc3\xa0/a/g' $LNG'_filtered.po' + #replace 'ä' with 'a' (left) + sed -i 's/\xc3\xa4/a/g' $LNG'_filtered.po' + #replace 'û' with 'u' (left) + sed -i 's/\xc3\xbc/u/g' $LNG'_filtered.po' + #replace 'î' with 'i' (left) + sed -i 's/\xc3\xae/i/g' $LNG'_filtered.po' + #replace 'í' with 'i' (left) + sed -i 's/\xc3\xad/i/g' $LNG'_filtered.po' + #replace 'ô' with 'o' (left) + sed -i 's/\xc3\xb4/o/g' $LNG'_filtered.po' + #replace 'ú' with 'u' (left) + sed -i 's/\xc3\xba/u/g' $LNG'_filtered.po' + #replace 'ñ' with 'n' (left) + sed -i 's/\xc3\xb1/n/g' $LNG'_filtered.po' + #replace 'â' with 'a' (left) + sed -i 's/\xc3\xa2/a/g' $LNG'_filtered.po' + #replace 'Å' with 'A' (left) + sed -i 's/\xc3\x85/A/g' $LNG'_filtered.po' +fi +``` + + +- In `../lang/fw-build.sh` + + In section `#update _SEC_LANG in binary file if language is selected` add + ``` + if [ -e lang_yy.bin ]; then + echo -n " Language-in-English : " >&2 + ./update_lang.sh yy 2>./update_lang_yy.out 1>/dev/null + if [ $? -eq 0 ]; then echo 'OK' >&2; else echo 'NG!' >&2; fi + fi + ``` + + Example: + ``` + if [ -e lang_nl.bin ]; then + echo -n " Dutch : " >&2 + ./update_lang.sh nl 2>./update_lang_nl.out 1>/dev/null + if [ $? -eq 0 ]; then echo 'OK' >&2; else echo 'NG!' >&2; fi + fi + ``` + + In section `#create binary file with all languages` add `if [ -e lang_yy.bin ]; then cat lang_yy.bin >> lang.bin; fi` + + Example: + `if [ -e lang_nl.bin ]; then cat lang_nl.bin >> lang.bin; fi` + +- In `../lang/fw-clean.sh` + + In section `echo "fw-clean.sh started" >&2` add ` + + ``` + rm_if_exists firmware_yy.hex + ... + ... + rm_if_exists update_lang_yy.out + ``` + + Example: + `rm_if_exists firmware_nl.hex` + and + `rm_if_exists update_lang_nl.out` + + +## Prepare language part + +## \ No newline at end of file