New module: Label.
[moodle.git] / mod / README
1 This directory contains all the learning modules.
3 Standard components expected of each module:
5   mod.html: a form to setup/update a module instance
7   version.php: defines some meta-info and provides upgrading code
9   icon.gif: a 16x16 icon for the module
11   db/mysql.sql: an SQL dump of all the required db tables and data
12  
13   index.php: a page to list all instances in a course
15   view.php: a page to view a particular instance
17   lib.php: any/all functions defined by the module should be in here.
18          constants should be defined using MODULENAME_xxxxxx
19          functions should be defined using modulename_xxxxxx
21          There are a number of standard functions:
23          modulename_add_instance()
24          modulename_update_instance()
25          modulename_delete_instance()
27          modulename_user_complete()
28          modulename_user_outline()
30          modulename_cron()
32          modulename_print_recent_activity()
34 See newmodule_template.zip in this directory for a blank template 
35 to help you get started.