summaryrefslogtreecommitdiff
path: root/yaksh/documentation/moderator_docs/creating_course.rst
diff options
context:
space:
mode:
Diffstat (limited to 'yaksh/documentation/moderator_docs/creating_course.rst')
-rw-r--r--yaksh/documentation/moderator_docs/creating_course.rst170
1 files changed, 95 insertions, 75 deletions
diff --git a/yaksh/documentation/moderator_docs/creating_course.rst b/yaksh/documentation/moderator_docs/creating_course.rst
index 5aaddf5..78e9907 100644
--- a/yaksh/documentation/moderator_docs/creating_course.rst
+++ b/yaksh/documentation/moderator_docs/creating_course.rst
@@ -23,11 +23,15 @@ Setting up a new course
* **Code**
If the course should be hidden and only accessible to students possessing the correct course code.
* **Instructions**
- Instructions for the course
+ Instructions for the course.
* **Start Date and Time for enrollment of course**
- If the enrollment of the course should be available only after a set date and time
+ If the enrollment of the course should be available only after a set date and time.
* **End Date and Time for enrollment of course**
- If the enrollment of the course should be available only before a set date and time
+ If the enrollment of the course should be available only before a set date and time.
+ * **Grading System**
+ Add a grading system to the course.
+ * **View Grade**
+ This field allows the student to view the grade if checked else grade is not visible to student.
Features in Courses
@@ -39,98 +43,114 @@ Features in Courses
This page shows all the courses created by a moderator and all the courses allotted to a moderator.
- The following features are available for courses
+ The following options are available in the courses page
+ * **My Courses**
+ Click to show all the courses created by you.
+ * **Add/Edit Course**
+ Click to add the details of a new course.
+ * **Add/View Grading Systems**
+ Add or view grading systems. More info on creating grading system
+ * **Search/Filter Courses**
+ Search the courses by name or filter the course with active and inactive status.
* **Course Name**
- Click on course name link to view all the enrolled, rejected and requested students list. Moderator can accept or reject the student.
- * **Module Name**
- Click to edit a module added to the course
- * **Lesson or Quiz Name**
- Click to edit a Lesson or Quiz added to the course
-
- In edit quiz you can also attempt the quiz in two modes -
- * **God Mode** - In God mode you can attempt quiz without any time or eligibilty constraints.
- * **User Mode** - In user mode you can attempt quiz the way normal users will attempt i.e.
-
- * Quiz will have the same duration as that of the original quiz.
- * Quiz won't start if the course is inactive or the quiz time has expired.
- * **Add Quizzes/Lessons for <module-name>**
- Click to add/delete lessons or quizzes.
- * **Design Course**
- Click to add/delete modules of a course.
- * **Add Teacher**
- Click to add teachers for the course. The teachers can edit and modify only the specific course that are allotted to them.
+ Shows course name of all the created and allotted courses.
+ * **Edit Course**
+ Click this button to edit the corresponding course details.
+ * **Manage Course**
+ This provides more options for the course. For e.g. setting up modules,
+ lessons, quizzes, practice exercises, students enrollments etc.
+ * **Download**
+ This button provides two options. One is to download the course CSV containing student data, Other is to download entire course for offline viewing.
* **Clone Course**
Click to create a copy of a course along with its modules, lessons and quizzes.
- * **Teachers added to the course**
- This shows all the teachers added to a particular course.
- * **Download CSV for the entire course**
- This downloads the CSV file containing the performance of all students in every quiz for a given course.
- * **Edit Course**
- Click to edit the details of an existing course.
- * **Deactivate/Activate Course**
- Click to deactivate or activate the course.
- * **My Courses**
- Click to show all the courses created by you.
- * **Allotted courses**
- Click to view all the courses allotted to you.
- * **Add New Course**
- Click to open course form to create new course.
- * **Add/View Quizzes**
- Click to view all the quizzes created by you or add new quiz.
- * **Add/View Lessons**
- Click to view all the lessons created by you or add new lesson.
- * **Add/View Modules**
- Click to view all the modules created by you or add new module.
-
-
-Design a Course
----------------
+ * **Activate/Deactivate Course**
+ Toogle to activate or deactivate the course.
- Clicking on **Design Course** will show the below page.
- .. image:: ../images/design_course.jpg
+Manage Course
+--------------------------
- **Available Modules** contains all the modules that are not added to a course.
+ Click on the Manage course button to view the course details page.
- To add a module to the course select the checkbox besides the desired module to be added and click **Add to course** button.
+ .. image:: ../images/course_details_features.jpg
- **Chosen Modules** contains all the modules that are added to a course.
+ Following are the features for course details -
- Following parameters can be changed while designing a course:
+ * **Enroll Students**
+ * **Upload Users**
+ Create and enroll users automatically by uploading a csv of the users. The mandatory fields for this csv are - **firstname, lastname, email**. Other fields like **username, password, institute, roll_no, department, remove** fields are optionals.
+ * **Requests**
+ This is a list of students who have requested to be enrolled in the course. Moderator can enroll or reject selected students.
+ * **Enrolled**
+ This is a list of students who have been enrolled in the course. Moderator can reject enrolled students.
+ * **Rejected**
+ This is a list of students who have been rejected for enrollment in a course. Moderator can enroll rejected students.
+ * **Course Modules**
+ Moderator can send mail to all enrolled students or selected students.
- **Order** - Order in which modules are shown to a student.
+ .. image:: ../images/course_modules.jpg
- To change a module's order change the value to a desired order in the textbox under **Order** column and click **Change order**.
+ * **Add Module**
+ Click on this button to add a module to the course. Fill the details
+ of the module and save it.
- **Check Prerequisite** - Check if previous module is completed. Default value is **Yes**.
- For e.g., Assuming a course contains modules **Demo Module** and **Python module** in the given order; a student has to first complete **Demo module** to attempt **Python Module** if the **Check Prerequisite** value for **Python Module** is checked **Yes**.
+ After creating a module for the course, following options are available:
- **Currently** column shows the current value of **Check Prerequisite** which in this case is **Yes**.
+ * **Add Lesson**
+ Add lesson to the corresponding module.
- Select the checkbox from **Change** column under **Check Prerequisite** and click **Change Prerequisite** button to change the value.
+ * **Add Quiz**
+ Add a graded quiz to the correspoding module.
- To remove a module from the course select the checkbox beside every module and click **Remove from course** button.
-
+ * **Add Exercise**
+ Add a ungraded practice exercise to the corresponding module.
-Features in Course Details
---------------------------
+ * **Design Module**
+ This option allows you to change the order of the units added to
+ the module, check for prerequisites of the module and remove a unit from the module.
+ * **Design Course**
+ Clicking on **Design Course** will show the below page.
- Click on a given course name to go to the course details page.
+ .. image:: ../images/design_course.jpg
- .. image:: ../images/course_details_features.jpg
+ * **Available Modules** contains all the modules that are not added to a course.
- Following are the features for course details -
+ To add a module to the course select the checkbox besides the desired module to be added and click **Add to course** button.
+
+ * **Chosen Modules** contains all the modules that are added to a course.
+
+ Following parameters can be changed while designing a course:
+
+ * **Order**
+ Order in which modules are shown to a student.
+
+ To change a module's order change the value to a desired order in the textbox under **Order** column and click **Change order**.
+
+ * **Check Prerequisite Completion**
+ Check if previous module is completed. Default value is **Yes**.
+
+ For e.g., Assuming a course contains modules **Demo Module** and **Trial for trial_course** in the given order; a student has to first complete **Demo module** to attempt **Trial for trial_course** if the **Check Prerequisite** value for **Trial for trial_course** is checked **Yes**.
+
+ **Currently** column shows the current value of **Change Prerequisite Completion** which in this case is **Yes**.
+
+ Select the checkbox from **Change** column under **Check Prerequisite Completion** and click **Change Prerequisite Completion** button to change the value.
+
+ * **Check Prerequisite Passing**
+ Check if previous module is completed. Default value is **Yes**. This is similar to **Check Prerequisite Completion** except that it checks if all the quizzes in the module are passed or not.
+
+ **Currently** column shows the current value of **Change Prerequisite Passing** which in this case is **Yes**.
+
+ Select the checkbox from **Change** column under **Check Prerequisite Passing** and click **Change Prerequisite Passing** button to change the value.
- * **Requests**
- This is a list of students who have requested to be enrolled in the course. Moderator can enroll or reject selected students.
- * **Enrolled**
- This is a list of students who have been enrolled in the course. Moderator can reject enrolled students.
- * **Rejected**
- This is a list of students who have been rejected for enrollment in a course. Moderator can enroll rejected students.
- * **Upload Users**
- Create and enroll users automatically by uploading a csv of the users. The mandatory fields for this csv are - **firstname, lastname, email**. Other fields like **username, password, institute, roll_no, department, remove** fields are optionals.
+ * **Remove Module**
+ To remove a module from the course select the checkbox beside every module and click **Remove from course** button.
+ * **Course Progress**
+ It shows progress made by the students in the course. Moderator can also
+ download the course progress data.
* **Send Mail**
Moderator can send mail to all enrolled students or selected students.
- * **View Course Status**
- View students' progress through the course.
+ * **Add Teachers/TAs**
+ Moderator can search for the users by username, email, first name and last name to add as Teacher/TA to the course.
+ * **Current Teachers/TAs**
+ It shows all the added Teachers/TAs to the course. Added users can view and edit the course, modules, lessons and quizzes available in the course.