Edit online

How to Add an Edit Link to Launch Oxygen XML Web Author

You can embed Edit links in the DITA WebHelp Responsive output that will automatically launch a particular document in Oxygen XML Web Author. A reviewer can then click the link to open the particular file in Oxygen XML Web Author where they can make or propose changes.

Using a Publishing Template

To embed an Edit link in the DITA Map WebHelp Responsive output using an Oxygen Publishing Template, follow this procedure:
  1. If you have not already created a Publishing Template, see Working with Publishing Templates.
  2. Open the template descriptor file associated with your publishing template and add the following parameters with their values set to the URLs:
    • editlink.ditamap.edit.url - The URL of the DITA map used to publish your content. The easiest way to obtain the URL is to open the map in Web Author and copy the URL from the browser's address bar.
    • editlink.additional.query.parameters - Optional query parameters to be appended to each generated edit link. Each parameter must start with & (e.g. &tags-mode=no-tags). 
    <publishing-template>
    ...
    <webhelp>
        ...                
        <parameters>
            <parameter name="editlink.ditamap.edit.url" 
                       value="webdav-https://dav.box.com/dav/my.ditamap"/>
        </parameters>
    </webhelp>
  3. Open the DITA Map WebHelp Responsive transformation scenario.
  4. Click the Choose Custom Publishing Template link and select your template.
  5. Click OK to save the changes to the transformation scenario.
  6. Run the transformation scenario.

Result: In the WebHelp output, all topics will have an Edit link to the right side of the title and clicking the link will launch that particular document in Oxygen XML Web Author.

For example:

  • Windows:

    dita.bat -i c:\mySample.ditamap -f webhelp-responsive -Deditlink.ditamap.edit.url=webdav-https://dav.box.com/dav/my.ditamap

  • macOS/ Linux:

    dita -i /mySample.ditamap -f webhelp-responsive -Deditlink.ditamap.edit.url=webdav-https://dav.box.com/dav/my.ditamap

Using a Transformation Scenario in Oxygen XML Editor/Author

To embed an Edit link in the DITA Map WebHelp Responsive output using a transformation scenario from within Oxygen XML Editor/Author, follow this procedure:
  1. Edit a DITA Map WebHelp Responsive transformation scenario and open the Parameters tab.
  2. Set values for the following parameters:
    • editlink.ditamap.edit.url - The URL of the Oxygen XML Web Author that have opened the DITA map for editing.
    • editlink.additional.query.parameters - Optional query parameters to be appended to each generated edit link. Must start with & (e.g.: &tags-mode=no-tags).
  3. Run the transformation scenario.

Result: In the WebHelp output, all topics will have an Edit link to the right side of the title and clicking the link will launch that particular document in Oxygen XML Web Author.