Migrating a Framework from Oxygen XML Editor/Author to Web Author
Edit online

Frameworks developed for Oxygen XML Editor/Author have a high degree of compatibility with Oxygen XML Web Author. However, in some cases, additional work is required to make the framework compatible with both products.

General Recommendations

You can use the Web Author Test Server add-on to test your framework in both products with minimal overhead.
Note: It is always useful to check out the server log. It can be found in the plugin's folder in: tomcat/logs/oxygen.log.

Document Styles

The CSS styles used to render the document in the desktop application can be re-used in Web Author, although there are some limitations.

Toolbar and Contextual Menu Actions

Some of the toolbar actions may not be appear in Web Author. The most common reason is that the toolbar actions use a custom AuthorOperation that is not marked as compatible with Web Author. Sometimes, this is just a matter of annotating your custom Java class. In other cases (for example, when the AuthorOperation is used to show a custom Java Swing dialog box), it has to be re-implemented in JavaScript.

This is how the toolbar structure is built:
  • The default structure of the toolbar is defined in the *.framework file and is common with the one in the desktop editor. You can visualize it using the Document Type Configuration dialog box.
  • The client-side component of Web Author retrieves this configuration using an HTTP request to something like ./rest/VERSION/actions/actionsConfig/docNNN.NNN. Actions that are not compatible are removed from this configuration. You can check it in the browser's Dev Tools Network tab.
  • If you are extending another framework, it can override the configuration of the toolbar using JavaScript code.
  • When the contextual menu is shown, actions that are not enabled at a specific position are not shown.
Note: The actions on the Web Author toolbar are not disabled based on the location of the cursor. However, they always try to find a valid position for that element in a position that is close to the cursor location.