Skip to content

Commit

Permalink
feat: problem editor (#2124)
Browse files Browse the repository at this point in the history
  • Loading branch information
rayzhou-bit committed Apr 6, 2023
1 parent 47b7486 commit 8a61257
Show file tree
Hide file tree
Showing 73 changed files with 2,237 additions and 2,677 deletions.
2 changes: 0 additions & 2 deletions en_us/course_authors/source/exercises_tools/checkbox.rst

This file was deleted.

8 changes: 4 additions & 4 deletions en_us/course_authors/source/exercises_tools/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,6 @@ For information about building specific course component types, see
enable_exercises_tools
annotation
calculator
checkbox
chemical_equation
circuit_schematic_builder
conditional_module
Expand All @@ -40,8 +39,8 @@ For information about building specific course component types, see
image_mapped_input
lti_component
math_expression_input
multiple_choice
mult_choice_num_input
mathjax
multi_select
notes
numerical_input
open_response_assessments/index
Expand All @@ -56,10 +55,11 @@ For information about building specific course component types, see
qualtrics
randomized_content_blocks
recommenderXBlock
single_select
single_select_num_input
staffgraded
survey
text_input
word_cloud
custom_python
zooming_image
mathjax

This file was deleted.

2 changes: 2 additions & 0 deletions en_us/course_authors/source/exercises_tools/multi_select.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
.. include:: ../../../shared/exercises_tools/multi_select.rst

This file was deleted.

2 changes: 2 additions & 0 deletions en_us/course_authors/source/exercises_tools/single_select.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
.. include:: ../../../shared/exercises_tools/single_select.rst

Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
.. include:: ../../../shared/exercises_tools/single_select_num_input.rst

Original file line number Diff line number Diff line change
Expand Up @@ -3543,7 +3543,7 @@ by other XBlocks, such as :ref:`open response assessments<ora2>`,
different events.

For information about designing problems to include hints, feedback, or
both, see :ref:`partnercoursestaff:Adding Feedback and Hints to a Problem` in
both, see the :ref:`feedback<Adding Feedback>` and :ref:`hint<Hints>` sections in
the *Building and Running an edX Course* guide.

===============================================
Expand Down Expand Up @@ -3621,7 +3621,7 @@ field.
* - ``choice_all``
- array
- For problems that have a set of possible answers defined, such as
checkbox problems, lists all of the answer choices.
multi-select problems, lists all of the answer choices.
* - ``correctness``
- Boolean
- 'True' if the ``student_answer`` response is correct. 'False' if the
Expand All @@ -3633,7 +3633,7 @@ field.
* - ``hints``
- array
- Contains a ``text`` member field with the feedback string that was
displayed to the user. For some problem types, such as checkbox
displayed to the user. For some problem types, such as multi-select
problems, feedback can be provided for more than one answer at a time,
including both correct and incorrect answers. A separate ``text`` member
field is included for each feedback message that was displayed.
Expand All @@ -3652,18 +3652,18 @@ field.
* - ``student_answer``
- array
- The answer value selected or supplied by the user. For problem types
that accept multiple answers, such as checkbox problems, every response,
that accept multiple answers, such as multi-select problems, every response,
including both selected and unselected options, is included.
* - ``trigger_type``
- string
- Identifies the type of feedback elicited by the ``student_answer``
response. For checkbox problems only, course teams can design 'compound'
response. For multi-select problems only, course teams can design 'compound'
feedback that is provided when a user's response matches an exact set of
correct and incorrect selections across all of the available choices.
All other types of feedback are identified as 'single'.

For more information, see :ref:`partnercoursestaff:Adding Feedback and
Hints to a Problem` in the *Building and Running an edX Course* guide.
For more information, see the :ref:`feedback<Adding Feedback>` and :ref:`hint<Hints>`
sections in the *Building and Running an edX Course* guide.

=================
``problem_check``
Expand Down
2 changes: 0 additions & 2 deletions en_us/olx/source/problem-xml/checkbox.rst

This file was deleted.

6 changes: 3 additions & 3 deletions en_us/olx/source/problem-xml/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,6 @@ exercise, tool, or problem type, see :ref:`Levels of Support`.

levels_of_support
annotation
checkbox
chemical_equation
circuit_schematic_builder
completion
Expand All @@ -34,8 +33,7 @@ exercise, tool, or problem type, see :ref:`Levels of Support`.
lti_component
math_expression_input
mathjax
mult_choice_num_input
multiple_choice
multi_select
numerical_input
open_response_assessments/index
periodic_table
Expand All @@ -45,6 +43,8 @@ exercise, tool, or problem type, see :ref:`Levels of Support`.
problem_with_hint
protein_builder
recommenderXBlock
single_select
single_select_num_input
survey
symbolic_response
text_input
Expand Down
2 changes: 0 additions & 2 deletions en_us/olx/source/problem-xml/mult_choice_num_input.rst

This file was deleted.

2 changes: 2 additions & 0 deletions en_us/olx/source/problem-xml/multi_select.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
.. include:: ../../../shared/exercises_tools/multi_select.rst

2 changes: 0 additions & 2 deletions en_us/olx/source/problem-xml/multiple_choice.rst

This file was deleted.

2 changes: 2 additions & 0 deletions en_us/olx/source/problem-xml/single_select.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
.. include:: ../../../shared/exercises_tools/single_select.rst

2 changes: 2 additions & 0 deletions en_us/olx/source/problem-xml/single_select_num_input.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
.. include:: ../../../shared/exercises_tools/single_select_num_input.rst

This file was deleted.

10 changes: 5 additions & 5 deletions en_us/open_edx_course_authors/source/exercises_tools/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -22,12 +22,12 @@ For information about building specific course component types, see
enable_exercises_tools
annotation
calculator
checkbox
chemical_equation
circuit_schematic_builder
completion
conditional_module
custom_javascript
custom_python
drag_and_drop
drag_and_drop_deprecated
dropdown
Expand All @@ -40,8 +40,8 @@ For information about building specific course component types, see
image_mapped_input
lti_component
math_expression_input
multiple_choice
mult_choice_num_input
mathjax
multi_select
notes
numerical_input
open_response_assessments/index
Expand All @@ -56,10 +56,10 @@ For information about building specific course component types, see
qualtrics
randomized_content_blocks
recommenderXBlock
single_select
single_select_num_input
staffgraded
survey
text_input
word_cloud
custom_python
zooming_image
mathjax

This file was deleted.

Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
.. include:: ../../../shared/exercises_tools/multi_select.rst

This file was deleted.

Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
.. include:: ../../../shared/exercises_tools/single_select.rst

Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
.. include:: ../../../shared/exercises_tools/single_select_num_input.rst

17 changes: 5 additions & 12 deletions en_us/shared/course_components/Section_learner_problem_view.rst
Original file line number Diff line number Diff line change
Expand Up @@ -33,12 +33,12 @@ an option is available in problems.
problem, the LMS saves the grade and current state of the problem. The
LMS immediately provides feedback about whether the response is correct
or incorrect, as well as the problem score. The **Submit** option remains
available if the learner has unused attempts remaining, so that she can
available if the learner has unused attempts remaining, so that they can
try to answer the problem again.

.. note::
If you want to temporarily or permanently hide learners' results for
the problem, see :ref:`Problem Results Visibility`.
problems inside of a subsection, see :ref:`Problem Results Visibility`.

#. **Attempts.** You can set a specific number of attempts or allow unlimited
attempts for a problem. By default, the course-wide **Maximum Attempts**
Expand All @@ -50,7 +50,7 @@ an option is available in problems.
Attempts** for an individual problem, the number of attempts for that
problem defaults to the number of attempts defined in Advanced Settings.

#. **Save.** The learner can select **Save** to save his current response
#. **Save.** The learner can select **Save** to save their current response
without submitting it for grading. This allows the learner to stop working
on a problem and come back to it later.

Expand All @@ -77,7 +77,7 @@ an option is available in problems.
problem. If a learner selects **Show Answer**, the learner sees both the
correct answer and the explanation, if any.

If you specify a number in **Show Answer: Number of Attempts**, the learner
If you specify a number in **Show Answer: After Some Number of Attempts**, the learner
must submit at least that number of attempted answers before the **Show
Answer** option is available for the problem.

Expand All @@ -96,18 +96,14 @@ an option is available in problems.

.. note::
If you want to temporarily or permanently hide learners' results for
the problem, see :ref:`Problem Results Visibility`.
problems inside of a subsection, see :ref:`Problem Results Visibility`.

In addition to the items above, which are shown in the example, problems also
have the following elements.

* **Correct answer.** Most problems require that you specify a single correct
answer.

.. note::
If you want to temporarily or permanently hide learners' results for
the problem, see :ref:`Problem Results Visibility`.

* **Explanation.** You can include an explanation that appears when a learner
selects **Show Answer**.

Expand Down Expand Up @@ -135,6 +131,3 @@ visible. You can set these attributes in Studio.
script to randomize the values that are presented to learners. You use this
setting to define when values are randomized. For more information, see
:ref:`Randomization`.

* **Weight.** Different problems in a particular problem set can be
given different weights. For more information, see :ref:`Problem Weight`.

0 comments on commit 8a61257

Please sign in to comment.