XWiki Rendering Framework
Last modified byon 2017/02/06 15:14
- Parser: Parses some textual input in a given syntax and generate a XDOM object which is an AST representing the input into structured blocks.
- Renderer: Takes a XDOM as input and generates some output.
- Transformation: Takes some XDOM and modifies it to generate a modified XDOM.
Seefor more details.
- Parsers for .
- Offers both a streaming API (useful for rendering large content) and an XDOM-based API (generates an intermediary AST on which transformations - such as macros - can be applied)
- Round trip between and XHTML. This features allows for example to have a strong WYSIWYG editor that doesn't loose information when editing wiki pages. Another use case is the ability to import Office documents in HTML and transform them into XWiki Syntax 2.0 without loosing information.
- 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.
- Ability to transform the XDOM through a Transformation (list of of ).
- Macro support (list of ). Note that Macro support is implemented as a Transformation (see ).
- Supports wiki syntax in link labels even for input syntaxes that don't support it.
- Automatic conversion from any of the supported input syntaxes to XWiki Syntax 2.0 or to XHTML.
- Strong Parsers:
- Based on Grammars (JavaCC)
- Fix user mistakes (not closed or overlapping markup elements...).
- Each block element (paragraph, table cells, list items, headers...) can spread over multiply lines.
- Support for groups, i.e. ability to include content inside other content (equivalent of DIV in HTML).
- All elements can have parameters associated to them.
- Been used in for several years and is stable and performant.
- Can be used standalone since it's independent of other XWiki projects such as XWiki Platform, XWiki Enterprise, etc.
The XWiki Rendering modules are all released under the.
- Input Syntax
- It means there's a Parser that can be used to parse this syntax into a XDOM object
- Output Syntax
- It means there's a Renderer that can be used to render an XDOM into this syntax
|Name||Id||Input Syntax?||Output Syntax?||Description|
|xwiki/2.1||Experimental at this stage which means it can still change before it's released as final.|
|HTML 5.0||html/5.0||Available in XWiki Rendering 6.4+ only.|
|Plain Text||plain/1.0||Print all than can be rendered in a simple notepad-like editor such as words, special symbols and spaces. It also generates link labels for links that have no labels and print the generated labels. Last it provides very basic formatting (e.g. separates paragraphs with new lines and separates list items with new lines).|
|docbook/4.4||Available in XWiki Rendering 3.2+ only.|
|xdom+xml/curent||Available in XWiki Rendering 3.3+ only.|
|xdom+xml/1.0||Available in XWiki Rendering 3.3+ only.|
|confluence/1.0||Removed in 9.0. Should use 1.1 instead. See.|
|confluence/1.1||Moved to contrib in 9.0. See.|
|confluence+xhtml/1.0||Moved to contrib in 9.0. See.|
|markdown/1.0||Extracted out of XWiki starting 8.2M1. Output syntax supported starting with version 8.2 of the Markdown module.|
|markdown/1.1||Extracted out of XWiki starting 8.2M1. Adds syntax for macros, superscript and subscript support over Markdown 1.0 syntax. Output syntax supported starting with version 8.2 of the Markdown module.|
|markdown/1.2||Added in version 8.4 of the Markdown module.|
|apt/1.0||Available in XWiki Rendering 4.3+ only.|
This simple demo converts your input written in one syntax to another syntax.
Check thewhich contains all information to access the XWiki Rendering binaries.
Source files are available.
Projects using XWiki Rendering
- : of course...
- : Uses both the XWiki Rendering and the XWiki WYSIWYG Editor to provide a simple wiki inside their tools
- : Uses XWiki Rendering to generate DocBook from content written using a wiki syntax
- : Uses XWiki Rendering in its
- : Grails plugin that allows to convert text using the XWiki Rendering Framework.
Here are some libraries similar to XWiki Rendering in purpose:
- : XWiki Rendering actually uses WikiModel and extends it. Note that since WikiModel wasn't active anymore, the XWiki project has forked it and incorporated it in its own sources.
- : Note that XWiki Rendering has a basic bridge to Doxia
- provides a MediaWiki syntax parser and renderer (see .