diff --git a/docs/course_authors/source/Images/Progress_tab.png b/docs/course_authors/source/Images/Progress_tab.png new file mode 100644 index 0000000000..2495ec72e3 Binary files /dev/null and b/docs/course_authors/source/Images/Progress_tab.png differ diff --git a/docs/course_authors/source/advanced_problems.rst b/docs/course_authors/source/advanced_problems.rst index 0cad06604e..2d67fe95cc 100644 --- a/docs/course_authors/source/advanced_problems.rst +++ b/docs/course_authors/source/advanced_problems.rst @@ -182,12 +182,11 @@ your code into the LaTeX editor, you'll only need to make a few minor adjustments. Note that **this problem type is still a prototype and may not be supported in the future**, so you should use it with caution. -***Note** If you want to use LaTeX to typeset mathematical expressions -in problems that you haven't yet written, use any of the other problem -templates together with `MathJax `_. For more -information about how to create mathematical expressions in Studio using -MathJax, see *A Brief Introduction to MathJax in -Studio*. +.. note:: If you want to use LaTeX to typeset mathematical expressions + in problems that you haven't yet written, use any of the other problem + templates together with `MathJax `_. For more + information about how to create mathematical expressions in Studio using + MathJax, see *A Brief Introduction to MathJax in Studio*. .. image:: Images/ProblemWrittenInLaTeX.gif diff --git a/docs/course_authors/source/common_problems.rst b/docs/course_authors/source/common_problems.rst index abdbd8f97a..ce9b9592c1 100644 --- a/docs/course_authors/source/common_problems.rst +++ b/docs/course_authors/source/common_problems.rst @@ -1,7 +1,8 @@ .. _Common Problems: +############################# Common Problems -=============== +############################# *Common problems* are typical problems such as multiple choice problems and other problems whose answers are simple for students to select or @@ -31,8 +32,9 @@ create a checkbox problem, you'll click **Blank Common Problem**.) .. _Checkbox: +******************* Checkbox --------- +******************* In checkbox problems, the student selects one or more options from a list of possible answers. The student must select all the options that @@ -41,8 +43,9 @@ at least one correct answer. .. image:: Images/CheckboxExample.gif +========================== Create a Checkbox Problem -~~~~~~~~~~~~~~~~~~~~~~~~~~ +========================== #. Under **Add New Component**, click **Problem**. #. In the **Select Problem Component Type** screen, click **Blank Common @@ -90,8 +93,9 @@ following. .. _Dropdown: +******************* Dropdown --------- +******************* Dropdown problems allow the student to choose from a collection of answer options, presented as a dropdown list. Unlike multiple choice @@ -101,8 +105,9 @@ the dropdown arrow. .. image:: Images/DropdownExample.gif +========================== Create a Dropdown Problem -~~~~~~~~~~~~~~~~~~~~~~~~~ +========================== To create a dropdown problem, follow these steps. @@ -145,8 +150,9 @@ following. .. _Multiple Choice: +******************* Multiple Choice ---------------- +******************* In multiple choice problems, students select one option from a list of answer options. Unlike with dropdown problems, whose answer choices @@ -156,8 +162,9 @@ the question. .. image:: Images/MultipleChoiceExample.gif +================================== Create a Multiple Choice Problem -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +================================== #. Under **Add New Component**, click **Problem**. #. In the **Select Problem Component Type** screen, click **Multiple @@ -210,8 +217,9 @@ following. .. _Numerical Input: +******************* Numerical Input ---------------- +******************* In numerical input problems, students enter numbers or specific and relatively simple mathematical expressions to answer a question. @@ -232,8 +240,9 @@ numerical input problems. To see more examples, scroll down to **Examples**. .. image:: Images/Math5.gif +================================== Create a Numerical Input Problem -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +================================== #. Under **Add New Component**, click **Problem**. #. In the **Select Problem Component Type** screen, click **Numerical @@ -286,8 +295,9 @@ For more information, see `Formula Equation Input .. _Text input: +******************* Text Input ----------- +******************* In text input problems, students enter text into a response field. The response can include numbers, letters, and special characters such as @@ -298,8 +308,9 @@ text input problems to allow for typographical errors. .. image:: Images/TextInputExample.gif +================================== Create a Text Input Problem -~~~~~~~~~~~~~~~~~~~~~~~~~~~ +================================== To create a text input problem, follow these steps. @@ -337,4 +348,58 @@ following. the risk of malaria begins to fall for everyone – users and non-users alike. This can fall to such a low probability that malaria is effectively eradicated from the group (even when the group does not have 100% bednet coverage). - [explanation] \ No newline at end of file + [explanation] + +========================================= +Case Sensitivity and Text Input Problems +========================================= + +By default, text input problems do not require a case sensitive response. You can change this +and require a case sensitive answer. + +To make a text input response case sensitive, you must use the :ref:`Advanced Editor`. + +In the advanced editor, you see that the **type** attribute of the **stringresponse** +element equals **ci**, for *case insensitive*. For example: + +:: + + + + + +To make the response case sensitive, change the value of the **type** attribute to **cs**. + +:: + + + + + +========================================= +Response Field Length of Text Input Problems +========================================= + +By default, the response field for text input problems is 20 characters long. + +You should preview the unit to ensure that the length of the response input field +accommodates the correct answer, and provides extra space for possible incorrect answers. + +If the default response field length is not sufficient, you can change it using the :ref:`Advanced Editor`. + +In the advanced editor, in the XML block for the answer, you see that the **size** attribute of the **textline** +element equals **20**: + +:: + + + + + +To change the response field length, change the value of the **size** attribute: + +:: + + + + diff --git a/docs/course_authors/source/create_discussion.rst b/docs/course_authors/source/create_discussion.rst index 566ac1656b..62012e0220 100644 --- a/docs/course_authors/source/create_discussion.rst +++ b/docs/course_authors/source/create_discussion.rst @@ -10,6 +10,8 @@ Overview You can add a Discussion component to a Unit, to pose a question related to the Unit and give students a chance to respond and interact. +See the following topics: + * :ref:`Create a Discussion Component` * :ref:`A Student's View of the Discussion` * :ref:`Seed a Discussion Space in Your Course` diff --git a/docs/course_authors/source/create_html_component.rst b/docs/course_authors/source/create_html_component.rst index fba6a044ba..7b01b26e7f 100644 --- a/docs/course_authors/source/create_html_component.rst +++ b/docs/course_authors/source/create_html_component.rst @@ -12,6 +12,8 @@ Overview You use an HTML component to add and format text for your course. You can add text, lists, links and images in an HTML component. +See the following topics: + * :ref:`Create an HTML Component` * :ref:`Work with the Visual and HTML Editors` * :ref:`Use the Announcement Template` @@ -65,7 +67,7 @@ For more information, see: * :ref:`Add a Link in an HTML Component` * :ref:`Add an Image to an HTML Component` -ADD LINKS + .. _Work with the Visual and HTML Editors: diff --git a/docs/course_authors/source/create_problem_component.rst b/docs/course_authors/source/create_problem_component.rst index 37b244f61e..f1750875ab 100644 --- a/docs/course_authors/source/create_problem_component.rst +++ b/docs/course_authors/source/create_problem_component.rst @@ -17,6 +17,14 @@ toward a student's grade. If you want the problems to count toward the student's grade, change the assignment type of the subsection that contains the problems. +See the following topics: + +* :ref:`Components and the User Interface` +* :ref:`Problem Settings` +* :ref:`Multiple Problems in One Component` +* :ref:`Modifying a Released Problem` + + .. _Components and the User Interface: ************************************ @@ -92,10 +100,10 @@ All problems on the edX platform have several component parts. past due does not have a **Check** button. It also does not accept answers or provide feedback. -**Note** Problems can be **open** or **closed.** Closed problems do not -have a **Check** button. Students can still see questions, solutions, -and revealed explanations, but they cannot check their work, submit -responses, or change their stored score. +.. note:: Problems can be **open** or **closed.** Closed problems do not + have a **Check** button. Students can still see questions, solutions, + and revealed explanations, but they cannot check their work, submit + responses, or change their stored score. There are also some attributes of problems that are not immediately visible. @@ -118,10 +126,10 @@ Editor and the Advanced Editor. - The **Advanced Editor** converts the problem to edX’s XML standard and allows you to edit that XML directly. -**Note** You can switch at any time from the Simple Editor to the -Advanced Editor by clicking **Advanced Editor** in the top right corner -of the Simple Editor interface. However, it is not possible to switch from -the Advanced Editor to the Simple Editor. +.. note:: You can switch at any time from the Simple Editor to the + Advanced Editor by clicking **Advanced Editor** in the top right corner + of the Simple Editor interface. However, it is not possible to switch from + the Advanced Editor to the Simple Editor. The Simple Editor ~~~~~~~~~~~~~~~~~ @@ -146,6 +154,8 @@ The following image shows a multiple choice problem in the Simple Editor. .. image:: Images/MultipleChoice_SimpleEditor.gif +.. _Advanced Editor: + The Advanced Editor ~~~~~~~~~~~~~~~~~~~ The **Advanced Editor** opens a problem in XML. The Advanced Problem templates, @@ -198,9 +208,9 @@ the problem. By default, a student has an unlimited number of attempts. Problem Weight ============================== -**Note** Studio stores scores for all problems, but scores only count -toward a student’s final grade if they are in a subsection that is -graded. +.. note:: Studio stores scores for all problems, but scores only count + toward a student’s final grade if they are in a subsection that is + graded. This setting specifies the maximum number of points possible for the problem. The problem weight appears next to the problem title. @@ -333,6 +343,8 @@ page for the problem type. students in your course, or a computer algorithm to grade responses in the form of essays, files such as computer code, and images. +.. _Multiple Problems in One Component: + ************************************ Multiple Problems in One Component ************************************ @@ -360,12 +372,13 @@ 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: + ************************************ Modifying a Released Problem ************************************ -**WARNING: Be careful when you modify problems after they have been -released!** +.. warning:: Be careful when you modify problems after they have been released! After a student submits a response to a problem, Studio stores the student’s response, the score that the student received, and the maximum diff --git a/docs/course_authors/source/create_video.rst b/docs/course_authors/source/create_video.rst index d043c552fc..f71e9c40e9 100644 --- a/docs/course_authors/source/create_video.rst +++ b/docs/course_authors/source/create_video.rst @@ -14,6 +14,8 @@ You can also associate a timed transcript with your video, which students can re When you add a video to your course, you first post the video online, and then create a link to that video in the body of your course. +See the following topics: + * :ref:`Video Formats` * :ref:`Video Hosting` * :ref:`Create a Video Component` diff --git a/docs/course_authors/source/establish_grading_policy.rst b/docs/course_authors/source/establish_grading_policy.rst index d47fb9be6d..45e54a36f4 100644 --- a/docs/course_authors/source/establish_grading_policy.rst +++ b/docs/course_authors/source/establish_grading_policy.rst @@ -160,6 +160,7 @@ See :ref:`Working with Problem Components` for instructions on creating problems ************************** The Student View of Grades ************************** -Once a grading policy is in place, students can view both their problem scores and the percent completed and current grade at the top of their **Progress** tab for the course. +Once a grading policy is in place, students can view both their problem scores and the percent completed and current grade in the **Progress** tab for the course. -ADD IMAGE \ No newline at end of file + .. image:: Images/Progress_tab.png + :width: 800 \ No newline at end of file diff --git a/docs/course_authors/source/open_response_assessment.rst b/docs/course_authors/source/open_response_assessment.rst index ffceca0022..1bb323e3cc 100644 --- a/docs/course_authors/source/open_response_assessment.rst +++ b/docs/course_authors/source/open_response_assessment.rst @@ -631,8 +631,8 @@ graders. If you want to see the full rubric for either an AI or peer assessment, click **Toggle Full Rubric**. -**Note** For a peer assessment, if you haven't yet graded enough -problems to see your score, you receive a message that lets you know how -many problems you still need to grade. +.. note:: For a peer assessment, if you haven't yet graded enough + problems to see your score, you receive a message that lets you know how + many problems you still need to grade. .. image:: Images/FeedbackNotAvailable.gif diff --git a/docs/course_authors/source/organizing_course.rst b/docs/course_authors/source/organizing_course.rst index 73ef085cc1..9355db2faf 100644 --- a/docs/course_authors/source/organizing_course.rst +++ b/docs/course_authors/source/organizing_course.rst @@ -57,7 +57,7 @@ The new, empty Section is placed at the bottom of the course outline. You must now add Subsections to the Section. Whether or not students see the new Section depends on the release date. -See LINK for more information on releasing your course. +See :ref:`Publishing Your Course` for more information. .. _Subsections: diff --git a/docs/course_authors/source/set_content_releasedates.rst b/docs/course_authors/source/set_content_releasedates.rst index 24755e9abc..f334472472 100644 --- a/docs/course_authors/source/set_content_releasedates.rst +++ b/docs/course_authors/source/set_content_releasedates.rst @@ -137,6 +137,10 @@ Modifying Public Units ************************* To make revisions to a unit that has been published, you create and edit a draft of that unit. + +.. warning:: There are additional implications to modifying the public unit that has graded problem + components students may have already completed. See :ref:`Modifying a Released Problem` for more information. + To create a draft, go to the unit's page, and then click **edit a draft** in the right pane. .. image:: Images/Viz_Revise_EditDraft.png