Venus - Fugerit Document Generation Framework (fj-doc)

❤️ If this project helps you, please consider dropping a star — it really motivates continued development!

Framework to produce documents in different output formats starting from an XML document metamodel. (options for json and yaml source models are also available)

As of version 8.10.2 most information previously contained in README are available through the new guide :

The Core library (fj-doc-base) is all you need to start, even though typically you will use at least :

• fj-doc-base
• fj-doc-freemarker
• One or more type handlers modules

Quickstart

Existing project

The easiest way to add the minimum configuration to an existing project is with the add goal of maven plugin, for example, running in a maven project base folder :

mvn org.fugerit.java:fj-doc-maven-plugin:add \
-Dextensions=base,freemarker,mod-fop

New project

Alternatively it is possible to create a project from scratch with the
init goal of maven plugin, for example, running the command :

mvn org.fugerit.java:fj-doc-maven-plugin:init \
-DgroupId=org.example.doc \
-DartifactId=fugerit-demo-quarkus-3 \
-Dflavour=quarkus-3 \
-DaddJacoco=true \
-DaddFormatting=true \
-DwithCI=GitHub

It will create a new folder as for the {artifactId} parameter (in our example : fugerit-demo-quarkus-3)

Usage

For more information on framework usage, refer to the guide, especially :

• Doc Source Format
• Dynamic Data
• Doc Handlers
• FAQ

Which provides a reference to customized existing and new projects.

❤️ Support

This project is maintained in my free time.
If you find it useful, please consider supporting it by:

• ⭐ Giving the repository a star
• 🐛 Opening an issue if you find a problem
• 🔧 Creating a pull request if you'd like to improve something
• 📢 Sharing it with others who might be interested

Thank you for helping the project grow!

Special thanks

Special thanks to JetBrains for accepting this project in the Licenses for Open Source Development - Community Support program.

Special thanks to Sonar Cloud, Codacy and Snyk too for their code review platforms.

Last but not least thank to all the OpenSource projects and developers whose software are the building bricks of this and many other repositories.