Files
edx-platform/docs/en_us/olx/source/example-course/insider-course-xml.rst
2014-10-28 11:53:40 -04:00

86 lines
2.9 KiB
ReStructuredText

.. _The edX-Insider course.xml File:
###################################
The edX-Insider ``course.xml`` File
###################################
The courseware for `edX-Insider`_ is defined in the `course.xml`_ file and
follows the organization described in :ref:`The Courseware Structure`.
See:
* `edX-Insider Course Hierarchy`_
* `Sequentials that Contain XBlocks`_
*****************************
edX-Insider Course Hierarchy
*****************************
The edX-Insider courseware is organized into chapters, sequentials, and
verticals.
For example, the following XML defines the first chapter, sequential, and
vertical in the course:
.. code-block:: xml
<chapter display_name="Pedagogical Foundations: Constructive Learning"
url_name="Week_2_Technology_enabled_constructive_learning">
<sequential format="Learning Sequence" graded="true"
display_name="Overview (go here first)"
url_name="Overview_go_here_first">
<vertical display_name="Week's overview" url_name="Week_s_overview">
<html display_name="Week overview" filename="Week_overview"
url_name="Week_overview"/>
<done display_name="Read week overview"
url_name="Read_week_overview" align="right"/>
The vertical ``Week's Overview`` contains an HTML component that references the
file ``Week_overview`` in the ``HTML`` directory.
Students see this content in the Learning Management System as:
.. Image:: ../Images/Insider-first-image.png
:alt: The HTML component as a student views it
*********************************
Sequentials that Contain XBlocks
*********************************
One advantage of OLX is the flexibility it allows in how you organize your
course. For example, edX-Insider demonstrates that you can nest XBlocks and
problems directly in a sequential, without the need for a vertical. This
streamlines the course creation process while maintaining consistency in how
students interact with courseware.
The following XML defines a sequential that has as children an HTML XBlock, a
reference to a vertical that is defined in another file, and a reference to a
problem defined in another file:
.. code-block:: xml
<sequential display_name="In-class exercise" url_name="in_class">
<html display_name="Overview" url_name="overview">
<p>In the on-line portion, . . . </p>
<table border="0">
<tr>
<td align="right">3pm-3:10pm</td><td>Welcome!</td>
</tr>
. . .
</table>
</html>
<vertical url_name="in_class_ora"></vertical>
<problem url_name="res_survey" filename="res_survey"
display_name="Survey: What next?">
</problem>
</sequential>
The student sees this sequential as:
.. Image:: ../Images/Insider-first-sequential.png
:alt: The squential as a student views it
.. include:: ../links.rst