How to Localize Email Notifications of WebHelp Classic with Feedback Output
Edit online

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.

Using Oxygen XML Editor/Author

To change the language of the emails for WebHelp Classic with Feedback output using a transformation scenario from within Oxygen XML Editor/Author, follow this procedure:
  1. Create the following directory, depending on your framework:
    • DITA: DITA-OT-DIR\plugins\com.oxygenxml.webhelp.classic\oxygen-webhelp\resources\php\templates\[Language code] (where the Language code is the 2-digit code, such as nl for Dutch)
    • DocBook: [DocBook XSL directory]\com.oxygenxml.webhelp.classic\oxygen-webhelp\resources\php\templates\[Language code] (where the Language code is the 2-digit code, such as nl for Dutch)
  2. Copy all English template files from the following directory (depending on your framework) and paste them into the directory you just created.
    • DITA: DITA-OT-DIR\plugins\com.oxygenxml.webhelp.classic\oxygen-webhelp\resources\php\templates\en
    • DocBook: [DocBook XSL directory]\com.oxygenxml.webhelp.classic\oxygen-webhelp\resources\php\templates\en
  3. Edit the HTML files from the following directory (depending on your framework) and translate the content into your language.
    • DITA: DITA-OT-DIR\plugins\com.oxygenxml.webhelp.classic\oxygen-webhelp\resources\php\templates\[Language code] (where the Language code is the 2-digit code, such as nl for Dutch)
    • DocBook: [DocBook XSL directory]\com.oxygenxml.webhelp.classic\oxygen-webhelp\resources\php\templates\[Language code] (where the Language code is the 2-digit code, such as nl for Dutch)
  4. Edit a WebHelp Classic with Feedback transformation scenario and open the Parameters tab.
  5. In the Parameters tab, look for the default.language parameter and set its value to the appropriate language code (for example, 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.

Using a Script Outside of Oxygen XML Editor/Author

Important: Running WebHelp transformations from a script outside of Oxygen XML Editor/Author requires an additional license and some additional setup:
To change the language of the emails for WebHelp Classic with Feedback output using a script outside of Oxygen XML Editor/Author, follow this procedure:
  1. Create the following directory, depending on your framework:
    • DITA: DITA-OT-DIR\plugins\com.oxygenxml.webhelp.classic\oxygen-webhelp\resources\php\templates\[Language code] (where the Language code is the 2-digit code, such as nl for Dutch)
    • DocBook: [DocBook XSL directory]\com.oxygenxml.webhelp.classic\oxygen-webhelp\resources\php\templates\[Language code] (where the Language code is the 2-digit code, such as nl for Dutch)
  2. Copy all English template files from the following directory (depending on your framework) and paste them into the directory you just created.
    • DITA: DITA-OT-DIR\plugins\com.oxygenxml.webhelp.classic\oxygen-webhelp\resources\php\templates\en
    • DocBook: [DocBook XSL directory]\com.oxygenxml.webhelp.classic\oxygen-webhelp\resources\php\templates\en
  3. Edit the HTML files from the following directory (depending on your framework) and translate the content into your language.
    • DITA: DITA-OT-DIR\plugins\com.oxygenxml.webhelp.classic\oxygen-webhelp\resources\php\templates\[Language code] (where the Language code is the 2-digit code, such as nl for Dutch)
    • DocBook: [DocBook XSL directory]\com.oxygenxml.webhelp.classic\oxygen-webhelp\resources\php\templates\[Language code] (where the Language code is the 2-digit code, such as nl for Dutch)
  4. Use the args.default.language parameter in your transformation script and set its value to the appropriate language code (for example, 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.
  5. Execute the transformation script.
For example, a DITA to WebHelp Classic with Feedback script might look like this:
  • Windows:

    dita.bat -i c:\mySample.ditamap -f webhelp-feedback -Dargs.default.language=nl

  • Mac OS X/ Linux:

    dita -i /mySample.ditamap -f webhelp-feedback -Dargs.default.language=nl