Difference between revisions of "I18n/Tools"
(→Tools related with Document translation) |
(→Tools related with document translation) |
||
| Line 2: | Line 2: | ||
== Tools related with document translation == | == Tools related with document translation == | ||
| + | |||
| + | OpenStack documents are in DocBook format. In order to make the document translation management consistent with message translation, we need to convert DocBook into PO format. | ||
| + | |||
| + | The document translation management include following steps: | ||
| + | * Slicing: slice DocBook into string segment with a Python script, and generate a PO template | ||
| + | * Uploading: Upload the translation resources to Transifex by automation scripts | ||
| + | * Translating: manage the translation in Transifex, including the translation memory and glossary management | ||
| + | * Merging: merge the translated string into Docbook with a python script | ||
| + | * Uploading: Download the translated results by automation scripts. | ||
| + | |||
| + | === Slicing script === | ||
| + | |||
| + | The [[https://github.com/openstack/openstack-manuals/blob/master/tools/generatepot slicing script]] has dependency to package "xml2po". So you have to install gnome-doc-utils before running it. | ||
| + | |||
| + | <pre><nowiki> | ||
| + | sudo apt-get install gnome-doc-utils | ||
| + | </nowiki></pre> | ||
| + | |||
| + | The script can scan a specific folder under openstack-manuals/doc/src/docbkx, collect all the text segment in *.xml and combine them into a PO template, with command: | ||
| + | |||
| + | <pre><nowiki> | ||
| + | ./tools/generatepot [foldername] | ||
| + | </nowiki></pre> | ||
| + | |||
| + | The PO template will be put in a "locale" folder under the specific docbook folder, i.e. openstack-manuals/doc/src/docbkx/[bookname]/locale. | ||
| + | |||
| + | === Merging script === | ||
| + | |||
| + | The [[https://github.com/openstack/openstack-manuals/blob/master/tools/generatedocbook merging script]] has dependency to package "xml2po". So you have to install gnome-doc-utils before running it. | ||
| + | |||
| + | <pre><nowiki> | ||
| + | sudo apt-get install gnome-doc-utils | ||
| + | </nowiki></pre> | ||
| + | |||
| + | The script can merge the translation strings into DocBook and generate a DocBook in the specific language. | ||
| + | |||
| + | <pre><nowiki> | ||
| + | ./tools/generatedocbook -l [language] -b [book_name] | ||
| + | </nowiki></pre> | ||
| + | |||
| + | === Uploading script === | ||
| + | |||
| + | The uploading script is an automation job running in Jenkins, which will be triggered by "commit" event of openstack-manuals repository. See [[https://github.com/openstack-infra/config/blob/master/modules/jenkins/files/slave_scripts/upstream_translation_update_manuals.sh here]]. | ||
| + | |||
| + | === Downloading script === | ||
| + | |||
| + | The downloading script is an automation job running daily in Jenkins. See [[https://github.com/openstack-infra/config/blob/master/modules/jenkins/files/slave_scripts/propose_translation_update_manuals.sh here]]. | ||
== Tools related with message translation == | == Tools related with message translation == | ||
Revision as of 22:08, 17 July 2013
I18N uses many different tools, across several OpenStack Projects to meet its goals.
Contents
OpenStack documents are in DocBook format. In order to make the document translation management consistent with message translation, we need to convert DocBook into PO format.
The document translation management include following steps:
- Slicing: slice DocBook into string segment with a Python script, and generate a PO template
- Uploading: Upload the translation resources to Transifex by automation scripts
- Translating: manage the translation in Transifex, including the translation memory and glossary management
- Merging: merge the translated string into Docbook with a python script
- Uploading: Download the translated results by automation scripts.
Slicing script
The [slicing script] has dependency to package "xml2po". So you have to install gnome-doc-utils before running it.
sudo apt-get install gnome-doc-utils
The script can scan a specific folder under openstack-manuals/doc/src/docbkx, collect all the text segment in *.xml and combine them into a PO template, with command:
./tools/generatepot [foldername]
The PO template will be put in a "locale" folder under the specific docbook folder, i.e. openstack-manuals/doc/src/docbkx/[bookname]/locale.
Merging script
The [merging script] has dependency to package "xml2po". So you have to install gnome-doc-utils before running it.
sudo apt-get install gnome-doc-utils
The script can merge the translation strings into DocBook and generate a DocBook in the specific language.
./tools/generatedocbook -l [language] -b [book_name]
Uploading script
The uploading script is an automation job running in Jenkins, which will be triggered by "commit" event of openstack-manuals repository. See [here].
Downloading script
The downloading script is an automation job running daily in Jenkins. See [here].
