Metadata-Version: 1.1
Name: eea.pdf
Version: 3.1
Summary: Download as PDF
Home-page: http://eea.github.io
Author: European Environment Agency
Author-email: webadmin@eea.europa.eu
License: GPL version 2
Description: =======
        EEA PDF
        =======
        .. image:: http://ci.eionet.europa.eu/job/eea.pdf-www/badge/icon
          :target: http://ci.eionet.europa.eu/job/eea.pdf-www/lastBuild
        .. image:: http://ci.eionet.europa.eu/job/eea.pdf-plone4/badge/icon
          :target: http://ci.eionet.europa.eu/job/eea.pdf-plone4/lastBuild
        
        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::
        
        Main features
        =============
        
        1. Adds download as PDF action at the bottom of the page
        2. 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
        ===============
        
        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: 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
        ============
        
        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)
        
        .. _EEA: http://www.eea.europa.eu/
        .. _eea.converter: http://eea.github.com/docs/eea.converter
        .. _wkhtmltopdf: http://wkhtmltopdf.org
        .. _pdftk: http://www.pdflabs.com/tools/pdftk-the-pdf-toolkit/
        .. _eea.cache: http://eea.github.com/docs/eea.cache
        
        Changelog
        =========
        
        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
        
        
Keywords: eea zope plone python
Platform: UNKNOWN
Classifier: Framework :: Zope2
Classifier: Framework :: Zope3
Classifier: Framework :: Plone
Classifier: Framework :: Plone :: 4.3
Classifier: Programming Language :: Zope
Classifier: Programming Language :: Python
Classifier: Topic :: Software Development :: Libraries :: Python Modules
Classifier: License :: OSI Approved :: GNU General Public License (GPL)
Classifier: License :: OSI Approved :: Mozilla Public License 1.0 (MPL)
