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.

110 lines
3.8 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. Module Prototyper
  6. =================
  7. This module allows the administrator to prototype new features and export them as module.
  8. Functional people can prepare the job for a developer who is left with the logic to implement
  9. in addition to everything the prototype does not export yet.
  10. Installation
  11. ============
  12. Make sure you have Jinja2 version 2.7.3 or higher installed::
  13. $ pip install --upgrade Jinja2==2.7.3
  14. Configuration
  15. =============
  16. No configuration required.
  17. Usage
  18. =====
  19. To use this module, you need to:
  20. * install the dependencies of your future module
  21. * customize your instance by adding fields and creating inherited views
  22. * create your menu items and their window actions
  23. * prepare your data and demo data by creating filters
  24. * create your own groups with access rights and record rules
  25. * add your own access rights and record rules to an existing group
  26. Once you have customized your instance properly, you can go to Settings > Module Prototypes > Prototypes
  27. and create a new prototype:
  28. * fill in the information of your module (enter the name, the description, the logo, etc.)
  29. * in the Depencencies tab, select all the other modules that yours will be depending on
  30. * in the Data & Demo tab, select your filters for data and demo data
  31. * in the Fields tab, select the fields you created or customized
  32. * in the Interface tab, select your menu items and your views
  33. * in the Security tab, select your groups, access rights and record rules
  34. * save and click on export
  35. You will get a zip file containing your module ready to be installed and compliant with the
  36. conventions of the OCA. You can then provide the module to a developer who have to implement
  37. things like default values or onchange methods.
  38. .. image:: https://odoo-community.org/website/image/ir.attachment/5784_f2813bd/datas
  39. :alt: Try me on Runbot
  40. :target: https://runbot.odoo-community.org/runbot/149/9.0
  41. Known issues / Roadmap
  42. ======================
  43. * `#104`_ - Include controllers.py and templates.xml from scaffold.
  44. * Attach images to the prototype and export them to be used in the 'images' module manifest.
  45. * Export data and demo data
  46. * Export reports
  47. * Export workflows, nodes, transitions, actions
  48. * Export groups, access rights and record rules
  49. * Allow selecting and exporting website stuff
  50. .. _#104: https://github.com/OCA/server-tools/issues/104
  51. Bug Tracker
  52. ===========
  53. Bugs are tracked on `GitHub Issues <https://github.com/OCA/server-tools/issues>`_.
  54. In case of trouble, please check there if your issue has already been reported.
  55. If you spotted it first, help us smashing it by providing a detailed and welcomed feedback
  56. `here <https://github.com/OCA/server-tools/issues/new?body=module:%20module_prototyper%0Aversion:%209.0%0A%0A**Steps%20to%20reproduce**%0A-%20...%0A%0A**Current%20behavior**%0A%0A**Expected%20behavior**>`_.
  57. Credits
  58. =======
  59. Contributors
  60. ------------
  61. * David Arnold <blaggacao@users.noreply.github.com>
  62. * Jordi Riera <jordi.riera@savoirfairelinux.com>
  63. * Maxime Chambreuil <maxime.chambreuil@savoirfairelinux.com>
  64. * El hadji Dem <elhadji.dem@savoirfairelinux.com>
  65. * Savoir-faire Linux <support@savoirfairelinux.com>
  66. * Vincent Vinet <vincent.vinet@savoirfairelinux.com>
  67. * Nicolas JEUDY <nicolas@sudokeys.com>
  68. Maintainer
  69. ----------
  70. .. image:: http://odoo-community.org/logo.png
  71. :alt: Odoo Community Association
  72. :target: http://odoo-community.org
  73. This module is maintained by the OCA.
  74. 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.
  75. To contribute to this module, please visit http://odoo-community.org.
  76. Changelog
  77. =========
  78. v9.0.0.1.0
  79. ----------
  80. * Initial V9 version from V8.0.3