eea.pdf 4.1

Download as PDF

This package allows your users to download Plone content as PDF files. As admin you can define specific PDF themes per content-type.

Note

Requires wkhtmltopdf and pdftk system-packages installed on your server. See eea.converter documentation for more details.

Contents

Contents

• Contents

• Main features

• Install

• Getting started

• PDF Theme options

  • Cover

  • Disclaimer

  • Body

  • Back Cover

  • Header

  • Footer

  • Table of contents

  • Table of contents links

  • JavaScript

  • Timeout

  • Asynchronous

  • Offset

  • Maximum depth

  • Maximum breadth

  • Maximum items

  • Portal types

• Custom permissions

  • Can download PDF (eea.pdf.download)

  • Can customize PDF (eea.pdf.customize)

• Content rules

  • PDF export succeeded

  • PDF export failed

  • PDF export failed (admin)

• Content rules email string substitution

  • ${download_came_from_url}

  • ${download_email}

  • ${download_error}

  • ${download_from_email}

  • ${download_from_name}

  • ${download_title}

  • ${download_url}

• Dependencies

• Source code

• Copyright and license

• Funding

• Changelog

  • 4.1 - (2014-09-16)

  • 4.0 - (2014-09-15)

  • 3.2 - (2014-09-07)

  • 3.1 - (2014-08-27)

  • 3.0 - (2014-08-12)

  • 2.0 - (2014-07-16)

  • 1.1 - (2014-06-30)

  • 1.0 - (2014-06-06)

Main features

1. Adds download as PDF action at the bottom of the page

2. Possibility to define custom PDF themes per content-type

3. Asynchronously generate PDF files and notify users by email when PDF is ready

Install

• Add eea.pdf to your eggs section in your buildout and re-run buildout. You can download a sample buildout from https://github.com/eea/eea.pdf/tree/master/buildouts/plone4

• Install eea.pdf within Site Setup > Add-ons

Getting started

1. Go to Site Setup > PDF Settings

2. Customize an existing PDF theme or add a new one

3. Go to Home page and click on download as pdf icon at the bottom of the page or directly access http://localhost:8080/Plone/front-page/download.pdf

PDF Theme options

For more information about wkhtmltopdf options like Table of contents XSL file, header and footer parameters, etc. see wkhtmltopdf documentation.

Cover

A page template to be used for PDF Cover. Leave empty to disable it. Default: pdf.body

Disclaimer

A page template containing copyright and author information. This page will be placed between cover and PDF body. Leave empty to skip it. Default: pdf.disclaimer

Body

A page template to be used for PDF body. An empty value will skip PDF body. Default: pdf.body

Back Cover

A page template to be used for back cover. Leave empty to disable back cover. Default: pdf.cover.back

Header

A page template to be used as PDF body header. This will not appear on cover, disclaimer or back cover. Leave empty for no header. Default: pdf.header

Footer

A page template to be used as PDF body footer. This will not appear on cover, disclaimer or back.cover. Leave empty for no footer. Default: pdf.footer

Table of contents

An XSL page template to be used for PDF Table of contents. See wkhtmltopdf documentation for more information about XSL format. Leave empty to disable Table of contents. Default: pdf.toc

Table of contents links

Enable or disable Table of Contents internal links and also PDF bookmarks (outline) Default: False

JavaScript

Enable or disable javascript. Default: True

Timeout

Abort PDF conversion after this number of seconds Default: 3600

Asynchronous

Generate PDF asynchronously and send an email to the user when it’s done Default: True

Offset

Start counting pages within PDF Body from this number. Usefull when cover and/or disclaimer are enabled. Default: 0

Maximum depth

This option defines the maximum depth a folderish item can go while recursively includes it’s children within PDF. Default: 1 (include only direct children, non-folderish ones)

Maximum breadth

This options limit the number of direct children a folderish item can include within PDF. Default: 100

Maximum items

The total items to be included within PDF export for a folderish item, including depth and breadth. Default: 1000

Portal types

Apply this theme to selected portal types. Default:

Custom permissions

Custom permissions added by this package

Can download PDF (eea.pdf.download)

Assign this permission to roles that you want to be able to download content as PDF Default: Owner, Manager, Editor

Can customize PDF (eea.pdf.customize)

Assign this permission to roles that you want to be able to contextually customize the output PDF look and feel Default: Manager, Site Administrator

Content rules

This package uses Plone Content-rules to notify users by email when an asynchronous PDF job is done. Thus 3 custom content-rules will be added within Plone > Site Setup > Content-rules

Warning

As these content-rules are triggered by an asynchronous job, while you customize the email template for these content-rules, please DO NOT USE OTHER string substitutions that the ones that start with $download_ as you’ll break the download chain. Also if you disable these content-rules the users will never know when the PDF is ready and what is the link where they can download the output PDF.

PDF export succeeded

Notify the person who requested a PDF export that the PDF successfully exported and provide a link to the downloadable PDF

PDF export failed

Notify the person who requested a PDF export that the PDF export failed.

PDF export failed (admin)

Notify admin that there were issues while exporting PDF

Content rules email string substitution

In order to be able to easily customize emails sent by this package the following custom email template string substitutions can be made

${download_came_from_url}

The absolute URL of the Plone object which is downloaded as PDF

${download_email}

Email address of the user that triggered the download as PDF action

${download_error}

Error traceback when download as PDF job fails

${download_from_email}

Site Admin email address customizable via Plone > Site Setup > Mail

${download_from_name}

Site Admin name customizable via Plone > Site Setup > Mail

${download_title}

Title of the Plone object which is downloaded as PDF

${download_url}

The absolute URL where the generated output PDF can be downloaded

Dependencies

1. eea.converter

2. wkhtmltopdf

3. pdftk

4. eea.cache (optional)

Source code

• Latest source code (Plone 4 compatible): https://github.com/eea/eea.pdf

Copyright and license

The Initial Owner of the Original Code is European Environment Agency (EEA). All Rights Reserved.

The EEA PDF (the Original Code) is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 2 of the License, or (at your option) any later version.

More details under docs/License.txt

Funding

EEA - European Environment Agency (EU)

Changelog

4.1 - (2014-09-16)

• Bug fix: Fixed ‘AttributeError: async’ within PDF Settings control panel [avoinea]

4.0 - (2014-09-15)

• Upgrade step: (optional) Within Plone > Site setup > PDF Settings ensure that all PDF themes have Asynchronous property checked and increase timeout to 3600 [voineali refs #20845]

• Upgrade step: (optional) Within Plone > Site setup > Content-rules review all PDF related content-rules. As these rules are triggered by an async job DO NOT USE other string substitutions while sending emails than the ones the start with $download_ [voineali refs #20845]

• Upgrade step: (optional) On server machine add a cleanup cron to remove generated PDF files older than 7 days (or more, depending on your storage size) [voineali refs #20845]

• Upgrade step: Within “Plone > Site setup > Add-ons” click on upgrade button available for EEA PDF

• Feature: Ask for email when user tries to asynchronously export PDF if the system can’t get it from current user’s profile [voineali refs #20846]

• Feature: Generate PDFs asynchronously with plone.app.async. Enabled by default with this version. It can be manually disabled from Site Setup > PDF Settings > Theme [voineali refs #20843]

3.2 - (2014-09-07)

• Bug fix: Re-release broken version 3.1 [avoinea]

3.1 - (2014-08-27)

• Feature: Speed-up PDF export by caching pdf.body method using memcached if eea.cache is present [voineali refs #20678]

• Feature: Added print CSS for embeded daviz charts [voineali refs #20523]

3.0 - (2014-08-12)

• Upgrade step: Assign “Can download PDF” permission to CommonEditor

• Upgrade step: Within “Plone > Site setup > Add-ons” click on upgrade button available for EEA PDF

• Change: Added i18n translations [voineali refs #20431]

• Bug fix: Hide some indicators boxes within PDF export [voineali refs #20454]

• Bug fix: Fixed spacing for key messages and related items [voineali refs #20457]

• Bug fix: Fixed CSS used for tables within PDF export [voineali refs #20462]

• Change: Skip description within PDF cover if length of first sentence is greather that 80 characters [voineali refs #20456]

• Feature: Include iframes and interpret javascript. Also added option to disable javascript per theme. [voineali refs #20459]

• Cleanup: Removed beautifulsoup4 dependency and cleanup all fixes made with this tool [voineali refs #20459]

• Feature: Added global and local PDF settings for collection and folderish content-types: Max depth, Max breadth and Total Max Items [voineali refs #20436]

• Feature: Added possibility to locally override PDF Theme to use within PDF export [voineali refs #20436]

• Feature: Added possibility to locally disable PDF export [voineali refs #20436]

• Feature: Added IPDFAware marker interface in order to easily support PDF export. Added Dexterity support, also. [voineali refs #20436]

• Feature: Added “Can download PDF” and “Can customize PDF” permissions [voineali refs #20436]

• Change: Removed default PDF theme concept. If there is no PDF Theme assigned for a content-type, PDF can’t be downloaded [voineali refs #20436]

2.0 - (2014-07-16)

• Feature: added style for excluding certain parts from PDF. [demarant #20255]

• Upgrade step: Within “Plone > Site setup > Add-ons” click on upgrade button available for EEA PDF

• Upgrade step: Within “Plone > Site setup > Add-ons” uninstall collective.sendaspdf

• Feature: Added table of contents support [voineali refs #20268]

• Feature: Added custom pdf.body for Topic and Collection content-types that is an aggregated page based on query results pdf.body [voineali refs #20267]

• Feature: Added custom pdf.body for Plone Folder ctype that is an aggregated page based on children pdf.body [voineali refs #20267]

• Cleanup: Remove collective.sendaspdf dependency [voineali refs #20268]

1.1 - (2014-06-30)

• Bug fix: fixed condition for print css which failed when using collective.sendaspdf to download a pdf [ichimdav refs #19880]

• Bug fix: use plone.app.vocabularies.ReallyUserFriendlyTypes for better portal types matching [ichim-david refs #19880]

1.0 - (2014-06-06)

• Upgrade step: Within “Plone > Site setup > Add-ons” install “EEA PDF” [voineali refs #19761]

• Initial release