From 886df9d22eed0f058910dac44e1e488f0bc9cf79 Mon Sep 17 00:00:00 2001 From: OCA Git Bot Date: Tue, 2 Oct 2018 05:23:59 +0200 Subject: [PATCH] [UPD] README.rst --- report_xlsx_helper/README.rst | 84 ++-- .../static/description/index.html | 457 ++++++++++++++++++ 2 files changed, 512 insertions(+), 29 deletions(-) create mode 100644 report_xlsx_helper/static/description/index.html diff --git a/report_xlsx_helper/README.rst b/report_xlsx_helper/README.rst index 142bdfdf..70106b5a 100644 --- a/report_xlsx_helper/README.rst +++ b/report_xlsx_helper/README.rst @@ -1,13 +1,42 @@ -.. image:: https://img.shields.io/badge/license-AGPL--3-blue.png - :target: https://www.gnu.org/licenses/agpl - :alt: License: AGPL-3 - -=========================== -Excel report engine helpers -=========================== +=================== +Report xlsx helpers +=================== + +.. !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! + !! 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/11.0/report_xlsx_helper + :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_xlsx_helper + :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 + +|badge1| |badge2| |badge3| |badge4| |badge5| This module provides a set of tools to facilitate the creation of excel reports with format xlsx. +**Table of contents** + +.. contents:: + :local: + +Installation +============ + +This module requires report_xlsx version 11.0.1.0.3 or higher. + Usage ===== @@ -44,45 +73,42 @@ facilitate the creation excel reports in Odoo. Download the ``account_asset_management_xls`` module from http://apps.odoo.com as example. -Installation -============ - -This module requires report_xlsx version 11.0.1.0.3 or higher. - -Configuration and Usage -======================= - -.. 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 ======= +Authors +~~~~~~~ + +* Noviat + Contributors ------------- +~~~~~~~~~~~~ * Luc De Meyer -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 http://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_xlsx_helper/static/description/index.html b/report_xlsx_helper/static/description/index.html new file mode 100644 index 00000000..1b69bbab --- /dev/null +++ b/report_xlsx_helper/static/description/index.html @@ -0,0 +1,457 @@ + + + + + + +Report xlsx helpers + + + +
+

Report xlsx helpers

+ + +

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

+

This module provides a set of tools to facilitate the creation of excel reports with format xlsx.

+

Table of contents

+ +
+

Installation

+

This module requires report_xlsx version 11.0.1.0.3 or higher.

+
+
+

Usage

+

In order to create an Excel report you can define a report of type ‘xlsx’ in a static or dynamic way:

+
    +
  • Static syntax: cf. account_move_line_report_xls for an example.
    • +
  • Dynamic syntax: cf. report_xlsx_helper_demo for an example
    • +
+

The AbstractReportXlsx class contains a number of attributes and methods to +facilitate the creation excel reports in Odoo.

+
    +

  • Cell types

    +

    string, number, boolean, datetime.

    +
    • +

  • Cell formats

    +

    The predefined cell formats result in a consistent +look and feel of the Odoo Excel reports.

    +
    • +

  • Cell formulas

    +

    Cell formulas can be easily added with the help of the _rowcol_to_cell() method.

    +
    • +

  • Excel templates

    +

    It is possible to define Excel templates which can be adapted +by ‘inherited’ modules. +Download the account_move_line_report_xls module +from http://apps.odoo.com as example.

    +
    • +

  • Excel with multiple sheets

    +

    Download the account_asset_management_xls module +from http://apps.odoo.com as example.

    +
    • +
+
+
+

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

+
    +
  • Noviat
    • +
+
+
+

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.

+
+
+
+ +