Technical reference

Requirements

oXygen XML Web Author 18.x or 19.x Installed
A valid license to install the integration in a production environment; otherwise, you can use the downloaded file just for demo purposes.

Installation

There are two ways to install MathType integration depending on oXygen version.

Install MathType integration adding it to the oXygen XML Web author (method 1)

Go to your oXygen Administration Page.
Select "Plugins" and click Add integration and choose an integration file to upload.
Click OK to upload a file. The integration should appear in the list on this page.
Restart the server.
Enable the integration on the Plugins oXygen Administration Page.
Try that works.

For further information see oXygen's Documentation.

Install MathType integration copying the files (method 2, only for Oxygen18.x)

Stop the Java server.
Unzip MathType integration for oXygen XML inside oXygen XML plugins.zip file. By default, plugins.zip file are on your oxygenwebapp/WEB-INF directory.
Restart the Java server.

Compatible documents with MathType integration

Currently, MathType integration for oXygen is compatible with DITA documents, as well as XHTML, DocBook, and JATS. If you want MathType integration working with another type of document, please contact us at support@wiris.com

Customize MathType toolbar

In order to customize the default MathType toolbar, one can call mathTypeAction.setCustomToolbar(toolbar) and MathTypeEnhancer.prototype.setCustomToolbar(toolbar) methods. With these methods MathType toolbar can be customized at any application level: from application level to document level.

setCustomToolbar admits a string as parameter:

A string with a predefined toolbar: default, quizzes, evaluate, PARCC_Grade3_5, 'PARCC_Grade6_8 and PARCC_Grade9_12.
A XML string containing a custom toolbar definition. For further information about custom toolbar definitions see the Custom toolbar section

Examples

The following example shows how to use a predefined toolbar. It's important call WirisAction.setCustomToolbar(toolbar) method once oXygen editor has been loaded. For that purpouse we use the oXygen's event BEFORE_EDITOR_LOADED with the Google Closure Library:

goog.events.listen(workspace, sync.api.Editor.EventTypes.BEFORE_EDITOR_LOADED, function(e) {
    WirisAction.setCustomToolbar('PARCC_Grade3_5');
});

The following example shows how to use a custom toolbar defined by an XML. As in the example above we use BEFORE_EDITOR_LOADED event to call WirisAction.setCustomToolbar() method.

goog.events.listen(workspace, sync.api.Editor.EventTypes.BEFORE_EDITOR_LOADED, function(e) {
    var xml = '<toolbar ref="general"><tab ref="advanced" before="contextual"/></toolbar>';
    WirisAction.setCustomToolbar(xml);
});

Customize MathType icons

By default, MathType inserts a Math Editor icon and a Chemistry Editor icon into oXygen's specific document toolbar (like DITA toolbar or DocBook toolbar). To disable a specific icon, disableToolbar(editor) method should be used. It's important call disableToolbar(editor) method once oXygen WEB XML editor is loaded.

Disable MathType icon:

sync.api.Workspace.EventType.BEFORE_EDITOR_LOADED, function(e) {
  WirisAction.prototype.disableToolbar(e.editor);
});

MathType icon:

sync.api.Workspace.EventType.BEFORE_EDITOR_LOADED, function(e) {
  WirisActionChemistry.prototype.disableToolbar(e.editor);
});

Technical reference