Skip to content

Commit 32bd190

Browse files
committed
Merge branch 'master' into docs
2 parents a166c10 + 396507b commit 32bd190

File tree

64 files changed

+89
-5061
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

64 files changed

+89
-5061
lines changed

README.md

Lines changed: 24 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -5,25 +5,30 @@ Framework to produce documents in different formats starting from an XML documen
55
The Core library (fj-doc-base) is all you need to start, even though typically you will use at least :
66
* fj-doc-base
77
* fj-doc-freemarker
8-
* One or more type handlers
8+
* One or more type handlers modules
99

1010
A quick start is available in module [fj-doc-sample](fj-doc-sample/README.md)
1111

1212
There are five kinds of components (each components README.md contains module status) :
1313

1414
### 1. Framework core :
15-
* [Core library (fj-doc-base)](fj-doc-base/README.md)
15+
* [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))
1616
* 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)
1717

18-
### 2. Feature extensions :
19-
* [FreeMarker template, (fj-doc-freemarker)](fj-doc-freemarker/README.md) (containes a simple renderer for [HTML](fj-doc-freemarker/src/main/java/org/fugerit/java/doc/freemarker/html/FreeMarkerHtmlTypeHandler.java) and [HTML FRAGMENT](fj-doc-freemarker/src/main/java/org/fugerit/java/doc/freemarker/html/FreeMarkerHtmlFragmentTypeHandler.java))
20-
* [Java EE extension (fj-doc-ent)](fj-doc-ent/README.md)
21-
22-
### 3. Type Handlers (Render) :
23-
* [Apache POI Renderer (fj-doc-mod-poi)](fj-doc-mod-poi/README.md) ([XLS](fj-doc-mod-poi/src/main/java/org/fugerit/java/doc/mod/poi/XlsPoiTypeHandler.java)/[XLSX](fj-doc-mod-poi/src/main/java/org/fugerit/java/doc/mod/poi/XlsxPoiTypeHandler.java))
24-
* [Apache PdfBox Renderer (PDF)(fj-doc-mod-pdfbox)](fj-doc-mod-pdfbox/README.md)
25-
* [Itext 2.X Renderer (PDF/RTF/HTML)(fj-doc-mod-itext)](fj-doc-mod-itext/README.md)
26-
* [JXL Renderer (XLS)(fj-doc-mod-jxl)](fj-doc-mod-jxl/README.md)
18+
### 2. Modules :
19+
* [FreeMarker template, (fj-doc-freemarker)](fj-doc-freemarker/README.md) (contains a simple renderer for [HTML](fj-doc-freemarker/src/main/java/org/fugerit/java/doc/freemarker/html/FreeMarkerHtmlTypeHandler.java) and [HTML FRAGMENT](fj-doc-freemarker/src/main/java/org/fugerit/java/doc/freemarker/html/FreeMarkerHtmlFragmentTypeHandler.java))
20+
* [Apache POI Module (fj-doc-mod-poi)](fj-doc-mod-poi/README.md) ([XLS](fj-doc-mod-poi/src/main/java/org/fugerit/java/doc/mod/poi/XlsPoiTypeHandler.java)/[XLSX](fj-doc-mod-poi/src/main/java/org/fugerit/java/doc/mod/poi/XlsPoiTypeHandler.java))
21+
* [Apache FOP Module (fj-doc-mod-fop)](fj-doc-mod-fop/README.md) ([PDF](fj-doc-mod-fop/src/main/java/org/fugerit/java/doc/mod/fop/PdfFopTypeHandler.java)/[FO](fj-doc-mod-fop/src/main/java/org/fugerit/java/doc/mod/fop/FreeMarkerFopTypeHandler.java))
22+
23+
### 3. Available type handlers :
24+
* [MD BASIC](fj-doc-base/src/main/java/org/fugerit/java/doc/base/typehandler/markdown/SimpleMarkdownBasicTypeHandler.java) - (fj-doc-core) output as Markdown basic language
25+
* [MD EXT](fj-doc-base/src/main/java/org/fugerit/java/doc/base/typehandler/markdown/SimpleMarkdownExtTypeHandler.java) - (fj-doc-core) output as Markdown extended (include tables) language
26+
* [HTML](fj-doc-freemarker/src/main/java/org/fugerit/java/doc/freemarker/html/FreeMarkerHtmlTypeHandler.java) - (fj-doc-freemarker) output as html
27+
* [HTML FRAGMENT](fj-doc-freemarker/src/main/java/org/fugerit/java/doc/freemarker/html/FreeMarkerHtmlFragmentTypeHandler.java) - (fj-doc-freemarker) output as html body content only (no html, head or body tags)
28+
* [XLS](fj-doc-mod-poi/src/main/java/org/fugerit/java/doc/mod/poi/XlsPoiTypeHandler.java) - (fj-doc-mod-poi) output as Microsoft XLS using Apache POI
29+
* [XLSX](fj-doc-mod-poi/src/main/java/org/fugerit/java/doc/mod/poi/XlsPoiTypeHandler.java) - (fj-doc-mod-poi) output as Microsoft XLSX using Apache POI
30+
* [PDF](fj-doc-mod-fop/src/main/java/org/fugerit/java/doc/mod/fop/PdfFopTypeHandler.java) - (fj-doc-mod-fop) - output as PDF using Apache FOP
31+
* [FO](fj-doc-mod-fop/src/main/java/org/fugerit/java/doc/mod/fop/FreeMarkerFopTypeHandler.java) - (fj-doc-mod-fop) - output as FO using Apache FOP
2732

2833
### 4. Tutorial :
2934
* [Samples and Quickstart (fj-doc-sample)](fj-doc-sample/README.md)
@@ -32,6 +37,14 @@ There are five kinds of components (each components README.md contains module st
3237
Basically the same as type handlers but based on libraries non available on Maven Repository Central (es. PDFLIB).
3338
You can find in them in a dedicated repository [fj-doc-ext](https://gitlab.com/fugerit-org/fj-doc-ext)
3439

40+
### 5. Incubator Type Handlers (Are too far from being complete) :
41+
* [Apache PdfBox Renderer (PDF)(fj-doc-mod-pdfbox)](https://github.com/fugerit-org/fj-doc-mod-pdfbox.git) (incubator since version 0.5.0)
42+
43+
### 6. Deprecated Type Handlers (Will not be maintained) :
44+
* [JXL Renderer (XLS)(fj-doc-mod-jxl)](https://github.com/fugerit-org/fj-doc-mod-jxl.git) (deprecated as [jexcelapi](https://jexcelapi.sourceforge.net/) is no longer mantained, may be used 'AS IS') (deprecated since version 0.5.0)
45+
* [Itext 2.X Renderer (PDF/RTF/HTML)(fj-doc-mod-jxl)](https://github.com/fugerit-org/fj-doc-mod-itext.git) (deprecated as [IText 2.1.X](https://mvnrepository.com/artifact/com.lowagie/itext/2.1.7) is no longer mantained, may be used 'AS IS') (deprecated since version 0.5.0)
46+
* [Java EE extension (fj-doc-ent)](https://github.com/fugerit-org/fj-doc-ent.git)) (deprecated as not the module fj-mod-freemarker provided mostly the same features, but in a standalone mode) (deprecated since version 0.5.0)
47+
3548
*About javadoc*
3649
Javadoc are far from being complete, but you can find latest version at [https://www.fugerit.org](https://www.fugerit.org/data/java/javadoc/)
3750
Note that, being an open source project hosted on maven central, you can find release javadoc on [javadoc.io](https://javadoc.io/doc/org.fugerit.java/fj-doc-base/)

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.3.9.4",
5-
"date" : "06/04/2022",
4+
"version" : "0.5.0",
5+
"date" : "17/11/2022",
66
"organization" : {
77
"name" : "Fugerit Org",
88
"url" : "https://www.fugerit.org"

docgen/release-notes.txt

Lines changed: 24 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,27 @@
1-
0.3.9.4 (2022-04-06)
1+
0.5.0 (2022-11-17) [0.5-RC2]
2+
------------------
3+
+ Changed fj-core version to 0.8.0
4+
+ Added parent (fj-bom 0.2.2)
5+
+ Put in incubator and moved module [fj-doc-mod-pdfbox](https://github.com/fugerit-org/fj-doc-mod-pdfbox.git)
6+
+ Deprecated and moved module [fj-doc-ent](https://github.com/fugerit-org/fj-doc-ent.git)
7+
+ Deprecated and moved module [fj-doc-mod-itext](https://github.com/fugerit-org/fj-doc-mod-itext.git)
8+
+ Deprecated and moved module [fj-doc-mod-jxl](https://github.com/fugerit-org/fj-doc-mod-jxl.git)
9+
+ Updated README.md
10+
11+
0.4.2 (2022-11-07)
12+
------------------
13+
+ Changed fj-core version to 0.7.9
14+
15+
0.4.1 (2022-11-07)
16+
------------------
17+
+ Bump hsqldb from 2.5.0 to 2.7.1
18+
19+
0.4.0 (2022-11-07)
20+
------------------
21+
+ Changed version format to MAJOR.MINOR.PATH
22+
+ Changed fj-core version to 0.7.8
23+
24+
0.3.9.4 (2022-04-06)
225
--------------------
326
+ para can now contains para and phrases (fop and freemarker mod)
427
+ Changed fj-core version to 0.7.6.8

fj-doc-base/pom.xml

Lines changed: 1 addition & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@
77
<parent>
88
<groupId>org.fugerit.java</groupId>
99
<artifactId>fj-doc</artifactId>
10-
<version>0.3.9.4</version>
10+
<version>0.5.0</version>
1111
</parent>
1212

1313
<name>fj-doc-base</name>
@@ -31,13 +31,6 @@
3131
<groupId>org.fugerit.java</groupId>
3232
<artifactId>fj-core</artifactId>
3333
</dependency>
34-
35-
<!-- java core dependancies -->
36-
<dependency>
37-
<groupId>javax</groupId>
38-
<artifactId>javaee-api</artifactId>
39-
<scope>provided</scope>
40-
</dependency>
4134

4235
</dependencies>
4336

fj-doc-ent/README.md

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

fj-doc-ent/pom.xml

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

fj-doc-ent/src/main/java/org/fugerit/java/doc/ent/config/DocServletConfig.java

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

fj-doc-ent/src/main/java/org/fugerit/java/doc/ent/helpers/DocResponseHelper.java

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

0 commit comments

Comments
 (0)