409a8f137ffa2a525f733fe9c1e8f1acb478232e
[pyhoca-gui.git] / README.i18n
1 Translating PyHoca-GUI
2 ======================
3
4 Translating with gettext
5 ------------------------
6
7 PyHoca-GUI uses gettext as translation service/mechanism (.po/.mo/.pot files).
8 The translation files can be found in the /po folder of this source project.
9
10
11 New team member --- new language for PyHoca-GUI
12 -----------------------------------------------
13 If you are a new member in the x2go-i18n team, the first we say is: WELCOME!!! and
14 THANKS!!! for the time you give to the X2Go project.
15
16 And, if you are new to the team and language files for the language you want to feel
17 responsible for do not yet exist, please subscribe to this mailing list first:
18
19   http://lists.berlios.de/mailman/listinfo/x2go-i18n 
20
21 Once you are subscribed, send an email to
22
23   x2go-i18n@lists.berlios.de
24
25 that explains your willingness to translate this-and-that language.
26
27 The developers will then provide a language file for you in the above mentioned /po
28 folder.
29
30
31 Git cloning
32 -----------
33 Next thing to do is to obtained the latest sources from X2Go Git.
34
35   $ # git needs to be installed, on Debian/Ubuntu this is
36   $ aptitude install git
37   $ # then checkout the code
38   $ git clone git://code.x2go.org/pyhoca-gui.git
39
40 In your current working directory there should now be a subfolder named ,,pyhoca-gui''.
41
42
43 Editing Your Language File
44 --------------------------
45 The recommended tool for editing gettext translation files is ,,poedit''
46
47   $ aptitude install poedit
48
49 Run poedit and configure it first (mostly personalizing, full name, email address, etc.).
50
51 Now open your language file in <current_dir>/pyhoca-gui/po/<lang>.po and edit it with
52 poedit.
53
54 NOTE: Make sure you translate all boldly marked items: non-translated as well as fuzzy
55 (i.e. inaccurate) items.
56
57
58 Testing i18n for development...
59 -------------------------------
60
61 First, install pyhoca-gui with all its dependency from our package repository
62 on your workplace/development machine.
63
64 For testing your translations of PyHoca-GUI you have to build the i18n files
65 with this command in PyHoca-GUI's base directory:
66
67   $ cd <current_dir>/pyhoca-gui
68   $ python setup.py build_i18n
69
70 If you system already runs with the locale (language setting) that you are
71 translating for then you simply have to start pyhoca-gui from the source base
72 folder:
73   
74   $ cd <current_dir>/pyhoca-gui
75   $ ./pyhoca-gui
76
77 Otherwise export the locale you translate for before you execute pyhoca-gui (e.g.
78 for testing the German translation):
79
80   $ export LANG=de_DE.UTF-8 pyhoca-gui
81
82
83 Sending in the Translation File
84 -------------------------------
85 When done, please send the complete translation file 
86
87   <current_dir>/pyhoca-gui/po/<lang>.po
88
89 to x2go-i18n@lists.berlios.de and remove your working copy of pyhoca-gui from
90 your system (or read how to use Git and keep the folder).
91
92
93 Other translation files for PyHoca-GUI:
94 ---------------------------------------
95 The NSIS installer also has some translatable strings. Please take a look at the
96 subfolder nsis_include/ in the PyHoca-GUI source tree.
97
98
99 Next time...
100 ------------
101 You will get informed on x2go-i18n if a translation update is necessary. So check
102 your mails there regularly.
103
104 For updating a translation, either keep the pyhoca-gui source project folder and
105 read more on Git by your self. 
106
107 Alternatively, just remove the folder (once you have sent in the translation file)
108 and start with this documentation all over again.
109
110 THANKS AGAIN FOR YOUR TIME!!!
111
112 light+love,
113 Mike Gabriel