Up: Component summary
Up: Component summary
Component
LatexTemplateCreates LaTeX header and footer files that are inserted to the beginning and the end of the LaTeX report. The header and footer can be customized using various parameters.
The header may include a title page that contains document title (see parameter title), author (optional, see parameter author) and date.
The component LatexPDF includes a default header and footer that can also be used, but they are static and not customizable. LatexTemplate provides a customizable header and footer.
Known bugs: For the default header, the TeX package `listings` version 1.6 might be incompatible with some of the other packages. Please update to 1.7 (or downgrade to 1.5) in your TeX distribution (e.g. `tlmgr update listings`).
| Version | 1.4.2 |
|---|---|
| Bundle | tools |
| Categories | Latex |
| Authors | Marko Laakso (Marko.Laakso@Helsinki.FI) |
| Issue tracker | View/Report issues |
| Source files | component.xml abstractTemplate.tex footerTemplate.tex headerTemplate.tex |
| Usage | Example with default values |
Inputs| Name | Type | Mandatory | Description |
|---|---|---|---|
| docAbstract | Latex | Optional | Document abstract including its Latex definition. You may use template entities within this document. The default abstract has been defined in abstractTemplate.tex. |
| bibtex | Bibtex | Optional | The default BibTeX database file for references. References included into Microarray bundle are used if this input is not defined. In most cases, it is wise to leave this port free and to use additional bibliographies for the custom references. |
| bibtex1 | Bibtex | Optional | An additional bibliography |
| bibtex2 | Bibtex | Optional | An additional bibliography |
| bibtex3 | Bibtex | Optional | An additional bibliography |
| bibtex4 | Bibtex | Optional | An additional bibliography |
| bibtex5 | Bibtex | Optional | An additional bibliography |
Outputs| Name | Type | Description |
|---|---|---|
| header | Latex | LaTeX header |
| footer | Latex | LaTeX footer |
Parameters| Name | Type | Default | Description |
|---|---|---|---|
| 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. |
| baselineskip | float | 1.2 | Baselineskip factor that indicates the line spacing |
| bibstyle | string | "abbrv" | BibTeX reference formatting style |
| printTOC | boolean | false | If true, print Table Of Contents. |
| title | string | "" | Document title on the title page. If empty, no title page is printed. Also see author. |
| usepackage | string | "" | Comma-separated list of LaTeX packages that are used in the document. Each package generates a \usepackage{X} line in the header. |
Test cases| Test case | Parameters▼ | IN docAbstract |
IN bibtex |
IN bibtex1 |
IN bibtex2 |
IN bibtex3 |
IN bibtex4 |
IN bibtex5 |
OUT header |
OUT footer |
|---|---|---|---|---|---|---|---|---|---|---|
| case1 | properties | (missing) | (missing) | (missing) | (missing) | (missing) | (missing) | (missing) | header | footer |
|
title = Test Document, |
||||||||||
| case2 | (missing) | docAbstract | bibtex | (missing) | (missing) | (missing) | (missing) | (missing) | header | footer |
| case3 | (missing) | (missing) | bibtex | bibtex1 | bibtex2 | (missing) | (missing) | (missing) | (missing) | footer |