API

The Xopus API allows integrators to customize Xopus. This ranges from configuring Xopus to save documents to building custom user interfaces on top of Xopus.

The Xopus API can be accessed in several ways.

  • Through the global configuration script in: xopus/config/config.js This script will be executed when Xopus is started and before any document is loaded.
  • Each Xopus Canvas can contain javascript elements that reference script files which will be executed when the canvas is activated.
  • XSL Stylesheets can output HTML event handlers that can access the Xopus API. See Use Events and Use The API for more information.

API Reference

DOM API
The Xopus implementation of W3C DOM standard objects and methods and our extensions.
Editor API

Xopus specific objects and methods.

Command
The Command object can be used to define commands for custom buttons
EmbeddedXopus
EmbeddedXopus can be used to make Xopus work better with iframes in an implementation
HTTPTools
The global HTTPTools object provides a library of http communication methods.
IO
IO is a global object that provides helper functions for interaction between Xopus and your web server.
Scope
Scope objects can be used to store command state across command invocations.