Rails Locale Data Repository
Central point to collect locale data for use in Ruby on Rails.
Add to your Gemfile:
gem 'rails-i18n', '~> 5.0.0' # For 5.0.x gem 'rails-i18n', '~> 4.0.0' # For 4.0.x gem 'rails-i18n', '~> 3.0.0' # For 3.x gem 'rails-i18n', github: 'svenfuchs/rails-i18n', branch: 'master' # For 5.x gem 'rails-i18n', github: 'svenfuchs/rails-i18n', branch: 'rails-4-x' # For 4.x gem 'rails-i18n', github: 'svenfuchs/rails-i18n', branch: 'rails-3-x' # For 3.x
or run this command:
gem install rails-i18n -v '~> 5.0.0' # For 5.0.0 gem install rails-i18n -v '~> 4.0.0' # For 4.0.x gem install rails-i18n -v '~> 3.0.0' # For 3.x
Note that your rails version must be 3.0 or higher if you want to install
rails-i18n as a gem. For rails 2.x, install it manually as described below.
rails-i18n loads all locale files, pluralization and
transliteration rules available in the gem. This behaviour can be changed, if you
config/environments/* the locales which have to be loaded via
config.i18n.available_locales = ['es-CO', :de]
config.i18n.available_locales = :nl
Download the locale files that are found in the directory rails/locale and put them into the
config/locales directory of your Rails application.
If any translation doesn't suit well to the requirements of your application, edit them or add your own locale files.
For more information, visit Rails Internationalization (I18n) API on the RailsGuides.
Usage on Rails 2.3
Locale data whose structure is compatible with Rails 2.3 are available on the separate branch rails-2-3.
Available locales are:
af, ar, az, be, bg, bn, bs, ca, cs, cy, da, de, de-AT, de-CH, de-DE, el, en, en-AU, en-CA, en-GB, en-IE, en-IN, en-NZ, en-US, en-ZA, eo, es, es-419, es-AR, es-CL, es-CO, es-CR, es-EC, es-ES, es-MX, es-PA, es-PE, es-US, es-VE, et, eu, fa, fi, fr, fr-CA, fr-CH, fr-FR, gl, he, hi, hi-IN, hr, hu, id, is, it, it-CH, ja, ka, km, kn, ko, lb, lo, lt, lv, mk, ml, mn, mr-IN, ms, nb, ne, nl, nn, or, pa, pl, pt, pt-BR, rm, ro, ru, sk, sl, sq, sr, sw, ta, th, tl, tr, tt, ug, uk, ur, uz, vi, wo, zh-CN, zh-HK, zh-TW, zh-YUE
Complete locales are:
af, da, de, de-AT, de-CH, de-DE, en-US, es, es-419, es-AR, es-CL, es-CO, es-CR, es-EC, es-ES, es-MX, es-PA, es-PE, es-US, es-VE, et, fa, fr, fr-CA, fr-CH, fr-FR, id, ja, ka, ml, nb, nl, nn, pt-BR, sv, sv-SE, tr, zh-CN, zh-HK, zh-TW, zh-YUE
Currently, most locales are incomplete. Typically they lack the following keys:
We always welcome your contributions!
Some locales have the symbol of the currency (e.g.
€) under the key
while others have the code (e.g.
CHF). The value of the key depends on the widespread adoption of
the unicode currency symbols by fonts.
For example the Turkish Lira sign (
₺) was recently added in Unicode 6.2 and while most popular
fonts have a glyph, there are still many fonts that will not render the character correctly.
If you want to provide a different value, in a Rails app, you can create your own locale file under
config/locales/tr.yml and override the respective key:
tr: number: currency: format: unit: TL
How to contribute
If you are familiar with GitHub operations, follow the procedures described in the subsequent sections.
If you are not,
- Save your locale data on the Gist.
- Open an issue with reference to the Gist you created.
- Get a github account and Git program if you haven't. See Help.Github for instructions.
svenfuchs/rails-i18nrepository and clone it into your PC.
Create or edit your locale file
- Have a look in
rails/locale/en.yml, which should be used as the base of your translation.
- Create or edit your locale file. Please pay attention to save your files as UTF-8.
Test your locale file
Before committing and pushing your changes, test the integrity of your locale file.
bundle exec rake spec
Make sure you have included all translations with:
bundle exec rake i18n-spec:completeness rails/locale/en.yml rails/locale/YOUR_NEW_LOCALE.yml
You can list all complete and incomplete locales:
thor locales:complete thor locales:incomplete
Also, you can list all available locales:
You can list all missing keys:
i18n-tasks missing es
Add your locale name to the list in
README.md if it isn't there.
Send pull request
If you are ready, push the repository into the Github and send us a pull request.
We will do the formality check and publish it as quick as we can.
- i18n-country-translation for translations of country names
- i18n-spec for RSpec matchers to test your locale files
- iso for the list of valid language/region codes and their translations
Tsutomu Kuroda for untiringly taking care of this repository, issues and pull requests