Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/fugerit-org/fj-doc-guides

Guides to Venus Fugerit Doc Generation Framework
https://github.com/fugerit-org/fj-doc-guides

documentation excel-generation java json markdown-generator pdf-generation xml yaml

Last synced: 13 days ago
JSON representation

Guides to Venus Fugerit Doc Generation Framework

Host: GitHub
URL: https://github.com/fugerit-org/fj-doc-guides
Owner: fugerit-org
License: apache-2.0
Created: 2023-07-30T20:56:29.000Z (over 1 year ago)
Default Branch: main
Last Pushed: 2024-09-09T08:32:10.000Z (4 months ago)
Last Synced: 2024-09-09T10:18:02.911Z (4 months ago)
Topics: documentation, excel-generation, java, json, markdown-generator, pdf-generation, xml, yaml
Language: Java
Homepage: https://www.fugerit.org/perm/venus/
Size: 74.2 KB
Stars: 0
Watchers: 1
Forks: 0
Open Issues: 0
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE

Awesome Lists containing this project

README

        # 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](https://github.com/fugerit-org/fj-doc)) :

[![HTML - Guide](https://img.shields.io/badge/HTML-Guide-blue?style=for-the-badge)](https://venusdocs.fugerit.org/guide/ "Go to project HTML documentation")

[![PDF - Guide](https://img.shields.io/badge/PDF-Guide-red?style=for-the-badge)](https://venusdocs.fugerit.org/guide/fj-doc-guide.pdf "Go to project PDF documentation")

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)](https://github.com/fugerit-org/fj-doc) project.

[![Keep a Changelog v1.1.0 badge](https://img.shields.io/badge/changelog-Keep%20a%20Changelog%20v1.1.0-%23E05735)](https://github.com/fugerit-org/fj-doc-guides/blob/main/CHANGELOG.md) 

[![license](https://img.shields.io/badge/License-Apache%20License%202.0-teal.svg)](https://opensource.org/licenses/Apache-2.0) 

[![Quality Gate Status](https://sonarcloud.io/api/project_badges/measure?project=fugerit-org_fj-doc-guides&metric=alert_status)](https://sonarcloud.io/summary/new_code?id=fugerit-org_fj-doc-guides)

[![Coverage](https://sonarcloud.io/api/project_badges/measure?project=fugerit-org_fj-doc-guides&metric=coverage)](https://sonarcloud.io/summary/new_code?id=fugerit-org_fj-doc-guides)

![Java runtime version](https://img.shields.io/badge/run%20on-java%208+-%23113366.svg?style=for-the-badge&logo=openjdk&logoColor=white)

![Java build version](https://img.shields.io/badge/build%20on-java%2011+-%23ED8B00.svg?style=for-the-badge&logo=openjdk&logoColor=white)

![Apache Maven](https://img.shields.io/badge/Apache%20Maven-3.9.0+-C71A36?style=for-the-badge&logo=Apache%20Maven&logoColor=white)

## Index

A new [Wizard](src/docs/wizard/index.md) section is available, guiding you through some common scenarios.

### General topics

- [Venus Doc Format entry point](src/docs/common/doc_format_summary.md) - a starting point for writing the Venus XML meta model

- [Venus Doc Format and freemarker](src/docs/common/doc_format_freemarker.md) - consideration on using the XML format with [Apache FreeMarker](https://freemarker.apache.org/)

- [From XML to JSON or YAML source](src/docs/common/doc_from_xml_to_json_or_yaml.md) - informations for using json or yaml as source instead of XML

- [Project history](src/docs/common/history.md) - some history of the project and the document format

### Guidelines

- ['Framework basics'](src/docs/guidelines/G001_basics.md) - This document explains the basic of the xml source format

- ['The source XML document format'](src/docs/guidelines/G002_xml_format.md) - This document explains the basics of the xml source format

### Core functionalities practical guides

- [Venus Guide A001 : Hello World PDF](fj-doc-guides-A001-hello-world-pdf/README.md)

- [Venus Guide A002 : Full document](fj-doc-guides-A002-full-document/README.md)

- [Venus Guide A003 : Apache FreeMarker Full document](fj-doc-guides-A003-full-document-freemarker/README.md)

- [Venus Guide A004 : Apache FreeMarker Hello World](fj-doc-guides-A004-freemarker-hello-world/README.md)

### Extra functionalities practical guides

- [Venus Guide E001 : Hello World PDF JSON Source](fj-doc-guides-E001-hello-world-pdf-json-source/README.md)