--------------------------------------------------- Localization Guide Sample --------------------------------------------------- Last updated on: 03/30/98 ========================================================================= Introduction ------------ This document covers the various localizable issues of YourProduct 1.0. It describes in detail the various localizable components of YourProduct 1.0, and give instructions as to how to work with and localize these components. It is intended to be used by the localization centers to localize YourProduct, and is not meant for end users or developers. ========================================================================= Contents ** Fill in here ** Appendix: Appendix A : Locale Names used in YourProduct ========================================================================= Message files ------------- (1) Solaris *.po Messages file for Solaris. These files should be converted to *.mo and place in the right locale directory. This type of files will be placed in locale directories that uses "Solaris" locale names. Example (messages file for Solaris start-up script): delivered location: /YourProduct/lib/locale/C/LC_MESSAGES/msg.po for ja locale: /YourProduct/lib/locale/ja/LC_MESSAGES/msg.mo (3) properties files Localization centers should localize the values of the properties. YourProduct contains many different types of properties. This section describes those properties that are part of the main tool. Information on the other types of properties can be found at: YourProduct Component properties - in the section "YourProduct Components" in this doc. 3rd Party Component properties - in the section "3rd Party Components" in this doc. There are 2 types of localizable properties files - these files are differentiated by the '-i18n' or '-messages' that appear before the '.properties' in their names. Any files without '-i18n' or '-messages' should not be touched. For the rest, use the following rules: xxxxx-i18n.properties localizable non-messages - these property files should NOT be translated but the values should be MODIFIED if needed. xxxxx-messages.properties localizable messages - these property files should be translated. The YourProduct engineering team has created a tool for converting these properties files into a ".class" file format. Please see the "loose file" package for details. The loose file package contains READMEs that provide step by step instructions on translating properties files. The README you want to read and follow is: loctoolsdir/translation-helper/messages/README ========================================================================== Documentation ------------- (1) hard copy * installation guide * YourProduct information * registration form (2) online documentation Additional Notes ---------------- Note1 : All html, gif, image files that are used by the online docs with original location as: YourProduct1.0/YourProduct/lib/XXX/... should be placed in the following directory in ja locale: YourProduct1.0/YourProduct/lib/locale/ja/lib/XXX/... ========================================================================== Special Files ------------- ========================================================================= ========================================================================== 3rd Party Components -------------------- The 3rd party components' properties kit is now located in: loctoolsdir/translation-helper/3pcomps This directory contains a README that should be read and followed. ========================================================================== Text Files ---------- YourProduct also includes legal text files. YourProductC should translate these files from the delivered location: YourProduct1.0/YourProduct/lib/License ========================================================================= Examples -------- YourProduct comes with a number of example code in YourProduct1.0/YourProduct/examples. delivered location: YourProduct1.0/YourProduct/examples ja locale: YourProduct1.0/YourProduct/examples/ja -- Note: all localized examples must live under the directory "YourProduct1.0/YourProduct/examples/" =========================================================================== Tutorial Images --------------- This section covers instructions on how to replace the images in the tutorial with locale specific images. If the existing images are ok, then you do not have to change them but you may wish to replace the existing images with new ones as some images contain English text. ========================================================================== eReg/Comments Properties information ------------------------ =========================================================================== YourProductHelp Localization -------------------- This section will describe in detail the various localizable components of YourProductHelp, and give instructions as to how to work with and localize these components. It is intended to be used by the localization centers to localize the YourProductHelp used in YourProduct, and is not meant for end users or developers. Special tools provided by YourProduct team for L10N work are delivered in the help/translation-helper directory (please see help.tar.Z). - setup-translation This will set up a work area to localize property files. Please see help/translation-helper/messages/README for details and an example of use - l10n-properties-to-class This is the tool that will convert properties file to class files. Please see the readme instructions of this tool for detail. ========================================================================== Help Index Generation --------------------- The YourProduct engineering team has put together a tool for generating the index search database. This tool can be found in: loctoolsdir/translation-helper/helpindex This directory contains a README that should be read and followed. ========================================================================== A P P E N D I X ========================================================================== Appendix A : Locale Names used in YourProduct ------------------------------------ Asian Locale Names ------------------ For Solaris: Arch. Item japan PRC Taiwan Korean dependent ---- ----- --- ------ ------ --------- (start-up) doc ja zh zh_TW ko no (.html, .gif) doc ja zh zh_TW ko yes (.txt) properties file ja zh zh_TW ko no examples ja zh zh_TW ko no For Win32: Arch Item japan PRC Taiwan Korean dependent ---- ----- --- ------ ------ --------- messags.po ja_JP zh_CN zh_TW ko yes (start-up) doc ja_JP zh_CN zh_TW ko no (.html, .gif) doc ja_JP zh_CN zh_TW ko yes (.txt) properties file ja_JP zh_CN zh_TW ko no examples ja zh zh_TW ko no European Locale Names --------------------- For Solaris: Arch. Item France Germany Itay Sweden Spanish dependent ---- ------ ------- ---- ------- ------- --------- (start-up) doc fr de it sv es no (.html, .gif) doc fr de it sv es yes (.txt) properties file fr de it sv es no examples fr de it sv es no For Win32: Arch. Item France Germany Italy Sweden Spanish dependent ---- ------ ------- ----- ------- ------- --------- messags.po fr de it sv es yes (start-up) doc fr de it sv es no (.html, .gif) doc fr de it sv es yes (.txt) properties file fr de it sv es no examples fr de it sv es no ==========================================================================