Merge pull request #116 from maheshgudi/documentation

Documentation

4 files changed, 208 insertions, 0 deletions

diff --git a/yaksh/documentation/moderator_docs/creating_course.rst b/yaksh/documentation/moderator_docs/creating_course.rst
new file mode 100644
index 0000000..a700971
--- /dev/null
+++ b/yaksh/documentation/moderator_docs/creating_course.rst
@@ -0,0 +1,35 @@
+=======
+Courses
+=======
+
+For students to take a quiz, it is imperative for the moderator to create a course first. 
+
+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.
+
+		* Name 
+			Name of the Course
+		* Active 
+			If the course should be active for students to take the quiz. The status of the course can be edited later.
+		* Enrollment 
+			 Open enrollment is open to all students. Enroll Request requires students to send a request which the moderator can accept or reject.
+
+Features in Courses
+-------------------
+
+	 Click on the Courses link located at the navigation bar, to view all the courses created by the moderator.
+
+	 .. image:: ../images/course_features.jpg
+
+	 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.
+	 	* 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.
+	 	* View Allotted Course
+	 		Clicking on view allotted courses will display the courses the moderator is added to by other course creators.
+
diff --git a/yaksh/documentation/moderator_docs/creating_question.rst b/yaksh/documentation/moderator_docs/creating_question.rst
new file mode 100644
index 0000000..d80b437
--- /dev/null
+++ b/yaksh/documentation/moderator_docs/creating_question.rst
@@ -0,0 +1,94 @@
+=========
+Questions
+=========
+
+Setting up questions
+--------------------
+
+	Setting up questions is the most important part of the Yaksh experience. Questions can be of multiple types i.e Multiple choice questions (MCQ), multiple correct choices (MCC), Coding questions and assignment upload types.
+
+	To set up a question click on the questions link in the navigation bar.
+
+	.. image:: ../images/questions.jpg 
+	
+	To add a question click on the **Add Question** button
+
+	.. image:: ../images/add_question.jpg
+
+	* **Summary**- Summary or the name of the question.
+
+	* **Language** - Programming language on which the question is based.
+
+	* **Active** -  If the question is active to attempt or not.
+
+	* **Type** - Type of the question. i.e Multiple Choice, Multiple Correct Choice, Code and Assignment Upload.
+
+	* **Description** - The actual question description is to be written. 
+
+	.. note::  To add codes in questions please use html <code> and <br> tags.
+
+	* **Tags** - Type of label or metadata tag making it easier to find specific type of questions.
+
+	* **Snippet** - Snippet is used to give any default value or default code or command. This will be displayed in the answer form. This is used only for code questions.
+
+	* **Test case type** - Test cases or answers are to be added. There are multiple type of test cases - 
+		
+		* Standard Test Case which is an assertion based testcase.
+		* Stdout Based Test Case is stdout based test where moderator can provide expected output (Only for Python).
+		* MCQ Based Test Case is testcase for Mcqs and Mccs.
+
+How to write Test cases
+-----------------------
+	
+	The following explains different methods to write test cases.
+
+	* **Create Standard Test Case**
+
+		Select Standard Test Case and click on Save & Add Testcase button to save the question.
+
+		* For Python:
+			In the test case field write a python assert to check the user code.
+			For e.g. :: 
+				
+				assert fact(3) == 6
+			
+			for program of factorial.
+
+		* For C, C++ and Java:
+			In Test Case Field add the test case file path.
+
+		Check Delete Field if a test case is to be removed.
+
+		Finally click on Save & Add Testcase Button to save the test case.
+
+
+	* **Create Standard out Based Test Case**
+
+			Select Stdout Based TestCase from Test Case Type field and click on Save & Add Testcase button to save the question.
+
+			In Expected Output Field type the expected output for a particular question. For e.g type 6 if the output of the user code is 6.
+
+	* **Create MCQ Based Test Case**
+
+		Select MCQ Based TestCase from Test Case Type field and click on Save & Add Testcase button to save the question.
+
+		In Options Field type the option check the correct checkbox if the current option is correct and click on Save & Add Testcase button to save each option.
+
+
+Features in Question
+--------------------
+	
+	* **Download Questions**
+
+			Select questions from the list of question displayed on the Questions page. Click on the Download Selected button to download the questions. This will create a json file of the Questions selected.
+
+	* **Upload Questions**
+			
+			Click on the Upload File button. This will open up a window. Select the json file of questions and click Ok and the questions will be uploaded and displayed on the Questions page.
+
+	* **Test Questions**
+			
+			Select questions from the list of question displayed on the Questions page. Click on Test selected button. This will take you to a quiz with the selected questions. 
+
+			.. Note:: This will not create an actual quiz but a trial quiz. This quiz is hidden from the students and only for moderator to view. You can delete the quiz from moderator's dashboard. 
+
diff --git a/yaksh/documentation/moderator_docs/creating_quiz.rst b/yaksh/documentation/moderator_docs/creating_quiz.rst
new file mode 100644
index 0000000..de0f031
--- /dev/null
+++ b/yaksh/documentation/moderator_docs/creating_quiz.rst
@@ -0,0 +1,59 @@
+=======
+Quizzes
+=======
+
+Quizzes are intrinsically associated with a course, hence to view and/or edit a quiz, we need to navigate to the courses page.
+
+
+
+
+Creating a Quiz
+---------------	
+	.. image:: ../images/add_quiz.jpg
+	
+	.. note :: It is important to have created or uploaded questions before creating a quiz. 
+
+	In courses click on **Add Quiz** button to add a quiz.
+	
+	* **Course** - Select a course from Course field. This field is mandatory.
+	* **Start Date and Time of quiz** - The date and time after which the quiz can be taken.
+	* **End Date and Time of quiz** - The date and time after which the quiz is deactivated and cannot be attempted.
+	* **Duration** - Duration of quiz to be written in minutes.
+	* **Active** - If the quiz is active or not.
+	* **Description** - Description or name of the quiz.
+	* **Passing Percentage** - Minimum percentage required to pass the test.
+	* **Prerequisite** - Set a prerequisite quiz to be passed before attempting the current quiz.
+	* **Language** - Programming language on which the quiz is based.
+	* **Attempts allowed** - Number of attempts that a student can take of the current quiz.
+	* **Number of Days** - Number of days between attempts. 
+
+	Once a quiz parameters have been set click on **design questionpaper** button to add questions into a quiz.
+
+
+Designing Question Paper
+------------------------
+
+	.. image:: ../images/design_questionpaper.jpg
+
+	A quiz can have fixed as well as random questions. Fixed questions are those question that are bound to appear for every student taking the quiz. In random questions a pool of questions is given and number of questions to be picked from the pool is set. Hence for different students, different questions from the pool will appear.
+
+	To add questions to a questionpaper 
+
+	* Select Question type and marks and a list of questions will be displayed will be in the **select questions to add** section. Do this for both fixed questions and random questions.
+
+	* Select shuffle paper if you want to jumble up the question sequence for every student and for every attempt.
+	* Click on save question paper to save it or preview question paper to preview it.
+
+
+Editing a Quiz
+--------------
+
+	In Courses page, click on the quiz link to edit the quiz. Then change the parameters and click on design question paper to save it. This will redirect you to the moderator dashboard.
+
+	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.
+			* You will be notified about quiz prerequisites.(You can still attempt the quiz though)
\ No newline at end of file
diff --git a/yaksh/documentation/moderator_docs/other_features.rst b/yaksh/documentation/moderator_docs/other_features.rst
new file mode 100644
index 0000000..2e670ac
--- /dev/null
+++ b/yaksh/documentation/moderator_docs/other_features.rst
@@ -0,0 +1,20 @@
+==============
+Other Features
+==============
+
+Grade User
+----------
+
+	Grade User is a feature of Yaksh to access students' answer papers for each quiz and grade them where necessary.
+
+Monitor
+-------
+
+	Monitor is a feature of Yaksh where the moderator can monitor a quiz and view statistics.
+
+Trial Papers
+------------
+
+	When a moderator attempts a quiz in User or God mode or tests questions, a trial answer paper is created. Moderator can check the answer paper. 
+
+	.. note:: It is advisable to delete these trial answer papers.
\ No newline at end of file