OCA reporting engine fork for dev and update.
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

114 lines
3.7 KiB

7 years ago
7 years ago
7 years ago
7 years ago
6 years ago
7 years ago
7 years ago
7 years ago
7 years ago
7 years ago
  1. ===================
  2. Report xlsx helpers
  3. ===================
  4. .. !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
  5. !! This file is generated by oca-gen-addon-readme !!
  6. !! changes will be overwritten. !!
  7. !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
  8. .. |badge1| image:: https://img.shields.io/badge/maturity-Beta-yellow.png
  9. :target: https://odoo-community.org/page/development-status
  10. :alt: Beta
  11. .. |badge2| image:: https://img.shields.io/badge/licence-AGPL--3-blue.png
  12. :target: http://www.gnu.org/licenses/agpl-3.0-standalone.html
  13. :alt: License: AGPL-3
  14. .. |badge3| image:: https://img.shields.io/badge/github-OCA%2Freporting--engine-lightgray.png?logo=github
  15. :target: https://github.com/OCA/reporting-engine/tree/12.0/report_xlsx_helper
  16. :alt: OCA/reporting-engine
  17. .. |badge4| image:: https://img.shields.io/badge/weblate-Translate%20me-F47D42.png
  18. :target: https://translation.odoo-community.org/projects/reporting-engine-12-0/reporting-engine-12-0-report_xlsx_helper
  19. :alt: Translate me on Weblate
  20. .. |badge5| image:: https://img.shields.io/badge/runbot-Try%20me-875A7B.png
  21. :target: https://runbot.odoo-community.org/runbot/143/12.0
  22. :alt: Try me on Runbot
  23. |badge1| |badge2| |badge3| |badge4| |badge5|
  24. This module provides a set of tools to facilitate the creation of excel reports with format xlsx.
  25. **Table of contents**
  26. .. contents::
  27. :local:
  28. Installation
  29. ============
  30. This module requires report_xlsx version 11.0.1.0.3 or higher.
  31. Usage
  32. =====
  33. In order to create an Excel report you can define a report of type 'xlsx' in a static or dynamic way:
  34. * Static syntax: cf. ``account_move_line_report_xls`` for an example.
  35. * Dynamic syntax: cf. ``report_xlsx_helper_demo`` for an example
  36. The ``AbstractReportXlsx`` class contains a number of attributes and methods to
  37. facilitate the creation excel reports in Odoo.
  38. * Cell types
  39. string, number, boolean, datetime.
  40. * Cell formats
  41. The predefined cell formats result in a consistent
  42. look and feel of the Odoo Excel reports.
  43. * Cell formulas
  44. Cell formulas can be easily added with the help of the ``_rowcol_to_cell()`` method.
  45. * Excel templates
  46. It is possible to define Excel templates which can be adapted
  47. by 'inherited' modules.
  48. Download the ``account_move_line_report_xls`` module
  49. from http://apps.odoo.com as example.
  50. * Excel with multiple sheets
  51. Download the ``account_asset_management_xls`` module
  52. from http://apps.odoo.com as example.
  53. Bug Tracker
  54. ===========
  55. Bugs are tracked on `GitHub Issues <https://github.com/OCA/reporting-engine/issues>`_.
  56. In case of trouble, please check there if your issue has already been reported.
  57. If you spotted it first, help us smashing it by providing a detailed and welcomed
  58. `feedback <https://github.com/OCA/reporting-engine/issues/new?body=module:%20report_xlsx_helper%0Aversion:%2012.0%0A%0A**Steps%20to%20reproduce**%0A-%20...%0A%0A**Current%20behavior**%0A%0A**Expected%20behavior**>`_.
  59. Do not contact contributors directly about support or help with technical issues.
  60. Credits
  61. =======
  62. Authors
  63. ~~~~~~~
  64. * Noviat
  65. Contributors
  66. ~~~~~~~~~~~~
  67. * Luc De Meyer <luc.demeyer@noviat.com>
  68. Maintainers
  69. ~~~~~~~~~~~
  70. This module is maintained by the OCA.
  71. .. image:: https://odoo-community.org/logo.png
  72. :alt: Odoo Community Association
  73. :target: https://odoo-community.org
  74. OCA, or the Odoo Community Association, is a nonprofit organization whose
  75. mission is to support the collaborative development of Odoo features and
  76. promote its widespread use.
  77. This module is part of the `OCA/reporting-engine <https://github.com/OCA/reporting-engine/tree/12.0/report_xlsx_helper>`_ project on GitHub.
  78. You are welcome to contribute. To learn how please visit https://odoo-community.org/page/Contribute.