Parsoid

The parser Parsoid project aims to develop a more consistent WikiText parser which translates MediaWiki's well-known syntax into an equivalent representation with better support for automated processing and visual editing. It is developed in parallel with and in support of the visual editor project as a future core project. A major requirement is the ability to reverse this translation (serialize back to WikiText) without the introduction of 'dirty diffs' or information loss. Wiki pages remain editable as plain WikiText.

Getting started
For a quick overview, you can test drive Parsoid using a node web service. Development happens in the Parsoid extension in Git (see ). The parser tests uses the parserTests.txt file from the core module.

Parsoid setup
git clone https://gerrit.wikimedia.org/r/p/mediawiki/extensions/Parsoid.git

You need node.js 0.4+, and npm 1.0+. If you have npm 0.x (as shown by ), please upgrade npm first with   or.

First, install the npm dependencies:

cd Parsoid/js npm install

Go to the  directory and create a   file based on.

With this in place, you should be able to run the Parsoid web service using:

cd Parsoid/js export NODE_PATH=node_modules node api/server.js

This will start the Parsoid HTTP service on port 8000. To test it, point your browser to http://localhost:8000/.

Running the tests
To run all parser tests:

cd Parsoid/js export NODE_PATH=node_modules npm test

parserTests has quite a few options now which can be listed using.

An alternative wrapper taking wikitext on stdin and emitting HTML on stdout is modules/parser/parse.js:

cd Parsoid/js/tests  echo '' | node parse.js 

This example will transclude the English Wikipedia's en:Main Page including its embedded templates. Also check out  for options.

You can also try to round-trip a page and check for the significance of the differences. For example, try

cd Parsoid/js/tests node roundtrip-tests.js --wiki mw Parsoid

This example will run the roundtripper on this page (the one you're reading, including all of this text) and report the results. It will also attempt to determine whether the differences in wikitext create any differences in the display of the page. If not, it reports the difference as "syntactic".

Finally, if you really wanted to hammer the Parsoid codebase to see how we're doing, you can try running the roundtrip testing environment on your computer with a list of titles.

Enjoy!

Monthly high-level status summary
(See all status reports)

Todo
If you would like to hack the Parsoid parser, we have a list of tasks we currently see ahead interspersed with notes on open issues. Some tasks are marked as especially well suited for newbies. If you have questions, try to ping the team on, or send a mail to the wikitext-l mailinglist. If all that fails, you can also contact Gabriel Wicke by mail.

Architecture
The broad architecture looks like this:

| wikitext V PEG wiki/HTML tokenizer        (or other tokenizers / SAX-like parsers) | Chunks of tokens V Token stream transformations | Chunks of tokens V HTML5 tree builder | HTML 5 DOM tree V DOM Postprocessors | HTML5 DOM tree V (X)HTML serialization |   +--> Browser |   V Visual Editor

So basically a HTML parser pipeline, with the regular HTML tokenizer replaced by a combined Wiki/HTML tokenizer with additional functionality implemented as (mostly syntax-independent) token stream transformations.


 * 1) The PEG-based wiki tokenizer produces a combined token stream from wiki and html syntax. The PEG grammar is a context-free grammar that can be ported to different parser generators, mostly by adapting the parser actions to the target language. Currently we use pegjs to build the actual JavaScript tokenizer for us. We try to do as much work as possible in the grammar-based tokenizer, so that the emitted tokens are already mostly syntax-independent.
 * 2) Token stream transformations are used to implement context-sensitive wiki-specific functionality (wiki lists, quotes for italic/bold etc). Templates are also be expanded at this stage, which makes it possible to still render unbalanced templates like table start / row / end combinations.
 * 3) The resulting tokens are then fed to a HTML5-spec compatible DOM tree builder (currently the 'html5' node.js module), which builds a HTML5 DOM tree from the token soup. This step already sanitizes nesting and enforces some content-model restrictions according to the rules of the HTML5 parsing spec.
 * 4) The resulting DOM is further manipulated using postprocessors. Currently, any remaining top-level inline content is wrapped into paragraphs in such a postprocessor. For output for viewing, further document model sanitation can be added here to get very close to what tidy does in the production parser.
 * 5) Finally, the DOM tree can be serialized as XML or HTML.

Some round-trip test results

 * b49f29be3c778db630124782db10b6e7eb73bb90 : 72k tested, 91.26% / 71.36%
 * 4eef2ccd89aa0bc092a14a175f5ecada89035b73 : 93900 tested, 94.09% / 75.39%

Technical documents

 * /HTML5 DOM with microdata: Design for the embedding of Wiki information into the HTML5 DOM produced by the parser, and used for communication with the visual editor. Not implemented, but gives the general idea.
 * Parsoid/RDFa vocabulary: Actual design work using RDFa instead of Microdata. Implementation in progress.
 * /test cases: Please add interesting snippets or pages.
 * Minimization of DOM tags primarily used for minimizing nesting of inline tags (bold and inline primarily).