From 1c4b3ae39a43efc976d619d0775619d001def84d Mon Sep 17 00:00:00 2001 From: OCA-git-bot Date: Sun, 19 Jul 2020 22:25:20 +0000 Subject: [PATCH] [UPD] README.rst --- report_qweb_txt/README.rst | 98 +++- report_qweb_txt/static/description/index.html | 432 ++++++++++++++++++ 2 files changed, 514 insertions(+), 16 deletions(-) create mode 100644 report_qweb_txt/static/description/index.html diff --git a/report_qweb_txt/README.rst b/report_qweb_txt/README.rst index 21cd7854d..56f8f1631 100644 --- a/report_qweb_txt/README.rst +++ b/report_qweb_txt/README.rst @@ -1,21 +1,87 @@ -**This file is going to be generated by oca-gen-addon-readme.** +================= +Qweb Text Reports +================= -*Manual changes will be overwritten.* +.. !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! + !! This file is generated by oca-gen-addon-readme !! + !! changes will be overwritten. !! + !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! -Please provide content in the ``readme`` directory: +.. |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/11.0/report_qweb_txt + :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-11-0/reporting-engine-11-0-report_qweb_txt + :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/11.0 + :alt: Try me on Runbot -* **DESCRIPTION.rst** (required) -* INSTALL.rst (optional) -* CONFIGURE.rst (optional) -* **USAGE.rst** (optional, highly recommended) -* DEVELOP.rst (optional) -* ROADMAP.rst (optional) -* HISTORY.rst (optional, recommended) -* **CONTRIBUTORS.rst** (optional, highly recommended) -* CREDITS.rst (optional) +|badge1| |badge2| |badge3| |badge4| |badge5| -Content of this README will also be drawn from the addon manifest, -from keys such as name, authors, maintainers, development_status, -and license. +This module extends the possibilities of the native Qweb reporting engine +to be able to generate any kind of text files (TXT, CSV, ZPL, EPL, ...). -A good, one sentence summary in the manifest is also highly recommended. +**Table of contents** + +.. contents:: + :local: + +Usage +===== + +To add a text report, you should develop an Odoo module that contains: + +* a Qweb template, +* a Qweb report definition with *report_type = qweb-txt*. + +This module provides a small demo report on *Users* called *CSV List*. + +The module *purchase_dilicom_csv* available on the `dilicom Github repository `_ (branch *10.0*) is a better example: it adds a report *Dilicom CSV Order* on purchase orders. This report is a CSV file with one line per order line and 2 columns: EAN13 and order quantity. + +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 +~~~~~~~ + +* Akretion + +Contributors +~~~~~~~~~~~~ + +* Alexis de Lattre +* Daniel Reis + +Maintainers +~~~~~~~~~~~ + +This module is maintained by the OCA. + +.. image:: https://odoo-community.org/logo.png + :alt: Odoo Community Association + :target: https://odoo-community.org + +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_qweb_txt/static/description/index.html b/report_qweb_txt/static/description/index.html new file mode 100644 index 000000000..a8bc41cad --- /dev/null +++ b/report_qweb_txt/static/description/index.html @@ -0,0 +1,432 @@ + + + + + + +Qweb Text Reports + + + +
+

Qweb Text Reports

+ + +

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

+

This module extends the possibilities of the native Qweb reporting engine +to be able to generate any kind of text files (TXT, CSV, ZPL, EPL, …).

+

Table of contents

+ +
+

Usage

+

To add a text report, you should develop an Odoo module that contains:

+
    +
  • a Qweb template,
    • +
  • a Qweb report definition with report_type = qweb-txt.
    • +
+

This module provides a small demo report on Users called CSV List.

+

The module purchase_dilicom_csv available on the dilicom Github repository (branch 10.0) is a better example: it adds a report Dilicom CSV Order on purchase orders. This report is a CSV file with one line per order line and 2 columns: EAN13 and order quantity.

+
+
+

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

+
    +
  • Akretion
    • +
+
+ +
+

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.

+
+
+
+ +