How to Localize the Interface of WebHelp Output

Static labels that are used in the WebHelp output are kept in translation files in the [OXYGEN_DIR]/frameworks/dita/DITA_OT/plugins/com.oxygenxml.webhelp/oxygen-webhelp/resources/localization folder. By default, the DITA-OT folder is [OXYGEN_DIR]/frameworks/dita/DITA-OT, or possibly elsewhere if you are using a different DITA-OT distribution. Translation files have the strings-lang1-lang2.xml name format, where lang1 and lang2 are ISO language codes. For example, the US English text is kept in the strings-en-us.xml file.

Follow these steps to localize the interface of the WebHelp output:

  1. Look for the strings-[lang1]-[lang2].xml file in [OXYGEN_DIR]/frameworks/dita/DITA_OT/plugins/com.oxygenxml.webhelp/oxygen-webhelp/resources/localization (for example, the Canadian French file would be: strings-fr-ca.xml). If it does not exist, create one starting from strings-en-us.xml.
  2. Translate all the labels from the above language file. Labels are stored in XML elements that have the following format: <str name="Label name">Caption</str>.
  3. Make sure that the new XML file that you created in the previous two steps is listed in the file [OXYGEN_DIR]/frameworks/dita/DITA_OT/plugins/com.oxygenxml.webhelp/oxygen-webhelp/resources/localization/strings.xml. In our example for the Canadian French file, it should be listed as: <lang xml:lang="fr-ca" filename="strings-fr-ca.xml"/>
  4. Edit the DITA Map WebHelp/DITA Map WebHelp with Feedback transformation scenario and set the args.default.language parameter to the code of the language you want to localize (for example, fr-ca for Canadian French).
  5. Run the transformation scenario to produce the WebHelp output.
Related information
Defining a New Transformation Scenario