Edit online

Adding Oxygen Feedback to WebHelp Responsive Documentation

You can add Oxygen Feedback in WebHelp Responsive for DITA output to benefit from a modern commenting system, advanced ready-to-use search engine, administrative interface, and Oxygen XML Editor/Author integration.

Comments Component
A comments component is presented in your WebHelp Responsive output to provide a simple and efficient way for your community to interact and offer feedback. The comments component is contributed by Oxygen Feedback, a modern comment management system that can be integrated with your WebHelp Responsive output to provide a comments area at the bottom of each WebHelp page where readers can add new comments or reply to existing ones.
External Search Engine
Oxygen Feedback can be configured as an external search engine for the Oxygen WebHelp Responsive output. This function be enabled from the Content Indexing and Search section that is available in the Version Settings page.
Administration Interface
Oxygen Feedback includes a modern, user-friendly administration interface where you can moderate comments, manage users, view statistics, and configure settings. It is very easy to integrate and there are no requirements for installing additional software. You simply need to create an Oxygen Feedback site configuration in the administration interface, copy the HTML installation fragment that is generated at the end of the creation process, and paste the generated fragment in the Feedback tab in the WebHelp Responsive transformation scenario dialog box.
Oxygen XML Editor/Author Integration
An add-on is available that contributes a Feedback Comments Manager view in Oxygen XML Editor/Author where the documentation team can see all the comments added in your WebHelp output. This means they can react to user feedback by making corrections and updating the source content without leaving the application.

Deploying the Oxygen Feedback Comments Component

Prerequisite

To install and manage Oxygen Feedback, you will need to obtain a license for the product. This requires that you choose a subscription plan during the installation procedure. To see the subscription plans prior to installing the product, go to: https://www.oxygenxml.com/oxygen_feedback/buy_feedback.html.

Installation Procedure
  1. Log in to your Feedback account from the administration login page (https://feedback.oxygenxml.com/login). 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.
  2. Click the Add site button to create a site configuration. If you have not already selected a subscription plan, you will be directed to a page where you can choose from several options.
  3. In the Settings page, enter a Name and Description for the site configuration. There are some optional settings that can be adjusted according to your needs. For more details, see the Site Settings topic. Click Continue.
  4. In the Initial version page, enter the Base URL for your website (you can add additional URLs by clicking the Add button). You can also specify an Initial version if you want it to be something other than 1.0. If you do not plan to have multiple versions, leave the version as 1.0. For more details, see the Initial Version topic.
  5. [Optional] To configure Oxygen Feedback as an external search engine check the Enable content indexing option.
  6. Click Continue.
  7. In the Installation page, choose a site generation option:
    1. If you will generate the documentation using a transformation scenario in Oxygen XML Editor/Author, select the Oxygen XML Editor option and continue with these steps:
      1. Copy the generated HTML fragment and click Finish.
      2. In Oxygen XML Editor/Author, open the Configure Transformation Scenario(s) dialog box.
      3. Select and duplicate the DITA Map WebHelp Responsive scenario.
      4. Go to the Feedback tab.
      5. Click the Edit button and paste the generated installation fragment.
    2. If you will generate the documentation using a command-line script, select the Oxygen XML WebHelp option and continue with these steps:
      1. Copy the generated HTML fragment and click Finish.
      2. Create an XML file (for example, feedback-install.xml) with the generated installation fragment.
      3. Use the webhelp.fragment.feedback parameter in your command-line script to specify the path to the file you just created. For example:
        dita.bat -Dwebhelp.fragment.feedback=c:\path\to\feedback-install.xml
  8. [Optional] If you want the Oxygen Feedback comments component to fill the entire page width, contribute a custom CSS file (use the args.css parameter to reference it) that contains the following style rule:
    div.footer {
  float: none;
}

For more details about Oxygen Feedback, how to configure settings, moderate comments, view statistics, and much more, see the Oxygen Feedback user guide.

Also, to see a demonstration of Oxygen Feedback being integrated into WebHelp Responsive output, watch our Webinar: DITA Publishing and Feedback with Oxygen Tools.