diff --git a/docs/en_us/course_authors/source/Images/MultipleChoice_AdvancedEditor.png b/docs/en_us/course_authors/source/Images/MultipleChoice_AdvancedEditor.png new file mode 100644 index 0000000000..cc0ca0a8a3 Binary files /dev/null and b/docs/en_us/course_authors/source/Images/MultipleChoice_AdvancedEditor.png differ diff --git a/docs/en_us/course_authors/source/Images/MultipleChoice_SimpleEditor.png b/docs/en_us/course_authors/source/Images/MultipleChoice_SimpleEditor.png new file mode 100644 index 0000000000..93eae5ab32 Binary files /dev/null and b/docs/en_us/course_authors/source/Images/MultipleChoice_SimpleEditor.png differ diff --git a/docs/en_us/course_authors/source/Images/ProbComponent_Attributes.png b/docs/en_us/course_authors/source/Images/ProbComponent_Attributes.png new file mode 100644 index 0000000000..76b0dea9d3 Binary files /dev/null and b/docs/en_us/course_authors/source/Images/ProbComponent_Attributes.png differ diff --git a/docs/en_us/course_authors/source/Images/ProbComponent_LMS_DisplayName.png b/docs/en_us/course_authors/source/Images/ProbComponent_LMS_DisplayName.png new file mode 100644 index 0000000000..4dcd6a400b Binary files /dev/null and b/docs/en_us/course_authors/source/Images/ProbComponent_LMS_DisplayName.png differ diff --git a/docs/en_us/course_authors/source/additional_tools.rst b/docs/en_us/course_authors/source/additional_tools.rst index d9018fc172..c49ab82a4c 100644 --- a/docs/en_us/course_authors/source/additional_tools.rst +++ b/docs/en_us/course_authors/source/additional_tools.rst @@ -111,7 +111,7 @@ Chemical Equation Problem Code \( \text{H}_2\text{SO}_4 \longrightarrow \text { H}^+ + \text{ HSO}_4^-\) - + if chemcalc.chemical_equations_equal(submission[0], 'H2SO4 -> H^+ + HSO4^-'): diff --git a/docs/en_us/course_authors/source/advanced_problems.rst b/docs/en_us/course_authors/source/advanced_problems.rst index 34a2ae4a34..d87e86887f 100644 --- a/docs/en_us/course_authors/source/advanced_problems.rst +++ b/docs/en_us/course_authors/source/advanced_problems.rst @@ -34,6 +34,8 @@ These problems are easy to access in Studio. To create them, click **Problem** under **Add New Component**, click the **Advanced** tab, and then click the name of the problem that you want to create. +To add a label for an advanced problem, you'll add a **label** attribute to one of the XML tags for the problem. For more information, see :ref:`Appendix E`. + .. _Circuit Schematic Builder: @@ -139,8 +141,6 @@ file that you'll download. #. In the problem component editor, replace the example code with the code below. #. Click **Save.** - - JavaScript Input Problem Code ############################# @@ -183,25 +183,17 @@ JavaScript Input Problem Code .. note:: When you create this problem, keep the following in mind. - - The webGLDemo.js file defines the three JavaScript functions (**WebGLDemo.getGrade**, - **WebGLDemo.getState**, and **WebGLDemo.setState**). + - The webGLDemo.js file defines the three JavaScript functions (**WebGLDemo.getGrade**, **WebGLDemo.getState**, and **WebGLDemo.setState**). - - The JavaScript input problem code uses **WebGLDemo.getGrade**, **WebGLDemo.getState**, - and **WebGLDemo.setState** to grade, save, or restore a problem. These functions must - be global in scope. + - The JavaScript input problem code uses **WebGLDemo.getGrade**, **WebGLDemo.getState**, and **WebGLDemo.setState** to grade, save, or restore a problem. These functions must be global in scope. - - **WebGLDemo.getState** and **WebGLDemo.setState** are optional. You only have to define - these functions if you want to conserve the state of the problem. + - **WebGLDemo.getState** and **WebGLDemo.setState** are optional. You only have to define these functions if you want to conserve the state of the problem. - - **Width** and **height** represent the dimensions of the IFrame that holds the - application. + - **Width** and **height** represent the dimensions of the IFrame that holds the application. - - When the problem opens, the cone and the cube are both blue, or "unselected." When - you click either shape once, the shape becomes yellow, or "selected." To unselect - the shape, click it again. Continue clicking the shape to select and unselect it. + - When the problem opens, the cone and the cube are both blue, or "unselected." When you click either shape once, the shape becomes yellow, or "selected." To unselect the shape, click it again. Continue clicking the shape to select and unselect it. - - The response is graded as correct if the cone is selected (yellow) when the user - clicks **Check**. + - The response is graded as correct if the cone is selected (yellow) when the user clicks **Check**. - Clicking **Check** or **Save** registers the problem's current state. diff --git a/docs/en_us/course_authors/source/appendices/e.rst b/docs/en_us/course_authors/source/appendices/e.rst index e2fc6ea993..8443e213d3 100644 --- a/docs/en_us/course_authors/source/appendices/e.rst +++ b/docs/en_us/course_authors/source/appendices/e.rst @@ -41,6 +41,9 @@ Most problems have the following tags. * - ``
`` (optional) - If you want to include more information in the problem, such as a detailed explanation of the problem's answer, you'll enter the text between the two ``
`` tags, which are inside the ```` tags. (These tags do not have to be on the same line.) +Additionally, all problems must include a **label** attribute. This attribute adds a descriptive label that helps visually impaired students navigate through the problem. +You'll add a **label** attribute to one of the XML tags for the problem. Each example problem below includes a label. + .. _Choice Response: Choice Response (Checkbox Problems) @@ -61,7 +64,7 @@ Although you can create checkbox problems by using the Simple Editor in Studio, * - ```` - Specifies that the problem lists answer options for students to choose from. * - ```` - - A child of ````. Specifies that the problem is a checkbox problem. + - A child of ````. Specifies that the problem is a checkbox problem. Can include a ``direction`` attribute and a ``label`` attribute. * - ```` - A child of ````. Designates an answer option. Each choice must include the ``correct`` attribute, set to ``true`` (for a correct answer) or ``false`` (for an incorrect answer). For checkbox problems, more than one option can be a correct answer. @@ -75,7 +78,7 @@ Although you can create checkbox problems by using the Simple Editor in Studio, difficult. Check all of the reasons below why this may be the case.

- + A large amount of time passes between undertaking a preventative measure and seeing the result. Non-immunized people will always fall sick. @@ -112,7 +115,7 @@ Although you can create checkbox problems by using the Simple Editor in Studio, - + Answer option 1 (incorrect) Answer option 2 (correct) @@ -147,7 +150,7 @@ In chemical equation problems, students enter text that represents a chemical eq * - ```` - Indicates that this problem has a custom response. The ```` tags must surround the ```` tags. * - ```` - - A child of ````. Indicates that the answer to this problem is a chemical equation. + - A child of ````. Indicates that the answer to this problem is a chemical equation. Must contain the ``size`` and ``label`` attributes. * - ```` - A child of ````. Contains the Python script that grades the problem. @@ -164,7 +167,7 @@ Chemical equation problems use MathJax to create formulas. For more information \( \text{H}_2\text{SO}_4 \longrightarrow \text { H}^+ + \text{ HSO}_4^-\) - + if chemcalc.chemical_equations_equal(submission[0], 'H2SO4 -> H^+ + HSO4^-'): @@ -202,7 +205,7 @@ Chemical equation problems use MathJax to create formulas. For more information

Problem text

- + if chemcalc.chemical_equations_equal(submission[0], 'TEXT REPRESENTING CHEMICAL EQUATION'): @@ -246,7 +249,7 @@ In custom Python-evaluated input (also called “write-your-own-grader”) probl * - ```` - * - - - This tag includes the ``size`` and ``correct_answer`` attributes. The ``correct_answer`` attribute is optional. + - This tag includes the ``size``, ``correct_answer``, and ``label`` attributes. The ``correct_answer`` attribute is optional. **Sample Problem XML**: @@ -272,14 +275,14 @@ In custom Python-evaluated input (also called “write-your-own-grader”) probl

Part 1: Enter two integers that sum to 10.

-
- +
+

Part 2: Enter two integers that sum to 20.

-
- +
+ @@ -309,8 +312,8 @@ The following template includes answers that appear when the student clicks **Sh

Problem text

-
- +
+ @@ -337,8 +340,8 @@ The following template does not return answers when the student clicks **Show An

Enter two real numbers that sum to 20:

-
- +
+ @@ -366,11 +369,9 @@ Formula Response (Math Expression Input Problems) * - ```` - * - ```` - - + - This tag includes the ``size`` and ``label`` attributes. * - `` - + @@ -422,7 +423,7 @@ Formula Response (Math Expression Input Problems)

Problem text

- +