(no commit message)
authorjoel kronenberg <joel.kronenberg@utoronto.ca>
Wed, 7 Dec 2005 21:17:42 +0000 (21:17 -0000)
committerjoel kronenberg <joel.kronenberg@utoronto.ca>
Wed, 7 Dec 2005 21:17:42 +0000 (21:17 -0000)
docs/documentation/developer/modules.html

index 232a932..51b3027 100644 (file)
@@ -79,9 +79,9 @@ acronym {
        <p>A <em>Hello World</em> example module is included with ATutor for developers who want to investigate this new feature. The module is found in the <kbd>mods/hello_world</kbd> directory.</p>
 
 <h2>Structure</h2>
-       <p>Modules are stored under ATutor's <kbd>mods</kbd> directory. <em>Core</em> modules are stored in the <kbd>mods/_core</kbd> subdirectory and are made available with every release of ATutor. These modules cannot be disabled by the administrator as they are vital to ATutor's functionality. <em>Standard</em> modules are stored in the <kbd>mods/_standard</kbd> subdirectory and are also made available with every release of ATutor. Standard modules can be disabled by the administrator. <em>Extra</em> modules are stored in the <kbd>mods</kbd> directory and are installed and distributed independently of ATutor. Although the process of developing modules is the same for each type of module, only <em>extra</em> modules can be distributed separately, while <em>core</em> and <em>standard</em> modules are added to the ATutor code repository (i.e. <acronym title="Subversion">SVN</acronym> trunk).</p>
+       <p><em>Core</em> and <em>standard</em> modules are stored throughout the ATutor installation as they are made available with every installation. <em>Core</em> modules cannot be disabled by the administrator as they are vital to ATutor's functionality, while <em>standard</em> modules can. <em>Extra</em> modules are stored in the <kbd>mods</kbd> directory and are installed and distributed independently of ATutor. Although the process of developing modules is the same for each type of module, only <em>extra</em> modules can be distributed separately, while <em>core</em> and <em>standard</em> modules are added to the ATutor code repository (i.e. <acronym title="Subversion">SVN</acronym> trunk).</p>
 
-       <p>Whenever a module identifier is needed within code, it should appear in lowercase with spaces converted to underscores.</p>
+       <p>Whenever a module identifier is needed within code, it should appear in lowercase with spaces converted to underscores. At this stage the identifier is created using the directory base name. <em>This will definitely change before ATutor 1.6 is released!</em></p>
 
        <p>The module name, and hence the directory and function names (see below for additional details), must be unique across all possible modules. A module should not be made available if an existing module is already being distributed under that same name. It is up to the module developer to ensure that their module name is unique.</p>