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.

119 lines
3.9 KiB

  1. =============
  2. Pdf watermark
  3. =============
  4. .. !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
  5. !! This file is generated by oca-gen-addon-readme !!
  6. !! changes will be overwritten. !!
  7. !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
  8. .. |badge1| image:: https://img.shields.io/badge/maturity-Beta-yellow.png
  9. :target: https://odoo-community.org/page/development-status
  10. :alt: Beta
  11. .. |badge2| image:: https://img.shields.io/badge/licence-AGPL--3-blue.png
  12. :target: http://www.gnu.org/licenses/agpl-3.0-standalone.html
  13. :alt: License: AGPL-3
  14. .. |badge3| image:: https://img.shields.io/badge/github-OCA%2Freporting--engine-lightgray.png?logo=github
  15. :target: https://github.com/OCA/reporting-engine/tree/14.0/report_qweb_pdf_watermark
  16. :alt: OCA/reporting-engine
  17. .. |badge4| image:: https://img.shields.io/badge/weblate-Translate%20me-F47D42.png
  18. :target: https://translation.odoo-community.org/projects/reporting-engine-14-0/reporting-engine-14-0-report_qweb_pdf_watermark
  19. :alt: Translate me on Weblate
  20. .. |badge5| image:: https://img.shields.io/badge/runbot-Try%20me-875A7B.png
  21. :target: https://runbot.odoo-community.org/runbot/143/14.0
  22. :alt: Try me on Runbot
  23. |badge1| |badge2| |badge3| |badge4| |badge5|
  24. 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.
  25. **Table of contents**
  26. .. contents::
  27. :local:
  28. Installation
  29. ============
  30. As PyPDF is not supported in python3, you need to install PyPDF2::
  31. $ pip install pypdf2
  32. Usage
  33. =====
  34. To use this module, you need to:
  35. #. go to your report
  36. #. select a PDF or image to use as watermark. Note that resolutions and size must match, otherwise you'll have funny results
  37. #. You can also fill in an expression that returns the data (base64 encoded) to be used as watermark
  38. Known issues / Roadmap
  39. ======================
  40. 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.
  41. Changelog
  42. =========
  43. 12.0.1.0.0 (2019-11-18)
  44. ~~~~~~~~~~~~~~~~~~~~~~~
  45. * [MIG] Migration to V12.
  46. 13.0.1.0.0 (2021-01-27)
  47. ~~~~~~~~~~~~~~~~~~~~~~~
  48. * [MIG] Migration to V13.
  49. 14.0.1.0.0 (2021-01-29)
  50. ~~~~~~~~~~~~~~~~~~~~~~~
  51. * [MIG] Migration to V14.
  52. Bug Tracker
  53. ===========
  54. Bugs are tracked on `GitHub Issues <https://github.com/OCA/reporting-engine/issues>`_.
  55. In case of trouble, please check there if your issue has already been reported.
  56. If you spotted it first, help us smashing it by providing a detailed and welcomed
  57. `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**>`_.
  58. Do not contact contributors directly about support or help with technical issues.
  59. Credits
  60. =======
  61. Authors
  62. ~~~~~~~
  63. * Therp BV
  64. Contributors
  65. ~~~~~~~~~~~~
  66. * Holger Brunn <hbrunn@therp.nl>
  67. * Stefan Rijnhart <stefan@opener.am>
  68. * Rod Schouteden <rod.schouteden@dynapps.be>
  69. * Robin Goots <robin.goots@dynapps.be>
  70. * Foram Shah <foram.shah@initos.com>
  71. Maintainers
  72. ~~~~~~~~~~~
  73. This module is maintained by the OCA.
  74. .. image:: https://odoo-community.org/logo.png
  75. :alt: Odoo Community Association
  76. :target: https://odoo-community.org
  77. OCA, or the Odoo Community Association, is a nonprofit organization whose
  78. mission is to support the collaborative development of Odoo features and
  79. promote its widespread use.
  80. 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.
  81. You are welcome to contribute. To learn how please visit https://odoo-community.org/page/Contribute.