Help File Multi-language Support

Multiple languages are supported for Issue help files in the two following ways:

• Translation of hyperlink labels based on the current language.

• Display of help file based on the current language.

This enables help file authors to install different sets of help files for different languages when a system is deployed while allowing users to choose their preferred language when accessing the system.

By default, the issue help file name is used as the hyperlink label displayed in the Issue Viewer. To display a different hyperlink label, one or more link translation files can be stored in the IssueHelp\LINKS directory. A link translation file maps an issue help file name to a hyperlink label.

Example: Suppose there are two help files associated with the "Cisco Running Config Not Saved" issue:

• 01Information.txt

• 02SavingConfig.doc

The link translation file for English, en_US.txt, contains these entries:

• 01Information=Additional Information About Saved Configurations

• 02SavingConfig=Procedure for Saving Cisco Configuration

The link translation file for Traditional Chinese, zh_TW.txt, contains these entries:

• 01Information=

• 02SavingConfig=

In these examples, the file names are prepended by an index number, which specifies the order in which the hyperlinks are displayed in the See Also list.

The link translation files define how the issue help file names should be displayed in the hyperlink labels based on the user's current language selection. NetMRI will automatically use the appropriate link translation file if one is defined. If NetMRI doesn't find a link translation file, the issue help file name is shown as the hyperlink label.

Issue help files and the issue link translation files in this example are organized in the following manner: NetMRI uses the contents of the zh_TW directory if that is the language selected by the user. If no subdirectory exists for the current language, then the files in the CiscoRunningConfigNotSaved directory are used.