Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

https://github.com/plone/plone.pdfexport

Provides generic PDF export functionality for Plone content.
https://github.com/plone/plone.pdfexport

Last synced: 3 months ago
JSON representation

Provides generic PDF export functionality for Plone content.

Host: GitHub
URL: https://github.com/plone/plone.pdfexport
Owner: plone
License: gpl-2.0
Created: 2021-07-13T11:42:18.000Z (almost 3 years ago)
Default Branch: main
Last Pushed: 2022-11-04T13:26:58.000Z (over 1 year ago)
Last Synced: 2024-04-14T05:54:34.778Z (3 months ago)
Language: Python
Homepage:
Size: 4.03 MB
Stars: 3
Watchers: 12
Forks: 0
Open Issues: 1
Metadata Files:
- Readme: README.rst
- Changelog: CHANGES.rst
- License: LICENSE.GPL

Lists

awesome-plone - plone.pdfexport - Generic PDF export functionality for Plone content. (Content and utilities for content)

README

.. This README is meant for consumption by humans and pypi. Pypi can render rst files so please do not use Sphinx features.
If you want to learn more about writing documentation, please check out: http://docs.plone.org/about/documentation_styleguide.html
This text does not appear on pypi or github. It is a comment.

.. image:: https://github.com/plone/plone.pdfexport/actions/workflows/plone-package.yml/badge.svg
:target: https://github.com/plone/plone.pdfexport/actions/workflows/plone-package.yml

.. image:: https://coveralls.io/repos/github/plone/plone.pdfexport/badge.svg?branch=main
:target: https://coveralls.io/github/plone/plone.pdfexport?branch=main
:alt: Coveralls

.. image:: https://img.shields.io/pypi/v/plone.pdfexport.svg
:target: https://pypi.python.org/pypi/plone.pdfexport/
:alt: Latest Version

.. image:: https://img.shields.io/pypi/status/plone.pdfexport.svg
:target: https://pypi.python.org/pypi/plone.pdfexport
:alt: Egg Status

.. image:: https://img.shields.io/pypi/pyversions/plone.pdfexport.svg?style=plastic :alt: Supported - Python Versions

.. image:: https://img.shields.io/pypi/l/plone.pdfexport.svg
:target: https://pypi.python.org/pypi/plone.pdfexport/
:alt: License

===============
plone.pdfexport
===============

Provides PDF export functionality for Plone content.

Features
--------

- Exports Documents, Event, News items and other custom content.
- Can be customized via CSS in the PDF Export control panel.
- Long tables which will be rendered on more than one page, will have the thead repeated on every page.
- One can use Plone body tag CSS classes to define CSS rules for specific Plone content.

.. figure:: https://github.com/plone/plone.pdfexport/raw/main/docs/plone-pdfexport.gif

This add-on is based on the great `WeasyPrint library `_.

Translations
------------

This product has been translated into

- english
- german

Installation
------------

Install plone.pdfexport by adding it to your buildout::

[buildout]

...

eggs =
plone.pdfexport

and then running ``bin/buildout``

Note: for Python 2 (Plone 5.1) you have to pin some packages:

weasyprint = 0.42.3
cairocffi = 0.9.0
tinycss2 = 0.6.1
soupsieve = 1.9.6
cssselect2 = 0.2.2

Usage
-----

After installing the add-on you can call the "aspdf" view on any Plone content.

``http://localhost:8080/Plone/news/aspdf``

for testing, you can add the GET parameter "html=1" to see the HTML version before it get rendered into a PDF.

``http://localhost:8080/Plone/news/aspdf?html=1``

We provide portrait and landscape mode with separate page setting for each mode:

.. code-block:: CSS

@page {
margin: 2.75cm 1.4cm 1.4cm 1.4cm;
size: landscape;
@top-center {
font-size:12px;
color:#666666;
content: "Beautiful Plone content, deserves a beautiful PDF export!";
}
@bottom-left {
font-size:12px;
color:#666666;
content: "provided by derico.de";
}
@bottom-right {
font-size:12px;
color:#666666;
content: "Page " counter(page);
}

}

You can set which mode is the default. To use a different mode, you can add a request parameter:

.. code-block::

http://localhost:8080/Plone/front-page/aspdf?mode=landscape
http://localhost:8080/Plone/front-page/aspdf?mode=portait

Authors
-------

This add-on was build by `Derico `_ [MrTango].

Contribute
----------

- Issue Tracker: https://github.com/plone/plone.pdfexport/issues
- Source Code: https://github.com/plone/plone.pdfexport

Support
-------

If you are having issues, please let us know.

License
-------

The project is licensed under the GPLv2.