summaryrefslogtreecommitdiff
path: root/yaksh
diff options
context:
space:
mode:
authoradityacp2018-02-27 11:30:52 +0530
committeradityacp2018-02-27 11:30:52 +0530
commit9270ce3fdc25d56554889b45f87a227009b76d48 (patch)
tree050ab12f798a2c751eb44e8545174c88e0f38e46 /yaksh
parent5986f457c1345b74f6a5d8f5223b901f36d515d7 (diff)
downloadonline_test-9270ce3fdc25d56554889b45f87a227009b76d48.tar.gz
online_test-9270ce3fdc25d56554889b45f87a227009b76d48.tar.bz2
online_test-9270ce3fdc25d56554889b45f87a227009b76d48.zip
Change documentation for courses, modules and quizzes
Diffstat (limited to 'yaksh')
-rw-r--r--yaksh/documentation/moderator_docs/creating_course.rst55
-rw-r--r--yaksh/documentation/moderator_docs/creating_lessons_modules.rst9
-rw-r--r--yaksh/documentation/moderator_docs/creating_quiz.rst6
3 files changed, 36 insertions, 34 deletions
diff --git a/yaksh/documentation/moderator_docs/creating_course.rst b/yaksh/documentation/moderator_docs/creating_course.rst
index 87a1d1c..ba3605a 100644
--- a/yaksh/documentation/moderator_docs/creating_course.rst
+++ b/yaksh/documentation/moderator_docs/creating_course.rst
@@ -3,9 +3,10 @@ Courses
=======
For students to take a quiz, it is imperative for the moderator to create a course first.
-A course contains modules and module contains lessons and quizzes.
+A course can contain several modules and a module can contain several lessons and/or quizzes.
-To create modules, lessons and quizzes go to the Lessons and Modules, Quizzes section of the documentation.
+To create modules, lessons and quizzes go to the :doc:`creating_lessons_modules`
+and :doc:`creating_quiz` section of the documentation.
Setting up a new course
-----------------------
@@ -41,7 +42,7 @@ Features in Courses
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.
+ 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**
@@ -53,35 +54,34 @@ Features in Courses
* 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.
- * You will be notified about quiz prerequisites.(You can still attempt the quiz though)
* **Add Quizzes/Lessons for <module-name>**
- Click to add/change/delete lessons or quizzes.
- * **My Courses**
- Clicking on this will show all the courses created by you.
- * **Allotted courses**
- Clicking on this will show all the courses allotted to you.
- * **Add New Course**
- Clicking on this will open course form to create new course.
- * **Add/View Quizzes**
- Click to view all the created quizzes and add new quizzes.
- * **Add/View Lessons**
- Click to view all the created lessons and add new lessons.
- * **Add/View Modules**
- Click to view all the created modules and add new modules.
+ Click to add/delete lessons or quizzes.
* **Design Course**
- Click to add/delete/change modules.
+ Click to add/delete modules of a course.
* **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.
+ Click to add teachers for the course. The teachers can edit and modify only the specific course that are allotted to them.
* **Clone Course**
- This will create a clone of the course for the moderator.
+ 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**
- Clicking on the edit course button will let you edit the details of an existing course.
+ Click to edit the details of an existing course.
* **Deactivate/Activate Course**
- Clicking on this will deactivate or activate the 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
@@ -93,18 +93,18 @@ Design a Course
**Available Modules** contains all the modules that are not added to a course.
- To add a module to the course select the checkbox beside every module and click **Add to course** button.
+ To add a module to the course select the checkbox besides the desired module to be added and click **Add to course** button.
- **Choosen Modules** contains all the modules that are added to a course.
+ **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 in the textbox under **Order** column and click **Change order**.
+ To change a module's order change the value to a desired index/order in the textbox under **Order** column and click **Change order**.
**Check Prerequisite** - Check if previous module is completed. Default value is **Yes**.
- For e.g. A student has to first complete **Demo module** to attempt **Python Module** if the 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 value is **Yes**.
**Currently** column shows the current value of **Check Prerequisite** which in this case is **Yes**.
@@ -113,9 +113,6 @@ Design a Course
To remove a module from the course select the checkbox beside every module and click **Remove from course** button.
-
-
-
Features in Course Details
--------------------------
diff --git a/yaksh/documentation/moderator_docs/creating_lessons_modules.rst b/yaksh/documentation/moderator_docs/creating_lessons_modules.rst
index d417731..e70c0a7 100644
--- a/yaksh/documentation/moderator_docs/creating_lessons_modules.rst
+++ b/yaksh/documentation/moderator_docs/creating_lessons_modules.rst
@@ -1,3 +1,5 @@
+.. _creating_lessons_modules:
+
===================
Lessons and Modules
===================
@@ -5,11 +7,10 @@ Lessons and Modules
Courses can have lessons and quizzes encapsulated using a module.
* **What is a lesson?**
- A lesson can be any markdown text or an embedded video of a particular topic.
+ A lesson can be any markdown text with/or an embedded video of a particular topic.
* **What is a module?**
- A module encapsulates lessons and quizzes. A module can have its own description
- as a markdown text or an embedded video.
+ A Module is a collection of lessons and courses clubbed together by similar idea/content. A module can have its own description as a markdown text with/or an embedded video.
Setting up a Lesson
@@ -59,7 +60,7 @@ Setting up a Module
Design a Module
---------------
- To add lesson or quizzes to a module click on **Add Quizzes/Lessons for <module-name>**.
+ To add lessons or quizzes to a module click on **Add Quizzes/Lessons for <module-name>**.
.. image:: ../images/design_module.jpg
diff --git a/yaksh/documentation/moderator_docs/creating_quiz.rst b/yaksh/documentation/moderator_docs/creating_quiz.rst
index 3acdf5f..3968a64 100644
--- a/yaksh/documentation/moderator_docs/creating_quiz.rst
+++ b/yaksh/documentation/moderator_docs/creating_quiz.rst
@@ -1,3 +1,5 @@
+.. _creating_quiz:
+
=======
Quizzes
=======
@@ -44,7 +46,9 @@ Creating a Exercise
.. image:: ../images/add_exercise.jpg
Exercise is similar to quiz with a difference that exercise has infinite attempts and
- exercise time depends on per question time. It also does not allow a student to skip the question.
+ infinite time. It also does not allow a student to skip the question.
+ Each question in an exercise can be timed i.e. time to solve a particular question.
+ Once the question time expires question solution is shown to the student.
All the parameters are set by default only below parameters can be changed.