diff options
Diffstat (limited to 'yaksh/documentation/moderator_docs')
| -rw-r--r-- | yaksh/documentation/moderator_docs/creating_course.rst | 94 | ||||
| -rw-r--r-- | yaksh/documentation/moderator_docs/creating_question.rst | 30 |
2 files changed, 61 insertions, 63 deletions
diff --git a/yaksh/documentation/moderator_docs/creating_course.rst b/yaksh/documentation/moderator_docs/creating_course.rst index 44ebe44..d4dc5f8 100644 --- a/yaksh/documentation/moderator_docs/creating_course.rst +++ b/yaksh/documentation/moderator_docs/creating_course.rst @@ -6,47 +6,73 @@ For students to take a quiz, it is imperative for the moderator to create a cour Setting up a new course ----------------------- - To create a course, click on the Add New Course button on the moderator's dashboard. This will lead you to a create add course page, where you need to fill in the following fields. - - .. image:: ../images/create_course.png - - * Name - Name of the Course - * Enrollment - Open enrollment is open to all students. Enroll Request requires students to send a request which the moderator can accept or reject. - * Active - If the course should be active for students to take the quiz. The status of the course can be edited later. - * Code - If the course should be hidden and only accessible to students possessing the correct course code. - * Instructions - 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 - * End Date and Time for enrollment of course - If the enrollment of the course should be available only before a set date and time + To create a course, click on the Add New Course button on the moderator's dashboard. This will lead you to a create add course page, where you need to fill in the following fields. + + .. image:: ../images/create_course.png + + * Name + Name of the Course + * Enrollment + Open enrollment is open to all students. Enroll Request requires students to send a request which the moderator can accept or reject. + * Active + If the course should be active for students to take the quiz. The status of the course can be edited later. + * Code + If the course should be hidden and only accessible to students possessing the correct course code. + * Instructions + 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 + * End Date and Time for enrollment of course + If the enrollment of the course should be available only before a set date and time Features in Courses ------------------- - Click on the Courses link on the navigation bar. + Click on the Courses link on the navigation bar. + + .. image:: ../images/course_features.jpg + + 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 + + * Course Name + Clicking on course name link will display all the enrolled, rejected and requested students list. Moderator can accept or reject the student. + * Quiz Name + Clicking on the quiz name will let you edit the quiz. + * Question Paper + Click on the **Add** link to create a Question Paper for associated Quiz. + If a question paper is already created, click on the Question Paper link to edit question paper. + * Add Teacher + Clicking on Add teacher can let you add teachers for the course. The teachers can edit and modify only the specific course that are allotted to them. + * 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 + Clicking on the edit course button will let you edit the details of an existing course. - .. image:: ../images/course_features.jpg +Features in Course Details +-------------------------- - This page shows all the courses created by a moderator and all the courses allotted to a moderator. + Click on a given course name to go to the course details page. - The following features are available for courses + .. image:: ../images/course_details_features.jpg - * Course Name - Clicking on course name link will display all the enrolled, rejected and requested students list. Moderator can accept or reject the student. - * Quiz Name - Clicking on the quiz name will let you edit the quiz. - * Question Paper - Click on the **Add** link to create a Question Paper for associated Quiz. - If a question paper is already created, click on the Question Paper link to - edit question paper. - * Add Teacher - Clicking on Add teacher can let you add teachers for the course. The teachers can edit and modify only the specific course that are allotted to them. - * Teachers added to the course - This shows all the teachers added to a particular course. + Following are the features for course details - + * 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. + * Deactivate/Activate Course + Clicking on this will deactivate or activate the course. + * 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. + * Clone Course + This will create a clone of the course for the moderator. + * Send Mail + Moderator can send mail to all enrolled students or selected students. diff --git a/yaksh/documentation/moderator_docs/creating_question.rst b/yaksh/documentation/moderator_docs/creating_question.rst index 69bb635..78b6f2c 100644 --- a/yaksh/documentation/moderator_docs/creating_question.rst +++ b/yaksh/documentation/moderator_docs/creating_question.rst @@ -301,36 +301,8 @@ Features in Question Click on the browse button. This will open up a window. Select the zip file of questions and click Ok and then click on Upload file button, questions will be uploaded and displayed on the Questions page. - Zip file should contain **questions_dump.json** from which questions will be loaded. + Zip file should contain **questions_dump.yaml** from which questions will be loaded. Zip file can contain files related to questions. - Sample entry in **questions_dump.json** is as shown below. :: - [{ - "snippet": "", - "testcase": [ - { - "test_case_args": "", - "test_case_type": "standardtestcase", - "weight": 1.0, - "test_case": "Test Case here" - }, - ], - "points": 2.0, - "description": "Question Description here", - "language": "python", - "active": true, - "type": "code", - "files": [[demo1.txt, false], [demo2.zip, true]], - "summary": "Question Summary here" - }] - - .. Note:: 1. In **files** entry in json, the list contains two items which - are filename (demo1.txt) and extract status (false) i.e file needs to extracted or not. - - 2. If there are no files then **files** entry can be empty - i.e it should be "files": []. - - 3. From sample, zip file should contain demo1.txt and demo2.zip since it is - required for question. * **Test Questions** |