From 28e491aa073cd79341f77584b6267e45151bac23 Mon Sep 17 00:00:00 2001 From: OCA-git-bot Date: Thu, 29 Dec 2022 08:59:48 +0000 Subject: [PATCH] [UPD] README.rst --- report_qweb_pdf_watermark/README.rst | 37 +++++++-- .../static/description/index.html | 78 ++++++++++++------- 2 files changed, 81 insertions(+), 34 deletions(-) diff --git a/report_qweb_pdf_watermark/README.rst b/report_qweb_pdf_watermark/README.rst index 6b470d042..4cf05573c 100644 --- a/report_qweb_pdf_watermark/README.rst +++ b/report_qweb_pdf_watermark/README.rst @@ -7,20 +7,20 @@ Pdf watermark !! changes will be overwritten. !! !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! -.. |badge1| image:: https://img.shields.io/badge/maturity-Beta-yellow.png +.. |badge1| image:: https://img.shields.io/badge/maturity-Production%2FStable-green.png :target: https://odoo-community.org/page/development-status - :alt: Beta + :alt: Production/Stable .. |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 + :target: https://github.com/OCA/reporting-engine/tree/15.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 + :target: https://translation.odoo-community.org/projects/reporting-engine-15-0/reporting-engine-15-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 + :target: https://runbot.odoo-community.org/runbot/143/15.0 :alt: Try me on Runbot |badge1| |badge2| |badge3| |badge4| |badge5| @@ -49,6 +49,21 @@ To use this module, you need to: #. 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 +To use the Company watermark, you need to: + +#. go to settings --> company --> update info +#. upload an pdf watermark +#. go to settings --> technical --> reporting --> reports +#. Select the report where you want to use it. +#. On the 'Advanced Properties' tab of the notebook check 'use company watermark' + +### Demo +And demo report is available (if you have demo data installed) on the users form view. + +#. go to Configuration --> users +#. Select an users +#. Click the print button --> Watermark Demo report. + Known issues / Roadmap ====================== @@ -74,13 +89,20 @@ Changelog * [MIG] Migration to V14. + +15.0.1.0.0 (2022-01-11) +~~~~~~~~~~~~~~~~~~~~~~~ + +* [MIG] Migration to V15. +* Define pdf watermark in company settings + Bug Tracker =========== Bugs are tracked on `GitHub 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 `_. +`feedback `_. Do not contact contributors directly about support or help with technical issues. @@ -100,6 +122,7 @@ Contributors * Rod Schouteden * Robin Goots * Foram Shah +* Emiel van Bokhoven Maintainers ~~~~~~~~~~~ @@ -114,6 +137,6 @@ 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 `_ project on GitHub. +This module is part of the `OCA/reporting-engine `_ project on GitHub. You are welcome to contribute. To learn how please visit https://odoo-community.org/page/Contribute. diff --git a/report_qweb_pdf_watermark/static/description/index.html b/report_qweb_pdf_watermark/static/description/index.html index c6614ec98..7e60ebb21 100644 --- a/report_qweb_pdf_watermark/static/description/index.html +++ b/report_qweb_pdf_watermark/static/description/index.html @@ -367,104 +367,128 @@ ul.auto-toc { !! This file is generated by oca-gen-addon-readme !! !! changes will be overwritten. !! !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! --> -

Beta License: AGPL-3 OCA/reporting-engine Translate me on Weblate Try me on Runbot

+

Production/Stable License: AGPL-3 OCA/reporting-engine Translate me on Weblate Try me on Runbot

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

-

Installation

+

Installation

As PyPDF is not supported in python3, you need to install PyPDF2:

 $ pip install pypdf2
-

Usage

+

Usage

To use this module, you need to:

  1. go to your report
  2. select a PDF or image to use as watermark. Note that resolutions and size must match, otherwise you’ll have funny results
  3. You can also fill in an expression that returns the data (base64 encoded) to be used as watermark
+

To use the Company watermark, you need to:

+
    +
  1. go to settings –> company –> update info
    2. +
  2. upload an pdf watermark
    3. +
  3. go to settings –> technical –> reporting –> reports
    4. +
  4. Select the report where you want to use it.
    5. +
  5. On the ‘Advanced Properties’ tab of the notebook check ‘use company watermark’
    6. +
+

### Demo +And demo report is available (if you have demo data installed) on the users form view.

+
    +
  1. go to Configuration –> users
    2. +
  2. Select an users
    3. +
  3. Click the print button –> Watermark Demo report.
    4. +
-

Known issues / Roadmap

+

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

+

Changelog

+
+

15.0.1.0.0 (2022-01-11)

+
    +
  • [MIG] Migration to V15.
    • +
  • Define pdf watermark in company settings
    • +
+
-

Bug Tracker

+

Bug Tracker

Bugs are tracked on GitHub 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.

+feedback.

Do not contact contributors directly about support or help with technical issues.

-

Credits

+

Credits

-

Authors

+

Authors

  • Therp BV
-

Contributors

+

Contributors

-

Maintainers

+

Maintainers

This module is maintained by the OCA.

Odoo Community Association

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 project on GitHub.

+

This module is part of the OCA/reporting-engine project on GitHub.

You are welcome to contribute. To learn how please visit https://odoo-community.org/page/Contribute.