Localization for the Web Help user interface

Publish

Platform_KC
On Premises

When you are publishing content that the Localize module has localized, the Web Help user interface (UI) supports the following languages:

Arabic

ar

Hindi

hi

German

de

Italian

it

English

en

Japanese

ja

French

fr

Russian

ru

Hebrew

he

Chinese

zh

Note: Some locales, such as when a base language has differences in the locales, are not currently supported. For example, simplified and traditional Chinese. If you publish Chinese (Traditional, Hong Kong SAR China) (zh- HK) or Chinese (Traditional, Taiwan) (zh-TW) they use the Chinese (zh) locale. You may need to update the JS file for these locales.

What has been localized in the UI for the supported languages?

  • Contents tab name
  • Index tab name
  • Search field and Mach partial words option
  • Tooltips for the toolbar buttons

Web Help Localized UI

How does it work?

When you have localized your content in Author-it using the Localize module, the content is assigned a value for the SYS_LOCALE_ABBREVIATION.

The Web Help publishing index.htm template includes JavaScript references in the head section and the configuration setting with the <

When you publish you localized content, the <Templates\Web Help\uilocale folder, then Web Help opens using the localized UI.

However, if you publish content that can't be matched to a supported locale, then the UI defaults to English.

Can I make my own locale files?

The files needed for a locale are the CSS file and the JS file. You need to create a CSS file and a JS file for your locale, and name them using the two letter locale code used in Localize. Store both of your files in the Templates\Web Help\uilocale folder.

  1. Use the CSS file if you need to overwrite any styling elements. In most files provided the files are empty. Only the Arabic and the Hebrew css files contain styling code.
  2. The JS file contains the text strings for elements in the UI - including tabs, button names or tooltips, and messages. Each of the text strings are in English in the first column; just add your localized text stings to the second column.

    Web Help JS file