1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
|
<?xml version='1.0'?>
<!DOCTYPE book PUBLIC '-//OASIS//DTD DocBook XML V4.3//EN'
'http://www.oasis-open.org/docbook/xml/4.3/docbookx.dtd'
[
<!ENTITY % local.common.attrib "xmlns:xi CDATA #FIXED 'http://www.w3.org/2003/XInclude'">
]>
<chapter id="xlet-translating">
<title>Translating applets</title>
<sect2>
<title>Prepare translation function</title>
<para>
Make sure the following two lines are imported in your <code>applet.js</code> file:
</para>
<informalexample>
<programlisting>
const GLib = imports.gi.GLib;
const Gettext = imports.gettext;
</programlisting>
</informalexample>
<para>
Add the following lines to your applet before <code>function MyApplet(...)</code>:
</para>
<informalexample>
<programlisting>
// l10n/translation support
const UUID = "yourApplet@You";
Gettext.bindtextdomain(UUID, GLib.get_home_dir() + "/.local/share/locale");
function _(str) {
return Gettext.dgettext(UUID, str);
}
function MyApplet(metadata, orientation, panelHeight, instance_id) {
......
</programlisting>
</informalexample>
<para>
And don't forget to change the <code>const UUID</code> above to your applets UUID.
</para>
</sect2>
<sect2>
<title>Prepare translatable strings</title>
<para>
Every String in <code>applet.js</code> you want to be translated, needs to be put in brackets with underscore <code>_("")</code>, for example
</para>
<informalexample>
<programlisting>
_("This is a text, which needs to be translated")
</programlisting>
</informalexample>
</sect2>
<sect2>
<title>Create translation template for the first time</title>
<itemizedlist>
<listitem>
Create a directory called <code>po</code> in the directory of your applet, where the <code>metadata.json</code> file is saved.
</listitem>
<listitem>
Open a terminal in the directory where the <code>metadata.json</code> file is saved.
</listitem>
<listitem>
Type in the command <code>cinnamon-xlet-makepot</code>
</listitem>
</itemizedlist>
<para>
The command creates a translation template file <code>yourApplet.pot</code> in the <code>po</code> directory.
</para>
</sect2>
<sect2>
<title>Create a translation for the first time with the application Poedit</title>
<para>
Install the program "Poedit": <code>sudo apt install poedit</code>
</para>
<itemizedlist>
<listitem>
Open Poedit and click on <code>Create new translation</code>.
</listitem>
<listitem>
Open the file <code>yourApplet.pot</code>.
</listitem>
<listitem>
Once the file is loaded, Poedit will ask you to choose a language for the translation.
</listitem>
<listitem>
At this point, the <code>.po</code> file can be saved and the name will automatically reflect the locale code.
</listitem>
<listitem>
Poedit usage is pretty much straight forward:
<itemizedlist>
<listitem>
There is the Source text box that contains the string to be translated (usually in English).
</listitem>
<listitem>
There is the Translation box that will contain the translated text.
</listitem>
<listitem>
If there is a <code>.mo</code> file saved, when you save your <code>.po</code> file, the <code>.mo</code> file should be deleted. You could also disable MO files creation from Poedit preferences (go to Edit > Preferences > General tab and uncheck the option called <code>Automatically compile MO file when saving</code>).
</listitem>
</itemizedlist>
</listitem>
</itemizedlist>
</sect2>
<sect2>
<title>Update an existing translation template</title>
<itemizedlist>
<listitem>
Open a terminal in the directory where the <code>metadata.json</code> file is saved.
</listitem>
<listitem>
Type in the command <code>cinnamon-xlet-makepot</code>
</listitem>
</itemizedlist>
<para>
The command overwrites yours translation template file <code>yourApplet.pot</code> in the <code>po</code> directory.
</para>
</sect2>
<sect2>
<title>Updating an existing translation file</title>
<itemizedlist>
<listitem>
Open the <code>.po</code> file with Poedit.
</listitem>
<listitem>
Go to the menu <code>Catalog</code> and choose the <code>Update from POT file...</code> menu item.
</listitem>
<listitem>
Select <code>yourApplet.pot</code> file from which your <code>.po</code> file was based on.
</listitem>
<listitem>
Translate the new untranslated strings and save the changes.
</listitem>
</itemizedlist>
</sect2>
<sect2>
<title>Testing your translations</title>
<para>
The translations will be installed automatically, when the applet is installed through <code>System Settings > Applets > Applet available (online)</code>.
</para>
<para>
If you have installed your applet manually and you want to test your translations:
</para>
<itemizedlist>
<listitem>
Open a terminal in the directory where the <code>metadata.json</code> file is saved.
</listitem>
<listitem>
Type in the command <code>cinnamon-xlet-makepot -i</code> to install the existing translations (i.e. the <code>.po</code> files)
</listitem>
<listitem>
Restart Cinnamon: <code>CTRL+ALT+ESC</code>
</listitem>
</itemizedlist>
<para>
If you want to remove your translations manually:
</para>
<itemizedlist>
<listitem>
Open a terminal in the directory where the <code>metadata.json</code> file is saved.
</listitem>
<listitem>
Type in the command <code>cinnamon-xlet-makepot -r</code> to remove the installed translations.
</listitem>
<listitem>
Restart Cinnamon: <code>CTRL+ALT+ESC</code>
</listitem>
</itemizedlist>
</sect2>
</chapter>
|
