Skip to content

Latest commit

 

History

History
99 lines (67 loc) · 2.8 KB

readme.md

File metadata and controls

99 lines (67 loc) · 2.8 KB
Raw

Introduction

Provide an easy way to generate a PDF for any page you have.

Setup

Install the extension as usual. Include the static TypoScript where you need pages to be generated as PDF.

Enable use of CURL

Please activate the use of curl in TYPO3 'curlUse' => '1'. The extension will check the provided urls for availability and deliver a 404 if the url is not valid.

If the option is not set, the extension won't work.

Configuration

The extension is configured via TS only. Everything is inside the new page configuration pdf.

If the preconfigured type 100 is already in use in your installation, just overwrite, the constant, to your needs.

Everything is configured with defaults and can be overwritten via TypoScript.

Each option is documented inside the TS, just browse through it using the constant editor with further documentation.

Add cli options

Add all wkhtmltopdf options via TS in pdf.10.cliParameters. You can configure them like this:

pdf.10.cliParameters {
    OPTION = VALUE
}

You can also add stdWraps to the options like:

pdf.10.cliParameters {
    header-html = PATH_TO_HTML_FILE
    header-html.wrap = |.html
}

Beware that you must not write -- for the options.

Look up the options at: http://wkhtmltopdf.org/usage/wkhtmltopdf.txt

RealURL

We recommend to configure EXT:realurl, if in use as follows:

'fileName' => array(
    'defaultToHTMLsuffixOnPrev' => 1,
    'acceptHTMLsuffix' => 1,
    'index' => array(
        '.pdf' => array(
            'keyValues' => array(
                'type' => 100,
            ),
        ),
    ),
),

This configuration will allow to generate urls like http://domain.tld/some-path/some-site.pdf as pdf version of http://domain.tld/some-path/some-site.html

Usage

Call the page, which should be delivered as PDF, with the configured type= parameter.

Security

This extension will do a system call to generate the PDFs. While doing so, some information need to be passed to the shell. This can lead to security issues. Every part of the command is escaped with PHP native functionality.

Anyway, take care what you configure and what is passed to the shell.

Limit the configuration to administrators or some respected group, as you always should to with TypoScript.

Current state

NOTE: The state is still alpha! This means:

The extension can behave unexpected in many cases. E.g. all generated files are stored with md5 hash of the given url in one folder which can lead to many files if you don't remove old ones.

We will add such things later, but most of them are very easy to extend. So do it your own and bring back the efforts to others. Send in Pull Requests / patches to the author