Skip to content

Commit 4a3dae9

Browse files
fugerit79fugerit79
committed
0.7.0 (2022-12-29)
+ Added module for using json a document generator [fj-doc-base-json](https://github.com/fugerit-org/fj-doc/tree/main/fj-doc-base-json) (based on jackson) + Added module for using yaml a document generator [fj-doc-base-yaml](https://github.com/fugerit-org/fj-doc/tree/main/fj-doc-base-yaml) (based on jackson) + Added playground module [fj-doc-playground-quarkus](https://github.com/fugerit-org/fj-doc/tree/main/fj-doc-playground-quarkus) (based on quarkus) + Better pdf validation handling + Updated fj-core version to 0.8.6
1 parent acc54bf commit 4a3dae9

File tree

17 files changed

+330
-287
lines changed

17 files changed

+330
-287
lines changed

‎README.md‎

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -15,6 +15,8 @@ There are five kinds of components (each components README.md contains module st
1515

1616
### 1. Framework core :
1717
* [Core library (fj-doc-base)](fj-doc-base/README.md) (contains a simple renderer for [Markdowm BASIC](fj-doc-base/src/main/java/org/fugerit/java/doc/base/typehandler/markdown/SimpleMarkdownBasicTypeHandler.java) and [Markdown EXT](fj-doc-base/src/main/java/org/fugerit/java/doc/base/typehandler/markdown/SimpleMarkdownExtTypeHandler.java))
18+
* [Json extension (fj-doc-base-json)](fj-doc-base-json/README.md) (allow for using json as document generator instead of standard xml generator) [since 0.7.0]
19+
* [Yaml extension (fj-doc-base-yaml)](fj-doc-base-yaml/README.md) (allow for using yaml as document generator instead of standard xml generator) [since 0.7.0]
1820
* Doc format XSD [public](https://www.fugerit.org/data/java/doc/xsd/doc-1-1.xsd) and [private](fj-doc-base/src/main/resources/config/doc-1-1.xsd)
1921

2022
### 2. Modules :
@@ -40,6 +42,7 @@ There are five kinds of components (each components README.md contains module st
4042
* [Doc type validation (fj-doc-val)](fj-doc-val/README.md) - simple utilities for validating file type.
4143

4244
### 5. Tutorial :
45+
* [Playgroundt (fj-doc-playground-quarkus)](fj-doc-playground-quarkus/README.md) [since 0.7.0]
4346
* [Samples and Quickstart (fj-doc-sample)](fj-doc-sample/README.md)
4447

4548
### 6. Extension Type Handlers (Extension renders) :

‎docgen/parameters.json‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
11
{
22
"title" : "Venus (Fugerit Document Generation Framework)",
33
"name": "Venus",
4-
"version" : "0.6.2",
5-
"date" : "23/12/2022",
4+
"version" : "0.7.0",
5+
"date" : "29/12/2022",
66
"organization" : {
77
"name" : "Fugerit Org",
88
"url" : "https://www.fugerit.org"

‎docgen/release-notes.txt‎

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,10 @@
1-
0.6.3 (2022-12-XX)
1+
0.7.0 (2022-12-29)
22
------------------
3+
+ Added module for using json a document generator [fj-doc-base-json](https://github.com/fugerit-org/fj-doc/tree/main/fj-doc-base-json) (based on jackson)
4+
+ Added module for using yaml a document generator [fj-doc-base-yaml](https://github.com/fugerit-org/fj-doc/tree/main/fj-doc-base-yaml) (based on jackson)
5+
+ Added playground module [fj-doc-playground-quarkus](https://github.com/fugerit-org/fj-doc/tree/main/fj-doc-playground-quarkus) (based on quarkus)
36
+ Better pdf validation handling
7+
+ Updated fj-core version to 0.8.6
48

59
0.6.2 (2022-12-23)
610
------------------

‎fj-doc-base-json/README.md‎

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
# Fugerit Document Generation Framework (fj-doc)
2+
3+
## Core library : json extension (fj-doc-base-json)
4+
5+
[back to fj-doc index](../README.md)
6+
7+
*Description* :
8+
Add the option to use a json as document generator instead of standard xml source provided by default.
9+
10+
*Status* :
11+
All basic features are implemented (json parsing, conversion from and to xml)

‎fj-doc-base-multi/pom.xml‎

Lines changed: 0 additions & 98 deletions
This file was deleted.

‎fj-doc-base-yaml/README.md‎

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
# Fugerit Document Generation Framework (fj-doc)
2+
3+
## Core library : yaml extension (fj-doc-base-json)
4+
5+
[back to fj-doc index](../README.md)
6+
7+
*Description* :
8+
Add the option to use a yank as document generator instead of standard xml source provided by default.
9+
10+
*Status* :
11+
All basic features are implemented (yaml parsing, conversion from and to xml)

‎fj-doc-base/README.md‎

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -10,8 +10,6 @@ Basic infrastructure for generation of [fj-doc XML format](https://www.fugerit.o
1010
*Status* :
1111
All basic features are implemented (plus helpers for other modules).
1212

13-
*[ChangeLog](ChangeLog.md)*
14-
1513
*Quickstart* :
1614

1715
This module is based on [DocHandlerFacade](src/main/java/org/fugerit/java/doc/base/facade/DocHandlerFacade.java)

‎fj-doc-playground-quarkus/README.md‎

Lines changed: 6 additions & 49 deletions
Original file line numberDiff line numberDiff line change
@@ -1,60 +1,17 @@
11
# fj-doc-playground-quarkus Project
22

3-
This project uses Quarkus, the Supersonic Subatomic Java Framework.
4-
5-
If you want to learn more about Quarkus, please visit its website: https://quarkus.io/ .
63

74
## Running the application in dev mode
85

9-
You can run your application in dev mode that enables live coding using:
10-
```shell script
11-
./mvnw compile quarkus:dev
12-
```
13-
14-
> **_NOTE:_** Quarkus now ships with a Dev UI, which is available in dev mode only at http://localhost:8080/q/dev/.
15-
16-
## Packaging and running the application
6+
You can run your application in dev mode that enables live coding using:
7+
shell script
178

18-
The application can be packaged using:
19-
```shell script
20-
./mvnw package
219
```
22-
It produces the `quarkus-run.jar` file in the `target/quarkus-app/` directory.
23-
Be aware that it’s not an _über-jar_ as the dependencies are copied into the `target/quarkus-app/lib/` directory.
24-
25-
The application is now runnable using `java -jar target/quarkus-app/quarkus-run.jar`.
26-
27-
If you want to build an _über-jar_, execute the following command:
28-
```shell script
29-
./mvnw package -Dquarkus.package.type=uber-jar
30-
```
31-
32-
The application, packaged as an _über-jar_, is now runnable using `java -jar target/*-runner.jar`.
33-
34-
## Creating a native executable
35-
36-
You can create a native executable using:
37-
```shell script
38-
./mvnw package -Pnative
39-
```
40-
41-
Or, if you don't have GraalVM installed, you can run the native executable build in a container using:
42-
```shell script
43-
./mvnw package -Pnative -Dquarkus.native.container-build=true
10+
./mvnw compile quarkus:dev
4411
```
4512

46-
You can then execute your native executable with: `./target/fj-doc-playground-quarkus-1.0.0-SNAPSHOT-runner`
47-
48-
If you want to learn more about building native executables, please consult https://quarkus.io/guides/maven-tooling.
49-
50-
## Related Guides
51-
52-
- RESTEasy Reactive ([guide](https://quarkus.io/guides/resteasy-reactive)): A JAX-RS implementation utilizing build time processing and Vert.x. This extension is not compatible with the quarkus-resteasy extension, or any of the extensions that depend on it.
53-
54-
## Provided Code
55-
56-
### RESTEasy Reactive
5713

58-
Easily start your Reactive RESTful Web Services
14+
And go to the home page link [http://localhost:8080/playground/](http://localhost:8080/playground/)
5915

60-
[Related guide section...](https://quarkus.io/guides/getting-started-reactive#reactive-jax-rs-resources)
16+
## modules currently supported in playground :
17+
* fj-doc-val (and all its extensions)

0 commit comments

Comments
 (0)