From db4b15ada4b078910442984776dbfc20e5955a8c Mon Sep 17 00:00:00 2001
From: maheshgudi
Date: Wed, 11 Jan 2017 14:37:25 +0530
Subject: added docs to hook_evaluator

---
 yaksh/documentation/images/hook_testcase.jpg          | Bin 0 -> 63419 bytes
 .../moderator_docs/creating_question.rst              |  18 ++++++++++++++++++
 2 files changed, 18 insertions(+)
 create mode 100644 yaksh/documentation/images/hook_testcase.jpg

(limited to 'yaksh')

diff --git a/yaksh/documentation/images/hook_testcase.jpg b/yaksh/documentation/images/hook_testcase.jpg
new file mode 100644
index 0000000..3018050
Binary files /dev/null and b/yaksh/documentation/images/hook_testcase.jpg differ
diff --git a/yaksh/documentation/moderator_docs/creating_question.rst b/yaksh/documentation/moderator_docs/creating_question.rst
index ec273f5..f99bf7f 100644
--- a/yaksh/documentation/moderator_docs/creating_question.rst
+++ b/yaksh/documentation/moderator_docs/creating_question.rst
@@ -234,6 +234,24 @@ How to write Test cases
 
 		For MCC based question, check the correct checkbox for multiple correct options.
 
+	* **Create Hook based Test Case**
+
+		Select Hook from Add Test Case field.
+
+		In Hook based test case type, moderator is provided with a evaluator function
+		called **check_answer** which is provided with a parameter called **user_answer**.
+
+		**user_answer** is the code of the student in string format.
+
+		A moderator can check the string for specific words in the user answer
+		and/or compile and execute the user answer (using standard python libraries) to 
+		evaluate and hence return the mark fraction.
+
+
+		.. image:: ../images/hook_testcase.jpg
+				:width: 80%
+
+
 
 Features in Question
 --------------------
-- 
cgit