Documentation for Venus Doc Format standard meta informations

Version : 4 (2023-11-30)

This section contains documentation for most <info name="key">value</info> of Venus Doc Format

  1. Properties for generic metadata
  2. Properties specific to HTML format
  3. Properties specific to fixed size formats (like PDF)
  4. Properties specific to spreadsheet format (XLS/XLSX)
  5. Properties specific to CSV format
top

Properties for generic metadata

Name

Description

Supporting handlers

Default

Since

doc-title

Set the document title, should be usually supported in document formats like html or pdf

fj-doc-freemarker(html), fj-doc-mod-fop(pdf),

1.0.0

doc-author

Set the document author, should be usually supported in document formats like html or pdf

fj-doc-freemarker(html), fj-doc-mod-fop(pdf),

1.0.0

doc-creator

Set the document creator tool (es. Venus Doc), should be usually supported in document formats like html or pdf

fj-doc-freemarker(html), fj-doc-mod-fop(pdf),

1.0.0

doc-language

Set the document language, should be usually supported in document formats like html or pdf

fj-doc-freemarker(html), fj-doc-mod-fop(pdf),

1.0.0

doc-subject

Set the document subject, should be usually supported in document formats like html or pdf

fj-doc-freemarker(html), fj-doc-mod-fop(pdf),

1.0.0

doc-version

A custom property to track meta model version

fj-doc-freemarker(html), fj-doc-mod-fop(pdf),

1.0.0

default-table-padding

Set default table padding, default '-1' means 'unset' (shoud be inherited by all cells, in HTML it is handled by 'padding')

fj-doc-freemarker(html), fj-doc-poi(xls), fj-doc-poi(xlsx), fj-doc-mod-fop(pdf), fj-doc-mod-openpdf(pdf), fj-doc-mod-itext(pdf),

-1

1.5.0

default-table-spacing

Set default table spacing, default '-1' means 'unset' (shoud be inherited by all cells, in HTML it is handled by 'margin')

fj-doc-freemarker(html), fj-doc-poi(xls), fj-doc-poi(xlsx), fj-doc-mod-fop(pdf), fj-doc-mod-openpdf(pdf), fj-doc-mod-itext(pdf),

-1

1.5.0

default-cell-border-width

Set default cell border width for all table cells, default '-1' means 'unset'

fj-doc-freemarker(html), fj-doc-poi(xls), fj-doc-poi(xlsx), fj-doc-mod-fop(pdf), fj-doc-mod-openpdf(pdf), fj-doc-mod-itext(pdf),

-1

1.5.0

table-border-collapse

Set the default table-border-collapse mode, possible values are 'separate' or 'collapse'. (note that this is a document scoped property, all tables in documnent will be affected)

fj-doc-mod-fop(pdf),

separate

3.2.2

default-font-name

Set the default font name

fj-doc-mod-fop(pdf), fj-doc-mod-openpdf-ext(pdf), fj-doc-mod-openrtf-ext(rtf),

helvetica

1.4.5

default-font-size

Set the default font size

fj-doc-mod-fop(pdf), fj-doc-mod-openpdf-ext(pdf), fj-doc-mod-openrtf-ext(rtf),

10

1.4.5

default-font-style

Set the default font style

fj-doc-mod-fop(pdf), fj-doc-mod-openpdf-ext(pdf), fj-doc-mod-openrtf-ext(rtf),

normal

1.4.5

suppress-wrong-type-error

If set to 'a' or 'true' it will set suppress some type error.

fj-doc-mod-openpdf-ext(pdf), fj-doc-mod-openrtf-ext(rtf),

false

8.11.5

top

Properties specific to HTML format

Name

Description

Supporting handlers

Default

Since

html-css-link

Link to css for the html document

fj-doc-freemarker(html),

1.4.5

html-css-style

Inline CSS style definition to be added to the document

fj-doc-freemarker(html),

1.4.5

html-add-to-head

Custom HTML code to be added directly in the head section

fj-doc-freemarker(html),

1.0.0

html-charset

Add meta charset to head

fj-doc-freemarker(html),

3.4.5

top

Properties specific to fixed size formats (like PDF)

Name

Description

Supporting handlers

Default

Since

margins

Document page margins, in pixels, in the format LEFT;RIGHT;TOP;BOTTOM

fj-doc-mod-fop(pdf),

10;10;10;10

1.0.0

page-width

Page width, in cm, for example 21cm for A4 portrait or 29.7cm for A4 landscape

fj-doc-mod-fop(pdf),

21cm

1.0.0

page-height

Page height, in cm, for example 29.7cm for A4 or 21cm for A4 landscape

fj-doc-mod-fop(pdf),

29.7cm

1.0.0

page-orient

Page orientation, 'vertical' for portrait or 'horizontal' for landscape

fj-doc-mod-openpdf(pdf), fj-doc-mod-itext(pdf),

vertical

1.0.0

top

Properties specific to spreadsheet format (XLS/XLSX)

Name

Description

Supporting handlers

Default

Since

excel-table-id

This property is required to generate spreadsheet format. It should be a list of ';' separated element. Each element is a key=value set, where 'key' is the id of a table in the document which will be the content of a new sheet, the 'value' is the name of the sheet to be created. i.e. 'table-1=sheet1;table-2=sheet2'.

fj-doc-mod-poi(xls), fj-doc-mod-poi(xlsx),

1.0.0

excel-try-autoresize

If set to 'true', a column auto resize will be tried on the created sheets.

fj-doc-mod-poi(xls), fj-doc-mod-poi(xlsx),

false

1.0.0

excel-fail-on-autoresize-error

If both this property and 'excel-try-autoresize' are set to true, the generation will fail in case of autoresize errors.

fj-doc-mod-poi(xls), fj-doc-mod-poi(xlsx),

false

1.0.0

excel-ignore-format

If set to 'true', column format will be ignored and all content will be rendered as string.

fj-doc-mod-poi(xls), fj-doc-mod-poi(xlsx),

false

1.0.0

excel-template

Path to a template to use as a base for the output. If the prefix is 'file://' will load from file system. If prefix is 'cl://' will load from classlaoder.

fj-doc-mod-poi(xls), fj-doc-mod-poi(xlsx), fj-doc-mod-jxl(xls) [deprecated],

false

1.0.0

excel-width-multiplier

A multiplier for zooming the width of the generated excel. Base value is '256'

fj-doc-mod-jxl(xls) [deprecated],

256

1.0.0

top

Properties specific to CSV format

Name

Description

Supporting handlers

Default

Since

csv-table-id

This property is required to generate the CSV format. It should be a single id of a table contained in the source document to be rendered as CSV.

fj-doc-mod-opencsv(csv),

1.4.5

csv-separator

The character separator to be used for the CSV.

fj-doc-mod-opencsv(csv),

,

3.1.8

csv-line-end

The line terminator for the CSV.

fj-doc-mod-opencsv(csv),

\n

3.1.8

top