Mediawiki syntax

This article explains the Mediawiki syntax which is supported by the tool.

Configure the tool to parse articles with the Mediawiki syntax

To be able to parse files with the Mediawiki syntax, you need to set either:^[1]

You can't use both the Markdown syntax and the Mediawiki syntax

• The allowMediawiki property on the command-line
• Or the allowMediawiki configuration property

The files must have the .md extension.

For example:

      java -jar docGenerator.jar -input=wiki/input -output=wiki/output -allowMediawiki=true

Generalities

The Mardown syntax is a lightweight markup language which allows to convert the syntax to HTML files. However this format is not really standardized and does not support several features which are necessary in a wiki, such as:

• links to resources and files
• inter-wiki links
• Categories

The docJGenerator tool uses the Mediawiki syntax used for wikipedia articles (Mediawiki).

Syntax

See Mediawiki markup.

Escaping non UTF8 characters

As for articles specified in XML, the parsing of Mediawiki files will escape non UTF8 characters by specifying the "escapeNonUTF8" option on the command-line or the configuration file.