From 8788fc1f5dc884740f5799b485d048feba816b47 Mon Sep 17 00:00:00 2001 From: OCA-git-bot Date: Sat, 18 Mar 2023 18:00:06 +0000 Subject: [PATCH] [UPD] README.rst --- report_label/README.rst | 65 +++++++++++++++------- report_label/static/description/index.html | 53 ++++++++++++------ 2 files changed, 81 insertions(+), 37 deletions(-) diff --git a/report_label/README.rst b/report_label/README.rst index 7fffe66b2..e8d633755 100644 --- a/report_label/README.rst +++ b/report_label/README.rst @@ -14,13 +14,13 @@ Report Labels :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_label + :target: https://github.com/OCA/reporting-engine/tree/16.0/report_label :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_label + :target: https://translation.odoo-community.org/projects/reporting-engine-16-0/reporting-engine-16-0-report_label :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/16.0 :alt: Try me on Runbot |badge1| |badge2| |badge3| |badge4| |badge5| @@ -35,39 +35,64 @@ This module allows you to create self-adhesive label printing actions on any mod Configuration ============= -Go to **Settings > Technical > Analysis > Label Paper Format** and create -your self-adhesive label paper formats. +**Configure your Report Label Paperformat** -.. image:: https://raw.githubusercontent.com/OCA/reporting-engine/14.0/report_label/static/description/configure_paperformat.png +* Go to "Settings > Technical > Reporting > Label Paper Format" -Go to **Settings > Technical > Analysis > Label Report** and create your label -report, and its context action. You'll also need to create or reuse a -QWeb template for you label. +* Create your self-adhesive label paper formats. -.. image:: https://raw.githubusercontent.com/OCA/reporting-engine/14.0/report_label/static/description/configure_report_label.png +You should reuse or create a Paperformat. + +.. image:: https://raw.githubusercontent.com/OCA/reporting-engine/16.0/report_label/static/description/report_paperformat_label_form.png + +**Configure your Server action** + +* Go to "Settings > Technical > Actions > Server Actions" + +Create your label report : + +* In the 'Action to do' field, select 'Print Self-adhesive Labels' + +* In the 'Label Paper Format' field, select your label paper format previously created + +* In the 'Label Qweb Template' create or reuse a QWeb template for your label. + +.. image:: https://raw.githubusercontent.com/OCA/reporting-engine/16.0/report_label/static/description/ir_actions_server.png + +**Importante Note** + +`By design `_, the variable used in this QWeb template must be named `record`. Usage ===== -1. In the target model's tree view, select the records to print. -2. Click *Action* and your label report action name. -3. Select the number of labels per record to print, and click Print. +* In the target model's tree view, select the records to print. +* Click *Action* and your label report action name. +* Select the number of labels per record to print, and click Print. -.. image:: https://raw.githubusercontent.com/OCA/reporting-engine/14.0/report_label/static/description/label_wizard.png +you can optionaly define an offset + +.. image:: https://raw.githubusercontent.com/OCA/reporting-engine/16.0/report_label/static/description/report_label_wizard_form.png + +The items will be printed in a pdf document. + +.. image:: https://raw.githubusercontent.com/OCA/reporting-engine/16.0/report_label/static/description/report_result.png Known issues / Roadmap ====================== Known issues: -* `wkhtmltopdf` doesn't always respect dpi, and mm measures don't match. For - this matter, it's recommended to use this module along with - `report_wkhtmltopdf_param` and enable `--disable-smart-shrinking`. - * This module depends on `base_automation` only because this module extends `ir.actions.server` with a new kind of action, and `base.automation` inherits from `ir.actions.server` by delegation in such a way that the modules cannot be loaded in another order. + To do when migrating in version > 16 : + 1. remove ``base_automation`` dependency + 2. install ``report_label`` + 3. install then ``base_automation``. + If the installation of ``base_automation`` works, the dependency can be + replaced by ``base``. Bug Tracker =========== @@ -75,7 +100,7 @@ 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. @@ -120,6 +145,6 @@ Current `maintainer `__: |maintainer-ivantodorovich| -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_label/static/description/index.html b/report_label/static/description/index.html index db91a1002..ba3602880 100644 --- a/report_label/static/description/index.html +++ b/report_label/static/description/index.html @@ -367,7 +367,7 @@ 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

+

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

This module allows you to create self-adhesive label printing actions on any model.

Table of contents

@@ -386,34 +386,53 @@ ul.auto-toc {

Configuration

-

Go to Settings > Technical > Analysis > Label Paper Format and create -your self-adhesive label paper formats.

-https://raw.githubusercontent.com/OCA/reporting-engine/14.0/report_label/static/description/configure_paperformat.png -

Go to Settings > Technical > Analysis > Label Report and create your label -report, and its context action. You’ll also need to create or reuse a -QWeb template for you label.

-https://raw.githubusercontent.com/OCA/reporting-engine/14.0/report_label/static/description/configure_report_label.png +

Configure your Report Label Paperformat

+
    +
  • Go to “Settings > Technical > Reporting > Label Paper Format”
    • +
  • Create your self-adhesive label paper formats.
    • +
+

You should reuse or create a Paperformat.

+https://raw.githubusercontent.com/OCA/reporting-engine/16.0/report_label/static/description/report_paperformat_label_form.png +

Configure your Server action

+
    +
  • Go to “Settings > Technical > Actions > Server Actions”
    • +
+

Create your label report :

+
    +
  • In the ‘Action to do’ field, select ‘Print Self-adhesive Labels’
    • +
  • In the ‘Label Paper Format’ field, select your label paper format previously created
    • +
  • In the ‘Label Qweb Template’ create or reuse a QWeb template for your label.
    • +
+https://raw.githubusercontent.com/OCA/reporting-engine/16.0/report_label/static/description/ir_actions_server.png +

Importante Note

+

By design, the variable used in this QWeb template must be named record.

Usage

-
    +
    • In the target model’s tree view, select the records to print.
    • Click Action and your label report action name.
    • Select the number of labels per record to print, and click Print.
      • -
-https://raw.githubusercontent.com/OCA/reporting-engine/14.0/report_label/static/description/label_wizard.png + +

you can optionaly define an offset

+https://raw.githubusercontent.com/OCA/reporting-engine/16.0/report_label/static/description/report_label_wizard_form.png +

The items will be printed in a pdf document.

+https://raw.githubusercontent.com/OCA/reporting-engine/16.0/report_label/static/description/report_result.png

Known issues / Roadmap

Known issues:

    -
  • wkhtmltopdf doesn’t always respect dpi, and mm measures don’t match. For -this matter, it’s recommended to use this module along with -report_wkhtmltopdf_param and enable –disable-smart-shrinking.
  • This module depends on base_automation only because this module extends ir.actions.server with a new kind of action, and base.automation inherits from ir.actions.server by delegation in such a way that the modules cannot -be loaded in another order.
    • +be loaded in another order. +To do when migrating in version > 16 : +1. remove base_automation dependency +2. install report_label +3. install then base_automation. +If the installation of base_automation works, the dependency can be +replaced by base.
@@ -421,7 +440,7 @@ be loaded in another order.

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.

@@ -460,7 +479,7 @@ mission is to support the collaborative development of Odoo features and promote its widespread use.

Current maintainer:

ivantodorovich

-

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.