Globalizing Rails–Railsconf edition

Transcript

1. Globalizing Rails Jeremy Voorhis Lead Architect, www.jvoorhis.com www.planetargon.com
2. What is Globalization? • Internationalization • Localization
3. Internationalization (i18n) • Preparation of software to be useful in multiple locales • Strings - dynamic and static • Bidirectional strings • Dates, times and numbers • is it 123,456.78 or 123.456,78?
4. Localization (L10n) • Providing translated content for a specific language • Implementing designs from right to left • Formatting dates, times and numbers for a specific region • Content that is sensitive to your audience’s culture
5. Locales • Operating definition: a combination of a language and a region • Can be identified with a locale tag • Globalize understands locales
6. Locale tags • Locale tags follow RFC 3066 • Language-Tag = Primary-subtag *( "-" Subtag ) Primary-subtag = 1*8ALPHA Subtag = 1*8(ALPHA / DIGIT) • Primary-subtag is an ISO 639 language code and should be lowercase • Subtag is typically an ISO 3166 country code and should be CAPITALIZED • Sometimes you have to wing it
7. Example productions • en-US • fr-CA • es-419
8. Unicode • Unpopular in Japan, and not natively supported by Ruby • Support available through jcode module • require ‘jcode’ $KCODE = ‘u’ • Your database must support unicode too!
9. What is Globalize? • A Rails plugin providing internationalization services to a Rails application • Model translations • View translations • Date and time translations and formatting • Number formatting
10. API • core extensions • String#t • String#/(number) • ActiveRecord macro • ActiveRecord::Base::translates
11. Getting started
12. Installing Globalize $ svn export http://svn.globalize-rails.org/svn/ globalize/globalize/branches/for-1.1 vendor/plugins/globalize $ rake globalize:setup
13. Setting the base language # config/environment.rb Globalize::Locale.set_base_language 'en-US'
14. Capturing locales # config/routes.rb map.connect ':locale/:controller/:action/:permalink'
15. Setting an active locale class ApplicationController < ActionController::Base before_filter :set_locale private def set_locale Locale.set params[:locale] rescue ArgumentError redirect_to params.merge( 'locale' => 'en-US' ) end end
16. Using model translations # Table "public.features" # Column | Type #-------------+----------------------------- # id | integer # headline | character varying(255) # abstract | text # body | text # permalink | text # created_at | timestamp without time zone # modified_at | timestamp without time zone class Feature < ActiveRecord::Base translates :headline, :abstract, :body end
17. Using view translations <%# GLobalize style %> <h2><%= 'FEATURES'.t -%></h2> <%# gettext style %> <h2><%= :features.t -%></h2>
18. Advanced techniques • Predicated blocks • Translation availability helper
19. The predicated block <% base_language_only do %> <%= link_to 'Destroy', { :action => 'destroy', :id => record.id }, { :post => true, :confirm => 'Are you sure?' } %> <% end %>
20. The predicated block defined def base_language_only yield if Locale.base? end def not_base_language yield unless Locale.base? end
21. Notify users when a translation is not available
22. A Translation Availability Helper <%= translation_availability_for :page, :body %> <%= markdown @page.body %>
23. Translation availability helper defined def translation_availability_for object_name, facet, message = nil not_base_language do message ||= content_tag 'p', '(Translation not available)'.t object = instance_variable_get "@#{object_name}" message if object and not object.send( facet ).blank? and object.send( "#{facet}_is_base?" ) end end
24. A gallery of practical interface design • Switching locales • Providing reference text • Bidirectional views • View translations
25. Make it easy for users to switch locales
26. Locale selector for public site
27. The same helper is used in the admin site
28. Translation interface with English reference
29. Base language administration screen params[:locale] # => ‘en-US’
30. Hide untranslated fields and provide a reference params[:locale] # => ‘zh-Hant’
31. Bidirectional views
32. English text is read left to right http://www.rashgash.co.il/en
33. Hebrew text is read right to left http://www.rashgash.co.il/
34. Make it easy for translators to update string literals in your views
35. Admin users can switch locales and update strings Translations provided by Google ;)
36. Globalize something • www.globalize-rails.org • Wiki • Mailing list • globalize.rubyforge.org • API Docs
37. Alternatives • Localization plugin • static text translation • Fluxiom • gettext • ubiquitous • interoperable
38. Acknowledgments • Joshua Harvey • Joshua Sierles • Per Wigren • Contributors!