Incremental generation

It is possible to perform the generation in an incremental generation mode rather than to parse and generate all the content of the wiki. You need to set the "incrementalGeneration" command-line argument or configuration property.

The incremental generation mode allows to decrease dramatically the time necessary to perform the generation.

Overview

The incremental generation mode work by only parsing and generating the content of the wiki which has changed since the last generation. It relies on a incremental generation file which store various data associated with each element in the wiki, and the last time of the generation.

Only input files which have been updated since the last generation will be parsed and generated, and the incremental generation state file will be updated.

Generation options

The two generation options used for the incremental generation mode are:

• "incrementalGeneration": true if the wiki generation is in incrementalGeneration mode
• "incrementalGenerationFile": the file used for the incrementalGeneration mode. By default this property is not set and the default file will be used

Conditions

There are some cases where all the content will be generated. It is the case if:

• The wiki is generated in incremental generation mode for the first time^[1]
  Which result in a not existing incremental generation file
• The generation cleaned parameter is set to true
• Some of the generation parameters are changed since the previous generation^[2]
  It includes: the search type, the full search capability, the full text search compression
• The output format is not the default "html" format

Example

The following example will use the incremental generation mode for the generation:

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