OCA reporting engine fork for dev and update.
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

73 lines
2.6 KiB

  1. .. image:: https://img.shields.io/badge/licence-AGPL--3-blue.svg
  2. :target: http://www.gnu.org/licenses/agpl-3.0-standalone.html
  3. :alt: License: AGPL-3
  4. =============
  5. Pdf watermark
  6. =============
  7. 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.
  8. Installation
  9. ============
  10. As PyPDF is not supported in python3, you need to install PyPDF2::
  11. $ pip install pypdf2
  12. Usage
  13. =====
  14. To use this module, you need to:
  15. #. go to your report
  16. #. select a PDF or image to use as watermark. Note that resolutions and size must match, otherwise you'll have funny results
  17. #. You can also fill in an expression that returns the data (base64 encoded) to be used as watermark
  18. .. image:: https://odoo-community.org/website/image/ir.attachment/5784_f2813bd/datas
  19. :alt: Try me on Runbot
  20. :target: https://runbot.odoo-community.org/runbot/143/8.0
  21. Known Issues
  22. ============
  23. 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.
  24. Bug Tracker
  25. ===========
  26. Bugs are tracked on `GitHub Issues
  27. <https://github.com/OCA/reporting-engine/issues>`_. In case of trouble, please
  28. check there if your issue has already been reported. If you spotted it first,
  29. help us smashing it by providing a detailed and welcomed feedback.
  30. Credits
  31. =======
  32. Images
  33. ------
  34. * Odoo Community Association: `Icon <https://github.com/OCA/maintainer-tools/blob/master/template/module/static/description/icon.svg>`_.
  35. Contributors
  36. ------------
  37. * Holger Brunn <hbrunn@therp.nl>
  38. * Stefan Rijnhart <stefan@opener.am>
  39. * Rod Schouteden <rod.schouteden@dynapps.be>
  40. Do not contact contributors directly about help with questions or problems concerning this addon, but use the `community mailing list <mailto:community@mail.odoo.com>`_ or the `appropriate specialized mailinglist <https://odoo-community.org/groups>`_ for help, and the bug tracker linked in `Bug Tracker`_ above for technical issues.
  41. Maintainer
  42. ----------
  43. .. image:: https://odoo-community.org/logo.png
  44. :alt: Odoo Community Association
  45. :target: https://odoo-community.org
  46. This module is maintained by the OCA.
  47. OCA, or the Odoo Community Association, is a nonprofit organization whose
  48. mission is to support the collaborative development of Odoo features and
  49. promote its widespread use.
  50. To contribute to this module, please visit https://odoo-community.org.