This module contains AsciiDoc sources and configuration to generate Jakarta Data documentation in HTML and PDF formats for both Apache License 2 and Jakarta Eclipse Foundation Specification Process.
From the spec directory, execute mvn install
Maven will generate the final documentation in HTML and PDF format in target directory with the default license (ASL2).
The HTML version of the document may be found in:
- target/generated-docs/jakarta-data-<version>.html
The PDF version of the document may be found in:
- target/generated-docs/jakarta-data-<version>.pdf
The documentation can be generated for 2 licenses : Apache License v 2.0 (by default) and EFSL license.
To generate doc with the final EFSL license, change the license-file property to final. Use asl or
specify nothing for the Apache V2 License.
For instance mvn -Dlicense-file=final will generate documentation with the EFSL final license.
This specification is split among different AsciiDoc files located in src/main/asciidoc
The master document (entry point) is jakarta-data.adoc that includes all the specification documents.
To work with the specification documents, you may want to install an AsciiDoc plugin in your preferred IDE. You can also use a good text editor that provides an AsciiDoc plugin. The best candidate are:
-
Download the latest AsciidocFX.zip and extract it
-
Execute
bin/asciidocfx.batorbin/asciidocfx.sh