Download as PDF
Project description
This package allows your users to download Plone content as PDF files. As admin you can define specific PDF themes per content-type.
Contents
Main features
Adds download as PDF action at the bottom of the page
Possibility to define custom PDF themes per content-type
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
Go to Site Setup > PDF Settings
Customize an existing PDF theme or add a new one
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
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: 60
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
Dependencies
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
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
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
