Create Course Overview in OLX

Create Course Overview in OLX#

Tags: educator how-to

Note

This page describes how to create the Course Overview section for your course, provided your Open edX instance is using the default Open edX course catalog. Your Open edX instance might utilize a different way of publishing and advertising courses.

Each course must have an overview page. Learners see the overview page when searching and registering for the course.

Create the Overview File#

In the about directory, you create an HTML file called overview.html.

Overview Sections#

The overview.html contains specific sections. The default Open edX course catalog does not style the Overview page based on most of these HTML classes, however, other course catalogs may (and Open edX Studio will export with these classes).

Each section is wrapped in section tags. The value of the class attribute specifies what the section is for and how it is displayed to learners. Within the section tags, you use valid HTML.

The overview may contain section(s) with the following names.

  • about

  • prerequisites

  • course-staff

  • teacher

  • faq

A Template For Your Course Overview#

Replace the placeholders in the following template with your information.

<section class="about">
  <h2>About This Course</h2>
  <p>Include your long course description here. The long course description
    should contain 150-400 words.</p>
  <p>This is paragraph 2 of the long course description. Add more paragraphs
    as needed. Make sure to enclose them in paragraph tags.</p>
<section>
<section class="prerequisites">
  <h2>Prerequisites</h2>
  <p>Add information about class prerequisites here.</p>
</section>
<section class="course-staff">
  <h2>Course Team</h2>
  <article class="teacher">
    <div class="teacher-image">
      <!-- Replace the path below with the path to your faculty image. -->
      <img src="/c4x/edX/edX101/asset/Placeholder_FacultyImage.jpg"
        align="left" style="margin:0 20 px 0"/>
    </div>
    <h3>Team Member</h3>
    <p>Biography of course team member</p>
  </article>
  <article class="teacher">
    <div class="teacher-image">
      <img src="/c4x/edX/edX101/asset/Placeholder_FalcutyImage.jpg"/>
    </div>
    <h3>Team Member Name</h3>
    <p>Biography of course team member</p>
  </article>
</section>
<section class="faq">
  <section class="responses">
    <h2>Frequently Asked Questions</h2>
    <article class="response">
      <h3>What web browser should I use?</h3>
      <p>The Open edX platform works best with the current versions of Chrome, Firefox, Safari, and Microsoft Edge.</p>
      <p>See our :ref:`list of supported browsers<Browsers>` for the most up-to-date information.</p>
    </article>
    <article class="response">
      <h3>Question 2?</h3>
      <p>Answer 2.</p>
    </article>
  </section>
</section>

See also

What is Open Learning XML? (concept)

Example of an OLX Course (reference)

Getting Started with OLX (quickstart)

What is the OLX Course Structure? (reference)

Maintenance chart

Review Date

Working Group Reviewer

Release

Test situation

2025-11-06

sarina

Ulmo

Pass
Contents