Jump to content

Extension:ParserMigration

From mediawiki.org
MediaWiki extensions manual
ParserMigration
Release status: stable
Implementation User interface
Description Provides an interface for migrating article text to new versions of the MediaWiki parser
Author(s)
Latest version Continuous updates
Compatibility policy Snapshots releases along with MediaWiki. Master is not backward compatible.
MediaWiki >= 1.43
Database changes No
License Creative Commons Zero v1.0 Universal
Download
  • $wgParserMigrationEnableParsoidArticlePages
  • $wgParserMigrationCompactIndicator
  • $wgParserMigrationEnableQueryString
  • $wgParserMigrationUserNoticeVersion
  • $wgParserMigrationEnableParsoidDiscussionTools
  • $wgParserMigrationUserNoticeDays
  • $wgParserMigrationEnableParsoidMobileFrontend
Quarterly downloads 4 (Ranked 129th)
Translate the ParserMigration extension if it is available at translatewiki.net
Issues Open tasks · Report a bug

The ParserMigration extension was introduced in gerrit:296182. It provides an interface for comparing article rendering with a new non-default version of the MediaWiki parser thus serving as a parser migration tool.

It was deployed on the Wikimedia production cluster until 2018 to compare Tidy-based output with a RemexHTML-based output. RemexHTML was the replacement for Tidy. In 2023 it was redeployed in order to compare legacy wikitext parser output with output generated by the Parsoid wikitext parser.

The availability of the tool can be controlled by a user via the "parsermigration" preference option.

Using the extension

See Help:Extension:ParserMigration and the extension's README file.


Installation

  • Download and move the extracted ParserMigration folder to your extensions/ directory.
    Developers and code contributors should install the extension from Git instead, using:cd extensions/
    git clone https://gerrit.wikimedia.org/r/mediawiki/extensions/ParserMigration
  • Add the following code at the bottom of your LocalSettings.php file:
    wfLoadExtension( 'ParserMigration' );
    
  • This extension also adds a dropdown under 'Developer tools' at the bottom of the 'Editing' options for a user, which allows the user to opt-in, opt-out, or follow the wiki defaults for the use of the new Parsoid wikitext parser to render article pages.
    "Follow the wiki default" uses Parsoid based on two configuration options:
    • $wgParserMigrationEnableParsoidDiscussionTools if set to true will use Parsoid for all pages in the talk namespace, but not for other pages. This is intended for use with the DiscussionTools extension, which is already powered by Parsoid and enabled by default on some wikis.
    • $wgParserMigrationEnableParsoidArticlePages if set to true will use Parsoid for all pages in the main article namespace, but not for other pages.
  • Yes Done – Navigate to Special:Version on your wiki to verify that the extension is successfully installed.

See also

For the 2018-era deployment of the ParserMigration tool, see: