Version 0.1.0

Note

Please be aware that multi user editing is still in beta and it's codebase as well it's functionality is still subject to change. Therefore, keep in mind that the features of this as well as it's bevahiour might change until it's final release. Also, we do not offer high priority support for this. Even though we will fix issues that you might find on this, it may take some time until they will be fixed.

What it does

This plugin will add multi user editing functionality to Xeditor. This means that multiple users can edit the same document at the same time.

Installation

First you have to switch into your project location using the command line.

cd path/to/your/project

Now you should be in the same directory as the package.json file. Then you can install the plugin as follows:

npm install @xeditor/plugin-collaboration --save --registry https://npm.xeditor.com

Configuration

The default configuration of the plugin looks like this:

{
    pluginId: 'collaboration',
    ptype: 'uxxeditorcollaboration',
    socketURL: BLACKBOX_URL,
    wholeElementTypesToLock: ['tab_table'],
    authOptions: {
        token: 'your-auth-token'
    }
}

It should be placed in your plugin configuration file (plugins.js as default).

In addition, make sure to set the configuration enableSocketServer to true in your blackbox configuration file xeblackbox.config.js.

API

The API for the plugin can be found here: collaboration plugin API

Changelog

v0.1.0

  • Initial release