diff --git a/report_xml/README.rst b/report_xml/README.rst new file mode 100644 index 00000000..f73c8204 --- /dev/null +++ b/report_xml/README.rst @@ -0,0 +1,136 @@ +=========== +XML Reports +=========== + +.. !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! + !! 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/12.0/report_xml + :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-12-0/reporting-engine-12-0-report_xml + :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/12.0 + :alt: Try me on Runbot + +|badge1| |badge2| |badge3| |badge4| |badge5| + +This module was written to extend the functionality of the reporting engine to +support XML reports and allow modules to generate them by code or by QWeb +templates. + +**Table of contents** + +.. contents:: + :local: + +Installation +============ + +To install this module, you need to: + +* Install lxml_ in Odoo's ``$PYTHONPATH``. +* Install the repository `reporting-engine`_. + +But this module does nothing for the end user by itself, so if you have it +installed it's probably because there is another module that depends on it. + +.. _reporting-engine: https://github.com/OCA/reporting-engine +.. _lxml: http://lxml.de/ + +Usage +===== + +This module is intended as a base engine for other modules to use it, so no direct result if you are a user. + +If you are a developer +~~~~~~~~~~~~~~~~~~~~~~ + +To learn from an example, just check the `sample module`_. + +To develop with this module, you need to: + +* Create a module. +* Make it depend on this one. +* Follow `instructions to create reports`_ having in mind that the + ``report_type`` field in your ``ir.actions.report.xml`` record must be + ``qweb-xml``. + +In case you want to create a `custom report`_, the instructions remain the same +as for HTML reports, and the method that you must override is also called +``_get_report_values``, even when this time you are creating a XML report. + +You can make your custom report inherit ``report_xml.xsd_checked_report``, name +it like your XML ``