Customizing Oxygen XML WebApp Documentation Frameworks

The custom documentation frameworks can be re-used between the oXygen XML Author standalone distribution and the WebApp, but some fine tuning might be necessary to achieve a better editing experience. The advantages of using a common framework include:

Easier development and testing, since you can test most of the functionality in the standalone version of oXygen XML Author, using advanced tools such as the CSS Inspector, CSS Editor, or the Document Type customization dialog.
Uniform experience across different oXygen XML Author distributions.
Reuse previously developed frameworks.

Developing And Testing a Documentation Framework Using the WebApp Add-on

The following procedures assumes that you have access to an oXygen XML Author standalone installation. This is not a mandatory requirement, but a way to speed-up the development process.

Use the standalone installation of oXygen XML Author to customize the documentation framework. Modifications made to the framework are instantly visible, but if you want to preview them in the WebApp, proceed to the next step.
Run the Oxygen XML WebApp using the add-on distribution and test the documentation framework.
Note: The changes that you make to your documentation framework will not be automatically reflected in the running WebApp. To see the results of changes, close the server using the Close and stop server button and start it again.

Deploying a Documentation Framework

Copy your customized framework into the bundle-frameworks/oxygen-frameworks/ folder of the oXygen XML SDK project.
Build the SDK project and deploy it.

Customization Tips

If you want to use CSS rules that only apply when the framework is used in the Oxygen XML WebApp, use the following media query:
```
@media oxygen AND (platform:webapp) {
 ... 
}
```
In every framework, you can add a web/framework.js file that uses the JavaScript API to implement editing actions and add them to the toolbar and contextual menu.
If the framework contains Oxygen XML Author operations (Java implementations of the ro.sync.ecss.extensions.api.AuthorOperation interface), they can be enabled to be used by the Oxygen XML WebApp by using the ro.sync.ecss.extensions.api.WebappCompatible annotation.
Note: Oxygen XML Author operations that use Java Swing components to display a graphical interface to the user are not compatible with Oxygen XML WebApp, so they should not be annotated.
Oxygen XML WebApp continuously validates the XML documents using the default validation scenarios defined at framework level. Only the validation units that are marked for Automatic Validation will be used. You can use the Document Type customization dialog to configure the automatic validation in the WebApp.