FC-0068 docs: how-tos review by edunext 16 (#764)

* FC-0068 docs: how-tos review by edunext 15 This PR modifies a series of how-tos documents migrated from the legacy repositories to the educators' documentation. * Update source/educators/how-tos/advanced_features/lti_prepare_content.rst Co-authored-by: Sarina Canelake <[email protected]> * Update source/educators/how-tos/course_development/add_custom_page.rst Co-authored-by: Sarina Canelake <[email protected]> * Update source/educators/how-tos/course_development/add_custom_page.rst Co-authored-by: Sarina Canelake <[email protected]> * Update source/educators/how-tos/course_development/enable_calculator.rst Co-authored-by: Sarina Canelake <[email protected]> * Update source/educators/how-tos/course_development/add_custom_page.rst Co-authored-by: Sarina Canelake <[email protected]> * Update source/educators/how-tos/course_development/enable_wiki.rst Co-authored-by: Sarina Canelake <[email protected]> * Update source/educators/how-tos/course_development/exercise_tools/create_zooming_image.rst Co-authored-by: Sarina Canelake <[email protected]> * Update source/educators/how-tos/course_development/exercise_tools/edit_text_input_advanced.rst Co-authored-by: Sarina Canelake <[email protected]> * Update source/educators/how-tos/course_development/reorder_deleting_custom_pages.rst Co-authored-by: Sarina Canelake <[email protected]> * Update timed_exams.rst * fix commit errors --------- Co-authored-by: Sarina Canelake <[email protected]>
openedx · Jan 14, 2025 · 9da48c9 · 9da48c9
1 parent 9481196
commit 9da48c9
Show file tree

Hide file tree

Showing 15 changed files with 476 additions and 312 deletions.
diff --git a/source/educators/how-tos/advanced_features/lti_prepare_content.rst b/source/educators/how-tos/advanced_features/lti_prepare_content.rst
@@ -1,13 +1,11 @@
 .. _Create a Duplicate Course for LTI use:
 
-######################################
 Create a Duplicate Course for LTI use
 ######################################
 
 .. tags:: educator, how-to
 
-.. note:: This feature was a closed pilot experiment. This feature is not
- supported for new users.
+.. warning:: This feature was a closed pilot experiment. This feature is poorly documented and may not work properly.
 
 Before you create a duplicate course, be sure to check with your DevOps team
 to determine the website that hosts your organization's courses for LTI use.
@@ -24,31 +22,31 @@ To create the duplicate course, follow these steps.
     original course and for LTI courses, be sure to give the duplicate course a
     different name or run.
 
-#. In the duplicate course, import the tar.gz file that you exported in step 1.
+#. In the duplicate course, import the tar.gz file you exported in step 1.
    For more information, see :ref:`Import a Course`.
 
 .. future: add re-run as an option for sites that host courses for LTI on the same instance (edit from Mark, Phil says re-run should work). - Alison 1 Sep 2015
 
-*******************************
+
 Verify Content Status
 *******************************
 
-Only edX course content that is published appears in an external LMS.
+Only the published course content from your Open edX instance appears in an external LMS.
 
 .. note:: The **Hide from students** setting for sections, subsections,
  and units does not affect the visibility of content in an external LMS. Only
  the publication status of a unit can prevent content from being included.
 
-To verify that all of the content in your edX course is published, follow these
+To verify that all of the content in your course is published, follow these
 steps.
 
 #. In Studio, from the **Content** menu select **Outline**. The **Course
    Outline** page opens.
 
 #. Expand each section and subsection.
 
-#. Locate units with "Unpublished units will not be released" or "Unpublished
-   changes to live content" below the unit name.
+#. Locate units with *Unpublished units will not be released* or *Unpublished
+   changes to live content* below the unit name.
 
 #. For each unpublished unit, make any changes that are necessary to prepare
    the content for publication. Alternatively, delete the unit.
@@ -64,6 +62,8 @@ steps.
 
  :ref:`Planning for Content Reuse (LTI)<Planning for Content Reuse>` (reference)
 
- :ref:`Example: Open edX as an LTI Provider to Canvas<Open edX as an LTI Provider to Canvas>` (reference)
+ :ref:`Open edX as an LTI Provider to Canvas` (how-to)
+
+ :ref:`Open edX as an LTI Provider to Blackboard` (how-to)
+
 
- :ref:`Example: edX as an LTI Provider to Blackboard<Open edX as an LTI Provider to Blackboard>` (reference)
diff --git a/source/educators/how-tos/advanced_features/timed_exams.rst b/source/educators/how-tos/advanced_features/timed_exams.rst
@@ -6,6 +6,10 @@ Configure Timed Exams
 
 .. tags:: educator, how-to
 
+.. contents::
+  :local:
+  :depth: 1
+
 .. _Enable Timed Exams:
 
 *******************
@@ -20,15 +24,15 @@ is set to be a "timed" exam, and set it to "none".
 
    The **Enable Timed Exams** field is now deprecated in the
    **Advanced Settings** page. If you want to access the field, you'll need
-   to click on the "Show Deprecated Settings" button on the **Advanced Settings**
+   to click on the **Show Deprecated Settings** button on the **Advanced Settings**
    page.
 
 
 *****************************
 Set a Subsection to be Timed
 *****************************
 
-Ensure that you have enabled timed exams in the course. Then follow these
+Ensure you have enabled timed exams in the course. Then follow these
 steps.
 
 #. Add and :ref:`develop a subsection <Developing Course Subsections>` as you
@@ -47,23 +51,18 @@ steps.
 
 #. Select the **Advanced** tab.
 
-   .. only:: Open_edX
-
-    If the **Settings** dialog box does not contain the **Advanced** tab, timed
-    exams might not be enabled for your Open edX site. Enabling timed exams for
-    an Open edX site is a task that is usually performed by a system
-    administrator. For more information, see :ref:`Enable Timed
-    Exams` in *Installing, Configuring, and Running the Open edX Platform*.
+   If the **Settings** dialog box does not contain the **Advanced** tab, timed
+   exams might not be enabled for your Open edX site. Enabling timed exams for
+   an Open edX site is a task that a system administrator usually performs.
 
 #. In the **Set as a Special Exam** section, select **Timed**.
 
-   .. only:: Partners
+   If your course has the proctored exam feature enabled, the
+   **Advanced** tab also shows options for :ref:`proctored and practice
+   proctored exams<Preparing Learners for Proctored Exams>`.
 
-     If your course has the proctored exam feature enabled, the
-     **Advanced** tab also shows options for :ref:`proctored and practice
-     proctored exams<ProctoredExams_Overview>`.
 
-#. In the **Time Allotted** field, enter the length of time that you want
+#. In the **Time Allotted** field, enter the length of time  you want
    learners to have to complete the problems in the subsection. Enter the time
    as HH:MM, where HH is hours and MM is minutes.
 
@@ -93,21 +92,20 @@ extra time to complete a timed or proctored exam.
 
    The **Add a New Allowance** dialog box opens.
 
-#. For **Username** or **Email**, enter all the learners' emails/usernames seperated by a comma that you wish to add an exception for.
+#. For **Username** or **Email**, enter all the learners' emails/usernames you wish to add an exception for seperated by a comma .
 
 #. For **Select Exam Type**, select the type of exams you want to add extra time for, either proctored or timed exams.
 
 #. For **Select Exams**, click on the desired exams you want extra time for.
 
 #. For **Allowance Type**, select either **Additional Time** or **Time Multiplier**
 
-#. If you selected **Additional Time**, enter the number of extra minutes that you
+#. If you selected **Additional Time**, enter the number of extra minutes you
    want to grant to the learner.
 
    .. note:: You must enter a whole number greater than 0.
 
-#. Otherwise if you selected **Time Multiplier**, enter the multiplier for how much total time you want the learners to have.
-For example for an exam of 30 minutes, a multiplier of 1.5 will give 15 extra minutes to each learner.
+#. Otherwise if you selected **Time Multiplier**, enter the multiplier for how much total time you want the learners to have. For example for an exam of 30 minutes, a multiplier of 1.5 will give 15 extra minutes to each learner.
 
    .. note:: You must enter a number greater than 1.
 
@@ -130,11 +128,6 @@ can allow them to resume the exam with their answers and time remaining saved.
    This option is only available if a learner's exam attempt is in an **Error**
    state. This can be seen by following the directions below.
 
-.. note::
-   Onboarding and practice exams can be self-service reset by the learner. See
-   `Checking Your Onboarding Status and Resetting Your Onboarding Exam`_ in the
-   edX Help Center.
-
 To allow a learner to resume a timed or proctored exam attempt, follow these
 steps.
 
@@ -146,7 +139,7 @@ steps.
 #. In the **Exam Name** column, locate the name of the specific exam for which
    you are resuming the learner's exam attempt.
 #. In the **Actions** column, click the gear icon (⚙) and select **Resume**.
-   A message displays asking you to confirm that you want to resume the learner's
+   A message displays asking you to confirm you want to resume the learner's
    exam attempt.
 #. Select **OK**. The learner's exam attempt status will change from **Error**
    to **Ready to Resume**, and they will be able to access the exam again.
@@ -176,7 +169,7 @@ To clear a timed or proctored exam attempt, follow these steps.
 #. In the **Exam Name** column, locate the name of the specific exam for which
    you are cleaning the learner's exam attempt.
 #. In the **Actions** column, select **Reset**. A message displays asking you
-   to confirm that you want to remove the learner's exam attempt.
+   to confirm you want to remove the learner's exam attempt.
 
    .. note::
       If the learner's exam attempt is in an error state, there will be a gear
@@ -204,7 +197,7 @@ affected, and their scores for the exam remain visible on the **Progress** page.
 
 
 #. In Studio, select the **Configure** icon for the timed exam (subsection)
-   that you want to configure.
+   you want to configure.
 
    The **Settings** dialog box opens to the **Basic** tab.
 
@@ -214,3 +207,9 @@ affected, and their scores for the exam remain visible on the **Progress** page.
 
 #. Select **Save**.
 
+
+.. seealso::
+ :class:dropdown
+
+ :ref:`Timed Exams` (concept)
+
diff --git a/source/educators/how-tos/course_development/add_custom_page.rst b/source/educators/how-tos/course_development/add_custom_page.rst
@@ -0,0 +1,70 @@
+.. _Add Custom Page:
+
+Add Custom Page Resources
+#############################
+
+.. tags:: educator, how-to
+
+You can customize your course by adding pages. Each page that you add appears in the navigation
+bar for your course. When you add a page, you add its content using an HTML editor.
+The following example shows the navigation bar for a course that has added a custom page named Syllabus.
+
+    .. image:: /_images/educator_how_tos/lms_navigation_bar.png
+     :width: 500
+     :alt: The navigation bar in the LMS, showing a custom page named Syllabus.
+
+When you add a page, you can specify whether it and its content are visible only to course team
+members who have the Admin or Staff role, or to all enrolled learners as well as the course team.
+For more information about assigning course team roles, see :ref:`Course_Staffing`.
+
+If you add a custom page to a course after its start date, and have specified that the page should
+be visible to learners, the page is visible in the LMS as soon as you save your work.
+
+As a best practice, be sure the following aspects of your page design are ready before you add a page
+in Studio.
+
+* The content for the page, which can include HTML markup.
+* The name of the page.
+* The audience for the page (everyone, or course team members with the Admin or Staff roles only).
+
+To add a custom page and its content to your course, follow these steps.
+
+#. In Studio, from the **Content** menu select **Pages & Resources**.
+#. Select the **Custom Pages** card on this page.
+#. Click **New Page**, which prompts the system to add a page named **Empty** to the end of the list.
+#. In the row for the new page, select **Edit**. The :ref:`visual editor<The Visual Editor>` opens.
+#. Enter the content for your page.
+
+    To add HTML tags to your content, select HTML to open the :ref:`the raw HTML editor<The Raw HTML Editor>`.
+    For more information about entering content, see :ref:`Options for Editing Text Components`.
+
+    .. note:: If you copy text from another source and paste it into the visual editor, be sure to proofread the result carefully. Some applications automatically change quotation marks and apostrophes from the “straight” version to the “smart” or “curly” version. The raw HTML editor requires “straight” quotation marks and apostrophes.
+
+#. To rename the page, select Settings, and then enter a Display Name. The display name is the label that course participants use in the course navigation bar.
+#. To hide the page from learners, select **Settings**, and then select true for **Hide Page from Learners**. By default, pages are visible to learners.
+#. Select **Save**.
+
+The new page is immediately available to the specified audience if the course has started.
+
+For details on reordering course pages, see additional detail in :ref:`Reordering and deleting custom pages`.
+
+.. seealso::
+ :class: dropdown
+
+ :ref:`Adding Pages to a Course` (how to)
+
+ :ref:`Enable Notes` (how to)
+
+ :ref:`Enable Teams` (how to)
+
+ :ref:`Enable Wiki` (how to)
+
+ :ref:`Enable Calculator` (how to)
+
+ :ref:`Enable Textbook` (how to)
+
+ :ref:`Reordering and deleting custom pages` (how to)
+
+ :ref:`Configure Resources` (how to)
+
+ :ref:`Adding Textbooks` (how to)