Skip to main content

MathFlow SDK overview

The MathFlow SDK contains the following components:

MathML Editing (Java only)

  • Java Applets and Applications

    • Simple Editor

The basic MathML editor, which includes a toolbar and editing area.

  * **Style Editor**

A more advanced MathML editor, which adds the following functionality:

    * Switch between different toolbars from the General Editing Preferences dialog.
    * Customize the "recognize common functions" list.
    * Easily change styles, or copy and paste from a mini-toolbar.
  * **Structure Editor**

Our most advanced MathML editor, which adds the following functionality:

    * Add new toolbars and switch between them from the menu.
    * Control Non-MathML elements from the General Editing Preferences dialog.
    * Edit the equation's presentation MathML source code from the "source view" tab.
    * Manage font styles from the menu.
    * Includes customizable ruler.

MathML Composition (Java and Windows)

  • Java Applications

    • Equation Composer for Java

Generates equation images from MathML.

  * **Document Composer for Java**

Processes a document and either adds additional information to the MathML (e.g., image links) or replaces MathML with equation images.

  • Windows Applications. Windows composers are COM objects. The return HRESULT may be E_* values, which may be treated as exceptions in some settings, such as C#.

    • Equation Composer

Generates equation images from MathML.

  * **Document Composer**

Processes a document and either adds additional information to the MathML (e.g., speech text or image links) or replaces MathML with equation images.

  * **Speech text**

Both Windows composer classes have the option to include speech text for the equations. This is an accessibility feature which generates phonetic text allowing screen readers to speak the equation.

API documentation

You'll find documentation for the Java Equation Composer API and Java Document Composer API in the javadocs folder, which for Windows is specifically C:/Program Files (x86)/MathFlow SDK/2.1/java/docs/javadoc/com/dessci/mathflow/sdk/editor/. For other operating systems it's similarly in the SDK installation folder. You'll find the API for Windows components in this guide: Equation Composer API and Document Composer API.