TypoScript Reference¶

config.class¶

plugin.tx_pdfviewhelpers.settings.config.class = string

Decides which PHP class should be used as TCPDF object. You can easily provide your own class in order to render custom header and footers or to customize TCPDF in any way. Your provided class must inherit from Bithost\Pdfviewhelpers\Model\BasePDF.

config.disableCache¶

plugin.tx_pdfviewhelpers.settings.config.disableCache = boolean

Decides whether the TYPO3 frontend cache will be disabled or not.

config.exitAfterPdfContentOutput¶

plugin.tx_pdfviewhelpers.settings.config.exitAfterPdfContentOutput = boolean

Decides whether the PHP method exit is called after the PDF content has been sent to the browser. This might solve issues when additional content is echoed and appended to the PDF document. However it might also lead to other unexpected behaviour so be careful.

config.jpgQuality¶

plugin.tx_pdfviewhelpers.settings.config.jpgQuality = integer

JpgQuality being used, values from 0 - 100.

config.sRGBMode¶

plugin.tx_pdfviewhelpers.settings.config.sRGBMode = boolean

Enable sRGBMode, see TCPDF documentation for further information.

config.allowedImageTypes¶

plugin.tx_pdfviewhelpers.settings.config.allowedImageTypes = Array

Mapping of TCPDF image functions to their corresponding image file extensions.

config.fonts.subset¶

plugin.tx_pdfviewhelpers.settings.config.fonts.subset = boolean

Decides whether to subset the used fonts or not. When this is set to true it is not possible to edit the generated PDF if the font is not present in the users system, but the file size gets smaller.

config.fonts.addTTFFont¶

plugin.tx_pdfviewhelpers.settings.config.fonts.addTTFFont = Array

Possibility to add custom fonts, please have a look at the dedicated chapter Custom Fonts.

document.title¶

plugin.tx_pdfviewhelpers.settings.document.title = string

The title of the generated PDF document.

document.subject¶

plugin.tx_pdfviewhelpers.settings.document.subject = string

The subject of the generated PDF document.

document.author¶

plugin.tx_pdfviewhelpers.settings.document.author = string

The author of the generated PDF document.

document.keywords¶

plugin.tx_pdfviewhelpers.settings.document.keywords = string

A comma separated list of keywords for the generated PDF document.

document.creator¶

plugin.tx_pdfviewhelpers.settings.document.creator = string

The creator of the generated PDF document.

document.outputDestination¶

plugin.tx_pdfviewhelpers.settings.document.outputDestination = string

The TCPDF output destination for the PDF. Possible values are:

outputDestination	Description
I / inline	Sending the PDF inline to the browser.
D / download	Sending the PDF as immediate file download.
F / file	Saving the PDF to the specified outputPath.
FI / file-inline	Saving the PDF to the specified outputPath and sending it inline to the browser.
FD / file-download	Saving the PDF to the specified outputPath and sending it as immediate file download.
E / email	Return the PDF as base64 mime multi-part email attachment (RFC 2045).
S / string	Return the PDF as string.

document.outputPath¶

plugin.tx_pdfviewhelpers.settings.document.outputPath = string

The TCPDF output path of the document. If you are saving the file to filesystem this is a relative path from the webroot directory e.g. fileadmin/pdfviewhelpers/projectXY.pdf. If you are sending it inline or as file download it is simply the name of the document e.g. projectXY.pdf.

document.sourceFile¶

plugin.tx_pdfviewhelpers.settings.document.sourceFile = string

The sourceFile is a the path to a PDF document you want to use as a template (see also page.importPage).

document.unit¶

plugin.tx_pdfviewhelpers.settings.document.unit = string

The measurement unit used. Possible values are pt, mm, cm and in.

document.unicode¶

plugin.tx_pdfviewhelpers.settings.document.unicode = boolean

Determines whether the input text is unicode or not.

document.encoding¶

plugin.tx_pdfviewhelpers.settings.document.encoding = string

Charset encoding (used only when converting back html entities).

document.pdfa¶

plugin.tx_pdfviewhelpers.settings.document.pdfa = boolean

Sets the document to PDF/A mode if true.

document.language¶

plugin.tx_pdfviewhelpers.settings.document.language = string

Decides which language settings are used from TCPDF. All possible language codes can be found in Resources/Private/tcpdf/examples/lang/.

document.hyphenFile¶

plugin.tx_pdfviewhelpers.settings.document.hyphenFile = string

The name of the hyphen file used for the automatic hyphenation. This needs to be set according to the language of your document. All possible values can be found in the directory pdfviewhelpers/Resources/Private/Hyphenation/.

Example values are: hyph-de-1996.tex, hyph-en-gb.tex, hyph-nl.tex, hyph-fr.tex

page.autoPageBreak¶

plugin.tx_pdfviewhelpers.settings.page.autoPageBreak = boolean

Decides whether TCPDF uses auto page break or not. You can always add a new page by adding a new <pdf:page> tag to your template.

page.margin¶

plugin.tx_pdfviewhelpers.settings.page.margin = Array

An array of the margin for each page. The default unit is millimeters.

page.importPage¶

plugin.tx_pdfviewhelpers.settings.page.importPage = integer

Specifies which page should be used as template for the current page. Must be used together with document.sourceFile.

page.importPageOnAutomaticPageBreak¶

plugin.tx_pdfviewhelpers.settings.page.importPageOnAutomaticPageBreak = boolean

Determines whether a PDF template that is used on a page is also rendered when an automatic page break occurs.

page.orientation¶

plugin.tx_pdfviewhelpers.settings.page.orientation = string

Defines the orientation of the current page and the following pages. Possible values are P / portrait and L / landscape.

page.format¶

plugin.tx_pdfviewhelpers.settings.page.format = string

Defines the format of the current page. Possible values are e.g. A0 - A12, to see all possible values you have to check \TCPDF_STATIC::$page_formats.

page.keepMargins¶

plugin.tx_pdfviewhelpers.settings.page.keepMargins = string

If true overwrites the default page margins with the current margins.

page.tableOfContentPage¶

plugin.tx_pdfviewhelpers.settings.page.tableOfContentPage = string

If true the page will be rendered as a table of content page, e.g. it can be moved to the front.

header.posY¶

plugin.tx_pdfviewhelpers.settings.header.posY = integer

Defines the header position relative to the top of the page.

footer.posY¶

plugin.tx_pdfviewhelpers.settings.footer.posY = integer

Defines the footer position relative to the top of the page. You can use negative numbers to place the footer relative to the bottom of the page.

avoidPageBreakInside.breakIfImpossibleToAvoid¶

plugin.tx_pdfviewhelpers.settings.avoidPageBreakInside.breakIfImpossibleToAvoid = boolean

If set to true this ViewHelper inserts a page break even if the content does not fit on one page, meaning a page break is unavoidable.

generalText.trim¶

plugin.tx_pdfviewhelpers.settings.generalText.trim = boolean

If set to true leading and trailing spaces or tabs are trimmed.

generalText.removeDoubleWhitespace¶

plugin.tx_pdfviewhelpers.settings.generalText.removeDoubleWhitespace = boolean

If set to true double spaces within text elements are removed.

generalText.color¶

plugin.tx_pdfviewhelpers.settings.generalText.color = string

The text color as hex value, possible syntax are: #000 or #000000

generalText.fontFamily¶

plugin.tx_pdfviewhelpers.settings.generalText.fontFamily = string

The font family being used. A list of available fonts and a configuration to add your own fonts is available in the chapter custom fonts.

generalText.fontSize¶

plugin.tx_pdfviewhelpers.settings.generalText.fontSize = integer

The font size being used.

generalText.fontStyle¶

plugin.tx_pdfviewhelpers.settings.generalText.fontStyle = string

The font style being used. Possible values are: R / regular, B / bold, I / italic, U / underline

generalText.lineHeight¶

plugin.tx_pdfviewhelpers.settings.generalText.lineHeight = data-type-float

Sets the line height with respect to the font size.

generalText.characterSpacing¶

plugin.tx_pdfviewhelpers.settings.generalText.characterSpacing = data-type-float

Sets the spacing between individual characters

generalText.padding¶

plugin.tx_pdfviewhelpers.settings.generalText.padding = Array

An array of the padding for each text element. The default unit is millimeters.

generalText.alignment¶

plugin.tx_pdfviewhelpers.settings.generalText.alignment = string

Possible values are: L / left, C / center, R / right, J / justify

generalText.paragraphSpacing¶

plugin.tx_pdfviewhelpers.settings.generalText.paragraphSpacing = integer

Defines the spacing of paragraphs separated by new lines.

generalText.paragraphLineFeed¶

plugin.tx_pdfviewhelpers.settings.generalText.paragraphLineFeed = boolean

Add new lines char after each paragraph (in justified text keeps left align the last line of each paragraph).

generalText.autoHyphenation¶

plugin.tx_pdfviewhelpers.settings.generalText.autoHyphenation = boolean

A boolean value indicating whether to use TCPDF’s automatic hyphenation or not. You can also add soft hyphens yourself to your text with “­”. If you use automatic hyphenation please make sure that you configure “config.hyphenFile” to match your language.

headline.addToTableOfContent¶

plugin.tx_pdfviewhelpers.settings.generalText.addToTableOfContent = boolean

If true the headline will be added to the table of content.

headline.tableOfContentLevel¶

plugin.tx_pdfviewhelpers.settings.generalText.tableOfContentLevel = integer

Indicating the level of the headline in the table of content. Starting from 0 as top level, 1 for second, 2 for third level and so on.

list.bulletColor¶

plugin.tx_pdfviewhelpers.settings.list.bulletColor = string

The color of the bullet used as hex value, possible syntax are: #000 or #000000

list.bulletImageSrc¶

plugin.tx_pdfviewhelpers.settings.list.bulletImageSrc = string

The path to an image that should be used as bullet.

list.bulletSize¶

plugin.tx_pdfviewhelpers.settings.list.bulletSize = data-type-float

The size of the bullet as floating point value.

image.alignment¶

plugin.tx_pdfviewhelpers.settings.image.alignment = string

Possible values are: L / left, C / center, R / right

image.padding¶

plugin.tx_pdfviewhelpers.settings.image.padding = Array

The padding around the image.

image.processingInstructions¶

plugin.tx_pdfviewhelpers.settings.image.processingInstructions = Array

An array of processing instructions that is passed to the method ImageService->applyProcessingInstructions. A possible configuration looks like this:

processingInstructions {
        width =
        height =
        maxHeight =
        minWidth =
        maxWidth = 200
        minHeight =
        crop =
        cropVariant =
}

html.styleSheet¶

plugin.tx_pdfviewhelpers.settings.html.styleSheet = string

The path to a style sheet being used in the HtmlViewHelper. The can be provided relative to the webroot directory, e.g. “fileadmin/pdf_style.css”.

html.padding¶

plugin.tx_pdfviewhelpers.settings.html.padding = Array

The padding around the html element.

graphics.line.padding¶

plugin.tx_pdfviewhelpers.settings.graphics.line.padding = Array

Defines the padding around a line. The default unit is millimeters.

graphics.line.style¶

plugin.tx_pdfviewhelpers.settings.graphics.line.style = Array

An array defining line styles, please see the https://tcpdf.org/examples/example_012/ for all possible values.

tableOfContent.page¶

plugin.tx_pdfviewhelpers.settings.tableOfContent.page = integer

Indicates at what place in the document the table of content will be rendered.

tableOfContent.numbersFont¶

plugin.tx_pdfviewhelpers.settings.tableOfContent.numbersFont = string

The font used to render the numbers. Note that a monospaced font must be used in order to guarantee correct alignment.

tableOfContent.filter¶

plugin.tx_pdfviewhelpers.settings.tableOfContent.filter = string

The filter used to fill up the space between the entry title and the page number.

tableOfContent.name¶

plugin.tx_pdfviewhelpers.settings.tableOfContent.name = string

The name used for the table of content bookmark.

tableOfContent.htmlMode¶

plugin.tx_pdfviewhelpers.settings.tableOfContent.htmlMode = boolean

If true the table of content is rendered in HTML mode.

tableOfContent.fontFamily¶

plugin.tx_pdfviewhelpers.settings.tableOfContent.fontFamily = string

The fontFamily for the entries. Also see See generalText.

tableOfContent.fontSize¶

plugin.tx_pdfviewhelpers.settings.tableOfContent.fontSize = data-type-float

The fontSize of the top most level. Also see See generalText.

tableOfContent.lineHeight¶

plugin.tx_pdfviewhelpers.settings.tableOfContent.lineHeight = data-type-float

The lineHeight used for the table content entries. Also see See generalText.

tableOfContent.characterSpacing¶

plugin.tx_pdfviewhelpers.settings.tableOfContent.characterSpacing = data-type-float

The characterSpacing used for the table content entries. Also see See generalText.

tableOfContent.padding¶

plugin.tx_pdfviewhelpers.settings.tableOfContent.padding = Array

The cell padding used for the table content entries.

htmlBookmarkTemplate.level¶

plugin.tx_pdfviewhelpers.settings.htmlBookmarkTemplate.level = integer

The bookmark entry level to which the HTML template should apply.

htmlBookmarkTemplate.sanitizeWhitespace¶

plugin.tx_pdfviewhelpers.settings.htmlBookmarkTemplate.sanitizeWhitespace = boolean

If true the input will be trimmed and whitespaces between HTML tags will be removed.

bookmark.level¶

plugin.tx_pdfviewhelpers.settings.bookmark.level = boolean

The table of content level for the bookmark.

bookmark.fontStyle¶

plugin.tx_pdfviewhelpers.settings.bookmark.fontStyle = boolean

The fontStyle this individual bookmark. Also see See generalText.

bookmark.color¶

plugin.tx_pdfviewhelpers.settings.bookmark.fontStyle = boolean

The fontStyle this individual bookmark. Also see See generalText.