.. _The olx-example course.xml File: ######################################### The ``course.xml`` file (advanced usage) ######################################### .. tags:: educator, reference .. warning:: This page was written in 2013 and may no longer work for imports into Open edX Studio. Alternative ways of structuring OLX aside from the Studio export format described elsewhere in this OLX guide are not guaranteed by the Open edX project to work with Open edX Studio in the future. Additionally, however a course is written, if that course is imported into Studio, Studio will export it in the specifically structured form of OLX *containers* described elsewhere in this guide. .. contents:: :local: :depth: 1 ***************************** Example Course Hierarchy ***************************** Open edX courseware is organized into chapters, sequentials, and verticals. For example, the following XML defines the first chapter, sequential, and vertical directly in the ``course.xml`` file. .. code-block:: xml The vertical ``Week's Overview`` contains an HTML component that references the file ``Week_overview`` in the ``HTML`` directory. Learners see this content in the Learning Management System as follows. .. Image:: /_images/olx-example-images/Insider-first-image.png :alt: The HTML component as a learner sees it. ********************************* Sequentials that Contain XBlocks ********************************* One advantage of OLX (open learning XML) is the flexibility it allows in how a course is organized. For example, authors 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. .. warning:: This structure is not guaranteed to successfully import into Open edX Studio. The following example 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

In the on-line portion, . . .

. . .

3pm-3:10pm

Welcome!

The learner sees this sequential as follows. .. Image:: /_images/olx-example-images/Insider-first-sequential.png :alt: The sequential as a learner sees it. .. seealso:: :ref:`What is Open Learning XML?` (concept) :ref:`OLX Components` (reference) :ref:`OLX Exercises, Tools, and Problem Types` (reference) :ref:`Example of an OLX Course` (reference) :ref:`Getting Started with OLX` (quickstart) :ref:`OLX Directory Structure` (reference) :ref:`The Courseware Structure` (reference) :ref:`Work with the targz File` (how-to) **Maintenance chart** +--------------+-------------------------------+----------------+--------------------------------------------------------------------------------------------------------------------+ | Review Date | Reviewer | Release | Test situation | +--------------+-------------------------------+----------------+--------------------------------------------------------------------------------------------------------------------+ | 2025-11-06 | sarina | Ulmo | Deprecated - this method is no longer guaranteed to work with Open edX Studio | +--------------+-------------------------------+----------------+--------------------------------------------------------------------------------------------------------------------+ | 2025-04-11 | Sarina Canelake | Sumac |`Fail `_ | +--------------+-------------------------------+----------------+--------------------------------------------------------------------------------------------------------------------+