| 1 |
This file contains instructions for translators to translate Speech |
| 2 |
Dispatcher interface to their languages. Speech Dispatcher uses |
| 3 |
gettext[1] for its internationalization support. |
| 4 |
|
| 5 |
If you're not familiar with gettext po files we recommend that you |
| 6 |
read the Gettext manual[2] before continuing. |
| 7 |
|
| 8 |
== Requirements == |
| 9 |
|
| 10 |
To translate Speech Dispatcher you need a git clone of speech |
| 11 |
dispatcher. If you are not reading this file from a git checkout |
| 12 |
please check the `INSTALL` file for detailed instructions. You will |
| 13 |
also need gettext package installed, as recommended on |
| 14 |
the `INSTALL` file. |
| 15 |
|
| 16 |
== Adding a new Language == |
| 17 |
|
| 18 |
If your locale is not already supported by Speech Dispatcher you must |
| 19 |
create a new <locale>.po file and translate all contained |
| 20 |
messages. The following steps explain the process. |
| 21 |
|
| 22 |
1. ON your Speech Dispatcher source directory change to the po directory. |
| 23 |
|
| 24 |
2. Create a pot template for Speech Dispatcher running: |
| 25 |
|
| 26 |
$ make -C po speech-dispatcher.pot-update |
| 27 |
|
| 28 |
This will create a file called Speech Dispatcher.pot with all |
| 29 |
translatable Speech Dispatcher messages. |
| 30 |
|
| 31 |
3. Create the po template for the current system locale from Speech |
| 32 |
Dispatcher.pot running |
| 33 |
|
| 34 |
$ msginit |
| 35 |
|
| 36 |
And follow the prompts. If you want to create a translation for a |
| 37 |
different locale please run |
| 38 |
|
| 39 |
$ msginit -l <locale> |
| 40 |
|
| 41 |
where <locale> is the locale's name. This will create a <locale>.po |
| 42 |
file. msginit will fill in the po template header for you from your |
| 43 |
environment but we recommend to double-check that information. |
| 44 |
|
| 45 |
You may also copy the Speech Dispatcher.pot file to <locale>.po and |
| 46 |
fill in the header information yourself. |
| 47 |
|
| 48 |
At this stage you can remove the Speech-Dispatcher.pot file since it |
| 49 |
is not needed anymore. |
| 50 |
|
| 51 |
4. Open the file `LINGUAS` and add your locale name there. Please put |
| 52 |
one locale on each line and keep the file alphabetically sorted. |
| 53 |
|
| 54 |
5. Translate all messages in <locale>.po and run make. If you found |
| 55 |
errors reported by msgfmt about your <locale>.po file please correct |
| 56 |
them before continuing. |
| 57 |
|
| 58 |
6. When you're done see the section about testing below. |
| 59 |
|
| 60 |
== Updating an existing Translation == |
| 61 |
|
| 62 |
When there are new Speech Dispatcher messages for translation or some |
| 63 |
messages are changed, you need to update your <locale.>.po file. |
| 64 |
|
| 65 |
To update an existing po file with new messages please run |
| 66 |
|
| 67 |
$ make -C po <locale>.po-update |
| 68 |
|
| 69 |
Where <locale> is the locale po file to update. |
| 70 |
|
| 71 |
Then you can translate new messages and, if needed, update the ones |
| 72 |
gettext guessed wrong when updating the po file. |
| 73 |
|
| 74 |
== Testing your Translation == |
| 75 |
|
| 76 |
To confirm that your translation works, please install Speech |
| 77 |
Dispatcher with your translation included and test it with your system |
| 78 |
configured for your locale. |
| 79 |
|
| 80 |
We recommend you test with spd-say and spd-conf, since those are the |
| 81 |
tools with more translatable content. |
| 82 |
|
| 83 |
== Sending your Translation to Speech Dispatcher == |
| 84 |
|
| 85 |
When you think your translation is ready to be included in Speech |
| 86 |
Dispatcher send the po file to our development mailling-list at |
| 87 |
[email protected] |
| 88 |
|
| 89 |
== References == |
| 90 |
|
| 91 |
[1] Gettext: https://www.gnu.org/software/gettext/ |
| 92 |
[2] Gettext Manual: https://www.gnu.org/software/gettext/manual/gettext.html |
| 93 |
|
| 94 |
|
| 95 |
Copyright (C) 2010 Rui Batista <[email protected]> |
| 96 |
Copyright (C) 2012 Brailcom, o.p.s |
| 97 |
Copyright (C) 2017 Jan Tojnar <[email protected]> |
| 98 |
|
| 99 |
This program is free software; you can redistribute it and/or modify it under |
| 100 |
the terms of the GNU General Public License as published by the Free Software |
| 101 |
Foundation; either version 2 of the License, or (at your option) any later |
| 102 |
version. |
| 103 |
|
| 104 |
This program is distributed in the hope that it will be useful, but WITHOUT ANY |
| 105 |
WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A |
| 106 |
PARTICULAR PURPOSE. See the GNU General Public License for more details (file |
| 107 |
COPYING in the root directory). |
| 108 |
|
| 109 |
You should have received a copy of the GNU General Public License |
| 110 |
along with this program. If not, see <https://www.gnu.org/licenses/>. |