Xopus API

The Xopus API allows integrators to customize Xopus. This ranges from configuring Xopus to save xml 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.

Related Topics


Title Description
Use Events

Using events from the Xopus API is a great way to get more control over the XML, and to assist users in an even better way. It takes some knowledge of Javascript, and a slight understanding of the API to work with it, but very nice things can be done with it.

Xopus Local Configuration

Xopus can be started from an html page. In that case it must contain an Xopus Canvas. An Xopus Canvas is an area in an html document where Xopus can create a wysiwyg editable view of an xml document. Multiple Xopus canvases are allowed on a single page.
javascript

The <javascript/> element points to a javascript file that is executed when Xopus activates an Xopus Canvas. The script is executed after the configuration is loaded but before any associated files are loaded. The script has access to the Xopus API.
Script Files

The Xopus API can be accessed in multiple ways.
Save XML

Xopus doesn't automatically save changes when it is deployed on a webserver. Since there are as many methods of saving files from a rich client as Xopus as there are web applications, Xopus is fully configurable to save changes to almost any server side system.

Contents

Login

Register with Xopus.com to keep up to date and to participate on the forum. Forgot your password?