Customizing Oxygen XML Web Author Component Frameworks
The custom frameworks that are designed for documentation purposes (such as DITA, DocBook, or TEI) can be reused interchangeably between the Oxygen XML Editor plugin 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 plugin 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 plugin distributions.
- Ability to reuse previously developed frameworks.
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 plugin standalone installation. This is not a mandatory requirement, but rather a way to speed up the development process.
- Use the standalone installation of Oxygen XML Editor plugin 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 plugin, but if you want to preview them in the Oxygen XML Web Author Component, proceed to the next step.
- Run the Oxygen XML Web Author Component using the add-on distribution
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
- 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 Web Author Component, use the following
mediaquery:@media oxygen AND (platform:webapp) { ... } - In the
webfolder of each framework, you can add aframework.jsfile that calls the JavaScript API to implement custom editing actions. The possible use cases include the following:- Create custom actions and add them to the toolbar or contextual menu. For more details, see the JS custom action tutorial.
- Create custom form controls. For more details, see the JS form control tutorial.
- Add more views. For more details, see the JS custom view tutorial.
- If the framework contains Author mode operations (Java
implementations of the
ro.sync.ecss.extensions.api.AuthorOperationinterface), they can be enabled to be used by the Oxygen XML Web Author Component using thero.sync.ecss.extensions.api.WebappCompatibleannotation.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.