Changes between Version 39 and Version 40 of DeveloperGuidelinesNewModule

Timestamp:

06/27/10 09:33:02 (14 years ago)

Author:

Fran Boon

Comment:

--

DeveloperGuidelinesNewModule

@@ -18 +18 @@
 To avoid namespace clashes, use the format: {{{db.module_table}}}
 
-e.g. if building a Vehicle Management System, create db.veh_vehicle:
+e.g. if building a Vehicle Management System, create db.vts_vehicle:
 {{{
-module = 'veh'
-resource = 'vehicle'
+module = "vts"
+resource = "vehicle"
 
-tablename = module + '_' + resource
+tablename = module + "_" + resource
 table = db.define_table(tablename, timestamp, uuidstamp,
-                Field('name'))
-table.uuid.requires = IS_NOT_IN_DB(db, '%s.uuid' % table)
+                Field("name"))
+table.uuid.requires = IS_NOT_IN_DB(db, "%s.uuid" % table)
 table.name.requires = IS_NOT_EMPTY()
 table.name.comment = SPAN("*", _class="req")
-}}}
-
-Add the messages for your resources:
-{{{
-s3.crud_strings[tablename] = Storage(
-    title_create = T('Add Vehicle'),
-    title_display = T('Vehicle Details'),
-    title_list = T('List Vehicles'),
-    title_update = T('Edit Vehicle'),
-    title_search = T('Search Vehicles'),
-    subtitle_create = T('Add New Vehicle'),
-    subtitle_list = T('Vehicles'),
-    label_list_button = T('List Vehicles'),
-    label_create_button = T('Add Vehicle'),
-    label_delete_button = T('Delete Vehicle'),
-    msg_record_created = T('Vehicle added'),
-    msg_record_modified = T('Vehicle updated'),
-    msg_record_deleted = T('Vehicle deleted'),
-    msg_list_empty = T('No Vehicles currently registered'))
 }}}
 
@@ -53 +34 @@
 Create a file: {{{/controllers/<MODULE NAME>.py}}}
 
-Add the S3 framework functions:
+Add CRUD functions for your tables:
 {{{
-module = 'veh'
+module = request.controller
 
+def vehicle():
+    "RESTful CRUD controller"
+    resource = request.function
+    return shn_rest_controller(module, resource)
+}}}
+
+Manual method for if/when you need more control: DeveloperGuidelinesCreateReadUpdateDelete
+
+Add the messages for your resources:
+{{{
+def vehicle():
+    "RESTful CRUD controller"
+    resource = request.function
+    s3.crud_strings[tablename] = Storage(
+        title_create = T("Add Vehicle"),
+        title_display = T("Vehicle Details"),
+        title_list = T("List Vehicles"),
+        title_update = T("Edit Vehicle"),
+        title_search = T("Search Vehicles"),
+        subtitle_create = T("Add New Vehicle"),
+        subtitle_list = T("Vehicles"),
+        label_list_button = T("List Vehicles"),
+        label_create_button = T("Add Vehicle"),
+        label_delete_button = T("Delete Vehicle"),
+        msg_record_created = T("Vehicle added"),
+        msg_record_modified = T("Vehicle updated"),
+        msg_record_deleted = T("Vehicle deleted"),
+        msg_list_empty = T("No Vehicles currently registered"))
+
+    return shn_rest_controller(module, resource)
+}}}
+
+Add a menu:
+{{{
 # Options Menu (available in all Functions' Views)
 response.menu_options = [
@@ -64 +79 @@
     [T("Search Vehicles"), False, URL(r=request, f="vehicle", args="search")]
 ]
-
 }}}
-
-Add CRUD functions for your tables:
-{{{
-def vehicle():
-    "RESTful CRUD controller"
-    return shn_rest_controller(module, "vehicle")
-}}}
-
-Manual method for if/when you need more control: DeveloperGuidelinesCreateReadUpdateDelete
 
 === Views ===
@@ -82 +87 @@
 If Custom Views are wanted they are detected automatically if files are found in {{{/views/<MODULE NAME>/<RESOURCE>_<METHOD>.html}}}
 
+----
 DeveloperGuidelines