From f1c3b9a4df0ac88835f0811db4f41b374add2156 Mon Sep 17 00:00:00 2001 From: "Laurent Mignon (ACSONE)" Date: Thu, 28 Jun 2018 12:31:09 +0200 Subject: [PATCH] [IMP] date_range: new README structure --- date_range/README.rst | 103 +++++++++++++++++++---------- date_range/__manifest__.py | 4 +- date_range/readme/CONTRIBUTORS.rst | 3 + date_range/readme/DESCRIPTION.rst | 2 + date_range/readme/INSTALL.rst | 3 + date_range/readme/USAGE.rst | 47 +++++++++++++ 6 files changed, 126 insertions(+), 36 deletions(-) create mode 100644 date_range/readme/CONTRIBUTORS.rst create mode 100644 date_range/readme/DESCRIPTION.rst create mode 100644 date_range/readme/INSTALL.rst create mode 100644 date_range/readme/USAGE.rst diff --git a/date_range/README.rst b/date_range/README.rst index 64ce918..32176f3 100644 --- a/date_range/README.rst +++ b/date_range/README.rst @@ -1,14 +1,45 @@ -.. 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 - ========== Date Range ========== +.. !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! + !! This file is generated by oca-gen-addon-readme !! + !! changes will be overwritten. !! + !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! + +.. |badge1| image:: https://img.shields.io/badge/maturity-Mature-brightgreen.png + :target: https://odoo-community.org/page/development-status + :alt: Mature +.. |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%2Fserver--ux-lightgray.png?logo=github + :target: https://github.com/OCA/server-ux/tree/11.0/date_range + :alt: OCA/server-ux +.. |badge4| image:: https://img.shields.io/badge/weblate-Translate%20me-F47D42.png + :target: https://translation.odoo-community.org/projects/server-ux-11-0/server-ux-11-0-date_range + :alt: Translate me on Weblate +.. |badge5| image:: https://img.shields.io/badge/runbot-Try%20me-875A7B.png + :target: https://runbot.odoo-community.org/runbot/250/11.0 + :alt: Try me on Runbot + +|badge1| |badge2| |badge3| |badge4| |badge5| + This module lets you define global date ranges that can be used to filter your values in tree views. +**Table of contents** + +.. contents:: + :local: + +Installation +============ + +The addon use the daterange method from postgres. This method is supported as of postgresql 9.2 + + + Usage ===== @@ -17,26 +48,26 @@ To configure this module, you need to: * Go to Settings > Technical > Date ranges > Date Range Types where you can create types of date ranges. - .. figure:: static/description/date_range_type_create.png + .. figure:: https://raw.githubusercontent.com/OCA/server-tools/10.0/date_range/static/description/date_range_type_create.png :scale: 80 % :alt: Create a type of date range * Go to Settings > Technical > Date ranges > Date Ranges where you can create date ranges. - .. figure:: static/description/date_range_create.png + .. figure:: https://raw.githubusercontent.com/OCA/server-tools/10.0/date_range/static/description/date_range_create.png :scale: 80 % :alt: Date range creation It's also possible to launch a wizard from the 'Generate Date Ranges' menu. - .. figure:: static/description/date_range_wizard.png + .. figure:: https://raw.githubusercontent.com/OCA/server-tools/10.0/date_range/static/description/date_range_wizard.png :scale: 80 % :alt: Date range wizard The wizard is useful to generate recurring periods. - .. figure:: static/description/date_range_wizard_result.png + .. figure:: https://raw.githubusercontent.com/OCA/server-tools/10.0/date_range/static/description/date_range_wizard_result.png :scale: 80 % :alt: Date range wizard result @@ -44,66 +75,68 @@ To configure this module, you need to: Date range types are proposed as a filter operator - .. figure:: static/description/date_range_type_as_filter.png + .. figure:: https://raw.githubusercontent.com/OCA/server-tools/10.0/date_range/static/description/date_range_type_as_filter.png :scale: 80 % :alt: Date range type available as filter operator Once a type is selected, date ranges of this type are porposed as a filter value - .. figure:: static/description/date_range_as_filter.png + .. figure:: https://raw.githubusercontent.com/OCA/server-tools/10.0/date_range/static/description/date_range_as_filter.png :scale: 80 % :alt: Date range as filter value And the dates specified into the date range are used to filter your result. - .. figure:: static/description/date_range_as_filter_result.png + .. figure:: https://raw.githubusercontent.com/OCA/server-tools/10.0/date_range/static/description/date_range_as_filter_result.png :scale: 80 % :alt: Date range as filter result - -.. image:: https://odoo-community.org/website/image/ir.attachment/5784_f2813bd/datas - :alt: Try me on Runbot - :target: https://runbot.odoo-community.org/runbot/250/11.0 - - -Known issues / Roadmap -====================== - -* The addon use the daterange method from postgres. This method is supported as of postgresql 9.2 - 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 feedback. +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 +`feedback `_. + +Do not contact contributors directly about support or help with technical issues. Credits ======= -Images ------- +Authors +~~~~~~~ -* Odoo Community Association: `Icon `_. +* ACSONE SA/NV Contributors ------------- +~~~~~~~~~~~~ * Laurent Mignon +* Alexis de Lattre * Miquel Raïch -Maintainer ----------- +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. +.. |maintainer-lmignon| image:: https://github.com/lmignon.png?size=40px + :target: https://github.com/lmignon + :alt: lmignon + +Current `maintainer `_: + +|maintainer-lmignon| + +This module is part of the `OCA/server-ux `_ project on GitHub. + +You are welcome to contribute. To learn how please visit https://odoo-community.org/page/Contribute. diff --git a/date_range/__manifest__.py b/date_range/__manifest__.py index 1499633..fd65913 100644 --- a/date_range/__manifest__.py +++ b/date_range/__manifest__.py @@ -22,5 +22,7 @@ ], "qweb": [ "static/src/xml/date_range.xml", - ] + ], + 'development_status': 'Mature', + 'maintainers': ['lmignon'], } diff --git a/date_range/readme/CONTRIBUTORS.rst b/date_range/readme/CONTRIBUTORS.rst new file mode 100644 index 0000000..4d37025 --- /dev/null +++ b/date_range/readme/CONTRIBUTORS.rst @@ -0,0 +1,3 @@ +* Laurent Mignon +* Alexis de Lattre +* Miquel Raïch diff --git a/date_range/readme/DESCRIPTION.rst b/date_range/readme/DESCRIPTION.rst new file mode 100644 index 0000000..0b51852 --- /dev/null +++ b/date_range/readme/DESCRIPTION.rst @@ -0,0 +1,2 @@ +This module lets you define global date ranges that can be used to filter +your values in tree views. diff --git a/date_range/readme/INSTALL.rst b/date_range/readme/INSTALL.rst new file mode 100644 index 0000000..695d21f --- /dev/null +++ b/date_range/readme/INSTALL.rst @@ -0,0 +1,3 @@ +The addon use the daterange method from postgres. This method is supported as of postgresql 9.2 + + diff --git a/date_range/readme/USAGE.rst b/date_range/readme/USAGE.rst new file mode 100644 index 0000000..07b3efa --- /dev/null +++ b/date_range/readme/USAGE.rst @@ -0,0 +1,47 @@ +To configure this module, you need to: + +* Go to Settings > Technical > Date ranges > Date Range Types where + you can create types of date ranges. + + .. figure:: https://raw.githubusercontent.com/OCA/server-tools/10.0/date_range/static/description/date_range_type_create.png + :scale: 80 % + :alt: Create a type of date range + +* Go to Settings > Technical > Date ranges > Date Ranges where + you can create date ranges. + + .. figure:: https://raw.githubusercontent.com/OCA/server-tools/10.0/date_range/static/description/date_range_create.png + :scale: 80 % + :alt: Date range creation + + It's also possible to launch a wizard from the 'Generate Date Ranges' menu. + + .. figure:: https://raw.githubusercontent.com/OCA/server-tools/10.0/date_range/static/description/date_range_wizard.png + :scale: 80 % + :alt: Date range wizard + + The wizard is useful to generate recurring periods. + + .. figure:: https://raw.githubusercontent.com/OCA/server-tools/10.0/date_range/static/description/date_range_wizard_result.png + :scale: 80 % + :alt: Date range wizard result + +* Your date ranges are now available in the search filter for any date or datetime fields + + Date range types are proposed as a filter operator + + .. figure:: https://raw.githubusercontent.com/OCA/server-tools/10.0/date_range/static/description/date_range_type_as_filter.png + :scale: 80 % + :alt: Date range type available as filter operator + + Once a type is selected, date ranges of this type are porposed as a filter value + + .. figure:: https://raw.githubusercontent.com/OCA/server-tools/10.0/date_range/static/description/date_range_as_filter.png + :scale: 80 % + :alt: Date range as filter value + + And the dates specified into the date range are used to filter your result. + + .. figure:: https://raw.githubusercontent.com/OCA/server-tools/10.0/date_range/static/description/date_range_as_filter_result.png + :scale: 80 % + :alt: Date range as filter result