Plugins

BXE has now Plugin Support. The interface is still quite simple. More will maybe follow.
See also Plugin_XMLSnippets for docu about a plugin.

See

http://cvs.bitflux.ch/chora/co.php/trunk/plugins/Drawer.js?rt=svneditor&r=HEAD

or

http://cvs.bitflux.ch/horde/chora/co.php/trunk/plugins/XMLSnippets.js?rt=svneditor&r=HEAD

for an example and

http://cvs.bitflux.ch/chora/co.php/trunk/examples/inlineXHTML/config.xml?rt=svneditor&r=HEAD

for the corresponding config.xml entries

Calling Order

The loading of the plugin XML happens just before the XML Documents are starting to load, when are JS files defined in config.xml are already loaded.

A plugin needs the following methods:

getCSS()

Should return an array of needed CSS by this plugin. Can be of course an empty array.

getScripts()

Should return an array of needed additional Javascript files by this plugin. Can be of course an empty array.

init(options)

Is called as soon as all plugin JS files are loaded.
In options you'll get an array with all options defined in config.xml. The option value is always a string, even if there are further nodes within <option>, because they will be serialized.

start()

Is called just after everything is loaded, validated and initialized. It's the same object as initialized with init.

Implementing it

Just put that JS file into the plugins ordner. Name the class something like BxePluginName and the file PluginName.js. Then add

<plugins>
{panel}
  <plugin name="PluginName"> </plugin>
{panel}
</plugins>

to your config.xml (see the example mentioned above. And it should then automatically being loaded and initialized.