mirror of
https://gitlab.com/flectra-community/reporting-engine.git
synced 2024-11-22 22:22:05 +00:00
119 lines
3.9 KiB
ReStructuredText
119 lines
3.9 KiB
ReStructuredText
|
=============
|
||
|
|
Pdf watermark
|
||
|
|
=============
|
||
|
|
|
||
|
|
.. !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
|
||
|
|
!! This file is generated by oca-gen-addon-readme !!
|
||
|
|
!! changes will be overwritten. !!
|
||
|
|
!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
|
||
|
|
|
||
|
|
.. |badge1| image:: https://img.shields.io/badge/maturity-Beta-yellow.png
|
||
|
|
:target: https://odoo-community.org/page/development-status
|
||
|
|
:alt: Beta
|
||
|
|
.. |badge2| image:: https://img.shields.io/badge/licence-AGPL--3-blue.png
|
||
|
|
:target: http://www.gnu.org/licenses/agpl-3.0-standalone.html
|
||
|
|
:alt: License: AGPL-3
|
||
|
|
.. |badge3| image:: https://img.shields.io/badge/github-OCA%2Freporting--engine-lightgray.png?logo=github
|
||
|
|
:target: https://github.com/OCA/reporting-engine/tree/14.0/report_qweb_pdf_watermark
|
||
|
|
:alt: OCA/reporting-engine
|
||
|
|
.. |badge4| image:: https://img.shields.io/badge/weblate-Translate%20me-F47D42.png
|
||
|
|
:target: https://translation.odoo-community.org/projects/reporting-engine-14-0/reporting-engine-14-0-report_qweb_pdf_watermark
|
||
|
|
:alt: Translate me on Weblate
|
||
|
|
.. |badge5| image:: https://img.shields.io/badge/runbot-Try%20me-875A7B.png
|
||
|
|
:target: https://runbot.odoo-community.org/runbot/143/14.0
|
||
|
|
:alt: Try me on Runbot
|
||
|
|
|
||
|
|
|badge1| |badge2| |badge3| |badge4| |badge5|
|
||
|
|
|
||
|
|
This module was written to add watermarks (backgrounds) to PDF reports. Because of the way wkhtmltopdf handles headers and footers in the current versions, it is quite impossible to have a background for the complete page using HTML and CSS. That is why this module inserts the image at the PDF level.
|
||
|
|
|
||
|
|
**Table of contents**
|
||
|
|
|
||
|
|
.. contents::
|
||
|
|
:local:
|
||
|
|
|
||
|
|
Installation
|
||
|
|
============
|
||
|
|
|
||
|
|
|
||
|
|
As PyPDF is not supported in python3, you need to install PyPDF2::
|
||
|
|
|
||
|
|
$ pip install pypdf2
|
||
|
|
|
||
|
|
Usage
|
||
|
|
=====
|
||
|
|
|
||
|
|
To use this module, you need to:
|
||
|
|
|
||
|
|
#. go to your report
|
||
|
|
#. select a PDF or image to use as watermark. Note that resolutions and size must match, otherwise you'll have funny results
|
||
|
|
#. You can also fill in an expression that returns the data (base64 encoded) to be used as watermark
|
||
|
|
|
||
|
|
Known issues / Roadmap
|
||
|
|
======================
|
||
|
|
|
||
|
|
This module depends on support for transparent backgrounds in Wkhtmltopdf, which has been flaky in the past. This module has been reported to work with Wkhtmltopdf 0.12.4.
|
||
|
|
|
||
|
|
Changelog
|
||
|
|
=========
|
||
|
|
|
||
|
|
12.0.1.0.0 (2019-11-18)
|
||
|
|
~~~~~~~~~~~~~~~~~~~~~~~
|
||
|
|
|
||
|
|
* [MIG] Migration to V12.
|
||
|
|
|
||
|
|
|
||
|
|
13.0.1.0.0 (2021-01-27)
|
||
|
|
~~~~~~~~~~~~~~~~~~~~~~~
|
||
|
|
|
||
|
|
* [MIG] Migration to V13.
|
||
|
|
|
||
|
|
|
||
|
|
14.0.1.0.0 (2021-01-29)
|
||
|
|
~~~~~~~~~~~~~~~~~~~~~~~
|
||
|
|
|
||
|
|
* [MIG] Migration to V14.
|
||
|
|
|
||
|
|
Bug Tracker
|
||
|
|
===========
|
||
|
|
|
||
|
|
Bugs are tracked on `GitHub Issues <https://github.com/OCA/reporting-engine/issues>`_.
|
||
|
|
In case of trouble, please check there if your issue has already been reported.
|
||
|
|
If you spotted it first, help us smashing it by providing a detailed and welcomed
|
||
|
|
`feedback <https://github.com/OCA/reporting-engine/issues/new?body=module:%20report_qweb_pdf_watermark%0Aversion:%2014.0%0A%0A**Steps%20to%20reproduce**%0A-%20...%0A%0A**Current%20behavior**%0A%0A**Expected%20behavior**>`_.
|
||
|
|
|
||
|
|
Do not contact contributors directly about support or help with technical issues.
|
||
|
|
|
||
|
|
Credits
|
||
|
|
=======
|
||
|
|
|
||
|
|
Authors
|
||
|
|
~~~~~~~
|
||
|
|
|
||
|
|
* Therp BV
|
||
|
|
|
||
|
|
Contributors
|
||
|
|
~~~~~~~~~~~~
|
||
|
|
|
||
|
|
* Holger Brunn <hbrunn@therp.nl>
|
||
|
|
* Stefan Rijnhart <stefan@opener.am>
|
||
|
|
* Rod Schouteden <rod.schouteden@dynapps.be>
|
||
|
|
* Robin Goots <robin.goots@dynapps.be>
|
||
|
|
* Foram Shah <foram.shah@initos.com>
|
||
|
|
|
||
|
|
Maintainers
|
||
|
|
~~~~~~~~~~~
|
||
|
|
|
||
|
|
This module is maintained by the OCA.
|
||
|
|
|
||
|
|
.. image:: https://odoo-community.org/logo.png
|
||
|
|
:alt: Odoo Community Association
|
||
|
|
:target: https://odoo-community.org
|
||
|
|
|
||
|
|
OCA, or the Odoo Community Association, is a nonprofit organization whose
|
||
|
|
mission is to support the collaborative development of Odoo features and
|
||
|
|
promote its widespread use.
|
||
|
|
|
||
|
|
This module is part of the `OCA/reporting-engine <https://github.com/OCA/reporting-engine/tree/14.0/report_qweb_pdf_watermark>`_ project on GitHub.
|
||
|
|
|
||
|
|
You are welcome to contribute. To learn how please visit https://odoo-community.org/page/Contribute.
|