diff --git a/report_xml/README.rst b/report_xml/README.rst new file mode 100644 index 00000000..a1c07f16 --- /dev/null +++ b/report_xml/README.rst @@ -0,0 +1,87 @@ +.. image:: https://img.shields.io/badge/licence-AGPL--3-blue.svg + :target: https://www.gnu.org/licenses/agpl-3.0-standalone.html + :alt: License: AGPL-3 + +=========== +XML Reports +=========== + +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. + +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. + +Usage +===== + +If you are a user +----------------- + +You will be able to download XML reports from the *Print* menu found on form +and list views. + +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 +``render_html``, 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 ``