Tsilly / spree_globalize

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

Spree Globalize

Build Status Code Climate

This is the globalization project extracted from spree_i18n for Spree Commerce version 3.1+.

For previous Spree versions you can just use spree_i18n.

See the official Internationalization documentation for more details.

Happy translating!


Installation

Add the following to your Gemfile:

gem 'spree_globalize', github: 'spree-contrib/spree_globalize', branch: 'master'

Run bundle install

You can use the generator to install migrations and append spree_globalize assets to your app spree manifest file.

rails g spree_globalize:install

This will insert these lines into your spree manifest files:

vendor/assets/javascripts/spree/backend/all.js
//= require spree/backend/spree_globalize

vendor/assets/javascripts/spree/frontend/all.js
//= require spree/frontend/spree_globalize

vendor/assets/stylesheets/spree/frontend/all.css
*= require spree/frontend/spree_globalize

Model Translations

This feature uses the Globalize gem to localize model data. So far the following models are translatable:

Product, Promotion, OptionType, Taxonomy, Taxon, Property and ShippingMethod.

Start your server and you should see a TRANSLATIONS link or a flag icon on each admin section that supports this feature.

There are two configs that allow users to customize which locales should be displayed as options on the translation forms and which should be listed to customers on the frontend. You can set them on an initializer. e.g.

SpreeI18n::Config.available_locales = [:en, :es, :'pt-BR'] # displayed on frontend select box
SpreeGlobalize::Config.supported_locales = [:en, :'pt-BR'] # displayed on translation forms

NOTE for early adopters: Spree::Globalize namespace is now SpreeGlobalize

PS. Please use symbols, not strings. e.g. :'pt-BR' not just 'pt-BR'. Otherwise you may get unexpected errors

Or if you prefer they're also available on the admin UI general settings section.

Every record needs to have a translation. If by any chance you remove spree_globalize from your Gemfile, add some records and then add spree_globalize gem back you might get errors like undefined method for nilClass because Globalize will try fetch translations that do not exist.


Contributing

See corresponding guidelines


Copyright (c) 2010-2015 Spree Commerce Inc. and other contributors. released under the New BSD License

About

License:BSD 3-Clause "New" or "Revised" License


Languages

Language:Ruby 73.2%Language:HTML 20.7%Language:CoffeeScript 4.1%Language:CSS 1.9%Language:JavaScript 0.2%