Customizing Oxygen XML Web Author Component Frameworks
History | Edit

Custom frameworks that are designed for documentation purposes can be reused interchangeably between the Oxygen XML Editor standalone distribution and the Oxygen XML Web Author Component. However, some fine-tuning might be necessary to maximize the editing experience for your content authors. 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 Editor using advanced tools such as the CSS Inspector, CSS Editor, or the Document Type Association customization dialog box.
  • Uniform experience across multiple Oxygen XML Editor distributions.
  • Ability to reuse previously developed frameworks.
  • Many of the customized items that are added to your framework in the Oxygen XML Editor standalone distribution also carry over to Oxygen XML Web Author Component. For example, items that are added to the list of proposals for the Content Completion Assistant will appear in both distributions.

Developing and Testing a Framework Using the Oxygen XML Web Author Test Server Add-on

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

  1. Use the standalone installation of Oxygen XML Editor to customize a specific framework for whatever type of documentation that you require. Modifications made to the framework are instantly visible in the standalone version of Oxygen XML Editor, but if you want to preview them in the Oxygen XML Web Author Component, proceed to the next step.
  2. Run the Oxygen XML Web Author Component Test Serve Add-on and test the framework.
    Note: The changes that you make to your framework will not automatically be reflected in the Oxygen XML Web Author Component if it was already running. To see the results of changes, close the server using the Close and stop server button and start it again.

Deploying a Framework

  1. Copy your customized framework into the bundle-frameworks/oxygen-frameworks/ folder of the Oxygen XML SDK project.
  2. 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 Web Author Component, use the following media query:
    @media oxygen AND (platform:webapp) {
 ... 
}
  • In the web folder of each framework, you can add a framework.js file that calls the JavaScript API to implement custom editing actions. The possible use cases include the following:
  • If the framework contains Author mode operations (Java implementations of the ro.sync.ecss.extensions.api.AuthorOperation interface), they can be enabled to be used by the Oxygen XML Web Author Component using the ro.sync.ecss.extensions.api.WebappCompatible annotation.
    Note: Author mode operations that use Java Swing components to display a graphical interface are not compatible with the Oxygen XML Web Author Component and they should not be annotated.
  • The Oxygen XML Web Author Component continuously validates the XML documents using the default validation scenarios defined at framework level. Only the validation units that have the Automatic Validation option selected in the Edit Scenario dialog box that is accessed by editing a scenario in the Validation subtab when editing a document type.