Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

FC-0068 docs: how-to cleaning by edunext #14 #758

Open
wants to merge 15 commits into
base: main
Choose a base branch
from
Open

FC-0068 docs: how-to cleaning by edunext #14 #758

Show file tree
Hide file tree
Changes from 12 commits
Commits
Show all changes
15 commits
Select commit Hold shift + click to select a range
0bb4ae1
docs: update 'create_image_mapped_input.rst' file
BryanttV Jan 3, 2025
091bf2a
docs: update 'enable_lti_component.rst' file
BryanttV Jan 3, 2025
539c75e
docs: update 'adding_math_expresion_problems.rst' file
BryanttV Jan 3, 2025
93ca2dd
docs: update 'add_multiselect_partial_credit.rst' file
BryanttV Jan 7, 2025
fe5f253
docs: update 'enable_notes.rst' file
BryanttV Jan 7, 2025
607ffe4
docs: update 'edit_numerical_input_advanced.rst' file
BryanttV Jan 7, 2025
3721839
docs: remove note to edx in 'enable_notes.rst' file
BryanttV Jan 7, 2025
acb4342
docs: update 'add_checkbox.rst' file
BryanttV Jan 7, 2025
bcbb24e
docs: update and split 'adding_multi_select.rst' file
BryanttV Jan 7, 2025
2781afd
docs: update and split 'award_partial_credit_numerical_input.rst' file
BryanttV Jan 7, 2025
e5d55d6
fix: replace '.' by '_' in the file names
BryanttV Jan 8, 2025
e4ea2e9
fix: remove blank space in the filename
BryanttV Jan 8, 2025
fbb67b4
docs: replace adding by add in tags
BryanttV Jan 9, 2025
83df8b2
fix(docs): adjust titles for consistency with 'How To' phrasing
BryanttV Jan 10, 2025
cfff858
fix(docs): add missing tag and update :ref: command
BryanttV Jan 10, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
17 changes: 16 additions & 1 deletion source/educators/how-tos/add_checkbox.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,8 +1,23 @@
.. _Adding a Checkbox Problem:

Add a Checkbox Problem
######################

.. tags:: educator, how-to

To create a checkbox (also known as "multi-select") problem, follow this video guide:

.. youtube:: 6VYKcMeZrxg
.. 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)
19 changes: 7 additions & 12 deletions ...s/how-tos/course_development/exercise_tools/add_multi_select_partial_credit.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,8 +1,7 @@
.. _Awarding Partial Credit in a Multi select Problem:

=============================
Awarding Partial Credit
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
Awarding Partial Credit
Award Partial Credit

You should be able to put "How To" in front of these titles and it should make sense ("How To Award Partial Credit", not "How To Awarding Partial Credit"

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for the explanation! I will make sure to keep it in mind for future changes.
I updated the files: 83df8b2

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@sarina, Should we also update the tags? This would also mean updating the :ref: commands.

=============================
#######################

.. tags:: educator, how-to

Expand Down Expand Up @@ -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
Expand Down Expand Up @@ -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 ``<choiceresponse>`` element in the problem OLX.
Expand All @@ -104,9 +101,8 @@ updated to provide partial credit.
</choiceresponse>
</problem>

--------------------------------------
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
Expand Down Expand Up @@ -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 ``<choiceresponse>`` element in
Expand Down Expand Up @@ -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)
7 changes: 3 additions & 4 deletions ...rs/how-tos/course_development/exercise_tools/adding_math_expression_problem.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,8 +1,7 @@
.. _Adding Math Expression Problem:
.. _Adding Math Expression Problem:

**************************************
Adding a Math Expression Input Problem
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
Adding a Math Expression Input Problem
Add a Math Expression Input Problem

**************************************
######################################

.. tags:: educator, how-to

Expand Down Expand Up @@ -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)
:ref:`Math Expression Input Problem XML` (reference)
180 changes: 11 additions & 169 deletions source/educators/how-tos/course_development/exercise_tools/adding_multi_select.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,8 +1,7 @@
.. _Adding a Multi Select Problem:
.. _Adding a Multi Select Problem:

******************************
Adding a Multi-select Problem
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
Adding a Multi-select Problem
Add a Multi-select Problem

******************************
#############################

.. tags:: educator, how-to

Expand Down Expand Up @@ -33,19 +32,17 @@ 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
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
Expand Down Expand Up @@ -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
Expand Down Expand Up @@ -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

<problem>
<choiceresponse>
<label>Learning about the benefits of preventative health care can be
particularly difficult.</label>
<description>Check all of the options below that might be reasons why.</description>
<checkboxgroup>
<choice correct="true">A large amount of time passes between
undertaking a preventative measure and seeing the result.</choice>
<choice correct="false">Non-immunized people will always fall sick.</choice>
<choice correct="true">If others are immunized, fewer people will fall
sick regardless of a particular individual's choice to get immunized
or not.</choice>
<choice correct="true">Trust in health care professionals and
government officials is fragile.</choice>
</checkboxgroup>
<solution>
<div class="detailed-solution">
<p>Explanation</p>
<p>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.</p>
</div>
</solution>
</choiceresponse>
</problem>

.. 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 correct="true">Choice label
<choicehint selected="true">Feedback for when learner selects this
answer.</choicehint>
<choicehint selected="false">Feedback for when learner does not select
this answer.</choicehint>
</choice>

For example, the following problem has feedback for each answer.

.. code-block:: xml

<problem>
<multiplechoiceresponse>
<label>Which of the following is an example of a vegetable?</label>
<description>You can select only one option.</description>
<choicegroup type="MultipleChoice">
<choice correct="false">apple
<choicehint>An apple is the fertilized ovary that comes from an apple
tree and contains seeds classifying it as a fruit.</choicehint>
</choice>
<choice correct="false">pumpkin
<choicehint>A pumpkin is the fertilized ovary of a squash plant
and contains seeds classifying it as a fruit.</choicehint>
</choice>
<choice correct="true">potato
<choicehint>A potato is an edible part of a plant in tuber form and
is classified as a vegetable.</choicehint>
</choice>
<choice correct="false">tomato
<choicehint>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.</choicehint>
</choice>
</choicegroup>
</multiplechoiceresponse>
</problem>

------------------------
Adding Group Feedback
------------------------

In the advanced editor, you define group feedback by adding a ``<compoundhint>``
element within the ``<checkboxgroup>`` element.

.. code-block:: xml

.
.
.
</choice>
<compoundhint value="Answer Combination">Feedback when learner selects
this combination of answers.</compoundhint>
</checkboxgroup>

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

.
.
.
</choice>
<compoundhint value="A B D">An apple, pumpkin, and tomato are all
fruits as they all are fertilized ovaries of a plant and contain
seeds.</compoundhint>
<compoundhint value="A B C D">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.
</compoundhint>
</checkboxgroup>

==============
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)
Loading