Rendering Module

This module is in charge of converting textual input in a given syntax into some rendered output. It's used in XWiki notably for rendering pages in XHTML, for performing syntax conversions, for performing page refactorings and to provide users with access to the page's structured information directly inside their wiki pages using one of the supported scripting macros.

Features

• Parsers for multiple syntaxes
• Round trip between XWiki Syntax 2.0 and XHTML. This features allows us to have a strong WYSIWYG editor that doesn't loose information when editing wiki pages. It also allows us to import Office documents into XWiki without loosing information.
• Macro support.
• Ability to get the result of the parsing as an AST tree (called XDOM) which can then be used to get access to all structured elements from the flat text input.
• Supports wiki syntax in link labels even for syntaxes that don't support it.
• Automatic conversion from any of the supported input syntaxes to XWiki Syntax 2.0 or to XHTML.

General Architecture

TODO: explain notions of Parser/Renderer/Macro/Transformation

Supported Syntaxes

Input Syntaxes:

• XWiki Syntax 1.0
• XWiki Syntax 2.0
• Confluence Syntax
• JSPWiki Syntax
• TWiki syntax
• Creole 1.0 Syntax
• XHTML and HTML Syntaxes

Output Syntaxes:

• XWiki Syntax 2.0
• XHTML 

Example

Adding support for a new Syntax

TODO

Adding a new Macro

TODO

Adding a new Transformation

TODO