fix menu issue spotted by randomjunk
[rails.git] / vendor / plugins / rails-i18n / README.textile
1 h1. Rails Locale Data Repository
2
3 Central point to collect locale data for use in Ruby on Rails.
4
5 To contribute just send me a pull request, patch or plain text file. 
6
7 Please include a comment with the language/locale name and your name and email address (or other contact information like your github profile) to the locale file so people can come contact you and ask questions etc.
8
9 Also, please pay attention to save your files as UTF-8.
10
11 h2. Rails translations plugin
12
13 To include the translations of this repository into your application, simply install it as a plugin:
14
15 ./script/plugin install git://github.com/zargony/rails-i18n.git
16
17 The plugin will load Rails core translations of locales you are using in your app. (i.e. if you have en.yml, de.yml and fr.yml in config/locales, Rails core locales for :de and :fr are added). These translations are added to the I18n load path before application locales, so you can still override them in your application locales.
18
19 h2. Rails translations
20
21 Simple tool for testing the integrity of your key structure:
22
23 Make sure you have the Ruby I18n gem installed. If you haven't already you can try: 
24
25 sudo gem install svenfuchs-i18n -s http://gems.github.com
26
27 Then, standing in the root directory of this repository, do:
28
29 ruby test/structure.rb [your-locale]
30
31 Assuming that there is a file locale/[your-locale].{rb,yml} you will get a summary of missing and bogus keys as well as extra pluralization keys in your locale data.
32
33 h2. Rails I18n Textmate bundle
34
35 Still in a very experimental state but already helpful for me.
36
37 The bundle adds a single command: extract translation (shift-cmd-e)
38
39 # expects you to have a string selected (including single or double quotes)
40 # prompts you for a dot-separated key
41 # opens the file /log/translations.yml (creating it when not available)
42 # adds the translation (mapping the dot-separated key to nested yaml keys)
43 # replaces the selected string in your source-code with the dot-separated key wrapped into a call to t(your.key)
44
45 It currently expects that you're working with English views, so it uses :en as a locale in translation.yml.
46
47 Note that Textmate, while active, won't reload the translations.yml for you if it's already open. When you give the focus to another application and then go back to Textmate (e.g. with cmd-tab, cmd-tab) it will reload the file. I found it useful to have translations.yml open on a second monitor while extracting translations from my application.
48
49 I still have to figure out how to automatically select the next string after this command has run. It works well to just use Textmate's "Find Next" though:
50
51 # hit cmd-f and give it <code>("|').*(\1)</code> as a search expression, tell it to use this as a "Regular expression"
52 # hit return and it will select the next string
53 # use shift-cmd-e to extract that string
54 # hit cmd-g to select the next string
55