From 354452402467fa889216e3ecad09f8be01f799d2 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Adri=C3=A0=20Gil=20Sorribes?= Date: Wed, 16 Jan 2019 12:29:30 +0100 Subject: [PATCH] Update readme --- bi_sql_editor/README.rst | 32 ++++-------------- bi_sql_editor/readme/INSTALL.rst | 2 ++ bi_sql_editor/static/description/index.html | 36 +++++++++++++-------- 3 files changed, 30 insertions(+), 40 deletions(-) create mode 100644 bi_sql_editor/readme/INSTALL.rst diff --git a/bi_sql_editor/README.rst b/bi_sql_editor/README.rst index a69e05d9..fc565181 100644 --- a/bi_sql_editor/README.rst +++ b/bi_sql_editor/README.rst @@ -66,11 +66,17 @@ this module is interesting for the following use cases * You have a lot of data, and classical SQL Views have very bad performance. In that case, MATERIALIZED VIEW will be a good solution to reduce display duration +**Table of contents** + +.. contents:: + :local: + Installation ============ * You must put this module as `server_wide_modules` in your odoo configuration file or add '--load=bi_sql_editor' if you start odoo in command line. + Configuration ============= @@ -141,25 +147,6 @@ If you spotted it first, help us smashing it by providing a detailed and welcome Do not contact contributors directly about support or help with technical issues. -Note -==== - -* If the view is materialized, the name of the action will contain the date - and the time of it last refresh: - - .. figure:: /bi_sql_editor/static/description/06_action_datetime_name.png - :width: 800 px - -* The syntax of the sql request has the following constrains: the name of the - selectable columns should be prefixed by `x_` - -Sample: - -.. code-block:: sql - - SELECT name as x_name - FROM res_partner - Credits ======= @@ -184,13 +171,6 @@ Contributors Module: grap/odoo-addons-misc/pos_sale_reporting link: https://github.com/grap/odoo-addons-misc/tree/7.0/pos_sale_reporting -Funders -~~~~~~~ - -The development of this module has been financially supported by: - -* GRAP, Groupement Régional Alimentaire de Proximité (http://www.grap.coop) - Maintainers ~~~~~~~~~~~ diff --git a/bi_sql_editor/readme/INSTALL.rst b/bi_sql_editor/readme/INSTALL.rst new file mode 100644 index 00000000..6ccbf3b4 --- /dev/null +++ b/bi_sql_editor/readme/INSTALL.rst @@ -0,0 +1,2 @@ +* You must put this module as `server_wide_modules` in your odoo configuration file + or add '--load=bi_sql_editor' if you start odoo in command line. diff --git a/bi_sql_editor/static/description/index.html b/bi_sql_editor/static/description/index.html index 8bf7238b..c004e69c 100644 --- a/bi_sql_editor/static/description/index.html +++ b/bi_sql_editor/static/description/index.html @@ -381,19 +381,27 @@ In that case, MATERIALIZED VIEW will be a good solution to reduce display durati

Table of contents

+
+

Installation

+ +
-

Configuration

+

Configuration

To configure this module, you need to:

-

Usage

+

Usage

To use this module, you need to:

  1. Go to ‘Reporting’ / ‘Custom Reports’
    2. @@ -459,7 +467,7 @@ search view.

-

Bug Tracker

+

Bug Tracker

Bugs are tracked on GitHub 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 @@ -467,15 +475,15 @@ If you spotted it first, help us smashing it by providing a detailed and welcome

Do not contact contributors directly about support or help with technical issues.

-

Credits

+

Credits

-

Authors

+

Authors

  • GRAP
-

Contributors

+

Contributors