Edit online

Adding Oxygen Feedback to WebHelp Generated from Oxygen XML Editor/Author

To install Oxygen Feedback in your WebHelp output generated using a transformation scenario from Oxygen XML Editor or Oxygen XML Author, use this procedure:

Prerequisites

  • You must create an account to access Oxygen Feedback.
  • To install and manage Oxygen Feedback Cloud, you will need to 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.
    Notice:
    If your subscription expires or if the number of page views allowed by your plan is exceeded for a particular month, you will receive a notification and the comments component will be disabled until the subscription is renewed/upgraded or until the end of the month (in the case of exceeding the page views limit). If an expired subscription is not renewed, the comments are still visible for a limited period of time (e.g. 2 weeks). After that, they will no longer be displayed.

Installation Procedure

  1. Log in to your Feedback account from the administration interface login page (https://feedback.oxygenxml.com/login). You can also access the administration interface by logging in from a page where the Oxygen Feedback commenting component is installed and then select Home from your user drop-down menu.

    Step Result: You are directed to the Dashboard page.

  2. Click the Create first site button in the Get Started pane to create a site configuration (or click the Add site link in the top-right corner of the Sites pane or go to the Sites page and click the Add site button).
  3. In the Settings page, enter a Name and Description for the site configuration. Some optional settings can be adjusted according to your needs. For more details, see the Settings Page topic. Click Continue.

  4. In the Version page, you must specify a version and the base URL from your website where the WebHelp output is deployed. The Name field is where you specify the version name or identifier. This is helpful if there will be multiple versions for your output. For example, if your published output is documentation for a product that has multiple released versions, each version probably has its own published documentation. In this case, each published version requires a different configuration since the version and base URL would be different for each of them.

    The Base URL field is where you specify the base URL for the website where you publish your output. For WebHelp output, for example, it is the URL where your WebHelp output is deployed. Comments will only be displayed on pages within the hierarchy of the specified base URL. For more details, see the Version Page topic. Click Continue.

  5. In the Installation page, choose the Install Feedback in WebHelp output generated from Oxygen XML Editor/Oxygen XML Author option.
  6. Copy the generated HTML fragment from the Installation page in the admin UI.

  7. In Oxygen XML Editor/Author, open the Configure Transformation Scenario(s) dialog box using the toolbar button in the DITA Maps Manager.

  8. Select and duplicate the DITA Map WebHelp Responsive scenario.

  9. Go to the Feedback tab, click the Edit button located at the bottom-right of the dialog box, and paste the HTML fragment that was copied to the clipboard.

  10. Run the transformation and deploy the WebHelp output to a web server.

Install Feedback Using a Publishing Template

It is also possible to install Oxygen Feedback using an Oxygen Publishing Template:
  1. Complete steps 1 through 4 in the procedure above.
  2. In the Installation page, choose the Install Feedback in WebHelp output generated from a command line option.
  3. In Oxygen XML Editor/Author, create an XML file (for example, feedback-install.xml) on disk with the content generated in the Installation page from the Feedback admin UI.
  4. Create a Publishing Template, if you have not already done so. If you need help, see Working with Publishing Templates.
  5. Copy the newly created XML file to a folder inside the publishing template's root folder.
  6. Open the template descriptor file associated with your publishing template and add a reference to the newly created XML file in the html-fragments section.
    <publishing-template>
 ...    
  <html-fragments>
    <fragment file="fragments/feedback-install.xml" 
     placeholder="webhelp.fragment.feedback"/>
  </html-fragments>

  7. Open the Configure Transformation Scenario(s) dialog box using the toolbar button in the DITA Maps Manager and duplicate the DITA Map WebHelp Responsive scenario.

  8. Click the Choose Custom Publishing Template link and select your template.
  9. Click OK to save the changes to the transformation scenario.

  10. Run the transformation and deploy the WebHelp output to a web server.

Resources

To see a demonstration of how to install Oxygen Feedback in WebHelp output generated from Oxygen XML Editor, watch our installation video: