Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with
or
.
Download ZIP
Newer
Older
100644 71 lines (40 sloc) 2.991 kB
ccdc033 @lifo Basic README
lifo authored
1 Tolk is a Rails engine designed to facilitate the translators doing the dirty work of translating your application to other languages.
be0c96e @dhh First init
authored
2
ccdc033 @lifo Basic README
lifo authored
3 * Installation & Setup
be0c96e @dhh First init
authored
4
ccdc033 @lifo Basic README
lifo authored
5 To install :
be0c96e @dhh First init
authored
6
ccdc033 @lifo Basic README
lifo authored
7 $ script/plugin install git://github.com/dhh/tolk.git
be0c96e @dhh First init
authored
8
ccdc033 @lifo Basic README
lifo authored
9 To setup :
be0c96e @dhh First init
authored
10
8675bd0 @lifo Improve README
lifo authored
11 1) Generate tolk migration and migrate your database :
a586d20 @lifo Add tolk_migration generator
lifo authored
12
13 $ script/generate tolk_migration
14 $ rake db:migrate
be0c96e @dhh First init
authored
15
8675bd0 @lifo Improve README
lifo authored
16 2) Setup Tolk assets by creating a symlink to tolk/public/tolk inside your application's public directory :
17
18 $ cd public
19 $ ln -s ../vendor/plugins/tolk/public/tolk tolk
20
21 And you're all set!
22
ccdc033 @lifo Basic README
lifo authored
23 * Usage
be0c96e @dhh First init
authored
24
8e7eb92 @lifo Fix the note about Locale.primary_locale_name in README
lifo authored
25 Tolk treats I18n.default_locale as the master source of strings to be translated. If you want the master source to be different from I18n.default_locale, you can override it by setting Tolk::Locale.primary_locale_name. Developers are expected to make all the changes to the master locale file ( en.yml by default ) and treat all the other locale.yml files as readonly files.
be0c96e @dhh First init
authored
26
ccdc033 @lifo Basic README
lifo authored
27 As tolk stores all the keys and translated strings in the database, you need to ask Tolk to update it's database from the primary yml file :
be0c96e @dhh First init
authored
28
ebd233c @lifo Tolk rake tasks
lifo authored
29 $ rake tolk:sync
ccdc033 @lifo Basic README
lifo authored
30
31 The above will fetch all the new keys from en.yml and put them in the database. Additionally, it'll also get rid of the deleted keys from the database and reflect updated translations - if any.
be0c96e @dhh First init
authored
32
86081dd @lifo Add a note about tolk:import in README
lifo authored
33 If you already have data in your non primary locale files, you will need to import those to Tolk as a one time thing :
34
35 $ rake tolk:import
36
c0c6fe2 @lifo Update the README
lifo authored
37 Upon visiting http://your_app.com/tolk - you will be presented with different options like creating new locale or providing translations for the existing locales. Once done with translating all the pending strings, you are can write back the new locales to filesystem :
be0c96e @dhh First init
authored
38
ebd233c @lifo Tolk rake tasks
lifo authored
39 $ rake tolk:dump_all
be0c96e @dhh First init
authored
40
6676379 @yaroslav RAILS_ROOT is deprecated, use Rails.root
yaroslav authored
41 This will generate yml files for all non primary locales and put them in #{Rails.root}/config/locales/ directory by default.
ebd233c @lifo Tolk rake tasks
lifo authored
42
43 You can use the dump_all method defined in Tolk::Locale directly and pass directory path as the argument if you want the generated files to be at a different location :
6b8bd68 @lifo More README
lifo authored
44
4bafade @lifo Implement authentication mechanism
lifo authored
45 $ script/runner "Tolk::Locale.dump_all('/Users/lifo')"
46
c0c6fe2 @lifo Update the README
lifo authored
47 You can even download the yml file using Tolk web interface by appending '.yml' to the locale url. E.g http://your_app.com/tolk/locales/de.yml
48
4bafade @lifo Implement authentication mechanism
lifo authored
49 * Authentication
50
51 If you want to authenticate users who can access Tolk, you need to provide <tt>Tolk::ApplicationController.authenticator</tt> proc. For example :
52
53 # config/initializers/tolk.rb
54 Tolk::ApplicationController.authenticator = proc {
55 authenticate_or_request_with_http_basic do |user_name, password|
56 user_name == 'translator' && password == 'transpass'
57 end
58 }
59
60 Authenticator proc will be run from a before filter in controller context.
4d16966 @lifo README: Handling blank and non-string values
lifo authored
61
62 * Handling blank and non-string values
63
64 Tolk speaks YAML for non strings values. If you want to enter a nil values, you could just enter '---'. Similarly, for an Array value, you could enter :
65
66 ---
67 - Sun
68 - Mon
69
70 And Tolk will take care of generating the appropriate entry in the YAML file.
Something went wrong with that request. Please try again.