Adds support for real-time WYSIWYG (rich-text) editing in XWiki.

Description

Adds support for real-time WYSIWYG (rich-text) editing in XWiki. This module is still experimental, so please use with care. It provides a CKEditor plugin that, when enabled, performs real-time synchronization of the edited content between the users editing the same wiki page.

The editor is using the Netflux API for real-time communication between the users participating in the editing session, and the ChainPad algorithm to ensure convergence between the changes made by each user. The actual rich text editing is done with the help of the CKEditor Integration.

This editor supersedes the Visual Realtime Collaborative Editor extension.

Usage

XWiki <16.2.0 The Realtime WYSIWYG Editor was initially implemented as a separate editor that you had to bind to the wiki syntax data type in order to use it. You could do that from the "Editing / WYSIWYG Editor" administration section by changing the "Default WYSIWYG Editor".

XWiki 16.2.0+ Real-time WYSIWYG editing is now implemented as a CKEditor plugin that is bundled in XWiki Standard, but disabled by default. To enabled it you have to uncheck the "xwiki-realtime" plugin from the list of "Disabled Plugins" in the CKEditor administration section, and save.

Limitations

Here's a list of known limitations:

• Editing directly the source wiki syntax is disabled for now as it can create problems. We plan to fix this later.
• Dynamic rendering macros whose output depends on the current user and which rely on custom CSS and JavaScript are currently not very well supported.
• Changes made outside the real-time session can lead to a merge conflict when auto-save is performed, which sometimes needs to be fixed manually.
• Auto-save can create lots of document revisions.

Prerequisites & Installation Instructions

We recommend using the Extension Manager to install this extension (Make sure that the text "Installable with the Extension Manager" is displayed at the top right location on this page to know if this extension can be installed with the Extension Manager). Note that installing Extensions when being offline is currently not supported and you'd need to use some complex manual method.

You can also use the following manual method, which is useful if this extension cannot be installed with the Extension Manager or if you're using an old version of XWiki that doesn't have the Extension Manager:

1. Log in the wiki with a user having Administration rights
2. Go to the Administration page and select the Import category
3. Follow the on-screen instructions to upload the downloaded XAR
4. Click on the uploaded XAR and follow the instructions
5. You'll also need to install all dependent Extensions that are not already installed in your wiki

Dependencies

Dependencies for this extension (org.xwiki.platform:xwiki-platform-realtime-wysiwyg-ui 16.1.0):

• org.xwiki.platform:xwiki-platform-ckeditor-ui 16.1.0
• org.xwiki.platform:xwiki-platform-realtime-ui 16.1.0
• org.xwiki.platform:xwiki-platform-rendering-macro-velocity 16.1.0
• org.xwiki.platform:xwiki-platform-rendering-macro-include 16.1.0
• org.xwiki.platform:xwiki-platform-uiextension-api 16.1.0
• org.xwiki.platform:xwiki-platform-edit-default 16.1.0
• org.xwiki.platform:xwiki-platform-webjars-api 16.1.0
• org.xwiki.platform:xwiki-platform-skin-skinx 16.1.0
• org.webjars:requirejs 2.3.6
• org.xwiki.platform:xwiki-platform-realtime-wysiwyg-webjar 16.1.0