From 46ccecb6462d5e659dec30fac2a4381ea05ff3a0 Mon Sep 17 00:00:00 2001 From: Abraham Anes Date: Thu, 28 Mar 2019 13:40:28 +0100 Subject: [PATCH] [12.0][MIG] report_wkhtmltopdf_param --- report_wkhtmltopdf_param/README.rst | 67 ++- report_wkhtmltopdf_param/__manifest__.py | 2 +- .../readme/CONTRIBUTORS.rst | 2 + .../readme/DESCRIPTION.rst | 9 + report_wkhtmltopdf_param/readme/USAGE.rst | 4 + .../security/ir.model.access.csv | 1 + .../static/description/index.html | 438 ++++++++++++++++++ report_wkhtmltopdf_param/tests/__init__.py | 1 - .../tests/test_report_paperformat.py | 1 - 9 files changed, 500 insertions(+), 25 deletions(-) create mode 100644 report_wkhtmltopdf_param/readme/CONTRIBUTORS.rst create mode 100644 report_wkhtmltopdf_param/readme/DESCRIPTION.rst create mode 100644 report_wkhtmltopdf_param/readme/USAGE.rst create mode 100644 report_wkhtmltopdf_param/static/description/index.html diff --git a/report_wkhtmltopdf_param/README.rst b/report_wkhtmltopdf_param/README.rst index e8c3e546..2c616a82 100644 --- a/report_wkhtmltopdf_param/README.rst +++ b/report_wkhtmltopdf_param/README.rst @@ -1,11 +1,30 @@ -.. image:: https://img.shields.io/badge/licence-AGPL--3-blue.svg - :target: https://www.gnu.org/licenses/agpl-3.0-standalone.html - :alt: License: AGPL-3 - ======================== Report Wkhtmltopdf Param ======================== +.. !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! + !! This file is generated by oca-gen-addon-readme !! + !! changes will be overwritten. !! + !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! + +.. |badge1| image:: https://img.shields.io/badge/maturity-Beta-yellow.png + :target: https://odoo-community.org/page/development-status + :alt: Beta +.. |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/12.0/report_wkhtmltopdf_param + :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-12-0/reporting-engine-12-0-report_wkhtmltopdf_param + :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/12.0 + :alt: Try me on Runbot + +|badge1| |badge2| |badge3| |badge4| |badge5| + This module allows you to add new parameters for a paper format which are then forwarded to wkhtmltopdf command as arguments. To display the arguments that wkhtmltopdf accepts go to your command line and type 'wkhtmltopdf -H'. @@ -16,6 +35,10 @@ important when you intend to have a layout that conforms to certain alignment. It is very common whenever you need to conform the PDF to a predefined layoyut (e.g. checks, official forms,...). +**Table of contents** + +.. contents:: + :local: Usage ===== @@ -25,44 +48,44 @@ Usage #. Add additional parameters indicating the command argument name (remember to add prefix -- or -) and value. -.. image:: https://odoo-community.org/website/image/ir.attachment/5784_f2813bd/datas - :alt: Try me on Runbot - :target: https://runbot.odoo-community.org/runbot/143/11.0 - - 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. +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 `_. + +Do not contact contributors directly about support or help with technical issues. Credits ======= -Images ------- +Authors +~~~~~~~ -* Odoo Community Association: `Icon `_. +* Avoin.Systems +* Eficent Contributors ------------- +~~~~~~~~~~~~ * Miku Laitinen * Jordi Ballester -Maintainer ----------- +Maintainers +~~~~~~~~~~~ + +This module is maintained by the OCA. .. image:: https://odoo-community.org/logo.png :alt: Odoo Community Association :target: https://odoo-community.org -This module is maintained by the OCA. - 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. -To contribute to this module, please visit https://odoo-community.org. +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_wkhtmltopdf_param/__manifest__.py b/report_wkhtmltopdf_param/__manifest__.py index bcf291e2..bd0639be 100644 --- a/report_wkhtmltopdf_param/__manifest__.py +++ b/report_wkhtmltopdf_param/__manifest__.py @@ -4,7 +4,7 @@ # noinspection PyStatementEffect { "name": "Report Wkhtmltopdf Param", - "version": "11.0.1.0.1", + "version": "12.0.1.0.0", "license": "AGPL-3", "summary": """ Add new parameters for a paper format to be used by wkhtmltopdf diff --git a/report_wkhtmltopdf_param/readme/CONTRIBUTORS.rst b/report_wkhtmltopdf_param/readme/CONTRIBUTORS.rst new file mode 100644 index 00000000..48c8fed4 --- /dev/null +++ b/report_wkhtmltopdf_param/readme/CONTRIBUTORS.rst @@ -0,0 +1,2 @@ +* Miku Laitinen +* Jordi Ballester diff --git a/report_wkhtmltopdf_param/readme/DESCRIPTION.rst b/report_wkhtmltopdf_param/readme/DESCRIPTION.rst new file mode 100644 index 00000000..6fe296ad --- /dev/null +++ b/report_wkhtmltopdf_param/readme/DESCRIPTION.rst @@ -0,0 +1,9 @@ +This module allows you to add new parameters for a paper format which are +then forwarded to wkhtmltopdf command as arguments. To display the arguments +that wkhtmltopdf accepts go to your command line and type 'wkhtmltopdf -H'. + +A commonly used parameter in Odoo is *--disable-smart-shrinking*, that will +disable the automatic resizing of the PDF when converting. This is +important when you intend to have a layout that conforms to certain alignment. +It is very common whenever you need to conform the PDF to a predefined +layoyut (e.g. checks, official forms,...). diff --git a/report_wkhtmltopdf_param/readme/USAGE.rst b/report_wkhtmltopdf_param/readme/USAGE.rst new file mode 100644 index 00000000..b838ed44 --- /dev/null +++ b/report_wkhtmltopdf_param/readme/USAGE.rst @@ -0,0 +1,4 @@ +#. Go to *Settings* and press 'Activate the developer mode (with assets)' +#. Go to *Settings - Technical - Reports - Paper Format* +#. Add additional parameters indicating the command argument name (remember to + add prefix -- or -) and value. diff --git a/report_wkhtmltopdf_param/security/ir.model.access.csv b/report_wkhtmltopdf_param/security/ir.model.access.csv index 204dd15f..63fd8f7c 100644 --- a/report_wkhtmltopdf_param/security/ir.model.access.csv +++ b/report_wkhtmltopdf_param/security/ir.model.access.csv @@ -1,3 +1,4 @@ "id","name","model_id:id","group_id:id","perm_read","perm_write","perm_create","perm_unlink" "paperformat_parameter_access_portal","ir_actions_report_paperformat_parameter group_portal","model_report_paperformat_parameter","base.group_portal",1,0,0,0 "paperformat_parameter_access_employee","ir_actions_report_paperformat_parameter group_hr_user","model_report_paperformat_parameter",,1,0,1,0 +"paperformat_parameter_access_administration","ir_actions_report_paperformat_parameter group_system","model_report_paperformat_parameter","base.group_system",1,1,1,1 diff --git a/report_wkhtmltopdf_param/static/description/index.html b/report_wkhtmltopdf_param/static/description/index.html new file mode 100644 index 00000000..f9d47ae3 --- /dev/null +++ b/report_wkhtmltopdf_param/static/description/index.html @@ -0,0 +1,438 @@ + + + + + + +Report Wkhtmltopdf Param + + + +
+

Report Wkhtmltopdf Param

+ + +

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

+

This module allows you to add new parameters for a paper format which are +then forwarded to wkhtmltopdf command as arguments. To display the arguments +that wkhtmltopdf accepts go to your command line and type ‘wkhtmltopdf -H’.

+

A commonly used parameter in Odoo is –disable-smart-shrinking, that will +disable the automatic resizing of the PDF when converting. This is +important when you intend to have a layout that conforms to certain alignment. +It is very common whenever you need to conform the PDF to a predefined +layoyut (e.g. checks, official forms,…).

+

Table of contents

+ +
+

Usage

+
    +
  1. Go to Settings and press ‘Activate the developer mode (with assets)’
    2. +
  2. Go to Settings - Technical - Reports - Paper Format
    3. +
  3. Add additional parameters indicating the command argument name (remember to +add prefix – or -) and value.
    4. +
+
+
+

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.

+

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

+
+
+

Credits

+
+

Authors

+
    +
  • Avoin.Systems
    • +
  • Eficent
    • +
+
+
+

Contributors

+ +
+
+

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.

+

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

+
+
+
+ + diff --git a/report_wkhtmltopdf_param/tests/__init__.py b/report_wkhtmltopdf_param/tests/__init__.py index 5b86a660..c743f089 100644 --- a/report_wkhtmltopdf_param/tests/__init__.py +++ b/report_wkhtmltopdf_param/tests/__init__.py @@ -1,4 +1,3 @@ -# -*- coding: utf-8 -*- # Copyright 2017 Avoin.Systems # Copyright 2017 Eficent Business and IT Consulting Services, S.L. # License AGPL-3.0 or later (https://www.gnu.org/licenses/agpl). diff --git a/report_wkhtmltopdf_param/tests/test_report_paperformat.py b/report_wkhtmltopdf_param/tests/test_report_paperformat.py index 33c98799..f238ae1d 100644 --- a/report_wkhtmltopdf_param/tests/test_report_paperformat.py +++ b/report_wkhtmltopdf_param/tests/test_report_paperformat.py @@ -1,4 +1,3 @@ -# -*- coding: utf-8 -*- # Copyright 2017 Avoin.Systems # Copyright 2017 Eficent Business and IT Consulting Services, S.L. # License AGPL-3.0 or later (https://www.gnu.org/licenses/agpl).