---

Help Components

The ShopSite help files are produced from three types of source files:

• HTML files, in the install and keys directories
• FrameMaker files, in the source directory
• Image files, in the images directory

Translating the HTML Files

The HTML files in the install and keys directories can be translated with an HTML editor or a text editor.

Note:

Some WYSIWYG editors add unwanted HTML tags to files. For best results, use a text editor such as Notepad or emacs to edit the HTML files.

Translating the FrameMaker Files

The FrameMaker files in the help/source directory serve as a single set of source files for producing all eight versions of ShopSite help (SC Pro, TX Manager, etc.). FrameMaker is used primarily as a text editor with conditional text support. After the source files are translated, they are run through a batch-mode script on FrameMaker for UNIX, which produces the eight different versions of the help, based on the conditional text settings.

To translate the FrameMaker files:

1. The help/source directory contains four text files (.txt). Open these files with a text editor and translate the few words contained in each. Save them as text files with the same names in the same directory. All of the FrameMaker files include these files by reference.
2. Translate the page.attributes.table.fm and product.attributes.table.fm files. Several other files include these files by reference.
3. Translate the rest of the FrameMaker files, except for these:
   • ConditionalSCExp.fm.
   • ConditionalSCLte.fm.
   • ConditionalSCMgr.fm.
   • ConditionalSCPro.fm.
   • ConditionalTXExp.fm.
   • ConditionalTXLte.fm.
   • ConditionalTXMgr.fm.
   • ConditionalTXPro.fm.
   • RemoveFiles.fm.
4. On a UNIX machine with UNIX FrameMaker and KornShell installed, create the following directory structure underneath the help directory:

   

5. Copy the translated FrameMaker source files into the source directory. Also copy the files listed in step 3, above, and the CreateBatchCommands.ksh file.
6. Run the CreateBatchCommands.ksh on all the FrameMaker files. This script creates a file called MyBatchCommands, which contains batch commands that can be processed by the fmbatch mode of FrameMaker for UNIX.

   > CreateBatchCommands.ksh *.fm

7. Run fmbatch, and pass in the file of batch commands as an argument:

   > fmbatch MyBatchCommands

8. Change directory to each of the eight help directories in turn (sc/pro, sc/mgr, etc.). In each directory, make the RemoveFiles.html file executable and then execute it. This removes files that don't apply to each version of the help.
9. Open the HTML files in a browser and verify the translation. (Note that the graphics will not appear with this directory structure.)

Translating the Image Files

Several of the image files for the help are created in Adobe LiveMotion. The text for those images is included in the LiveMotion source files, so by following the instructions for translating the LiveMotion files, you have already translated those help images. After you have finished translating the LiveMotion files, copy these files into the help/images directory:

• From the button/seller folder:
  • feedback.gif
  • quickstart.gif
  • search.gif
  • topics.gif

• From the navbar/section folder:
  • help_resource_center.gif
• Also copy the help_resource_center.gif file into the help/install folder.

• Copy all gif files from the button/sample/images folder to the help/images/buttons folder.

Some of the other help graphics are screenshots that need to be captured after the product graphics and message catalogs have been translated. By looking at the English versions of the graphics, someone familiar with ShopSite should be able to recreate the screens. Click here for more details on these files.

The rest of the help graphics do not require translation.