Realtime Collaborative Plain WikiText Editor

Last modified by Caleb James DeLisle on 2014/10/13 09:55

cogCollaboratively edit wiki pages in realtime with friends and colleagues
TypeXAR
Developed by

Caleb James DeLisle

LicenseGNU Affero General Public License 3
Installable with the Extension Manager

View Source

Download v1.9

Description

RtWiki is a Realtime Collaborative Editor for XWiki Syntax and scripts based on the cjdrt Realtime Engine and the XWiki WebSocket Integration extension.

In contrast to the RealTime Wiki Editor which is based on the Jupiter Operational Transformation Algorithm and implemented in the Google Web Toolkit, RtWiki is based on a radically new peer-to-peer design implemented entirely in Javascript and based on the Bitcoin Blockchain. While the Jupiter Realtime Editor had issues such as poor performance with large pastes, its fundamental limitation was its inability to handle multiple types of content because the server had to be aware of the content type. This realtime editor is based on RtBackend which is unaware of the document's content and merely handles registrations, de-registrations and the forwarding of messages, much like a chat server.

The RtWiki editor preserves the user interface of the original XWiki Wiki editor so with the RtWiki editor, you can smoothly transition from editing Wiki syntax alone to editing with other collaborators as a group.

rtwiki.png

If a document is currently being edited in Realtime, the normal "This document has been locked for editing" screen will appear but will allow you to join the Realtime Collaborative Session if applicable.

locked_join_rt.png

And of course if you are uncomfortable with realtime editing, you can click on the ALLOW REALTIME COLLABORATION checkbox to return to normal editing at any time and your preferences will be preserved.

allow_realtime_collaboration.png

Reminder for users: even though you are in a realtime session, you will still have to save your document when you are done editing it.

Reminder for admins: the RtWiki editor makes use of WebSocket which requires an open port from the users to the wiki, this port number and the hostname of the wiki can be specified in configuration, for more information see WebSocket.

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).

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

After installing with the Extension Manager, you will need to open the WebSocket Port as described above and restart the XWiki installation.

Release Notes

v1.9

fix http://jira.xwiki.org/browse/RTWIKI-21

v1.5

See: http://jira.xwiki.org/browse/RTWIKI-8?jql=project%20%3D%20RTWIKI%20and%20fixVersion%20%3D%20%271.5%27

v1.4

See: http://jira.xwiki.org/browse/RTWIKI-8?jql=project%20%3D%20RTWIKI%20and%20fixVersion%20%3D%20%271.4%27

v1.3

See: http://jira.xwiki.org/browse/RTWIKI-8?jql=project%20%3D%20RTWIKI%20and%20fixVersion%20%3D%20%271.3%27

v1.2

fixed http://jira.xwiki.org/browse/RTWIKI-3

v1.1

Added modal-popup to tell the user if he/she has been disconnected
Added lag meter to tell latency to the server and user-list to show who else is collaborating
Added auto-save every 30 seconds with save-announcements to prevent a document with many users from thrashing the server.
Updated the demo

Dependencies

Tags: realtime
Created by Caleb James DeLisle on 2014/02/03 23:13
    

Download XWiki

My Recent Modifications

Get Connected