mirror of
https://github.com/OCA/reporting-engine.git
synced 2025-02-16 16:30:38 +02:00
[MIG] report_xml: Migration to 12.0
This commit is contained in:
@@ -1,15 +1,39 @@
|
||||
.. 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 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
|
||||
============
|
||||
|
||||
@@ -21,13 +45,16 @@ To install this module, you need to:
|
||||
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`_.
|
||||
|
||||
@@ -41,7 +68,7 @@ To develop with this module, you need to:
|
||||
|
||||
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.
|
||||
``_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 ``<template>`` id prepended by ``report.``, add a ``xsd()``
|
||||
@@ -56,35 +83,54 @@ For further information, please visit:
|
||||
* https://www.odoo.com/forum/help-1
|
||||
* https://github.com/OCA/reporting-engine
|
||||
|
||||
.. _custom report: https://www.odoo.com/documentation/12.0/reference/reports.html#custom-reports
|
||||
.. _instructions to create reports: https://www.odoo.com/documentation/12.0/reference/reports.html
|
||||
.. _sample module: https://github.com/OCA/reporting-engine/tree/12.0/report_xml_sample
|
||||
|
||||
Bug Tracker
|
||||
===========
|
||||
|
||||
Bugs are tracked on `GitHub Issues <https://github.com/OCA/reporting-engine/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 <https://github.com/OCA/reporting-engine/issues/new?body=module:%20report_xml%0Aversion:%2012.0%0A%0A**Steps%20to%20reproduce**%0A-%20...%0A%0A**Current%20behavior**%0A%0A**Expected%20behavior**>`_.
|
||||
|
||||
Do not contact contributors directly about support or help with technical issues.
|
||||
|
||||
Credits
|
||||
=======
|
||||
|
||||
* Icon taken from http://commons.wikimedia.org/wiki/File:Text-xml.svg.
|
||||
Authors
|
||||
~~~~~~~
|
||||
|
||||
* Tecnativa
|
||||
|
||||
Contributors
|
||||
------------
|
||||
~~~~~~~~~~~~
|
||||
|
||||
* Jairo Llopis <j.llopis@grupoesoc.es>
|
||||
* Enric Tobella <etobella@creublanca.es>
|
||||
* `Tecnativa <https://www.tecnativa.com>`_:
|
||||
|
||||
Maintainer
|
||||
----------
|
||||
Jairo Llopis
|
||||
|
||||
Other credits
|
||||
~~~~~~~~~~~~~
|
||||
|
||||
* Icon taken from http://commons.wikimedia.org/wiki/File:Text-xml.svg
|
||||
|
||||
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 https://odoo-community.org.
|
||||
This module is part of the `OCA/reporting-engine <https://github.com/OCA/reporting-engine/tree/12.0/report_xml>`_ project on GitHub.
|
||||
|
||||
|
||||
.. _custom report: https://www.odoo.com/documentation/8.0/reference/reports.html#custom-reports
|
||||
.. _instructions to create reports: https://www.odoo.com/documentation/8.0/reference/reports.html
|
||||
.. _reporting-engine: https://github.com/OCA/reporting-engine
|
||||
.. _sample module: https://github.com/OCA/reporting-engine/tree/8.0/report_xml_sample
|
||||
.. _lxml: http://lxml.de/
|
||||
You are welcome to contribute. To learn how please visit https://odoo-community.org/page/Contribute.
|
||||
|
||||
Reference in New Issue
Block a user