diff --git a/source/educators/concepts/data/learner_data.rst b/source/educators/concepts/data/learner_data.rst index 678fada66..9bdadfc47 100644 --- a/source/educators/concepts/data/learner_data.rst +++ b/source/educators/concepts/data/learner_data.rst @@ -15,12 +15,11 @@ any time after you create the course. .. _PII: -*************************************************************** +********************************************** Guidance for Working with Personal Information -*************************************************************** +********************************************** -The information that edX collects from site registrants includes personal -information that can be used to identify, contact, and locate individuals. This +The information that your instance collects from site registrants includes personal information that can be used to identify, contact, and locate individuals. This information is available to course team members with the Admin or Staff role for the learners who are enrolled in their courses. @@ -45,9 +44,9 @@ For information about course enrollment, see :ref:`Enrollment`. About Learner-Reported Data =========================== -When learners create, or register, their user accounts, they select a public +When learners create or register their user accounts, they select a public username and supply their full names and email addresses. Learners also have -the option to provide personal demographic information, including highest +the option to provide personal demographic information, including the highest level of education completed, gender, year of birth, and preferred language. Because this information is optional, not all of the learners who are enrolled in your course provide it. @@ -75,4 +74,6 @@ understanding of how the learner population changes over time. :ref:`View and download student data` (how-to) - :ref:`Access Anonymized Learner IDs ` (how-to) \ No newline at end of file + :ref:`Access Anonymized Learner IDs ` (how-to) + + :ref:`Manage Learner Grades ` (how-to) \ No newline at end of file diff --git a/source/educators/concepts/instructional_design/id_course_dev_process_overview.rst b/source/educators/concepts/instructional_design/id_course_dev_process_overview.rst index 0f88682fb..04cb20a76 100644 --- a/source/educators/concepts/instructional_design/id_course_dev_process_overview.rst +++ b/source/educators/concepts/instructional_design/id_course_dev_process_overview.rst @@ -217,4 +217,11 @@ Templates for the Information Collection phase that may be helpful: * :ref:`Support Calendar Template` -Remember: Course development is an iterative process. It is important to assume that there will be some changes made after the first group of learners completes the course and provides feedback. \ No newline at end of file +Remember: Course development is an iterative process. It is important to assume that there will be some changes made after the first group of learners completes the course and provides feedback. + +.. seealso:: + :class: dropdown + + :ref:`Instructional Design Overview` (concept) + + :ref:`Instructional Design Templates` (concept) \ No newline at end of file diff --git a/source/educators/concepts/instructional_design/id_instructional_design_overview.rst b/source/educators/concepts/instructional_design/id_instructional_design_overview.rst index 1c3895bef..f1157f415 100644 --- a/source/educators/concepts/instructional_design/id_instructional_design_overview.rst +++ b/source/educators/concepts/instructional_design/id_instructional_design_overview.rst @@ -355,4 +355,6 @@ As you get started building your online course on your platform, here are five i .. seealso:: :class: dropdown + :ref:`Course Development Process` (concept) + :ref:`Instructional Design Templates` (concept) \ No newline at end of file diff --git a/source/educators/concepts/instructional_design/id_templates.rst b/source/educators/concepts/instructional_design/id_templates.rst index ad501296c..0b9251ca0 100644 --- a/source/educators/concepts/instructional_design/id_templates.rst +++ b/source/educators/concepts/instructional_design/id_templates.rst @@ -121,4 +121,6 @@ If your team is involved in the delivery of a course, you may want to spend some .. seealso:: :class: dropdown - :ref:`Instructional Design Overview` (concept) \ No newline at end of file + :ref:`Instructional Design Overview` (concept) + + :ref:`Course Development Process` (concept) \ No newline at end of file diff --git a/source/educators/concepts/planning_course_run_information/set_up_course.rst b/source/educators/concepts/planning_course_run_information/set_up_course.rst index 15ca40d4c..9d24b7781 100644 --- a/source/educators/concepts/planning_course_run_information/set_up_course.rst +++ b/source/educators/concepts/planning_course_run_information/set_up_course.rst @@ -16,4 +16,19 @@ types of basic information about your course. information such as the course staff and start and end dates. For information about how to develop your course content in the Studio course -outline, see :ref:`Developing Your Course Index `. \ No newline at end of file +outline, see the section on :ref:`Creating a Course in Open edX® `. + +.. seealso:: + :class: dropdown + + :ref:`Course Title Guidelines` (reference) + + :ref:`Creating Number Guidelines` (reference) + + :ref:`Course and Program Images and Videos` (reference) + + :ref:`Course Description` (reference) + + :ref:`Additional Course Information` (reference) + + :ref:`Creating a New Course ` \ No newline at end of file diff --git a/source/educators/concepts/releasing-course/beta_testing.rst b/source/educators/concepts/releasing-course/beta_testing.rst index 3060d9e52..a80d67183 100644 --- a/source/educators/concepts/releasing-course/beta_testing.rst +++ b/source/educators/concepts/releasing-course/beta_testing.rst @@ -103,10 +103,10 @@ reluctant to provide feedback, or overly zealous. If you do want a team member to be a beta tester, note that the privileges of the Staff or Admin role override those of a beta tester. The team member must -use a different, second email address to create an additional edX account and +use a different, second email address to create an additional account and enroll in the course, and the course team must assign only the beta tester role -to that edX account. The course team member experiences the course as a learner -only when she signs in to edX using the beta tester account. +to that account. The course team member experiences the course as a learner +only when she signs in using the beta tester account. .. _What_Test: @@ -124,7 +124,7 @@ Beta testers should interact with everything in the course. * Complete all problems. -Beta testers can use a desktop computer to access an edX website, the edX +Beta testers can use a desktop computer to access your course website, the mobile app on a smartphone, or both to complete their tests. As they work, beta testers log issues and questions for the course team. diff --git a/source/educators/how-tos/course_development/exercise_tools/embed_google_calendar.rst b/source/educators/how-tos/course_development/exercise_tools/embed_google_calendar.rst index 3a5d75250..d78c68c2a 100644 --- a/source/educators/how-tos/course_development/exercise_tools/embed_google_calendar.rst +++ b/source/educators/how-tos/course_development/exercise_tools/embed_google_calendar.rst @@ -1,8 +1,8 @@ .. _Embed Google Calendar: -******************************************* +########################################## Embedding a Google Calendar in Your Course -******************************************* +########################################## .. tags:: educator, how-to @@ -14,9 +14,9 @@ To embed a Google Calendar in your course, follow these steps. .. _Enable the Google Calendars Tool: -================================================ +******************************** Enable the Google Calendars Tool -================================================ +******************************** Before you can add Google Calendars to your course, you must enable the Google Calendars tool in Studio or OLX (open learning XML). @@ -30,8 +30,9 @@ Alternatively, you can use OLX to enable the Google Calendars tool. .. _Enable Google Calendars in OLX: +****************************** Enable Google Calendars in OLX -********************************************** +****************************** To enable Google Calendars in your course, you edit the XML file that defines the course structure. You locate the ``course`` element's ``advanced-modules`` @@ -53,9 +54,9 @@ For more information, see `OLX Course Building Blocks`_ in the .. _Make the Google Calendar Public and Obtain Its ID: -=================================================== +************************************************* Make the Google Calendar Public and Obtain Its ID -=================================================== +************************************************* Before you can add a Google Calendar to your course, you must make the Calendar public and obtain its ID. @@ -65,8 +66,9 @@ public and obtain its ID. Because the software is subject to change by its owner, the steps provided here are intended as guidelines and not as an exact procedure. +******************************* Make the Google Calendar Public -********************************************** +******************************* #. Open the Google Calendar. #. From the **Settings** menu, select **Settings**. @@ -91,8 +93,9 @@ Make the Google Calendar Public .. _Obtain the Google Calendar ID: +****************************** Obtain the Google Calendar ID -********************************************** +****************************** #. On the **Calendars** tab, select the name of the calendar. #. Select the **Calendar Details** tab. @@ -113,17 +116,18 @@ Obtain the Google Calendar ID .. _Add a Google Calendar in the Course Body: -======================================== +**************************************** Add a Google Calendar in the Course Body -======================================== +**************************************** To add a Google calendar in the course body, you create an advanced component in Studio or create a Google Calendar XBlock in OLX. -.. _Add a Google Calendar Component in edX Studio: +.. _Add a Google Calendar Component in Studio: -Add a Google Calendar Component in edX Studio -********************************************** +************************************************** +Add a Google Calendar Component in Open edX Studio +************************************************** Make sure that you :ref:`enable Google Calendars` for your course before you add a Google Calendar component. @@ -136,8 +140,7 @@ To add a Google Calendar component, follow these steps. #. Under **Add New Component**, select **Advanced**, and then select **Google Calendar**. - The new component is added to the unit, with the default edX Google Calendar - embedded. + The new component is added to the unit. #. In the new component, select **Edit**. @@ -158,8 +161,9 @@ Google Calendar will appear to learners. .. _Add a Google Calendar XBlock in OLX: +*********************************** Add a Google Calendar XBlock in OLX -********************************************** +*********************************** To add a Google Calendar XBlock in OLX, create the ``google-calendar`` element. You can embed this element in the ``vertical`` element, or you can embed this @@ -179,7 +183,7 @@ The value of the ``calendar_id`` attribute is the calendar ID that you copied in the :ref:`Obtain the Google Calendar ID` task. .. note:: - The edX Learning Management System sets the height and width values for + The Learning Management System sets the height and width values for Google Calendars. If you add these attributes, the LMS overrides your changes. 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 47e97d11c..9cf4d42dd 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 @@ -1,22 +1,21 @@ .. _OLX Completion: -**************************************** +######################################## Add the Completion Tool to an OLX Course -**************************************** +######################################## .. tags:: educator, how-to To add the completion tool to a unit in an OLX (open learning XML) course, it is sufficient to add the ```` tag to the OLX. -EdX recommends that you also explicitly specify a ``url_name`` within the +It is recommended that you also explicitly specify a ``url_name`` within the ```` tag, as shown in the following example. If you do not explicitly specify a ``url_name``, a value is automatically assigned, which can be problematic if the same course is imported several times. For example, if the ``url_name`` value is automatically generated each time you import your course, and if you import your course more than once, the learner state for -the associated problems is lost each time a new ``url_name`` value is -ssigned. +the associated problems is lost each time a new ``url_name`` value is assigned. .. code-block:: xml diff --git a/source/educators/how-tos/course_development/video_process_overview.rst b/source/educators/how-tos/course_development/video_process_overview.rst index 54da19d52..96b2ce7bc 100644 --- a/source/educators/how-tos/course_development/video_process_overview.rst +++ b/source/educators/how-tos/course_development/video_process_overview.rst @@ -12,8 +12,7 @@ The following diagram outlines the general process for adding videos to a course :alt: The process for adding videos to a course, as outlined in the following numbered steps. -#. The course team :ref:`prepares to add videos to the course `. These steps can happen simultaneously. +#. The course team :ref:`prepares to add videos to the course `. These steps can happen simultaneously. * The course team sets up a third party :ref:`hosting service ` to provide a location for course videos. @@ -28,6 +27,19 @@ The following diagram outlines the general process for adding videos to a course and adds the video location to the components. #. The course team :ref:`Add a Transcript` in - the video component. + the video component. +.. seealso:: + :class: dropdown + :ref:`Introduction to Video` (reference) + + :ref:`Add a Video` (how-to) + + :ref:`Troubleshoot Videos` (reference) + + :ref:`Create a Video` (how-to) + + :ref:`Specifying Additional Video Options ` (how-to) + + :ref:`Add an In Video Quiz` (how-to) \ No newline at end of file diff --git a/source/educators/how-tos/set_up_course/edit_course_about.rst b/source/educators/how-tos/set_up_course/edit_course_about.rst index 3a18a6255..01c3bf8c9 100644 --- a/source/educators/how-tos/set_up_course/edit_course_about.rst +++ b/source/educators/how-tos/set_up_course/edit_course_about.rst @@ -1,8 +1,8 @@ .. _Edit Your Course: -************* +############# Edit a Course -************* +############# .. tags:: educator, how-to @@ -13,8 +13,7 @@ dates`, or developing the :ref:`course outline`. When you return to Studio later, your **My Courses** dashboard page lists -the courses that you created as well as any courses for which you have course -team privileges. +the courses that you created as well as any courses for which you have course team privileges. .. image:: /_images/educator_how_tos/open_course.png :width: 600 @@ -45,11 +44,10 @@ change the way that your course title and number appear in Studio and the LMS. Change the Course Title ======================= -To change the way that your course title appears in Studio and the LMS, follow -these steps. +To change the way that your course title appears in Studio and the LMS, follow these steps. .. note:: - EdX does not recommended that you do this if your course is live. + It is not recommended that you do this if your course is live. #. Open the course in Studio. #. On the **Settings** menu, select **Advanced Settings**. @@ -69,7 +67,7 @@ To change the way that your course number appears in Studio and the LMS, follow these steps. .. note:: - EdX does not recommended that you do this if your course is live. + It is not recommended that you do this if your course is live. #. Open the course in Studio. #. On the **Settings** menu, select **Advanced Settings**. @@ -81,3 +79,19 @@ In Studio and the LMS, your course number changes to the value that you specify in the **Course Number Display String** field. The URL for your course does not change. + +.. seealso:: + :class: dropdown + + :ref:`Getting Started with Course Content Development` (reference) + + :ref:`Course Outline` (concept) + + :ref:`Create a Course` (how-to) + + :ref:`Create the Course About Page` (how-to) + + :ref:`Understanding a Course Outline ` (reference) + + :ref:`Developing Your Course Outline` (reference) + diff --git a/source/educators/how-tos/set_up_course/set_schedule.rst b/source/educators/how-tos/set_up_course/set_schedule.rst index 13d947810..ee40cf16f 100644 --- a/source/educators/how-tos/set_up_course/set_schedule.rst +++ b/source/educators/how-tos/set_up_course/set_schedule.rst @@ -19,12 +19,11 @@ For more information about determining how to schedule your course, see Set Start and End Dates and Times in Studio ******************************************* - To set dates and times for the course and for course enrollment in Studio, follow these steps. .. note:: - EdX recommends that you verify all important dates in Studio one week before + It is recommended that you verify all important dates in Studio one week before you plan to start the course. #. On the **Settings** menu, select **Schedule & Details**. @@ -44,9 +43,9 @@ follow these steps. .. _Advertise a Different Start Date: -==================================== +********************************* Advertise a Different Start Date -==================================== +********************************* You can advertise a start date for your course that is different from the course start date you set in the **Schedule & Details** page. You might want @@ -90,7 +89,6 @@ To set an advertised start date in Studio, follow these steps. Set Pacing for Your Course in Studio ************************************ - Before you can use this feature to set up a self-paced course, it must be enabled using the Open edX Django admin panel. Follow these steps, or contact your Open edX site administrator for assistance. @@ -112,3 +110,17 @@ To set the pacing for your course, follow these steps. #. Under **Course Pacing**, select either **Instructor-Paced** or **Self-Paced**. #. Select **Save Changes**. + + +.. seealso:: + :class: dropdown + + :ref:`Course Dates` (reference) + + :ref:`Scheduling Your Course` (reference) + + :ref:`Setting Course Pacing` (reference) + + :ref:`Course Pacing` (reference) + + :ref:`Additional Course Run Information` (concept) diff --git a/source/educators/how-tos/update_rerun_course.rst b/source/educators/how-tos/update_rerun_course.rst index 09b1279a2..46c20342b 100644 --- a/source/educators/how-tos/update_rerun_course.rst +++ b/source/educators/how-tos/update_rerun_course.rst @@ -96,4 +96,4 @@ for launch, see :ref:`Launch`. :ref: `Re-running a Course` (reference) - :ref: `Re-Run a Course` (how-to) \ No newline at end of file + :ref: `Re-Run a Course` (how-to) diff --git a/source/educators/references/accessibility/accessibility_checker.rst b/source/educators/references/accessibility/accessibility_checker.rst index 058a190e7..bc27f2cc3 100644 --- a/source/educators/references/accessibility/accessibility_checker.rst +++ b/source/educators/references/accessibility/accessibility_checker.rst @@ -104,6 +104,8 @@ content: .. seealso:: :class: dropdown + :ref:`Accessibility Guidelines` (concept) + :ref:`Accessibility Best Practices for Course Content Development` (concept) :ref:`Designing for Mobile` (concept) diff --git a/source/educators/references/course_development/add_edit_in_outline.rst b/source/educators/references/course_development/add_edit_in_outline.rst index 7576e7011..d18fc391c 100644 --- a/source/educators/references/course_development/add_edit_in_outline.rst +++ b/source/educators/references/course_development/add_edit_in_outline.rst @@ -7,18 +7,13 @@ Add Content in the Course Outline .. tags:: educator, reference You can add content in the course outline by creating a new section, -subsection, or unit, or by duplicating an existing unit, subsection, or -section. +subsection, or unit, or by duplicating an existing unit, subsection, or section. For information about adding content to a unit, see :ref:`Developing Course Components`. -.. the following note is for prerequisite exams, which are currently released in open edx only and not on edx.org. when they are available on edx.org, this note should no longer be conditionalized. - - - .. note:: - If you want to require an entrance exam for your course, you also create + If you want to require an entrance exam for your course, you also create the exam in the course outline. Before you can create an exam, you must set your course to require an entrance exam in Studio. For more information, see :ref:`Require an Entrance Exam`. @@ -39,14 +34,13 @@ Adding New Sections, Subsections, or Units **New Unit**. The :ref:`unit` page opens. -======================================================= +====================================================== Duplicating Existing Sections, Subsections, or Units -======================================================= +====================================================== To add a section, subsection, or unit by duplicating content that already exists in the course outline, select the **Duplicate** icon for the item that -you want to duplicate. You see a **Duplicating** indicator at the bottom of the -Studio page. +you want to duplicate. You see a **Duplicating** indicator at the bottom of the Studio page. Duplicated items are added to the course outline immediately below the original item, with the name "Duplicate of ". @@ -128,4 +122,44 @@ You are prompted to confirm the deletion. .. note:: When you delete an object, all objects that it contains are deleted. For example, when you delete a subsection, all units in that subsection are - deleted. \ No newline at end of file + deleted. + +.. seealso:: + :class: dropdown + + :ref:`Getting Started with Course Content Development` (reference) + + :ref:`Course Outline` (concept) + + :ref:`Creating a New Course in Studio ` (how-to) + + :ref:`Create a Course` (how-to) + + :ref:`Create the Course About Page` (how-to) + + :ref:`Understanding a Course Outline ` (reference) + + :ref:`Developing Your Course Outline` (reference) + + :ref:`Modify Settings for Objects in the Course Outline` (reference) + + :ref:`Publish Content from the Course Outline` (reference) + + :ref:`Developing Course Sections` (reference) + + :ref:`Developing Course Subsections` (reference) + + :ref:`Create a Section` (how-to) + + :ref:`Create a Subsection` (how-to) + + :ref:`Hiding a Subsection from Learners ` (how-to) + + :ref:`Add Course Metadata` (how-to) + + :ref:`Use a Section from a Course independently of the Course Outline` (how-to) + + :ref:`Resources for Course Teams` (reference) + + :ref:`Resources for Open edX` (reference) + diff --git a/source/educators/references/course_development/course_outline.rst b/source/educators/references/course_development/course_outline.rst index acd12cefd..efa216f8a 100644 --- a/source/educators/references/course_development/course_outline.rst +++ b/source/educators/references/course_development/course_outline.rst @@ -6,7 +6,7 @@ Developing Your Course Outline .. tags:: educator, reference -As you develop your course, you work primarily in the edX Studio course +As you develop your course, you work primarily in the Open edX® Studio course outline. This section includes the following information about working with the course outline. @@ -28,7 +28,7 @@ Open the Course Outline To view the course outline, follow these steps. -#. Sign in to edX Studio. +#. Sign in to Studio. #. On the **My Courses** page, select the course you want to develop. The course outline opens by default when you open a course. @@ -45,4 +45,42 @@ following message is visible. To add content, you :ref:`create a section`. - +.. seealso:: + :class: dropdown + + :ref:`Getting Started with Course Content Development` (reference) + + :ref:`Course Outline` (concept) + + :ref:`Creating a New Course in Studio ` (how-to) + + :ref:`Create a Course` (how-to) + + :ref:`Create the Course About Page` (how-to) + + :ref:`Understanding a Course Outline ` (reference) + + :ref:`Add Content in the Course Outline` (reference) + + :ref:`Modify Settings for Objects in the Course Outline` (reference) + + :ref:`Publish Content from the Course Outline` (reference) + + :ref:`Developing Course Sections` (reference) + + :ref:`Developing Course Subsections` (reference) + + :ref:`Create a Section` (how-to) + + :ref:`Create a Subsection` (how-to) + + :ref:`Hiding a Subsection from Learners ` (how-to) + + :ref:`Add Course Metadata` (how-to) + + :ref:`Use a Section from a Course independently of the Course Outline` (how-to) + + :ref:`Resources for Course Teams` (reference) + + :ref:`Resources for Open edX` (reference) + \ No newline at end of file diff --git a/source/educators/references/course_development/course_units.rst b/source/educators/references/course_development/course_units.rst index fcaf5e092..07b30c77f 100644 --- a/source/educators/references/course_development/course_units.rst +++ b/source/educators/references/course_development/course_units.rst @@ -62,11 +62,11 @@ circles and text to show different areas and controls in the page. Viewing Units as a Learner **************************** -To a learner using the edX learning management system (LMS), each unit in the +To a learner using the learning management system +(LMS), each unit in the subsection is represented by an icon in the unit navigation bar at the top of the **Course** page. The current unit is indicated with bold underlining in the -unit navigation bar. The components in the current unit appear below the unit -navigation bar. +unit navigation bar. The components in the current unit appear below the unit navigation bar. The following image shows a subsection in the LMS that contains several units. @@ -82,3 +82,21 @@ following actions. * Viewed all of each video. * Submitted answers for all of the problems. * Viewed all HTML content for at least five seconds. + +.. seealso:: + :class: dropdown + + :ref:`Add Units to the Outline` (how-to) + + :ref:`Create a Unit` (how-to) + + :ref:`Set Access Restrictions For a Unit` (how-to) + + :ref:`Copy and Paste Course Units ` (how-to) + + :ref:`Hide a Unit from Learners ` (how-to) + + :ref:`Copy and Paste Course Content ` (how-to) + + :ref:`The Unit Workflow` (reference) + diff --git a/source/educators/references/course_development/description_guidelines.rst b/source/educators/references/course_development/description_guidelines.rst index 13efe0b96..0fe22fb4f 100644 --- a/source/educators/references/course_development/description_guidelines.rst +++ b/source/educators/references/course_development/description_guidelines.rst @@ -96,7 +96,7 @@ What You Will Learn Guidelines ************************************ The "what you will learn" information describes the skills and knowledge -learners will acquire in the course in an itemized list. EdX recommends that +learners will acquire in the course in an itemized list. It is recommended that you format each item as a bullet with four to ten words. @@ -144,4 +144,17 @@ Use the following guidelines to select the level for your course. * Intermediate - Basic prerequisites; learners need to complete secondary school or some university courses. * Advanced - Significant prerequisites; the course is geared to third or fourth - year university students or master's degree students. \ No newline at end of file + year university students or master's degree students. + +.. seealso:: + :class: dropdown + + :ref:`Course Title Guidelines` (reference) + + :ref:`Creating Number Guidelines` (reference) + + :ref:`Course and Program Images and Videos` (reference) + + :ref:`Additional Course Information` (reference) + + :ref:`Creating a New Course ` diff --git a/source/educators/references/course_development/exercise_tools/completion.rst b/source/educators/references/course_development/exercise_tools/completion.rst index 021c9137f..e9079e73f 100644 --- a/source/educators/references/course_development/exercise_tools/completion.rst +++ b/source/educators/references/course_development/exercise_tools/completion.rst @@ -33,21 +33,19 @@ score on the **Progress** page. Practice scores are not included in the learner's final grade for the course. You can also use the completion tool in graded sections of the course. If you -do so, a score for completing the activity is included in learners' final -grades. For example, if you include a completion component in a particular unit -of the course content, learners who use the component to mark the unit as -complete receive 1/1 points, while learners who do not mark the unit as +do so, a score for completing the activity is included in learners' final grades. For example, if you include a completion component in a particular unit +of the course content, learners who use the component to mark the unit as complete receive 1/1 points, while learners who do not mark the unit as complete receive 0/1 points. These scores are included in learners' final grades on the **Progress** page. -.. note:: EdX recommends using the completion tool primarily to track progress +.. note:: It is recommended to use the completion tool primarily to track progress for ungraded activities such as reading assigned texts, watching videos, or participating in course discussions. -====================== +********************** The Completion Control -====================== +********************** When you add a completion component to a unit, learners see a control that is labeled **Mark as complete**. In this example, the completion component follows diff --git a/source/educators/references/data/interpreting_grade_report.rst b/source/educators/references/data/interpreting_grade_report.rst index 1d2f009a5..19dc34696 100644 --- a/source/educators/references/data/interpreting_grade_report.rst +++ b/source/educators/references/data/interpreting_grade_report.rst @@ -16,7 +16,7 @@ homework, lab, midterm, final, and any other assignment type you added to your course. .. note:: The grade report does not include information about individual - problems within assignments, or include learner answer distributions. For a + problems within assignments or include learner answer distributions. For a report that shows problem-level information, see :ref:`problem_report`. The report indicates the enrollment track for each learner. For professional @@ -47,7 +47,7 @@ columns that provide the following information. of 0.65 has earned 65% of the credit in the course, and a learner with a grade of 1 has earned 100%. -* Each **{assignment type} {number}** defined in your grading configuration, +* Each **{assignment type} {number}** is defined in your grading configuration, with the score that the learner attained for that specific assignment. For example, column Homework 3 shows the scores for the third homework assignment. If the learner did not attempt the assignment, the value is "Not @@ -88,8 +88,7 @@ columns that provide the following information. * The **Verification Status** column indicates whether learners who are enrolled in course tracks that require ID verification have successfully - verified their identities to edX by submitting an official photo ID via - webcam. The value in this column is "N/A" for learners enrolled in course + verified their identities to your instance by submitting an official photo ID via webcam. The value in this column is "N/A" for learners enrolled in course tracks that do not require ID verification, such as "Audit". A value of "Not ID Verified" in this column indicates that the learner is @@ -132,6 +131,12 @@ columns that provide the following information. enrolled or unenrolled in the course. .. seealso:: - :class: dropdown + :class: dropdown - :ref:`Access_grades` (how-to) \ No newline at end of file + :ref:`Learner Data` (concept) + + :ref:`Interpret the Problem Grade Report` (reference) + + :ref:`Understanding the Progress Page` (reference + + :ref:`Manage Learner Grades ` (how-to) \ No newline at end of file diff --git a/source/educators/references/data/staff_debug_info.rst b/source/educators/references/data/staff_debug_info.rst index 12dbb8e13..984e488ad 100644 --- a/source/educators/references/data/staff_debug_info.rst +++ b/source/educators/references/data/staff_debug_info.rst @@ -6,13 +6,13 @@ Staff Debug Info .. tags:: educator, reference -The edX system keeps track of learners' progress through a course -- recording +The platform keeps track of learners' progress through a course -- recording when the learner watches videos, responds to problems, and so on. If you are a member of a course team, some of that data is visible to you for debugging purposes. Under every problem is a **Staff Debug Info** button: selecting this button opens a window with information about the problem. -None of this information should be necessary for day-to-day usage of edX, +None of this information should be necessary for day-to-day usage of your Open edX® LMS, but for the sake of clarity, some of these fields are documented here. ``is_released`` @@ -21,12 +21,6 @@ but for the sake of clarity, some of these fields are documented here. ``location`` An internal unique identifier that corresponds to this problem. - .. only:: Partners - - If you are having trouble with a problem, and need assistance from the edX - support team, including this value will make it easier for them to track - down the issue you are having with the problem. - ``markdown`` The text of the problem, in Markdown format. This is often written using Studio. Markdown is no longer supported with the release of the visual editors. @@ -39,11 +33,16 @@ but for the sake of clarity, some of these fields are documented here. correctly. ``attempts`` - The number of times that the currently logged in learner has + The number of times that the currently logged-in learner has attempted to answer the problem correctly, so far. Every time this learner attempts to answer this question, this number will go up, until it reaches ``max_attempts``. ``parent`` An internal unique identifier that corresponds to the unit that - contains this problem. \ No newline at end of file + contains this problem. + +.. seealso:: + :class: dropdown + + :ref:`Learner Data` (concept) \ No newline at end of file diff --git a/source/educators/references/licensing_course.rst b/source/educators/references/licensing_course.rst index 91fab21b8..9fbadfad9 100644 --- a/source/educators/references/licensing_course.rst +++ b/source/educators/references/licensing_course.rst @@ -19,9 +19,9 @@ Course Content Licensing`. .. _License Options: -************************************* +*************** License Options -************************************* +*************** For your course content and for each video in your course, you can select one of the following license options. @@ -31,9 +31,9 @@ of the following license options. .. _All Rights Reserved License: -==================================== +******************* All Rights Reserved -==================================== +******************* All Rights Reserved indicates to learners that you own the copyright but reserve all rights for sharing copies of course content or videos. Learners @@ -42,17 +42,16 @@ Reserved licenses. .. _Creative Commons License: -==================================== +************************ Creative Commons License -==================================== +************************ The Creative Commons license indicates to learners that you own the copyright but are granting certain permissions for reuse, depending on the license options that you select. When you create a new course, the default terms are set to All Rights Reserved. -You can change the terms for your course in the **Schedule & Details** page in -Studio. +You can change the terms for your course in the **Schedule & Details** page in Studio. .. list-table:: :widths: 10 70 @@ -63,7 +62,7 @@ Studio. * - **Attribution** - This option allows others to copy, distribute, display, and perform your copyrighted work but only if they give credit to you in the way that you - request. This option is enabled for all Creative Commons licenses on edX + request. This option is enabled for all Creative Commons licenses on course content. You cannot clear this option. * - **Noncommercial** - This option allows others to distribute, display, and perform your work @@ -83,9 +82,9 @@ For more information, see the `Creative Commons website`_. .. _Learners View of Licenses: -************************************* +************************** Learners' View of Licenses -************************************* +************************** When they view content in the **Course** tab, learners see the license that you set for the course at the bottom of the page. @@ -104,4 +103,9 @@ the license at the bottom right of the video player. For the course and for videos, if you choose **All Rights Reserved**, learners see **All Rights Reserved**; if you choose **Creative Commons** and select any allowed combination of options, learners see **Some Rights Reserved** and can -select the link to see details. \ No newline at end of file +select the link to see details. + +.. seealso:: + :class: dropdown + + :ref:`Set Course Content Licensing` (how-to) \ No newline at end of file diff --git a/source/educators/references/workflow.rst b/source/educators/references/workflow.rst index b8356c42b..9f30a8269 100644 --- a/source/educators/references/workflow.rst +++ b/source/educators/references/workflow.rst @@ -21,7 +21,7 @@ course content, with links to more details. Understanding Course Building Blocks ************************************************ -Before you begin, you should understand the building blocks of an edX course. +Before you begin, you should understand the building blocks of courses built on the Open edX® platform. * :ref:`The course outline` is the container for all of your course content. The outline contains one or more sections. @@ -42,7 +42,7 @@ Before you begin, you should understand the building blocks of an edX course. Creating New Course Content **************************************** -Once you understand the way edX courses are structured, you can start +Once you understand the way courses are structured on the Open edX® platform, you can start organizing your content and entering it into Studio. You create :ref:`sections`, :ref:`subsections` throughout the creation process, including making sure that the -content is available for learners who access courses using the edX mobile apps. +content is available for learners who access courses using the mobile apps. For more information, see :ref:`design for mobile `. .. note:: Keep in mind that course updates that you make might take longer to - appear in the edX mobile apps than on the edX site. In particular, newly + appear in the mobile apps than on your course website. In particular, newly published content can take up to an hour to update on the Android app. @@ -146,9 +146,50 @@ visibility: It is recommended that you :ref:`test course content ` during the revision process, including making sure that the content -is available for learners who access courses using the edX mobile apps. For +is available for learners who access courses using the mobile apps. For more information, see :ref:`Designing for Mobile`. .. note:: Keep in mind that course updates that you make might take longer to - appear in the edX mobile apps than on the edX site. In particular, newly - published content can take up to an hour to update on the Android app. \ No newline at end of file + appear in the mobile apps than on your course website. In particular, newly + published content can take up to an hour to update on the Android app. + + +.. seealso:: + :class: dropdown + + :ref:`Course Outline` (concept) + + :ref:`Creating a New Course in Studio ` (how-to) + + :ref:`Create a Course` (how-to) + + :ref:`Create the Course About Page` (how-to) + + :ref:`Understanding a Course Outline ` (reference) + + :ref:`Add Content in the Course Outline` (reference) + + :ref:`Developing Your Course Outline` (reference) + + :ref:`Modify Settings for Objects in the Course Outline` (reference) + + :ref:`Publish Content from the Course Outline` (reference) + + :ref:`Developing Course Sections` (reference) + + :ref:`Developing Course Subsections` (reference) + + :ref:`Create a Section` (how-to) + + :ref:`Create a Subsection` (how-to) + + :ref:`Hiding a Subsection from Learners ` (how-to) + + :ref:`Add Course Metadata` (how-to) + + :ref:`Use a Section from a Course independently of the Course Outline` (how-to) + + :ref:`Resources for Open edX Course Teams ` (reference) + + :ref:`Resources for Open edX` (reference) + \ No newline at end of file