Skip to main content

An open source product for Plone to download or email a page seen by the user as a PDF file.

Project description

Introduction
============

collective.sendaspdf is an open source product for Plone that
allows downloading the page seen by the user as a PDF file. It also
provide a form to send the page by e-mail (a screenshot of the current
page in a PDF format being joined to the e-mail).

It relies on two products to generate the PDF files:
- xhtml2pdf: http://www.xhtml2pdf.com/
- wkhtmltopdf: http://code.google.com/p/wkhtmltopdf/

The site manager can easily chose which solution he prefers for
the generation.

Installing
==========

To install the package, you can simply add 'collective.sendaspdf'
to the eggs list in your buildout.
Then install it using Zope's quick installer or Plone's add-on
products manager.

To install xhtml2pdf, add the following to your buildout eggs
directory:
pisa
pyPdf
html5lib
reportlab

collective.sendaspdf has been tested with development versions of
pisa and html5lib. With the last releases (when writing this README
- html5lib 0.9 and pisa 3.0.33) some pages could not be rendered.

To install wkhtmltopdf, go to the projects page and download an
executable version for your OS. Install it so the command
'wkhtmltopdf' is in the PATH.
You can also update your buildout to automatically download
wkhtmltopdf and have if use by your instance using the following
recipes:

[buildout]
parts =
...
wkhtmltopdf
wkhtmltopdf_executable

[instance]
...
environment-vars =
...
WKHTMLTOPDF_PATH ${wkhtmltopdf:location}/wkhtmltopdf

[wkhtmltopdf]
recipe = hexagonit.recipe.download
url = http://wkhtmltopdf.googlecode.com/files/wkhtmltopdf-0.9.9-static-amd64.tar.bz2

[wkhtmltopdf_executable]
recipe = collective.recipe.cmd
on_install = true
on_update = true
cmds =
cd ${buildout:directory}/parts/wkhtmltopdf
mv wkhtmltopdf-amd64 wkhtmltopdf
chmod +x wkhtmltopdf

You might have some changes to do depending on the architecture you
are using (this example is for the amd64 architecture)

Configuring
===========

Go to the Plone control panel. You will find a 'Send as PDF' link that
sends you to the products configuration page.

This page proposes a few settings:
- the tool used to render the PDF files.
- the directory where the PDF files are stored.
- the sentence used as salt when hashing the user's emails
(this hash is used to know which files a user can access)
- the name used in the mail for the PDF file.
- a default title/body for the mails.

For wkhtmltopdf user, two extra options are available:
- always use the print CSS to render the PDF.
- use the print CSS for a given set of objects.

xhtml2pdf always use the print CSS.

TODO
====

- a buildout recipe to install wkhtmltopdf
- an Ajax version of the send by mail form

Changelog
=========

2.0 (2010-10-22)
----------------

- compatibility fixes with Plone4. [vincent]

- added Ajax version of "Download as PDF" link. [vincent]

- added Ajax version of the "Send as PDF" link. [vincent]

- Removed the '-C' parameter. [yuri + vincent]


1.1 (2010-09-16)
----------------

- when the PDF generation failed in the page to send by mail, we
display an error page instead of failing. [vincent]

- bugfix in send page - it was impossible to load the Wysiwyg for
anonymous users. Stole some code from POI to solve it. [vincent]


1.0.3 (2010-08-02)
------------------

- Fix broken release with missing files. (Now released with setuptools-git
installed.) [mark]


1.0.2 (2010-08-02)
------------------

- updated egg information in setup.py (author and description). [mark]


1.0.1 (2010-08-02)
------------------

- translated the "download as PDF" action. [mark]

- registered the translations so they are applied. [mark]


1.0 (2010-07-21)
----------------

- added Dutch and French translations [vincent+mark]

- added view to send by mail and download the page. [vincent]

- added document actions to send the page by mail and download as
pdf. [vincent]

- Added sendaspdf tool to manage preferences. [vincent]

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Files for collective.sendaspdf, version 2.0
Filename, size File type Python version Upload date Hashes
Filename, size collective.sendaspdf-2.0.zip (55.7 kB) File type Source Python version None Upload date Hashes View

Supported by

AWS AWS Cloud computing Datadog Datadog Monitoring DigiCert DigiCert EV certificate Facebook / Instagram Facebook / Instagram PSF Sponsor Fastly Fastly CDN Google Google Object Storage and Download Analytics Pingdom Pingdom Monitoring Salesforce Salesforce PSF Sponsor Sentry Sentry Error logging StatusPage StatusPage Status page