| Elements configuration reference | ||
|---|---|---|
| Element | Description | Children |
| doc | This is the root element of source doc (consisting in a 'metadata' and a 'body' section) | ( body ) [1-1] ( metadata | meta ) [1-1] |
| metadata | Contains the meta informations of the document (roughly comparable to a HTML 'head' element) | ( info , header , footer , header-ext , footer-ext , background , bookmark-tree ) [1-1] |
| meta | Contains the meta informations of the document ('meta' is kept for compatibility, better use 'metadata') | ( info , header , footer , header-ext , footer-ext , background , bookmark-tree ) [1-1] |
| body | The body of the document (roughly comparable to a HTML 'body' element) | ( para | table | list | image | phrase | nbsp | br | barcode | h | page-break ) [0-unbounded] |
| info | This is a key/value element containing informations for document generations, the attribute 'name' is the key, while the text content is the value. | mixed |
| header | A header made of a complex elements (not includes tables) | ( para | image | phrase | h ) [0-unbounded] |
| footer | A footer made of simple elements (not includes tables) | ( para | image | phrase | h ) [0-unbounded] |
| header-ext | A header made of a complex elements (includes tables) | ( para | table | image | phrase | barcode | h ) [0-unbounded] |
| footer-ext | A footer made of complex elements (includes tables) | ( para | table | image | phrase | barcode | h ) [0-unbounded] |
| background | A background image to use for the document | ( image ) [1-1] |
| bookmark-tree | The root of the bookmark tree for the document | ( bookmark ) [1-1] |
| bookmark | A bookmark for the document | mixed |
| para | A document paragraph (roughly comparable to a HTML 'p' element) , Depending on type handler support it is possible to use some constants (usually in header or footer) , ${currentPage} to display the current page (starts at 1) , ${pageCount} to display the last page number | mixed ( phrase | para | h ) [0-unbounded] |
| table | A document table (roughly comparable to a HTML 'table' element) | ( row ) [1-1] |
| row | A table row (roughly comparable to a HTML 'tr' element) | ( cell ) [1-1] |
| cell | A row cell (roughly comparable to a HTML 'th' or 'td' element) | ( para | table | image | phrase | nbsp | br | barcode | h ) [1-unbounded] |
| list | A list in the document (roughly comparable to a HTML 'ul' pr 'ol' element) | ( li ) [1-1] |
| li | A item of a list (roughly comparable to a HTML 'li' element) | ( list ) [1-2] ( para | h | pl ) [1-1] |
| pl | A phrase list contained in a list item | ( phrase ) [1-unbounded] |
| image | An image to include in the document (roughly comparable to a HTML 'image' element) | |
| phrase | A phrase of the document (roughly comparable to a HTML 'span' element) | mixed |
| nbsp | Simple spacing (roughly comparable to a HTML 'nbsp' entity) | |
| br | A line break (roughly comparable to a HTML 'br' element) | |
| barcode | Create a barcode (this element is kept for compatibility, but it's better to generate barcode as images) | |
| h | A document heading (roughly comparable to a HTML 'h1', 'h2' etc. element) | mixed ( phrase | para | h ) [0-unbounded] |
| page-break | A page break heading | |
| Element : doc | ||
|---|---|---|
| This is the root element of source doc (consisting in a 'metadata' and a 'body' section) | ||
| Attribute | Description | Note |
| This element does not have attributes | ||
| Element : metadata | ||
|---|---|---|
| Contains the meta informations of the document (roughly comparable to a HTML 'head' element) | ||
| Attribute | Description | Note |
| This element does not have attributes | ||
| Element : meta | ||
|---|---|---|
| Contains the meta informations of the document ('meta' is kept for compatibility, better use 'metadata') | ||
| Attribute | Description | Note |
| This element does not have attributes | ||
| Element : body | ||
|---|---|---|
| The body of the document (roughly comparable to a HTML 'body' element) | ||
| Attribute | Description | Note |
| This element does not have attributes | ||
| Element : info | ||
|---|---|---|
| This is a key/value element containing informations for document generations, the attribute 'name' is the key, while the text content is the value. | ||
| Attribute | Description | Note |
| name | Contains the value of this document information (see the link https://venusdocs.fugerit.org/docs/html/doc_meta_info.html for possible values) | string |
| Element : header | ||
|---|---|---|
| A header made of a complex elements (not includes tables) | ||
| Attribute | Description | Note |
| align | Header horizontal alignment | alignType , base : string , enumeration : [ center , right , left , justify , justifyall ] |
| numbered | 'true' is the header should add page number | boolean |
| border-width | The size of the border | borderWidthType , base : int , minInclusive : 0 , maxInclusive : 32 |
| expected-size | Expected header size | int |
| A footer made of simple elements (not includes tables) | ||
|---|---|---|
| Attribute | Description | Note |
| align | Footer horizontal alignment | alignType , base : string , enumeration : [ center , right , left , justify , justifyall ] |
| numbered | 'true' is the footer should add page number | boolean |
| border-width | The size of the border | borderWidthType , base : int , minInclusive : 0 , maxInclusive : 32 |
| expected-size | Expected footer size | int |
| Element : header-ext | ||
|---|---|---|
| A header made of a complex elements (includes tables) | ||
| Attribute | Description | Note |
| align | Header horizontal alignment | alignType , base : string , enumeration : [ center , right , left , justify , justifyall ] |
| numbered | 'true' is the header should add page number | boolean |
| border-width | The size of the border | borderWidthType , base : int , minInclusive : 0 , maxInclusive : 32 |
| expected-size | Expected header size | int |
| A footer made of complex elements (includes tables) | ||
|---|---|---|
| Attribute | Description | Note |
| align | Footer horizontal alignment | alignType , base : string , enumeration : [ center , right , left , justify , justifyall ] |
| numbered | 'true' is the footer should add page number | boolean |
| border-width | The size of the border | borderWidthType , base : int , minInclusive : 0 , maxInclusive : 32 |
| expected-size | Expected footer size | int |
| Element : background | ||
|---|---|---|
| A background image to use for the document | ||
| Attribute | Description | Note |
| This element does not have attributes | ||
| Element : bookmark-tree | ||
|---|---|---|
| The root of the bookmark tree for the document | ||
| Attribute | Description | Note |
| This element does not have attributes | ||
| Element : bookmark | ||
|---|---|---|
| A bookmark for the document | ||
| Attribute | Description | Note |
| ref | The reference to the element id to link | idType , base : string , minLength : 1 , maxLength : 64 |
| Element : para | ||
|---|---|---|
| A document paragraph (roughly comparable to a HTML 'p' element) , Depending on type handler support it is possible to use some constants (usually in header or footer) , ${currentPage} to display the current page (starts at 1) , ${pageCount} to display the last page number | ||
| Attribute | Description | Note |
| id | An element id (should be unique in the document) | idType , base : string , minLength : 1 , maxLength : 64 |
| style | Font style of the element | styleType , base : string , enumeration : [ normal , bold , underline , italic , bolditalic ] |
| align | Horizontal alignment of the element | alignType , base : string , enumeration : [ center , right , left , justify , justifyall ] |
| font-name | The name of the font to use | fontNameType , base : string , minLength : 1 , maxLength : 64 |
| leading | The leading between lines | leadingType , base : decimal , minInclusive : 0 , maxInclusive : 2048 |
| back-color | A color representation in HTML RGB format | colorType , base : string , pattern : #([A-Fa-f0-9]{6}) |
| fore-color | A color representation in HTML RGB format | colorType , base : string , pattern : #([A-Fa-f0-9]{6}) |
| type | Data type contained in the element | dataType , base : string , enumeration : [ string , number , date ] |
| format | Data format | formatType , enumeration : [ yyyy-MM-dd , yyyy-MM-dd hh:mm:ss , yyyy-MM-dd'T'HH:mm:ss.SSSZ , iso ] , base : string , minLength : 1 , maxLength : 128 |
| size | The size of the font to use | fontSize , base : int , minInclusive : 0 , maxInclusive : 256 |
| text-indent | Text indentation (currently ignored) | textIndentType , base : decimal , minInclusive : 0 , maxInclusive : 2048 |
| space-before | The spacing of the element (possibly in a given direction) | spaceType , base : decimal , minInclusive : 0 , maxInclusive : 2048 |
| space-after | The spacing of the element (possibly in a given direction) | spaceType , base : decimal , minInclusive : 0 , maxInclusive : 2048 |
| space-left | The spacing of the element (possibly in a given direction) | spaceType , base : decimal , minInclusive : 0 , maxInclusive : 2048 |
| space-right | The spacing of the element (possibly in a given direction) | spaceType , base : decimal , minInclusive : 0 , maxInclusive : 2048 |
| white-space-collapse | Value is 'true' if the white spaces must be trimmed | whiteSpaceCollapsType , base : boolean |
| Element : table | ||
|---|---|---|
| A document table (roughly comparable to a HTML 'table' element) | ||
| Attribute | Description | Note |
| id | An element id (should be unique in the document) | idType , base : string , minLength : 1 , maxLength : 64 |
| columns | Number of columns in a table | columnsType , base : int , minInclusive : 1 , maxInclusive : 2048 |
| width | The width in percentage of the table | percentageType , base : int , minInclusive : 1 , maxInclusive : 100 |
| back-color | A color representation in HTML RGB format | colorType , base : string , pattern : #([A-Fa-f0-9]{6}) |
| fore-color | A color representation in HTML RGB format | colorType , base : string , pattern : #([A-Fa-f0-9]{6}) |
| spacing | This should be a integer value representing the table cell spacing (for some format like fo/pdf and html, it represents the margin) (Is it possible to set a default for the document : https://venusdocs.fugerit.org/docs/html/doc_meta_info.html#default-table-spacing) | spaceType , base : decimal , minInclusive : 0 , maxInclusive : 2048 |
| padding | This should be a integer value representing the table cell padding (Is it possible to set a default for the document : https://venusdocs.fugerit.org/docs/html/doc_meta_info.html#default-table-padding) | spaceType , base : decimal , minInclusive : 0 , maxInclusive : 2048 |
| colwidths | The sizes of the columns of the table as percentages separated by semicolons (for instance '30;30;40' are three columns if size 30%, 30% and 40%) | string |
| space-before | The spacing of the element (possibly in a given direction) | spaceType , base : decimal , minInclusive : 0 , maxInclusive : 2048 |
| space-after | The spacing of the element (possibly in a given direction) | spaceType , base : decimal , minInclusive : 0 , maxInclusive : 2048 |
| render-mode | Table render mode (if 'inline' the handler will try to render the table as a flow of element) | tableRenderModeType , base : string , enumeration : [ normal , inline ] |
| caption | The caption to be used for the table (basically an alternate description) Note : different type handlers may render it in different ways | string |
| Element : row | ||
|---|---|---|
| A table row (roughly comparable to a HTML 'tr' element) | ||
| Attribute | Description | Note |
| id | An element id (should be unique in the document) | idType , base : string , minLength : 1 , maxLength : 64 |
| header | Set to 'true' if the row is a header for the table | boolean |
| Element : cell | ||
|---|---|---|
| A row cell (roughly comparable to a HTML 'th' or 'td' element) | ||
| Attribute | Description | Note |
| id | An element id (should be unique in the document) | idType , base : string , minLength : 1 , maxLength : 64 |
| colspan | The column span size of the cell (default value is '1') | spanType , base : int , minInclusive : 1 |
| rowspan | The row span size of the cell (default value is '1') | spanType , base : int , minInclusive : 1 |
| align | Horizontal alignment of the element | alignType , base : string , enumeration : [ center , right , left , justify , justifyall ] |
| valign | Vertical alignment of the element | valignType , base : string , enumeration : [ middle , top , bottom ] |
| header | Set to 'true' if the cell is a header for the table | boolean |
| border-color | A color representation in HTML RGB format | colorType , base : string , pattern : #([A-Fa-f0-9]{6}) |
| border-color-top | A color representation in HTML RGB format | colorType , base : string , pattern : #([A-Fa-f0-9]{6}) |
| border-color-bottom | A color representation in HTML RGB format | colorType , base : string , pattern : #([A-Fa-f0-9]{6}) |
| border-color-left | A color representation in HTML RGB format | colorType , base : string , pattern : #([A-Fa-f0-9]{6}) |
| border-color-right | A color representation in HTML RGB format | colorType , base : string , pattern : #([A-Fa-f0-9]{6}) |
| border-width | The size of the border | borderWidthType , base : int , minInclusive : 0 , maxInclusive : 32 |
| border-width-top | The size of the border | borderWidthType , base : int , minInclusive : 0 , maxInclusive : 32 |
| border-width-bottom | The size of the border | borderWidthType , base : int , minInclusive : 0 , maxInclusive : 32 |
| border-width-left | The size of the border | borderWidthType , base : int , minInclusive : 0 , maxInclusive : 32 |
| border-width-right | The size of the border | borderWidthType , base : int , minInclusive : 0 , maxInclusive : 32 |
| back-color | A color representation in HTML RGB format | colorType , base : string , pattern : #([A-Fa-f0-9]{6}) |
| fore-color | A color representation in HTML RGB format | colorType , base : string , pattern : #([A-Fa-f0-9]{6}) |
| type | Data type contained in the element | dataType , base : string , enumeration : [ string , number , date ] |
| Element : list | ||
|---|---|---|
| A list in the document (roughly comparable to a HTML 'ul' pr 'ol' element) | ||
| Attribute | Description | Note |
| id | An element id (should be unique in the document) | idType , base : string , minLength : 1 , maxLength : 64 |
| list-type | The type fo the list ( 'uld' - unordered with dots, 'ulm' - unordered with mius, 'oln' - ordered with numbers, 'uld' - ordered with letters ) | listType , base : string , enumeration : [ ul , uld , ulm , ol , oln , oll ] |
| Element : li | ||
|---|---|---|
| A item of a list (roughly comparable to a HTML 'li' element) | ||
| Attribute | Description | Note |
| id | An element id (should be unique in the document) | idType , base : string , minLength : 1 , maxLength : 64 |
| Element : pl | ||
|---|---|---|
| A phrase list contained in a list item | ||
| Attribute | Description | Note |
| This element does not have attributes | ||
| Element : image | ||
|---|---|---|
| An image to include in the document (roughly comparable to a HTML 'image' element) | ||
| Attribute | Description | Note |
| url | Valid values are : cl://pathinjar (Path inside the class loader, safest way to load the image) http://imageurl (but generating machine should be able to access the url) file://imagepath (Path should be absolute, but you can use, for instance, free marker templating to make it more generic.) In case of base64 just provide the type (png,jpg etc.) | urlType , base : string , minLength : 0 , maxLength : 2048 |
| type | The type of the image | imageType , base : string , enumeration : [ png , jpg , gif ] |
| scaling | The scaling percentage (can be higher than 100) | scalingType , base : int , minInclusive : 1 |
| base64 | Base 64 representation of a resource | base64Type , base : base64Binary |
| alt | Alternate description of the element | altType , base : string , minLength : 0 , maxLength : 2048 |
| align | Horizontal alignment of the element | alignType , base : string , enumeration : [ center , right , left , justify , justifyall ] |
| Element : phrase | ||
|---|---|---|
| A phrase of the document (roughly comparable to a HTML 'span' element) | ||
| Attribute | Description | Note |
| id | An element id (should be unique in the document) | idType , base : string , minLength : 1 , maxLength : 64 |
| font-name | The name of the font to use | fontNameType , base : string , minLength : 1 , maxLength : 64 |
| style | Font style of the element | styleType , base : string , enumeration : [ normal , bold , underline , italic , bolditalic ] |
| leading | The leading between lines | leadingType , base : decimal , minInclusive : 0 , maxInclusive : 2048 |
| size | The size of the font to use | fontSize , base : int , minInclusive : 0 , maxInclusive : 256 |
| link | string | |
| white-space-collapse | Value is 'true' if the white spaces must be trimmed | whiteSpaceCollapsType , base : boolean |
| anchor | string | |
| Element : nbsp | ||
|---|---|---|
| Simple spacing (roughly comparable to a HTML 'nbsp' entity) | ||
| Attribute | Description | Note |
| length | The length of the spacing | lengthType , base : int , minInclusive : 1 |
| Element : br | ||
|---|---|---|
| A line break (roughly comparable to a HTML 'br' element) | ||
| Attribute | Description | Note |
| This element does not have attributes | ||
| Element : barcode | ||
|---|---|---|
| Create a barcode (this element is kept for compatibility, but it's better to generate barcode as images) | ||
| Attribute | Description | Note |
| size | The size of the font to use | fontSize , base : int , minInclusive : 0 , maxInclusive : 256 |
| type | string | |
| text | Alternate description of the element | altType , base : string , minLength : 0 , maxLength : 2048 |
| Element : h | ||
|---|---|---|
| A document heading (roughly comparable to a HTML 'h1', 'h2' etc. element) | ||
| Attribute | Description | Note |
| id | An element id (should be unique in the document) | idType , base : string , minLength : 1 , maxLength : 64 |
| style | Font style of the element | styleType , base : string , enumeration : [ normal , bold , underline , italic , bolditalic ] |
| align | Horizontal alignment of the element | alignType , base : string , enumeration : [ center , right , left , justify , justifyall ] |
| font-name | The name of the font to use | fontNameType , base : string , minLength : 1 , maxLength : 64 |
| leading | The leading between lines | leadingType , base : decimal , minInclusive : 0 , maxInclusive : 2048 |
| back-color | A color representation in HTML RGB format | colorType , base : string , pattern : #([A-Fa-f0-9]{6}) |
| fore-color | A color representation in HTML RGB format | colorType , base : string , pattern : #([A-Fa-f0-9]{6}) |
| type | Data type contained in the element | dataType , base : string , enumeration : [ string , number , date ] |
| format | Data format | formatType , enumeration : [ yyyy-MM-dd , yyyy-MM-dd hh:mm:ss , yyyy-MM-dd'T'HH:mm:ss.SSSZ , iso ] , base : string , minLength : 1 , maxLength : 128 |
| size | The size of the font to use | fontSize , base : int , minInclusive : 0 , maxInclusive : 256 |
| text-indent | Text indentation (currently ignored) | textIndentType , base : decimal , minInclusive : 0 , maxInclusive : 2048 |
| space-before | The spacing of the element (possibly in a given direction) | spaceType , base : decimal , minInclusive : 0 , maxInclusive : 2048 |
| space-after | The spacing of the element (possibly in a given direction) | spaceType , base : decimal , minInclusive : 0 , maxInclusive : 2048 |
| space-left | The spacing of the element (possibly in a given direction) | spaceType , base : decimal , minInclusive : 0 , maxInclusive : 2048 |
| space-right | The spacing of the element (possibly in a given direction) | spaceType , base : decimal , minInclusive : 0 , maxInclusive : 2048 |
| white-space-collapse | Value is 'true' if the white spaces must be trimmed | whiteSpaceCollapsType , base : boolean |
| head-level | The level of the headings, from 1 (most relevant) to 7 (less relevant) (roughly comparable to a HTML 'h1', 'h2' etc.) | headLevelType , base : int , minInclusive : 1 , maxInclusive : 7 |
| Element : page-break | ||
|---|---|---|
| A page break heading | ||
| Attribute | Description | Note |
| This element does not have attributes | ||