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
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
|
<HTML>
<HEAD>
<!-- This HTML file has been created by texi2html 1.52a
from gettext.texi on 24 April 2002 -->
<TITLE>GNU gettext utilities - 5 Creating a New PO File</TITLE>
</HEAD>
<BODY>
Go to the <A HREF="gettext_1.html">first</A>, <A HREF="gettext_4.html">previous</A>, <A HREF="gettext_6.html">next</A>, <A HREF="gettext_22.html">last</A> section, <A HREF="gettext_toc.html">table of contents</A>.
<P><HR><P>
<H1><A NAME="SEC29" HREF="gettext_toc.html#TOC29">5 Creating a New PO File</A></H1>
<P>
<A NAME="IDX210"></A>
</P>
<P>
When starting a new translation, the translator creates a file called
<TT>`<VAR>LANG</VAR>.po´</TT>, as a copy of the <TT>`<VAR>package</VAR>.pot´</TT> template
file with modifications in the initial comments (at the beginning of the file)
and in the header entry (the first entry, near the beginning of the file).
</P>
<P>
The easiest way to do so is by use of the <SAMP>`msginit´</SAMP> program.
For example:
</P>
<PRE>
$ cd <VAR>PACKAGE</VAR>-<VAR>VERSION</VAR>
$ cd po
$ msginit --verbose
</PRE>
<P>
The alternative way is to do the copy and modifications by hand.
To do so, the translator copies <TT>`<VAR>package</VAR>.pot´</TT> to
<TT>`<VAR>LANG</VAR>.po´</TT>. Then she modifies the initial comments and
the header entry of this file.
</P>
<H2><A NAME="SEC30" HREF="gettext_toc.html#TOC30">5.1 Invoking the <CODE>msginit</CODE> Program</A></H2>
<P>
<A NAME="IDX211"></A>
<A NAME="IDX212"></A>
<PRE>
msginit [<VAR>option</VAR>]
</PRE>
<P>
<A NAME="IDX213"></A>
<A NAME="IDX214"></A>
The <CODE>msginit</CODE> program creates a new PO file, initializing the meta
information with values from the user's environment.
</P>
<H3><A NAME="SEC31" HREF="gettext_toc.html#TOC31">5.1.1 Input file location</A></H3>
<DL COMPACT>
<DT><SAMP>`-i <VAR>inputfile</VAR>´</SAMP>
<DD>
<DT><SAMP>`--input=<VAR>inputfile</VAR>´</SAMP>
<DD>
<A NAME="IDX215"></A>
<A NAME="IDX216"></A>
Input POT file.
</DL>
<P>
If no <VAR>inputfile</VAR> is given, the current directory is searched for the
POT file. If it is <SAMP>`-´</SAMP>, standard input is read.
</P>
<H3><A NAME="SEC32" HREF="gettext_toc.html#TOC32">5.1.2 Output file location</A></H3>
<DL COMPACT>
<DT><SAMP>`-o <VAR>file</VAR>´</SAMP>
<DD>
<DT><SAMP>`--output-file=<VAR>file</VAR>´</SAMP>
<DD>
<A NAME="IDX217"></A>
<A NAME="IDX218"></A>
Write output to specified PO file.
</DL>
<P>
If no output file is given, it depends on the <SAMP>`--locale´</SAMP> option or the
user's locale setting. If it is <SAMP>`-´</SAMP>, the results are written to
standard output.
</P>
<H3><A NAME="SEC33" HREF="gettext_toc.html#TOC33">5.1.3 Output details</A></H3>
<DL COMPACT>
<DT><SAMP>`-l <VAR>ll_CC</VAR>´</SAMP>
<DD>
<DT><SAMP>`--locale=<VAR>ll_CC</VAR>´</SAMP>
<DD>
<A NAME="IDX219"></A>
<A NAME="IDX220"></A>
Set target locale. <VAR>ll</VAR> should be a language code, and <VAR>CC</VAR> should
be a country code. The command <SAMP>`locale -a´</SAMP> can be used to output a list
of all installed locales. The default is the user's locale setting.
<DT><SAMP>`--no-translator´</SAMP>
<DD>
<A NAME="IDX221"></A>
Declares that the PO file will not have a human translator and is instead
automatically generated.
<DT><SAMP>`-w <VAR>number</VAR>´</SAMP>
<DD>
<DT><SAMP>`--width=<VAR>number</VAR>´</SAMP>
<DD>
<A NAME="IDX222"></A>
<A NAME="IDX223"></A>
Set the output page width. Long strings in the output files will be
split across multiple lines in order to ensure that each line's width
(= number of screen columns) is less or equal to the given <VAR>number</VAR>.
<DT><SAMP>`--no-wrap´</SAMP>
<DD>
<A NAME="IDX224"></A>
Do not break long message lines. Message lines whose width exceeds the
output page width will not be split into several lines. Only file reference
lines which are wider than the output page width will be split.
</DL>
<H3><A NAME="SEC34" HREF="gettext_toc.html#TOC34">5.1.4 Informative output</A></H3>
<DL COMPACT>
<DT><SAMP>`-h´</SAMP>
<DD>
<DT><SAMP>`--help´</SAMP>
<DD>
<A NAME="IDX225"></A>
<A NAME="IDX226"></A>
Display this help and exit.
<DT><SAMP>`-V´</SAMP>
<DD>
<DT><SAMP>`--version´</SAMP>
<DD>
<A NAME="IDX227"></A>
<A NAME="IDX228"></A>
Output version information and exit.
</DL>
<H2><A NAME="SEC35" HREF="gettext_toc.html#TOC35">5.2 Filling in the Header Entry</A></H2>
<P>
<A NAME="IDX229"></A>
</P>
<P>
The initial comments "SOME DESCRIPTIVE TITLE", "YEAR" and
"FIRST AUTHOR <EMAIL@ADDRESS>, YEAR" ought to be replaced by sensible
information. This can be done in any text editor; if Emacs is used
and it switched to PO mode automatically (because it has recognized
the file's suffix), you can disable it by typing <KBD>M-x fundamental-mode</KBD>.
</P>
<P>
Modifying the header entry can already be done using PO mode: in Emacs,
type <KBD>M-x po-mode RET</KBD> and then <KBD>RET</KBD> again to start editing the
entry. You should fill in the following fields.
</P>
<DL COMPACT>
<DT>Project-Id-Version
<DD>
This is the name and version of the package.
<DT>POT-Creation-Date
<DD>
This has already been filled in by <CODE>xgettext</CODE>.
<DT>PO-Revision-Date
<DD>
You don't need to fill this in. It will be filled by the Emacs PO mode
when you save the file.
<DT>Last-Translator
<DD>
Fill in your name and email address (without double quotes).
<DT>Language-Team
<DD>
Fill in the English name of the language, and the email address or
homepage URL of the language team you are part of.
Before starting a translation, it is a good idea to get in touch with
your translation team, not only to make sure you don't do duplicated work,
but also to coordinate difficult linguistic issues.
<A NAME="IDX230"></A>
In the Free Translation Project, each translation team has its own mailing
list. The up-to-date list of teams can be found at the Free Translation
Project's homepage, <A HREF="http://www.iro.umontreal.ca/contrib/po/HTML/">http://www.iro.umontreal.ca/contrib/po/HTML/</A>,
in the "National teams" area.
<DT>Content-Type
<DD>
<A NAME="IDX231"></A>
<A NAME="IDX232"></A>
Replace <SAMP>`CHARSET´</SAMP> with the character encoding used for your language,
in your locale, or UTF-8. This field is needed for correct operation of the
<CODE>msgmerge</CODE> and <CODE>msgfmt</CODE> programs, as well as for users whose
locale's character encoding differs from yours (see section <A HREF="gettext_10.html#SEC149">10.2.4 How to specify the output character set <CODE>gettext</CODE> uses</A>).
<A NAME="IDX233"></A>
You get the character encoding of your locale by running the shell command
<SAMP>`locale charmap´</SAMP>. If the result is <SAMP>`C´</SAMP> or <SAMP>`ANSI_X3.4-1968´</SAMP>,
which is equivalent to <SAMP>`ASCII´</SAMP> (= <SAMP>`US-ASCII´</SAMP>), it means that your
locale is not correctly configured. In this case, ask your translation
team which charset to use. <SAMP>`ASCII´</SAMP> is not usable for any language
except Latin.
<A NAME="IDX234"></A>
Because the PO files must be portable to operating systems with less advanced
internationalization facilities, the character encodings that can be used
are limited to those supported by both GNU <CODE>libc</CODE> and GNU
<CODE>libiconv</CODE>. These are:
<CODE>ASCII</CODE>, <CODE>ISO-8859-1</CODE>, <CODE>ISO-8859-2</CODE>, <CODE>ISO-8859-3</CODE>,
<CODE>ISO-8859-4</CODE>, <CODE>ISO-8859-5</CODE>, <CODE>ISO-8859-6</CODE>, <CODE>ISO-8859-7</CODE>,
<CODE>ISO-8859-8</CODE>, <CODE>ISO-8859-9</CODE>, <CODE>ISO-8859-13</CODE>, <CODE>ISO-8859-15</CODE>,
<CODE>KOI8-R</CODE>, <CODE>KOI8-U</CODE>, <CODE>CP850</CODE>, <CODE>CP866</CODE>, <CODE>CP874</CODE>,
<CODE>CP932</CODE>, <CODE>CP949</CODE>, <CODE>CP950</CODE>, <CODE>CP1250</CODE>, <CODE>CP1251</CODE>,
<CODE>CP1252</CODE>, <CODE>CP1253</CODE>, <CODE>CP1254</CODE>, <CODE>CP1255</CODE>, <CODE>CP1256</CODE>,
<CODE>CP1257</CODE>, <CODE>GB2312</CODE>, <CODE>EUC-JP</CODE>, <CODE>EUC-KR</CODE>, <CODE>EUC-TW</CODE>,
<CODE>BIG5</CODE>, <CODE>BIG5-HKSCS</CODE>, <CODE>GBK</CODE>, <CODE>GB18030</CODE>, <CODE>SHIFT_JIS</CODE>,
<CODE>JOHAB</CODE>, <CODE>TIS-620</CODE>, <CODE>VISCII</CODE>, <CODE>UTF-8</CODE>.
<A NAME="IDX235"></A>
In the GNU system, the following encodings are frequently used for the
corresponding languages.
<A NAME="IDX236"></A>
<UL>
<LI><CODE>ISO-8859-1</CODE> for
Afrikaans, Albanian, Basque, Catalan, Dutch, English, Estonian, Faroese,
Finnish, French, Galician, German, Greenlandic, Icelandic, Indonesian,
Irish, Italian, Malay, Norwegian, Portuguese, Spanish, Swedish,
<LI><CODE>ISO-8859-2</CODE> for
Croatian, Czech, Hungarian, Polish, Romanian, Serbian, Slovak, Slovenian,
<LI><CODE>ISO-8859-3</CODE> for Maltese,
<LI><CODE>ISO-8859-5</CODE> for Macedonian, Serbian,
<LI><CODE>ISO-8859-6</CODE> for Arabic,
<LI><CODE>ISO-8859-7</CODE> for Greek,
<LI><CODE>ISO-8859-8</CODE> for Hebrew,
<LI><CODE>ISO-8859-9</CODE> for Turkish,
<LI><CODE>ISO-8859-13</CODE> for Latvian, Lithuanian,
<LI><CODE>ISO-8859-15</CODE> for
Basque, Catalan, Dutch, English, Finnish, French, Galician, German, Irish,
Italian, Portuguese, Spanish, Swedish,
<LI><CODE>KOI8-R</CODE> for Russian,
<LI><CODE>KOI8-U</CODE> for Ukrainian,
<LI><CODE>CP1251</CODE> for Bulgarian, Byelorussian,
<LI><CODE>GB2312</CODE>, <CODE>GBK</CODE>, <CODE>GB18030</CODE>
for simplified writing of Chinese,
<LI><CODE>BIG5</CODE>, <CODE>BIG5-HKSCS</CODE>
for traditional writing of Chinese,
<LI><CODE>EUC-JP</CODE> for Japanese,
<LI><CODE>EUC-KR</CODE> for Korean,
<LI><CODE>TIS-620</CODE> for Thai,
<LI><CODE>UTF-8</CODE> for any language, including those listed above.
</UL>
<A NAME="IDX237"></A>
<A NAME="IDX238"></A>
When single quote characters or double quote characters are used in
translations for your language, and your locale's encoding is one of the
ISO-8859-* charsets, it is best if you create your PO files in UTF-8
encoding, instead of your locale's encoding. This is because in UTF-8
the real quote characters can be represented (single quote characters:
U+2018, U+2019, double quote characters: U+201C, U+201D), whereas none of
ISO-8859-* charsets has them all. Users in UTF-8 locales will see the
real quote characters, whereas users in ISO-8859-* locales will see the
vertical apostrophe and the vertical double quote instead (because that's
what the character set conversion will transliterate them to).
<A NAME="IDX239"></A>
To enter such quote characters under X11, you can change your keyboard
mapping using the <CODE>xmodmap</CODE> program. The X11 names of the quote
characters are "leftsinglequotemark", "rightsinglequotemark",
"leftdoublequotemark", "rightdoublequotemark", "singlelowquotemark",
"doublelowquotemark".
Note that only recent versions of GNU Emacs support the UTF-8 encoding:
Emacs 20 with Mule-UCS, and Emacs 21. As of January 2001, XEmacs doesn't
support the UTF-8 encoding.
The character encoding name can be written in either upper or lower case.
Usually upper case is preferred.
<DT>Content-Transfer-Encoding
<DD>
Set this to <CODE>8bit</CODE>.
<DT>Plural-Forms
<DD>
This field is optional. It is only needed if the PO file has plural forms.
You can find them by searching for the <SAMP>`msgid_plural´</SAMP> keyword. The
format of the plural forms field is described in section <A HREF="gettext_10.html#SEC150">10.2.5 Additional functions for plural forms</A>.
</DL>
<P><HR><P>
Go to the <A HREF="gettext_1.html">first</A>, <A HREF="gettext_4.html">previous</A>, <A HREF="gettext_6.html">next</A>, <A HREF="gettext_22.html">last</A> section, <A HREF="gettext_toc.html">table of contents</A>.
</BODY>
</HTML>
|
