View source | Discuss this page | Page history | Printable version   
Toolbox
Main Page
Upload file
What links here
Recent changes
Help

PDF Books
Add page
Show collection (0 pages)
Collections help

Search

Naming guidelines for modules

Contents

Naming guidelines for modules

It is important to select an appropriate name for your module in order to make it easier for users to recognize it both in the Forge and in the Module Management window.

In future, Openbravo may also use these naming convention to automatically categorize modules based on tags, therefore it is important that these naming conventions are followed.

Here is a set of naming guidelines that we ask module author to honor:

Branding rules:

Language and grammar conventions:

Specific types of modules:

Packaging

 org.openbravo.functionalcategory.modulename
 org.openbravo.functionalcategory.functionalsubcategory.modulename
-applicationdictionary (platform)
-kernel (platform) ->  although seam module uses base, so we can change to base (Martin?)
-utility (platform)
-setup (erp engineering)
-common (erp engineering)
-document (erp engineering) ->  this one has never been clear, it consolidates sales and purchase (use them as optional subcategories?)
-warehouse (erp engineering)
-project (erp engineering)
-production (erp engineering)
-mrp (erp engineering)
-financial (erp engineering)
-erputil (erp engineering)
-localization (localization) ->  subcategories for each country (eg. localizatation.spain)
-localizationutil (localization) ->  not sure if needed
-quickstart (industry templates / verticals are a category by itself)
-quickstartspain (industry templates / verticals are a category by itself)

Choosing a db_prefix

Modules created by the community

Modules created by Openbravo, S.L.U. and staff

Customization modules

Usually customization modules are not intended to be published in Central Repository. In this case, DBPrefix should start with CUST. Modules with these kind of DBPrefixes cannot be registered in Central Repository but are collision safe because no other module in Central Repository can use this DBPrefix. This is an important decision to be taken before starting the module development: in case there is any chance of publishing the module at some moment, it should follow the standard rule, if it is absolutely sure that it will not be published you can use CUST and do not register it.

Retrieved from "http://wiki.openbravo.com/wiki/Naming_guidelines_for_modules"

This page has been accessed 7,630 times. This page was last modified on 8 March 2013, at 09:03. Content is available under Creative Commons Attribution-ShareAlike 2.5 Spain License.