VisualEditor

Category:MediaWiki extension VisualEditor
Extension name	VisualEditor
About this article / disclaimer	[[Has about meta information::The VisualEditor project aims to create a reliable rich-text editor for MediaWiki. [...] 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 2014.]]
Logo
Screenshot	[[Image:|135px]]
Location of the main author	Berlin
Coordinates of the main authors	52.510885, 13.398937
Developers
Licences
Description
Mediawiki requirements	1.23 (or better)
Dependencies
Related extensions (documented here)
Related extensions
Discussion
Language support
Status	beta
First release date
Last release date (as of 2014/06/20!)
Last version number	0.1.0 (as of June 2014)
Programming language
Alternatives
Website	home page
Publications
Support websites	web site
Example websites
Last edited	2014/06/20

The MediaWiki Visual Editor (operational since 2013 and more fully deployed on Wikipedia since 2014) is a Wysiwyg editor. It requires two components:

• Extension:VisualEditor
• Parsoid

MediaWiki 1.23 installation notes

• Upgrade to the latest version

cd installdir
git pull

Download and install the extension

cd installdir
git clone https://gerrit.wikimedia.org/r/p/mediawiki/extensions/VisualEditor.git
cd VisualEditor
git submodule update --init

backtrack to an older version if needed!! E.g.:

git checkout REL1_23

Download and install the parsoid

This depends on your OS. For Ubuntu 12.04 LTS you cannot use the official distro as explained in the official setup documentation.

Install Parsoid

Firstly edit the /etc/apt/sources.list file:

deb http://parsoid.wmflabs.org:8080/debian wmf-production/

Then get/install Parsoid

sudo apt-get update
sudo apt-get install parsoid

This will create:

• a user parsoid (uid = 118)
• A Parsoid server that runs on port 8142

Check it it runs, e.g.

more  /var/log/parsoid/parsoid.log 

Files:

/usr/lib/parsoid # the parsoid installation directory
/etc/default/parsoid # default settings
/etc/mediawiki/parsoid/settings.js # MEdiawiki-specific stuff
/var/log/parsoid/parsoid.log

Install NodeJS

Then get a different NodJS first

sudo apt-get update
sudo apt-get install -y python-software-properties python g++ make
sudo add-apt-repository ppa:chris-lea/node.js
sudo apt-get update
sudo apt-get install nodejs=0.10*

Test if it's there:

 nodejs --version
 v0.10.28

Configure Parsoid

Continue parsoid install

Go to the Parsoid source directory

cd /usr/lib/parsoid/src

Type

npm install

This will take a while and will download extra stuff. npm seems to be a kind of node management tool (yes I don't understand anything here...)

Test it (again in the src directory)

npm test

Your will get something like

3206 total passed tests (expected 3206), 1927 total failures (expected 1927)
--> NO UNEXPECTED RESULTS <--
==========================================================
WARNING: parserTests.txt not up-to-date with upstream.
        Run fetch-parserTests.txt.js to update.

Configure parsoid install

Create a localsettings.js file based on localsettings.js ???

cd /etc/mediawiki/parsoid

Edit file settings.js to add your wiki

parsoidConfig.setInterwiki( 'localhost', 'http://localhost/w/api.php' );

Configure the extension

In Localsettings.php:

 # VISUAL Editor
require_once("$IP/extensions/VisualEditor/VisualEditor.php");
 
// OPTIONAL: Enable VisualEditor in other namespaces
// By default, VE is only enabled in NS_MAIN
//$wgVisualEditorNamespaces[] = NS_PROJECT;
 
// Enable by default for everybody
$wgDefaultUserOptions['visualeditor-enable'] = 1;
 
// Don't allow users to disable it
$wgHiddenPrefs[] = 'visualeditor-enable';
 
// OPTIONAL: Enable VisualEditor's experimental code features
//$wgVisualEditorEnableExperimentalCode = true;