README.md

Guides to Venus - Fugerit Document Generation Framework (fj-doc)

Deprecation notice start

This guide has been deprecated and will not be maintained, now you can refer to the new official guide (built it in the main Fugerit Venus Doc repository) :

Deprecation reasons :

• Most examples and guides are still working they are more complex than required by new version of Fugerit Venus Doc.
• The new guide is organized in more coherent way
• The new guide rely on AsciiDoc for formatting, which is more powerful than MaroDown

Deprecation notice end

Archive notice start

As of 2024-10-25, this repository is archived as a consequence of deprecation

Archive notice end

This projects provides simple guides to Venus - Fugerit Document Generation Framework (fj-doc) project.

Index

A new Wizard section is available, guiding you through some common scenarios.

General topics

• Venus Doc Format entry point - a starting point for writing the Venus XML meta model
• Venus Doc Format and freemarker - consideration on using the XML format with Apache FreeMarker
• From XML to JSON or YAML source - informations for using json or yaml as source instead of XML
• Project history - some history of the project and the document format

Guidelines

• 'Framework basics' - This document explains the basic of the xml source format
• 'The source XML document format' - This document explains the basics of the xml source format

Core functionalities practical guides

• Venus Guide A001 : Hello World PDF
• Venus Guide A002 : Full document
• Venus Guide A003 : Apache FreeMarker Full document
• Venus Guide A004 : Apache FreeMarker Hello World

Extra functionalities practical guides

• Venus Guide E001 : Hello World PDF JSON Source