Localization Guidelines

Localization Guidelines

• Create a Fat Free CRM fork by visiting the Github project page and clicking the fork button. This will fork (copy) the main repository to your github account. Clone your forked repository to your computer by typing:

$ git clone [email protected]:{your-username}/fat_free_crm.git

• Follow the Fat Free CRM installation instructions.

Once you have it up and running take a look at locale files in config/locales directory. Each translation consists of two files: {locale}.yml containing Ruby on Rails message translations as maintained by "rails-i18n project":http://github.com/svenfuchs/rails-i18n, and {locale}_fat_free_crm.yml file that stores all Fat Free CRM-specific messages; this is the one that requires translation.

• Start by copying US/English locale file, for example:

  $ cp config/locale/en-US_fat_free_crm.yml config/locale/fi_fat_free_crm.yml

• Change first two lines in your new {locale}_fat_free_crm.yml file to specify your locale and language names, then proceed with translating individual messages.

• To test your translation change Language option on User's Profile page. Fat Free CRM should reload the page with currently selected language. To change default language setting, add or edit the @:locale@ key in config/settings.yml, then restart your server.

• To commit your changes and push them to Github do the following:

$ git status $ git diff $ git add . $ git commit -a -m "Translated to {language}" $ git push

• Send a pull request to merge your translation into the master branch.