Browse Source

[IMP] Module description and dependencies

[FIX] URL

[FIX] URL to issue

[FIX] Typo

[FIX] Typo
pull/107/head
Maxime Chambreuil 10 years ago
parent
commit
ab7700fe80
  1. 79
      prototype/README.rst
  2. 23
      prototype/__openerp__.py

79
prototype/README.rst

@ -0,0 +1,79 @@
Module Prototype
================
This module allows the administrator to prototype new features and export them as module.
Functional people can prepare the job for a developer who is left with the logic to implement
in addition to everything the prototype does not export yet.
Installation
============
No installation steps required other than installing the module itself.
Configuration
=============
No configuration required.
Usage
=====
To use this module, you need to:
* install the dependencies of your future module
* customize your instance by adding fields and creating inherited views
* create your menu items and their window actions
* prepare your data and demo data by creating filters
* create your own groups with access rights and record rules
* add your own access rights and record rules to an existing group
Once you have customized your instance properly, you can go to Settings > Modules > Prototype
and create a new prototype:
* fill in the information of your module (enter the name, the description, the logo, etc.)
* in the Depencencies tab, select all the other modules that yours will be depending on
* in the Data & Demo tab, select your filters for data and demo data
* in the Fields tab, select the fields you created or customized
* in the Interface tab, select your menu items and your views
* in the Security tab, select your groups, access rights and record rules
* save and click on export
You will get a zip file containing your module ready to be installed and compliant with the
conventions of the OCA. You can then provide the module to a developer who have to implement
things like default values or onchange methods.
Known issues / Roadmap
======================
* `#104`_ - Include controllers.py and templates.xml from scaffold.
* Attach images to the prototype and export them to be used in the 'images' module manifest.
* Add a Report tab to select and export reports
* Add a Workflow tab to select and export workflows, nodes, transitions, actions
.. _#104: https://github.com/OCA/server-tools/issues/104
Please report any idea or issue to https://github.com/OCA/server-tools/issues.
Credits
=======
Contributors
------------
* David Arnold <blaggacao@users.noreply.github.com>
* Jordi Riera <jordi.riera@savoirfairelinux.com>
* Maxime Chambreuil <maxime.chambreuil@savoirfairelinux.com>
* Savoir-faire Linux <support@savoirfairelinux.com>
Maintainer
----------
.. image:: http://odoo-community.org/logo.png
:alt: Odoo Community Association
:target: http://odoo-community.org
This module is maintained by the OCA.
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.
To contribute to this module, please visit http://odoo-community.org.

23
prototype/__openerp__.py

@ -29,30 +29,9 @@
'license': 'AGPL-3',
'category': 'Others',
'summary': 'Prototype your module',
'description': """
This module allows the administrator to prototype new features and export
them as module.
Usage
=====
Go to Settings > Modules > Prototype, create a new prototype, fill in the
information and export your module.
Contributors
============
* Maxime Chambreuil <maxime.chambreuil@savoirfairelinux.com>
* Savoir-faire Linux <support@savoirfairelinux.com>
More information
----------------
* Module developed and tested with Odoo version 8.0
* For questions, please contact our support services
(support@savoirfairelinux.com)
""",
'depends': [
'base',
'admin_technical_features',
],
'external_dependencies': {
'python': [],

Loading…
Cancel
Save