Customizing the Web Author User Interface
Edit online

It is possible to customize the Oxygen XML Web Author user interface (including the side views, toolbars, contextual menu actions, and theme).

Customizing the Toolbar and Contextual Menu Actions

The Oxygen XML Web Author toolbar and contextual menu structure includes standard actions (such as Undo, Redo, Cut, etc.) as well as actions that are dictated by the framework configuration.

There are several methods you can use to customize the actions that appear on the toolbar and contextual menu:
Document Type Configuration in Oxygen XML Editor/Author
You can use the Document Type configuration dialog box in Oxygen XML Editor/Author (Options > Preferences > Document Type Association > [select framework] > Edit). This approach is entirely GUI-based and controls only the framework-specific configuration. You can add and remove actions, create drop-down sub-menus, or add separators.
Note: 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 Oxygen XML Web Author using the ro.sync.ecss.extensions.api.WebappCompatible annotation. Author mode operations that use Java Swing components to display a graphical interface are not compatible with the Oxygen XML Web Author and they should not be annotated.
Web Author JavaScript API
You can use the Web Author JavaScript API to add custom actions or remove actions from the toolbar and contextual menu.
The advantages of using this approach include:
  • You can remove any action, even standard ones.
  • You can remove actions from all the places where they appear in the GUI.
  • You can dynamically remove actions (for example, based on the user role).
  • You can add actions that have a web-based GUI.

Customizing the Header Bar

If you embed Web Author in a web page, you may want to remove the header bar that displays the logo, the name of the file, and the name of the author. You can hide it using the hideAppBar() JavaScript API.

Customizing the Side Views

You can customize the side-views that appear in the editor by using the JavaScript API as described in the Customizing the Side Views tutorial.

Customizing the Theme

Although Web Author has a neutral theme, to better match the theme of your application, you can customize it by injecting a custom CSS file using JavaScript code from a plugin. The CSS file should also be served by your plugin using the WebappStaticResourcesFolder extension type.