Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with
or
.
Download ZIP
Newer
Older
100644 55 lines (31 sloc) 2.404 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
4bafade @lifo Implement authentication mechanism
lifo authored
25 Tolk treats <tt>Tolk::Locale.primary_locale_name</tt> as the main source of strings to be translated. Developers are expected to make all the changes to that file ( en.yml in our case ) 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
ef27fa6 @lifo Fix the README file w/ namespace changes
lifo authored
29 $ script/runner 'Tolk::Locale.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
c0c6fe2 @lifo Update the README
lifo authored
33 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
34
ef27fa6 @lifo Fix the README file w/ namespace changes
lifo authored
35 $ script/runner 'Tolk::Locale.dump_all'
be0c96e @dhh First init
authored
36
6b8bd68 @lifo More README
lifo authored
37 This will generate yml files for all non primary locales and put them in RAILS_ROOT/config/locales/ directory by default. You can pass directory path as the argument if you want the generated files to be at a different location :
38
4bafade @lifo Implement authentication mechanism
lifo authored
39 $ script/runner "Tolk::Locale.dump_all('/Users/lifo')"
40
c0c6fe2 @lifo Update the README
lifo authored
41 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
42
4bafade @lifo Implement authentication mechanism
lifo authored
43 * Authentication
44
45 If you want to authenticate users who can access Tolk, you need to provide <tt>Tolk::ApplicationController.authenticator</tt> proc. For example :
46
47 # config/initializers/tolk.rb
48 Tolk::ApplicationController.authenticator = proc {
49 authenticate_or_request_with_http_basic do |user_name, password|
50 user_name == 'translator' && password == 'transpass'
51 end
52 }
53
54 Authenticator proc will be run from a before filter in controller context.
Something went wrong with that request. Please try again.