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

Editor requirements



To be able to open the editor, you need:
  • To define at least the inputs of the wiki
  • To have the docGeneratorEditor.jar library in your ClassPath (by default it is included if the jar file is in the same directory as the docGenerator.jar jar file)
  • You also need to have the JavaFX framework in your ClassPath[1]
    Note that by default it is not automatically the case if your Java version is at least Java 11
If one of these conditions is not fulfilled, the option will be grayed-out:
editordisabled

JavaFX requirements

You need to have JavaFX on your ClassPath to be able to launch the Editor:
  • JavaFX is on the ClassPath for Java versions before Java 11, but it is not the case beginning with Java 11. You will need to add it explicitly
You also need to open the javafx.web/javafx.scene.web and javafx.web/com.sun.webkit modules to be able to use the Search function.

Opening the GUI

Main Article: Opening the GUI

If you double-click on the launcher.jar jar file in the install directory, you will open the GUI interface and the Editor will be available.

You need to configure the docgenerator.conf file in the same directory. This is a properties file containing two properties:
  • JAVAHOME: the path of the JAVA_HOME directory. If you don't specify the path or it is empty, the default JRE location will be used
  • JAVAFXLIB: the path of the JavaFX library. If the JRE is less than Java 11, this will not be used because before Java 11, JavaFX is bundled with the JRE installation

Notes

  1. ^ Note that by default it is not automatically the case if your Java version is at least Java 11

See also


Categories: editor | gui

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