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
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
|
<HTML>
<HEAD>
<!-- This HTML file has been created by texi2html 1.52b
from gettext.texi on 11 June 2016 -->
<META HTTP-EQUIV="content-type" CONTENT="text/html; charset=UTF-8">
<TITLE>GNU gettext utilities - 6 Creating a New PO File</TITLE>
</HEAD>
<BODY>
Go to the <A HREF="gettext_1.html">first</A>, <A HREF="gettext_5.html">previous</A>, <A HREF="gettext_7.html">next</A>, <A HREF="gettext_25.html">last</A> section, <A HREF="gettext_toc.html">table of contents</A>.
<P><HR><P>
<H1><A NAME="SEC37" HREF="gettext_toc.html#TOC37">6 Creating a New PO File</A></H1>
<P>
<A NAME="IDX250"></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
</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="SEC38" HREF="gettext_toc.html#TOC38">6.1 Invoking the <CODE>msginit</CODE> Program</A></H2>
<P>
<A NAME="IDX251"></A>
<A NAME="IDX252"></A>
<PRE>
msginit [<VAR>option</VAR>]
</PRE>
<P>
<A NAME="IDX253"></A>
<A NAME="IDX254"></A>
The <CODE>msginit</CODE> program creates a new PO file, initializing the meta
information with values from the user's environment.
</P>
<P>
Here are more details. The following header fields of a PO file are
automatically filled, when possible.
</P>
<DL COMPACT>
<DT><SAMP>‘Project-Id-Version’</SAMP>
<DD>
The value is guessed from the <CODE>configure</CODE> script or any other files
in the current directory.
<DT><SAMP>‘PO-Revision-Date’</SAMP>
<DD>
The value is taken from the <CODE>PO-Creation-Data</CODE> in the input POT
file, or the current date is used.
<DT><SAMP>‘Last-Translator’</SAMP>
<DD>
The value is taken from user's password file entry and the mailer
configuration files.
<DT><SAMP>‘Language-Team, Language’</SAMP>
<DD>
These values are set according to the current locale and the predefined
list of translation teams.
<DT><SAMP>‘MIME-Version, Content-Type, Content-Transfer-Encoding’</SAMP>
<DD>
These values are set according to the content of the POT file and the
current locale. If the POT file contains charset=UTF-8, it means that
the POT file contains non-ASCII characters, and we keep the UTF-8
encoding. Otherwise, when the POT file is plain ASCII, we use the
locale's encoding.
<DT><SAMP>‘Plural-Forms’</SAMP>
<DD>
The value is first looked up from the embedded table.
As an experimental feature, you can instruct <CODE>msginit</CODE> to use the
information from Unicode CLDR, by setting the <CODE>GETTEXTCLDRDIR</CODE>
environment variable.
</DL>
<H3><A NAME="SEC39" HREF="gettext_toc.html#TOC39">6.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="IDX255"></A>
<A NAME="IDX256"></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="SEC40" HREF="gettext_toc.html#TOC40">6.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="IDX257"></A>
<A NAME="IDX258"></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="SEC41" HREF="gettext_toc.html#TOC41">6.1.3 Input file syntax</A></H3>
<DL COMPACT>
<DT><SAMP>‘-P’</SAMP>
<DD>
<DT><SAMP>‘--properties-input’</SAMP>
<DD>
<A NAME="IDX259"></A>
<A NAME="IDX260"></A>
Assume the input file is a Java ResourceBundle in Java <CODE>.properties</CODE>
syntax, not in PO file syntax.
<DT><SAMP>‘--stringtable-input’</SAMP>
<DD>
<A NAME="IDX261"></A>
Assume the input file is a NeXTstep/GNUstep localized resource file in
<CODE>.strings</CODE> syntax, not in PO file syntax.
</DL>
<H3><A NAME="SEC42" HREF="gettext_toc.html#TOC42">6.1.4 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="IDX262"></A>
<A NAME="IDX263"></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="IDX264"></A>
Declares that the PO file will not have a human translator and is instead
automatically generated.
<DT><SAMP>‘--color’</SAMP>
<DD>
<DT><SAMP>‘--color=<VAR>when</VAR>’</SAMP>
<DD>
<A NAME="IDX265"></A>
Specify whether or when to use colors and other text attributes.
See section <A HREF="gettext_9.html#SEC150">9.11.1 The <CODE>--color</CODE> option</A> for details.
<DT><SAMP>‘--style=<VAR>style_file</VAR>’</SAMP>
<DD>
<A NAME="IDX266"></A>
Specify the CSS style rule file to use for <CODE>--color</CODE>.
See section <A HREF="gettext_9.html#SEC152">9.11.3 The <CODE>--style</CODE> option</A> for details.
<DT><SAMP>‘-p’</SAMP>
<DD>
<DT><SAMP>‘--properties-output’</SAMP>
<DD>
<A NAME="IDX267"></A>
<A NAME="IDX268"></A>
Write out a Java ResourceBundle in Java <CODE>.properties</CODE> syntax. Note
that this file format doesn't support plural forms and silently drops
obsolete messages.
<DT><SAMP>‘--stringtable-output’</SAMP>
<DD>
<A NAME="IDX269"></A>
Write out a NeXTstep/GNUstep localized resource file in <CODE>.strings</CODE> syntax.
Note that this file format doesn't support plural forms.
<DT><SAMP>‘-w <VAR>number</VAR>’</SAMP>
<DD>
<DT><SAMP>‘--width=<VAR>number</VAR>’</SAMP>
<DD>
<A NAME="IDX270"></A>
<A NAME="IDX271"></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="IDX272"></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="SEC43" HREF="gettext_toc.html#TOC43">6.1.5 Informative output</A></H3>
<DL COMPACT>
<DT><SAMP>‘-h’</SAMP>
<DD>
<DT><SAMP>‘--help’</SAMP>
<DD>
<A NAME="IDX273"></A>
<A NAME="IDX274"></A>
Display this help and exit.
<DT><SAMP>‘-V’</SAMP>
<DD>
<DT><SAMP>‘--version’</SAMP>
<DD>
<A NAME="IDX275"></A>
<A NAME="IDX276"></A>
Output version information and exit.
</DL>
<H2><A NAME="SEC44" HREF="gettext_toc.html#TOC44">6.2 Filling in the Header Entry</A></H2>
<P>
<A NAME="IDX277"></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. Fill it in if it has not
already been filled in by <CODE>xgettext</CODE>.
<DT>Report-Msgid-Bugs-To
<DD>
This has already been filled in by <CODE>xgettext</CODE>. It contains an email
address or URL where you can report bugs in the untranslated strings:
<UL>
<LI>Strings which are not entire sentences, see the maintainer guidelines
in section <A HREF="gettext_4.html#SEC19">4.3 Preparing Translatable Strings</A>.
<LI>Strings which use unclear terms or require additional context to be
understood.
<LI>Strings which make invalid assumptions about notation of date, time or
money.
<LI>Pluralisation problems.
<LI>Incorrect English spelling.
<LI>Incorrect formatting.
</UL>
<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 PO file editor
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="IDX278"></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://translationproject.org/">http://translationproject.org/</A>, in the "Teams"
area.
<DT>Language
<DD>
Fill in the language code of the language. This can be in one of three
forms:
<UL>
<LI>
<SAMP>‘<VAR>ll</VAR>’</SAMP>, an ISO 639 two-letter language code (lowercase).
See section <A HREF="gettext_17.html#SEC331">A Language Codes</A> for the list of codes.
<LI>
<SAMP>‘<VAR>ll</VAR>_<VAR>CC</VAR>’</SAMP>, where <SAMP>‘<VAR>ll</VAR>’</SAMP> is an ISO 639 two-letter
language code (lowercase) and <SAMP>‘<VAR>CC</VAR>’</SAMP> is an ISO 3166 two-letter
country code (uppercase). The country code specification is not redundant:
Some languages have dialects in different countries. For example,
<SAMP>‘de_AT’</SAMP> is used for Austria, and <SAMP>‘pt_BR’</SAMP> for Brazil. The country
code serves to distinguish the dialects. See section <A HREF="gettext_17.html#SEC331">A Language Codes</A> and
section <A HREF="gettext_18.html#SEC334">B Country Codes</A> for the lists of codes.
<LI>
<SAMP>‘<VAR>ll</VAR>_<VAR>CC</VAR>@<VAR>variant</VAR>’</SAMP>, where <SAMP>‘<VAR>ll</VAR>’</SAMP> is an
ISO 639 two-letter language code (lowercase), <SAMP>‘<VAR>CC</VAR>’</SAMP> is an
ISO 3166 two-letter country code (uppercase), and <SAMP>‘<VAR>variant</VAR>’</SAMP> is
a variant designator. The variant designator (lowercase) can be a script
designator, such as <SAMP>‘latin’</SAMP> or <SAMP>‘cyrillic’</SAMP>.
</UL>
The naming convention <SAMP>‘<VAR>ll</VAR>_<VAR>CC</VAR>’</SAMP> is also the way locales are
named on systems based on GNU libc. But there are three important differences:
<UL>
<LI>
In this PO file field, but not in locale names, <SAMP>‘<VAR>ll</VAR>_<VAR>CC</VAR>’</SAMP>
combinations denoting a language's main dialect are abbreviated as
<SAMP>‘<VAR>ll</VAR>’</SAMP>. For example, <SAMP>‘de’</SAMP> is equivalent to <SAMP>‘de_DE’</SAMP>
(German as spoken in Germany), and <SAMP>‘pt’</SAMP> to <SAMP>‘pt_PT’</SAMP> (Portuguese as
spoken in Portugal) in this context.
<LI>
In this PO file field, suffixes like <SAMP>‘.<VAR>encoding</VAR>’</SAMP> are not used.
<LI>
In this PO file field, variant designators that are not relevant to message
translation, such as <SAMP>‘@euro’</SAMP>, are not used.
</UL>
So, if your locale name is <SAMP>‘de_DE.UTF-8’</SAMP>, the language specification in
PO files is just <SAMP>‘de’</SAMP>.
<DT>Content-Type
<DD>
<A NAME="IDX279"></A>
<A NAME="IDX280"></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_11.html#SEC188">11.2.4 How to specify the output character set <CODE>gettext</CODE> uses</A>).
<A NAME="IDX281"></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="IDX282"></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-14</CODE>,
<CODE>ISO-8859-15</CODE>,
<CODE>KOI8-R</CODE>, <CODE>KOI8-U</CODE>, <CODE>KOI8-T</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>GEORGIAN-PS</CODE>, <CODE>UTF-8</CODE>.
<A NAME="IDX283"></A>
In the GNU system, the following encodings are frequently used for the
corresponding languages.
<A NAME="IDX284"></A>
<UL>
<LI><CODE>ISO-8859-1</CODE> for
Afrikaans, Albanian, Basque, Breton, Catalan, Cornish, Danish, Dutch,
English, Estonian, Faroese, Finnish, French, Galician, German,
Greenlandic, Icelandic, Indonesian, Irish, Italian, Malay, Manx,
Norwegian, Occitan, Portuguese, Spanish, Swedish, Tagalog, Uzbek,
Walloon,
<LI><CODE>ISO-8859-2</CODE> for
Bosnian, 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, Maori,
<LI><CODE>ISO-8859-14</CODE> for Welsh,
<LI><CODE>ISO-8859-15</CODE> for
Basque, Catalan, Dutch, English, Finnish, French, Galician, German, Irish,
Italian, Portuguese, Spanish, Swedish, Walloon,
<LI><CODE>KOI8-R</CODE> for Russian,
<LI><CODE>KOI8-U</CODE> for Ukrainian,
<LI><CODE>KOI8-T</CODE> for Tajik,
<LI><CODE>CP1251</CODE> for Bulgarian, Belarusian,
<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>GEORGIAN-PS</CODE> for Georgian,
<LI><CODE>UTF-8</CODE> for any language, including those listed above.
</UL>
<A NAME="IDX285"></A>
<A NAME="IDX286"></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="IDX287"></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_11.html#SEC190">11.2.6 Additional functions for plural forms</A> and
section <A HREF="gettext_12.html#SEC211">12.6 Translating plural forms</A>.
</DL>
<P><HR><P>
Go to the <A HREF="gettext_1.html">first</A>, <A HREF="gettext_5.html">previous</A>, <A HREF="gettext_7.html">next</A>, <A HREF="gettext_25.html">last</A> section, <A HREF="gettext_toc.html">table of contents</A>.
</BODY>
</HTML>
|
