Skip to content

Latest commit

 

History

History
72 lines (47 loc) · 3.51 KB

README_DEV.md

File metadata and controls

72 lines (47 loc) · 3.51 KB

Creating content for the edX generator

In order to create the edX course, the instructors need to organise their files in a specific folder structure that is four levels deep. All other assets, such as images and videos, can be placed in context, in the same folder as where they are being used.

The content is defined using markdown files with an .md extension. Here is a markdown cheatsheet that gives a quick overview of the things you can do.

There are two types of files:

  • Settings and content files (.md)
    • Markdown files
    • Contains the settings for the parent folder.
    • Contains the content for the components that make up the units.
  • Assets (e.g. *.jpg, *.png)
    • Images can be .png and .jpg
    • The assets should be placed in the same folder where they are used, i.e. in the unit folder.

Structure of folders and .md files

The folder structure is as follows:

  • Course_Folder (1st level)
    • course_settings.md
    • Section_Folder (2nd level)
      • section_settings.md
      • Subsection_Folder (3rd level)
        • subsection_settings.md
        • Unit_Folder (4th level)
          • unit_settings.md
          • components.md

NOTE: that each folder should contain exactly one markdown (.md) file. These files can have any name, but must always have a .md extension.

Note that the alphanumeric ordering of the folders is important, as this will reflect the ordering that will be generated in edX. In this example, the sections_sec1 (for Section 1). Due to the subsection naming as followed sub1, sub2, and sub3 they would be sorted correctly. Alternatively 1_sub, 2_sub, and 3_sub would work as well, so the file/folder name construction is important for the processing order.

In the example, short folder names used. This is because when the final files get generated, the files names will concatenate all the folder names. So in order to avoid long file names in the final output, it is advisable to keep the folder names short. In addition, in the example, we start the filename with an _ (underscore). This is to ensure that the markdown file will always be listed at the top of the file list. (But this is just a convenience, not a requirement.)

Root .md file

For the edX import to succeed, it is vital that settings in the root .md file (which is the .md file in the root folder) match the settings in edX.

org="<organization>" 
course="<course number>"
url_name="<course run>"

In the edX UI for the course, under the menu Settings > Schedule & Details, these are named as follows:

  • EDX_ORG = Organization
  • EDX_NUM = Course Number
  • EDX_RUN = Course Run

Hierarchical terminology

In the edX interface, the hierarchy is as follows:

  • course > section > subsection > unit > component

In the tar file folder structure, the hierarchy is as follows

  • course > chapter > sequence > vertical > component

In this document, we will use the first, i.e. course > section > subsection > unit > component. This matches what users see in the user interface. However, the python script will generate a .tar.gz file that uses the second.

Writing .md files

For more information on writing the .md files, follow the links below.