You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

67 lines
2.3 KiB

  1. .. image:: https://img.shields.io/badge/licence-AGPL--3-blue.svg
  2. :target: http://www.gnu.org/licenses/agpl-3.0-standalone.html
  3. :alt: License: AGPL-3
  4. ================
  5. Repetition rules
  6. ================
  7. This module was written to offer a field type that holds rrules according to RFC 2445.
  8. Usage
  9. =====
  10. To use this module, you need to:
  11. * depend on it
  12. * say ``from openerp.addons.field_rrule.field_rrule import FieldRRule``
  13. * use ``FieldRRule`` like any other field
  14. * on forms, use ``widget="rrule"``
  15. * have a look at `demo/res_partner.*`
  16. Technically, this is a wrapper around serialized fields. The value always will be a subclass of dateutil's ``rruleset``. For technical reasons, this class overrides ``__iter__``, so if you need a proper ``rruleset``, call the value: ``my_browse_record.my_field_of_type_rrule()`` - this gives you a vanilla ``rruleset``.
  17. Known issues / Roadmap
  18. ======================
  19. * support the unimplemented features of rrules
  20. * support rdates, exdates, exrules
  21. * consider multiple widgets with different feature sets
  22. Bug Tracker
  23. ===========
  24. Bugs are tracked on `GitHub Issues
  25. <https://github.com/OCA/server-tools/issues>`_. In case of trouble, please
  26. check there if your issue has already been reported. If you spotted it first,
  27. help us smashing it by providing a detailed and welcomed feedback.
  28. Credits
  29. =======
  30. Images
  31. ------
  32. * Odoo Community Association: `Icon <https://github.com/OCA/maintainer-tools/blob/master/template/module/static/description/icon.svg>`_.
  33. Contributors
  34. ------------
  35. * Holger Brunn <hbrunn@therp.nl>
  36. Do not contact contributors directly about help with questions or problems concerning this addon, but use the `community mailing list <mailto:community@mail.odoo.com>`_ or the `appropriate specialized mailinglist <https://odoo-community.org/groups>`_ for help, and the bug tracker linked in `Bug Tracker`_ above for technical issues.
  37. Maintainer
  38. ----------
  39. .. image:: https://odoo-community.org/logo.png
  40. :alt: Odoo Community Association
  41. :target: https://odoo-community.org
  42. This module is maintained by the OCA.
  43. OCA, or the Odoo Community Association, is a nonprofit organization whose
  44. mission is to support the collaborative development of Odoo features and
  45. promote its widespread use.
  46. To contribute to this module, please visit https://odoo-community.org.