EXT: Webkit PDF¶

What does it do?¶

WebkitPDF uses the binary “wkhtmtopdf” (http://code.google.com/p/wkhtmltopdf/) to render given pages to a PDF file on the fly. The binary for 32bit i386 unix systems is shipped with the extension.

Once rendered, the PDF files are cached in the filesystem for a better performance.

The caching information is kept in a database table. Clearing the cache in the TYPO3 backend will remove those PDF files which exceed a certain lifetime limit. This limit can be set in the configuration section of the extension manager.

Reference¶

plugin.tx_webkitpdf_pi1.pdfLink = TEXT
plugin.tx_webkitpdf_pi1.pdfLink {
  value = {$plugin.tx_webkitpdf_pi1.pdfLink.linkText}
  typolink {
    parameter = {$plugin.tx_webkitpdf_pi1.pdfLink.pluginPid}
    no_cache = {$plugin.tx_webkitpdf_pi1.pdfLink.no_cache}
    additionalParams {
      data = getIndpEnv:TYPO3_REQUEST_URL
      wrap = &tx_webkitpdf_pi1[urls][0]=|
    }
  }
}

plugin.tx_webkitpdf_pi1.pdfLink {
 pluginPid = 123
 linkText = Save as PDF
 no_cache = 1
}

<a href=”http://www.example.com/index.php?id=123&no_cache=1&tx_webkitpdf_pi1[urls][0]=http://www.example.com/index.php?id=1”>Save as PDF</a>

Upgrading from version 1.1.3 (or below) to any later version¶

Link generation has changed in versions >1.1.3 ! You need to perform some manual steps to update your environment.

The userfunc is not needed anymore and its use is deprecated. Instead, you have to use a built-in TypoScript object plugin.tx_webkitpdf_pi1.pdfLink

Follow these steps after upgrading from 1.1.3 (or below) to any later version:

The old userfunc TypoScript which is going to be replaced should look like this:

includeLibs.webkit = EXT:webkitpdf/res/user_webkitpdf.php
lib.pdf = USER
lib.pdf.userFunc = user_webkitpdf->user_getPDFLink
lib.pdf {
  pid = 23
  linkText = Save as PDF
}

• First, go to your TypoScript template and include the static template from extension 'WebKit PDF' in your template.
• Go to template constant editor. Set pluginPid according to lib.pdf.pid (it's the page id which contains the plugin 'WebKit PDF'). The text of the link can be set in linkText.
• Remove the old TypoScript as shown above and replace it by the below line:

lib.pdf < plugin.tx_webkitpdf_pi1.pdfLink

Generating PDFs of access protected pages¶

WebkitPDF is capable of generating PDFs of access protected pages. But in order to be able to do so, you have to do some configuration in the install tool:

• Set [FE][lockIP] = 0
• Set [FE][lockHashKeyWords] =

This way the binary used by WebkitPDF is able to access the page to render from “outside”.

Warnings on PDF generation page¶

While generating a PDF sometimes PHP warnings are logged in the webserver's error log. This depends on your TYPO3 and server configuration.

PHP Warning: Cannot modify header information - headers already sent by (output started at /path/to/typo3/typo3conf/ext/webkitpdf/pi1/class .tx_webkitpdf_pi1.php:160) in /path/to/typo3/typo3/sysext/cms/tslib/class.tslib_fe.php on line 3229, referer: …

To fix this, add this TS to the page with the WebKit PDF-plugin:

config {
 disableCharsetHeader = 1
 sendCacheHeaders = 0
 additionalHeaders =
}

Use a page type to render PDFs¶

You can use WebkitPDF on a special page type to show a PDF.

PDF = PAGE
PDF.typeNum = 250
PDF.config {
   disableAllHeaderCode = 1
   disableCharsetHeader = 1
   disablePrefixComment = 1
}

PDF.10 < plugin.tx_webkitpdf_pi1
PDF.10 {
  customScriptPath = /usr/bin/
  urls {
    typolink.parameter.data = TSFE:id
    typolink.returnLast = url
    dataWrap = {getIndpEnv:TYPO3_REQUEST_HOST}/|
  }
  staticFileName.data = page:title
  staticFileName.wrap = |.pdf
}

This way, all calls to &type=250 result in a PDF.Now you can put a link to all your pages:

page.1 = TEXT
page.1 {
  typolink {
    parameter.data = TSFE:id
    additionalParams = &type=250
  }
}