diff --git a/source/_images/educator_references/AnatomyOfExercise.png b/source/_images/educator_references/AnatomyOfExercise.png index 77196703a..3f13d4699 100644 Binary files a/source/_images/educator_references/AnatomyOfExercise.png and b/source/_images/educator_references/AnatomyOfExercise.png differ diff --git a/source/_images/educator_references/AnatomyOfExercise2.png b/source/_images/educator_references/AnatomyOfExercise2.png index dee5b1a53..7b83bd6c4 100644 Binary files a/source/_images/educator_references/AnatomyOfExercise2.png and b/source/_images/educator_references/AnatomyOfExercise2.png differ diff --git a/source/_images/educator_references/AnatomyOfExercise3.png b/source/_images/educator_references/AnatomyOfExercise3.png new file mode 100644 index 000000000..d41c1f687 Binary files /dev/null and b/source/_images/educator_references/AnatomyOfExercise3.png differ diff --git a/source/_images/educator_references/multiple_choice_feedback.png b/source/_images/educator_references/multiple_choice_feedback.png index f7da994bf..f41ab69e8 100644 Binary files a/source/_images/educator_references/multiple_choice_feedback.png and b/source/_images/educator_references/multiple_choice_feedback.png differ diff --git a/source/_images/educator_references/multiple_choice_hint.png b/source/_images/educator_references/multiple_choice_hint.png index 455b404d9..ea041e5da 100644 Binary files a/source/_images/educator_references/multiple_choice_hint.png and b/source/_images/educator_references/multiple_choice_hint.png differ diff --git a/source/_images/educator_references/multiple_choice_hint2.png b/source/_images/educator_references/multiple_choice_hint2.png index 9445c92bd..7090acbdb 100644 Binary files a/source/_images/educator_references/multiple_choice_hint2.png and b/source/_images/educator_references/multiple_choice_hint2.png differ diff --git a/source/_images/educator_references/partial_credit_multiple_choice.png b/source/_images/educator_references/partial_credit_multiple_choice.png index d3845d49c..959a5fd7e 100644 Binary files a/source/_images/educator_references/partial_credit_multiple_choice.png and b/source/_images/educator_references/partial_credit_multiple_choice.png differ diff --git a/source/_images/olx-example-images/olx-example-github.png b/source/_images/olx-example-images/olx-example-github.png index ed56fac11..0660e02b2 100644 Binary files a/source/_images/olx-example-images/olx-example-github.png and b/source/_images/olx-example-images/olx-example-github.png differ diff --git a/source/conf.py b/source/conf.py index e83857e74..b3e351b44 100644 --- a/source/conf.py +++ b/source/conf.py @@ -66,6 +66,7 @@ "learners/sfd_discussions/explore_posts.rst": "learners/sfd_discussions/find_follow_conversations.rst", "learners/sfd_discussions/keep_up.rst": "learners/sfd_discussions/discussions_notifications.rst", "learners/sfd_discussions/provide_feedback.rst": "learners/sfd_discussions/find_follow_conversations.rst", + "educators/references/course_development/working_with_targz_file.rst": "educators/how-tos/course_development/work_with_targz_file.rst", } tags_create_tags = True diff --git a/source/educators/how-tos/course_development/exercise_tools/award_partial_credit_multiple_choice.rst b/source/educators/how-tos/course_development/exercise_tools/award_partial_credit_multiple_choice.rst index acc5b2d77..a971a8273 100644 --- a/source/educators/how-tos/course_development/exercise_tools/award_partial_credit_multiple_choice.rst +++ b/source/educators/how-tos/course_development/exercise_tools/award_partial_credit_multiple_choice.rst @@ -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. diff --git a/source/educators/how-tos/course_development/exercise_tools/award_partial_credit_numerical_input.rst b/source/educators/how-tos/course_development/exercise_tools/award_partial_credit_numerical_input.rst index 5642efedc..2536d832d 100644 --- a/source/educators/how-tos/course_development/exercise_tools/award_partial_credit_numerical_input.rst +++ b/source/educators/how-tos/course_development/exercise_tools/award_partial_credit_numerical_input.rst @@ -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` to configure partial credit. diff --git a/source/educators/references/course_development/working_with_targz_file.rst b/source/educators/how-tos/course_development/work_with_targz_file.rst similarity index 96% rename from source/educators/references/course_development/working_with_targz_file.rst rename to source/educators/how-tos/course_development/work_with_targz_file.rst index 27ed6f37f..e102405f7 100644 --- a/source/educators/references/course_development/working_with_targz_file.rst +++ b/source/educators/how-tos/course_development/work_with_targz_file.rst @@ -1,9 +1,9 @@ .. _Work with the targz File: -Working with the ``.tar.gz`` File +Work with the ``.tar.gz`` File ################################### -.. tags:: educator, reference +.. tags:: educator, how-to Courses are exported and imported in ``.tar.gz`` files containing OLX (Open Learning XML), the Open edX markup format for open course exchange. For more diff --git a/source/educators/how-tos/releasing-course/import_course.rst b/source/educators/how-tos/releasing-course/import_course.rst index d0aeecd18..3ba09e8ba 100644 --- a/source/educators/how-tos/releasing-course/import_course.rst +++ b/source/educators/how-tos/releasing-course/import_course.rst @@ -77,7 +77,7 @@ To import a course, follow these steps. :ref:`Course Export File Terminology` (reference) - :ref:`Work with the targz File` (reference) + :ref:`Work with the targz File` (how-to) **Maintenance chart** diff --git a/source/educators/navigation/content_creation_management.rst b/source/educators/navigation/content_creation_management.rst index 7cdb20df4..7ac8d9120 100644 --- a/source/educators/navigation/content_creation_management.rst +++ b/source/educators/navigation/content_creation_management.rst @@ -182,7 +182,7 @@ Re-run a Course :glob: ../references/course_development/course_export_terminology.rst - ../references/course_development/working_with_targz_file.rst + ../how-tos/course_development/work_with_targz_file.rst Test Your Course diff --git a/source/educators/navigation/olx.rst b/source/educators/navigation/olx.rst index 96e9acc52..f422121b8 100644 --- a/source/educators/navigation/olx.rst +++ b/source/educators/navigation/olx.rst @@ -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 @@ -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 @@ -113,7 +128,8 @@ The topics in this section describe how to use OLX (open learning XML) to create ../olx/components/html-components.rst ../olx/components/discussion-components.rst ../olx/components/video-components.rst - ../olx/components/problem-components.rst + ../olx/components/problem-components.rst + ../olx/components/multipart-components.rst .. _OLX Exercises, Tools, and Problem Types: @@ -182,30 +198,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 diff --git a/source/educators/olx/about/overview.rst b/source/educators/olx/about/overview.rst index dc2126f2b..27420402a 100644 --- a/source/educators/olx/about/overview.rst +++ b/source/educators/olx/about/overview.rst @@ -6,6 +6,13 @@ Create Course Overview in OLX .. tags:: educator, how-to +.. note:: + + This page describes how to create the Course Overview section for + a course, provided the Open edX instance the course is hosted on is using the default + Open edX course catalog. Some Open edX instances 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. @@ -13,20 +20,23 @@ searching and registering for the course. Create the Overview File ********************************************* -In the ``overview`` directory, you create an HTML file called +In the ``about`` directory, 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. +learners. Within the ``section`` tags, use valid HTML. -The overview must contain sections with the following names. +The overview may contain section(s) with the following names. * ``about`` * ``prerequisites`` @@ -38,10 +48,10 @@ The overview must contain sections with the following names. .. _A Template For Course Overview: ************************************************ -A Template For Your Course Overview +A Template For A Course Overview ************************************************ -Replace the placeholders in the following template with your information. +Replace the placeholders in the following template with relevant course information. .. code-block:: html @@ -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 | +--------------+-------------------------------+----------------+--------------------------------+ diff --git a/source/educators/olx/about/short-description.rst b/source/educators/olx/about/short-description.rst index a4f7e922d..12f4a387c 100644 --- a/source/educators/olx/about/short-description.rst +++ b/source/educators/olx/about/short-description.rst @@ -6,22 +6,25 @@ 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 + a course, provided the Open edX instance the course is hosted on is using the default + Open edX course catalog. Some Open edX instances might utilize a different + way of publishing and advertising courses. + +A short description of the 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`` +Create an HTML file called ``short_description.html`` in the ``about`` directory. The short description is limited to 150 characters. -Within that limit, you can add any text and HTML markup to the short -description file. +Within that limit, any text and HTML markup to the short description file can be added. .. seealso:: @@ -33,12 +36,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 | +--------------+-------------------------------+----------------+--------------------------------+ diff --git a/source/educators/olx/assets/assets.rst b/source/educators/olx/assets/assets.rst index 636674fe7..0a5435bcf 100644 --- a/source/educators/olx/assets/assets.rst +++ b/source/educators/olx/assets/assets.rst @@ -6,17 +6,15 @@ Create Course Assets in OLX .. tags:: educator, how-to -You must put all assets, or files that support your course, in the ``static`` +All assets, or files that support the course, must be placed in the ``static`` directory. Assets include any image files, textbooks, handouts, and supporting JavaScript files. -You must also define the asset in the assets policy file. For more information, +Assets must be defined in the assets policy file. For more information, see :ref:`Course Asset Policy`. .. seealso:: - :ref:`Add Course Assets` (reference) - :ref:`Course Asset Policy` (reference) :ref:`What is Open Learning XML?` (concept) @@ -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) @@ -36,5 +34,5 @@ see :ref:`Course Asset Policy`. +--------------+-------------------------------+----------------+--------------------------------+ | Review Date | Working Group Reviewer | Release |Test situation | +--------------+-------------------------------+----------------+--------------------------------+ -| | | | | +| 2025-11-06 | sarina | Ulmo | Pass | +--------------+-------------------------------+----------------+--------------------------------+ diff --git a/source/educators/olx/components/discussion-components.rst b/source/educators/olx/components/discussion-components.rst index 79ada6b08..458841c71 100644 --- a/source/educators/olx/components/discussion-components.rst +++ b/source/educators/olx/components/discussion-components.rst @@ -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= + "{"enable_graded_units": true, + "enable_in_context": true, + "provider_type": "openedx", + "unit_level_visibility": true, + "posting_restrictions": "disabled", + "openedx": {"group_at_subsection": 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. @@ -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`` @@ -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 | +--------------+-------------------------------+----------------+--------------------------------+ diff --git a/source/educators/olx/components/html-components.rst b/source/educators/olx/components/html-components.rst index 6a3da67f7..3ab63e03d 100644 --- a/source/educators/olx/components/html-components.rst +++ b/source/educators/olx/components/html-components.rst @@ -14,55 +14,46 @@ HTML Components in OLX Create the HTML Component ********************************************* -To add an HTML component to your course, you can embed the XML for it in the -parent XML file, or split it up into either 1 or 2 additional files. You can -break up the HTML configuration into an .xml file in the html directory and an -additional .html file in the same directory. +To add an HTML component to a course, split it up into 2 files: The HTML +configuration into an .xml file in the html directory and an additional .html +file in the same directory. -.. caution:: If you are including HTML that is not valid HTML, you must break - out HTML content in a separate file. - - -***************************************************** -Example of an HTML Component Embedded in a Vertical -***************************************************** - -.. code-block:: xml - - - ... - The above has an error. x should be y in the second equation. - +.. caution:: + + HTML that is not valid HTML must be broken out into a separate file. ********************************************* -Example of Separate HTML Files +Example of XML & HTML Files ********************************************* -You create an XML file in the ``html`` directory for the content that you -choose to break out into separate HTML files. +Create an XML file in the ``html`` directory for the content that is broken out +into separate HTML files. The name of the XML file must match the value of the @url_name attribute of the ``html`` element in the vertical XML file. -For example, a vertical XML file contains the following url_name. +For example, the ``vertical/unit_1_what_is_olx.xml`` file contains the following +``url_name``. .. code-block:: xml - - - . . . + + + . . . -You create the file ``html/Introduction.xml`` to define the HTML component. +This references the file ``html/what_is_olx.xml`` to define the HTML component. ************************************* -HTML Component XML File Elements +Example HTML Component XML File ************************************* -The root element of the XML file for the HTML component is file is ``html``. +The following example shows the ``html/what_is_olx.xml`` file for an HTML component. -In this case, the ``html`` element contains no children. +.. code-block:: xml + + ************************************* ``html`` Element Attributes @@ -75,47 +66,39 @@ In this case, the ``html`` element contains no children. * - Attribute - Meaning * - ``display_name`` - - Required. The value that is displayed to students as the name of the - HTML component. If you do not supply a ``display_name`` value, "html" is - supplied for you. + - Required. The value that is displayed to learners as the name of the + HTML component. If a ``display_name`` value is not supplied, "html" is + supplied. * - ``filename`` - The name of the HTML file that contains the content for the HTML component, without the ``.HTML`` extension. + ************************************* -Example HTML Component XML File +HTML Component XML File Elements ************************************* -The following example shows an XML file for an HTML component. - -.. code-block:: xml - - +The root element of the XML file for the HTML component is file is ``html``. +In this case, the ``html`` element contains no children. ************************************* Example HTML Component Content ************************************* -In the component's HTML file, you add valid HTML to represent the content you -want to be displayed to students. For example, the following is from an HTML -file for the edX Demo course: +In the component's HTML file, add valid HTML to represent the content that will +be displayed to learners. For example, the following is from an HTML +file from the olx_example_course: .. code-block:: html -

Lesson 2: Let's Get INTERACTIVE!

-

- InteractiveNow that you know your - way around an Open edX course let's look at some of the exciting interactive - tools you may encounter. Use the unit navigation bar above to explore. -  

-

Once you have tried the interactive tools in this lesson, - make sure to check out the week 2 homework where we show you several of the - really cool interactive labs we’ve created for past courses. -  They’re fun to play with.  Many courses will have tools - and labs that you need to use to complete homework assignments.

+

OLX (open learning XML) is the XML-based standard used to build courses for the Open edX Platform.

+

With OLX, you can:

+ .. seealso:: @@ -130,12 +113,10 @@ file for the edX Demo course: :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 | +--------------+-------------------------------+----------------+--------------------------------+ diff --git a/source/educators/olx/components/multipart-components.rst b/source/educators/olx/components/multipart-components.rst new file mode 100644 index 000000000..ca37e27e5 --- /dev/null +++ b/source/educators/olx/components/multipart-components.rst @@ -0,0 +1,148 @@ +.. _Multipart Components OLX: + +Multipart Components in OLX +############################ + +.. tags:: educator, reference + +In OLX, authors can create one component that gate multiple problems behind a +single Submit button. + +.. contents:: + :local: + :depth: 1 + +.. _Multiple Problems in One Component OLX: + +Multiple Problems in One Component +*********************************** + +Authors can create a problem that includes more than one response type. For +example, authors might want to create a numerical input problem and then include a +multiple choice problem that refers to the numerical input problem. Or, +authors might want a learner to be able to check the answers to many problems at +one time. To do this, authors can include multiple problems inside a single +```` element. The problems can be different types. + +Each question and its answer options are enclosed by the element that +identifies the type of problem, such as ```` for a +multiple choice question or ```` for a math expression input +question. + +A different explanation for each question can be supplied by using the +```` element. + +As a best practice, Open edX accessibility best practices recommend that +unformatted paragraph text between the questions be avoided; insert text +using a ``
`` element. Screen readers can skip over text that is inserted +among multiple questions. + +Elements such as the **Submit**, **Show Answer**, and **Reset** buttons, as +well as the settings that are selected for the problem component, apply to all +of the problems in that component. Thus, if the maximum number of +attempts is set to 3, the learner has three attempts to answer the entire set of +problems in the component as a whole rather than three attempts to answer each +problem individually. If a learner selects **Submit**, the LMS scores all of +the problems in the component at once. If a learner selects **Show Answer**, +the answers for all the problems in the component appear. + +.. note:: + :ref:`Custom JavaScript` cannot be used + in a component that contains more than one problem. Each custom JavaScript problem must be in its own + component. + +Create a Multipart Component +********************************************* + +Typically when making a :ref:`problem component `, there is +one type of component nested within the ```` element. However, in a +multipart component, authors can nest multiple components within a single +```` element. + +An `example of a multipart problem +`_ +follows: + +.. code-block:: xml + + + +
What is the correct answer?
+ + +
Incorrect
+ + +
Incorrect
+ + +
Correct
+ + + +
+

Explanation

+

The correct answer is called "Correct"

+
+ + + + +
What is the incorrect answer?
+ + +
Incorrect
+ + +
Correct
+ + +
Correct
+ + + +
+

Explanation

+

The correct answer is called "Incorrect"

+
+ + + + +Note in the above example, there is exactly one ```` element. Within +this element, there are two ```` elements. + +Multipart Grading +********************************************* + +The LMS will distribute the total number of points available for the problem +evenly across all problems. So in the above example (worth 2.0 points - +``weight="2.0"``), if a learner answers one part correctly and the second +incorrectly, they will be awarded 1/2 points. + +.. image:: /_images/educator_references/partial_credit_multiple_choice.png + :alt: A two part problem, worth 2 points, receiving one point for getting only one of two answers correct. + :width: 500 + +.. seealso:: + + :ref:`What is Open Learning XML?` (concept) + + :ref:`Problem Components` (reference) + + :ref:`Components and Activities TOC` (reference) + + :ref:`Example of an OLX Course` (reference) + + :ref:`Getting Started with OLX` (quickstart) + + :ref:`OLX Directory Structure` (reference) + + +**Maintenance chart** + ++--------------+-------------------------------+----------------+--------------------------------+ +| Review Date | Working Group Reviewer | Release |Test situation | ++--------------+-------------------------------+----------------+--------------------------------+ +| 2025-11-06 | sarina | Ulmo | Pass | ++--------------+-------------------------------+----------------+--------------------------------+ \ No newline at end of file diff --git a/source/educators/olx/components/problem-components.rst b/source/educators/olx/components/problem-components.rst index 3071a4969..2da002c8a 100644 --- a/source/educators/olx/components/problem-components.rst +++ b/source/educators/olx/components/problem-components.rst @@ -6,10 +6,10 @@ Problem Components in OLX .. tags:: educator, reference -The problem component allows you to add interactive exercises to the verticals -in your course. You can add many different types of exercises and problems. +The problem component allows authors to add interactive exercises to the units +in a course. Many different types of exercises and problems can be added. This section covers the basics of problem components: what they look like to -you and your learners, and the options that every problem component has. +authors and learners, and the options that every problem component has. .. contents:: :local: @@ -21,20 +21,15 @@ Problem Component Overview The format for Open edX problems is based on the `LON-CAPA XML format`_, although the two are not quite compatible. In the Open edX variant, problems are composed of -the following types of tags. - -* ``inputtypes`` are similar to XBlocks. They define ways for users to enter - input into the problem. -* ``responsetypes`` are graders. They define how inputs are mapped to grades. -* ``hinters`` are used to provide feedback to problems. -* Standard HTML tags are used for formatting. - -OLX is designed to allow mixing and matching of ``inputtypes``, -``responsetypes``, and ``hinters``. For example, a numerical grader could match -7+-0.1%. Ideally, you could use this grader with any ``inputtype`` that returns -numbers as its output, including a text box, equation input, slider, or -multiple choice question. In practice, this does not always work. For example, -in the example described above, a multiple choice question would not give an +various *input types*, such as ``numericalresponse`` or ``stringresponse``. + +Standard HTML tags are used for formatting. + +OLX is designed to allow mixing and matching of input types and response types. +For example, a numerical grader could match 7+-0.1%. Ideally, this grader could +be used with any input type that returns numbers as its output, including a text +box, equation input, slider, or multiple choice question. In practice, this does +not always work. For example, a multiple choice question would not give an output in a format a numerical grader could handle. In addition, in many cases, there is a 1:1 mapping between graders and inputs. @@ -42,27 +37,27 @@ For some types of inputs (especially discipline-specific specialized ones), only one grader is needed. The most general grader is ``customresponse``. This grader uses Python code to -evaluate the input. By design, this ought to work with any inputtype, although -there are bugs mixing this with a small number of the newer inputtypes. +evaluate the input. By design, this ought to work with any input type, although +this is not guaranteed to render or work properly in the Open edX Studio or LMS +environments. Like LON-CAPA, OLX allows embedding of code to generate parameterized problems. Unlike LON-CAPA, Open edX supports Python (and not Perl). Otherwise, the syntax for parameterizing problems is approximately identical. - ===================================== Creating Graded or Ungraded Problems ===================================== -All problems receive a point score. However, when you establish the grading -policy for your course, you specify the assignment types that will count toward -learners' grades; for example, homework, lab, midterm, and final. +All problems receive a point score. However, when a grading policy is +established for a course, the assignment types that will count toward learners' +grades are defined; for example, homework, lab, midterm, and final. -As you develop your course, you can add problem components to the units in any -subsection. The problem components that you add automatically inherit the -assignment type that is defined at the subsection level. You can only set -assignment types at the subsection level, not at the unit or individual -component level. +As a course is developed, problem components can be added to the units in any +subsection. The problem components that are added automatically inherit the +assignment type that is defined at the subsection level. Assignment types can +only be set at the subsection level, not at the unit or individual component +level. For more information, see :ref:`Grading Policy`. @@ -72,18 +67,49 @@ For more information, see :ref:`Grading Policy`. :start-after: .. START LEARNER VIEW OF PROBLEM :end-before: .. END LEARNER VIEW OF PROBLEM +===================================== +Example OLX - Single Select Problem +===================================== + +See the `single select problem `_ +in the ``olx_example_course``; it is replicated here: + +.. code-block:: xml + + + +
What is the correct answer?
+ + +
Incorrect
+ + +
Incorrect
+ + +
Correct
+ + + +
+

Explanation

+

The correct answer is called "Correct"

+
+ + + + ****************** Problem Settings ****************** -In addition to the text of the problem, problems that you create have the -following settings. +In addition to the text of the problem, problems have the following settings. .. contents:: :local: :depth: 1 -This section describes the OLX elements and attributes that you define for the +This section describes the OLX elements and attributes that can be defined for the problem settings. For a detailed description of each setting, see :ref:`Guide to Problem Settings`. @@ -91,7 +117,7 @@ problem settings. For a detailed description of each setting, see Display Name =============== -Using OLX, you set the display name as an attribute of the ```` +Using OLX, set the display name as an attribute of the ```` element. .. code-block:: xml @@ -102,7 +128,7 @@ element. Maximum Attempts ============================== -Using OLX, you set the maximum attempts as an attribute of the ```` +Using OLX, set the maximum attempts as an attribute of the ```` element. .. code-block:: xml @@ -116,7 +142,7 @@ element. Problem Weight ============================== -Using OLX, you set the component weight as an attribute of the ```` +Using OLX, set the score of the component as an attribute of the ```` element. .. code-block:: xml @@ -129,14 +155,14 @@ element. Randomization =============== -Using OLX, you set value randomization as an attribute of the ```` +Using OLX, set value randomization as an attribute of the ```` element. .. code-block:: xml -You can specify the following values for this attribute. +The following values can be set for this attribute: * always * on_reset @@ -149,23 +175,26 @@ You can specify the following values for this attribute. Show Answer =============== -Using OLX, you set the show answer preference as an attribute of the +Using OLX, set set the show answer preference as an attribute of the ```` element. .. code-block:: xml -You can specify the following values for this attribute. +The following values can be set for this attribute: -* always -* answered -* attempted -* closed -* correct_or_past_due -* finished -* past_due -* never +* "always" +* "answered" +* "attempted" +* "closed" +* "finished" +* "past_due" +* "correct_or_past_due" +* "after_all_attempts" +* "after_all_attempts_or_correct" +* "attempted_no_past_due" +* "never" .. _Show Reset Button OLX: @@ -173,7 +202,7 @@ You can specify the following values for this attribute. Show Reset Button ================= -Using OLX, you set the show reset button preference as an attribute of the +Using OLX, set the show reset button preference as an attribute of the ```` element. .. code-block:: xml @@ -186,30 +215,29 @@ Using OLX, you set the show reset button preference as an attribute of the Modifying a Released Problem ********************************* -.. warning:: Be careful when you modify problems after they have been - released! Changes that you make to published problems can affect the learner +.. warning:: Be careful when modifying problems after they have been + released! Changes that are made to published problems can affect the learner experience in the course and analysis of course data. After a learner submits a response to a problem, the LMS stores the learner's response, the score that the learner received, and the maximum score for the problem. For problems with a **Maximum Attempts** setting greater than 1, the LMS updates these values each time the learner submits a new response to a -problem. However, if you change a problem or its attributes, -existing learner information for that problem is not automatically updated. - -For example, you might release a problem and specify that its answer is 3. -After some learners have submitted responses, you notice that the answer -should be 2 instead of 3. When you update the problem with the correct -answer, the LMS does not update scores for learners who answered 2 for the -original problem and thus received the wrong score. - -For another example, you might change the number of response fields to -three. Learners who submitted answers before the change have a score of -0, 1, or 2 out of 2.0 for that problem. Learners who submitted answers -after the change have scores of 0, 1, 2, or 3 out of 3.0 for the same -problem. - -If you change the weight setting for the problem in Studio, however, existing +problem. However, if a problem or its attributes are changed, existing learner +information for that problem is not automatically updated. + +For example, a problem might be released with the answer specified as "3". After +some learners have submitted responses, the course team notices that the answer +should be 2 instead of 3. When the problem is updated with the correct answer, +the LMS does not update scores for learners who answered 2 for the original +problem and thus received the wrong score. + +For another example, the number of response fields is changed fom two to three. +Learners who submitted answers before the change have a score of 0, 1, or 2 out +of 2.0 for that problem. Learners who submitted answers after the change have +scores of 0, 1, 2, or 3 out of 3.0 for the same problem. + +If the weight setting for the problem in Studio is changed, however, existing learner scores update when the learner's **Progress** page is refreshed. In a live section, learners will see the effect of these changes. @@ -217,64 +245,35 @@ live section, learners will see the effect of these changes. Workarounds =============== -If you have to modify a released problem in a way that affects grading, you -have two options within Studio to assure that every learner has the opportunity -to submit a new response and be regraded. Note that both options require you to -ask your learners to go back and resubmit answers to a problem. - -* In the problem component that you changed, increase the number of attempts - for the problem. Then ask all your learners to redo the problem. - -* Delete the entire Problem component in Studio and create a new Problem - component with the content and settings that you want. (If the revisions you - must make are minor, duplicate the problem component before you delete it - and revise the copy.) Then ask all your learners to complete the new - problem. +The Instructor Dashboard allows rescoring existing submissions for either a +specific learner, or all learners in the course. However, this may not be ideal +in the situation that the problem itself has changed. +If a released problem has to be modifyed in a way that affects grading, there are +two options within Studio to assure that every learner has the opportunity to +submit a new response and be regraded. Note that both options require the course +team to ask their learners to go back and resubmit answers to a problem. -.. _Multiple Problems in One Component OLX: +* In the problem component that was changed, increase the number of attempts + for the problem. Then ask all learners to redo the problem. -*********************************** -Multiple Problems in One Component -*********************************** +* Delete the entire Problem component in Studio and create a new Problem + component with the correct content and settings. (If the revisions needed are + minor, duplicate the problem component before it is deleted and revise the + copy.) Then ask all learners to complete the new problem. -You can create a problem that includes more than one response type. For -example, you might want to create a numerical input problem and then include a -multiple choice problem that refers to the numerical input problem. Or, -you might want a learner to be able to check the answers to many problems at -one time. To do this, you can include multiple problems inside a single -```` element. The problems can be different types. - -Each question and its answer options are enclosed by the element that -identifies the type of problem, such as ```` for a -multiple choice question or ```` for a math expression input -question. - -You can provide a different explanation for each question by using the -```` element. - -As a best practice, Open edX accessibility best practices recommend that you avoid including unformatted -paragraph text between the questions. Screen readers can skip over text that is -inserted among multiple questions. - -Elements such as the **Submit**, **Show Answer**, and **Reset** buttons, as -well as the settings that you select for the problem component, apply to all -of the problems in that component. Thus, if you set the maximum number of -attempts to 3, the learner has three attempts to answer the entire set of -problems in the component as a whole rather than three attempts to answer each -problem individually. If a learner selects **Submit**, the LMS scores all of -the problems in the component at once. If a learner selects **Show Answer**, -the answers for all the problems in the component appear. - -.. note:: - You cannot use a :ref:`Custom JavaScript` in a component that contains more - than one problem. Each custom JavaScript problem must be in its own - component. +**************************************************** +Adding Feedback and Hints to a Problem +**************************************************** .. include:: /educators/references/course_development/exercise_tools/adding_hints.rst :start-after: .. START ADDING FEEDBACK AND HINTS :end-before: .. END ADDING FEEDBACK AND HINTS +************************** +Awarding Partial Credit +************************** + .. include:: /educators/references/course_development/awarding_partial_credit.rst :start-after: .. START PARTIAL CREDIT :end-before: .. END PARTIAL CREDIT @@ -288,9 +287,10 @@ Problem Randomization Presenting different learners with different problems or with different versions of the same problem is referred to as "problem randomization". -You can provide different learners with different problems by using randomized -content blocks, which randomly draw problems from pools of problems stored in -content libraries. For more information, see :ref:`Randomized Content Blocks`. +Different learners can be provided with with different problems by using +randomized content blocks, which randomly draw problems from pools of problems +stored in content libraries. For more information, see :ref:`Randomized Content +Blocks`. .. note:: Problem randomization is different from the **Randomization** setting in Studio. Problem randomization offers different problems or problem @@ -306,13 +306,17 @@ content libraries. For more information, see :ref:`Randomized Content Blocks`. Create Randomized Problems ==================================== -.. note:: Creating randomized problems by exporting your course and editing - some of your course's XML files is no longer supported. +.. note:: Creating randomized problems by exporting a course and editing + some of the course's XML files is no longer supported. -You can provide different learners with different problems by using randomized -content blocks, which randomly draw problems from pools of problems stored in -content libraries. For more information, see -:ref:`Randomized Content Blocks`. +Different learners can be provided with with different problems by using +randomized content blocks, which randomly draw problems from pools of problems +stored in content libraries. For more information, see :ref:`Randomized Content +Blocks`. + +************************** +Tooltips +************************** .. include:: /educators/references/course_development/adding_tooltips.rst :start-after: .. START ADDING TOOLTIPS @@ -322,6 +326,8 @@ content libraries. For more information, see :ref:`What is Open Learning XML?` (concept) + :ref:`Multipart Components OLX` (reference) + :ref:`Components and Activities TOC` (reference) :ref:`Example of an OLX Course` (reference) @@ -330,12 +336,10 @@ content libraries. For more information, see :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 | +--------------+-------------------------------+----------------+--------------------------------+ diff --git a/source/educators/olx/components/video-components.rst b/source/educators/olx/components/video-components.rst index 7b3d7b959..fee305595 100644 --- a/source/educators/olx/components/video-components.rst +++ b/source/educators/olx/components/video-components.rst @@ -6,9 +6,7 @@ Video Components in OLX .. tags:: educator, reference -You can add video components to any container in your course (such as -a vertical or sequential). Studio places all video components inside -verticals (which it calls units). +Authors can add video components to a course unit via the ``video/.xml`` file. .. contents:: :local: @@ -18,20 +16,24 @@ verticals (which it calls units). Create the XML File for a Video Component ********************************************** -To add a video component to your course, add it to the course XML tree as -follows. +To add a video component to a course, add it to the course XML tree as +follows. This is ``video/purpose_power_reach.xml`` in the olx_example_course. .. code-block:: xml + youtube="1.00:lVPPPpyUOR4" + url_name="purpose_power_reach" + display_name="The Purpose, Power and Reach of the Open edX® Platform" + edx_video_id="" + end_time="00:00:00" + html5_sources="[]" + start_time="00:00:00" + track="" + youtube_id_1_0="lVPPPpyUOR4"/> + -If you prefer to place the video component in its own file, you create an XML -file in the ``video`` directory for each video component in your course. +Place an XML file in the ``video`` directory for each video component in the course. The name of the XML file must match the value of the @url_name attribute of the ``video`` element in the vertical XML file. @@ -40,13 +42,12 @@ For example, the vertical XML file uses the following format. .. code-block:: xml - -