Browse Source

[IMP] date_range: new README structure

pull/1305/head
Laurent Mignon (ACSONE) 7 years ago
parent
commit
e65540efcd
  1. 104
      date_range/README.rst
  2. 4
      date_range/__manifest__.py
  3. 3
      date_range/readme/CONTRIBUTORS.rst
  4. 2
      date_range/readme/DESCRIPTION.rst
  5. 3
      date_range/readme/INSTALL.rst
  6. 47
      date_range/readme/USAGE.rst

104
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--tools-lightgray.png?logo=github
:target: https://github.com/OCA/server-tools/tree/10.0/date_range
:alt: OCA/server-tools
.. |badge4| image:: https://img.shields.io/badge/weblate-Translate%20me-F47D42.png
:target: https://translation.odoo-community.org/projects/server-tools-10-0/server-tools-10-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/149/10.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,65 +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/149/10.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
<https://github.com/OCA/server-tools/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 <https://github.com/OCA/server-tools/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/server-tools/issues/new?body=module:%20date_range%0Aversion:%2010.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
=======
Images
------
Authors
~~~~~~~
* Odoo Community Association: `Icon <https://github.com/OCA/maintainer-tools/blob/master/template/module/static/description/icon.svg>`_.
* ACSONE SA/NV
Contributors
------------
~~~~~~~~~~~~
* Laurent Mignon <laurent.mignon@acsone.eu>
* Alexis de Lattre <alexis.delattre@akretion.com>
* Miquel Raïch <miquel.raich@eficent.com>
Maintainers
~~~~~~~~~~~
Maintainer
----------
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 <https://odoo-community.org/page/maintainer-role>`_:
|maintainer-lmignon|
This module is part of the `OCA/server-tools <https://github.com/OCA/server-tools/tree/10.0/date_range>`_ project on GitHub.
You are welcome to contribute. To learn how please visit https://odoo-community.org/page/Contribute.

4
date_range/__manifest__.py

@ -23,5 +23,7 @@
],
"qweb": [
"static/src/xml/date_range.xml",
]
],
'development_status': 'Mature',
'maintainers': ['lmignon'],
}

3
date_range/readme/CONTRIBUTORS.rst

@ -0,0 +1,3 @@
* Laurent Mignon <laurent.mignon@acsone.eu>
* Alexis de Lattre <alexis.delattre@akretion.com>
* Miquel Raïch <miquel.raich@eficent.com>

2
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.

3
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

47
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
Loading…
Cancel
Save