pencilAdds support for real-time wiki syntax (text) editing in XWiki.
TypeXAR
CategoryOther
Developed by

XWiki Development Team

Active Installs7
Rating
0 Votes
LicenseGNU Lesser General Public License 2.1
Compatibility

Since 13.9RC1

Installable with the Extension Manager

Description

Adds support for real-time wiki syntax (text) editing in XWiki. This module is still experimental so please use with care. It provides a collaborative plain text editor for wiki syntax. Check the Edit Module for more information on how an editor is defined and how editors are associated to data types.

realtimeWikiEditor.png

The editor is using the Netflux API for real-time communication between the users participating to the editing session, and the ChainPad algorithm to ensure convergence between the changes made by each user.

This editor supersedes the Realtime Collaborative Plain WikiText Editor extension.

Usage

You have to bind the Realtime Wiki Editor to the wiki syntax data type in order to use it. One way to do this is to add an object of type XWiki.EditorBindingClass to the wiki preferences page, setting:

  • Data Type: org.xwiki.rendering.syntax.SyntaxContent#text
  • Role Hint: realtime-wiki

Limitations

At the moment the editor can be used only in Wiki Edit mode to edit the document content.

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-wiki-ui 13.9):

Tags:
    

Get Connected