Changes between Version 47 and Version 48 of DeveloperGuidelinesNewModule

Timestamp:

11/29/13 21:31:05 (11 years ago)

Author:

Pat Tressel

Comment:

--

DeveloperGuidelinesNewModule

@@ -11 +11 @@
 
 '''Note''' 
-           - You need to Add your module to {{{private/templates/<template>/config.py}}}[[BR]]
-           - Also, Add It to {{{models/00_tables.py}}}[[BR]]
+ * Add your module to settings.modules in {{{private/templates/<template>/config.py}}} if it is for a specific template.
+ * Add it to {{{private/templates/default/config.py}}} to provide an example of how your module should be entered in settings.modules.
+ * Add an import statement to {{{models/00_tables.py}}}
 
-Add tables to modules/s3db/<MODULE NAME>.py file, as-required for your resources.[[BR]]
-To avoid namespace clashes, use the format: {{{s3db.module_table}}}
+Add tables to modules/s3db/<MODULE NAME>.py file, as-required for your resources.
+To avoid namespace clashes, use your module name as a prefix for table names.
+Follow with underscore and the name of the resource your table represents: module_resource. Resource names should be unique.
 
-e.g. if building a Vehicle Management System, create s3db.vts_vehicle:
+E.g. if building a Vehicle Management System, create s3db.vms_vehicle:
 {{{
-module = "org"
-resource = "organisation"
+module = "vms"
+resource = "vehicle"
 
 tablename = "%s_%s" % (module, resource)