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.

79 lines
2.6 KiB

  1. .. image:: https://img.shields.io/badge/license-LGPL--3-blue.svg
  2. :target: https://www.gnu.org/licenses/lgpl.html
  3. :alt: License: LGPL-3
  4. ===============================
  5. Module Manifest - Extra Options
  6. ===============================
  7. This is a technical module that allows developers to make use of extra keys in
  8. module manifests. The following keys are available currently:
  9. * ``depends_if_installed`` - Your module will depend on modules listed here but
  10. only if those modules are already installed. This is useful if your module
  11. needs to override the behavior of a certain module (dependencies determine
  12. load order) but would also work without it.
  13. * ``rdepends_if_installed`` - The modules listed here will depend on your
  14. module if they are already installed. This is useful if you want your module
  15. to be higher in the inheritance chain than the target modules and do not want
  16. to or cannot make changes to those modules.
  17. Usage
  18. =====
  19. Add this module as a dependency and use the keys described above.
  20. Roadmap
  21. =======
  22. Add support for the following additional keys:
  23. * ``breaks`` - Used to mark some modules as being incompatible with the
  24. current one. This could be set up to support versioning (e.g. ``'breaks':
  25. ['my_module<<0.4.2']``).
  26. * ``demo_if_installed``, ``data_if_installed``, ``qweb_if_installed`` - Dicts
  27. with module names as keys and lists of files as values. Used to load files
  28. only if some other module is installed.
  29. * ``_if_module`` - Used on models to load them only if the appropriate module
  30. is installed.
  31. Bug Tracker
  32. ===========
  33. Bugs are tracked on
  34. `GitHub Issues <https://github.com/OCA/server-tools/issues>`_. In case of
  35. trouble, please check there if your issue has already been reported. If you
  36. spotted it first, help us smash it by providing detailed and welcome feedback.
  37. Credits
  38. =======
  39. Images
  40. ------
  41. * Odoo Community Association:
  42. `Icon <https://github.com/OCA/maintainer-tools/blob/master/template/module/static/description/icon.svg>`_.
  43. Contributors
  44. ------------
  45. * Holger Brunn <hbrunn@therp.nl>
  46. * Oleg Bulkin <obulkin@laslabs.com>
  47. Do not contact contributors directly about support or help with technical
  48. issues.
  49. Maintainer
  50. ----------
  51. .. image:: https://odoo-community.org/logo.png
  52. :alt: Odoo Community Association
  53. :target: https://odoo-community.org
  54. This module is maintained by the OCA.
  55. OCA, or the Odoo Community Association, is a nonprofit organization whose
  56. mission is to support the collaborative development of Odoo features and
  57. promote its widespread use.
  58. To contribute to this module, please visit https://odoo-community.org.