Home
Categories
Dictionary
Download
Project Details
Changes Log
What Links Here
How To
Syntax
FAQ
License

Prerequisites



The tool can work on both Windows and Unix-like platforms, and on JRE version greater or equal to Java 8.

JRE distribution

The JRE is not included in the tool distribution, so you must have a JRE available for your platform. The tool has been tested on both Java 8 and Java 17 JRE versions, on both Windows an Mac OS X platforms.

You don't need to have the JRE installed on your system, you can also use the JRE on any directory without having it installed.

JavaFX platform

You don't need to have the JavaFX platform available for Java versions greater than Java 9 (Java 10 and greater). The tool does not have any dependencies on JavaFX libraries[1]
The JavaFX platform is not included by default on JRE beginning with Java 10
.

Using the tool on Unix-like platforms

You can use the tool on Unix-like platforms exactly as on Windows. The GUI interface and the command-line starting modes are both available. If you prefer to use a batch file, you can do very simply, such as for example:
   #!/bin/bash
   java -jar -Dfile.encoding=UTF8 soft/docGenerator.jar -config=source/config.properties -input=source -output=wiki

Of course if you want to use a bash file you will need to make it executable by for example chmod +x myBashFile.sh.

Notes

  1. ^ The JavaFX platform is not included by default on JRE beginning with Java 10

Categories: general

docJGenerator Copyright (c) 2016-2023 Herve Girod. All rights reserved.