Up: Component summary
Up: Component summary
Component
LatexCombinerCombines several LaTeX fragments into one LaTeX document. Input fragments are processed in numeric order.
| Version | 1.5 |
|---|---|
| Bundle | tools |
| Categories | Latex |
| Authors | Kristian Ovaska (kristian.ovaska@helsinki.fi), Marko Laakso (Marko.Laakso@Helsinki.FI) |
| Issue tracker | View/Report issues |
| Requires | R |
| Source files | component.xml LatexCombiner.r |
| Usage | Example with default values |
Inputs| Name | Type | Mandatory | Description |
|---|---|---|---|
| latex1 | Latex | Optional | LaTeX fragment 1. |
| latex2 | Latex | Optional | LaTeX fragment 2. |
| latex3 | Latex | Optional | LaTeX fragment 3. |
| latex4 | Latex | Optional | LaTeX fragment 4. |
| latex5 | Latex | Optional | LaTeX fragment 5. |
| latex6 | Latex | Optional | LaTeX fragment 6. |
| latex7 | Latex | Optional | LaTeX fragment 7. |
| latex8 | Latex | Optional | LaTeX fragment 8. |
| latex9 | Latex | Optional | LaTeX fragment 9. |
| array | Array<Latex> | Optional | Input array |
| resources | Array<BinaryFile> | Optional | Additional files that shall be included to the document folder. This input may be used for images, styles, attachments, etc. |
Outputs| Name | Type | Description |
|---|---|---|
| document | Latex | Combined LaTeX document. |
Parameters| Name | Type | Default | Description |
|---|---|---|---|
| head | string | "" | Raw LaTeX content that will be written to the beginning of the output document |
| pagebreak | boolean | false | Determines if the result document should start with a page break. |
| sectionTitle | string | "" | If non-empty, a declaration of a new section with the given name is inserted to the beginning of the combined document. This is a convenience feature to make it easy to compile subsections into a section. |
| sectionType | string | "section" | Type of LaTeX section: usually one of section, subsection or subsubsection. No section statement is written if sectionTitle is empty. |
| strictBorders | boolean | true | Enables the flushing of all document elements before each fragment |
| tail | string | "" | Raw LaTeX content that will be written to the end of the output document |
Test cases| Test case | Parameters▼ | IN latex1 |
IN latex2 |
IN latex3 |
IN latex4 |
IN latex5 |
IN latex6 |
IN latex7 |
IN latex8 |
IN latex9 |
IN array |
IN resources |
OUT document |
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| case01 | (missing) | latex1 | (missing) | (missing) | latex4 | (missing) | (missing) | (missing) | latex8 | (missing) | (missing) | (missing) | document |
| case02-invalid-conflict | (missing) | latex1 | latex2 | (missing) | (missing) | (missing) | (missing) | (missing) | (missing) | (missing) | (missing) | (missing) | (expecting failure) |
| case03-invalid-missing | (missing) | latex1 | latex2 | (missing) | (missing) | (missing) | (missing) | (missing) | (missing) | (missing) | (missing) | (missing) | (expecting failure) |
| case04_no_input | (missing) | (missing) | (missing) | (missing) | (missing) | (missing) | (missing) | (missing) | (missing) | (missing) | (missing) | (missing) | document |
| case05_head_tail | properties | (missing) | (missing) | (missing) | (missing) | (missing) | (missing) | (missing) | (missing) | (missing) | (missing) | (missing) | document |
|
head = \\textbf{HEAD}\\\\, |
|||||||||||||
| case06_arrays | (missing) | (missing) | (missing) | (missing) | (missing) | (missing) | (missing) | (missing) | (missing) | (missing) | array | (missing) | document |
| case07_input_arrays | (missing) | latex1 | (missing) | (missing) | latex4 | (missing) | (missing) | (missing) | latex8 | (missing) | array | resources | document |
| case08_arrays_conflict | (missing) | (missing) | (missing) | (missing) | (missing) | (missing) | (missing) | (missing) | (missing) | (missing) | array | (missing) | (expecting failure) |
| case09_empty_array | (missing) | (missing) | (missing) | (missing) | (missing) | (missing) | (missing) | (missing) | (missing) | (missing) | array | (missing) | document |