C H A P T E R 4

Localizing Interfaces

In addition to changing the look and feel of the Sun Java System Content Delivery Server interfaces, you can also change the language in which the pages are presented. The text strings used by the interfaces are in property files that you can edit to translate the strings to the language of your choice.

This chapter presents the following topics:

Localizing the Subscriber Portal

Localizing the Developer Portal

Localizing the Catalog Manager Administration Console

Localizing the Vending Manager Administration Console

Setting the Currency Symbol

4.1 Localizing the Subscriber Portal

The Subscriber Portal is presented to subscribers in the language that is set for the browser that they are using. If Content Delivery Server does not support the language, the Subscriber Portal is presented in the language that is specified in the subscriber’s profile. You can set the default language for new profiles and customize the strings and images as needed.

4.1.1 Setting the Default Language

By default, the Subscriber Portal is presented in English. You can change the default language to any locale supported by the Catalog Manager. See the online help for the Manage Server Locales page in the Catalog Manager administration console for information on adding locales.

To set the default locale for all Content Delivery Server interfaces, set the i18n.default.locale property in the $CDS_HOME/deployment/deployment-name/conf/CDS.properties file. To change the locale for only the Subscriber Portal, add the i18n.default.locale property to the $CDS_HOME/deployment/deployment-name/conf/SubscriberPortal.properties file. For example, the following statement sets the default language to French:

i18n.default.locale=fr

After you set the default language, you must restart the server.

Note - If you set the default language to something other than English, but want to support English as a language selection, you must copy the $CDS_HOME/deployment/deployment-name/localization/SubscriberPortalLocaleResource.properties file to $CDS_HOME/deployment/deployment-name/localization/SubscriberPortalLocaleResource_en.properties.

4.1.2 Providing Localized Strings

The text strings used for the Subscriber Portal are defined in the SubscriberPortalLocaleResource.properties file and the FulfillmentLocaleResource.properties file in the $CDS_HOME/deployment/deployment-name/localization directory. Note that elements that are entered by an administrator, such as category names and prices, appear as they are entered, regardless of the locale specified.

To change the strings presented or customize the language, follow these steps:

1. Either edit the existing file, or copy the appropriate resource file to a new file. If you are creating a file for a different language, append the language code to the name of the file.

For example, to present the Subscriber Portal in Spanish, create a file named SubscriberPortalLocaleResource_es.properties.

2. Translate the text strings to the right of the equals sign (=). Do not change any strings to the left of the equals sign and do not delete an existing string.

Changes take effect when the file is saved.

4.1.3 Providing Localized Templates and Images

In addition to changing the text for the Subscriber Portal, you can also provide language-specific page templates and images for the PC-based version.

For each locale that you need to support, you need a language-specific version of the SubscriberPortalLocaleResource.properties and FulfillmentLocaleResource.properties files in the $CDS_HOME/deployment/deployment-name/localization directory. For example, to support French you need files named SubscriberPortalLocaleResource_fr.properties and FulfillmentLocaleResource_fr.properties.

Set the following properties in each language-specific SubscriberPortalLocaleResource.properties file.

TABLE 4-1 Localization Properties
Property Name	Description
`desktop.path.templateUrl`	Location of the template file, `_tpl_main.jsp`. This must be a subdirectory under the `/tpl` directory, for example: desktop.path.templateUrl=/tpl/_tpl_main.jsp
`localized.path.image_url`	Location of the localized images. This must be a subdirectory under the `/static/media` directory, for example: localized.path.image_url=/static/media/fr

Source files for the Subscriber Portal are found in the following directory:

If using Sun Java System Application Server, $CDS_HOME/deployment/deployment-name/sun/domains/server-domain/applications/j2ee-modules/CDSSubscriberPortal

If using WebLogic Server, $CDS_HOME/deployment/deployment-name/weblogic/domains/server-domain/applications/subscriber

deployment-name is the name specified when the Vending Manager was deployed. server-domain is the domain name specified in the deployment configuration file for the app.server.domain property.

Create the subdirectories for the templates and images that you specified in the SubscriberPortalLocaleResource.properties files. For example, to support English and French, you might create the following directory structure:

../CDSSubscriberPortal
  /tpl
    /english
    /french
  /static
    /media
      /en
      /fr

In each template subdirectory, include a localized copy of the template file _tpl_main.jsp.

In each image subdirectory, include a copy of all localized images referenced by the Subscriber Portal. Leave images that are not specific to a language in the /static/media root directory. Files that contain the images for the buttons in the Subscriber Portal are described in Section 1.6, Changing Buttons.

In the template files, use the image path variable <%=img_url%> for images in the root image directory. Use the image path variable <%=localized_image_url%> for images in a language-specific subdirectory. The following code example shows the path for an image that is localized.

<td width="175">
  <img src="<%=localized_img_url%>/t0-banner.gif"
      width="165" height="22">
</td>

4.2 Localizing the Developer Portal

The following steps describe the process for presenting the Developer Portal in a different language.

1. In the $CDS_HOME/deployment/deployment-name/conf/CDS.properties file, set the i18n.default.locale property to the locale that you want to use.

This property determines the default locale for the Developer Portal, the Catalog Manager administration console, the Vending Manager administration console, the Subscriber Portal, and log files. To change the locale for only the Developer Portal, add the i18n.default.locale property to the $CDS_HOME/deployment/deployment-name/conf/DeveloperPortal.properties file.

2. In the $CDS_HOME/deployment/deployment-name/localization directory, make a copy of the file DevPortalMessages.properties with the language code appended to the end of the file name.

For example, to present the Developer Portal in Spanish, create a file named DevPortalMessages_es.properties.

3. In the file that you created, translate the text strings to the right of the equals sign (=) using the following guidelines.

Do not change the property names to the left of the equals sign.

Set the following properties to a pattern string as defined in the HTML output of the Javadoc tool for the java.text.SimpleDateFormat class.

date.format

date.format.long

time.format

time.format.long

datetime.format

datetime.format.long

date.format.input

time.format.input

datetime.format.input

Property names that end in .image specify names of image files. To localize an image, replace the file name with the name of a localized image that you created. Image files are in one of the following directories, depending on the application server that you are using:

If using Sun Java System Application Server, $CDS_HOME/deployment/deployment-name/sun/domains/server-domain/applications/j2ee-modules/CDSDeveloperPortal/developer/media

If using WebLogic Server, $CDS_HOME/deployment/deployment-name/weblogic/domains/server-domain/applications/developer/developer/media

The content.developers.agreement.url property points to the file that contains the terms and conditions for submitting content. Set this property to the URL for the localized version of the file.

The login.devguide.link property points to the file that contains the Content Developer Guide. Set this property to the URL for the localized version of the file.

4.3 Localizing the Catalog Manager Administration Console

The following steps describe the process for presenting the Catalog Manager administration console in a different language.

1. In the $CDS_HOME/deployment/deployment-name/conf/CDS.properties file, set the i18n.default.locale property to the locale that you want to use.

This property determines the default locale for the Developer Portal, the Catalog Manager administration console, the Vending Manager administration console, the Subscriber Portal, and log files. To change the locale for only the Catalog Manager administration console, add the i18n.default.locale property to the $CDS_HOME/deployment/deployment-name/conf/AdminConsole.properties file.

2. In the $CDS_HOME/deployment/deployment-name/localization directory, make a copy of the file AdminConsoleMessages.properties with the language code appended to the end of the file name.

For example, to present the administration console in Spanish, create a file named AdminConsoleMessages_es.properties.

3. In the file that you created, translate the strings to the right of the equals sign (=) using the following guidelines.

Do not change the property names to the left of the equals sign.

Set the following properties to a pattern string as defined in the HTML output of the Javadoc tool for the java.text.SimpleDateFormat class.

date.format

date.format.long

time.format

time.format.long

datetime.format

datetime.format.long

date.format.input

time.format.input

datetime.format.input

The property localized.path.image_url specifies the directory in which the images are found. If you want to change any image, copy all images from the directory currently specified to your new directory. Replace the existing file with your version and set the localized.path.image_url property to the new directory name. The directory that you specify must be a subdirectory of one of the following directories, depending on the application server that you are using:

If using Sun Java System Application Server, $CDS_HOME/deployment/deployment-name/sun/domains/server-domain/applications/j2ee-modules/CDSCatalogManager

If using WebLogic Server, $CDS_HOME/deployment/deployment-name/weblogic/domains/server-domain/applications/admin

The login.form.stylesheet property and all property names ending in .layout specify the file name of a template used to generate a web page. If you must change a template, set the corresponding property to the correct file name. Be careful when you change a template because any error might cause the page to display incorrectly or not display at all.

4.4 Localizing the Vending Manager Administration Console

The following steps describe the process for presenting the Vending Manager administration console in a different language.

1. In the $CDS_HOME/deployment/deployment-name/conf/CDS.properties file, set the i18n.default.locale property to the locale that you want to use.

This property determines the default locale for the Developer Portal, the Catalog Manager administration console, the Vending Manager administration console, the Subscriber Portal, and log files. To change the locale for only the Vending Manager administration console, add the i18n.default.locale property to the $CDS_HOME/deployment/deployment-name/conf/VSAdminConsole.properties file.

2. In the $CDS_HOME/deployment/deployment-name/localization directory, make a copy of the file VendingManagerMessages.properties with the language code appended to the end of the file name.

For example, to present the administration console in Spanish, create a file named VendingManagerMessages_es.properties.

3. In the file that you created, translate the strings to the right of the equals sign (=) using the following guidelines.

Do not change the property names to the left of the equals sign.

Set the following properties to a pattern string as defined in the HTML output of the Javadoc tool for the java.text.SimpleDateFormat class.

campaign.time.pattern

date.format

date.format.long

time.format

time.format.long

datetime.format

datetime.format.long

date.format.input

time.format.input

datetime.format.input

For property names beginning with common.names.status or common.names.gender, do not change the character before the vertical bar (|). Translate only the word after the bar.

The property localized.path.image_url specifies the directory in which the images are found. To change any image, copy all images from the directory currently specified to your new directory. Replace the existing file with your version and set the localized.path.image_url property to the new directory name. The directory that you specify must be a subdirectory of one of the following directories, depending on the application server that you are using:

If using Sun Java System Application Server, $CDS_HOME/deployment/deployment-name/sun/domains/server-domain/applications/j2ee-modules/CDSVendingManager

If using WebLogic Server, $CDS_HOME/deployment/deployment-name/weblogic/domains/server-domain/applications/vsadmin

Property names ending in .layout and .stylesheet specify the file name of a template used to generate a web page. If you must change a template, set the corresponding property to the correct file name. Be careful when you change a template because any error might cause the page to display incorrectly or not display at all.

Within the View by Title feature, the administrator can generate a list of content that has a title that begins with a specific letter. The list.alphabet property specifies the letters that can be used. To display the string of letters across more than one line, insert the character specified for the list.alphabet.delimiter property at the break point.

4.5 Setting the Currency Symbol

See Section 12.1, “Set the Currency Symbol,” in the Sun Java System Content Delivery Server Integration and Configuration Guide for information on setting the currency symbol used by all components in a deployment.