Skip to content

Commit

Permalink
Documentation for the word emitter user properties like README (eclip…
Browse files Browse the repository at this point in the history
  • Loading branch information
speckyspooky authored Nov 9, 2024
1 parent 7338b0d commit 84d2a0e
Show file tree
Hide file tree
Showing 3 changed files with 72 additions and 4 deletions.
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
# Eclipse BIRT
Introduction to use the specialist user properties of the PdfEmitter.
Introduction to use the specialized user properties of the PdfEmitter.

## Reason
The PdfEmitter provides a set of specialist user properties to optimize the pdf output according of the reporting based requirements.
The PdfEmitter provides a set of specialized user properties to optimize the pdf output according of the reporting based requirements.

Each of the user properties starts with the master prefix "PdfEmitter".

Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,68 @@
# Eclipse BIRT
Introduction to use the specialized user properties of the WordEmitter.

## Reason
The WordEmitter provides a set of specialized user properties to optimize the word output of type DOCX.

Each of the user properties starts with the master prefix "WordEmitter".


### User properties of the WordEmitter

The following list get an overview of all supported user properties, the content and the definition of use.


**WordEmitter.CombineMarginPadding**

Content use margin and padding combined to calculate the text indent for (dynamic) text elements,
padding is an unsupported feature of MS Word.
Location report
Data type boolean
Values true, margin and padding will combined to calculate the text indent
false, margin will be used for text indent (without padding)
Default true
Since 4.18

**WordEmitter.AddEmptyParagraphForAllCells**

Content use empty paragraph for the grid & table cell at the end independent of the cell content (standard up to BIRT 4.17)
Location report
Data type boolean
Values true, add empty paragraph at grid & table cell end
false, avoid empty paragraph at grid & table cell end
Default false, if wrappedTableForMarginPadding is set to false
true, if wrappedTableForMarginPadding is set to true
Relation WordEmitter.WrappedTableForMarginPadding
Since 4.18

**WordEmitter.AddEmptyParagraphForListCell**

Content use empty paragraph for the list table cell at the end independent of the cell content (standard up to BIRT 4.17)
Location report
Data type boolean
Values true, add empty paragraph at list table cell end
false, avoid empty paragraph at list table cell end
Default false
Since 4.18

**WordEmitter.WrappedTableForMarginPadding**

Content text element and dynamic text element should have a wrapper layout table to simulate margin and padding style (standard up to BIRT 4.17)
Location report
Data type boolean
Values true, use wrapper layout table for (dynamic) text elements
false, use optimized handling and avoid wrapper layout table
Default false
Relation WordEmitter.AddEmptyParagraphForAllCells
Since 4.18


**WordEmitter.WrappedTableHeaderFooter**

Content page header and footer should have a wrapper layout table (standard up to BIRT 4.17)
Location report
Data type boolean
Values true, use wrapper layout table for page header and footer
false, use optimized handling and avoid wrapper layout table for page header and footer
Default false
Since 4.18
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
# Eclipse BIRT
Introduction to use the specialist user properties of the ExcelEmitter.
Introduction to use the specialized user properties of the ExcelEmitter.

## Reason
The ExelEmitter provides a set of specialist user properties to optimize the excel output according of the reporting based requirements.
The ExelEmitter provides a set of specialized user properties to optimize the excel output according of the reporting based requirements.

Each of the user properties starts with the master prefix "ExcelEmitter".

Expand Down

0 comments on commit 84d2a0e

Please sign in to comment.