Skip to content

Latest commit

 

History

History
134 lines (76 loc) · 4.49 KB

README.md

File metadata and controls

134 lines (76 loc) · 4.49 KB
Raw

Rails Locale Data Repository

Build Status

Central point to collect locale data for use in Ruby on Rails.

Gem installation

Add to your Gemfile:

gem 'rails-i18n'

or run this command:

gem install rails-i18n

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.

Configuration

By default rails-i18n loads all locale files, pluralization and transliteration rules available in the gem. This behaviour can be changed, if you specify in config/environments/* the locales which have to be loaded via I18n.available_locales option:

config.i18n.available_locales = ['es-CO', :de]

or

config.i18n.available_locales = :nl

Manual installation

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

Available locales are:

ar, az, bg, bn-IN, bs, ca, cs, csb, cy, da, de, de-AT, de-CH, dsb, el, en-AU, en-GB, en-IN, en-US, eo, es, es-AR, es-CL, es-CO, es-MX, es-PE, et, eu, fa, fi, fr, fr-CA, fr-CH, fur, gl-ES, gsw-CH, he, hi-IN, hr, hsb, hu, id, is, it, ja, kn, ko, lo, lt, lv, mk, mn, nb, nl, nn, pl, pt-BR, pt-PT, rm, ro, ru, sk, sl, sr, sr-Latn, sv-SE, sw, th, tr, uk, vi, zh-CN, zh-TW

Following locales are complete:

ar, az, bg, bs, ca, cs, csb, cy, da, de, de-AT, de-CH, el, en-AU, en-GB, en-US, eo, es, es-AR, es-CL, es-CO, es-MX, et, eu, fa, fi, fr, fr-CA, fr-CH, fur, gsw-CH, he, hi, hi-IN, hr, hu, is, it, ja, kn, ko, lv, mn, nb, nl, pl, pt-BR, pt-PT, ro, ru, sk, sv-SE, sw, th, uk, zh-CN, zh-TW

Following locales have some missing translations:

bn-IN, dsb, en-IN, es-PE, gl-ES, hsb, id, lo, lt, mk, nn, rm, sl, sr, sr-Latn, tr, vi

We always welcome your contributions!

How to contribute

Quick contribution

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.

Fetch the rails-18n repository

  • Get a github account and Git program if you haven't. See Help.Github for instructions.
  • Fork svenfuchs/rails-i18n repository and clone it into your PC.

Create or edit your locale file

  • Have a look in rails/locale/en-US.yml, which can be used as the base of your translation. Note that we use &errors_messages and <<: *errors_messages to anchor and merge a part of translation data.
  • 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.

rake spec

Make sure you have included all translations with:

rake i18n-spec:completeness rails/locale/en-US.yml rails/locale/YOUR_NEW_LOCALE.yml

You can list all complete locales:

thor locales:complete

Also, you can list all available locales:

thor locales:list

Edit README.md

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.

See also

License

MIT

Contributors

See https://github.com/svenfuchs/rails-i18n/contributors

Special thanks

Tsutomu Kuroda for untiringly taking care of this repository, issues and pull requests