Small usability improvements

Replace README.md by README.rst (not finished)
8 years ago · b6faa590b2
10 changed files with 130 additions and 57 deletions
--- a/report_py3o/README.md
+++ b/report_py3o/README.md
@ -1,18 +0,0 @@
-### README ###
-
-
-### LibreOffice Report Engine for Odoo/OpenERP ###
-
-
-This module allows you to convert any type of report into LibreOffice/OpenOffice.
-The benefits is that you have control over your documents and you can 
-modify them as needed.
-
-
-Requirements
-============
-
-The py3o.template package is required; install it with:
-    easy_install -UZ py3o.template
-
-
--- a/report_py3o/README.rst
+++ b/report_py3o/README.rst
@ -0,0 +1,94 @@
+.. image:: https://img.shields.io/badge/licence-AGPL--3-blue.svg
+   :target: http://www.gnu.org/licenses/agpl-3.0-standalone.html
+   :alt: License: AGPL-3
+
+===========
+Report Py3o
+===========
+
+The py3o reporting engine is a reporting engine for Odoo based on `Libreoffice <http://www.libreoffice.org/>`_:
+
+* the report is created with Libreoffice (ODT or ODS),
+* the report is stored on the server in OpenDocument format (.odt or .ods file)
+* the report is sent to the user in OpenDocument format or in any output format supported by Libreoffice (PDF, HTML, DOC, DOCX, Docbook, XLS, etc.)
+
+The key advantages of a Libreoffice-based reporting engine are:
+
+* no need to be a developper to create or modify a report: the report is created and modified with Libreoffice. So this reporting engine has a fully WYSIWYG report developpment tool!
+
+* For a PDF report in A4/Letter format, it's easier to develop it with a tool such as Libreoffice that is designed to create A4/Letter documents than to develop it in HTML/CSS.
+
+* If you want your users to be able to modify the document after its generation by Odoo, just configure the document with ODT output (or DOC or DOCX) and the user will be able to modify the document with Libreoffice (or Word) after its generation by Odoo.
+
+* Easy development of spreadsheet reports in ODS format (XLS output possible).
+
+This reporting engine is an alternative to `Aeroo <https://github.com/aeroo/aeroo_reports>`_: these 2 reporting engines have similar features but their codes are completely different.
+
+Installation
+============
+
+You must install 2 additionnal python libs:
+
+.. code::
+
+  pip install py3o.template
+  pip install py3o.formats
+
+If you want to convert the ODT or ODS report in another format, you need several additionnal components and Python libs:
+
+* `Py3o Fusion server <https://bitbucket.org/faide/py3o.fusion>`_
+* `Py3o render server <https://bitbucket.org/faide/py3o.renderserver>`_
+* Libreoffice started in the background in headless mode.
+
+TODO : continue
+
+Configuration
+=============
+
+If you want to convert the report in another format, go to the menu *Configuration > Technical > Reports > Py3o > Py3o Servers* and create a new Py3o server with its URL (for example:  http://localhost:8765/form).
+
+TODO: continue
+
+Usage
+=====
+
+.. image:: https://odoo-community.org/website/image/ir.attachment/5784_f2813bd/datas
+   :alt: Try me on Runbot
+   :target: https://runbot.odoo-community.org/runbot/143/9.0
+
+Known issues / Roadmap
+======================
+
+* generate barcode ?
+
+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.
+
+Credits
+=======
+
+Contributors
+------------
+
+* Florent Aide (`XCG Consulting <http://odoo.consulting/>`_)
+* Laurent Mignon (Acsone)
+
+Maintainer
+----------
+
+.. 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.
--- a/report_py3o/openerp.py
+++ b/report_py3o/openerp.py
@ -3,20 +3,16 @@
 # License AGPL-3.0 or later (http://www.gnu.org/licenses/agpl).
 {
    'name': 'LibreOffice Report Engine',
-    'description': '''
-Generation of LibreOffice/OpenOffice reports using LibreOffice/OpenOffice
-templates.
-
-The py3o.template package is required; install it with:
-    pip install py3o.template
-''',
+    'summary': 'Reporting engine based on Libreoffice (ODT -> ODT, '
+               'ODT -> PDF, ODT -> DOC, ODT -> DOCX, ODS -> ODS, etc.)',
    'version': '9.0.1.0.0',
    'category': 'Reporting',
-    'author': 'XCG Consulting',
+    'license': 'AGPL-3',
+    'author': 'XCG Consulting,Odoo Community Association (OCA)',
    'website': 'http://odoo.consulting/',
    'depends': [
        'base',
-        'report'
+        'report',
    ],
    'external_dependencies': {
        'python': ['py3o.template',
--- a/report_py3o/models/ir_report.py
+++ b/report_py3o/models/ir_report.py
@ -55,14 +55,14 @@ class ReportXml(models.Model):
        'py3o.template',
        "Template")
    py3o_is_local_fusion = fields.Boolean(
-        "Local fusion",
+        "Local Fusion",
        help="Native formats will be processed without a server. "
             "You must use this mode if you call methods on your model into "
             "the template.",
        default=True)
    py3o_server_id = fields.Many2one(
        "py3o.server",
-        "Fusion server")
+        "Fusion Server")
    module = fields.Char(
        "Module",
        help="The implementer module that provides this report")
--- a/report_py3o/models/py3o_server.py
+++ b/report_py3o/models/py3o_server.py
@ -6,6 +6,10 @@ from openerp import fields, models

 class Py3oServer(models.Model):
    _name = 'py3o.server'
+    _rec_name = 'url'

-    url = fields.Char("URL", required=True)
+    url = fields.Char(
+        "Py3o Fusion Server URL", required=True,
+        help="If your Py3o Fusion server is on the same machine and runs "
+        "on the default port, the URL is http://localhost:8765/form")
    is_active = fields.Boolean("Active", default=True)
--- a/report_py3o/models/py3o_template.py
+++ b/report_py3o/models/py3o_template.py
@ -8,7 +8,7 @@ class Py3oTemplate(models.Model):
    _name = 'py3o.template'

    name = fields.Char(required=True)
-    py3o_template_data = fields.Binary("LibreOffice template")
+    py3o_template_data = fields.Binary("LibreOffice Template")
    filetype = fields.Selection(
        selection=[
            ('odt', "ODF Text Document"),
--- a/report_py3o/views/ir_report.xml
+++ b/report_py3o/views/ir_report.xml
@ -1,3 +1,4 @@
+<?xml version="1.0" encoding="utf-8"?>
 <odoo>
    <data>

@ -10,7 +11,7 @@
            <field name="arch" type="xml">

                <xpath expr="//page[@name='security']" position="before">
-                    <page string="LibreOffice template"
+                    <page string="LibreOffice Template"
                        attrs="{'invisible': [('report_type', '!=', 'py3o')]}">

                        <group>
--- a/report_py3o/views/py3o_server.xml
+++ b/report_py3o/views/py3o_server.xml
@ -5,13 +5,11 @@
            <field name="name">py3o.server.configuration.form.view</field>
            <field name="model">py3o.server</field>
            <field name="arch" type="xml">
-                <form string="Py3o Server Configuration" version="7.0">
-                    <sheet>
-                        <group>
-                            <field name="url" />
-                            <field name="is_active" />
-                        </group>
-                    </sheet>
+                <form string="Py3o Server Configuration">
+                    <group>
+                        <field name="url" widget="url"/>
+                        <field name="is_active" />
+                    </group>
                </form>
            </field>
        </record>
@ -20,7 +18,7 @@
            <field name="name">py3o.server.configuration.tree.view</field>
            <field name="model">py3o.server</field>
            <field name="arch" type="xml">
-                <tree string="Py3o Server Configuration" version="7.0">
+                <tree string="Py3o Servers Configuration">
                    <field name="url" />
                    <field name="is_active" />
                </tree>
@ -28,14 +26,12 @@
        </record>

        <record id="py3o_server_configuration_action" model="ir.actions.act_window">
-            <field name="name">py3o.server.configuration.action</field>
+            <field name="name">Py3o Servers</field>
            <field name="res_model">py3o.server</field>
-            <field name="view_type">form</field>
            <field name="view_mode">tree,form</field>
        </record>

        <menuitem id="py3o_server_configuration_menu"
-            name="Py3o Server Configuration"
            parent="py3o_config_menu"
            action="py3o_server_configuration_action" />
    </data>
--- a/report_py3o/views/py3o_template.xml
+++ b/report_py3o/views/py3o_template.xml
@ -5,9 +5,13 @@
            <field name="name">py3o.template.configuration.search.view</field>
            <field name="model">py3o.template</field>
            <field name="arch" type="xml">
-                <search string="Py3o Templates Configuration" version="7.0">
+                <search string="Py3o Templates Configuration">
                    <field name="name" />
                    <field name="filetype" />
+                    <group string="Group By" name="groupby">
+                        <filter name="filetype_groupby" string="File Type"
+                        context="{'group_by': 'filetype'}"/>
+                    </group>
                </search>
            </field>
        </record>
@ -16,14 +20,12 @@
            <field name="name">py3o.template.configuration.form.view</field>
            <field name="model">py3o.template</field>
            <field name="arch" type="xml">
-                <form string="Py3o Templates Configuration" version="7.0">
-                    <sheet>
-                        <group>
-                            <field name="name" />
-                            <field name="filetype" />
-                            <field name="py3o_template_data" />
-                        </group>
-                    </sheet>
+                <form string="Py3o Templates Configuration">
+                    <group>
+                        <field name="name" />
+                        <field name="filetype" />
+                        <field name="py3o_template_data" />
+                    </group>
                </form>
            </field>
        </record>
@ -32,7 +34,7 @@
            <field name="name">py3o.template.configuration.tree.view</field>
            <field name="model">py3o.template</field>
            <field name="arch" type="xml">
-                <tree string="Py3o Templates Configuration" version="7.0">
+                <tree string="Py3o Templates Configuration">
                    <field name="name" />
                    <field name="filetype" />
                </tree>
@ -40,14 +42,12 @@
        </record>

        <record id="py3o_template_configuration_action" model="ir.actions.act_window">
-            <field name="name">Py3o Templates Configuration</field>
+            <field name="name">Py3o Templates</field>
            <field name="res_model">py3o.template</field>
-            <field name="view_type">form</field>
            <field name="view_mode">tree,form</field>
        </record>

        <menuitem id="py3o_template_configuration_menu"
-            name="Py3o Templates"
            parent="py3o_config_menu"
            action="py3o_template_configuration_action" />
    </data>