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/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/navigation/olx.rst b/source/educators/navigation/olx.rst index 96e9acc52..eb27acfc8 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 @@ -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 diff --git a/source/educators/olx/about/overview.rst b/source/educators/olx/about/overview.rst index dc2126f2b..0c9873e60 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 + 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. @@ -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, 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`` @@ -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..d0b92b901 100644 --- a/source/educators/olx/about/short-description.rst +++ b/source/educators/olx/about/short-description.rst @@ -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. @@ -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 | +--------------+-------------------------------+----------------+--------------------------------+ diff --git a/source/educators/olx/assets/assets.rst b/source/educators/olx/assets/assets.rst index 636674fe7..ac796f918 100644 --- a/source/educators/olx/assets/assets.rst +++ b/source/educators/olx/assets/assets.rst @@ -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) @@ -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) @@ -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..c550cc74c 100644 --- a/source/educators/olx/components/html-components.rst +++ b/source/educators/olx/components/html-components.rst @@ -14,29 +14,17 @@ 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 your 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:: + + If you are including HTML that is not valid HTML, you must break out HTML content in 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 @@ -45,24 +33,27 @@ choose to break 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 + - Required. The value that is displayed to learners as the name of the HTML component. If you do not supply a ``display_name`` value, "html" is supplied for you. * - ``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: +want to 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/problem-components.rst b/source/educators/olx/components/problem-components.rst index 3071a4969..858b34089 100644 --- a/source/educators/olx/components/problem-components.rst +++ b/source/educators/olx/components/problem-components.rst @@ -6,7 +6,7 @@ Problem Components in OLX .. tags:: educator, reference -The problem component allows you to add interactive exercises to the verticals +The problem component allows you to add interactive exercises to the units in your course. You can add many different types of exercises and problems. 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. @@ -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, you could use this +grader 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,14 +37,14 @@ 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 ===================================== @@ -116,7 +111,7 @@ element. Problem Weight ============================== -Using OLX, you set the component weight as an attribute of the ```` +Using OLX, you set the score of the component as an attribute of the ```` element. .. code-block:: xml @@ -158,14 +153,17 @@ Using OLX, you set the show answer preference as an attribute of the You can specify the following values 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: @@ -217,6 +215,10 @@ live section, learners will see the effect of these changes. Workarounds =============== +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 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 @@ -271,10 +273,18 @@ the answers for all the problems in the component appear. 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 @@ -314,6 +324,10 @@ 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 :end-before: .. END ADDING TOOLTIPS @@ -330,8 +344,6 @@ content libraries. For more information, see :ref:`OLX Directory Structure` (reference) - :ref:`Example of OLX for a Studio Course` (reference) - **Maintenance chart** +--------------+-------------------------------+----------------+--------------------------------+ diff --git a/source/educators/olx/components/video-components.rst b/source/educators/olx/components/video-components.rst index 7b3d7b959..6260890ff 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). +You can add video components to a course unit via the ``video/.xml`` file. .. contents:: :local: @@ -19,19 +17,23 @@ 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. +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 your 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,12 +42,12 @@ For example, the vertical XML file uses the following format. .. code-block:: xml - -