194 lines
9.9 KiB
HTML
194 lines
9.9 KiB
HTML
|
|
|
|
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
|
|
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
|
|
|
|
|
|
<html xmlns="http://www.w3.org/1999/xhtml">
|
|
<head>
|
|
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
|
|
|
|
<title>edX Data Documentation — edX Data 0.1 documentation</title>
|
|
|
|
<link rel="stylesheet" href="_static/sphinxdoc.css" type="text/css" />
|
|
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
|
|
|
|
<script type="text/javascript">
|
|
var DOCUMENTATION_OPTIONS = {
|
|
URL_ROOT: '',
|
|
VERSION: '0.1',
|
|
COLLAPSE_INDEX: false,
|
|
FILE_SUFFIX: '.html',
|
|
HAS_SOURCE: true
|
|
};
|
|
</script>
|
|
<script type="text/javascript" src="_static/jquery.js"></script>
|
|
<script type="text/javascript" src="_static/underscore.js"></script>
|
|
<script type="text/javascript" src="_static/doctools.js"></script>
|
|
<script type="text/javascript" src="http://cdn.mathjax.org/mathjax/latest/MathJax.js?config=TeX-AMS-MML_HTMLorMML"></script>
|
|
<link rel="top" title="edX Data 0.1 documentation" href="#" />
|
|
<link rel="next" title="Course XML Tutorial" href="course_data_formats/course_xml.html" />
|
|
</head>
|
|
<body>
|
|
<div class="related">
|
|
<h3>Navigation</h3>
|
|
<ul>
|
|
<li class="right" style="margin-right: 10px">
|
|
<a href="genindex.html" title="General Index"
|
|
accesskey="I">index</a></li>
|
|
<li class="right" >
|
|
<a href="py-modindex.html" title="Python Module Index"
|
|
>modules</a> |</li>
|
|
<li class="right" >
|
|
<a href="course_data_formats/course_xml.html" title="Course XML Tutorial"
|
|
accesskey="N">next</a> |</li>
|
|
<li><a href="#">edX Data 0.1 documentation</a> »</li>
|
|
</ul>
|
|
</div>
|
|
<div class="sphinxsidebar">
|
|
<div class="sphinxsidebarwrapper">
|
|
<h3><a href="#">Table Of Contents</a></h3>
|
|
<ul>
|
|
<li><a class="reference internal" href="#">edX Data Documentation</a><ul>
|
|
<li><a class="reference internal" href="#course-data-formats">Course Data Formats</a><ul>
|
|
<li><a class="reference internal" href="#specific-problem-types">Specific Problem Types</a><ul>
|
|
</ul>
|
|
</li>
|
|
</ul>
|
|
</li>
|
|
<li><a class="reference internal" href="#internal-data-formats">Internal Data Formats</a><ul>
|
|
</ul>
|
|
</li>
|
|
</ul>
|
|
</li>
|
|
<li><a class="reference internal" href="#indices-and-tables">Indices and tables</a></li>
|
|
</ul>
|
|
|
|
<h4>Next topic</h4>
|
|
<p class="topless"><a href="course_data_formats/course_xml.html"
|
|
title="next chapter">Course XML Tutorial</a></p>
|
|
<h3>This Page</h3>
|
|
<ul class="this-page-menu">
|
|
<li><a href="_sources/index.txt"
|
|
rel="nofollow">Show Source</a></li>
|
|
</ul>
|
|
<div id="searchbox" style="display: none">
|
|
<h3>Quick search</h3>
|
|
<form class="search" action="search.html" method="get">
|
|
<input type="text" name="q" />
|
|
<input type="submit" value="Go" />
|
|
<input type="hidden" name="check_keywords" value="yes" />
|
|
<input type="hidden" name="area" value="default" />
|
|
</form>
|
|
<p class="searchtip" style="font-size: 90%">
|
|
Enter search terms or a module, class or function name.
|
|
</p>
|
|
</div>
|
|
<script type="text/javascript">$('#searchbox').show(0);</script>
|
|
</div>
|
|
</div>
|
|
|
|
<div class="document">
|
|
<div class="documentwrapper">
|
|
<div class="bodywrapper">
|
|
<div class="body">
|
|
|
|
<div class="section" id="edx-data-documentation">
|
|
<h1>edX Data Documentation<a class="headerlink" href="#edx-data-documentation" title="Permalink to this headline">¶</a></h1>
|
|
<p>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.</p>
|
|
<div class="section" id="course-data-formats">
|
|
<h2>Course Data Formats<a class="headerlink" href="#course-data-formats" title="Permalink to this headline">¶</a></h2>
|
|
<p>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.</p>
|
|
<div class="toctree-wrapper compound">
|
|
<ul>
|
|
<li class="toctree-l1"><a class="reference internal" href="course_data_formats/course_xml.html">Course XML Tutorial</a><ul>
|
|
<li class="toctree-l2"><a class="reference internal" href="course_data_formats/course_xml.html#goals">Goals</a></li>
|
|
<li class="toctree-l2"><a class="reference internal" href="course_data_formats/course_xml.html#introduction">Introduction</a></li>
|
|
<li class="toctree-l2"><a class="reference internal" href="course_data_formats/course_xml.html#case-study">Case Study</a></li>
|
|
<li class="toctree-l2"><a class="reference internal" href="course_data_formats/course_xml.html#tags">Tags</a></li>
|
|
<li class="toctree-l2"><a class="reference internal" href="course_data_formats/course_xml.html#id1">Policy Files</a></li>
|
|
<li class="toctree-l2"><a class="reference internal" href="course_data_formats/course_xml.html#static-links">Static links</a></li>
|
|
<li class="toctree-l2"><a class="reference internal" href="course_data_formats/course_xml.html#tabs">Tabs</a></li>
|
|
<li class="toctree-l2"><a class="reference internal" href="course_data_formats/course_xml.html#other-file-locations-info-and-about">Other file locations (info and about)</a></li>
|
|
<li class="toctree-l2"><a class="reference internal" href="course_data_formats/course_xml.html#tips-for-content-developers">Tips for content developers</a></li>
|
|
</ul>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="course_data_formats/grading.html">Course Grading</a><ul>
|
|
<li class="toctree-l2"><a class="reference internal" href="course_data_formats/grading.html#totaling-sections">Totaling sections</a></li>
|
|
<li class="toctree-l2"><a class="reference internal" href="course_data_formats/grading.html#weighting-problems">Weighting Problems</a></li>
|
|
<li class="toctree-l2"><a class="reference internal" href="course_data_formats/grading.html#weighting-sections">Weighting Sections</a></li>
|
|
<li class="toctree-l2"><a class="reference internal" href="course_data_formats/grading.html#displaying-the-final-grade">Displaying the final grade</a></li>
|
|
</ul>
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
<div class="section" id="specific-problem-types">
|
|
<h3>Specific Problem Types<a class="headerlink" href="#specific-problem-types" title="Permalink to this headline">¶</a></h3>
|
|
<div class="toctree-wrapper compound">
|
|
<ul>
|
|
<li class="toctree-l1"><a class="reference internal" href="course_data_formats/drag_and_drop/drag_and_drop_input.html">XML format of drag and drop input [inputtypes]</a></li>
|
|
<li class="toctree-l1"><a class="reference internal" href="course_data_formats/graphical_slider_tool/graphical_slider_tool.html">XML format of graphical slider tool [xmodule]</a></li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
<div class="section" id="internal-data-formats">
|
|
<h2>Internal Data Formats<a class="headerlink" href="#internal-data-formats" title="Permalink to this headline">¶</a></h2>
|
|
<p>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.</p>
|
|
<div class="toctree-wrapper compound">
|
|
<ul>
|
|
<li class="toctree-l1"><a class="reference internal" href="internal_data_formats/sql_schema.html">Student Info and Progress Data</a><ul>
|
|
<li class="toctree-l2"><a class="reference internal" href="internal_data_formats/sql_schema.html#user-information">User Information</a></li>
|
|
<li class="toctree-l2"><a class="reference internal" href="internal_data_formats/sql_schema.html#courseware-progress">Courseware Progress</a></li>
|
|
<li class="toctree-l2"><a class="reference internal" href="internal_data_formats/sql_schema.html#certificates">Certificates</a></li>
|
|
</ul>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="internal_data_formats/discussion_data.html">Discussion Forums Data</a><ul>
|
|
<li class="toctree-l2"><a class="reference internal" href="internal_data_formats/discussion_data.html#shared-attributes">Shared Attributes</a></li>
|
|
<li class="toctree-l2"><a class="reference internal" href="internal_data_formats/discussion_data.html#commentthread">CommentThread</a></li>
|
|
<li class="toctree-l2"><a class="reference internal" href="internal_data_formats/discussion_data.html#comment">Comment</a></li>
|
|
</ul>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="internal_data_formats/tracking_logs.html">Tracking Logs</a><ul>
|
|
<li class="toctree-l2"><a class="reference internal" href="internal_data_formats/tracking_logs.html#common-fields">Common Fields</a></li>
|
|
<li class="toctree-l2"><a class="reference internal" href="internal_data_formats/tracking_logs.html#event-sources">Event Sources</a></li>
|
|
</ul>
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
<div class="section" id="indices-and-tables">
|
|
<h1>Indices and tables<a class="headerlink" href="#indices-and-tables" title="Permalink to this headline">¶</a></h1>
|
|
<ul class="simple">
|
|
<li><a class="reference internal" href="search.html"><em>Search Page</em></a></li>
|
|
</ul>
|
|
</div>
|
|
|
|
|
|
</div>
|
|
</div>
|
|
</div>
|
|
<div class="clearer"></div>
|
|
</div>
|
|
<div class="related">
|
|
<h3>Navigation</h3>
|
|
<ul>
|
|
<li class="right" style="margin-right: 10px">
|
|
<a href="genindex.html" title="General Index"
|
|
>index</a></li>
|
|
<li class="right" >
|
|
<a href="py-modindex.html" title="Python Module Index"
|
|
>modules</a> |</li>
|
|
<li class="right" >
|
|
<a href="course_data_formats/course_xml.html" title="Course XML Tutorial"
|
|
>next</a> |</li>
|
|
<li><a href="#">edX Data 0.1 documentation</a> »</li>
|
|
</ul>
|
|
</div>
|
|
<div class="footer">
|
|
© Copyright 2013, edX Team.
|
|
Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> 1.1.3.
|
|
</div>
|
|
</body>
|
|
</html> |