Extension:TogetherJS

From MediaWiki.org
Jump to: navigation, search
MediaWiki extensions manualManual:Extensions
Crystal Clear action run.svg
TogetherJS

Release status:Extension status experimental

TogetherJS on Labs.png
ImplementationTemplate:Extension#type Page action
DescriptionTemplate:Extension#description Enables real-time collaborative editing
Author(s)Template:Extension#username C. Scott Ananian and Mark Holmquist (cscotttalk)
MediaWikiTemplate:Extension#mediawiki 1.22/wmf13
Database changesTemplate:Extension#needs-updatephp No
LicenseTemplate:Extension#license GPLv2+
Download
README
Hooks usedTemplate:Extension#hook
BeforePageDisplayManual:Hooks/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.

Download[edit]

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 instructions[edit]

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. To see a (unstable and liable to change) test instance, visit Wikimedia Labs.

How TogetherJS works[edit]

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 links[edit]

Mozilla's TogetherJS is worth a look.