FC-0068 docs: how-to cleaning by edunext #19

source/educators/how-tos/add_dropdown.rst

@@ -1,8 +1,27 @@
+.. _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
+.. youtube:: e6HxKo18_xE
+
+.. seealso::
+  :class: dropdown
+
+  :ref:`Single Select Overview` (concept)
+
+  :ref:`Multiple Choice` (reference)
+
+  :ref:`Single Select` (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:`Single Select Problem XML` (reference)
+
+  :ref:`Add a Multiple Choice Problem` (how-to)

source/educators/how-tos/add_multiple_choice.rst

@@ -1,3 +1,5 @@
+.. _Add a Multiple Choice Problem:
+
 Add a Multiple Choice Problem
 #############################
 

source/educators/how-tos/course_development/exercise_tools/add_recommenderXBlock.rst

@@ -1,8 +1,7 @@
 .. _RecommenderXBlock:
 
-##################
 Recommender Tool
-##################
+################
 
 .. tags:: educator, how-to
 
@@ -14,9 +13,8 @@ and the learners.
   :local:
   :depth: 2
 
-***********
 Overview
-***********
+********
 
 The most common use of the recommender is for remediation of errors and
 misconceptions, followed by providing additional, more advanced resources.
@@ -54,9 +52,8 @@ assure that they are accessible before making them available through your
 course. For more information, see :ref:`Accessibility Best Practices for Course
 Content Development`.
 
-**************************************************
 Enable the Recommender Tool
-**************************************************
+***************************
 
 Before you can add a recommender component to your course, you must enable the
 recommender tool in Studio.
@@ -66,9 +63,8 @@ the **Advanced Module List** on the **Advanced Settings** page. (Be sure to
 include the quotation marks around the key value.) For more information, see
 :ref:`Enable Additional Exercises and Tools`.
 
-********************************
 Add a Recommender
-********************************
+*****************
 
 To add a recommender to a course, follow these steps.
 
@@ -87,8 +83,9 @@ To add a recommender to a course, follow these steps.
      sees the recommender, there will be a short guided tutorial.
 
    * Whether to disable the user interface functions which are under
-     development. Because these are untested and under development, please leave
-     these disabled unless otherwise advised by edX staff.
+     development. Because these are untested and under development, please
+     leave these disabled unless your Open edX instance requieres another
+     settings.
 
    * How many resources you want to show in each page of the resource list.
 
@@ -98,4 +95,15 @@ To add a recommender to a course, follow these steps.
 
 #. Select **Save**.
 
-#. Optionally, open the unit in the LMS and suggest some resources.
+#. Optionally, open the unit in the LMS and suggest some resources.
+
+.. seealso::
+ :class: dropdown
+
+ :ref:`Notes Tool` (how-to)
+
+ :ref:`Annotation` (how-to)
+
+ :ref:`Calculator` (how-to)
+
+ :ref:`Enable Completion` (how-to)

source/educators/how-tos/course_development/exercise_tools/add_single_select.rst

@@ -1,23 +1,10 @@
 .. _Single Select:
 
-#####################
-Single Select Problem
-#####################
+Add a Single Select Problem
+###########################
 
 .. tags:: educator, how-to
 
-The single select problem type is a simple problem type that can be added to
-any course. At a minimum, single select problems include a question or
-prompt and several answer options. By adding hints, feedback, or both, you can
-give learners guidance and help when they work on a problem.
-
-For more information about the simple problem types, see
-:ref:`Working with Problem Components`.
-
-******************************
-Adding a Single Select Problem
-******************************
-
 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.
@@ -43,17 +30,14 @@ Creating a single select problem is as simple as:
 If you have any questions on the specifics of using the simple editor, please check
 out :ref:`Simple Editor` and :ref:`Problem Settings`.
 
-Note
-
 .. 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
   more than one of the checkboxes in the Answers section.
 
 .. _Use Feedback in a Single Select Problem:
 
-===============
 Adding Feedback
-===============
+***************
 
 For an overview of feedback in problems, see :ref:`Adding Feedback and Hints to
 a Problem`. You can add feedback for each of the answer options you provide in
@@ -84,9 +68,8 @@ learner submits this answer.
 
 .. _Use Hints in a Single Select Problem:
 
-============
 Adding Hints
-============
+************
 
 You can add hints to a single select problem . For an overview of hints in
 problems, see :ref:`Adding Feedback and Hints to a Problem`.
@@ -98,6 +81,6 @@ problems, see :ref:`Adding Feedback and Hints to a Problem`.
 
  :ref:`Single Select Problem XML` (reference)
 
- :ref:`Awarding Partial Credit in a Multiple Choice Problem` (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:`Editing Single Select Problems using the Advanced Editor` (how-to)

source/educators/how-tos/course_development/exercise_tools/add_single_select_num_input.rst

@@ -1,8 +1,7 @@
 .. _Single Select and Numerical Input:
 
-############################################
-Single Select and Numerical Input Problem
-############################################
+Add a Single Select and Numerical Input Problem
+###############################################
 
 .. tags:: educator, how-to
 
@@ -16,31 +15,29 @@ but also provide more specific information, if necessary.
 .. note::
  Currently, students can only enter numerals in the text field. Students
  cannot enter words or mathematical expressions, which might be confusing to
- students who are accustomed to other edX numerical input fields.
+ students who are accustomed to other Open edX numerical input fields.
 
  You can make a calculator available to your learners on every unit
  page. For more information, see :ref:`Calculator`.
 
 .. _Create an MCNI Problem:
 
-********************************************************
 Create a Single Select and Numerical Input Problem
-********************************************************
+**************************************************
 
 To create a single select and numerical input problem, follow these steps.
 
 #. In the unit where you want to create the problem, click **Problem** under
    **Add New Component**.
-#. Clicke ** Advanced problem types**. Then click **Blank Advanced Problem**.
+#. Click in **Advanced problem types**. Then click **Blank Advanced Problem**.
 #. In the component editor, paste the code from below.
 #. Replace the example problem and response options with your own text.
 #. Click **Save**.
 
 .. _MCNI Problem Code:
 
-************************************************
 Single Select and Numerical Input Problem Code
-************************************************
+**********************************************
 
 .. code-block:: xml
 
@@ -52,4 +49,15 @@ Single Select and Numerical Input Problem Code
         <choice correct="true">False. The correct value is <numtolerance_input answer="3.14"/>.</choice>
       </radiotextgroup>
     </choicetextresponse>
-  </problem>
+  </problem>
+
+.. seealso::
+ :class: dropdown
+
+ :ref:`Numerical Input` (reference)
+
+ :ref:`Adding Numerical Input Problem` (how-to)
+
+ :ref:`Single Select Overview` (concept)
+
+ :ref:`Single Select` (how-to)

source/educators/how-tos/course_development/exercise_tools/award_partial_credit_multiple_choice.rst

@@ -1,15 +1,13 @@
 .. _Awarding Partial Credit in a Multiple Choice Problem:
 
-=======================
-Awarding Partial Credit
-=======================
+Award Partial Credit in a Multiple Choice Problem
+#################################################
 
 .. tags:: educator, how-to
 
 You can configure a single select problem so that specific incorrect answers
 award learners partial credit for the problem.
 
-
 In the following example, the learner selected a wrong answer and received
 partial credit.
 
@@ -59,9 +57,8 @@ provides partial credit of 25% for an answer option.
 
 .. _Shuffle Answers in a Single Select Problem:
 
-===============
 Shuffle Answers
-===============
+***************
 
 Optionally, you can configure a single select problem so that it shuffles
 the order of possible answers.
@@ -123,9 +120,8 @@ Then, you select **Settings** to specify an option other than **Never** for the
 
 .. _Answer Pools in a Single Select Problem:
 
-============
 Answer Pools
-============
+************
 
 You can configure a single select problem so that a random subset of choices
 are shown to each learner. For example, you can add 10 possible choices to the
@@ -202,8 +198,8 @@ explanation ID.
 
  :ref:`Single Select Overview` (concept)
 
- :ref:`Single Select` (how to)
+ :ref:`Single Select` (how-to)
 
  :ref:`Single Select Problem XML` (reference)
 
- :ref:`Editing Single Select Problems using the Advanced Editor` (how to)
+ :ref:`Editing Single Select Problems using the Advanced Editor` (how-to)

source/educators/how-tos/course_development/exercise_tools/edit_single_select_advanced.rst

@@ -1,8 +1,7 @@
 .. _Editing Single Select Problems using the Advanced Editor:
 
-********************************************************
-Editing Single Select Problems using the Advanced Editor
-********************************************************
+Edit Single Select Problems using the Advanced Editor
+#####################################################
 
 .. tags:: educator, how-to
 
@@ -53,9 +52,8 @@ You can see the OLX for the example problem from the Overview section below.
   changes you make in the advanced editor, you may not be able to cannot
   switch back to the simple editor.
 
-===============
 Adding Feedback
-===============
+***************
 
 In the advanced editor, you configure feedback with the following syntax.
 
@@ -97,9 +95,8 @@ For example, the following problem has feedback for each answer.
 
 .. _Targeted Feedback in a Single Select Problem:
 
------------------
 Targeted Feedback
------------------
+=================
 
 You can configure a single select problem so that explanations for specific
 answers are automatically shown to learners. You can use these explanations to
@@ -175,9 +172,8 @@ targeted feedback.
     </targetedfeedbackset>
   </problem>
 
-============
 Adding Hints
-============
+************
 
 You can add hints to a single select problem . For an overview of hints in
 problems, see :ref:`Adding Feedback and Hints to a Problem`.
@@ -187,8 +183,8 @@ problems, see :ref:`Adding Feedback and Hints to a Problem`.
 
  :ref:`Single Select Overview` (concept)
 
- :ref:`Single Select` (how to)
+ :ref:`Single Select` (how-to)
 
  :ref:`Single Select Problem XML` (reference)
 
- :ref:`Awarding Partial Credit in a Multiple Choice Problem` (how to)
+ :ref:`Awarding Partial Credit in a Multiple Choice Problem` (how-to)