Skip to content

Commit c5189b2

Browse files
fugerit79fugerit79
committed
Merge branch 'main' into docs
2 parents 27e579a + ac576c9 commit c5189b2

File tree

23 files changed

+73
-23
lines changed

23 files changed

+73
-23
lines changed

‎README.md‎

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ The Core library (fj-doc-base) is all you need to start, even though typically y
77
* fj-doc-freemarker
88
* One or more type handlers modules
99

10-
Useful resources : [github pages documentation](https://venusdocs.fugerit.org/) | [project home page](https://www.fugerit.org/perm/venus) | docgen [home](https://www.fugerit.org/data/java/doc/venus/index.html) | [release notes](https://www.fugerit.org/data/java/doc/venus/release-notes.html)
10+
Useful resources : [github pages documentation](https://venusdocs.fugerit.org/) | [project home page](https://www.fugerit.org/perm/venus) | docgen [home](https://www.fugerit.org/data/java/doc/venus/index.html) | [release notes](https://www.fugerit.org/data/java/doc/venus/release-notes.html) | [Doc XSD Configuration Reference](https://venusdocs.fugerit.org/fj-doc-base/src/main/docs/doc_xsd_config_ref.html)
1111

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

@@ -17,7 +17,7 @@ There are five kinds of components (each components README.md contains module st
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))
1818
* [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]
1919
* [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]
20-
* 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)
20+
* Doc format XSD [public](https://www.fugerit.org/data/java/doc/xsd/doc-2-0.xsd) and [private](fj-doc-base/src/main/resources/config/doc-2-0.xsd)
2121

2222
### 2. Modules :
2323
* [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))
@@ -39,6 +39,7 @@ There are five kinds of components (each components README.md contains module st
3939

4040
### 4. Bundled libraries :
4141
* [Simple table (fj-doc-lib-singletable)](fj-doc-lib-simpletable/README.md) - offers a simple API for creating a document made of a table.
42+
* [XSD Autodoc (fj-doc-lib-autodoc)](fj-doc-lib-autodoc/README.md) - offers a simple api for documenting the Venus library (to a limited extent some features can be used on any xsd).
4243
* [Doc type validation (fj-doc-val)](fj-doc-val/README.md) - simple utilities for validating file type.
4344

4445
### 5. Tutorial :

‎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.7.2",
5-
"date" : "04/01/2023",
4+
"version" : "0.8.0",
5+
"date" : "07/01/2023",
66
"organization" : {
77
"name" : "Fugerit Org",
88
"url" : "https://www.fugerit.org"

‎docgen/release-notes.txt‎

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,10 @@
1-
0.7.2 (2023-01-04)
1+
0.8.0 (2023-01-07)
2+
------------------
3+
+ Added a new module for generating documentation [fj-doc-lib-autodoc](https://github.com/fugerit-org/fj-doc/tree/main/fj-doc-lib-autodoc)
4+
+ Published new version of [doc-2-0.xsd](https://venusdocs.fugerit.org/fj-doc-base/src/main/resources/config/doc-2-0.xsd), [see doc xsd changelog](https://github.com/fugerit-org/fj-doc/blob/main/fj-doc-base/DocXsdChangelog.md)
5+
+ Created a brand new [xsd reference documentation](https://venusdocs.fugerit.org/fj-doc-base/src/main/docs/doc_xsd_config_ref.html)
6+
7+
0.7.2 (2023-01-04)
28
------------------
39
+ Fixed xml validation in DocXmlParser
410
+ Added validation in DocJsonParser and DocYamlParser (though conversion to XML)

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

Lines changed: 1 addition & 1 deletion
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.7.2</version>
10+
<version>0.8.0</version>
1111
</parent>
1212

1313
<name>fj-doc-base-json</name>

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

Lines changed: 1 addition & 1 deletion
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.7.2</version>
10+
<version>0.8.0</version>
1111
</parent>
1212

1313
<name>fj-doc-base-yaml</name>

‎fj-doc-base/pom.xml‎

Lines changed: 1 addition & 1 deletion
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.7.2</version>
10+
<version>0.8.0</version>
1111
</parent>
1212

1313
<name>fj-doc-base</name>

fj-doc-lib-autodoc/src/main/docs/doc_xsd_config_ref.html renamed to fj-doc-base/src/main/docs/doc_xsd_config_ref.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,7 @@
2727
</head>
2828
<body>
2929
<div>
30-
<h1 style="font-weight: bold; ">Reference configuration for Venus Doc Generation (fj-doc)</h1>
30+
<h1 style="font-weight: bold; ">Reference xsd documentation for Venus - Fugerit Document Generation Framework (fj-doc) 2.0.0-b1</h1>
3131
<table style='width: 100%'>
3232
<thead>
3333
<tr>

‎fj-doc-freemarker/pom.xml‎

Lines changed: 1 addition & 1 deletion
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.7.2</version>
10+
<version>0.8.0</version>
1111
</parent>
1212

1313
<name>fj-doc-freemarker</name>

‎fj-doc-lib-autodoc/CHANGELOG.md‎

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
# Changelog for module fj-doc-lib-simpletable
2+
3+
## version 0.5.10 - 2022-12-12
4+
* Added maximum table width
5+
* Added doc language support
6+
7+
## version 0.5.9 - 2022-12-11
8+
* Added support for cell style and align

‎fj-doc-lib-autodoc/README.md‎

Lines changed: 35 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,35 @@
1+
# Fugerit Document Generation Framework (fj-doc)
2+
3+
## Bundle library : XSD Autodoc (fj-doc-lib-autodoc)
4+
5+
[back to fj-doc index](../README.md)
6+
7+
*Description* :
8+
This library generating documentation automatically from an XSD. It has been tested deeply only on Venus XSD 2.0 and later.
9+
10+
*Status* :
11+
All basic features are implemented.
12+
13+
14+
*Quickstart* :
15+
This module can be used by adapting this sample code :
16+
17+
```
18+
try ( FileOutputStream fos = new FileOutputStream( new File( "target.html" ) ) ) {
19+
String pathToXsd = ...;
20+
XsdParserFacade xsdParserFacade = new XsdParserFacade();
21+
AutodocModel autodocModel = xsdParserFacade.parse( pathToXsd );
22+
autodocModel.setVersion( "version" );
23+
autodocModel.setTitle( "title" );
24+
autodocModel.setXsdPrefix( "xsd:" ); // xsd prefix
25+
autodocModel.setAutodocPrefix( "doc:" ); // my xsd prefix
26+
AutodocDocConfig docConfig = AutodocDocConfig.newConfig();
27+
docConfig.processAutodocHtmlDefault(autodocModel, fos);
28+
} catch (Exception e) {
29+
... error handling ...
30+
}
31+
32+
```
33+
34+
*Dependencies* :
35+
This library currently relies on [xmlet/XsdParser](https://github.com/xmlet/XsdParser)

0 commit comments

Comments
 (0)