From 3bc8a41fc1524e41268668362beddd547b76db17 Mon Sep 17 00:00:00 2001 From: Sylvia Pearce Date: Fri, 28 Feb 2014 13:15:26 -0500 Subject: [PATCH] Add polls and randomization to problem information --- .../source/additional_tools.rst | 79 +++++++---- .../course_authors/source/common_problems.rst | 131 ++++++------------ .../source/create_problem_component.rst | 84 ++++++++++- 3 files changed, 172 insertions(+), 122 deletions(-) diff --git a/docs/en_us/course_authors/source/additional_tools.rst b/docs/en_us/course_authors/source/additional_tools.rst index eb07777b80..5b414749b2 100644 --- a/docs/en_us/course_authors/source/additional_tools.rst +++ b/docs/en_us/course_authors/source/additional_tools.rst @@ -398,7 +398,7 @@ You can run polls in your course so that your students can share opinions on dif .. image:: /Images/PollExample.png -Note that creating a poll requires you to export your course, edit it in a text editor, and then re-import your course. We recommend that you create a backup copy of your course before you create the poll. +.. note:: Creating a poll requires you to export your course, edit it in a text editor, and then re-import your course. We recommend that you create a backup copy of your course before you create the poll. We also do not recommend that you try to edit other areas of your course while you're working in the text editor unless you have the necessary background and training. ========================== Terminology @@ -412,49 +412,70 @@ In the **Course Outline** view, your content is arranged in sections, subsection Create a Poll ========================== -#. In the unit where you want to create the poll, create components that contain all the content that you want *except* for the poll. +#. In the unit where you want to create the poll, create components that contain all the content that you want *except* for the poll. Make a note of the 32-digit unit ID that appears in the **Unit Identifier** field under **Unit Location**. -#. Export your course. For information about how to do this, see :ref:`Exporting and Importing a Course`. Save your course in a memorable location so that you can find it easily. +#. Export your course. For information about how to do this, see :ref:`Exporting and Importing a Course`. Save the .tar.gz file that contains your course in a memorable location so that you can find it easily. -#. Locate the .tar.gz file that contains your course, and then unpack the file. +#. Locate the .tar.gz file that contains your course, and then unpack the .tar.gz file so that you can see its contents in a list of folders and files. - - To do this on a Windows computer, you'll need to download a third-party program. For more information, see `How to Unpack a tar File in Windows `_, `How to Extract a Gz File `_, `The gzip Home Page `_, or the `Windows `_ section of the `How to Open .tar.gz Files` `_ page. + - To do this on a Windows computer, you'll need to download a third-party program. For more information, see `How to Unpack a tar File in Windows `_, `How to Extract a Gz File `_, `The gzip Home Page `_, or the `Windows `_ section of the `How to Open .tar.gz Files `_ page. - - For information about how to do this on a Mac, see the `Mac OS X `_ section of the `How to Open .tar.gz Files` `_ page. + - For information about how to do this on a Mac, see the `Mac OS X `_ section of the `How to Open .tar.gz Files `_ page. +#. In the list of folders and files, open the **Vertical** folder. -Create a Unit all the Components you want other than the polls (see "Regular Section" for an example of a pre-poll section). -Export the tarball of your course ("Tools") -Find the problem you wish to edit in the "verticals" folder. Open it with a text editor (an editor such as Sublime 2 is geared towards programming). -Add poll questions in between the and tags. A template is below. + .. note:: If your unit is not published, open the **Drafts** folder, and then open the **Vertical** folder in the **Drafts** folder. -.. code-block:: xml - -

This is where you put the prompt

- Yes - No - +#. In the **Vertical** folder, locate the .xml file that has the same name as the unit ID that you noted in step 1, and then open the file in a text editor such as Sublime 2. For example, if the unit ID is e461de7fe2b84ebeabe1a97683360d31, you'll open the e461de7fe2b84ebeabe1a97683360d31.xml file. -As a result, your code should look something like the below: + The file contains a list of all the components in the unit, together with the URL names of the components. For example, the following file contains an HTML component followed by a Discussion component. -.. code-block:: xml - - + .. code-block:: xml + + + + + + +#. Add the following poll code in the location where you want the poll. Change the text of the prompt to the text that you want. + + .. code-block:: xml + -

This is where you put the prompt

+

Text of the prompt

Yes No - - -Re-tarball your course (how to do this in Terminal here) -Import the tarball -Notes + In the example above, if you wanted your poll to appear between the HTML component and the Discussion component in the unit, your code would resemble the following. -Although the polls will render correctly in Studio, you will not be able to edit them in Studio. You will need to follow the export/import process outlined above to make any edits to your polls. -You will be editing the raw XML code of your course to add this feature. We do not recommend attempting to edit other areas of your course in this method unless you have the necessary background and training. -A CSV for student responses to the problem is not currently available for polls, though the aggregate data is easily obtained directly in the problem. + .. code-block:: xml + + + + +

Text of the prompt

+ Yes + No + + + + +#. After you add the poll code, save and close the .xml file. + +#. Re-package your course as a .tar.gz file. + + * For information about how to do this on a Mac, see `How to Create a Tar GZip File from the Command Line `_. + + * For information about how to do this on a Windows computer, see `How to Make a .tar.gz on Windows `_. + +#. In Studio, re-import your course. + +.. note:: + + * Although polls render correctly in Studio, you cannot edit them in Studio. You will need to follow the export/import process outlined above to make any edits to your polls. + + * A .csv file that contains student responses to the problem is not currently available for polls. However, you can obtain the aggregate data directly in the problem. .. _Protein Builder: diff --git a/docs/en_us/course_authors/source/common_problems.rst b/docs/en_us/course_authors/source/common_problems.rst index 1c4134cec4..c21d846eb9 100644 --- a/docs/en_us/course_authors/source/common_problems.rst +++ b/docs/en_us/course_authors/source/common_problems.rst @@ -29,59 +29,6 @@ These problems are easy to access in Studio. To create them, click Types** tab, and then click the name of the problem. (Note that **Checkbox** doesn't appear in the list of common problem types. To create a checkbox problem, you'll click **Blank Common Problem**.) - - - - - - - - - - - - - - - -To add labels to these problems, enclose the text that you want to use as a label in two sets of angle brackets (<<>>) - - - -Just in case you want to see the XML, we've provided it - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - .. _Checkbox: @@ -652,49 +599,49 @@ text that students enter. .. code-block:: xml - -

Example Problem

+ +

Example Problem

-

What base is the decimal numeral system in? - - +

What base is the decimal numeral system in? + + + +

+ +

What is the value of the standard gravity constant g, measured in m/s2? Give your answer to at least two decimal places. + + + -

+

-

What is the value of the standard gravity constant g, measured in m/s2? Give your answer to at least two decimal places. - - - - -

+ + - - - -

What is the distance in the plane between the points (pi, 0) and (0, e)? You can type math. - - - - -

- -
-

Explanation

-

The decimal numerical system is base ten.

-

The standard gravity constant is defined to be precisely 9.80665 m/s2. - This is 9.80 to two decimal places. Entering 9.8 also works.

-

By the distance formula, the distance between two points in the plane is - the square root of the sum of the squares of the differences of each coordinate. - Even though an exact numerical value is checked in this case, the - easiest way to enter this answer is to type - sqrt(pi^2+e^2) into the editor. - Other answers like sqrt((pi-0)^2+(0-e)^2) also work. -

-
- - +

What is the distance in the plane between the points (pi, 0) and (0, e)? You can type math. + + + + +

+ +
+

Explanation

+

The decimal numerical system is base ten.

+

The standard gravity constant is defined to be precisely 9.80665 m/s2. + This is 9.80 to two decimal places. Entering 9.8 also works.

+

By the distance formula, the distance between two points in the plane is + the square root of the sum of the squares of the differences of each coordinate. + Even though an exact numerical value is checked in this case, the + easiest way to enter this answer is to type + sqrt(pi^2+e^2) into the editor. + Other answers like sqrt((pi-0)^2+(0-e)^2) also work. +

+
+ + **Templates** diff --git a/docs/en_us/course_authors/source/create_problem_component.rst b/docs/en_us/course_authors/source/create_problem_component.rst index a0be560720..51c9397ce6 100644 --- a/docs/en_us/course_authors/source/create_problem_component.rst +++ b/docs/en_us/course_authors/source/create_problem_component.rst @@ -22,6 +22,7 @@ For more information, see the following topics. * :ref:`Components and the User Interface` * :ref:`Problem Settings` * :ref:`Multiple Problems in One Component` +* :ref:`Problem Randomization` * :ref:`Modifying a Released Problem` @@ -415,7 +416,88 @@ attempts to answer each problem individually. If a student clicks If a student clicks **Show Answer**, the answers for all the problems in the component appear. -.. _Modifying a Released Problem: +.. _Problem Randomization: + +********************* +Problem Randomization +********************* + +You may want to present different students with different problems, or different versions of the same problem. To do this, you'll create a Problem component for each problem or version in Studio, and then edit your course outside of Studio to randomize the problem that students see. + +Note that *problem randomization* is different from the **Randomization** setting in Studio. The **Randomization** setting randomizes variables within a single problem. Problem randomization offers different problems or problem versions to different students. + +.. note:: Implementing the randomization setting requires you to export your course, edit it in a text editor, and then re-import your course. We recommend that you create a backup copy of your course before you do this. We also do not recommend that you try to edit other areas of your course while you're working in the text editor unless you have the necessary background and training. + +========================== +Terminology +========================== + +In the **Course Outline** view, your content is arranged in sections, subsections, units, and components. When you edit your course in a text editor, sections are **chapters**, subsections are **sequentials**, units are **verticals**, and components are **videos**, **HTMLs**, **problems**, or **discussions**. + +.. _Create Randomized Problems: + +========================== +Create Randomized Problems +========================== + +#. In the unit where you want to create a randomized problem, create a separate Problem component for each version or problem that you want to randomize. For example, if you want to offer four versions or problems, you'll create four separate Problem components. Make a note of the 32-digit unit ID that appears in the **Unit Identifier** field under **Unit Location**. + +#. Export your course. For information about how to do this, see :ref:`Exporting and Importing a Course`. Save the .tar.gz file that contains your course in a memorable location so that you can find it easily. + +#. Locate the .tar.gz file that contains your course, and then unpack the .tar.gz file so that you can see its contents in a list of folders and files. + + - To do this on a Windows computer, you'll need to download a third-party program. For more information, see `How to Unpack a tar File in Windows `_, `How to Extract a Gz File `_, `The gzip Home Page `_, or the `Windows `_ section of the `How to Open .tar.gz Files `_ page. + + - For information about how to do this on a Mac, see the `Mac OS X `_ section of the `How to Open .tar.gz Files `_ page. + +#. In the list of folders and files, open the **Vertical** folder. + + .. note:: If your unit is not published, open the **Drafts** folder, and then open the **Vertical** folder in the **Drafts** folder. + +#. In the **Vertical** folder, locate the .xml file that has the same name as the unit ID that you noted in step 1, and then open the file in a text editor such as Sublime 2. For example, if the unit ID is e461de7fe2b84ebeabe1a97683360d31, you'll open the e461de7fe2b84ebeabe1a97683360d31.xml file. + + The file contains a list of all the components in the unit, together with the URL names of the components. For example, the following file contains four Problem components. + + .. code-block:: xml + + + + + + + + +#. Add `` `` tags around the components for the problems that you want to randomize. + + .. code-block:: xml + + + + + + + + + + +#. After you add the `` `` tags, save and close the .xml file. + +#. Re-package your course as a .tar.gz file. + + * For information about how to do this on a Mac, see `How to Create a Tar GZip File from the Command Line `_. + + * For information about how to do this on a Windows computer, see `How to Make a .tar.gz on Windows `_. + +#. In Studio, re-import your course. + +.. note:: + + * Once you've implemented randomization, you can only see one of the versions or problems in Studio. You can edit that single problem directly in Studio, but to edit any of the other problems, you'll have to export your course, edit the problems in a text editor, and then re-import the course. This is true for instructors as well as course teams. + + * A .csv file for student responses contains the responses to each of the problems in the problem bank. + + + .. _Modifying a Released Problem: ************************************ Modifying a Released Problem