ShopSite Localization Kit

Table of Contents

I. Introduction
II. Required Tools
III. Contents of the Kit
IV. Unpacking the Kit
V. Translating the ShopSite Components
VI. Creating an Installable Language Pack
VII. Installing the Translated Help
VIII. Testing the Translation
Introduction

The ShopSite Localization Kit contains the source files and instructions required to localize the ShopSite merchant interface, customer interface, and help into any single-byte language that uses the Latin 1 character set. These instructions list the contents of the kit, the tools required to localize ShopSite, and links to specific instructions for translating each component of ShopSite.

Localizing ShopSite requires translation of four components of the program:

Message Catalogs – The text strings in ShopSite that are displayed to merchants and customers.

Images – The navigation buttons and other graphics that are displayed to merchants and customers.

Transact Screen Pack – Text strings that are displayed to merchants administering ShopSite TX stores and to customers on the order form (only required for ShopSite TX stores).

ShopSite Help – The help information that merchants can view when administering their stores.

Each component requires different tools and methodologies for translation, which are described in the detailed instructions for the components.

After the components are translated, they must be built into an installable language pack and then thoroughly tested before being installed and used by merchants and buyers.

Required Tools

The tools and programs listed here are required to translate the components of the ShopSite Localization Kit.

text editor – used to translate the message catalogs and screen pack screens

C++ compiler – used to compile the translated message catalogs

TCL shell –

LiveMotion – used to create localized images

FrameMaker – for translating the help source files

UNIX FrameMaker – required for batch processing the help source files

KornShell – used for batch processing the help source files to produce help HTML files

Contents of the Kit

You should have downloaded the following four files that make up the Localization Kit:

shopsite-ui.zip – contains a tar file of the message catalogs.

help_source.zip – contains the source files and image files used in ShopSite help.

make_lang_zip.zip – contains instructions and a script for converting translated message catalogs, images, and screen pack files into a zip file that can be installed on ShopSite systems. (Note that the help files are installed separately and are not part of this zip file.)

readme-first.txt

Unpacking the Kit

To unpack the zip files that make up the language kit:

Create a working directory, such as "WD", to contain the source files and your translated files.

Create a directory called "en-US" under the directory that you created in step 1.

Create another directory at the same level to contain the translated files. You should name this directory with the standard ISO locale naming structure, which is the two-letter code for the language (in lowercase), a dash, then the two-letter code for a locale (in uppercase). For example, the French language for use in France is fr-FR, and the French language for use in Canada is fr-CA.

Unzip the shopsite-ui.zip file, and then untar the resulting shopsite-ui.tar file into the en-US directory. Be sure to retain the folder structure contained in the zip file.

Unzip the help_source.zip file into the en-US directory. Be sure to retain the folder structure contained in the zip file.

Copy all files and directories from the en-US directory to the directory that you created for the translation. Perform all translation work on the files in the translation directory, and leave the en-US directory for reference.

Verify that your working directory has the following structure:

Translating the ShopSite Components

Each component of the ShopSite Localization Kit requires different tools and procedures for translation. Follow these links for detailed instructions:

Translating message catalogs

Translating buttons

Translating the screen pack

Translating the help

Creating an Installable Language Pack

The ShopSite Localization Kit includes files and utilities for creating a zip archive (language pack) from the localized files for a language. Creating a language pack involves three steps: putting the translated files into the correct directory structure, editing the lpscript-language file, and making the zipped language pack.
Put the translated files into the correct directory structure

The directory structure required to make an installable language pack is not exactly the same as the structure of the source files. Create the following directory structure and copy the translated files into it.
 WD

  images

   LiveMotion

       button

        buyer

         images

        sample

         images

        seller

            images

       navbar

           section

            images

           tab

            images

           tip

               images

  screen_pack

   images

     images

   screens

  Ui -- contains compiled message catalog and .dat files.
Edit the lpscript-language File

To begin, unzip the make_lang_zip.zip file into the sslockit directory that contains the directories with all of your translated files.
Open lpscript-language file with a text editor.
Scroll to near the end of the file. The only lines that you need to change are at the end of the file, starting with <loc-LOC>.
Change all instances of "loc-LOC" to the abbreviation for the new locale, such as "fr-FR".

Change the following fields in the line that starts with "addlocale":

loc-LOC – change to the new locale

Language, Country (loc-LOC)– This is the text string that merchants will see when they are selecting this locale from a drop-down list. Change to a descriptive text string describing the language and country for the translation, with the locale in parentheses, such as "Français, France (fr-FR)"

. (period) – Change to the decimal separator used in the currency for this locale.

, (comma) – Change to the thousands separator used in the currency for this locale.

lbs – Change to the abbreviation for the unit of weight that will be used by merchants in this locale, such as "kg."

%a %b %d %Y – The date format for the locale. Use the definitions in the comment section of the file to build a date representation. The default settings would format the date like this: Fri Mar 10 2000.

%a %b %d %Y %I:%M:%S %p – The combined date-time format for the locale. This is usually a combination of the date format and the time format.

%I:%M:%S %p – The time format for the locale. Use the definitions in the comment section of the file to build a time representation. Don't forget to include punctuation. The default settings would format the time like this: 09:38:52 a.m.
If you want to support more than one locale with this language, copy the section of text that you just changed and paste it at the bottom of the file. Make the same changes for the new locale as you did for the first one. You can define as many locales as needed. Here is a section of the lpscript file for the French language that defines two locales:
<fr-FR>
untar fr-FR.tar nls/fr-FR
untar fr-FR-images.tar images/fr-FR
copy images/fr-FR media
addlocale |fr-FR|Fran&ccedil;ais, France (fr-FR)|latin1|,|.|kg|%a %b %d %Y|%a %b %d %Y %I:%M:%S %p|%I:%M:%S %p
</fr-FR>

<fr-BE>
addlocale |fr-BE|Fran&ccedil;ais, Belgique (fr-BE)|latin1|,|.|kg|%a %b %d %Y|%a %b %d %Y %I:%M:%S %p|%I:%M:%S %p
symlink nls/fr-BE to nls/fr-FR
symlink images/fr-BE to images/fr-FR
</fr-BE>
  
Save the file with a new name that represents your language, such as lpscript-Francais.
Zip Up the Language Pack

To zip up the language files into an installable language pack, run the make_lang_zip script from the sslockit directory, using this syntax:
  > make_lang_zip path_orig language locale lpscript-language
where:

path_orig is the directory containing the translated files. Do not include the full path to the directory, just the directory name.

language is the name of the translated Language, such as French

locale is the abbreviation for the locale, such as fr-FR

lpscript-language is the name of the modified lpscript file, such as lpscript-French

After the script completes, verify that there is a new file called XXX. Install and test this file according to the procedures in section VIII of these instructions.

Installing the Translated Help

You can install the ShopSite help files either on a server that is hosting ShopSite stores or on a separate server. There is a variable in the global.aa file that must be set to point to the server that hosts the help files.

In addition to the translated help files, you must install help files for all languages that merchants can select. The English help files are included in the localization kit, since English is included with ShopSite.

To install ShopSite help files on a server:

Create a directory named "help" to hold the help. This directory must be at the Web server root, so that it's URL will be similar to www.yourserver.com/help, and it must have permissions set so that the Web server can read files from the directory.

Create the following directory structure under the directory that you just created:
help/version/locale

such as:

Copy the translated help files underneath the locale directory so that the final directory structure looks like this (the locale name will be different):

Note: If you will be hosting only ShopSite SC or ShopSite TX stores, you do not need help directories for the other product.

Create symbolic links from the templates directory to a templates directory under each exp, lte, mgr, and pro directory.

Create an en-US directory under the help directory and copy in the English help files that came with the localization kit.
Create additional directory trees for all languages and locales that you will be supporting. You can create links to an existing locale for other locales that use the same language. For example, en-UK can be linked to en-US.

After installing ShopSite on a server, open the global.aa file and edit the help_domain_name variable to point to the server that is hosting the help. Note that you only need the server name; you do not need to include the path to the help. ShopSite expects the help to be arranged as described above.

Testing the Translation

It is essential that you thoroughly test all ShopSite screens after translating the text and images, both to verify that no English text or images remain and to verify that ???

We have provided a document that outlines the functional flow of the ShopSite user interface. It is not meant to be a complete test procedure for functional or linguistic testing. It provides a complete list of screens in each of the different ShopSite products, so that testers don't need to go through all of the functionality for each product. Part I gives general information for preparing the test environment. Part II contains the list of screens.