Project

General

Profile

Translating » History » Version 15

Lukas Zapletal, 04/16/2013 08:29 AM

1 6 Lukas Zapletal
h1. Translating for contributors
2 1 Lukas Zapletal
3 7 Lukas Zapletal
h2. General tips
4
5
It is important not to change punctuation and whitespace. For example if the English string is "blah." it must be translated as "xyz." with the dot at the end. The same for an extra space - e.g. "blah " must be "xyz ". Although we try to eliminate all the extra spaces, there are rare cases where we need them. There is a checker (pofilter) which is executed regularly by developers to catch and fix all these types of mistakes. 
6
7
There are model names in the translation strings, you can get the full list here: https://github.com/lzap/foreman/blob/develop/locale/model_attributes.rb
8
9
These model names are in two formats: "Model name" (name of the database table) and "Modelname|Column name" for column name. Here are few examples how to translate them:
10
11
 _('Compute resource') -> "Compute Resource"
12
13
 _('ComputeResource|Description') -> "Description"
14
15
Several models have prefixes in the form something/ or Something:: - you can ignore these. Example:
16
17
 _('Audited/adapters/active record/audit') -> "Audit"
18
19
 _('Audited::Adapters::ActiveRecord::Audit|Associated name') -> "Associated Name"
20
21 6 Lukas Zapletal
h2. Using Transifex
22
23
Go to https://www.transifex.com/projects/p/foreman and register/login. Then you can use the Transifex interface to do all translations. The project on Transifex automatically updates when we add new strings into git. Foreman team regularly downloads new translations to the develop branch in git as well, therefore there is no action needed when you finish with translations. It will be pulled eventually (e.g. before the next release).
24
25
Read the tips bellow if you want to start translating now.
26 1 Lukas Zapletal
27 2 Lukas Zapletal
h2. Manually
28
29
If you prefer, you can edit PO files directly using your preferred editor. Please make sure the encoding of the files is UTF-8. It is also recommended to test your translations before submitting a Pull Request on the github using either:
30
31
  foreman# rake gettext:pack
32 1 Lukas Zapletal
33 2 Lukas Zapletal
or
34 1 Lukas Zapletal
35 7 Lukas Zapletal
  foreman# make -C locale check all-mo
36 2 Lukas Zapletal
37 1 Lukas Zapletal
The above command should not print any error message. Also you should start Foreman UI and see if your translations do fit (sometimes longer strings can wrap or even break the UI). If you start Foreman in the production mode, you need to do one of the above commands every time you change your translation. In the development mode, you only need to restart Foreman to see the changes.
38
39
More info about contributing your translation directly is on our [[Contribute]] wiki page. 
40
41 6 Lukas Zapletal
h1. Translating for developers
42 1 Lukas Zapletal
43 15 Lukas Zapletal
h2. Extracting strings
44
45
There are several rules to follow when marking strings for translations with _("") and similar functions:
46
47
 * To translate a string use _("My string")
48
 * To translate string with a parameter use _("String with param: %25s") %25 param
49
 * To translate string with more than one parameters do not use _("Params: %25s and %25s") %25 [param1, param2] which is translator-unfriendly
50
 * Therefore for more than one parameters use _("Params: %25{a} and %25{b}") %25 {:a => foo, :b => bar}
51
 * To mark something for translation (but not translate) use N_("String")
52
 * To use plural form use s_("One", "Two", number) - note this function always accepts three parameters as the base language is usually English but translators are able to define as many plural forms as they need.
53
 * Do not break strings with newlines because then the strings have many whitespace and it looks confusing for translators like "blah    \\n     blah". If you must separate string on several lines, you can use HEREDOC or you can contatenate strings like "line1" + "line2" because Ruby Gettext detects them both.
54
 * If you want to leave a note to the translator, just drop a comment before the string in the format of # TRANSLATORS: your comment here
55
 * Note that all HEREDOC strings are automatically extracted, when adding API documentation descriptions via HEREDOC, leave a message to translators not to translate these (API documentation will not be translated at the moment).
56
 * Strings get extracted into ./locale/foreman.pot file, model and column names are in ./locale/model_attributes.rb
57
 * Additional Rails strings are in ./config/locale - there is a script to update those from Rails I18N git (branch 3-x).
58
 * For more info go here: http://www.yotabanana.com/hiki/ruby-gettext-howto.html
59
60
From time to time it is good to extract strings and update translations with incoming strings, so translators are able to work on them. We usually do this before releases, but it is good idea to do this on a weekly/monthly basis. For string extractions, please *do not* use rake gettext:find but use
61
62
  foreman# rake locale:find
63
64
because it also extracts model names and columns and filters them plus it adds some notes to translators (see locale:find_model rake task).
65
66
h2. Generating gettext translate tables
67
68
For production environment, you need to compile PO files into binary translate tables (MO files). This is *not needed* for development or test environments as in these modes Foreman reads PO files directly.
69
70
To generate gettext MO files, you can do either
71
72
  foreman# rake gettext:pack
73
74
or
75
76
  foreman# make -C locale
77
78
Both tools generate the same result, the latter is a bit faster and allows additional checks (see locale/Makefile targets). If you install from distribution packages, you do not need to run this because everything has been pre-compiled already.
79
80 8 Lukas Zapletal
h2. Adding new language
81 6 Lukas Zapletal
82 2 Lukas Zapletal
Adding new language into Foreman is easy. You need to take two steps - first of all create new gettext PO file as a copy from POT and edit the header (at least set plural configuration):
83 12 Lukas Zapletal
84 3 Lukas Zapletal
  # cp locale/foreman.pot locale/xx/foreman.po
85 6 Lukas Zapletal
  # vim locale/xx/foreman.po
86
87 1 Lukas Zapletal
Then pull Rails translation strings from upstream 3-x branch:
88 12 Lukas Zapletal
89
  # cd config/locale
90
  # touch xx.yml
91
  # ./update.sh
92
93
And add the language to Transifex and Zanata using their web interfaces.
94 2 Lukas Zapletal
95 6 Lukas Zapletal
h2. How to pull translations
96 1 Lukas Zapletal
97 4 Lukas Zapletal
To get updated translations from Transifex you will need account there (https://www.transifex.com) and the tx cli tool.
98
99
On Fedora:
100
101
  # yum -y install transifex-client gettext make intltool
102
103
On Debian:
104
105
  # apt-get install transifex-client gettext make intltool-debian
106
107
Then configure your account:
108
109
  $ cat ~/.transifexrc
110
  [https://www.transifex.net]
111
  hostname = https://www.transifex.net
112
  username = <your_username>
113
  password = <your_password>
114
  token = <should be empty>
115
116
And then prepare new topic branch (because the following command will make new commits to your git repo):
117
118
  git checkout -b update-translations
119
120
Finally do the translation pull
121
122
  make -C locale tx-update
123
124
And then you can push changes.
125
126
  git push ...
127 9 Lukas Zapletal
128
h2. Not translated
129
130
Some parts are (yet) not translated. These include:
131
132 10 Lukas Zapletal
 * all JavaScript resources (components etc)
133 9 Lukas Zapletal
 * permission names
134
 * predefined role names
135
 * predefined user names
136
 * descriptions of settings
137 11 Dominic Cleal
 * default bookmark names (active, disabled etc)
138
 * INTERNAL auth method
139 13 Lukas Zapletal
 * audit entries
140 14 Dominic Cleal
 * will_paginate (Dom working on this)
141 10 Lukas Zapletal
142
Some items from the list above will never be translated due to technical reasons or to avoid confusion.