Extension:Parsoid

From MediaWiki.org
Jump to: navigation, search


MediaWiki extensions manual
Crystal Clear action run.png
Parsoid

Release status: unmaintained

Description Populate a Parsoid cache of pages on editing
Author(s) Parsoid team
MediaWiki 1.22 - 1.23
PHP 5.3+
Database changes No
License GNU General Public License 2.0 or later
Download

Translate the Parsoid extension if it is available at translatewiki.net

Check usage and version matrix; code metrics

Issues:

Open tasks · Report a bug

The Parsoid service, which is written in Node, can use this PHP extension to populate and co-ordinate a cache with pages so that they are available immediately for users.

Required for MediaWiki 1.23 users of VisualEditor[edit | edit source]

For MediaWiki 1.23 users, it also provides a styling module that is a dependency of VisualEditor, so this extension must be installed for VisualEditor to work on MediaWiki 1.23. From MediaWiki 1.24 onwards, this styling module was upstreamed into MediaWiki itself, and so this extension is not required (although you must still install the Parsoid server itself) unless you have a deployed Varnish cache.

Installing[edit | edit source]

  • Download and place the file(s) in a directory called Parsoid in your extensions/ folder.
  • Add the following code at the bottom of your LocalSettings.php:
wfLoadExtension( 'Parsoid' );
  • YesYDone - Navigate to Special:Version on your wiki to verify that the extension is successfully installed.

To users running MediaWiki 1.24 or earlier:

Those instructions describe the new way of installing extensions since MediaWiki 1.25. If you need to install this extension in earlier versions, instead of wfLoadExtension( 'Parsoid' );, you need to use:

require_once "$IP/extensions/Parsoid/Parsoid.php";