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.8 KiB

  1. Module Prototype
  2. ================
  3. This module allows the administrator to prototype new features and export them as module.
  4. Functional people can prepare the job for a developer who is left with the logic to implement
  5. in addition to everything the prototype does not export yet.
  6. Installation
  7. ============
  8. No installation steps required other than installing the module itself.
  9. Configuration
  10. =============
  11. No configuration required.
  12. Usage
  13. =====
  14. To use this module, you need to:
  15. * install the dependencies of your future module
  16. * customize your instance by adding fields and creating inherited views
  17. * create your menu items and their window actions
  18. * prepare your data and demo data by creating filters
  19. * create your own groups with access rights and record rules
  20. * add your own access rights and record rules to an existing group
  21. Once you have customized your instance properly, you can go to Settings > Modules > Prototype
  22. and create a new prototype:
  23. * fill in the information of your module (enter the name, the description, the logo, etc.)
  24. * in the Depencencies tab, select all the other modules that yours will be depending on
  25. * in the Data & Demo tab, select your filters for data and demo data
  26. * in the Fields tab, select the fields you created or customized
  27. * in the Interface tab, select your menu items and your views
  28. * in the Security tab, select your groups, access rights and record rules
  29. * save and click on export
  30. You will get a zip file containing your module ready to be installed and compliant with the
  31. conventions of the OCA. You can then provide the module to a developer who have to implement
  32. things like default values or onchange methods.
  33. Known issues / Roadmap
  34. ======================
  35. * `#104`_ - Include controllers.py and templates.xml from scaffold.
  36. * Attach images to the prototype and export them to be used in the 'images' module manifest.
  37. * Add a Report tab to select and export reports
  38. * Add a Workflow tab to select and export workflows, nodes, transitions, actions
  39. .. _#104: https://github.com/OCA/server-tools/issues/104
  40. Please report any idea or issue to https://github.com/OCA/server-tools/issues.
  41. Credits
  42. =======
  43. Contributors
  44. ------------
  45. * David Arnold <blaggacao@users.noreply.github.com>
  46. * Jordi Riera <jordi.riera@savoirfairelinux.com>
  47. * Maxime Chambreuil <maxime.chambreuil@savoirfairelinux.com>
  48. * Savoir-faire Linux <support@savoirfairelinux.com>
  49. Maintainer
  50. ----------
  51. .. image:: http://odoo-community.org/logo.png
  52. :alt: Odoo Community Association
  53. :target: http://odoo-community.org
  54. This module is maintained by the OCA.
  55. 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.
  56. To contribute to this module, please visit http://odoo-community.org.