Realtime Collaborative Plain WikiText Editor
|Collaboratively edit wiki pages in realtime with friends and colleagues|
|License||GNU Affero General Public License 3|
Table of contents
RtWiki is afor XWiki Syntax and scripts based on the Realtime Engine and the extension.
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.
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.
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.
Prerequisites & Installation Instructions
We recommend using theto 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:
- Log in the wiki with a user having Administration rights
- Go to the Administration page and select the Import category
- Follow the on-screen instructions to upload the downloaded XAR
- 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.
Use the version 1.9 of Realtime Frontend
Use the new Realtime Frontend with reconnecting websockets to re-enable editing after a connection failure
Ability to use RTWiki with the Syntax Highlighting extension (CodeMirror)
Refactor the application to use the new Realtime Frontend extension.
unable to save if document contains non-ascii characters when certain Java plugins are present on host instance.
race condition in save and view eats save content.
Occasional deadlocks would cause the page to redirect before the save had completed.
: integrate changes which are made at the server side
using merge algorithm
: Do not autosave unless there have been actual changes to the text.
: Realtime should never override a save which bypassed the realtime session.
always merge, whether using buttons or autosave
: Hook the save button - merge on save
save and view/continue are _almost_ guaranteed to send ISAVE messages. only in the event of a network disconnection will other users be unaware of your having saved. related: RTWIKI-36
: On merge failure: keep our version OR theirs
settled by merge dialog
: Give Messages when merging
there are a variety of translatable messages, and a simple API for displaying them
: Use merge algorithm from inside of XWiki to do merge for RTWiki
: changes made during an asynchronous merge are overwritten
check if changes have been made, and discard merge until next cycle if so
: ISAVED messages are not recognized by chainpad
catch these messages before they are ever sent to chainpad
: don't merge if latestCommonAncestor and most recent version are equal
: in the event of a merge conflict, present a modal dialog
additionally, receiving an ISAVED message closes this modal
: don't save if live content is determined to be equal to the last saved content
determined by the server
: autosave cycles continue while the merge dialog is pending
set a flag while dialog is displayed, short-circuit during check if flag is present
: Only users which have made changes should autosave or settle merge conflicts
this cuts down on the number of merges the server performs. It also prevents displaying merge dialogs to non-editing users
: documents can wrongfully merge with themselves
if the merged document's content hash is found in the realtime history, the merge is ignored. This prevents merges which are reversions to earlier states
Closes RTWiki-28, prevents unnecessary saves by comparing against the state of the last saved version (fetched via REST URL).
If one person edits a document using WYSIWYG, another is incorrectly invited to "join realtime collaboration"
- attempt to get the language of the document from the html tag in case that the document is 'locked for editing'
2. do not consider a realtime collaborative session as existing unless another user has registered
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