How to install Oxygen Feedback on Your Website

The Oxygen Feedback comment system can be added at the bottom of each topic in your WebHelp Responsive documentation or added to any HTML-based website.

Prerequisites

  • If you want to add Oxygen Feedback to WebHelp documentation, you must have an installed version of Oxygen XML Editor or Oxygen XML Author with a valid license.
  • You need to sign up for a Feedback account from the administration login page. You can click on Log in with Google or Log in with Facebook to create an account using your Google or Facebook credentials, or click the Sign Up tab to create an account using your name and email address.

Instructions

  1. Log in to your Feedback account from the administration login page.

  2. Click the Add site button to create a Feedback site configuration.

  3. In the Settings page, enter a Name and Description for the site configuration. There are some optional settings (for example, you can add a logo or specify whether or not comments require moderation). Click Continue.

  4. In the Initial version page, enter the Base URL for your website. You can also specify an Initial version if you want it to be something other than 1.0. Click Continue.

  5. In the Installation page, choose a site generation option:

    • If you want to add Oxygen Feedback to WebHelp documentation using a transformation scenario in Oxygen XML Editor/Author, select the Oxygen XML Editor option and follow the on-screen instructions.
    • If you want to add Oxygen Feedback to WebHelp documentation using a command-line script, select the Oxygen XML WebHelp option and follow the on-screen instructions.
    • If you want to add Oxygen Feedback to HTML-based web pages, select the Any Platform option, copy the HTML fragment shown in the box, and paste it into your HTML code for each web page that you want to have the Feedback system embedded.