Translating the Inventory Builder UI
This How-to applies to: 1.0
i18n directory structure description
- generated.pot - automaticly generated by ArchGenXML where are msgids from content-types schemata (widget labels and descriptions) etc.
- inventorybuilder-??.po - msgids translation from 'InventoryBuilder' i18n domain for the language '??' (for example: 'cs' for Czech)
- inventorybuilder-plone-??.po - msgids translation from 'plone' i18n domain for the language '??' (for example: 'cs' for Czech)
- inventorybuilder-plone.pot - msgids definition from 'plone' i18n domain
- inventorybuilder.pot - msgids definition from 'InventoryBuilder' i18n domain
- manual-plone.pot - custom msgids definition from 'plone' i18n domain
- manual.pot - custom msgids definition from 'InventoryBuilder' i18n domain
- usei18ndude.sh - helper method to generate and update translation definitions
Translating - step by step
- copy one of inventorybuilder-plone-??.po to inventorybuilder-plone-<your_language_suffix>.po
- edit the PO file headers (author, language and coding settings)
- clear all defined msgids and msgstrings
- do the same for inventorybuilder-??.po file (copy to inventorybuilder-<your_language_suffix>.po
- run 'usei18ndude.sh' script and make sure that at the end of it's output will be something like:
inventorybuilder-cs.po: 0 added, 0 removedWhere XX is your language suffix, 333 is number of existing msgids to be translated in 'InventoryBuilder' i18n domain and 28 is number of existing msgids to be translated in 'plone' i18n domain.
...
inventorybuilder-XX.po: 333 added, 0 removed
inventorybuilder-plone-cs.po: 0 added, 0 removed
...
inventorybuilder-plone-XX.po: 28 added, 0 removed
- then go to your new po files (inventorybuilder-xx.po and inventorybuilder-plone-xx.po) and start to translating msgstrings
- and that's it
Custom translations
If you made some modifications to templates or other parts of the package to resolve your own needs it would be usefull to support i18n.In this case define your own msgids (only msgids) in 'manual.pot' file before you will run usei18ndude.sh script - your own msgids will be merged into other po files and made available to be translated. There is also 'manual-plone.pot' file available for the same usage but for 'plone' i18n domain.
note:
Before you start translating make sure you have the newest version of the package. If you are not sure make new checkout or update your package.
If you will want to contribute and add your translation into official product package please commit or send (archived) only your two new po files. Calling usei18ndude.sh should change other translations which will need review that's why don't commit it. Thx!.
If you will use 'manual.pot' to define your own custom parts of the package don't commit or send PO files into official package.