diff --git a/source/educators/how-tos/advanced_features/lti_prepare_content.rst b/source/educators/how-tos/advanced_features/lti_prepare_content.rst index 52f7e1b6..90b57773 100644 --- 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,22 +22,22 @@ 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 @@ -47,8 +45,8 @@ steps. #. 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)` (reference) - :ref:`Example: 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` (reference) diff --git a/source/educators/how-tos/advanced_features/timed_exams.rst b/source/educators/how-tos/advanced_features/timed_exams.rst index 7eb855bc..7c851c76 100644 --- 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,7 +24,7 @@ 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. @@ -28,7 +32,7 @@ is set to be a "timed" exam, and set it to "none". 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 ` 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`. - If your course has the proctored exam feature enabled, the - **Advanced** tab also shows options for :ref:`proctored and practice - proctored exams`. -#. 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,7 +92,7 @@ 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. @@ -101,13 +100,12 @@ extra time to complete a timed or proctored exam. #. 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 new file mode 100644 index 00000000..fe100ebb --- /dev/null +++ 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` opens. +#. Enter the content for your page. + + To add HTML tags to your content, select HTML to open the :ref:`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) diff --git a/source/educators/how-tos/course_development/add_pages.rst b/source/educators/how-tos/course_development/add_pages.rst index 1c9e8fc9..a878bd4d 100644 --- a/source/educators/how-tos/course_development/add_pages.rst +++ b/source/educators/how-tos/course_development/add_pages.rst @@ -39,13 +39,13 @@ As a course team member with the **Staff** or **Admin** role, you also see the I option in the navigation bar, shown at the end of the list of pages. Learners do not see the Instructor option. - .. note:: - The progress page can be disabled and thus hidden from the learner experience, - though this is not commonly done and is not recommended. The information on - the Progress page is critical for motivating learners, particularly in courses - that include graded subsections, but also for courses that include only ungraded - exercises. Before choosing to hide the Progress page for your course, consider - the possible effect on learner engagement. +.. note:: + The progress page can be disabled and thus hidden from the learner experience, + though this is not commonly done and is not recommended. The information on + the Progress page is critical for motivating learners, particularly in courses + that include graded subsections, but also for courses that include only ungraded + exercises. Before choosing to hide the Progress page for your course, consider + the possible effect on learner engagement. .. _Enable Additional Resource: @@ -55,204 +55,30 @@ Enabling Additional Applications & Resources Additional applications and resources can be enabled depending on your course needs, including: -* Notes -* Teams -* Wiki -* Calculator -* Textbooks -* Custom Pages +* :ref:`Notes` +* :ref:`Teams` +* :ref:`Wiki` +* :ref:`Calculator` +* :ref:`Textbooks` +* :ref:`Custom Pages` -.. _Enable Notes: - -============================== -Enabling the Notes Application -============================== - -The notes application can be optionally enabled to allow learners to easily create organized -text notes for any text, problem, or video transcript content within a course. These notes are -then centrally stored for review in the Notes area of the course - -To disable or enable the Notes application, follow these steps. - -#. In Studio, from the **Content** menu select **Pages & Resources**. - -#. Click the gear icon on the **Notes** card shown on this page. - -#. From the **Configure notes** modal, select the toggle to enable or disable the notes application. - -#. Select **Apply** to save your configuration changes. - -.. _Enable Teams: - -============================== -Enabling the Teams Application -============================== - -When you create a course, the teams application can be optionally enabled to provide a -mechanism for instructor and learner-driven team formation or assignment. - -To disable or enable the Teams application, follow these steps. - -#. In Studio, from the **Content** menu select **Pages & Resources**. - -#. Click the gear icon on the **Teams** card shown on this page. - -#. From the **Configure teams** modal, select the toggle to enable or disable the teams application. - -#. Select **Apply** to save your configuration changes. - -Additional configuration for the Teams application can be found at :ref:`11.3.3.3 Configuring the Teams application` - - -.. _Enable Wiki: - -============================= -Enabling the Wiki Application -============================= - -When you create a course, a wiki can be optionally enabled to create and share resources that can be edited and updated by any course team member or learner. - -To disable or enable the Wiki application, follow these steps. - -#. In Studio, from the **Content** menu select **Pages & Resources**. - -#. Click the gear icon on the **Wiki** card shown on this page. - -#. From the **Configure Wiki** modal, select the toggle to enable or disable the wiki. - -#. Select **Apply** to save your configuration changes. - -When you disable the wiki application in your course, any existing articles remain in the edX- wide wiki, but the Wiki page is removed from your course pages. - -Additional details for configuring the wiki application can be found at :ref:`11.3.3.2 Configuring the wiki application`. - -.. _Enable Calculator: - -================================ -Enabling the Calculator Resource -================================ -Courses can optionally render a calculator resource that helps learners use an in-platform -tool for mathematical operations and computations. - -To disable or enable the Calculator resource, follow these steps. - -#. In Studio, from the **Content** menu select **Pages & Resources**. - -#. Click the gear icon on the **Calculator** card shown on this page. - -#. From the **Configure calculator** modal, select the toggle to enable or disable the calculator. - -#. Select **Apply** to save your configuration changes. - -.. _Add Page: - -.. _Add Custom Page: - -============================ -Adding Custom Page Resources -============================ - -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 also 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` opens. -#. Enter the content for your page. - - To add HTML tags to your content, select HTML to open the :ref:`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:`11.3.4. Reordering and Deleting Custom Pages`. - -.. _Enable Textbook: - -================================ -Enabling the Textbooks Resources -================================ - -You can add textbooks in PDF format to your course using the Textbooks resource area. Each textbook that -you add is displayed to learners as a page, or tab, in the course navigation bar. - - .. note:: Do not use image files (for example, .png files) as textbooks for your course, because they are not accessible to learners who use screen readers. For more information, review :ref:`Creating Accessible PDFs`. - -To add a textbook resource to your course, follow these steps. - -#. In Studio, from the **Content** menu select **Pages & Resources**. -#. Select the **Textbooks** card on this page. -#. Select either **Add your first textbook** or **New Textbook**. -#. On the page that opens, enter the **Textbook Name**. -#. Enter the **Chapter Name**. -#. Next to **Chapter Asset**, select **Upload PDF** to upload a PDF from your computer, and then follow the prompts to upload your file. -#. To add more chapters, select **Add a Chapter** and repeat steps 5 and 6. -#. Select **Save**. - - .. note:: When you add a textbook to your course, Studio automatically adds each PDF file that you upload to the Files & Uploads page. EdX recommends that you upload a separate PDF for each chapter of your textbook. When learners open the textbook page in the course, they can navigate the textbook by chapter. - -You can delete a custom textbook from your course using the delete icon shown on each textbook from the Textbooks -Studio page. It is also possible to delete a specific chapter from a textbook when editing a textbook using -the close icon to the right of each listed chapter. - - .. note:: After you delete your textbook on the Textbooks page, edX strongly recommends that you :ref:`lock ` or :ref:`delete ` the PDF files for the textbook on the Files & Uploads page to avoid copyright issues. - - -.. _Reordering and deleting custom pages: - -************************************ -Reordering and Deleting Custom Pages -************************************ - -For instructions on how to add custom pages see :ref:`11.3.2.5 Adding Custom Page Resources`. - -You can reorder the custom pages in your course in the same way that you :ref:`reorganize the course outline`: -you drag a page to a different location in the list of pages and drop it there. +.. seealso:: + :class: dropdown -.. note:: All default course pages (Course, Progress, Dates, Discussion) and optional course applications (Notes, Teams, Wiki) appear in the navigation before any configured custom page resources. If you have configured any textbook resources, these are listed after custom pages. + :ref:`Enable Notes` (how to) -To reorder the pages, follow these steps. + :ref:`Enable Teams` (how to) -#. In Studio, from the **Content** menu select **Pages & Resources**. -#. Select the **Custom Pages** card on this page. -#. On the list of pages, each page that you can move includes a Drag to reorder icon. -#. Move your pointer over the Drag to reorder icon for the page. Your pointer changes to a four-headed arrow. -#. Click and drag the page to the new location, and then release. + :ref:`Enable Wiki` (how to) + + :ref:`Enable Calculator` (how to) -You can also delete a custom page from your course using the delete icon shown on each custom page from the **Custom Pages** Studio page. -If you delete a page after the course start date, note that the visibility of the page in the learner experience changes immediately. + :ref:`Enable Textbook` (how to) -.. seealso:: - :class: dropdown + :ref:`Add Custom Page` (how to) + :ref:`Reordering and deleting custom pages` (how to) + :ref:`Configure Resources` (how to) :ref:`Adding Textbooks` (how to) diff --git a/source/educators/how-tos/course_development/enable_calculator.rst b/source/educators/how-tos/course_development/enable_calculator.rst new file mode 100644 index 00000000..ae7ae904 --- /dev/null +++ b/source/educators/how-tos/course_development/enable_calculator.rst @@ -0,0 +1,40 @@ +.. _Enable Calculator: + +Enable the Calculator Resource +################################# + +.. tags:: educator, how-to + +Courses can optionally render a calculator resource that helps learners use an in-platform +tool for mathematical operations and computations. + +To disable or enable the Calculator resource, follow these steps. + +#. In Studio, from the **Content** menu select **Pages & Resources**. + +#. Click the gear icon on the **Calculator** card shown on this page. + +#. From the **Configure calculator** modal, select the toggle to enable or disable the calculator. + +#. Select **Apply** to save your configuration changes. + +.. 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 Textbook` (how to) + + :ref:`Add Custom Page` (how to) + + :ref:`Reordering and deleting custom pages` (how to) + + :ref:`Configure Resources` (how to) + + :ref:`Adding Textbooks` (how to) \ No newline at end of file diff --git a/source/educators/how-tos/course_development/enable_notes.rst b/source/educators/how-tos/course_development/enable_notes.rst new file mode 100644 index 00000000..5b9eec84 --- /dev/null +++ b/source/educators/how-tos/course_development/enable_notes.rst @@ -0,0 +1,41 @@ +.. _Enable Notes: + +Enabling the Notes Application +############################### + +.. tags:: educator, how-to + +The notes application can be optionally enabled to allow learners to easily create organized +text notes for any text, problem, or video transcript content within a course. These notes are +then centrally stored for review in the Notes area of the course + +To disable or enable the Notes application, follow these steps. + +#. In Studio, from the **Content** menu select **Pages & Resources**. + +#. Click the gear icon on the **Notes** card shown on this page. + +#. From the **Configure notes** modal, select the toggle to enable or disable the notes application. + +#. Select **Apply** to save your configuration changes. + +.. seealso:: + :class: dropdown + + :ref:`Adding Pages to a Course` (how to) + + :ref:`Enable Teams` (how to) + + :ref:`Enable Wiki` (how to) + + :ref:`Enable Calculator` (how to) + + :ref:`Enable Textbook` (how to) + + :ref:`Add Custom Page` (how to) + + :ref:`Reordering and deleting custom pages` (how to) + + :ref:`Configure Resources` (how to) + + :ref:`Adding Textbooks` (how to) diff --git a/source/educators/how-tos/course_development/enable_teams.rst b/source/educators/how-tos/course_development/enable_teams.rst new file mode 100644 index 00000000..ee58a936 --- /dev/null +++ b/source/educators/how-tos/course_development/enable_teams.rst @@ -0,0 +1,43 @@ +.. _Enable Teams: + +Enabling the Teams Application +############################### + +.. tags:: educator, how-to + +When you create a course, the teams application can be optionally enabled to provide a +mechanism for instructor and learner-driven team formation or assignment. + +To disable or enable the Teams application, follow these steps. + +#. In Studio, from the **Content** menu select **Pages & Resources**. + +#. Click the gear icon on the **Teams** card shown on this page. + +#. From the **Configure teams** modal, select the toggle to enable or disable the teams application. + +#. Select **Apply** to save your configuration changes. + +Additional configuration for the Teams application can be found at :ref:`Teams Configuration`. + + +.. seealso:: + :class: dropdown + + :ref:`Adding Pages to a Course` (how to) + + :ref:`Enable Notes` (how to) + + :ref:`Enable Wiki` (how to) + + :ref:`Enable Calculator` (how to) + + :ref:`Enable Textbook` (how to) + + :ref:`Add Custom Page` (how to) + + :ref:`Reordering and deleting custom pages` (how to) + + :ref:`Configure Resources` (how to) + + :ref:`Adding Textbooks` (how to) diff --git a/source/educators/how-tos/course_development/enable_textbook.rst b/source/educators/how-tos/course_development/enable_textbook.rst new file mode 100644 index 00000000..3ef47473 --- /dev/null +++ b/source/educators/how-tos/course_development/enable_textbook.rst @@ -0,0 +1,51 @@ +.. _Enable Textbook: + +Enabling the Textbooks Resources +################################# + +.. tags:: educator, how-to + +You can add textbooks in PDF format to your course using the Textbooks resource area. Each textbook that +you add is displayed to learners as a page, or tab, in the course navigation bar. + +.. note:: Do not use image files (for example, .png files) as textbooks for your course, because they are not accessible to learners who use screen readers. For more information, review :ref:`Creating Accessible PDFs`. + +To add a textbook resource to your course, follow these steps. + +#. In Studio, from the **Content** menu select **Pages & Resources**. +#. Select the **Textbooks** card on this page. +#. Select either **Add your first textbook** or **New Textbook**. +#. On the page that opens, enter the **Textbook Name**. +#. Enter the **Chapter Name**. +#. Next to **Chapter Asset**, select **Upload PDF** to upload a PDF from your computer, and then follow the prompts to upload your file. +#. To add more chapters, select **Add a Chapter** and repeat steps 5 and 6. +#. Select **Save**. + +.. note:: When you add a textbook to your course, Studio automatically adds each PDF file that you upload to the **Files & Uploads page**. The recommendation is that you upload a separate PDF for each textbook chapter. When learners open the textbook page in the course, they can navigate the textbook by chapter. + +You can delete a custom textbook from your course using the delete icon shown on each textbook from the Textbooks +Studio page. It is also possible to delete a specific chapter from a textbook when editing a textbook using +the close icon to the right of each listed chapter. + +.. note:: After you delete your textbook on the Textbooks page, it is strongly recommended that you :ref:`lock ` or :ref:`delete ` the PDF files for the textbook on the Files & Uploads page to avoid copyright issues. + +.. 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:`Add Custom Page` (how to) + + :ref:`Reordering and deleting custom pages` (how to) + + :ref:`Configure Resources` (how to) + + :ref:`Adding Textbooks` (how to) \ No newline at end of file diff --git a/source/educators/how-tos/course_development/enable_wiki.rst b/source/educators/how-tos/course_development/enable_wiki.rst new file mode 100644 index 00000000..57304ac7 --- /dev/null +++ b/source/educators/how-tos/course_development/enable_wiki.rst @@ -0,0 +1,43 @@ +.. _Enable Wiki: + +Enable the Wiki Application +############################### + +.. tags:: educator, how-to + +When you create a course, a wiki can be optionally enabled to create and share resources that can be edited and updated by any course team member or learner. + +To disable or enable the Wiki application, follow these steps. + +#. In Studio, from the **Content** menu select **Pages & Resources**. + +#. Click the gear icon on the **Wiki** card shown on this page. + +#. From the **Configure Wiki** modal, select the toggle to enable or disable the wiki. + +#. Select **Apply** to save your configuration changes. + +When you disable the wiki application in your course, any existing articles remain in the wide wiki of your Open edX instance, but the Wiki page is removed from your course pages. + +Additional details for configuring the wiki application can be found at :ref:`Wiki Configuration`. + +.. seealso:: + :class: dropdown + + :ref:`Adding Pages to a Course` (how to) + + :ref:`Enable Notes` (how to) + + :ref:`Enable Teams` (how to) + + :ref:`Enable Calculator` (how to) + + :ref:`Enable Textbook` (how to) + + :ref:`Add Custom Page` (how to) + + :ref:`Reordering and deleting custom pages` (how to) + + :ref:`Configure Resources` (how to) + + :ref:`Adding Textbooks` (how to) diff --git a/source/educators/how-tos/course_development/exercise_tools/add_poll_question.rst b/source/educators/how-tos/course_development/exercise_tools/add_poll_question.rst index 6ec7e052..3de7fdd2 100644 --- a/source/educators/how-tos/course_development/exercise_tools/add_poll_question.rst +++ b/source/educators/how-tos/course_development/exercise_tools/add_poll_question.rst @@ -1,8 +1,7 @@ .. _Add Poll: -*************************** -Add a Poll in edX Studio -*************************** +Add a Poll in Open edX Studio +############################## .. tags:: educator, how-to @@ -89,15 +88,15 @@ View Poll Results When you view the poll as a course staff member, you can view results of the poll inside the course. -Select **View results** in the poll. +#. Select **View results** in the poll. -.. image:: /_images/educator_how_tos/poll_view_results.png + .. image:: /_images/educator_how_tos/poll_view_results.png :alt: A poll with the View Results button for course staff. :width: 400 -The results of the poll are then displayed. +#. The results of the poll are then displayed. -.. image:: /_images/educator_references/poll_with_results.png + .. image:: /_images/educator_references/poll_with_results.png :alt: A poll showing results after the learner has submitted a response. :width: 400 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 b08ce1c1..dad728ac 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 @@ -63,21 +63,21 @@ Create a Zooming Image Tool image that you want to appear magnified when the user hovers over the regular image. - ``https://studio.edx.org/c4x/edX/DemoX/asset/pathways_detail_01.png`` + ``https://studio.openedx.org/c4x/openedX/DemoX/asset/pathways_detail_01.png`` For example, your file name and path might be ``/static/Image1.jpg``. - Replace the following file name and path with the name and path of the image that you want to appear when the page opens. - ``https://studio.edx.org/c4x/edX/DemoX/asset/pathways_overview_01.png`` + ``https://studio.openedx.org/c4x/openedX/DemoX/asset/pathways_overview_01.png`` For example, your file name and path might be ``/static/Image2.jpg``. - Replace the following name and file path with the name and path of the JavaScript file that you downloaded from ``files.edx.org``. - ``https://studio.edx.org/c4x/edX/DemoX/asset/jquery.loupeAndLightbox.js`` + ``https://studio.openedx.org/c4x/openedX/DemoX/asset/jquery.loupeAndLightbox.js`` Because you uploaded the ``jquery.loupeAndLightbox.js`` file to the **Files & Uploads** page, your file name and path is @@ -96,3 +96,11 @@ Create a Zooming Image Tool #. Select **Save**. +.. seealso:: + :class:dropdown + + :ref:`Add Files to a Course` (how-to) + + :ref:`Image Mapped Input` (reference) + + 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 0692f4ed..44bdddf2 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 @@ -1,17 +1,22 @@ .. _Editing Text Input Problems using the Advanced Editor: -********************************************************************* -Editing Text Input Problems using the Advanced Editor -********************************************************************* +Edit Text 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 +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 text input problem +#. You can use the advanced editor to identify the elements of a text input problem with OLX. For more information, see :ref:`Text Input Problem XML`. To format equations, you can use MathJax. For more information, see :ref:`MathJax in Studio`. @@ -42,9 +47,9 @@ 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 answer feedback with the following syntax. @@ -81,16 +86,16 @@ common incorrect answers. -============================= + Adding Hints -============================= +************* For an overview of hints in problems, see :ref:`Adding Feedback and Hints to a Problem`. -========================================================== + Adding Text after the Response Field -========================================================== +************************************** You might want to include a word, phrase, or sentence after the response field in a text input problem to help guide your learners or resolve ambiguity. @@ -102,11 +107,11 @@ in a text input problem to help guide your learners or resolve ambiguity. To do this, you use the advanced editor. -In the problem, locate the ``textline`` element. This element creates the +#. In the problem, locate the ``textline`` element. This element creates the response field for the problem and is a child of the ``stringresponse`` element. -To add text after the response field, add the ``trailing_text`` attribute +#. To add text after the response field, add the ``trailing_text`` attribute together with the text that you want to use inside the ``textline`` element. An example follows. .. code-block:: xml @@ -119,33 +124,33 @@ together with the text that you want to use inside the ``textline`` element. An -========================================================== + Case Sensitivity and Text Input Problems -========================================================== +========================================= By default, text input problems do not require a case sensitive response. You can change this default to require a case sensitive answer. To make a text input response case sensitive, you use the advanced editor. -In the advanced editor, the ``stringresponse`` element has a ``type`` +#. In the advanced editor, the ``stringresponse`` element has a ``type`` attribute. By default, the value for this attribute is set to ``ci``, for "case insensitive". An example follows. -.. code-block:: xml + .. code-block:: xml - - - . - . - . - - + + + . + . + . + + -Learners who submit an answer of either "Paris" or "paris" are scored -as correct. + Learners who submit an answer of either "Paris" or "paris" are scored + as correct. -To make the response case sensitive, change the value of the ``type`` +#. To make the response case sensitive, change the value of the ``type`` attribute to ``cs``. .. code-block:: xml @@ -161,7 +166,7 @@ attribute to ``cs``. Learners who submit an answer of "Paris" are scored as correct, but learners who submit an answer of "PARIS" are scored as incorrect. -========================================================== + Response Field Length in Text Input Problems ========================================================== @@ -172,33 +177,33 @@ incorrect answers. If the default response field is not long enough, you can change it using the advanced editor. -In the advanced editor, the ``textline`` element has a ``size`` attribute. By +#. In the advanced editor, the ``textline`` element has a ``size`` attribute. By default, the value for this attribute is set to ``20``. An example follows. -.. code-block:: xml + .. code-block:: xml - - - . - . - . - - - + + + . + . + . + + + -To change the response field length, change the value of the ``size`` +#. To change the response field length, change the value of the ``size`` attribute. -.. code-block:: xml + .. code-block:: xml - - - . - . - . - - - + + + . + . + . + + + =============================================================== Allowing Regular Expressions as Answers for Text Input Problems @@ -213,22 +218,22 @@ answer is marked as correct. To do this, you use the advanced editor. -In the advanced editor, the ``stringresponse`` element has a ``type`` +#. In the advanced editor, the ``stringresponse`` element has a ``type`` attribute. You can set the value for this attribute to ``regexp``, with or without also including ``ci`` or ``cs`` for a case insensitive or case sensitive answer. An example follows. -.. code-block:: xml + .. code-block:: xml - - - . - . - . - - + + + . + . + . + + -The regular expression that the learner enters must contain, in whole or in +#. The regular expression that the learner enters must contain, in whole or in part, the answer that you specify. In this example, learners who submit an answer of "string pattern", "String diff --git a/source/educators/how-tos/course_development/reorder_deleting_custom_pages.rst b/source/educators/how-tos/course_development/reorder_deleting_custom_pages.rst new file mode 100644 index 00000000..8d2b3a0e --- /dev/null +++ b/source/educators/how-tos/course_development/reorder_deleting_custom_pages.rst @@ -0,0 +1,33 @@ +.. _Reordering and deleting custom pages: + +Reorder and Delete Custom Pages +##################################### + +For instructions on how to add custom pages see :ref:`Add Custom Page`. + +You can reorder the custom pages in your course in the same way that you :ref:`reorganize the course outline`: +you drag a page to a different location in the list of pages and drop it there. + +.. note:: All default course pages (Course, Progress, Dates, Discussion) and optional course applications (Notes, Teams, Wiki) appear in the navigation before any configured custom page resources. If you have configured any textbook resources, these are listed after custom pages. + +To reorder the pages, follow these steps. + +#. In Studio, from the **Content** menu select **Pages & Resources**. +#. Select the **Custom Pages** card on this page. +#. On the list of pages, each page that you can move includes a Drag to reorder icon. +#. Move your pointer over the Drag to reorder icon for the page. Your pointer changes to a four-headed arrow. +#. Click and drag the page to the new location, and then release. + +You can also delete a custom page from your course using the delete icon shown on each custom page from the **Custom Pages** Studio page. +If you delete a page after the course start date, note that the visibility of the page in the learner experience changes immediately. + +.. seealso:: + :class: dropdown + + :ref:`Adding Pages to a Course` (how to) + + :ref:`Add Custom Page` (how to) + + :ref:`Configure Resources` (how to) + + :ref:`Adding Textbooks` (how to) diff --git a/source/educators/navigation/content_creation_management.rst b/source/educators/navigation/content_creation_management.rst index ee3a2d4d..dbfac448 100644 --- a/source/educators/navigation/content_creation_management.rst +++ b/source/educators/navigation/content_creation_management.rst @@ -101,7 +101,13 @@ Add Course Assets ../references/course_development/exercise_tools/google_docs.rst ../references/course_development/files_page.rst ../how-tos/manage_files.rst - + ../how-tos/course_development/enable_notes.rst + ../how-tos/course_development/enable_teams.rst + ../how-tos/course_development/enable_wiki.rst + ../how-tos/course_development/enable_calculator.rst + ../how-tos/course_development/add_custom_page.rst + ../how-tos/course_development/enable_textbook.rst + ../how-tos/course_development/reorder_deleting_custom_pages.rst Add Mathjax ******************************************************* diff --git a/source/educators/references/course_development/additional_course_information.rst b/source/educators/references/course_development/additional_course_information.rst index 01e21a20..c5bc1115 100644 --- a/source/educators/references/course_development/additional_course_information.rst +++ b/source/educators/references/course_development/additional_course_information.rst @@ -22,7 +22,7 @@ information, see :ref:`Creating a Course About Page `. Best Practices for Entrance Exams ================================== -We strongly recommend that you follow several guidelines to help you and your +We strongly recommend you follow several guidelines to help you and your learners have a positive experience with entrance exams. -* Make sure that your beta testers include the entrance exam when they test +* Make sure your beta testers include the entrance exam when they test your other course content. -* Make sure that you mention the entrance exam in the course description on +* Make sure you mention the entrance exam in the course description on your course **About** page. Otherwise, learners will not know about the entrance exam before they enroll in your course and try to access course content. @@ -110,7 +110,7 @@ learners have a positive experience with entrance exams. * Add an announcement to the **Course Updates & News** page that contains information and instructions for learners who need to take the exam. When learners first try to access content in a course that has an entrance exam, - they see the **Course Updates & News** page. We suggest that you include + they see the **Course Updates & News** page. We suggest you include the following information. * To begin the course entrance exam, learners select **Entrance Exam**. @@ -138,7 +138,7 @@ You can add the syllabus to your course About page. For more information, see :ref:`Creating a Course About Page `. You can also add a syllabus to your course in Studio by creating a custom page -or a handout. For more information, see :ref:`Add Page ` and :ref:`Add Course +or a handout. For more information, see :ref:`Add Page ` and :ref:`Add Course Handouts `. ================