Adding an Edit Link in Your Interface
History | Edit

Oxygen XML Web Author Component can be launched to edit a file by simply following a link with a carefully built target. The base URL for the Edit link used to open the Web Author is the URL that you see in the browser when the Dashboard page is opened.

Example: The base URL for oXygen XML Web Author demo deployment
https://www.oxygenxml.com/webapp-demo-aws/app/oxygen.html
Table 1. The information about the file to open and the options used to load it can be specified as URL parameters:
Parameter name Description
url The OXY-URL of the file to be opened.
ditamap For DITA files, the OXY-URL of the DITA Map to use as a context for resolving keys.
trackChanges
default
Whether or not changes are tracked depend on the server settings.
enabled
The changes are tracked by default but the user is able to disabled it.
forced
The changes are tracked and the user cannot accept or reject changes made by others.
author The name of the author
The OXY-URL uses a custom schema according to the file storage system the file comes from.
GitHub
The URLs have the following format:
github://getFileContent/<user>/<repo>/<branch>/path/to/file.dita
Git
The URLs have the following format:
github://getFileList/<encoded-repo-http-url>/<branch>/path/to/file.dita

where encoded-repo-http-url is the http URL of the git repository (for example: https://user@bitbucket.org/user/flowers.git).

WebDAV
The URLs have the following format:
webdav-https://dav.box.com/dav/path/to/file.dita

where the WebDAV URL of the file is: https://dav.box.com/dav/path/to/file.dita.

SharePoint
The URL of the file is the SharePoint file URL, prefixed with spo-.
REST
The URLs have the following format:
rest://<server-id>/path/to/file.dita
The format can be further specified by the implementer of the REST API.