Merge branch 'master' into feature/will/move_correct_mark_for_multiple_choice

cms/djangoapps/contentstore/features/advanced-settings.feature

+Feature: Advanced (manual) course policy
+  In order to specify course policy settings for which no custom user interface exists
+  I want to be able to manually enter JSON key/value pairs
+
+  Scenario: A course author sees only display_name on a newly created course
+    Given I have opened a new course in Studio
+    When I select the Advanced Settings
+    Then I see only the display name
+
+  Scenario: Test if there are no policy settings without existing UI controls
+    Given I am on the Advanced Course Settings page in Studio
+    When I delete the display name
+    Then there are no advanced policy settings
+    And I reload the page
+    Then there are no advanced policy settings
+
+  Scenario: Test cancel editing key name
+    Given I am on the Advanced Course Settings page in Studio
+    When I edit the name of a policy key
+    And I press the "Cancel" notification button
+    Then the policy key name is unchanged
+
+  Scenario: Test editing key name
+    Given I am on the Advanced Course Settings page in Studio
+    When I edit the name of a policy key
+    And I press the "Save" notification button
+    Then the policy key name is changed
+
+  Scenario: Test cancel editing key value
+    Given I am on the Advanced Course Settings page in Studio
+    When I edit the value of a policy key
+    And I press the "Cancel" notification button
+    Then the policy key value is unchanged
+
+  Scenario: Test editing key value
+    Given I am on the Advanced Course Settings page in Studio
+    When I edit the value of a policy key
+    And I press the "Save" notification button
+    Then the policy key value is changed
+
+  Scenario: Add new entries, and they appear alphabetically after save
+    Given I am on the Advanced Course Settings page in Studio
+    When I create New Entries
+    Then they are alphabetized
+    And I reload the page
+    Then they are alphabetized
+
+  Scenario: Test how multi-line input appears
+    Given I am on the Advanced Course Settings page in Studio
+    When I create a JSON object
+    Then it is displayed as formatted

cms/djangoapps/contentstore/features/advanced-settings.py

+from lettuce import world, step
+from common import *
+import time
+
+from nose.tools import assert_equal
+from nose.tools import assert_true
+
+"""
+http://selenium.googlecode.com/svn/trunk/docs/api/py/webdriver/selenium.webdriver.common.keys.html
+"""
+from selenium.webdriver.common.keys import Keys
+
+
+############### ACTIONS ####################
+@step('I select the Advanced Settings$')
+def i_select_advanced_settings(step):
+    expand_icon_css = 'li.nav-course-settings i.icon-expand'
+    if world.browser.is_element_present_by_css(expand_icon_css):
+        css_click(expand_icon_css)
+    link_css = 'li.nav-course-settings-advanced a'
+    css_click(link_css)
+
+
+@step('I am on the Advanced Course Settings page in Studio$')
+def i_am_on_advanced_course_settings(step):
+    step.given('I have opened a new course in Studio')
+    step.given('I select the Advanced Settings')
+
+
+# TODO: this is copied from terrain's step.py. Need to figure out how to share that code.
+@step('I reload the page$')
+def reload_the_page(step):
+    world.browser.reload()
+
+
+@step(u'I edit the name of a policy key$')
+def edit_the_name_of_a_policy_key(step):
+    policy_key_css = 'input.policy-key'
+    e = css_find(policy_key_css).first
+    e.fill('new')
+
+
+@step(u'I press the "([^"]*)" notification button$')
+def press_the_notification_button(step, name):
+    world.browser.click_link_by_text(name)
+
+
+@step(u'I edit the value of a policy key$')
+def edit_the_value_of_a_policy_key(step):
+    """
+    It is hard to figure out how to get into the CodeMirror
+    area, so cheat and do it from the policy key field :)
+    """
+    policy_key_css = 'input.policy-key'
+    e = css_find(policy_key_css).first
+    e._element.send_keys(Keys.TAB, Keys.END, Keys.ARROW_LEFT, ' ', 'X')
+
+
+@step('I delete the display name$')
+def delete_the_display_name(step):
+    delete_entry(0)
+    click_save()
+
+
+@step('create New Entries$')
+def create_new_entries(step):
+    create_entry("z", "apple")
+    create_entry("a", "zebra")
+    click_save()
+
+
+@step('I create a JSON object$')
+def create_JSON_object(step):
+    create_entry("json", '{"key": "value", "key_2": "value_2"}')
+    click_save()
+
+
+############### RESULTS ####################
+@step('I see only the display name$')
+def i_see_only_display_name(step):
+    assert_policy_entries(["display_name"], ['"Robot Super Course"'])
+
+
+@step('there are no advanced policy settings$')
+def no_policy_settings(step):
+    assert_policy_entries([], [])
+
+
+@step('they are alphabetized$')
+def they_are_alphabetized(step):
+    assert_policy_entries(["a", "display_name", "z"], ['"zebra"', '"Robot Super Course"', '"apple"'])
+
+
+@step('it is displayed as formatted$')
+def it_is_formatted(step):
+    assert_policy_entries(["display_name", "json"], ['"Robot Super Course"', '{\n    "key": "value",\n    "key_2": "value_2"\n}'])
+
+
+@step(u'the policy key name is unchanged$')
+def the_policy_key_name_is_unchanged(step):
+    policy_key_css = 'input.policy-key'
+    e = css_find(policy_key_css).first
+    assert_equal(e.value, 'display_name')
+
+
+@step(u'the policy key name is changed$')
+def the_policy_key_name_is_changed(step):
+    policy_key_css = 'input.policy-key'
+    e = css_find(policy_key_css).first
+    assert_equal(e.value, 'new')
+
+
+@step(u'the policy key value is unchanged$')
+def the_policy_key_value_is_unchanged(step):
+    policy_value_css = 'li.course-advanced-policy-list-item div.value textarea'
+    e = css_find(policy_value_css).first
+    assert_equal(e.value, '"Robot Super Course"')
+
+
+@step(u'the policy key value is changed$')
+def the_policy_key_value_is_unchanged(step):
+    policy_value_css = 'li.course-advanced-policy-list-item div.value textarea'
+    e = css_find(policy_value_css).first
+    assert_equal(e.value, '"Robot Super Course X"')
+
+
+############# HELPERS ###############
+def create_entry(key, value):
+    # Scroll down the page so the button is visible
+    world.scroll_to_bottom()
+    css_click_at('a.new-advanced-policy-item', 10, 10)
+    new_key_css = 'div#__new_advanced_key__ input'
+    new_key_element = css_find(new_key_css).first
+    new_key_element.fill(key)
+#   For some reason have to get the instance for each command (get error that it is no longer attached to the DOM)
+#   Have to do all this because Selenium has a bug that fill does not remove existing text
+    new_value_css = 'div.CodeMirror textarea'
+    css_find(new_value_css).last.fill("")
+    css_find(new_value_css).last._element.send_keys(Keys.DELETE, Keys.DELETE)
+    css_find(new_value_css).last.fill(value)
+
+
+def delete_entry(index):
+    """ 
+    Delete the nth entry where index is 0-based
+    """
+    css = '.delete-button'
+    assert_true(world.browser.is_element_present_by_css(css, 5))
+    delete_buttons = css_find(css)
+    assert_true(len(delete_buttons) > index, "no delete button exists for entry " + str(index))
+    delete_buttons[index].click()
+
+
+def assert_policy_entries(expected_keys, expected_values):
+    assert_entries('.key input', expected_keys)
+    assert_entries('.json', expected_values)
+
+
+def assert_entries(css, expected_values):
+    webElements = css_find(css)
+    assert_equal(len(expected_values), len(webElements))
+#   Sometimes get stale reference if I hold on to the array of elements
+    for counter in range(len(expected_values)):
+        assert_equal(expected_values[counter], css_find(css)[counter].value)
+
+
+def click_save():
+    css = ".save-button"
+
+    def is_shown(driver):
+        visible = css_find(css).first.visible
+        if visible:
+            # Even when waiting for visible, this fails sporadically. Adding in a small wait.
+            time.sleep(float(1))
+        return visible
+    wait_for(is_shown)
+    css_click(css)
+
+
+def fill_last_field(value):
+    newValue = css_find('#__new_advanced_key__ input').first
+    newValue.fill(value)

cms/djangoapps/contentstore/features/common.py

 from lettuce import world, step
-from factories import *
-from django.core.management import call_command
 from lettuce.django import django_url
-from django.conf import settings
-from django.core.management import call_command
 from nose.tools import assert_true
 from nose.tools import assert_equal
+from selenium.webdriver.support.ui import WebDriverWait
+
+from terrain.factories import UserFactory, RegistrationFactory, UserProfileFactory
+from terrain.factories import CourseFactory, GroupFactory
 import xmodule.modulestore.django
+from auth.authz import get_user_by_email
 
 from logging import getLogger
 logger = getLogger(__name__)
@@ -44,6 +45,13 @@ def i_press_the_category_delete_icon(step, category):
         assert False, 'Invalid category: %s' % category
     css_click(css)
 
+
+@step('I have opened a new course in Studio$')
+def i_have_opened_a_new_course(step):
+    clear_courses()
+    log_into_studio()
+    create_a_course()
+
 ####### HELPER FUNCTIONS ##############
 
 
@@ -86,13 +94,38 @@ def assert_css_with_text(css, text):
 
 
 def css_click(css):
+    assert_true(world.browser.is_element_present_by_css(css, 5))
     world.browser.find_by_css(css).first.click()
 
 
+def css_click_at(css, x=10, y=10):
+    '''
+    A method to click at x,y coordinates of the element
+    rather than in the center of the element
+    '''
+    assert_true(world.browser.is_element_present_by_css(css, 5))
+    e = world.browser.find_by_css(css).first
+    e.action_chains.move_to_element_with_offset(e._element, x, y)
+    e.action_chains.click()
+    e.action_chains.perform()
+
+
 def css_fill(css, value):
     world.browser.find_by_css(css).first.fill(value)
 
 
+def css_find(css):
+    return world.browser.find_by_css(css)
+
+
+def wait_for(func):
+    WebDriverWait(world.browser.driver, 10).until(func)
+
+
+def id_find(id):
+    return world.browser.find_by_id(id)
+
+
 def clear_courses():
     flush_xmodule_store()
 
@@ -129,9 +162,18 @@ def log_into_studio(
 
 
 def create_a_course():
-    css_click('a.new-course-button')
-    fill_in_course_info()
-    css_click('input.new-course-save')
+    c = CourseFactory.create(org='MITx', course='999', display_name='Robot Super Course')
+
+    # Add the user to the instructor group of the course
+    # so they will have the permissions to see it in studio
+    g = GroupFactory.create(name='instructor_MITx/999/Robot_Super_Course')
+    u = get_user_by_email('robot+studio@edx.org')
+    u.groups.add(g)
+    u.save()
+    world.browser.reload()
+
+    course_link_css = 'span.class-name'
+    css_click(course_link_css)
     course_title_css = 'span.course-title'
     assert_true(world.browser.is_element_present_by_css(course_title_css, 5))
 

cms/djangoapps/contentstore/features/section.py

@@ -4,13 +4,6 @@ from common import *
 ############### ACTIONS ####################
 
 
-@step('I have opened a new course in Studio$')
-def i_have_opened_a_new_course(step):
-    clear_courses()
-    log_into_studio()
-    create_a_course()
-
-
 @step('I click the new section link$')
 def i_click_new_section_link(step):
     link_css = 'a.new-courseware-section-button'
@@ -46,6 +39,7 @@ def i_save_a_new_section_release_date(step):
     css_fill(time_css, '12:00am')
     css_click('a.save-button')
 
+
 ############ ASSERTIONS ###################
 
 

cms/djangoapps/contentstore/tests/test_course_settings.py

 import datetime
-import time
 import json
-import calendar
 import copy
 from util import converters
 from util.converters import jsdate_to_time
@@ -11,7 +9,6 @@ from django.test.client import Client
 from django.core.urlresolvers import reverse
 from django.utils.timezone import UTC
 
-import xmodule
 from xmodule.modulestore import Location
 from cms.djangoapps.models.settings.course_details import (CourseDetails,
                                                     CourseSettingsEncoder)
@@ -22,6 +19,10 @@ from django.test import TestCase
 from utils import ModuleStoreTestCase
 from xmodule.modulestore.tests.factories import CourseFactory
 
+from cms.djangoapps.models.settings.course_metadata import CourseMetadata
+from xmodule.modulestore.xml_importer import import_from_xml
+from xmodule.modulestore.django import modulestore
+
 
 # YYYY-MM-DDThh:mm:ss.s+/-HH:MM
 class ConvertersTestCase(TestCase):
@@ -261,3 +262,64 @@ class CourseGradingTest(CourseTestCase):
         test_grader.graders[1]['drop_count'] = test_grader.graders[1].get('drop_count') + 1
         altered_grader = CourseGradingModel.update_grader_from_json(test_grader.course_location, test_grader.graders[1])
         self.assertDictEqual(test_grader.graders[1], altered_grader, "drop_count[1] + 2")
+
+class CourseMetadataEditingTest(CourseTestCase):
+    def setUp(self):
+        CourseTestCase.setUp(self)
+        # add in the full class too
+        import_from_xml(modulestore(), 'common/test/data/', ['full'])
+        self.fullcourse_location = Location(['i4x','edX','full','course','6.002_Spring_2012', None])
+
+
+    def test_fetch_initial_fields(self):
+        test_model = CourseMetadata.fetch(self.course_location)
+        self.assertIn('display_name', test_model, 'Missing editable metadata field')
+        self.assertEqual(test_model['display_name'], 'Robot Super Course', "not expected value")
+
+        test_model = CourseMetadata.fetch(self.fullcourse_location)
+        self.assertNotIn('graceperiod', test_model, 'blacklisted field leaked in')
+        self.assertIn('display_name', test_model, 'full missing editable metadata field')
+        self.assertEqual(test_model['display_name'], 'Testing', "not expected value")
+        self.assertIn('rerandomize', test_model, 'Missing rerandomize metadata field')
+        self.assertIn('showanswer', test_model, 'showanswer field ')
+        self.assertIn('xqa_key', test_model, 'xqa_key field ')
+
+    def test_update_from_json(self):
+        test_model = CourseMetadata.update_from_json(self.course_location,
+            { "a" : 1,
+              "b_a_c_h" : { "c" : "test" },
+              "test_text" : "a text string"})
+        self.update_check(test_model)
+        # try fresh fetch to ensure persistence
+        test_model = CourseMetadata.fetch(self.course_location)
+        self.update_check(test_model)
+        # now change some of the existing metadata
+        test_model = CourseMetadata.update_from_json(self.course_location,
+            { "a" : 2,
+              "display_name" : "jolly roger"})
+        self.assertIn('display_name', test_model, 'Missing editable metadata field')
+        self.assertEqual(test_model['display_name'], 'jolly roger', "not expected value")
+        self.assertIn('a', test_model, 'Missing revised a metadata field')
+        self.assertEqual(test_model['a'], 2, "a not expected value")
+
+    def update_check(self, test_model):
+        self.assertIn('display_name', test_model, 'Missing editable metadata field')
+        self.assertEqual(test_model['display_name'], 'Robot Super Course', "not expected value")
+        self.assertIn('a', test_model, 'Missing new a metadata field')
+        self.assertEqual(test_model['a'], 1, "a not expected value")
+        self.assertIn('b_a_c_h', test_model, 'Missing b_a_c_h metadata field')
+        self.assertDictEqual(test_model['b_a_c_h'], { "c" : "test" }, "b_a_c_h not expected value")
+        self.assertIn('test_text', test_model, 'Missing test_text metadata field')
+        self.assertEqual(test_model['test_text'], "a text string", "test_text not expected value")
+
+
+    def test_delete_key(self):
+        test_model = CourseMetadata.delete_key(self.fullcourse_location, { 'deleteKeys' : ['doesnt_exist', 'showanswer', 'xqa_key']})
+        # ensure no harm
+        self.assertNotIn('graceperiod', test_model, 'blacklisted field leaked in')
+        self.assertIn('display_name', test_model, 'full missing editable metadata field')
+        self.assertEqual(test_model['display_name'], 'Testing', "not expected value")
+        self.assertIn('rerandomize', test_model, 'Missing rerandomize metadata field')
+        # check for deletion effectiveness
+        self.assertNotIn('showanswer', test_model, 'showanswer field still in')
+        self.assertNotIn('xqa_key', test_model, 'xqa_key field still in')
\ No newline at end of file

cms/djangoapps/contentstore/views.py

@@ -58,8 +58,8 @@ from cms.djangoapps.models.settings.course_details import CourseDetails,\
     CourseSettingsEncoder
 from cms.djangoapps.models.settings.course_grading import CourseGradingModel
 from cms.djangoapps.contentstore.utils import get_modulestore
-from lxml import etree
 from django.shortcuts import redirect
+from cms.djangoapps.models.settings.course_metadata import CourseMetadata
 
 # to install PIL on MacOSX: 'easy_install http://dist.repoze.org/PIL-1.1.6.tar.gz'
 
@@ -365,7 +365,6 @@ def preview_component(request, location):
         'editor': wrap_xmodule(component.get_html, component, 'xmodule_edit.html')(),
     })
 
-
 @expect_json
 @login_required
 @ensure_csrf_cookie
@@ -682,7 +681,6 @@ def create_draft(request):
 
     return HttpResponse()
 
-
 @login_required
 @expect_json
 def publish_draft(request):
@@ -712,7 +710,6 @@ def unpublish_unit(request):
 
     return HttpResponse()
 
-
 @login_required
 @expect_json
 def clone_item(request):
@@ -901,7 +898,6 @@ def remove_user(request, location):
 def landing(request, org, course, coursename):
     return render_to_response('temp-course-landing.html', {})
 
-
 @login_required
 @ensure_csrf_cookie
 def static_pages(request, org, course, coursename):
@@ -1005,7 +1001,6 @@ def edit_tabs(request, org, course, coursename):
         'components': components
         })
 
-
 def not_found(request):
     return render_to_response('error.html', {'error': '404'})
 
@@ -1041,7 +1036,6 @@ def course_info(request, org, course, name, provided_id=None):
         'handouts_location': Location(['i4x', org, course, 'course_info', 'handouts']).url()
     })
 
-
 @expect_json
 @login_required
 @ensure_csrf_cookie
@@ -1112,7 +1106,6 @@ def module_info(request, module_location):
     else:
         return HttpResponseBadRequest()
 
-
 @login_required
 @ensure_csrf_cookie
 def get_course_settings(request, org, course, name):
@@ -1159,6 +1152,28 @@ def course_config_graders_page(request, org, course, name):
         'course_details': json.dumps(course_details, cls=CourseSettingsEncoder)
     })
 
+@login_required
+@ensure_csrf_cookie
+def course_config_advanced_page(request, org, course, name):
+    """
+    Send models and views as well as html for editing the advanced course settings to the client.
+
+    org, course, name: Attributes of the Location for the item to edit
+    """
+    location = ['i4x', org, course, 'course', name]
+
+    # check that logged in user has permissions to this item
+    if not has_access(request.user, location):
+        raise PermissionDenied()
+
+    course_module = modulestore().get_item(location)
+
+    return render_to_response('settings_advanced.html', {
+        'context_course': course_module,
+        'course_location' : location,
+        'advanced_blacklist' : json.dumps(CourseMetadata.FILTERED_LIST),
+        'advanced_dict' : json.dumps(CourseMetadata.fetch(location)),
+    })
 
 @expect_json
 @login_required
@@ -1191,7 +1206,6 @@ def course_settings_updates(request, org, course, name, section):
         return HttpResponse(json.dumps(manager.update_from_json(request.POST), cls=CourseSettingsEncoder),
                             mimetype="application/json")
 
-
 @expect_json
 @login_required
 @ensure_csrf_cookie
@@ -1226,6 +1240,37 @@ def course_grader_updates(request, org, course, name, grader_index=None):
         return HttpResponse(json.dumps(CourseGradingModel.update_grader_from_json(Location(['i4x', org, course, 'course', name]), request.POST)),
                             mimetype="application/json")
 
+        
+## NB: expect_json failed on ["key", "key2"] and json payload
+@login_required
+@ensure_csrf_cookie
+def course_advanced_updates(request, org, course, name):
+    """
+    restful CRUD operations on metadata. The payload is a json rep of the metadata dicts. For delete, otoh,
+    the payload is either a key or a list of keys to delete.
+
+    org, course: Attributes of the Location for the item to edit
+    """
+    location = ['i4x', org, course, 'course', name]
+    
+    # check that logged in user has permissions to this item
+    if not has_access(request.user, location):
+        raise PermissionDenied()
+
+    # NB: we're setting Backbone.emulateHTTP to true on the client so everything comes as a post!!!
+    if request.method == 'POST' and 'HTTP_X_HTTP_METHOD_OVERRIDE' in request.META:
+        real_method = request.META['HTTP_X_HTTP_METHOD_OVERRIDE']
+    else:
+        real_method = request.method
+        
+    if real_method == 'GET':
+        return HttpResponse(json.dumps(CourseMetadata.fetch(location)), mimetype="application/json")
+    elif real_method == 'DELETE':
+        return HttpResponse(json.dumps(CourseMetadata.delete_key(location, json.loads(request.body))), mimetype="application/json")
+    elif real_method == 'POST' or real_method == 'PUT':
+        # NOTE: request.POST is messed up because expect_json cloned_request.POST.copy() is creating a defective entry w/ the whole payload as the key
+        return HttpResponse(json.dumps(CourseMetadata.update_from_json(location, json.loads(request.body))), mimetype="application/json")
+
 
 @login_required
 @ensure_csrf_cookie
@@ -1286,7 +1331,6 @@ def asset_index(request, org, course, name):
 def edge(request):
     return render_to_response('university_profiles/edge.html', {})
 
-
 @login_required
 @expect_json
 def create_new_course(request):
@@ -1342,7 +1386,6 @@ def create_new_course(request):
 
     return HttpResponse(json.dumps({'id': new_course.location.url()}))
 
-
 def initialize_course_tabs(course):
     # set up the default tabs
     # I've added this because when we add static tabs, the LMS either expects a None for the tabs list or
@@ -1360,7 +1403,6 @@ def initialize_course_tabs(course):
 
     modulestore('direct').update_metadata(course.location.url(), course.own_metadata)
 
-
 @ensure_csrf_cookie
 @login_required
 def import_course(request, org, course, name):
@@ -1438,7 +1480,6 @@ def import_course(request, org, course, name):
                         course_module.location.name])
         })
 
-
 @ensure_csrf_cookie
 @login_required
 def generate_export_course(request, org, course, name):
@@ -1490,7 +1531,6 @@ def export_course(request, org, course, name):
         'successful_import_redirect_url': ''
     })
 
-
 def event(request):
     '''
     A noop to swallow the analytics call so that cms methods don't spook and poor developers looking at

cms/djangoapps/models/settings/course_metadata.py

+from xmodule.modulestore import Location
+from contentstore.utils import get_modulestore
+from xmodule.x_module import XModuleDescriptor
+
+
+class CourseMetadata(object):
+    '''
+    For CRUD operations on metadata fields which do not have specific editors on the other pages including any user generated ones.
+    The objects have no predefined attrs but instead are obj encodings of the editable metadata.
+    '''
+    # __new_advanced_key__ is used by client not server; so, could argue against it being here
+    FILTERED_LIST = XModuleDescriptor.system_metadata_fields + ['start', 'end', 'enrollment_start', 'enrollment_end', 'tabs', 'graceperiod', '__new_advanced_key__']
+    
+    @classmethod
+    def fetch(cls, course_location):
+        """
+        Fetch the key:value editable course details for the given course from persistence and return a CourseMetadata model.
+        """
+        if not isinstance(course_location, Location):
+            course_location = Location(course_location)
+            
+        course = {}
+        
+        descriptor = get_modulestore(course_location).get_item(course_location)
+        
+        for k, v in descriptor.metadata.iteritems():
+            if k not in cls.FILTERED_LIST:
+                course[k] = v
+                
+        return course
+        
+    @classmethod
+    def update_from_json(cls, course_location, jsondict):
+        """
+        Decode the json into CourseMetadata and save any changed attrs to the db.
+        
+        Ensures none of the fields are in the blacklist.
+        """
+        descriptor = get_modulestore(course_location).get_item(course_location)
+        
+        dirty = False
+
+        for k, v in jsondict.iteritems():
+            # should it be an error if one of the filtered list items is in the payload?
+            if k not in cls.FILTERED_LIST and (k not in descriptor.metadata or descriptor.metadata[k] != v):
+                dirty = True
+                descriptor.metadata[k] = v
+            
+        if dirty:
+            get_modulestore(course_location).update_metadata(course_location, descriptor.metadata)
+            
+        # Could just generate and return a course obj w/o doing any db reads, but I put the reads in as a means to confirm
+        # it persisted correctly
+        return cls.fetch(course_location)
+    
+    @classmethod
+    def delete_key(cls, course_location, payload):
+        '''
+        Remove the given metadata key(s) from the course. payload can be a single key or [key..]
+        '''
+        descriptor = get_modulestore(course_location).get_item(course_location)
+        
+        for key in payload['deleteKeys']:
+            if key in descriptor.metadata:
+                del descriptor.metadata[key]
+    
+        get_modulestore(course_location).update_metadata(course_location, descriptor.metadata)
+        
+        return cls.fetch(course_location)
+        
\ No newline at end of file

cms/static/client_templates/advanced_entry.html

+<li class="field-group course-advanced-policy-list-item">
+	<div class="field text key" id="<%= (_.isEmpty(key) ? '__new_advanced_key__' : key) %>">
+		<label for="<%= keyUniqueId %>">Policy Key:</label>
+		<input type="text" class="short policy-key" id="<%= keyUniqueId %>" value="<%= key %>" />
+		<span class="tip tip-stacked">Keys are case	sensitive and cannot contain spaces or start with a number</span>
+  </div>
+  
+  <div class="field text value">
+    <label for="<%= valueUniqueId %>">Policy Value:</label>
+    <textarea class="json text" id="<%= valueUniqueId %>"><%= value %></textarea>
+  </div>
+	
+	<div class="actions">
+		<a href="#" class="button delete-button standard remove-item remove-grading-data"><span class="delete-icon"></span>Delete</a>
+	</div>
+</li>
\ No newline at end of file

cms/static/js/models/settings/advanced.js

+if (!CMS.Models['Settings']) CMS.Models.Settings = {};
+
+CMS.Models.Settings.Advanced = Backbone.Model.extend({
+    // the key for a newly added policy-- before the user has entered a key value
+    new_key : "__new_advanced_key__",
+
+    defaults: {
+        // the properties are whatever the user types in (in addition to whatever comes originally from the server)
+    },
+    // which keys to send as the deleted keys on next save
+    deleteKeys : [],
+    blacklistKeys : [], // an array which the controller should populate directly for now [static not instance based]
+
+    validate: function (attrs) {
+        var errors = {};
+        for (var key in attrs) {
+            if (key === this.new_key || _.isEmpty(key)) {
+                errors[key] = "A key must be entered.";
+            }
+            else if (_.contains(this.blacklistKeys, key)) {
+                errors[key] = key + " is a reserved keyword or can be edited on another screen";
+            }
+        }
+        if (!_.isEmpty(errors)) return errors;
+    },
+    
+    save : function (attrs, options) {
+        // wraps the save call w/ the deletion of the removed keys after we know the saved ones worked
+        options = options ? _.clone(options) : {};
+        // add saveSuccess to the success
+        var success = options.success;
+        options.success = function(model, resp, options) {
+          model.afterSave(model);
+          if (success) success(model, resp, options);
+        };
+        Backbone.Model.prototype.save.call(this, attrs, options);
+    },
+    
+    afterSave : function(self) {
+        // remove deleted attrs
+        if (!_.isEmpty(self.deleteKeys)) {
+            // remove the to be deleted keys from the returned model
+            _.each(self.deleteKeys, function(key) { self.unset(key); });
+            // not able to do via backbone since we're not destroying the model
+            $.ajax({
+                url : self.url,
+                // json to and fro
+                contentType : "application/json",
+                dataType : "json",
+                // delete
+                type : 'DELETE',
+                // data
+                data : JSON.stringify({ deleteKeys : self.deleteKeys})
+            })
+            .fail(function(hdr, status, error) { CMS.ServerError(self, "Deleting keys:" + status); })
+            .done(function(data, status, error) {
+                // clear deleteKeys on success
+                self.deleteKeys = [];
+            });
+        }
+    }
+});

cms/static/js/template_loader.js

@@ -5,7 +5,7 @@
 	if (typeof window.templateLoader == 'function') return;
 	
     var templateLoader = {
-      templateVersion: "0.0.12",
+      templateVersion: "0.0.15",
       templates: {},
       loadRemoteTemplate: function(templateName, filename, callback) {
         if (!this.templates[templateName]) {

cms/static/js/views/settings/advanced_view.js

+if (!CMS.Views['Settings']) CMS.Views.Settings = {};
+
+CMS.Views.Settings.Advanced = CMS.Views.ValidatingView.extend({
+    error_saving : "error_saving",
+    successful_changes: "successful_changes",
+
+    // Model class is CMS.Models.Settings.Advanced
+    events : {
+        'click .delete-button' : "deleteEntry",
+        'click .new-button' : "addEntry",
+        // update model on changes
+        'change .policy-key' : "updateKey",
+        // keypress to catch alpha keys and backspace/delete on some browsers
+        'keypress .policy-key' : "showSaveCancelButtons",
+        // keyup to catch backspace/delete reliably
+        'keyup .policy-key' : "showSaveCancelButtons",
+        'focus :input' : "focusInput",
+        'blur :input' : "blurInput"
+        // TODO enable/disable save based on validation (currently enabled whenever there are changes)
+    },
+    initialize : function() {
+        var self = this;
+        // instantiates an editor template for each update in the collection
+        window.templateLoader.loadRemoteTemplate("advanced_entry",
+            "/static/client_templates/advanced_entry.html",
+            function (raw_template) {
+                self.template = _.template(raw_template);
+                self.render();
+            }
+        );
+        // because these are outside of this.$el, they can't be in the event hash
+        $('.save-button').on('click', this, this.saveView);
+        $('.cancel-button').on('click', this, this.revertView);
+        this.model.on('error', this.handleValidationError, this);
+    },
+    render: function() {
+        // catch potential outside call before template loaded
+        if (!this.template) return this;
+
+        var listEle$ = this.$el.find('.course-advanced-policy-list');
+        listEle$.empty();
+        
+        // b/c we've deleted all old fields, clear the map and repopulate
+        this.fieldToSelectorMap = {};
+        this.selectorToField = {};
+
+        // iterate through model and produce key : value editors for each property in model.get
+        var self = this;
+        _.each(_.sortBy(_.keys(this.model.attributes), _.identity),
+            function(key) {
+                listEle$.append(self.renderTemplate(key, self.model.get(key)));
+            });
+
+        var policyValues = listEle$.find('.json');
+        _.each(policyValues, this.attachJSONEditor, this);
+        this.showMessage();
+        return this;
+    },
+    attachJSONEditor : function (textarea) {
+        // Since we are allowing duplicate keys at the moment, it is possible that we will try to attach
+        // JSON Editor to a value that already has one. Therefore only attach if no CodeMirror peer exists.
+        if ( $(textarea).siblings().hasClass('CodeMirror')) {
+            return;
+        }
+
+        var self = this;
+        var oldValue = $(textarea).val();
+        CodeMirror.fromTextArea(textarea, {
+            mode: "application/json", lineNumbers: false, lineWrapping: false,
+            onChange: function(instance, changeobj) {
+                // this event's being called even when there's no change :-(
+                if (instance.getValue() !== oldValue) self.showSaveCancelButtons();
+            },
+            onFocus : function(mirror) {
+              $(textarea).parent().children('label').addClass("is-focused");
+            },
+            onBlur: function (mirror) {
+                $(textarea).parent().children('label').removeClass("is-focused");
+                var key = $(mirror.getWrapperElement()).closest('.field-group').children('.key').attr('id');
+                var stringValue = $.trim(mirror.getValue());
+                // update CodeMirror to show the trimmed value.
+                mirror.setValue(stringValue);
+                var JSONValue = undefined;
+                try {
+                    JSONValue = JSON.parse(stringValue);
+                } catch (e) {
+                    // If it didn't parse, try converting non-arrays/non-objects to a String.
+                    // But don't convert single-quote strings, which are most likely errors.
+                    var firstNonWhite = stringValue.substring(0, 1);
+                    if (firstNonWhite !== "{" && firstNonWhite !== "[" && firstNonWhite !== "'") {
+                        try {
+                            stringValue = '"'+stringValue +'"';
+                            JSONValue = JSON.parse(stringValue);
+                            mirror.setValue(stringValue);
+                        } catch(quotedE) {
+                            // TODO: validation error
+                            console.log("Error with JSON, even after converting to String.");
+                            console.log(quotedE);
+                            JSONValue = undefined;
+                        }
+                    }
+                    else {
+                        // TODO: validation error
+                        console.log("Error with JSON, but will not convert to String.");
+                        console.log(e);
+                    }
+                }
+                if (JSONValue !== undefined) {
+                    self.clearValidationErrors();
+                    self.model.set(key, JSONValue, {validate: true});
+                }
+            }
+        });
+    },
+
+    showMessage: function (type) {
+        this.$el.find(".message-status").removeClass("is-shown");
+        if (type) {
+            if (type === this.error_saving) {
+                this.$el.find(".message-status.error").addClass("is-shown");
+            }
+            else if (type === this.successful_changes) {
+                this.$el.find(".message-status.confirm").addClass("is-shown");
+                this.hideSaveCancelButtons();
+            }
+        }
+        else {
+            // This is the case of the page first rendering, or when Cancel is pressed.
+            this.hideSaveCancelButtons();
+            this.toggleNewButton(true);
+        }
+    },
+
+    showSaveCancelButtons: function(event) {
+        if (!this.buttonsVisible) {
+            if (event && (event.type === 'keypress' || event.type === 'keyup')) {
+                // check whether it's really an altering event: note, String.fromCharCode(keyCode) will 
+                // give positive values for control/command/option-letter combos; so, don't use it
+                if (!((event.charCode && String.fromCharCode(event.charCode) !== "") ||
+                        // 8 = backspace, 46 = delete
+                        event.keyCode === 8 || event.keyCode === 46)) return;
+            }
+            this.$el.find(".message-status").removeClass("is-shown");
+            $('.wrapper-notification').addClass('is-shown');
+            this.buttonsVisible = true;
+        }
+    },
+
+    hideSaveCancelButtons: function() {
+        $('.wrapper-notification').removeClass('is-shown');
+        this.buttonsVisible = false;
+    },
+
+    toggleNewButton: function (enable) {
+        var newButton = this.$el.find(".new-button");
+        if (enable) {
+            newButton.removeClass('disabled');
+        }
+        else {
+            newButton.addClass('disabled');
+        }
+    },
+
+    deleteEntry : function(event) {
+        event.preventDefault();
+        // find out which entry
+        var li$ = $(event.currentTarget).closest('li');
+        // Not data b/c the validation view uses it for a selector
+        var key = $('.key', li$).attr('id');
+
+        delete this.selectorToField[this.fieldToSelectorMap[key]];
+        delete this.fieldToSelectorMap[key];
+        if (key !== this.model.new_key) {
+            this.model.deleteKeys.push(key);
+            this.model.unset(key);
+        }
+        li$.remove();
+        this.showSaveCancelButtons();
+    },
+    saveView : function(event) {
+        // TODO one last verification scan:
+        //    call validateKey on each to ensure proper format
+        //    check for dupes
+        var self = event.data;
+        self.model.save({},
+            {
+            success : function() {
+                self.render();
+                self.showMessage(self.successful_changes);
+            },
+            error : CMS.ServerError
+        });
+    },
+    revertView : function(event) {
+        var self = event.data;
+        self.model.deleteKeys = [];
+        self.model.clear({silent : true});
+        self.model.fetch({
+            success : function() { self.render(); },
+            error : CMS.ServerError
+        });
+    },
+    addEntry : function() {
+        var listEle$ = this.$el.find('.course-advanced-policy-list');
+        var newEle = this.renderTemplate("", "");
+        listEle$.append(newEle);
+        // need to re-find b/c replaceWith seems to copy rather than use the specific ele instance
+        var policyValueDivs = this.$el.find('#' + this.model.new_key).closest('li').find('.json');
+        // only 1 but hey, let's take advantage of the context mechanism
+        _.each(policyValueDivs, this.attachJSONEditor, this);
+        this.toggleNewButton(false);
+    },
+    updateKey : function(event) {
+        var parentElement = $(event.currentTarget).closest('.key');
+        // old key: either the key as in the model or new_key.
+        // That is, it doesn't change as the val changes until val is accepted.
+        var oldKey = parentElement.attr('id');
+        // TODO: validation of keys with spaces. For now at least trim strings to remove initial and
+        // trailing whitespace
+        var newKey = $.trim($(event.currentTarget).val());
+        if (oldKey !== newKey) {
+            // TODO: is it OK to erase other validation messages?
+            this.clearValidationErrors();
+
+            if (!this.validateKey(oldKey, newKey)) return;
+
+            if (this.model.has(newKey)) {
+                var error = {};
+                error[oldKey] = 'You have already defined "' + newKey + '" in the manual policy definitions.';
+                error[newKey] = "You tried to enter a duplicate of this key.";
+                this.model.trigger("error", this.model, error);
+                return false;
+            }
+
+            // explicitly call validate to determine whether to proceed (relying on triggered error means putting continuation in the success
+            // method which is uglier I think?)
+            var newEntryModel = {};
+            // set the new key's value to the old one's
+            newEntryModel[newKey] = (oldKey === this.model.new_key ? '' : this.model.get(oldKey));
+
+            var validation = this.model.validate(newEntryModel);
+            if (validation) {
+                if (_.has(validation, newKey)) {
+                    // swap to the key which the map knows about
+                    validation[oldKey] = validation[newKey];
+                }
+                this.model.trigger("error", this.model, validation);
+                // abandon update
+                return;
+            }
+
+            // Now safe to actually do the update
+            this.model.set(newEntryModel);
+
+            // update maps
+            var selector = this.fieldToSelectorMap[oldKey];
+            this.selectorToField[selector] = newKey;
+            this.fieldToSelectorMap[newKey] = selector;
+            delete this.fieldToSelectorMap[oldKey];
+
+            if (oldKey !== this.model.new_key) {
+                // mark the old key for deletion and delete from field maps
+                this.model.deleteKeys.push(oldKey);
+                this.model.unset(oldKey) ;
+            }
+            else {
+                // id for the new entry will now be the key value. Enable new entry button.
+                this.toggleNewButton(true);
+            }
+            
+            // check for newkey being the name of one which was previously deleted in this session
+            var wasDeleting = this.model.deleteKeys.indexOf(newKey);
+            if (wasDeleting >= 0) {
+                this.model.deleteKeys.splice(wasDeleting, 1);
+            }
+
+            // Update the ID to the new value.
+            parentElement.attr('id', newKey);
+            
+        }
+    },
+    validateKey : function(oldKey, newKey) {
+        // model validation can't handle malformed keys nor notice if 2 fields have same key; so, need to add that chk here
+        // TODO ensure there's no spaces or illegal chars (note some checking for spaces currently done in model's
+        // validate method.
+        return true;
+    },
+
+    renderTemplate: function (key, value) {
+        var newKeyId = _.uniqueId('policy_key_'),
+        newEle = this.template({ key : key, value : JSON.stringify(value, null, 4),
+            keyUniqueId: newKeyId, valueUniqueId: _.uniqueId('policy_value_')});
+        
+        this.fieldToSelectorMap[(_.isEmpty(key) ? this.model.new_key : key)] = newKeyId;
+        this.selectorToField[newKeyId] = (_.isEmpty(key) ? this.model.new_key : key);
+        return newEle;
+    },
+    
+    focusInput : function(event) {
+        $(event.target).prev().addClass("is-focused");
+    },
+    blurInput : function(event) {
+        $(event.target).prev().removeClass("is-focused");
+    }
+});
\ No newline at end of file

cms/static/js/views/settings/main_settings_view.js

-if (!CMS.Views['Settings']) CMS.Views.Settings = {}; // ensure the pseudo pkg exists
+if (!CMS.Views['Settings']) CMS.Views.Settings = {};
 
 CMS.Views.Settings.Details = CMS.Views.ValidatingView.extend({
     // Model class is CMS.Models.Settings.CourseDetails
     events : {
-        "blur input" : "updateModel",
-        "blur textarea" : "updateModel",
+        "change input" : "updateModel",
+        "change textarea" : "updateModel",
         'click .remove-course-syllabus' : "removeSyllabus",
         'click .new-course-syllabus' : 'assetSyllabus',
         'click .remove-course-introduction-video' : "removeVideo",

cms/static/js/views/settings/settings_grading_view.js

@@ -3,9 +3,9 @@ if (!CMS.Views['Settings']) CMS.Views.Settings = {}; // ensure the pseudo pkg ex
 CMS.Views.Settings.Grading = CMS.Views.ValidatingView.extend({
     // Model class is CMS.Models.Settings.CourseGradingPolicy
     events : {
-        "blur input" : "updateModel",
-        "blur textarea" : "updateModel",
-        "blur span[contenteditable=true]" : "updateDesignation",
+        "change input" : "updateModel",
+        "change textarea" : "updateModel",
+        "change span[contenteditable=true]" : "updateDesignation",
         "click .settings-extra header" : "showSettingsExtras",
         "click .new-grade-button" : "addNewGrade",
         "click .remove-button" : "removeGrade",
@@ -310,8 +310,8 @@ CMS.Views.Settings.Grading = CMS.Views.ValidatingView.extend({
 CMS.Views.Settings.GraderView = CMS.Views.ValidatingView.extend({
     // Model class is CMS.Models.Settings.CourseGrader
     events : {
-        "blur input" : "updateModel",
-        "blur textarea" : "updateModel",
+        "change input" : "updateModel",
+        "change textarea" : "updateModel",
         "click .remove-grading-data" : "deleteModel",
         // would love to move to a general superclass, but event hashes don't inherit in backbone :-(
         'focus :input' : "inputFocus",

cms/static/js/views/validating_view.js

@@ -10,8 +10,8 @@ CMS.Views.ValidatingView = Backbone.View.extend({
     errorTemplate : _.template('<span class="message-error"><%= message %></span>'),
 
     events : {
-        "blur input" : "clearValidationErrors",
-        "blur textarea" : "clearValidationErrors"
+        "change input" : "clearValidationErrors",
+        "change textarea" : "clearValidationErrors"
     },
     fieldToSelectorMap : {
         // Your subclass must populate this w/ all of the model keys and dom selectors 

cms/static/sass/_alerts.scss

+// notifications
+.wrapper-notification {
+	@include clearfix();
+	@include box-sizing(border-box);
+	@include transition (bottom 2.0s ease-in-out 5s);
+	@include box-shadow(0 -1px 2px rgba(0,0,0,0.1));
+	position: fixed;
+	bottom: -100px;
+	z-index: 1000;
+	width: 100%;
+	overflow: hidden;
+	opacity: 0;
+	border-top: 1px solid $darkGrey;
+	padding: 20px 40px;
+
+	&.is-shown {
+		bottom: 0;
+		opacity: 1.0;
+	}
+
+	&.wrapper-notification-warning {
+		border-color: shade($yellow, 25%);
+		background: tint($yellow, 25%);
+	}
+
+	&.wrapper-notification-error {
+		border-color: shade($red, 50%);
+		background: tint($red, 20%);
+		color: $white;
+	}
+
+	&.wrapper-notification-confirm {
+		border-color: shade($green, 30%);
+		background: tint($green, 40%);
+		color: shade($green, 30%);
+	}
+}
+
+.notification {
+	@include box-sizing(border-box);
+	margin: 0 auto;
+	width: flex-grid(12);
+	max-width: $fg-max-width;
+	min-width: $fg-min-width;
+
+	.copy {
+		float: left;
+		width: flex-grid(9, 12);
+		margin-right: flex-gutter();
+		margin-top: 5px;
+		font-size: 14px;
+
+		.icon {
+			display: inline-block;
+			vertical-align: top;
+			margin-right: 5px;
+			font-size: 20px;
+		}
+
+		p {
+			width: flex-grid(8, 9);
+			display: inline-block;
+			vertical-align: top;
+		}
+	}
+
+	.actions {
+		float: right;
+		width: flex-grid(3, 12);
+		margin-top: ($baseline/2);
+		text-align: right;
+
+		li {
+			display: inline-block;
+			vertical-align: middle;
+			margin-right: 10px;
+
+			&:last-child {
+				margin-right: 0;
+			}
+		}
+
+		.save-button {
+			@include blue-button;
+		}
+
+		.cancel-button {
+		  @include white-button;
+		}
+	}
+
+	strong {
+		font-weight: 700;
+	}
+}
+
+// adopted alerts
 .alert {
 	padding: 15px 20px;
 	margin-bottom: 30px;

cms/static/sass/_settings.scss

@@ -14,6 +14,44 @@ body.course.settings {
     padding: $baseline ($baseline*1.5);
   }
 
+  // messages - should be synced up with global messages in the future
+  .message {
+    display: block;
+    font-size: 14px;
+  }
+
+  .message-status {
+    display: none;
+    @include border-top-radius(2px);
+    @include box-sizing(border-box);
+    border-bottom: 2px solid $yellow;
+    margin: 0 0 20px 0;
+    padding: 10px 20px;
+    font-weight: 500;
+    background: $paleYellow;
+
+    .text {
+      display: inline-block;
+    }
+
+    &.error {
+      border-color: shade($red, 50%);
+      background: tint($red, 20%);
+      color: $white;
+    }
+
+    &.confirm {
+      border-color: shade($green, 50%);
+      background: tint($green, 20%);
+      color: $white;
+    }
+
+    &.is-shown {
+      display: block;
+    }
+  }
+
+  // in form - elements
   .group-settings {
     margin: 0 0 ($baseline*2) 0;
 
@@ -45,7 +83,12 @@ body.course.settings {
 
     }
 
-    // UI hints/tips/messages
+    // in form  -UI hints/tips/messages
+    .instructions {
+      @include font-size(14);
+      margin: 0 0 $baseline 0;
+    }
+
     .tip {
       @include transition(color, 0.15s, ease-in-out);
       @include font-size(13);
@@ -576,6 +619,119 @@ body.course.settings {
         }
       }
     }
+
+    // specific fields - advanced settings
+    &.advanced-policies {
+
+      .field-group {
+        margin-bottom: ($baseline*1.5);
+
+        &:last-child {
+          border: none;
+          padding-bottom: 0;
+        }
+      }
+
+      .course-advanced-policy-list-item {
+        @include clearfix();
+        position: relative;
+
+        .field {
+
+          input {
+            width: 100%;
+          }
+
+          .tip {
+            @include transition (opacity 0.5s ease-in-out 0s);
+            opacity: 0;
+            position: absolute;
+            bottom: ($baseline*1.25);
+          }
+
+          input:focus {
+
+            & + .tip {
+              opacity: 1.0;
+            }
+          }
+
+          input.error {
+
+            & + .tip {
+              opacity: 0;
+            }
+          }
+        }
+
+        .key, .value {
+          float: left;
+          margin: 0 0 ($baseline/2) 0;
+        }
+
+       .key {
+         width: flex-grid(3, 9);
+         margin-right: flex-gutter();
+        }
+
+        .value {
+          width: flex-grid(6, 9);
+        }
+
+        .actions {
+          float: left;
+          width: flex-grid(9, 9);
+
+          .delete-button {
+            margin: 0;
+          }
+        }
+      }
+
+      .message-error {
+        position: absolute;
+        bottom: ($baseline*0.75);
+      }
+
+      // specific to code mirror instance in JSON policy editing, need to sync up with other similar code mirror UIs
+      .CodeMirror {
+        @include font-size(16);
+        @include box-sizing(border-box);
+        @include box-shadow(0 1px 2px rgba(0, 0, 0, .1) inset);
+        @include linear-gradient($lightGrey, tint($lightGrey, 90%));
+        padding: 5px 8px;
+        border: 1px solid $mediumGrey;
+        border-radius: 2px;
+        background-color: $lightGrey;
+        font-family: 'Open Sans', sans-serif;
+        color: $baseFontColor;
+        outline: 0;
+
+        &.CodeMirror-focused {
+          @include linear-gradient($paleYellow, tint($paleYellow, 90%));
+          outline: 0;
+        }
+
+        .CodeMirror-scroll {
+          overflow: hidden;
+          height: auto;
+          min-height: ($baseline*1.5);
+          max-height: ($baseline*10);
+        }
+
+        // editor color changes just for JSON
+        .CodeMirror-lines {
+
+          .cm-string {
+            color: #cb9c40;
+          }
+
+          pre {
+            line-height: 2.0rem;
+          }
+        }
+      }
+    }
   }
 
   .content-supplementary {

cms/templates/settings.html

@@ -23,7 +23,8 @@ from contentstore import utils
   
   <script type="text/javascript">
     $(document).ready(function(){
-    
+      
+      // hilighting labels when fields are focused in
       $("form :input").focus(function() {
         $("label[for='" + this.id + "']").addClass("is-focused");
       }).blur(function() {
@@ -205,7 +206,7 @@ from contentstore import utils
 
     <aside class="content-supplementary" role="complimentary">
      <div class="bit">
-        <h3 class="title-3">How will these settings be used</h3>
+        <h3 class="title-3">How will these settings be used?</h3>
         <p>Your course's schedule settings determine when students can enroll in and begin a course as well as when the course.</p>
 
         <p>Additionally, details provided on this page are also used in edX's catalog of courses, which new and returning students use to choose new courses to study.</p>
@@ -220,6 +221,7 @@ from contentstore import utils
           <ul>
             <li class="nav-item"><a href="${reverse('contentstore.views.course_config_graders_page', kwargs={'org' : ctx_loc.org, 'course' : ctx_loc.course, 'name': ctx_loc.name})}">Grading</a></li>
             <li class="nav-item"><a href="${reverse('manage_users', kwargs=dict(location=ctx_loc))}">Course Team</a></li>
+            <li class="nav-item"><a href="${reverse('course_advanced_settings', kwargs={'org' : ctx_loc.org, 'course' : ctx_loc.course, 'name': ctx_loc.name})}">Advanced Settings</a></li>
           </ul>
         </nav>
       % endif

cms/templates/settings_advanced.html

+<%inherit file="base.html" />
+<%! from django.core.urlresolvers import reverse %>
+<%block name="title">Advanced Settings</%block>
+<%block name="bodyclass">is-signedin course advanced settings</%block>
+
+<%namespace name='static' file='static_content.html'/>
+<%!
+from contentstore import utils
+%>
+
+<%block name="jsextra">
+
+<script type="text/javascript" src="${static.url('js/template_loader.js')}"></script>
+<script type="text/javascript" src="${static.url('js/views/server_error.js')}"></script>
+<script type="text/javascript" src="${static.url('js/views/validating_view.js')}"></script>
+<script type="text/javascript" src="${static.url('js/models/settings/advanced.js')}"></script>
+<script type="text/javascript" src="${static.url('js/views/settings/advanced_view.js')}"></script>
+
+<script type="text/javascript">
+$(document).ready(function () {
+
+    // proactively populate advanced b/c it has the filtered list and doesn't really follow the model pattern
+    var advancedModel = new CMS.Models.Settings.Advanced(${advanced_dict | n}, {parse: true});
+    advancedModel.blacklistKeys = ${advanced_blacklist | n};
+    advancedModel.url = "${reverse('course_advanced_settings_updates', kwargs=dict(org=context_course.location.org, course=context_course.location.course, name=context_course.location.name))}";
+
+    var editor = new CMS.Views.Settings.Advanced({
+      el: $('.settings-advanced'),
+      model: advancedModel
+      });
+
+editor.render();
+
+});
+
+</script>
+</%block>
+
+<%block name="content">
+<div class="wrapper-content wrapper">
+  <section class="content">
+    <header class="page">
+      <span class="title-sub">Settings</span>
+      <h1 class="title-1">Advanced Settings</h1>
+    </header>
+
+    <article class="content-primary" role="main">
+      <form id="settings_advanced" class="settings-advanced" method="post" action="">
+
+        <div class="message message-status confirm">
+          Your policy changes have been saved.
+        </div>
+
+        <div class="message message-status error">
+          There was an error saving your information. Please see below.
+        </div>
+
+        <section class="group-settings advanced-policies">
+          <header>
+            <h2 class="title-2">Manual Policy Definition</h2>
+            <span class="tip">Manually Edit Course Policy Values (JSON Key / Value pairs)</span>
+          </header>
+
+          <p class="instructions"><strong>Warning</strong>: Add only manual policy data that you are familiar
+          with.</p>
+
+          <ul class="list-input course-advanced-policy-list enum">
+              
+          </ul>
+
+          <div class="actions">
+            <a href="#" class="button new-button new-advanced-policy-item add-policy-data">
+              <span class="plus-icon white"></span>New Manual Policy
+            </a>            
+          </div>
+        </section>
+      </form>
+    </article>
+
+    <aside class="content-supplementary" role="complimentary">
+      <div class="bit">
+        <h3 class="title-3">How will these settings be used?</h3>
+        <p>Manual policies are JSON-based key and value pairs that allow you add additional settings which edX Studio will use when generating your course.</p>
+
+        <p>Any policies you define here will override any other information you've defined elsewhere in Studio. With this in mind, please be very careful and do not add policies that you are unfamiliar with (both their purpose and their syntax).</p>
+      </div>
+
+      <div class="bit">
+      % if context_course:
+      <% ctx_loc = context_course.location %>
+      <%! from django.core.urlresolvers import reverse %>
+        <h3 class="title-3">Other Course Settings</h3>
+        <nav class="nav-related">
+          <ul>
+            <li class="nav-item"><a href="${reverse('contentstore.views.get_course_settings', kwargs=dict(org=ctx_loc.org, course=ctx_loc.course, name=ctx_loc.name))}">Details &amp; Schedule</a></li>
+            <li class="nav-item"><a href="${reverse('contentstore.views.course_config_graders_page', kwargs={'org' : ctx_loc.org, 'course' : ctx_loc.course, 'name': ctx_loc.name})}">Grading</a></li>
+            <li class="nav-item"><a href="${reverse('manage_users', kwargs=dict(location=ctx_loc))}">Course Team</a></li>
+          </ul>
+        </nav>
+      % endif
+      </div>
+    </aside>
+  </section>
+</div>
+
+<!-- notification: change has been made and a save is needed -->
+<div class="wrapper wrapper-notification wrapper-notification-warning">
+  <div class="notification warning">
+    <div class="copy">
+      <i class="ss-icon ss-symbolicons-block icon icon-warning">&#x26A0;</i>
+
+      <p><strong>Note: </strong>Your changes will not take effect until you <strong>save your
+      progress</strong>. Take care with key and value formatting, as validation is <strong>not implemented</strong>.</p>
+    </div>
+
+    <div class="actions">
+      <ul>
+        <li><a href="#" class="save-button">Save</a></li>
+        <li><a href="#" class="cancel-button">Cancel</a></li>
+      </ul>
+    </div>
+  </div>
+</div>
+</%block>
\ No newline at end of file

cms/templates/settings_graders.html

@@ -126,7 +126,7 @@ from contentstore import utils
 
     <aside class="content-supplementary" role="complimentary">
       <div class="bit">
-        <h3 class="title-3">How will these settings be used</h3>
+        <h3 class="title-3">How will these settings be used?</h3>
         <p>Your grading settings will be used to calculate students grades and performance.</p>
 
         <p>Overall grade range will be used in students' final grades, which are calculated by the weighting you determine for each custom assignment type.</p>
@@ -141,6 +141,7 @@ from contentstore import utils
           <ul>
             <li class="nav-item"><a href="${reverse('contentstore.views.get_course_settings', kwargs=dict(org=ctx_loc.org, course=ctx_loc.course, name=ctx_loc.name))}">Details &amp; Schedule</a></li>
             <li class="nav-item"><a href="${reverse('manage_users', kwargs=dict(location=ctx_loc))}">Course Team</a></li>
+            <li class="nav-item"><a href="${reverse('course_advanced_settings', kwargs={'org' : ctx_loc.org, 'course' : ctx_loc.course, 'name': ctx_loc.name})}">Advanced Settings</a></li>
           </ul>
         </nav>
       % endif

cms/templates/widgets/header.html

@@ -44,7 +44,7 @@
                   <li class="nav-item nav-course-settings-schedule"><a href="${reverse('contentstore.views.get_course_settings', kwargs=dict(org=ctx_loc.org, course=ctx_loc.course, name=ctx_loc.name))}">Schedule &amp; Details</a></li>
                   <li class="nav-item nav-course-settings-grading"><a href="${reverse('contentstore.views.course_config_graders_page', kwargs={'org' : ctx_loc.org, 'course' : ctx_loc.course, 'name': ctx_loc.name})}">Grading</a></li>
                   <li class="nav-item nav-course-settings-team"><a href="${reverse('manage_users', kwargs=dict(location=ctx_loc))}">Course Team</a></li>
-                  <!-- <li class="nav-item nav-course-settings-advanced"><a href="${reverse('course_settings', kwargs={'org' : ctx_loc.org, 'course' : ctx_loc.course, 'name': ctx_loc.name})}">Advanced Settings</a></li> -->
+                  <li class="nav-item nav-course-settings-advanced"><a href="${reverse('course_advanced_settings', kwargs={'org' : ctx_loc.org, 'course' : ctx_loc.course, 'name': ctx_loc.name})}">Advanced Settings</a></li>
                 </ul>
               </div>
             </div>            

cms/urls.py

@@ -47,6 +47,10 @@ urlpatterns = ('',
     url(r'^(?P<org>[^/]+)/(?P<course>[^/]+)/settings-grading/(?P<name>[^/]+)$', 'contentstore.views.course_config_graders_page', name='course_settings'),
     url(r'^(?P<org>[^/]+)/(?P<course>[^/]+)/settings-details/(?P<name>[^/]+)/section/(?P<section>[^/]+).*$', 'contentstore.views.course_settings_updates', name='course_settings'),
     url(r'^(?P<org>[^/]+)/(?P<course>[^/]+)/settings-grading/(?P<name>[^/]+)/(?P<grader_index>.*)$', 'contentstore.views.course_grader_updates', name='course_settings'),
+    # This is the URL to initially render the course advanced settings.
+    url(r'^(?P<org>[^/]+)/(?P<course>[^/]+)/settings-advanced/(?P<name>[^/]+)$', 'contentstore.views.course_config_advanced_page', name='course_advanced_settings'),
+    # This is the URL used by BackBone for updating and re-fetching the model.
+    url(r'^(?P<org>[^/]+)/(?P<course>[^/]+)/settings-advanced/(?P<name>[^/]+)/update.*$', 'contentstore.views.course_advanced_updates', name='course_advanced_settings_updates'),
 
     url(r'^(?P<org>[^/]+)/(?P<course>[^/]+)/(?P<category>[^/]+)/(?P<name>[^/]+)/gradeas.*$', 'contentstore.views.assignment_type_update', name='assignment_type_update'),
 

common/djangoapps/terrain/factories.py

 from student.models import User, UserProfile, Registration
+from django.contrib.auth.models import Group
 from datetime import datetime
 from factory import Factory
 from xmodule.modulestore import Location
@@ -8,6 +9,12 @@ from uuid import uuid4
 from xmodule.timeparse import stringify_time
 
 
+class GroupFactory(Factory):
+    FACTORY_FOR = Group
+
+    name = 'staff_MITx/999/Robot_Super_Course'
+    
+
 class UserProfileFactory(Factory):
     FACTORY_FOR = UserProfile
 

common/djangoapps/terrain/steps.py

 from lettuce import world, step
 from factories import *
-from django.core.management import call_command
 from lettuce.django import django_url
-from django.conf import settings
 from django.contrib.auth.models import User
 from student.models import CourseEnrollment
 from urllib import quote_plus
@@ -21,6 +19,11 @@ def wait(step, seconds):
     time.sleep(float(seconds))
 
 
+@step('I reload the page$')
+def reload_the_page(step):
+    world.browser.reload()
+
+
 @step('I (?:visit|access|open) the homepage$')
 def i_visit_the_homepage(step):
     world.browser.visit(django_url('/'))
@@ -105,6 +108,11 @@ def i_am_an_edx_user(step):
 
 #### helper functions
 
+@world.absorb
+def scroll_to_bottom():
+    # Maximize the browser
+    world.browser.execute_script("window.scrollTo(0, screen.height);")
+
 
 @world.absorb
 def create_user(uname):

common/lib/capa/capa/verifiers/draganddrop.py

@@ -111,7 +111,7 @@ class DragAndDrop(object):
         Returns: bool.
         '''
         for draggable in self.excess_draggables:
-            if not self.excess_draggables[draggable]:
+            if self.excess_draggables[draggable]:
                 return False  # user answer has more draggables than correct answer
 
         # Number of draggables in user_groups may be differ that in
@@ -304,8 +304,13 @@ class DragAndDrop(object):
 
         user_answer = json.loads(user_answer)
 
-        # check if we have draggables that are not in correct answer:
-        self.excess_draggables = {}
+        # This dictionary will hold a key for each draggable the user placed on
+        # the image.  The value is True if that draggable is not mentioned in any
+        # correct_answer entries.  If the draggable is mentioned in at least one
+        # correct_answer entry, the value is False.
+        # default to consider every user answer excess until proven otherwise.
+        self.excess_draggables = dict((users_draggable.keys()[0],True) 
+            for users_draggable in user_answer['draggables'])
 
         # create identical data structures from user answer and correct answer
         for i in xrange(0, len(correct_answer)):
@@ -322,11 +327,8 @@ class DragAndDrop(object):
                     self.user_groups[groupname].append(draggable_name)
                     self.user_positions[groupname]['user'].append(
                                             draggable_dict[draggable_name])
-                    self.excess_draggables[draggable_name] = True
-                else:
-                    self.excess_draggables[draggable_name] = \
-                    self.excess_draggables.get(draggable_name, False)
-
+                    # proved that this is not excess
+                    self.excess_draggables[draggable_name] = False
 
 def grade(user_input, correct_answer):
     """ Creates DragAndDrop instance from user_input and correct_answer and

common/lib/capa/capa/verifiers/tests_draganddrop.py

@@ -46,6 +46,18 @@ class Test_DragAndDrop_Grade(unittest.TestCase):
         correct_answer = {'1':              't1', 'name_with_icon': 't2'}
         self.assertTrue(draganddrop.grade(user_input, correct_answer))
 
+    def test_expect_no_actions_wrong(self):
+        user_input = '{"draggables": [{"1": "t1"}, \
+         {"name_with_icon": "t2"}]}'
+        correct_answer = []
+        self.assertFalse(draganddrop.grade(user_input, correct_answer))
+
+    def test_expect_no_actions_right(self):
+        user_input = '{"draggables": []}'
+        correct_answer = []
+        self.assertTrue(draganddrop.grade(user_input, correct_answer))
+
+
     def test_targets_false(self):
         user_input = '{"draggables": [{"1": "t1"}, \
         {"name_with_icon": "t2"}]}'

common/lib/xmodule/xmodule/js/src/combinedopenended/display.coffee

@@ -4,7 +4,47 @@ class @Rubric
   @initialize: (location) ->
     $('.rubric').data("location", location) 
     $('input[class="score-selection"]').change @tracking_callback
+    # set up the hotkeys
+    $(window).unbind('keydown', @keypress_callback)
+    $(window).keydown @keypress_callback
+    # display the 'current' carat
+    @categories = $('.rubric-category')
+    @category = $(@categories.first())
+    @category.prepend('> ')
+    @category_index = 0
+    
+    
+  @keypress_callback: (event) =>
+    # don't try to do this when user is typing in a text input
+    if $(event.target).is('input, textarea')
+      return
+    # for when we select via top row
+    if event.which >= 48 and event.which <= 57
+      selected = event.which - 48
+    # for when we select via numpad
+    else if event.which >= 96 and event.which <= 105
+      selected = event.which - 96
+    # we don't want to do anything since we haven't pressed a number
+    else
+      return
 
+    # if we actually have a current category (not past the end)
+    if(@category_index <= @categories.length)
+      # find the valid selections for this category
+      inputs = $("input[name='score-selection-#{@category_index}']")
+      max_score = inputs.length - 1
+
+      if selected > max_score or selected < 0
+        return
+      inputs.filter("input[value=#{selected}]").click()
+
+      # move to the next category
+      old_category_text = @category.html().substring(5)
+      @category.html(old_category_text)
+      @category_index++
+      @category = $(@categories[@category_index])
+      @category.prepend('> ')
+    
   @tracking_callback: (event) ->
     target_selection = $(event.target).val()
     # chop off the beginning of the name so that we can get the number of the category
@@ -49,6 +89,7 @@ class @CombinedOpenEnded
   constructor: (element) ->
     @element=element
     @reinitialize(element)
+    $(window).keydown @keydown_handler
 
   reinitialize: (element) ->
     @wrapper=$(element).find('section.xmodule_CombinedOpenEndedModule')
@@ -306,6 +347,7 @@ class @CombinedOpenEnded
           if response.success
             @rubric_wrapper.html(response.rubric_html)
             @rubric_wrapper.show()
+            Rubric.initialize(@location)
             @answer_area.html(response.student_response)
             @child_state = 'assessing'
             @find_assessment_elements()
@@ -318,6 +360,11 @@ class @CombinedOpenEnded
     else
       @errors_area.html(@out_of_sync_message)
 
+  keydown_handler: (e) =>
+    # only do anything when the key pressed is the 'enter' key
+    if e.which == 13 && @child_state == 'assessing' && Rubric.check_complete()
+      @save_assessment(e)
+
   save_assessment: (event) =>
     event.preventDefault()
     if @child_state == 'assessing' && Rubric.check_complete()

common/lib/xmodule/xmodule/js/src/peergrading/peer_grading_problem.coffee

@@ -210,6 +210,9 @@ class @PeerGradingProblem
     @calibration_interstitial_page_button = $('.calibration-interstitial-page-button')
     @flag_student_checkbox = $('.flag-checkbox')
     @answer_unknown_checkbox = $('.answer-unknown-checkbox')
+
+    $(window).keydown @keydown_handler
+
     @collapse_question()
 
     Collapsible.setCollapsibles(@content_panel)
@@ -251,9 +254,6 @@ class @PeerGradingProblem
   fetch_submission_essay: () =>
     @backend.post('get_next_submission', {location: @location}, @render_submission)
 
-  gentle_alert: (msg) =>
-    @grading_message.fadeIn()
-    @grading_message.html("<p>" + msg + "</p>")
 
   construct_data: () ->
     data =
@@ -337,6 +337,14 @@ class @PeerGradingProblem
       @show_submit_button()
       @grade = Rubric.get_total_score()
 
+  keydown_handler: (event) =>
+    if event.which == 13 && @submit_button.is(':visible')
+      if @calibration
+        @submit_calibration_essay()
+      else
+        @submit_grade()
+
+
 
 
   ##########
@@ -473,6 +481,10 @@ class @PeerGradingProblem
     # And now hook up an event handler again
     $("input[class='score-selection']").change @graded_callback
 
+  gentle_alert: (msg) =>
+    @grading_message.fadeIn()
+    @grading_message.html("<p>" + msg + "</p>")
+
   collapse_question: () =>
     @prompt_container.slideToggle()
     @prompt_container.toggleClass('open')

common/static/css/pdfviewer.css

@@ -85,13 +85,16 @@ select {
 }
 
 #viewerContainer {
-  overflow: auto;
+/*  overflow: auto; */
   box-shadow: inset 1px 0 0 hsla(0,0%,100%,.05);
 /*  position: absolute;
   top: 32px;
   right: 0;
   bottom: 0;
   left: 0; */
+/* switch to using these instead: */
+  position: relative;
+  overflow: hidden;
 }
 
 .toolbar {

common/static/js/pdfviewer.js

@@ -27,12 +27,28 @@ PDFJS.disableWorker = true;
         var pdfViewer = this;
 
         var pdfDocument = null;
-        var url = options['url'];
-        var pageNum = 1;
+        var urlToLoad = null;
+        if (options.url) {
+            urlToLoad = options.url;
+        }
+        var chapterUrls = null;
+        if (options.chapters) {
+            chapterUrls = options.chapters;
+        }
+        var chapterToLoad = 1;
+        if (options.chapterNum) {
+            // TODO: this should only be specified if there are 
+            // chapters, and it should be in-bounds.
+            chapterToLoad = options.chapterNum;
+        }
+        var pageToLoad = 1;
         if (options.pageNum) {
-            pageNum = options.pageNum;
+            pageToLoad = options.pageNum;
         }
 
+        var chapterNum = 1;
+        var pageNum = 1;
+
         var viewerElement = document.getElementById('viewer');
         var ANNOT_MIN_SIZE = 10;
         var DEFAULT_SCALE_DELTA = 1.1;
@@ -44,31 +60,28 @@ PDFJS.disableWorker = true;
         var currentScaleValue = "0";
         var DEFAULT_SCALE_VALUE = "1";
 
-	// TESTING:
-	var destinations = null;
-
         var setupText = function setupText(textdiv, content, viewport) {
 
             function getPageNumberFromDest(dest) {
-		var destPage = 1;
-		if (dest instanceof Array) {
-		    var destRef = dest[0]; 
-		    if (destRef instanceof Object) {
-			// we would need to look this up in the 
-			// list of all pages that have been loaded,
-			// but we're trying to not have to load all the pages
-			// right now.  
-			// destPage = this.pagesRefMap[destRef.num + ' ' + destRef.gen + ' R'];
-		    } else {
-			destPage = (destRef + 1);
-		    }
-		}
-		return destPage;
-	    }
+                var destPage = 1;
+                if (dest instanceof Array) {
+                    var destRef = dest[0]; 
+                    if (destRef instanceof Object) {
+                        // we would need to look this up in the 
+                        // list of all pages that have been loaded,
+                        // but we're trying to not have to load all the pages
+                        // right now.  
+                        // destPage = this.pagesRefMap[destRef.num + ' ' + destRef.gen + ' R'];
+                    } else {
+                        destPage = (destRef + 1);
+                    }
+                }
+                return destPage;
+            }
 
             function bindLink(link, dest) {
-		// get page number from dest:
-		destPage = getPageNumberFromDest(dest);
+                // get page number from dest:
+                destPage = getPageNumberFromDest(dest);
                 link.href = '#page=' + destPage;
                 link.onclick = function pageViewSetupLinksOnclick() {
                     if (dest && dest instanceof Array )
@@ -138,10 +151,10 @@ PDFJS.disableWorker = true;
         // Get page info from document, resize canvas accordingly, and render page
         //
         renderPage = function(num) {
-	    // don't try to render a page that cannot be rendered
-	    if (num < 1 || num > pdfDocument.numPages) {
-		return;
-	    }
+            // don't try to render a page that cannot be rendered
+            if (num < 1 || num > pdfDocument.numPages) {
+                return;
+            }
 
             // Update logging:
             log_event("book", { "type" : "gotopage", "old" : pageNum, "new" : num });
@@ -270,18 +283,37 @@ PDFJS.disableWorker = true;
         //
         // Asynchronously download PDF as an ArrayBuffer
         //
-        PDFJS.getDocument(url).then(
-            function getDocument(_pdfDocument) {
-                pdfDocument = _pdfDocument;
-		// display the current page with a default scale value:
-		parseScale(DEFAULT_SCALE_VALUE);
-            }, 
-            function getDocumentError(message, exception) {
-                // placeholder: don't expect errors :)
-            }, 
-            function getDocumentProgress(progressData) {
-                // placeholder: not yet ready to display loading progress
-            });
+        loadUrl = function pdfViewLoadUrl(url, page) {
+            PDFJS.getDocument(url).then(
+                function getDocument(_pdfDocument) {
+                    pdfDocument = _pdfDocument;
+                    pageNum = page;
+                    // if the scale has not been set before, set it now.
+                    // Otherwise, don't change the current scale,
+                    // but make sure it gets refreshed.
+                    if (currentScale == UNKNOWN_SCALE) {
+                        parseScale(DEFAULT_SCALE_VALUE);
+                    } else {
+                        var preservedScale = currentScale;
+                        currentScale = UNKNOWN_SCALE;
+                        parseScale(preservedScale);
+                    }
+                }, 
+                function getDocumentError(message, exception) {
+                    // placeholder: don't expect errors :)
+                }, 
+                function getDocumentProgress(progressData) {
+                    // placeholder: not yet ready to display loading progress
+                });
+            }; 
+
+        loadChapterUrl = function pdfViewLoadChapterUrl(chapterNum, pageVal) {
+            if (chapterNum < 1 || chapterNum > chapterUrls.length) {
+                return;
+            }
+            var chapterUrl = chapterUrls[chapterNum-1];
+            loadUrl(chapterUrl, pageVal);
+        }
 
         $("#previous").click(function(event) {
             prevPage();
@@ -302,11 +334,34 @@ PDFJS.disableWorker = true;
             parseScale(this.value);
         });
 
+
         $('#pageNumber').change(function(event) {
-	    var newPageVal = parseInt(this.value);
-	    if (newPageVal) {
-		renderPage(newPageVal);
-	    }
+            var newPageVal = parseInt(this.value);
+            if (newPageVal) {
+                renderPage(newPageVal);
+            }
         });
+
+        // define navigation links for chapters:  
+        if (chapterUrls != null) {
+            var loadChapterUrlHelper = function(i) {
+                return function(event) {
+                    // when opening a new chapter, always open the first page:
+                    loadChapterUrl(i, 1);
+                };
+            };
+            for (var index = 1; index <= chapterUrls.length; index += 1) {
+                $("#pdfchapter-" + index).click(loadChapterUrlHelper(index));
+            }   
+        }
+
+        // finally, load the appropriate url/page
+        if (urlToLoad != null) {
+            loadUrl(urlToLoad, pageToLoad);
+        } else {
+            loadChapterUrl(chapterToLoad, pageToLoad);
+        }       
+            
+        return pdfViewer;
     }
 })(jQuery);

common/static/js/vendor/CodeMirror/codemirror.js

+// CodeMirror version 2.23 (with edits)
+//
 // All functions that need access to the editor's state live inside
 // the CodeMirror function. Below that, at the bottom of the file,
 // some utilities are defined.

common/static/js/vendor/CodeMirror/javascript.js

+CodeMirror.defineMode("javascript", function(config, parserConfig) {
+  var indentUnit = config.indentUnit;
+  var jsonMode = parserConfig.json;
+
+  // Tokenizer
+
+  var keywords = function(){
+    function kw(type) {return {type: type, style: "keyword"};}
+    var A = kw("keyword a"), B = kw("keyword b"), C = kw("keyword c");
+    var operator = kw("operator"), atom = {type: "atom", style: "atom"};
+    return {
+      "if": A, "while": A, "with": A, "else": B, "do": B, "try": B, "finally": B,
+      "return": C, "break": C, "continue": C, "new": C, "delete": C, "throw": C,
+      "var": kw("var"), "const": kw("var"), "let": kw("var"),
+      "function": kw("function"), "catch": kw("catch"),
+      "for": kw("for"), "switch": kw("switch"), "case": kw("case"), "default": kw("default"),
+      "in": operator, "typeof": operator, "instanceof": operator,
+      "true": atom, "false": atom, "null": atom, "undefined": atom, "NaN": atom, "Infinity": atom
+    };
+  }();
+
+  var isOperatorChar = /[+\-*&%=<>!?|]/;
+
+  function chain(stream, state, f) {
+    state.tokenize = f;
+    return f(stream, state);
+  }
+
+  function nextUntilUnescaped(stream, end) {
+    var escaped = false, next;
+    while ((next = stream.next()) != null) {
+      if (next == end && !escaped)
+        return false;
+      escaped = !escaped && next == "\\";
+    }
+    return escaped;
+  }
+
+  // Used as scratch variables to communicate multiple values without
+  // consing up tons of objects.
+  var type, content;
+  function ret(tp, style, cont) {
+    type = tp; content = cont;
+    return style;
+  }
+
+  function jsTokenBase(stream, state) {
+    var ch = stream.next();
+    if (ch == '"' || ch == "'")
+      return chain(stream, state, jsTokenString(ch));
+    else if (/[\[\]{}\(\),;\:\.]/.test(ch))
+      return ret(ch);
+    else if (ch == "0" && stream.eat(/x/i)) {
+      stream.eatWhile(/[\da-f]/i);
+      return ret("number", "number");
+    }      
+    else if (/\d/.test(ch)) {
+      stream.match(/^\d*(?:\.\d*)?(?:[eE][+\-]?\d+)?/);
+      return ret("number", "number");
+    }
+    else if (ch == "/") {
+      if (stream.eat("*")) {
+        return chain(stream, state, jsTokenComment);
+      }
+      else if (stream.eat("/")) {
+        stream.skipToEnd();
+        return ret("comment", "comment");
+      }
+      else if (state.reAllowed) {
+        nextUntilUnescaped(stream, "/");
+        stream.eatWhile(/[gimy]/); // 'y' is "sticky" option in Mozilla
+        return ret("regexp", "string-2");
+      }
+      else {
+        stream.eatWhile(isOperatorChar);
+        return ret("operator", null, stream.current());
+      }
+    }
+    else if (ch == "#") {
+        stream.skipToEnd();
+        return ret("error", "error");
+    }
+    else if (isOperatorChar.test(ch)) {
+      stream.eatWhile(isOperatorChar);
+      return ret("operator", null, stream.current());
+    }
+    else {
+      stream.eatWhile(/[\w\$_]/);
+      var word = stream.current(), known = keywords.propertyIsEnumerable(word) && keywords[word];
+      return (known && state.kwAllowed) ? ret(known.type, known.style, word) :
+                     ret("variable", "variable", word);
+    }
+  }
+
+  function jsTokenString(quote) {
+    return function(stream, state) {
+      if (!nextUntilUnescaped(stream, quote))
+        state.tokenize = jsTokenBase;
+      return ret("string", "string");
+    };
+  }
+
+  function jsTokenComment(stream, state) {
+    var maybeEnd = false, ch;
+    while (ch = stream.next()) {
+      if (ch == "/" && maybeEnd) {
+        state.tokenize = jsTokenBase;
+        break;
+      }
+      maybeEnd = (ch == "*");
+    }
+    return ret("comment", "comment");
+  }
+
+  // Parser
+
+  var atomicTypes = {"atom": true, "number": true, "variable": true, "string": true, "regexp": true};
+
+  function JSLexical(indented, column, type, align, prev, info) {
+    this.indented = indented;
+    this.column = column;
+    this.type = type;
+    this.prev = prev;
+    this.info = info;
+    if (align != null) this.align = align;
+  }
+
+  function inScope(state, varname) {
+    for (var v = state.localVars; v; v = v.next)
+      if (v.name == varname) return true;
+  }
+
+  function parseJS(state, style, type, content, stream) {
+    var cc = state.cc;
+    // Communicate our context to the combinators.
+    // (Less wasteful than consing up a hundred closures on every call.)
+    cx.state = state; cx.stream = stream; cx.marked = null, cx.cc = cc;
+  
+    if (!state.lexical.hasOwnProperty("align"))
+      state.lexical.align = true;
+
+    while(true) {
+      var combinator = cc.length ? cc.pop() : jsonMode ? expression : statement;
+      if (combinator(type, content)) {
+        while(cc.length && cc[cc.length - 1].lex)
+          cc.pop()();
+        if (cx.marked) return cx.marked;
+        if (type == "variable" && inScope(state, content)) return "variable-2";
+        return style;
+      }
+    }
+  }
+
+  // Combinator utils
+
+  var cx = {state: null, column: null, marked: null, cc: null};
+  function pass() {
+    for (var i = arguments.length - 1; i >= 0; i--) cx.cc.push(arguments[i]);
+  }
+  function cont() {
+    pass.apply(null, arguments);
+    return true;
+  }
+  function register(varname) {
+    var state = cx.state;
+    if (state.context) {
+      cx.marked = "def";
+      for (var v = state.localVars; v; v = v.next)
+        if (v.name == varname) return;
+      state.localVars = {name: varname, next: state.localVars};
+    }
+  }
+
+  // Combinators
+
+  var defaultVars = {name: "this", next: {name: "arguments"}};
+  function pushcontext() {
+    if (!cx.state.context) cx.state.localVars = defaultVars;
+    cx.state.context = {prev: cx.state.context, vars: cx.state.localVars};
+  }
+  function popcontext() {
+    cx.state.localVars = cx.state.context.vars;
+    cx.state.context = cx.state.context.prev;
+  }
+  function pushlex(type, info) {
+    var result = function() {
+      var state = cx.state;
+      state.lexical = new JSLexical(state.indented, cx.stream.column(), type, null, state.lexical, info)
+    };
+    result.lex = true;
+    return result;
+  }
+  function poplex() {
+    var state = cx.state;
+    if (state.lexical.prev) {
+      if (state.lexical.type == ")")
+        state.indented = state.lexical.indented;
+      state.lexical = state.lexical.prev;
+    }
+  }
+  poplex.lex = true;
+
+  function expect(wanted) {
+    return function expecting(type) {
+      if (type == wanted) return cont();
+      else if (wanted == ";") return pass();
+      else return cont(arguments.callee);
+    };
+  }
+
+  function statement(type) {
+    if (type == "var") return cont(pushlex("vardef"), vardef1, expect(";"), poplex);
+    if (type == "keyword a") return cont(pushlex("form"), expression, statement, poplex);
+    if (type == "keyword b") return cont(pushlex("form"), statement, poplex);
+    if (type == "{") return cont(pushlex("}"), block, poplex);
+    if (type == ";") return cont();
+    if (type == "function") return cont(functiondef);
+    if (type == "for") return cont(pushlex("form"), expect("("), pushlex(")"), forspec1, expect(")"),
+                                      poplex, statement, poplex);
+    if (type == "variable") return cont(pushlex("stat"), maybelabel);
+    if (type == "switch") return cont(pushlex("form"), expression, pushlex("}", "switch"), expect("{"),
+                                         block, poplex, poplex);
+    if (type == "case") return cont(expression, expect(":"));
+    if (type == "default") return cont(expect(":"));
+    if (type == "catch") return cont(pushlex("form"), pushcontext, expect("("), funarg, expect(")"),
+                                        statement, poplex, popcontext);
+    return pass(pushlex("stat"), expression, expect(";"), poplex);
+  }
+  function expression(type) {
+    if (atomicTypes.hasOwnProperty(type)) return cont(maybeoperator);
+    if (type == "function") return cont(functiondef);
+    if (type == "keyword c") return cont(maybeexpression);
+    if (type == "(") return cont(pushlex(")"), maybeexpression, expect(")"), poplex, maybeoperator);
+    if (type == "operator") return cont(expression);
+    if (type == "[") return cont(pushlex("]"), commasep(expression, "]"), poplex, maybeoperator);
+    if (type == "{") return cont(pushlex("}"), commasep(objprop, "}"), poplex, maybeoperator);
+    return cont();
+  }
+  function maybeexpression(type) {
+    if (type.match(/[;\}\)\],]/)) return pass();
+    return pass(expression);
+  }
+    
+  function maybeoperator(type, value) {
+    if (type == "operator" && /\+\+|--/.test(value)) return cont(maybeoperator);
+    if (type == "operator") return cont(expression);
+    if (type == ";") return;
+    if (type == "(") return cont(pushlex(")"), commasep(expression, ")"), poplex, maybeoperator);
+    if (type == ".") return cont(property, maybeoperator);
+    if (type == "[") return cont(pushlex("]"), expression, expect("]"), poplex, maybeoperator);
+  }
+  function maybelabel(type) {
+    if (type == ":") return cont(poplex, statement);
+    return pass(maybeoperator, expect(";"), poplex);
+  }
+  function property(type) {
+    if (type == "variable") {cx.marked = "property"; return cont();}
+  }
+  function objprop(type) {
+    if (type == "variable") cx.marked = "property";
+    if (atomicTypes.hasOwnProperty(type)) return cont(expect(":"), expression);
+  }
+  function commasep(what, end) {
+    function proceed(type) {
+      if (type == ",") return cont(what, proceed);
+      if (type == end) return cont();
+      return cont(expect(end));
+    }
+    return function commaSeparated(type) {
+      if (type == end) return cont();
+      else return pass(what, proceed);
+    };
+  }
+  function block(type) {
+    if (type == "}") return cont();
+    return pass(statement, block);
+  }
+  function vardef1(type, value) {
+    if (type == "variable"){register(value); return cont(vardef2);}
+    return cont();
+  }
+  function vardef2(type, value) {
+    if (value == "=") return cont(expression, vardef2);
+    if (type == ",") return cont(vardef1);
+  }
+  function forspec1(type) {
+    if (type == "var") return cont(vardef1, forspec2);
+    if (type == ";") return pass(forspec2);
+    if (type == "variable") return cont(formaybein);
+    return pass(forspec2);
+  }
+  function formaybein(type, value) {
+    if (value == "in") return cont(expression);
+    return cont(maybeoperator, forspec2);
+  }
+  function forspec2(type, value) {
+    if (type == ";") return cont(forspec3);
+    if (value == "in") return cont(expression);
+    return cont(expression, expect(";"), forspec3);
+  }
+  function forspec3(type) {
+    if (type != ")") cont(expression);
+  }
+  function functiondef(type, value) {
+    if (type == "variable") {register(value); return cont(functiondef);}
+    if (type == "(") return cont(pushlex(")"), pushcontext, commasep(funarg, ")"), poplex, statement, popcontext);
+  }
+  function funarg(type, value) {
+    if (type == "variable") {register(value); return cont();}
+  }
+
+  // Interface
+
+  return {
+    startState: function(basecolumn) {
+      return {
+        tokenize: jsTokenBase,
+        reAllowed: true,
+        kwAllowed: true,
+        cc: [],
+        lexical: new JSLexical((basecolumn || 0) - indentUnit, 0, "block", false),
+        localVars: parserConfig.localVars,
+        context: parserConfig.localVars && {vars: parserConfig.localVars},
+        indented: 0
+      };
+    },
+
+    token: function(stream, state) {
+      if (stream.sol()) {
+        if (!state.lexical.hasOwnProperty("align"))
+          state.lexical.align = false;
+        state.indented = stream.indentation();
+      }
+      if (stream.eatSpace()) return null;
+      var style = state.tokenize(stream, state);
+      if (type == "comment") return style;
+      state.reAllowed = !!(type == "operator" || type == "keyword c" || type.match(/^[\[{}\(,;:]$/));
+      state.kwAllowed = type != '.';
+      return parseJS(state, style, type, content, stream);
+    },
+
+    indent: function(state, textAfter) {
+      if (state.tokenize != jsTokenBase) return 0;
+      var firstChar = textAfter && textAfter.charAt(0), lexical = state.lexical,
+          type = lexical.type, closing = firstChar == type;
+      if (type == "vardef") return lexical.indented + 4;
+      else if (type == "form" && firstChar == "{") return lexical.indented;
+      else if (type == "stat" || type == "form") return lexical.indented + indentUnit;
+      else if (lexical.info == "switch" && !closing)
+        return lexical.indented + (/^(?:case|default)\b/.test(textAfter) ? indentUnit : 2 * indentUnit);
+      else if (lexical.align) return lexical.column + (closing ? 0 : 1);
+      else return lexical.indented + (closing ? 0 : indentUnit);
+    },
+
+    electricChars: ":{}"
+  };
+});
+
+CodeMirror.defineMIME("text/javascript", "javascript");
+CodeMirror.defineMIME("application/json", {name: "javascript", json: true});

doc/public/Makefile

+# Makefile for Sphinx documentation
+#
+
+# You can set these variables from the command line.
+SPHINXOPTS    =
+SPHINXBUILD   = sphinx-build
+PAPER         =
+BUILDDIR      = _build
+
+# Internal variables.
+PAPEROPT_a4     = -D latex_paper_size=a4
+PAPEROPT_letter = -D latex_paper_size=letter
+ALLSPHINXOPTS   = -d $(BUILDDIR)/doctrees $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) .
+# the i18n builder cannot share the environment and doctrees with the others
+I18NSPHINXOPTS  = $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) .
+
+.PHONY: help clean html dirhtml singlehtml pickle json htmlhelp qthelp devhelp epub latex latexpdf text man changes linkcheck doctest gettext
+
+help:
+	@echo "Please use \`make <target>' where <target> is one of"
+	@echo "  html       to make standalone HTML files"
+	@echo "  dirhtml    to make HTML files named index.html in directories"
+	@echo "  singlehtml to make a single large HTML file"
+	@echo "  pickle     to make pickle files"
+	@echo "  json       to make JSON files"
+	@echo "  htmlhelp   to make HTML files and a HTML help project"
+	@echo "  qthelp     to make HTML files and a qthelp project"
+	@echo "  devhelp    to make HTML files and a Devhelp project"
+	@echo "  epub       to make an epub"
+	@echo "  latex      to make LaTeX files, you can set PAPER=a4 or PAPER=letter"
+	@echo "  latexpdf   to make LaTeX files and run them through pdflatex"
+	@echo "  text       to make text files"
+	@echo "  man        to make manual pages"
+	@echo "  texinfo    to make Texinfo files"
+	@echo "  info       to make Texinfo files and run them through makeinfo"
+	@echo "  gettext    to make PO message catalogs"
+	@echo "  changes    to make an overview of all changed/added/deprecated items"
+	@echo "  linkcheck  to check all external links for integrity"
+	@echo "  doctest    to run all doctests embedded in the documentation (if enabled)"
+
+clean:
+	-rm -rf $(BUILDDIR)/*
+
+html:
+	$(SPHINXBUILD) -b html $(ALLSPHINXOPTS) $(BUILDDIR)/html
+	@echo
+	@echo "Build finished. The HTML pages are in $(BUILDDIR)/html."
+
+dirhtml:
+	$(SPHINXBUILD) -b dirhtml $(ALLSPHINXOPTS) $(BUILDDIR)/dirhtml
+	@echo
+	@echo "Build finished. The HTML pages are in $(BUILDDIR)/dirhtml."
+
+singlehtml:
+	$(SPHINXBUILD) -b singlehtml $(ALLSPHINXOPTS) $(BUILDDIR)/singlehtml
+	@echo
+	@echo "Build finished. The HTML page is in $(BUILDDIR)/singlehtml."
+
+pickle:
+	$(SPHINXBUILD) -b pickle $(ALLSPHINXOPTS) $(BUILDDIR)/pickle
+	@echo
+	@echo "Build finished; now you can process the pickle files."
+
+json:
+	$(SPHINXBUILD) -b json $(ALLSPHINXOPTS) $(BUILDDIR)/json
+	@echo
+	@echo "Build finished; now you can process the JSON files."
+
+htmlhelp:
+	$(SPHINXBUILD) -b htmlhelp $(ALLSPHINXOPTS) $(BUILDDIR)/htmlhelp
+	@echo
+	@echo "Build finished; now you can run HTML Help Workshop with the" \
+	      ".hhp project file in $(BUILDDIR)/htmlhelp."
+
+qthelp:
+	$(SPHINXBUILD) -b qthelp $(ALLSPHINXOPTS) $(BUILDDIR)/qthelp
+	@echo
+	@echo "Build finished; now you can run "qcollectiongenerator" with the" \
+	      ".qhcp project file in $(BUILDDIR)/qthelp, like this:"
+	@echo "# qcollectiongenerator $(BUILDDIR)/qthelp/edXDocs.qhcp"
+	@echo "To view the help file:"
+	@echo "# assistant -collectionFile $(BUILDDIR)/qthelp/edXDocs.qhc"
+
+devhelp:
+	$(SPHINXBUILD) -b devhelp $(ALLSPHINXOPTS) $(BUILDDIR)/devhelp
+	@echo
+	@echo "Build finished."
+	@echo "To view the help file:"
+	@echo "# mkdir -p $$HOME/.local/share/devhelp/edXDocs"
+	@echo "# ln -s $(BUILDDIR)/devhelp $$HOME/.local/share/devhelp/edXDocs"
+	@echo "# devhelp"
+
+epub:
+	$(SPHINXBUILD) -b epub $(ALLSPHINXOPTS) $(BUILDDIR)/epub
+	@echo
+	@echo "Build finished. The epub file is in $(BUILDDIR)/epub."
+
+latex:
+	$(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
+	@echo
+	@echo "Build finished; the LaTeX files are in $(BUILDDIR)/latex."
+	@echo "Run \`make' in that directory to run these through (pdf)latex" \
+	      "(use \`make latexpdf' here to do that automatically)."
+
+latexpdf:
+	$(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
+	@echo "Running LaTeX files through pdflatex..."
+	$(MAKE) -C $(BUILDDIR)/latex all-pdf
+	@echo "pdflatex finished; the PDF files are in $(BUILDDIR)/latex."
+
+text:
+	$(SPHINXBUILD) -b text $(ALLSPHINXOPTS) $(BUILDDIR)/text
+	@echo
+	@echo "Build finished. The text files are in $(BUILDDIR)/text."
+
+man:
+	$(SPHINXBUILD) -b man $(ALLSPHINXOPTS) $(BUILDDIR)/man
+	@echo
+	@echo "Build finished. The manual pages are in $(BUILDDIR)/man."
+
+texinfo:
+	$(SPHINXBUILD) -b texinfo $(ALLSPHINXOPTS) $(BUILDDIR)/texinfo
+	@echo
+	@echo "Build finished. The Texinfo files are in $(BUILDDIR)/texinfo."
+	@echo "Run \`make' in that directory to run these through makeinfo" \
+	      "(use \`make info' here to do that automatically)."
+
+info:
+	$(SPHINXBUILD) -b texinfo $(ALLSPHINXOPTS) $(BUILDDIR)/texinfo
+	@echo "Running Texinfo files through makeinfo..."
+	make -C $(BUILDDIR)/texinfo info
+	@echo "makeinfo finished; the Info files are in $(BUILDDIR)/texinfo."
+
+gettext:
+	$(SPHINXBUILD) -b gettext $(I18NSPHINXOPTS) $(BUILDDIR)/locale
+	@echo
+	@echo "Build finished. The message catalogs are in $(BUILDDIR)/locale."
+
+changes:
+	$(SPHINXBUILD) -b changes $(ALLSPHINXOPTS) $(BUILDDIR)/changes
+	@echo
+	@echo "The overview file is in $(BUILDDIR)/changes."
+
+linkcheck:
+	$(SPHINXBUILD) -b linkcheck $(ALLSPHINXOPTS) $(BUILDDIR)/linkcheck
+	@echo
+	@echo "Link check complete; look for any errors in the above output " \
+	      "or in $(BUILDDIR)/linkcheck/output.txt."
+
+doctest:
+	$(SPHINXBUILD) -b doctest $(ALLSPHINXOPTS) $(BUILDDIR)/doctest
+	@echo "Testing of doctests in the sources finished, look at the " \
+	      "results in $(BUILDDIR)/doctest/output.txt."

doc/public/conf.py

+# -*- coding: utf-8 -*-
+#
+# edX Docs documentation build configuration file, created by
+# sphinx-quickstart on Mon Feb 25 16:55:22 2013.
+#
+# This file is execfile()d with the current directory set to its containing dir.
+#
+# Note that not all possible configuration values are present in this
+# autogenerated file.
+#
+# All configuration values have a default; values that are commented out
+# serve to show the default.
+
+import sys, os
+
+# If extensions (or modules to document with autodoc) are in another directory,
+# add these directories to sys.path here. If the directory is relative to the
+# documentation root, use os.path.abspath to make it absolute, like shown here.
+#sys.path.insert(0, os.path.abspath('.'))
+
+# -- General configuration -----------------------------------------------------
+# If your documentation needs a minimal Sphinx version, state it here.
+#needs_sphinx = '1.0'
+
+# Add any Sphinx extension module names here, as strings. They can be extensions
+# coming with Sphinx (named 'sphinx.ext.*') or your custom ones.
+extensions = ['sphinx.ext.intersphinx', 'sphinx.ext.mathjax']
+
+# Add any paths that contain templates here, relative to this directory.
+templates_path = ['_templates']
+
+# The suffix of source filenames.
+source_suffix = '.rst'
+
+# The encoding of source files.
+#source_encoding = 'utf-8-sig'
+
+# The master toctree document.
+master_doc = 'index'
+
+# General information about the project.
+project = u'edX Data'
+copyright = u'2013, edX Team'
+
+# The version info for the project you're documenting, acts as replacement for
+# |version| and |release|, also used in various other places throughout the
+# built documents.
+#
+# The short X.Y version.
+version = '0.1'
+# The full version, including alpha/beta/rc tags.
+release = '0.1'
+
+# The language for content autogenerated by Sphinx. Refer to documentation
+# for a list of supported languages.
+#language = None
+
+# There are two options for replacing |today|: either, you set today to some
+# non-false value, then it is used:
+#today = ''
+# Else, today_fmt is used as the format for a strftime call.
+#today_fmt = '%B %d, %Y'
+
+# List of patterns, relative to source directory, that match files and
+# directories to ignore when looking for source files.
+exclude_patterns = ['_build']
+
+# The reST default role (used for this markup: `text`) to use for all documents.
+#default_role = None
+
+# If true, '()' will be appended to :func: etc. cross-reference text.
+#add_function_parentheses = True
+
+# If true, the current module name will be prepended to all description
+# unit titles (such as .. function::).
+#add_module_names = True
+
+# If true, sectionauthor and moduleauthor directives will be shown in the
+# output. They are ignored by default.
+#show_authors = False
+
+# The name of the Pygments (syntax highlighting) style to use.
+pygments_style = 'sphinx'
+
+# A list of ignored prefixes for module index sorting.
+#modindex_common_prefix = []
+
+
+# -- Options for HTML output ---------------------------------------------------
+
+# The theme to use for HTML and HTML Help pages.  See the documentation for
+# a list of builtin themes.
+html_theme = 'sphinxdoc'
+
+# Theme options are theme-specific and customize the look and feel of a theme
+# further.  For a list of options available for each theme, see the
+# documentation.
+#html_theme_options = {}
+
+# Add any paths that contain custom themes here, relative to this directory.
+#html_theme_path = []
+
+# The name for this set of Sphinx documents.  If None, it defaults to
+# "<project> v<release> documentation".
+#html_title = None
+
+# A shorter title for the navigation bar.  Default is the same as html_title.
+#html_short_title = None
+
+# The name of an image file (relative to this directory) to place at the top
+# of the sidebar.
+#html_logo = None
+
+# The name of an image file (within the static path) to use as favicon of the
+# docs.  This file should be a Windows icon file (.ico) being 16x16 or 32x32
+# pixels large.
+#html_favicon = None
+
+# Add any paths that contain custom static files (such as style sheets) here,
+# relative to this directory. They are copied after the builtin static files,
+# so a file named "default.css" will overwrite the builtin "default.css".
+html_static_path = ['_static']
+
+# If not '', a 'Last updated on:' timestamp is inserted at every page bottom,
+# using the given strftime format.
+#html_last_updated_fmt = '%b %d, %Y'
+
+# If true, SmartyPants will be used to convert quotes and dashes to
+# typographically correct entities.
+#html_use_smartypants = True
+
+# Custom sidebar templates, maps document names to template names.
+#html_sidebars = {}
+
+# Additional templates that should be rendered to pages, maps page names to
+# template names.
+#html_additional_pages = {}
+
+# If false, no module index is generated.
+#html_domain_indices = True
+
+# If false, no index is generated.
+#html_use_index = True
+
+# If true, the index is split into individual pages for each letter.
+#html_split_index = False
+
+# If true, links to the reST sources are added to the pages.
+#html_show_sourcelink = True
+
+# If true, "Created using Sphinx" is shown in the HTML footer. Default is True.
+#html_show_sphinx = True
+
+# If true, "(C) Copyright ..." is shown in the HTML footer. Default is True.
+#html_show_copyright = True
+
+# If true, an OpenSearch description file will be output, and all pages will
+# contain a <link> tag referring to it.  The value of this option must be the
+# base URL from which the finished HTML is served.
+#html_use_opensearch = ''
+
+# This is the file name suffix for HTML files (e.g. ".xhtml").
+#html_file_suffix = None
+
+# Output file base name for HTML help builder.
+htmlhelp_basename = 'edXDocsdoc'
+
+
+# -- Options for LaTeX output --------------------------------------------------
+
+latex_elements = {
+# The paper size ('letterpaper' or 'a4paper').
+#'papersize': 'letterpaper',
+
+# The font size ('10pt', '11pt' or '12pt').
+#'pointsize': '10pt',
+
+# Additional stuff for the LaTeX preamble.
+#'preamble': '',
+}
+
+# Grouping the document tree into LaTeX files. List of tuples
+# (source start file, target name, title, author, documentclass [howto/manual]).
+latex_documents = [
+  ('index', 'edXDocs.tex', u'edX Data Documentation',
+   u'edX Team', 'manual'),
+]
+
+# The name of an image file (relative to this directory) to place at the top of
+# the title page.
+#latex_logo = None
+
+# For "manual" documents, if this is true, then toplevel headings are parts,
+# not chapters.
+#latex_use_parts = False
+
+# If true, show page references after internal links.
+#latex_show_pagerefs = False
+
+# If true, show URL addresses after external links.
+#latex_show_urls = False
+
+# Documents to append as an appendix to all manuals.
+#latex_appendices = []
+
+# If false, no module index is generated.
+#latex_domain_indices = True
+
+
+# -- Options for manual page output --------------------------------------------
+
+# One entry per manual page. List of tuples
+# (source start file, name, description, authors, manual section).
+man_pages = [
+    ('index', 'edxdocs', u'edX Data Documentation',
+     [u'edX Team'], 1)
+]
+
+# If true, show URL addresses after external links.
+#man_show_urls = False
+
+
+# -- Options for Texinfo output ------------------------------------------------
+
+# Grouping the document tree into Texinfo files. List of tuples
+# (source start file, target name, title, author,
+#  dir menu entry, description, category)
+texinfo_documents = [
+  ('index', 'edXDocs', u'edX Data Documentation',
+   u'edX Team', 'edXDocs', 'One line description of project.',
+   'Miscellaneous'),
+]
+
+# Documents to append as an appendix to all manuals.
+#texinfo_appendices = []
+
+# If false, no module index is generated.
+#texinfo_domain_indices = True
+
+# How to display URL addresses: 'footnote', 'no', or 'inline'.
+#texinfo_show_urls = 'footnote'
+
+
+# Example configuration for intersphinx: refer to the Python standard library.
+intersphinx_mapping = {'http://docs.python.org/': None}

doc/public/course_data_formats/course_xml.rst

+###################
+Course XML Tutorial
+###################
+EdX uses an XML format to describe the structure and contents of its courses. While much of this is abstracted away by the Studio authoring interface, it is still helpful to understand how the edX platform renders a course.
+
+This guide was written with the assumption that you've dived straight into the edX platform without necessarily having any prior programming/CS knowledge. It will be especially valuable to you if your course is being authored with XML files rather than Studio -- in which case you're likely using functionality that is not yet fully supported in Studio.
+
+*****
+Goals
+*****
+After reading this, you should be able to:
+
+* Organize your course content into the files and folders the edX platform expects.
+* Add new content to a course and make sure it shows up in the courseware.
+
+*Prerequisites:* it would be helpful to know a little bit about xml.  Here is a 
+`simple example <http://www.ultraslavonic.info/intro-to-xml/>`_ if you've never seen it before. 
+
+************
+Introduction
+************
+
+A course is organized hierarchically. We start by describing course-wide parameters, then break the course into chapters, and then go deeper and deeper until we reach a specific pset, video, etc. You could make an analogy to finding a green shirt in your house -> bedroom -> closet -> drawer -> shirts -> green shirt.
+
+We'll begin with a sample course structure as a case study of how XML and files in a course are organized. More technical details will follow, including discussion of some special cases.
+
+**********
+Case Study
+**********
+Let's jump right in by looking at the directory structure of a very simple toy course::
+
+  toy/
+      course/
+      course.xml
+      problem/
+      policies/
+      roots/
+
+The only top level file is `course.xml`, which should contain one line, looking something like this:
+
+.. code-block:: xml
+
+  <course org="edX" course="toy" url_name="2012_Fall"/>
+
+This gives all the information to uniquely identify a particular run of any course -- which organization is producing the course, what the course name is, and what "run" this is, specified via the `url_name` attribute.
+
+Obviously, this doesn't actually specify any of the course content, so we need to find that next.  To know where to look, you need to know the standard organizational structure of our system: course elements are uniquely identified by the combination `(category, url_name)`. In this case, we are looking for a `course` element with the `url_name` "2012_Fall". The definition of this element will be in `course/2012_Fall.xml`. Let's look there next::
+
+  toy/
+      course/
+             2012_Fall.xml # <-- Where we look for category="course", url_name="2012_Fall"
+
+.. code-block:: xml
+
+  <!-- Contents of course/2012_Fall.xml -->
+  <course>
+    <chapter url_name="Overview">
+      <videosequence url_name="Toy_Videos">
+        <problem url_name="warmup"/>
+        <video url_name="Video_Resources" youtube="1.0:1bK-WdDi6Qw"/>
+      </videosequence>
+      <video url_name="Welcome" youtube="1.0:p2Q6BrNhdh8"/>
+    </chapter>
+  </course>
+
+Aha. Now we've found some content. We can see that the course is organized hierarchically, in this case with only one chapter, with `url_name` "Overview". The chapter contains a `videosequence` and a `video`, with the sequence containing a problem and another video. When viewed in the courseware, chapters are shown at the top level of the navigation accordion on the left, with any elements directly included in the chapter below.
+
+Looking at this file, we can see the course structure, and the youtube urls for the videos, but what about the "warmup" problem?  There is no problem content here! Where should we look? This is a good time to pause and try to answer that question based on our organizational structure above.
+
+As you hopefully guessed, the problem would be in `problem/warmup.xml`.  (Note: This tutorial doesn't discuss the xml format for problems -- there are chapters of edx4edx that describe it.)  This is an instance of a *pointer tag*: any xml tag with only the category and a url_name attribute will point to the file `{category}/{url_name}.xml`.  For example, this means that our toy `course.xml` could have also been written as
+
+.. code-block:: xml
+
+  <!-- Contents of course/2012_Fall.xml -->
+  <course>
+    <chapter url_name="Overview"/>
+  </course>
+
+with `chapter/Overview.xml` containing
+
+.. code-block:: xml
+
+  <chapter>
+    <videosequence url_name="Toy_Videos">
+      <problem url_name="warmup"/>
+      <video url_name="Video_Resources" youtube="1.0:1bK-WdDi6Qw"/>
+    </videosequence>
+    <video url_name="Welcome" youtube="1.0:p2Q6BrNhdh8"/>
+  </chapter>
+
+In fact, this is the recommended structure for real courses -- putting each chapter into its own file makes it easy to have different people work on each without conflicting or having to merge.  Similarly, as sequences get large, it can be handy to split them out as well (in `sequence/{url_name}.xml`, of course).
+
+Note that the `url_name` is only specified once per element -- either the inline definition, or in the pointer tag.
+
+Policy Files
+============
+
+We still haven't looked at two of the directories in the top-level listing above: `policies` and `roots`.  Let's look at policies next.  The policy directory contains one file::
+
+  toy/
+      policies/
+               2012_Fall.json
+
+and that file is named `{course-url_name}.json`.  As you might expect, this file contains a policy for the course. In our example, it looks like this:
+
+.. code-block:: json
+
+    {
+        "course/2012_Fall": {
+            "graceperiod": "2 days 5 hours 59 minutes 59 seconds",
+            "start": "2015-07-17T12:00",
+            "display_name": "Toy Course"
+        },
+        "chapter/Overview": {
+            "display_name": "Overview"
+        },
+        "videosequence/Toy_Videos": {
+            "display_name": "Toy Videos",
+            "format": "Lecture Sequence"
+        },
+        "problem/warmup": {
+            "display_name": "Getting ready for the semester"
+        },
+        "video/Video_Resources": {
+            "display_name": "Video Resources"
+        },
+        "video/Welcome": {
+            "display_name": "Welcome"
+        }
+    }
+
+The policy specifies metadata about the content elements -- things which are not inherent to the definition of the content, but which describe how the content is presented to the user and used in the course.  See below for a full list of metadata attributes; as the example shows, they include `display_name`, which is what is shown when this piece of content is referenced or shown in the courseware, and various dates and times, like `start`, which specifies when the content becomes visible to students, and various problem-specific parameters like the allowed number of attempts.  One important point is that some metadata is inherited: for example, specifying the start date on the course makes it the default for every element in the course.  See below for more details.
+
+It is possible to put metadata directly in the XML, as attributes of the appropriate tag, but using a policy file has two benefits: it puts all the policy in one place, making it easier to check that things like due dates are set properly, and it allows the content definitions to be easily used in another run of the same course, with the same or similar content, but different policy.
+
+Roots
+=====
+The last directory in the top level listing is `roots`.  In our toy course, it contains a single file::
+
+  roots/
+        2012_Fall.xml
+
+This file is identical to the top-level `course.xml`, containing
+
+.. code-block:: xml
+
+  <course org="edX" course="toy" url_name="2012_Fall"/>
+
+In fact, the top level `course.xml` is a symbolic link to this file.  When there is only one run of a course, the roots directory is not really necessary, and the top-level course.xml file can just specify the `url_name` of the course.  However, if we wanted to make a second run of our toy course, we could add another file called, e.g., `roots/2013_Spring.xml`, containing
+
+.. code-block:: xml
+
+  <course org="edX" course="toy" url_name="2013_Spring"/>
+
+After creating `course/2013_Spring.xml` with the course structure (possibly as a symbolic link or copy of `course/2012_Fall.xml` if no content was changing), and `policies/2013_Spring.json`, we would have two different runs of the toy course in the course repository.  Our build system understands this roots structure, and will build a course package for each root.
+
+.. note::
+   If you're using a local development environment, make the top level `course.xml` point to the desired root, and check out the repo multiple times if you need multiple runs simultaneously).
+
+That's basically all there is to the organizational structure.  Read the next section for details on the tags we support, including some special case tags like `customtag` and `html` invariants, and look at the end for some tips that will make the editing process easier.
+
+****
+Tags
+****
+
+  .. list-table::
+     :widths: 10 80
+     :header-rows: 0
+     
+     * - `abtest`
+       - Support for A/B testing.  TODO: add details..
+     * - `chapter`
+       - Top level organization unit of a course. The courseware display code currently expects the top level `course` element to contain only chapters, though there is no philosophical reason why this is required, so we may change it to properly display non-chapters at the top level.
+     * - `conditional`
+       - Conditional element, which shows one or more modules only if certain conditions are satisfied.
+     * - `course`
+       - Top level tag.  Contains everything else.
+     * - `customtag` 
+       - Render an html template, filling in some parameters, and return the resulting html. See below for details.
+     * - `discussion`
+       - Inline discussion forum.
+     * - `html`
+       - A reference to an html file.
+     * - `error`
+       - Don't put these in by hand :) The internal representation of content that has an error, such as malformed XML or some broken invariant.
+     * - `problem`
+       - See elsewhere in edx4edx for documentation on the format.
+     * - `problemset`
+       - Logically, a series of related problems. Currently displayed vertically. May contain explanatory html, videos, etc.
+     * - `sequential`
+       - A sequence of content, currently displayed with a horizontal list of tabs. If possible, use a more semantically meaningful tag (currently, we only have `videosequence`).
+     * - `vertical`
+       - A sequence of content, displayed vertically. Content will be accessed all at once, on the right part of the page. No navigational bar. May have to use browser scroll bars. Content split with separators. If possible, use a more semantically meaningful tag (currently, we only have `problemset`).
+     * - `video`
+       - A link to a video, currently expected to be hosted on youtube.
+     * - `videosequence`
+       - A sequence of videos.  This can contain various non-video content; it just signals to the system that this is logically part of an explanatory sequence of content, as opposed to say an exam sequence.
+
+Container Tags
+==============
+Container tags include `chapter`, `sequential`, `videosequence`, `vertical`, and `problemset`. They are all specified in the same way in the xml, as shown in the tutorial above.
+
+`course`
+========
+`course` is also a container, and is similar, with one extra wrinkle: the top level pointer tag *must* have  `org` and `course` attributes specified--the organization name, and course name. Note that `course` is referring to the platonic ideal of this course (e.g. "6.002x"), not to any particular run of this course. The `url_name` should be the particular run of this course.
+
+`conditional`
+=============
+`conditional` is as special kind of container tag as well.  Here are two examples:
+
+  .. code-block:: xml
+  
+    <conditional condition="require_completed" required="problem/choiceprob">
+      <video url_name="secret_video" />
+    </conditional>
+  
+    <conditional condition="require_attempted" required="problem/choiceprob&problem/sumprob">
+      <html url_name="secret_page" />
+    </conditional>
+
+The condition can be either `require_completed`, in which case the required modules must be completed, or `require_attempted`, in which case the required modules must have been attempted.
+
+The required modules are specified as a set of `tag`/`url_name`, joined by an ampersand.
+
+`customtag`
+===========
+When we see:
+
+  .. code-block:: xml
+
+    <customtag impl="special" animal="unicorn" hat="blue"/>
+
+We will:
+
+#. Look for a file called `custom_tags/special`  in your course dir.
+#. Render it as a mako template, passing parameters {'animal':'unicorn', 'hat':'blue'}, generating html.  (Google `mako` for template syntax, or look at existing examples).
+
+Since `customtag` is already a pointer, there is generally no need to put it into a separate file--just use it in place:
+
+  .. code-block:: xml
+
+    <customtag url_name="my_custom_tag" impl="blah" attr1="..."/>
+
+`discussion`
+============
+The discussion tag embeds an inline discussion module. The XML format is:
+
+  .. code-block:: xml
+
+    <discussion for="Course overview" id="6002x_Fall_2012_Overview" discussion_category="Week 1/Overview" />
+
+The meaning of each attribute is as follows:
+
+  .. list-table::
+     :widths: 10 80
+     :header-rows: 0
+
+     * - `for`
+       - A string that describes the discussion. Purely for descriptive purposes (to the student).
+     * - `id`
+       - The identifier that the discussion forum service uses to refer to this inline discussion module. Since the `id` must be unique and lives in a common namespace with all other courses, the preferred convention is to use `<course_name>_<course_run>_<descriptor>` as in the above example. The `id` should be "machine-friendly", e.g. use alphanumeric characters, underscores. Do **not** use a period (e.g. `6.002x_Fall_2012_Overview`).
+     * - `discussion_category`
+       - The inline module will be indexed in the main "Discussion" tab of the course. The inline discussions are organized into a directory-like hierarchy. Note that the forward slash indicates depth, as in conventional filesytems. In the above example, this discussion module will show up in the following "directory": `Week 1/Overview/Course overview`
+
+Note that the `for` tag has been appended to the end of the `discussion_category`. This can often lead into deeply nested subforums, which may not be intended. In the above example, if we were to use instead:
+
+  .. code-block:: xml
+
+   <discussion for="Course overview" id="6002x_Fall_2012_Overview" discussion_category="Week 1" />
+
+This discussion module would show up in the main forums as `Week 1 / Course overview`, which is more succinct.
+
+`html`
+======
+Most of our content is in XML, but some HTML content may not be proper xml (all tags matched, single top-level tag, etc), since browsers are fairly lenient in what they'll display.  So, there are two ways to include HTML content:
+
+* If your HTML content is in a proper XML format, just put it in `html/{url_name}.xml`.
+* If your HTML content is not in proper XML format, you can put it in `html/{filename}.html`, and put `<html filename={filename} />` in `html/{filename}.xml`.  This allows another level of indirection, and makes sure that we can read the XML file and then just return the actual HTML content without trying to parse it.
+
+`video`
+=======
+Videos have an attribute `youtube`, which specifies a series of speeds + youtube video IDs:
+
+  .. code-block:: xml
+
+    <video youtube="0.75:1yk1A8-FPbw,1.0:vNMrbPvwhU4,1.25:gBW_wqe7rDc,1.50:7AE_TKgaBwA" 
+           url_name="S15V14_Response_to_impulse_limit_case"/>
+
+This video has been encoded at 4 different speeds: `0.75x`, `1x`, `1.25x`, and `1.5x`.
+
+More on `url_name`
+==================
+Every content element (within a course) should have a unique id.  This id is formed as `{category}/{url_name}`, or automatically generated from the content if `url_name` is not specified.  Categories are the different tag types ('chapter', 'problem', 'html', 'sequential', etc).  Url_name is a string containing a-z, A-Z, dot (.), underscore (_), and ':'.  This is what appears in urls that point to this object.
+
+Colon (':') is special--when looking for the content definition in an xml, ':' will be replaced with '/'.  This allows organizing content into folders.  For example, given the pointer tag
+
+  .. code-block:: xml
+
+    <problem url_name="conceptual:add_apples_and_oranges"/>
+
+we would look for the problem definition in `problem/conceptual/add_apples_and_oranges.xml`. (There is a technical reason why we can't just allow '/' in the url_name directly.)
+
+.. important::
+  A student's state for a particular content element is tied to the element ID, so automatic ID generation is only ok for elements that do not need to store any student state (e.g. verticals or customtags).  For problems, sequentials, and videos, and any other element where we keep track of what the student has done and where they are at, you should specify a unique `url_name`. Of course, any content element that is split out into a file will need a `url_name` to specify where to find the definition.
+
+
+************
+Policy Files
+************
+* A policy file is useful when running different versions of a course e.g. internal, external, fall, spring, etc. as you can change due dates, etc, by creating multiple policy files.
+* A policy file provides information on the metadata of the course--things that are not inherent to the definitions of the contents, but that may vary from run to run.
+* Note: We will be expanding our understanding and format for metadata in the not-too-distant future, but for now it is simply a set of key-value pairs.
+
+Locations
+=========
+* The policy for a course run `some_url_name` should live in `policies/some_url_name/policy.json`  (NOTE: the old format of putting it in `policies/some_url_name.json` will also work, but we suggest using the subdirectory to have all the per-course policy files in one place)
+* Grading policy files go in `policies/some_url_name/grading_policy.json`   (if there's only one course run, can also put it directly in the course root: `/grading_policy.json`)
+
+Contents
+========
+* The file format is JSON, and is best shown by example, as in the tutorial above.
+* The expected contents are a dictionary mapping from keys to values (syntax `{ key : value, key2 : value2, etc}`)
+* Keys are in the form `{category}/{url_name}`, which should uniquely identify a content element. Values are dictionaries of the form `{"metadata-key" : "metadata-value"}`.
+* The order in which things appear does not matter, though it may be helpful to organize the file in the same order as things appear in the content.
+* NOTE: JSON is picky about commas.  If you have trailing commas before closing braces, it will complain and refuse to parse the file.  This can be irritating at first.
+
+Supported fields at the course level
+====================================
+
+  .. list-table::
+     :widths: 10 80
+     :header-rows: 0
+
+     * - `start`
+       - specify the start date for the course.  Format-by-example: `"2012-09-05T12:00"`.
+     * - `advertised_start`
+       - specify what you want displayed as the start date of the course in the course listing and course about pages. This can be useful if you want to let people in early before the formal start. Format-by-example: `"2012-09-05T12:"00`.
+     * - `disable_policy_graph`
+       - set to true (or "Yes"), if the policy graph should be disabled (ie not shown).
+     * - `enrollment_start`, `enrollment_end`
+       - -- when can students enroll?  (if not specified, can enroll anytime). Same format as `start`.
+     * - `end`
+       - specify the end date for the course.  Format-by-example: `"2012-11-05T12:00"`.
+     * - `end_of_course_survey_url`
+       - a url for an end of course survey -- shown after course is over, next to certificate download links.
+     * - `tabs`
+       - have custom tabs in the courseware.  See below for details on config.
+     * - `discussion_blackouts`
+       - An array of time intervals during which you want to disable a student's ability to create or edit posts in the forum. Moderators, Community TAs, and Admins are unaffected. You might use this during exam periods, but please be aware that the forum is often a very good place to catch mistakes and clarify points to students. The better long term solution would be to have better flagging/moderation mechanisms, but this is the hammer we have today. Format by example: `[["2012-10-29T04:00", "2012-11-03T04:00"], ["2012-12-30T04:00", "2013-01-02T04:00"]]`
+     * - `show_calculator`
+       - (value "Yes" if desired)
+     * - `days_early_for_beta`
+       - number of days (floating point ok) early that students in the beta-testers group get to see course content.  Can also be specified for any other course element, and overrides values set at higher levels.
+     * - `cohort_config`
+       -
+          * `cohorted` : boolean.  Set to true if this course uses student cohorts.  If so, all inline discussions are automatically cohorted, and top-level discussion topics are configurable via the cohorted_discussions list. Default is not cohorted).
+          * `cohorted_discussions`: list of discussions that should be cohorted.  Any not specified in this list are not cohorted.
+          * `auto_cohort`: Truthy.
+          * `auto_cohort_groups`: `["group name 1", "group name 2", ...]` If `cohorted` and `auto_cohort` is true, automatically put each student into a random group from the `auto_cohort_groups` list, creating the group if needed.  
+
+
+Available metadata
+==================
+
+Not Inherited
+--------------
+`display_name`
+  Name that will appear when this content is displayed in the courseware.  Useful for all tag types.
+
+`format`
+  Subheading under display name -- currently only displayed for chapter sub-sections.  Also used by the the grader to know how to process students assessments that the section contains. New formats can be defined as a 'type' in the GRADER variable in course_settings.json. Optional.  (TODO: double check this--what's the current behavior?)
+
+`hide_from_toc`
+  If set to true for a chapter or chapter subsection, will hide that element from the courseware navigation accordion.  This is useful if you'd like to link to the content directly instead (e.g. for tutorials)
+
+`ispublic`
+  Specify whether the course is public.  You should be able to use start dates instead (?)
+
+Inherited
+---------
+
+`start`
+  When this content should be shown to students.  Note that anyone with staff access to the course will always see everything.
+
+`showanswer`
+  When to show answer. For 'attempted', will show answer after first attempt. Values: never, attempted, answered, closed. Default: closed. Optional.
+
+`graded`
+  Whether this section will count towards the students grade. "true" or "false". Defaults to "false".
+
+`rerandomize`
+  Randomize question on each attempt. Optional. Possible values:
+  
+  `always` (default)
+    Students see a different version of the problem after each attempt to solve it.
+  `onreset`
+    Randomize question when reset button is pressed by the student.
+  `never`
+    All students see the same version of the problem.
+  `per_student`
+    Individual students see the same version of the problem each time the look at it, but that version is different from what other students see.
+  `due`
+    Due date for assignment. Assignment will be closed after that.  Values: valid date. Default: none. Optional.
+  `attempts`
+    Number of allowed attempts. Values: integer. Default: infinite. Optional.
+  `graceperiod`
+    A default length of time that the problem is still accessible after the due date in the format `"2 days 3 hours"` or `"1 day 15 minutes"`.  Note, graceperiods are currently the easiest way to handle time zones. Due dates are all expressed in UTC.
+  `xqa_key`
+    For integration with Ike's content QA server. -- should typically be specified at the course level.
+
+Inheritance example
+-------------------
+This is a sketch ("tue" is not a valid start date), that should help illustrate how metadata inheritance works.
+
+  .. code-block:: xml
+
+    <course start="tue">
+      <chap1> -- start tue
+        <problem>   --- start tue
+      </chap1>
+      <chap2 start="wed">  -- start wed
+       <problem2 start="thu">  -- start thu
+       <problem3>      -- start wed
+      </chap2>
+    </course>
+
+
+Specifying metadata in the XML file
+-----------------------------------
+Metadata can also live in the xml files, but anything defined in the policy file overrides anything in the XML.  This is primarily for backwards compatibility, and you should probably  not use both.  If you do leave some metadata tags in the xml, you should be consistent (e.g. if `display_name` stays in XML, they should all stay in XML. Note `display_name` should be specified in the problem xml definition itself, ie, `<problem display_name="Title">Problem Text</problem>`, in file `ProblemFoo.xml`).
+
+.. note::
+   Some xml attributes are not metadata.  e.g. in `<video youtube="xyz987293487293847"/>`, the `youtube` attribute specifies what video this is, and is logically part of the content, not the policy, so it should stay in the xml.
+
+Another example policy file::
+
+    {
+        "course/2012": {
+            "graceperiod": "1 day",
+            "start": "2012-10-15T12:00",
+            "display_name": "Introduction to Computer Science I",
+            "xqa_key": "z1y4vdYcy0izkoPeihtPClDxmbY1ogDK"
+        },
+        "chapter/Week_0": {
+            "display_name": "Week 0"
+        },
+        "sequential/Pre-Course_Survey": {
+            "display_name": "Pre-Course Survey",
+            "format": "Survey"
+        }
+    }
+
+
+
+Deprecated Formats
+------------------
+If you look at some older xml, you may see some tags or metadata attributes that aren't listed above.  They are deprecated, and should not be used in new content.  We include them here so that you can understand how old-format content works.
+
+Obsolete Tags
+^^^^^^^^^^^^^
+`section`
+  This used to be necessary within chapters.  Now, you can just use any standard tag inside a chapter, so use the container tag that makes the most sense for grouping content--e.g. `problemset`, `videosequence`, and just include content directly if it belongs inside a chapter (e.g. `html`, `video`, `problem`)
+
+`videodev, book, slides, image, discuss`
+  There used to be special purpose tags that all basically did the same thing, and have been subsumed by `customtag`.  The list is `videodev, book, slides, image, discuss`.  Use `customtag` in new content.  (e.g. instead of `<book page="12"/>`, use `<customtag impl="book" page="12"/>`)
+
+Obsolete Attributes
+^^^^^^^^^^^^^^^^^^^
+`slug`
+  Old term for `url_name`.  Use `url_name`
+
+`name`
+  We didn't originally have a distinction between `url_name` and `display_name` -- this made content element ids fragile, so please use `url_name` as a stable unique identifier for the content, and `display_name` as the particular string you'd like to display for it.
+
+************
+Static links
+************
+If your content links (e.g. in an html file)  to `"static/blah/ponies.jpg"`, we will look for this...
+
+* If your course dir has a `static/` subdirectory, we will look in `YOUR_COURSE_DIR/static/blah/ponies.jpg`.   This is the prefered organization, as it does not expose anything except what's in `static/` to the world.
+*  If your course dir does not have a `static/` subdirectory, we will look in `YOUR_COURSE_DIR/blah/ponies.jpg`.  This is the old organization, and requires that the web server allow access to everything in the couse dir.  To switch to the new organization, move all your static content into a new `static/` dir  (e.g. if you currently have things in `images/`, `css/`, and `special/`, create a dir called `static/`, and move `images/, css/, and special/` there).
+
+Links that include `/course` will be rewritten to the root of your course in the courseware (e.g. `courses/{org}/{course}/{url_name}/` in the current url structure).  This is useful for linking to the course wiki, for example.
+
+****
+Tabs
+****
+
+If you want to customize the courseware tabs displayed for your course, specify a "tabs" list in the course-level policy, like the following example:
+
+.. code-block:: json
+
+  "tabs" : [
+    {"type": "courseware"},
+    {
+      "type": "course_info",
+      "name": "Course Info"
+    },
+    {
+      "type": "external_link",
+      "name": "My Discussion",
+      "link": "http://www.mydiscussion.org/blah"
+    },
+    {"type": "progress", "name": "Progress"},
+    {"type": "wiki", "name": "Wonderwiki"},
+    {
+      "type": "static_tab",
+      "url_slug": "news",
+      "name": "Exciting news"
+    },
+    {"type": "textbooks"}
+  ]
+
+* If you specify any tabs, you must specify all tabs.  They will appear in the order given.
+* The first two tabs must have types `"courseware"` and `"course_info"`, in that order, or the course will not load.
+* The `courseware` tab never has a name attribute -- it's always rendered as "Courseware" for consistency between courses.
+* The `textbooks` tab will actually generate one tab per textbook, using the textbook titles as names.
+* For static tabs, the `url_slug` will be the url that points to the tab.  It can not be one of the existing courseware url types (even if those aren't used in your course).  The static content will come from `tabs/{course_url_name}/{url_slug}.html`, or `tabs/{url_slug}.html` if that doesn't exist.
+* An Instructor tab will be automatically added at the end for course staff users.
+
+.. list-table:: Supported Tabs and Parameters
+   :widths: 10 80
+   :header-rows: 0
+
+   * - `courseware`
+     - No other parameters.
+   * - `course_info`
+     - Parameter `name`.
+   * - `wiki`
+     - arameter `name`.
+   * - `discussion`
+     - Parameter `name`.
+   * - `external_link`
+     - Parameters `name`, `link`.
+   * - `textbooks`
+     - No parameters--generates tab names from book titles.
+   * - `progress`
+     - Parameter `name`.
+   * - `static_tab`
+     - Parameters `name`, `url_slug`--will look for tab contents in 'tabs/{course_url_name}/{tab url_slug}.html'
+   * - `staff_grading`
+     - No parameters.  If specified, displays the staff grading tab for instructors.
+
+*************************************
+Other file locations (info and about)
+*************************************
+With different course runs, we may want different course info and about materials.  This is now supported by putting files in as follows::
+
+    / 
+      about/
+           foo.html      -- shared default for all runs
+           url_name1/
+                foo.html   -- version used for url_name1
+                bar.html   -- bar for url_name1
+           url_name2/
+                bar.html   -- bar for url_name2
+                           -- url_name2 will use default foo.html
+
+and the same works for the `info` directory.
+
+
+***************************
+Tips for content developers
+***************************
+
+#. We will be making better tools for managing policy files soon.  In the meantime, you can add dummy definitions to make it easier to search and separate the file visually.  For example, you could add `"WEEK 1" : "###################"`, before the week 1 material to make it easy to find in the file.
+
+#. Come up with a consistent pattern for url_names, so that it's easy to know where to look for any piece of content.  It will also help to come up with a standard way of splitting your content files.  As a point of departure, we suggest splitting chapters, sequences, html, and problems into separate files.
+
+#. Prefer the most "semantic" name for containers: e.g., use problemset rather than sequential for a problem set. That way, if we decide to display problem sets differently, we don't have to change the XML.
+

doc/public/course_data_formats/drag_and_drop/drag-n-drop-demo.xml

+<problem display_name="Drag and drop demos: drag and drop icons or labels
+    to proper positions." >
+
+<customresponse>
+    <text>
+        <h4>[Anyof rule example]</h4><br/>
+        <h4>Please label hydrogen  atoms connected with left carbon atom.</h4>
+        <br/>
+    </text>
+
+    <drag_and_drop_input img="/static/images/images_list/ethglycol.jpg" target_outline="true"
+        one_per_target="true" no_labels="true" label_bg_color="rgb(222, 139, 238)">
+        <draggable id="1" label="Hydrogen" />
+        <draggable id="2" label="Hydrogen" />
+
+        <target id="t1_o" x="10" y="67" w="100" h="100"/>
+        <target id="t2" x="133" y="3" w="70" h="70"/>
+        <target id="t3" x="2" y="384" w="70" h="70"/>
+        <target id="t4" x="95" y="386" w="70" h="70"/>
+        <target id="t5_c" x="94" y="293" w="91" h="91"/>
+        <target id="t6_c" x="328" y="294" w="91" h="91"/>
+        <target id="t7" x="393" y="463" w="70" h="70"/>
+        <target id="t8" x="344" y="214" w="70" h="70"/>
+        <target id="t9_o" x="445" y="162" w="100" h="100"/>
+        <target id="t10" x="591" y="132" w="70" h="70"/>
+
+    </drag_and_drop_input>
+
+    <answer type="loncapa/python"><![CDATA[
+correct_answer = [
+{'draggables': ['1', '2'],
+'targets': ['t2', 't3', 't4' ],
+'rule':'anyof'
+}]
+if draganddrop.grade(submission[0], correct_answer):
+    correct = ['correct']
+else:
+    correct = ['incorrect']
+]]></answer>
+</customresponse>
+
+<customresponse>
+    <text>
+        <h4>[Complex grading example]</h4><br/>
+        <h4>Describe carbon molecule in LCAO-MO.</h4>
+        <br/>
+    </text>
+
+    <drag_and_drop_input img="/static/images/images_list/lcao-mo/lcao-mo.jpg" target_outline="true" >
+
+        <!-- filled bond -->
+        <draggable id="1" icon="/static/images/images_list/lcao-mo/u_d.png" />
+        <draggable id="2" icon="/static/images/images_list/lcao-mo/u_d.png" />
+        <draggable id="3" icon="/static/images/images_list/lcao-mo/u_d.png" />
+        <draggable id="4" icon="/static/images/images_list/lcao-mo/u_d.png" />
+        <draggable id="5" icon="/static/images/images_list/lcao-mo/u_d.png" />
+        <draggable id="6" icon="/static/images/images_list/lcao-mo/u_d.png" />
+
+        <!-- up bond -->
+        <draggable id="7"  icon="/static/images/images_list/lcao-mo/up.png"/>
+        <draggable id="8"  icon="/static/images/images_list/lcao-mo/up.png"/>
+        <draggable id="9"  icon="/static/images/images_list/lcao-mo/up.png"/>
+        <draggable id="10" icon="/static/images/images_list/lcao-mo/up.png"/>
+
+        <!-- sigma -->
+        <draggable id="11" icon="/static/images/images_list/lcao-mo/sigma.png"/>
+        <draggable id="12" icon="/static/images/images_list/lcao-mo/sigma.png"/>
+
+        <!-- sigma* -->
+        <draggable id="13" icon="/static/images/images_list/lcao-mo/sigma_s.png"/>
+        <draggable id="14" icon="/static/images/images_list/lcao-mo/sigma_s.png"/>
+
+        <!-- pi -->
+        <draggable id="15" icon="/static/images/images_list/lcao-mo/pi.png" />
+
+        <!-- pi* -->
+        <draggable id="16" icon="/static/images/images_list/lcao-mo/pi_s.png" />
+
+        <!-- images that should not be dragged -->
+        <draggable id="17" icon="/static/images/images_list/lcao-mo/d.png" />
+        <draggable id="18" icon="/static/images/images_list/lcao-mo/d.png" />
+
+        <!-- positions of electrons and electron pairs -->
+        <target id="s_left"       x="130" y="360"    w="32" h="32"/>
+        <target id="s_right"      x="505" y="360"    w="32" h="32"/>
+        <target id="s_sigma"      x="320" y="425"    w="32" h="32"/>
+        <target id="s_sigma_star" x="320" y="290"    w="32" h="32"/>
+        <target id="p_left_1"     x="80"  y="100"    w="32" h="32"/>
+        <target id="p_left_2"     x="125" y="100"    w="32" h="32"/>
+        <target id="p_left_3"     x="175" y="100"    w="32" h="32"/>
+        <target id="p_right_1"    x="465" y="100"    w="32" h="32"/>
+        <target id="p_right_2"    x="515" y="100"    w="32" h="32"/>
+        <target id="p_right_3"    x="560" y="100"    w="32" h="32"/>
+        <target id="p_pi_1"       x="290" y="220"    w="32" h="32"/>
+        <target id="p_pi_2"       x="335" y="220"    w="32" h="32"/>
+        <target id="p_sigma"      x="315" y="170"    w="32" h="32"/>
+        <target id="p_pi_star_1"  x="290" y="40"     w="32" h="32"/>
+        <target id="p_pi_star_2"  x="340" y="40"     w="32" h="32"/>
+        <target id="p_sigma_star" x="315" y="0"      w="32" h="32"/>
+
+        <!-- positions of names of energy levels -->
+        <target id="s_sigma_name"      x="400" y="425"  w="32" h="32"/>
+        <target id="s_sigma_star_name" x="400" y="290"  w="32" h="32"/>
+        <target id="p_pi_name"         x="400" y="220"  w="32" h="32"/>
+        <target id="p_sigma_name"      x="400" y="170"  w="32" h="32"/>
+        <target id="p_pi_star_name"    x="400" y="40"   w="32" h="32"/>
+        <target id="p_sigma_star_name" x="400" y="0"    w="32" h="32"/>
+
+  </drag_and_drop_input>
+
+    <answer type="loncapa/python"><![CDATA[
+correct_answer = [
+{
+  'draggables': ['1', '2', '3', '4', '5', '6'],
+  'targets': [
+    's_left', 's_right', 's_sigma', 's_sigma_star', 'p_pi_1', 'p_pi_2'
+  ],
+  'rule': 'unordered_equal'
+}, {
+  'draggables': ['7','8', '9', '10'],
+  'targets': ['p_left_1', 'p_left_2', 'p_right_1','p_right_2'],
+  'rule': 'unordered_equal'
+}, {
+  'draggables': ['11', '12'],
+  'targets': ['s_sigma_name', 'p_sigma_name'],
+  'rule': 'unordered_equal'
+}, {
+  'draggables': ['13', '14'],
+  'targets': ['s_sigma_star_name', 'p_sigma_star_name'],
+  'rule': 'unordered_equal'
+}, {
+  'draggables': ['15'],
+  'targets': ['p_pi_name'],
+  'rule': 'unordered_equal'
+}, {
+  'draggables': ['16'],
+  'targets': ['p_pi_star_name'],
+  'rule': 'unordered_equal'
+}]
+
+if draganddrop.grade(submission[0], correct_answer):
+    correct = ['correct']
+else:
+    correct = ['incorrect']
+]]></answer>
+</customresponse>
+
+<customresponse>
+    <text>
+        <h4>[Another complex grading example]</h4><br/>
+        <h4>Describe oxygen molecule in LCAO-MO</h4>
+        <br/>
+    </text>
+
+    <drag_and_drop_input img="/static/images/images_list/lcao-mo/lcao-mo.jpg" target_outline="true" one_per_target="true">
+        <!-- filled bond -->
+        <draggable id="1" icon="/static/images/images_list/lcao-mo/u_d.png" />
+        <draggable id="2" icon="/static/images/images_list/lcao-mo/u_d.png" />
+        <draggable id="3" icon="/static/images/images_list/lcao-mo/u_d.png" />
+        <draggable id="4" icon="/static/images/images_list/lcao-mo/u_d.png" />
+        <draggable id="5" icon="/static/images/images_list/lcao-mo/u_d.png" />
+        <draggable id="6" icon="/static/images/images_list/lcao-mo/u_d.png" />
+        <draggable id="v_fb_1" icon="/static/images/images_list/lcao-mo/u_d.png" />
+        <draggable id="v_fb_2" icon="/static/images/images_list/lcao-mo/u_d.png" />
+        <draggable id="v_fb_3" icon="/static/images/images_list/lcao-mo/u_d.png" />
+
+        <!-- up bond -->
+        <draggable id="7"  icon="/static/images/images_list/lcao-mo/up.png"/>
+        <draggable id="8"  icon="/static/images/images_list/lcao-mo/up.png"/>
+        <draggable id="9"  icon="/static/images/images_list/lcao-mo/up.png"/>
+        <draggable id="10" icon="/static/images/images_list/lcao-mo/up.png"/>
+        <draggable id="v_ub_1" icon="/static/images/images_list/lcao-mo/up.png"/>
+        <draggable id="v_ub_2" icon="/static/images/images_list/lcao-mo/up.png"/>
+
+        <!-- sigma -->
+        <draggable id="11" icon="/static/images/images_list/lcao-mo/sigma.png"/>
+        <draggable id="12" icon="/static/images/images_list/lcao-mo/sigma.png"/>
+
+        <!-- sigma* -->
+        <draggable id="13" icon="/static/images/images_list/lcao-mo/sigma_s.png"/>
+        <draggable id="14" icon="/static/images/images_list/lcao-mo/sigma_s.png"/>
+
+        <!-- pi -->
+        <draggable id="15" icon="/static/images/images_list/lcao-mo/pi.png" />
+
+        <!-- pi* -->
+        <draggable id="16" icon="/static/images/images_list/lcao-mo/pi_s.png" />
+
+        <!-- images that should not be dragged -->
+        <draggable id="17" icon="/static/images/images_list/lcao-mo/d.png" />
+        <draggable id="18" icon="/static/images/images_list/lcao-mo/d.png" />
+
+        <!-- positions of electrons and electron pairs -->
+        <target id="s_left"       x="130" y="360"    w="32" h="32"/>
+        <target id="s_right"      x="505" y="360"    w="32" h="32"/>
+        <target id="s_sigma"      x="320" y="425"    w="32" h="32"/>
+        <target id="s_sigma_star" x="320" y="290"   w="32" h="32"/>
+        <target id="p_left_1"     x="80"  y="100"   w="32" h="32"/>
+        <target id="p_left_2"     x="125" y="100"   w="32" h="32"/>
+        <target id="p_left_3"     x="175" y="100"   w="32" h="32"/>
+        <target id="p_right_1"    x="465" y="100"   w="32" h="32"/>
+        <target id="p_right_2"    x="515" y="100"   w="32" h="32"/>
+        <target id="p_right_3"    x="560" y="100"   w="32" h="32"/>
+        <target id="p_pi_1"       x="290" y="220"  w="32" h="32"/>
+        <target id="p_pi_2"       x="335" y="220"  w="32" h="32"/>
+        <target id="p_sigma"      x="315" y="170"  w="32" h="32"/>
+        <target id="p_pi_star_1"  x="290" y="40"  w="32" h="32"/>
+        <target id="p_pi_star_2"  x="340" y="40"  w="32" h="32"/>
+        <target id="p_sigma_star" x="315" y="0"  w="32" h="32"/>
+
+        <!-- positions of names of energy levels -->
+        <target id="s_sigma_name" x="400" y="425"  w="32" h="32"/>
+        <target id="s_sigma_star_name" x="400" y="290"  w="32" h="32"/>
+        <target id="p_pi_name" x="400" y="220"  w="32" h="32"/>
+        <target id="p_pi_star_name" x="400" y="40"  w="32" h="32"/>
+        <target id="p_sigma_name" x="400" y="170"  w="32" h="32"/>
+        <target id="p_sigma_star_name" x="400" y="0"  w="32" h="32"/>
+
+    </drag_and_drop_input>
+
+    <answer type="loncapa/python"><![CDATA[
+correct_answer = [{
+  'draggables': ['1', '2', '3', '4', '5', '6', 'v_fb_1', 'v_fb_2', 'v_fb_3'],
+  'targets': [
+    's_left', 's_right', 's_sigma', 's_sigma_star', 'p_pi_1', 'p_pi_2',
+    'p_sigma', 'p_left_1', 'p_right_3'
+  ],
+  'rule': 'anyof'
+}, {
+  'draggables': ['7', '8', '9', '10', 'v_ub_1', 'v_ub_2'],
+  'targets': [
+    'p_left_2', 'p_left_3', 'p_right_1', 'p_right_2', 'p_pi_star_1',
+    'p_pi_star_2'
+  ],
+  'rule': 'anyof'
+}, {
+  'draggables': ['11', '12'],
+  'targets': ['s_sigma_name', 'p_sigma_name'],
+  'rule': 'anyof'
+}, {
+  'draggables': ['13', '14'],
+  'targets': ['s_sigma_star_name', 'p_sigma_star_name'],
+  'rule': 'anyof'
+}, {
+  'draggables': ['15'],
+  'targets': ['p_pi_name'],
+  'rule': 'anyof'
+}, {
+  'draggables': ['16'],
+  'targets': ['p_pi_star_name'],
+  'rule': 'anyof'
+}]
+
+if draganddrop.grade(submission[0], correct_answer):
+    correct = ['correct']
+else:
+    correct = ['incorrect']
+
+]]></answer>
+</customresponse>
+
+<customresponse>
+    <text>
+        <h4>[Individual targets with outlines, One draggable per target]</h4><br/>
+        <h4>
+        Drag -Ant- to first position and -Star- to third position </h4><br/>
+    </text>
+
+    <drag_and_drop_input img="/static/images/cow.png" target_outline="true">
+        <draggable id="1" label="Label 1"/>
+        <draggable id="name_with_icon" label="Ant" icon="/static/images/images_list/ant.jpg"/>
+        <draggable id="with_icon" label="Cloud" icon="/static/images/images_list/cloud.jpg" />
+        <draggable id="5" label="Label2" />
+        <draggable id="2" label="Drop" icon="/static/images/images_list/drop.jpg" />
+        <draggable id="name_label_icon3" label="Grass" icon="/static/images/images_list/grass.jpg" />
+        <draggable id="name4" label="Star" icon="/static/images/images_list/star.png" />
+        <draggable id="7" label="Label3" />
+
+        <target id="t1" x="20" y="20" w="90" h="90"/>
+        <target id="t2" x="300" y="100" w="90" h="90"/>
+        <target id="t3" x="150" y="40" w="50" h="50"/>
+
+    </drag_and_drop_input>
+
+    <answer type="loncapa/python"><![CDATA[
+correct_answer = {'name_with_icon': 't1', 'name4': 't2'}
+if draganddrop.grade(submission[0], correct_answer):
+    correct = ['correct']
+else:
+    correct = ['incorrect']
+]]></answer>
+</customresponse>
+
+<customresponse>
+    <text>
+        <h4>[SMALL IMAGE,  Individual targets WITHOUT outlines, One draggable
+            per target]</h4><br/>
+        <h4>
+            Move -Star- to the volcano opening, and -Label3- on to
+            the right ear of the cow.
+        </h4><br/>
+    </text>
+
+    <drag_and_drop_input img="/static/images/cow3.png" target_outline="false">
+        <draggable id="1" label="Label 1"/>
+        <draggable id="name_with_icon" label="Ant" icon="/static/images/images_list/ant.jpg"/>
+        <draggable id="with_icon" label="Cloud" icon="/static/images/images_list/cloud.jpg" />
+        <draggable id="5" label="Label2" />
+        <draggable id="2" label="Drop" icon="/static/images/images_list/drop.jpg" />
+        <draggable id="name_label_icon3" label="Grass" icon="/static/images/images_list/grass.jpg" />
+        <draggable id="name4" label="Star" icon="/static/images/images_list/star.png" />
+        <draggable id="7" label="Label3" />
+
+        <target id="t1" x="111" y="58" w="90" h="90"/>
+        <target id="t2" x="212" y="90" w="90" h="90"/>
+
+    </drag_and_drop_input>
+
+    <answer type="loncapa/python"><![CDATA[
+correct_answer = {'name4': 't1',
+                '7': 't2'}
+if draganddrop.grade(submission[0], correct_answer):
+    correct = ['correct']
+else:
+    correct = ['incorrect']
+]]></answer>
+</customresponse>
+
+<customresponse>
+    <text>
+        <h4>[Many draggables per target]</h4><br/>
+        <h4>Move -Star- and -Ant- to most left target
+            and -Label3- and -Label2- to most right target.</h4><br/>
+    </text>
+
+    <drag_and_drop_input img="/static/images/cow.png" target_outline="true" one_per_target="false">
+        <draggable id="1" label="Label 1"/>
+        <draggable id="name_with_icon" label="Ant" icon="/static/images/images_list/ant.jpg"/>
+        <draggable id="with_icon" label="Cloud" icon="/static/images/images_list/cloud.jpg" />
+        <draggable id="5" label="Label2" />
+        <draggable id="2" label="Drop" icon="/static/images/images_list/drop.jpg" />
+        <draggable id="name_label_icon3" label="Grass" icon="/static/images/images_list/grass.jpg" />
+        <draggable id="name4" label="Star" icon="/static/images/images_list/star.png" />
+        <draggable id="7" label="Label3" />
+
+        <target id="t1" x="20" y="20" w="90" h="90"/>
+        <target id="t2" x="300" y="100" w="90" h="90"/>
+        <target id="t3" x="150" y="40" w="50" h="50"/>
+
+    </drag_and_drop_input>
+
+    <answer type="loncapa/python"><![CDATA[
+correct_answer = {'name4': 't1',
+                'name_with_icon': 't1',
+                '5': 't2',
+                '7':'t2'}
+if draganddrop.grade(submission[0], correct_answer):
+    correct = ['correct']
+else:
+    correct = ['incorrect']
+]]></answer>
+</customresponse>
+
+<customresponse>
+    <text>
+        <h4>[Draggables can be placed anywhere on base image]</h4><br/>
+        <h4>
+            Place -Grass- in the middle of the image and -Ant- in the
+            right upper corner.</h4><br/>
+    </text>
+
+    <drag_and_drop_input img="/static/images/cow.png" >
+        <draggable id="1" label="Label 1"/>
+        <draggable id="ant" label="Ant" icon="/static/images/images_list/ant.jpg"/>
+        <draggable id="with_icon" label="Cloud" icon="/static/images/images_list/cloud.jpg" />
+        <draggable id="5" label="Label2" />
+        <draggable id="2" label="Drop" icon="/static/images/images_list/drop.jpg" />
+        <draggable id="grass" label="Grass" icon="/static/images/images_list/grass.jpg" />
+        <draggable id="name4" label="Star" icon="/static/images/images_list/star.png" />
+        <draggable id="7" label="Label3" />
+
+    </drag_and_drop_input>
+
+    <answer type="loncapa/python"><![CDATA[
+correct_answer = {'grass':     [[300, 200], 200],
+                  'ant': [[500, 0], 200]}
+if draganddrop.grade(submission[0], correct_answer):
+    correct = ['correct']
+else:
+    correct = ['incorrect']
+]]></answer>
+</customresponse>
+
+<customresponse>
+    <text>
+        <h4>[Another anyof example]</h4><br/>
+        <h4>Please identify the Carbon and Oxygen atoms in the molecule.</h4><br/>
+    </text>
+
+    <drag_and_drop_input img="/static/images/images_list/ethglycol.jpg" target_outline="true" one_per_target="true">
+        <draggable id="l1_c" label="Carbon" />
+        <draggable id="l2" label="Methane"/>
+        <draggable id="l3_o" label="Oxygen" />
+        <draggable id="l4" label="Calcium" />
+        <draggable id="l5" label="Methane"/>
+        <draggable id="l6" label="Calcium" />
+        <draggable id="l7" label="Hydrogen" />
+        <draggable id="l8_c" label="Carbon" />
+        <draggable id="l9" label="Hydrogen" />
+        <draggable id="l10_o" label="Oxygen" />
+
+        <target id="t1_o" x="10" y="67" w="100" h="100"/>
+        <target id="t2" x="133" y="3" w="70" h="70"/>
+        <target id="t3" x="2" y="384" w="70" h="70"/>
+        <target id="t4" x="95" y="386" w="70" h="70"/>
+        <target id="t5_c" x="94" y="293" w="91" h="91"/>
+        <target id="t6_c" x="328" y="294" w="91" h="91"/>
+        <target id="t7" x="393" y="463" w="70" h="70"/>
+        <target id="t8" x="344" y="214" w="70" h="70"/>
+        <target id="t9_o" x="445" y="162" w="100" h="100"/>
+        <target id="t10" x="591" y="132" w="70" h="70"/>
+
+    </drag_and_drop_input>
+
+    <answer type="loncapa/python"><![CDATA[
+correct_answer = [
+{
+    'draggables':  ['l3_o', 'l10_o'],
+    'targets':  ['t1_o', 't9_o'],
+    'rule': 'anyof'
+},
+{
+    'draggables': ['l1_c','l8_c'],
+    'targets': ['t5_c','t6_c'],
+    'rule': 'anyof'
+}
+]
+if draganddrop.grade(submission[0], correct_answer):
+    correct = ['correct']
+else:
+    correct = ['incorrect']
+]]></answer>
+</customresponse>
+
+<customresponse>
+    <text>
+        <h4>[Again another anyof example]</h4><br/>
+        <h4>If the element appears in this molecule, drag the label onto it</h4>
+        <br/>
+    </text>
+
+    <drag_and_drop_input img="/static/images/images_list/ethglycol.jpg" target_outline="true"
+        one_per_target="true" no_labels="true" label_bg_color="rgb(222, 139, 238)">
+        <draggable id="1" label="Hydrogen" />
+        <draggable id="2" label="Hydrogen" />
+        <draggable id="3" label="Nytrogen" />
+        <draggable id="4" label="Nytrogen" />
+        <draggable id="5" label="Boron" />
+        <draggable id="6" label="Boron" />
+        <draggable id="7" label="Carbon" />
+        <draggable id="8" label="Carbon" />
+
+        <target id="t1_o" x="10" y="67" w="100" h="100"/>
+        <target id="t2_h" x="133" y="3" w="70" h="70"/>
+        <target id="t3_h" x="2" y="384" w="70" h="70"/>
+        <target id="t4_h" x="95" y="386" w="70" h="70"/>
+        <target id="t5_c" x="94" y="293" w="91" h="91"/>
+        <target id="t6_c" x="328" y="294" w="91" h="91"/>
+        <target id="t7_h" x="393" y="463" w="70" h="70"/>
+        <target id="t8_h" x="344" y="214" w="70" h="70"/>
+        <target id="t9_o" x="445" y="162" w="100" h="100"/>
+        <target id="t10_h" x="591" y="132" w="70" h="70"/>
+
+    </drag_and_drop_input>
+
+    <answer type="loncapa/python"><![CDATA[
+correct_answer = [
+{
+    'draggables':   ['7', '8'],
+    'targets':  ['t5_c', 't6_c'],
+    'rule': 'anyof'
+},
+{
+    'draggables': ['1', '2'],
+    'targets': ['t2_h', 't3_h', 't4_h', 't7_h', 't8_h', 't10_h'],
+    'rule': 'anyof'
+}]
+if draganddrop.grade(submission[0], correct_answer):
+    correct = ['correct']
+else:
+    correct = ['incorrect']
+]]></answer>
+</customresponse>
+
+<customresponse>
+    <text>
+        <h4>[Wrong base image url example]
+        </h4><br/>
+    </text>
+
+    <drag_and_drop_input img="/static/images/cow3_bad.png" target_outline="false">
+        <draggable id="1" label="Label 1"/>
+        <draggable id="name_with_icon" label="Ant" icon="/static/images/images_list/ant.jpg"/>
+        <draggable id="with_icon" label="Cloud" icon="/static/images/images_list/cloud.jpg" />
+        <draggable id="5" label="Label2" />
+        <draggable id="2" label="Drop" icon="/static/images/images_list/drop.jpg" />
+        <draggable id="name_label_icon3" label="Grass" icon="/static/images/images_list/grass.jpg" />
+        <draggable id="name4" label="Star" icon="/static/images/images_list/star.png" />
+        <draggable id="7" label="Label3" />
+
+        <target id="t1" x="111" y="58" w="90" h="90"/>
+        <target id="t2" x="212" y="90" w="90" h="90"/>
+
+    </drag_and_drop_input>
+
+    <answer type="loncapa/python"><![CDATA[
+correct_answer = {'name4': 't1',
+                '7': 't2'}
+if draganddrop.grade(submission[0], correct_answer):
+    correct = ['correct']
+else:
+    correct = ['incorrect']
+]]></answer>
+</customresponse>
+
+</problem>

doc/public/course_data_formats/drag_and_drop/drag-n-drop-demo2.xml

+<problem display_name="Drag and drop demos: drag and drop icons or labels
+    to proper positions." >
+
+<customresponse>
+    <text>
+        <h4>[Draggable is reusable example]</h4>
+        <br/>
+        <h4>Please label all hydrogen atoms.</h4>
+        <br/>
+    </text>
+
+    <drag_and_drop_input
+        img="/static/images/images_list/ethglycol.jpg"
+        target_outline="true"
+        one_per_target="true"
+        no_labels="true"
+        label_bg_color="rgb(222, 139, 238)"
+    >
+        <draggable id="1" label="Hydrogen" can_reuse='true' />
+
+        <target id="t1_o" x="10" y="67" w="100" h="100" />
+        <target id="t2" x="133" y="3" w="70" h="70" />
+        <target id="t3" x="2" y="384" w="70" h="70" />
+        <target id="t4" x="95" y="386" w="70" h="70" />
+        <target id="t5_c" x="94" y="293" w="91" h="91" />
+        <target id="t6_c" x="328" y="294" w="91" h="91" />
+        <target id="t7" x="393" y="463" w="70" h="70" />
+        <target id="t8" x="344" y="214" w="70" h="70" />
+        <target id="t9_o" x="445" y="162" w="100" h="100" />
+        <target id="t10" x="591" y="132" w="70" h="70" />
+    </drag_and_drop_input>
+
+    <answer type="loncapa/python">
+    <![CDATA[
+correct_answer = [{
+    'draggables': ['1'],
+    'targets': ['t2', 't3', 't4', 't7', 't8', 't10'],
+    'rule': 'exact'
+}]
+if draganddrop.grade(submission[0], correct_answer):
+    correct = ['correct']
+else:
+    correct = ['incorrect']
+    ]]>
+    </answer>
+</customresponse>
+
+<customresponse>
+    <text>
+        <h4>[Complex grading example]</h4><br/>
+        <h4>Describe carbon molecule in LCAO-MO.</h4>
+        <br/>
+    </text>
+
+    <drag_and_drop_input img="/static/images/images_list/lcao-mo/lcao-mo.jpg" target_outline="true" >
+
+        <!-- filled bond -->
+        <draggable id="1" icon="/static/images/images_list/lcao-mo/u_d.png" can_reuse="true" />
+
+        <!-- up bond -->
+        <draggable id="7"  icon="/static/images/images_list/lcao-mo/up.png" can_reuse="true" />
+
+        <!-- sigma -->
+        <draggable id="11" icon="/static/images/images_list/lcao-mo/sigma.png" can_reuse="true" />
+
+        <!-- sigma* -->
+        <draggable id="13" icon="/static/images/images_list/lcao-mo/sigma_s.png" can_reuse="true" />
+
+        <!-- pi -->
+        <draggable id="15" icon="/static/images/images_list/lcao-mo/pi.png" can_reuse="true" />
+
+        <!-- pi* -->
+        <draggable id="16" icon="/static/images/images_list/lcao-mo/pi_s.png" can_reuse="true" />
+
+        <!-- images that should not be dragged -->
+        <draggable id="17" icon="/static/images/images_list/lcao-mo/d.png" can_reuse="true" />
+
+        <!-- positions of electrons and electron pairs -->
+        <target id="s_left"       x="130" y="360"    w="32" h="32"/>
+        <target id="s_right"      x="505" y="360"    w="32" h="32"/>
+        <target id="s_sigma"      x="320" y="425"    w="32" h="32"/>
+        <target id="s_sigma_star" x="320" y="290"    w="32" h="32"/>
+        <target id="p_left_1"     x="80"  y="100"    w="32" h="32"/>
+        <target id="p_left_2"     x="125" y="100"    w="32" h="32"/>
+        <target id="p_left_3"     x="175" y="100"    w="32" h="32"/>
+        <target id="p_right_1"    x="465" y="100"    w="32" h="32"/>
+        <target id="p_right_2"    x="515" y="100"    w="32" h="32"/>
+        <target id="p_right_3"    x="560" y="100"    w="32" h="32"/>
+        <target id="p_pi_1"       x="290" y="220"    w="32" h="32"/>
+        <target id="p_pi_2"       x="335" y="220"    w="32" h="32"/>
+        <target id="p_sigma"      x="315" y="170"    w="32" h="32"/>
+        <target id="p_pi_star_1"  x="290" y="40"     w="32" h="32"/>
+        <target id="p_pi_star_2"  x="340" y="40"     w="32" h="32"/>
+        <target id="p_sigma_star" x="315" y="0"      w="32" h="32"/>
+
+        <!-- positions of names of energy levels -->
+        <target id="s_sigma_name"      x="400" y="425"  w="32" h="32"/>
+        <target id="s_sigma_star_name" x="400" y="290"  w="32" h="32"/>
+        <target id="p_pi_name"         x="400" y="220"  w="32" h="32"/>
+        <target id="p_sigma_name"      x="400" y="170"  w="32" h="32"/>
+        <target id="p_pi_star_name"    x="400" y="40"   w="32" h="32"/>
+        <target id="p_sigma_star_name" x="400" y="0"    w="32" h="32"/>
+
+  </drag_and_drop_input>
+
+    <answer type="loncapa/python"><![CDATA[
+correct_answer = [
+{
+  'draggables': ['1'],
+  'targets': [
+    's_left', 's_right', 's_sigma', 's_sigma_star', 'p_pi_1', 'p_pi_2'
+  ],
+  'rule': 'exact'
+}, {
+  'draggables': ['7'],
+  'targets': ['p_left_1', 'p_left_2', 'p_right_1','p_right_2'],
+  'rule': 'exact'
+}, {
+  'draggables': ['11'],
+  'targets': ['s_sigma_name', 'p_sigma_name'],
+  'rule': 'exact'
+}, {
+  'draggables': ['13'],
+  'targets': ['s_sigma_star_name', 'p_sigma_star_name'],
+  'rule': 'exact'
+}, {
+  'draggables': ['15'],
+  'targets': ['p_pi_name'],
+  'rule': 'exact'
+}, {
+  'draggables': ['16'],
+  'targets': ['p_pi_star_name'],
+  'rule': 'exact'
+}]
+
+if draganddrop.grade(submission[0], correct_answer):
+    correct = ['correct']
+else:
+    correct = ['incorrect']
+]]></answer>
+</customresponse>
+
+<customresponse>
+    <text>
+        <h4>[Many draggables per target]</h4><br/>
+        <h4>Move two Stars and three Ants to most left target
+            and one Label3 and four Label2 to most right target.</h4><br/>
+    </text>
+
+    <drag_and_drop_input img="/static/images/cow.png" target_outline="true" one_per_target="false">
+        <draggable id="1" label="Label 1" can_reuse="true" />
+        <draggable id="name_with_icon" label="Ant" icon="/static/images/images_list/ant.jpg" can_reuse="true" />
+        <draggable id="with_icon" label="Cloud" icon="/static/images/images_list/cloud.jpg" can_reuse="true" />
+        <draggable id="5" label="Label2" can_reuse="true" />
+        <draggable id="2" label="Drop" icon="/static/images/images_list/drop.jpg" can_reuse="true" />
+        <draggable id="name_label_icon3" label="Grass" icon="/static/images/images_list/grass.jpg" can_reuse="true" />
+        <draggable id="name4" label="Star" icon="/static/images/images_list/star.png" can_reuse="true" />
+        <draggable id="7" label="Label3" can_reuse="true" />
+
+        <target id="t1" x="20" y="20" w="90" h="90"/>
+        <target id="t2" x="300" y="100" w="90" h="90"/>
+        <target id="t3" x="150" y="40" w="50" h="50"/>
+
+    </drag_and_drop_input>
+
+    <answer type="loncapa/python"><![CDATA[
+correct_answer = [
+{
+    'draggables': ['name4'],
+    'targets': [
+        't1', 't1'
+    ],
+    'rule': 'exact'
+},
+{
+    'draggables': ['name_with_icon'],
+    'targets': [
+        't1', 't1', 't1'
+    ],
+    'rule': 'exact'
+},
+{
+    'draggables': ['5'],
+    'targets': [
+        't2', 't2', 't2', 't2'
+    ],
+    'rule': 'exact'
+},
+{
+    'draggables': ['7'],
+    'targets': [
+        't2'
+    ],
+    'rule': 'exact'
+}
+]
+if draganddrop.grade(submission[0], correct_answer):
+    correct = ['correct']
+else:
+    correct = ['incorrect']
+]]></answer>
+</customresponse>
+
+<customresponse>
+    <text>
+        <h4>[Draggables can be placed anywhere on base image]</h4><br/>
+        <h4>
+            Place -Grass- in the middle of the image and -Ant- in the
+            right upper corner.</h4><br/>
+    </text>
+
+    <drag_and_drop_input img="/static/images/cow.png" >
+        <draggable id="1" label="Label 1" can_reuse="true" />
+        <draggable id="ant" label="Ant" icon="/static/images/images_list/ant.jpg" can_reuse="true" />
+        <draggable id="with_icon" label="Cloud" icon="/static/images/images_list/cloud.jpg" can_reuse="true" />
+        <draggable id="5" label="Label2" can_reuse="true" />
+        <draggable id="2" label="Drop" icon="/static/images/images_list/drop.jpg" can_reuse="true" />
+        <draggable id="grass" label="Grass" icon="/static/images/images_list/grass.jpg" can_reuse="true" />
+        <draggable id="name4" label="Star" icon="/static/images/images_list/star.png" can_reuse="true" />
+        <draggable id="7" label="Label3" can_reuse="true" />
+
+    </drag_and_drop_input>
+
+    <answer type="loncapa/python"><![CDATA[
+correct_answer = {
+    'grass': [[300, 200], 200],
+    'ant': [[500, 0], 200]
+}
+if draganddrop.grade(submission[0], correct_answer):
+    correct = ['correct']
+else:
+    correct = ['incorrect']
+]]></answer>
+</customresponse>
+
+<customresponse>
+    <text>
+        <h4>[Another anyof example]</h4><br/>
+        <h4>Please identify the Carbon and Oxygen atoms in the molecule.</h4><br/>
+    </text>
+
+    <drag_and_drop_input img="/static/images/images_list/ethglycol.jpg" target_outline="true" one_per_target="true">
+        <draggable id="l1_c" label="Carbon" can_reuse="true" />
+        <draggable id="l2" label="Methane" can_reuse="true" />
+        <draggable id="l3_o" label="Oxygen" can_reuse="true" />
+        <draggable id="l4" label="Calcium" can_reuse="true" />
+        <draggable id="l7" label="Hydrogen" can_reuse="true" />
+
+        <target id="t1_o" x="10" y="67" w="100" h="100"/>
+        <target id="t2" x="133" y="3" w="70" h="70"/>
+        <target id="t3" x="2" y="384" w="70" h="70"/>
+        <target id="t4" x="95" y="386" w="70" h="70"/>
+        <target id="t5_c" x="94" y="293" w="91" h="91"/>
+        <target id="t6_c" x="328" y="294" w="91" h="91"/>
+        <target id="t7" x="393" y="463" w="70" h="70"/>
+        <target id="t8" x="344" y="214" w="70" h="70"/>
+        <target id="t9_o" x="445" y="162" w="100" h="100"/>
+        <target id="t10" x="591" y="132" w="70" h="70"/>
+
+    </drag_and_drop_input>
+
+    <answer type="loncapa/python"><![CDATA[
+correct_answer = [
+{
+    'draggables': ['l3_o'],
+    'targets': ['t1_o', 't9_o'],
+    'rule': 'exact'
+},
+{
+    'draggables': ['l1_c'],
+    'targets': ['t5_c', 't6_c'],
+    'rule': 'exact'
+}
+]
+if draganddrop.grade(submission[0], correct_answer):
+    correct = ['correct']
+else:
+    correct = ['incorrect']
+]]></answer>
+</customresponse>
+
+<customresponse>
+    <text>
+        <h4>[Exact number of draggables for a set of targets.]</h4><br/>
+        <h4>Drag two Grass and one Star to first or second positions, and three Cloud to any of the three positions.</h4>
+        <br/>
+    </text>
+
+    <drag_and_drop_input img="/static/images/cow.png" target_outline="true" one_per_target="false">
+        <draggable id="1" label="Label 1" can_reuse="true" />
+        <draggable id="name_with_icon" label="Ant" icon="/static/images/images_list/ant.jpg" can_reuse="true" />
+        <draggable id="with_icon" label="Cloud" icon="/static/images/images_list/cloud.jpg" can_reuse="true" />
+        <draggable id="5" label="Label2" can_reuse="true" />
+        <draggable id="2" label="Drop" icon="/static/images/images_list/drop.jpg" can_reuse="true" />
+        <draggable id="name_label_icon3" label="Grass" icon="/static/images/images_list/grass.jpg" can_reuse="true" />
+        <draggable id="name4" label="Star" icon="/static/images/images_list/star.png" can_reuse="true" />
+        <draggable id="7" label="Label3" can_reuse="true" />
+
+        <target id="t1" x="20" y="20" w="90" h="90"/>
+        <target id="t2" x="300" y="100" w="90" h="90"/>
+        <target id="t3" x="150" y="40" w="50" h="50"/>
+
+    </drag_and_drop_input>
+
+    <answer type="loncapa/python"><![CDATA[
+correct_answer = [
+{
+    'draggables': ['name_label_icon3', 'name_label_icon3'],
+    'targets': ['t1', 't3'],
+    'rule': 'unordered_equal+number'
+},
+{
+    'draggables': ['name4'],
+    'targets': ['t1', 't3'],
+    'rule': 'anyof+number'
+},
+{
+    'draggables': ['with_icon', 'with_icon', 'with_icon'],
+    'targets': ['t1', 't2', 't3'],
+    'rule': 'anyof+number'
+}
+]
+if draganddrop.grade(submission[0], correct_answer):
+    correct = ['correct']
+else:
+    correct = ['incorrect']
+]]></answer>
+</customresponse>
+
+<customresponse>
+    <text>
+        <h4>[As many as you like draggables for a set of targets.]</h4><br/>
+        <h4>Drag some Grass to any of the targets, and some Stars to either first or last target.</h4>
+        <br/>
+    </text>
+
+    <drag_and_drop_input img="/static/images/cow.png" target_outline="true" one_per_target="false">
+        <draggable id="1" label="Label 1" can_reuse="true" />
+        <draggable id="name_with_icon" label="Ant" icon="/static/images/images_list/ant.jpg" can_reuse="true" />
+        <draggable id="with_icon" label="Cloud" icon="/static/images/images_list/cloud.jpg" can_reuse="true" />
+        <draggable id="5" label="Label2" can_reuse="true" />
+        <draggable id="2" label="Drop" icon="/static/images/images_list/drop.jpg" can_reuse="true" />
+        <draggable id="name_label_icon3" label="Grass" icon="/static/images/images_list/grass.jpg" can_reuse="true" />
+        <draggable id="name4" label="Star" icon="/static/images/images_list/star.png" can_reuse="true" />
+        <draggable id="7" label="Label3" can_reuse="true" />
+
+        <target id="t1" x="20" y="20" w="90" h="90"/>
+        <target id="t2" x="300" y="100" w="90" h="90"/>
+        <target id="t3" x="150" y="40" w="50" h="50"/>
+
+    </drag_and_drop_input>
+
+    <answer type="loncapa/python"><![CDATA[
+correct_answer = [
+{
+    'draggables': ['name_label_icon3'],
+    'targets': ['t1', 't2', 't3'],
+    'rule': 'anyof'
+},
+{
+    'draggables': ['name4'],
+    'targets': ['t1', 't2'],
+    'rule': 'anyof'
+}
+]
+if draganddrop.grade(submission[0], correct_answer):
+    correct = ['correct']
+else:
+    correct = ['incorrect']
+]]></answer>
+</customresponse>
+
+</problem>

doc/public/course_data_formats/drag_and_drop/drag_and_drop_input.rst

+**********************************************
+XML format of drag and drop input [inputtypes]
+**********************************************
+
+.. module:: drag_and_drop_input
+
+Format description
+==================
+
+The main tag of Drag and Drop (DnD) input is::
+
+    <drag_and_drop_input> ... </drag_and_drop_input>
+
+``drag_and_drop_input`` can include any number of the following 2 tags:
+``draggable`` and ``target``.
+
+drag_and_drop_input tag
+-----------------------
+
+The main container for a single instance of DnD. The following attributes can
+be specified for this tag::
+
+    img - Relative path to an image that will be the base image. All draggables
+          can be dragged onto it.
+    target_outline - Specify whether an outline (gray dashed line) should be
+          drawn around targets (if they are specified). It can be either
+          'true' or 'false'. If not specified, the default value is
+          'false'.
+    one_per_target - Specify whether to allow more than one draggable to be
+          placed onto a single target. It can be either 'true' or 'false'. If
+          not specified, the default value is 'true'.
+    no_labels - default is false, in default behaviour if label is not set, label
+          is obtained from id. If no_labels is true, labels are not automatically
+          populated from id, and one can not set labels and obtain only icons.
+
+draggable tag
+-------------
+
+Draggable tag specifies a single draggable object which has the following
+attributes::
+
+    id - Unique identifier of the draggable object.
+    label - Human readable label that will be shown to the user.
+    icon - Relative path to an image that will be shown to the user.
+    can_reuse - true or false, default is false. If true, same draggable can be
+    used multiple times.
+
+A draggable is what the user must drag out of the slider and place onto the
+base image. After a drag operation, if the center of the draggable ends up
+outside the rectangular dimensions of the image, it will be returned back
+to the slider.
+
+In order for the grader to work, it is essential that a unique ID
+is provided. Otherwise, there will be no way to tell which draggable is at what
+coordinate, or over what target. Label and icon attributes are optional. If
+they are provided they will be used, otherwise, you can have an empty
+draggable. The path is relative to 'course_folder' folder, for example,
+/static/images/img1.png.
+
+target tag
+----------
+
+Target tag specifies a single target object which has the following required
+attributes::
+
+    id - Unique identifier of the target object.
+    x - X-coordinate on the base image where the top left corner of the target
+        will be positioned.
+    y - Y-coordinate on the base image where the top left corner of the target
+        will be positioned.
+    w - Width of the target.
+    h - Height of the target.
+
+A target specifies a place on the base image where a draggable can be
+positioned. By design, if the center of a draggable lies within the target
+(i.e. in the rectangle defined by [[x, y], [x + w, y + h]], then it is within
+the target. Otherwise, it is outside.
+
+If at lest one target is provided, the behavior of the client side logic
+changes. If a draggable is not dragged on to a target, it is returned back to
+the slider.
+
+If no targets are provided, then a draggable can be dragged and placed anywhere
+on the base image.
+
+correct answer format
+---------------------
+
+There are two correct answer formats: short and long
+If short from correct answer is mapping of 'draggable_id' to 'target_id'::
+
+    correct_answer = {'grass':     [[300, 200], 200], 'ant': [[500, 0], 200]}
+    correct_answer = {'name4': 't1', '7': 't2'}
+
+In long form correct answer is list of dicts. Every dict has 3 keys:
+draggables, targets and rule. For example::
+
+    correct_answer = [
+    {
+    'draggables':   ['7', '8'],
+    'targets':  ['t5_c', 't6_c'],
+    'rule': 'anyof'
+    },
+    {
+    'draggables': ['1', '2'],
+    'targets': ['t2_h', 't3_h', 't4_h', 't7_h', 't8_h', 't10_h'],
+    'rule': 'anyof'
+    }]
+
+Draggables is list of draggables id. Target is list of targets id, draggables
+must be dragged to with considering rule. Rule is string.
+
+Draggables in dicts inside correct_answer list must not intersect!!!
+
+Wrong (for draggable id 7)::
+
+    correct_answer = [
+    {
+    'draggables':   ['7', '8'],
+    'targets':  ['t5_c', 't6_c'],
+    'rule': 'anyof'
+    },
+    {
+    'draggables': ['7', '2'],
+    'targets': ['t2_h', 't3_h', 't4_h', 't7_h', 't8_h', 't10_h'],
+    'rule': 'anyof'
+    }]
+
+Rules are: exact, anyof, unordered_equal, anyof+number, unordered_equal+number
+
+
+.. such long lines are needed for sphinx to display lists correctly
+
+- Exact rule means that targets for draggable id's in user_answer are the same that targets from correct answer. For example, for draggables 7 and 8 user must drag 7 to target1 and 8 to target2 if correct_answer is::
+
+    correct_answer = [
+    {
+    'draggables':   ['7', '8'],
+    'targets':  ['tartget1', 'target2'],
+    'rule': 'exact'
+    }]
+
+
+- unordered_equal rule allows draggables be dragged to targets unordered. If one want to allow for student to drag 7 to target1 or target2 and 8 to target2 or target 1 and 7 and 8 must be in different targets, then correct answer must be::
+
+    correct_answer = [
+    {
+    'draggables':   ['7', '8'],
+    'targets':  ['tartget1', 'target2'],
+    'rule': 'unordered_equal'
+    }]
+
+
+- Anyof rule allows draggables to be dragged to any of targets. If one want to allow for student to drag 7 and 8 to target1 or target2, which means that if 7 is on target1 and 8 is on target1 or 7 on target2 and 8 on target2 or 7 on target1 and 8 on target2. Any of theese are correct which anyof rule::
+
+    correct_answer = [
+    {
+    'draggables':   ['7', '8'],
+    'targets':  ['tartget1', 'target2'],
+    'rule': 'anyof'
+    }]
+
+
+- If you have can_reuse true, then you, for example, have draggables a,b,c and 10 targets. These will allow you to drag 4 'a' draggables to ['target1',  'target4', 'target7', 'target10'] , you do not need to write 'a' four times. Also this will allow you to drag 'b' draggable to target2 or target5 for target5 and target2 etc..::
+
+    correct_answer = [
+        {
+            'draggables': ['a'],
+            'targets': ['target1',  'target4', 'target7', 'target10'],
+            'rule': 'unordered_equal'
+        },
+        {
+            'draggables': ['b'],
+            'targets': ['target2', 'target5', 'target8'],
+            'rule': 'anyof'
+        },
+        {
+            'draggables': ['c'],
+            'targets': ['target3', 'target6', 'target9'],
+            'rule': 'unordered_equal'
+        }]
+
+- And sometimes you want to allow drag only two 'b' draggables, in these case you sould use 'anyof+number' of 'unordered_equal+number' rule::
+
+    correct_answer = [
+        {
+            'draggables': ['a', 'a', 'a'],
+            'targets': ['target1',  'target4', 'target7'],
+            'rule': 'unordered_equal+numbers'
+        },
+        {
+            'draggables': ['b', 'b'],
+            'targets': ['target2', 'target5', 'target8'],
+            'rule': 'anyof+numbers'
+        },
+        {
+            'draggables': ['c'],
+            'targets': ['target3', 'target6', 'target9'],
+            'rule': 'unordered_equal'
+        }]
+
+In case if we have no multiple draggables per targets (one_per_target="true"),
+for same number of draggables, anyof is equal to unordered_equal
+
+If we have can_reuse=true, than one must use only long form of correct answer.
+
+
+Grading logic
+-------------
+
+1. User answer (that comes from browser) and correct answer (from xml) are parsed to the same format::
+
+    group_id: group_draggables, group_targets, group_rule
+
+
+Group_id is ordinal number, for every dict in correct answer incremental
+group_id is assigned: 0, 1, 2, ...
+
+Draggables from user answer are added to same group_id where identical draggables
+from correct answer are, for example::
+
+    If correct_draggables[group_0] = [t1, t2] then
+    user_draggables[group_0] are all draggables t1 and t2 from user answer:
+    [t1] or [t1, t2] or [t1, t2, t2] etc..
+
+2. For every group from user answer, for that group draggables, if 'number' is in  group rule, set() is applied,
+if 'number' is not in rule, set is not applied::
+
+    set() : [t1, t2, t3, t3] -> [t1, t2, ,t3]
+
+For every group, at this step, draggables lists are equal.
+
+
+3. For every group, lists of targets are compared using rule for that group.
+
+
+Set and '+number' cases
+.......................
+
+Set() and '+number' are needed only for case of reusable draggables,
+for other cases there are no equal draggables in list, so set() does nothing.
+
+.. such long lines needed for sphinx to display nicely
+
+* Usage of set() operation allows easily create rule for case of "any number of same draggable can be dragged to some targets"::
+
+        {
+                'draggables': ['draggable_1'],
+                'targets': ['target3', 'target6', 'target9'],
+                'rule': 'anyof'
+        }
+
+
+
+
+* 'number' rule is used for the case of reusable draggables, when one want to fix number of draggable to drag. In this example only two instances of draggables_1 are allowed to be dragged::
+
+    {
+            'draggables': ['draggable_1', 'draggable_1'],
+            'targets': ['target3', 'target6', 'target9'],
+            'rule': 'anyof+number'
+    }
+
+
+* Note, that in using rule 'exact', one does not need 'number', because you can't recognize from user interface which reusable draggable is on which target. Absurd example::
+
+    {
+            'draggables': ['draggable_1', 'draggable_1', 'draggable_2'],
+            'targets': ['target3', 'target6', 'target9'],
+            'rule': 'exact'
+    }
+
+
+    Correct handling of this example is to create different rules for draggable_1 and
+    draggable_2
+
+* For 'unordered_equal' (or 'exact' too) we don't need 'number' if you have only same draggable in group, as targets length will provide constraint for the number of draggables::
+
+    {
+            'draggables': ['draggable_1'],
+            'targets': ['target3', 'target6', 'target9'],
+            'rule': 'unordered_equal'
+    }
+
+
+    This means that only three draggaggables 'draggable_1' can be dragged.
+
+* But if you have more that one different reusable draggable in list, you may use 'number' rule::
+
+    {
+            'draggables': ['draggable_1', 'draggable_1', 'draggable_2'],
+            'targets': ['target3', 'target6', 'target9'],
+            'rule': 'unordered_equal+number'
+    }
+
+
+    If not use number, draggables list will be setted to  ['draggable_1', 'draggable_2']
+
+
+
+
+Logic flow
+----------
+
+(Click on image to see full size version.)
+
+.. image:: draganddrop_logic_flow.png
+    :width: 100%
+    :target: _images/draganddrop_logic_flow.png
+
+
+Example
+=======
+
+Examples of draggables that can't be reused
+-------------------------------------------
+
+.. literalinclude:: drag-n-drop-demo.xml
+
+Draggables can be reused
+------------------------
+
+.. literalinclude:: drag-n-drop-demo2.xml

doc/course_grading.md → doc/public/course_data_formats/grading.rst

-# Course Grading
-
+##############
+Course Grading
+##############
 This document is written to help professors understand how a final grade for a
 course is computed.
 
@@ -8,42 +9,46 @@ in a course and generating a final score (and corresponding letter grade). This
 grading process can be split into two phases - totaling sections and section 
 weighting.
 
-## Totaling sections
-
+*****************
+Totaling sections
+*****************
 The process of totaling sections is to get a percentage score (between 0.0 and
 1.0) for every section in the course. A section is any module that is a direct
 child of a chapter. For example, psets, labs, and sequences are all common
 sections. Only the *percentage* on the section will be available to compute the
 final grade, *not* the final number of points earned / possible.
 
-
-**For a section to be included in the final grade, the policies file must set
-graded = True for the section.**
+.. important::
+  For a section to be included in the final grade, the policies file must set
+  `graded = True` for the section.
 
 For each section, the grading function retrieves all problems within the
 section. The section percentage is computed as (total points earned) / (total
 points possible).
 
-
-### Weighting Problems
+******************
+Weighting Problems
+******************
 In some cases, one might want to give weights to problems within a section. For
-example, a final exam might contain 4 questions each worth 1 point by default.
+example, a final exam might contain four questions each worth 1 point by default.
 This means each question would by default have the same weight. If one wanted
 the first problem to be worth 50% of the final exam, the policy file could specify
-weights of 30, 10, 10, and 10 to the 4 problems, respectively.
+weights of 30, 10, 10, and 10 to the four problems, respectively.
 
-Note that the default weight of a problem **is not 1.** The default weight of a
-problem is the module's max_grade.
+Note that the default weight of a problem **is not 1**. The default weight of a
+problem is the module's `max_grade`.
 
 If weighting is set, each problem is worth the number of points assigned, regardless of the number of responses it contains.
 
 Consider a Homework section that contains two problems.
 
+.. code-block:: xml
+
     <problem display_name=”Problem 1”>
       <numericalresponse> ... </numericalreponse>
     </problem>
 
-and
+.. code-block:: xml
 
     <problem display_name=”Problem 2”>
       <numericalresponse> ... </numericalreponse>
@@ -51,41 +56,40 @@ and
       <numericalresponse> ... </numericalreponse>
     </problem>
 
-
-
-
-
 Without weighting, Problem 1 is worth 25% of the assignment, and Problem 2 is worth 75% of the assignment.
 
 Weighting for the problems can be set in the policy.json file.
 
+.. code-block:: json
+
     "problem/problem1": {
-       "weight": 2
-       },
+      "weight": 2
+    },
     "problem/problem2": {
-       "weight": 2
-        },
+      "weight": 2
+    },
 
 With the above weighting, Problems 1 and 2 are each worth 50% of the assignment.
 
-Please note: When problems have weight, the point value is automatically included in the display name *except* when “weight”: 1.When “weight”: 1, no visual change occurs in the display name, leaving the point value open to interpretation to the student.
-
-
+Please note: When problems have weight, the point value is automatically included in the display name *except* when `"weight": 1`. When the weight is 1, no visual change occurs in the display name, leaving the point value open to interpretation to the student.
 
-## Section Weighting
 
+******************
+Weighting Sections
+******************
 Once each section has a percentage score, we must total those sections into a
 final grade. Of course, not every section has equal weight in the final grade.
 The policies for weighting sections into a final grade are specified in the
 grading_policy.json file.
 
-The grading_policy.json file specifies several sub-graders that are each given
+The `grading_policy.json` file specifies several sub-graders that are each given
 a weight and factored into the final grade. There are currently two types of
 sub-graders, section format graders and single section graders.
 
 We will use this simple example of a grader with one section format grader and
 one single section grader.
 
+.. code-block:: json
 
     "GRADER" : [
         {
@@ -103,13 +107,14 @@ one single section grader.
         }
     ]
 
-### Section Format Graders
-
+Section Format Graders
+======================
 A section format grader grades a set of sections with the same format, as
 defined in the course policy file. To make a vertical named Homework1 be graded
 by the Homework section format grader, the following definition would be in the
 course policy file.
 
+.. code-block:: json
 
     "vertical/Homework1": {
         "display_name": "Homework 1", 
@@ -132,25 +137,26 @@ A section format grader will also show the average of that section in the grade
 breakdown (shown on the Progress page, gradebook, etc.).
 
 
-### Single Section Graders
-
+Single Section Graders
+======================
 A single section grader grades exactly that - a single section. If a section
 is found with a matching format and display name then the score of that section
 is used. If not, a score of 0% is assumed.
 
 
-### Combining sub-graders
-
+Combining sub-graders
+=====================
 The final grade is computed by taking the score and weight of each sub grader.
 In the above example, homework will be 40% of the final grade. The final exam
 will be 60% of the final grade.
 
-## Displaying the final grade
-
+**************************
+Displaying the final grade
+**************************
 The final grade is then rounded up to the nearest percentage point. This is so
 the system can consistently display a percentage without worrying whether the
 displayed percentage has been rounded up or down (potentially misleading the
-student). The formula for the rounding is
+student). The formula for the rounding is::
 
     rounded_percent = round(computed_percent * 100 + 0.05) / 100
 

doc/public/course_data_formats/graphical_slider_tool/graphical_slider_tool.rst

+*********************************************
+XML format of graphical slider tool [xmodule]
+*********************************************
+
+.. module:: xml_format_gst
+
+
+Format description
+==================
+
+Graphical slider tool (GST) main tag is::
+
+    <graphical_slider_tool> BODY </graphical_slider_tool>
+
+``graphical_slider_tool`` tag must have two children tags: ``render``
+and ``configuration``.
+
+
+Render tag
+----------
+
+Render tag can contain usual html tags mixed with some GST specific tags::
+
+    <slider/> - represents jQuery slider for changing a parameter's value
+    <textbox/> - represents a text input field for changing a parameter's value
+    <plot/> - represents Flot JS plot element
+
+Also GST will track all elements inside ``<render></render>`` where ``id``
+attribute is set, and a corresponding parameter referencing that ``id`` is present
+in the configuration section below. These will be referred to as dynamic elements.
+
+The contents of the <render> section will be shown to the user after
+all occurrences of::
+
+    <slider var="{parameter name}" [style="{CSS statements}"] />
+    <textbox var="{parameter name}" [style="{CSS statements}"] />
+    <plot [style="{CSS statements}"] />
+
+have been converted to actual sliders, text inputs, and a plot graph.
+Everything in square brackets is optional. After initialization, all
+text input fields, sliders, and dynamic elements will be set to the initial
+values of the parameters that they are assigned to.
+
+``{parameter name}`` specifies the parameter to which the slider or text
+input will be attached to.
+
+[style="{CSS statements}"] specifies valid CSS styling. It will be passed
+directly to the browser without any parsing.
+
+There is a one-to-one relationship between a slider and a parameter.
+I.e. for one parameter you can put only one ``<slider>`` in the
+``<render>`` section. However, you don't have to specify a slider - they
+are optional.
+
+There is a many-to-one relationship between text inputs and a
+parameter. I.e. for one parameter you can put many '<textbox>' elements in
+the ``<render>`` section. However, you don't have to specify a text
+input - they are optional.
+
+You can put only one ``<plot>`` in the ``<render>`` section. It is not
+required.
+
+
+Slider tag
+..........
+
+Slider tag must have ``var`` attribute and optional ``style`` attribute::
+
+    <slider var='a' style="width:400px;float:left;" />
+
+After processing, slider tags will be replaced by jQuery UI sliders with applied
+``style`` attribute.
+
+``var`` attribute must correspond to a parameter. Parameters can be used in any
+of the ``function`` tags in ``functions`` tag. By moving slider, value of
+parameter ``a`` will change, and so result of function, that depends on parameter
+``a``, will also change.
+
+
+Textbox tag
+...........
+
+Texbox tag must have ``var`` attribute and optional ``style`` attribute::
+
+    <textbox var="b" style="width:50px; float:left; margin-left:10px;" />
+
+After processing, textbox tags will be replaced by html text inputs with applied
+``style`` attribute. If you want a readonly text input, then you should use a
+dynamic element instead (see section below "HTML tagsd with ID").
+
+``var`` attribute must correspond to a parameter. Parameters can be used in any
+of the ``function`` tags in ``functions`` tag. By changing the value on the text input,
+value of parameter ``a`` will change, and so result of function, that depends on
+parameter ``a``, will also change.
+
+
+Plot tag
+........
+
+Plot tag may have optional ``style`` attribute::
+
+    <plot style="width:50px; float:left; margin-left:10px;" />
+
+After processing plot tags will be replaced by Flot JS plot with applied
+``style`` attribute.
+
+
+HTML tags with ID (dynamic elements)
+....................................
+
+Any HTML tag with ID, e.g. ``<span id="answer_span_1">`` can be used as a
+place where result of function can be inserted. To insert function result to
+an element, element ID must be included in ``function`` tag as ``el_id`` attribute
+and ``output`` value must be ``"element"``::
+
+    <function output="element" el_id="answer_span_1">
+                    function add(a, b, precision) {
+                        var x = Math.pow(10, precision || 2);
+                        return (Math.round(a * x) + Math.round(b * x)) / x;
+                    }
+
+                    return add(a, b, 5);
+    </function>
+
+
+Configuration tag
+-----------------
+
+The configuration tag contains parameter settings, graph
+settings, and function definitions which are to be plotted on the
+graph and that use specified parameters.
+
+Configuration tag contains two mandatory tag ``functions`` and ``parameters`` and
+may contain another ``plot`` tag.
+
+
+Parameters tag
+..............
+
+``Parameters`` tag contains ``parameter`` tags. Each ``parameter`` tag must have
+``var``, ``max``, ``min``, ``step`` and ``initial`` attributes::
+
+        <parameters>
+                <param var="a" min="-10.0" max="10.0" step="0.1" initial="0" />
+                <param var="b" min="-10.0" max="10.0" step="0.1" initial="0" />
+        </parameters>
+
+``var`` attribute links min, max, step and initial values to parameter name.
+
+``min`` attribute is the minimal value that a parameter can take. Slider and input
+values can not go below it.
+
+``max`` attribute is the maximal value that a parameter can take. Slider and input
+values can not go over it.
+
+``step`` attribute is value of slider step. When a slider increase or decreases
+the specified parameter, it will do so by the amount specified with 'step'
+
+``initial`` attribute is the initial value that the specified parameter should be
+set to. Sliders and inputs will initially show this value.
+
+The parameter's name is specified by the ``var`` property. All occurrences
+of sliders and/or text inputs that specify a ``var`` property, will be
+connected to this parameter - i.e. they will reflect the current
+value of the parameter, and will be updated when the parameter
+changes.
+
+If at lest one of these attributes is not set, then the parameter
+will not be used, slider's and/or text input elements that specify
+this parameter will not be activated, and the specified functions
+which use this parameter will not return a numeric value. This means
+that neglecting to specify at least one of the attributes for some
+parameter will have the result of the whole GST instance not working
+properly.
+
+
+Functions tag
+.............
+
+For the GST to do something, you must defined at least one
+function, which can use any of the specified parameter values. The
+function expects to take the ``x`` value, do some calculations, and
+return the ``y`` value. I.e. this is a 2D plot in Cartesian
+coordinates. This is how the default function is meant to be used for
+the graph.
+
+There are other special cases of functions. They are used mainly for
+outputting to elements, plot labels, or for custom output. Because
+the return a single value, and that value is meant for a single element,
+these function are invoked only with the set of all of the parameters.
+I.e. no ``x`` value is available inside them. They are useful for
+showing the current value of a parameter, showing complex static
+formulas where some parameter's value must change, and other useful
+things.
+
+The different style of function is specified by the ``output`` attribute.
+
+Each function must be defined inside ``function`` tag in  ``functions`` tag::
+
+    <functions>
+        <function output="element" el_id="answer_span_1">
+            function add(a, b, precision) {
+                var x = Math.pow(10, precision || 2);
+                return (Math.round(a * x) + Math.round(b * x)) / x;
+            }
+
+            return add(a, b, 5);
+        </function>
+    </functions>
+
+The parameter names (along with their values, as provided from text
+inputs and/or sliders), will be available inside all defined
+functions. A defined function body string will be parsed internally
+by the browser's JavaScript engine and converted to a true JS
+function.
+
+The function's parameter list will automatically be created and
+populated, and will include the ``x`` (when ``output`` is not specified or
+is set to ``"graph"``), and all of the specified parameter values (from sliders
+and text inputs). This means that each of the defined functions will have
+access to all of the parameter values. You don't have to use them, but
+they will be there.
+
+Examples::
+
+    <function>
+        return x;
+    </function>
+
+    <function dot="true" label="\(y_2\)">
+        return (x + a) * Math.sin(x * b);
+    </function>
+
+    <function color="green">
+        function helperFunc(c1) {
+            return c1 * c1 - a;
+        }
+        return helperFunc(x + 10 * a * b) + Math.sin(a - x);
+    </function>
+
+Required parameters::
+
+    function body:
+
+    A string composing a normal JavaScript function
+    except that there is no function declaration
+    (along with parameters), and no closing bracket.
+
+    So if you normally would have written your
+    JavaScript function like this:
+
+        function myFunc(x, a, b) {
+            return x * a + b;
+        }
+
+    here you must specify just the function body
+    (everything that goes between '{' and '}'). So,
+    you would specify the above function like so (the
+    bare-bone minimum):
+
+        <function>return x * a + b;</function>
+
+    VERY IMPORTANT: Because the function will be passed
+    to the browser as a single string, depending on implementation
+    specifics, the end-of-line characters can be stripped. This
+    means that single line JavaScript comments (starting with "//")
+    can lead to the effect that everything after the first such comment
+    will be treated as a comment. Therefore, it is absolutely
+    necessary that such single line comments are not used when
+    defining functions for GST. You can safely use the alternative
+    multiple line JavaScript comments (such comments start with "/*"
+    and end with "*/).
+
+    VERY IMPORTANT: If you have a large function body, and decide to
+    split it into several lines, than you must wrap it in "CDATA" like
+    so:
+
+        <function>
+        <![CDATA[
+            var dNew;
+
+            dNew = 0.3;
+
+            return x * a + b - dNew;
+        ]]>
+        </function>
+
+Optional parameters::
+
+
+    color:  Color name ('red', 'green', etc.) or in the form of
+            '#FFFF00'. If not specified, a default color (different
+            one for each graphed function) will be given by Flot JS.
+    line:   A string - 'true' or 'false'. Should the data points be
+            connected by a line on the graph? Default is 'true'.
+    dot:    A string - 'true' or 'false'. Should points be shown for
+            each data point on the graph? Default is 'false'.
+    bar:    A string - 'true' or 'false'. When set to 'true', points
+            will be plotted as bars.
+    label:  A string. If provided, will be shown in the legend, along
+            with the color that was used to plot the function.
+    output: 'element', 'none', 'plot_label', or 'graph'. If not defined,
+            function will be plotted (same as setting 'output' to 'graph').
+            If defined, and other than 'graph', function will not be
+            plotted, but it's output will be inserted into the element
+            with ID specified by 'el_id' attribute.
+    el_id:  Id of HTML element, defined in '<render>' section. Value of
+            function will be inserted as content of this element.
+    disable_auto_return: By default, if JavaScript function string is written
+                         without a "return" statement, the "return" will be
+                         prepended to it. Set to "true" to disable this
+                         functionality. This is done so that simple functions
+                         can be defined in an easy fashion (for example, "a",
+                         which will be translated into "return a").
+    update_on: A string - 'change', or 'slide'. Default (if not set) is
+               'slide'. This defines the event on which a given function is
+               called, and its result is inserted into an element. This
+               setting is relevant only when "output" is other than "graph".
+
+When specifying ``el_id``, it is essential to set "output" to one of
+    element - GST will invoke the function, and the return of it will be
+              inserted into a HTML element with id specified by ``el_id``.
+    none    - GST will simply inoke the function. It is left to the instructor
+              who writes the JavaScript function body to update all necesary
+              HTML elements inside the function, before it exits. This is done
+              so that extra steps can be preformed after an HTML element has
+              been updated with a value. Note, that because the return value
+              from this function is not actually used, it will be tempting to
+              omit the "return" statement. However, in this case, the attribute
+              "disable_auto_return" must be set to "true" in order to prevent
+              GST from inserting a "return" statement automatically.
+    plot_label - GST will process all plot labels (which are strings), and
+                 will replace the all instances of substrings specified by
+                 ``el_id`` with the returned value of the function. This is
+                 necessary if you want a label in the graph to have some changing
+                 number. Because of the nature of Flot JS, it is impossible to
+                 achieve the same effect by setting the "output" attribute
+                 to "element", and including a HTML element in the label.
+
+The above values for "output" will tell GST that the function is meant for an
+HTML element (not for graph), and that it should not get an 'x' parameter (along
+with some value).
+
+
+[Note on MathJax and labels]
+............................
+
+Independently of this module, will render all TeX code
+within the ``<render>`` section into nice mathematical formulas. Just
+remember to wrap it in one of::
+
+    \(  and  \)  -  for inline formulas (formulas surrounded by
+                  standard text)
+    \[  and  \]  -  if you want the formula to be a separate line
+
+It is possible to define a label in standard TeX notation. The JS
+library MathJax will work on these labels also because they are
+inserted on top of the plot as standard HTML (text within a DIV).
+
+If the label is dynamic, i.e. it will contain some text (numeric, or other)
+that has to be updated on a parameter's change, then one can define
+a special function to handle this. The "output" of such a function must be
+set to "none", and the JavaScript code inside this function must update the
+MathJax element by itself. Before exiting, MathJax typeset function should
+be called so that the new text will be re-rendered by MathJax. For example,
+
+    <render>
+        ...
+        <span id="dynamic_mathjax"></span>
+    </render>
+    ...
+    <function output="none" el_id="dynamic_mathjax">
+    <![CDATA[
+        var out_text;
+
+        out_text = "\\[\\mathrm{Percent \\space of \\space treated \\space with \\space YSS=\\frac{"
+          +(treated_men*10)+"\\space men *"
+          +(your_m_tx_yss/100)+"\\space prev. +\\space "
+          +((100-treated_men)*10)+"\\space women *"
+          +(your_f_tx_yss/100)+"\\space prev.}"
+          +"{1000\\space total\\space treated\\space patients}"
+          +"="+drummond_combined[0][1]+"\\%}\\]";
+          mathjax_for_prevalence_calcs+="\\[\\mathrm{Percent \\space of \\space untreated \\space with \\space YSS=\\frac{"
+          +(untreated_men*10)+"\\space men *"
+          +(your_m_utx_yss/100)+"\\space prev. +\\space "
+          +((100-untreated_men)*10)+"\\space women *"
+          +(your_f_utx_yss/100)+"\\space prev.}"
+          +"{1000\\space total\\space untreated\\space patients}"
+          +"="+drummond_combined[1][1]+"\\%}\\]";
+
+        $("#dynamic_mathjax").html(out_text);
+
+        MathJax.Hub.Queue(["Typeset",MathJax.Hub,"dynamic_mathjax"]);
+    ]]>
+    </function>
+    ...
+
+
+Plot tag
+........
+
+``Plot`` tag inside ``configuration`` tag defines settings for plot output.
+
+Required parameters::
+
+    xrange: 2 functions that must return value. Value is constant (3.1415)
+            or depend on parameter from parameters section:
+                <xrange>
+                    <min>return 0;</min>
+                    <max>return 30;</max>
+                </xrange>
+                                        or
+                <xrange>
+                    <min>return -a;</min>
+                    <max>return a;</max>
+                </xrange>
+
+            All functions will be calculated over domain between xrange:min
+            and xrange:max. Xrange depending on parameter is extremely
+            useful when domain(s) of your function(s) depends on parameter
+            (like circle, when parameter is radius and you want to allow
+            to change it).
+
+Optional parameters::
+
+    num_points: Number of data points to generated for the plot. If
+                this is not set, the number of points will be
+                calculated as width / 5.
+
+    bar_width: If functions are present which are to be plotted as bars,
+               then this parameter specifies the width of the bars. A
+               numeric value for this parameter is expected.
+
+    bar_align: If functions are present which are to be plotted as bars,
+               then this parameter specifies how to align the bars relative
+               to the tick. Available values are "left" and "center".
+
+    xticks,
+    yticks:    3 floating point numbers separated by commas. This
+               specifies how many ticks are created, what number they
+               start at, and what number they end at. This is different
+               from the 'xrange' setting in that it has nothing to do
+               with the data points - it control what area of the
+               Cartesian space you will see. The first number is the
+               first tick's value, the second number is the step
+               between each tick, the third number is the value of the
+               last tick. If these configurations are not specified,
+               Flot will chose them for you based on the data points
+               set that he is currently plotting. Usually, this results
+               in a nice graph, however, sometimes you need to fine
+               grain the controls. For example, when you want to show
+               a fixed area of the Cartesian space, even when the data
+               set changes. On it's own, Flot will recalculate the
+               ticks, which will result in a different graph each time.
+               By specifying the xticks, yticks configurations, only
+               the plotted data will change - the axes (ticks) will
+               remain as you have defined them.
+
+    xticks_names, yticks_names:
+              A JSON string which represents a mapping of xticks, yticks
+              values to some defined strings. If specified, the graph will
+              not have any xticks, yticks except those for which a string
+              value has been defined in the JSON string. Note that the
+              matching will be string-based and not numeric. I.e. if a tick
+              value was "3.70" before, then inside the JSON there should be
+              a mapping like {..., "3.70": "Some string", ...}. Example:
+
+                  <xticks_names>
+                  <![CDATA[
+                  {
+                      "1": "Treated", "2": "Not Treated",
+                      "4": "Treated", "5": "Not Treated",
+                      "7": "Treated", "8": "Not Treated"
+                  }
+                  ]]>
+                  </xticks_names>
+
+                  <yticks_names>
+                  <![CDATA[
+                      {"0": "0%", "10": "10%", "20": "20%", "30": "30%", "40": "40%", "50": "50%"}
+                  ]]>
+                  </yticks_names>
+
+    xunits,
+    yunits:   Units values to be set on axes. Use MathJax. Example:
+                <xunits>\(cm\)</xunits>
+                <yunits>\(m\)</yunits>
+
+    moving_label:
+              A way to specify a label that should be positioned dynamically,
+              based on the values of some parameters, or some other factors.
+              It is similar to a <function>, but it is only valid for a plot
+              because it is drawn relative to the plot coordinate system.
+
+              Multiple "moving_label" configurations can be provided, each one
+              with a unique text and a unique set of functions that determine
+              it's dynamic positioning.
+
+              Each "moving_label" can have a "color" attribute (CSS color notation),
+              and a "weight" attribute. "weight" can be one of "normal" or "bold",
+              and determines the styling of moving label's text.
+
+              Each "moving_label" function should return an object with a 'x'
+              and 'y properties. Within those functions, all of the parameter
+              names along with their value are available.
+
+              Example (note that "return" statement is missing; it will be automatically
+              inserted by GST):
+
+                  <moving_label text="Co" weight="bold" color="red>
+                  <![CDATA[  {'x': -50, 'y': c0};]]>
+                  </moving_label>
+
+    asymptote:
+              Add a vertical or horizontal asymptote to the graph which will
+              be dynamically repositioned based on the specified function.
+
+              It is similar to the function in that it provides a JavaScript body function
+              string. This function will be used to calculate the position of the asymptote
+              relative to the axis specified by the "type" parameter.
+
+              Required parameters:
+                  type:
+                        Which axis should the asymptote be plotted against. Available values
+                        are "x" and "y".
+
+              Optional parameters:
+                  color:
+                        The color of the line. A valid CSS color string is expected.
+
+
+Example
+=======
+
+
+Plotting, sliders and inputs
+----------------------------
+
+.. literalinclude:: gst_example_with_documentation.xml
+
+
+Update of html elements, no plotting
+------------------------------------
+
+.. literalinclude:: gst_example_html_element_output.xml
+
+
+Circle with dynamic radius
+--------------------------
+
+.. literalinclude:: gst_example_dynamic_range.xml
+
+
+Example of a bar graph
+----------------------
+
+.. literalinclude:: gst_example_bars.xml
+
+
+Example of moving labels of graph
+---------------------------------
+
+.. literalinclude:: gst_example_dynamic_labels.xml

doc/public/course_data_formats/graphical_slider_tool/gst_example_bars.xml

+<vertical>
+    <graphical_slider_tool>
+      <render>
+        <h2>Graphic slider tool: Bar graph example.</h2>
+
+        <p>We can request the API to plot us a bar graph.</p>
+        <div style="clear:both">
+          <p style="width:60px;float:left;">a</p>
+          <slider var='a' style="width:400px;float:left;"/>
+          <textbox var='a' style="width:50px;float:left;margin-left:15px;"/>
+          <br /><br /><br />
+          <p style="width:60px;float:left;">b</p>
+          <slider var='b' style="width:400px;float:left;"/>
+          <textbox var='b' style="width:50px;float:left;margin-left:15px;"/>
+        </div>
+          <plot style="clear:left;"/>
+      </render>
+      <configuration>
+        <parameters>
+            <param var="a" min="-100" max="100" step="5" initial="25" />
+            <param var="b" min="-100" max="100" step="5" initial="50" />
+        </parameters>
+        <functions>
+          <function bar="true" color="blue" label="Men">
+            <![CDATA[if (((x>0.9) && (x<1.1)) || ((x>4.9) && (x<5.1))) { return Math.sin(a * 0.01 * Math.PI + 2.952 * x); }
+            else {return undefined;}]]>
+          </function>
+          <function bar="true" color="red" label="Women">
+            <![CDATA[if (((x>1.9) && (x<2.1)) || ((x>3.9) && (x<4.1))) { return Math.cos(b * 0.01 * Math.PI + 3.432 * x); }
+            else {return undefined;}]]>
+          </function>
+          <function bar="true" color="green" label="Other 1">
+            <![CDATA[if (((x>1.9) && (x<2.1)) || ((x>3.9) && (x<4.1))) { return Math.cos((b - 10 * a) * 0.01 * Math.PI + 3.432 * x); }
+            else {return undefined;}]]>
+          </function>
+          <function bar="true" color="yellow" label="Other 2">
+            <![CDATA[if (((x>1.9) && (x<2.1)) || ((x>3.9) && (x<4.1))) { return Math.cos((b + 7 * a) * 0.01 * Math.PI + 3.432 * x); }
+            else {return undefined;}]]>
+          </function>
+        </functions>
+        <plot>
+          <xrange><min>1</min><max>5</max></xrange>
+          <num_points>5</num_points>
+          <xticks>0, 0.5, 6</xticks>
+          <yticks>-1.5, 0.1, 1.5</yticks>
+          <xticks_names>
+          <![CDATA[
+              {
+                  "1.5": "Single", "4.5": "Married"
+              }
+          ]]>
+          </xticks_names>
+          <yticks_names>
+          <![CDATA[
+              {
+                  "-1.0": "-100%", "-0.5": "-50%", "0.0": "0%", "0.5": "50%", "1.0": "100%"
+              }
+          ]]>
+          </yticks_names>
+          <bar_width>0.4</bar_width>
+        </plot>
+      </configuration>
+    </graphical_slider_tool>
+</vertical>

doc/public/course_data_formats/graphical_slider_tool/gst_example_dynamic_labels.xml

+<vertical>
+ <graphical_slider_tool>
+      <render>
+        <h1>Graphic slider tool: Dynamic labels.</h1>
+        <p>There are two kinds of dynamic lables.
+        1) Dynamic changing values in graph legends.
+        2) Dynamic labels, which coordinates depend on parameters </p>
+         <p>a: <slider var="a"/></p>
+          <br/>
+          <p>b: <slider var="b"/></p>
+          <br/><br/>
+          <plot style="width:400px; height:400px;"/>
+      </render>
+
+      <configuration>
+        <parameters>
+            <param var="a" min="-10" max="10" step="1" initial="0" />
+            <param var="b" min="0" max="10" step="0.5" initial="5" />
+        </parameters>
+        <functions>
+          <function label="Value of a is: dyn_val_1">a * x + b</function>
+         <!-- dynamic values in legend -->
+         <function output="plot_label" el_id="dyn_val_1">a</function>
+        </functions>
+        <plot>
+          <xrange><min>0</min><max>30</max></xrange>
+          <num_points>10</num_points>
+          <xticks>0, 6, 30</xticks>
+          <yticks>-9, 1, 9</yticks>
+          <!-- custom labels with coordinates as any function of parameter -->
+          <moving_label text="Dynam_lbl 1" weight="bold">
+          <![CDATA[  {'x': 10, 'y': a};]]>
+          </moving_label>
+          <moving_label text="Dynam lbl 2" weight="bold">
+          <![CDATA[  {'x': -6, 'y': b};]]>
+          </moving_label>
+        </plot>
+      </configuration>
+    </graphical_slider_tool>
+</vertical>
\ No newline at end of file

doc/public/course_data_formats/graphical_slider_tool/gst_example_dynamic_range.xml

+<vertical>
+    <graphical_slider_tool>
+      <render>
+        <h2>Graphic slider tool: Dynamic range and implicit functions.</h2>
+
+        <p>You can make x range (not ticks of x axis) of functions to depend on
+          parameter value. This can be useful when function domain depends
+          on parameter.</p>
+        <p>Also implicit functons like circle can be plotted as 2 separate
+            functions of same color.</p>
+         <div style="height:50px;">
+         <slider var='a' style="width:400px;float:left;"/>
+         <textbox var='a' style="float:left;width:60px;margin-left:15px;"/>
+       </div>
+        <plot style="margin-top:15px;margin-bottom:15px;"/>
+      </render>
+      <configuration>
+        <parameters>
+            <param var="a" min="5" max="25" step="0.5" initial="12.5" />
+        </parameters>
+        <functions>
+          <function color="red">Math.sqrt(a * a - x * x)</function>
+          <function color="red">-Math.sqrt(a * a - x * x)</function>
+        </functions>
+        <plot>
+          <xrange>
+            <!-- dynamic range -->
+              <min>-a</min>
+              <max>a</max>
+          </xrange>
+          <num_points>1000</num_points>
+          <xticks>-30, 6, 30</xticks>
+          <yticks>-30, 6, 30</yticks>
+        </plot>
+      </configuration>
+    </graphical_slider_tool>
+</vertical>

doc/public/course_data_formats/graphical_slider_tool/gst_example_html_element_output.xml

+<vertical>
+    <graphical_slider_tool>
+        <render>
+            <h2>Graphic slider tool: Output to DOM element.</h2>
+
+            <p>a + b = <span id="answer_span_1"></span></p>
+
+            <div style="clear:both">
+                <p style="float:left;margin-right:10px;">a</p>
+                <slider var='a' style="width:400px;float:left;"/>
+                <textbox var='a' style="width:50px;float:left;margin-left:15px;"/>
+            </div>
+
+            <div style="clear:both">
+                <p style="float:left;margin-right:10px;">b</p>
+                <slider var='b' style="width:400px;float:left;"/>
+                <textbox var='b' style="width:50px;float:left;margin-left:15px;"/>
+            </div>
+            <br/><br/><br/>
+            <plot/>
+        </render>
+        <configuration>
+            <parameters>
+                <param var="a" min="-10.0" max="10.0" step="0.1" initial="0" />
+                <param var="b" min="-10.0" max="10.0" step="0.1" initial="0" />
+            </parameters>
+
+            <functions>
+                <function output="element" el_id="answer_span_1">
+                    function add(a, b, precision) {
+                        var x = Math.pow(10, precision || 2);
+                        return (Math.round(a * x) + Math.round(b * x)) / x;
+                    }
+
+                    return add(a, b, 5);
+                </function>
+            </functions>
+        </configuration>
+    </graphical_slider_tool>
+</vertical>

doc/public/course_data_formats/graphical_slider_tool/gst_example_with_documentation.xml

+<vertical>
+    <graphical_slider_tool>
+      <render>
+
+          <h2>Graphic slider tool: full example.</h2>
+            <p>
+                A simple equation
+                    \(
+                        y_1 = 10 \times b \times \frac{sin(a \times x) \times sin(b \times x)}{cos(b \times x) + 10}
+                    \)
+                can be plotted.
+            </p>
+
+            <!-- make text and input or slider at the same line -->
+            <div>
+              <p style="float:left;"> Currently \(a\) is</p>
+              <!-- readonly input for a -->
+              <span id="a_readonly" style="width:50px; float:left; margin-left:10px;"/>
+            </div>
+            <!-- clear:left will make next text to begin from new line -->
+            <p style="clear:left">   This one
+                  \(
+                      y_2 = sin(a \times x)
+                  \)
+              will be overlayed on top.
+            </p>
+            <div>
+              <p style="float:left;">Currently \(b\) is </p>
+              <textbox var="b" style="width:50px; float:left; margin-left:10px;"/>
+            </div>
+            <div style="clear:left;">
+              <p style="float:left;">To change \(a\) use:</p>
+              <slider var="a" style="width:400px;float:left;margin-left:10px;"/>
+            </div>
+            <div style="clear:left;">
+              <p style="float:left;">To change \(b\) use:</p>
+              <slider var="b" style="width:400px;float:left;margin-left:10px;"/>
+            </div>
+            <plot style='clear:left;width:600px;padding-top:15px;padding-bottom:20px;'/>
+            <div style="clear:left;height:50px;">
+             <p style="float:left;">Second input for b:</p>
+             <!-- editable input for b -->
+              <textbox var="b" style="color:red;width:60px;float:left;margin-left:10px;"/>
+            </div >
+      </render>
+
+      <configuration>
+
+        <parameters>
+            <param var="a" min="90" max="120" step="10" initial="100" />
+            <param var="b" min="120" max="200" step="2.3" initial="120" />
+        </parameters>
+
+        <functions>
+
+          <function color="#0000FF" line="false" dot="true" label="\(y_1\)">
+            return 10.0 * b * Math.sin(a * x) * Math.sin(b * x) / (Math.cos(b * x) + 10);
+          </function>
+          <function color="red" line="true" dot="false" label="\(y_2\)">
+            <!-- works w/o return, if function is single line -->
+            Math.sin(a * x);
+          </function>
+          <function color="#FFFF00" line="false" dot="false" label="unknown">
+            function helperFunc(c1) {
+              return c1 * c1 - a;
+            }
+
+            return helperFunc(x + 10 * a * b) + Math.sin(a - x);
+          </function>
+          <function output="element" el_id="a_readonly">a</function>
+        </functions>
+
+        <plot>
+
+          <xrange>
+              <min>return 0;</min>
+              <!-- works w/o return -->
+              <max>30</max>
+          </xrange>
+
+          <num_points>120</num_points>
+
+          <xticks>0, 3, 30</xticks>
+          <yticks>-1.5, 1.5, 13.5</yticks>
+
+          <xunits>\(cm\)</xunits>
+          <yunits>\(m\)</yunits>
+        </plot>
+      </configuration>
+    </graphical_slider_tool>
+</vertical>

doc/public/index.rst

+..
+    Public facing docs for non-developers go here. Please do not add any Python
+    dependencies for code introspection here (we may temporarily host it some
+    place where those dependencies are cumbersome to build).
+
+edX Data Documentation
+======================
+The following documents are targetted at those who are working with various data formats consumed and produced by the edX platform -- primarily course authors and those who are conducting research on data in our system. Developer oriented discussion of architecture and strictly internal APIs should be documented elsewhere.
+
+Course Data Formats
+-------------------
+These are data formats written by people to specify course structure and content. Some of this is abstracted away if you are using the Studio authoring user interface.
+
+.. toctree::
+   :maxdepth: 2
+
+   course_data_formats/course_xml.rst
+   course_data_formats/grading.rst
+
+Specific Problem Types
+^^^^^^^^^^^^^^^^^^^^^^
+.. toctree::
+   :maxdepth: 1
+
+   course_data_formats/drag_and_drop/drag_and_drop_input.rst
+   course_data_formats/graphical_slider_tool/graphical_slider_tool.rst
+
+
+Internal Data Formats
+---------------------
+These document describe how we store course structure, student state/progress, and events internally. Useful for developers or researchers who interact with our raw data exports.
+
+.. toctree::
+   :maxdepth: 2
+
+   internal_data_formats/sql_schema.rst
+   internal_data_formats/discussion_data.rst
+   internal_data_formats/tracking_logs.rst
+
+Indices and tables
+==================
+
+* :ref:`search`
+

doc/public/internal_data_formats/discussion_data.rst

+######################
+Discussion Forums Data
+######################
+Discussions in edX are stored in a MongoDB database as collections of JSON documents.
+
+The primary collection holding all posts and comments written by users is `contents`. There are two types of objects stored here, though they share much of the same structure. A `CommentThread` represents a comment that opens a new thread -- usually a student question of some sort. A `Comment` is a reply in the conversation started by a `CommentThread`.
+
+*****************
+Shared Attributes
+*****************
+
+The attributes that `Comment` and `CommentThread` objects share are listed below.
+
+`_id`
+-----
+  The 12-byte MongoDB unique ID for this collection. Like all MongoDB IDs, they are monotonically increasing and the first four bytes are a timestamp. 
+
+`_type`
+-------
+  `CommentThread` or `Comment` depending on the type of object.
+
+`anonymous`
+-----------
+  If true, this `Comment` or `CommentThread` will show up as written by anonymous, even to those who have moderator privileges in the forums.
+
+`anonymous_to_peers`
+--------------------
+  The idea behind this field was that `anonymous_to_peers = true` would make the the comment appear anonymous to your fellow students, but would allow the course staff to see who you were. However, that was never implemented in the UI, and only `anonymous` is actually used. The `anonymous_to_peers` field is always false.
+
+`at_position_list`
+------------------
+  No longer used. Child comments (replies) are just sorted by their `created_at` timestamp instead. 
+
+`author_id`
+-----------
+  The user who wrote this. Corresponds to the user IDs we store in our MySQL database as `auth_user.id`
+
+`body`
+------
+  Text of the comment in Markdown. UTF-8 encoded.
+
+`course_id`
+-----------
+  The full course_id of the course that this comment was made in, including org and run. This value can be seen in the URL when browsing the courseware section. Example: `BerkeleyX/Stat2.1x/2013_Spring`
+
+`created_at`
+------------
+  Timestamp in UTC. Example: `ISODate("2013-02-21T03:03:04.587Z")`
+
+`updated_at`
+------------
+  Timestamp in UTC. Example: `ISODate("2013-02-21T03:03:04.587Z")`
+
+`votes`
+-------
+  Both `CommentThread` and `Comment` objects support voting. `Comment` objects that are replies to other comments still have this attribute, even though there is no way to actually vote on them in the UI. This attribute is a dictionary that has the following inside:
+
+* `up` = list of User IDs that up-voted this comment or thread.
+* `down` = list of User IDs that down-voted this comment or thread (no longer used).
+* `up_count` = total upvotes received.
+* `down_count` = total downvotes received (no longer used).
+* `count` = total votes cast.
+* `point` = net vote, now always equal to `up_count`.
+
+A user only has one vote per `Comment` or `CommentThread`. Though it's still written to the database, the UI no longer displays an option to downvote anything.
+
+*************
+CommentThread
+*************
+The following fields are specific to `CommentThread` objects. Each thread in the forums is represented by one `CommentThread`.
+
+`closed`
+--------
+  If true, this thread was closed by a forum moderator/admin.
+
+`comment_count`
+---------------
+  The number of comment replies in this thread. This includes all replies to replies, but does not include the original comment that started the thread. So if we had::
+
+    CommentThread: "What's a good breakfast?"
+      * Comment: "Just eat cereal!"
+      * Comment: "Try a Loco Moco, it's amazing!"
+        * Comment: "A Loco Moco? Only if you want a heart attack!"
+        * Comment: "But it's worth it! Just get a spam musubi on the side."
+
+  In that exchange, the `comment_count` for the `CommentThread` is `4`.
+
+`commentable_id`
+----------------
+  We can attach a discussion to any piece of content in the course, or to top level categories like "General" and "Troubleshooting". When the `commentable_id` is a high level category, it's specified in the course's policy file. When it's a specific content piece (e.g. `600x_l5_p8`, meaning 6.00x, Lecture Sequence 5, Problem 8), it's taken from a discussion module in the course.
+
+`last_activity_at`
+------------------
+  Timestamp in UTC indicating the last time there was activity in the thread (new posts, edits, etc). Closing the thread does not affect the value in this field. 
+
+`tags_array`
+------------
+  Meant to be a list of tags that were user definable, but no longer used.
+
+`title`
+-------
+  Title of the thread, UTF-8 string.
+
+*******
+Comment
+*******
+The following fields are specific to `Comment` objects. A `Comment` is a reply to a `CommentThread` (so an answer to the question), or a reply to another `Comment` (a comment about somebody's answer). It used to be the case that `Comment` replies could nest much more deeply, but we later capped it at just these three levels (question, answer, comment) much in the way that StackOverflow does.
+
+`endorsed`
+----------
+  Boolean value, true if a forum moderator or instructor has marked that this `Comment` is a correct answer for whatever question the thread was asking. Exists for `Comments` that are replies to other `Comments`, but in that case `endorsed` is always false because there's no way to endorse such comments through the UI.
+
+`comment_thread_id`
+-------------------
+  What `CommentThread` are we a part of? All `Comment` objects have this.
+
+`parent_id`
+-----------
+  The `parent_id` is the `_id` of the `Comment` that this comment was made in reply to. Note that this only occurs in a `Comment` that is a reply to another `Comment`; it does not appear in a `Comment` that is a reply to a `CommentThread`.
+
+`parent_ids`
+------------
+  The `parent_ids` attribute appears in all `Comment` objects, and contains the `_id` of all ancestor comments. Since the UI now prevents comments from being nested more than one layer deep, it will only ever have at most one element in it. If a `Comment` has no parent, it's an empty list.

doc/public/internal_data_formats/sql_schema.rst

+##############################
+Student Info and Progress Data
+##############################
+
+The following sections detail how edX stores student state data internally, and is useful for developers and researchers who are examining database exports. This information includes demographic information collected at signup, course enrollment, course progress, and certificate status.
+
+Conventions to keep in mind:
+
+* We currently use MySQL 5.1 with InnoDB tables
+* All strings are stored as UTF-8.
+* All datetimes are stored as UTC.
+* Tables that are built into the Django framework are not documented here unless we use them in unconventional ways.
+
+All of our tables will be described below, first in summary form with field types and constraints, and then with a detailed explanation of each field. For those not familiar with the MySQL schema terminology in the table summaries:
+
+`Type`
+  This is the kind of data it is, along with the size of the field. When a numeric field has a length specified, it just means that's how many digits we want displayed -- it has no affect on the number of bytes used.
+
+  .. list-table::
+     :widths: 10 80
+     :header-rows: 1
+  
+     * - Value
+       - Meaning
+     * - `int`
+       - 4 byte integer.
+     * - `smallint`
+       - 2 byte integer, sometimes used for enumerated values.
+     * - `tinyint`
+       - 1 byte integer, but usually just used to indicate a boolean field with 0 = False and 1 = True.
+     * - `varchar`
+       - String, typically short and indexable. The length is the number of chars, not bytes (so unicode friendly).
+     * - `longtext`
+       - A long block of text, usually not indexed.
+     * - `date`
+       - Date
+     * - `datetime`
+       - Datetime in UTC, precision in seconds.
+  
+`Null`
+
+  .. list-table::
+     :widths: 10 80
+     :header-rows: 1
+  
+     * - Value
+       - Meaning
+     * - `YES`
+       - `NULL` values are allowed
+     * - `NO`
+       - `NULL` values are not allowed
+
+  .. note::
+     Django often just places blank strings instead of NULL when it wants to indicate a text value is optional. This is used more meaningful for numeric and date fields.
+
+`Key`
+  .. list-table::
+     :widths: 10 80
+     :header-rows: 1
+  
+     * - Value
+       - Meaning
+     * - `PRI`
+       - Primary key for the table, usually named `id`, unique
+     * - `UNI`
+       - Unique
+     * - `MUL`
+       - Indexed for fast lookup, but the same value can appear multiple times. A Unique index that allows `NULL` can also show up as `MUL`.
+
+
+****************
+User Information
+****************
+
+`auth_user`
+===========
+
+The `auth_user` table is built into the Django web framework that we use. It holds generic information necessary for basic login and permissions information. It has the following fields::
+
+  +------------------------------+--------------+------+-----+
+  | Field                        | Type         | Null | Key |
+  +------------------------------+--------------+------+-----+
+  | id                           | int(11)      | NO   | PRI |
+  | username                     | varchar(30)  | NO   | UNI |
+  | first_name                   | varchar(30)  | NO   |     | # Never used
+  | last_name                    | varchar(30)  | NO   |     | # Never used
+  | email                        | varchar(75)  | NO   | UNI |
+  | password                     | varchar(128) | NO   |     |
+  | is_staff                     | tinyint(1)   | NO   |     |
+  | is_active                    | tinyint(1)   | NO   |     |
+  | is_superuser                 | tinyint(1)   | NO   |     |
+  | last_login                   | datetime     | NO   |     |
+  | date_joined                  | datetime     | NO   |     |
+  | status                       | varchar(2)   | NO   |     | # No longer used
+  | email_key                    | varchar(32)  | YES  |     | # No longer used
+  | avatar_type                  | varchar(1)   | NO   |     | # No longer used
+  | country                      | varchar(2)   | NO   |     | # No longer used
+  | show_country                 | tinyint(1)   | NO   |     | # No longer used
+  | date_of_birth                | date         | YES  |     | # No longer used
+  | interesting_tags             | longtext     | NO   |     | # No longer used
+  | ignored_tags                 | longtext     | NO   |     | # No longer used
+  | email_tag_filter_strategy    | smallint(6)  | NO   |     | # No longer used
+  | display_tag_filter_strategy  | smallint(6)  | NO   |     | # No longer used
+  | consecutive_days_visit_count | int(11)      | NO   |     | # No longer used
+  +------------------------------+--------------+------+-----+
+
+`id`
+----
+  Primary key, and the value typically used in URLs that reference the user. A user has the same value for `id` here as they do in the MongoDB database's users collection. Foreign keys referencing `auth_user.id` will often be named `user_id`, but are sometimes named `student_id`.
+
+`username`
+----------
+  The unique username for a user in our system. It may contain alphanumeric, _, @, +, . and - characters. The username is the only information that the students give about themselves that we currently expose to other students. We have never allowed people to change their usernames so far, but that's not something we guarantee going forward.
+
+`first_name`
+------------
+  .. note::
+     Not used; we store a user's full name in `auth_userprofile.name` instead.
+
+`last_name`
+-----------
+  .. note::
+     Not used; we store a user's full name in `auth_userprofile.name` instead.
+
+`email`
+-------
+  Their email address. While Django by default makes this optional, we make it required, since it's the primary mechanism through which people log in. Must be unique to each user. Never shown to other users.
+
+`password`
+----------
+  A hashed version of the user's password. Depending on when the password was last set, this will either be a SHA1 hash or PBKDF2 with SHA256 (Django 1.3 uses the former and 1.4 the latter).
+
+`is_staff`
+----------
+  This value is `1` if the user is a staff member *of edX* with corresponding elevated privileges that cut across courses. It does not indicate that the person is a member of the course staff for any given course. Generally, users with this flag set to 1 are either edX program managers responsible for course delivery, or edX developers who need access for testing and debugging purposes. People who have `is_staff = 1` get instructor privileges on all courses, along with having additional debug information show up in the instructor tab.
+
+  Note that this designation has no bearing with a user's role in the forums, and confers no elevated privileges there.
+
+  Most users have a `0` for this value.
+
+`is_active`
+-----------
+  This value is `1` if the user has clicked on the activation link that was sent to them when they created their account, and `0` otherwise. Users who have `is_active = 0` generally cannot log into the system. However, when users first create their account, they are automatically logged in even though they are not active. This is to let them experience the site immediately without having to check their email. They just get a little banner at the top of their dashboard reminding them to check their email and activate their account when they have time. If they log out, they won't be able to log back in again until they've activated. However, because our sessions last a long time, it is theoretically possible for someone to use the site as a student for days without being "active".
+
+  Once `is_active` is set to `1`, the only circumstance where it would be set back to `0` would be if we decide to ban the user (which is very rare, manual operation).
+
+`is_superuser`
+--------------
+  Value is `1` if the user has admin privileges. Only the earliest developers of the system have this set to `1`, and it's no longer really used in the codebase. Set to 0 for almost everybody.
+
+`last_login`
+------------
+  A datetime of the user's last login. Should not be used as a proxy for activity, since people can use the site all the time and go days between logging in and out.
+
+`date_joined`
+-------------
+  Date that the account was created (NOT when it was activated).
+
+`(obsolete fields)`
+-------------------
+  All the following fields were added by an application called Askbot, a discussion forum package that is no longer part of the system:
+
+  * `status`
+  * `email_key`
+  * `avatar_type`
+  * `country`
+  * `show_country`
+  * `date_of_birth`
+  * `interesting_tags`
+  * `ignored_tags`
+  * `email_tag_filter_strategy`
+  * `display_tag_filter_strategy`
+  * `consecutive_days_visit_count`
+
+  Only users who were part of the prototype 6.002x course run in the Spring of 2012 would have any information in these fields. Even with those users, most of this information was never collected. Only the fields that are automatically generated have any values in them, such as tag settings.
+
+  These fields are completely unrelated to the discussion forums we currently use, and will eventually be dropped from this table.
+
+
+`auth_userprofile`
+==================
+The `auth_userprofile` table is mostly used to store user demographic information collected during the signup process. We also use it to store certain additional metadata relating to certificates. Every row in this table corresponds to one row in `auth_user`::
+
+  +--------------------+--------------+------+-----+
+  | Field              | Type         | Null | Key |
+  +--------------------+--------------+------+-----+
+  | id                 | int(11)      | NO   | PRI |
+  | user_id            | int(11)      | NO   | UNI |
+  | name               | varchar(255) | NO   | MUL |
+  | language           | varchar(255) | NO   | MUL | # Prototype course users only
+  | location           | varchar(255) | NO   | MUL | # Prototype course users only
+  | meta               | longtext     | NO   |     |
+  | courseware         | varchar(255) | NO   |     | # No longer used
+  | gender             | varchar(6)   | YES  | MUL | # Only users signed up after prototype
+  | mailing_address    | longtext     | YES  |     | # Only users signed up after prototype
+  | year_of_birth      | int(11)      | YES  | MUL | # Only users signed up after prototype
+  | level_of_education | varchar(6)   | YES  | MUL | # Only users signed up after prototype
+  | goals              | longtext     | YES  |     | # Only users signed up after prototype
+  | allow_certificate  | tinyint(1)   | NO   |     |
+  +--------------------+--------------+------+-----+
+
+There is an important split in demographic data gathered for the students who signed up during the MITx prototype phase in the spring of 2012, and those that signed up afterwards.
+
+`id`
+----
+  Primary key, not referenced anywhere else.
+
+`user_id`
+---------
+  A foreign key that maps to `auth_user.id`.
+
+`name`
+------
+  String for a user's full name. We make no constraints on language or breakdown into first/last name. The names are never shown to other students. Foreign students usually enter a romanized version of their names, but not always.
+
+  It used to be our policy to require manual approval of name changes to guard the integrity of the certificates. Students would submit a name change request and someone from the team would approve or reject as appropriate. Later, we decided to allow the name changes to take place automatically, but to log previous names in the `meta` field.
+
+`language`
+----------
+  User's preferred language, asked during the sign up process for the 6.002x prototype course given in the Spring of 2012. This information stopped being collected after the transition from MITx to edX happened, but we never removed the values from our first group of students. Sometimes written in those languages.
+
+`location`
+----------
+  User's location, asked during the sign up process for the 6.002x prototype course given in the Spring of 2012. We weren't specific, so people tended to put the city they were in, though some just specified their country and some got as specific as their street address. Again, sometimes romanized and sometimes written in their native language. Like `language`, we stopped collecting this field when we transitioned from MITx to edX, so it's only available for our first batch of students.
+
+`meta`
+------
+  An optional, freeform text field that stores JSON data. This was a hack to allow us to associate arbitrary metadata with a user. An example of the JSON that can be stored here is::
+
+    {
+      "old_names" : [
+     ["David Ormsbee", "I want to add my middle name as well.", "2012-11-15T17:28:12.658126"],
+     ["Dave Ormsbee", "Dave's too informal for a certificate.", "2013-02-07T11:15:46.524331"]
+      ],
+      "old_emails" : [["dormsbee@mitx.mit.edu", "2012-10-18T15:21:41.916389"]],
+      "6002x_exit_response" : {
+     "rating": ["6"],
+     "teach_ee": ["I do not teach EE."],
+     "improvement_textbook": ["I'd like to get the full PDF."],
+     "future_offerings": ["true"],
+     "university_comparison":
+       ["This course was <strong>on the same level</strong> as the university class."],
+     "improvement_lectures": ["More PowerPoint!"],
+     "highest_degree": ["Bachelor's degree."],
+     "future_classes": ["true"],
+     "future_updates": ["true"],
+     "favorite_parts": ["Releases, bug fixes, and askbot."]
+      }
+    }
+
+  The following are details about this metadata. Please note that the fields described below are found as JSON attributes *inside* the `meta` field, and are *not* separate database fields of their own.
+
+  `old_names`
+    A list of the previous names this user had, and the timestamps at which they submitted a request to change those names. These name change request submissions used to require a staff member to approve it before the name change took effect. This is no longer the case, though we still record their previous names.
+  
+    Note that the value stored for each entry is the name they had, not the name they requested to get changed to. People often changed their names as the time for certificate generation approached, to replace nicknames with their actual names or correct spelling/punctuation errors.
+  
+    The timestamps are UTC, like all datetimes stored in our system.
+  
+  `old_emails`
+    A list of previous emails this user had, with timestamps of when they changed them, in a format similar to `old_names`. There was never an approval process for this.
+  
+    The timestamps are UTC, like all datetimes stored in our system.
+  
+  `6002x_exit_response`
+    Answers to a survey that was sent to students after the prototype 6.002x course in the Spring of 2012. The questions and number of questions were randomly selected to measure how much survey length affected response rate. Only students from this course have this field.
+  
+
+`courseware`
+------------
+  This can be ignored. At one point, it was part of a way to do A/B tests, but it has not been used for anything meaningful since the conclusion of the prototype course in the spring of 2012.
+
+`gender`
+--------
+  Dropdown field collected during student signup. We only started collecting this information after the transition from MITx to edX, so prototype course students will have `NULL` for this field.
+
+  .. list-table::
+     :widths: 10 80
+     :header-rows: 1
+  
+     * - Value
+       - Meaning
+     * - `NULL`
+       - This student signed up before this information was collected
+     * - `''` (blank)
+       - User did not specify gender
+     * - `'f'`
+       - Female
+     * - `'m'`
+       - Male
+     * - `'o'`
+       - Other
+
+`mailing_address`
+-----------------
+  Text field collected during student signup. We only started collecting this information after the transition from MITx to edX, so prototype course students will have `NULL` for this field. Students who elected not to enter anything will have a blank string.
+
+`year_of_birth`
+---------------
+  Dropdown field collected during student signup. We only started collecting this information after the transition from MITx to edX, so prototype course students will have `NULL` for this field. Students who decided not to fill this in will also have NULL.
+
+`level_of_education`
+--------------------
+  Dropdown field collected during student signup. We only started collecting this information after the transition from MITx to edX, so prototype course students will have `NULL` for this field.
+
+  .. list-table::
+     :widths: 10 80
+     :header-rows: 1
+  
+     * - Value
+       - Meaning
+     * - `NULL` 
+       - This student signed up before this information was collected
+     * - `''` (blank)
+       - User did not specify level of education.
+     * - `'p_se'`
+       - Doctorate in science or engineering
+     * - `'p_oth'`
+       - Doctorate in another field
+     * - `'m'`
+       - Master's or professional degree
+     * - `'b'`
+       - Bachelor's degree
+     * - `'hs'`
+       - Secondary/high school
+     * - `'jhs'`
+       - Junior secondary/junior high/middle school
+     * - `'el'`
+       - Elementary/primary school
+     * - `'none'`
+       - None
+     * - `'other'`
+       - Other
+     
+`goals`
+-------
+  Text field collected during student signup in response to the prompt, "Goals in signing up for edX". We only started collecting this information after the transition from MITx to edX, so prototype course students will have `NULL` for this field. Students who elected not to enter anything will have a blank string.
+
+`allow_certificate`
+-------------------
+  Set to `1` for most students. This field is set to `0` if log analysis has revealed that this student is accessing our site from a country that the US has an embargo against. At this time, we do not issue certificates to students from those countries.
+
+
+`student_courseenrollment`
+==========================
+A row in this table represents a student's enrollment for a particular course run. If they decide to unenroll in the course, we delete their entry in this table, but we still leave all their state in `courseware_studentmodule` untouched.
+
+`id`
+----
+  Primary key.
+
+`user_id`
+---------
+  Student's ID in `auth_user.id`
+
+`course_id`
+-----------
+  The ID of the course run they're enrolling in (e.g. `MITx/6.002x/2012_Fall`). You can get this from the URL when you're viewing courseware on your browser.
+
+`created`
+---------
+  Datetime of enrollment, UTC.
+
+
+
+*******************
+Courseware Progress
+*******************
+
+Any piece of content in the courseware can store state and score in the `courseware_studentmodule` table. Grades and the user Progress page are generated by doing a walk of the course contents, searching for graded items, looking up a student's entries for those items in `courseware_studentmodule` via `(course_id, student_id, module_id)`, and then applying the grade weighting found in the course policy and grading policy files. Course policy files determine how much weight one problem has relative to another, and grading policy files determine how much categories of problems are weighted (e.g. HW=50%, Final=25%, etc.).
+
+.. warning::
+   **Modules might not be what you expect!**
+   
+   It's important to understand what "modules" are in the context of our system, as the terminology can be confusing. For the conventions of this table and many parts of our code, a "module" is a content piece that appears in the courseware. This can be nearly anything that appears when users are in the courseware tab: a video, a piece of HTML, a problem, etc. Modules can also be collections of other modules, such as sequences, verticals (modules stacked together on the same page), weeks, chapters, etc. In fact, the course itself is a top level module that contains all the other contents of the course as children. You can imagine the entire course as a tree with modules at every node.
+
+   Modules can store state, but whether and how they do so is up to the implemenation for that particular kind of module. When a user loads page, we look up all the modules they need to render in order to display it, and then we ask the database to look up state for those modules for that user. If there is corresponding entry for that user for a given module, we create a new row and set the state to an empty JSON dictionary.
+
+
+`courseware_studentmodule`
+==========================
+
+The `courseware_studentmodule` table holds all courseware state for a given user. Every student has a separate row for every piece of content in the course, making this by far our largest table::
+
+  +-------------+--------------+------+-----+
+  | Field       | Type         | Null | Key |
+  +-------------+--------------+------+-----+
+  | id          | int(11)      | NO   | PRI |
+  | module_type | varchar(32)  | NO   | MUL |
+  | module_id   | varchar(255) | NO   | MUL |
+  | student_id  | int(11)      | NO   | MUL |
+  | state       | longtext     | YES  |     |
+  | grade       | double       | YES  | MUL | # problem, selfassessment, and combinedopenended use this
+  | created     | datetime     | NO   | MUL |
+  | modified    | datetime     | NO   | MUL |
+  | max_grade   | double       | YES  |     | # problem, selfassessment, and combinedopenended use this
+  | done        | varchar(8)   | NO   | MUL | # ignore this
+  | course_id   | varchar(255) | NO   | MUL |
+  +-------------+--------------+------+-----+
+
+
+`id`
+----
+  Primary key. Rarely used though, since most lookups on this table are searches on the three tuple of `(course_id, student_id, module_id)`.
+
+`module_type`
+-------------
+
+  .. list-table::
+     :widths: 10 80
+     :header-rows: 0
+  
+     * - `chapter`
+       - The top level categories for a course. Each of these is usually labeled as a Week in the courseware, but this is just convention.
+     * - `combinedopenended`
+       - A new module type developed for grading open ended questions via self assessment, peer assessment, and machine learning.
+     * - `conditional`
+       - A new module type recently developed for 8.02x, this allows you to prevent access to certain parts of the courseware if other parts have not been completed first.
+     * - `course`
+       - The top level course module of which all course content is descended.
+     * - `problem`
+       - A problem that the user can submit solutions for. We have many different varieties.
+     * - `problemset`
+       - A collection of problems and supplementary materials, typically used for homeworks and rendered as a horizontal icon bar in the courseware. Use is inconsistent, and some courses use a `sequential` instead.
+     * - `selfassessment`
+       - Self assessment problems. An early test of the open ended grading system that is not in widespread use yet. Recently deprecated in favor of `combinedopenended`.
+     * - `sequential`
+       - A collection of videos, problems, and other materials, rendered as a horizontal icon bar in the courseware.
+     * - `timelimit`
+       - A special module that records the time you start working on a piece of courseware and enforces time limits, used for Pearson exams. This hasn't been completely generalized yet, so is not available for widespread use.
+     * - `videosequence`
+       - A collection of videos, exercise problems, and other materials, rendered as a horizontal icon bar in the courseware. Use is inconsistent, and some courses use a `sequential` instead.
+
+  There's been substantial muddling of our container types, particularly between sequentials, problemsets, and videosequences. In the beginning we only had sequentials, and these ended up being used primarily for two purposes: creating a sequence of lecture videos and exercises for instruction, and creating homework problem sets. The `problemset` and `videosequence` types were created with the hope that our system would have a better semantic understanding of what a sequence actually represented, and could at a later point choose to render them differently to the user if it was appropriate. Due to a variety of reasons, migration over to this has been spotty. They all render the same way at the moment.
+
+`module_id`
+-----------
+  Unique ID for a distinct piece of content in a course, these are recorded as URLs of the form `i4x://{org}/{course_num}/{module_type}/{module_name}`. Having URLs of this form allows us to give content a canonical representation even as we are in a state of transition between backend data stores.
+
+  .. list-table:: Breakdown of example `module_id`: `i4x://MITx/3.091x/problemset/Sample_Problems`
+     :widths: 10 20 70
+     :header-rows: 1
+     
+     * - Part
+       - Example
+       - Definition
+     * - `i4x://`
+       - 
+       - Just a convention we ran with. We had plans for the domain `i4x.org` at one point.
+     * - `org`
+       - `MITx`
+       - The organization part of the ID, indicating what organization created this piece of content.
+     * - `course_num` 
+       - `3.091x`
+       - The course number this content was created for. Note that there is no run information here, so you can't know what runs of the course this content is being used for from the `module_id` alone; you have to look at the `courseware_studentmodule.course_id` field.
+     * - `module_type` 
+       - `problemset`
+       - The module type, same value as what's in the `courseware_studentmodule.module_type` field.
+     * - `module_name`
+       - `Sample_Problems`
+       - The name given for this module by the content creators. If the module was not named, the system will generate a name based on the type and a hash of its contents (ex: `selfassessment_03c483062389`).
+
+`student_id`
+------------
+  A reference to `auth_user.id`, this is the student that this module state row belongs to.
+
+`state`
+-------
+  This is a JSON text field where different module types are free to store their state however they wish.
+
+  Container Modules: `course`, `chapter`, `problemset`, `sequential`, `videosequence`
+    The state for all of these is a JSON dictionary indicating the user's last known position within this container. This is 1-indexed, not 0-indexed, mostly because it went out that way at one point and we didn't want to later break saved navigation state for users.
+
+    Example: `{"position" : 3}`
+      When this user last interacted with this course/chapter/etc., they had clicked on the third child element. Note that the position is a simple index and not a `module_id`, so if you rearranged the order of the contents, it would not be smart enough to accomodate the changes and would point users to the wrong place.
+
+    The hierarchy goes: `course > chapter > (problemset | sequential | videosequence)`
+
+  `combinedopenended`
+    TODO: More details to come.
+
+  `conditional`
+    Conditionals don't actually store any state, so this value is always an empty JSON dictionary (`'{}'`). We should probably remove these entries altogether.
+
+  `problem`
+    There are many kinds of problems supported by the system, and they all have different state requirements. Note that one problem can have many different response fields. If a problem generates a random circuit and asks five questions about it, then all of that is stored in one row in `courseware_studentmodule`.
+
+    TODO: Write out different problem types and their state.
+
+  `selfassessment`
+    TODO: More details to come.
+
+  `timelimit`
+    This very uncommon type was only used in one Pearson exam for one course, and the format may change significantly in the future. It is currently a JSON dictionary with fields:
+
+    .. list-table::
+       :widths: 10 20 70
+       :header-rows: 1
+
+       * - JSON field
+         - Example
+         - Definition
+       * - `beginning_at`
+         - `1360590255.488154`
+         - UTC time as measured in seconds since UNIX epoch representing when the exam was started.
+       * - `ending_at`
+         - `1360596632.559758`
+         - UTC time as measured in seconds since UNIX epoch representing the time the exam will close.
+       * - `accomodation_codes`
+         - `DOUBLE`
+         - (optional) Sometimes students are given more time for accessibility reasons. Possible values are:
+         
+           * `NONE`: no time accommodation
+           * `ADDHALFTIME`: 1.5X normal time allowance
+           * `ADD30MIN`: normal time allowance + 30 minutes
+           * `DOUBLE`: 2X normal time allowance
+           * `TESTING`: extra long period (for testing/debugging)
+
+
+`grade`
+-------
+  Floating point value indicating the total unweighted grade for this problem that the student has scored. Basically how many responses they got right within the problem.
+
+  Only `problem` and `selfassessment` types use this field. All other modules set this to `NULL`. Due to a quirk in how rendering is done, `grade` can also be `NULL` for a tenth of a second or so the first time that a user loads a problem. The initial load will trigger two writes, the first of which will set the `grade` to `NULL`, and the second of which will set it to `0`.
+
+`created`
+---------
+  Datetime when this row was created (i.e. when the student first accessed this piece of content).
+
+`modified`
+----------
+  Datetime when we last updated this row. Set to be equal to `created` at first. A change in `modified` implies that there was a state change, usually in response to a user action like saving or submitting a problem, or clicking on a navigational element that records its state. However it can also be triggered if the module writes multiple times on its first load, like problems do (see note in `grade`).
+
+`max_grade`
+-----------
+  Floating point value indicating the total possible unweighted grade for this problem, or basically the number of responses that are in this problem. Though in practice it's the same for every entry with the same `module_id`, it is technically possible for it to be anything. The problems are dynamic enough where you could create a random number of responses if you wanted. This a bad idea and will probably cause grading errors, but it is possible.
+
+  Another way in which `max_grade` can differ between entries with the same `module_id` is if the problem was modified after the `max_grade` was written and the user never went back to the problem after it was updated. This might happen if a member of the course staff puts out a problem with five parts, realizes that the last part doesn't make sense, and decides to remove it. People who saw and answered it when it had five parts and never came back to it after the changes had been made will have a `max_grade` of `5`, while people who saw it later will have a `max_grade` of `4`.
+
+  These complexities in our grading system are a high priority target for refactoring in the near future.
+
+  Only `problem` and `selfassessment` types use this field. All other modules set this to `NULL`.
+
+`done`
+------
+  Ignore this field. It was supposed to be an indication whether something was finished, but was never properly used and is just `'na'` in every row.
+
+`course_id`
+-----------
+  The course that this row applies to, represented in the form org/course/run (ex: `MITx/6.002x/2012_Fall`). The same course content (same `module_id`) can be used in different courses, and a student's state needs to be tracked separately for each course.
+
+
+
+************
+Certificates
+************
+
+`certificates_generatedcertificate`
+===================================
+
+The generatedcertificate table tracks certificate state for students who have been graded after a course completes. Currently the table is only populated when a course ends and a script is run to grade students who have completed the course::
+
+  +---------------+--------------+------+-----+---------+----------------+
+  | Field         | Type         | Null | Key | Default | Extra          |
+  +---------------+--------------+------+-----+---------+----------------+
+  | id            | int(11)      | NO   | PRI | NULL    | auto_increment |
+  | user_id       | int(11)      | NO   | MUL | NULL    |                |
+  | download_url  | varchar(128) | NO   |     | NULL    |                |
+  | grade         | varchar(5)   | NO   |     | NULL    |                |
+  | course_id     | varchar(255) | NO   | MUL | NULL    |                |
+  | key           | varchar(32)  | NO   |     | NULL    |                |
+  | distinction   | tinyint(1)   | NO   |     | NULL    |                |
+  | status        | varchar(32)  | NO   |     | NULL    |                |
+  | verify_uuid   | varchar(32)  | NO   |     | NULL    |                |
+  | download_uuid | varchar(32)  | NO   |     | NULL    |                |
+  | name          | varchar(255) | NO   |     | NULL    |                |
+  | created_date  | datetime     | NO   |     | NULL    |                |
+  | modified_date | datetime     | NO   |     | NULL    |                |
+  | error_reason  | varchar(512) | NO   |     | NULL    |                |
+  +---------------+--------------+------+-----+---------+----------------+
+
+
+`user_id`, `course_id`
+----------------------
+  The table is indexed by user and course
+
+`status`
+--------
+  Status may be one of these states:
+
+  * `unavailable`
+  * `generating`
+  * `regenerating`
+  * `deleting`
+  * `deleted`
+  * `downloadable`
+  * `notpassing`
+  * `restricted`
+  * `error`
+  
+  After a course has been graded and certificates have been issued status will be one of:
+  
+  * `downloadable`
+  * `notpassing`
+  * `restricted`
+  
+  If the status is `downloadable` then the student passed the course and there will be a certificate available for download.
+
+`download_url`
+--------------
+  The `download_uuid` has the full URL to the certificate
+
+`download_uuid`, `verify_uuid`
+------------------------------
+  The two uuids are what uniquely identify the download url and the url used to download the certificate.
+
+`distinction`
+-------------
+  This was used for letters of distinction for 188.1x and is not being used for any current courses
+
+`name`
+------
+  This field records the name of the student that was set at the time the student was graded and the certificate was generated.
+
+`grade`
+-------
+  The grade of the student recorded at the time the certificate was generated. This may be different than the current grade since grading is only done once for a course when it ends.
\ No newline at end of file

doc/public/internal_data_formats/tracking_logs.rst

+#############
+Tracking Logs
+#############
+
+* Tracking logs are made available as separate tar files on S3 in the course-data bucket.
+* They are represented as JSON files that catalog all user interactions with the site.
+* To avoid filename collisions the tracking logs are organized by server name, where each directory corresponds to a server where they were stored. 
+
+*************
+Common Fields
+*************
+
+  .. list-table::
+     :widths: 10 40 10 25
+     :header-rows: 1
+     
+     * - field
+       - details
+       - type
+       - values/format
+     * - `username`
+       - username of the user who triggered the event, empty string for anonymous events (not logged in)
+       - string
+       - 
+     * - `session`
+       - key identifying the user's session, may be undefined
+       - string
+       - 32 digits key
+     * - `time`
+       - GMT time the event was triggered
+       - string	
+       - `YYYY-MM-DDThh:mm:ss.xxxxxx`
+     * - `ip`
+       - user ip address
+       - string
+       - 
+     * - `agent`
+       - users browser agent string
+       - string
+       - 
+     * - `page`
+       - page the user was visiting when the event was generated
+       - string
+       - `$URL`
+     * - event_source
+       - event source
+       - string
+       - `browser`, `server`
+     * - `event_type`
+       - type of event triggered, values depends on `event_source`
+       - string
+       - *more details listed below*
+     * - `event`
+       - specifics of the event (dependenty of the event_type)
+       - string/json
+       - *the event string may encode a JSON record*
+       
+
+*************
+Event Sources
+*************
+
+The `event_source` field identifies whether the event originated in the browser (via javascript) or on the server (during the processing of a request).
+
+Server Events
+=============
+
+  .. list-table::
+     :widths: 20 10 10 10 50
+     :header-rows: 1
+  
+     * - event_type
+       - event fields
+       - type
+       - values/format
+       - details
+     * - `show_answer`
+       - `problem_id`
+       - string
+       - 
+       - id of the problem being shown. Ex: `i4x://MITx/6.00x/problem/L15:L15_Problem_2`
+     * - `save_problem_check`
+       - `problem_id`
+       - string
+       - 
+       - id of the problem being shown
+     * -
+       - `success`
+       - string
+       - correct, incorrect
+       - whether the problem was correct
+     * -  	
+       - `attempts`
+       - integer
+       - number of attempts
+       -
+     * - 
+       - `correct_map`
+       - string/json
+       - 
+       - see details below
+     * - 
+       - `state`
+       - string/json
+       - 
+       - current problem state
+     * - 
+       - `answers`
+       - string/json
+       -
+       - students answers
+     * -
+       - `reset_problem`
+       - problem_id
+       - string
+       - id of the problem being shown
+
+
+`correct_map` details
+---------------------
+
+  .. list-table::
+     :widths: 15 10 15 10
+     :header-rows: 1
+    
+     * - correct_map fields
+       - type
+       - values/format
+       - null allowed?
+     * - hint
+       - string
+       -
+       -
+     * - hintmode
+       - boolean
+       -
+       - yes
+     * - correctness
+       - string
+       - correct, incorrect
+       -
+     * - npoints
+       - integer
+       -
+       - yes
+     * - msg
+       - string
+       -
+       -
+     * - queuestate
+       - string/json
+       - keys: key, time
+       -
+
+
+Browser Events
+==============
+
+  .. list-table::
+     :widths: 10 10 8 12 20 10
+     :header-rows: 1
+  
+     * - event_type
+       - fields
+       - type
+       - values/format
+       - details
+       - example
+     * - `book`
+       - `type`
+       - string
+       - `gotopage`	
+       -
+       -
+     * - 
+       - `old`
+       - integer	
+       - `$PAGE`
+       - from page number
+       - `2`
+     * -
+       - `new`
+       - integer
+       - `$PAGE`
+       - to page number
+       - `25`
+     * - `book`
+       - `type`
+       - string
+       - `nextpage`
+       -
+       -
+     * - 
+       - new
+       - integer
+       - `$PAGE`
+       - next page number
+       - `10`
+     * - `page_close`
+       - *empty*
+       - string
+       -
+       - 'page' field indicates which page was being closed
+       -
+     * - play_video
+       - `id`
+       - string
+       -
+       - edX id of the video being watched
+       - `i4x-HarvardX-PH207x-video-Simple_Random_Sample`
+     * -
+       - code
+       - string
+       -
+       - youtube id of the video being watched
+       - `FU3fCJNs94Y`
+     * -
+       - `currentTime`
+       - float
+       -
+       - time the video was paused at, in seconds
+       - `1.264`
+     * -
+       - `speed`
+       - string
+       - `0.75, 1.0, 1.25, 1.50`
+       - video speed being played
+       - `"1.0"`
+     * - `pause_video`
+       - `id`
+       - string
+       -
+       - edX id of the video being watched
+       -
+     * -
+       - `code`
+       - string
+       -
+       - youtube id of the video being watched
+       -
+     * -
+       - `currentTime`
+       - float
+       -
+       - time the video was paused at
+       -
+     * - 
+       - `speed`
+       - string
+       - `0.75, 1.0, 1.25, 1.50`
+       - video speed being played
+       -
+     * - `problem_check`
+       - *none*
+       - string
+       -
+       - event field contains the values of all input fields from the problem being checked (in the style of GET parameters (`key=value&key=value`))
+       -
+     * - `problem_show`
+       - `problem`
+       - string
+       - 
+       - id of the problem being checked
+       -
+     * - `seq_goto`
+       - `id`
+       - string
+       -
+       - edX id of the sequence
+       -
+     * -	
+       - `old`
+       - integer
+       -
+       - sequence element being jumped from
+       - `3`
+     * -
+       - `new`
+       - integer
+       -
+       - sequence element being jumped to
+       - `5`
+     * - `seq_next`
+       - `id`
+       - string
+       -
+       - edX id of the sequence	
+       -
+     * -	
+       - `old`
+       - integer
+       -
+       - sequence element being jumped from
+       - `4`
+     * -
+       - `new`
+       - integer
+       -
+       - sequence element being jumped to
+       - `6`
+     * - `rubric_select`
+       - `location`
+       - string
+       -
+       - location of the rubric's problem
+       - `i4x://MITx/6.00x/problem/L15:L15_Problem_2`
+     * -
+       - `category`
+       - integer
+       - 
+       - category number of the rubric selection
+       -
+     * -
+       - `value`
+       - integer
+       -
+       - value selected within the category
+       -
+     * - `(oe / peer_grading / staff_grading)`
+         `_show_problem`
+       - `location`
+       - string
+       -
+       - the location of the problem whose prompt we're showing
+       -
+     * - `(oe / peer_grading / staff_grading)`
+         `_hide_problem`
+       - `location`
+       - string
+       - 
+       - the location of the problem whose prompt we're hiding
+       -
+     * - `oe_show_full_feedback`
+       - *empty*
+       -
+       -
+       - the page where they're showing full feedback is already recorded
+       -
+     * - `oe_show_respond_to_feedback`
+       - *empty*
+       -
+       -
+       - the page where they're showing the feedback response form is already recorded
+       -
+     * - `oe_feedback_response_selected`
+       - `value`
+       - integer
+       -
+       - the value selected in the feedback response form
+       -
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+

doc/xml-format.md

-# edX xml format tutorial
-
-## Goals of this document
-
-*	This was written assuming the reader has no prior programming/CS knowledge and has jumped cold turkey into the edX platform.
-*	To educate the reader on how to build and maintain the back end structure of the course content. This is important for debugging and standardization.
-*	After reading this, you should be able to add content to a course and make sure it shows up in the courseware and does not break the code.
-* __Prerequisites:__ it would be helpful to know a little bit about xml.  Here is a [simple example](http://www.ultraslavonic.info/intro-to-xml/) if you've never seen it before.
-
-## Outline
-
-*	First, we will show a sample course structure as a case study/model of how xml and files in a course are organized to introductory understanding.
-
-*	More technical details are below, including discussion of some special cases.
-
-
-## Introduction
-
-*	The course is organized hierarchically.  We start by describing course-wide parameters, then break the course into chapters, and then go deeper and deeper until we reach a specific pset, video, etc.
-
-*	You could make an analogy to finding a green shirt in your house - front door -> bedroom -> closet -> drawer -> shirts -> green shirt
-
-
-## Case Study
-
-Let's jump right in by looking at the directory structure of a very simple toy course:
-
-    toy/
-        course
-        course.xml
-        problem
-        policies
-        roots
-
-The only top level file is `course.xml`, which should contain one line, looking something like this:
-
-    <course org="edX" course="toy" url_name="2012_Fall"/>
-
-This gives all the information to uniquely identify a particular run of any course--which organization is producing the course, what the course name is, and what "run" this is, specified via the `url_name` attribute.
-
-Obviously, this doesn't actually specify any of the course content, so we need to find that next.  To know where to look, you need to know the standard organizational structure of our system: _course elements are uniquely identified by the combination `(category, url_name)`_.  In this case, we are looking for a `course` element with the `url_name` "2012_Fall".  The definition of this element will be in `course/2012_Fall.xml`.  Let's look there next:
-
-`course/2012_Fall.xml`
-
-    <course>
-      <chapter url_name="Overview">
-        <videosequence url_name="Toy_Videos">
-          <problem url_name="warmup"/>
-          <video url_name="Video_Resources" youtube="1.0:1bK-WdDi6Qw"/>
-        </videosequence>
-        <video url_name="Welcome" youtube="1.0:p2Q6BrNhdh8"/>
-      </chapter>
-    </course>
-
-Aha.  Now we found some content.  We can see that the course is organized hierarchically, in this case with only one chapter, with `url_name` "Overview".   The chapter contains a `videosequence` and a `video`, with the sequence containing a problem and another video.  When viewed in the courseware, chapters are shown at the top level of the navigation accordion on the left, with any elements directly included in the chapter below.
-
-Looking at this file, we can see the course structure, and the youtube urls for the videos, but what about the "warmup" problem?  There is no problem content here!    Where should we look?  This is a good time to pause and try to answer that question based on our organizational structure above.
-
-As you hopefully guessed, the problem would be in `problem/warmup.xml`.  (Note: This tutorial doesn't discuss the xml format for problems--there are chapters of edx4edx that describe it.)  This is an instance of a _pointer tag:_ any xml tag with only the category and a url_name attribute will point to the file `{category}/{url_name}.xml`.  For example, this means that our toy `course.xml` could have also been written as
-
-`course/2012_Fall.xml`
-
-    <course>
-      <chapter url_name="Overview"/>
-    </course>
-
-with `chapter/Overview.xml` containing
-
-    <chapter>
-        <videosequence url_name="Toy_Videos">
-          <problem url_name="warmup"/>
-          <video url_name="Video_Resources" youtube="1.0:1bK-WdDi6Qw"/>
-        </videosequence>
-        <video url_name="Welcome" youtube="1.0:p2Q6BrNhdh8"/>
-    </chapter>
-
-In fact, this is the recommended structure for real courses--putting each chapter into its own file makes it easy to have different people work on each without conflicting or having to merge.  Similarly, as sequences get large, it can be handy to split them out as well (in `sequence/{url_name}.xml`, of course).
-
-Note that the `url_name` is only specified once per element--either the inline definition, or in the pointer tag.
-
-## Policy files
-
-We still haven't looked at two of the directoies in the top-level listing above: `policies` and `roots`.  Let's look at policies next.  The policy directory contains one file:
-
-    policies:
-        2012_Fall.json
-
-and that file is named {course-url_name}.json.  As you might expect, this file contains a policy for the course.  In our example, it looks like this:
-
-    2012_Fall.json:
-    {
-        "course/2012_Fall": {
-            "graceperiod": "2 days 5 hours 59 minutes 59 seconds",
-            "start": "2015-07-17T12:00",
-            "display_name": "Toy Course"
-        },
-        "chapter/Overview": {
-            "display_name": "Overview"
-        },
-        "videosequence/Toy_Videos": {
-            "display_name": "Toy Videos",
-            "format": "Lecture Sequence"
-        },
-        "problem/warmup": {
-            "display_name": "Getting ready for the semester"
-        },
-        "video/Video_Resources": {
-            "display_name": "Video Resources"
-        },
-        "video/Welcome": {
-            "display_name": "Welcome"
-        }
-    }
-
-The policy specifies metadata about the content elements--things which are not inherent to the definition of the content, but which describe how the content is presented to the user and used in the course.  See below for a full list of metadata attributes; as the example shows, they include `display_name`, which is what is shown when this piece of content is referenced or shown in the courseware, and various dates and times, like `start`, which specifies when the content becomes visible to students, and various problem-specific parameters like the allowed number of attempts.  One important point is that some metadata is inherited: for example, specifying the start date on the course makes it the default for every element in the course.  See below for more details.
-
-It is possible to put metadata directly in the xml, as attributes of the appropriate tag, but using a policy file has two benefits: it puts all the policy in one place, making it easier to check that things like due dates are set properly, and it allows the content definitions to be easily used in another run of the same course, with the same or similar content, but different policy.
-
-## Roots
-
-The last directory in the top level listing is `roots`.  In our toy course, it contains a single file:
-
-    roots/
-        2012_Fall.xml
-
-This file is identical to the top-level `course.xml`, containing
-
-    <course org="edX" course="toy" url_name="2012_Fall"/>
-
-In fact, the top level `course.xml` is a symbolic link to this file.  When there is only one run of a course, the roots directory is not really necessary, and the top-level course.xml file can just specify the `url_name` of the course.  However, if we wanted to make a second run of our toy course, we could add another file called, e.g., `roots/2013_Spring.xml`, containing
-
-    <course org="edX" course="toy" url_name="2013_Spring"/>
-
-After creating `course/2013_Spring.xml` with the course structure (possibly as a symbolic link or copy of `course/2012_Fall.xml` if no content was changing), and `policies/2013_Spring.json`, we would have two different runs of the toy course in the course repository.  Our build system understands this roots structure, and will build a course package for each root.  (Dev note: if you're using a local development environment, make the top level `course.xml` point to the desired root, and check out the repo multiple times if you need multiple runs simultaneously).
-
-That's basically all there is to the organizational structure.  Read the next section for details on the tags we support, including some special case tags like `customtag` and `html` invariants, and look at the end for some tips that will make the editing process easier.
-
-----------
-
-# Tag types
-
-* `abtest` -- Support for A/B testing.  TODO: add details..
-* `chapter` -- top level organization unit of a course.   The courseware display code currently expects the top level `course` element to contain only chapters, though there is no philosophical reason why this is required, so we may change it to properly display non-chapters at the top level.
-* `conditional` -- conditional element, which shows one or more modules only if certain conditions are satisfied.
-* `course` -- top level tag.  Contains everything else.
-* `customtag` -- render an html template, filling in some parameters, and return the resulting html.  See below for details.
-* `discussion` -- Inline discussion forum
-* `html` -- a reference to an html file.
-* `error`  -- don't put these in by hand :)   The internal representation of content that has an error, such as malformed xml or some broken invariant.  You may see this in the xml once the CMS is in use...
-* `problem` -- a problem.  See elsewhere in edx4edx for documentation on the format.
-* `problemset` -- logically, a series of related problems.  Currently displayed vertically.  May contain explanatory html, videos, etc.
-* `sequential` -- a sequence of content, currently displayed with a horizontal list of tabs.  If possible, use a more semantically meaningful tag (currently, we only have `videosequence`).
-* `vertical` -- a sequence of content, displayed vertically.  Content will be accessed all at once, on the right part of the page. No navigational bar. May have to use browser scroll bars. Content split with separators.   If possible, use a more semantically meaningful tag (currently, we only have `problemset`).
-* `video`  -- a link to a video, currently expected to be hosted on youtube.
-* `videosequence` -- a sequence of videos.  This can contain various non-video content; it just signals to the system that this is logically part of an explanatory sequence of content, as opposed to say an exam sequence.
-
-## Tag details
-
-### Container tags
-
-Container tags include `chapter`, `sequential`, `videosequence`, `vertical`, and `problemset`.  They are all specified in the same way in the xml, as shown in the tutorial above.
-
-### `course`
-
-`course` is also a container, and is similar, with one extra wrinkle: the top level pointer tag _must_ have  `org` and `course` attributes specified--the organization name, and course name.  Note that `course` is referring to the platonic ideal of this course (e.g. "6.002x"), not to any particular run of this course.  The `url_name` should be the particular run of this course.
-
-### `conditional`
-
-`conditional` is as special kind of container tag as well.  Here are two examples:
-
-        <conditional condition="require_completed" required="problem/choiceprob">
-            <video url_name="secret_video" />
-        </conditional>
-
-        <conditional condition="require_attempted" required="problem/choiceprob&problem/sumprob">
-            <html url_name="secret_page" />
-        </conditional>
-
-The condition can be either `require_completed`, in which case the required modules must be completed, or `require_attempted`, in which case the required modules must have been attempted.
-
-The required modules are specified as a set of `tag`/`url_name`, joined by an ampersand.
-
-### `customtag`
-
-When we see `<customtag impl="special" animal="unicorn" hat="blue"/>`, we will:
-
-* look for a file called `custom_tags/special`  in your course dir.
-* render it as a mako template, passing parameters {'animal':'unicorn', 'hat':'blue'}, generating html.  (Google `mako` for template syntax, or look at existing examples).
-
-Since `customtag` is already a pointer, there is generally no need to put it into a separate file--just use it in place: <customtag url_name="my_custom_tag" impl="blah" attr1="..."/>
-
-### `discussion`
-
-The discussion tag embeds an inline discussion module. The XML format is:
-```
-<discussion for="Course overview" id="6002x_Fall_2012_Overview" discussion_category="Week 1 / Overview" />
-``` 
-The meaning of each attribute is as follows:
-* `for`: A string that describes the discussion. Purely for descriptive purposes (to the student).
-* `id`: The identifier that the discussion forum service uses to refer to this inline discussion module. Since the `id` must be unique and lives in a common namespace with all other courses, the preferred convention is to use `<course_name>_<course_run>_<descriptor>` as in the above example. The `id` should be "machine-friendly", e.g. use alphanumeric characters, underscores. Do **not** use a period (e.g. `6.002x_Fall_2012_Overview`).
-* `discussion_category`: The inline module will be indexed in the main "Discussion" tab of the course. The inline discussions are organized into a directory-like hierarchy. Note that the forward slash indicates depth, as in conventional filesytems. In the above example, this discussion module will show up in the following "directory":
-```
-Week 1 / Overview / Course overview
-```
-
-Further discussion on `discussion_category`:
-Note that the `for` tag has been appended to the end of the `discussion_category`. This can often lead into deeply nested subforums, which may not be intended. In the above example, if we were to use instead:
-
-```
-<discussion for="Course overview" id="6002x_Fall_2012_Overview" discussion_category="Week 1" />
-``` 
-
-this discussion module would show up in the main forums as:
-```
-Week 1 / Course overview
-```
-
-which is more succinct.
-
-### `html`
-
-Most of our content is in xml, but some html content may not be proper xml (all tags matched, single top-level tag, etc), since browsers are fairly lenient in what they'll display.  So, there are two ways to include html content:
-
-* If your html content is in a proper xml format, just put it in `html/{url_name}.xml`.
-* If your html content is not in proper xml format, you can put it in `html/{filename}.html`, and put `<html filename={filename} />` in `html/{filename}.xml`.  This allows another level of indirection, and makes sure that we can read the xml file and then just return the actual html content without trying to parse it.
-
-### `video`
-
-Videos have an attribute youtube, which specifies a series of speeds + youtube videos id:
-
-    <video youtube="0.75:1yk1A8-FPbw,1.0:vNMrbPvwhU4,1.25:gBW_wqe7rDc,1.50:7AE_TKgaBwA" url_name="S15V14_Response_to_impulse_limit_case"/>
-
-This video has been encoded at 4 different speeds: 0.75x, 1x, 1.25x, and 1.5x.
-
-## More on `url_name`s
-
-Every content element (within a course) should have a unique id.  This id is formed as `{category}/{url_name}`, or automatically generated from the content if `url_name` is not specified.  Categories are the different tag types ('chapter', 'problem', 'html', 'sequential', etc).  Url_name is a string containing a-z, A-Z, dot (.), underscore (_), and ':'.  This is what appears in urls that point to this object.
-
-Colon (':') is special--when looking for the content definition in an xml, ':' will be replaced with '/'.  This allows organizing content into folders.  For example, given the pointer tag
-
-    <problem url_name="conceptual:add_apples_and_oranges"/>
-
-we would look for the problem definition in `problem/conceptual/add_apples_and_oranges.xml`.   (There is a technical reason why we can't just allow '/' in the url_name directly.)
-
-__IMPORTANT__: A student's state for a particular content element is tied to the element id, so the automatic id generation if only ok for elements that do not need to store any student state (e.g. verticals or customtags).  For problems, sequentials, and videos, and any other element where we keep track of what the student has done and where they are at, you should specify a unique `url_name`.  Of course, any content element that is split out into a file will need a `url_name` to specify where to find the definition.  When the CMS comes online, it will use these ids to enable content reuse, so if there is a logical name for something, please do specify it.
-
------
-
-## Policy files
-
-*	A policy file is useful when running different versions of a course e.g. internal, external, fall, spring, etc. as you can change due dates, etc, by creating multiple policy files.
-*	A policy file provides information on the metadata of the course--things that are not inherent to the definitions of the contents, but that may vary from run to run.
-* Note: We will be expanding our understanding and format for metadata in the not-too-distant future, but for now it is simply a set of key-value pairs.
-
-### Policy file location
-* The policy for a course run `some_url_name` should live in `policies/some_url_name/policy.json`  (NOTE: the old format of putting it in `policies/some_url_name.json` will also work, but we suggest using the subdirectory to have all the per-course policy files in one place)
-* Grading policy files go in `policies/some_url_name/grading_policy.json`   (if there's only one course run, can also put it directly in the course root: `/grading_policy.json`)
-
-### Policy file contents
-* The file format is "json", and is best shown by example, as in the tutorial above (though also feel free to google :)
-* The expected contents are a dictionary mapping from keys to values (syntax "{ key : value, key2 : value2, etc}")
-* Keys are in the form "{category}/{url_name}", which should uniquely identify a content element.
-Values are dictionaries of the form {"metadata-key" : "metadata-value"}.
-* The order in which things appear does not matter, though it may be helpful to organize the file in the same order as things appear in the content.
-* NOTE: json is picky about commas.  If you have trailing commas before closing braces, it will complain and refuse to parse the file.  This can be irritating at first.
-
-Supported fields at the course level:
-
-* "start" -- specify the start date for the course.  Format-by-example: "2012-09-05T12:00".
-* "advertised_start" -- specify what you want displayed as the start date of the course in the course listing and course about pages. This can be useful if you want to let people in early before the formal start. Format-by-example: "2012-09-05T12:00".
-* "disable_policy_graph" -- set to true (or "Yes"), if the policy graph should be disabled (ie not shown).
-* "enrollment_start", "enrollment_end" -- when can students enroll?  (if not specified, can enroll anytime).   Same format as "start".
-* "end" -- specify the end date for the course.  Format-by-example: "2012-11-05T12:00".
-* "end_of_course_survey_url" -- a url for an end of course survey -- shown after course is over, next to certificate download links.
-* "tabs" -- have custom tabs in the courseware.  See below for details on config.
-* "discussion_blackouts" -- An array of time intervals during which you want to disable a student's ability to create or edit posts in the forum. Moderators, Community TAs, and Admins are unaffected. You might use this during exam periods, but please be aware that the forum is often a very good place to catch mistakes and clarify points to students. The better long term solution would be to have better flagging/moderation mechanisms, but this is the hammer we have today. Format by example: [["2012-10-29T04:00", "2012-11-03T04:00"], ["2012-12-30T04:00", "2013-01-02T04:00"]]
-* "show_calculator" (value "Yes" if desired)
-* "days_early_for_beta" -- number of days (floating point ok) early that students in the beta-testers group get to see course content.  Can also be specified for any other course element, and overrides values set at higher levels.
-* "cohort_config" : dictionary with keys 
-    - "cohorted" : boolean.  Set to true if this course uses student cohorts.  If so, all inline discussions are automatically cohorted, and top-level discussion topics are configurable via the cohorted_discussions list. Default is not cohorted).
-    - "cohorted_discussions": list of discussions that should be cohorted.  Any not specified in this list are not cohorted.
-    - "auto_cohort": Truthy.
-    - "auto_cohort_groups": ["group name 1", "group name 2", ...]
-    - If cohorted and auto_cohort is true, automatically put each student into a random group from the auto_cohort_groups list, creating the group if needed.  
-
-* TODO: there are others
-
-### Grading policy file contents
-
-TODO: This needs to be improved, but for now here's a sketch of how grading works:
-
-
-* First we grade on individual problems. Correct and total are methods on CapaProblem.
-
-    `problem_score = (correct ,  total)`
-
-* If a problem weight is in the xml, then re-weight the problem to be worth that many points
-
-    `if problem_weight:`
-         `problem_score = (correct * weight / total, weight)`
-
-* Now sum up all of problems in a section to get the percent for that section
-
-    `section_percent = \sum_problems_correct /   \sum_problems_total`
-
-* Now we have all of the percents for all of the graded sections. This is the gradesheet that we pass to to a subclass of CourseGrader.
-
-* A WeightedSubsectionsGrader contains several SingleSectionGraders and AssignmentFormatGraders. Each of those graders is run first before WeightedSubsectionsGrader computes the final grade.
-
-    - SingleSectionGrader (within a WeightedSubsectionsGrader) contains one section
-
-    `grader_percent = section_percent`
-
-    - AssignmentFormatGrader (within a WegithedSubsectionsGrader) contains multiple sections matching a certain format
-drop the lowest X sections
-
-    `grader_percent = \sum_section_percent  /  \count_section`
-
-    - WeightedSubsectionsGrader
-
-    `final_grade_percent = \sum_(grader_percent * grader_weight)`
-
-* Round the final grade up to the nearest percentage point
-
-    `final_grade_percent = round(final_grade_percent * 100 + 0.05) / 100`
-
-### Available metadata
-
-__Not inherited:__
-
-* `display_name` - name that will appear when this content is displayed in the courseware.  Useful for all tag types.
-*	`format` - subheading under display name -- currently only displayed for chapter sub-sections.  Also used by the the grader to know how to process students assessments that the
-    section contains. New formats can be defined as a 'type' in the GRADER variable in course_settings.json. Optional.  (TODO: double check this--what's the current behavior?)
-* `hide_from_toc` -- If set to true for a chapter or chapter subsection, will hide that element from the courseware navigation accordion.  This is useful if you'd like to link to the content directly instead (e.g. for tutorials)
-* `ispublic` -- specify whether the course is public.  You should be able to use start dates instead (?)
-
-__Inherited:__
-
-* `start` -- when this content should be shown to students.  Note that anyone with staff access to the course will always see everything.
-*	`showanswer` - When to show answer. For 'attempted', will show answer after first attempt. Values: never, attempted, answered, closed. Default: closed. Optional.
-*	`graded` - Whether this section will count towards the students grade. "true" or "false". Defaults to "false".
-*	`rerandomize` - Randomize question on each attempt. Values: 'always' (students see a different version of the problem after each attempt to solve it)
-                                                            'onreset' (randomize question when reset button is pressed by the student)
-                                                            'never' (all students see the same version of the problem)
-                                                            'per_student' (individual students see the same version of the problem each time the look at it, but that version is different from what other students see)
-                                                            Default: 'always'. Optional.
-*	`due` - Due date for assignment. Assignment will be closed after that.  Values: valid date. Default: none. Optional.
-* attempts: Number of allowed attempts. Values: integer. Default: infinite. Optional.
-* `graceperiod` - A default length of time that the problem is still accessible after the due date in the format "2 days 3 hours" or "1 day 15 minutes".  Note, graceperiods are currently the easiest way to handle time zones. Due dates are all expressed in UCT.
-* `xqa_key` -- for integration with Ike's content QA server. -- should typically be specified at the course level.
-
-__Inheritance example:__
-
-This is a sketch ("tue" is not a valid start date), that should help illustrate how metadata inheritance works.
-
-    <course start="tue">
-      <chap1> -- start tue
-        <problem>   --- start tue
-      </chap1>
-      <chap2 start="wed">  -- start wed
-       <problem2 start="thu">  -- start thu
-       <problem3>      -- start wed
-      </chap2>
-    </course>
-
-
-## Specifying metadata in the xml file
-
-Metadata can also live in the xml files, but anything defined in the policy file overrides anything in the xml.  This is primarily for backwards compatibility, and you should probably  not use both.  If you do leave some metadata tags in the xml, you should be consistent (e.g. if `display_name`s stay in xml, they should all stay in xml. Note `display_name` should be specified in the problem xml definition itself, ie, <problem display_name="Title"> Problem Text </problem>, in file ProblemFoo.xml).
-   - note, some xml attributes are not metadata.  e.g. in `<video youtube="xyz987293487293847"/>`, the `youtube` attribute specifies what video this is, and is logically part of the content, not the policy, so it should stay in the xml.
-
-Another example policy file:
-
-    {
-        "course/2012": {
-            "graceperiod": "1 day",
-            "start": "2012-10-15T12:00",
-            "display_name": "Introduction to Computer Science I",
-            "xqa_key": "z1y4vdYcy0izkoPeihtPClDxmbY1ogDK"
-        },
-        "chapter/Week_0": {
-            "display_name": "Week 0"
-        },
-        "sequential/Pre-Course_Survey": {
-            "display_name": "Pre-Course Survey",
-            "format": "Survey"
-        }
-    }
-
-
-
-## Deprecated formats
-
-If you look at some older xml, you may see some tags or metadata attributes that aren't listed above.  They are deprecated, and should not be used in new content.  We include them here so that you can understand how old-format content works.
-
-### Obsolete tags:
-
-* `section` : this used to be necessary within chapters.  Now, you can just use any standard tag inside a chapter, so use the container tag that makes the most sense for grouping content--e.g. `problemset`, `videosequence`, and just include content directly if it belongs inside a chapter (e.g. `html`, `video`, `problem`)
-
-* There used to be special purpose tags that all basically did the same thing, and have been subsumed by `customtag`.  The list is `videodev, book, slides, image, discuss`.  Use `customtag` in new content.  (e.g. instead of `<book page="12"/>`, use `<customtag impl="book" page="12"/>`)
-
-### Obsolete attributes
-
-* `slug` -- old term for `url_name`.  Use `url_name`
-* `name` -- we didn't originally have a distinction between `url_name` and `display_name` -- this made content element ids fragile, so please use `url_name` as a stable unique identifier for the content, and `display_name` as the particular string you'd like to display for it.
-
-
-# Static links
-
-If your content links (e.g. in an html file)  to `"static/blah/ponies.jpg"`, we will look for this...
-
-* If your course dir has a `static/` subdirectory, we will look in `YOUR_COURSE_DIR/static/blah/ponies.jpg`.   This is the prefered organization, as it does not expose anything except what's in `static/` to the world.
-*  If your course dir does not have a `static/` subdirectory, we will look in `YOUR_COURSE_DIR/blah/ponies.jpg`.  This is the old organization, and requires that the web server allow access to everything in the couse dir.  To switch to the new organization, move all your static content into a new `static/` dir  (e.g. if you currently have things in `images/`, `css/`, and `special/`, create a dir called `static/`, and move `images/, css/, and special/` there).
-
-Links that include `/course` will be rewritten to the root of your course in the courseware (e.g. `courses/{org}/{course}/{url_name}/` in the current url structure).  This is useful for linking to the course wiki, for example.
-
-# Tabs
-
-If you want to customize the courseware tabs displayed for your course, specify a "tabs" list in the course-level policy.  e.g.:
-
-    "tabs" : [
-        {"type": "courseware"},       # no name--always "Courseware" for consistency between courses
-        {"type": "course_info", "name": "Course Info"},
-        {"type": "external_link", "name": "My Discussion", "link": "http://www.mydiscussion.org/blah"},
-        {"type": "progress", "name": "Progress"},
-        {"type": "wiki", "name": "Wonderwiki"},
-        {"type": "static_tab", "url_slug": "news", "name": "Exciting news"},
-        {"type": "textbooks"}        # generates one tab per textbook, taking names from the textbook titles
-    ]
-
-
-* If you specify any tabs, you must specify all tabs.  They will appear in the order given.
-* The first two tabs must have types `"courseware"` and `"course_info"`, in that order.  Otherwise, we'll refuse to load the course.
-* for static tabs, the url_slug will be the url that points to the tab.  It can not be one of the existing courseware url types (even if those aren't used in your course).  The static content will come from `tabs/{course_url_name}/{url_slug}.html`, or `tabs/{url_slug}.html` if that doesn't exist.
-
-* An Instructor tab will be automatically added at the end for course staff users.
-
-## Supported tab types:
-
-* "courseware".  No other parameters.
-* "course_info".  Parameter "name".
-* "wiki". Parameter "name".
-* "discussion".  Parameter "name".
-* "external_link".  Parameters "name", "link".
-* "textbooks".  No parameters--generates tab names from book titles.
-* "progress".  Parameter "name".
-* "static_tab".  Parameters "name", 'url_slug'--will look for tab contents in
-                       'tabs/{course_url_name}/{tab url_slug}.html'
-* "staff_grading". No parameters.  If specified, displays the staff grading tab for instructors.
-
-
-# Tips for content developers
-
-* We will be making better tools for managing policy files soon.  In the meantime, you can add dummy definitions to make it easier to search and separate the file visually.  For example, you could add:
-
-    "WEEK 1" : "##################################################",
-
-before the week 1 material to make it easy to find in the file.
-
-* Come up with a consistent pattern for url_names, so that it's easy to know where to look for any piece of content.  It will also help to come up with a standard way of splitting your content files.  As a point of departure, we suggest splitting chapters, sequences, html, and problems into separate files.
-
-* Prefer the most "semantic" name for containers: e.g., use problemset rather than sequential for a problem set.  That way, if we decide to display problem sets differently, we don't have to change the xml.
-
-# Other file locations (info and about)
-
-With different course runs, we may want different course info and about materials.  This is now supported by putting files in as follows:
-
-    / 
-      about/
-           foo.html      -- shared default for all runs
-           url_name1/
-                foo.html   -- version used for url_name1
-                bar.html   -- bar for url_name1
-           url_name2/
-                bar.html   -- bar for url_name2
-                           -- url_name2 will use default foo.html
-
-and the same works for the `info` directory.
-
-----
-
-(Dev note: This file is generated from the mitx repo, in `doc/xml-format.md`.  Please make edits there.)

lms/djangoapps/instructor/views.py

@@ -195,7 +195,7 @@ def instructor_dashboard(request, course_id):
         track.views.server_track(request, 'dump-answer-dist-csv', {}, page='idashboard')
         return return_csv('answer_dist_{0}.csv'.format(course_id), get_answers_distribution(request, course_id))
 
-    elif "Reset student's attempts" in action:
+    elif "Reset student's attempts" in action or "Delete student state for problem" in action:
         # get the form data
         unique_student_identifier = request.POST.get('unique_student_identifier', '')
         problem_to_reset = request.POST.get('problem_to_reset', '')
@@ -226,28 +226,36 @@ def instructor_dashboard(request, course_id):
             except Exception as e:
                 msg += "<font color='red'>Couldn't find module with that urlname.  </font>"
 
-        # modify the problem's state
-        try:
-            # load the state json
-            problem_state = json.loads(module_to_reset.state)
-            old_number_of_attempts = problem_state["attempts"]
-            problem_state["attempts"] = 0
-
-            # save
-            module_to_reset.state = json.dumps(problem_state)
-            module_to_reset.save()
-            track.views.server_track(request,
-                                    '{instructor} reset attempts from {old_attempts} to 0 for {student} on problem {problem} in {course}'.format(
-                                        old_attempts=old_number_of_attempts,
-                                        student=student_to_reset,
-                                        problem=module_to_reset.module_state_key,
-                                        instructor=request.user,
-                                        course=course_id),
-                                    {},
-                                    page='idashboard')
-            msg += "<font color='green'>Module state successfully reset!</font>"
-        except:
-            msg += "<font color='red'>Couldn't reset module state.  </font>"
+        if "Delete student state for problem" in action:
+            # delete the state
+            try:
+                module_to_reset.delete()
+                msg += "<font color='red'>Deleted student module state for %s!</font>" % module_state_key
+            except:
+                msg += "Failed to delete module state for %s/%s" % (unique_student_identifier, problem_to_reset)
+        else:
+            # modify the problem's state
+            try:
+                # load the state json
+                problem_state = json.loads(module_to_reset.state)
+                old_number_of_attempts = problem_state["attempts"]
+                problem_state["attempts"] = 0
+
+                # save
+                module_to_reset.state = json.dumps(problem_state)
+                module_to_reset.save()
+                track.views.server_track(request,
+                                        '{instructor} reset attempts from {old_attempts} to 0 for {student} on problem {problem} in {course}'.format(
+                                            old_attempts=old_number_of_attempts,
+                                            student=student_to_reset,
+                                            problem=module_to_reset.module_state_key,
+                                            instructor=request.user,
+                                            course=course_id),
+                                        {},
+                                        page='idashboard')
+                msg += "<font color='green'>Module state successfully reset!</font>"
+            except:
+                msg += "<font color='red'>Couldn't reset module state.  </font>"
 
 
     elif "Get link to student's progress page" in action:

lms/djangoapps/staticbook/views.py

@@ -52,13 +52,18 @@ def pdf_index(request, course_id, book_index, chapter=None, page=None):
         # strip off the quotes again...
         return output_url[1:-1]
 
-    textbook['url'] = remap_static_url(textbook['url'], course)
+    if 'url' in textbook:
+        textbook['url'] = remap_static_url(textbook['url'], course)
     # then remap all the chapter URLs as well, if they are provided.
-    
+    if 'chapters' in textbook:
+        for entry in textbook['chapters']:
+            entry['url'] = remap_static_url(entry['url'], course)            
+
+
     return render_to_response('static_pdfbook.html',
                               {'book_index': book_index, 
                                'course': course, 
                                'textbook': textbook,
-                               'page': page,
                                'chapter': chapter,
+                               'page': page,
                                'staff_access': staff_access})

lms/static/coffee/src/staff_grading/staff_grading.coffee

@@ -183,6 +183,8 @@ class @StaffGrading
 
     @breadcrumbs = $('.breadcrumbs')
 
+
+    $(window).keydown @keydown_handler
     @question_header = $('.question-header')
     @question_header.click @collapse_question
     @collapse_question()
@@ -219,7 +221,7 @@ class @StaffGrading
 
   setup_score_selection: =>
     @score_selection_container.html(@rubric)
-    $('.score-selection').click => @graded_callback()
+    $('input[class="score-selection"]').change => @graded_callback()
     Rubric.initialize(@location)
 
 
@@ -229,6 +231,10 @@ class @StaffGrading
       @state = state_graded
       @submit_button.show()
 
+  keydown_handler: (e) =>
+    if e.which == 13 && !@list_view && Rubric.check_complete()
+      @submit_and_get_next()
+
   set_button_text: (text) =>
     @action_button.attr('value', text)
 

lms/static/sass/course/_textbook.scss

@@ -102,6 +102,7 @@ div.book-wrapper {
           position: absolute;
           height: 100%;
           width: flex-grid(2, 8);
+          z-index: 1;
 
           a {
             background-color: rgba(#000, .7);

lms/templates/courseware/instructor_dashboard.html

@@ -149,6 +149,12 @@ function goto( mode)
     <p><input type="text" name="unique_student_identifier">  <input type="submit" name="action" value="Get link to student's progress page"></p>
     <p>and, if you want to reset the number of attempts for a problem, the urlname of that problem</p>
     <p> <input type="text" name="problem_to_reset"> <input type="submit" name="action" value="Reset student's attempts">  </p>
+
+    %if instructor_access:
+    <p> You may also delete the entire state of a student for a problem:
+    <input type="submit" name="action" value="Delete student state for problem">  </p>
+    %endif
+
  %endif
 
 ##----------------------------------------------------------------------------- 

lms/templates/index.html

@@ -122,7 +122,7 @@
             <a href="${reverse('university_profile', args=['TorontoX'])}">
               <img src="${static.url('images/university/toronto/toronto.png')}" />
               <div class="name">
-                <span>TorontoX</span>
+                <span>University of TorontoX</span>
               </div>
             </a>
           </li>

lms/templates/static_pdfbook.html

@@ -17,37 +17,39 @@
 <%block name="js_extra">
   <script type="text/javascript">
 
-    var url = "${textbook['url']}";
-
     $(document).ready(function() {
-        $('#outerContainer').PDFViewer( { 
-            % if page is not None:
-            'pageNum' : ${page},
-            % endif
-            'url' : url
-        });
+        var options = {};
+        %if 'url' in textbook:
+            options.url = "${textbook['url']}";
+        %endif
+        %if 'chapters' in textbook:
+            var chptrs = [];
+            %for chap in textbook['chapters']:
+                chptrs.push("${chap['url']}");
+            %endfor
+            options.chapters = chptrs;
+        %endif
+        %if chapter is not None:
+            options.chapterNum = ${chapter};
+        %endif
+        %if page is not None:
+            options.pageNum = ${page};
+        %endif
+    
+        $('#outerContainer').PDFViewer(options);
     });
   </script>  
 </%block>
 
 <%include file="/courseware/course_navigation.html" args="active_page='pdftextbook/{0}'.format(book_index)" />
 
-
     <div id="outerContainer">
-      <div id="mainContainer">
+      <div id="mainContainer" class="book-wrapper">
+
         <div class="toolbar">
           <div id="toolbarContainer">
             <div id="toolbarViewer">
               <div id="toolbarViewerLeft">
-                <div class="splitToolbarButton">
-                  <button class="toolbarButton pageUp" title="Previous Page" id="previous" tabindex="5">
-                    <span>Previous</span>
-                  </button>
-                  <div class="splitToolbarButtonSeparator"></div>
-                  <button class="toolbarButton pageDown" title="Next Page" id="next" tabindex="6">
-                    <span>Next</span>
-                  </button>
-                </div>
                 <label id="pageNumberLabel" class="toolbarLabel" for="pageNumber">Page: </label>
                 <input type="number" id="pageNumber" class="toolbarField pageNumber" value="1" size="4" min="1" tabindex="7">
                 </input>
@@ -88,7 +90,38 @@
           </div>
         </div>
 
-        <div id="viewerContainer">
+%if 'chapters' in textbook:
+    <section aria-label="Textbook Navigation" class="book-sidebar">
+
+      <ul id="booknav" class="treeview-booknav">
+          <%def name="print_entry(entry, index_value)">
+              <li id="pdfchapter-${index_value}">
+                <a class="chapter">
+                  ${entry.get('title')}
+                </a>
+              </li>
+          </%def>
+
+          % for (index, entry) in enumerate(textbook['chapters']):
+            ${print_entry(entry, index+1)}
+          % endfor
+      </ul>
+    </section>
+%endif
+
+        <section id="viewerContainer" class="book">
+	  <!-- use same page-turning as used in image-based textbooks -->
+          <nav>
+            <ul>
+              <li class="last">
+                <a id="previous">Previous page</a>
+              </li>
+              <li class="next">
+                <a id="next">Next page</a>
+              </li>
+            </ul>
+          </nav>
+
           <div id="viewer" contextmenu="viewerContextMenu"></div>
         </div>
 

lms/templates/university_profile/torontox.html

 <%inherit file="base.html" />
 <%namespace name='static' file='../static_content.html'/>
 
-<%block name="title"><title>TorontoX</title></%block>
+<%block name="title"><title>University of TorontoX</title></%block>
 
 <%block name="university_header">
   <header class="search" style="background: url('/static/images/university/toronto/toronto-cover.jpg')">
@@ -10,7 +10,7 @@
         <div class="logo">
            <img src="${static.url('images/university/toronto/toronto.png')}" />
         </div>
-        <h1>TorontoX</h1>
+        <h1>University of TorontoX</h1>
       </hgroup>
     </div>
   </header>

lms/urls.py

@@ -280,11 +280,10 @@ if settings.COURSEWARE_ENABLED:
         url(r'^courses/(?P<course_id>[^/]+/[^/]+/[^/]+)/pdfbook/(?P<book_index>[^/]*)/(?P<page>[^/]*)$',
             'staticbook.views.pdf_index'),
 
-# Doesn't yet support loading individual chapters...
-#        url(r'^courses/(?P<course_id>[^/]+/[^/]+/[^/]+)/pdfbook/(?P<book_index>[^/]*)/chapter/(?P<chapter>[^/]*)/$',
-#            'staticbook.views.pdf_index'),
-#        url(r'^courses/(?P<course_id>[^/]+/[^/]+/[^/]+)/pdfbook/(?P<book_index>[^/]*)/chapter/(?P<chapter>[^/]*)/(?P<page>[^/]*)$',
-#            'staticbook.views.pdf_index'),
+        url(r'^courses/(?P<course_id>[^/]+/[^/]+/[^/]+)/pdfbook/(?P<book_index>[^/]*)/chapter/(?P<chapter>[^/]*)/$',
+            'staticbook.views.pdf_index'),
+        url(r'^courses/(?P<course_id>[^/]+/[^/]+/[^/]+)/pdfbook/(?P<book_index>[^/]*)/chapter/(?P<chapter>[^/]*)/(?P<page>[^/]*)$',
+            'staticbook.views.pdf_index'),
 
         url(r'^courses/(?P<course_id>[^/]+/[^/]+/[^/]+)/courseware/?$',
             'courseware.views.index', name="courseware"),