Up: Component summary
Up: Component summary
Function
DocumentGeneratorCreates a PDF document from the given LaTeX elements and of the system configuration.
| Version | 1.1 |
|---|---|
| Bundle | microarray |
| Categories | Latex |
| Authors | Kristian Ovaska (kristian.ovaska@helsinki.fi), Marko Laakso (Marko.Laakso@Helsinki.FI) |
| Issue tracker | View/Report issues |
| Source files | component.xml function.scala |
| Usage | Example with default values |
Inputs| Name | Type | Mandatory | Description |
|---|---|---|---|
| body1 | Latex | Mandatory | Document content fragment 1 |
| body2 | Latex | Optional | Document content fragment 2 |
| body3 | Latex | Optional | Document content fragment 3 |
| body4 | Latex | Optional | Document content fragment 4 |
| body5 | Latex | Optional | Document content fragment 5 |
| body6 | Latex | Optional | Document content fragment 6 |
| body7 | Latex | Optional | Document content fragment 7 |
| bibtex | Bibtex | Optional | BibTeX database file for references |
| abstractText | Latex | Optional | Document abstract including its Latex definition. You may use template entities within this document. |
| appendix | Latex | Optional | An additional document that will follow the configuration report |
Outputs| Name | Type | Description |
|---|---|---|
| document | Final PDF document. |
Parameters| Name | Type | Default | Description |
|---|---|---|---|
| attachConfReport | boolean | true | If true, add Configuration Report as a attachment to the final PDF document. Otherwise it will be a part of the final document as a whole. |
| authors | string | "" | A comma-separated list of document authors on the title page. If authors is empty but title is non-empty, a title page with no author name is printed. |
| rPackages | string | "" | List of R packages that shall be documented |
| title | string | "" | Document title on the title page. If empty, no title page is printed. Also see author. |
Test cases| Test case | Parameters▼ | IN body1 |
IN body2 |
IN body3 |
IN body4 |
IN body5 |
IN body6 |
IN body7 |
IN bibtex |
IN abstractText |
IN appendix |
OUT document |
|---|---|---|---|---|---|---|---|---|---|---|---|---|
| case1 | (missing) | body1 | (missing) | (missing) | (missing) | (missing) | (missing) | (missing) | (missing) | (missing) | (missing) | (missing) |
| case2 | properties | body1 | (missing) | (missing) | (missing) | (missing) | (missing) | (missing) | (missing) | (missing) | (missing) | (missing) |
|
title = Document title, |
||||||||||||