Commit bad2ab67 by solashirai Committed by Piotr Mitros

updated readme

parent d976d72f
......@@ -11,12 +11,12 @@ An example of after a student corrects their answer
To bring the crowd sourced hinter into a demo course:
First, follow https://github.com/edx/edx-platform/blob/master/docs/en_us/developers/source/xblocks.rst#testing for general xblock creation.
The name of the module to set in the advanced settings tab is "crowdsourcehinter".
Follow https://github.com/edx/edx-platform/wiki/Installing-a-new-XBlock for basic xblock installation. The name of the module to set in the advanced settings tab is "crowdsourcehinter".
After creating a new unit, add the crowdsourcehinter XBlock into a course just like any other XBlock. The name of the crowd sourced hinter may not show up in studio for some unknown reason, but an empty space where its name should be will be clickable (problem to be identified/fixed...).
In studio view, edit the hinter so that the "Problem Element" is set to the "data-usage-id" of the problem block (findable by inspecting element of the problem block). This allows for multiple problems each with their own corresponding hinters to exist on a single page. While setting the Problem Element is crucial, the hinter can function without setting Initial hints or Generic hints.
![CrowdSourceHinter Installation Screenshot](crowdsourcehinter_setup.png)
What It Does:
The two key features of the crowdsource hinter are the abilities to show students hints and to have the students themselves create hints to be shown to future students.
When a student incorrectly answers a problem, the hinter will look through its database to search for a hint that has been stored for that exact incorrect answer input (i.e. when the database is large enough, two different incorrect answers would not receive the same hint). If hints exist for a student's incorrect answer, this hint is shown to the student. The student then may have the opportunity to input their answer again, which may prompt another hint to be displayed.
......
......@@ -85,6 +85,10 @@ function CrowdsourceHinter(runtime, element, data){
getHint(data);
}
}}
//IMPORTANT
//Comment out the listener for "problem_check" and uncomment "problem_graded" on the lavash devstack release.
//problem_check is used in the birch release to detect answer submission
//Logger.listen('problem_check', null, onStudentSubmission());
Logger.listen('problem_graded', data.hinting_element, onStudentSubmission());
/**
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment