Moved all mod.php functions from modules into lib.php, and
[moodle.git] / mod / README
CommitLineData
04eba58f 1This directory contains all the learning modules.
2
3Standard components expected of each module:
4
5mod.html: a form to setup/update a module instance
6version.php: defines some meta-info and provides upgrading code
7icon.gif: a 16x16 icon for the module
8db/mysql.sql: an SQL dump of all the required db tables and data
9index.php: a page to list all instances in a course
10view.php: a page to view a particular instance
11lib.php: any/all functions defined by the module should be in here.
12 constants should be defined using MODULENAME_xxxxxx
13 functions should be defined using modulename_xxxxxx
14
15 There are a number of standard functions:
16
17 modulename_add_instance()
18 modulename_update_instance()
19 modulename_delete_instance()
20
21 modulename_user_complete()
22 modulename_user_outline()
23
24 modulename_cron()
25