-
Notifications
You must be signed in to change notification settings - Fork 3
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge branch 'branch-preview' into branch-deploy
- Loading branch information
Showing
32 changed files
with
628 additions
and
32 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
7 changes: 3 additions & 4 deletions
7
fj-doc-guide/src/main/docs/asciidoc/attributes/_attributes-common.adoc
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,10 +1,9 @@ | ||
| :author: Matteo Franci | ||
| :revnumber: v1.0.0 | ||
| :revdate: June XX, 2024 | ||
| :revdate: October 15, 2024 | ||
| :email: [email protected] | ||
| :description: This is a comparison of a simple online demo photobook \ | ||
| implemented with three popular java cloud ready framework. | ||
| :keywords: java, graalvm, spring, springboot, quarkus, micronaut | ||
| :description: Fugerit Doc Venus : document generation framework | ||
| :keywords: java, xml, json, yaml, kotlin, pdf, html, xlsx, csv, document generation | ||
| :encoding: utf-8 | ||
| :lang: en | ||
| :toc: left | ||
|
|
||
38 changes: 38 additions & 0 deletions
38
fj-doc-guide/src/main/docs/asciidoc/chapters/03_4_doc_format_info.adoc
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,38 @@ | ||
| [#doc-format-entry-point-info] | ||
| === Doc Format Info Element | ||
|
|
||
| The _info_ element is available to setup some specific properties of the document. | ||
|
|
||
| Here is a link:https://venusdocs.fugerit.org/docs/html/doc_meta_info.html[list of possible info element]. | ||
|
|
||
| For instance in this document we set following _info_ elements : | ||
|
|
||
| * margin | ||
| * doc-title | ||
| * doc-author | ||
| * doc-language | ||
| Some DocHandler will ignore some info elements. | ||
|
|
||
| [source,xml] | ||
| ---- | ||
| <?xml version="1.0" encoding="utf-8"?> | ||
| <doc | ||
| xmlns="http://javacoredoc.fugerit.org" | ||
| xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" | ||
| xsi:schemaLocation="http://javacoredoc.fugerit.org https://www.fugerit.org/data/java/doc/xsd/doc-2-1.xsd" > | ||
| <metadata> | ||
| <!-- Margin for document : left;right;top;bottom --> | ||
| <info name="margins">10;10;10;30</info> | ||
| <!-- documenta meta information --> | ||
| <info name="doc-title">Hello World</info> | ||
| <info name="doc-author">fugerit79</info> | ||
| <info name="doc-language">en</info> | ||
| </metadata> | ||
| <body> | ||
| <para>Hello World!</para> | ||
| </body> | ||
| </doc> | ||
| ---- |
50 changes: 50 additions & 0 deletions
50
fj-doc-guide/src/main/docs/asciidoc/chapters/06_0_base.adoc
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,50 @@ | ||
| <<< | ||
| [#doc-handler-base] | ||
| === [fj-doc-base] | ||
|
|
||
| Here are described the doc handlers included in the basic module, which usually is always included : | ||
|
|
||
| [source,xml] | ||
| ---- | ||
| <dependency> | ||
| <groupId>org.fugerit.java</groupId> | ||
| <artifactId>fj-doc-base</artifactId> | ||
| <version>${fj-doc-version}</version> | ||
| </dependency> | ||
| ---- | ||
|
|
||
| [#doc-handler-base-md-ext] | ||
| ==== MarkDown (Extended) | ||
|
|
||
| This doc handler would render a MarkDown (Extended) document. The Basic and Extended version only differ for table management. Basic version will render tables in html. | ||
|
|
||
| *In brief* : | ||
|
|
||
| - *compliance level* : _HIGH_ | ||
| - *compliance detail* : All generic link:#doc-format-entry-point[Venus Doc Format] elements are supported. | ||
| - *native ready* : _YES_ | ||
| Add this element to *<docHandlerConfig/>* : | ||
|
|
||
| [source,xml] | ||
| ---- | ||
| <docHandler id="md-ext" info="md" type="org.fugerit.java.doc.base.typehandler.markdown.SimpleMarkdownExtTypeHandlerNoCommentsUTF8" /> | ||
| ---- | ||
|
|
||
| [#doc-handler-base-md-basic] | ||
| ==== MarkDown (Basic) | ||
|
|
||
| This doc handler would render a MarkDown (Basic) document. The Basic and Extended version only differ for table management. Basic version will render tables in html. | ||
|
|
||
| *In brief* : | ||
|
|
||
| - *compliance level* : _HIGH_ | ||
| - *compliance detail* : All generic link:#doc-format-entry-point[Venus Doc Format] elements are supported. | ||
| - *native ready* : _YES_ | ||
| Add this element to *<docHandlerConfig/>* : | ||
|
|
||
| [source,xml] | ||
| ---- | ||
| <docHandler id="md-basic" info="md" type="org.fugerit.java.doc.base.typehandler.markdown.SimpleMarkdownBasicTypeHandlerNoCommentsUTF8" /> | ||
| ---- |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
107 changes: 107 additions & 0 deletions
107
fj-doc-guide/src/main/docs/asciidoc/chapters/06_3_mod-poi.adoc
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,107 @@ | ||
| <<< | ||
| [#doc-handler-mod-poi] | ||
| === [fj-doc-mod-poi] : a XLS/XLSX DocHandler | ||
|
|
||
| To use this doc handler, you will need to add the following dependency : | ||
|
|
||
| [source,xml] | ||
| ---- | ||
| <dependency> | ||
| <groupId>org.fugerit.java</groupId> | ||
| <artifactId>fj-doc-mod-poi</artifactId> | ||
| <version>${fj-doc-version}</version> | ||
| </dependency> | ||
| ---- | ||
|
|
||
| This module is based on link:https://poi.apache.org/[Apache POI Project]. | ||
|
|
||
| [#doc-handler-mod-poi-basics] | ||
| ==== POI Handler Basics | ||
|
|
||
| The following information apply to both xlsx and xls DocHandler. | ||
|
|
||
| You will need at least a table, with an _id_ set. (in this example the id is *data-table*). | ||
|
|
||
| And the link:https://venusdocs.fugerit.org/docs/html/doc_meta_info.html#excel-table-id[excel-table-id] element with the comma separated enumeration of the table to render as sheet. : | ||
|
|
||
| [source,xml] | ||
| ---- | ||
| <info name="excel-table-id">data-table=print</info> | ||
| ---- | ||
|
|
||
| The given table (*data-table*) will be rendered as the named sheet (*print*) in the couple : *$tableId*=*$sheetName*. | ||
|
|
||
| Here is a full example. | ||
|
|
||
| [source,xml] | ||
| ---- | ||
| <?xml version="1.0" encoding="utf-8"?> | ||
| <doc | ||
| xmlns="http://javacoredoc.fugerit.org" | ||
| xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" | ||
| xsi:schemaLocation="http://javacoredoc.fugerit.org https://www.fugerit.org/data/java/doc/xsd/doc-2-1.xsd" > | ||
| <metadata> | ||
| <!-- property specific for xls/xlsx --> | ||
| <info name="excel-table-id">data-table=print</info> | ||
| </metadata> | ||
| <body> | ||
| <table columns="3" colwidths="30;30;40" width="100" id="data-table" padding="2"> | ||
| <row> | ||
| <cell align="center" border-color="#000000" border-width="1"><para style="bold">Name</para></cell> | ||
| <cell align="center"><para style="bold">Surname</para></cell> | ||
| <cell align="center"><para style="bold">Title</para></cell> | ||
| </row> | ||
| <row> | ||
| <cell><para><![CDATA[Luthien]]></para></cell> | ||
| <cell><para><![CDATA[Tinuviel]]></para></cell> | ||
| <cell><para><![CDATA[Queen]]></para></cell> | ||
| </row> | ||
| <row> | ||
| <cell><para><![CDATA[Thorin]]></para></cell> | ||
| <cell><para><![CDATA[Oakshield]]></para></cell> | ||
| <cell><para><![CDATA[King]]></para></cell> | ||
| </row> | ||
| </table> | ||
| </body> | ||
| </doc> | ||
| ---- | ||
|
|
||
| More elements specific to excel format are available link:https://venusdocs.fugerit.org/docs/html/doc_meta_info.html#meta_xls[here]. | ||
|
|
||
| [#doc-handler-mod-poi-xlsx] | ||
| ==== Xlsx DocHandler | ||
|
|
||
| This doc handler would a XLSX document. | ||
|
|
||
| *In brief* : | ||
|
|
||
| - *compliance level* : _MEDIUM_ | ||
| - *compliance detail* : Only single table elements of the link:#doc-format-entry-point[Venus Doc Format] are rendered. | ||
| - *native ready* : _NO_ (As Apache POI is not ready). | ||
| Add this element to *<docHandlerConfig/>* : | ||
|
|
||
| [source,xml] | ||
| ---- | ||
| <!-- XLSX type hanlder --> | ||
| <docHandler id="xlsx-poi" info="xlsx" type="org.fugerit.java.doc.mod.poi.XlsxPoiTypeHandler" /> | ||
| ---- | ||
|
|
||
| [#doc-handler-mod-poi-xls] | ||
| ==== Xls DocHandler | ||
|
|
||
| This doc handler would a XLS document. | ||
|
|
||
| *In brief* : | ||
|
|
||
| - *compliance level* : _MEDIUM_ | ||
| - *compliance detail* : Only single table elements of the link:#doc-format-entry-point[Venus Doc Format] are rendered. | ||
| - *native ready* : _NO_ (As Apache POI is not ready). | ||
| Add this element to *<docHandlerConfig/>* : | ||
|
|
||
| [source,xml] | ||
| ---- | ||
| <!-- XLSX type hanlder --> | ||
| <docHandler id="xls-poi" info="xlsx" type="org.fugerit.java.doc.mod.poi.XlsPoiTypeHandler" /> | ||
| ---- |
Oops, something went wrong.