Internalization: Add your local language

[aboullaite]

Is your feature request related to a problem? Please describe.

For more information about the translation process look at the official Flask-Babel documentation

By default, the bot interact with users with English. We can customize the user experience by adding support for i18n. If you're interested in adding support for a language, please follow the steps below:

Translate Greeting and Persistant Menu

1. Get your supported YOUR_LANGUAGE_CODE here

2. In the file profile.py add a new object related to your language in GREETINGS

GREETING = {
    "greeting": [
        {
            "locale": "default",
            "text": u'🙋🏽 Hi {{user_first_name}}! Click on the Get Started'
            ' button bellow to access Facebook DevC curated resources related'
            ' to Open Source 🔓.'
        },
        ...
        {
            "locale": "YOUR_LANGUAGE_CODE",
            "text": u'.....'
        }
    ]
}

3. then add a new entry for PERSISTENT_MENU

PERSISTENT_MENU = {
    "persistent_menu": [
        {
            "locale": "default",
            "composer_input_disabled": False,
            "call_to_actions": [
                {
                    "type": "postback",
                    "title": "🏁 Start Over",
                    "payload": "START"
                },
                {
                    "type": "postback",
                    "title": "🗄️ Main Menu",
                    "payload": "MAIN_MENU"
                },
                {
                    "type": "postback",
                    "title": "🔓 FB Open Source",
                    "payload": "FB_OS"
                }
            ]
        },
       ...
        {
            "locale": "YOUR_LANGUAGE_CODE",
            "composer_input_disabled": False,
            "call_to_actions": [
                {
                    "type": "postback",
                    "title": " 🏁 ....",
                    "payload": "START"
                },
                {
                    "type": "postback",
                    "title": "🗄️ ....",
                    "payload": "MAIN_MENU"
                },
                {
                    "type": "postback",
                    "title": "🔓 ....",
                    "payload": "FB_OS"
                }
            ]
        }
    ]
}

Update GREETINGS and PERSISTENT_MENU

For that use cURL like this

(venv) $ curl -X GET "<YOUR HOST>/webhook?hub.verify_token=<YOUR VERIFY TOKEN>&hub.challenge=CHALLENGE_ACCEPTED&hub.mode=subscribe&init_bot=true"

after that check the logs to see if all the request return success

Adding a new language

1. Determine the language code

The ISO 639-1 standard defines two-letter codes for languages. Find the two-letter codes of the language you want to add here.

Make sure your language is not already supported

(venv) $ ls src/locales/

2. Extract all the text in the chatbot

(venv) $ pybabel extract -F babel.cfg -k lazy_gettext -o locales/messages.pot .

3. Create .po file for your language (One-time only)
   .po translation files are generated from .pot template files using pybabel init.

(venv) $ pybabel init -i locales/messages.pot -d locales -l <LANGUAGE_CODE>

4. Add your translation manually or by using software like poedit
   got to the newly generated file and start i18n process. you can get inspired from src/locales/fr/LC_MESSAGES/messages.po

5. Compile .po file to .mo
   Compile your .po translation file by doing:

pybabel compile -d locales

6. Verify
   Make sure your Facebook account develop language is set to <LANGAUGE_CODE>. Run the app in your test environment, and verify that the bot answers you in your selected language

Updating an existing language

After a change in the code that affect the text, you have to do this process

1. Extract all the text in the chatbot

(venv) $ pybabel extract -F babel.cfg -k lazy_gettext -o locales/messages.pot .

2. Update the message.po files

(venv) $ pybabel update -i locales/messages.pot -d locales

3. Add your translation manually or by using software like poedit

After this you will have to translate the ../src/locales/<LANGUAGE_CODE>/LC_MESSAGES/messages.po

4. how to compile your new translation

(venv) $ pybabel compile -d locales

5. Verify
   Make sure your Facebook account develop language is set to <LANGAUGE_CODE>. Run the app in your test environment, and verify that the bot answers you in your selected language

[ChiragTutlani]

I will take up of translating it to hindi (ISO 639-1 code: hi).

[aboullaite]

Awesome @ChiragTutlani 🎉 please do not hesitate to reach oit if you need any assistance 👌

[elinguiuriel]

@ChiragTutlani I made an update to describe how to translate GREETINGS and PERSISTANT_MENU take a look here

[prilcool]

I added Simplified Chinese (zh-Hans) work in progress in the locales folder ,
Welcome to do a pull and continue translation while i'm asleep lol :)

[SrilalS]

Hi! I Would like to Take Translation to Sinhala (Code: si).

[vj-codes]

I would like to add German (code:de) translation!

[elinguiuriel]

I added Simplified Chinese (zh-Hans) work in progress in the locales folder ,
Welcome to do a pull and continue translation while i'm asleep lol :)

Are you a chinesse speaker ? Please only add a language if you are a native speaker.

[elinguiuriel]

I would like to add German (code:de) translation!

Are you a german speaker or do you know a good german speaker willing to help you ?

[elinguiuriel]

Hi! I Would like to Take Translation to Sinhala (Code: si).

Great, first make sure the langage is supporter https://developers.facebook.com/docs/messenger-platform/messenger-profile/supported-locales
are you a native speaker or that language, or Can you have help from a native speaker ?

[aboullaite]

@elinguiuriel being a native speaker is not necessary IMHO! Anyone who can correctly translate the messages is welcomed to open a PR as far is he's capable of completing it! Anyone who find issues on translation can submit improvements afterwards

[vj-codes]

I would like to add German (code:de) translation!

Are you a german speaker or do you know a good german speaker willing to help you ?

I'm a speaker , I know german as an additional language.If required I can ask a native speaker for PR review too. @elinguiuriel