Changes between Version 12 and Version 13 of DeveloperGuidelinesNewModule

Timestamp:

01/02/09 17:25:54 (16 years ago)

Author:

Fran Boon

Comment:

Vehicles example including main resource table

DeveloperGuidelinesNewModule

@@ -30 +30 @@
 }}}
 
-Add additional tables to this file, as-required.[[BR]]
+Add additional tables to this file, as-required for your resources.[[BR]]
 To avoid namespace clashes, use the format: {{{db.module_table}}}
+
+e.g. if beilding a Vehicle Management System, create db.veh_vehicle:
+{{{
+db.define_table('veh_vehicle',
+                SQLField('modified_on','datetime',default=now),
+                SQLField('uuid',length=64,default=uuid.uuid4()),
+                SQLField('name'))
+db.veh_vehicle.name.requires=IS_NOT_EMPTY()
+db.veh_vehicle.name.comment=SPAN("*",_class="req")
+}}}
+
 Also add the messages for your resources:
 {{{
-crud_strings_shelter=Storage(title_create=T('Add Shelter'),
-            title_display=T('Organisation Details'),
-            title_list=T('List Shelters'),
-            title_update=T('Edit Shelter'),
-            subtitle_list=T('Shelters'),
-            subtitle_create=T('Add New Shelter'),
-            label_list_button=T('List Shelters'),
+crud_strings_vehicle=Storage(title_create=T('Add Vehicle'),
+            title_display=T('Vehicle Details'),
+            title_list=T('List Vehicles'),
+            title_update=T('Edit Vehicle'),
+            subtitle_list=T('Vehicles'),
+            subtitle_create=T('Add New Vehicle'),
+            label_list_button=T('List Vehicles'),
             label_create_button=T('Add Shelter'),
-            msg_record_created=T('Shelter added'),
-            msg_record_modified=T('Shelter updated'),
-            msg_record_deleted=T('Shelter deleted'),
-            msg_list_empty=T('No Shelters currently registered'))
+            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'))
 }}}
 Copy/paste & do just a few small tweaks once pasted:
  * Search/Replace 'Shelter' with Your_resource
  * Fix plurals, if required (e.g. Persons -> People, Classs -> Classes, Metadatas -> Metadata)
+ * Maybe change phrasing: registered vs defined, etc
 
 === Controller ===
 Add CRUD functions for these tables to {{{/controllers/module.py}}}:
 {{{
-def shelter():
+def vehicle():
     "RESTful CRUD controller"
-    return shn_rest_controller(module,'shelter')
+    return shn_rest_controller(module,'vehicle')
 }}}