Extension:EtherEditor

EtherEditor is an extension that allows a user collaboratively edit with all other users editing a page. It was developed by Mark Holmquist.

Installation and Configuration
In order to get this extension working, you'll need to do several things other than actually installing the extension. This is because the extension relies on an external service running somewhere else entirely.

Set up Etherpad Lite
Etherpad Lite can be obtained from their GitHub page. You should download the develop branch like so (but install Git first):

Next, you'll need to set up two extensions for Etherpad Lite. These can be found at the ep_plugins project page at Gitorious. Download both ep_wikitext and ep_wikiauth, and put them into the node_modules directory inside of the main directory for your Etherpad Lite instance. Probably something like this:

After all that is done, make sure the Etherpad Lite instance runs (the command should be something like ./bin/run.sh).

Configuring EtherEditor
As you probably expected, EtherEditor needs to know where to find your Etherpad Lite instance. So, add a section to your LocalSettings.php that looks like so:

Change these values as needed. The apiKey value, in particular, will need to be changed--you can find its value in your Etherpad Lite instance's main directory, inside of APIKEY.txt. Be careful not to share this value with anyone!

update.php
It's very important that you run maintenance/update.php once you're ready to start using the extension. There are several necessary database tables added by the update hooks.

How to Use
In order to use the extension, you'll need to be logged into the wiki that has it installed. Once logged in, you can click "Collaborate" from any page to go to a collaborative editor. There are now also buttons available for "forking" the pad, and working in a separate area. These pads are not yet private, but will be in the near future. You can also kick people from the pad, but it might not take effect until they leave on their own.

Development status
This extension is still very new, so don't trust it on a production wiki.

How to help
There are the normal channels for getting involved in this extension's development.


 * TranslateWiki has our messages
 * Edit this page to contribute to the community documentation
 * Test the extension at our test instance
 * Report a bug you see with Bugzilla
 * Help with bug reports over at Bugzilla
 * Join the IRC channel, #ethereditor on Freenode, to learn more!
 * Graphic designer? Cool! We could really use a logo....

Related extensions

 * Extension:VisualEditor
 * Extension:WikiEditor
 * Extension:EtherpadLite