Mercurial > trustbridge
annotate packaging/README.linux-installer-l10n @ 1001:0b7bb4f68f5a
(issue89) Add Help button
| author | Andre Heinecke <andre.heinecke@intevation.de> |
|---|---|
| date | Tue, 02 Sep 2014 10:43:51 +0200 |
| parents | 71cdd4b2f038 |
| children | 96ecd345c961 |
| rev | line source |
|---|---|
|
822
71cdd4b2f038
Added documentation on l10n of the linux installer on how to update.
Sascha Wilde <wilde@intevation.de>
parents:
diff
changeset
|
1 ---------------------------------------------------------------------- |
|
71cdd4b2f038
Added documentation on l10n of the linux installer on how to update.
Sascha Wilde <wilde@intevation.de>
parents:
diff
changeset
|
2 Localization of the GNU/Linux Installer |
|
71cdd4b2f038
Added documentation on l10n of the linux installer on how to update.
Sascha Wilde <wilde@intevation.de>
parents:
diff
changeset
|
3 ---------------------------------------------------------------------- |
|
71cdd4b2f038
Added documentation on l10n of the linux installer on how to update.
Sascha Wilde <wilde@intevation.de>
parents:
diff
changeset
|
4 |
|
71cdd4b2f038
Added documentation on l10n of the linux installer on how to update.
Sascha Wilde <wilde@intevation.de>
parents:
diff
changeset
|
5 The GNU/Linux Installer uses a simple custom i18n implementation for |
|
71cdd4b2f038
Added documentation on l10n of the linux installer on how to update.
Sascha Wilde <wilde@intevation.de>
parents:
diff
changeset
|
6 localization. Currently English (default) and German messages are |
|
71cdd4b2f038
Added documentation on l10n of the linux installer on how to update.
Sascha Wilde <wilde@intevation.de>
parents:
diff
changeset
|
7 supported: |
|
71cdd4b2f038
Added documentation on l10n of the linux installer on how to update.
Sascha Wilde <wilde@intevation.de>
parents:
diff
changeset
|
8 |
|
71cdd4b2f038
Added documentation on l10n of the linux installer on how to update.
Sascha Wilde <wilde@intevation.de>
parents:
diff
changeset
|
9 All messages in the Installer are written in English, a associative |
|
71cdd4b2f038
Added documentation on l10n of the linux installer on how to update.
Sascha Wilde <wilde@intevation.de>
parents:
diff
changeset
|
10 array L10N_DE holds a German translations for the message strings. |
|
71cdd4b2f038
Added documentation on l10n of the linux installer on how to update.
Sascha Wilde <wilde@intevation.de>
parents:
diff
changeset
|
11 |
|
71cdd4b2f038
Added documentation on l10n of the linux installer on how to update.
Sascha Wilde <wilde@intevation.de>
parents:
diff
changeset
|
12 If locale is set to any de_* localization (following the same |
|
71cdd4b2f038
Added documentation on l10n of the linux installer on how to update.
Sascha Wilde <wilde@intevation.de>
parents:
diff
changeset
|
13 semantics as GNU gettext) and a German translation for the particular |
|
71cdd4b2f038
Added documentation on l10n of the linux installer on how to update.
Sascha Wilde <wilde@intevation.de>
parents:
diff
changeset
|
14 message is available it will be printed in German, otherwise the |
|
71cdd4b2f038
Added documentation on l10n of the linux installer on how to update.
Sascha Wilde <wilde@intevation.de>
parents:
diff
changeset
|
15 original English message will be used. |
|
71cdd4b2f038
Added documentation on l10n of the linux installer on how to update.
Sascha Wilde <wilde@intevation.de>
parents:
diff
changeset
|
16 |
|
71cdd4b2f038
Added documentation on l10n of the linux installer on how to update.
Sascha Wilde <wilde@intevation.de>
parents:
diff
changeset
|
17 |
|
71cdd4b2f038
Added documentation on l10n of the linux installer on how to update.
Sascha Wilde <wilde@intevation.de>
parents:
diff
changeset
|
18 Relevant files |
|
71cdd4b2f038
Added documentation on l10n of the linux installer on how to update.
Sascha Wilde <wilde@intevation.de>
parents:
diff
changeset
|
19 -------------- |
|
71cdd4b2f038
Added documentation on l10n of the linux installer on how to update.
Sascha Wilde <wilde@intevation.de>
parents:
diff
changeset
|
20 |
|
71cdd4b2f038
Added documentation on l10n of the linux installer on how to update.
Sascha Wilde <wilde@intevation.de>
parents:
diff
changeset
|
21 * linux-installer.inc.in : |
|
71cdd4b2f038
Added documentation on l10n of the linux installer on how to update.
Sascha Wilde <wilde@intevation.de>
parents:
diff
changeset
|
22 |
|
71cdd4b2f038
Added documentation on l10n of the linux installer on how to update.
Sascha Wilde <wilde@intevation.de>
parents:
diff
changeset
|
23 Linux Installer Template, written in bash. l10n-enabled messages |
|
71cdd4b2f038
Added documentation on l10n of the linux installer on how to update.
Sascha Wilde <wilde@intevation.de>
parents:
diff
changeset
|
24 are printed using the function "getxt" or "fatal" (which in turn |
|
71cdd4b2f038
Added documentation on l10n of the linux installer on how to update.
Sascha Wilde <wilde@intevation.de>
parents:
diff
changeset
|
25 uses getxt for output). The semantics are these of printf and all |
|
71cdd4b2f038
Added documentation on l10n of the linux installer on how to update.
Sascha Wilde <wilde@intevation.de>
parents:
diff
changeset
|
26 messages are in English. |
|
71cdd4b2f038
Added documentation on l10n of the linux installer on how to update.
Sascha Wilde <wilde@intevation.de>
parents:
diff
changeset
|
27 |
|
71cdd4b2f038
Added documentation on l10n of the linux installer on how to update.
Sascha Wilde <wilde@intevation.de>
parents:
diff
changeset
|
28 * linux-installer.l10n-de : |
|
71cdd4b2f038
Added documentation on l10n of the linux installer on how to update.
Sascha Wilde <wilde@intevation.de>
parents:
diff
changeset
|
29 |
|
71cdd4b2f038
Added documentation on l10n of the linux installer on how to update.
Sascha Wilde <wilde@intevation.de>
parents:
diff
changeset
|
30 This file contains the associative array L10N_DE which has the |
|
71cdd4b2f038
Added documentation on l10n of the linux installer on how to update.
Sascha Wilde <wilde@intevation.de>
parents:
diff
changeset
|
31 English messages as used in linux-installer.inc.in as keys and the |
|
71cdd4b2f038
Added documentation on l10n of the linux installer on how to update.
Sascha Wilde <wilde@intevation.de>
parents:
diff
changeset
|
32 corresponding German strings as values. |
|
71cdd4b2f038
Added documentation on l10n of the linux installer on how to update.
Sascha Wilde <wilde@intevation.de>
parents:
diff
changeset
|
33 |
|
71cdd4b2f038
Added documentation on l10n of the linux installer on how to update.
Sascha Wilde <wilde@intevation.de>
parents:
diff
changeset
|
34 * getxt-gen-l10n-array.sh : |
|
71cdd4b2f038
Added documentation on l10n of the linux installer on how to update.
Sascha Wilde <wilde@intevation.de>
parents:
diff
changeset
|
35 |
|
71cdd4b2f038
Added documentation on l10n of the linux installer on how to update.
Sascha Wilde <wilde@intevation.de>
parents:
diff
changeset
|
36 A tool to update the file linux-installer.l10n-de. Detailed usage |
|
71cdd4b2f038
Added documentation on l10n of the linux installer on how to update.
Sascha Wilde <wilde@intevation.de>
parents:
diff
changeset
|
37 is described in the commends at the head of the file. It performs |
|
71cdd4b2f038
Added documentation on l10n of the linux installer on how to update.
Sascha Wilde <wilde@intevation.de>
parents:
diff
changeset
|
38 the following steps: |
|
71cdd4b2f038
Added documentation on l10n of the linux installer on how to update.
Sascha Wilde <wilde@intevation.de>
parents:
diff
changeset
|
39 |
|
71cdd4b2f038
Added documentation on l10n of the linux installer on how to update.
Sascha Wilde <wilde@intevation.de>
parents:
diff
changeset
|
40 1. collect all message strings used with "getxt" (or "fatal") in the |
|
71cdd4b2f038
Added documentation on l10n of the linux installer on how to update.
Sascha Wilde <wilde@intevation.de>
parents:
diff
changeset
|
41 source file. |
|
71cdd4b2f038
Added documentation on l10n of the linux installer on how to update.
Sascha Wilde <wilde@intevation.de>
parents:
diff
changeset
|
42 |
|
71cdd4b2f038
Added documentation on l10n of the linux installer on how to update.
Sascha Wilde <wilde@intevation.de>
parents:
diff
changeset
|
43 2. sort and remove any duplicates |
|
71cdd4b2f038
Added documentation on l10n of the linux installer on how to update.
Sascha Wilde <wilde@intevation.de>
parents:
diff
changeset
|
44 |
|
71cdd4b2f038
Added documentation on l10n of the linux installer on how to update.
Sascha Wilde <wilde@intevation.de>
parents:
diff
changeset
|
45 3. merge with existing translations in the array file |
|
71cdd4b2f038
Added documentation on l10n of the linux installer on how to update.
Sascha Wilde <wilde@intevation.de>
parents:
diff
changeset
|
46 |
|
71cdd4b2f038
Added documentation on l10n of the linux installer on how to update.
Sascha Wilde <wilde@intevation.de>
parents:
diff
changeset
|
47 4. write updated array to array file |
|
71cdd4b2f038
Added documentation on l10n of the linux installer on how to update.
Sascha Wilde <wilde@intevation.de>
parents:
diff
changeset
|
48 |
|
71cdd4b2f038
Added documentation on l10n of the linux installer on how to update.
Sascha Wilde <wilde@intevation.de>
parents:
diff
changeset
|
49 |
|
71cdd4b2f038
Added documentation on l10n of the linux installer on how to update.
Sascha Wilde <wilde@intevation.de>
parents:
diff
changeset
|
50 How to update translations |
|
71cdd4b2f038
Added documentation on l10n of the linux installer on how to update.
Sascha Wilde <wilde@intevation.de>
parents:
diff
changeset
|
51 -------------------------- |
|
71cdd4b2f038
Added documentation on l10n of the linux installer on how to update.
Sascha Wilde <wilde@intevation.de>
parents:
diff
changeset
|
52 |
|
71cdd4b2f038
Added documentation on l10n of the linux installer on how to update.
Sascha Wilde <wilde@intevation.de>
parents:
diff
changeset
|
53 When any messages in "linux-installer.inc.in" were changed or added |
|
71cdd4b2f038
Added documentation on l10n of the linux installer on how to update.
Sascha Wilde <wilde@intevation.de>
parents:
diff
changeset
|
54 the array file "linux-installer.l10n-de" needs to be updated: |
|
71cdd4b2f038
Added documentation on l10n of the linux installer on how to update.
Sascha Wilde <wilde@intevation.de>
parents:
diff
changeset
|
55 |
|
71cdd4b2f038
Added documentation on l10n of the linux installer on how to update.
Sascha Wilde <wilde@intevation.de>
parents:
diff
changeset
|
56 1. Edit "linux-installer.inc.in" (obviously) |
|
71cdd4b2f038
Added documentation on l10n of the linux installer on how to update.
Sascha Wilde <wilde@intevation.de>
parents:
diff
changeset
|
57 |
|
71cdd4b2f038
Added documentation on l10n of the linux installer on how to update.
Sascha Wilde <wilde@intevation.de>
parents:
diff
changeset
|
58 2. Update the array file using getxt-gen-l10n-array.sh in the |
|
71cdd4b2f038
Added documentation on l10n of the linux installer on how to update.
Sascha Wilde <wilde@intevation.de>
parents:
diff
changeset
|
59 packaging source directory (the directory containing this README): |
|
71cdd4b2f038
Added documentation on l10n of the linux installer on how to update.
Sascha Wilde <wilde@intevation.de>
parents:
diff
changeset
|
60 |
|
71cdd4b2f038
Added documentation on l10n of the linux installer on how to update.
Sascha Wilde <wilde@intevation.de>
parents:
diff
changeset
|
61 $ ./getxt-gen-l10n-array.sh linux-installer.inc.in L10N_DE linux-installer.l10n-de |
|
71cdd4b2f038
Added documentation on l10n of the linux installer on how to update.
Sascha Wilde <wilde@intevation.de>
parents:
diff
changeset
|
62 |
|
71cdd4b2f038
Added documentation on l10n of the linux installer on how to update.
Sascha Wilde <wilde@intevation.de>
parents:
diff
changeset
|
63 the associative array "L10N_DE" in "linux-installer.l10n-de" will |
|
71cdd4b2f038
Added documentation on l10n of the linux installer on how to update.
Sascha Wilde <wilde@intevation.de>
parents:
diff
changeset
|
64 now contain entries for all new or changed messaged with empty |
|
71cdd4b2f038
Added documentation on l10n of the linux installer on how to update.
Sascha Wilde <wilde@intevation.de>
parents:
diff
changeset
|
65 strings for the German translations. |
|
71cdd4b2f038
Added documentation on l10n of the linux installer on how to update.
Sascha Wilde <wilde@intevation.de>
parents:
diff
changeset
|
66 |
|
71cdd4b2f038
Added documentation on l10n of the linux installer on how to update.
Sascha Wilde <wilde@intevation.de>
parents:
diff
changeset
|
67 CAVEAT: this means that if you change a message the translation |
|
71cdd4b2f038
Added documentation on l10n of the linux installer on how to update.
Sascha Wilde <wilde@intevation.de>
parents:
diff
changeset
|
68 for the old message will be removed from "linux-installer.l10n-de"! |
|
71cdd4b2f038
Added documentation on l10n of the linux installer on how to update.
Sascha Wilde <wilde@intevation.de>
parents:
diff
changeset
|
69 If you (slightly) change messages instead of adding or removing you |
|
71cdd4b2f038
Added documentation on l10n of the linux installer on how to update.
Sascha Wilde <wilde@intevation.de>
parents:
diff
changeset
|
70 might want to keep a copy of the old version of |
|
71cdd4b2f038
Added documentation on l10n of the linux installer on how to update.
Sascha Wilde <wilde@intevation.de>
parents:
diff
changeset
|
71 "linux-installer.l10n-de", so you can use the old translations as a |
|
71cdd4b2f038
Added documentation on l10n of the linux installer on how to update.
Sascha Wilde <wilde@intevation.de>
parents:
diff
changeset
|
72 reference. |
|
71cdd4b2f038
Added documentation on l10n of the linux installer on how to update.
Sascha Wilde <wilde@intevation.de>
parents:
diff
changeset
|
73 |
|
71cdd4b2f038
Added documentation on l10n of the linux installer on how to update.
Sascha Wilde <wilde@intevation.de>
parents:
diff
changeset
|
74 3. Edit "linux-installer.l10n-de" and add the missing translations. |
|
71cdd4b2f038
Added documentation on l10n of the linux installer on how to update.
Sascha Wilde <wilde@intevation.de>
parents:
diff
changeset
|
75 They are best found by searching for empty strings, which are |
|
71cdd4b2f038
Added documentation on l10n of the linux installer on how to update.
Sascha Wilde <wilde@intevation.de>
parents:
diff
changeset
|
76 denoted by two consecutive quotation marks: "" in your editor. |
|
71cdd4b2f038
Added documentation on l10n of the linux installer on how to update.
Sascha Wilde <wilde@intevation.de>
parents:
diff
changeset
|
77 |
|
71cdd4b2f038
Added documentation on l10n of the linux installer on how to update.
Sascha Wilde <wilde@intevation.de>
parents:
diff
changeset
|
78 That's all. Don't forget to commit "linux-installer.l10n-de" along |
|
71cdd4b2f038
Added documentation on l10n of the linux installer on how to update.
Sascha Wilde <wilde@intevation.de>
parents:
diff
changeset
|
79 with your changes to "linux-installer.inc.in". |