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.

77 lines
2.4 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 is
  11. supposed to override the behavior of a certain module (dependencies determine
  12. load order) but does not need it to be installed.
  13. Usage
  14. =====
  15. Add this module as a dependency and use the keys described above.
  16. Roadmap
  17. =======
  18. Add support for the following additional keys:
  19. * ``breaks`` - Used to mark some modules as being incompatible with the
  20. current one. This could be set up to support versioning (e.g. ``'breaks':
  21. ['my_module<<0.4.2']``).
  22. * ``demo_if_installed``, ``data_if_installed``, ``qweb_if_installed`` - Dicts
  23. with module names as keys and lists of files as values. Used to load files
  24. only if some other module is installed.
  25. * ``rdepends_if_installed`` - Similar to ``depends_if_installed`` but
  26. used to make another installed module depend on the current one.
  27. * ``_if_module`` - Used on models to load them only if the appropriate module
  28. is installed.
  29. Bug Tracker
  30. ===========
  31. Bugs are tracked on
  32. `GitHub Issues <https://github.com/OCA/server-tools/issues>`_. In case of
  33. trouble, please check there if your issue has already been reported. If you
  34. spotted it first, help us smash it by providing detailed and welcome feedback.
  35. Credits
  36. =======
  37. Images
  38. ------
  39. * Odoo Community Association:
  40. `Icon <https://github.com/OCA/maintainer-tools/blob/master/template/module/static/description/icon.svg>`_.
  41. Contributors
  42. ------------
  43. * Holger Brunn <hbrunn@therp.nl>
  44. * Oleg Bulkin <obulkin@laslabs.com>
  45. Do not contact contributors directly about support or help with technical
  46. issues.
  47. Maintainer
  48. ----------
  49. .. image:: https://odoo-community.org/logo.png
  50. :alt: Odoo Community Association
  51. :target: https://odoo-community.org
  52. This module is maintained by the OCA.
  53. OCA, or the Odoo Community Association, is a nonprofit organization whose
  54. mission is to support the collaborative development of Odoo features and
  55. promote its widespread use.
  56. To contribute to this module, please visit https://odoo-community.org.