audrius/reporting-engine
1
0
Fork 1
mirror of https://github.com/OCA/reporting-engine.git synced 2025-02-16 16:30:38 +02:00
Code Issues Packages Projects Releases Wiki Activity

[UPD] README.rst

Browse Source
This commit is contained in:
OCA-git-bot
2023-04-04 17:50:04 +00:00
parent fa3c1b3526
commit f45c4c7775
2 changed files with 42 additions and 36 deletions
Download Patch File Download Diff File Expand all files Collapse all files

16
report_qweb_pdf_watermark/README.rst
View File

@@ -14,13 +14,13 @@ 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/15.0/report_qweb_pdf_watermark
:target: https://github.com/OCA/reporting-engine/tree/16.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-15-0/reporting-engine-15-0-report_qweb_pdf_watermark
:target: https://translation.odoo-community.org/projects/reporting-engine-16-0/reporting-engine-16-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/15.0
:target: https://runbot.odoo-community.org/runbot/143/16.0
:alt: Try me on Runbot
|badge1| |badge2| |badge3| |badge4| |badge5|
@@ -96,13 +96,18 @@ Changelog
* [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 smashing it by providing a detailed and welcomed
`feedback <https://github.com/OCA/reporting-engine/issues/new?body=module:%20report_qweb_pdf_watermark%0Aversion:%2015.0%0A%0A**Steps%20to%20reproduce**%0A-%20...%0A%0A**Current%20behavior**%0A%0A**Expected%20behavior**>`_.
`feedback <https://github.com/OCA/reporting-engine/issues/new?body=module:%20report_qweb_pdf_watermark%0Aversion:%2016.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.
@@ -123,6 +128,7 @@ Contributors
* Robin Goots <robin.goots@dynapps.be>
* Foram Shah <foram.shah@initos.com>
* Emiel van Bokhoven <emiel@360erp.nl>
* Anjeel Haria
Maintainers
~~~~~~~~~~~
@@ -137,6 +143,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/15.0/report_qweb_pdf_watermark>`_ project on GitHub.
This module is part of the `OCA/reporting-engine <https://github.com/OCA/reporting-engine/tree/16.0/report_qweb_pdf_watermark>`_ project on GitHub.
You are welcome to contribute. To learn how please visit https://odoo-community.org/page/Contribute.

62
report_qweb_pdf_watermark/static/description/index.html
View File

@@ -367,40 +367,40 @@ ul.auto-toc {
!! This file is generated by oca-gen-addon-readme !!
!! changes will be overwritten. !!
!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! -->
<p><a class="reference external" href="https://odoo-community.org/page/development-status"><img alt="Production/Stable" src="https://img.shields.io/badge/maturity-Production%2FStable-green.png" /></a> <a class="reference external" href="http://www.gnu.org/licenses/agpl-3.0-standalone.html"><img alt="License: AGPL-3" src="https://img.shields.io/badge/licence-AGPL--3-blue.png" /></a> <a class="reference external" href="https://github.com/OCA/reporting-engine/tree/16.0/report_qweb_pdf_watermark"><img alt="OCA/reporting-engine" src="https://img.shields.io/badge/github-OCA%2Freporting--engine-lightgray.png?logo=github" /></a> <a class="reference external" href="https://translation.odoo-community.org/projects/reporting-engine-15-0/reporting-engine-15-0-report_qweb_pdf_watermark"><img alt="Translate me on Weblate" src="https://img.shields.io/badge/weblate-Translate%20me-F47D42.png" /></a> <a class="reference external" href="https://runbot.odoo-community.org/runbot/143/16.0"><img alt="Try me on Runbot" src="https://img.shields.io/badge/runbot-Try%20me-875A7B.png" /></a></p>
<p><a class="reference external" href="https://odoo-community.org/page/development-status"><img alt="Production/Stable" src="https://img.shields.io/badge/maturity-Production%2FStable-green.png" /></a> <a class="reference external" href="http://www.gnu.org/licenses/agpl-3.0-standalone.html"><img alt="License: AGPL-3" src="https://img.shields.io/badge/licence-AGPL--3-blue.png" /></a> <a class="reference external" href="https://github.com/OCA/reporting-engine/tree/16.0/report_qweb_pdf_watermark"><img alt="OCA/reporting-engine" src="https://img.shields.io/badge/github-OCA%2Freporting--engine-lightgray.png?logo=github" /></a> <a class="reference external" href="https://translation.odoo-community.org/projects/reporting-engine-16-0/reporting-engine-16-0-report_qweb_pdf_watermark"><img alt="Translate me on Weblate" src="https://img.shields.io/badge/weblate-Translate%20me-F47D42.png" /></a> <a class="reference external" href="https://runbot.odoo-community.org/runbot/143/16.0"><img alt="Try me on Runbot" src="https://img.shields.io/badge/runbot-Try%20me-875A7B.png" /></a></p>
<p>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.</p>
<p><strong>Table of contents</strong></p>
<div class="contents local topic" id="contents">
<ul class="simple">
<li><a class="reference internal" href="#installation" id="id5">Installation</a></li>
<li><a class="reference internal" href="#usage" id="id6">Usage</a></li>
<li><a class="reference internal" href="#known-issues-roadmap" id="id7">Known issues / Roadmap</a></li>
<li><a class="reference internal" href="#changelog" id="id8">Changelog</a><ul>
<li><a class="reference internal" href="#id1" id="id9">12.0.1.0.0 (2019-11-18)</a></li>
<li><a class="reference internal" href="#id2" id="id10">13.0.1.0.0 (2021-01-27)</a></li>
<li><a class="reference internal" href="#id3" id="id11">14.0.1.0.0 (2021-01-29)</a></li>
<li><a class="reference internal" href="#id4" id="id12">15.0.1.0.0 (2022-01-11)</a></li>
<li><a class="reference internal" href="#id4" id="id13">16.0.1.0.0 (2023-03-13)</a></li>
<li><a class="reference internal" href="#installation" id="id6">Installation</a></li>
<li><a class="reference internal" href="#usage" id="id7">Usage</a></li>
<li><a class="reference internal" href="#known-issues-roadmap" id="id8">Known issues / Roadmap</a></li>
<li><a class="reference internal" href="#changelog" id="id9">Changelog</a><ul>
<li><a class="reference internal" href="#id1" id="id10">12.0.1.0.0 (2019-11-18)</a></li>
<li><a class="reference internal" href="#id2" id="id11">13.0.1.0.0 (2021-01-27)</a></li>
<li><a class="reference internal" href="#id3" id="id12">14.0.1.0.0 (2021-01-29)</a></li>
<li><a class="reference internal" href="#id4" id="id13">15.0.1.0.0 (2022-01-11)</a></li>
<li><a class="reference internal" href="#id5" id="id14">16.0.1.0.0 (2023-03-13)</a></li>
</ul>
</li>
<li><a class="reference internal" href="#bug-tracker" id="id14">Bug Tracker</a></li>
<li><a class="reference internal" href="#credits" id="id15">Credits</a><ul>
<li><a class="reference internal" href="#authors" id="id16">Authors</a></li>
<li><a class="reference internal" href="#contributors" id="id17">Contributors</a></li>
<li><a class="reference internal" href="#maintainers" id="id18">Maintainers</a></li>
<li><a class="reference internal" href="#bug-tracker" id="id15">Bug Tracker</a></li>
<li><a class="reference internal" href="#credits" id="id16">Credits</a><ul>
<li><a class="reference internal" href="#authors" id="id17">Authors</a></li>
<li><a class="reference internal" href="#contributors" id="id18">Contributors</a></li>
<li><a class="reference internal" href="#maintainers" id="id19">Maintainers</a></li>
</ul>
</li>
</ul>
</div>
<div class="section" id="installation">
<h1><a class="toc-backref" href="#id5">Installation</a></h1>
<h1><a class="toc-backref" href="#id6">Installation</a></h1>
<p>As PyPDF is not supported in python3, you need to install PyPDF2:</p>
<pre class="literal-block">
$ pip install pypdf2
</pre>
</div>
<div class="section" id="usage">
<h1><a class="toc-backref" href="#id6">Usage</a></h1>
<h1><a class="toc-backref" href="#id7">Usage</a></h1>
<p>To use this module, you need to:</p>
<ol class="arabic simple">
<li>go to your report</li>
@@ -424,61 +424,61 @@ And demo report is available (if you have demo data installed) on the users form
</ol>
</div>
<div class="section" id="known-issues-roadmap">
<h1><a class="toc-backref" href="#id7">Known issues / Roadmap</a></h1>
<h1><a class="toc-backref" href="#id8">Known issues / Roadmap</a></h1>
<p>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.</p>
</div>
<div class="section" id="changelog">
<h1><a class="toc-backref" href="#id8">Changelog</a></h1>
<h1><a class="toc-backref" href="#id9">Changelog</a></h1>
<div class="section" id="id1">
<h2><a class="toc-backref" href="#id9">12.0.1.0.0 (2019-11-18)</a></h2>
<h2><a class="toc-backref" href="#id10">12.0.1.0.0 (2019-11-18)</a></h2>
<ul class="simple">
<li>[MIG] Migration to V12.</li>
</ul>
</div>
<div class="section" id="id2">
<h2><a class="toc-backref" href="#id10">13.0.1.0.0 (2021-01-27)</a></h2>
<h2><a class="toc-backref" href="#id11">13.0.1.0.0 (2021-01-27)</a></h2>
<ul class="simple">
<li>[MIG] Migration to V13.</li>
</ul>
</div>
<div class="section" id="id3">
<h2><a class="toc-backref" href="#id11">14.0.1.0.0 (2021-01-29)</a></h2>
<h2><a class="toc-backref" href="#id12">14.0.1.0.0 (2021-01-29)</a></h2>
<ul class="simple">
<li>[MIG] Migration to V14.</li>
</ul>
</div>
<div class="section" id="id4">
<h2><a class="toc-backref" href="#id12">15.0.1.0.0 (2022-01-11)</a></h2>
<h2><a class="toc-backref" href="#id13">15.0.1.0.0 (2022-01-11)</a></h2>
<ul class="simple">
<li>[MIG] Migration to V15.</li>
<li>Define pdf watermark in company settings</li>
</ul>
</div>
<div class="section" id="id19">
<h2><a class="toc-backref" href="#id11">16.0.1.0.0 (2023-03-13)</a></h2>
<div class="section" id="id5">
<h2><a class="toc-backref" href="#id14">16.0.1.0.0 (2023-03-13)</a></h2>
<ul class="simple">
<li>[MIG] Migration to V16.</li>
</ul>
</div>
</div>
<div class="section" id="bug-tracker">
<h1><a class="toc-backref" href="#id13">Bug Tracker</a></h1>
<h1><a class="toc-backref" href="#id15">Bug Tracker</a></h1>
<p>Bugs are tracked on <a class="reference external" href="https://github.com/OCA/reporting-engine/issues">GitHub Issues</a>.
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
<a class="reference external" href="https://github.com/OCA/reporting-engine/issues/new?body=module:%20report_qweb_pdf_watermark%0Aversion:%2015.0%0A%0A**Steps%20to%20reproduce**%0A-%20...%0A%0A**Current%20behavior**%0A%0A**Expected%20behavior**">feedback</a>.</p>
<a class="reference external" href="https://github.com/OCA/reporting-engine/issues/new?body=module:%20report_qweb_pdf_watermark%0Aversion:%2016.0%0A%0A**Steps%20to%20reproduce**%0A-%20...%0A%0A**Current%20behavior**%0A%0A**Expected%20behavior**">feedback</a>.</p>
<p>Do not contact contributors directly about support or help with technical issues.</p>
</div>
<div class="section" id="credits">
<h1><a class="toc-backref" href="#id14">Credits</a></h1>
<h1><a class="toc-backref" href="#id16">Credits</a></h1>
<div class="section" id="authors">
<h2><a class="toc-backref" href="#id15">Authors</a></h2>
<h2><a class="toc-backref" href="#id17">Authors</a></h2>
<ul class="simple">
<li>Therp BV</li>
</ul>
</div>
<div class="section" id="contributors">
<h2><a class="toc-backref" href="#id16">Contributors</a></h2>
<h2><a class="toc-backref" href="#id18">Contributors</a></h2>
<ul class="simple">
<li>Holger Brunn &lt;<a class="reference external" href="mailto:hbrunn&#64;therp.nl">hbrunn&#64;therp.nl</a>&gt;</li>
<li>Stefan Rijnhart &lt;<a class="reference external" href="mailto:stefan&#64;opener.am">stefan&#64;opener.am</a>&gt;</li>
@@ -490,7 +490,7 @@ If you spotted it first, help us smashing it by providing a detailed and welcome
</ul>
</div>
<div class="section" id="maintainers">
<h2><a class="toc-backref" href="#id17">Maintainers</a></h2>
<h2><a class="toc-backref" href="#id19">Maintainers</a></h2>
<p>This module is maintained by the OCA.</p>
<a class="reference external image-reference" href="https://odoo-community.org"><img alt="Odoo Community Association" src="https://odoo-community.org/logo.png" /></a>
<p>OCA, or the Odoo Community Association, is a nonprofit organization whose