Mercurial > trustbridge
annotate packaging/README.linux-installer-l10n @ 1322:02c7dea7ea67
(issue156) Reference template directory correctly
author | Andre Heinecke <andre.heinecke@intevation.de> |
---|---|
date | Mon, 13 Oct 2014 18:13:22 +0200 |
parents | 96ecd345c961 |
children |
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 |
1149
96ecd345c961
Split up l10n matching the new split up installer files.
Sascha Wilde <wilde@intevation.de>
parents:
822
diff
changeset
|
21 * linux-installer.inc : |
96ecd345c961
Split up l10n matching the new split up installer files.
Sascha Wilde <wilde@intevation.de>
parents:
822
diff
changeset
|
22 linux-installer-common.inc.in : |
96ecd345c961
Split up l10n matching the new split up installer files.
Sascha Wilde <wilde@intevation.de>
parents:
822
diff
changeset
|
23 linux-installer-uninstall.inc : |
822
71cdd4b2f038
Added documentation on l10n of the linux installer on how to update.
Sascha Wilde <wilde@intevation.de>
parents:
diff
changeset
|
24 |
1149
96ecd345c961
Split up l10n matching the new split up installer files.
Sascha Wilde <wilde@intevation.de>
parents:
822
diff
changeset
|
25 Linux Installer Templates, written in bash. l10n-enabled messages |
822
71cdd4b2f038
Added documentation on l10n of the linux installer on how to update.
Sascha Wilde <wilde@intevation.de>
parents:
diff
changeset
|
26 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
|
27 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
|
28 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
|
29 |
71cdd4b2f038
Added documentation on l10n of the linux installer on how to update.
Sascha Wilde <wilde@intevation.de>
parents:
diff
changeset
|
30 * linux-installer.l10n-de : |
1149
96ecd345c961
Split up l10n matching the new split up installer files.
Sascha Wilde <wilde@intevation.de>
parents:
822
diff
changeset
|
31 linux-installer-common.l10n-de : |
96ecd345c961
Split up l10n matching the new split up installer files.
Sascha Wilde <wilde@intevation.de>
parents:
822
diff
changeset
|
32 linux-installer-uninstall.l10n-de : |
822
71cdd4b2f038
Added documentation on l10n of the linux installer on how to update.
Sascha Wilde <wilde@intevation.de>
parents:
diff
changeset
|
33 |
1149
96ecd345c961
Split up l10n matching the new split up installer files.
Sascha Wilde <wilde@intevation.de>
parents:
822
diff
changeset
|
34 This files contain assignments to the associative array L10N_DE |
96ecd345c961
Split up l10n matching the new split up installer files.
Sascha Wilde <wilde@intevation.de>
parents:
822
diff
changeset
|
35 which has the English messages as used in linux-installer.inc as |
96ecd345c961
Split up l10n matching the new split up installer files.
Sascha Wilde <wilde@intevation.de>
parents:
822
diff
changeset
|
36 keys and the corresponding German strings as values. |
822
71cdd4b2f038
Added documentation on l10n of the linux installer on how to update.
Sascha Wilde <wilde@intevation.de>
parents:
diff
changeset
|
37 |
71cdd4b2f038
Added documentation on l10n of the linux installer on how to update.
Sascha Wilde <wilde@intevation.de>
parents:
diff
changeset
|
38 * 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
|
39 |
71cdd4b2f038
Added documentation on l10n of the linux installer on how to update.
Sascha Wilde <wilde@intevation.de>
parents:
diff
changeset
|
40 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
|
41 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
|
42 the following steps: |
71cdd4b2f038
Added documentation on l10n of the linux installer on how to update.
Sascha Wilde <wilde@intevation.de>
parents:
diff
changeset
|
43 |
71cdd4b2f038
Added documentation on l10n of the linux installer on how to update.
Sascha Wilde <wilde@intevation.de>
parents:
diff
changeset
|
44 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
|
45 source 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 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
|
48 |
71cdd4b2f038
Added documentation on l10n of the linux installer on how to update.
Sascha Wilde <wilde@intevation.de>
parents:
diff
changeset
|
49 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
|
50 |
71cdd4b2f038
Added documentation on l10n of the linux installer on how to update.
Sascha Wilde <wilde@intevation.de>
parents:
diff
changeset
|
51 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
|
52 |
71cdd4b2f038
Added documentation on l10n of the linux installer on how to update.
Sascha Wilde <wilde@intevation.de>
parents:
diff
changeset
|
53 |
71cdd4b2f038
Added documentation on l10n of the linux installer on how to update.
Sascha Wilde <wilde@intevation.de>
parents:
diff
changeset
|
54 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
|
55 -------------------------- |
71cdd4b2f038
Added documentation on l10n of the linux installer on how to update.
Sascha Wilde <wilde@intevation.de>
parents:
diff
changeset
|
56 |
71cdd4b2f038
Added documentation on l10n of the linux installer on how to update.
Sascha Wilde <wilde@intevation.de>
parents:
diff
changeset
|
57 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
|
58 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
|
59 |
1149
96ecd345c961
Split up l10n matching the new split up installer files.
Sascha Wilde <wilde@intevation.de>
parents:
822
diff
changeset
|
60 1. Edit one or more of "linux-installer.inc", |
96ecd345c961
Split up l10n matching the new split up installer files.
Sascha Wilde <wilde@intevation.de>
parents:
822
diff
changeset
|
61 "linux-installer-common.inc.in", "linux-installer-uninstall.inc" |
96ecd345c961
Split up l10n matching the new split up installer files.
Sascha Wilde <wilde@intevation.de>
parents:
822
diff
changeset
|
62 (obviously) |
822
71cdd4b2f038
Added documentation on l10n of the linux installer on how to update.
Sascha Wilde <wilde@intevation.de>
parents:
diff
changeset
|
63 |
71cdd4b2f038
Added documentation on l10n of the linux installer on how to update.
Sascha Wilde <wilde@intevation.de>
parents:
diff
changeset
|
64 2. Update the array file using getxt-gen-l10n-array.sh in the |
1149
96ecd345c961
Split up l10n matching the new split up installer files.
Sascha Wilde <wilde@intevation.de>
parents:
822
diff
changeset
|
65 packaging source directory (the directory containing this README) |
96ecd345c961
Split up l10n matching the new split up installer files.
Sascha Wilde <wilde@intevation.de>
parents:
822
diff
changeset
|
66 for the file(s) you edited: |
822
71cdd4b2f038
Added documentation on l10n of the linux installer on how to update.
Sascha Wilde <wilde@intevation.de>
parents:
diff
changeset
|
67 |
71cdd4b2f038
Added documentation on l10n of the linux installer on how to update.
Sascha Wilde <wilde@intevation.de>
parents:
diff
changeset
|
68 $ ./getxt-gen-l10n-array.sh linux-installer.inc.in L10N_DE linux-installer.l10n-de |
1149
96ecd345c961
Split up l10n matching the new split up installer files.
Sascha Wilde <wilde@intevation.de>
parents:
822
diff
changeset
|
69 $ ./getxt-gen-l10n-array.sh linux-installer-common.inc.in L10N_DE linux-installer-common.l10n-de |
96ecd345c961
Split up l10n matching the new split up installer files.
Sascha Wilde <wilde@intevation.de>
parents:
822
diff
changeset
|
70 $ ./getxt-gen-l10n-array.sh linux-installer-uninstall.inc L10N_DE linux-installer-uninstall.l10n-de |
822
71cdd4b2f038
Added documentation on l10n of the linux installer on how to update.
Sascha Wilde <wilde@intevation.de>
parents:
diff
changeset
|
71 |
71cdd4b2f038
Added documentation on l10n of the linux installer on how to update.
Sascha Wilde <wilde@intevation.de>
parents:
diff
changeset
|
72 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
|
73 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
|
74 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
|
75 |
71cdd4b2f038
Added documentation on l10n of the linux installer on how to update.
Sascha Wilde <wilde@intevation.de>
parents:
diff
changeset
|
76 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
|
77 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
|
78 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
|
79 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
|
80 "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
|
81 reference. |
71cdd4b2f038
Added documentation on l10n of the linux installer on how to update.
Sascha Wilde <wilde@intevation.de>
parents:
diff
changeset
|
82 |
71cdd4b2f038
Added documentation on l10n of the linux installer on how to update.
Sascha Wilde <wilde@intevation.de>
parents:
diff
changeset
|
83 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
|
84 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
|
85 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
|
86 |
71cdd4b2f038
Added documentation on l10n of the linux installer on how to update.
Sascha Wilde <wilde@intevation.de>
parents:
diff
changeset
|
87 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
|
88 with your changes to "linux-installer.inc.in". |