Customizing Oxygen XML WebApp's Client Side

Oxygen XML WebApp is an editing platform, but it is the integrator's job to provide a way for the user to select/choose which file is going to be edited. Afterwards, the user should be redirected to WebApp's editing page, along with three URL parameters:

url - absolute URL of the edited file
ditamap - absolute URL, optional parameter. Taken into account only when editing a DITA file. Provides the DITA map context of the edited DITA file.
author - author name

Example

Let's suppose that the WebApp is deployed at the following URL:

http://www.example.com/oxygen-sdk-sample-webapp/

The user (whose name is John Doe) wants to edit a file (located at http://www.test.com/topics/topic.xml) in the context of a DITA map (located at http://www.test.com/map.xml). In this case, the editing URL should be:

http://www.example.com/oxygen-sdk-sample-webapp/app/demo-mobile.html?
url=http%3A%2F%2Fwww.test.com%2Ftopics%2Ftopic.xml&
ditamap=http%3A%2F%2Fwww.test.com%2Fmap.xml
&author=John%20Doe

Note: The parameters values are percent encoded before being added to the editing URL.

Loading Custom JavaScript Code

To extend the functionality provided by Oxygen XML WebApp, create a file called plugin.js and copy it in the app folder of the WebApp deployment. Alternatively, you can bundle JavaScript code with a Java Plugin.

The plugin.js file can contain JavaScript code that calls the JavaScript API provided by Oxygen XML WebApp.