diff --git a/source/community/release_notes/dogwood.rst b/source/community/release_notes/dogwood.rst index 1dce25afe..f23b68ba4 100644 --- a/source/community/release_notes/dogwood.rst +++ b/source/community/release_notes/dogwood.rst @@ -110,7 +110,7 @@ uploads, the following options are available. * A custom set of one or more file formats, specified by the course team. -For more information, see PA Allow Images. +For more information, see Allow ORA Images. To protect learners from the transmission of potentially harmful files, this enhancement also gives system administrators the ability to configure a list of diff --git a/source/developers/references/developer_guide/extending_platform/extending.rst b/source/developers/references/developer_guide/extending_platform/extending.rst index 2396f099c..7040e9d56 100644 --- a/source/developers/references/developer_guide/extending_platform/extending.rst +++ b/source/developers/references/developer_guide/extending_platform/extending.rst @@ -61,7 +61,7 @@ ways to extend the platform, starting with the following table. - Yes * - Clean UI Integration - Yes - - No (see :ref:`LTI Component`) + - No (see :ref:`About the LTI Component`) - Yes - Yes - Yes @@ -72,13 +72,13 @@ ways to extend the platform, starting with the following table. - Yes - Yes * - Server Side Grading - - Possibly (See :ref:`Custom JavaScript`) + - Possibly (See :ref:`Custom JavaScript`) - Yes - Yes - Yes - Yes * - Usage Data - - No (See :ref:`Custom JavaScript`) + - No (See :ref:`Custom JavaScript`) - No - Limited - Yes diff --git a/source/developers/references/glossary.rst b/source/developers/references/glossary.rst index 974d870ba..32c53d263 100644 --- a/source/developers/references/glossary.rst +++ b/source/developers/references/glossary.rst @@ -518,11 +518,9 @@ Glossary Rubric A list of the items that a learner's response should cover in an open - response assessment. For more information, see the - `partnercoursestaff:PA Rubric` topic in `partnercoursestaff:Open - Response Assessments Two`. + response assessment. - See also :ref:`Open Response Assessment`. + See :ref:`Open Response Assessment`. Seat Type diff --git a/source/educators/concepts/accessibility/design_for_mobile.rst b/source/educators/concepts/accessibility/design_for_mobile.rst index 4f517e64a..ac5a6f9c1 100644 --- a/source/educators/concepts/accessibility/design_for_mobile.rst +++ b/source/educators/concepts/accessibility/design_for_mobile.rst @@ -20,7 +20,7 @@ Android and iPhone apps, although we still recommend that learners complete graded assignments on a desktop computer, depending on the type of assessments that their courses include. For information on which exercises and tools are mobile-ready, see the table in the :ref:`Introduction to Exercises and -Tools` section. +Tools` section. To make the course experience for mobile learners as rewarding as it is for learners using desktop computers, keep the following best practices in mind as diff --git a/source/educators/concepts/advanced_features/timed_exams.rst b/source/educators/concepts/advanced_features/about_timed_exams.rst similarity index 95% rename from source/educators/concepts/advanced_features/timed_exams.rst rename to source/educators/concepts/advanced_features/about_timed_exams.rst index 3119ec2fb..d2d941743 100644 --- a/source/educators/concepts/advanced_features/timed_exams.rst +++ b/source/educators/concepts/advanced_features/about_timed_exams.rst @@ -1,7 +1,7 @@ .. _Timed Exams: -Timed Exams -############# +About Timed Exams +################# .. tags:: educator, concept @@ -25,7 +25,7 @@ starting a timed exam. .. seealso:: - :ref:`Configure Timed Exams` + :ref:`Manage Timed Exams` diff --git a/source/educators/concepts/advanced_features/using_openedx_as_LTI_provider.rst b/source/educators/concepts/advanced_features/using_openedx_as_LTI_provider.rst index e17608e76..b86fe26d3 100644 --- a/source/educators/concepts/advanced_features/using_openedx_as_LTI_provider.rst +++ b/source/educators/concepts/advanced_features/using_openedx_as_LTI_provider.rst @@ -6,7 +6,7 @@ Using Open edX as an LTI Tool Provider .. tags:: educator, concept You can also include content from an LTI provider in your courses. For more -information, see :ref:`LTI Component`. +information, see :ref:`About the LTI Component`. .. _Grading Remote Content: diff --git a/source/educators/concepts/exercise_tools/OpenResponseAssessments.rst b/source/educators/concepts/exercise_tools/OpenResponseAssessments.rst index 85bd7fb6c..878bb9421 100644 --- a/source/educators/concepts/exercise_tools/OpenResponseAssessments.rst +++ b/source/educators/concepts/exercise_tools/OpenResponseAssessments.rst @@ -1,10 +1,14 @@ .. _Open Response Assessments: -Introduction to Open Response Assessments +About Open Response Assessments (ORA) ######################################### .. tags:: educator, concept +.. contents:: + :local: + :depth: 2 + In open response assessments (ORA), learners submit essay responses and then go through a series of assessment steps (such as peer assessment and self assessment) to complete the assignment. @@ -23,19 +27,19 @@ assessment) to complete the assignment. The following topics provide conceptual information about open response assessments. -* :ref:`PA Elements` +* :ref:`Elements of an Open Response Assessment` * :ref:`PA Scoring` * :ref:`Best Practices for ORA` For information about creating and managing open response assessments, including step by step instructions, see the following sections. -* :ref:`PA Create an ORA Assignment` +* :ref:`Create an ORA Assignment` * :ref:`Managing ORA Assignments` -* :ref:`Accessing ORA Assignment Information` +* :ref:`Access ORA Assignment Information` -.. _PA Elements: +.. _Elements of an Open Response Assessment: Elements of an Open Response Assessment *************************************** @@ -43,9 +47,9 @@ Elements of an Open Response Assessment When you create an open response assessment assignment, you include several elements. -* One or more :ref:`prompts `, or questions, that learners answer. +* One or more :ref:`prompts `, or questions, that learners answer. -* A :ref:`rubric `. One rubric is used to grade all the prompts in +* A :ref:`rubric `. One rubric is used to grade all the prompts in the assessment. * One or more :ref:`assessment steps `. Assignments can @@ -58,9 +62,9 @@ elements. be the final step in the assignment. For step-by-step instructions for creating an open response assessment, see -:ref:`PA Create an ORA Assignment`. +:ref:`Create an ORA Assignment`. -.. _PA Prompts: +.. _ORA Prompts: Prompts ======= @@ -73,15 +77,14 @@ other type of file to accompany their written response. Within each prompt, you can include helpful information for your learners, such as the approximate number of words or sentences that their responses should have, the types of files that they can upload, or what they can expect -after they submit their responses. For more information, see :ref:`PA Add -Prompt`. +after they submit their responses. For more information, see :ref:`Add ORA Prompt`. In the learner view of the assignment, each prompt appears above the field where learners enter their responses. For more information, see :ref:`PA Assessment Steps`. -.. _PA Rubric: +.. _ORA Rubrics: Rubric ======= @@ -131,7 +134,7 @@ A rubric consists of several criteria and a set of options for each criterion. You can also include criteria that do not have options, but that do include a field where learners or staff can enter feedback. For more information, - see :ref:`PA Criteria Comment Field Only`. + see :ref:`ORA Criteria Comment Field Only`. In a rubric as it appears to a learner, the following elements are visible. @@ -151,11 +154,11 @@ Criterion names do not display in the rubric that learners use to perform their assessments, but do appear on the page that shows the learner's final ORA assignment grade. -For information about creating a rubric, see :ref:`PA Add Rubric`. +For information about creating a rubric, see :ref:`Add ORA Rubric`. An Example Criterion -******************** +------------------------ In a rubric, one criterion and its set of options might resemble the following. @@ -228,7 +231,7 @@ a self assessment ("Assess Your Response"). .. _PA Student Training Step: Learner Training Step -********************* +---------------------- Learner training steps teach learners to perform their own assessments. A learner training assessment contains one or more sample responses that you @@ -268,7 +271,7 @@ For more information, see :ref:`PA Student Training`. .. _Peer Assessment Step: Peer Assessment Step -******************** +-------------------- In the peer assessment step, learners review the responses of other learners in the course. For each response, they select an option for each criterion in @@ -282,7 +285,7 @@ For information about how peer assessments affect a learner's assignment grade, see :ref:`PA Scoring`. Number of Responses and Assessments -=================================== +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ When you include a peer assessment step, you specify the number of responses that each learner must assess (**Must Grade**) and the number of peer @@ -307,7 +310,7 @@ do not count toward the score that the response receives. .. _Feedback Options: Feedback Options -================ +----------------- By default, in peer assessment steps, learners can provide text feedback for the entire response, using a single comment field below the entire rubric. You @@ -317,12 +320,12 @@ individual criteria. This comment field can contain up to 1000 characters. Comment fields for individual criterion appear below the options for the criterion. -For more information, see :ref:`PA Add Rubric` and :ref:`PA Criteria Comment +For more information, see :ref:`Add ORA Rubric` and :ref:`ORA Criteria Comment Field Only`. Assessing Additional Responses -============================== +------------------------------- Learners can assess more than the required number of responses. After a learner completes the peer assessment step, the step "collapses" so that only @@ -335,7 +338,7 @@ peer assessments. .. _Self Assessment Step: Self Assessment Step -******************** +--------------------- In self assessment steps, the learner sees her own response followed by the rubric. As with peer assessments, the learner evaluates the response using the rubric, @@ -347,7 +350,7 @@ include the peer assessment before the self assessment. .. _Staff Assessment Step: Staff Assessment Step -********************* +--------------------- In staff assessment steps, a member of the course team performs an evaluation of the learner's response. Course team members grade the response using the @@ -500,6 +503,9 @@ Then set the toggle for this feature on or off :alt: Image highlighting the toggle for flexible peer grading on the course level :width: 600 +Scoring Calculation +******************** + Self Assessment Scoring ======================= @@ -550,7 +556,7 @@ prevent the page from becoming too long. learner response from peer grading>` it is also removed from the **Top Responses** list. -For more information, see :ref:`PA Show Top Responses`. +For more information, see :ref:`ORA Show Top Responses`. .. _Best Practices for ORA: @@ -592,7 +598,7 @@ Designing the Assignment Grading and Rubrics =================== -* Make sure you have a well designed and clear :ref:`rubric ` for +* Make sure you have a well designed and clear :ref:`rubric ` for the assignment. A good rubric is very important in helping to eliminate ambiguity in the peer grading process. @@ -673,7 +679,7 @@ responses, however, be aware of the following limitations and best practices. * Image files must be in .jpg, .gif, or .png format. -For more information, see :ref:`PA Allow Images`. +For more information, see :ref:`Allow ORA Images`. .. _Prohibited File Extensions: @@ -705,15 +711,14 @@ information, see `Configuring ora2 to prohibit submission of file types`_. .vbscript, .workflow .ws, .wsc, .wsf, .wsh .. seealso:: - - :ref:`PA Create an ORA Assignment` (how-to) + :ref:`Create an ORA Assignment` (how-to) :ref:`Managing ORA Assignments` (how-to) :ref:`ORA Staff Grading` (reference) - :ref:`Accessing ORA Assignment Information` (reference) + :ref:`Access ORA Assignment Information` (reference) **Maintenance chart** diff --git a/source/educators/references/course_development/exercise_tools/custom_python.rst b/source/educators/concepts/exercise_tools/about_custom_python_problem.rst similarity index 63% rename from source/educators/references/course_development/exercise_tools/custom_python.rst rename to source/educators/concepts/exercise_tools/about_custom_python_problem.rst index 6080eb702..ffb4723ac 100644 --- a/source/educators/references/course_development/exercise_tools/custom_python.rst +++ b/source/educators/concepts/exercise_tools/about_custom_python_problem.rst @@ -1,40 +1,34 @@ -.. _Write Your Own Grader: +.. _About Custom Python-Evaluated Input Problem: -Custom Python-evaluated Input Problem (Write Your Own Grader) +About Custom Python-evaluated Input Problem ############################################################# -.. tags:: educator, reference +.. tags:: educator, concept In custom Python-evaluated input (also called "write-your-own-grader" problems), the grader uses a Python script that you create and embed in the problem to evaluate a learner's response or provide hints. These problems can -be any type. :ref:`Numerical input` and :ref:`text input` and :ref:`text input` problems are the most common write-your-own-grader problems. Custom Python-evaluated input problems can include the following advanced problem types. * :ref:`Chemical Equation` -* :ref:`Custom JavaScript` +* :ref:`Custom JavaScript` * :ref:`Gene Explorer` * :ref:`Protein Builder` -Learn here how to :ref:`Create a Custom Python Evaluated Input Problem in Studio`, and visit :ref:`Award Partial Credit` to learn how to configurate the credits in this type of exercise. +Learn here how to :ref:`Create a Custom Python Evaluated Input Problem`, and visit :ref:`Award Partial Credit` to learn how to configurate the credits in this type of exercise. .. seealso:: - :ref:`Create a Custom Python Evaluated Input Problem in Studio` (how to) + :ref:`Create a Custom Python Evaluated Input Problem` (how to) - :ref:`Create a Custom Python Evaluated Input Problem in Script Tag Format` (how to) - - :ref:`Create a Randomized Custom Python Evaluated Input Problem` (how to) - - :ref:`Script Tag Format` (concept) - - :ref:`Award Partial Credit` (concept) + :ref:`Guide to the Custom Python-Evaluated Input Problem` (concept) **Maintenance chart** diff --git a/source/educators/concepts/exercise_tools/drag_and_drop.rst b/source/educators/concepts/exercise_tools/about_drag_and_drop.rst similarity index 94% rename from source/educators/concepts/exercise_tools/drag_and_drop.rst rename to source/educators/concepts/exercise_tools/about_drag_and_drop.rst index 2e5297a51..a17f79522 100644 --- a/source/educators/concepts/exercise_tools/drag_and_drop.rst +++ b/source/educators/concepts/exercise_tools/about_drag_and_drop.rst @@ -1,7 +1,7 @@ -.. _drag_and_drop_problem: +.. _About the Drag and Drop Problem: -Drag and Drop Problem -##################### +About the Drag and Drop Problem +############################### .. tags:: educator, concept @@ -18,7 +18,7 @@ to use drag and drop problems in your course. drag and drop problem type. This drag and drop problem type includes significant improvements and you should use it for any new course development. For more information about the previous, deprecated drag and - drop problem type, see :ref:`Drag and Drop`. + drop problem type, see :ref:`Guide to the Drag and Drop Problem`. .. _overview_of_drag_and_drop_problems: @@ -95,9 +95,9 @@ message informs the learner that the problem is complete. .. seealso:: - :ref:`Creating a Drag and Drop Problem` (how-to) + :ref:`Create a Drag and Drop Problem` (how-to) - :ref:`Drag and Drop` (reference) + :ref:`Guide to the Drag and Drop Problem` (reference) **Maintenance chart** diff --git a/source/educators/concepts/exercise_tools/external_graders.rst b/source/educators/concepts/exercise_tools/about_external_graders.rst similarity index 97% rename from source/educators/concepts/exercise_tools/external_graders.rst rename to source/educators/concepts/exercise_tools/about_external_graders.rst index 786331f48..bcb39a96d 100644 --- a/source/educators/concepts/exercise_tools/external_graders.rst +++ b/source/educators/concepts/exercise_tools/about_external_graders.rst @@ -1,7 +1,7 @@ -.. _External Grader: +.. _About External Grader Problems: -External Grader -############### +About External Grader Problems +############################## .. tags:: educator, concept @@ -113,7 +113,7 @@ When you build your external grader, keep the following requirements in mind. :ref:`External Grader Problem Requirements` (reference) - :ref:`Create an External Grader Problem in Studio` (how-to) + :ref:`Add an External Grader Problem` (how-to) **Maintenance chart** diff --git a/source/educators/references/course_development/exercise_tools/image_mapped_input.rst b/source/educators/concepts/exercise_tools/about_image_mapped_input.rst similarity index 90% rename from source/educators/references/course_development/exercise_tools/image_mapped_input.rst rename to source/educators/concepts/exercise_tools/about_image_mapped_input.rst index c97c8f575..91495b6aa 100644 --- a/source/educators/references/course_development/exercise_tools/image_mapped_input.rst +++ b/source/educators/concepts/exercise_tools/about_image_mapped_input.rst @@ -1,10 +1,10 @@ -.. _Image Mapped Input: +.. _About Image Mapped Input Problem: -########################### -Image Mapped Input Problem -########################### +################################# +About Image Mapped Input Problem +################################# -.. tags:: educator, reference +.. tags:: educator, concept In an image mapped input problem, also known as a "pointing on a picture" problem, students click inside a defined region in an image. You define this diff --git a/source/educators/references/course_development/exercise_tools/lti_component.rst b/source/educators/concepts/exercise_tools/about_lti_component.rst similarity index 89% rename from source/educators/references/course_development/exercise_tools/lti_component.rst rename to source/educators/concepts/exercise_tools/about_lti_component.rst index a6345a59f..cd8d48abb 100644 --- a/source/educators/references/course_development/exercise_tools/lti_component.rst +++ b/source/educators/concepts/exercise_tools/about_lti_component.rst @@ -1,10 +1,10 @@ -.. _LTI Component: +.. _About the LTI Component: -############### -LTI Component -############### +########################### +About the LTI Component +########################### -.. tags:: educator, reference +.. tags:: educator, concept You can integrate remote learning tools, such as applications and textbooks, into your course with the learning tools interoperability (LTI) component. The @@ -65,13 +65,16 @@ For more information about how to use Studio as an LTI tool provider, see .. note the slightly different destination links ^. Alison 23 Nov 2015 .. seealso:: - - :ref:`Enable_LTI_Components` (how to) + :ref:`LTI Component Settings` (reference) - :ref:`LTI Component settings` (reference) + :ref:`Enable_LTI_Components` (how-to) - :ref:`Accessibility Best Practices Checklist` + :ref:`Set up an LTI 1_1 component` (how-to) + + :ref:`Set up an LTI 1_3 component` (how-to) + + :ref:`Enabling and using LTI Advantage features` (how-to) **Maintenance chart** diff --git a/source/educators/references/course_development/exercise_tools/multi_select.rst b/source/educators/concepts/exercise_tools/about_multi_select.rst similarity index 94% rename from source/educators/references/course_development/exercise_tools/multi_select.rst rename to source/educators/concepts/exercise_tools/about_multi_select.rst index 65850ec6e..95a5b8023 100644 --- a/source/educators/references/course_development/exercise_tools/multi_select.rst +++ b/source/educators/concepts/exercise_tools/about_multi_select.rst @@ -1,10 +1,10 @@ .. _Multi select: -##################### -Multi-select Problem -##################### +########################################## +About Multi-select Problem +########################################## -.. tags:: educator, reference +.. tags:: educator, concept The multi-select problem type is a simple problem type that can be added to any course. At a minimum, multi-select problems include a question or prompt and diff --git a/source/educators/concepts/exercise_tools/create_exercises.rst b/source/educators/concepts/exercise_tools/about_problems_exercises_tools.rst similarity index 71% rename from source/educators/concepts/exercise_tools/create_exercises.rst rename to source/educators/concepts/exercise_tools/about_problems_exercises_tools.rst index b199e278c..55d97b79c 100644 --- a/source/educators/concepts/exercise_tools/create_exercises.rst +++ b/source/educators/concepts/exercise_tools/about_problems_exercises_tools.rst @@ -1,7 +1,7 @@ -.. _Create Exercises: +.. _About Problems Exercises and Tools: -Problems, Exercises, and Tools -############################## +About Problems, Exercises, and Tools +#################################### .. tags:: educator, concept @@ -38,11 +38,36 @@ The topics in this section introduce the core set of problem types and a selection of other exercises and tools that you can add to your course. .. seealso:: - - :ref:`Core Problem Types` (reference) + :ref:`Core Problem Types` (reference) - :ref:`Enable Additional Exercises and Tools` (how-to) + :ref:`Working with Problem Components` (reference) + + :ref:`Guide to Problem Settings` (reference) + + :ref:`Gradebook Assignment Types` (reference) + + :ref:`Feedback Best Practices` (concept) + + :ref:`Adding Feedback and Hints to a Problem` (reference) + + :ref:`Configure Hint` (how-to) + + :ref:`Partial Credit` (reference) + + :ref:`Set the Assignment Type and Due Date for a Subsection` (how-to) + + :ref:`Adding Tooltips` (reference) + + :ref:`Learner View of Problems` (reference) + + :ref:`Advanced Editor` (reference) + + :ref:`Add Hints via the Advanced Editor` (how-to) + + :ref:`Modifying a Released Problem` (reference) + + :ref:`Add Unsupported Exercises Problems` (how-to) **Maintenance chart** diff --git a/source/educators/references/course_development/exercise_tools/text_input.rst b/source/educators/concepts/exercise_tools/about_text_input.rst similarity index 97% rename from source/educators/references/course_development/exercise_tools/text_input.rst rename to source/educators/concepts/exercise_tools/about_text_input.rst index 633439e17..48f34daab 100644 --- a/source/educators/references/course_development/exercise_tools/text_input.rst +++ b/source/educators/concepts/exercise_tools/about_text_input.rst @@ -1,10 +1,10 @@ .. _Text Input: ######################## -Text Input Problem +About Text Input Problem ######################## -.. tags:: educator, reference +.. tags:: educator, concept The text input problem type is a simple problem type that can be added to any course. At a minimum, text input problems include a question or prompt and a diff --git a/source/educators/concepts/exercise_tools/single_select_overview.rst b/source/educators/concepts/exercise_tools/single_select_overview.rst index 094cd56aa..f76db94ea 100644 --- a/source/educators/concepts/exercise_tools/single_select_overview.rst +++ b/source/educators/concepts/exercise_tools/single_select_overview.rst @@ -1,7 +1,7 @@ -.. _Single Select Overview: +.. _About Single Select: -Overview -######### +About Single Select Problems +############################# .. tags:: educator, concept diff --git a/source/educators/concepts/exercise_tools/staff_graded.rst b/source/educators/concepts/exercise_tools/staff_graded.rst deleted file mode 100644 index cc6b18036..000000000 --- a/source/educators/concepts/exercise_tools/staff_graded.rst +++ /dev/null @@ -1,29 +0,0 @@ -.. _StaffGraded Grading: - -Grading Learners -################# - -.. tags:: educator, concept - -While your course is running, after learners have had a chance to complete the off-platform assignment you’re grading, you can assign learner grades from the LMS Instructor view of the component as follows: - -#. **Export scores.** Download a grading CSV and use this as a template to assign scores for this problem. You can use track/cohort filters to limit to grading only a subset of learners. - -#. **(On your own machine) Fill out grades.** Open the CSV in a spreadsheet editor and assign scores to learners via “New Points” field. Leave scores that you don’t want to change blank. - -#. **Import scores** Uploading the filled out CSV. Learners will immediately see their grades after import completes. Supports smaller courses - i.e. file sizes up to 4MB. *Note: [Provisionally supported: usage in large courses] To use in larger courses, break up your grade file CSV by rows, and import in separate files -- or use the track & cohort filters to limit to a subset of rows. In this case, keep the header row for each file. This manual approach for larger courses is error prone, so we are making it available as a use-at-your-own-risk feature for advanced users, but don’t explicitly support it.* - -#. **Review result** File is uploaded, validated, scores are overwritten for non-blank rows. You’ll get a readout at the bottom of the screen. - -.. seealso:: - - - :ref:`StaffGraded` (how to) - -**Maintenance chart** - -+--------------+-------------------------------+----------------+--------------------------------+ -| Review Date | Working Group Reviewer | Release |Test situation | -+--------------+-------------------------------+----------------+--------------------------------+ -| | | | | -+--------------+-------------------------------+----------------+--------------------------------+ diff --git a/source/educators/concepts/grading/graded_subsections.rst b/source/educators/concepts/grading/graded_subsections.rst index 9a6c140a5..5a8fcfd37 100644 --- a/source/educators/concepts/grading/graded_subsections.rst +++ b/source/educators/concepts/grading/graded_subsections.rst @@ -1,8 +1,8 @@ -.. _Graded Subsections: +.. _About Graded Subsections: -################## -Graded Subsections -################## +######################### +About Graded Subsections +######################### .. tags:: educator, concept diff --git a/source/educators/concepts/instructional_design/feedback_best_practices.rst b/source/educators/concepts/instructional_design/feedback_best_practices.rst index c535d71e4..dd32f9596 100644 --- a/source/educators/concepts/instructional_design/feedback_best_practices.rst +++ b/source/educators/concepts/instructional_design/feedback_best_practices.rst @@ -25,16 +25,35 @@ reason why the selection is correct. .. seealso:: + :ref:`About Problems Exercises and Tools` (concept) - :ref:`Working with Problem Components` (reference) + :ref:`Core Problem Types` (reference) - :ref:`Modifying a Released Problem` (reference) + :ref:`Working with Problem Components` (reference) - :ref:`Advanced Editor` (reference) + :ref:`Guide to Problem Settings` (reference) - :ref:`Problem Settings` (reference) + :ref:`Gradebook Assignment Types` (reference) - :ref:`Learner View of Problems` (reference) + :ref:`Adding Feedback and Hints to a Problem` (reference) + + :ref:`Configure Hint` (how-to) + + :ref:`Partial Credit` (reference) + + :ref:`Set the Assignment Type and Due Date for a Subsection` (how-to) + + :ref:`Adding Tooltips` (reference) + + :ref:`Learner View of Problems` (reference) + + :ref:`Advanced Editor` (reference) + + :ref:`Add Hints via the Advanced Editor` (how-to) + + :ref:`Modifying a Released Problem` (reference) + + :ref:`Add Unsupported Exercises Problems` (how-to) **Maintenance chart** diff --git a/source/educators/concepts/proctored_exams/preparing_learners_proctored_exams.rst b/source/educators/concepts/proctored_exams/preparing_learners_proctored_exams.rst index a6a29e2c5..03dc8ec66 100644 --- a/source/educators/concepts/proctored_exams/preparing_learners_proctored_exams.rst +++ b/source/educators/concepts/proctored_exams/preparing_learners_proctored_exams.rst @@ -58,7 +58,7 @@ practice proctored exam. .. seealso:: - :ref:`ProctoredExams_Overview` (concept) + :ref:`About Proctored Exams` (concept) :ref:`Enable Proctored Exams` (how-to) diff --git a/source/educators/concepts/proctored_exams/proctored_exams_overview.rst b/source/educators/concepts/proctored_exams/proctored_exams_overview.rst index 4d196f895..a6490bdc7 100644 --- a/source/educators/concepts/proctored_exams/proctored_exams_overview.rst +++ b/source/educators/concepts/proctored_exams/proctored_exams_overview.rst @@ -1,7 +1,7 @@ -.. _ProctoredExams_Overview: +.. _About Proctored Exams: ####################### -Proctored Exam Overview +About Proctored Exams ####################### .. tags:: educator, concept diff --git a/source/educators/how-tos/add_checkbox.rst b/source/educators/how-tos/add_checkbox.rst deleted file mode 100644 index 6479e74d8..000000000 --- a/source/educators/how-tos/add_checkbox.rst +++ /dev/null @@ -1,32 +0,0 @@ -.. _Add 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 - -.. seealso:: - - - :ref:`Multi select` (reference) - - :ref:`Add 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) - - -**Maintenance chart** - -+--------------+-------------------------------+----------------+--------------------------------+ -| Review Date | Working Group Reviewer | Release |Test situation | -+--------------+-------------------------------+----------------+--------------------------------+ -| | | | | -+--------------+-------------------------------+----------------+--------------------------------+ diff --git a/source/educators/how-tos/add_dropdown.rst b/source/educators/how-tos/add_dropdown.rst deleted file mode 100644 index faa906ba1..000000000 --- a/source/educators/how-tos/add_dropdown.rst +++ /dev/null @@ -1,30 +0,0 @@ -.. _Add a Dropdown Problem: - -Add a Dropdown Problem -###################### - -.. tags:: educator, how-to - -This video explains how to add a dropdown-type problem: - -.. youtube:: e6HxKo18_xE - -.. seealso:: - - - :ref:`Dropdown` (reference) - - :ref:`Dropdown Problem XML` (reference) - - :ref:`Use Hints in a Dropdown Problem` (how-to) - - :ref:`Use Feedback in a Dropdown Problem` (how-to) - - -**Maintenance chart** - -+--------------+-------------------------------+----------------+--------------------------------+ -| Review Date | Working Group Reviewer | Release |Test situation | -+--------------+-------------------------------+----------------+--------------------------------+ -| | | | | -+--------------+-------------------------------+----------------+--------------------------------+ diff --git a/source/educators/how-tos/add_multiple_choice.rst b/source/educators/how-tos/add_multiple_choice.rst deleted file mode 100644 index d6f016818..000000000 --- a/source/educators/how-tos/add_multiple_choice.rst +++ /dev/null @@ -1,73 +0,0 @@ -.. _Add a Multiple Choice Problem: - -Add a Multiple Choice Problem -############################# - -.. tags:: educator, how-to - -This video explains how to add a multiple choice (also known as "single-select") problem: - -.. youtube:: ij5VHvY6jBk - - -. In the unit where you want to place the text, select :guilabel:`Problem` at the bottom of the page. - -#. From the list of problem types, select :guilabel:`Multiple Choice`. - - The problem component is added at the end of the unit. - -#. In the component, select :guilabel:`Edit`. - - The template multiple choice component opens in the Simple editor, - -#. Edit the question as needed, keeping the following format. - - .. code-block:: - - >>Add the question text, or prompt, here. This text is required. - ||You can add an optional tip or note related to the prompt like this. << - - ( ) an incorrect answer - (x) the correct answer - ( ) an incorrect answer - -#. To enter a display name for the problem, select :guilabel:`Settings`, and then enter text in the :guilabel:`Display Name` field. - -#. Click :guilabel:`Save` to save the problem in the unit. - - -.. seealso:: - - - :ref:`Overview` (concept) - - :ref:`Multiple Choice` (how-to) - - :ref:`Single Select` (how-to) - - :ref:`Single Select and Numerical Input` (how-to) - - :ref:`Awarding Partial Credit in a Multiple Choice Problem` (how-to) - - :ref:`Editing Single Select Problems using the Advanced Editor` (how-to) - - :ref:`Add a Dropdown Problem` (how-to) - - - - - - - - - - - - -**Maintenance chart** - -+--------------+-------------------------------+----------------+--------------------------------+ -| Review Date | Working Group Reviewer | Release |Test situation | -+--------------+-------------------------------+----------------+--------------------------------+ -| | | | | -+--------------+-------------------------------+----------------+--------------------------------+ diff --git a/source/educators/how-tos/advanced_features/timed_exams.rst b/source/educators/how-tos/advanced_features/manage_timed_exams.rst similarity index 99% rename from source/educators/how-tos/advanced_features/timed_exams.rst rename to source/educators/how-tos/advanced_features/manage_timed_exams.rst index adf3a04cd..a8197b82d 100644 --- a/source/educators/how-tos/advanced_features/timed_exams.rst +++ b/source/educators/how-tos/advanced_features/manage_timed_exams.rst @@ -1,7 +1,7 @@ -.. _Configure Timed Exams: +.. _Manage Timed Exams: ###################### -Configure Timed Exams +Manage Timed Exams ###################### .. tags:: educator, how-to diff --git a/source/educators/how-tos/communication/moderate_discussions.rst b/source/educators/how-tos/communication/moderate_discussions.rst index ef667644b..281c2fd42 100644 --- a/source/educators/how-tos/communication/moderate_discussions.rst +++ b/source/educators/how-tos/communication/moderate_discussions.rst @@ -119,8 +119,6 @@ enrollment period for the course is over. Close Discussions ****************** -.. tags:: educator, how-to - .. note:: You can only close discussions when you work in a web browser. You cannot close discussions when you work in an Open edX mobile app. diff --git a/source/educators/how-tos/course_development/Subsection_configure_hints.rst b/source/educators/how-tos/course_development/configure_hints.rst similarity index 61% rename from source/educators/how-tos/course_development/Subsection_configure_hints.rst rename to source/educators/how-tos/course_development/configure_hints.rst index 0f48d30ce..34aa7e700 100644 --- a/source/educators/how-tos/course_development/Subsection_configure_hints.rst +++ b/source/educators/how-tos/course_development/configure_hints.rst @@ -21,14 +21,35 @@ Configure a Hint in a Problem .. seealso:: + :ref:`About Problems Exercises and Tools` (concept) - :ref:`Adding Feedback and Hints to a Problem` (reference) + :ref:`Core Problem Types` (reference) - :ref:`Adding Hints via the Advanced Editor` (how-to) - - :ref:`Use Hints in a Dropdown Problem` (how-to) + :ref:`Working with Problem Components` (reference) + + :ref:`Guide to Problem Settings` (reference) + + :ref:`Gradebook Assignment Types` (reference) + + :ref:`Feedback Best Practices` (concept) + + :ref:`Adding Feedback and Hints to a Problem` (reference) + + :ref:`Partial Credit` (reference) + + :ref:`Set the Assignment Type and Due Date for a Subsection` (how-to) + + :ref:`Adding Tooltips` (reference) + + :ref:`Learner View of Problems` (reference) + + :ref:`Advanced Editor` (reference) + + :ref:`Add Hints via the Advanced Editor` (how-to) + + :ref:`Modifying a Released Problem` (reference) - :ref:`Problem Settings` (reference) + :ref:`Add Unsupported Exercises Problems` (how-to) **Maintenance chart** diff --git a/source/educators/how-tos/course_development/exercise_tools/CreateORAAssignment.rst b/source/educators/how-tos/course_development/exercise_tools/CreateORAAssignment.rst index cc7d4f83e..270fc8fdc 100644 --- a/source/educators/how-tos/course_development/exercise_tools/CreateORAAssignment.rst +++ b/source/educators/how-tos/course_development/exercise_tools/CreateORAAssignment.rst @@ -1,4 +1,4 @@ -.. _PA Create an ORA Assignment: +.. _Create an ORA Assignment: ############################################# Create an Open Response Assessment Assignment @@ -18,7 +18,7 @@ In addition, you can also review other topics about different aspects of Open Re * Components of an :ref:`Open Response Assessments` * Viewing metrics and learner responses for released open response assessments: - :ref:`Accessing ORA Assignment Information` + :ref:`Access ORA Assignment Information` * Actions you can take for an active ORA assignment: :ref:`Managing ORA Assignments` @@ -38,7 +38,7 @@ your course's Team Configuration to define the desired team sets in the for help setting up team sets. -.. _PA Create Component: +.. _Create ORA Copmonent: ****************************** Step 1. Add the Component @@ -72,7 +72,7 @@ steps. corrections. However, you can modify the due dates and the weight of the ORA assignment after you have published it. -.. _PA Add Prompt: +.. _Add ORA Prompt: ****************************** Step 2. Add Prompts @@ -82,7 +82,7 @@ You can format text and add images inside an open response assessment prompt the same way you would for a Text component. For more information, see :ref:`The Visual Editor`. -To add :ref:`prompts` or questions to your ORA assignment, +To add :ref:`prompts` or questions to your ORA assignment, complete these steps. #. In the open response assessment component editor, select a **Prompt**. @@ -91,13 +91,13 @@ complete these steps. repeat step 2. -.. _PA Add Rubric: +.. _Add ORA Rubric: ****************************** Step 3. Add the Rubric ****************************** -In this step, you add your :ref:`rubric` to provide guidance for +In this step, you add your :ref:`rubric` to provide guidance for assessing responses within the assignment. You add one rubric for each problem, regardless of the number of prompts in the problem. @@ -155,9 +155,9 @@ To add the rubric, follow these steps. corrections. However, you can modify the ORA assignments' due dates and weight after publishing them. .. note:: If you wish to allow learners to view the rubric as they work on their - response, see :ref:`Show Rubric During Response` + response, see :ref:`Show Rubric During Response` -.. _PA Criteria Comment Field Only: +.. _ORA Criteria Comment Field Only: ========================================================== Provide Only Comment Fields for Individual Criteria @@ -210,7 +210,7 @@ To reuse a rubric, complete the following steps: currently *saved* version, not the currently *published* version. This is done to support the ability to clone from ORAs that have not yet been published. -.. _PA Specify Additional Settings: +.. _Specify Additional ORA Settings: *********************************** Step 4. Specify Additional Settings @@ -220,7 +220,7 @@ After you have added a prompt and rubric, you must specify additional settings for the assignment. These settings include the type of response that learners must submit, assignment dates, and whether learners will see a list of top-scoring responses. -.. _PA Team vs Individual ORA: +.. _Team vs Individual ORA: ======================== Team vs. Individual ORA @@ -248,7 +248,7 @@ member of the team. .. note:: Team Open Response Assessments are designed to only be assessed by staff. -.. _PA Allow Images: +.. _Allow ORA Images: ========================= Specify the Response Type @@ -313,7 +313,7 @@ these steps. #. For **Allow LaTeX Responses**, select **True** or **False**. -.. _PA Show Rubric During Response: +.. _Show ORA Rubric During Response: =================================================== Allow Learners to View the Rubric While Responding @@ -332,10 +332,10 @@ When this setting is enabled, a collapsable section will appear in the Response above the first prompt, that shows learners a detailed breakdown of how their response will be graded. -.. note:: This is the rubric you set up in :ref:`Add Rubric`. For each Criterion, learners +.. note:: This is the rubric you set up in :ref:`Add Rubric`. For each Criterion, learners will see all Option names, descriptions, and point values. -.. _PA Show Top Responses: +.. _ORA Show Top Responses: ===================== Include Top Responses @@ -357,7 +357,7 @@ the assignment. If offered, this section will be displayed after each learner ha If you do not want this section to appear, set the number to 0. The maximum number is 100. -.. _PA Select Assignment Steps: +.. _ORA Select Assignment Steps: **************************************** Step 5. Select Assignment Steps @@ -638,7 +638,7 @@ For more information about beta testing, see :ref:`About Course Beta Testing`. :ref:`ORA Staff Grading` (reference) - :ref:`Accessing ORA Assignment Information` (reference) + :ref:`Access ORA Assignment Information` (reference) **Maintenance chart** diff --git a/source/educators/how-tos/course_development/exercise_tools/Manage_ORA_Assignment.rst b/source/educators/how-tos/course_development/exercise_tools/Manage_ORA_Assignment.rst index 405c7cfe2..4bd823538 100644 --- a/source/educators/how-tos/course_development/exercise_tools/Manage_ORA_Assignment.rst +++ b/source/educators/how-tos/course_development/exercise_tools/Manage_ORA_Assignment.rst @@ -21,10 +21,10 @@ assessments. * :ref:`Components of an ORA assignment` -* :ref:`Instructions for creating an ORA assignment` +* :ref:`Instructions for creating an ORA assignment` * :ref:`Viewing metrics and learner responses for released ORA - assignments` + assignments` .. _Access Information for a Specific Learner: @@ -463,16 +463,54 @@ grading>`, locate the specific submission by following these steps. #. Make a note of the username, and follow the steps to :ref:`remove a learner response from peer grading`. + +.. _List and manage students waiting in peer step: + +************************************************* +List and Manage Students Waiting in Peer Step +************************************************* + +On ORA problems with the peer assessment step, sometimes learners might get stuck +waiting for peer responses to evaluate or peer reviews from other learners indefinitely. +There's a tool in the instructor dashboard that allows listing and managing those +learners. + +To view a list of students in the waiting step of an ORA problem in a course, follow +these steps. + +#. View the live version of the course. +#. Select **Instructor** to open the instructor dashboard. +#. On the instructor dashboard, select **Open Responses**. +#. In the table listing the ORA problems, locate the waiting column corresponding to + the problem you want to see users waiting on. +#. If there are any students in the waiting step, the column will become clickable. +#. Select it to open the **Waiting step details** page. + +The **Waiting step details** page displays some information related to the peer step +configuration and a table listing users in the waiting step with the +following attributes: + +* Usernames +* Number of peers assessed +* Number of peer reviews received +* Time spent on the waiting step so far +* Status from staff assessment step, if available in the problem +* Final grade status (waiting or overwritten). + +The **Waiting step details** page also allows managing student grades through the +**Manage individual learners** button near the bottom of the page, which works in +the same manner as :ref:`Access Information for a Specific Learner`. + .. seealso:: :ref:`Open Response Assessments` (concept) - :ref:`PA Create an ORA Assignment` (how to) + :ref:`Create an ORA Assignment` (how to) :ref:`ORA Staff Grading` (reference) - :ref:`Accessing ORA Assignment Information` (reference) + :ref:`Access ORA Assignment Information` (reference) **Maintenance chart** diff --git a/source/educators/how-tos/course_development/exercise_tools/access_ORA_metrics.rst b/source/educators/how-tos/course_development/exercise_tools/access_ORA_metrics.rst new file mode 100644 index 000000000..1781ce888 --- /dev/null +++ b/source/educators/how-tos/course_development/exercise_tools/access_ORA_metrics.rst @@ -0,0 +1,284 @@ +.. _Access ORA Assignment Information: + +###################################### +Access Metrics for ORA Assignments +###################################### + +After you release an Open Response Assessment (ORA) assignment, you can access various +metrics for the assignment or for all open response assessment assignments in +the course. For example, you can view the number of learners in each step of the +assignment or in possible states such as "Waiting" or "Completed" within the +assignment. In addition to viewing metrics for the assignment or for assignments +in a course, you can also access assignment details for an individual learner, +or :ref:`generate a report ` containing learner and +response details for ORA assignments in the course. + +For information about tasks that you can perform on learner responses in an +ORA assignment, including :ref:`performing a grade override +assessment` or :ref:`cancelling a +learner's submission`, see +:ref:`Managing ORA Assignments`. + +.. contents:: + :local: + :depth: 1 + +.. _View Metrics for All ORA Assignments: + +View Statistics for All ORA Assignments in a Course +**************************************************** + +To view metrics about all of the ORA assignments in a course, follow these steps. + +#. View the live version of the course. +#. Select **Instructor** to open the instructor dashboard. +#. On the instructor dashboard, select **Open Responses**. + +The **Open Responses** tab of the instructor dashboard displays the following +information. + +* The number of course units that include an ORA assignment. +* The number of ORA assignments in the course. +* The total number of submitted responses. +* The number of learners who are in each of the training, peer, + self, and staff workflow states. +* The number of learners who have received a final grade. + +The **Open Responses** tab also displays the same information for each separate +ORA assignment in the course, grouped by the course units that include ORA +assignments. + +.. _PA View Metrics for Individual Steps: + +View Statistics for a Single ORA Assignment +********************************************** + +To view metrics about learners in a single ORA assignment, including the number +who are active in each step, follow these steps. + +#. Open the ORA assignment in the course. + +#. Scroll to the bottom of the assignment and select **View Assignment + Statistics**. + + You see statistics for the assignment, including the total number of + responses and the location ID for the assignment. + + In the **Learner Progress** section, for each assessment step in the + assignment, you can see the number of learners who are currently working + through (but who have not completed) that step. Only assessment types that + exist in the assignment are included. + + .. note:: If a Staff Assessment step exists in the assignment, this step + will always show 0 active learners, because no learner actions are + required for that step. + + In addition to learners who are active in the assessment steps of the + assignment, you can see the number of learners who are in the following + states in the assignment. + + * **Waiting**: Learners who have finished the requirements for a step + and are waiting for their responses to be assessed by peers or staff. + + * **Done**: Learners who have completed all of their required steps, and + have received the required number of reviews. + + * **Cancelled**: Learners who have had their responses cancelled. + +In the **Dates** section below **Learner Progress**, the release and due dates +for each step in the assignment are shown. + +.. image:: /_images/educator_references/ORA_AssignmentStats.png + :width: 500 + :alt: The View Assignment Statistics page shows the number of active learners in each step, the number of learners in the Waiting, Done, and Cancelled states, and the start and due dates for each step. + + +.. _Generate ORA Report: + +Generate a Report for ORA Assignments +###################################### + +To generate a report containing details of the ORA assignments in the course, +follow these steps. + +#. View the live version of your course. + +#. Select **Instructor**, and then select **Data Download**. + +#. In the **Reports** section, select **Generate ORA Data Report**. + + A status message indicates that the ORA data report is being generated. This + process might take some time to complete, but you can navigate away from this + page and do other work while it runs. + + To check the progress of the report generation, reload the page in your + browser and scroll down to the **Pending Tasks** section. The table shows + the status of active tasks. + + When the report is complete, a linked .csv file name becomes available above + the **Pending Tasks** section. File names are in the format + ``{course_id}_ORA_data_{datetime}.csv``. The most recently generated + reports appear at the top of the list. + +#. To open or save the generated ORA data report, locate and select the link + for the grade report you requested. + + You can open .csv files in a spreadsheet application to sort, graph, and + compare data. + + +.. _Interpret ORA Data Report: + +Interpret the ORA Data Report +****************************** + +The ORA data report for your course is a time-stamped .csv file that contains +data for all the ORA assignments in your course. For each ORA assignment in +the course, the report provides information that includes each learner's +anonymized ID, response, assessments details and scores, and the final score +for the assignment. For more details about each column in the report, see the +following descriptions. + + +.. image:: /_images/educator_references/ORA_Data_Report_Example.png + :alt: An example ORA data report shown in Excel. + + +The .csv file contains one row of data for each response from a learner. + +* The IDs in the **Submission ID** and **Item ID** columns uniquely identify the + problem within the course content and the learner's submission for that + problem. The **Problem Name** column is also available to help identify a + problem by its display name. + +* The **Username** column helps identify impacted learner submissions for further + platform review if applicable. + +* The **Anonymized Student ID** column lists an ID for each learner without + revealing confidential, personally identifiable data such as email addresses + and usernames. + +* The **Date/Time Response Submitted** column displays the date and time that the + learner submitted her response, in YYYY-MM-DD HH-MM-SS format. + +* The **Response** column displays the content of the learner's response. + +* The **Assessment Details** column displays the following details for the + assessments that were performed on the response. + + * The time and date that the assessment was submitted. + * The type of assessment: self (SE), peer (PE), staff (ST). + * The ID of the person who performed the assessment. + * Any text comments about the response that were included in the assessment. + +* The **Assessment Scores** column lists the scores that the response received + in self, peer, or staff assessments. + +* The **Date/Time Final Score Given**, **Final Score Points Earned**, and the + **Final Score Points Possible** columns provide details of the final score + that the response received. If a response has not received enough + assessments for the assignment to be considered complete, these columns show + a value of "None". + +* The **Feedback Statements Selected** and **Feedback on Peer Assessments** + columns together show the information that learners provided in the **Provide + Feedback on Peer Assessments** section of their ORA assignments. This section + is available to learners only when all assessments for an assignment have been + completed, and provides an optional way for learners to comment on their + experience of the peer assessment process. + + The **Feedback Statements Selected** column displays the text of the + feedback statements (if any) that the learner selected to describe their + experience of the peer assessment process. Learners can select either "These + assessments were useful" or "These assessments were not useful". They can + also select either or both of "I disagree with one or more of the peer + assessments of my response" and "Some comments I received were + inappropriate". + + If a learner also provided a free-form comment in the text field below the + selectable feedback statements, the text appears in the **Feedback on Peer + Assessments** column. + +.. _Generate a Report for ORA File Submissions and Attachments: + +Generate a Report for ORA File Submissions and Attachments +########################################################### + +To generate a report containing details of the ORA assignments in the course, +follow these steps. + +#. View the live version of your course. + +#. Select **Instructor**, and then select **Data Download**. + +#. In the **Reports** section, select **Generate ORA Submission Files Archive**. + + A status message indicates that the ORA data report is being generated. This + process might take some time to complete, but you can navigate away from this + page and do other work while it runs. + + To check the progress of the report generation, reload the page in your + browser and scroll down to the **Pending Tasks** section. The table shows + the status of active tasks. + + When the report is complete, a linked .zip file name becomes available above + the **Pending Tasks** section. File names are in the format + ``{course_id}_submission_files_{datetime}.csv``. The most recently generated + reports appear at the top of the list. + +#. To open or save the generated ORA submission files archive, locate and select + the link for the archive you requested. + + You can open .zip files using your computer and navigate the student's + submissions from your file explorer. + + +.. _Interpret the ORA Submission Files Archive: + +Interpret the ORA Submission Files Archive +******************************************* + +The ORA submission files archive for your course is a zipped folder that contains +both a time-stamped .csv file listing out all included submissions as well as +folder directories with the contents of these submissions for each ORA problem +contained in your course. + +This zipped directory contains a ``downloads.csv`` file which lists all available submissions, +their location, the content of any text submissions and file IDs for any attached +files included in the submission. Missing or corrupted files will be annotated with +``False`` in the ``file_found`` column of this document but will not be included in the +zipped file archive. + +Inside the zipped directory there's a folder for each unit that contains an ORA +problem in the course named using the following format: ``[section_index] Section +title, [subsection_index] Subsection name, [unit_index] Unit name``. +Example: ``[1] First section, [2] Second subsection, [3] Unit name``. + +Each of the folders mentioned above contain the text submissions for all students +in .txt format along with any attached files in that submission if applicable. The +filename indicates the ORA index, username (or partner ID if available) and +prompt index for a given ORA. When responses are file uploads, the name will also +include the original filename. +Example: ``[1] - john_doe - prompt_0.txt``. + + +.. seealso:: + + + :ref:`Open Response Assessments` (concept) + + :ref:`Create an ORA Assignment` (how to) + + :ref:`Managing ORA Assignments` (how to) + + :ref:`ORA Staff Grading` (reference) + + + +**Maintenance chart** + ++--------------+-------------------------------+----------------+--------------------------------+ +| Review Date | Working Group Reviewer | Release |Test situation | ++--------------+-------------------------------+----------------+--------------------------------+ +| | | | | ++--------------+-------------------------------+----------------+--------------------------------+ diff --git a/source/educators/how-tos/course_development/exercise_tools/add_chemical_equation.rst b/source/educators/how-tos/course_development/exercise_tools/add_chemical_equation.rst index c6823e089..d01ad3533 100644 --- a/source/educators/how-tos/course_development/exercise_tools/add_chemical_equation.rst +++ b/source/educators/how-tos/course_development/exercise_tools/add_chemical_equation.rst @@ -81,7 +81,7 @@ Sample Chemical Equation Problem Code .. seealso:: - :ref:`Chemical Equation Problem XML` (reference) + :ref:`Guide to Chemical Equation Problem XML` (reference) **Maintenance chart** diff --git a/source/educators/how-tos/course_development/exercise_tools/adding_dropdown.rst b/source/educators/how-tos/course_development/exercise_tools/add_dropdown.rst similarity index 96% rename from source/educators/how-tos/course_development/exercise_tools/adding_dropdown.rst rename to source/educators/how-tos/course_development/exercise_tools/add_dropdown.rst index 42fd27e23..b43c9ab4b 100644 --- a/source/educators/how-tos/course_development/exercise_tools/adding_dropdown.rst +++ b/source/educators/how-tos/course_development/exercise_tools/add_dropdown.rst @@ -1,10 +1,12 @@ -.. _Adding Dropdown: +.. _Add Dropdown: Add a Dropdown Problem ###################### .. tags:: educator, how-to +.. youtube:: e6HxKo18_xE + You add dropdown problems in Studio by selecting the **Problem** component. In the problem editor, select the **Dropdown** option. Fill in the fields on this screen to create your problem. @@ -28,7 +30,7 @@ Creating a dropdown problem is as simple as: #. Selecting and filling in any desired settings on the right. If you have any questions on the specifics of using the simple editor, please -check out :ref:`Simple Editor` and :ref:`Problem Settings`. +check out :ref:`Simple Editor` and :ref:`Guide to Problem Settings`. .. _Editing Dropdown Problems using the Advanced Editor: diff --git a/source/educators/how-tos/course_development/exercise_tools/create_external_grader.rst b/source/educators/how-tos/course_development/exercise_tools/add_external_grader.rst similarity index 91% rename from source/educators/how-tos/course_development/exercise_tools/create_external_grader.rst rename to source/educators/how-tos/course_development/exercise_tools/add_external_grader.rst index 530e269ee..151cf477e 100644 --- a/source/educators/how-tos/course_development/exercise_tools/create_external_grader.rst +++ b/source/educators/how-tos/course_development/exercise_tools/add_external_grader.rst @@ -1,6 +1,6 @@ -.. _Create an External Grader Problem in Studio: +.. _Add an External Grader Problem: -Create an External Grader Problem in Studio +Add an External Grader Problem in Studio ########################################### .. tags:: educator, how-to @@ -30,7 +30,7 @@ To create a code response problem in Studio, follow these steps. .. seealso:: - :ref:`External Grader` (concept) + :ref:`About External Grader Problems` (concept) :ref:`External Grader Problem Requirements` (reference) diff --git a/source/educators/how-tos/course_development/exercise_tools/add_hints_advanced_editor.rst b/source/educators/how-tos/course_development/exercise_tools/add_hints_advanced_editor.rst index ab238794a..e1a9e4307 100644 --- a/source/educators/how-tos/course_development/exercise_tools/add_hints_advanced_editor.rst +++ b/source/educators/how-tos/course_development/exercise_tools/add_hints_advanced_editor.rst @@ -1,7 +1,7 @@ -.. _Adding Hints via the Advanced Editor: +.. _Add Hints via the Advanced Editor: -Adding Hints via the Advanced Editor +Add Hints via the Advanced Editor ##################################### .. tags:: educator, how-to @@ -44,14 +44,35 @@ For example, the following OLX for a single select problem shows two hints. .. seealso:: +:ref:`About Problems Exercises and Tools` (concept) - :ref:`Dropdown` (reference) +:ref:`Core Problem Types` (reference) - :ref:`Dropdown Problem XML` (reference) +:ref:`Working with Problem Components` (reference) - :ref:`Adding Dropdown` (how to) +:ref:`Guide to Problem Settings` (reference) - :ref:`Use Feedback in a Dropdown Problem` (how to) +:ref:`Gradebook Assignment Types` (reference) + +:ref:`Feedback Best Practices` (concept) + +:ref:`Adding Feedback and Hints to a Problem` (reference) + +:ref:`Configure Hint` (how-to) + +:ref:`Partial Credit` (reference) + +:ref:`Set the Assignment Type and Due Date for a Subsection` (how-to) + +:ref:`Adding Tooltips` (reference) + +:ref:`Learner View of Problems` (reference) + +:ref:`Advanced Editor` (reference) + +:ref:`Modifying a Released Problem` (reference) + +:ref:`Add Unsupported Exercises Problems` (how-to) **Maintenance chart** diff --git a/source/educators/how-tos/course_development/exercise_tools/adding_multi_select.rst b/source/educators/how-tos/course_development/exercise_tools/add_multi_select.rst similarity index 97% rename from source/educators/how-tos/course_development/exercise_tools/adding_multi_select.rst rename to source/educators/how-tos/course_development/exercise_tools/add_multi_select.rst index 210a89d75..aa8429a85 100644 --- a/source/educators/how-tos/course_development/exercise_tools/adding_multi_select.rst +++ b/source/educators/how-tos/course_development/exercise_tools/add_multi_select.rst @@ -1,10 +1,12 @@ .. _Add a Multi Select Problem: -Add a Multi-select Problem -########################## +Add a Multi-select (Checkbox) Problem +###################################### .. tags:: educator, how-to +.. youtube:: 6VYKcMeZrxg + You add multi-select problems in Studio by selecting the **Problem** component. In the problem editor, select **the Multi-select** option. Fill in the fields on this screen to create your problem. @@ -28,7 +30,7 @@ Creating a multi-select problem is as simple as: #. Selecting and filling in any desired settings on the right. If you have any questions on the specifics of using the simple editor, please check -out :ref:`Simple Editor` and :ref:`Problem Settings`. +out :ref:`Simple Editor` and :ref:`Guide to Problem Settings`. .. _Adding Feedback for Multi select Problems: @@ -124,8 +126,6 @@ You can add hints to a multi-select problem. For an overview of hints in problem :ref:`Multi select` (reference) - :ref:`Add a Checkbox Problem` (how-to) - :ref:`Edit Multi select Problems using the Advanced Editor` (how-to) :ref:`Adding Feedback and Hints to a Problem` (how-to) diff --git a/source/educators/how-tos/course_development/exercise_tools/add_numerical_input_problem.rst b/source/educators/how-tos/course_development/exercise_tools/add_numerical_input_problem.rst deleted file mode 100644 index 4f1f392bf..000000000 --- a/source/educators/how-tos/course_development/exercise_tools/add_numerical_input_problem.rst +++ /dev/null @@ -1,149 +0,0 @@ -.. _Adding Numerical Input Problem: - -################################ -Adding a Numerical Input Problem -################################ - -.. tags:: educator, how-to - -.. youtube:: fkoF8ZDPMoQ - -You add numerical input problems in Studio by selecting the **Problem** -component. In the problem editor, select the **Numerical Input** option. Fill in -the fields on this screen to create your problem. - -.. image:: /_images/educator_how_tos/problem_editor_numerical_input.png - :alt: An example numerical input problem in the problem editor with number - indicators labeling the various features. - :width: 800 - -Creating a numerical input problem is as simple as: - -#. Editing the **Display Name**. Click the pen symbol to edit. -#. Filling in the **Question** field. -#. Filling in the **Explanation** field. When this is shown to learners is - based on the selection in the **Show answer** panel on the right. -#. Filling in the **Answer** fields. For numerical input problems, only correct - answers can be added here. Additional answers can be added by clicking the - **Add answer** button. Answers can be deleted by clicking the trash can icon. - Feedback can be provided for each answer. More information on feedback can be - found in the following section. -#. Selecting and filling in any desired settings on the right. - -.. note:: Only correct answers can be added to a numerical input problem. - -If you have any questions on the specifics of using the simple editor, please check -out :ref:`Simple Editor` and :ref:`Problem Settings`. - -***************************** -Adding a Tolerance or a Range -***************************** - -To give learners the option to receive full credit for a close approximation of -the correct answer, and to support a wide range of possible correct numerical -answers, you can specify a tolerance for the correct answer or a range of values -to mark as correct for the numerical input problem type. - -.. contents:: - :local: - :depth: 1 - -.. note:: You can either have a **tolerance** or an **answer range** for a - numerical input problem. You cannot add both. - -================== -Adding a Tolerance -================== - -You can specify a margin of error or tolerance for learner responses. You -can specify a percentage or number. The tolerance settings panel can be -found to the right of the editor. - -.. image:: /_images/educator_how_tos/problem_editor_tolerance_box.png - :alt: An example tolerance setting set to 5%. - :width: 200 - -========================== -Specifying an Answer Range -========================== - -You can specify an answer range so that any learner response within that range -is marked correct. - -Add an answer range by selecting the **Add answer range** button from the -**Add answer** dropdown. This option can only be selected if you only have one -answer. This will replace your answer field with an answer range field. - -.. image:: /_images/educator_how_tos/problem_editor_answer_range_box.png - :alt: An example answer range set from 1 to 10. This includes 1 but not 10. - :width: 200 - -To format an answer range, you provide the starting and -ending values and then separate them with a comma character (``,``). You then -surround the range with bracket (``[ ]``) or parentheses characters (``( )``), -or a combination of one bracket and one parenthesis. - -* Use a bracket to include the number next to it in the range, as in a less - than or equal to, or greater than or equal to, inequality. - -* Use a parenthesis to exclude the number from the range, as in a less than or - greater than inequality. - -For example, to identify the correct answers as 5, 6, or 7, but not 8, specify -``[5,8)``. To identify the correct answers as 6, 7, and 8, but not 5, specify -``(5,8]``. - - -=============== -Adding Feedback -=============== - -For an overview of feedback in problems, see :ref:`Adding Feedback and Hints to -a Problem`. In numerical input problems, you can provide feedback for correct -responses. If you define multiple correct responses, you can define feedback -for each response. In numerical input problems, use feedback to reinforce the -process used to arrive at the correct answer. - -You can add answer-specific feedback for each answer in a numerical input problem. -You can access the feedback panel shown below by clicking the button to the right -of the answer text. - -.. image:: /_images/educator_how_tos/problem_editor_feedback_box_2.png - :alt: An example of an expanded feedback section for dropdown problems showing - the 'is selected' feedback field. - :width: 600 - -Simply enter your feedback message in this text field. It will display when the -learner submits this answer. - -.. note:: You cannot add feedback for an incorrect answer in numerical input - problems. Add hints to guide the learners in the correct direction instead. - -.. _Use Hints in a Numerical Input Problem: - -============ -Adding Hints -============ - -You can add hints to a numerical input problem using the simple editor or the -advanced editor. For an overview of hints in problems, see -:ref:`Adding Feedback and Hints to a Problem`. - -.. seealso:: - - - :ref:`Numerical Input` (reference) - - :ref:`Use Feedback in a Numerical Input Problems` (how to) - - :ref:`Numerical Input Problem XML` (reference) - - :ref:`Awarding Partial Credit in a Numerical Input Problem` (how to) - -**Maintenance chart** - -+--------------+-------------------------------+----------------+--------------------------------+ -| Review Date | Working Group Reviewer | Release |Test situation | -+--------------+-------------------------------+----------------+--------------------------------+ -| | | | | -+--------------+-------------------------------+----------------+--------------------------------+ diff --git a/source/educators/how-tos/course_development/exercise_tools/add_single_select.rst b/source/educators/how-tos/course_development/exercise_tools/add_single_select.rst index 2922569e9..349c1dea0 100644 --- a/source/educators/how-tos/course_development/exercise_tools/add_single_select.rst +++ b/source/educators/how-tos/course_development/exercise_tools/add_single_select.rst @@ -5,6 +5,8 @@ Add a Single Select Problem .. tags:: educator, how-to +.. youtube:: ij5VHvY6jBk + You add single select problems in Studio by selecting the **Problem** component. In the problem editor, select the **Single select** option. Fill in the fields on this screen to create your problem. @@ -28,7 +30,7 @@ Creating a single select problem is as simple as: #. Selecting and filling in any desired settings on the right. If you have any questions on the specifics of using the simple editor, please check -out :ref:`Simple Editor` and :ref:`Problem Settings`. +out :ref:`Simple Editor` and :ref:`Guide to Problem Settings`. .. note:: With the single select problem type, although the learner only selects one answer, you can set more than one correct answer. You can do this by ticking @@ -36,7 +38,7 @@ out :ref:`Simple Editor` and :ref:`Problem Settings`. .. _Use Feedback in a Single Select Problem: -Adding Feedback +Add Feedback *************** For an overview of feedback in problems, see :ref:`Adding Feedback and Hints to @@ -68,7 +70,7 @@ learner submits this answer. .. _Use Hints in a Single Select Problem: -Adding Hints +Add Hints ************ You can add hints to a single select problem . For an overview of hints in @@ -77,7 +79,7 @@ problems, see :ref:`Adding Feedback and Hints to a Problem`. .. seealso:: - :ref:`Single Select Overview` (concept) + :ref:`About Single Select` (concept) :ref:`Single Select Problem XML` (reference) diff --git a/source/educators/how-tos/course_development/exercise_tools/add_single_select_num_input.rst b/source/educators/how-tos/course_development/exercise_tools/add_single_select_num_input.rst index 1fcb6f97d..b366c904f 100644 --- a/source/educators/how-tos/course_development/exercise_tools/add_single_select_num_input.rst +++ b/source/educators/how-tos/course_development/exercise_tools/add_single_select_num_input.rst @@ -54,11 +54,11 @@ Single Select and Numerical Input Problem Code .. seealso:: - :ref:`Numerical Input` (reference) + :ref:`About Numerical Input` (reference) - :ref:`Adding Numerical Input Problem` (how-to) + :ref:`Manage Numerical Input Problem` (how-to) - :ref:`Single Select Overview` (concept) + :ref:`About Single Select` (concept) :ref:`Single Select` (how-to) diff --git a/source/educators/how-tos/course_development/exercise_tools/add_text_input.rst b/source/educators/how-tos/course_development/exercise_tools/add_text_input.rst index 410a5ffa2..b88c6f7fd 100644 --- a/source/educators/how-tos/course_development/exercise_tools/add_text_input.rst +++ b/source/educators/how-tos/course_development/exercise_tools/add_text_input.rst @@ -1,7 +1,7 @@ .. _Add Text Input Problem: ########################### -Adding a Text Input Problem +Add a Text Input Problem ########################### .. tags:: educator, how-to @@ -29,10 +29,10 @@ Creating a text input problem is as simple as: #. Selecting and filling in any desired settings on the right. If you have any questions on the specifics of using the simple editor, please check -out :ref:`Simple Editor` and :ref:`Problem Settings`. +out :ref:`Simple Editor` and :ref:`Guide to Problem Settings`. *************** -Adding Feedback +Add Feedback *************** For an overview of feedback in problems, see :ref:`Adding Feedback and Hints to @@ -58,7 +58,7 @@ Simply enter your feedback message in this text field. It will display when the learner submits this answer. ************ -Adding Hints +Add Hints ************ You can add hints to a text input problem using the simple editor or the diff --git a/source/educators/how-tos/course_development/exercise_tools/add_unsupported_problem_types.rst b/source/educators/how-tos/course_development/exercise_tools/add_unsupported_problem_types.rst index d07fa11c4..3d9b87eff 100644 --- a/source/educators/how-tos/course_development/exercise_tools/add_unsupported_problem_types.rst +++ b/source/educators/how-tos/course_development/exercise_tools/add_unsupported_problem_types.rst @@ -1,6 +1,6 @@ .. _Add Unsupported Exercises Problems: -Adding Unsupported Problem Types and Exercises +Add Unsupported Problem Types and Exercises ############################################### .. tags:: educator, how-to @@ -29,12 +29,35 @@ in Studio. .. seealso:: + :ref:`About Problems Exercises and Tools` (concept) - :ref:`Create Exercises` (concept) + :ref:`Core Problem Types` (reference) - :ref:`Enable Additional Exercises and Tools` (how to) + :ref:`Working with Problem Components` (reference) - :ref:`Core Problem Types` (reference) + :ref:`Guide to Problem Settings` (reference) + + :ref:`Gradebook Assignment Types` (reference) + + :ref:`Feedback Best Practices` (concept) + + :ref:`Adding Feedback and Hints to a Problem` (reference) + + :ref:`Configure Hint` (how-to) + + :ref:`Partial Credit` (reference) + + :ref:`Set the Assignment Type and Due Date for a Subsection` (how-to) + + :ref:`Adding Tooltips` (reference) + + :ref:`Learner View of Problems` (reference) + + :ref:`Advanced Editor` (reference) + + :ref:`Add Hints via the Advanced Editor` (how-to) + + :ref:`Modifying a Released Problem` (reference) **Maintenance chart** diff --git a/source/educators/how-tos/course_development/exercise_tools/adding_math_expression_problem.rst b/source/educators/how-tos/course_development/exercise_tools/adding_math_expression_problem.rst index 68780e272..e66465320 100644 --- a/source/educators/how-tos/course_development/exercise_tools/adding_math_expression_problem.rst +++ b/source/educators/how-tos/course_development/exercise_tools/adding_math_expression_problem.rst @@ -24,7 +24,7 @@ To create a math expression input problem, follow these steps. problem. #. Provide an identifying **Display Name** and define - settings for the problem. For more information, see :ref:`Problem Settings`. + settings for the problem. For more information, see :ref:`Guide to Problem Settings`. #. Select **Save**. diff --git a/source/educators/how-tos/course_development/exercise_tools/adding_text_in_numeric_response_field.rst b/source/educators/how-tos/course_development/exercise_tools/adding_text_in_numeric_response_field.rst deleted file mode 100644 index deedd2c3b..000000000 --- a/source/educators/how-tos/course_development/exercise_tools/adding_text_in_numeric_response_field.rst +++ /dev/null @@ -1,75 +0,0 @@ -.. _Add Text After the Numeric Response Field: - -Add Text after the Numeric Response Field -######################################### - -.. tags:: educator, how-to - -You might want to include a word, phrase, or sentence after the response field -in a numerical input problem to help guide your students or resolve ambiguity. - -.. image:: /_images/educator_how_tos/NI_trailing_text.png - :width: 500 - :alt: Three numerical input problems with text after the response field: - "km", a percent sign, and a symbol for meters per second squared. - -To do this, you use the advanced editor. - -In the problem, locate the ``formulaequationinput`` element. This element -creates the response field for the problem and is a child of the -``numericalresponse`` element. - -To add text after the response field, add the ``trailing_text`` attribute -together with the symbol or text that you want to use inside the -``formulaequationinput`` element. An example problem follows with three -questions that use this attribute. - -.. note:: You can use MathJax inside the ``trailing_text`` attribute, as the - third question in this example shows. You cannot use HTML inside this - attribute. - -.. code-block:: xml - - - - - - - - - - - - - - - - - - - -.. seealso:: - - - :ref:`Numerical Input` (reference) - - :ref:`Adding Numerical Input Problem` (how-to) - - :ref:`Awarding Partial Credit in a Numerical Input Problem` (how-to) - - :ref:`Use Feedback in a Numerical Input Problems` (how-to) - - :ref:`Editing Numerical Input Problems using the Advanced Editor` (how-to) - - :ref:`Numerical Input Problem XML` (reference) - - -**Maintenance chart** - -+--------------+-------------------------------+----------------+--------------------------------+ -| Review Date | Working Group Reviewer | Release |Test situation | -+--------------+-------------------------------+----------------+--------------------------------+ -| | | | | -+--------------+-------------------------------+----------------+--------------------------------+ diff --git a/source/educators/how-tos/course_development/exercise_tools/award_partial_credit.rst b/source/educators/how-tos/course_development/exercise_tools/award_partial_credit.rst deleted file mode 100644 index 4fab9ab92..000000000 --- a/source/educators/how-tos/course_development/exercise_tools/award_partial_credit.rst +++ /dev/null @@ -1,136 +0,0 @@ -.. _Award Partial Credit: - -Award Partial Credit for a Custom Python-Evaluated Input Problem -################################################################# - -.. tags:: educator, how-to - -You can configure a custom Python-evaluated input problem so that learners -who give a partially correct answer receive partial credit for the problem. -You can award 50% of the points for the problem, or you can award a different -percentage of points. For more information, see the following sections. - -* :ref:`Award Half Credit` -* :ref:`Award a Percentage of Credit` - -.. _Award Half Credit: - -Award Half Credit -***************** - -You can configure a problem to award 50% of the possible points. To provide a -learner with a more granular score, see `Award a Percentage of Credit`_. - -The ``check`` function must return the value ``"Partial"`` in one of the -following ways. - -* Return the value ``"Partial"`` directly. - -* Return the value ``"Partial"`` in the dictionary that is returned, in the - following form. - - ``{ 'ok': 'Partial', 'msg': 'Message' }`` - -* Return the value ``"Partial"`` as part of the input list for multi-part - problems. - - .. code-block:: python - - { 'overall_message': 'Overall message', - 'input_list': [ - { 'ok': True, 'msg': 'Feedback for input 1'}, - { 'ok': False, 'msg': 'Feedback for input 2'}, - { 'ok': 'Partial', 'msg': 'Feedback for input 3'} - ... ] } - -With all of these options, ``True`` awards learners with 100% of the available -points for the problem, ``'Partial'`` with 50%, and ``False`` with 0%. - -For more information about ``check`` function return values, see :ref:`The Check Function`. - -.. _Award a Percentage of Credit: - -Award a Percentage of Credit -**************************** - -You can configure a problem to return a percent value as a grade. This method -provides greater flexibility in assigning the learner a score than -:ref:`awarding half credit`. - -In the following example, the learner's score equals the answer divided by 100. - -.. image:: /_images/educator_references/partial-credit-python-problem.png - :alt: An image of a write-your-own-grader problem that provides partial - credit. - -The following code shows the configuration of this problem. - -.. code-block:: xml - - -

In the following problem, the learner receives a score that equals the - answer / 100. If the learner's answer is greater than 100 or less than 0, - the score equals 0.

- - - -

Enter a number beween 0 and 100.

- -
- - - -This example illustrates the following points. - -* The ``points`` attribute of the ```` element specifies that - the question is worth 100 points. - -* The ``give_partial_credit`` function checks that the answer is between 0 and - 100, and if so divides the learner's answer by 100 to determine the grade. - -* The ``input_list`` that is returned specifies that: - - * The answer is acceptable and can receive partial or full credit, with the - item ``'ok': True``. - - * The learner receives the message ``Your grade is`` followed by the percent - grade, with the item ``'msg': 'Your grade is ' + str(ans) + '%'``. - - * The grade assigned is the learner's answer divided by 100, with the item - ``'grade_decimal':grade``. - -You can enhance and apply this example for your own partial credit problems. - -.. seealso:: - - - :ref:`Write Your Own Grader` (reference) - - :ref:`Create a Custom Python Evaluated Input Problem in Studio` (how to) - - :ref:`Create a Custom Python Evaluated Input Problem in Script Tag Format` (how to) - - :ref:`Create a Randomized Custom Python Evaluated Input Problem` (how to) - - :ref:`Script Tag Format` (concept) - -**Maintenance chart** - -+--------------+-------------------------------+----------------+--------------------------------+ -| Review Date | Working Group Reviewer | Release |Test situation | -+--------------+-------------------------------+----------------+--------------------------------+ -| | | | | -+--------------+-------------------------------+----------------+--------------------------------+ diff --git a/source/educators/how-tos/course_development/exercise_tools/award_partial_credit_multiple_choice.rst b/source/educators/how-tos/course_development/exercise_tools/award_partial_credit_multiple_choice.rst index 95f1e3326..acc5b2d77 100644 --- a/source/educators/how-tos/course_development/exercise_tools/award_partial_credit_multiple_choice.rst +++ b/source/educators/how-tos/course_development/exercise_tools/award_partial_credit_multiple_choice.rst @@ -196,7 +196,7 @@ explanation ID. .. seealso:: - :ref:`Single Select Overview` (concept) + :ref:`About Single Select` (concept) :ref:`Single Select` (how-to) diff --git a/source/educators/how-tos/course_development/exercise_tools/award_partial_credit_numerical_input.rst b/source/educators/how-tos/course_development/exercise_tools/award_partial_credit_numerical_input.rst index 4312ea59a..5642efedc 100644 --- a/source/educators/how-tos/course_development/exercise_tools/award_partial_credit_numerical_input.rst +++ b/source/educators/how-tos/course_development/exercise_tools/award_partial_credit_numerical_input.rst @@ -1,4 +1,4 @@ -.. _Awarding Partial Credit in a Numerical Input Problem: +.. _Award Partial Credit in a Numerical Input Problem: Award Partial Credit in a Numerical Input Problem ################################################# @@ -129,9 +129,9 @@ updated to provide partial credit for a different answer. .. seealso:: - :ref:`Numerical Input` (reference) + :ref:`About Numerical Input` (reference) - :ref:`Adding Numerical Input Problem` (how-to) + :ref:`Manage Numerical Input Problem` (how-to) :ref:`Add Text After the Numeric Response Field` (how-to) diff --git a/source/educators/how-tos/course_development/exercise_tools/create_custom_javascript.rst b/source/educators/how-tos/course_development/exercise_tools/create_custom_javascript.rst index 7041a03fc..afd4c43a4 100644 --- a/source/educators/how-tos/course_development/exercise_tools/create_custom_javascript.rst +++ b/source/educators/how-tos/course_development/exercise_tools/create_custom_javascript.rst @@ -45,7 +45,7 @@ Create a Custom JavaScript Display and Grading Problem .. seealso:: - :ref:`Custom JavaScript` (reference) + :ref:`Guide to Custom JavaScript Display and Grading Problem` (reference) **Maintenance chart** diff --git a/source/educators/how-tos/course_development/exercise_tools/create_custom_python_problem.rst b/source/educators/how-tos/course_development/exercise_tools/create_custom_python_problem.rst index 94f2b21a1..7daad2c53 100644 --- a/source/educators/how-tos/course_development/exercise_tools/create_custom_python_problem.rst +++ b/source/educators/how-tos/course_development/exercise_tools/create_custom_python_problem.rst @@ -1,11 +1,148 @@ -.. _Create a Custom Python Evaluated Input Problem in Studio: +.. _Create a Custom Python Evaluated Input Problem: -Create a Custom Python-Evaluated Input Problem in Studio -######################################################## +Create a Custom Python-Evaluated Input Problem +################################################################### .. tags:: educator, how-to -Following the next steps, you can :ref:`Write Your Own Grader` using Python in your Open edX instance. In custom Python-evaluated input (also called "write-your-own-grader" problems), the grader uses a Python script that you create and embed in the problem to evaluate a learner's response or provide hints. These problems can be any type. Numerical input and text input problems are the most common write-your-own-grader problems. +.. contents:: + :local: + :depth: 2 + +Create a Standard Python Problem +******************************** + +You can use a script or answer tag format to create these problems. To create a custom Python-evaluated input problem using a `` + +

Part 1: Enter two integers that sum to 10.

+ +
+ + + +

Part 2: Enter two integers that sum to 20.

+ +
+ + + + +
+

Explanation

+

For part 1, any two numbers of the form n and 10-n, + where n is any integer, will work. One possible answer would + be the pair 0 and 10.

+

For part 2, any two numbers of the form n and 20-n, where n is any integer, will work. One possible answer would be the pair 1 and 19

+
+ + + +Sample Code: Problem with Sample Answers +===================================================== + +The following template includes answers that appear when the learner selects +**Show Answer**. + +.. code-block:: xml + + + + + +

Problem text

+ +
+ + + + +
+

Solution or Explanation Heading

+

Solution or explanation text

+
+ + + +Sample Code: Problem with No Sample Answers +===================================================== + +The following template does not return answers when the learner selects **Show +Answer**. If your problem does not include answers for the learner to see, make +sure to set **Show Answer** to **Never** in the problem component. + +.. code-block:: xml + + + + + +

Enter two real numbers that sum to 20:

+ +
+ + + + +
+

Solution or Explanation Heading

+

Solution or explanation text

+
+ + + + +.. _Create a Randomized Custom Python Evaluated Input Problem: + +Create a Randomized Custom Python-Evaluated Input Problem +************************************************************ + +You can create a custom Python-evaluated input problem that randomizes +variables in the Python code. #. In the unit where you want to create the problem, select **Problem** under **Add New Component**. @@ -14,26 +151,169 @@ Following the next steps, you can :ref:`Write Your Own Grader` using Python in y #. In the component editor, modify the example as needed. +#. Select the randomization option that applies better to your exercise. The option selected will define when to randomize the variables specified in the associated Python script. The options you can select are Never, Always, Per Student, and On Reset. + +.. note:: + In the problem settings, you must set the **Randomization** value to + something other than **Never** to have Python variables randomized. See + :ref:`Randomization` for more information. + #. Select **Save**. -You can also use :ref:`Script Tag Format` or answer tag format to create these problems. Learn how to :ref:`Create a Custom Python Evaluated Input Problem in Script Tag Format`. +Example: Problem with Randomized Variables +============================================ +The following example demonstrates using randomization with a Python-evaluated +input problem. -.. seealso:: - +.. note:: + This example uses the method ``random.randint`` to generate random numbers. + You can use any standard Python library for this purpose. + +.. code-block:: xml + + +

Some problems in the course will utilize randomized parameters. + For such problems, after you check your answer you will have the option + of resetting the question, which reconstructs the problem with a new + set of parameters.

+ +

Let (x_1 = $x1) and (x_2 = $x2). What is the value of (x_1+x_2)?

+ + + + + +

Explanation:

+ + + +.. _Award Partial Credit: + +Award Partial Credit for a Custom Python-Evaluated Input Problem +****************************************************************** + +You can configure a custom Python-evaluated input problem so that learners +who give a partially correct answer receive partial credit for the problem. +You can award 50% of the points for the problem, or you can award a different +percentage of points. For more information, see the following sections. + +* :ref:`Award Half Credit` +* :ref:`Award a Percentage of Credit` + +.. _Award Half Credit: + +Award Half Credit +================== + +You can configure a problem to award 50% of the possible points. To provide a +learner with a more granular score, see `Award a Percentage of Credit`_. + +The ``check`` function must return the value ``"Partial"`` in one of the +following ways. + +* Return the value ``"Partial"`` directly. + +* Return the value ``"Partial"`` in the dictionary that is returned, in the + following form. + + ``{ 'ok': 'Partial', 'msg': 'Message' }`` + +* Return the value ``"Partial"`` as part of the input list for multi-part + problems. + + .. code-block:: python + + { 'overall_message': 'Overall message', + 'input_list': [ + { 'ok': True, 'msg': 'Feedback for input 1'}, + { 'ok': False, 'msg': 'Feedback for input 2'}, + { 'ok': 'Partial', 'msg': 'Feedback for input 3'} + ... ] } - :ref:`Write Your Own Grader` (reference) +With all of these options, ``True`` awards learners with 100% of the available +points for the problem, ``'Partial'`` with 50%, and ``False`` with 0%. - :ref:`Create a Custom Python Evaluated Input Problem in Studio` (how to) +For more information about ``check`` function return values, see :ref:`The Check Function`. - :ref:`Create a Custom Python Evaluated Input Problem in Script Tag Format` (how to) +.. _Award a Percentage of Credit: - :ref:`Create a Randomized Custom Python Evaluated Input Problem` (how to) +Award a Percentage of Credit +============================== - :ref:`Script Tag Format` (concept) +You can configure a problem to return a percent value as a grade. This method +provides greater flexibility in assigning the learner a score than +:ref:`awarding half credit`. + +In the following example, the learner's score equals the answer divided by 100. + +.. image:: /_images/educator_references/partial-credit-python-problem.png + :alt: An image of a write-your-own-grader problem that provides partial + credit. + +The following code shows the configuration of this problem. + +.. code-block:: xml + + +

In the following problem, the learner receives a score that equals the + answer / 100. If the learner's answer is greater than 100 or less than 0, + the score equals 0.

+ + + +

Enter a number beween 0 and 100.

+ +
+ + + +This example illustrates the following points. + +* The ``points`` attribute of the ```` element specifies that + the question is worth 100 points. + +* The ``give_partial_credit`` function checks that the answer is between 0 and + 100, and if so divides the learner's answer by 100 to determine the grade. + +* The ``input_list`` that is returned specifies that: + + * The answer is acceptable and can receive partial or full credit, with the + item ``'ok': True``. + + * The learner receives the message ``Your grade is`` followed by the percent + grade, with the item ``'msg': 'Your grade is ' + str(ans) + '%'``. + + * The grade assigned is the learner's answer divided by 100, with the item + ``'grade_decimal':grade``. + +You can enhance and apply this example for your own partial credit problems. + + +.. seealso:: + - :ref:`Award Partial Credit` (concept) + :ref:`About Custom Python-Evaluated Input Problem` (reference) + :ref:`Create a Custom Python Evaluated Input Problem` (how to) diff --git a/source/educators/how-tos/course_development/exercise_tools/create_custom_python_problem_script_tag.rst b/source/educators/how-tos/course_development/exercise_tools/create_custom_python_problem_script_tag.rst deleted file mode 100644 index 08135050f..000000000 --- a/source/educators/how-tos/course_development/exercise_tools/create_custom_python_problem_script_tag.rst +++ /dev/null @@ -1,144 +0,0 @@ -.. _Create a Custom Python Evaluated Input Problem in Script Tag Format: - -Create a Custom Python-Evaluated Input Problem in Script Tag Format -################################################################### - -.. tags:: educator, how-to - -You can use a script or answer tag format to create these problems. To create a custom Python-evaluated input problem using a `` - -

Part 1: Enter two integers that sum to 10.

- -
- - - -

Part 2: Enter two integers that sum to 20.

- -
- - - - -
-

Explanation

-

For part 1, any two numbers of the form n and 10-n, - where n is any integer, will work. One possible answer would - be the pair 0 and 10.

-

For part 2, any two numbers of the form n and 20-n, where n is any integer, will work. One possible answer would be the pair 1 and 19

-
- - - -**Templates** - -The following template includes answers that appear when the learner selects -**Show Answer**. - -.. code-block:: xml - - - - - -

Problem text

- -
- - - - -
-

Solution or Explanation Heading

-

Solution or explanation text

-
- - - -The following template does not return answers when the learner selects **Show -Answer**. If your problem does not include answers for the learner to see, make -sure to set **Show Answer** to **Never** in the problem component. - -.. code-block:: xml - - - - - -

Enter two real numbers that sum to 20:

- -
- - - - -
-

Solution or Explanation Heading

-

Solution or explanation text

-
- - - - -.. seealso:: - - - :ref:`Write Your Own Grader` (reference) - - :ref:`Create a Custom Python Evaluated Input Problem in Studio` (how to) - - :ref:`Create a Randomized Custom Python Evaluated Input Problem` (how to) - - :ref:`Script Tag Format` (concept) - - :ref:`Award Partial Credit` (concept) - - - - -**Maintenance chart** - -+--------------+-------------------------------+----------------+--------------------------------+ -| Review Date | Working Group Reviewer | Release |Test situation | -+--------------+-------------------------------+----------------+--------------------------------+ -| | | | | -+--------------+-------------------------------+----------------+--------------------------------+ diff --git a/source/educators/how-tos/course_development/exercise_tools/creating_a_drag_and_drop_problem.rst b/source/educators/how-tos/course_development/exercise_tools/create_drag_and_drop_problem.rst similarity index 93% rename from source/educators/how-tos/course_development/exercise_tools/creating_a_drag_and_drop_problem.rst rename to source/educators/how-tos/course_development/exercise_tools/create_drag_and_drop_problem.rst index 1effd6790..2c505b9f3 100644 --- a/source/educators/how-tos/course_development/exercise_tools/creating_a_drag_and_drop_problem.rst +++ b/source/educators/how-tos/course_development/exercise_tools/create_drag_and_drop_problem.rst @@ -1,4 +1,4 @@ -.. _Creating a Drag and Drop Problem: +.. _Create a Drag and Drop Problem: Create a Drag and Drop Problem ############################## @@ -34,7 +34,7 @@ To create a drag and drop problem, follow these steps. of a file you have added to your course or the URL of an image on the web. For more information about working with course files, see :ref:`Add Course Files`. For more information about background images, see - :ref:`drag_and_drop_background_images`. + :ref:`Guide to the Drag and Drop Problem`. Select **Change background** after you enter the URL for your background image. @@ -46,7 +46,7 @@ To create a drag and drop problem, follow these steps. * Remove the target zones for the example drag and drop problem. Select **Add a zone** to add each target zone for your problem. For more information about target zones, see - :ref:`drag_and_drop_background_images`. + :ref:`Guide to the Drag and Drop Problem`. * Remove the draggable items for the example drag and drop problem. Select **Add an item** to add draggable items for your problem. Select a matching @@ -78,9 +78,9 @@ site. For more information, see :ref:`Styling Drag and Drop Problems`. .. seealso:: - :ref:`Drag and Drop Problem ` (concept) + :ref:`Drag and Drop Problem ` (concept) - :ref:`Drag and Drop` (reference) + :ref:`Guide to the Drag and Drop Problem` (reference) **Maintenance chart** diff --git a/source/educators/how-tos/course_development/exercise_tools/create_image_mapped_input.rst b/source/educators/how-tos/course_development/exercise_tools/create_image_mapped_input.rst index 789a02449..d533a2f17 100644 --- a/source/educators/how-tos/course_development/exercise_tools/create_image_mapped_input.rst +++ b/source/educators/how-tos/course_development/exercise_tools/create_image_mapped_input.rst @@ -213,7 +213,7 @@ For example, the following ``regions`` attribute creates a pentagon. .. seealso:: - :ref:`Image Mapped Input` (reference) + :ref:`About Image Mapped Input Problem` (reference) :ref:`Image Mapped Input Problem XML` (reference) diff --git a/source/educators/how-tos/course_development/exercise_tools/create_problem_in_latex.rst b/source/educators/how-tos/course_development/exercise_tools/create_problem_in_latex.rst index cfab2f73e..e47112e7e 100644 --- a/source/educators/how-tos/course_development/exercise_tools/create_problem_in_latex.rst +++ b/source/educators/how-tos/course_development/exercise_tools/create_problem_in_latex.rst @@ -50,17 +50,17 @@ To create a problem written in LaTeX, follow these steps. .. seealso:: - :ref:`Numerical Input` (reference) + :ref:`About Numerical Input` (reference) :ref:`Numerical Input Problem XML` (reference) :ref:`Editing Numerical Input Problems using the Advanced Editor` (how-to) - :ref:`Awarding Partial Credit in a Numerical Input Problem` (how-to) + :ref:`Award Partial Credit in a Numerical Input Problem` (how-to) :ref:`Work with Latex Code` (how-to) - :ref:`Adding Numerical Input Problem` (how-to) + :ref:`Manage Numerical Input Problem` (how-to) **Maintenance chart** diff --git a/source/educators/how-tos/course_development/exercise_tools/create_protein_builder.rst b/source/educators/how-tos/course_development/exercise_tools/create_protein_builder.rst index 6ec808601..cf863bdea 100644 --- a/source/educators/how-tos/course_development/exercise_tools/create_protein_builder.rst +++ b/source/educators/how-tos/course_development/exercise_tools/create_protein_builder.rst @@ -105,7 +105,7 @@ In this code: :ref:`Chemical Equation` (how-to) - :ref:`Custom JavaScript` (reference) + :ref:`Guide to Custom JavaScript Display and Grading Problem` (reference) :ref:`Gene Explorer` (reference) diff --git a/source/educators/how-tos/course_development/exercise_tools/create_zooming_image.rst b/source/educators/how-tos/course_development/exercise_tools/create_zooming_image.rst index cc0950cae..087d51d86 100644 --- a/source/educators/how-tos/course_development/exercise_tools/create_zooming_image.rst +++ b/source/educators/how-tos/course_development/exercise_tools/create_zooming_image.rst @@ -80,7 +80,7 @@ Create a Zooming Image Tool :ref:`Add Course Files` (how-to) - :ref:`Image Mapped Input` (reference) + :ref:`About Image Mapped Input Problem` (concept) diff --git a/source/educators/how-tos/course_development/exercise_tools/edit_multi_select_using_advanced_editor.rst b/source/educators/how-tos/course_development/exercise_tools/edit_multi_select_using_advanced_editor.rst index d5d7e6c8e..455659003 100644 --- a/source/educators/how-tos/course_development/exercise_tools/edit_multi_select_using_advanced_editor.rst +++ b/source/educators/how-tos/course_development/exercise_tools/edit_multi_select_using_advanced_editor.rst @@ -151,8 +151,6 @@ See :ref:`Adding Feedback and Hints to a Problem` for more information on adding :ref:`Multi select` (reference) - :ref:`Add a Checkbox Problem` (how-to) - :ref:`Add a Multi Select Problem` (how-to) :ref:`Adding Feedback and Hints to a Problem` (how-to) diff --git a/source/educators/how-tos/course_development/exercise_tools/edit_numerical_input_advanced.rst b/source/educators/how-tos/course_development/exercise_tools/edit_numerical_input_advanced.rst deleted file mode 100644 index eb2eb70a7..000000000 --- a/source/educators/how-tos/course_development/exercise_tools/edit_numerical_input_advanced.rst +++ /dev/null @@ -1,182 +0,0 @@ -.. _Editing Numerical Input Problems using the Advanced Editor: - -Edit Numerical Input Problems using the Advanced Editor -####################################################### - -.. tags:: educator, how-to - -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 numerical input problem -with OLX. For more information, see :ref:`Numerical Input 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 - - - - - - -
-

Explanation

-

The decimal numeral system is base ten.

-
- - - - -.. 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. - -.. _Use Feedback in a Numerical Input Problems: - -Adding Feedback -*************** - -In the advanced editor, you configure feedback with the following syntax. - -.. code-block:: xml - - - - - - Feedback for the correct answer - - - -For example, the following problem has feedback for each answer. - -.. code-block:: xml - - - - - - The mean for this set of numbers is 20 / 5 which equals 4. - - - -If you define multiple correct responses, you can define feedback for each response. - -Adding Hints -************ - -See :ref:`Adding Hints via the Advanced Editor` for more information about adding hints to problems. - -.. _Multiple Responses in Numerical Input Problems: - -Adding Multiple Correct Responses -********************************* - -You can specify more than one specific, correct response for numerical input problems. -To do this, use the advanced editor. - -If you specify multiple correct responses, you cannot also specify a tolerance, a range, -or a text string as correct answers. For example, when you define multiple correct -responses, you can specify a numeric value for each correct answer but not a tolerance, -range, or text string. - -To specify an additional correct response in the advanced editor, within the -```` element add the ```` element with an -``answer=""`` attribute value. - -.. code-block:: xml - - - - - Use scientific notation to answer. - - - - - -Adding a Tolerance -****************** - -You can specify a margin of error or tolerance for learner responses. You can -specify a percentage, number, or range. - -To add a tolerance in the advanced editor you include a ```` -element with a ``type="tolerance"`` attribute and a ``default`` attribute set -to either a number or a percentage value. - -The following example shows a problem with a decimal tolerance. - -.. code-block:: xml - - - - - - - - - -The following example shows a problem with a percentage tolerance. - -.. code-block:: xml - - - - - - - - - -Specifying an Answer Range -************************** - -You can specify an answer range so that any learner response within that -range is marked correct. To format an answer range, you provide the starting -and ending values and then separate them with a comma character (``,```). You -then surround the range with bracket (``[ ]``) or parentheses characters -(``( )``), or a combination of one bracket and one parenthesis. - -* Use a bracket to include the number next to it in the range, as in a less - than or equal to, or greater than or equal to, inequality. - -* Use a parenthesis to exclude the number from the range, as in a less than or - greater than inequality. - -For example, to identify the correct answers as 5, 6, or 7, but not 8, specify -``[5,8)``. To identify the correct answers as 6, 7, and 8, but not 5, specify -``(5,8]``. - -To specify a range in the advanced editor, you enter the complete, formatted -range in the ```` element as the value for the ``answer`` -attribute: ```` or -````. - -.. seealso:: - - - :ref:`Numerical Input` (reference) - - :ref:`Adding Numerical Input Problem` (how-to) - - :ref:`Use Feedback in a Numerical Input Problems` (how-to) - - :ref:`Numerical Input Problem XML` (reference) - - :ref:`Awarding Partial Credit in a Numerical Input Problem` (how-to) - - -**Maintenance chart** - -+--------------+-------------------------------+----------------+--------------------------------+ -| Review Date | Working Group Reviewer | Release |Test situation | -+--------------+-------------------------------+----------------+--------------------------------+ -| | | | | -+--------------+-------------------------------+----------------+--------------------------------+ diff --git a/source/educators/how-tos/course_development/exercise_tools/edit_single_select_advanced.rst b/source/educators/how-tos/course_development/exercise_tools/edit_single_select_advanced.rst index 3f1f3afe2..d75a969d8 100644 --- a/source/educators/how-tos/course_development/exercise_tools/edit_single_select_advanced.rst +++ b/source/educators/how-tos/course_development/exercise_tools/edit_single_select_advanced.rst @@ -181,7 +181,7 @@ problems, see :ref:`Adding Feedback and Hints to a Problem`. .. seealso:: - :ref:`Single Select Overview` (concept) + :ref:`About Single Select` (concept) :ref:`Single Select` (how-to) diff --git a/source/educators/how-tos/course_development/exercise_tools/edit_text_input_advanced.rst b/source/educators/how-tos/course_development/exercise_tools/edit_text_input_advanced.rst index 7f429febe..874b6c615 100644 --- a/source/educators/how-tos/course_development/exercise_tools/edit_text_input_advanced.rst +++ b/source/educators/how-tos/course_development/exercise_tools/edit_text_input_advanced.rst @@ -48,7 +48,7 @@ You can see the OLX for the example problem from the Overview section below. switch back to the simple editor. -Adding Feedback +Add Feedback ***************** In the advanced editor, you configure answer feedback with the following syntax. @@ -87,14 +87,14 @@ common incorrect answers. -Adding Hints +Add Hints ************* For an overview of hints in problems, see :ref:`Adding Feedback and Hints to a Problem`. -Adding Text after the Response Field +Add Text after the Response Field ************************************** You might want to include a word, phrase, or sentence after the response field @@ -206,7 +206,7 @@ attribute. =============================================================== -Allowing Regular Expressions as Answers for Text Input Problems +Allow Regular Expressions as Answers for Text Input Problems =============================================================== You can configure a text input problem to allow a regular expression as an diff --git a/source/educators/how-tos/course_development/exercise_tools/enable_completion.rst b/source/educators/how-tos/course_development/exercise_tools/enable_completion.rst index 3076c509b..8647c749d 100644 --- a/source/educators/how-tos/course_development/exercise_tools/enable_completion.rst +++ b/source/educators/how-tos/course_development/exercise_tools/enable_completion.rst @@ -34,7 +34,7 @@ component to a unit in a course, follow these steps. .. seealso:: - :ref:`Completion` (reference) + :ref:`About the Completion Tool` (reference) :ref:`OLX Completion` (how to) diff --git a/source/educators/how-tos/course_development/exercise_tools/enable_exercises_tools.rst b/source/educators/how-tos/course_development/exercise_tools/enable_exercises_tools.rst index 3c6b77ba0..34b285476 100644 --- a/source/educators/how-tos/course_development/exercise_tools/enable_exercises_tools.rst +++ b/source/educators/how-tos/course_development/exercise_tools/enable_exercises_tools.rst @@ -71,7 +71,7 @@ To enable an advanced exercise or tool, follow these steps. :ref:`Core Problem Types` (reference) - :ref:`Create Exercises` (concept) + :ref:`About Problems Exercises and Tools` (concept) **Maintenance chart** diff --git a/source/educators/how-tos/course_development/exercise_tools/enable_lti_component.rst b/source/educators/how-tos/course_development/exercise_tools/enable_lti_component.rst index 247f2e3f3..dd36e845d 100644 --- a/source/educators/how-tos/course_development/exercise_tools/enable_lti_component.rst +++ b/source/educators/how-tos/course_development/exercise_tools/enable_lti_component.rst @@ -24,18 +24,16 @@ information, see :ref:`Enable Additional Exercises and Tools`. .. seealso:: + :ref:`About the LTI Component` (concept) - :ref:`LTI Component` (reference) + :ref:`LTI Component Settings` (reference) - :ref:`LTI Component settings` (reference) + :ref:`Set up an LTI 1_1 component` (how-to) - :ref:`Setting up a LTI 1.1 component` (how-to) - - :ref:`Setting up a LTI 1.3 component` (how-to) + :ref:`Set up an LTI 1_3 component` (how-to) :ref:`Enabling and using LTI Advantage features` (how-to) - **Maintenance chart** +--------------+-------------------------------+----------------+--------------------------------+ diff --git a/source/educators/how-tos/course_development/exercise_tools/enable_olx_completion.rst b/source/educators/how-tos/course_development/exercise_tools/enable_olx_completion.rst index eb1a523d4..b5d1848e0 100644 --- a/source/educators/how-tos/course_development/exercise_tools/enable_olx_completion.rst +++ b/source/educators/how-tos/course_development/exercise_tools/enable_olx_completion.rst @@ -24,9 +24,9 @@ the associated problems is lost each time a new ``url_name`` value is assigned. .. seealso:: - :ref:`Enable Completion` (how to) + :ref:`About the Completion Tool` (reference) - :ref:`Completion` (reference) + :ref:`Enable Completion` (how to) **Maintenance chart** diff --git a/source/educators/how-tos/course_development/exercise_tools/generate_ORA_report.rst b/source/educators/how-tos/course_development/exercise_tools/generate_ORA_report.rst deleted file mode 100644 index 320b30a38..000000000 --- a/source/educators/how-tos/course_development/exercise_tools/generate_ORA_report.rst +++ /dev/null @@ -1,136 +0,0 @@ -.. _Generate ORA Report: - -Generate a Report for ORA Assignments -###################################### - -To generate a report containing details of the ORA assignments in the course, -follow these steps. - -#. View the live version of your course. - -#. Select **Instructor**, and then select **Data Download**. - -#. In the **Reports** section, select **Generate ORA Data Report**. - - A status message indicates that the ORA data report is being generated. This - process might take some time to complete, but you can navigate away from this - page and do other work while it runs. - - To check the progress of the report generation, reload the page in your - browser and scroll down to the **Pending Tasks** section. The table shows - the status of active tasks. - - When the report is complete, a linked .csv file name becomes available above - the **Pending Tasks** section. File names are in the format - ``{course_id}_ORA_data_{datetime}.csv``. The most recently generated - reports appear at the top of the list. - -#. To open or save the generated ORA data report, locate and select the link - for the grade report you requested. - - You can open .csv files in a spreadsheet application to sort, graph, and - compare data. - - -.. _Interpret ORA Data Report: - -Interpret the ORA Data Report -****************************** - -The ORA data report for your course is a time-stamped .csv file that contains -data for all the ORA assignments in your course. For each ORA assignment in -the course, the report provides information that includes each learner's -anonymized ID, response, assessments details and scores, and the final score -for the assignment. For more details about each column in the report, see the -following descriptions. - - -.. image:: /_images/educator_references/ORA_Data_Report_Example.png - :alt: An example ORA data report shown in Excel. - - -The .csv file contains one row of data for each response from a learner. - -* The IDs in the **Submission ID** and **Item ID** columns uniquely identify the - problem within the course content and the learner's submission for that - problem. The **Problem Name** column is also available to help identify a - problem by its display name. - -* The **Username** column helps identify impacted learner submissions for further - platform review if applicable. - -* The **Anonymized Student ID** column lists an ID for each learner without - revealing confidential, personally identifiable data such as email addresses - and usernames. - -* The **Date/Time Response Submitted** column displays the date and time that the - learner submitted her response, in YYYY-MM-DD HH-MM-SS format. - -* The **Response** column displays the content of the learner's response. - -* The **Assessment Details** column displays the following details for the - assessments that were performed on the response. - - * The time and date that the assessment was submitted. - * The type of assessment: self (SE), peer (PE), staff (ST). - * The ID of the person who performed the assessment. - * Any text comments about the response that were included in the assessment. - -* The **Assessment Scores** column lists the scores that the response received - in self, peer, or staff assessments. - -* The **Date/Time Final Score Given**, **Final Score Points Earned**, and the - **Final Score Points Possible** columns provide details of the final score - that the response received. If a response has not received enough - assessments for the assignment to be considered complete, these columns show - a value of "None". - -* The **Feedback Statements Selected** and **Feedback on Peer Assessments** - columns together show the information that learners provided in the **Provide - Feedback on Peer Assessments** section of their ORA assignments. This section - is available to learners only when all assessments for an assignment have been - completed, and provides an optional way for learners to comment on their - experience of the peer assessment process. - - The **Feedback Statements Selected** column displays the text of the - feedback statements (if any) that the learner selected to describe their - experience of the peer assessment process. Learners can select either "These - assessments were useful" or "These assessments were not useful". They can - also select either or both of "I disagree with one or more of the peer - assessments of my response" and "Some comments I received were - inappropriate". - - If a learner also provided a free-form comment in the text field below the - selectable feedback statements, the text appears in the **Feedback on Peer - Assessments** column. - -.. seealso:: - - - :ref:`Open Response Assessments` (concept) - - :ref:`Accessing ORA Assignment Information` (reference) - - :ref:`List and manage students waiting in peer step` (how-to) - - :ref:`View Metrics for All ORA Assignments` (how-to) - - :ref:`PA View Metrics for Individual Steps` (how-to) - - :ref:`Generate a Report for ORA File Submissions and Attachments` (how-to) - - :ref:`PA Create an ORA Assignment` (how to) - - :ref:`Managing ORA Assignments` (how to) - - :ref:`ORA Staff Grading` (reference) - - - -**Maintenance chart** - -+--------------+-------------------------------+----------------+--------------------------------+ -| Review Date | Working Group Reviewer | Release |Test situation | -+--------------+-------------------------------+----------------+--------------------------------+ -| | | | | -+--------------+-------------------------------+----------------+--------------------------------+ diff --git a/source/educators/how-tos/course_development/exercise_tools/generate_report_ORA_submissions_attachments.rst b/source/educators/how-tos/course_development/exercise_tools/generate_report_ORA_submissions_attachments.rst deleted file mode 100644 index e38dabd3e..000000000 --- a/source/educators/how-tos/course_development/exercise_tools/generate_report_ORA_submissions_attachments.rst +++ /dev/null @@ -1,94 +0,0 @@ -.. _Generate a Report for ORA File Submissions and Attachments: - -Generate a Report for ORA File Submissions and Attachments -########################################################### - -.. tags:: educator, how-to - -To generate a report containing details of the ORA assignments in the course, -follow these steps. - -#. View the live version of your course. - -#. Select **Instructor**, and then select **Data Download**. - -#. In the **Reports** section, select **Generate ORA Submission Files Archive**. - - A status message indicates that the ORA data report is being generated. This - process might take some time to complete, but you can navigate away from this - page and do other work while it runs. - - To check the progress of the report generation, reload the page in your - browser and scroll down to the **Pending Tasks** section. The table shows - the status of active tasks. - - When the report is complete, a linked .zip file name becomes available above - the **Pending Tasks** section. File names are in the format - ``{course_id}_submission_files_{datetime}.csv``. The most recently generated - reports appear at the top of the list. - -#. To open or save the generated ORA submission files archive, locate and select - the link for the archive you requested. - - You can open .zip files using your computer and navigate the student's - submissions from your file explorer. - - -.. _Interpret the ORA Submission Files Archive: - -Interpret the ORA Submission Files Archive -******************************************* - -The ORA submission files archive for your course is a zipped folder that contains -both a time-stamped .csv file listing out all included submissions as well as -folder directories with the contents of these submissions for each ORA problem -contained in your course. - -This zipped directory contains a ``downloads.csv`` file which lists all available submissions, -their location, the content of any text submissions and file IDs for any attached -files included in the submission. Missing or corrupted files will be annotated with -``False`` in the ``file_found`` column of this document but will not be included in the -zipped file archive. - -Inside the zipped directory there's a folder for each unit that contains an ORA -problem in the course named using the following format: ``[section_index] Section -title, [subsection_index] Subsection name, [unit_index] Unit name``. -Example: ``[1] First section, [2] Second subsection, [3] Unit name``. - -Each of the folders mentioned above contain the text submissions for all students -in .txt format along with any attached files in that submission if applicable. The -filename indicates the ORA index, username (or partner ID if available) and -prompt index for a given ORA. When responses are file uploads, the name will also -include the original filename. -Example: ``[1] - john_doe - prompt_0.txt``. - -.. seealso:: - - - :ref:`Open Response Assessments` (concept) - - :ref:`Accessing ORA Assignment Information` (reference) - - :ref:`List and manage students waiting in peer step` (how-to) - - :ref:`View Metrics for All ORA Assignments` (how-to) - - :ref:`PA View Metrics for Individual Steps` (how-to) - - :ref:`Generate ORA Report` (how-to) - - :ref:`PA Create an ORA Assignment` (how to) - - :ref:`Managing ORA Assignments` (how to) - - :ref:`ORA Staff Grading` (reference) - - - -**Maintenance chart** - -+--------------+-------------------------------+----------------+--------------------------------+ -| Review Date | Working Group Reviewer | Release |Test situation | -+--------------+-------------------------------+----------------+--------------------------------+ -| | | | | -+--------------+-------------------------------+----------------+--------------------------------+ diff --git a/source/educators/how-tos/course_development/exercise_tools/list_manage_students_waiting_peer_step.rst b/source/educators/how-tos/course_development/exercise_tools/list_manage_students_waiting_peer_step.rst deleted file mode 100644 index 00bc86ab9..000000000 --- a/source/educators/how-tos/course_development/exercise_tools/list_manage_students_waiting_peer_step.rst +++ /dev/null @@ -1,69 +0,0 @@ -.. _List and manage students waiting in peer step: - -List and Manage Students Waiting in Peer Step -############################################# - -.. tags:: educator, how-to - -On ORA problems with the peer assessment step, sometimes learners might get stuck -waiting for peer responses to evaluate or peer reviews from other learners indefinitely. -There's a tool in the instructor dashboard that allows listing and managing those -learners. - -To view a list of students in the waiting step of an ORA problem in a course, follow -these steps. - -#. View the live version of the course. -#. Select **Instructor** to open the instructor dashboard. -#. On the instructor dashboard, select **Open Responses**. -#. In the table listing the ORA problems, locate the waiting column corresponding to - the problem you want to see users waiting on. -#. If there are any students in the waiting step, the column will become clickable. -#. Select it to open the **Waiting step details** page. - -The **Waiting step details** page displays some information related to the peer step -configuration and a table listing users in the waiting step with the -following attributes: - -* Usernames -* Number of peers assessed -* Number of peer reviews received -* Time spent on the waiting step so far -* Status from staff assessment step, if available in the problem -* Final grade status (waiting or overwritten). - -The **Waiting step details** page also allows managing student grades through the -**Manage individual learners** button near the bottom of the page, which works in -the same manner as :ref:`Access Information for a Specific Learner`. - - -.. seealso:: - - - :ref:`Open Response Assessments` (concept) - - :ref:`Accessing ORA Assignment Information` (reference) - - :ref:`View Metrics for All ORA Assignments` (how-to) - - :ref:`PA View Metrics for Individual Steps` (how-to) - - :ref:`Generate ORA Report` (how-to) - - :ref:`Generate a Report for ORA File Submissions and Attachments` (how-to) - - :ref:`PA Create an ORA Assignment` (how to) - - :ref:`Managing ORA Assignments` (how to) - - :ref:`ORA Staff Grading` (reference) - - - -**Maintenance chart** - -+--------------+-------------------------------+----------------+--------------------------------+ -| Review Date | Working Group Reviewer | Release |Test situation | -+--------------+-------------------------------+----------------+--------------------------------+ -| | | | | -+--------------+-------------------------------+----------------+--------------------------------+ diff --git a/source/educators/how-tos/course_development/exercise_tools/manage_numerical_input_problem.rst b/source/educators/how-tos/course_development/exercise_tools/manage_numerical_input_problem.rst new file mode 100644 index 000000000..238b6da53 --- /dev/null +++ b/source/educators/how-tos/course_development/exercise_tools/manage_numerical_input_problem.rst @@ -0,0 +1,375 @@ +.. _Manage Numerical Input Problem: + +################################ +Manage a Numerical Input Problem +################################ + +.. tags:: educator, how-to + +.. contents:: + :local: + :depth: 2 + +*********************************** +Add a Numerical Input Problem +*********************************** + +.. youtube:: fkoF8ZDPMoQ + +You add numerical input problems in Studio by selecting the **Problem** +component. In the problem editor, select the **Numerical Input** option. Fill in +the fields on this screen to create your problem. + +.. image:: /_images/educator_how_tos/problem_editor_numerical_input.png + :alt: An example numerical input problem in the problem editor with number + indicators labeling the various features. + :width: 800 + +Creating a numerical input problem is as simple as: + +#. Editing the **Display Name**. Click the pen symbol to edit. +#. Filling in the **Question** field. +#. Filling in the **Explanation** field. When this is shown to learners is + based on the selection in the **Show answer** panel on the right. +#. Filling in the **Answer** fields. For numerical input problems, only correct + answers can be added here. Additional answers can be added by clicking the + **Add answer** button. Answers can be deleted by clicking the trash can icon. + Feedback can be provided for each answer. More information on feedback can be + found in the following section. +#. Selecting and filling in any desired settings on the right. + +.. note:: Only correct answers can be added to a numerical input problem. + +If you have any questions on the specifics of using the simple editor, please check +out :ref:`Simple Editor` and :ref:`Guide to Problem Settings`. + +***************************** +Add a Tolerance or a Range +***************************** + +To give learners the option to receive full credit for a close approximation of +the correct answer, and to support a wide range of possible correct numerical +answers, you can specify a tolerance for the correct answer or a range of values +to mark as correct for the numerical input problem type. + +.. contents:: + :local: + :depth: 1 + +.. note:: You can either have a **tolerance** or an **answer range** for a + numerical input problem. You cannot add both. + +================== +Add a Tolerance +================== + +You can specify a margin of error or tolerance for learner responses. You +can specify a percentage or number. The tolerance settings panel can be +found to the right of the editor. + +.. image:: /_images/educator_how_tos/problem_editor_tolerance_box.png + :alt: An example tolerance setting set to 5%. + :width: 200 + +========================== +Specify an Answer Range +========================== + +You can specify an answer range so that any learner response within that range +is marked correct. + +Add an answer range by selecting the **Add answer range** button from the +**Add answer** dropdown. This option can only be selected if you only have one +answer. This will replace your answer field with an answer range field. + +.. image:: /_images/educator_how_tos/problem_editor_answer_range_box.png + :alt: An example answer range set from 1 to 10. This includes 1 but not 10. + :width: 200 + +To format an answer range, you provide the starting and +ending values and then separate them with a comma character (``,``). You then +surround the range with bracket (``[ ]``) or parentheses characters (``( )``), +or a combination of one bracket and one parenthesis. + +* Use a bracket to include the number next to it in the range, as in a less + than or equal to, or greater than or equal to, inequality. + +* Use a parenthesis to exclude the number from the range, as in a less than or + greater than inequality. + +For example, to identify the correct answers as 5, 6, or 7, but not 8, specify +``[5,8)``. To identify the correct answers as 6, 7, and 8, but not 5, specify +``(5,8]``. + + +************************************************** +Add Feedback and Hints via the Simple Editor +************************************************** + +=================== +Add Feedback +=================== + +For an overview of feedback in problems, see :ref:`Adding Feedback and Hints to +a Problem`. In numerical input problems, you can provide feedback for correct +responses. If you define multiple correct responses, you can define feedback +for each response. In numerical input problems, use feedback to reinforce the +process used to arrive at the correct answer. + +You can add answer-specific feedback for each answer in a numerical input problem. +You can access the feedback panel shown below by clicking the button to the right +of the answer text. + +.. image:: /_images/educator_how_tos/problem_editor_feedback_box_2.png + :alt: An example of an expanded feedback section for dropdown problems showing + the 'is selected' feedback field. + :width: 600 + +Simply enter your feedback message in this text field. It will display when the +learner submits this answer. + +.. note:: You cannot add feedback for an incorrect answer in numerical input + problems. Add hints to guide the learners in the correct direction instead. + +.. _Use Hints in a Numerical Input Problem: + +=================== +Add Hints +=================== + +You can add hints to a numerical input problem using the simple editor or the +advanced editor. For an overview of hints in problems, see +:ref:`Adding Feedback and Hints to a Problem`. + +.. _Editing Numerical Input Problems using the Advanced Editor: + +****************************************************************** +Edit Numerical Input 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 numerical input problem +with OLX. For more information, see :ref:`Numerical Input 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 + + + + + + +
+

Explanation

+

The decimal numeral system is base ten.

+
+ + + + +.. 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. + +.. _Use Feedback in a Numerical Input Problems: + +================================================== +Add Feedback via the Advanced Editor +================================================== + +In the advanced editor, you configure feedback with the following syntax. + +.. code-block:: xml + + + + + + Feedback for the correct answer + + + +For example, the following problem has feedback for each answer. + +.. code-block:: xml + + + + + + The mean for this set of numbers is 20 / 5 which equals 4. + + + +If you define multiple correct responses, you can define feedback for each response. + +================================================== +Add Hints via the Advanced Editor +================================================== + +See :ref:`Add Hints via the Advanced Editor` for more information about adding hints to problems. + +.. _Multiple Responses in Numerical Input Problems: + +======================================================= +Add Multiple Correct Responses via the Advanced Editor +======================================================= + +You can specify more than one specific, correct response for numerical input problems. +To do this, use the advanced editor. + +If you specify multiple correct responses, you cannot also specify a tolerance, a range, +or a text string as correct answers. For example, when you define multiple correct +responses, you can specify a numeric value for each correct answer but not a tolerance, +range, or text string. + +To specify an additional correct response in the advanced editor, within the +```` element add the ```` element with an +``answer=""`` attribute value. + +.. code-block:: xml + + + + + Use scientific notation to answer. + + + + + +================================================== +Add a Tolerance via the Advanced Editor +================================================== + +You can specify a margin of error or tolerance for learner responses. You can +specify a percentage, number, or range. + +To add a tolerance in the advanced editor you include a ```` +element with a ``type="tolerance"`` attribute and a ``default`` attribute set +to either a number or a percentage value. + +The following example shows a problem with a decimal tolerance. + +.. code-block:: xml + + + + + + + + + +The following example shows a problem with a percentage tolerance. + +.. code-block:: xml + + + + + + + + + +================================================== +Specify an Answer Range via the Advanced Editor +================================================== + +You can specify an answer range so that any learner response within that +range is marked correct. To format an answer range, you provide the starting +and ending values and then separate them with a comma character (``,```). You +then surround the range with bracket (``[ ]``) or parentheses characters +(``( )``), or a combination of one bracket and one parenthesis. + +* Use a bracket to include the number next to it in the range, as in a less + than or equal to, or greater than or equal to, inequality. + +* Use a parenthesis to exclude the number from the range, as in a less than or + greater than inequality. + +For example, to identify the correct answers as 5, 6, or 7, but not 8, specify +``[5,8)``. To identify the correct answers as 6, 7, and 8, but not 5, specify +``(5,8]``. + +To specify a range in the advanced editor, you enter the complete, formatted +range in the ```` element as the value for the ``answer`` +attribute: ```` or +````. + + +.. _Add Text After the Numeric Response Field: + +******************************************** +Add Text after the Numeric Response Field +******************************************** + +You might want to include a word, phrase, or sentence after the response field +in a numerical input problem to help guide your students or resolve ambiguity. + +.. image:: /_images/educator_how_tos/NI_trailing_text.png + :width: 500 + :alt: Three numerical input problems with text after the response field: + "km", a percent sign, and a symbol for meters per second squared. + +To do this, you use the advanced editor. + +In the problem, locate the ``formulaequationinput`` element. This element +creates the response field for the problem and is a child of the +``numericalresponse`` element. + +To add text after the response field, add the ``trailing_text`` attribute +together with the symbol or text that you want to use inside the +``formulaequationinput`` element. An example problem follows with three +questions that use this attribute. + +.. note:: You can use MathJax inside the ``trailing_text`` attribute, as the + third question in this example shows. You cannot use HTML inside this + attribute. + +.. code-block:: xml + + + + + + + + + + + + + + + + + + +.. seealso:: + + + :ref:`About Numerical Input` (reference) + + :ref:`Numerical Input Problem XML` (reference) + + :ref:`Award Partial Credit in a Numerical Input Problem` (how to) + +**Maintenance chart** + ++--------------+-------------------------------+----------------+--------------------------------+ +| Review Date | Working Group Reviewer | Release |Test situation | ++--------------+-------------------------------+----------------+--------------------------------+ +| | | | | ++--------------+-------------------------------+----------------+--------------------------------+ diff --git a/source/educators/how-tos/course_development/exercise_tools/create_staffgraded.rst b/source/educators/how-tos/course_development/exercise_tools/manage_staffgraded.rst similarity index 56% rename from source/educators/how-tos/course_development/exercise_tools/create_staffgraded.rst rename to source/educators/how-tos/course_development/exercise_tools/manage_staffgraded.rst index f3d659a74..e71e67e24 100644 --- a/source/educators/how-tos/course_development/exercise_tools/create_staffgraded.rst +++ b/source/educators/how-tos/course_development/exercise_tools/manage_staffgraded.rst @@ -1,8 +1,8 @@ .. _StaffGraded: -####################### -Staff Graded Assignment -####################### +################################ +Manage Staff Graded Assignment +################################ .. tags:: educator, how-to @@ -50,10 +50,21 @@ Staff Graded Assignment Settings * - ``Problem Weight`` (optional) - Enter the number of points possible for this component. The default value is 1.0. -.. seealso:: - +********************************************** +Grading Learners in a Staff Graded Assignment +********************************************** + +While your course is running, after learners have had a chance to complete the off-platform assignment you’re grading, you can assign learner grades from the LMS Instructor view of the component as follows: + +#. **Export scores.** Download a grading CSV and use this as a template to assign scores for this problem. You can use track/cohort filters to limit to grading only a subset of learners. + +#. **(On your own machine) Fill out grades.** Open the CSV in a spreadsheet editor and assign scores to learners via “New Points” field. Leave scores that you don’t want to change blank. + +#. **Import scores** Uploading the filled out CSV. Learners will immediately see their grades after import completes. Supports smaller courses - i.e. file sizes up to 4MB. *Note: [Provisionally supported: usage in large courses] To use in larger courses, break up your grade file CSV by rows, and import in separate files -- or use the track & cohort filters to limit to a subset of rows. In this case, keep the header row for each file. This manual approach for larger courses is error prone, so we are making it available as a use-at-your-own-risk feature for advanced users, but don’t explicitly support it.* + +#. **Review result** File is uploaded, validated, scores are overwritten for non-blank rows. You’ll get a readout at the bottom of the screen. + - :ref:`StaffGraded Grading` (concept) diff --git a/source/educators/how-tos/course_development/exercise_tools/manage_word_cloud.rst b/source/educators/how-tos/course_development/exercise_tools/manage_word_cloud.rst index cf7e50f12..cd0b1fd22 100644 --- a/source/educators/how-tos/course_development/exercise_tools/manage_word_cloud.rst +++ b/source/educators/how-tos/course_development/exercise_tools/manage_word_cloud.rst @@ -82,7 +82,7 @@ To create a word cloud, follow these steps. .. seealso:: - :ref:`Create Exercises` (concepts) + :ref:`About Problems Exercises and Tools` (concepts) **Maintenance chart** diff --git a/source/educators/how-tos/course_development/exercise_tools/randomized_custom_python_problem.rst b/source/educators/how-tos/course_development/exercise_tools/randomized_custom_python_problem.rst deleted file mode 100644 index 2f34260ee..000000000 --- a/source/educators/how-tos/course_development/exercise_tools/randomized_custom_python_problem.rst +++ /dev/null @@ -1,80 +0,0 @@ -.. _Create a Randomized Custom Python Evaluated Input Problem: - -Create a Randomized Custom Python-Evaluated Input Problem -######################################################### - -.. tags:: educator, how-to - -You can create a custom Python-evaluated input problem that randomizes -variables in the Python code. - -#. In the unit where you want to create the problem, select **Problem** under - **Add New Component**. - -#. In the problem editor, select **Advanced problem types**. Then select **Custom Python-Evaluated Input**. - -#. In the component editor, modify the example as needed. - -#. Select the randomization option that applies better to your exercise. The option selected will define when to randomize the variables specified in the associated Python script. The options you can select are Never, Always, Per Student, and On Reset. - -.. note:: - In the problem settings, you must set the **Randomization** value to - something other than **Never** to have Python variables randomized. See - :ref:`Randomization` for more information. - -#. Select **Save**. - -Example: -======== - -The following example demonstrates using randomization with a Python-evaluated -input problem. - -.. note:: - This example uses the method ``random.randint`` to generate random numbers. - You can use any standard Python library for this purpose. - -.. code-block:: xml - - -

Some problems in the course will utilize randomized parameters. - For such problems, after you check your answer you will have the option - of resetting the question, which reconstructs the problem with a new - set of parameters.

- -

Let (x_1 = $x1) and (x_2 = $x2). What is the value of (x_1+x_2)?

- - - - - -

Explanation:

- - - -.. seealso:: - - - :ref:`Write Your Own Grader` (reference) - - :ref:`Create a Custom Python Evaluated Input Problem in Studio` (how to) - - :ref:`Create a Custom Python Evaluated Input Problem in Script Tag Format` (how to) - - :ref:`Script Tag Format` (concept) - - :ref:`Award Partial Credit` (concept) - - -**Maintenance chart** - -+--------------+-------------------------------+----------------+--------------------------------+ -| Review Date | Working Group Reviewer | Release |Test situation | -+--------------+-------------------------------+----------------+--------------------------------+ -| | | | | -+--------------+-------------------------------+----------------+--------------------------------+ diff --git a/source/educators/how-tos/course_development/exercise_tools/setting_up_lti_1_1_component.rst b/source/educators/how-tos/course_development/exercise_tools/set_up_lti_1_1_component.rst similarity index 94% rename from source/educators/how-tos/course_development/exercise_tools/setting_up_lti_1_1_component.rst rename to source/educators/how-tos/course_development/exercise_tools/set_up_lti_1_1_component.rst index 2c745fd32..3c68952e7 100644 --- a/source/educators/how-tos/course_development/exercise_tools/setting_up_lti_1_1_component.rst +++ b/source/educators/how-tos/course_development/exercise_tools/set_up_lti_1_1_component.rst @@ -1,10 +1,12 @@ -.. _Setting up a LTI 1.1 component: +.. _Set up an LTI 1_1 component: Set Up an LTI 1.1 Component ########################### .. tags:: educator, how-to +.. youtube:: dJuEGsZM4gw + Some LTI 1.1 tools require users to provide authentication credentials. If the LTI tool you are including in your course requires authentication, you must add an LTI passport for that tool to your course configuration. @@ -81,8 +83,7 @@ follow these steps. ``"test_lti_id:b289378-f88d-2929-ctools.umich.edu:secret"`` - For more information about creating your key, see :ref:`Setting up a LTI 1.1 - component`. + For more information about creating your key, see :ref:`Set up an LTI 1_1 component`. #. If you use more than one LTI provider in your course, separate each LTI passport string with commas. Make sure to surround each entry with quotation @@ -110,7 +111,7 @@ To add an LTI 1.1 component to a course unit, follow these steps. #. If the LTI tool requires authentication, register the key and shared secret for the LTI tool in the configuration for your course. For more information about registering authentication credentials, see - :ref:`Setting up a LTI 1.1 component`. + :ref:`Set up an LTI 1_1 component`. #. Edit the unit in which you want to add the remote LTI tool and select **Advanced** from the **Add New Component** section. Select **LTI @@ -133,14 +134,13 @@ in the LMS. For more information, see :ref:`Testing Your Course Content`. .. seealso:: + :ref:`About the LTI Component` (concept) - :ref:`LTI Component` (reference) - - :ref:`LTI Component settings` (reference) + :ref:`LTI Component Settings` (reference) :ref:`Enable_LTI_Components` (how-to) - :ref:`Setting up a LTI 1.3 component` (how-to) + :ref:`Set up an LTI 1_3 component` (how-to) :ref:`Enabling and using LTI Advantage features` (how-to) diff --git a/source/educators/how-tos/course_development/exercise_tools/setting_up_lti_1_3_component.rst b/source/educators/how-tos/course_development/exercise_tools/set_up_lti_1_3_component.rst similarity index 95% rename from source/educators/how-tos/course_development/exercise_tools/setting_up_lti_1_3_component.rst rename to source/educators/how-tos/course_development/exercise_tools/set_up_lti_1_3_component.rst index cdc4f3ce4..12ca51cbb 100644 --- a/source/educators/how-tos/course_development/exercise_tools/setting_up_lti_1_3_component.rst +++ b/source/educators/how-tos/course_development/exercise_tools/set_up_lti_1_3_component.rst @@ -1,4 +1,4 @@ -.. _Setting up a LTI 1.3 component: +.. _Set up an LTI 1_3 component: Set Up an LTI 1.3 Component ########################### @@ -67,14 +67,13 @@ To add an LTI 1.3 component to a course unit, follow these steps. .. seealso:: + :ref:`About the LTI Component` (concept) - :ref:`LTI Component` (reference) - - :ref:`LTI Component settings` (reference) + :ref:`LTI Component Settings` (reference) :ref:`Enable_LTI_Components` (how-to) - :ref:`Setting up a LTI 1.1 component` (how-to) + :ref:`Set up an LTI 1_1 component` (how-to) :ref:`Enabling and using LTI Advantage features` (how-to) diff --git a/source/educators/how-tos/course_development/exercise_tools/use_dropdown_feedback.rst b/source/educators/how-tos/course_development/exercise_tools/use_dropdown_feedback.rst index 936aebc4e..7ae4ca921 100644 --- a/source/educators/how-tos/course_development/exercise_tools/use_dropdown_feedback.rst +++ b/source/educators/how-tos/course_development/exercise_tools/use_dropdown_feedback.rst @@ -119,7 +119,7 @@ a custom label. :ref:`Dropdown Problem XML` (reference) - :ref:`Adding Dropdown` (how-to) + :ref:`Add Dropdown` (how-to) :ref:`Use Hints in a Dropdown Problem` (how-to) diff --git a/source/educators/how-tos/course_development/exercise_tools/use_dropdown_hints.rst b/source/educators/how-tos/course_development/exercise_tools/use_dropdown_hints.rst index 051ab5165..5eb76c40b 100644 --- a/source/educators/how-tos/course_development/exercise_tools/use_dropdown_hints.rst +++ b/source/educators/how-tos/course_development/exercise_tools/use_dropdown_hints.rst @@ -26,7 +26,7 @@ you've added, click the trash can icon next to its respective hint field. :ref:`Adding Feedback and Hints to a Problem` (reference) - :ref:`Adding Dropdown` (how-to) + :ref:`Add Dropdown` (how-to) **Maintenance chart** diff --git a/source/educators/how-tos/course_development/exercise_tools/using_lti_advantage_features.rst b/source/educators/how-tos/course_development/exercise_tools/using_lti_advantage_features.rst index c4a5925f5..f90407476 100644 --- a/source/educators/how-tos/course_development/exercise_tools/using_lti_advantage_features.rst +++ b/source/educators/how-tos/course_development/exercise_tools/using_lti_advantage_features.rst @@ -118,16 +118,15 @@ To set up LTI-NRPS services on a component, follow these steps. .. seealso:: + :ref:`About the LTI Component` (concept) - :ref:`LTI Component` (reference) - - :ref:`LTI Component settings` (reference) + :ref:`LTI Component Settings` (reference) :ref:`Enable_LTI_Components` (how-to) - :ref:`Setting up a LTI 1.1 component` (how-to) + :ref:`Set up an LTI 1_1 component` (how-to) - :ref:`Setting up a LTI 1.3 component` (how-to) + :ref:`Set up an LTI 1_3 component` (how-to) **Maintenance chart** diff --git a/source/educators/how-tos/course_development/exercise_tools/view_metrics_ORA_assignments.rst b/source/educators/how-tos/course_development/exercise_tools/view_metrics_ORA_assignments.rst deleted file mode 100644 index f87bc0403..000000000 --- a/source/educators/how-tos/course_development/exercise_tools/view_metrics_ORA_assignments.rst +++ /dev/null @@ -1,58 +0,0 @@ -.. _View Metrics for All ORA Assignments: - -View Statistics for All ORA Assignments in a Course -################################################### - -.. tags:: educator, how-to - -To view metrics about all of the ORA assignments in a course, follow these steps. - -#. View the live version of the course. -#. Select **Instructor** to open the instructor dashboard. -#. On the instructor dashboard, select **Open Responses**. - -The **Open Responses** tab of the instructor dashboard displays the following -information. - -* The number of course units that include an ORA assignment. -* The number of ORA assignments in the course. -* The total number of submitted responses. -* The number of learners who are in each of the training, peer, - self, and staff workflow states. -* The number of learners who have received a final grade. - -The **Open Responses** tab also displays the same information for each separate -ORA assignment in the course, grouped by the course units that include ORA -assignments. - - -.. seealso:: - - - :ref:`Open Response Assessments` (concept) - - :ref:`Accessing ORA Assignment Information` (reference) - - :ref:`List and manage students waiting in peer step` (how-to) - - :ref:`PA View Metrics for Individual Steps` (how-to) - - :ref:`Generate ORA Report` (how-to) - - :ref:`Generate a Report for ORA File Submissions and Attachments` (how-to) - - :ref:`PA Create an ORA Assignment` (how to) - - :ref:`Managing ORA Assignments` (how to) - - :ref:`ORA Staff Grading` (reference) - - - -**Maintenance chart** - -+--------------+-------------------------------+----------------+--------------------------------+ -| Review Date | Working Group Reviewer | Release |Test situation | -+--------------+-------------------------------+----------------+--------------------------------+ -| | | | | -+--------------+-------------------------------+----------------+--------------------------------+ diff --git a/source/educators/how-tos/course_development/exercise_tools/view_statistics_single_ORA_assignment.rst b/source/educators/how-tos/course_development/exercise_tools/view_statistics_single_ORA_assignment.rst deleted file mode 100644 index 0fa64c312..000000000 --- a/source/educators/how-tos/course_development/exercise_tools/view_statistics_single_ORA_assignment.rst +++ /dev/null @@ -1,78 +0,0 @@ -.. _PA View Metrics for Individual Steps: - -View Statistics for a Single ORA Assignment -############################################ - -.. tags:: educator, how-to - -To view metrics about learners in a single ORA assignment, including the number -who are active in each step, follow these steps. - -#. Open the ORA assignment in the course. - -#. Scroll to the bottom of the assignment and select **View Assignment - Statistics**. - - You see statistics for the assignment, including the total number of - responses and the location ID for the assignment. - - In the **Learner Progress** section, for each assessment step in the - assignment, you can see the number of learners who are currently working - through (but who have not completed) that step. Only assessment types that - exist in the assignment are included. - - .. note:: If a Staff Assessment step exists in the assignment, this step - will always show 0 active learners, because no learner actions are - required for that step. - - In addition to learners who are active in the assessment steps of the - assignment, you can see the number of learners who are in the following - states in the assignment. - - * **Waiting**: Learners who have finished the requirements for a step - and are waiting for their responses to be assessed by peers or staff. - - * **Done**: Learners who have completed all of their required steps, and - have received the required number of reviews. - - * **Cancelled**: Learners who have had their responses cancelled. - -In the **Dates** section below **Learner Progress**, the release and due dates -for each step in the assignment are shown. - -.. image:: /_images/educator_references/ORA_AssignmentStats.png - :width: 500 - :alt: The View Assignment Statistics page shows the number of active learners in each step, the number of learners in the Waiting, Done, and Cancelled states, and the start and due dates for each step. - - - -.. seealso:: - - - :ref:`Open Response Assessments` (concept) - - :ref:`Accessing ORA Assignment Information` (reference) - - :ref:`List and manage students waiting in peer step` (how-to) - - :ref:`View Metrics for All ORA Assignments` (how-to) - - :ref:`Generate ORA Report` (how-to) - - :ref:`Generate a Report for ORA File Submissions and Attachments` (how-to) - - :ref:`PA Create an ORA Assignment` (how to) - - :ref:`Managing ORA Assignments` (how to) - - :ref:`ORA Staff Grading` (reference) - - - -**Maintenance chart** - -+--------------+-------------------------------+----------------+--------------------------------+ -| Review Date | Working Group Reviewer | Release |Test situation | -+--------------+-------------------------------+----------------+--------------------------------+ -| | | | | -+--------------+-------------------------------+----------------+--------------------------------+ diff --git a/source/educators/how-tos/course_development/manage_components.rst b/source/educators/how-tos/course_development/manage_components.rst index a17155d24..54a5f8ba3 100644 --- a/source/educators/how-tos/course_development/manage_components.rst +++ b/source/educators/how-tos/course_development/manage_components.rst @@ -99,8 +99,6 @@ box, but all of them have a **Display Name** field. Reorganize a Component ********************************** -.. tags:: educator, how-to - You can drag and drop components to a new position within their current unit, or you can move components from one unit to another unit. diff --git a/source/educators/how-tos/course_development/manage_subsections.rst b/source/educators/how-tos/course_development/manage_subsections.rst index f57d8c0d4..45687dd64 100644 --- a/source/educators/how-tos/course_development/manage_subsections.rst +++ b/source/educators/how-tos/course_development/manage_subsections.rst @@ -88,8 +88,6 @@ For more information, see :ref:`Release Dates`. Hide a Subsection from Learners ******************************************** -.. tags:: educator, how-to - You can hide a subsection from learners in the following ways. * :ref:`Entirely hide the subsection ` so that it diff --git a/source/educators/how-tos/course_development/manage_videos.rst b/source/educators/how-tos/course_development/manage_videos.rst index 298c65518..49626f3e3 100644 --- a/source/educators/how-tos/course_development/manage_videos.rst +++ b/source/educators/how-tos/course_development/manage_videos.rst @@ -57,8 +57,6 @@ This name appears as a heading above the video in the LMS, and it identifies the Specify Additional Video Options ********************************** -.. tags:: educator, how-to - When you create a video component, you can customize additonal settings such as specifying download options for the video and transcript, video license options, and a start and stop time for the video. diff --git a/source/educators/how-tos/course_development/set_subsection_problem_date.rst b/source/educators/how-tos/course_development/set_subsection_problem_date.rst index 7df7de1f4..8068b8590 100644 --- a/source/educators/how-tos/course_development/set_subsection_problem_date.rst +++ b/source/educators/how-tos/course_development/set_subsection_problem_date.rst @@ -71,7 +71,7 @@ common problem types. * :ref:`Dropdown` * :ref:`Multi select` -* :ref:`Numerical Input` +* :ref:`About Numerical Input` * :ref:`Single Select` * :ref:`Text Input` @@ -80,9 +80,9 @@ advanced problem types. * :ref:`Annotation` * :ref:`Circuit Schematic Builder` -* :ref:`Custom JavaScript Display and Grading` -* :ref:`Custom Python-Evaluated Input` -* :ref:`Image Mapped Input` +* :ref:`Custom JavaScript Display and Grading` +* :ref:`Custom Python-Evaluated Input` +* :ref:`Image Mapped Input` * :ref:`Math Expression Input` * :ref:`Problem Written in LaTeX` * :ref:`Problem with Adaptive Hint` @@ -118,8 +118,37 @@ To change the results visibility for your subsection, follow these steps. .. seealso:: + :ref:`About Problems Exercises and Tools` (concept) - :ref:`Create an Open Response Assessment Assignment ` (how-to) + :ref:`Core Problem Types` (reference) + + :ref:`Working with Problem Components` (reference) + + :ref:`Guide to Problem Settings` (reference) + + :ref:`Gradebook Assignment Types` (reference) + + :ref:`Feedback Best Practices` (concept) + + :ref:`Adding Feedback and Hints to a Problem` (reference) + + :ref:`Configure Hint` (how-to) + + :ref:`Partial Credit` (reference) + + :ref:`Set the Assignment Type and Due Date for a Subsection` (how-to) + + :ref:`Adding Tooltips` (reference) + + :ref:`Learner View of Problems` (reference) + + :ref:`Advanced Editor` (reference) + + :ref:`Add Hints via the Advanced Editor` (how-to) + + :ref:`Modifying a Released Problem` (reference) + +:ref:`Add Unsupported Exercises Problems` (how-to) diff --git a/source/educators/how-tos/data/view_answer_data.rst b/source/educators/how-tos/data/view_answer_data.rst index b28ae534f..bf3ea61bc 100644 --- a/source/educators/how-tos/data/view_answer_data.rst +++ b/source/educators/how-tos/data/view_answer_data.rst @@ -365,8 +365,7 @@ learners. For example, for a problem that has a total of five possible answers the file includes up to five rows, one for each answer selected by at least one learner. For problems with **Randomization** enabled in Studio (sometimes called rerandomization), there is one row for each problem-variant-answer -combination selected by your learners. For more information, see :ref:`Problem -Settings`. +combination selected by your learners. For more information, see :ref:`Guide to Problem Settings`. .. note:: Certain types of problems can be set up to :ref:`award partial credit `. When a learner receives either the full or a partial score for a problem, this report includes that answer as correct. diff --git a/source/educators/how-tos/grading/set_grace_period.rst b/source/educators/how-tos/grading/set_grace_period.rst index c1ceef28f..0f7f9e409 100644 --- a/source/educators/how-tos/grading/set_grace_period.rst +++ b/source/educators/how-tos/grading/set_grace_period.rst @@ -31,7 +31,7 @@ the **Grace Period on Deadline** field. Enter the value in ``HH:MM`` format. .. seealso:: - :ref:`Graded Subsections` (concept) + :ref:`About Graded Subsections` (concept) :ref:`Gradebook Assignment Types` (reference) diff --git a/source/educators/how-tos/grading/set_grade_range.rst b/source/educators/how-tos/grading/set_grade_range.rst index 3caf220f4..955bcf238 100644 --- a/source/educators/how-tos/grading/set_grade_range.rst +++ b/source/educators/how-tos/grading/set_grade_range.rst @@ -69,7 +69,7 @@ For more information, see :ref:`Manage Course Certificates`. .. seealso:: - :ref:`Graded Subsections` (concept) + :ref:`About Graded Subsections` (concept) :ref:`Gradebook Assignment Types` (reference) diff --git a/source/educators/how-tos/proctored_exams/allow_opt_out_proctored_exam.rst b/source/educators/how-tos/proctored_exams/allow_opt_out_proctored_exam.rst index 36d094e12..7d8a199d8 100644 --- a/source/educators/how-tos/proctored_exams/allow_opt_out_proctored_exam.rst +++ b/source/educators/how-tos/proctored_exams/allow_opt_out_proctored_exam.rst @@ -31,7 +31,7 @@ follow these steps. .. seealso:: - :ref:`ProctoredExams_Overview` (concept) + :ref:`About Proctored Exams` (concept) :ref:`Enable Proctored Exams` (how-to) diff --git a/source/educators/how-tos/proctored_exams/create_proctored_exam_pt.rst b/source/educators/how-tos/proctored_exams/create_proctored_exam_pt.rst index f834b47b3..38e4baf69 100644 --- a/source/educators/how-tos/proctored_exams/create_proctored_exam_pt.rst +++ b/source/educators/how-tos/proctored_exams/create_proctored_exam_pt.rst @@ -132,7 +132,7 @@ steps. .. seealso:: - :ref:`ProctoredExams_Overview` (concept) + :ref:`About Proctored Exams` (concept) :ref:`Enable Proctored Exams` (how-to) diff --git a/source/educators/how-tos/proctored_exams/create_proctored_exam_rpnow.rst b/source/educators/how-tos/proctored_exams/create_proctored_exam_rpnow.rst index c13362ad8..5e9e89cfb 100644 --- a/source/educators/how-tos/proctored_exams/create_proctored_exam_rpnow.rst +++ b/source/educators/how-tos/proctored_exams/create_proctored_exam_rpnow.rst @@ -100,7 +100,7 @@ To specify custom proctored exam rules, follow these steps. .. seealso:: - :ref:`ProctoredExams_Overview` (concept) + :ref:`About Proctored Exams` (concept) :ref:`Enable Proctored Exams` (how-to) diff --git a/source/educators/how-tos/proctored_exams/enable_proctored_exams.rst b/source/educators/how-tos/proctored_exams/enable_proctored_exams.rst index 642e713e8..380727dfa 100644 --- a/source/educators/how-tos/proctored_exams/enable_proctored_exams.rst +++ b/source/educators/how-tos/proctored_exams/enable_proctored_exams.rst @@ -49,7 +49,7 @@ proctored/onboarding exam. .. seealso:: - :ref:`ProctoredExams_Overview` (concept) + :ref:`About Proctored Exams` (concept) :ref:`Preparing Learners for Proctored Exams` (concept) diff --git a/source/educators/how-tos/proctored_exams/manage_proctored_exams.rst b/source/educators/how-tos/proctored_exams/manage_proctored_exams.rst index f3c957b90..a705ccda3 100644 --- a/source/educators/how-tos/proctored_exams/manage_proctored_exams.rst +++ b/source/educators/how-tos/proctored_exams/manage_proctored_exams.rst @@ -131,7 +131,7 @@ To view learners' onboarding status for your course, follow these steps. .. seealso:: - :ref:`ProctoredExams_Overview` (concept) + :ref:`About Proctored Exams` (concept) :ref:`Enable Proctored Exams` (how-to) diff --git a/source/educators/how-tos/proctored_exams/review_pt_results.rst b/source/educators/how-tos/proctored_exams/review_pt_results.rst index 6fa32dd8c..cd69f1962 100644 --- a/source/educators/how-tos/proctored_exams/review_pt_results.rst +++ b/source/educators/how-tos/proctored_exams/review_pt_results.rst @@ -135,7 +135,7 @@ On the page, the learner's status is visible as "Pending", "Satisfactory", or .. seealso:: - :ref:`ProctoredExams_Overview` (concept) + :ref:`About Proctored Exams` (concept) :ref:`Enable Proctored Exams` (how-to) diff --git a/source/educators/how-tos/proctored_exams/review_rpnow_results.rst b/source/educators/how-tos/proctored_exams/review_rpnow_results.rst index e25acf7b7..bc0c9e87d 100644 --- a/source/educators/how-tos/proctored_exams/review_rpnow_results.rst +++ b/source/educators/how-tos/proctored_exams/review_rpnow_results.rst @@ -110,7 +110,7 @@ On the page, the learner's status is visible as "Pending", "Satisfactory", or .. seealso:: - :ref:`ProctoredExams_Overview` (concept) + :ref:`About Proctored Exams` (concept) :ref:`Enable Proctored Exams` (how-to) diff --git a/source/educators/how-tos/rerun_course.rst b/source/educators/how-tos/rerun_course.rst index 4f08d8658..bc35dbef4 100644 --- a/source/educators/how-tos/rerun_course.rst +++ b/source/educators/how-tos/rerun_course.rst @@ -95,8 +95,6 @@ steps. Update the New Course after a Re-Run ************************************* -.. tags:: educator, how-to - When you create a course by re-running another course, you must carefully review the settings and content of the new course. To assure a quality experience for learners, be sure to test the course thoroughly before the @@ -129,7 +127,7 @@ course for release. created prior to April 2016 with the newer drag and drop problem component, which is accessible and mobile ready. For more information about enabling the new drag and drop problem type and adding these problems to your course, see - :ref:`drag_and_drop_problem`. + :ref:`About the Drag and Drop Problem`. The following additional changes can also improve the experience of learners who enroll in the new course run. diff --git a/source/educators/how-tos/reusable_content/add_multiple_choice.txt b/source/educators/how-tos/reusable_content/add_multiple_choice.txt index b591a1c70..a9cf4c7bf 100644 --- a/source/educators/how-tos/reusable_content/add_multiple_choice.txt +++ b/source/educators/how-tos/reusable_content/add_multiple_choice.txt @@ -47,6 +47,6 @@ :ref:`Editing Single Select Problems using the Advanced Editor` (how-to) - :ref:`Add a Dropdown Problem` (how-to) + :ref:`Add Dropdown` (how-to) diff --git a/source/educators/how-tos/set_up_course/edit_about_page.rst b/source/educators/how-tos/set_up_course/edit_about_page.rst index d7b4b5b55..15fca4c51 100644 --- a/source/educators/how-tos/set_up_course/edit_about_page.rst +++ b/source/educators/how-tos/set_up_course/edit_about_page.rst @@ -16,8 +16,6 @@ before they enroll in the course. For more information, see :ref:`Guide to Cours Describe Your Course ********************** -.. tags:: educator, how-to - .. youtube:: ruXRjT176Cs Learners see a description of your course on the course About page, under the diff --git a/source/educators/how-tos/using_lti.rst b/source/educators/how-tos/using_lti.rst deleted file mode 100644 index 1652d1078..000000000 --- a/source/educators/how-tos/using_lti.rst +++ /dev/null @@ -1,23 +0,0 @@ -Using LTI -######### - -.. tags:: educator, how-to - -It is possible to use LTI content in a course, too! See this video for details: - -.. youtube:: dJuEGsZM4gw - - -.. seealso:: - - - :ref:`juniper_educator` (reference) - - -**Maintenance chart** - -+--------------+-------------------------------+----------------+--------------------------------+ -| Review Date | Working Group Reviewer | Release |Test situation | -+--------------+-------------------------------+----------------+--------------------------------+ -| | | | | -+--------------+-------------------------------+----------------+--------------------------------+ diff --git a/source/educators/navigation/advanced_features.rst b/source/educators/navigation/advanced_features.rst index e66a34a02..de85660d6 100644 --- a/source/educators/navigation/advanced_features.rst +++ b/source/educators/navigation/advanced_features.rst @@ -145,5 +145,5 @@ Advanced Components ../how-tos/course_development/exercise_tools/add_recommenderXBlock.rst ../how-tos/course_development/exercise_tools/add_annotation.rst ../how-tos/course_development/exercise_tools/add_calculator.rst - ../how-tos/course_development/exercise_tools/enable_completion.rst + diff --git a/source/educators/navigation/components_activities.rst b/source/educators/navigation/components_activities.rst index f8a123393..a9e56ed0b 100644 --- a/source/educators/navigation/components_activities.rst +++ b/source/educators/navigation/components_activities.rst @@ -11,31 +11,31 @@ The Open edX® Problem Component ******************************************************* .. toctree:: - :maxdepth: 2 + :maxdepth: 1 :glob: - ../concepts/exercise_tools/create_exercises.rst - ../references/course_development/exercise_tools/create_exercises_and_tools.rst - ../references/course_development/create_problem.rst + ../concepts/exercise_tools/about_problems_exercises_tools.rst + ../references/course_development/exercise_tools/guide_problem_types.rst + ../references/course_development/working_with_problem_components.rst ../references/course_development/problem_settings.rst ../references/grading/gradebook_assignment_types.rst ../concepts/instructional_design/feedback_best_practices.rst - ../references/course_development/exercise_tools/Section_adding_hints.rst - ../how-tos/course_development/Subsection_configure_hints.rst - ../references/course_development/Section_partial_credit.rst + ../references/course_development/exercise_tools/adding_hints + ../how-tos/course_development/configure_hints.rst + ../references/course_development/awarding_partial_credit.rst ../how-tos/course_development/set_subsection_problem_date.rst - ../references/course_development/Section_adding_tooltip.rst + ../references/course_development/adding_tooltips.rst ../references/course_development/advanced_problem_editor.rst ../how-tos/course_development/exercise_tools/add_hints_advanced_editor.rst ../references/course_development/modifying_released_problem.rst - ../references/course_development/Section_learner_problem_view.rst + ../references/course_development/learner_problem_view.rst ../how-tos/course_development/exercise_tools/add_unsupported_problem_types.rst Chemical Equation Problem ******************************************************* .. toctree:: - :maxdepth: 2 + :maxdepth: 1 :glob: ../how-tos/course_development/exercise_tools/add_chemical_equation.rst @@ -45,7 +45,7 @@ Circuit Schematic Builder Problem ******************************************************* .. toctree:: - :maxdepth: 2 + :maxdepth: 1 :glob: ../how-tos/course_development/exercise_tools/add_circuit_schematic_builder.rst @@ -54,28 +54,19 @@ Completion Tool ******************************************************* .. toctree:: - :maxdepth: 2 + :maxdepth: 1 :glob: ../references/course_development/exercise_tools/completion.rst + ../how-tos/course_development/exercise_tools/enable_completion.rst ../how-tos/course_development/exercise_tools/enable_olx_completion.rst -Configure Grades -******************************************************* - -.. toctree:: - :maxdepth: 2 - :glob: - - ../concepts/grading/graded_subsections.rst - ../how-tos/grading/set_grace_period.rst - ../how-tos/grading/set_grade_range.rst Custom Javascript Display and Grading Problem ******************************************************* .. toctree:: - :maxdepth: 2 + :maxdepth: 1 :glob: ../references/course_development/exercise_tools/custom_javascript.rst @@ -85,29 +76,23 @@ Custom Python-evaluated Input Problem (Write-Your-Own-Grader) *************************************************************** .. toctree:: - :maxdepth: 2 + :maxdepth: 1 :glob: - ../references/course_development/exercise_tools/custom_python.rst - ../references/course_development/exercise_tools/script_tag_format.rst + ../concepts/exercise_tools/about_custom_python_problem.rst + ../references/course_development/exercise_tools/guide_custom_python_problem.rst ../how-tos/course_development/exercise_tools/create_custom_python_problem.rst - ../how-tos/course_development/exercise_tools/create_custom_python_problem_script_tag.rst - ../how-tos/course_development/exercise_tools/randomized_custom_python_problem.rst - ../how-tos/course_development/exercise_tools/award_partial_credit.rst Drag and Drop Problem ******************************************************* .. toctree:: - :maxdepth: 2 + :maxdepth: 1 :glob: - ../concepts/exercise_tools/drag_and_drop.rst - ../references/course_development/exercise_tools/drag_and_drop.rst - ../how-tos/course_development/exercise_tools/creating_a_drag_and_drop_problem.rst - ../how-tos/course_development/exercise_tools/adding_dropdown.rst - ../how-tos/course_development/exercise_tools/use_dropdown_feedback.rst - ../how-tos/course_development/exercise_tools/use_dropdown_hints.rst + ../concepts/exercise_tools/about_drag_and_drop.rst + ../references/course_development/exercise_tools/guide_drag_and_drop.rst + ../how-tos/course_development/exercise_tools/create_drag_and_drop_problem.rst .. _Dropdown Problem: @@ -115,23 +100,21 @@ Dropdown Problem ******************************************************* .. toctree:: - :maxdepth: 2 + :maxdepth: 1 :glob: ../references/course_development/exercise_tools/dropdown.rst + ../how-tos/course_development/exercise_tools/add_dropdown.rst + ../how-tos/course_development/exercise_tools/use_dropdown_feedback.rst + ../how-tos/course_development/exercise_tools/use_dropdown_hints.rst ../references/course_development/exercise_tools/dropdown_problem_xml.rst -******************************************************* - -.. toctree:: - :maxdepth: 2 - :glob: Enable Advanced Problem Types ******************************************************* .. toctree:: - :maxdepth: 2 + :maxdepth: 1 :glob: ../how-tos/course_development/exercise_tools/enable_exercises_tools.rst @@ -140,18 +123,18 @@ External Grader ******************************************************* .. toctree:: - :maxdepth: 2 + :maxdepth: 1 :glob: - ../concepts/exercise_tools/external_graders.rst + ../concepts/exercise_tools/about_external_graders.rst ../references/course_development/exercise_tools/external_grader_requirements.rst - ../how-tos/course_development/exercise_tools/create_external_grader.rst + ../how-tos/course_development/exercise_tools/add_external_grader.rst Gene Explorer Tool ******************************************************* .. toctree:: - :maxdepth: 2 + :maxdepth: 1 :glob: ../references/course_development/exercise_tools/gene_explorer.rst @@ -160,48 +143,47 @@ Image Mapped Input Problem ******************************************************* .. toctree:: - :maxdepth: 2 + :maxdepth: 1 :glob: - ../references/course_development/exercise_tools/image_mapped_input.rst + ../concepts/exercise_tools/about_image_mapped_input.rst ../how-tos/course_development/exercise_tools/create_image_mapped_input.rst ../references/course_development/exercise_tools/image_mapped_input_xml.rst -Learner View -******************************************************* - -.. toctree:: - :maxdepth: 2 - :glob: - - ../references/grading/learner_view_of_grades.rst - LTI Component ******************************************************* .. toctree:: - :maxdepth: 2 + :maxdepth: 1 :glob: + ../concepts/exercise_tools/about_lti_component.rst ../references/course_development/exercise_tools/lti_component_settings.rst - ../references/course_development/exercise_tools/lti_component.rst ../how-tos/course_development/exercise_tools/enable_lti_component.rst - ../how-tos/course_development/exercise_tools/setting_up_lti_1_1_component.rst - ../how-tos/course_development/exercise_tools/setting_up_lti_1_3_component.rst + ../how-tos/course_development/exercise_tools/set_up_lti_1_1_component.rst + ../how-tos/course_development/exercise_tools/set_up_lti_1_3_component.rst ../how-tos/course_development/exercise_tools/using_lti_advantage_features.rst - ../how-tos/using_lti.rst Math Expression Input Problem ******************************************************* .. toctree:: - :maxdepth: 2 + :maxdepth: 1 :glob: ../references/course_development/exercise_tools/math_expression_input.rst - ../references/course_development/exercise_tools/math_expression_input_xml.rst - ../how-tos/course_development/exercise_tools/adding_mathjax.rst ../how-tos/course_development/exercise_tools/adding_math_expression_problem.rst + ../references/course_development/exercise_tools/math_expression_input_xml.rst + + +Multiple Choice Problem +******************************************************* + +.. toctree:: + :maxdepth: 1 + :glob: + + ../references/course_development/exercise_tools/multiple_choice.rst .. _Multi Select Problem: @@ -209,12 +191,11 @@ Multi-Select Problem ******************************************************* .. toctree:: - :maxdepth: 2 + :maxdepth: 1 :glob: - ../references/course_development/exercise_tools/multi_select.rst - ../how-tos/add_checkbox.rst - ../how-tos/course_development/exercise_tools/adding_multi_select.rst + ../concepts/exercise_tools/about_multi_select.rst + ../how-tos/course_development/exercise_tools/add_multi_select.rst ../how-tos/course_development/exercise_tools/edit_multi_select_using_advanced_editor.rst ../how-tos/course_development/exercise_tools/add_multi_select_partial_credit.rst ../references/course_development/exercise_tools/multi_select_xml.rst @@ -224,17 +205,17 @@ Numerical Input Problem ******************************************************* .. toctree:: - :maxdepth: 2 + :maxdepth: 1 :glob: ../references/course_development/exercise_tools/numerical_input.rst - ../how-tos/course_development/exercise_tools/add_numerical_input_problem.rst - ../references/course_development/exercise_tools/numerical_input_xml.rst - ../how-tos/course_development/exercise_tools/edit_numerical_input_advanced.rst + ../how-tos/course_development/exercise_tools/manage_numerical_input_problem.rst ../how-tos/course_development/exercise_tools/award_partial_credit_numerical_input.rst - ../how-tos/course_development/exercise_tools/adding_text_in_numeric_response_field.rst + ../how-tos/course_development/exercise_tools/add_single_select_num_input.rst + ../references/course_development/exercise_tools/numerical_input_xml.rst ../how-tos/course_development/exercise_tools/create_problem_in_latex.rst ../how-tos/course_development/text_components/manage_latex.rst + .. _Nav Open Response Assessments: @@ -242,26 +223,21 @@ Open Response Assessments ******************************************************* .. toctree:: - :maxdepth: 2 + :maxdepth: 1 :glob: ../concepts/exercise_tools/OpenResponseAssessments.rst ../how-tos/course_development/exercise_tools/CreateORAAssignment.rst ../how-tos/course_development/exercise_tools/Manage_ORA_Assignment.rst - ../how-tos/course_development/exercise_tools/list_manage_students_waiting_peer_step.rst - ../how-tos/course_development/exercise_tools/view_metrics_ORA_assignments.rst - ../how-tos/course_development/exercise_tools/view_statistics_single_ORA_assignment - ../how-tos/course_development/exercise_tools/generate_ORA_report.rst - ../how-tos/course_development/exercise_tools/generate_report_ORA_submissions_attachments.rst + ../how-tos/course_development/exercise_tools/access_ORA_metrics.rst ../references/course_development/exercise_tools/ORA_Staff_Grading.rst - ../references/course_development/exercise_tools/Access_ORA_Info.rst Oppia Exploration Tool ******************************************************* .. toctree:: - :maxdepth: 2 + :maxdepth: 1 :glob: ../references/course_development/exercise_tools/oppia_exploration.rst @@ -271,7 +247,7 @@ Peer Instruction Tool ******************************************************* .. toctree:: - :maxdepth: 2 + :maxdepth: 1 :glob: ../concepts/exercise_tools/peer_instruction.rst @@ -281,7 +257,7 @@ Periodic Table Tool ******************************************************* .. toctree:: - :maxdepth: 2 + :maxdepth: 1 :glob: ../how-tos/course_development/exercise_tools/create_periodic_table.rst @@ -292,7 +268,7 @@ Poll Tool ******************************************************* .. toctree:: - :maxdepth: 2 + :maxdepth: 1 :glob: ../how-tos/course_development/exercise_tools/enable_poll_tool.rst @@ -302,7 +278,7 @@ Problem with Adaptive Hint ******************************************************* .. toctree:: - :maxdepth: 2 + :maxdepth: 1 :glob: ../how-tos/course_development/exercise_tools/create_problem_with_hint.rst @@ -312,28 +288,28 @@ Proctored Exams ******************************************************* .. toctree:: - :maxdepth: 2 + :maxdepth: 1 :glob: ../concepts/proctored_exams/proctored_exams_overview.rst ../concepts/proctored_exams/preparing_learners_proctored_exams.rst ../how-tos/proctored_exams/enable_proctored_exams.rst - ../how-tos/proctored_exams/create_proctored_exam_pt.rst - ../references/proctored_exams/online_proctoring_rules.rst ../how-tos/proctored_exams/manage_proctored_exams.rst + ../references/proctored_exams/online_proctoring_rules.rst + ../how-tos/proctored_exams/allow_opt_out_proctored_exam.rst + ../how-tos/proctored_exams/create_proctored_exam_pt.rst ../how-tos/proctored_exams/create_proctored_exam_rpnow.rst - ../references/proctored_exams/rpnow_proctored_exam_report.rst + ../how-tos/proctored_exams/review_pt_results.rst ../how-tos/proctored_exams/review_rpnow_results.rst ../references/proctored_exams/pt_proctored_exam_report.rst - ../how-tos/proctored_exams/review_pt_results.rst - ../how-tos/proctored_exams/allow_opt_out_proctored_exam.rst + ../references/proctored_exams/rpnow_proctored_exam_report.rst Protex Protein Builder ******************************************************* .. toctree:: - :maxdepth: 2 + :maxdepth: 1 :glob: ../how-tos/course_development/exercise_tools/create_protein_builder.rst @@ -342,49 +318,37 @@ Randomized Content Block ******************************************************* .. toctree:: - :maxdepth: 2 + :maxdepth: 1 :glob: ../concepts/exercise_tools/randomized_content.rst ../how-tos/course_development/exercise_tools/use_randomized_content_blocks.rst -Single Select and Numerical Input Problem -******************************************************* - -.. toctree:: - :maxdepth: 2 - :glob: - - ../how-tos/course_development/exercise_tools/add_single_select_num_input.rst - .. _Single Select Problem: Single Select Problem ******************************************************* .. toctree:: - :maxdepth: 2 + :maxdepth: 1 :glob: ../concepts/exercise_tools/single_select_overview.rst - ../references/course_development/exercise_tools/multiple_choice.rst ../how-tos/course_development/exercise_tools/add_single_select.rst ../how-tos/course_development/exercise_tools/award_partial_credit_multiple_choice.rst + ../how-tos/course_development/exercise_tools/add_single_select_num_input.rst ../how-tos/course_development/exercise_tools/edit_single_select_advanced.rst ../references/course_development/exercise_tools/single_select_xml.rst - ../how-tos/add_multiple_choice.rst - ../how-tos/add_dropdown.rst Staff Graded Assignment ******************************************************* .. toctree:: - :maxdepth: 2 + :maxdepth: 1 :glob: - ../concepts/exercise_tools/staff_graded.rst - ../how-tos/course_development/exercise_tools/create_staffgraded.rst + ../how-tos/course_development/exercise_tools/manage_staffgraded.rst .. _Text Input Problem: @@ -392,12 +356,11 @@ Text Input Problem ******************************************************* .. toctree:: - :maxdepth: 2 + :maxdepth: 1 :glob: - ../references/course_development/exercise_tools/text_input.rst + ../concepts/exercise_tools/about_text_input.rst ../how-tos/course_development/exercise_tools/add_text_input.rst - ../how-tos/add_text_input.rst ../how-tos/course_development/exercise_tools/edit_text_input_advanced.rst ../references/course_development/exercise_tools/text_input_xml.rst @@ -408,17 +371,17 @@ Timed Exams ******************************************************* .. toctree:: - :maxdepth: 2 + :maxdepth: 1 :glob: - ../concepts/advanced_features/timed_exams.rst - ../how-tos/advanced_features/timed_exams.rst + ../concepts/advanced_features/about_timed_exams.rst + ../how-tos/advanced_features/manage_timed_exams.rst Zooming Image Tool ******************************************************* .. toctree:: - :maxdepth: 2 + :maxdepth: 1 :glob: ../how-tos/course_development/exercise_tools/create_zooming_image.rst diff --git a/source/educators/navigation/content_creation_management.rst b/source/educators/navigation/content_creation_management.rst index 407ce1cfe..ec551073b 100644 --- a/source/educators/navigation/content_creation_management.rst +++ b/source/educators/navigation/content_creation_management.rst @@ -47,6 +47,7 @@ Manage Text Components ../how-tos/course_development/text_components/manage_text.rst ../how-tos/course_development/text_components/manage_html.rst ../how-tos/course_development/text_components/manage_latex.rst + ../how-tos/course_development/exercise_tools/adding_mathjax.rst ../how-tos/course_development/exercise_tools/manage_full_screen_image.rst .. _Add Video Components: diff --git a/source/educators/navigation/creating_course.rst b/source/educators/navigation/creating_course.rst index b8c8b880a..a971a0e12 100644 --- a/source/educators/navigation/creating_course.rst +++ b/source/educators/navigation/creating_course.rst @@ -75,7 +75,7 @@ Create a New Course ../how-tos/view_as_learner.rst ../how-tos/course_development/exercise_tools/add_text.rst ../how-tos/course_development/manage_videos.rst - ../how-tos/add_multiple_choice.rst + ../how-tos/course_development/exercise_tools/add_single_select.rst ../references/resources_for_course_teams.rst @@ -91,7 +91,18 @@ Add Course Team Members ../references/course_development/course_team_roles.rst ../how-tos/set_up_course/add_course_team_members.rst ../how-tos/releasing-course/manage_beta_testing.rst - + +Configure Grades +******************************************************* + +.. toctree:: + :maxdepth: 1 + :glob: + + ../concepts/grading/graded_subsections.rst + ../how-tos/grading/set_grace_period.rst + ../how-tos/grading/set_grade_range.rst + ../references/grading/learner_view_of_grades.rst Set Up Course Certificates diff --git a/source/educators/navigation/olx.rst b/source/educators/navigation/olx.rst index b1a979f8f..5cb99489d 100644 --- a/source/educators/navigation/olx.rst +++ b/source/educators/navigation/olx.rst @@ -132,8 +132,8 @@ This section describes the various exercises, tools, and problem types that you /educators/references/course_development/exercise_tools/completion.rst /educators/references/course_development/exercise_tools/conditional_module.rst /educators/references/course_development/exercise_tools/custom_javascript.rst - /educators/references/course_development/exercise_tools/custom_python.rst - /educators/concepts/exercise_tools/drag_and_drop.rst + /educators/concepts/exercise_tools/about_custom_python_problem.rst + /educators/concepts/exercise_tools/about_drag_and_drop.rst /educators/references/course_development/exercise_tools/dropdown_problem_xml.rst /educators/how-tos/course_development/exercise_tools/manage_full_screen_image.rst /educators/references/course_development/exercise_tools/gene_explorer.rst @@ -141,16 +141,16 @@ This section describes the various exercises, tools, and problem types that you /educators/how-tos/course_development/exercise_tools/add_google_drive.rst /educators/how-tos/course_development/exercise_tools/create_iframe.rst /educators/references/course_development/exercise_tools/image_mapped_input_xml.rst - /educators/references/course_development/exercise_tools/lti_component.rst + /educators/concepts/exercise_tools/about_lti_component.rst /educators/references/course_development/exercise_tools/math_expression_input_xml.rst /educators/how-tos/course_development/exercise_tools/adding_mathjax.rst /educators/references/course_development/exercise_tools/multi_select_xml.rst - /educators/how-tos/course_development/exercise_tools/edit_numerical_input_advanced.rst + /educators/how-tos/course_development/exercise_tools/manage_numerical_input_problem.rst /educators/concepts/exercise_tools/OpenResponseAssessments.rst /educators/how-tos/course_development/exercise_tools/CreateORAAssignment.rst /educators/how-tos/course_development/exercise_tools/Manage_ORA_Assignment.rst /educators/references/course_development/exercise_tools/ORA_Staff_Grading.rst - /educators/how-tos/course_development/exercise_tools/view_metrics_ORA_assignments.rst + /educators/how-tos/course_development/exercise_tools/access_ORA_metrics.rst /educators/how-tos/course_development/exercise_tools/create_periodic_table.rst /educators/references/course_development/exercise_tools/poll_olx.rst /educators/how-tos/course_development/exercise_tools/create_poll_olx.rst @@ -162,7 +162,7 @@ This section describes the various exercises, tools, and problem types that you /educators/how-tos/course_development/exercise_tools/add_single_select_num_input.rst /educators/how-tos/course_development/exercise_tools/manage_survey_olx.rst ../olx/problem-xml/symbolic_response.rst - /educators/references/course_development/exercise_tools/text_input.rst + /educators/concepts/exercise_tools/about_text_input.rst /educators/how-tos/course_development/exercise_tools/manage_word_cloud.rst /educators/how-tos/course_development/exercise_tools/create_zooming_image.rst diff --git a/source/educators/olx/components/problem-components.rst b/source/educators/olx/components/problem-components.rst index 560276ba8..627daa8bc 100644 --- a/source/educators/olx/components/problem-components.rst +++ b/source/educators/olx/components/problem-components.rst @@ -66,7 +66,7 @@ For more information, see :ref:`Grading Policy`. .. _Problem Student View: -.. include:: /educators/references/course_development/Section_learner_problem_view.rst +.. include:: /educators/references/course_development/learner_problem_view.rst :start-after: .. START LEARNER VIEW OF PROBLEM :end-before: .. END LEARNER VIEW OF PROBLEM @@ -83,7 +83,7 @@ following settings. This section describes the OLX elements and attributes that you define for the problem settings. For a detailed description of each setting, see -:ref:`Problem Settings`. +:ref:`Guide to Problem Settings`. =============== Display Name @@ -265,15 +265,15 @@ the problems in the component at once. If a learner selects **Show Answer**, the answers for all the problems in the component appear. .. note:: - You cannot use a :ref:`Custom JavaScript` in a component that contains more + You cannot use a :ref:`Custom JavaScript` in a component that contains more than one problem. Each custom JavaScript problem must be in its own component. -.. include:: /educators/references/course_development/exercise_tools/Section_adding_hints.rst +.. include:: /educators/references/course_development/exercise_tools/adding_hints.rst :start-after: .. START ADDING FEEDBACK AND HINTS :end-before: .. END ADDING FEEDBACK AND HINTS -.. include:: /educators/references/course_development/Section_partial_credit.rst +.. include:: /educators/references/course_development/awarding_partial_credit.rst :start-after: .. START PARTIAL CREDIT :end-before: .. END PARTIAL CREDIT @@ -312,6 +312,6 @@ content blocks, which randomly draw problems from pools of problems stored in content libraries. For more information, see :ref:`Randomized Content Blocks`. -.. include:: /educators/references/course_development/Section_adding_tooltip.rst +.. include:: /educators/references/course_development/adding_tooltips.rst :start-after: .. START ADDING TOOLTIPS :end-before: .. END ADDING TOOLTIPS diff --git a/source/educators/quickstarts/build_a_course.rst b/source/educators/quickstarts/build_a_course.rst index 339f316d1..fcdfcddec 100644 --- a/source/educators/quickstarts/build_a_course.rst +++ b/source/educators/quickstarts/build_a_course.rst @@ -100,7 +100,7 @@ Follow the steps below to build your first course. By the end, you will have a f :ref:`Work with the Text Editor` (how-to) - :ref:`Add a Multiple Choice Problem` (how-to) + :ref:`Add a Multi Select Problem` (how-to) :ref:`Publish a Unit` (how-to) diff --git a/source/educators/references/course_development/about_page.rst b/source/educators/references/course_development/about_page.rst index 85565e393..d911d17f3 100644 --- a/source/educators/references/course_development/about_page.rst +++ b/source/educators/references/course_development/about_page.rst @@ -422,8 +422,6 @@ the image appears correctly on the dashboard. Course About Video Guidelines ======================================== -.. tags:: educator, reference - The course About video should excite and entice potential learners to enroll, and reveal some of the personality that the course team brings to the course. diff --git a/source/educators/references/course_development/Section_adding_tooltip.rst b/source/educators/references/course_development/adding_tooltips.rst similarity index 71% rename from source/educators/references/course_development/Section_adding_tooltip.rst rename to source/educators/references/course_development/adding_tooltips.rst index a88567db4..8c67cdc4c 100644 --- a/source/educators/references/course_development/Section_adding_tooltip.rst +++ b/source/educators/references/course_development/adding_tooltips.rst @@ -41,10 +41,35 @@ tooltips. .. seealso:: + :ref:`About Problems Exercises and Tools` (concept) - :ref:`Adding Feedback and Hints to a Problem` (reference) + :ref:`Core Problem Types` (reference) - :ref:`Accessibility Best Practices Checklist` (reference) + :ref:`Working with Problem Components` (reference) + + :ref:`Guide to Problem Settings` (reference) + + :ref:`Gradebook Assignment Types` (reference) + + :ref:`Feedback Best Practices` (concept) + + :ref:`Adding Feedback and Hints to a Problem` (reference) + + :ref:`Configure Hint` (how-to) + + :ref:`Partial Credit` (reference) + + :ref:`Set the Assignment Type and Due Date for a Subsection` (how-to) + + :ref:`Learner View of Problems` (reference) + + :ref:`Advanced Editor` (reference) + + :ref:`Add Hints via the Advanced Editor` (how-to) + + :ref:`Modifying a Released Problem` (reference) + + :ref:`Add Unsupported Exercises Problems` (how-to) **Maintenance chart** diff --git a/source/educators/references/course_development/advanced_problem_editor.rst b/source/educators/references/course_development/advanced_problem_editor.rst index ce585edac..ec0a6ce16 100644 --- a/source/educators/references/course_development/advanced_problem_editor.rst +++ b/source/educators/references/course_development/advanced_problem_editor.rst @@ -155,7 +155,7 @@ the questions are submitted when learners select **Submit**, and the correct answers for all of the questions appear when learners select **Show Answer**. By default, learners receive one point for each question they answer correctly. For more information about changing the default problem points and other -settings, see :ref:`Problem Settings`. +settings, see :ref:`Guide to Problem Settings`. .. important:: To assure that the data collected for learner interactions with @@ -189,7 +189,7 @@ series of text input questions, or you can include questions that use different problem types, such as both numerical input and math expression input. .. note:: - You cannot use a :ref:`Custom JavaScript` in a problem component that + You cannot use a :ref:`Custom JavaScript` in a problem component that contains more than one question. Each custom JavaScript problem must be in its own component. @@ -255,20 +255,35 @@ course's XML files is no longer supported. .. seealso:: + :ref:`About Problems Exercises and Tools` (concept) - :ref:`Working with Problem Components` (reference) + :ref:`Core Problem Types` (reference) - :ref:`Modifying a Released Problem` (reference) + :ref:`Working with Problem Components` (reference) - :ref:`Problem Settings` (reference) + :ref:`Guide to Problem Settings` (reference) - :ref:`Feedback Best Practices` (concept) + :ref:`Gradebook Assignment Types` (reference) - :ref:`Learner View of Problems` (reference) + :ref:`Feedback Best Practices` (concept) - :ref:`Partial Credit` (reference) + :ref:`Adding Feedback and Hints to a Problem` (reference) - :ref:`Adding Tooltips` (reference) + :ref:`Configure Hint` (how-to) + + :ref:`Partial Credit` (reference) + + :ref:`Set the Assignment Type and Due Date for a Subsection` (how-to) + + :ref:`Adding Tooltips` (reference) + + :ref:`Learner View of Problems` (reference) + + :ref:`Add Hints via the Advanced Editor` (how-to) + + :ref:`Modifying a Released Problem` (reference) + + :ref:`Add Unsupported Exercises Problems` (how-to) diff --git a/source/educators/references/course_development/Section_partial_credit.rst b/source/educators/references/course_development/awarding_partial_credit.rst similarity index 79% rename from source/educators/references/course_development/Section_partial_credit.rst rename to source/educators/references/course_development/awarding_partial_credit.rst index 21f27958a..56e01274d 100644 --- a/source/educators/references/course_development/Section_partial_credit.rst +++ b/source/educators/references/course_development/awarding_partial_credit.rst @@ -12,7 +12,7 @@ partial credit for a problem if they submit a partially correct answer. * :ref:`Single Select ` * :ref:`Multi-select ` -* :ref:`Numerical Input ` +* :ref:`Numerical Input ` * :ref:`Custom Python-evaluated Input Problem (Write-Your-Own Grader) ` By awarding partial credit for problems, you can motivate learners who have @@ -67,13 +67,35 @@ the learner received out of the total available score and the value in the .. seealso:: - :ref:`Awarding Partial Credit in a Multiple Choice Problem` (how-to) - - :ref:`Awarding Partial Credit in a Multi select Problem` (how-to) + :ref:`About Problems Exercises and Tools` (concept) - :ref:`Awarding Partial Credit in a Numerical Input Problem` (how-to) + :ref:`Core Problem Types` (reference) - :ref:`Award Partial Credit` (how-to) + :ref:`Working with Problem Components` (reference) + + :ref:`Guide to Problem Settings` (reference) + + :ref:`Gradebook Assignment Types` (reference) + + :ref:`Feedback Best Practices` (concept) + + :ref:`Adding Feedback and Hints to a Problem` (reference) + + :ref:`Configure Hint` (how-to) + + :ref:`Set the Assignment Type and Due Date for a Subsection` (how-to) + + :ref:`Adding Tooltips` (reference) + + :ref:`Learner View of Problems` (reference) + + :ref:`Advanced Editor` (reference) + + :ref:`Add Hints via the Advanced Editor` (how-to) + + :ref:`Modifying a Released Problem` (reference) + + :ref:`Add Unsupported Exercises Problems` (how-to) **Maintenance chart** diff --git a/source/educators/references/course_development/exercise_tools/Access_ORA_Info.rst b/source/educators/references/course_development/exercise_tools/Access_ORA_Info.rst deleted file mode 100644 index f4c5d0c36..000000000 --- a/source/educators/references/course_development/exercise_tools/Access_ORA_Info.rst +++ /dev/null @@ -1,53 +0,0 @@ -.. _Accessing ORA Assignment Information: - -###################################### -Accessing Metrics for ORA Assignments -###################################### - -.. tags:: educator, reference - -After you release an Open Response Assessment (ORA) assignment, you can access various -metrics for the assignment or for all open response assessment assignments in -the course. For example, you can view the number of learners in each step of the -assignment or in possible states such as "Waiting" or "Completed" within the -assignment. In addition to viewing metrics for the assignment or for assignments -in a course, you can also access assignment details for an individual learner, -or :ref:`generate a report ` containing learner and -response details for ORA assignments in the course. - -For information about tasks that you can perform on learner responses in an -ORA assignment, including :ref:`performing a grade override -assessment` or :ref:`cancelling a -learner's submission`, see -:ref:`Managing ORA Assignments`. - -.. seealso:: - - - :ref:`Open Response Assessments` (concept) - - :ref:`List and manage students waiting in peer step` (how-to) - - :ref:`View Metrics for All ORA Assignments` (how-to) - - :ref:`PA View Metrics for Individual Steps` (how-to) - - :ref:`Generate ORA Report` (how-to) - - :ref:`Generate a Report for ORA File Submissions and Attachments` (how-to) - - :ref:`PA Create an ORA Assignment` (how to) - - :ref:`Managing ORA Assignments` (how to) - - :ref:`ORA Staff Grading` (reference) - - - -**Maintenance chart** - -+--------------+-------------------------------+----------------+--------------------------------+ -| Review Date | Working Group Reviewer | Release |Test situation | -+--------------+-------------------------------+----------------+--------------------------------+ -| | | | | -+--------------+-------------------------------+----------------+--------------------------------+ diff --git a/source/educators/references/course_development/exercise_tools/ORA_Staff_Grading.rst b/source/educators/references/course_development/exercise_tools/ORA_Staff_Grading.rst index 332ddfed6..a29f15ef9 100644 --- a/source/educators/references/course_development/exercise_tools/ORA_Staff_Grading.rst +++ b/source/educators/references/course_development/exercise_tools/ORA_Staff_Grading.rst @@ -1,7 +1,7 @@ .. _ORA Staff Grading: ########################################### -Staff Grading for Open Response Assignments +Staff Grading for Open Response Assessments ########################################### .. tags:: educator, reference @@ -177,11 +177,11 @@ grading claim on any submissions the staff member currently has open, but ungrad :ref:`Open Response Assessments` (concept) - :ref:`PA Create an ORA Assignment` (how to) + :ref:`Create an ORA Assignment` (how to) :ref:`Managing ORA Assignments` (how to) - :ref:`Accessing ORA Assignment Information` (reference) + :ref:`Access ORA Assignment Information` (reference) **Maintenance chart** diff --git a/source/educators/references/course_development/exercise_tools/Section_adding_hints.rst b/source/educators/references/course_development/exercise_tools/adding_hints.rst similarity index 88% rename from source/educators/references/course_development/exercise_tools/Section_adding_hints.rst rename to source/educators/references/course_development/exercise_tools/adding_hints.rst index 983f6b288..90dd13d57 100644 --- a/source/educators/references/course_development/exercise_tools/Section_adding_hints.rst +++ b/source/educators/references/course_development/exercise_tools/adding_hints.rst @@ -145,13 +145,35 @@ hints for learners. .. seealso:: + :ref:`About Problems Exercises and Tools` (concept) - :ref:`Adding Hints via the Advanced Editor` (how-to) - - :ref:`Use Hints in a Dropdown Problem` (how-to) + :ref:`Core Problem Types` (reference) + + :ref:`Working with Problem Components` (reference) + + :ref:`Guide to Problem Settings` (reference) + + :ref:`Gradebook Assignment Types` (reference) + + :ref:`Feedback Best Practices` (concept) + + :ref:`Adding Feedback and Hints to a Problem` (reference) + + :ref:`Partial Credit` (reference) + + :ref:`Set the Assignment Type and Due Date for a Subsection` (how-to) + + :ref:`Adding Tooltips` (reference) + + :ref:`Learner View of Problems` (reference) + + :ref:`Advanced Editor` (reference) + + :ref:`Add Hints via the Advanced Editor` (how-to) - :ref:`Problem Settings` (reference) + :ref:`Modifying a Released Problem` (reference) + :ref:`Add Unsupported Exercises Problems` (how-to) **Maintenance chart** diff --git a/source/educators/references/course_development/exercise_tools/chemical_equation_xml.rst b/source/educators/references/course_development/exercise_tools/chemical_equation_xml.rst index 4945fe2c1..7844bcc69 100644 --- a/source/educators/references/course_development/exercise_tools/chemical_equation_xml.rst +++ b/source/educators/references/course_development/exercise_tools/chemical_equation_xml.rst @@ -1,7 +1,7 @@ -.. _Chemical Equation Problem XML: +.. _Guide to Chemical Equation Problem XML: -Chemical Equation Problem XML -############################# +Guide to Chemical Equation Problem XML +######################################### .. tags:: educator, reference diff --git a/source/educators/references/course_development/exercise_tools/completion.rst b/source/educators/references/course_development/exercise_tools/completion.rst index 56c421fc0..afcf505b7 100644 --- a/source/educators/references/course_development/exercise_tools/completion.rst +++ b/source/educators/references/course_development/exercise_tools/completion.rst @@ -1,8 +1,8 @@ -.. _Completion: +.. _About the Completion Tool: -############### -Completion Tool -############### +######################### +About the Completion Tool +######################### .. tags:: educator, reference diff --git a/source/educators/references/course_development/exercise_tools/custom_javascript.rst b/source/educators/references/course_development/exercise_tools/custom_javascript.rst index b9de7b20c..ce39a18af 100644 --- a/source/educators/references/course_development/exercise_tools/custom_javascript.rst +++ b/source/educators/references/course_development/exercise_tools/custom_javascript.rst @@ -1,7 +1,7 @@ -.. _Custom JavaScript: +.. _Guide to Custom JavaScript Display and Grading Problem: -Custom JavaScript Display and Grading Problem -############################################# +Guide to Custom JavaScript Display and Grading Problem +###################################################### .. tags:: educator, reference diff --git a/source/educators/references/course_development/exercise_tools/dropdown.rst b/source/educators/references/course_development/exercise_tools/dropdown.rst index f1cef0e6b..5f5cca2ee 100644 --- a/source/educators/references/course_development/exercise_tools/dropdown.rst +++ b/source/educators/references/course_development/exercise_tools/dropdown.rst @@ -45,7 +45,7 @@ problem. An example of a dropdown problem from the learner's perspective follows .. seealso:: - :ref:`Adding Dropdown` (how to) + :ref:`Add Dropdown` (how to) :ref:`Dropdown Problem XML` (reference) diff --git a/source/educators/references/course_development/exercise_tools/dropdown_problem_xml.rst b/source/educators/references/course_development/exercise_tools/dropdown_problem_xml.rst index 668c484b7..8a09aea1a 100644 --- a/source/educators/references/course_development/exercise_tools/dropdown_problem_xml.rst +++ b/source/educators/references/course_development/exercise_tools/dropdown_problem_xml.rst @@ -220,7 +220,7 @@ None. :ref:`Dropdown` (reference) - :ref:`Adding Dropdown` (how to) + :ref:`Add Dropdown` (how to) :ref:`Use Hints in a Dropdown Problem` (how to) diff --git a/source/educators/references/course_development/exercise_tools/external_grader_requirements.rst b/source/educators/references/course_development/exercise_tools/external_grader_requirements.rst index bb23d27e4..ac2b9c9f2 100644 --- a/source/educators/references/course_development/exercise_tools/external_grader_requirements.rst +++ b/source/educators/references/course_development/exercise_tools/external_grader_requirements.rst @@ -103,8 +103,7 @@ has the following keys. file. XQueue stores files that learners upload in ``xqueue_files``. * ``grader_payload``: An optional string that you can specify when you create - the problem. For more information, see :ref:`Create an External Grader - Problem in Studio`. + the problem. For more information, see :ref:`Add an External Grader Problem`. An example JSON object for a learner submission follows. @@ -215,9 +214,9 @@ external grader. .. seealso:: - :ref:`External Grader` (concept) + :ref:`About External Grader Problems` (concept) - :ref:`Create an External Grader Problem in Studio` (how-to) + :ref:`Add an External Grader Problem` (how-to) diff --git a/source/educators/references/course_development/exercise_tools/script_tag_format.rst b/source/educators/references/course_development/exercise_tools/guide_custom_python_problem.rst similarity index 94% rename from source/educators/references/course_development/exercise_tools/script_tag_format.rst rename to source/educators/references/course_development/exercise_tools/guide_custom_python_problem.rst index 05ef4bc60..66bcdf6e8 100644 --- a/source/educators/references/course_development/exercise_tools/script_tag_format.rst +++ b/source/educators/references/course_development/exercise_tools/guide_custom_python_problem.rst @@ -1,7 +1,7 @@ -.. _Script Tag Format: +.. _Guide to the Custom Python-Evaluated Input Problem: -Script Tag Format -################# +Guide to the Custom Python-Evaluated Input Problem +#################################################### .. tags:: educator, reference @@ -173,15 +173,9 @@ preceding example. .. seealso:: - :ref:`Write Your Own Grader` (reference) + :ref:`About Custom Python-Evaluated Input Problem` (reference) - :ref:`Create a Custom Python Evaluated Input Problem in Studio` (how to) - - :ref:`Create a Custom Python Evaluated Input Problem in Script Tag Format` (how to) - - :ref:`Create a Randomized Custom Python Evaluated Input Problem` (how to) - - :ref:`Award Partial Credit` (concept) + :ref:`Create a Custom Python Evaluated Input Problem` (how to) diff --git a/source/educators/references/course_development/exercise_tools/drag_and_drop.rst b/source/educators/references/course_development/exercise_tools/guide_drag_and_drop.rst similarity index 97% rename from source/educators/references/course_development/exercise_tools/drag_and_drop.rst rename to source/educators/references/course_development/exercise_tools/guide_drag_and_drop.rst index b7e9bfe05..097bbe2f7 100644 --- a/source/educators/references/course_development/exercise_tools/drag_and_drop.rst +++ b/source/educators/references/course_development/exercise_tools/guide_drag_and_drop.rst @@ -1,9 +1,7 @@ -.. _Drag and Drop: +.. _Guide to the Drag and Drop Problem: -.. _drag_and_drop_background_images: - -Understanding Background Images -############################### +Guide to the Drag and Drop Problem +################################## .. tags:: educator, reference @@ -32,7 +30,7 @@ between the top of the background image and the top of the target zone. The following image shows a background image and target zones in the drag and drop problem editing dialog box. For more information about editing drag and -drop problems, see :ref:`Creating a Drag and Drop Problem`. +drop problems, see :ref:`Create a Drag and Drop Problem`. .. image:: /_images/educator_references/dnd-zone-borders.png :width: 600 @@ -213,7 +211,7 @@ The following table explains the controls in the **Editing** dialog box. * - **Background URL** - The URL of the image that contains target zones for the problem. The URL can be relative to a file you add to your course or to a file on the - web. For more information, see :ref:`drag_and_drop_background_images`. + web. For more information, see :ref:`Guide to the Drag and Drop Problem`. You must select **Change background** when you enter a new URL in this field. If you do not select **Change background**, the new value will @@ -326,9 +324,9 @@ The following table explains the controls in the **Editing** dialog box. .. seealso:: - :ref:`Drag and Drop Problem ` (concept) + :ref:`About the Drag and Drop Problem` (concept) - :ref:`Drag and Drop` (reference) + :ref:`Guide to the Drag and Drop Problem` (reference) diff --git a/source/educators/references/course_development/exercise_tools/create_exercises_and_tools.rst b/source/educators/references/course_development/exercise_tools/guide_problem_types.rst similarity index 90% rename from source/educators/references/course_development/exercise_tools/create_exercises_and_tools.rst rename to source/educators/references/course_development/exercise_tools/guide_problem_types.rst index 347d66bc2..230c1ddff 100644 --- a/source/educators/references/course_development/exercise_tools/create_exercises_and_tools.rst +++ b/source/educators/references/course_development/exercise_tools/guide_problem_types.rst @@ -1,7 +1,7 @@ .. _Core Problem Types: -Core Problem Types -################## +Guide to Problem Types +###################### .. tags:: educator, reference @@ -12,7 +12,7 @@ types are classified as either **Simple Problem Types** or **Advanced**. .. contents:: :local: - :depth: 1 + :depth: 2 Simple Problem Types @@ -44,7 +44,7 @@ following problem types. When you select any of the simple problem types, the answers, which are presented in a dropdown list after the learner selects the dropdown arrow. - Full support; mobile-ready - * - :ref:`Numerical Input` + * - :ref:`Numerical Input` - In numerical input problems, learners enter numbers or specific and relatively simple mathematical expressions to answer a question. These problems allow only integers and a few select constants. You can specify @@ -94,13 +94,13 @@ advanced problem types, the :ref:`advanced editor` opens. - Description - Support - * - :ref:`Custom JavaScript Display and Grading` + * - :ref:`Custom JavaScript Display and Grading` - Custom JavaScript display and grading problems (also called custom JavaScript problems or JS input problems) allow you to create a custom problem or tool that uses JavaScript and then add the problem or tool directly into Studio. - Full support - * - :ref:`Custom Python-evaluated Input (Write Your Own Grader)` + * - :ref:`Custom Python-evaluated Input ` - In custom Python-evaluated input (also called "write-your-own-grader") problems, the grader uses a Python script that you create and embed in the problem to evaluate a learner's response or provide hints. These @@ -136,7 +136,7 @@ available in Studio. For more information, see resistors, and MOSFETs on an interactive grid. They then submit a DC, AC, or transient analysis of their circuits to the system for grading. - Not supported - * - :ref:`Image Mapped Input` + * - :ref:`Image Mapped Input` - Learners answer prompts by selecting a defined area in an image. You define the area by including coordinates in the body of the problem. - Not supported @@ -188,18 +188,18 @@ tools that you can add to your course. question then see a different block of text from the learners who answer "No" to that question. - Provisional support - * - :ref:`drag_and_drop_problem` + * - :ref:`Drag and Drop Problem` - Learners respond to a question by dragging text or objects to a specific location on an image. - Full support; mobile-ready - * - :ref:`Drag and Drop` + * - :ref:`Guide to the Drag and Drop Problem` - Learners respond to a question by dragging text or objects to a specific location on an image. This version of the drag and drop problem type is deprecated and should not be added to a course. For more information about the fully supported drag and drop problem type, see - :ref:`drag_and_drop_problem`. + :ref:`About the Drag and Drop Problem`. - Not supported - * - :ref:`External Grader` + * - :ref:`External Grader` - An external grader is a service that receives learner responses to a problem, processes those responses, and returns feedback and a problem grade to the Open edX platform. You build and deploy an external grader @@ -220,7 +220,7 @@ tools that you can add to your course. - With the iframe tool, you can integrate ungraded exercises and tools from any Internet site into a Text component in your course. - Provisional support - * - :ref:`LTI Component` + * - :ref:`LTI Component` - LTI components allow you to add an external learning application or non- PDF textbook to Studio. - Full support @@ -280,7 +280,7 @@ tools available in Studio. For more information, see box. The grader uses Python script that you create and embed in the problem to evaluate learner responses. - Not supported - * - :ref:`completion` + * - :ref:`Completion Tool` - Learners mark sections of course content as completed. This tool helps learners track their progress through sections of the course (including ungraded activities such as reading text, watching videos, or @@ -342,11 +342,11 @@ Mobile-Ready Problem Types Learners can read and submit answers for the following types of problems while they use the Open edX mobile app. -* :ref:`drag_and_drop_problem` +* :ref:`Drag and Drop Problem` * :ref:`Dropdown` * :ref:`Math Expression Input` * :ref:`Multi select` -* :ref:`Numerical Input` +* :ref:`Numerical Input` * :ref:`Single Select` * :ref:`Text Input` @@ -356,13 +356,36 @@ in a web browser. .. seealso:: - - :ref:`Create Exercises` (concept) + :ref:`About Problems Exercises and Tools` (concept) - :ref:`Enable Additional Exercises and Tools` (how to) + :ref:`Working with Problem Components` (reference) - :ref:`Add Unsupported Exercises Problems` (how to) + :ref:`Guide to Problem Settings` (reference) + + :ref:`Gradebook Assignment Types` (reference) + + :ref:`Feedback Best Practices` (concept) + + :ref:`Adding Feedback and Hints to a Problem` (reference) + + :ref:`Configure Hint` (how-to) + + :ref:`Partial Credit` (reference) + + :ref:`Set the Assignment Type and Due Date for a Subsection` (how-to) + + :ref:`Adding Tooltips` (reference) + + :ref:`Learner View of Problems` (reference) + + :ref:`Advanced Editor` (reference) + + :ref:`Add Hints via the Advanced Editor` (how-to) + + :ref:`Modifying a Released Problem` (reference) + + :ref:`Add Unsupported Exercises Problems` (how-to) **Maintenance chart** diff --git a/source/educators/references/course_development/exercise_tools/iframe.rst b/source/educators/references/course_development/exercise_tools/iframe.rst index 294d160d5..e4390e4ca 100644 --- a/source/educators/references/course_development/exercise_tools/iframe.rst +++ b/source/educators/references/course_development/exercise_tools/iframe.rst @@ -25,8 +25,8 @@ see :ref:`Accessibility Best Practices Checklist`. Iframes are well-suited for tools that demonstrate a concept, but that are not graded or used to store student data. If you want to add a graded tool or -exercise, add the tool as a :ref:`custom JavaScript problem` -or an :ref:`LTI component`. +exercise, add the tool as a :ref:`custom JavaScript problem` +or an :ref:`LTI component`. For more information about iframes, see the `iframe: The Inline Frame element `_. diff --git a/source/educators/references/course_development/exercise_tools/image_mapped_input_xml.rst b/source/educators/references/course_development/exercise_tools/image_mapped_input_xml.rst index b361bf0e2..bc689e4f7 100644 --- a/source/educators/references/course_development/exercise_tools/image_mapped_input_xml.rst +++ b/source/educators/references/course_development/exercise_tools/image_mapped_input_xml.rst @@ -77,7 +77,7 @@ Specifies the image file and the region in the file where learners must click. :ref:`Create Image Mapped Input Problem` (how to) - :ref:`Image Mapped Input` (reference) + :ref:`About Image Mapped Input Problem` (concept) **Maintenance chart** diff --git a/source/educators/references/course_development/exercise_tools/lti_component_settings.rst b/source/educators/references/course_development/exercise_tools/lti_component_settings.rst index 1c82e7856..4d527d310 100644 --- a/source/educators/references/course_development/exercise_tools/lti_component_settings.rst +++ b/source/educators/references/course_development/exercise_tools/lti_component_settings.rst @@ -192,10 +192,15 @@ LTI Component Settings .. seealso:: + :ref:`About the LTI Component` (concept) - :ref:`Enable_LTI_Components` (how to) + :ref:`Enable_LTI_Components` (how-to) - :ref:`LTI Component` (reference) + :ref:`Set up an LTI 1_1 component` (how-to) + + :ref:`Set up an LTI 1_3 component` (how-to) + + :ref:`Enabling and using LTI Advantage features` (how-to) **Maintenance chart** diff --git a/source/educators/references/course_development/exercise_tools/math_expression_input.rst b/source/educators/references/course_development/exercise_tools/math_expression_input.rst index 1b9c1779c..bc7e44553 100644 --- a/source/educators/references/course_development/exercise_tools/math_expression_input.rst +++ b/source/educators/references/course_development/exercise_tools/math_expression_input.rst @@ -1,8 +1,8 @@ .. _Math Expression Input: -############################## -Math Expression Input Problems -############################## +########################################## +About the Math Expression Input Problem +########################################## .. tags:: educator, reference diff --git a/source/educators/references/course_development/exercise_tools/math_expression_input_xml.rst b/source/educators/references/course_development/exercise_tools/math_expression_input_xml.rst index 7e0e99f1a..449d31ff2 100644 --- a/source/educators/references/course_development/exercise_tools/math_expression_input_xml.rst +++ b/source/educators/references/course_development/exercise_tools/math_expression_input_xml.rst @@ -67,7 +67,7 @@ In addition, standard HTML tags can be used to format text. Required. Indicates that the problem is a math expression input problem. The ```` tag is similar to the ```` tag -used by :ref:`numerical input` problem types, but +used by :ref:`numerical input` problem types, but ```` allows unknown variables. Attributes diff --git a/source/educators/references/course_development/exercise_tools/numerical_input.rst b/source/educators/references/course_development/exercise_tools/numerical_input.rst index 3cdf86547..1fa85bd08 100644 --- a/source/educators/references/course_development/exercise_tools/numerical_input.rst +++ b/source/educators/references/course_development/exercise_tools/numerical_input.rst @@ -1,7 +1,7 @@ -.. _Numerical Input: +.. _About Numerical Input: -Numerical Input Problem -######################## +About Numerical Input Problem +################################ .. tags:: educator, reference @@ -62,17 +62,12 @@ numerical input problem. An example of a completed numerical input problem follo :alt: A problem with one question, answered correctly, in the LMS. .. seealso:: - - :ref:`Editing Numerical Input Problems using the Advanced Editor` (how to) - - :ref:`Use Feedback in a Numerical Input Problems` (how to) - - :ref:`Adding Numerical Input Problem` (how to) + :ref:`Manage Numerical Input Problem` (how to) :ref:`Numerical Input Problem XML` (reference) - :ref:`Awarding Partial Credit in a Numerical Input Problem` (how to) + :ref:`Award Partial Credit in a Numerical Input Problem` (how to) **Maintenance chart** diff --git a/source/educators/references/course_development/exercise_tools/numerical_input_xml.rst b/source/educators/references/course_development/exercise_tools/numerical_input_xml.rst index 68e248976..bb15febee 100644 --- a/source/educators/references/course_development/exercise_tools/numerical_input_xml.rst +++ b/source/educators/references/course_development/exercise_tools/numerical_input_xml.rst @@ -370,13 +370,11 @@ None. .. seealso:: - :ref:`Numerical Input` (reference) + :ref:`About Numerical Input` (reference) - :ref:`Adding Numerical Input Problem` (how to) + :ref:`Manage Numerical Input Problem` (how to) - :ref:`Editing Numerical Input Problems using the Advanced Editor` (how to) - - :ref:`Awarding Partial Credit in a Numerical Input Problem` (how to) + :ref:`Award Partial Credit in a Numerical Input Problem` (how to) **Maintenance chart** diff --git a/source/educators/references/course_development/exercise_tools/single_select_xml.rst b/source/educators/references/course_development/exercise_tools/single_select_xml.rst index eca7b82f8..8cdf1751c 100644 --- a/source/educators/references/course_development/exercise_tools/single_select_xml.rst +++ b/source/educators/references/course_development/exercise_tools/single_select_xml.rst @@ -432,7 +432,7 @@ correctness. .. seealso:: - :ref:`Single Select Overview` (concept) + :ref:`About Single Select` (concept) :ref:`Single Select` (how to) diff --git a/source/educators/references/course_development/Section_learner_problem_view.rst b/source/educators/references/course_development/learner_problem_view.rst similarity index 90% rename from source/educators/references/course_development/Section_learner_problem_view.rst rename to source/educators/references/course_development/learner_problem_view.rst index a720f63ce..68509819d 100644 --- a/source/educators/references/course_development/Section_learner_problem_view.rst +++ b/source/educators/references/course_development/learner_problem_view.rst @@ -139,16 +139,35 @@ visible. You can set these attributes in Studio. .. seealso:: + :ref:`About Problems Exercises and Tools` (concept) - :ref:`Working with Problem Components` (reference) + :ref:`Core Problem Types` (reference) - :ref:`Modifying a Released Problem` (reference) + :ref:`Working with Problem Components` (reference) - :ref:`Advanced Editor` (reference) + :ref:`Guide to Problem Settings` (reference) - :ref:`Problem Settings` (reference) + :ref:`Gradebook Assignment Types` (reference) - :ref:`Feedback Best Practices` (concept) + :ref:`Feedback Best Practices` (concept) + + :ref:`Adding Feedback and Hints to a Problem` (reference) + + :ref:`Configure Hint` (how-to) + + :ref:`Partial Credit` (reference) + + :ref:`Set the Assignment Type and Due Date for a Subsection` (how-to) + + :ref:`Adding Tooltips` (reference) + + :ref:`Advanced Editor` (reference) + + :ref:`Add Hints via the Advanced Editor` (how-to) + + :ref:`Modifying a Released Problem` (reference) + + :ref:`Add Unsupported Exercises Problems` (how-to) **Maintenance chart** diff --git a/source/educators/references/course_development/modifying_released_problem.rst b/source/educators/references/course_development/modifying_released_problem.rst index 5f4b8bd5f..d82ec43d3 100644 --- a/source/educators/references/course_development/modifying_released_problem.rst +++ b/source/educators/references/course_development/modifying_released_problem.rst @@ -56,16 +56,35 @@ For information about how to review and adjust learner grades in the LMS, see .. seealso:: + :ref:`About Problems Exercises and Tools` (concept) - :ref:`Working with Problem Components` (reference) + :ref:`Core Problem Types` (reference) - :ref:`Advanced Editor` (reference) + :ref:`Working with Problem Components` (reference) - :ref:`Problem Settings` (reference) + :ref:`Guide to Problem Settings` (reference) - :ref:`Feedback Best Practices` (concept) + :ref:`Gradebook Assignment Types` (reference) - :ref:`Learner View of Problems` (reference) + :ref:`Feedback Best Practices` (concept) + + :ref:`Adding Feedback and Hints to a Problem` (reference) + + :ref:`Configure Hint` (how-to) + + :ref:`Partial Credit` (reference) + + :ref:`Set the Assignment Type and Due Date for a Subsection` (how-to) + + :ref:`Adding Tooltips` (reference) + + :ref:`Learner View of Problems` (reference) + + :ref:`Advanced Editor` (reference) + + :ref:`Add Hints via the Advanced Editor` (how-to) + + :ref:`Add Unsupported Exercises Problems` (how-to) **Maintenance chart** diff --git a/source/educators/references/course_development/problem_settings.rst b/source/educators/references/course_development/problem_settings.rst index 67440d789..f54546796 100644 --- a/source/educators/references/course_development/problem_settings.rst +++ b/source/educators/references/course_development/problem_settings.rst @@ -1,6 +1,6 @@ -.. _Problem Settings: +.. _Guide to Problem Settings: -Defining Settings for Problem Components +Guide to Problem Settings ######################################## .. tags:: educator, reference @@ -291,18 +291,35 @@ Problems** advanced setting. .. seealso:: + :ref:`About Problems Exercises and Tools` (concept) - :ref:`Working with Problem Components` (reference) + :ref:`Core Problem Types` (reference) - :ref:`Modifying a Released Problem` (reference) + :ref:`Working with Problem Components` (reference) - :ref:`Advanced Editor` (reference) + :ref:`Gradebook Assignment Types` (reference) - :ref:`Feedback Best Practices` (concept) + :ref:`Feedback Best Practices` (concept) - :ref:`Learner View of Problems` (reference) + :ref:`Adding Feedback and Hints to a Problem` (reference) - :ref:`Configure Hint` (how-to) + :ref:`Configure Hint` (how-to) + + :ref:`Partial Credit` (reference) + + :ref:`Set the Assignment Type and Due Date for a Subsection` (how-to) + + :ref:`Adding Tooltips` (reference) + + :ref:`Learner View of Problems` (reference) + + :ref:`Advanced Editor` (reference) + + :ref:`Add Hints via the Advanced Editor` (how-to) + + :ref:`Modifying a Released Problem` (reference) + + :ref:`Add Unsupported Exercises Problems` (how-to) **Maintenance chart** diff --git a/source/educators/references/course_development/create_problem.rst b/source/educators/references/course_development/working_with_problem_components.rst similarity index 91% rename from source/educators/references/course_development/create_problem.rst rename to source/educators/references/course_development/working_with_problem_components.rst index be8b92078..28aaab687 100644 --- a/source/educators/references/course_development/create_problem.rst +++ b/source/educators/references/course_development/working_with_problem_components.rst @@ -15,7 +15,7 @@ and settings for problem components. :depth: 1 For information about specific problem types, and the other exercises and tools -that you can add to your course, see :ref:`Create Exercises`. +that you can add to your course, see :ref:`About Problems Exercises and Tools`. .. _Adding a Problem: @@ -72,12 +72,12 @@ types** or select Advanced problem types for a list of **advanced problem types* * For open response assessment problem types, you define the problem elements and options by using a graphical user interface. For more information, see - :ref:`PA Create an ORA Assignment`. + :ref:`Create an ORA Assignment`. * For drag-and-drop problem types, you build an interactive assessment in a customized interface in which you define areas that learners can drag into target zones on a background image. For more information, see - :ref:`Creating a Drag and Drop Problem`. + :ref:`Create a Drag and Drop Problem`. You can switch from the simple editor to the advanced editor at any time by selecting the **Switch to advanced editor** from the simple editor's settings. @@ -101,7 +101,7 @@ the simple editor. * :ref:`Dropdown` -* :ref:`Numerical Input` +* :ref:`Numerical Input` * :ref:`Text Input` @@ -254,21 +254,35 @@ Paste, see :ref:`Paste without Formatting in a Text Component`. .. seealso:: + :ref:`About Problems Exercises and Tools` (concept) - :ref:`Modifying a Released Problem` (reference) + :ref:`Core Problem Types` (reference) - :ref:`Advanced Editor` (reference) + :ref:`Guide to Problem Settings` (reference) - :ref:`Problem Settings` (reference) + :ref:`Gradebook Assignment Types` (reference) - :ref:`Feedback Best Practices` (concept) + :ref:`Feedback Best Practices` (concept) - :ref:`Learner View of Problems` (reference) + :ref:`Adding Feedback and Hints to a Problem` (reference) - :ref:`Partial Credit` (reference) + :ref:`Configure Hint` (how-to) - :ref:`Configure Hint` (how to) + :ref:`Partial Credit` (reference) + :ref:`Set the Assignment Type and Due Date for a Subsection` (how-to) + + :ref:`Adding Tooltips` (reference) + + :ref:`Learner View of Problems` (reference) + + :ref:`Advanced Editor` (reference) + + :ref:`Add Hints via the Advanced Editor` (how-to) + + :ref:`Modifying a Released Problem` (reference) + + :ref:`Add Unsupported Exercises Problems` (how-to) **Maintenance chart** diff --git a/source/educators/references/glossary.rst b/source/educators/references/glossary.rst index 712503cd5..87d4fcfd9 100644 --- a/source/educators/references/glossary.rst +++ b/source/educators/references/glossary.rst @@ -298,7 +298,7 @@ C A custom response problem evaluates text responses from learners using an embedded Python script. These problems are also called "write-your-own-grader" problems. For more information, see - :ref:`Write Your Own Grader`. + :ref:`About Custom Python-Evaluated Input Problem`. .. _D: @@ -415,7 +415,7 @@ E Practice or practical problems that are interspersed in edX course content to keep learners engaged. Exercises are also an important measure of teaching effectiveness and learner comprehension. For more information, see - :ref:`Create Exercises`. + :ref:`About Problems Exercises and Tools`. .. _Export: @@ -508,8 +508,7 @@ I **Image Mapped Input Problem** A problem that presents an image and accepts clicks on the image as an - answer. For more information, see :ref:`Image Mapped - Input`. + answer. For more information, see :ref:`About Image Mapped Input Problem`. .. _Import: @@ -678,7 +677,7 @@ N A problem that asks learners to enter numbers or specific and relatively simple mathematical expressions. For more information, see - :ref:`Numerical Input`. + :ref:`About Numerical Input`. .. _O: @@ -832,7 +831,7 @@ R A list of the items that a learner's response should cover in an open response assessment. For more information, see the - :ref:`PA Rubric` topic in :ref:`Open + :ref:`ORA Rubrics` topic in :ref:`Open Response Assessments`. See also :ref:`Open Response Assessment`. diff --git a/source/educators/references/grading/gradebook_assignment_types.rst b/source/educators/references/grading/gradebook_assignment_types.rst index 496b8c95c..0f68eaeab 100644 --- a/source/educators/references/grading/gradebook_assignment_types.rst +++ b/source/educators/references/grading/gradebook_assignment_types.rst @@ -84,14 +84,35 @@ You configure the following fields for each assignment type. .. seealso:: + :ref:`About Problems Exercises and Tools` (concept) - :ref:`Graded Subsections` (concept) + :ref:`Core Problem Types` (reference) - :ref:`The Learner View of Grades` (reference) + :ref:`Working with Problem Components` (reference) - :ref:`Set the Grade Range` (how-to) + :ref:`Guide to Problem Settings` (reference) - :ref:`Set the Grace Period` (how-to) + :ref:`Feedback Best Practices` (concept) + + :ref:`Adding Feedback and Hints to a Problem` (reference) + + :ref:`Configure Hint` (how-to) + + :ref:`Partial Credit` (reference) + + :ref:`Set the Assignment Type and Due Date for a Subsection` (how-to) + + :ref:`Adding Tooltips` (reference) + + :ref:`Learner View of Problems` (reference) + + :ref:`Advanced Editor` (reference) + + :ref:`Add Hints via the Advanced Editor` (how-to) + + :ref:`Modifying a Released Problem` (reference) + + :ref:`Add Unsupported Exercises Problems` (how-to) **Maintenance chart** diff --git a/source/educators/references/grading/learner_view_of_grades.rst b/source/educators/references/grading/learner_view_of_grades.rst index 4c70fea54..3f8d59c26 100644 --- a/source/educators/references/grading/learner_view_of_grades.rst +++ b/source/educators/references/grading/learner_view_of_grades.rst @@ -35,7 +35,7 @@ together, followed by labs, then exams. .. seealso:: - :ref:`Graded Subsections` (concept) + :ref:`About Graded Subsections` (concept) :ref:`Gradebook Assignment Types` (reference) diff --git a/source/educators/references/proctored_exams/online_proctoring_rules.rst b/source/educators/references/proctored_exams/online_proctoring_rules.rst index 2cbe65492..7123d872a 100644 --- a/source/educators/references/proctored_exams/online_proctoring_rules.rst +++ b/source/educators/references/proctored_exams/online_proctoring_rules.rst @@ -123,7 +123,7 @@ your request and make any adjustments before you start your exam. .. seealso:: - :ref:`ProctoredExams_Overview` (concept) + :ref:`About Proctored Exams` (concept) :ref:`Enable Proctored Exams` (how-to) diff --git a/source/educators/references/proctored_exams/pt_proctored_exam_report.rst b/source/educators/references/proctored_exams/pt_proctored_exam_report.rst index 239a15338..2bf069547 100644 --- a/source/educators/references/proctored_exams/pt_proctored_exam_report.rst +++ b/source/educators/references/proctored_exams/pt_proctored_exam_report.rst @@ -1,8 +1,8 @@ .. _PT Proctored Session Results File: -########################################### -Interpret the Proctored Exam Results Report -########################################### +######################################################## +Guide to Interpreting the Proctored Exam Results Report +######################################################## .. tags:: educator, reference @@ -209,7 +209,7 @@ column. .. seealso:: - :ref:`ProctoredExams_Overview` (concept) + :ref:`About Proctored Exams` (concept) :ref:`Enable Proctored Exams` (how-to) diff --git a/source/educators/references/proctored_exams/rpnow_proctored_exam_report.rst b/source/educators/references/proctored_exams/rpnow_proctored_exam_report.rst index ab81ab390..c969eddcd 100644 --- a/source/educators/references/proctored_exams/rpnow_proctored_exam_report.rst +++ b/source/educators/references/proctored_exams/rpnow_proctored_exam_report.rst @@ -1,8 +1,8 @@ .. _RPNow Proctored Session Results File: -########################################### -Interpret the Proctored Exam Results Report -########################################### +######################################################## +Guide to Interpreting the Proctored Exam Results Report +######################################################## .. tags:: educator, reference @@ -202,7 +202,7 @@ column. .. seealso:: - :ref:`ProctoredExams_Overview` (concept) + :ref:`About Proctored Exams` (concept) :ref:`Enable Proctored Exams` (how-to)