diff --git a/source/educators/how-tos/course_development/exercise_tools/add_oppia_exploration.rst b/source/educators/how-tos/course_development/exercise_tools/add_oppia_exploration.rst new file mode 100644 index 000000000..2497a9fa8 --- /dev/null +++ b/source/educators/how-tos/course_development/exercise_tools/add_oppia_exploration.rst @@ -0,0 +1,57 @@ +.. _Enable the Oppia Exploration Tool: + +Enable the Oppia Exploration Tool +################################# + +.. tags:: educator, how-to + +Before you can add an Oppia exploration to your course, you must enable this +tool in Studio. + +To enable the Oppia exploration tool in Studio, you add the ``"oppia"`` key to +the **Advanced Module List** on the **Advanced Settings** page. (Be sure to +include the quotation marks around the key value.) For more information, see +:ref:`Enable Additional Exercises and Tools`. + +*********************************** +Add an Oppia Exploration in Studio +*********************************** + +You must :ref:`enable the Oppia exploration tool ` before you add a component with an exploration to your course. You must +also select the Oppia exploration that you want to add, and obtain both the URL +of the website that hosts that exploration and its ID. + +#. On the **Course Outline** page, open the unit in an ungraded subsection + where you want to add the exploration. + +#. Under **Add New Component**, select **Advanced**, and then select **Oppia + Exploration**. The new component is added to the unit. + +#. In the new component, select **Edit**. + + .. image:: /_images/educator_references/oppia_studio.png + :alt: The Edit component dialog box for an Oppia exploration in Studio. + :width: 600 + +#. In the **Component Display Name** field, enter an identifying name for the + component. In the LMS, this name appears as a heading above the exploration. + +#. In the **Oppia Exploration ID** field, enter the identifier assigned to the + exploration you want to add. For example, ``qG6kclSxlWZn`` or + ``gC4_ggkWar-L``. + +#. In the **Oppia Server URL** field, enter the host site of the exploration + you want to add. For example, ``www.oppia.org``. + +#. Select **Save**. + + Studio does not show the exploration on the unit page. To verify your work, + select **Preview**, or publish the unit and then select **View Live**. + +.. seealso:: + .. class::dropdown + + :ref:`Enable Additional Exercises and Tools` (how-to) + + :ref:`Oppia Exploration Tool` (reference) \ No newline at end of file diff --git a/source/educators/how-tos/course_development/exercise_tools/add_unsupported_problem_types.rst b/source/educators/how-tos/course_development/exercise_tools/add_unsupported_problem_types.rst new file mode 100644 index 000000000..cf8a00821 --- /dev/null +++ b/source/educators/how-tos/course_development/exercise_tools/add_unsupported_problem_types.rst @@ -0,0 +1,37 @@ +.. _Add Unsupported Exercises Problems: + +Adding Unsupported Problem Types and Exercises +############################################### + +.. tags:: educator, how-to + +In general, you should use only problem types and exercises that are either +fully or provisionally supported. By default, only supported problem +types and exercises are available in Studio for adding to courses. + +However, in some situations, you might choose to use exercises and problem types +that the Open edX Platform does not support. + +To add unsupported problem types, exercises, and tools to your course, follow +these steps. + +#. In Studio, select **Settings**, then **Advanced Settings**. + +#. Locate the **Add Unsupported Problems and Tools** field, and enter a value + of ``true``. + +#. Select **Save Changes**. + +After you enable this setting, unsupported problem types, exercises, and tools +are available in the lists of new components that you can add to your course +in Studio. + + +.. seealso:: + :class: dropdown + + :ref:`Create Exercises` (concept) + + :ref:`Enable Additional Exercises and Tools` (how to) + + :ref:`Core Problem Types` (reference) \ No newline at end of file diff --git a/source/educators/navigation/components_activities.rst b/source/educators/navigation/components_activities.rst index c0847cbb1..facb2c15f 100644 --- a/source/educators/navigation/components_activities.rst +++ b/source/educators/navigation/components_activities.rst @@ -14,6 +14,7 @@ The Open edX® Problem Component :maxdepth: 2 :glob: + ../references/course_development/exercise_tools/create_exercises_and_tools.rst ../how-tos/course_development/Subsection_configure_hints.rst ../how-tos/course_development/set_subsection_problem_date.rst ../references/course_development/Section_adding_tooltip.rst @@ -28,7 +29,7 @@ The Open edX® Problem Component ../concepts/exercise_tools/create_exercises.rst ../how-tos/course_development/exercise_tools/add_hints_advanced_editor.rst ../references/grading/gradebook_assignment_types.rst - ../references/course_development/exercise_tools/create_exercises_and_tools.rst + ../how-tos/course_development/exercise_tools/add_unsupported_problem_types.rst Chemical Equation Problem ******************************************************* @@ -207,7 +208,6 @@ Multi-Select Problem ../how-tos/add_checkbox.rst ../references/course_development/exercise_tools/multi_select_xml.rst ../references/course_development/exercise_tools/multi_select.rst - ../references/course_development/exercise_tools/checkbox.rst ../how-tos/course_development/exercise_tools/adding_multi_select.rst ../how-tos/course_development/exercise_tools/add_multi_select_partial_credit.rst diff --git a/source/educators/references/course_development/Section_learner_problem_view.rst b/source/educators/references/course_development/Section_learner_problem_view.rst index 3f9e8117d..84ce1dddd 100644 --- a/source/educators/references/course_development/Section_learner_problem_view.rst +++ b/source/educators/references/course_development/Section_learner_problem_view.rst @@ -1,12 +1,11 @@ .. _Learner View of Problems: -############################# The Learner View of a Problem ############################# .. tags:: educator, reference -All problems on the edX platform have these component parts, some of which can +All problems on the Open edX platform have these component parts, some of which can be configured. For configurable options, you can specify whether and when an option is available in problems. diff --git a/source/educators/references/course_development/create_problem.rst b/source/educators/references/course_development/create_problem.rst index f8a07f64e..7b54a348c 100644 --- a/source/educators/references/course_development/create_problem.rst +++ b/source/educators/references/course_development/create_problem.rst @@ -37,7 +37,7 @@ assessment, or custom JavaScript problems. Adding Graded or Ungraded Problems ===================================== -When you :ref:`establish the grading policy` for your course, +When you :ref:`establish the grading policy` for your course, you define the assignment types that count toward learners' grades: for example, homework, labs, midterm, final, and participation. You specify one of these assignment types for each of the subsections in your course. @@ -63,10 +63,10 @@ types** or select Advanced problem types for a list of **advanced problem types* * For simple problem types, the :ref:`simple editor` opens. In this editor, you can quickly create problems with question and answer formats. - Options for scoring, hints, feedback and more can be entered. + Options for scoring, hints, feedback, and more can be entered. * For advanced problem types, the :ref:`advanced editor` opens. - In this editor you use `EdX Open Learning XML Guide`_. + In this editor, you use `EdX Open Learning XML Guide`_. elements and attributes to identify the elements of the problem. Options for scoring, feedback and more can be entered. @@ -74,10 +74,10 @@ types** or select Advanced problem types for a list of **advanced problem types* options by using a graphical user interface. For more information, see :ref:`PA Create an ORA Assignment`. -* For drag and drop problem types, you build an interactive assessment in a +* For drag-and-drop problem types, you build an interactive assessment in a customized interface in which you define areas that learners can drag into target zones on a background image. For more information, see - :ref:`creating_a_drag_and_drop_problem`. + :ref:`Creating a Drag and Drop Problem`. You can switch from the simple editor to the advanced editor at any time by selecting the **Switch to advanced editor** from the simple editor's settings. @@ -97,7 +97,7 @@ the simple editor. * :ref:`Single Select` -* :ref:`Multi-select` +* :ref:`Multi-select` * :ref:`Dropdown` @@ -248,7 +248,7 @@ Power Paste ============ Many course authoring teams rely on copying and pasting content from documents -such as Google docs or Microsoft Word. Correct formatting in Studio and the LMS +such as Google Docs or Microsoft Word. Correct formatting in Studio and the LMS can be most easily realized through Power Paste. To learn how to use Power Paste, see :ref:`Paste without Formatting in a Text Component`. diff --git a/source/educators/references/course_development/exercise_tools/checkbox.rst b/source/educators/references/course_development/exercise_tools/checkbox.rst deleted file mode 100644 index dd52aecf8..000000000 --- a/source/educators/references/course_development/exercise_tools/checkbox.rst +++ /dev/null @@ -1,10 +0,0 @@ -:orphan: - -.. _Checkbox: - -######################################## -Checkbox -######################################## - -.. note:: - See :ref:`Multi-select` for documentation \ No newline at end of file diff --git a/source/educators/references/course_development/exercise_tools/create_exercises_and_tools.rst b/source/educators/references/course_development/exercise_tools/create_exercises_and_tools.rst index d5863d8a8..b0e916a1e 100644 --- a/source/educators/references/course_development/exercise_tools/create_exercises_and_tools.rst +++ b/source/educators/references/course_development/exercise_tools/create_exercises_and_tools.rst @@ -1,8 +1,7 @@ .. _Core Problem Types: -****************** Core Problem Types -****************** +################## .. tags:: educator, reference @@ -15,9 +14,9 @@ types are classified as either **Simple Problem Types** or **Advanced**. :local: :depth: 1 -==================== + Simple Problem Types -==================== +********************* When you create a problem in Studio, the editor opens with options for the following problem types. When you select any of the simple problem types, the @@ -34,7 +33,7 @@ following problem types. When you select any of the simple problem types, the - In single select problems, learners select one answer from a set of possible answers, which are visible directly below the question. - Full support; mobile-ready - * - :ref:`Multi-select` + * - :ref:`Multi select` - In multi-select problems, learners select one or more options from a list of possible answers. To answer the problem correctly, a learner must select all of the options that are correct answers, and none of the options @@ -64,9 +63,9 @@ the editor interface provides additional guidance and text fields for entering these options. All of these problem types also have full support and are mobile-ready. -======== -Advanced -======== + +Advanced Problem Types +*********************** If none of the simple problem types fit what you need, the editor's problem type select page has an option for **Advanced problem types**. Selecting this option @@ -84,7 +83,7 @@ advanced problem types, the :ref:`advanced editor` opens. .. note:: Some advanced problem types are :ref:`unsupported` and are not available in the list of problem types unless you enable a setting in Studio. For more information, see :ref:`Unsupported - Advanced Problem Types` and :ref:`Add_Unsupported_Exercises_Problems`. + Advanced Problem Types` and :ref:`Add Unsupported Exercises Problems`. .. list-table:: @@ -116,12 +115,12 @@ advanced problem types, the :ref:`advanced editor` opens. .. _Unsupported Advanced Problem Types: -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + Unsupported Advanced Problem Types -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +=================================== The following advanced problem types are :ref:`not supported` by edX. You can enable an option to make unsupported problem types +Support>` by the Open edX Platform. You can enable an option to make unsupported problem types available in Studio. For more information, see :ref:`Add_Unsupported_Exercises_Problems`. @@ -156,19 +155,17 @@ This table lists the fully or provisionally supported additional exercises and tools that you can add to your course. .. note:: Some additional exercises and tools are :ref:`not supported` by edX. You can enable an option to make unsupported exercises + of Support>` by the Open edX Platform. You can enable an option to make unsupported exercises and tools available in Studio. For more information, see :ref:`Unsupported Additional Exercises and Tools` and :ref:`Add_Unsupported_Exercises_Problems`. .. to come: revise to eliminate entries with no support. Add pointer (at least for Open edX) to all of the XBlocks that are available. -.. only:: Open_edX - .. note:: In addition to the following exercises and tools, Open edX offers +.. note:: In addition to the following exercises and tools, the Open edX platform offers the :ref:`Notes tool`. The Notes tool allows learners to - highlight and make notes about what they read in the course. This tool - is not available for courses on edx.org. + highlight and make notes about what they read in the course. T .. list-table:: :widths: 25 60 20 @@ -205,8 +202,8 @@ tools that you can add to your course. * - :ref:`External Grader` - An external grader is a service that receives learner responses to a problem, processes those responses, and returns feedback and a problem - grade to the edX platform. You build and deploy an external grader - separately from the edX platform. An external grader is particularly + grade to the Open edX platform. You build and deploy an external grader + separately from the Open edX platform. An external grader is particularly useful for software programming courses where learners are asked to submit complex code. - Provisional support @@ -227,7 +224,7 @@ tools that you can add to your course. - LTI components allow you to add an external learning application or non- PDF textbook to Studio. - Full support - * - :ref:`Open Response Assessment` + * - :ref:`Open Response Assessments` - Learners receive feedback on responses that they submit and give feedback to other course participants. Open response assessments include self assessment, peer assessment, and optionally, staff assessment. @@ -266,7 +263,7 @@ Unsupported Additional Exercises and Tools ========================================== The following additional exercises and tools are :ref:`not supported` by edX. You can enable an option to make unsupported exercises and +Support>` by the Open edX Platform. You can enable an option to make unsupported exercises and tools available in Studio. For more information, see :ref:`Add_Unsupported_Exercises_Problems`. @@ -311,11 +308,11 @@ tools available in Studio. For more information, see information about each element when learners move the pointer over each element. - Not supported - * - :ref:`Poll` + * - :ref:`Poll Tool for OLX` - You can run polls in your course so that your learners can share opinions on different questions. You can only add this type of poll to a course by using OLX (open learning XML). Support for this tool in Studio - is not available. For more information, see the `EdX Open Learning XML Guide`_.. + is not available. For more information, see the :ref:`Set Up Group Configuration for OLX Courses`. - Not supported * - :ref:`Problem Written in LaTeX` - If you have a problem that is already written in LaTeX, you can use this @@ -341,63 +338,33 @@ tools available in Studio. For more information, see sections in an image that can be enlarged. - Not supported -.. _Mobile-Ready Problem Types: +.. _Mobile Ready Problem Types: ************************** Mobile-Ready Problem Types ************************** Learners can read and submit answers for the following types of problems while -they use the edX mobile app. +they use the Open edX mobile app. * :ref:`drag_and_drop_problem` * :ref:`Dropdown` * :ref:`Math Expression Input` -* :ref:`Multi-select` +* :ref:`Multi select` * :ref:`Numerical Input` * :ref:`Single Select` * :ref:`Text Input` -Questions that have other problem types do not appear in the edX mobile app. +Questions that have other problem types do not appear in the Open edX mobile app. Instead, a message appears with a link to open the applicable problem component in a web browser. -.. _Add_Unsupported_Exercises_Problems: - -********************************************** -Adding Unsupported Problem Types and Exercises -********************************************** - - .. note:: These instructions are applicable only if your Open edX site has configured...insert name of the config setting. - -.. When DOC-3163 is complete, update this note to say "These instructions are applicable only to edx.org or if your Open edX site has configured {the name of the config setting}" - -In general, you should use only problem types and exercises that are either -fully or provisionally supported by edX. By default, only supported problem -types and exercises are available in Studio for adding to courses. - -However, in some situations, you might choose to use exercises and problem types -that edX does not support. - -To add unsupported problem types, exercises, and tools to your course, follow -these steps. - -#. In Studio, select **Settings**, then **Advanced Settings**. - -#. Locate the **Add Unsupported Problems and Tools** field, and enter a value - of ``true``. - -#. Select **Save Changes**. - -After you enable this setting, unsupported problem types, exercises, and tools -are available in the lists of new components that you can add to your course -in Studio. - - .. seealso:: :class: dropdown :ref:`Create Exercises` (concept) - :ref:'Enable Additional Exercises and Tools' (how to) \ No newline at end of file + :ref:`Enable Additional Exercises and Tools` (how to) + + :ref:`Add Unsupported Exercises Problems` (how to) \ No newline at end of file diff --git a/source/educators/references/course_development/exercise_tools/oppia_exploration.rst b/source/educators/references/course_development/exercise_tools/oppia_exploration.rst index 1d4251833..20b3abccd 100644 --- a/source/educators/references/course_development/exercise_tools/oppia_exploration.rst +++ b/source/educators/references/course_development/exercise_tools/oppia_exploration.rst @@ -42,52 +42,9 @@ LMS. For information about how to create Oppia explorations, see the `Oppia User Documentation`_. -.. _Enable the Oppia Exploration Tool: +.. seealso:: + .. class::dropdown -********************************************* -Enable the Oppia Exploration Tool -********************************************* + :ref:`Enable Additional Exercises and Tools` (how-to) -Before you can add an Oppia exploration to your course, you must enable this -tool in Studio. - -To enable the Oppia exploration tool in Studio, you add the ``"oppia"`` key to -the **Advanced Module List** on the **Advanced Settings** page. (Be sure to -include the quotation marks around the key value.) For more information, see -:ref:`Enable Additional Exercises and Tools`. - -*********************************** -Add an Oppia Exploration in Studio -*********************************** - -You must :ref:`enable the Oppia exploration tool ` before you add a component with an exploration to your course. You must -also select the Oppia exploration that you want to add, and obtain both the URL -of the website that hosts that exploration and its ID. - -#. On the **Course Outline** page, open the unit in an ungraded subsection - where you want to add the exploration. - -#. Under **Add New Component**, select **Advanced**, and then select **Oppia - Exploration**. The new component is added to the unit. - -#. In the new component, select **Edit**. - - .. image:: /_images/educator_references/oppia_studio.png - :alt: The Edit component dialog box for an Oppia exploration in Studio. - :width: 600 - -#. In the **Component Display Name** field, enter an identifying name for the - component. In the LMS, this name appears as a heading above the exploration. - -#. In the **Oppia Exploration ID** field, enter the identifier assigned to the - exploration you want to add. For example, ``qG6kclSxlWZn`` or - ``gC4_ggkWar-L``. - -#. In the **Oppia Server URL** field, enter the host site of the exploration - you want to add. For example, ``www.oppia.org``. - -#. Select **Save**. - - Studio does not show the exploration on the unit page. To verify your work, - select **Preview**, or publish the unit and then select **View Live**. + :ref:`Enable the Oppia Exploration Tool` (how-to) diff --git a/source/educators/references/course_development/modifying_released_problem.rst b/source/educators/references/course_development/modifying_released_problem.rst index 79f23e25f..8efbead2c 100644 --- a/source/educators/references/course_development/modifying_released_problem.rst +++ b/source/educators/references/course_development/modifying_released_problem.rst @@ -1,8 +1,7 @@ .. _Modifying a Released Problem: -***************************** Modifying a Released Problem -***************************** +############################# .. tags:: educator, reference @@ -34,9 +33,9 @@ If you change the points setting for the problem in Studio, however, existing scores update when the learner's **Progress** page is refreshed. In a 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 to ensure that every learner has the opportunity diff --git a/source/educators/references/course_development/problem_settings.rst b/source/educators/references/course_development/problem_settings.rst index 579d86ac7..515a132ec 100644 --- a/source/educators/references/course_development/problem_settings.rst +++ b/source/educators/references/course_development/problem_settings.rst @@ -1,8 +1,7 @@ .. _Problem Settings: -**************************************** Defining Settings for Problem Components -**************************************** +######################################## .. tags:: educator, reference @@ -26,9 +25,9 @@ problems. change the visibility of individual problems. For more information, see :ref:`Problem Results Visibility`. -============= + Display Name -============= +************ This required setting provides an identifying name for the problem. The display name appears as a heading above the problem in the LMS, and it identifies the @@ -48,9 +47,9 @@ in the LMS. .. _Problem Type: -======== + Type -======== +**** You can change the problem type after your initial selection. The current problem type is shown with a check mark. Selecting any other problem type will @@ -64,16 +63,16 @@ over when changing problem types. .. _Problem Scoring: -========== + Scoring -========== +******** These settings allow you to change the amount of points your problem is worth and the number of attempts a student has for answering it. ---------------- + Problem Points ---------------- +============== This setting specifies the total number of points possible for the problem. This defaults to 1 point. In the LMS, the number of points a problem is worth @@ -84,9 +83,9 @@ appears near the problem's display name. components that are in graded subsections count toward a learner's final grade. ---------------- + Attempts ---------------- +******** This setting specifies the number of times that a learner is allowed to try to answer this problem correctly. You can define a different **Attempts** @@ -106,18 +105,49 @@ the answer distribution computations used in the Student Answer Distribution report. .. note:: - EdX recommends setting **Maximum Attempts** to unlimited or a + The recomendation is to set **Maximum Attempts** to unlimited or a large number when possible. Problems that allow unlimited attempts encourage risk taking and experimentation, both of which lead to improved learning outcomes. However, allowing for unlimited attempts might not be feasible in some courses, such as those that use primarily single select or dropdown problems in graded subsections. +.. _Show Answer Number of Attempts: + + +Number of Attempts +================== + +This setting appears under the Show answer dropdown when the +**After some number of attempts**, **After all attempts** or +**After all attempts or correct** option is selected. This limits when +learners can select the **Show Answer** option for a problem. Learners must +submit at least the specified number of attempted answers for the problem +before the **Show Answer** option is available to them. + +.. _Time Between Attempts: + +Time Between Attempts +======================= + +This setting can be found on the collapsible settings to the right of the +problem editor after clicking **Show advanced settings**. It specifies the +number of seconds that a learner must wait between submissions for a problem +that allows multiple attempts. If the value is 0, the learner can attempt the +problem again immediately after an incorrect attempt. + +Adding required wait time between attempts can help to prevent learners from +simply guessing when multiple attempts are allowed. + +If a learner attempts a problem again before the required time has elapsed, they +see a message below the problem indicating the remaining wait time. The format +of the message is, "You must wait at least {n} seconds between submissions. {n} +seconds remaining." + .. _Hints: -============= Hints -============= +****** When you add hints, the **Hint** button is automatically displayed to learners. Learners can access the hints by selecting **Hint** beneath the problem. A @@ -144,9 +174,9 @@ been used, the **Hint** or **Next Hint** option is no longer available. :ref:`Configure Hint` (how-to) ------------------------------------ + Best Practices for Providing Hints ------------------------------------ +================================== To ensure that your hints can assist learners with varying backgrounds and levels of understanding, you should provide multiple hints with different @@ -162,9 +192,8 @@ solution for learners who are still confused. .. _Show Answer: -=============== Show Answer -=============== +*********** This setting can be found on the collapsible settings to the right of the problem editor after clicking Show advanced settings. This will add a @@ -236,24 +265,11 @@ options define when the answer is shown to learners. An explanation for the correct answer can be entered below. This explanation is displayed when the learner presses the Show answer option. -.. _Show Answer Number of Attempts: - -------------------- -Number of Attempts -------------------- - -This setting appears under the Show answer dropdown when the -**After some number of attempts**, **After all attempts** or -**After all attempts or correct** option is selected. This limits when -learners can select the **Show Answer** option for a problem. Learners must -submit at least the specified number of attempted answers for the problem -before the **Show Answer** option is available to them. - .. _Show Reset Button: -================= + Show Reset Button -================= +***************** This setting can be found on the collapsible settings to the right of the problem editor after clicking **Show advanced settings**. It defines whether a @@ -272,25 +288,6 @@ reached, the **Reset** option is not visible. This problem-level setting overrides the course-level **Show Reset Button for Problems** advanced setting. -.. _Time Between Attempts: - -======================= -Time Between Attempts -======================= - -This setting can be found on the collapsible settings to the right of the -problem editor after clicking **Show advanced settings**. It specifies the -number of seconds that a learner must wait between submissions for a problem -that allows multiple attempts. If the value is 0, the learner can attempt the -problem again immediately after an incorrect attempt. - -Adding required wait time between attempts can help to prevent learners from -simply guessing when multiple attempts are allowed. - -If a learner attempts a problem again before the required time has elapsed, they -see a message below the problem indicating the remaining wait time. The format -of the message is, "You must wait at least {n} seconds between submissions. {n} -seconds remaining." .. seealso:: :class: dropdown