Configuration

There are several ways to configure the tool:

• By using the GUI interface
• By using the command-line arguments to configure the options
• By using the configuration file to configure the options

Using the GUI interface

Double clicking on the Jar file of the application without specifying any command-line parameter will open the GUI of the application.

Using the command-line arguments

The following example specifies:

• The input directory
• The output directory
• The cleaned option to clean the wiki output before its generation
• The search option to search on the articles names and titles

      java -jar docGenerator.jar -input=wiki/input -output=wiki/output -cleaned=true -search=titles

Using the configuration file

The following example specifies:

• The input directory
• The output directory
• The cleaned option to clean the wiki output before its generation
• The search option to search on the articles names and titles

The content of the configuration file is:

   cleaned=true
   search=titles

To use the configuration file:

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

Priority between the command-line arguments and the configuration file

Options specified as command-line arguments are overriding those specified in the configuration file.

For example, suppose the following command-line arguments:

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

And the content of the configuration file:

   cleaned=true
   search=false

The resulting options will be:

• The input directory
• The output directory
• The cleaned option will be set to true
• The search option will be set to titles