Collaborative real-time editor
- 7 min read
- 3 chapters
Related on Lably
Through Web application, Cloud storage and Spreadsheet
Real-time editing performs automatic, periodic, often nearly instantaneous synchronization of edits of all online users as they edit the document on their own device. This is designed to avoid or minimize edit conflicts.
With asynchronous collaborative editing (i.e. non-real-time, delayed or offline), each user must typically manually submit (publish, push or commit), update (refresh, pull, download or sync) and (if any edit conflicts occur) merge their edits. Due to the delayed nature of asynchronous collaborative editing, multiple users can end up editing the same line, word, element, data, row or field resulting in edit conflicts which require manual edit merging or overwriting, requiring the user to choose which edits to use or (depending on the system and setup) automatically overwriting their edits or other people's edits, with or without a warning.
History of key products
The first instance of a collaborative real-time editor was demonstrated by Douglas Engelbart in 1968, in The Mother of All Demos. Widely available implementations of the concept took decades to appear.
A piece of software called Instant Update was released for the classic Mac OS in 1991 from ON Technology. It allowed real-time editing of a single document by multiple users over a LAN and relied on a workgroup server.
Interest in real-time collaborative editing over the internet led to the development of MoonEdit and SubEthaEdit in the 2003-2005 time frame, followed soon after by Gobby.
With the introduction of Ajax technology and the "content editable" function in browsers, web-based collaborative editing in real-time developed as part of the Web 2.0 phenomenon around 2005. In particular, a product called Writely saw explosive user growth and was bought by Google in March 2006 (what became known as Google Docs and later renamed to Google Drive). It provided simultaneous edits on the entirety of a document, though changes from other users were only reflected after the client program polling the server (every half-minute or so). Another early web-based solution was JotSpotLive, in which line-by-line simultaneous editing was available in near-realtime. However, after Google's purchase of parent company JotSpot in November 2006, the site was closed. Google Sites was launched in February 2007 as a refactoring of JotSpot, but it lacks the multi-user real-time abilities of JotLive. The Synchroedit (rich text) and MobWrite (plain text) projects are two, more recent, open source attempts to fill the gap in real-time browser-based collaborative editing, though still unable to achieve true real-time performance, especially on a large scale architecture.
In 2009, Google started beta testing Google Wave, a real-time collaboration environment which Google hoped would eventually displace email and instant messaging. EtherPad was acquired by Google, which allocated the EtherPad team to work within the Wave project. However, Google announced in August 2010 on its blog that it had decided to stop developing Wave as a standalone project, due to insufficient user adoption. After Google released the abandoned EtherPad source code as open source in December 2009, the community took over its development and produced a complete rewrite named Etherpad lite, which is written entirely in JavaScript and built on top of Node.js. Another notable tools based on operational transformation technology is CKEditor. 2020 has seen a surge of interest in the concept, as Microsoft also recently released its Fluid Framework, which relies on a novel Total Order Broadcast technology, as opposed to OT or CRDT. Fluid is currently framework agnostic. Microsoft states that it is not yet ready for production use.
In June 2016, Collabora Productivity released V1.0 of Collabora Online, an open source online office suite using LibreOffice Technology, it can be integrated into any website with a few lines of code. A software development kit exists with sample integration code in several languages Node.js, PHP, Python, ReactJS and .NET, these have API specifications allowing interoperable integrations with customizable user interfaces. With Collabora Online documents remain on the server, each user shares the same document concurrently allowing just one document to be edited in real-time and interactively with no extra lag or latency to see other users’ typing. It avoids the need for locking of paragraphs in text documents. It enables collaborative real-time editing of word processing documents, spreadsheets, presentations, drawing and vector graphics.
Recently, real-time collaborative editing has returned to stand-alone text editing applications with extensions for Atom and Visual Studio Code released in 2020.
Sign in to keep reading
2 more chapters are free with a Lably account.
Other examples
Real-time collaborative editing can occur online in web applications such as Microsoft Office on the web (formerly Office Online) – which supports online (web-based) simultaneous editing (which Microsoft refers to as "Co-Authoring") of Word documents, Excel spreadsheets, PowerPoint and other Microsoft Office documents stored on Office.com, OneDrive or SharePoint cloud storage – or Google Docs and other Google Workspace productivity (office suite) apps – for online collaborative editing of word processing and other documents stored in Google Drive. Real-time collaborative editing can also occur in hybrid manner, such as with Power Sheet BI for Excel, in offline, web-based, and online collaborative editing in desktop software as well as web-based and mobile apps, which can be synchronized automatically with instant access to version history. 2020 has seen a resurgence of interest in embedding these applications into secure web applications, particularly for business use-cases, with Microsoft and Vaadin taking the lead with specialized real-time collaboration backends that handle the complexities of real-time synchronous data sharing, which developers can utilize through APIs. Mozilla released in 2013 the javascript library TogetherJS, which adds real-time collaborative editing to any web application via a messaging system and optionally an operational transform algorithm for forms synchronization.
Vaadin Ltd., the vendor of the Vaadin platform, released V1.0 of their Collaboration Engine In October 2020, with the premise of allowing developers to rapidly build real-time collaboration and editing features in to any web application with Java backends using a few lines of codes (for specific use-cases through their, still limited, high-level APIs). This feature currently supports Java, although the vendor notes that a TypeScript-based API is also incoming, in line with the Vaadin platform's recent ongoing expansion into also enabling TypeScript-based UI building in the future through its upcoming Fusion framework.
Technical challenges
The complexity of real-time collaborative editing solutions stems from communication latency. In theory, if communication were instantaneous, then creating a real-time collaborative editor would be no more difficult than creating a single-user editor, because a document could be edited using an algorithm similar to the following:
- Request an 'edit document' token from the server
- Wait until the server says it's our turn to edit the document
- Tell the server how to edit the document
- Release the 'edit document' token
However, the speed of communication is limited by network latency. This creates a fundamental dilemma: users need their own edits incorporated into the document instantly, but if they are incorporated instantly, then because of communication latency, their edits must necessarily be inserted into different versions of the document.
An example illustrates this problem. Suppose Bob and Alice start with a document containing the word Mary. Bob deletes 'M', then inserts 'H', to change the word into Hary. Alice, before she receives either edit from Bob, deletes 'r', then deletes 'a', to change it into My. Both Bob and Alice will then receive edits that were applied to versions of the document that never existed on their own machines.
Thus, the challenge of real-time collaborative editing is to figure out exactly how to apply edits from remote users, which were originally created in versions of the document that never existed locally, and which may conflict with the user's own local edits.
The most sophisticated solutions solve this problem in a way that does not require a server, does not use locking (all users can freely edit all parts of a document at the same time), and supports any number of users (limited only by the resources of the computers). UNA and SubEthaEdit are examples of two programs that take this approach.
While these sophisticated approaches enable the best user experience, a basic collaborative editor can also be created in a client–server model. In a client–server scenario, one of the editor instances is assigned the role of collaboration server when the document is opened. This server ensures that other editors are kept in sync by determining network latency and acting as a time synchronization server. The server receives timestamped notifications of changes made to the document by other users. It determines how those changes should affect its local copy, and broadcasts its changes to the collaboration pool. In some models, the changes are not reflected on a client until an official response is returned from the server, even if those changes were made locally.
This approach, while significantly less powerful, allows for basic collaboration at a relatively low cost. This makes it preferable in situations where processing resources are limited. NetSketch is an example of a program that uses this model.
In the past, Microsoft and IBM have worked to add collaboration facilities to their existing architectures. Although marketed as real-time collaboration, these 'workspace' approaches require either document locking (so only one person can edit it at a time), or 'reconciliation' of conflicting changes, which is generally found by users to be unsatisfactory.