Extension:VisualEditor

The VisualEditor project aims to create a reliable rich-text editor for the Web and for MediaWiki. More information can be found on the project page; this page is just about the VisualEditor-MediaWiki extension itself. The extension relies on the separate nodeJS-based Parsoid parser service to be up and running in order to edit pages. Stable release is planned for 2015.

Download
If you're using the latest stable version of MediaWiki you will need to download the VisualEditor-MediaWiki extension from the ExtensionDistributor page. The following download instructions are for use with the latest nightly build of MediaWiki only. cd extensions git clone https://gerrit.wikimedia.org/r/p/mediawiki/extensions/VisualEditor.git cd VisualEditor git submodule update --init

If you cannot use git (e.g. you are in an air-gapped installation), you can download a snapshot of VisualEditor-MediaWiki for master or for a release version of MediaWiki from the ExtensionDistributor page. After you've got the code, save it into the extensions/VisualEditor directory of your wiki.
 * VisualEditor-MediaWiki's master branch contains the latest code, as used at Wikimedia. This code is potentially slightly buggy or unstable, but is likely to have fewer bugs and more features than old builds.
 * The master branch requires alpha builds of MediaWiki (currently, 1.25wmf16 ) and will not work with the older, official releases of MediaWiki like 1.25.1, for that use the REL1_25 branch (command :.
 * The  command is vital, as MediaWiki-VisualEditor needs the core VisualEditor submodule to work. If you do not use this command, VisualEditor will fail to work.

Dependencies
VisualEditor depends on the following extension:
 * UniversalLanguageSelector

Setup a Parsoid service
Without the Parsoid node.js service you will not be able to edit existing pages or save pages!

If you want to be able to edit existing pages and save pages with VisualEditor you need a Parsoid service.

To setup your own Parsoid service follow the Parsoid installation instructions first. Note that it is particularly complicated to set up Parsoid in non-standard systems for running NodeJS, like those running Windows or Debian.

Basic configuration for MediaWiki-VisualEditor
For the initial setup, before you have installed the Parsoid node.js service you can experiment with loading MediaWiki-VisualEditor on your own wiki.

Add the following lines to your wiki's  after you have downloaded the extension:

Other extensions which load plugins for VE (e.g. Math) should be loaded after VE for those plugins to work.

Linking with Parsoid
To get VisualEditor to talk to Parsoid, add the following code to your  to specify your Parsoid instance:

Additionally, you may need to set the  prefix. If you only run a single wiki then you can leave its unique ID as "localhost" in parsoid's localsettings.js configuration file and do not need to set this. But if you are running multiple wikis on the same host then each will need a different interwiki name for parsoid (see Parsoid/Setup for more detail), and you must set  to the interwiki name you give this wiki in parsoid's localsettings.js:

Forwarding Cookies to Parsoid
Note that this configuration is not available in the old version of VisualEditor that is compatible with MediaWiki 1.22.

ONLY enable this on private wikis and ONLY IF you understand the SECURITY IMPLICATIONS of sending Cookie headers to Parsoid over HTTP!

Parsoid Authentication Without Forwarding Cookies
The forwarding of cookies (and the enabling of $wgSessionsInObjectCache and $wgVisualEditorParsoidForwardCookies) can be avoided by adding a user (which may be called parsoid) to the wiki and then add the NetworkAuth Extension to the wiki with the configuration in LocalSettings.php: require_once( "$IP/extensions/NetworkAuth/NetworkAuth.php" ); $wgNetworkAuthUsers[] = array(        'iprange'               => array('127.0.0.1/32'),         'user'                  => 'parsoid'); Where the IP address matches that of the parsoid server and the user matches the one you added to the wiki. This should of course only be done if the parsoid server is on a 'trusted' network.

See also:
 * Alternative solution using a modification to LocalSettings.php and the $_SERVER['REMOTE_ADDR'] variable, which grants read access to connections that originate from the local server.

Note for MediaWiki 1.23 users
For MediaWiki 1.23, as well as the Parsoid nodejs service, you will also need to install the the Parsoid PHP extension. Without this, VisualEditor will fail to load (as it supplied key styling code until that was moved in MediaWiki itself in MediaWiki 1.24 onwards).

Note for Parsoid on Windows and other systems
Note that it is particularly complicated and time consuming to set up VisualEditor with Parsoid in non-standard systems, like those running Windows or nonstandard Linux - those difficulties might even prevent the successful installation of VisualEditor for some people on some platforms.

Complete list of configuration options
Each configuration option is shown without the  prefix for brevity.

Setting VisualEditor up on shared hosting
See VisualEditor/Installation on a shared host

Troubleshooting

 * Error loading data from server : HTTP 500. Would you like to retry?
 * "curl" or "php5-curl" is not installed or not accessible to your server.


 * parsoidserver-http-curl-error : couldn't connect to host.
 * Parsoid is not running, or  is not set correctly


 * parsoidserver-http-curl-error : Failed to connect to .... : Permission denied.
 * Can be caused by a cURL request on a Security-Enhanced Linux (SELinux, like CentOS) to a non standard port like 8000 in the example configuration above, see http://www.akashif.co.uk/php/curl-error-7-failed-to-connect-to-permission-denied and https://www.centos.org/forums/viewtopic.php?f=47&t=53223&p=225372#p225372


 * parsoidserver-http-bad-status : 401
 * Caused by read or edit restrictions. If you've set up a private wiki and don't want to use cookie forwarding, you can explicitly remove restrictions for Parsoid by IP address.


 * parsoidserver-http-not-found : 404 (or timeout)
 * Caused by wrong path to MediaWiki API endpoint. Set correct url to the right path to  in Parsoid's   config file. If you have set up following the recommendations, your API path would be "http://localhost/w/api.php". Add this API path to "localsettings.js" like "parsoidConfig.setInterwiki( 'localhost', 'http://localhost/w/api.php ' );".


 * No visible error (Appears to load forever)
 * Check the parsoid log file, and consult Parsoid/Troubleshooting.