--------------------------------------------------------------------------------
Author:Ravishankar Somasundaram
--------------------------------------------------------------------------------

Instructions to install.
------------------------

1. Please take a backup copy of your existing installation just incase, the installation itself is pretty simple and straight forward as you can see below.

2. Copy the files in directories and place it in the same dir tree location if askedfor a replacement just go ahead

 Replace assign.php inside admin/roles/ with the file in this module
 Copy activity_locking folder and place it within the blocks folder of your installation
 Copy the contents of course folder and place it inside course folder of your installtion
 Similarly copy contents of lib and user directories and place it appropriate directories

Note: Language strings has been modified to give a business outlook, for example Category has been changed to Business division(as to group courses with relate to that particular business division), so if you want to go with it then proceed with the usuall copy and paste stuff, 

 Copy the en_utf8_local directory and paste it inside your lang folder 

or else manually pick the strings that you might need for the curriculum part alone(have commented these in the corresponding files)and inject it into your language files, look out for repetitions of placeholders if you are doing the later.

3. And visit the notifications page to make system install necessary things for you.
 
4. And you are good to go now

================================================================================


Usage instructions (Will write a page in moodle docs for this soon)
-------------------

Course hierarchy
----------------

1. There can be a tree hierarchy
2. There can be a parallel hierarchy
3. There can be a serial hierarchy

between courses inside the curriculum, and the admin/teacher has the power to tailor the courses in any of above mentioned hierarchies.

And any student enrolled in a curriculum is enrolled in all the courses within the curriculum but denied access to courses as per the hierarchy structure designed by admin/teacher.


Creation of curriculum:
----------------------

1. It is like a normall course creation but for selection of the course format called "Curriculum" and selecting a Yes as an
option for "Is this a curriculum"

Adding child courses(Curriculum contents) to curriculum:

1. This follows same procedure as moodles child course addition to a meta course and if you are unclear about the same please go ahead and read the following, others can skip the points below in this topic

   i)	Create a normall course with parameters that you intended to have as a part of curriculum.
   ii)	Repeat step 1 till you have enough courses that you would like to structure as sections within a curriculum
   iii)	Now go to Site Administration ->child courses and select your child courses from the list


Assigning roles:
---------------

1. This part is pretty straight forward as same as in normall moodle installations except for that a new scope in roles has been introduced here, you assign a person a role in a curriculum(it follows curriculum wide scop) the same role applies to all child courses within the curriculum.

2. The converse is not true to make provision for new feature called "Ban", which is basically a new role which can be assigned to students and make them not to complete the course/Curriculum for desired time interval by the teacher.


Course completion:
-----------------

Completion of a course for any student occurs on two ways, 

1. Automatic
2. Manual

1. Automatic :
   ----------

   Any student is marked as he completed the course if he completes the dependencies within the course,Once he completes this course automatically the other courses which are dependant on this course opens up

Note: if the teacher did not place any locks/dependencies within the course any student who just visits the course will be marked as completed immediately

2. Manual :
   -------

   A student take a course and even though he finished all locks/dependencies he will not be marked as he completed the course untill the teacher manually does it using the participants page(which appears in the participants block).


Caution: I used the activity locking format to set dependencies/lock within resources/activities which has a possibility to have a circular dependency.(Example: activity1 depends on activity2 completion and activity2 depends on activity1 completion thereby leaving the student no way to finish both)

	 The circular dependency between courses inside a curriculum cannot happen as functionally takes care off it.