Open main menu

Extension:TogetherJS

MediaWiki extensions manual
OOjs UI icon advanced.svg
TogetherJS
Release status: experimental
TogetherJS on Labs.png
Implementation Page action
Description Enables real-time collaborative editing
Author(s) C. Scott Ananian and Mark Holmquist (cscotttalk)
MediaWiki 1.22/wmf13
Database changes No
License GNU General Public License 2.0 or later
Download
README
Hooks used
BeforePageDisplay
Translate the TogetherJS extension if it is available at translatewiki.net
Check usage and version matrix.

The TogetherJS extension enables real-time collaborative editing, both in the traditional wikitext edit box and with VisualEditor. (VisualEditor is not required, but you may wish to install it.) This extension builds off of Mozilla's TogetherJS library, formerly known as "TowTruck".

Use & hack this at your own risk; it is not generally ready for real-world applications yet! Patches welcome.

Contents

DownloadEdit

TogetherJS currently has dependencies on pre-release alpha versions of MediaWiki and VisualEditor; if you want to install it, you should shell into your server and use git to download the very latest version:

cd extensions
git clone https://github.com/cscott/mediawiki-extensions-togetherjs.git TogetherJS

Basic setup instructionsEdit

To experiment with this extension locally, add the following into LocalSettings.php:

require_once "$IP/extensions/TogetherJS/TogetherJS.php";

Congratulations, you should now have TogetherJS up and running! Test it by visiting a page like Sandbox on your wiki and clicking the "Together" page action.

How TogetherJS worksEdit

TogetherJS currently provides a simple toolkit of Web-based real-time collaboration tools to end users, including chat, audio, and screensharing. We hope that these tools will be helpful for a variety of use cases, such as...

  • Real-time collaboration on wiki pages for Wikimedia projects, of course
  • Remote pair programming and collaborative debugging, for MediaWiki developers building extensions, gadgets, userscripts etc.
  • and more! Please add your ideas.

External linksEdit