[17.0][MIG] report_qweb_pdf_watermark #841
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -17,18 +17,22 @@ Pdf watermark | |
| :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/17.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-17-0/reporting-engine-17-0-report_qweb_pdf_watermark | ||
| :alt: Translate me on Weblate | ||
| .. |badge5| image:: https://img.shields.io/badge/runboat-Try%20me-875A7B.png | ||
| :target: https://runboat.odoo-community.org/builds?repo=OCA/reporting-engine&target_branch=17.0 | ||
| :alt: Try me on Runboat | ||
|
|
||
| |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** | ||
|
|
||
|
|
@@ -38,103 +42,106 @@ This module was written to add watermarks (backgrounds) to PDF reports. Because | |
| Installation | ||
| ============ | ||
|
|
||
| As PyPDF is not supported in python3, you need to install PyPDF2: | ||
|
|
||
| :: | ||
|
|
||
| $ pip install pypdf2 | ||
|
|
||
| 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. upload an pdf watermark | ||
| 3. go to settings --> technical --> reporting --> reports | ||
| 4. Select the report where you want to use it. | ||
| 5. 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. | ||
|
|
||
| 1. go to Configuration --> users | ||
| 2. Select an users | ||
| 3. Click the print button --> Watermark Demo report. | ||
|
|
||
| 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. | ||
|
|
||
| 15.0.1.0.0 (2022-01-11) | ||
| ----------------------- | ||
|
|
||
| - [MIG] Migration to V15. | ||
| - Define pdf watermark in company settings | ||
|
|
||
| 16.0.1.0.0 (2023-03-13) | ||
| ----------------------- | ||
|
|
||
| - [MIG] Migration to V16. | ||
|
|
||
| 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 to smash it by providing a detailed and welcomed | ||
| `feedback <https://github.com/OCA/reporting-engine/issues/new?body=module:%20report_qweb_pdf_watermark%0Aversion:%2017.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 <[email protected]> | ||
| - Stefan Rijnhart <[email protected]> | ||
| - Rod Schouteden <[email protected]> | ||
| - Robin Goots <[email protected]> | ||
| - Foram Shah <[email protected]> | ||
| - Emiel van Bokhoven <[email protected]> | ||
| - Anjeel Haria | ||
|
|
||
| Maintainers | ||
| ----------- | ||
|
|
||
| This module is maintained by the OCA. | ||
|
|
||
|
|
@@ -146,6 +153,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 <https://github.com/OCA/reporting-engine/tree/17.0/report_qweb_pdf_watermark>`_ project on GitHub. | ||
|
|
||
| You are welcome to contribute. To learn how please visit https://odoo-community.org/page/Contribute. | ||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,3 @@ | ||
| [build-system] | ||
| requires = ["whool"] | ||
| build-backend = "whool.buildapi" |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,7 @@ | ||
| - Holger Brunn \<<[email protected]>\> | ||
| - Stefan Rijnhart \<<[email protected]>\> | ||
| - Rod Schouteden \<<[email protected]>\> | ||
| - Robin Goots \<<[email protected]>\> | ||
| - Foram Shah \<<[email protected]>\> | ||
| - Emiel van Bokhoven \<<[email protected]>\> | ||
| - Anjeel Haria |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,5 @@ | ||
| 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. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,20 @@ | ||
| ## 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. | ||
|
|
||
| ## 15.0.1.0.0 (2022-01-11) | ||
|
|
||
| - \[MIG\] Migration to V15. | ||
| - Define pdf watermark in company settings | ||
|
|
||
| ## 16.0.1.0.0 (2023-03-13) | ||
|
|
||
| - \[MIG\] Migration to V16. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,4 +1,3 @@ | ||
| As PyPDF is not supported in python3, you need to install PyPDF2: | ||
|
|
||
| $ pip install pypdf2 |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,3 @@ | ||
| 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. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,23 @@ | ||
| 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. upload an pdf watermark | ||
| 3. go to settings --\> technical --\> reporting --\> reports | ||
| 4. Select the report where you want to use it. | ||
| 5. 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. | ||
|
|
||
| 1. go to Configuration --\> users | ||
| 2. Select an users | ||
| 3. Click the print button --\> Watermark Demo report. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Check this