Creating a localized help collection

Actuate Java Component supports localizing help collections by placing localized help files into the help directory for the appropriate locale. The <context_root>\help directory contains several locale-specific help directories. For example, the United States English help subdirectory is <context_root>\help\en_us. Other help locale directories can be populated with localized help to provide help for customers in other locales and in other languages. In order to maintain proper help navigation and context-sensitive help links, localized help pages must have the same name as the help pages provided by Actuate.

How to create a localized help collection

Use the following procedure to create a localized online help collection for Java Component that maintains context-sensitive help requests and help navigation.

1	Copy the all of the non-locale-specific directories from <context_root>\help into the appropriate locale-specific directory. For example, for the Italian locale, copy the files into <context_root>\help\it_it.

2	Create localized versions of existing help files in a separate directory.

3	In the locale-specific directory, copy the localized versions of the help files over the English files of the same name. The localized help can be accessed using the following URL:

http://localhost:8700/ajc11/help/<locale-specific directory>/wwhelp.htm

For example, for the Italian locale-specific help, use the following URL:

http://localhost:8700/ajc11/help/it_it/wwhelp.htm

4

Test your results by opening Java Component, selecting the new locale on the login page, and selecting a help link. The resulting page is from the custom application. For example, the help link on the login page shown in Figure 10-3 would link to http://localhost:8700//ajc11//help/it_it/wwhelp/wwhimpl/common/html/wwhelp.htm#href=using-dk/DKmanaging-reports.3.02.html#229645&single=true.

How to make locale-specific online help the default help

Use the following procedure to make a locale-specific help collection the default help for Java Component.

1	Open wwhelp.htm in the <context root>\help directory in a text editor. Find the following line:

setTimeout("location.replace(\"/wwhelp/wwhimpl/common/html/switch.htm" + Parameters + "\");", 1);

Add the locale-specific directory to the URL string, as shown in the following code:

setTimeout("location.replace(\"/<locale-specific directory>/wwhelp/wwhimpl/common/html/switch.htm" + Parameters + "\");", 1);

For example, to set the Italian locale as the default locale for context-sensitive help, change the line to the following one:

setTimeout("location.replace(\"/it_it/wwhelp/wwhimpl/common/html/switch.htm" + Parameters + "\");", 1);

2	Save and close wwhelp.htm.

3	Copy the all of the non-locale-specific directories from <context_root>\help into each English locale-specific directory - en_au, en_bz, en_ca, en_gb, en_ie, en_nz, en_us, and en_za. For example, for US English, copy the files into <context_root>\help\en_us.

4	In each English locale-specific directory, open wwhelp.htm in a text editor. Find the following line:

setTimeout("location.replace(\"../wwhelp/wwhimpl/common/html/switch.htm" + Parameters + "\")

Add the locale-specific directory to the URL string, as shown in the following code:

setTimeout("location.replace(\"/<locale-specific directory>/wwhelp/wwhimpl/common/html/switch.htm" + Parameters + "\");", 1);

For example, to set US English help to the en_us locale for context-sensitive help, change the line to the following one:

setTimeout("location.replace(\"/en_us/wwhelp/wwhimpl/common/html/switch.htm" + Parameters + "\");", 1);

5

Test your results by opening Java Component and selecting a help link. The resulting page is from the custom application. For example, the help link on the login page shown in Figure 10-3 would link to http://localhost:8700/ajc11/help/it_it/wwhelp/wwhimpl/common/html/wwhelp.htm#href=using-dk/DKmanaging-reports.3.02.html#229645&single=true.

Then, test an English locale by selecting an English locale on the login page and then selecting a help link. The resulting page is from the English locale help. For example, the help link on the login page shown in Figure 10-3 would link to http://localhost:8700/ajc11/help/en_us/wwhelp/wwhimpl/common/html/wwhelp.htm#href=using-dk/DKmanaging-reports.3.02.html#229645&single=true for the US English locale.

Copyright Actuate Corporation 2012