Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Binary file modified source/_images/educator_references/AnatomyOfExercise.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified source/_images/educator_references/AnatomyOfExercise2.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified source/_images/educator_references/multiple_choice_feedback.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified source/_images/educator_references/multiple_choice_hint.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified source/_images/educator_references/multiple_choice_hint2.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,13 @@ Award Partial Credit in a Multiple Choice Problem

.. tags:: educator, how-to

.. warning::

Partial credit is not an option exposed in Open edX Studio.

Studio and LMS support of partial credit is not guaranteed to work.


You can configure a single select problem so that specific incorrect answers
award learners partial credit for the problem.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,13 @@ Award Partial Credit in a Numerical Input Problem

.. tags:: educator, how-to

.. warning::

Partial credit is not an option exposed in Open edX Studio.

Studio and LMS support of partial credit is not guaranteed to work.


You can configure a numerical input problem to award partial credit to learners
who submit an answer that is close or related to the correct answer. You must
use the :ref:`advanced editor<Advanced Editor>` to configure partial credit.
Expand Down
43 changes: 16 additions & 27 deletions source/educators/navigation/olx.rst
Original file line number Diff line number Diff line change
Expand Up @@ -16,10 +16,11 @@ OLX General Information
:maxdepth: 1
:glob:

../olx/front_matter/read_me.rst
../olx/what-is-olx.rst
../olx/getting-started.rst

:ref:`Work with the targz File`

.. _OLX Course Structure:

OLX Course Structure
Expand All @@ -33,6 +34,20 @@ This topic describes the structure of a generic OLX (open learning XML) course.

../olx/directory-structure.rst

.. _OLX Example Course:

Example of an OLX Course
*******************************************************

.. toctree::
:maxdepth: 1
:glob:

../olx/example-course/index.rst
../olx/example-course/insider-structure.rst
../olx/example-course/insider-course-xml.rst
../olx/studio-example/manual-testing-structure.rst

.. _OLX Policies:

Policies
Expand Down Expand Up @@ -182,30 +197,4 @@ The topics in this section describe how to use OLX (open learning XML) to create
/educators/how-tos/advanced_features/manage_content_experiments.rst
/educators/how-tos/advanced_features/add_content_experiments_olx.rst
../olx/content-experiments/content_experiments_test_olx.rst


.. _OLX Example Course:

Example of an OLX Course
*******************************************************

.. toctree::
:maxdepth: 1
:glob:

../olx/example-course/index.rst
../olx/example-course/insider-structure.rst
../olx/example-course/insider-course-xml.rst

.. _OLX Example Studio Course:

Example of OLX for a Studio Course
*******************************************************

.. toctree::
:maxdepth: 1
:glob:

../olx/studio-example/index.rst
../olx/studio-example/manual-testing-structure.rst

20 changes: 14 additions & 6 deletions source/educators/olx/about/overview.rst
Original file line number Diff line number Diff line change
Expand Up @@ -6,27 +6,37 @@ 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 ``overview`` directory, you create an HTML file called
In the ``about`` directory, you create an HTML file called
``overview.html``.

*********************************************
Overview Sections
*********************************************

The ``overview.html`` must contain specific 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 must contain sections with the following names.
The overview may contain section(s) with the following names.

* ``about``
* ``prerequisites``
Expand Down Expand Up @@ -100,12 +110,10 @@ Replace the placeholders in the following template with your information.

:ref:`OLX Directory Structure` (reference)

:ref:`Example of OLX for a Studio Course` (reference)

**Maintenance chart**

+--------------+-------------------------------+----------------+--------------------------------+
| Review Date | Working Group Reviewer | Release |Test situation |
+--------------+-------------------------------+----------------+--------------------------------+
| | | | |
| 2025-11-06 | sarina | Ulmo | Pass |
+--------------+-------------------------------+----------------+--------------------------------+
16 changes: 9 additions & 7 deletions source/educators/olx/about/short-description.rst
Original file line number Diff line number Diff line change
Expand Up @@ -6,16 +6,20 @@ Create Short Description in OLX

.. tags:: educator, how-to

Optionally, you can define a short description for your course.
.. note::

Learners see the short description when they move their cursors over the course
image in the catalog.
This page describes how to create the Short Description 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.

A short description of your course appears at the top of the Course About page.

*********************************************
Create the Short Description File
*********************************************

You create an HTML file called ``short_description.html`` in the ``overview``
You create an HTML file called ``short_description.html`` in the ``about``
directory.

The short description is limited to 150 characters.
Expand All @@ -33,12 +37,10 @@ description file.

:ref:`OLX Directory Structure` (reference)

:ref:`Example of OLX for a Studio Course` (reference)

**Maintenance chart**

+--------------+-------------------------------+----------------+--------------------------------+
| Review Date | Working Group Reviewer | Release |Test situation |
+--------------+-------------------------------+----------------+--------------------------------+
| | | | |
| 2025-11-06 | sarina | Ulmo | Pass |
+--------------+-------------------------------+----------------+--------------------------------+
6 changes: 2 additions & 4 deletions source/educators/olx/assets/assets.rst
Original file line number Diff line number Diff line change
Expand Up @@ -15,8 +15,6 @@ see :ref:`Course Asset Policy`.

.. seealso::

:ref:`Add Course Assets` (reference)

:ref:`Course Asset Policy` (reference)

:ref:`What is Open Learning XML?` (concept)
Expand All @@ -27,7 +25,7 @@ see :ref:`Course Asset Policy`.

:ref:`OLX Directory Structure` (reference)

:ref:`Example of OLX for a Studio Course` (reference)
:ref:`Add Course Assets` (via Studio) (reference)



Expand All @@ -36,5 +34,5 @@ see :ref:`Course Asset Policy`.
+--------------+-------------------------------+----------------+--------------------------------+
| Review Date | Working Group Reviewer | Release |Test situation |
+--------------+-------------------------------+----------------+--------------------------------+
| | | | |
| 2025-11-06 | sarina | Ulmo | Pass |
+--------------+-------------------------------+----------------+--------------------------------+
28 changes: 23 additions & 5 deletions source/educators/olx/components/discussion-components.rst
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,27 @@ Discussion Components in OLX

.. tags:: educator, reference

.. warning:: This page refers to the older discussion forums (pre-Olive release) and may be out of date.
.. warning::

This page refers to the older discussion forums (pre-Olive release) and is deprecated for post-Olive releases.

For Olive and newer releases, discussion components are automatically created for each ungraded unit. To
enable discussion on graded units, the behavior can be overridden via the ``discussions_settings`` attribute
on the ``course`` object in the ``course/run.xml`` file.

Here is an example of ``discussions_settings`` with ``enable_graded_units`` set to ``true``:

.. code-block:: xml

discussions_settings=
"{&quot;enable_graded_units&quot;: true,
&quot;enable_in_context&quot;: true,
&quot;provider_type&quot;: &quot;openedx&quot;,
&quot;unit_level_visibility&quot;: true,
&quot;posting_restrictions&quot;: &quot;disabled&quot;,
&quot;openedx&quot;: {&quot;group_at_subsection&quot;: false}}"

The UI for discussions configuration can be found under the Content > Pages & Resources menu in Studio.

You can add inline :term:`Discussion` components to any container in your
course.
Expand Down Expand Up @@ -91,7 +111,7 @@ The ``discussion`` element contains no children.
- The name of the subcategory for the inline discussion as shown in the
**Discussion** tab of the course. For example: ``Problem 2``
* - ``display_name``
- Optional. The value that is displayed to students as the name of the
- Optional. The value that is displayed to learners as the name of the
discussion component. If you do not supply a ``display_name`` value,
"Discussion" is supplied for you.
* - Optional. ``discussion_id``
Expand Down Expand Up @@ -130,12 +150,10 @@ The following example shows an XML file for a discussion component.

:ref:`OLX Directory Structure` (reference)

:ref:`Example of OLX for a Studio Course` (reference)

**Maintenance chart**

+--------------+-------------------------------+----------------+--------------------------------+
| Review Date | Working Group Reviewer | Release |Test situation |
+--------------+-------------------------------+----------------+--------------------------------+
| | | | |
| 2025-11-06 | sarina | Ulmo | Deprecated |
+--------------+-------------------------------+----------------+--------------------------------+
Loading