c9c41529475250fc7df0a65351848dad12dcf62d
[moodle.git] / mod / README.txt
1 ACTIVITY MODULES
2 ----------------
4 These are main modules in Moodle, allowing various activities.
7 Each of these modules contains a number of expected components:
9   mod_form.php: a form to setup/update a module instance
11   version.php: defines some meta-info and provides upgrading code
13   pix/icon.gif: a 16x16 icon for the module
15   db/install.xml: an SQL dump of all the required db tables and data
17   index.php: a page to list all instances in a course
19   view.php: a page to view a particular instance
21   lib.php: any/all functions defined by the module should be in here.
22          constants should be defined using MODULENAME_xxxxxx
23          functions should be defined using modulename_xxxxxx
25          There are a number of standard functions:
27          modulename_add_instance()
28          modulename_update_instance()
29          modulename_delete_instance()
31          modulename_user_complete()
32          modulename_user_outline()
34          modulename_cron()
36          modulename_print_recent_activity()
39 If you are a developer and interested in developing new Modules see:
41    Moodle Documentation:  http://moodle.org/doc
42    Moodle Community:      http://moodle.org/community