Edit online

Adding Oxygen Feedback to WebHelp Generated with Oxygen Content Fusion

To install Oxygen Feedback in your WebHelp output generated with Oxygen Content Fusion, use this procedure:

Prerequisites

Installation Procedure

  1. Log in to your Feedback account from the 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.

    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 with Oxygen Content Fusion option.
  6. Create an XML file (e.g. feedback-install.xml) on disk with the following content:
    <div xmlns="http://www.w3.org/1999/xhtml" id="oxygen-feedback-frame-container">
        <script id="feedback-init" defer="defer"
            src="https://<server-url>/app/init/init.js?deploymentToken=<token>"><!-- --></script>
    </div>

    The file content (with the actual server URL and deployment token) can be copied or downloaded directly from the Oxygen Feedback administration interface (the Version Installation Instructions page).

  7. Upload the file created in the previous step to your Content Fusion project (for example, in the .contentfusion directory, click Upload file from the contextual menu).

  8. Open the DITA project file (.contentfusion/ditaProject.xml) in the text editing mode (click More > Edit XML Source in the Content Fusion editor's toolbar).
  9. Add the webhelp.fragment.feedback parameter to your WebHelp deliverable inside the <publication> element:
    <param href="feedback-install.xml" name="webhelp.fragment.feedback"/>

    Set the parameter value to the path of the XML file created in step 6 that contains the installation fragment.

  10. Commit the changes in the Content Fusion workspace and build the WebHelp deliverable.

Tip:
A pre-built AI Positron prompt is available in the Version Installation Instructions page (when you expand the instructions). You can copy it and paste it into the AI Positron assistant in Content Fusion to complete the setup automatically.