|
| 1 | +=================== |
| 2 | +Report xlsx helpers |
| 3 | +=================== |
| 4 | + |
| 5 | +.. |
| 6 | + !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! |
| 7 | + !! This file is generated by oca-gen-addon-readme !! |
| 8 | + !! changes will be overwritten. !! |
| 9 | + !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! |
| 10 | + !! source digest: sha256:07e670ba3bc592076c782c24a73763641c491d37b4e44f75b894ea10315a47bb |
| 11 | + !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! |
| 12 | +
|
| 13 | +.. |badge1| image:: https://img.shields.io/badge/maturity-Mature-brightgreen.png |
| 14 | + :target: https://odoo-community.org/page/development-status |
| 15 | + :alt: Mature |
| 16 | +.. |badge2| image:: https://img.shields.io/badge/licence-AGPL--3-blue.png |
| 17 | + :target: http://www.gnu.org/licenses/agpl-3.0-standalone.html |
| 18 | + :alt: License: AGPL-3 |
| 19 | +.. |badge3| image:: https://img.shields.io/badge/github-OCA%2Freporting--engine-lightgray.png?logo=github |
| 20 | + :target: https://github.com/OCA/reporting-engine/tree/17.0/report_xlsx_helper |
| 21 | + :alt: OCA/reporting-engine |
| 22 | +.. |badge4| image:: https://img.shields.io/badge/weblate-Translate%20me-F47D42.png |
| 23 | + :target: https://translation.odoo-community.org/projects/reporting-engine-17-0/reporting-engine-17-0-report_xlsx_helper |
| 24 | + :alt: Translate me on Weblate |
| 25 | +.. |badge5| image:: https://img.shields.io/badge/runboat-Try%20me-875A7B.png |
| 26 | + :target: https://runboat.odoo-community.org/builds?repo=OCA/reporting-engine&target_branch=17.0 |
| 27 | + :alt: Try me on Runboat |
| 28 | + |
| 29 | +|badge1| |badge2| |badge3| |badge4| |badge5| |
| 30 | + |
| 31 | +This module provides a set of tools to facilitate the creation of excel |
| 32 | +reports with format xlsx. |
| 33 | + |
| 34 | +**Table of contents** |
| 35 | + |
| 36 | +.. contents:: |
| 37 | + :local: |
| 38 | + |
| 39 | +Installation |
| 40 | +============ |
| 41 | + |
| 42 | +This module requires report_xlsx version 13.0.1.0.0 or higher. |
| 43 | + |
| 44 | +Usage |
| 45 | +===== |
| 46 | + |
| 47 | +In order to create an Excel report you can define a report of type |
| 48 | +'xlsx' in a static or dynamic way: |
| 49 | + |
| 50 | +- Static syntax: cf. ``account_move_line_report_xls`` for an example. |
| 51 | +- Dynamic syntax: cf. ``report_xlsx_helper_demo`` for an example |
| 52 | + |
| 53 | +The ``AbstractReportXlsx`` class contains a number of attributes and |
| 54 | +methods to facilitate the creation excel reports in Odoo. |
| 55 | + |
| 56 | +- Cell types |
| 57 | + |
| 58 | + string, number, boolean, datetime. |
| 59 | + |
| 60 | +- Cell formats |
| 61 | + |
| 62 | + The predefined cell formats result in a consistent look and feel of |
| 63 | + the Odoo Excel reports. |
| 64 | + |
| 65 | +- Cell formulas |
| 66 | + |
| 67 | + Cell formulas can be easily added with the help of the |
| 68 | + ``_rowcol_to_cell()`` method. |
| 69 | + |
| 70 | +- Excel templates |
| 71 | + |
| 72 | + It is possible to define Excel templates which can be adapted by |
| 73 | + 'inherited' modules. Download the ``account_move_line_report_xls`` |
| 74 | + module from http://apps.odoo.com as example. |
| 75 | + |
| 76 | +- Excel with multiple sheets |
| 77 | + |
| 78 | + Download the ``account_asset_management_xls`` module from |
| 79 | + http://apps.odoo.com as example. |
| 80 | + |
| 81 | +Bug Tracker |
| 82 | +=========== |
| 83 | + |
| 84 | +Bugs are tracked on `GitHub Issues <https://github.com/OCA/reporting-engine/issues>`_. |
| 85 | +In case of trouble, please check there if your issue has already been reported. |
| 86 | +If you spotted it first, help us to smash it by providing a detailed and welcomed |
| 87 | +`feedback <https://github.com/OCA/reporting-engine/issues/new?body=module:%20report_xlsx_helper%0Aversion:%2017.0%0A%0A**Steps%20to%20reproduce**%0A-%20...%0A%0A**Current%20behavior**%0A%0A**Expected%20behavior**>`_. |
| 88 | + |
| 89 | +Do not contact contributors directly about support or help with technical issues. |
| 90 | + |
| 91 | +Credits |
| 92 | +======= |
| 93 | + |
| 94 | +Authors |
| 95 | +------- |
| 96 | + |
| 97 | +* Noviat |
| 98 | + |
| 99 | +Contributors |
| 100 | +------------ |
| 101 | + |
| 102 | +- Luc De Meyer <luc.demeyer@noviat.com> |
| 103 | + |
| 104 | +- Rattapong Chokmasermkul <rattapongc@ecosoft.co.th> |
| 105 | + |
| 106 | +- Saran Lim. <saranl@ecosoft.co.th> |
| 107 | + |
| 108 | +- `Sinerkia Innovación y Desarrollo S.L. <https://www.sinerkia.com>`__: |
| 109 | + |
| 110 | + - Luis Pomar |
| 111 | + |
| 112 | +Maintainers |
| 113 | +----------- |
| 114 | + |
| 115 | +This module is maintained by the OCA. |
| 116 | + |
| 117 | +.. image:: https://odoo-community.org/logo.png |
| 118 | + :alt: Odoo Community Association |
| 119 | + :target: https://odoo-community.org |
| 120 | + |
| 121 | +OCA, or the Odoo Community Association, is a nonprofit organization whose |
| 122 | +mission is to support the collaborative development of Odoo features and |
| 123 | +promote its widespread use. |
| 124 | + |
| 125 | +This module is part of the `OCA/reporting-engine <https://github.com/OCA/reporting-engine/tree/17.0/report_xlsx_helper>`_ project on GitHub. |
| 126 | + |
| 127 | +You are welcome to contribute. To learn how please visit https://odoo-community.org/page/Contribute. |
0 commit comments