VisualEditor/Real-time collaboration

From MediaWiki.org
Jump to navigation Jump to search
shortcut: COLLABPAD
Special:CollabPad

A work-in-progress demo exists in the VisualEditor codebase which provides support for real-time collaboration in a VE environment.

The code is currently experimental and unstable.

Demos[edit]

Standalone[edit]

  1. Make sure you have the latest master of VisualEditor core (which usually lives in lib/ve) from https://github.com/wikimedia/VisualEditor
  2. Install a MongoDB instance.
  3. In the root folder (or lib/ve if inside MediaWiki) run npm install and then grunt build.
  4. In the rebaser/ sub-folder run npm install.
  5. Create a config.yaml file by copying config.dev.yaml and making any changes you require.
  6. Run npm start to start the server.
  7. Go to http://localhost:8081 (or whatever port you set in config.yaml)

If you update the code, you will need to re-run grunt build and then restart the server from within rebaser/.

Once you have the standalone server working you can have a go at the MediaWiki integration:

MediaWiki[edit]

  1. Check out the latest version of VisualEditor-MediaWiki from https://github.com/wikimedia/mediawiki-extensions-VisualEditor, and run git submodule update to get the latest associated version of VE core in lib/ve.
  2. Follow the steps above to get the standlone server running.
  3. Add $wgVisualEditorRebaserURL = 'http://localhost:8081'; to your LocalSettings.php (or whatever server/port you ended up using above).
  4. Go to Special:CollabPad on your wiki.

Known issues[edit]

Support[edit]

You can speak with us in our chat channel, #mediawiki-visualeditorconnect.

Past efforts[edit]