About the EditLink Plugin

Astoria supports the EditLink plugin from Oxygen, which allows you to supply Astoria named parameters as values for the plugin parameters to embed links in PDF output that open a topic in the repository for editing in Oxygen WebApp editor.

Organizations who have licensed the Oxygen WebApp may want to install the EditLink plugin, compatible with DITA-OT 2.x and above. See Installing the EditLink Plugin.

When installed in the Astoria repository, the EditLink plugin can make use of Astoria named parameters to create the edit links in output files:
EditLink Parameter Name Value Description
editlink.present.only.path.to.topic false The EditLink default value.
editlink.remote.ditamap.url documentEditURL Substitutes the repository URL for the EditLink plugin to identify the map being composed.
editlink.web.author.url oxygenAuthorURL Substitutes the URL required to launch the Oxygen WebApp browser.

EditLink parameters are registered as watched parameters during an Astoria upgrade or installation. The presence of a registered parameter will alter the naming of output files to be of the format _id_[astoria_object id]_[name].[extension]. This naming convention is required for the EditLink plugin to work correctly. For more information about an administrator script that manages watched parameters, see registerAlternativeNamingParams.py in Administrator Scripts.

Use one of these methods to specify these EditLink custom parameters when composing output:
When you view a PDF file composed with the EditLink custom parameters, each topic displays an Edit online link.
If a licensed user of Oxygen WebApp clicks on the Edit online link, the topic is opened for editing in WebApp.

See Working With the Oxygen WebApp Editor.