Localizing the Email Notifications of WebHelp with Feedback Systems

The feedback-enabled WebHelp systems use emails to notify users when comments are posted. These emails are based on templates stored in the WebHelp directory. The default messages are in English, French, German, and Japanese. These messages are copied into the WebHelp system deployment directory during the execution of the corresponding transformation scenario.

Suppose that you want to localize the emails into Dutch (nl). Follow these steps:

DocBook WebHelp Classic with Feedback

  1. Create the following directory:

    [OXYGEN_INSTALL_DIR]\frameworks\docbook\xsl\com.oxygenxml.webhelp.classic\oxygen-webhelp\resources\php\templates\nl

  2. Copy all English template files from [OXYGEN_INSTALL_DIR]\frameworks\docbook\xsl\com.oxygenxml.webhelp.classic\oxygen-webhelp\resources\php\templates\en and paste them into the directory you just created.
  3. Edit the HTML files from the [OXYGEN_INSTALL_DIR]\frameworks\docbook\xsl\com.oxygenxml.webhelp.classic\oxygen-webhelp\resources\php\templates\nl directory and translate the content into Dutch.
  4. Start Oxygen XML Author plugin and edit the DocBook WebHelp Classic with Feedback transformation scenario.
  5. In the Parameters tab, look for the l10n.gentext.default.language parameter and set its value to the appropriate language code. In our example, use the value nl for Dutch.
    Note: If you set the parameter to a value such as LanguageCode-CountryCode (for example, en-us), the transformation scenario will only use the language code
  6. Run the transformation scenario to obtain the WebHelp with Feedback output.

DITA WebHelp Classic with Feedback

  1. Create the following directory:

    DITA-OT-DIR\plugins\com.oxygenxml.webhelp.classic\oxygen-webhelp\resources\php\templates\nl

  2. Copy all English template files from DITA-OT-DIR\plugins\com.oxygenxml.webhelp.classic\oxygen-webhelp\resources\php\templates\en and paste them into the directory you just created.
  3. Edit the HTML files from the DITA-OT-DIR\plugins\com.oxygenxml.webhelp.classic\oxygen-webhelp\resources\php\templates\nl directory and translate the content into Dutch.
  4. Start Oxygen XML Author plugin and edit the DITA Map WebHelp Classic with Feedback or DITA Map WebHelp Responsive with Feedback transformation scenario.
  5. In the Parameters tab, look for the args.default.language parameter and set its value to the appropriate language code. In our example, use the value nl for Dutch.
    Note: If you set the parameter to a value such as LanguageCode-CountryCode (for example, en-us), the transformation scenario will only use the language code
  6. Run the transformation scenario to obtain the WebHelp with Feedback output.

DITA WebHelp Responsive with Feedback

  1. Create the following directory:

    DITA-OT-DIR\plugins\com.oxygenxml.webhelp.responsive\oxygen-webhelp\resources\php\templates\nl

  2. Copy all English template files from DITA-OT-DIR\plugins\com.oxygenxml.webhelp.responsive\oxygen-webhelp\resources\php\templates\en and paste them into the directory you just created.
  3. Edit the HTML files from the DITA-OT-DIR\plugins\com.oxygenxml.webhelp.responsive\oxygen-webhelp\resources\php\templates\nl directory and translate the content into Dutch.
  4. Start Oxygen XML Author plugin and edit the DITA Map WebHelp Classic with Feedback or DITA Map WebHelp Responsive with Feedback transformation scenario.
  5. In the Parameters tab, look for the args.default.language parameter and set its value to the appropriate language code. In our example, use the value nl for Dutch.
    Note: If you set the parameter to a value such as LanguageCode-CountryCode (for example, en-us), the transformation scenario will only use the language code
  6. Run the transformation scenario to obtain the WebHelp with Feedback output.