Basic usage

This article presents the basic usage and configuration of the tool.

Minimal configuration

To be able to generate the wiki, you only need at the minimum to specify:

• The input directory
• The output directory

For example on the command-line:

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

The tool will produce a html site as an offline wiki-like site in the output directory.

Useful specific configurations

Not checking HTTP URLs

In some environments, access to external URLs is not allowed or limited to specific configurations. If you want to avoid to check for the validity of HTTP URLs during the generation, you must set to false the "checkHTTPLinks" property. For example:

      java -jar docGenerator.jar -input=wiki/input -output=wiki/output -checkHTTPLinks=false

Allowing Mediawiki content

It you want to allow articles with a mediawiki syntax, you must set to true the "allowMediawiki" property. For example:

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

Using a configuration file

If you have many properties, you might want to define them in a configuration file rather than on the command-line. For example, suppose that we want to allow Mediawiki content, and don't check HTTP links. We can define a myConfigFile.properties configuration file with the following content:

   checkHTTPLinks=false
   allowMediawiki=true

And start the tool on the command-line with the following properties:

      java -jar docGenerator.jar -input=wiki/input -output=wiki/output -config=myConfigFile.properties

Note that you can even specify the input and output directories on the configuration file.