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.

132 lines
4.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. 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. Bug Tracker
  41. ===========
  42. Bugs are tracked on `GitHub Issues <https://github.com/OCA/server-tools/issues>`_.
  43. In case of trouble, please check there if your issue has already been reported.
  44. If you spotted it first, help us smashing it by providing a detailed and welcomed feedback
  45. `here <https://github.com/OCA/server-tools/issues/new?body=module:%20module_prototyper%0Aversion:%200.3%0A%0A**Steps%20to%20reproduce**%0A-%20...%0A%0A**Current%20behavior**%0A%0A**Expected%20behavior**>`_.
  46. Credits
  47. =======
  48. Contributors
  49. ------------
  50. * David Arnold <blaggacao@users.noreply.github.com>
  51. * Jordi Riera <jordi.riera@savoirfairelinux.com>
  52. * Maxime Chambreuil <maxime.chambreuil@savoirfairelinux.com>
  53. * El hadji Dem <elhadji.dem@savoirfairelinux.com>
  54. * Savoir-faire Linux <support@savoirfairelinux.com>
  55. * Vincent Vinet <vincent.vinet@savoirfairelinux.com>
  56. Maintainer
  57. ----------
  58. .. image:: http://odoo-community.org/logo.png
  59. :alt: Odoo Community Association
  60. :target: http://odoo-community.org
  61. This module is maintained by the OCA.
  62. 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.
  63. To contribute to this module, please visit http://odoo-community.org.
  64. Versions
  65. ========
  66. v0.1
  67. ----
  68. All the features are not implemented but the minimal is done.
  69. With this version you can:
  70. The set up of openerp.py is covered, description, maintainer, website, name, technical name...
  71. Views and menus can be set through odoo and gathered in prototype. The files will be automatically generated and add to the data section of the openerp.py. Be aware some advanced feature as domain or context might still missing.
  72. Dependencies can be set throught the Dependency page
  73. Custom fields can be added. A file by model will be generated with all the fields of the model. The init.py files are updated accordingly. Be aware that some features are not implemented yet, as the domain, the context.
  74. This version should be enought for:
  75. set up the client module
  76. create a new field in a view.
  77. Features that you might expect in next version:
  78. better generation of fields (many2many fields, domain, context)
  79. Generation of data and demo data files.
  80. Security files (rules, ir.model.access.csv)
  81. openerp's description editing README.rst and index.html
  82. module screenshots
  83. v0.2
  84. ----
  85. Renamed from prototype to module_prototyper as discussed in #108
  86. menu in Settings that gather element used to create a prototype (menu views, views, fields)
  87. v0.3
  88. ----
  89. Replace ir.ui.model by ir.ui.view in generated xml views
  90. Improve pep8 compatibility of generation of models
  91. Known bugs
  92. ----------
  93. icon file extension might be wrong. The extension is hard coded for now. It is planned add Document as dependency to handle it.