Skip to content

E
edx-ora2
Commit 9e3192de by Stephen Sanchez
Options

Adding the Student Training UI

parent 12c5cd8f
Showing with 469 additions and 42 deletions
apps/openassessment/templates/openassessmentblock/student_training/student_training.html
{% load i18n %}
{% load tz %}
{% spaceless %}
{% block list_item %}
<li id="openassessment__student-training" class="openassessment__steps__step step--student-training ui-toggle-visibility">
{% endblock %}
<header class="step__header ui-toggle-visibility__control">
<h2 class="step__title">
<span class="step__counter"></span>
<span class="wrapper--copy">
<span class="step__label">{% trans "Learn to Assess" %}</span>
{% if self_start %}
<span class="step__deadline">{% trans "available" %}
<span class="date">
{{ self_start|utc|date:"N j, Y H:i e" }}
(in {{ self_start|timeuntil }})
</span>
</span>
{% elif training_due %}
<span class="step__deadline">due
<span class="date">
{{ training_due|utc|date:"N j, Y H:i e" }}
(in {{ training_due|timeuntil }})
</span>
</span>
{% endif %}
</span>
</h2>
{% block title %}
<span class="step__status">
<span class="step__status__label">{% trans "This step's status" %}:</span>
<span class="step__status__value">
<span class="copy">{% trans "In Progress" %}</span>
</span>
</span>
{% endblock %}
</header>
{% block body %}
<div class="ui-toggle-visibility__content">
<div class="wrapper--step__content">
<div class="step__content">
<article class="student-training__display" id="student-training">
<header class="student-training__display__header">
<h3 class="student-training__display__title">{% trans "Your Response" %}</h3>
</header>
<div class="student-training__display__response">
{{ training_essay.text|linebreaks }}
</div>
</article>
<form id="student-training--001__assessment" class="student-training__assessment" method="post">
<fieldset class="assessment__fields">
<ol class="list list--fields assessment__rubric">
{% for criterion in training_rubric.criteria %}
<li class="field field--radio is--required assessment__rubric__question ui-toggle-visibility" id="assessment__rubric__question--{{ criterion.order_num }}">
<h4 class="question__title ui-toggle-visibility__control">
<i class="ico icon-caret-right"></i>
<span class="question__title__copy">{{ criterion.prompt }}</span>
<span class="label--required sr">* ({% trans "Required" %})</span>
</h4>
<div class="ui-toggle-visibility__content">
<ol class="question__answers">
{% for option in criterion.options %}
<li class="answer">
<div class="wrapper--input">
<input type="radio"
name="{{ criterion.name }}"
id="assessment__rubric__question--{{ criterion.order_num }}__{{ option.order_num }}"
class="answer__value"
value="{{ option.name }}" />
<label for="assessment__rubric__question--{{ criterion.order_num }}__{{ option.order_num }}"
class="answer__label">{{ option.name }}</label>
</div>
<div class="wrapper--metadata">
<span class="answer__tip">{{ option.explanation }}</span>
<span class="answer__points">{{option.points}} <span class="answer__points__label">{% trans "points" %}</span></span>
</div>
</li>
{% endfor %}
</ol>
</div>
</li>
{% endfor %}
</ol>
</fieldset>
</form>
</div>
<div class="step__actions">
<div class="message message--inline message--error message--error-server">
<h3 class="message__title">{% trans "We could not submit your assessment" %}</h3>
<div class="message__content"></div>
</div>
<ul class="list list--actions">
<li class="list--actions__item">
<button type="submit" id="student-training--001__assessment__submit" class="action action--submit is--disabled">
<span class="copy">{% trans "Check Rubric" %}</span>
<i class="ico icon-caret-right"></i>
</button>
</li>
</ul>
</div>
</div>
</div>
{% endblock %}
</li>
{% endspaceless %}
apps/openassessment/templates/openassessmentblock/student_training/student_training_closed.html
{% extends "openassessmentblock/student_training/student_training.html" %}
{% load i18n %}
{% block list_item %}
<li id="openassessment__student-training" class="openassessment__steps__step step--student-training is--incomplete ui-toggle-visibility">
{% endblock %}
{% block title %}
<span class="step__status">
<span class="step__status__label">{% trans "This step's status" %}:</span>
<span class="step__status__value">
<i class="ico icon-warning-sign"></i>
<span class="copy">{% trans "Incomplete" %}</span>
</span>
</span>
{% endblock %}
{% block body %}
<div class="ui-toggle-visibility__content">
<div class="wrapper--step__content">
<div class="step__message message message--incomplete">
<h3 class="message__title">{% trans "The Due Date for This Step Has Passed" %}</h3>
<div class="message__content">
<p>{% trans "This step is now closed. You can no longer complete a assessment training or continue with this assignment, and you'll receive a grade of Incomplete." %}</p>
</div>
</div>
</div>
</div>
{% endblock %}
apps/openassessment/templates/openassessmentblock/student_training/student_training_complete.html
{% extends "openassessmentblock/student_training/student_training.html" %}
{% load i18n %}
{% block list_item %}
<li id="openassessment__student-training" class="openassessment__steps__step step--student-training is--complete is--empty is--collapsed">
{% endblock %}
{% block title %}
<span class="step__status">
<span class="step__status__label">{% trans "This step's status" %}:</span>
<span class="step__status__value">
<i class="ico icon-ok"></i>
<span class="copy">{% trans "Complete" %}</span>
</span>
</span>
{% endblock %}
{% block body %}
{% endblock %}
apps/openassessment/templates/openassessmentblock/student_training/student_training_unavailable.html
{% extends "openassessmentblock/student_training/student_training.html" %}
{% load i18n %}
{% block list_item %}
<li id="openassessment__student-training" class="openassessment__steps__step step--student-training is--empty is--unavailable is--collapsed">
{% endblock %}
{% block title %}
<span class="step__status">
<span class="step__status__label">{% trans "This step's status" %}:</span>
<span class="step__status__value">
<span class="copy">{% trans "Not Available" %}</span>
</span>
</span>
{% endblock %}
{% block body %}
{% endblock %}
apps/openassessment/workflow/api.py
......@@ -8,6 +8,7 @@ import logging
from django.db import DatabaseError
from openassessment.assessment.api import peer as peer_api
from openassessment.assessment.api import student_training as student_training
from openassessment.assessment.errors import PeerAssessmentError
from submissions import api as sub_api
from .models import AssessmentWorkflow, AssessmentWorkflowStep
......@@ -138,6 +139,8 @@ def create_workflow(submission_uuid, steps):
raise AssessmentWorkflowInternalError(err_msg)
elif steps[0] == "self":
status = AssessmentWorkflow.STATUS.self
elif steps[0] == "training":
status = AssessmentWorkflow.STATUS.training
try:
workflow = AssessmentWorkflow.objects.create(
......
apps/openassessment/workflow/models.py
......@@ -263,7 +263,7 @@ class AssessmentWorkflowStep(models.Model):
"""
from openassessment.assessment.api import peer as peer_api
from openassessment.assessment.api import self as self_api
from openassessment.assessment.api import student_training as student_training
from openassessment.assessment.api import student_training
api = None
if self.name == AssessmentWorkflow.STATUS.self:
api = self_api
......
apps/openassessment/xblock/data_conversion.py 0 → 100644
"""
Data Conversion utility methods for handling ORA2 XBlock data transformations.
"""
def convert_training_examples_list_to_dict(examples_list):
"""
Convert of options selected we store in the problem def,
which is ordered, to the unordered dictionary of options
selected that the student training API expects.
Args:
examples_list (list): A list of options selected against a rubric.
Returns:
A dictionary of the given examples in the list.
Example:
>>> examples = [
>>> {
>>> "answer": "This is my response",
>>> "options_selected": [
>>> {
>>> "criterion": "Ideas",
>>> "option": "Fair"
>>> },
>>> {
>>> "criterion": "Content",
>>> "option": "Good"
>>> }
>>> ]
>>> }
>>> ]
>>> convert_training_examples_list_to_dict(examples)
[
{
'answer': 'This is my response',
'options_selected': {
'Ideas': 'Fair',
'Content': 'Good'
}
}
]
"""
return [
{
'answer': ex['answer'],
'options_selected': {
select_dict['criterion']: select_dict['option']
for select_dict in ex['options_selected']
}
}
for ex in examples_list
]
\ No newline at end of file
apps/openassessment/xblock/defaults.py
......@@ -65,6 +65,40 @@ DEFAULT_RUBRIC_FEEDBACK_PROMPT = """
"""
DEFAULT_STUDENT_TRAINING = {
"name": "student-training",
"start": None,
"due": None,
"examples": [
{
"answer": "Example Calibration Response",
"options_selected": [
{
"criterion": "Ideas",
"option": "Fair"
},
{
"criterion": "Content",
"option": "Good"
}
]
},
{
"answer": "Another Example Calibration Response",
"options_selected": [
{
"criterion": "Ideas",
"option": "Poor"
},
{
"criterion": "Content",
"option": "Good"
}
]
}
]
}
# The Default Peer Assessment is created as an example of how this XBlock can be
# configured. If no configuration is specified, this is the default assessment
# module(s) associated with the XBlock.
......@@ -82,6 +116,7 @@ DEFAULT_SELF_ASSESSMENT = {
}
DEFAULT_ASSESSMENT_MODULES = [
DEFAULT_STUDENT_TRAINING,
DEFAULT_PEER_ASSESSMENT,
DEFAULT_SELF_ASSESSMENT,
]
......
apps/openassessment/xblock/openassessmentblock.py
......@@ -40,6 +40,12 @@ UI_MODELS = {
"navigation_text": "Your response to this problem",
"title": "Your Response"
},
"student-training": {
"name": "student-training",
"class_id": "openassessment__student-training",
"navigation_text": "Learn to assess responses",
"title": "Learn to Assess"
},
"peer-assessment": {
"name": "peer-assessment",
"class_id": "openassessment__peer-assessment",
......@@ -61,6 +67,7 @@ UI_MODELS = {
}
VALID_ASSESSMENT_TYPES = [
"student-training",
"peer-assessment",
"self-assessment",
]
......
apps/openassessment/xblock/static/sass/oa/utilities/_developer.scss
......@@ -73,4 +73,62 @@
.student__answer__display__content p {
color: inherit;
}
// --------------------
// Developer Styles for Student Training
// --------------------
.step--student-training {
// submission
.student-training__display {
@extend %ui-subsection;
}
.student-training__display__header {
@include clearfix();
}
.student-training__display__title {
@extend %t-heading;
margin-bottom: ($baseline-v/2);
color: $heading-secondary-color;
}
.student-training__display__response {
@extend %ui-subsection-content;
@extend %copy-3;
@extend %ui-content-longanswer;
@extend %ui-well;
color: $copy-color;
}
// assessment form
.student-training__assessment {
// fields
.assessment__fields {
margin-bottom: $baseline-v;
}
// rubric question
.assessment__rubric__question {
@extend %ui-rubric-question;
}
// rubric options
.question__answers {
@extend %ui-rubric-answers;
overflow: visible; // needed for ui-hints
}
// genereal feedback question
.assessment__rubric__question--feedback {
textarea {
@extend %ui-content-longanswer;
min-height: ($baseline-v*5);
}
}
}
}
}
\ No newline at end of file
apps/openassessment/xblock/static/xml/censorship_rubric_example.xml
......@@ -63,6 +63,20 @@
</feedbackprompt>
</rubric>
<assessments>
<assessment name="student-training">
<example>
<answer>Censorship is terrible. I don't like it at all.</answer>
<select criterion="concise" option="Matsuo Basho" />
<select criterion="clear-headed" option="Eric" />
<select criterion="form" option="IRC"/>
</example>
<example>
<answer>I love censorship.</answer>
<select criterion="concise" option="Matsuo Basho" />
<select criterion="clear-headed" option="Ian" />
<select criterion="form" option="Old-timey letters"/>
</example>
</assessment>
<assessment name="peer-assessment"
start="2014-12-20T19:00-7:00"
due="2014-12-21T22:22-7:00"
......
apps/openassessment/xblock/student_training_mixin.py
......@@ -6,6 +6,7 @@ from django.utils.translation import ugettext as _
from webob import Response
from xblock.core import XBlock
from openassessment.assessment.api import student_training
from openassessment.xblock.data_conversion import convert_training_examples_list_to_dict
logger = logging.getLogger(__name__)
......@@ -41,7 +42,7 @@ class StudentTrainingMixin(object):
unicode: HTML content of the grade step
"""
if "training" not in self.assessment_steps:
if "student-training" not in self.assessment_steps:
return Response(u"")
try:
......@@ -70,12 +71,15 @@ class StudentTrainingMixin(object):
context = {}
template = 'openassessmentblock/student_training/student_training_unavailable.html'
if not workflow_status:
return template, context
# If the student has completed the training step, then show that the step is complete.
# We put this condition first so that if a student has completed the step, it *always*
# shows as complete.
# We're assuming here that the training step always precedes the other assessment steps
# (peer/self) -- we may need to make this more flexible later.
if workflow_status in ['peer', 'self', 'waiting', 'done']:
if workflow_status and workflow_status != "training":
template = 'openassessmentblock/student_training/student_training_complete.html'
# If the problem is closed, then do not allow students to access the training step
......@@ -89,14 +93,27 @@ class StudentTrainingMixin(object):
# If we're on the training step, show the student an example
# We do this last so we can avoid querying the student training API if possible.
else:
training_module = self.get_assessment_module('student-training')
if not training_module:
return template, context
context['training_due'] = due_date
# Report progress in the student training workflow (completed X out of Y)
status = student_training.get_workflow_status(self.submission_uuid)
context['training_num_completed'] = status['num_completed']
context['training_num_available'] = status['num_total']
context['training_num_available'] = len(training_module["examples"])
context['training_num_completed'] = student_training.get_num_completed(self.submission_uuid)
# Retrieve the example essay for the student to submit
# This will contain the essay text, the rubric, and the options the instructor selected.
example = student_training.get_training_example(self.submission_uuid)
examples = convert_training_examples_list_to_dict(training_module["examples"])
example = student_training.get_training_example(
self.submission_uuid,
{
'prompt': self.prompt,
'criteria': self.rubric_criteria
},
examples
)
context['training_essay'] = example['answer']
context['training_rubric'] = example['rubric']
template = 'openassessmentblock/student_training/student_training.html'
......
apps/openassessment/xblock/test/data/student_training.xml
......@@ -39,22 +39,12 @@
<assessments>
<assessment name="student-training">
<example>
<answer>
𝑨 𝒔𝒖𝒃𝒔𝒕𝒂𝒏𝒄𝒆--𝒕𝒉𝒂𝒕 𝒘𝒉𝒊𝒄𝒉 𝒊𝒔 𝒄𝒂𝒍𝒍𝒆𝒅 𝒂 𝒔𝒖𝒃𝒔𝒕𝒂𝒏𝒄𝒆 𝒎𝒐𝒔𝒕 𝒔𝒕𝒓𝒊𝒄𝒕𝒍𝒚, 𝒑𝒓𝒊𝒎𝒂𝒓𝒊𝒍𝒚,
𝒂𝒏𝒅 𝒎𝒐𝒔𝒕 𝒐𝒇 𝒂𝒍𝒍--𝒊𝒔 𝒕𝒉𝒂𝒕 𝒘𝒉𝒊𝒄𝒉 𝒊𝒔 𝒏𝒆𝒊𝒕𝒉𝒆𝒓 𝒔𝒂𝒊𝒅 𝒐𝒇 𝒂 𝒔𝒖𝒃𝒋𝒆𝒄𝒕 𝒐𝒏 𝒐𝒓 𝒊𝒏 𝒂 𝒔𝒖𝒃𝒋𝒆𝒄𝒕,
𝒆.𝒈. 𝒕𝒉𝒆 𝒊𝒏𝒅𝒊𝒗𝒊𝒅𝒖𝒂𝒍 𝒎𝒂𝒏 𝒐𝒓 𝒕𝒉𝒆 𝒊𝒏𝒅𝒊𝒗𝒊𝒅𝒖𝒂𝒍 𝒉𝒐𝒓𝒔𝒆.
</answer>
<answer>This is my answer.</answer>
<select criterion="Vocabulary" option="Good" />
<select criterion="Grammar" option="Excellent" />
</example>
<example>
<answer>
Їḟ ẗḧëṛë ïṡ ṡöṁë ëṅḋ öḟ ẗḧë ẗḧïṅġṡ ẅë ḋö, ẅḧïċḧ ẅë ḋëṡïṛë ḟöṛ ïẗṡ öẅṅ ṡäḳë,
ċḷëäṛḷÿ ẗḧïṡ ṁüṡẗ ḅë ẗḧë ġööḋ. Ẅïḷḷ ṅöẗ ḳṅöẅḷëḋġë öḟ ïẗ, ẗḧëṅ, ḧäṿë ä ġṛëäẗ
ïṅḟḷüëṅċë öṅ ḷïḟë? Ṡḧäḷḷ ẅë ṅöẗ, ḷïḳë äṛċḧëṛṡ ẅḧö ḧäṿë ä ṁäṛḳ ẗö äïṁ äẗ,
ḅë ṁöṛë ḷïḳëḷÿ ẗö ḧïẗ üṗöṅ ẅḧäẗ ẅë ṡḧöüḷḋ? Їḟ ṡö, ẅë ṁüṡẗ ẗṛÿ, ïṅ öüẗḷïṅë äẗ ḷëäṡẗ,
ẗö ḋëẗëṛṁïṅë ẅḧäẗ ïẗ ïṡ.
</answer>
<answer>тєѕт αηѕωєя</answer>
<select criterion="Vocabulary" option="Excellent" />
<select criterion="Grammar" option="Poor" />
</example>
......
apps/openassessment/xblock/test/data/student_training_mixin.json 0 → 100644
{
"simple": {
"expected_template": "openassessmentblock/student_training/student_training.html",
"expected_context": {
"training_num_completed": 0,
"training_num_available": 2,
"training_due": "9999-01-01T00:00:00+00:00",
"training_essay": "This is my answer.",
"training_rubric": {
"id": 2,
"content_hash": "de2bb2b7e2c6e3df014e53b8c65f37d511cc4344",
"criteria": [
{
"order_num": 0,
"name": "Vocabulary",
"prompt": "How varied is the vocabulary?",
"options": [
{
"order_num": 0,
"points": 0,
"name": "Poor",
"explanation": "Poor job"
},
{
"order_num": 1,
"points": 1,
"name": "Good",
"explanation": "Good job"
},
{
"order_num": 2,
"points": 3,
"name": "Excellent",
"explanation": "Excellent job"
}
],
"points_possible": 3
},
{
"order_num": 1,
"name": "Grammar",
"prompt": "How correct is the grammar?",
"options": [
{
"order_num": 0,
"points": 0,
"name": "Poor",
"explanation": "Poor job"
},
{
"order_num": 1,
"points": 1,
"name": "Good",
"explanation": "Good job"
},
{
"order_num": 2,
"points": 3,
"name": "Excellent",
"explanation": "Excellent job"
}
],
"points_possible": 3
}
],
"points_possible": 6
}
}
}
}
\ No newline at end of file
apps/openassessment/xblock/validation.py
......@@ -6,6 +6,7 @@ from django.utils.translation import ugettext as _
from openassessment.assessment.serializers import rubric_from_dict, InvalidRubric
from openassessment.assessment.api.student_training import validate_training_examples
from openassessment.xblock.resolve_dates import resolve_dates, DateValidationError, InvalidDateFormat
from openassessment.xblock.data_conversion import convert_training_examples_list_to_dict
def _match_by_order(items, others):
......@@ -228,27 +229,15 @@ def _validate_assessment_examples(rubric_dict, assessments):
for asmnt in assessments:
if asmnt['name'] == 'student-training':
# Convert of options selected we store in the problem def,
# which is ordered, to the unordered dictionary of options
# selected that the student training API expects.
examples = [
{
'answer': ex['answer'],
'options_selected': {
select_dict['criterion']: select_dict['option']
for select_dict in ex['options_selected']
}
}
for ex in asmnt['examples']
]
examples = convert_training_examples_list_to_dict(asmnt['examples'])
# Delegate to the student training API to validate the
# examples against the rubric.
errors = validate_training_examples(rubric_dict, examples)
if errors:
return (False, "\n".join(errors))
return False, "\n".join(errors)
return (True, u'')
return True, u''
def validator(oa_block, strict_post_release=True):
......
apps/openassessment/xblock/workflow_mixin.py
......@@ -60,17 +60,22 @@ class WorkflowMixin(object):
dict
"""
assessment_ui_model = self.get_assessment_module('peer-assessment')
requirements = {}
if not assessment_ui_model:
return {}
peer_assessment_module = self.get_assessment_module('peer-assessment')
if peer_assessment_module:
requirements["peer"] = {
"must_grade": peer_assessment_module["must_grade"],
"must_be_graded_by": peer_assessment_module["must_be_graded_by"]
}
return {
"peer": {
"must_grade": assessment_ui_model["must_grade"],
"must_be_graded_by": assessment_ui_model["must_be_graded_by"]
training_module = self.get_assessment_module('student-training')
if training_module:
requirements["training"] = {
"num_required": len(training_module["examples"])
}
}
return requirements
def update_workflow_status(self, submission_uuid=None):
"""
......
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