From 0bb4ae1b5e768dbb5f16f56f422bd96fda6bf9fb Mon Sep 17 00:00:00 2001 From: Bryann Valderrama Date: Fri, 3 Jan 2025 12:53:27 -0500 Subject: [PATCH 01/15] docs: update 'create_image_mapped_input.rst' file --- .../create_image_mapped_input.rst | 19 ++++++++----------- 1 file changed, 8 insertions(+), 11 deletions(-) diff --git a/source/educators/how-tos/course_development/exercise_tools/create_image_mapped_input.rst b/source/educators/how-tos/course_development/exercise_tools/create_image_mapped_input.rst index b77cda0ab..5d38b47cd 100644 --- a/source/educators/how-tos/course_development/exercise_tools/create_image_mapped_input.rst +++ b/source/educators/how-tos/course_development/exercise_tools/create_image_mapped_input.rst @@ -1,8 +1,7 @@ -.. _Create Image Mapped Input Problem: +.. _Create Image Mapped Input Problem: -**************************************** Create an Image Mapped Input Problem -**************************************** +#################################### .. tags:: educator, how-to @@ -15,9 +14,8 @@ To create an image mapped input problem, follow these steps. .. _Determine Coordinates: -============================ Collect Image Information -============================ +************************* To create an image mapped input problem, you need the following elements. @@ -47,9 +45,8 @@ tool such as Microsoft Paint. .. _Create an IMI Problem in Studio: -================================================ Create an Image Mapped Input Problem in Studio -================================================ +********************************************** #. In Studio, upload your image to the **Files & Uploads** page, and make a note of the file path for the image. For more information, see :ref:`Add @@ -82,7 +79,7 @@ Create an Image Mapped Input Problem in Studio .. _Specify a Rectangular Region: Specify a Rectangular Region -**************************************** +============================ To specify a rectangular region, edit the ``rectangle`` attribute in the ```` element. @@ -129,7 +126,7 @@ two coordinate pairs: .. _Specify Multiple Rectangular Regions: Specify Multiple Rectangular Regions -**************************************** +==================================== You can specify more than one rectangular region in an image. @@ -172,7 +169,7 @@ For example, the following ``rectangle`` attribute creates three rectangles: .. _Specify an Irregular Region: Specify an Irregular Region -**************************************** +=========================== You can specify one non-rectangular region. @@ -218,4 +215,4 @@ For example, the following ``regions`` attribute creates a pentagon. :ref:`Image Mapped Input` (reference) - :ref:`Image Mapped Input Problem XML` (reference) \ No newline at end of file + :ref:`Image Mapped Input Problem XML` (reference) From 091bf2ae6c60ae661cb54fefe76a49b0fefbf98b Mon Sep 17 00:00:00 2001 From: Bryann Valderrama Date: Fri, 3 Jan 2025 13:50:13 -0500 Subject: [PATCH 02/15] docs: update 'enable_lti_component.rst' file --- .../exercise_tools/enable_lti_component.rst | 321 +----------------- .../setting_up_lti_1.1_component.rst | 145 ++++++++ .../setting_up_lti_1.3_component .rst | 79 +++++ .../using_lti_advantage_features.rst | 130 +++++++ .../navigation/components_activities.rst | 3 + 5 files changed, 364 insertions(+), 314 deletions(-) create mode 100644 source/educators/how-tos/course_development/exercise_tools/setting_up_lti_1.1_component.rst create mode 100644 source/educators/how-tos/course_development/exercise_tools/setting_up_lti_1.3_component .rst create mode 100644 source/educators/how-tos/course_development/exercise_tools/using_lti_advantage_features.rst diff --git a/source/educators/how-tos/course_development/exercise_tools/enable_lti_component.rst b/source/educators/how-tos/course_development/exercise_tools/enable_lti_component.rst index 9aa90911c..5c2e9a64f 100644 --- a/source/educators/how-tos/course_development/exercise_tools/enable_lti_component.rst +++ b/source/educators/how-tos/course_development/exercise_tools/enable_lti_component.rst @@ -1,8 +1,7 @@ .. _enable_lti_components: -****************************************** Enabling LTI Components for a Course -****************************************** +#################################### .. tags:: educator, how-to @@ -23,321 +22,15 @@ information, see :ref:`Enable Additional Exercises and Tools`. the previous LTI component will continue to work correctly, even if the ``lti`` module is no longer present in the **Advanced Module List**. - -.. _Setting up a LTI 1.1 component: - -******************************* -Setting up an LTI 1.1 component -******************************* - -Some LTI 1.1 tools require users to provide authentication credentials. If the LTI -tool you are including in your course requires authentication, you must add an -LTI passport for that tool to your course configuration. - -An LTI passport is a string of text that contains the authentication key and -shared secret for one LTI tool. A passport also contains the LTI ID for the -tool. When you add an LTI component to your course, assign it a matching LTI ID -so that it can use the LTI passport that it requires. - -For more information about creating and registering LTI passports, see the -following sections. - -.. contents:: - :local: - :depth: 1 - -========================================= -Creating an LTI Passport String -========================================= - -Each LTI passport includes three component text strings that are separated by -colon characters. The component strings are: the LTI ID, the client key, and -the client secret. - -- The **LTI ID** is a value that you create to refer to the remote LTI tool - provider. You should create an LTI ID that you can remember easily. - - The LTI ID can contain uppercase and lowercase alphanumeric characters, as - well as underscore characters (_). It can be any length. For example, you - can create an LTI ID that is as simple as ``test_lti_id``, or your LTI ID - can be a string of numbers and letters such as ``id_21441`` or - ``book_lti_provider_from_new_york``. - -- The **client key** is a sequence of characters that you obtain from the LTI - tool provider. The client key is used for authentication and can contain any - number of characters. For example, your client key might be - ``b289378-f88d-2929-ctools.school.edu``. - -- The **client secret** is a sequence of characters that you obtain from the - LTI tool provider. The client secret is used for authentication and can - contain any number of characters. For example, your client secret can be - something as simple as ``secret``, or it might be a string of numbers and - letters such as ``23746387264`` or ``yt4984yr8``. - -To create an LTI passport, combine the LTI ID, client key, -and client secret in the following format (be sure to include the colons). - -``{your_lti_id}:{client_key}:{client_secret}`` - -The following example LTI passports show the format of the -passport string. - -``test_lti_id:b289378-f88d-2929-ctools.school.edu:secret`` - -``id_21441:b289378-f88d-2929-ctools.school.edu:23746387264`` - -``book_lti_provider_from_new_york:b289378-f88d-2929-ctools.company.com:yt4984yr8`` - -.. _adding_an_lti_passport: - -================================================== -Adding an LTI Passport to the Course Configuration -================================================== - -To add an LTI passport for an LTI tool to the configuration for your course, follow these steps. - -#. From the Studio **Settings** menu, select **Advanced Settings**. - -#. In the **LTI Passports** field, place your cursor between the - brackets. - -#. Enter the LTI passport string surrounded by quotation marks. - - The following example shows an LTI passport string. - - ``"test_lti_id:b289378-f88d-2929-ctools.umich.edu:secret"`` - - For more information about creating your key, see :ref:`Setting up a LTI 1.1 component`. - -#. If you use more than one LTI provider in your course, separate each LTI - passport string with commas. Make sure to surround each entry with quotation - marks. The following example shows multiple LTI passports in the **LTI - Passports** field. - - .. code-block:: json - - [ - "test_lti_id:b289378-f88d-2929-ctools.umich.edu:secret", - "id_21441:b289378-f88d-2929-ctools.school.edu:23746387264", - "book_lti_provider_from_new_york:b289378-f88d-2929-ctools.company.com:yt4984yr8" - ] - -#. Select **Save Changes**. - -The page refreshes automatically, reformats your entry in the **LTI Passports** -field, and displays a notification that your changes have been saved. - - -========================================= -Adding an LTI Component to a Course Unit -========================================= - -To add an LTI 1.1 component to a course unit, follow these steps. - -#. If the LTI tool requires authentication, register the key and shared secret - for the LTI tool in the configuration for your course. For more information - about registering authentication credentials, see - :ref:`Setting up a LTI 1.1 component`. - -#. Edit the unit in which you want to add the remote LTI tool and select - **Advanced** from the **Add New Component** section. Select **LTI - Consumer**. - - If the **Advanced** component type is not available, make sure you have - enabled LTI components. To do this, see :ref:`enable_lti_components`. - -#. Select **Edit** in the component that appears. - -#. In the **LTI Version** field, select **LTI 1.1/1.2**. - -#. Configure the LTI component in the component editor. For more information - about each setting, see :ref:`LTI Component settings`. - -#. Select **Save**. - -To test an LTI component, use the **Preview** feature or view the live version -in the LMS. For more information, see :ref:`Testing Your Course Content`. - -.. _Setting up a LTI 1.3 component: - -******************************* -Setting up an LTI 1.3 component -******************************* - -To add an LTI 1.3 component to a course unit, follow these steps. - -#. Edit the unit in which you want to add the remote LTI tool and select - **Advanced** from the **Add New Component** section. Select **LTI - Consumer**. - - If the **Advanced** component type is not available, make sure you have - enabled LTI components. To do this, see :ref:`enable_lti_components`. - -#. Select **Edit** in the component that appears. - -#. In the **LTI Version** field, select **LTI 1.3**. - -#. Enter the LTI 1.3 settings provided from your tool. For basic LTI 1.3 - tools, without LTI Advantage, you need to set the following settings: - - * **LTI 1.3 Tool Launch URL** (can also be called redirect url) - * **LTI 1.3 OIDC URL** (can also be called login url) - - To enable *LTI Advantage* features, such as grades pass back and Deep Linking, - you also need to set **LTI 1.3 Tool Public Key** with a key provided by the - LTI tool. The key will look similar to this example: - - .. code-block:: bash - - -----BEGIN PUBLIC KEY----- - MIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEApAbQVx8FLXOflwvmV4dE - merOO/C+syqDG7MniysYzbMm+egZ8Z3Dq0e2YuggZlRSHVtT9TpTu6BrP7GyWrhH - 7nOgCx5Rz+9g/B+KsasZ9x35bPjMeqNAu5aP3b0xgaRtnWec0h0a6T1L2xaQLuPS - bDTJhABs0d22OYmdlMNN0+fWPmqxxAz8t7DBmjMMAmPLG4tjyEOwKCBlYCx0WELP - Izg9bYA7MhCpHyD6+kTB51dbOA6lBbrIszCO9PBV4RD96LQWPs3YQ+DTqvPfLeTQ - Q9XwiOe7yzsG1Ml+dkUODpZbuBk5Z9X486l36WbRWGBDWIWlsNE7M9Nl3eS42oS4 - IQIDAQAB - -----END PUBLIC KEY----- - - You should paste the key from the tool directly into the configuration field. - For more information about each setting, see :ref:`LTI Component settings`. - -#. Select **Save**. - -#. The Studio page will refresh and display LTI configuration required by the - tool. Copy each of those values and follow the instructions provided by the - tool to set them up. - - For basic LTI 1.3 launches, the following configuration values are required - (they are provided by the LTI tool being set up): - - * **Client** - * **Deployment ID** - * **Keyset URL** - * **OIDC Callback URL** (some tools refer to this as launch or redirect urls). - - For LTI Advantage, you'll also need to set **OAuth Token URL** (token/login url) - in the tool. - -.. note:: LTI 1.3 launches only work with published blocks, make sure the block is - published before doing a launch. - -.. _Enabling and using LTI Advantage features: - -***************************************** -Enabling and using LTI Advantage features -***************************************** - -LTI Advantage is an extension of the LTI 1.3 specification that enables additional -features in LTI components. See `LTI Advantage`_ for more information. - -Currently, the platform supports the following LTI Advantage extensions: - -`Assignments and Grades services`_ -`Deep Linking`_ -`Names and Roles Provisioning Service`_ - - -.. _Enabling LTI Assignments and Grades services: - -============================================ -Enabling LTI Assignments and Grades services -============================================ - -The LTI Assignments and Grades service (LTI-AGS) allows LTI tools to send and manage -learner grades back to the platform after an activity is completed. - -To set up LTI-AGS services on a component, follow these steps. - -#. Locate the unit and LTI component in which you want to enable LTI-AGS functionality. - -#. Select **Edit** in the component that appears. - -#. Locate the **LTI Assignment and Grades Service** setting. - -#. Select the operation mode of the Assignments and Grades services. You can disable - the LTI-AGS service by selecting **Disabled** or pick one of the operation - modes available: *declarative* to allow only one grade per problem, or *programmatic* - to let the tool create many grades. For more information about each mode, read the - corresponding entry on :ref:`LTI Component settings`. - -#. Select **Save**. - -.. _Enabling and using LTI Deep Linking: - -=================================== -Enabling and using LTI Deep Linking -=================================== - -The Deep Linking service (LTI-DL) allows course creators to select and configure -the content displayed to learners through Open edX Studio, removing the need to -use custom parameters and settings when setting up content, improving the ease of -use and content authoring experience. - -To set up LTI-DL services on a component, follow these steps. - -#. Locate the unit and LTI component in which you want to enable LTI-DL functionality. - -#. Select **Edit** in the component that appears. - -#. Locate the **Deep linking** setting and set it to **True** (enabled). - -#. Locate the **LTI Advantage Deep Linking Launch URL** setting. - -#. Retrieve the Deep Linking Launch url from the tool you're integrating with. If it's not - provided, try using the same value as in the **LTI 1.3 Tool Launch URL**. - -#. Select **Save**. The Studio page will refresh and show the updated details page. - -To use LTI Deep Linking, follow these steps: - -#. Ensure that LTI-DL is enabled by following the steps above. - -#. Locate the unit and LTI component in Studio. - -#. In the LTI component page in Studio, locate the **Deep Linking Launch - Configure tool** - link and select it. - -#. You'll be redirected to the Tool and presented with a page to select the options. - -#. Once the configuration is complete, you'll be redirected back to the Studio and the - Deep Linking setup will be complete. - -#. The content you selected in the tool will be presented to your students in the LMS. - -.. note:: LTI 1.3 launches only work with published blocks, make sure the block is - published before doing a Deep Link Launch. - - -.. _Enabling LTI Names and Roles Provisioning Service: - -================================================= -Enabling LTI Names and Roles Provisioning Service -================================================= - -The Names and Roles Provisioning service (LTI-NRPS) allows tools to list and retrieve -information about the learners that have access to an LTI component. -The tools that support this service can retrieve a limited amount of personal -information (full name, email, username) and the membership status of all the learners -enrolled in the course. - -To set up LTI-NRPS services on a component, follow these steps. - -#. Locate the unit and LTI component in which you want to enable LTI-NRPS functionality. - -#. Select **Edit** in the component that appears. - -#. Locate the **Enable LTI NRPS** setting and set it to **True** (enabled). - -#. Select **Save**. The LTI-NRPS will be enabled for all subsequent launches. - -.. note:: Due to performance concerns, LTI-NRPS information is by default only - available on courses with up to 1000 users. Site operators may adjust - this limit using the `LTI_NRPS_ACTIVE_ENROLLMENT_LIMIT setting`_. - .. seealso:: :class: dropdown :ref:`LTI Component` (reference) :ref:`LTI Component settings` (reference) + + :ref:`Setting up a LTI 1.1 component` (how-to) + + :ref:`Setting up a LTI 1.3 component` (how-to) + + :ref:`Enabling and using LTI Advantage features` (how-to) diff --git a/source/educators/how-tos/course_development/exercise_tools/setting_up_lti_1.1_component.rst b/source/educators/how-tos/course_development/exercise_tools/setting_up_lti_1.1_component.rst new file mode 100644 index 000000000..e8e09a42c --- /dev/null +++ b/source/educators/how-tos/course_development/exercise_tools/setting_up_lti_1.1_component.rst @@ -0,0 +1,145 @@ +.. _Setting up a LTI 1.1 component: + +Setting up an LTI 1.1 component +############################### + +.. tags:: educator, how-to + +Some LTI 1.1 tools require users to provide authentication credentials. If the +LTI tool you are including in your course requires authentication, you must add +an LTI passport for that tool to your course configuration. + +An LTI passport is a string of text that contains the authentication key and +shared secret for one LTI tool. A passport also contains the LTI ID for the +tool. When you add an LTI component to your course, assign it a matching LTI ID +so that it can use the LTI passport that it requires. + +For more information about creating and registering LTI passports, see the +following sections. + +.. contents:: + :local: + :depth: 1 + +Creating an LTI Passport String +******************************* + +Each LTI passport includes three component text strings that are separated by +colon characters. The component strings are: the LTI ID, the client key, and +the client secret. + +- The **LTI ID** is a value that you create to refer to the remote LTI tool + provider. You should create an LTI ID that you can remember easily. + + The LTI ID can contain uppercase and lowercase alphanumeric characters, as + well as underscore characters (_). It can be any length. For example, you + can create an LTI ID that is as simple as ``test_lti_id``, or your LTI ID + can be a string of numbers and letters such as ``id_21441`` or + ``book_lti_provider_from_new_york``. + +- The **client key** is a sequence of characters that you obtain from the LTI + tool provider. The client key is used for authentication and can contain any + number of characters. For example, your client key might be + ``b289378-f88d-2929-ctools.school.edu``. + +- The **client secret** is a sequence of characters that you obtain from the + LTI tool provider. The client secret is used for authentication and can + contain any number of characters. For example, your client secret can be + something as simple as ``secret``, or it might be a string of numbers and + letters such as ``23746387264`` or ``yt4984yr8``. + +To create an LTI passport, combine the LTI ID, client key, +and client secret in the following format (be sure to include the colons). + +``{your_lti_id}:{client_key}:{client_secret}`` + +The following example LTI passports show the format of the +passport string. + +``test_lti_id:b289378-f88d-2929-ctools.school.edu:secret`` + +``id_21441:b289378-f88d-2929-ctools.school.edu:23746387264`` + +``book_lti_provider_from_new_york:b289378-f88d-2929-ctools.company.com:yt4984yr8`` + +.. _adding_an_lti_passport: + +Adding an LTI Passport to the Course Configuration +************************************************** + +To add an LTI passport for an LTI tool to the configuration for your course, +follow these steps. + +#. From the Studio **Settings** menu, select **Advanced Settings**. + +#. In the **LTI Passports** field, place your cursor between the + brackets. + +#. Enter the LTI passport string surrounded by quotation marks. + + The following example shows an LTI passport string. + + ``"test_lti_id:b289378-f88d-2929-ctools.umich.edu:secret"`` + + For more information about creating your key, see :ref:`Setting up a LTI 1.1 + component`. + +#. If you use more than one LTI provider in your course, separate each LTI + passport string with commas. Make sure to surround each entry with quotation + marks. The following example shows multiple LTI passports in the **LTI + Passports** field. + + .. code-block:: json + + [ + "test_lti_id:b289378-f88d-2929-ctools.umich.edu:secret", + "id_21441:b289378-f88d-2929-ctools.school.edu:23746387264", + "book_lti_provider_from_new_york:b289378-f88d-2929-ctools.company.com:yt4984yr8" + ] + +#. Select **Save Changes**. + +The page refreshes automatically, reformats your entry in the **LTI Passports** +field, and displays a notification that your changes have been saved. + +Adding an LTI Component to a Course Unit +**************************************** + +To add an LTI 1.1 component to a course unit, follow these steps. + +#. If the LTI tool requires authentication, register the key and shared secret + for the LTI tool in the configuration for your course. For more information + about registering authentication credentials, see + :ref:`Setting up a LTI 1.1 component`. + +#. Edit the unit in which you want to add the remote LTI tool and select + **Advanced** from the **Add New Component** section. Select **LTI + Consumer**. + + If the **Advanced** component type is not available, make sure you have + enabled LTI components. To do this, see :ref:`enable_lti_components`. + +#. Select **Edit** in the component that appears. + +#. In the **LTI Version** field, select **LTI 1.1/1.2**. + +#. Configure the LTI component in the component editor. For more information + about each setting, see :ref:`LTI Component settings`. + +#. Select **Save**. + +To test an LTI component, use the **Preview** feature or view the live version +in the LMS. For more information, see :ref:`Testing Your Course Content`. + +.. seealso:: + :class: dropdown + + :ref:`LTI Component` (reference) + + :ref:`LTI Component settings` (reference) + + :ref:`Enable_LTI_Components` (how-to) + + :ref:`Setting up a LTI 1.3 component` (how-to) + + :ref:`Enabling and using LTI Advantage features` (how-to) diff --git a/source/educators/how-tos/course_development/exercise_tools/setting_up_lti_1.3_component .rst b/source/educators/how-tos/course_development/exercise_tools/setting_up_lti_1.3_component .rst new file mode 100644 index 000000000..8b5807ece --- /dev/null +++ b/source/educators/how-tos/course_development/exercise_tools/setting_up_lti_1.3_component .rst @@ -0,0 +1,79 @@ +.. _Setting up a LTI 1.3 component: + +Setting up an LTI 1.3 component +############################### + +.. tags:: educator, how-to + +To add an LTI 1.3 component to a course unit, follow these steps. + +#. Edit the unit in which you want to add the remote LTI tool and select + **Advanced** from the **Add New Component** section. Select **LTI + Consumer**. + + If the **Advanced** component type is not available, make sure you have + enabled LTI components. To do this, see :ref:`enable_lti_components`. + +#. Select **Edit** in the component that appears. + +#. In the **LTI Version** field, select **LTI 1.3**. + +#. Enter the LTI 1.3 settings provided from your tool. For basic LTI 1.3 + tools, without LTI Advantage, you need to set the following settings: + + * **LTI 1.3 Tool Launch URL** (can also be called redirect url) + * **LTI 1.3 OIDC URL** (can also be called login url) + + To enable *LTI Advantage* features, such as grades pass back and Deep + Linking, you also need to set **LTI 1.3 Tool Public Key** with a key + provided by the LTI tool. The key will look similar to this example: + + .. code-block:: bash + + -----BEGIN PUBLIC KEY----- + MIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEApAbQVx8FLXOflwvmV4dE + merOO/C+syqDG7MniysYzbMm+egZ8Z3Dq0e2YuggZlRSHVtT9TpTu6BrP7GyWrhH + 7nOgCx5Rz+9g/B+KsasZ9x35bPjMeqNAu5aP3b0xgaRtnWec0h0a6T1L2xaQLuPS + bDTJhABs0d22OYmdlMNN0+fWPmqxxAz8t7DBmjMMAmPLG4tjyEOwKCBlYCx0WELP + Izg9bYA7MhCpHyD6+kTB51dbOA6lBbrIszCO9PBV4RD96LQWPs3YQ+DTqvPfLeTQ + Q9XwiOe7yzsG1Ml+dkUODpZbuBk5Z9X486l36WbRWGBDWIWlsNE7M9Nl3eS42oS4 + IQIDAQAB + -----END PUBLIC KEY----- + + You should paste the key from the tool directly into the configuration + field. For more information about each setting, see :ref:`LTI Component + settings`. + +#. Select **Save**. + +#. The Studio page will refresh and display LTI configuration required by the + tool. Copy each of those values and follow the instructions provided by the + tool to set them up. + + For basic LTI 1.3 launches, the following configuration values are required + (they are provided by the LTI tool being set up): + + * **Client** + * **Deployment ID** + * **Keyset URL** + * **OIDC Callback URL** (some tools refer to this as launch or redirect + urls). + + For LTI Advantage, you'll also need to set **OAuth Token URL** (token/login + url) in the tool. + +.. note:: LTI 1.3 launches only work with published blocks, make sure the block + is published before doing a launch. + +.. seealso:: + :class: dropdown + + :ref:`LTI Component` (reference) + + :ref:`LTI Component settings` (reference) + + :ref:`Enable_LTI_Components` (how-to) + + :ref:`Setting up a LTI 1.1 component` (how-to) + + :ref:`Enabling and using LTI Advantage features` (how-to) diff --git a/source/educators/how-tos/course_development/exercise_tools/using_lti_advantage_features.rst b/source/educators/how-tos/course_development/exercise_tools/using_lti_advantage_features.rst new file mode 100644 index 000000000..294ad11f4 --- /dev/null +++ b/source/educators/how-tos/course_development/exercise_tools/using_lti_advantage_features.rst @@ -0,0 +1,130 @@ +.. _Enabling and using LTI Advantage features: + +Enabling and using LTI Advantage features +######################################### + +.. tags:: educator, how-to + +LTI Advantage is an extension of the LTI 1.3 specification that enables +additional features in LTI components. See `LTI Advantage`_ for more +information. + +Currently, the platform supports the following LTI Advantage extensions: + +* `Assignments and Grades services`_ +* `Deep Linking`_ +* `Names and Roles Provisioning Service`_ + +.. _Enabling LTI Assignments and Grades services: + +Enabling LTI Assignments and Grades services +******************************************** + +The LTI Assignments and Grades service (LTI-AGS) allows LTI tools to send and +manage learner grades back to the platform after an activity is completed. + +To set up LTI-AGS services on a component, follow these steps. + +#. Locate the unit and LTI component in which you want to enable LTI-AGS + functionality. + +#. Select **Edit** in the component that appears. + +#. Locate the **LTI Assignment and Grades Service** setting. + +#. Select the operation mode of the Assignments and Grades services. You can + disable the LTI-AGS service by selecting **Disabled** or pick one of the + operation modes available: *declarative* to allow only one grade per + problem, or *programmatic* to let the tool create many grades. For more + information about each mode, read the corresponding entry on :ref:`LTI + Component settings`. + +#. Select **Save**. + +.. _Enabling and using LTI Deep Linking: + +Enabling and using LTI Deep Linking +*********************************** + +The Deep Linking service (LTI-DL) allows course creators to select and +configure the content displayed to learners through Open edX Studio, removing +the need to use custom parameters and settings when setting up content, +improving the ease of use and content authoring experience. + +To set up LTI-DL services on a component, follow these steps. + +#. Locate the unit and LTI component in which you want to enable LTI-DL + functionality. + +#. Select **Edit** in the component that appears. + +#. Locate the **Deep linking** setting and set it to **True** (enabled). + +#. Locate the **LTI Advantage Deep Linking Launch URL** setting. + +#. Retrieve the Deep Linking Launch url from the tool you're integrating with. + If it's not provided, try using the same value as in the **LTI 1.3 Tool + Launch URL**. + +#. Select **Save**. The Studio page will refresh and show the updated details + page. + +To use LTI Deep Linking, follow these steps: + +#. Ensure that LTI-DL is enabled by following the steps above. + +#. Locate the unit and LTI component in Studio. + +#. In the LTI component page in Studio, locate the **Deep Linking Launch - + Configure tool** link and select it. + +#. You'll be redirected to the Tool and presented with a page to select the + options. + +#. Once the configuration is complete, you'll be redirected back to the Studio + and the Deep Linking setup will be complete. + +#. The content you selected in the tool will be presented to your students in + the LMS. + +.. note:: LTI 1.3 launches only work with published blocks, make sure the block + is published before doing a Deep Link Launch. + +.. _Enabling LTI Names and Roles Provisioning Service: + +Enabling LTI Names and Roles Provisioning Service +************************************************* + +The Names and Roles Provisioning service (LTI-NRPS) allows tools to list and +retrieve information about the learners that have access to an LTI component. +The tools that support this service can retrieve a limited amount of personal +information (full name, email, username) and the membership status of all the +learners enrolled in the course. + +To set up LTI-NRPS services on a component, follow these steps. + +#. Locate the unit and LTI component in which you want to enable LTI-NRPS + functionality. + +#. Select **Edit** in the component that appears. + +#. Locate the **Enable LTI NRPS** setting and set it to **True** (enabled). + +#. Select **Save**. The LTI-NRPS will be enabled for all subsequent launches. + +.. note:: Due to performance concerns, LTI-NRPS information is by default only + available on courses with up to 1000 users. Site operators may adjust + this limit using the `LTI_NRPS_ACTIVE_ENROLLMENT_LIMIT setting`_. + +.. seealso:: + :class: dropdown + + :ref:`LTI Component` (reference) + + :ref:`LTI Component settings` (reference) + + :ref:`Enable_LTI_Components` (how-to) + + :ref:`Setting up a LTI 1.1 component` (how-to) + + :ref:`Setting up a LTI 1.3 component` (how-to) diff --git a/source/educators/navigation/components_activities.rst b/source/educators/navigation/components_activities.rst index 817570b57..4f15d50de 100644 --- a/source/educators/navigation/components_activities.rst +++ b/source/educators/navigation/components_activities.rst @@ -185,6 +185,9 @@ LTI Component ../references/course_development/exercise_tools/lti_component_settings.rst ../references/course_development/exercise_tools/lti_component.rst ../how-tos/course_development/exercise_tools/enable_lti_component.rst + ../how-tos/course_development/exercise_tools/setting_up_lti_1.1_component.rst + ../how-tos/course_development/exercise_tools/setting_up_lti_1.3_component.rst + ../how-tos/course_development/exercise_tools/using_lti_advantage_features.rst ../how-tos/using_lti.rst Math Expression Input Problem From 539c75e4ed477fd848f5cd3eb6b452da843fc61e Mon Sep 17 00:00:00 2001 From: Bryann Valderrama Date: Fri, 3 Jan 2025 13:56:34 -0500 Subject: [PATCH 03/15] docs: update 'adding_math_expresion_problems.rst' file --- .../exercise_tools/adding_math_expression_problem.rst | 7 +++---- 1 file changed, 3 insertions(+), 4 deletions(-) diff --git a/source/educators/how-tos/course_development/exercise_tools/adding_math_expression_problem.rst b/source/educators/how-tos/course_development/exercise_tools/adding_math_expression_problem.rst index 205970575..6e860cf6e 100644 --- a/source/educators/how-tos/course_development/exercise_tools/adding_math_expression_problem.rst +++ b/source/educators/how-tos/course_development/exercise_tools/adding_math_expression_problem.rst @@ -1,8 +1,7 @@ -.. _Adding Math Expression Problem: +.. _Adding Math Expression Problem: -************************************** Adding a Math Expression Input Problem -************************************** +###################################### .. tags:: educator, how-to @@ -34,4 +33,4 @@ To create a math expression input problem, follow these steps. :ref:`Math Expression Input` (reference) - :ref:`Math Expression Input Problem XML` (reference) \ No newline at end of file + :ref:`Math Expression Input Problem XML` (reference) From 93ca2dd7cb01e40c80bc4ed09b4e889ddefd7588 Mon Sep 17 00:00:00 2001 From: Bryann Valderrama Date: Tue, 7 Jan 2025 14:09:32 -0500 Subject: [PATCH 04/15] docs: update 'add_multiselect_partial_credit.rst' file --- .../add_multi_select_partial_credit.rst | 19 +++++++------------ 1 file changed, 7 insertions(+), 12 deletions(-) diff --git a/source/educators/how-tos/course_development/exercise_tools/add_multi_select_partial_credit.rst b/source/educators/how-tos/course_development/exercise_tools/add_multi_select_partial_credit.rst index e1a9f9f59..cd1bafb94 100644 --- a/source/educators/how-tos/course_development/exercise_tools/add_multi_select_partial_credit.rst +++ b/source/educators/how-tos/course_development/exercise_tools/add_multi_select_partial_credit.rst @@ -1,8 +1,7 @@ .. _Awarding Partial Credit in a Multi select Problem: -============================= Awarding Partial Credit -============================= +####################### .. tags:: educator, how-to @@ -32,9 +31,8 @@ problem. .. _Every Decision Counts: ---------------------------------------- Using the Every Decision Counts Method ---------------------------------------- +************************************** You can configure a multi-select problem so that every selection a learner makes for the multi-select problem is evaluated and scored. This method is known as every @@ -79,9 +77,8 @@ would score for one EDC problem whose answers are as follows. - The learner matched 1 of the correct answers for 25%, but selected the incorrect answer. -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ Configure an EDC Multi-select Problem -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ +===================================== To configure an EDC multi-select problem, you add the ``partial_credit="EDC"`` attribute to the ```` element in the problem OLX. @@ -104,9 +101,8 @@ updated to provide partial credit. --------------------------------------- Using the By Halves Method --------------------------------------- +************************** You can configure a multi-select problem so that for every answer that a learner gets wrong, either by not selecting a correct answer or by selecting an @@ -252,9 +248,8 @@ for problems with an increasing number of total answer options. - 7 - 0 -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ Configure a By Halves Multi-select Problem -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ +========================================== To configure a by halves multi-select problem, you add the ``partial_credit="halves"`` attribute to the ```` element in @@ -284,8 +279,8 @@ halves. :ref:`Multi select` (reference) - :ref:`Adding a Multi Select Problem` (how to) + :ref:`Adding a Multi Select Problem` (how-to) - :ref:`Adding Feedback and Hints to a Problem` (how to) + :ref:`Adding Feedback and Hints to a Problem` (how-to) :ref:`Multi select Problem XML` (reference) From fe5f253d448642cf03a4b2760631af6effdb6915 Mon Sep 17 00:00:00 2001 From: Bryann Valderrama Date: Tue, 7 Jan 2025 14:28:03 -0500 Subject: [PATCH 05/15] docs: update 'enable_notes.rst' file --- .../exercise_tools/enable_notes.rst | 16 +++++++++++++--- 1 file changed, 13 insertions(+), 3 deletions(-) diff --git a/source/educators/how-tos/course_development/exercise_tools/enable_notes.rst b/source/educators/how-tos/course_development/exercise_tools/enable_notes.rst index 5f56d868e..036718995 100644 --- a/source/educators/how-tos/course_development/exercise_tools/enable_notes.rst +++ b/source/educators/how-tos/course_development/exercise_tools/enable_notes.rst @@ -1,8 +1,7 @@ .. _Notes Tool: -############################## Notes Tool -############################## +########## .. tags:: educator, how-to @@ -39,4 +38,15 @@ tool, follow these steps. #. Select **Apply** to save your configuration changes. For more information about the ways learners can use notes, see - `SFD Notes`_. \ No newline at end of file + `SFD Notes`_. + +.. seealso:: + :class: dropdown + + :ref:`RecommenderXBlock` (how-to) + + :ref:`Annotation` (how-to) + + :ref:`Calculator` (how-to) + + :ref:`Enable Completion` (how-to) From 607ffe41308f887ff6b79827964d079f656b7b54 Mon Sep 17 00:00:00 2001 From: Bryann Valderrama Date: Tue, 7 Jan 2025 14:38:32 -0500 Subject: [PATCH 06/15] docs: update 'edit_numerical_input_advanced.rst' file --- .../edit_numerical_input_advanced.rst | 25 +++++++------------ 1 file changed, 9 insertions(+), 16 deletions(-) diff --git a/source/educators/how-tos/course_development/exercise_tools/edit_numerical_input_advanced.rst b/source/educators/how-tos/course_development/exercise_tools/edit_numerical_input_advanced.rst index 20ec5bc76..2704ba7aa 100644 --- a/source/educators/how-tos/course_development/exercise_tools/edit_numerical_input_advanced.rst +++ b/source/educators/how-tos/course_development/exercise_tools/edit_numerical_input_advanced.rst @@ -1,8 +1,7 @@ .. _Editing Numerical Input Problems using the Advanced Editor: -************************************************************** Editing Numerical Input Problems using the Advanced Editor -************************************************************** +########################################################## .. tags:: educator, how-to @@ -37,9 +36,8 @@ You can see the OLX for the example problem from the Overview section below. changes you make in the advanced editor, you may not be able to cannot switch back to the simple editor. -=================== Adding Feedback -=================== +*************** In the advanced editor, you configure feedback with the following syntax. @@ -68,18 +66,15 @@ For example, the following problem has feedback for each answer. If you define multiple correct responses, you can define feedback for each response. - -=================== Adding Hints -=================== +************ See :ref:`Adding Hints via the Advanced Editor` for more information about adding hints to problems. .. _Multiple Responses in Numerical Input Problems: -========================================= Adding Multiple Correct Responses -========================================= +********************************* You can specify more than one specific, correct response for numerical input problems. To do this, use the advanced editor. @@ -104,9 +99,8 @@ To specify an additional correct response in the advanced editor, within the -========================================= Adding a Tolerance -========================================= +****************** You can specify a margin of error or tolerance for learner responses. You can specify a percentage, number, or range. @@ -139,9 +133,8 @@ The following example shows a problem with a percentage tolerance. -========================================= Specifying an Answer Range -========================================= +************************** You can specify an answer range so that any learner response within that range is marked correct. To format an answer range, you provide the starting @@ -169,10 +162,10 @@ attribute: ```` or :ref:`Numerical Input` (reference) - :ref:`Adding Numerical Input Problem` (how to) + :ref:`Adding Numerical Input Problem` (how-to) - :ref:`Use Feedback in a Numerical Input Problems` (how to) + :ref:`Use Feedback in a Numerical Input Problems` (how-to) :ref:`Numerical Input Problem XML` (reference) - :ref:`Awarding Partial Credit in a Numerical Input Problem` (how to) \ No newline at end of file + :ref:`Awarding Partial Credit in a Numerical Input Problem` (how-to) From 3721839054d085fff355e4be72eec3bc71c1e8d8 Mon Sep 17 00:00:00 2001 From: Bryann Valderrama Date: Tue, 7 Jan 2025 15:37:31 -0500 Subject: [PATCH 07/15] docs: remove note to edx in 'enable_notes.rst' file --- .../how-tos/course_development/exercise_tools/enable_notes.rst | 3 --- 1 file changed, 3 deletions(-) diff --git a/source/educators/how-tos/course_development/exercise_tools/enable_notes.rst b/source/educators/how-tos/course_development/exercise_tools/enable_notes.rst index 036718995..9c4bc067b 100644 --- a/source/educators/how-tos/course_development/exercise_tools/enable_notes.rst +++ b/source/educators/how-tos/course_development/exercise_tools/enable_notes.rst @@ -37,9 +37,6 @@ tool, follow these steps. #. Select **Apply** to save your configuration changes. - For more information about the ways learners can use notes, see - `SFD Notes`_. - .. seealso:: :class: dropdown From acb43420d66e1500dbc9979b5aa43562fa049924 Mon Sep 17 00:00:00 2001 From: Bryann Valderrama Date: Tue, 7 Jan 2025 15:41:02 -0500 Subject: [PATCH 08/15] docs: update 'add_checkbox.rst' file --- source/educators/how-tos/add_checkbox.rst | 17 ++++++++++++++++- 1 file changed, 16 insertions(+), 1 deletion(-) diff --git a/source/educators/how-tos/add_checkbox.rst b/source/educators/how-tos/add_checkbox.rst index 6aa9ebe9c..d582a6bf4 100644 --- a/source/educators/how-tos/add_checkbox.rst +++ b/source/educators/how-tos/add_checkbox.rst @@ -1,3 +1,5 @@ +.. _Adding a Checkbox Problem: + Add a Checkbox Problem ###################### @@ -5,4 +7,17 @@ Add a Checkbox Problem To create a checkbox (also known as "multi-select") problem, follow this video guide: -.. youtube:: 6VYKcMeZrxg \ No newline at end of file +.. youtube:: 6VYKcMeZrxg + +.. seealso:: + :class: dropdown + + :ref:`Multi select` (reference) + + :ref:`Adding a Multi Select Problem` (how-to) + + :ref:`Adding Feedback and Hints to a Problem` (how-to) + + :ref:`Multi select Problem XML` (reference) + + :ref:`Awarding Partial Credit in a Multi select Problem` (how-to) From bcbb24e1b1b2ef65ba57d69fc2ea4447e0845aec Mon Sep 17 00:00:00 2001 From: Bryann Valderrama Date: Tue, 7 Jan 2025 15:50:49 -0500 Subject: [PATCH 09/15] docs: update and split 'adding_multi_select.rst' file --- .../exercise_tools/adding_multi_select.rst | 180 ++---------------- ...ing_multi_select_using_advanced_editor.rst | 162 ++++++++++++++++ .../navigation/components_activities.rst | 1 + 3 files changed, 174 insertions(+), 169 deletions(-) create mode 100644 source/educators/how-tos/course_development/exercise_tools/editing_multi_select_using_advanced_editor.rst diff --git a/source/educators/how-tos/course_development/exercise_tools/adding_multi_select.rst b/source/educators/how-tos/course_development/exercise_tools/adding_multi_select.rst index 5edc503ea..c9fc79495 100644 --- a/source/educators/how-tos/course_development/exercise_tools/adding_multi_select.rst +++ b/source/educators/how-tos/course_development/exercise_tools/adding_multi_select.rst @@ -1,8 +1,7 @@ -.. _Adding a Multi Select Problem: +.. _Adding a Multi Select Problem: -****************************** Adding a Multi-select Problem -****************************** +############################# .. tags:: educator, how-to @@ -33,9 +32,8 @@ out :ref:`Simple Editor` and :ref:`Problem Settings`. .. _Adding Feedback for Multi select Problems: -================== Adding Feedback -================== +*************** For an overview of feedback in problems, see :ref:`Adding Feedback and Hints to a Problem`. For multi-select problems, you can add feedback for each of the answer @@ -43,9 +41,8 @@ options you provide in the problem. You can also identify different combinations of answer options that learners are likely to select, and add group feedback for those combinations. ------------------------------------------ Adding Feedback for Individual Answers ------------------------------------------ +====================================== In multi-select problems, you can provide feedback for each answer that a learner can select, with distinct feedback depending on whether or not the learner @@ -73,9 +70,8 @@ right of the answer text. the 'is selected' and 'is not selected' feedback fields. :width: 600 ------------------------------------------ Adding Group Feedback ------------------------------------------ +===================== You can configure the multi-select problem to provide group feedback. Group feedback is feedback given for a specific combination of answers. For @@ -117,177 +113,23 @@ and (A, C) respectively. .. _Use Hints in a Multi select Problem: -======================================== Adding Hints -======================================== +============ You can add hints to a multi-select problem. For an overview of hints in problems, see :ref:`Adding Feedback and Hints to a Problem`. - -.. _Editing Multi select Problems using the Advanced Editor: - -********************************************************** -Editing Multi-select Problems using the Advanced Editor -********************************************************** - -If the simple editor is not enough to meet your needs, you can switch over to the -advanced editor. In the setting panels on the right of the editor, click -**Show advanced settings**, then scroll down and click -**Switch to advanced editor**. - -You can use the advanced editor to identify the elements of a multi-select problem -with OLX. For more information, see :ref:`Multi-select Problem XML`. To format equations, -you can use MathJax. For more information, see :ref:`MathJax in Studio`. - -You can see the OLX for the example problem from the Overview section below. - -.. code-block:: xml - - - - - Check all of the options below that might be reasons why. - - A large amount of time passes between - undertaking a preventative measure and seeing the result. - Non-immunized people will always fall sick. - If others are immunized, fewer people will fall - sick regardless of a particular individual's choice to get immunized - or not. - Trust in health care professionals and - government officials is fragile. - - -
-

Explanation

-

People who are not immunized against a disease might still not - fall sick from the disease. If someone is trying to learn whether - or not preventative measures against the disease have any impact, - he or she might see these people and conclude, since they have - remained healthy despite not being immunized, that immunizations - have no effect. Consequently, he or she would tend to believe that - immunization (or other preventative measures) have fewer benefits - than they actually do.

-
- - - - -.. note:: You can begin work on the problem in the simple editor, and then - switch to the advanced editor. However, after you save any advanced OLX - changes you make in the advanced editor, you may not be able to cannot - switch back to the simple editor. - -============================= -Adding Feedback -============================= - -There are several types of feedback you can add for a multi-select problem -and different ways to configure them: - -.. contents:: - :local: - :depth: 1 - ----------------------------------------- -Adding Feedback for Individual Answers ----------------------------------------- - -In the advanced editor, you configure feedback with the following syntax. - -.. code-block:: xml - - Choice label - Feedback for when learner selects this - answer. - Feedback for when learner does not select - this answer. - - -For example, the following problem has feedback for each answer. - -.. code-block:: xml - - - - - You can select only one option. - - apple - An apple is the fertilized ovary that comes from an apple - tree and contains seeds classifying it as a fruit. - - pumpkin - A pumpkin is the fertilized ovary of a squash plant - and contains seeds classifying it as a fruit. - - potato - A potato is an edible part of a plant in tuber form and - is classified as a vegetable. - - tomato - Many people mistakenly think a tomato is a vegetable. - However, because a tomato is the fertilized ovary of a tomato plant - and contains seeds it is classified as a fruit. - - - - - ------------------------- -Adding Group Feedback ------------------------- - -In the advanced editor, you define group feedback by adding a ```` -element within the ```` element. - -.. code-block:: xml - - . - . - . - - Feedback when learner selects - this combination of answers. - - -For example, the following group feedback is used when learners select -options **A, B, and D** or **A, B, C, and D**. - -.. code-block:: xml - - . - . - . - - An apple, pumpkin, and tomato are all - fruits as they all are fertilized ovaries of a plant and contain - seeds. - You are correct that an apple, pumpkin, - and tomato are all fruits as they all are fertilized ovaries of a - plant and contain seeds. However, a potato is not a fruit as it is an - edible part of a plant in tuber form and is classified as a vegetable. - - - -============== -Adding Hints -============== - -See :ref:`Adding Feedback and Hints to a Problem` for more information on adding hints to a problem. - .. seealso:: :class: dropdown :ref:`Multi select` (reference) - :ref:`Adding Feedback and Hints to a Problem` (how to) + :ref:`Adding a Checkbox Problem` (how-to) - :ref:`Multi select Problem XML` (reference) - - :ref:`Awarding Partial Credit in a Multi select Problem` (how to) + :ref:`Editing Multi select Problems using the Advanced Editor` (how-to) + :ref:`Adding Feedback and Hints to a Problem` (how-to) + :ref:`Multi select Problem XML` (reference) + :ref:`Awarding Partial Credit in a Multi select Problem` (how-to) diff --git a/source/educators/how-tos/course_development/exercise_tools/editing_multi_select_using_advanced_editor.rst b/source/educators/how-tos/course_development/exercise_tools/editing_multi_select_using_advanced_editor.rst new file mode 100644 index 000000000..481bd1dbc --- /dev/null +++ b/source/educators/how-tos/course_development/exercise_tools/editing_multi_select_using_advanced_editor.rst @@ -0,0 +1,162 @@ +.. _Editing Multi select Problems using the Advanced Editor: + +Editing Multi-select Problems using the Advanced Editor +####################################################### + +If the simple editor is not enough to meet your needs, you can switch over to the +advanced editor. In the setting panels on the right of the editor, click +**Show advanced settings**, then scroll down and click +**Switch to advanced editor**. + +You can use the advanced editor to identify the elements of a multi-select problem +with OLX. For more information, see :ref:`Multi-select Problem XML`. To format equations, +you can use MathJax. For more information, see :ref:`MathJax in Studio`. + +You can see the OLX for the example problem from the Overview section below. + +.. code-block:: xml + + + + + Check all of the options below that might be reasons why. + + A large amount of time passes between + undertaking a preventative measure and seeing the result. + Non-immunized people will always fall sick. + If others are immunized, fewer people will fall + sick regardless of a particular individual's choice to get immunized + or not. + Trust in health care professionals and + government officials is fragile. + + +
+

Explanation

+

People who are not immunized against a disease might still not + fall sick from the disease. If someone is trying to learn whether + or not preventative measures against the disease have any impact, + he or she might see these people and conclude, since they have + remained healthy despite not being immunized, that immunizations + have no effect. Consequently, he or she would tend to believe that + immunization (or other preventative measures) have fewer benefits + than they actually do.

+
+ + + + +.. note:: You can begin work on the problem in the simple editor, and then + switch to the advanced editor. However, after you save any advanced OLX + changes you make in the advanced editor, you may not be able to cannot + switch back to the simple editor. + +Adding Feedback +*************** + +There are several types of feedback you can add for a multi-select problem +and different ways to configure them: + +.. contents:: + :local: + :depth: 1 + +Adding Feedback for Individual Answers +====================================== + +In the advanced editor, you configure feedback with the following syntax. + +.. code-block:: xml + + Choice label + Feedback for when learner selects this + answer. + Feedback for when learner does not select + this answer. + + +For example, the following problem has feedback for each answer. + +.. code-block:: xml + + + + + You can select only one option. + + apple + An apple is the fertilized ovary that comes from an apple + tree and contains seeds classifying it as a fruit. + + pumpkin + A pumpkin is the fertilized ovary of a squash plant + and contains seeds classifying it as a fruit. + + potato + A potato is an edible part of a plant in tuber form and + is classified as a vegetable. + + tomato + Many people mistakenly think a tomato is a vegetable. + However, because a tomato is the fertilized ovary of a tomato plant + and contains seeds it is classified as a fruit. + + + + + +Adding Group Feedback +===================== + +In the advanced editor, you define group feedback by adding a ```` +element within the ```` element. + +.. code-block:: xml + + . + . + . + + Feedback when learner selects + this combination of answers. + + +For example, the following group feedback is used when learners select +options **A, B, and D** or **A, B, C, and D**. + +.. code-block:: xml + + . + . + . + + An apple, pumpkin, and tomato are all + fruits as they all are fertilized ovaries of a plant and contain + seeds. + You are correct that an apple, pumpkin, + and tomato are all fruits as they all are fertilized ovaries of a + plant and contain seeds. However, a potato is not a fruit as it is an + edible part of a plant in tuber form and is classified as a vegetable. + + + +Adding Hints +============ + +See :ref:`Adding Feedback and Hints to a Problem` for more information on adding hints to a problem. + +.. seealso:: + :class: dropdown + + :ref:`Multi select` (reference) + + :ref:`Adding a Checkbox Problem` (how-to) + + :ref:`Adding a Multi Select Problem` (how-to) + + :ref:`Adding Feedback and Hints to a Problem` (how-to) + + :ref:`Multi select Problem XML` (reference) + + :ref:`Awarding Partial Credit in a Multi select Problem` (how-to) diff --git a/source/educators/navigation/components_activities.rst b/source/educators/navigation/components_activities.rst index 4f15d50de..019233fbe 100644 --- a/source/educators/navigation/components_activities.rst +++ b/source/educators/navigation/components_activities.rst @@ -215,6 +215,7 @@ Multi-Select Problem ../references/course_development/exercise_tools/multi_select_xml.rst ../references/course_development/exercise_tools/multi_select.rst ../how-tos/course_development/exercise_tools/adding_multi_select.rst + ../how-tos/course_development/exercise_tools/editing_multi_select_using_advanced_editor.rst ../how-tos/course_development/exercise_tools/add_multi_select_partial_credit.rst Numerical Input Problem From 2781afd70697d7604abef891e675c714f7edf8b1 Mon Sep 17 00:00:00 2001 From: Bryann Valderrama Date: Tue, 7 Jan 2025 17:24:59 -0500 Subject: [PATCH 10/15] docs: update and split 'award_partial_credit_numerical_input.rst' file --- .../adding_text_in_numeric_response_field.rst | 66 +++++++++++++++++ .../award_partial_credit_numerical_input.rst | 72 +++---------------- .../navigation/components_activities.rst | 1 + 3 files changed, 77 insertions(+), 62 deletions(-) create mode 100644 source/educators/how-tos/course_development/exercise_tools/adding_text_in_numeric_response_field.rst diff --git a/source/educators/how-tos/course_development/exercise_tools/adding_text_in_numeric_response_field.rst b/source/educators/how-tos/course_development/exercise_tools/adding_text_in_numeric_response_field.rst new file mode 100644 index 000000000..aa7341ab7 --- /dev/null +++ b/source/educators/how-tos/course_development/exercise_tools/adding_text_in_numeric_response_field.rst @@ -0,0 +1,66 @@ +.. _Adding Text After the Numeric Response Field: + +Adding Text after the Numeric Response Field +############################################ + +.. tags:: educator, how-to + +You might want to include a word, phrase, or sentence after the response field +in a numerical input problem to help guide your students or resolve ambiguity. + +.. image:: /_images/educator_how_tos/NI_trailing_text.png + :width: 500 + :alt: Three numerical input problems with text after the response field: + "km", a percent sign, and a symbol for meters per second squared. + +To do this, you use the advanced editor. + +In the problem, locate the ``formulaequationinput`` element. This element +creates the response field for the problem and is a child of the +``numericalresponse`` element. + +To add text after the response field, add the ``trailing_text`` attribute +together with the symbol or text that you want to use inside the +``formulaequationinput`` element. An example problem follows with three +questions that use this attribute. + +.. note:: You can use MathJax inside the ``trailing_text`` attribute, as the + third question in this example shows. You cannot use HTML inside this + attribute. + +.. code-block:: xml + + + + + + + + + + + + + + + + + + + +.. seealso:: + :class: dropdown + + :ref:`Numerical Input` (reference) + + :ref:`Adding Numerical Input Problem` (how-to) + + :ref:`Awarding Partial Credit in a Numerical Input Problem` (how-to) + + :ref:`Use Feedback in a Numerical Input Problems` (how-to) + + :ref:`Editing Numerical Input Problems using the Advanced Editor` (how-to) + + :ref:`Numerical Input Problem XML` (reference) 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 b5e48384f..0ecd9b78a 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 @@ -1,8 +1,7 @@ .. _Awarding Partial Credit in a Numerical Input Problem: -========================================= Awarding Partial -========================================= +################ .. tags:: educator, how-to @@ -29,9 +28,8 @@ problem. .. note:: You can use these methods of awarding partial credit individually or in combination. --------------------------- Identifying Close Answers --------------------------- +************************* You can configure a numerical input problem so that answers that are close to the correct answer receive partial credit. @@ -56,9 +54,8 @@ apply. * An answer more than 3x outside of the tolerance receives 0%. -^^^^^^^^^^^^^^^^^^^^^^^^ Configure Close Answers -^^^^^^^^^^^^^^^^^^^^^^^^ +======================= To configure a numerical input problem to award partial credit for close answers, you add the following attributes to the problem XML. @@ -87,9 +84,8 @@ credit for close answers. ----------------------------------------------------- Awarding Partial Credit for Answers in a List ----------------------------------------------------- +********************************************* For some numerical input problems, mistakes do not help a learner arrive at the correct answer. For example, a small mistake can lead to negative instead of @@ -100,9 +96,8 @@ For these types of problems, you can configure a list of wrong answers that receive partial credit. Learners who submit answers that are on the list receive 50% of the problem's points. -^^^^^^^^^^^^^^^^^^ Configure a List -^^^^^^^^^^^^^^^^^^ +================ To configure a numerical input problem to award partial credit for answers in a list, you add the following attributes to the problem XML. @@ -131,64 +126,17 @@ updated to provide partial credit for a different answer. -============================================= -Adding Text after the Numeric Response Field -============================================= - -You might want to include a word, phrase, or sentence after the response field -in a numerical input problem to help guide your students or resolve ambiguity. - -.. image:: /_images/educator_how_tos/NI_trailing_text.png - :width: 500 - :alt: Three numerical input problems with text after the response field: - "km", a percent sign, and a symbol for meters per second squared. - -To do this, you use the advanced editor. - -In the problem, locate the ``formulaequationinput`` element. This element -creates the response field for the problem and is a child of the -``numericalresponse`` element. - -To add text after the response field, add the ``trailing_text`` attribute -together with the symbol or text that you want to use inside the -``formulaequationinput`` element. An example problem follows with three -questions that use this attribute. - -.. note:: You can use MathJax inside the ``trailing_text`` attribute, as the - third question in this example shows. You cannot use HTML inside this - attribute. - -.. code-block:: xml - - - - - - - - - - - - - - - - - - - .. seealso:: :class: dropdown :ref:`Numerical Input` (reference) - :ref:`Adding Numerical Input Problem` (how to) + :ref:`Adding Numerical Input Problem` (how-to) + + :ref:`Adding Text After the Numeric Response Field` (how-to) :ref:`Use Feedback in a Numerical Input Problems` (how-to) - :ref:`Editing Numerical Input Problems using the Advanced Editor` (how to) + :ref:`Editing Numerical Input Problems using the Advanced Editor` (how-to) - :ref:`Numerical Input Problem XML` (reference) \ No newline at end of file + :ref:`Numerical Input Problem XML` (reference) diff --git a/source/educators/navigation/components_activities.rst b/source/educators/navigation/components_activities.rst index 019233fbe..6fce102f3 100644 --- a/source/educators/navigation/components_activities.rst +++ b/source/educators/navigation/components_activities.rst @@ -229,6 +229,7 @@ Numerical Input Problem ../references/course_development/exercise_tools/numerical_input_xml.rst ../how-tos/course_development/exercise_tools/edit_numerical_input_advanced.rst ../how-tos/course_development/exercise_tools/award_partial_credit_numerical_input.rst + ../how-tos/course_development/exercise_tools/adding_text_in_numeric_response_field.rst ../how-tos/course_development/exercise_tools/create_problem_in_latex.rst ../how-tos/course_development/text_components/work_with_latex.rst ../how-tos/course_development/exercise_tools/add_numerical_input_problem.rst From e5d55d67886a8f3822b8d08f50e6e0cae9a686e0 Mon Sep 17 00:00:00 2001 From: Bryann Valderrama Date: Wed, 8 Jan 2025 18:16:14 -0500 Subject: [PATCH 11/15] fix: replace '.' by '_' in the file names --- ...lti_1.1_component.rst => setting_up_lti_1_1_component.rst} | 0 ...i_1.3_component .rst => setting_up_lti_1_3_component .rst} | 0 source/educators/navigation/components_activities.rst | 4 ++-- 3 files changed, 2 insertions(+), 2 deletions(-) rename source/educators/how-tos/course_development/exercise_tools/{setting_up_lti_1.1_component.rst => setting_up_lti_1_1_component.rst} (100%) rename source/educators/how-tos/course_development/exercise_tools/{setting_up_lti_1.3_component .rst => setting_up_lti_1_3_component .rst} (100%) diff --git a/source/educators/how-tos/course_development/exercise_tools/setting_up_lti_1.1_component.rst b/source/educators/how-tos/course_development/exercise_tools/setting_up_lti_1_1_component.rst similarity index 100% rename from source/educators/how-tos/course_development/exercise_tools/setting_up_lti_1.1_component.rst rename to source/educators/how-tos/course_development/exercise_tools/setting_up_lti_1_1_component.rst diff --git a/source/educators/how-tos/course_development/exercise_tools/setting_up_lti_1.3_component .rst b/source/educators/how-tos/course_development/exercise_tools/setting_up_lti_1_3_component .rst similarity index 100% rename from source/educators/how-tos/course_development/exercise_tools/setting_up_lti_1.3_component .rst rename to source/educators/how-tos/course_development/exercise_tools/setting_up_lti_1_3_component .rst diff --git a/source/educators/navigation/components_activities.rst b/source/educators/navigation/components_activities.rst index 6fce102f3..84a249248 100644 --- a/source/educators/navigation/components_activities.rst +++ b/source/educators/navigation/components_activities.rst @@ -185,8 +185,8 @@ LTI Component ../references/course_development/exercise_tools/lti_component_settings.rst ../references/course_development/exercise_tools/lti_component.rst ../how-tos/course_development/exercise_tools/enable_lti_component.rst - ../how-tos/course_development/exercise_tools/setting_up_lti_1.1_component.rst - ../how-tos/course_development/exercise_tools/setting_up_lti_1.3_component.rst + ../how-tos/course_development/exercise_tools/setting_up_lti_1_1_component.rst + ../how-tos/course_development/exercise_tools/setting_up_lti_1_3_component.rst ../how-tos/course_development/exercise_tools/using_lti_advantage_features.rst ../how-tos/using_lti.rst From e4ea2e92885584ece0364998f3a54aa0d5946b87 Mon Sep 17 00:00:00 2001 From: Bryann Valderrama Date: Wed, 8 Jan 2025 18:26:14 -0500 Subject: [PATCH 12/15] fix: remove blank space in the filename --- ...up_lti_1_3_component .rst => setting_up_lti_1_3_component.rst} | 0 1 file changed, 0 insertions(+), 0 deletions(-) rename source/educators/how-tos/course_development/exercise_tools/{setting_up_lti_1_3_component .rst => setting_up_lti_1_3_component.rst} (100%) diff --git a/source/educators/how-tos/course_development/exercise_tools/setting_up_lti_1_3_component .rst b/source/educators/how-tos/course_development/exercise_tools/setting_up_lti_1_3_component.rst similarity index 100% rename from source/educators/how-tos/course_development/exercise_tools/setting_up_lti_1_3_component .rst rename to source/educators/how-tos/course_development/exercise_tools/setting_up_lti_1_3_component.rst From fbb67b4d6364a61f3b2e2fed676d4ecee6d4e391 Mon Sep 17 00:00:00 2001 From: Bryann Valderrama Date: Thu, 9 Jan 2025 14:04:50 -0500 Subject: [PATCH 13/15] docs: replace adding by add in tags --- source/educators/how-tos/add_checkbox.rst | 4 ++-- .../exercise_tools/add_multi_select_partial_credit.rst | 2 +- .../exercise_tools/adding_multi_select.rst | 8 ++++---- .../adding_text_in_numeric_response_field.rst | 6 +++--- .../award_partial_credit_numerical_input.rst | 2 +- .../editing_multi_select_using_advanced_editor.rst | 4 ++-- .../course_development/exercise_tools/multi_select.rst | 6 +++--- .../exercise_tools/multi_select_xml.rst | 6 +++--- 8 files changed, 19 insertions(+), 19 deletions(-) diff --git a/source/educators/how-tos/add_checkbox.rst b/source/educators/how-tos/add_checkbox.rst index d582a6bf4..eab54ec48 100644 --- a/source/educators/how-tos/add_checkbox.rst +++ b/source/educators/how-tos/add_checkbox.rst @@ -1,4 +1,4 @@ -.. _Adding a Checkbox Problem: +.. _Add a Checkbox Problem: Add a Checkbox Problem ###################### @@ -14,7 +14,7 @@ To create a checkbox (also known as "multi-select") problem, follow this video g :ref:`Multi select` (reference) - :ref:`Adding a Multi Select Problem` (how-to) + :ref:`Add a Multi Select Problem` (how-to) :ref:`Adding Feedback and Hints to a Problem` (how-to) diff --git a/source/educators/how-tos/course_development/exercise_tools/add_multi_select_partial_credit.rst b/source/educators/how-tos/course_development/exercise_tools/add_multi_select_partial_credit.rst index cd1bafb94..59da962c2 100644 --- a/source/educators/how-tos/course_development/exercise_tools/add_multi_select_partial_credit.rst +++ b/source/educators/how-tos/course_development/exercise_tools/add_multi_select_partial_credit.rst @@ -279,7 +279,7 @@ halves. :ref:`Multi select` (reference) - :ref:`Adding a Multi Select Problem` (how-to) + :ref:`Add a Multi Select Problem` (how-to) :ref:`Adding Feedback and Hints to a Problem` (how-to) diff --git a/source/educators/how-tos/course_development/exercise_tools/adding_multi_select.rst b/source/educators/how-tos/course_development/exercise_tools/adding_multi_select.rst index c9fc79495..ddd9e4357 100644 --- a/source/educators/how-tos/course_development/exercise_tools/adding_multi_select.rst +++ b/source/educators/how-tos/course_development/exercise_tools/adding_multi_select.rst @@ -1,7 +1,7 @@ -.. _Adding a Multi Select Problem: +.. _Add a Multi Select Problem: -Adding a Multi-select Problem -############################# +Add a Multi-select Problem +########################## .. tags:: educator, how-to @@ -124,7 +124,7 @@ You can add hints to a multi-select problem. For an overview of hints in problem :ref:`Multi select` (reference) - :ref:`Adding a Checkbox Problem` (how-to) + :ref:`Add a Checkbox Problem` (how-to) :ref:`Editing Multi select Problems using the Advanced Editor` (how-to) diff --git a/source/educators/how-tos/course_development/exercise_tools/adding_text_in_numeric_response_field.rst b/source/educators/how-tos/course_development/exercise_tools/adding_text_in_numeric_response_field.rst index aa7341ab7..27c2cb6bf 100644 --- a/source/educators/how-tos/course_development/exercise_tools/adding_text_in_numeric_response_field.rst +++ b/source/educators/how-tos/course_development/exercise_tools/adding_text_in_numeric_response_field.rst @@ -1,7 +1,7 @@ -.. _Adding Text After the Numeric Response Field: +.. _Add Text After the Numeric Response Field: -Adding Text after the Numeric Response Field -############################################ +Add Text after the Numeric Response Field +######################################### .. tags:: educator, how-to 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 0ecd9b78a..48a758961 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 @@ -133,7 +133,7 @@ updated to provide partial credit for a different answer. :ref:`Adding Numerical Input Problem` (how-to) - :ref:`Adding Text After the Numeric Response Field` (how-to) + :ref:`Add Text After the Numeric Response Field` (how-to) :ref:`Use Feedback in a Numerical Input Problems` (how-to) diff --git a/source/educators/how-tos/course_development/exercise_tools/editing_multi_select_using_advanced_editor.rst b/source/educators/how-tos/course_development/exercise_tools/editing_multi_select_using_advanced_editor.rst index 481bd1dbc..5acc7e797 100644 --- a/source/educators/how-tos/course_development/exercise_tools/editing_multi_select_using_advanced_editor.rst +++ b/source/educators/how-tos/course_development/exercise_tools/editing_multi_select_using_advanced_editor.rst @@ -151,9 +151,9 @@ See :ref:`Adding Feedback and Hints to a Problem` for more information on adding :ref:`Multi select` (reference) - :ref:`Adding a Checkbox Problem` (how-to) + :ref:`Add a Checkbox Problem` (how-to) - :ref:`Adding a Multi Select Problem` (how-to) + :ref:`Add a Multi Select Problem` (how-to) :ref:`Adding Feedback and Hints to a Problem` (how-to) diff --git a/source/educators/references/course_development/exercise_tools/multi_select.rst b/source/educators/references/course_development/exercise_tools/multi_select.rst index 27bee8d48..7e45aadbb 100644 --- a/source/educators/references/course_development/exercise_tools/multi_select.rst +++ b/source/educators/references/course_development/exercise_tools/multi_select.rst @@ -52,10 +52,10 @@ selected **Show Answer** to reveal the correct answer and an explanation. .. seealso:: :class: dropdown - :ref:`Adding a Multi Select Problem` (how to) + :ref:`Add a Multi Select Problem` (how-to) - :ref:`Adding Feedback and Hints to a Problem` (how to) + :ref:`Adding Feedback and Hints to a Problem` (how-to) :ref:`Multi select Problem XML` (reference) - :ref:`Awarding Partial Credit in a Multi select Problem` (how to) + :ref:`Awarding Partial Credit in a Multi select Problem` (how-to) diff --git a/source/educators/references/course_development/exercise_tools/multi_select_xml.rst b/source/educators/references/course_development/exercise_tools/multi_select_xml.rst index 2b8e158fd..b03620016 100644 --- a/source/educators/references/course_development/exercise_tools/multi_select_xml.rst +++ b/source/educators/references/course_development/exercise_tools/multi_select_xml.rst @@ -337,8 +337,8 @@ correctness. :ref:`Multi select` (reference) - :ref:`Adding a Multi Select Problem` (how to) + :ref:`Add a Multi Select Problem` (how-to) - :ref:`Adding Feedback and Hints to a Problem` (how to) + :ref:`Adding Feedback and Hints to a Problem` (how-to) - :ref:`Awarding Partial Credit in a Multi select Problem` (how to) \ No newline at end of file + :ref:`Awarding Partial Credit in a Multi select Problem` (how-to) \ No newline at end of file From 83df8b2efa8c8b0f2bf564aca6b02c4bd000098d Mon Sep 17 00:00:00 2001 From: Bryann Valderrama Date: Fri, 10 Jan 2025 09:30:05 -0500 Subject: [PATCH 14/15] fix(docs): adjust titles for consistency with 'How To' phrasing --- .../exercise_tools/add_multi_select_partial_credit.rst | 4 ++-- .../exercise_tools/adding_math_expression_problem.rst | 4 ++-- .../exercise_tools/award_partial_credit_numerical_input.rst | 4 ++-- .../exercise_tools/edit_numerical_input_advanced.rst | 4 ++-- .../exercise_tools/enable_lti_component.rst | 4 ++-- .../course_development/exercise_tools/enable_notes.rst | 4 ++-- .../exercise_tools/setting_up_lti_1_1_component.rst | 4 ++-- .../exercise_tools/setting_up_lti_1_3_component.rst | 4 ++-- .../exercise_tools/using_lti_advantage_features.rst | 4 ++-- 9 files changed, 18 insertions(+), 18 deletions(-) diff --git a/source/educators/how-tos/course_development/exercise_tools/add_multi_select_partial_credit.rst b/source/educators/how-tos/course_development/exercise_tools/add_multi_select_partial_credit.rst index 59da962c2..89c2f1ee0 100644 --- a/source/educators/how-tos/course_development/exercise_tools/add_multi_select_partial_credit.rst +++ b/source/educators/how-tos/course_development/exercise_tools/add_multi_select_partial_credit.rst @@ -1,7 +1,7 @@ .. _Awarding Partial Credit in a Multi select Problem: -Awarding Partial Credit -####################### +Award Partial Credit +#################### .. tags:: educator, how-to diff --git a/source/educators/how-tos/course_development/exercise_tools/adding_math_expression_problem.rst b/source/educators/how-tos/course_development/exercise_tools/adding_math_expression_problem.rst index 6e860cf6e..461786160 100644 --- a/source/educators/how-tos/course_development/exercise_tools/adding_math_expression_problem.rst +++ b/source/educators/how-tos/course_development/exercise_tools/adding_math_expression_problem.rst @@ -1,7 +1,7 @@ .. _Adding Math Expression Problem: -Adding a Math Expression Input Problem -###################################### +Add a Math Expression Input Problem +################################### .. tags:: educator, how-to 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 48a758961..a0b4cd790 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 @@ -1,7 +1,7 @@ .. _Awarding Partial Credit in a Numerical Input Problem: -Awarding Partial -################ +Award Partial Credit in a Numerical Input Problem +################################################# .. tags:: educator, how-to diff --git a/source/educators/how-tos/course_development/exercise_tools/edit_numerical_input_advanced.rst b/source/educators/how-tos/course_development/exercise_tools/edit_numerical_input_advanced.rst index 2704ba7aa..c35b88881 100644 --- a/source/educators/how-tos/course_development/exercise_tools/edit_numerical_input_advanced.rst +++ b/source/educators/how-tos/course_development/exercise_tools/edit_numerical_input_advanced.rst @@ -1,7 +1,7 @@ .. _Editing Numerical Input Problems using the Advanced Editor: -Editing Numerical Input Problems using the Advanced Editor -########################################################## +Edit Numerical Input Problems using the Advanced Editor +####################################################### .. tags:: educator, how-to diff --git a/source/educators/how-tos/course_development/exercise_tools/enable_lti_component.rst b/source/educators/how-tos/course_development/exercise_tools/enable_lti_component.rst index 5c2e9a64f..03976e9ac 100644 --- a/source/educators/how-tos/course_development/exercise_tools/enable_lti_component.rst +++ b/source/educators/how-tos/course_development/exercise_tools/enable_lti_component.rst @@ -1,7 +1,7 @@ .. _enable_lti_components: -Enabling LTI Components for a Course -#################################### +Enable LTI Components for a Course +################################## .. tags:: educator, how-to diff --git a/source/educators/how-tos/course_development/exercise_tools/enable_notes.rst b/source/educators/how-tos/course_development/exercise_tools/enable_notes.rst index 9c4bc067b..eb38178f8 100644 --- a/source/educators/how-tos/course_development/exercise_tools/enable_notes.rst +++ b/source/educators/how-tos/course_development/exercise_tools/enable_notes.rst @@ -1,7 +1,7 @@ .. _Notes Tool: -Notes Tool -########## +Enable the Notes Tool +##################### .. tags:: educator, how-to diff --git a/source/educators/how-tos/course_development/exercise_tools/setting_up_lti_1_1_component.rst b/source/educators/how-tos/course_development/exercise_tools/setting_up_lti_1_1_component.rst index e8e09a42c..e65141c8a 100644 --- a/source/educators/how-tos/course_development/exercise_tools/setting_up_lti_1_1_component.rst +++ b/source/educators/how-tos/course_development/exercise_tools/setting_up_lti_1_1_component.rst @@ -1,7 +1,7 @@ .. _Setting up a LTI 1.1 component: -Setting up an LTI 1.1 component -############################### +Set Up an LTI 1.1 Component +########################### .. tags:: educator, how-to diff --git a/source/educators/how-tos/course_development/exercise_tools/setting_up_lti_1_3_component.rst b/source/educators/how-tos/course_development/exercise_tools/setting_up_lti_1_3_component.rst index 8b5807ece..f2a75e8f1 100644 --- a/source/educators/how-tos/course_development/exercise_tools/setting_up_lti_1_3_component.rst +++ b/source/educators/how-tos/course_development/exercise_tools/setting_up_lti_1_3_component.rst @@ -1,7 +1,7 @@ .. _Setting up a LTI 1.3 component: -Setting up an LTI 1.3 component -############################### +Set Up an LTI 1.3 Component +########################### .. tags:: educator, how-to diff --git a/source/educators/how-tos/course_development/exercise_tools/using_lti_advantage_features.rst b/source/educators/how-tos/course_development/exercise_tools/using_lti_advantage_features.rst index 294ad11f4..6d9644595 100644 --- a/source/educators/how-tos/course_development/exercise_tools/using_lti_advantage_features.rst +++ b/source/educators/how-tos/course_development/exercise_tools/using_lti_advantage_features.rst @@ -1,7 +1,7 @@ .. _Enabling and using LTI Advantage features: -Enabling and using LTI Advantage features -######################################### +Enable and Use LTI Advantage Features +##################################### .. tags:: educator, how-to From cfff858764d0090c39e57c1ae6bff4344b942cff Mon Sep 17 00:00:00 2001 From: Bryann Valderrama Date: Fri, 10 Jan 2025 10:52:40 -0500 Subject: [PATCH 15/15] fix(docs): add missing tag and update :ref: command --- .../exercise_tools/add_numerical_input_problem.rst | 2 ++ .../editing_multi_select_using_advanced_editor.rst | 2 +- 2 files changed, 3 insertions(+), 1 deletion(-) diff --git a/source/educators/how-tos/course_development/exercise_tools/add_numerical_input_problem.rst b/source/educators/how-tos/course_development/exercise_tools/add_numerical_input_problem.rst index de0da15b0..0cd9c4ed6 100644 --- a/source/educators/how-tos/course_development/exercise_tools/add_numerical_input_problem.rst +++ b/source/educators/how-tos/course_development/exercise_tools/add_numerical_input_problem.rst @@ -94,6 +94,8 @@ For example, to identify the correct answers as 5, 6, or 7, but not 8, specify ``(5,8]``. +.. _Use Feedback in a Numerical Input Problems: + =============== Adding Feedback =============== diff --git a/source/educators/how-tos/course_development/exercise_tools/editing_multi_select_using_advanced_editor.rst b/source/educators/how-tos/course_development/exercise_tools/editing_multi_select_using_advanced_editor.rst index 5acc7e797..ca9948c31 100644 --- a/source/educators/how-tos/course_development/exercise_tools/editing_multi_select_using_advanced_editor.rst +++ b/source/educators/how-tos/course_development/exercise_tools/editing_multi_select_using_advanced_editor.rst @@ -9,7 +9,7 @@ advanced editor. In the setting panels on the right of the editor, click **Switch to advanced editor**. You can use the advanced editor to identify the elements of a multi-select problem -with OLX. For more information, see :ref:`Multi-select Problem XML`. To format equations, +with OLX. For more information, see :ref:`Multi select Problem XML`. To format equations, you can use MathJax. For more information, see :ref:`MathJax in Studio`. You can see the OLX for the example problem from the Overview section below.