Skip to content

E
edx-platform
Commit b7486133 by Mark Hoeber
Options

Doc changes for new publishing workflow

parent 41425a46
Showing with 1904 additions and 799 deletions
docs/en_us/course_authors/source/building_course/establish_grading_policy.rst
......@@ -13,7 +13,7 @@ Establishing a grading policy takes several steps. You must:
#. :ref:`Set the Grade Range`
#. :ref:`Set the Grace Period`
#. :ref:`Configure the Assignment Types`
#. :ref:`Set the Assignment Type for Graded Subsections`
#. :ref:`Graded Subsections`
#. :ref:`The Student View of Grades`
......@@ -166,28 +166,33 @@ You configure the following fields for each assignment type:
will drop the lowest-scored assignments first.
.. _Set the Assignment Type for Graded Subsections:
.. _Graded Subsections:
**********************************************
Set the Assignment Type for Graded Subsections
Graded Subsections
**********************************************
After you configure assignment types, as you are organizing your course, you set
the assignment type for subsections that contain problems that are to be graded.
After you configure assignment types, as you are organizing your course, you
set the assignment type for subsections that contain problems that are to be
graded.
Each subsection that contains problems to be graded can include only one
assignment type. See :ref:`subsections` for more information.
assignment type.
.. note:: You can only set assignment types and due dates at the subsection
level. You cannot set assignment types or due dates for entire sections or
for individual units within subsections. Additionally, you can designate a
subsection as one, and only one, of the assignment types you configured.
.. note::
You can only set assignment types and due dates at the subsection level. You
cannot set assignment types or due dates for entire sections or for individual
units within subsections. Additionally, you can designate a subsection as one,
and only one, of the assignment types you configured.
See :ref:`subsections` for general instructions on configuring a subsection. See
:ref:`Set the Grading Policy` for instructions on designating a subsection as a
graded assignment.
See :ref:`Developing Course Subsections` for general instructions on
configuring a subsection.
See :ref:`Set the Assignment Type and Due Date for a Subsection` for
instructions on designating a subsection as a graded assignment.
Within a graded subsection, you create problems of the type designated for that
subsection. You cannotß not mix problems of different assignment types in the
subsection. You cannot not mix problems of different assignment types in the
same subsection.
For example, if you want to create a homework assignment and a lab for a
......@@ -195,74 +200,12 @@ specific topic, create two subsections. Set one subsection as the Homework
assignment type and the other as the Lab assignment type. Both subsections can
contain other content as well as the actual homework or lab problems.
.. note:: You can create problems in Studio without specifying that the
subsection is an assignment type. However, such problems do not count toward
a student's grade.
See :ref:`Working with Problem Components` for instructions on creating problems.
.. _Set the Grading Policy:
=======================
Set the Grading Policy
=======================
You can designate a subsection as one of the assignment types that you specified
in the grading policy.
You set the grading policy for the subsection from two places:
* The course outline
* The subsection page
From the course outline, click the checkmark next to the subsection. Then
select a grading policy from the popup menu:
.. image:: ../Images/course_outline_set_grade.png
:alt: Image of the assignment type for a subsection
From the subsection page, click the text next to the **Graded as** label, then
select a grading policy from the popup menu:
.. image:: ../Images/subsection_set_grade.png
:alt: Image of the assignment type on the subsection page
See :ref:`Establish a Grading Policy` for more information.
==================
Set the Due Date
==================
For subsections that contain graded problems, you can set a due date. Students
must complete the problems in the subsection before the due date to get credit.
All problems in a subsection have the same due date.
#. From the subsection page, click **SET A DUE DATE**. The Due Day and Due Time
fields appear.
#. Place the cursor in the Due Date field, and pick a day from the popup
calendar.
#. Place the cursor in the Due Time field and pick a time.
.. note:: When you set a due date, keep in mind that students will be in
different time zones. By default, the time zone appears as UTC, not the
student's local time. If you tell your students an assignment is due at 5:00
PM, make sure to specify that the time is 5:00 PM UTC and point them to a
time converter.
You can also :ref:`Set the Grace Period` for your assignments to cover any
misunderstandings about time. For example, some classes have set a grace period
of 1 day, 6 hours, and 1 minute. The grace period applies to all assignments.
Students see the due date in the course accordion under the subsection title.
For example:
.. image:: ../Images/Subsection_due_date.png
:alt: Image of subsection due dates in the course accordion
There are several problems in this subsection, all due November 3, 2013 at 23:30
UTC.
.. note::
You can create problems in Studio without specifying that the subsection is an
assignment type. However, such problems do not count toward a student's grade.
See :ref:`Working with Problem Components` for instructions on creating
problems.
......
docs/en_us/course_authors/source/building_course/index.rst
.. _Building a Course Index:
.. _Setting up Your Course Index:
##########################
Building a Course
Setting up Your Course
##########################
Use the chapters in this section to create and build your course.
For information on how to develop your course content in the Studio Outline
page, see :ref:`Developing Your Course Index`.
.. toctree::
:maxdepth: 2
creating_new_course
export_import_course
setting_up_student_view
establish_grading_policy
\ No newline at end of file
course_files
handouts_updates
pages
textbooks
establish_grading_policy
setting_up_student_view
\ No newline at end of file
docs/en_us/course_authors/source/change_log.rst
......@@ -12,6 +12,22 @@ August, 2014
* - Date
- Change
* - 08/12/14
- Updated documentation to address the new publishing workflow and user
interface.
Created a new part, :ref:`Developing Your Course Index`,
which contains the following chapters:
* :ref:`Getting Started with Course Content Development`
* :ref:`Developing Your Course Outline`
* :ref:`Developing Course Sections`
* :ref:`Developing Course Subsections`
* :ref:`Developing Course Units`
* :ref:`Developing Course Components`
* :ref:`Controlling Content Visibility`
* :ref:`Testing Your Course Content`
* - 08/07/14
- Added information about reviewing and duplicating the contents of
previously-sent messages to the :ref:`Bulk Email` section.
......@@ -19,6 +35,12 @@ August, 2014
- Updated the :ref:`view_enrollment_count` section to include the
breakdown by certification track in the enrollment section.
.. note::
In several cases, older links to changed topics were made obsolete by
subsequent changes.
***********
July, 2014
***********
......@@ -188,7 +210,8 @@ April, 2014
* :ref:`Answer Pools in a Multiple Choice Problem`
* - 04/15/14
- Updated :ref:`Testing Your Course` to include a section on how to :ref:`View Your Live Course`.
- Updated *Testing Your Course* to include a section on how to *View Your
Live Course*.
* - 04/11/14
- Expanded the :ref:`Grades` section to include a topic on interpreting the Student Answer Distribution report.
* - 04/08/14
......@@ -199,8 +222,8 @@ April, 2014
* - 04/03/14
- Updated the :ref:`Adding Pages to a Course` chapter to reflect ability to :ref:`Show or Hide the Course Wiki Page`.
* - 04/02/14
- Reorganized the sections :ref:`Building a Course Index` and
:ref:`Creating Course Content Index` to better reflect the workflow of
- Reorganized the sections Building a *Course Index* and
*Creating Course Content Index* to better reflect the workflow of
building a new course.
* - 04/01/14
- Update the :ref:`Establish a Grading Policy` chapter to emphasize that
......@@ -236,7 +259,7 @@ March, 2014
* :ref:`Getting Started Index`
* :ref:`Building a Course Index`
* Building a Course Index
* :ref:`Creating Course Content Index`
......@@ -337,7 +360,7 @@ January, 2014
- Added info about scoring (:ref:`ORA Access Scores`) and due dates in
:ref:`Open Response Assessment`.
* - 01/13/2014
- Extensive updates to :ref:`Organizing Your Course Content` and
- Extensive updates to Organizing Your Course Content and
:ref:`Working with HTML Components`.
* - 01/08/2014
- Updated :ref:`Add Files to a Course` to reflect addition of sorting to
......@@ -354,8 +377,8 @@ January, 2014
* - 01/06/2014
- Created :ref:`Zooming image`
* - 01/01/2014
- Updated the chapters :ref:`Organizing Your Course Content` and
:ref:`Testing Your Course` to reflect changes in the Course Outline
- Updated the chapters Organizing Your Course Content and
Testing Your Course to reflect changes in the Course Outline
design.
***************
......
docs/en_us/course_authors/source/creating_content/create_discussion.rst
......@@ -33,10 +33,6 @@ Also see the following chapters:
Create a Discussion Component
*****************************
To create a new Discussion component in an existing unit, ensure the unit is
Private. For more information, see :ref:`Public and
Private Units`.
#. Under **Add New Component**, click **Discussion**.
#. In the Discussion component that appears, click **Edit**.
......@@ -62,11 +58,22 @@ Private Units`.
#. Click **Save**.
.. warning:: You should always use these steps to create a discussion component. If you create a discussion component by using the **Duplicate** button in Studio, both discussion components will contain the same conversations, even if users post in different discussions.
.. warning::
You should always use these steps to create a discussion component. If you
create a discussion component by using the **Duplicate** button in Studio,
both discussion components will contain the same conversations, even if users
post in different discussions.
Discussion *categories* are immediately visible on the **Discussion** tab for your course when you create them, even if the unit that contains the Discussion component is set to Private. However, an individual Discussion component is not visible until the unit is published and release dates for the section and subsection have passed. See :ref:`Publishing Your Course` for more information.
Discussion *categories* are immediately visible on the **Discussion** tab for
your course when you create them, even if the unit that contains the Discussion
is not published. However, an individual Discussion component is not visible
until the unit is published and release dates for the section and subsection
have passed. See :ref:`Controlling Content Visibility` for more information.
Additionally, you cannot see posts, responses, or comments in a Discussion component when you are working in Studio. To see the discussion, go to the unit that contains the Discussion component in Studio, and then click **Preview** or **View Live** under **Unit Settings**.
Additionally, you cannot see posts, responses, or comments in a Discussion
component when you are working in Studio. To see the discussion, go to the unit
that contains the Discussion component in Studio, and then click **Preview** or
**View Live** under **Unit Settings**.
.. _A Students View of the Discussion:
......@@ -74,16 +81,16 @@ Additionally, you cannot see posts, responses, or comments in a Discussion compo
A Student's View of the Discussion
**********************************
For students, the display name for the Discussion component appears in the course ribbon at the top
of the page:
For students, the display name for the Discussion component appears in the
course ribbon at the top of the page:
.. image:: ../Images/DiscussionComponent_LMS_Ribbon.png
:alt: Image of a unit from a student's point of view with the component list
showing a discussion component
The Discussion space appears under other components in the unit. It doesn't have
a label in the body of the unit. Instead, students see "Show discussion" or
"Hide discussion" on the left, and a blue **New Post** button on the right.
The Discussion space appears under other components in the unit. It doesn't
have a label in the body of the unit. Instead, students see "Show discussion"
or "Hide discussion" on the left, and a blue **New Post** button on the right.
In the following example, the Discussion component follows Video and HTML
components:
......@@ -91,10 +98,8 @@ components:
.. image:: ../Images/DiscussionComponent_LMS.png
:alt: Image of a video component followed by a discussion component
In the **Discussion** tab at the top of the page, students can find the category
and subcategory of the discussion in the left pane.
In the **Discussion** tab at the top of the page, students can find the
category and subcategory of the discussion in the left pane.
.. image:: ../Images/Discussion_category_subcategory.png
:alt: Image of the Discussion page from a student's point of view
:alt: Image of the Discussion page from a student's point of view
\ No newline at end of file
docs/en_us/course_authors/source/creating_content/create_html_component.rst
......@@ -10,10 +10,11 @@ HTML Component Overview
***********************
HTML, or HyperText Markup Language, is the standard markup language used to
create web pages. Web browsers present HTML code in a more readable format. When
students see text and images in your course, they are seeing HTML code that is
formatted and presented by their browsers. For more information about HTML, see
`Wikipedia <http://en.wikipedia.org/wiki/HTML>`_.
create web pages. Web browsers present HTML code in a more readable format.
When students see text and images in your course, they are seeing HTML code
that is formatted and presented by their browsers. For more information about
HTML, see `Wikipedia <http://en.wikipedia.org/wiki/HTML>`_.
HTML components are the basic building blocks of your course content. You use
HTML components to add and format text, links, images, and more. You can choose
......@@ -32,9 +33,11 @@ For more information, see the following topics:
* :ref:`Import LaTeX Code`
.. note::
Review :ref:`Organizing Your Course Content` and :ref:`Best Practices for HTML Markup` before you start working with HTML components.
Review :ref:`Developing Your Course Index` and :ref:`Best Practices for HTML
Markup` before you start working with HTML components.
To add an instant hangout to an HTML component, see :ref:`Google Instant Hangout`.
To add an instant hangout to an HTML component, see :ref:`Google Instant
Hangout`.
.. _Options for Editing HTML Components:
......
docs/en_us/course_authors/source/creating_content/index.rst
.. _Creating Course Content Index:
##########################
############################
Creating Course Content
##########################
############################
Use the chapters in this section to understand how to create course content of
different types.
For information on how to develop your course content in the Studio Outline
page, see :ref:`Developing Your Course Index`.
For information on creating exercises and tools, see :ref:`Exercises and Tools
Index`.
.. toctree::
:maxdepth: 2
accessibility
course_files
handouts_updates
textbooks
pages
organizing_course
create_html_component
create_video
create_discussion
......
docs/en_us/course_authors/source/creating_content/organizing_course.rst deleted 100644 → 0
.. _Organizing Your Course Content:
###############################
Organizing Your Course Content
###############################
.. _How a Course is Organized:
*************************
How a Course is Organized
*************************
You organize your course in the following hierarchy:
* :ref:`Sections`, which contain
* :ref:`subsections`, which contain
* :ref:`units`, which contain
* :ref:`components`, which contain your actual course content.
Studio provides you with flexibility when organizing your course. A common
course model is for sections to correspond to weeks or chapters, and for
subsections to correspond to lessons.
.. note:: We recommend that you review :ref:`Guidelines for Creating Accessible
Content` before developing content for your course.
==================
The Course Outline
==================
In Studio, you view your course organization through the course outline.
To open the course outline, on the **Content** menu, click **Outline**.
The following image shows the different elements of a course outline:
.. image:: ../Images/Course_Outline.png
:alt: Image of the course outline, with call-outs for sections, subsection, and
units
The following image shows the way this course content appears in the LMS:
.. image:: ../Images/Course_Outline_LMS.png
:alt: Image of sections from the student's point of view
.. _Sections:
********
Sections
********
A section is the topmost category in your course. A section can represent a time
period in your course, a chapter, or another organizing principle. A section
contains one or more subsections.
To create a section:
#. In the course outline, click **New Section**.
#. In the field that opens at the top of the outline, enter the new section
name.
#. Click **Save**.
The new, empty section appears at the bottom of the course outline.
You can now add subsections to the section.
Whether or not students see the new section depends on the release date.
See :ref:`Publishing Your Course` for more information.
.. _Subsections:
****************
Subsections
****************
Sections are divided into subsections, which in turn contain one or more units.
A subsection may represent a topic in your course, or another organizing
principle. Subsections are sometimes called "lessons" or "learning sequences."
To create a subsection:
#. On the **Course Outline** page, under the name of the section that you want,
click **New Subsection**.
#. In the field that opens at the bottom of the section, enter the new
subsection name.
#. Click **Save**.
The new, empty subsection appears at the bottom of the section. You can then add
units to the subsection.
==================
Edit a Subsection
==================
You add and delete subsections from the **Course Outline** page. You edit a
subsection's settings on the page for that subsection. To open the page for a
subsection, click the name of the subsection on the **Course Outline** page.
On the page for the subsection, you can see all the units in the subsection.
.. image:: ../Images/subsection.png
:alt: Image of the subsection page
You can also do the following.
- Change the subsection name
- Add or delete a unit
- Set the subsection release date and time
- Set the subsection to be an assignment type
- Set a due date for the exercises in the subsection (if you set the assignment
type of the subsection)
- Preview a draft of the subsection
- View the live version of your course
Whether students can see a subsection depends on its release date. For more
information, see :ref:`Publishing Your Course`.
For more information about setting assignment types, see :ref:`Establish a
Grading Policy`.
For more information about viewing drafts or the current version of your course,
see :ref:`Preview Your Course` and :ref:`View Your Live Course`.
.. _Units:
******
Units
******
Subsections are divided into units. A unit, in turn, contains one or more
components, such as HTML content, problems, and videos.
In the LMS, each unit in the subsection appears as a link on the course ribbon
at the top of the page. The following image shows a subsection that has eight
units:
.. image:: ../Images/Units_LMS.png
:alt: Image of units from a student's point of view
The titles in the pop-up dialog, in white text on a black background, are the
display names of the components in that unit.
You can create a unit from the course outline or the subsection page. To create
a unit, click **New Unit** within the subsection that you want.
When you create a new unit, a page opens for that unit. On the unit page, you
can do the following.
- Enter the unit name that you want in the **Display Name** field. Note that
students do not see the unit name.
- Create components in the unit.
- Change the visibility of the unit. By default, the unit visibility is set to
**Private**, so students will not be able to see the unit.Unless you want
students to see the unit immediately, leave this setting as-is. For more
information, see :ref:`Publishing Your Course`.
- Preview a draft of the unit.
- If a unit has been published, view the live version of the unit.
After you create a new unit, you can create components in the unit.
.. warning::
Studio does not have versioning and does not automatically update your browser
between refreshes. Versioning is planned for future releases, but, in the
meantime, only one author should edit a unit, in one browser, on only one tab.
If a unit is open for editing in multiple browser sessions, the session that
saves last will overwrite any previously saved content without displaying a
warning. Also, older browser sessions can overwrite more recent content, so
you should refresh your browser before you start working every time you work
with a private unit or edit a draft of a public unit.
.. _Components:
**********
Components
**********
A component is the part of a unit that contains your actual course content. A
unit can contain one or more components.
A student can view the name of all components in a unit by hovering over the
unit in the ribbon at the top of the page.
.. image:: ../Images/ComponentNames_CourseRibbon.png
:alt: Image of the component list for a unit
By default, Studio includes four types of components.
- **Discussion components** provide discussion spaces in the body of your
course. Students can explore ideas about a lesson with their peers in a
discussion space.
- **HTML components** allow you to add text, images, and some types of learning
tools to your course. Content in HTML components is formatted as HTML.
- **Problem components** enable you to add many different types of exercises and
problems to you course, from simple multiple choice problems to complex
circuit schematic exercises.
- **Video components** contain the videos that you want to include in your course.
To add a component to the unit, click the component type that you want under
**Add New Component**.
.. image:: ../Images/AddNewComponent.png
:alt: Image of adding a new component
For more information, see the documentation for the specific component type that
you want:
- :ref:`Working with Discussion Components`
- :ref:`Working with HTML Components`
- :ref:`Working with Problem Components`
- :ref:`Working with Video Components`
==================
Edit a Component
==================
You can edit a component only if the unit that contains it is Private, or if you
are editing a new draft of the unit. For more information, see :ref:`Public and
Private Units`.
When you can edit the component, the Edit icon and the Display Name appear in
the component header:
.. image:: ../Images/unit-edit.png
:alt: Image of a unit with Edit icon circled
Click the Edit icon. Then follow instructions for the type of component you are
editing.
=====================================
Set the Display Name for a Component
=====================================
Each component has a display name that shows in the component header when you
can edit the component. The display name also shows to students when they hover
the mouse pointer over the unit icon in the course accordion.
To set the display name for a component:
#. Edit the component.
#. Click **Settings**.
#. Edit the **Display Name** field.
.. image:: ../Images/display-name.png
:alt: Image of the Display Name field for a component.
4. Click **Save**.
Different types of components have different fields in the Settings dialog box,
but all have the **Display Name** field.
======================
Duplicate a Component
======================
You can duplicate a component only if the unit that contains it is Private, or
if you are editing a new draft of the unit. For more information, see
:ref:`Public and Private Units`.
When you duplicate a component, a new copy of that component is added directly
beneath the first component. You can then modify the duplicate. In many cases,
duplicating a component and editing a copy is a faster way to create new
content.
When you can duplicate the component, the Duplicate icon appears in the
component header:
.. image:: ../Images/unit-dup.png
:alt: Image of a unit with Duplicate icon circled
Click the Duplicate icon. Then follow instructions for the type of component
you are editing.
======================
Delete a Component
======================
You can delete a component only if the unit that contains it is Private, or if
you are editing a new draft of the unit. For more information, see :ref:`Public
and Private Units`.
.. note:: Be sure you want to delete the component. You can not undo the
deletion.
When you can delete the component, the Delete icon appears in the component
header:
.. image:: ../Images/unit-delete.png
:alt: Image of a unit with Delete icon circled
Click the Delete icon. Then follow instructions for the type of component you
are editing.
.. _Reorganize Your Course:
**********************
Reorganize Your Course
**********************
You can reorganize your course by dragging and dropping sections, subsections,
units, and components. You can move elements on the **Course Outline** page or
on an individual unit page.
To move an element, hover over the element handle on the right side of the
screen until the mouse pointer changes to a four-headed arrow. Then, click and
drag the element to the location that you want.
.. image:: ../Images/DragAndDropExample.png
:alt: Image of the course outline, with the handle for a unit selected for drag
and drop
When you move an element, a blue line indicates where the element will land when
you release the mouse.
.. image:: ../Images/DragAndDrop_BlueLine.png
:alt: Image of the course outline, with a unit being dragged to a different
location
\ No newline at end of file
docs/en_us/course_authors/source/developing_course/controlling_content_visibility.rst 0 → 100644
.. _Controlling Content Visibility:
###################################
Controlling Content Visibility
###################################
As course staff, you must carefully control which content is visible to
students and when.
You control content visibility through these features in Studio:
* `Release Dates`_
* `Unit Publishing Status`_
* `Content Hidden from Students`_
These features work together to control content visibility for students.
.. _Release Dates:
***********************
Release Dates
***********************
You schedule release dates for sections and subsections. By default, a
subsection inherits the release date of the section it is in, though you can
change it to another date.
By defining release dates, you can ensure that content is available to students
as planned without requiring manual intervention at that future time.
Published units are not visible to students until the scheduled release date.
When the section and subsection have different release dates, published units
are not visible until both dates have passed.
Prior to the release date, content is visible to course staff
:ref:`previewing the course <Preview Course Content>` or :ref:`viewing the live
course as staff<View Your Live Course>`.
See:
* :ref:`Set a Section Release Date`
* :ref:`Set a Subsection Release Date`
***********************
Unit Publishing Status
***********************
You publish units to make them visible to students. Students see the last
published version of a unit if the section and subsection it is in are
released.
Students do not see units that have never been published, and they do not see
unpublished changes to units or components within units. Therefore, you can
make changes to units in released subsections without disrupting the student
experience.
For more information, see :ref:`Unit Publishing Status`.
.. _Content Hidden from Students:
*****************************
Content Hidden from Students
*****************************
You can :ref:`hide any unit from students<Hide a Unit from Students>`,
regardless of the parent section and subsection's release dates.
You might hide a unit from students, for example, when that unit contains an
answer to a problem in that subsection. After the problem due date, you could
make the unit with the answer visible.
\ No newline at end of file
docs/en_us/course_authors/source/developing_course/course_components.rst 0 → 100644
.. _Developing Course Components:
###################################
Developing Course Components
###################################
This chapter describes how you develop course components. See:
* `What is a Component?`_
* `Add a Component`_
* `Edit a Component`_
* `Duplicate a Component`_
* `Delete a Component`_
For more information about specific component types, see:
* :ref:`Creating Course Content Index`
* :ref:`Exercises and Tools Index`
********************
What is a Component?
********************
A component is the part of a unit that contains your actual course content. A
unit can contain one or more components.
A student can view the name of all components in a unit by hovering over the
unit in the ribbon at the top of the page.
.. image:: ../Images/ComponentNames_CourseRibbon.png
:alt: Image of the component list for a unit
By default, Studio includes four types of components.
* **Discussion components** provide discussion spaces in the body of your
course. Students can explore ideas about a lesson with their peers in a
discussion space.
* **HTML components** allow you to add text, images, and some types of learning
tools to your course. Content in HTML components is formatted as HTML.
* **Problem components** enable you to add many different types of exercises
and problems to you course, from simple multiple choice problems to complex
circuit schematic exercises.
* **Video components** contain the videos that you want to include in your
course.
.. _Add a Component:
********************
Add a Component
********************
To add a component to the unit, click the component type that you want under
**Add New Component**.
.. image:: ../Images/AddNewComponent.png
:alt: Image of adding a new component
For more information, see the documentation for the specific component type
that you want:
- :ref:`Working with Discussion Components`
- :ref:`Working with HTML Components`
- :ref:`Working with Problem Components`
- :ref:`Working with Video Components`
After you add a component, it is not visible to students until you
:ref:`publish the unit<Publish a Unit>`.
.. _Edit a Component:
********************
Edit a Component
********************
To edit a component, click **Edit**:
.. image:: ../Images/unit-edit.png
:alt: Image of a unit with Edit icon circled
Then follow instructions for the type of component you are editing.
After you edit a component, the changes are not visible to students until you
:ref:`publish the unit<Publish a Unit>`.
=====================================
Set the Display Name for a Component
=====================================
Each component has a display name that shows in the component header when you
can edit the component. The display name also shows to students when they hover
the cursor over the unit icon in the course ribbon.
To set the display name for a component:
#. Edit the component.
#. Click **Settings**.
#. Edit the **Display Name** field.
.. image:: ../Images/display-name.png
:alt: Image of the Display Name field for a component.
4. Click **Save**.
Different types of components have different fields in the Settings dialog box,
but all have the **Display Name** field.
.. _Duplicate a Component:
**********************
Duplicate a Component
**********************
When you duplicate a component, a new copy of that component is added directly
beneath the first component. You can then modify the duplicate. In many cases,
duplicating a component and editing a copy is a faster way to create new
content.
To duplicate a component, click the Duplicate icon in the component header:
.. image:: ../Images/unit-dup.png
:alt: Image of a unit with Duplicate icon circled
Then follow instructions for the type of component you are editing.
After you duplicate a component, the new component is not visible to students
until you :ref:`publish the unit<Publish a Unit>`.
.. _Delete a Component:
**********************
Delete a Component
**********************
.. note::
Be sure you want to delete the component. You can not undo the deletion.
To delete a component:
#. Click the Delete icon in the component header:
.. image:: ../Images/unit-delete.png
:alt: Image of a unit with Delete icon circled
2. When you receive the confirmation prompt, click **Yes, delete this
component**.
After you delete a component, the component remians visible to students until you :ref:`publish the unit<Publish a Unit>`.
\ No newline at end of file
docs/en_us/course_authors/source/developing_course/course_outline.rst 0 → 100644
.. _Developing Your Course Outline:
###################################
Developing Your Course Outline
###################################
As you develop your course, you work primarily in the edX Studio course
outline. This chapter includes the following information about working with
the course outline:
* `Open the Course Outline`_
* `Example of a Developed Course in the Outline`_
* `View the Course Organization as a Student`_
* `Navigate the Course Outline`_
* `Add Content in the Course Outline`_
* `Reorganize the Course Outline`_
* `Delete Content in the Course Outline`_
See the following chapters for information about working with the course
building blocks in the course outline:
* :ref:`Developing Course Sections`
* :ref:`Developing Course Subsections`
* :ref:`Developing Course Units`
* :ref:`Developing Course Components`
****************************
Open the Course Outline
****************************
To view the course outline:
#. Log in to edX Studio.
#. In the **My Courses** page, select the course you want to develop.
The course outline opens by default when you open a course.
When working in a course, to open the outline, from the **Content** menu,
select **Outline**.
The first time you view an outline for a course, it contains no content.
.. image:: ../Images/outline_empty.png
:alt: An empty course outline
You must :ref:`create the first section<Create a Section>`.
********************************************************
Example of a Developed Course in the Outline
********************************************************
The following example shows a sample course in the outline, with indications
for sections, subsections, and units. As you develop your course, it will begin
to look like this example:
.. image:: ../Images/outline-callouts.png
:alt: An outline with callouts for sections, subsections, and units
As this example shows, the course is organized into the following levels:
#. :ref:`Sections<Developing Course Sections>`
#. :ref:`Subsections<Developing Course Subsections>`
#. :ref:`Units<Developing Course Units>`
:ref:`Components<Developing Course Components>` are not shown in the outline. You add or access components by clicking on the units that contain them.
Use the links above for more information and instructions on working with each
type of object in the course. The rest of this chapter provides more detail
about the course outline.
********************************************************
View the Course Organization as a Student
********************************************************
The content you see in the outline in Studio is displayed to students in the
Courseware tab in the LMS. The following image shows how a student sees your
course content:
.. image:: ../Images/Course_Outline_LMS.png
:alt: Image of course conent from student's point of view
.. _Navigating the Course Outline:
*******************************
Navigate the Course Outline
*******************************
In Studio, you navigate the course outline by expanding and collapsing sections
and subsections. Use the drop-down icon next to a section or subsection name
to expand or collapse its contents:
.. image:: ../Images/outline-expand-collapse.png
:alt: The outline with expand and collapse icons circled
When you expand a subsection, all units in the subsection are visible:
.. image:: ../Images/outline-with-units.png
:alt: The outline with an expanded subsection
Click the name of a unit to open the :ref:`unit page<Developing Course Units>`.
.. _Add Content in the Course Outline:
************************************************
Add Content in the Course Outline
************************************************
You add sections, subsections, and units directly in the outline.
To add a section to the end of the outline, click **New Section** at the top of
the outline page or at the bottom of the outline:
.. image:: ../Images/outline-create-section.png
:alt: The outline with the New Section buttons circled
To add a subsection to the end of the section, expand the section and click
**New Subsection**:
.. image:: ../Images/outline-new-subsection.png
:alt: The outline with the New Subsection button circled
To add a unit to the end of a subsection, expand the subsection and click **New
Unit**:
.. image:: ../Images/outline-new-unit.png
:alt: The outline with the New Subsection button circled
The :ref:`unit<Developing Course Units>` page opens.
.. _Reorganize the Course Outline:
************************************************
Reorganize the Course Outline
************************************************
You can reorganize your course content by dragging and dropping sections,
subsections, and units to new locations in the outline.
To move a section, subsection, or unit, hover over the handle on the right of
the object's box until the cursor changes to a four-headed arrow. For example,
in the image below, the handle for the subsection Lesson 1 - Getting Started is
selected:
.. image:: ../Images/outline-drag-select.png
:alt: A subsection handle selected to drag it
Then, click and drag the object to the location that you want.
If you expanded the section or subsection you are moving the object to, when
you move the object, a blue line indicates where the object will land when you
release the mouse button. For example, in the image below, the subsection
Lesson 1 - Getting Started is being moved to the end of the section
Introduction:
.. image:: ../Images/outline-drag-new-location.png
:alt: A subsection being dragged to a new section
If you did not expand the section or subsection you are moving the object to,
the outline of that section or subsection turns blue when you have moved the
object to a valid location. You can then release the mouse button. For example,
in the image below, the subsection Lesson 1 - Getting Started is being moved to
the collapsed section Introduction:
.. image:: ../Images/outline-drag-new-location-collapsed.png
:alt: A subsection being dragged to a new section
.. _Delete Content in the Course Outline:
************************************************
Delete Content in the Course Outline
************************************************
You delete sections, subsections, and units from the course outline.
.. warning::
You cannot restore course content after you delete it. To ensure you do not
delete content you may need later, you can move any unused content to a
section in your course that you set to never release.
Click the delete icon in the box for the object you want to delete:
.. image:: ../Images/outline-delete.png
:alt: The outline with Delete icons circled
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
docs/en_us/course_authors/source/developing_course/course_sections.rst 0 → 100644
.. _Developing Course Sections:
###################################
Developing Course Sections
###################################
To develop sections in your course, you must first understand the following:
* `What is a Section?`_
* `Viewing Sections in the Outline`_
* `The Student View of a Section`_
* `Sections and Visibility to Students`_
* `Release Statuses of Sections`_
Section tasks:
* `Create a Section`_
* `Change a Section Name`_
* `Set a Section Release Date`_
* `Delete a Section`_
****************************
What Is a Section?
****************************
A section is the topmost category in your course. A section can represent a
time period in your course, a chapter, or another organizing principle. A
section contains one or more subsections.
********************************
Viewing Sections in the Outline
********************************
The follow example shows four sections, all collapsed, in the course outline:
.. image:: ../Images/sections-outline.png
:alt: Four sections in the outline
******************************
The Student View of a Section
******************************
Students see sections in the **Courseware** tab. Students can expand one
section at a time to see its contents. In the following example, three sections
are circled, and the third one is expanded to show its subsections:
.. image:: ../Images/sections_student.png
:alt: The students view of the course with two sections circled
************************************************
Sections and Visibility to Students
************************************************
Students cannot see any content in the section if the section's release date is
unscheduled or has not passed.
If a section's release date has passed, students can see content in the section
if:
* The release date for the subsection that contains that content has passed.
* The unit has been published.
* The unit is not hidden from students.
************************************************
Release Statuses of Sections
************************************************
As an course author, you control the release status of sections. For the
content of a section to be visible to students, the section must be released.
See the following for more information about the possible releases statuses of
sections:
* `Unscheduled`_
* `Scheduled`_
* `Released`_
* `Released with Unpublished Changes`_
* `Staff Only Content`_
========================
Unscheduled
========================
If you do not change the :ref:`course start date<The Course Start Date>`
default value, ``1/1/2030 00:00:00 UTC``, when you create a new section, its
release date will appear as ``Unscheduled``. When the section release date is
unscheduled, students cannot see any content in that section, regardless of
the publishing status of that content.
If you have modified the course start date, when you create a new section, the
default release date is the course start date.
The following example shows how an unscheduled section is displayed in the
outline, summarized with a gray bar:
.. image:: ../Images/section-unscheduled.png
:alt: An unscheduled section
To make the content available to students, you must schedule the release date.
==========
Scheduled
==========
A section that is scheduled for release on a future date will not be visible to
students until after the release date. Regardless of the publishing status of
content within the section, the entire section will not visible to students.
The following example shows how a section that is scheduled for release is
displayed in the outline, summarized with a green bar:
.. image:: ../Images/section-future.png
:alt: An section scheduled to release in the future
The scheduled date must pass for the section to be visible to students.
===========================
Released
===========================
A section that is released is visible to students; however, students see only
subsections within the section that are also released, and units that are
published.
The following example shows how a released section is displayed in the outline,
summarized with a blue bar:
.. image:: ../Images/section-released.png
:alt: An unscheduled section
==================================
Released with Unpublished Changes
==================================
If you change a unit in a released section but do not publish the changes,
students see the last published version of the modified unit.
The following example shows how a released section with unpublished changes is
displayed in the outline, with a yellow bar. The section is expanded to show
the unit with unpublished changes:
.. image:: ../Images/section-unpublished-changes.png
:alt: A section with unpublished changes
You must publish the unit for students to see the updates.
===========================
Staff Only Content
===========================
A section can contain a unit that is hidden from students and available to
staff only. That unit is not visible to students, regardless of the release
date of the section or subsection.
The following example shows how a section that contains a unit that is hidden
from students is displayed in the outline, summarized with a black bar:
.. image:: ../Images/section-hidden-unit.png
:alt: A section with a hidden unit
.. _Create a Section:
****************************
Create a Section
****************************
If you do not change the :ref:`course start date<The Course Start Date>`
default value, ``1/1/2030``, when you create a new section, its release date
will be ``Unscheduled``.
If you have modified the course start date, when you create a new section, the
default release date is the course start date.
.. caution::
If the course start date is in the past, newly created sections are
immediately visible to students.
To create a new section:
#. Click **New Section** at the top or bottom of the outline:
.. image:: ../Images/outline-create-section.png
:alt: The outline with the New Section buttons circled
A new section is added at the end of the course content, with the section
name selected.
#. Enter the name for the new section. Remember that students see the section
name in the courseware.
#. :ref:`Add subsections<Create a Subsection>` to the new section as needed.
It is recommended that you :ref:`test course content <Testing Your Course
Content>` as you create new sections.
********************************
Change a Section Name
********************************
To edit a section name, hover over the section name to show the Edit icon:
.. image:: ../Images/section-edit-icon.png
:alt: The Edit Section Name icon
Click the Edit icon next to the section name. The name field becomes editable.
Enter the new name and tab or click out of the field to save the name.
.. _Set a Section Release Date:
********************************
Set a Section Release Date
********************************
To set the section release date:
#. Click the Settings icon in the section box:
.. image:: ../Images/section-settings-box.png
:alt: The section settings icon circled
The **Settings** dialog box opens.
#. Enter the release date and time for the section:
.. image:: ../Images/section-settings.png
:alt: The section release date settings
#. Click **Save**.
For more information, see :ref:`Release Dates`.
********************************
Delete a Section
********************************
When you delete a section, you delete all subsections and units within the
section.
.. warning::
You cannot restore course content after you delete it. To ensure you do not
delete content you may need later, you can move any unused content to a
section in your course that you set to never release.
To delete a section:
#. Click the delete icon in the section that you want to delete:
.. image:: ../Images/section-delete.png
:alt: The section with Delete icon circled
2. When you receive the confirmation prompt, click **Yes, delete this
section**.
\ No newline at end of file
docs/en_us/course_authors/source/developing_course/course_subsections.rst 0 → 100644
.. _Developing Course Subsections:
###################################
Developing Course Subsections
###################################
To develop subsections in your course, you must first understand the
following:
* `What is a Subsection?`_
* `Viewing Subsections in the Outline`_
* `The Student View of a Subsection`_
* `Subsections and Visibility to Students`_
* `Release Statuses of Subsections`_
Subsection tasks:
* `Create a Subsection`_
* `Change a Subsection Name`_
* `Set a Subsection Release Date`_
* `Set the Assignment Type and Due Date for a Subsection`_
* `Delete a Subsection`_
****************************
What Is a Subsection?
****************************
Sections are divided into subsections, which in turn contain one or more units.
A subsection may represent a topic in your course, or another organizing
principle. Subsections are sometimes called “lessons” or “learning sequences.”
***********************************
Viewing Subsections in the Outline
***********************************
The following example shows three subsections in a section, all collapsed, in
the course outline:
.. image:: ../Images/subsections.png
:alt: Three collapsed subsections in the outline
*********************************
The Student View of a Subsection
*********************************
Students see subsections in the Courseware tab, listed beneath the expanded
section. In the following example, seven subsections are circled, and the first
is open.
.. image:: ../Images/subsections_student.png
:alt: The student view of the outline
************************************************
Subsections and Visibility to Students
************************************************
Students cannot see any content in a subsection if the subsection's release
date is unscheduled or has not passed.
If a subsection's release date has passed, students can see content in the
subsection if the following three conditions are met:
* The release date of the parent section has passed.
* The units have been published.
* The units are not hidden from students.
************************************************
Release Statuses of Subsections
************************************************
As a course author, you control the release status of subsections. For the
content of a subsection to be visible to students, the subsection must be
released. See the following for more information about the possible releases
statuses of subsections:
* `Scheduled with the Section`_
* `Unscheduled`_
* `Scheduled Later than the Section`_
* `Scheduled with Unpublished Changes`_
* `Released with Unpublished Changes`_
* `Released`_
==========================
Scheduled with the Section
==========================
When you create a subsection, it is set by default to release at the same time
as the section it is in. Therefore, published content in the subsection is
visible to students at the date and time the section is released.
The following example shows how an subsection in the Scheduled with Section
state is displayed in the outline, summarized with a green bar:
.. image:: ../Images/subsection-scheduled.png
:alt: A subsection scheduled to release with the section
========================
Unscheduled
========================
If the parent section is unscheduled, when you create a new subsection it
will also be unscheduled.
Regardless of the publishing status of units within the subsection, no content
in an unscheduled subsection is visible to students.
The following example shows how an unscheduled subsection is displayed in the
outline, summarized with a gray bar:
.. image:: ../Images/subsection-unscheduled.png
:alt: An unscheduled subsection
Content in the subsection is not visible to students until you set a release
date and the date passes.
===================================
Scheduled Later than the Section
===================================
You can set a subsection to release on a date after the section releases.
Content in a subsection that is scheduled for release on a future date is not
visible to students, even if some or all of the units in the subsection are
published.
The following example shows the way that a subsection that will release after
its parent subsection appears in the course outline:
.. image:: ../Images/subsection-scheduled-different.png
:alt: A subsection scheduled to release later than the section
The scheduled date must pass for the subsection to be visible to students.
==================================
Scheduled with Unpublished Changes
==================================
You can make changes to a published unit before its parent subsection
is released.
In this situation, when the release date for the subsection passes, the last
published version of units within the subsection are made visible to students.
The changes in units are not visible to students until you publish them.
The following example shows how a scheduled subsection with unpublished changes
is displayed in the outline, summarized with a yellow bar:
.. image:: ../Images/section-scheduled-with-changes.png
:alt: A scheduled subsection with unpublished changes
==================================
Released with Unpublished Changes
==================================
If you modify a unit within a released subsection, those modifications are not
visible to students until you publish them.
The following example shows how a released section that has unpublished changes
appears in the outline, summarized with a yellow bar:
.. image:: ../Images/section-released-with-changes.png
:alt: A released subsection with unpublished changes
===========================
Released
===========================
A subsection that is released is visible to students; however, students see
only units within the subsection that are published.
The following example shows how a released subsection is displayed in the
outline, summarized with a blue bar:
.. image:: ../Images/subsection-released.png
:alt: A released subsection
===========================
Staff Only Content
===========================
A subsection can contain a unit that is hidden from students and available to
staff only. That unit is not visible to students, even if the subsection has
been released.
The following example shows how an subsection that contains a unit that is
hidden from students is displayed in the outline, summarized with a black bar:
.. image:: ../Images/section-hidden-unit.png
:alt: A section with a hidden unit
.. _Create a Subsection:
****************************
Create a Subsection
****************************
To create a new subsection:
#. In the outline, expand the section in which you want to create a new
subsection.
#. Click **New Subsection** at the bottom of the expanded section. A new
subsection is added at the end of the section, with the subsection name
selected.
#. Enter the name for the new subsection. Remember that students see the
subsection name in the courseware.
#. :ref:`Add units<Create a Unit>` to the new subsection as needed.
It is recommended that you :ref:`test course content <Testing Your Course
Content>` as you create new subsections.
********************************
Change a Subsection Name
********************************
To change a subsection name, click the Edit icon next to the subsection name.
The name field becomes editable. Enter the new name and tab or click out of the
field to save the name.
.. _Set a Subsection Release Date:
********************************
Set a Subsection Release Date
********************************
To set the subsection release date:
#. Click the Settings icon in the subsection box:
.. image:: ../Images/subsections-settings-icon.png
:alt: The subsection settings icon circled
The **Settings** dialog box opens.
#. Enter the release date and time for the section:
.. image:: ../Images/subsection-settings.png
:alt: The subsection release date settings
#. Click **Save**.
For more information, see :ref:`Release Dates`.
.. _Set the Assignment Type and Due Date for a Subsection:
********************************************************
Set the Assignment Type and Due Date for a Subsection
********************************************************
You set the assignment type for problems at the subsection level.
When you set the assignment type for a subsection, all problems within the
subsection are graded and weighted as a single type. For example, if you
designate the assignment type for a subsection as **Homework**, then all
problem types in that subsection are graded as homework.
To set the assignment type and due date for a subsection:
#. Click the Settings icon in the subsection box:
.. image:: ../Images/subsections-settings-icon.png
:alt: The subsection settings icon circled
The Settings dialog box opens.
#. Select the assignment type for this subsection in the **Grade as** field:
.. image:: ../Images/subsection-settings-grading.png
:alt: The subsection settings with the assignment type and due date circled
#. Enter or select a due date and time for problems in this subsection.
#. Click **Save**.
For more information, see :ref:`Establish a Grading Policy`.
.. _Delete a Subsection:
********************************
Delete a Subsection
********************************
When you delete a subsection, you delete all units within the subsection.
.. warning::
You cannot restore course content after you delete it. To ensure you do not
delete content you may need later, you can move any unused content to a
section in your course that you set to never release.
To delete a subsection:
#. Click the delete icon in the subsection that you want to delete:
.. image:: ../Images/subsection-delete.png
:alt: The subsection with Delete icon circled
2. When you receive the confirmation prompt, click **Yes, delete this
subsection**.
\ No newline at end of file
docs/en_us/course_authors/source/developing_course/course_units.rst 0 → 100644
.. _Developing Course Units:
###################################
Developing Course Units
###################################
When working with units in the course outline, ensure you understand the
following:
* `What is a Unit?`_
* `Viewing Units in the Outline`_
* `Viewing the Unit Page`_
* `Viewing Units as a Student`_
* `Unit Publishing Status and Visibility to Students`_
* `Unit Publishing Status`_
When developing your course, you perform the following tasks with units:
* `Create a Unit`_
* `Edit a Unit`_
* `Preview a Unit`_
* `Publish a Unit`_
* `Discard Changes to a Unit`_
* `View a Published Unit`_
* `Hide a Unit from Students`_
* `Delete a Unit`_
You add content to units with :ref:`course components<Developing Course
Components>`.
.. _What is a Unit?:
****************************
What is a Unit?
****************************
A unit is a part of a :ref:`subsection<Developing Course Subsections>` that
students view as a single page.
A unit contains one or more :ref:`components<Developing Course Components>`,
such as :ref:`HTML content<Working with HTML Components>`,
:ref:`problems<Working with Problem Components>`, :ref:`discussions<Working
with Discussion Components>`, and
:ref:`videos<Working with Video Components>`.
****************************
Viewing Units in the Outline
****************************
To view units in the outline, you :ref:`expand<Navigating the Course Outline>`
the parent section and subsection:
.. image:: ../Images/outline-callouts.png
:alt: An outline with callouts for sections, subsections, and units
****************************
Viewing the Unit Page
****************************
When you click on a unit name in the outline, the **Unit** page opens.
The following example shows a unit page with two components, with circles and
text to show different areas and controls in the page.
.. image:: ../Images/unit-page.png
:alt: The Unit page
****************************
Viewing Units as a Student
****************************
To a student using the edX Learning Management System, each unit in the
subsection appears as a link on the course ribbon at the top of the page. The
active unit is open beneath the course ribbon.
The following image shows a subsection that has seven units, which are circled
in the ribbon above the video, with the first unit open:
.. image:: ../Images/Units_LMS.png
:alt: Image of units from the student's point of view
.. _The Unit Workflow:
************************************************
The Unit Workflow
************************************************
When you have set up the :ref:`section<Developing Course Sections>` and
:ref:`subsection<Developing Course Subsections>` in the course outline, you
then work with units.
The typical workflow is:
#. :ref:`Create a new unit<Create a Unit>`.
#. :ref:`Add components to the unit<Add a Component>`.
#. :ref:`Publish the unit<Publish a Unit>`.
After you publish the unit, you can:
#. :ref:`Modify components in the unit<Developing Course Components>`.
#. :ref:`Publish the changes to the unit<Publish a Unit>`.
The following diagram shows the typical unit development workflow:
.. image:: ../Images/workflow-create-unit.png
:alt: Diagram of the unit development workflow
As you work through these steps, the **publishing status** of the unit changes.
The publishing status controls the content available to students, along with
:ref:`release dates<Release Dates>`. See the next section for more information.
.. _Unit States and Visibility to Students:
*************************************************
Unit Publishing Status and Visibility to Students
*************************************************
The following information summarizes whether or not students can see a unit.
* Students never see a unit with the publishing status `Draft (Never
Published)`_.
* Students never see a unit with the publishing status `Visible to Staff
Only`_. See `Hide a Unit from Students`_ for more information.
* Students do not see a unit with the publishing status `Published Not Yet
Released`_ until the :ref:`release date <Release Dates>`. On the release
date, the status changes to `Published and Live`_.
* If the publishing status is `Published and Live`_, students see the current
version of the unit.
* If the publishing status is `Draft (Unpublished Changes)`_, students see the
last published version of the unit if the :ref:`release date <Release Dates>`
for the containing section and subsection has passed.
For more information, see :ref:`Controlling Content Visibility`.
.. _Unit Publishing Status:
************************************************
Unit Publishing Status
************************************************
As an course author, you work with units with the following statuses:
* `Draft (Never Published)`_
* `Published and Live`_
* `Published Not Yet Released`_
* `Draft (Unpublished Changes)`_
* `Visible to Staff Only`_
.. _Draft (Never Published):
========================
Draft (Never Published)
========================
When you create a new unit and add components to it, the unit's publishing
status is **Draft (Never Published)**, as shown in the status panel:
.. image:: ../Images/unit-never-published.png
:alt: Status panel of a unit that has never been published
In Studio, you see the version of the content that you're working on. Students
never see a unit with this status, even if the release date has passed.
Though you do not see the unit in the LMS, you can :ref:`preview the
unit<Preview Course Content>`.
You must :ref:`publish the unit<Publish a Unit>` for it to be included in the
LMS.
.. _Published and Live:
====================
Published and Live
====================
The release date for the section and subsection have passed. You've published
the unit and haven't made any changes to it. You and students both see the
current version of the unit.
.. image:: ../Images/unit-published.png
:alt: Status panel of a unit that is published
.. _Published Not Yet Released:
====================================
Published Not Yet Released
====================================
You've published the unit, but the release date hasn't passed. Students cannot
see this unit until the release date passes.
.. image:: ../Images/unit-published_unreleased.png
:alt: Status panel of a unit that is published but not released
.. _Draft (Unpublished Changes):
===========================
Draft (Unpublished Changes)
===========================
When you edit a published unit, whether or not it is released, the unit's
publishing status changes to **Draft (Unpublished Changes)**, as shown in the
status panel:
.. image:: ../Images/unit-pending-changes.png
:alt: Status panel of a unit that has pending changes
In Studio, you see the draft of the content that you're working on. If the
release date has passed, students see the last published version of the unit.
If the release date hasn't passed, students can't see your content.
You must :ref:`publish the unit<Publish a Unit>` for students to see your
changes.
You can :ref:`preview the changes to a unit<Preview Course Content>` to test
how your changes will appear to students after you publish the unit.
.. _Visible to Staff Only:
===========================
Visible to Staff Only
===========================
When you :ref:`hide a unit from students<Hide a Unit from Students>`, the
unit's publishing status changes to **Visible to Staff Only**.
Students never see a unit with this status, even if it has been published and
the release date has passed.
.. image:: ../Images/unit-unpublished.png
:alt: Status panel of a unit that has pending changes
.. _Create a Unit:
****************************
Create a Unit
****************************
You can create a unit from the outline or create a unit in the same subsection
from the unit page.
To create a unit from the outline:
#. In the outline, expand the subsection in which you want to create a new
unit.
#. Click **New Unit** at the bottom of the expanded subsection. A new
unit is added at the end of the subsection.
#. On the unit page, the unit name is selected. Edit the name as needed.
#. :ref:`Add components<Add a Component>` to the new unit as needed.
To create a new unit from a unit page:
#. In the **Unit Location** panel, click **New Unit**.
.. image:: ../Images/unit_location.png
:alt: The Unit Location panel in the Unit page
The unit page for the new unit opens automatically.
#. On the unit page, the unit name is selected. Edit the name as needed.
#. :ref:`Add components<Add a Component>` to the new unit as needed.
You must then :ref:`publish the unit<Publish a Unit>` to make it visible to
students.
.. _Edit a Unit:
**************
Edit a Unit
**************
You can edit a unit in the following ways:
* `Edit the unit name`_
* :ref:`Develop components<Developing Course Components>`
* `Reorganize Components in Units`_
When you make any of these changes, if you previously published the unit, the
state changes to `Draft (Unpublished Changes)`_. You must then :ref:`publish
the unit<Publish a Unit>` to make your edits visible to students.
==============================
Edit the Unit Name
==============================
To edit a unit name, hover over the name to show the Edit icon:
.. image:: ../Images/unit-edit-icon.png
:alt: The Edit Unit Name icon
Click the Edit icon next to the unit name. The name field becomes editable.
Enter the new name and tab or click out of the field to save the name.
==============================
Reorganize Components in Units
==============================
You can reorganize components within a unit by dragging and dropping them to
new locations.
To move a component, hover over the handle on the right of the component's box
until the cursor changes to a four-headed arrow. For example, in the image
below, the handle for the discussion component is selected:
.. image:: ../Images/unit-drag-selected.png
:alt: A discussion component selected to drag it
Then, click and drag the component to the location that you want.
A dashed outline indicates where the component will land when you release the
mouse button. For example, in the image below, the discussion component is
being moved to the top of the unit:
.. image:: ../Images/unit-drag-moved.png
:alt: A component being dragged to a new location
.. _Preview a Unit:
****************************
Preview a Unit
****************************
You preview a unit to review and test the content before it is visible to
students.
You can preview a unit before it is published and when there are unpublished
changes. When the unit is published and there are no pending changes, you
cannot preview the unit; you must view the live version of the unit.
To preview the unit, in the unit page, click **Preview Changes**.
.. image:: ../Images/preview_changes.png
:alt: The Unit page with Preview Changes button circled
The unit opens in preview mode:
.. image:: ../Images/preview_mode.png
:alt: The unit in preview mode
When you are revising a previously published unit, it is helpful to preview
your changes in one window and :ref:`view the published unit<View a Published
Unit>` in a second window.
.. _Publish a Unit:
****************************
Publish a Unit
****************************
Publishing a unit makes the current version of the unit in Studio available to
students, if the release date for the section and subsection have passed.
You publish a unit that has a status of `Draft (Never Published)`_ or `Draft
(Unpublished Changes)`_. When you publish a unit, the status changes to
`Published and Live`_ or `Published Not Yet Released`_.
To publish the unit, click **Publish** in the status panel:
.. image:: ../Images/unit-publish-button.png
:alt: Unit status panel with Publish button circled
.. _Discard Changes to a Unit:
****************************
Discard Changes to a Unit
****************************
When you modify a published unit, your changes are saved in Studio, though the
changes aren't visible to students until you publish the unit again.
In certain situations, you may decide that you never want to publish your
changes. You can discard the changes so that Studio reverts to the last
published version of the unit.
To discard changes and revert the Studio version of the unit to the last
published version, click **Discard Changes** in the status panel:
.. image:: ../Images/unit-discard-changes.png
:alt: Unit status panel with Discard Changes circled
.. caution::
When you discard changes to a unit, the changes are permanently deleted. You
cannot retrieve discarded changes or undo the action.
.. _View a Published Unit:
****************************
View a Published Unit
****************************
To view the last published version of a unit in the LMS, click **View Published
Version**.
.. image:: ../Images/unit_view_live_button.png
:alt: Unit page with View Published Version button circled
The unit page opens in the LMS in Staff view. You may be prompted to log in to
the LMS.
If the unit status is `Draft (Unpublished Changes)`_, you do not see your
changes in the LMS until you publish the unit again.
If the unit status is `Draft (Never Published)`_, the **View Published
Version** button is not enabled.
.. _Hide a Unit from Students:
****************************
Hide a Unit from Students
****************************
You can prevent students from seeing a unit regardless of the unit status or
the release schedules of the section and subsection.
To do this, select the **Hide from students** checkbox in the status panel:
.. image:: ../Images/unit-hide.png
:alt: Unit status panel with Hide from Students checked
For more information, see :ref:`Controlling Content Visibility`.
=======================================
Make a Hidden Unit Visible to Students
=======================================
To make a hidden unit visible to students, clear the **Hide from students**
checkbox.
You are prompted to confirm that you want to make the unit visible to students.
.. caution::
When you make a hidden unit that was previously published visible to
students, the current content in the unit is published. Any changes you made
to the unit when it was hidden from students will now be visible to students.
********************************
Delete a Unit
********************************
You delete a unit from the course outline.
When you delete a unit, you delete all components within the unit.
.. warning::
You cannot restore course content after you delete it. To ensure you do not
delete content you may need later, you can move any unused content to a
section in you
To delete a unit:
#. Click the delete icon in the box for the unit you want to delete:
.. image:: ../Images/section-delete.png
:alt: The section with Delete icon circled
2. When you receive the confirmation prompt, click **Yes, delete this
unit**.
\ No newline at end of file
docs/en_us/course_authors/source/developing_course/index.rst 0 → 100644
.. _Developing Your Course Index:
##########################
Developing Your Course
##########################
Use the chapters in this section to understand how to develop your course
content in the Studio Outline page.
For information on building specific course component types, see :ref:`Creating
Course Content Index`.
For information on creating exercises and tools, see :ref:`Exercises and Tools
Index`.
.. toctree::
:maxdepth: 2
workflow
course_outline
course_sections
course_subsections
course_units
course_components
controlling_content_visibility
testing_courseware
\ No newline at end of file
docs/en_us/course_authors/source/developing_course/testing_courseware.rst 0 → 100644
.. _Testing Your Course Content:
###########################
Testing Your Course Content
###########################
The way your course looks in Studio is not the way that students will see and
experience it when it is live.
It is recommended that you test your content continually as you build your
course, so you can interact with your course from a student's point of view.
To test your content, you can:
* `Preview Course Content`_
* `View Your Live Course`_
For information about setting up a beta test for your course, see
:ref:`Beta_Testing`.
.. _Preview Course Content:
*************************
Preview Course Content
*************************
You preview course content before you publish it to test how it will look to
students.
When you preview course content, you see the latest course content as
configured in Studio. You see content in units with the publishing status
:ref:`Draft (Never Published)`, :ref:`Draft (Unpublished Changes)`, or
:ref:`Visible to Staff Only`.
For example, you :ref:`publish a unit<Publish a Unit>` with a video and
discussion:
.. image:: ../Images/test-unit-studio.png
:alt: A unit in Studio with a video and discussion
Students see the same content in the LMS:
.. image:: ../Images/test-unit-lms.png
:alt: A unit in the LMS with a video and discussion
You later decide to add a multiple choice problem to the unit, before the
discussion:
.. image:: ../Images/test-unit-studio-added-comp.png
:alt: A unit in Studio with a video, problem, and discussion
Before you publish this change, you can see what the question will look to
students.
When you click **Preview Changes**, you see the unit in the LMS with
the multiple choice question:
.. image:: ../Images/test-unit-lms-added-comp.png
:alt: A unit in the LMS with a video, problem, and discussion
This preview shows how students will experience the unit after you
:ref:`publish the change<Publish a Unit>`.
In the live course, students continue to see the same content, without the
multiple choice question, until you :ref:`publish the change<Publish a Unit>`.
.. note::
**Preview Changes** in not available when the unit's state is :ref:`Published
and Live`, because in this case the preview and live version are exactly the
same. You can view the live course to see the published content.
.. _View Your Live Course:
******************************************
View Your Live Course
******************************************
When you are working in Studio, you can test your course by viewing it in the
LMS. In the LMS, you can see your course as a student sees it. You can see your
course in `Staff View`_ or `Student View`_
While you work in Studio, you can switch to your live course to see how your
course appears to students in two ways.
* From the outline page, click **View Live**.
.. image:: ../Images/test-outline-view-live.png
:alt: View live button on the outline
* In a unit page, click **View Live Version**.
.. image:: ../Images/test-unit-view-live.png
:alt: View Live Version button on the unit page
=================
Staff View
=================
You see the course in the **Staff View**.
.. image:: ../Images/Live_Course_Staff_View.png
:alt: Image of the Courseware page in a live course with Staff View indicated
at top right and a View Unit in Studio button
In **Staff View**:
* You see all units that are :ref:`Published and Live`. For units that are
:ref:`Draft (Unpublished Changes)` or :ref:`Visible to Staff Only`, you
see the last published version of the unit. You see these units
regardless of the release dates of the containing section or subsection.
* You do not see units that are :ref:`Draft (Never Published)`. To
see these units, you must use Preview mode as described in :ref:`Preview
Course Content`.
* You can access the Instructor Dashboard, which has features and reports that
help you :ref:`run your course<Running Your Course Index>`.
When you view your course in **Staff View**, you can execute tests to make sure
that your course works the way you intend. For example, before the release
date of a subsection, members of the course team can work through the problems
to verify that the correct answer gets a green check for correct, and that any
answer other than the correct one gets a red X for incorrect.
=================
Student View
=================
When viewing your course in the LMS, you can switch to student view to see the
content exactly how students will see it.
To switch from **Staff View** to **Student View** and back again, click **Staff
View** or **Student View** in the upper right corner.
.. image:: ../Images/Live_Course_Student_View.png
:alt: Image of the Courseware page in a live course with Student View
indicated at top right
In **Student View**:
* You do not see sections or subsections that have not yet been released.
* If the section and subsection are released, you see units that are
:ref:`Published and Live`. For units that are
:ref:`Draft (Unpublished Changes)`, you see the last published version of the
unit.
* You do not see units that are :ref:`Draft (Never Published)` or
:ref:`Visible to Staff Only`. To see these units, you must switch back to Instructor view or use Preview mode as described in :ref:`Preview Course Content`.
* You can access the Instructor Dashboard, which has features and reports that
help you run your course.
*************************************
Open Studio from Your Live Course
*************************************
When you are viewing your course in the LMS as **Staff View**, you can open
Studio directly.
* In a unit page, click **View Unit in Studio**.
.. image:: ../Images/Live_Studio_from_LMS_Unit.png
:alt: The View Unit in Studio button in an LMS unit
The unit page opens in Studio.
* In the Instructor Dashboard, click **View Course in Studio** to open the
course outline.
.. image:: ../Images/Live_Course_Instructor_Dashboard.png
:alt: Image of the Instructor Dashboard in a live course with a View Course
in Studio button
For information about the tasks you can complete on the Instructor Dashboard,
see :ref:`Running Your Course Index`.
* In the **Course Progress** page, click **View Grading in Studio** to open the
Grading page.
.. image:: ../Images/Student_Progress.png
:alt: Image of the Course Progress page for a student with a View Grading
in Studio button
For information about checking a student's progress, see
:ref:`Review_grades`.
\ No newline at end of file
docs/en_us/course_authors/source/developing_course/workflow.rst 0 → 100644
.. _Getting Started with Course Content Development:
###############################################
Getting Started with Course Content Development
###############################################
When you are done :ref:`setting up your course<Setting up your Course Index>`,
you are ready to build your course content.
This chapter provides an outline of the steps involved in developing your
course content, with links to more details. See:
* `Understanding Course Building Blocks`_
* `Creating New Course Content`_
* `Making Course Content Visible to Students`_
* `Revising Content`_
.. _Understanding Course Building Blocks:
************************************************
Understanding Course Building Blocks
************************************************
Before you begin, you should understand the building blocks of an edX course.
* :ref:`The course outline<Developing Your Course Outline>` is the container
for all of your course content. The outline contains one or more sections.
* :ref:`Course sections<Developing Course Sections>` are at the top level of
your course and typically represent a time period. A section contains one or
more subsections.
* :ref:`Course subsections<Developing Course Subsections>` are parts of a
section, and usually represent a topic or other organizing principle. A
subsection contains one or more units.
* :ref:`Course units <Developing Course Units>` are lessons in a subsection
that students view as single pages. A unit contains one or more components.
* :ref:`Course components<Developing Course Components>` are objects within
units that contain your actual course content.
.. _Creating New Course Content:
****************************************
Creating New Course Content
****************************************
Once you understand the way edX courses are structured, you can start
organizing your content and entering it into Studio.
You create :ref:`sections<Create a Section>`, :ref:`subsections<Create a
Subsection>`, and :ref:`units<Create a Unit>` in the :ref:`course
outline<Developing Your Course Outline>`.
For graded subsections, you also
:ref:`set the assignment type and due date<Set the Assignment Type and Due Date
for a Subsection>`.
You :ref:`create components<Add a Component>` in the unit
page.
In addition, you :ref:`control content visibility<Controlling Content
Visibility>` by setting release dates on the outline and publishing units.
The following diagram summarizes the content creation workflow:
.. image:: ../Images/workflow-create-content.png
:alt: Diagram of the content creation process
It is recommended that you :ref:`test course content <Testing Your Course
Content>` throughout the creation process.
.. _Making Course Content Visible to Students:
******************************************************
Making Course Content Visible to Students
******************************************************
When you create your content, you'll also specify if and when students will be
able to see it. Content visibility depends on several factors:
* The :ref:`course start date<The Course Start Date>`
* The release dates of the :ref:`section<Set a Section Release Date>` and
:ref:`subsection<Set a Subsection Release Date>`
* The :ref:`publishing status<Hide a Unit from Students>` of the unit
* The :ref:`Hide content from students<Hide a Unit from Students>` setting
For more information, see :ref:`Controlling Content Visibility`.
.. _Revising Content:
****************************
Revising Content
****************************
You can revise your course content at any time.
* When you :ref:`reorganize sections, subsections, and units<Reorganize the
Course Outline>` in the outline, the new order is immediately visible to
students if the section and subsection are released.
* When you :ref:`edit a unit<Edit a Unit>`, or :ref:`components<Add a
Component>` within a unit, you must :ref:`publish<Publish a Unit>` those
changes to make them visible to students.
The following diagram summarizes the content revision workflow and content
visibility:
.. image:: ../Images/workflow-revise-content.png
:alt: Diagram of the content creation process
It is recommended that you :ref:`test course content <Testing Your Course
Content>` during the revision process.
\ No newline at end of file
docs/en_us/course_authors/source/exercises_tools/index.rst
......@@ -4,6 +4,16 @@
Creating Exercises and Tools
############################
Use the chapters in this section to understand how to create exercises and
tools in your course.
For information on how to develop your course content in the Studio Outline
page, see :ref:`Developing Your Course Index`.
For information on building specific course component types, see :ref:`Creating
Course Content Index`.
.. toctree::
:maxdepth: 2
......
docs/en_us/course_authors/source/getting_started/glossary.rst
.. _Glossary:
###################################################
############
Glossary
###################################################
############
.. _A:
......@@ -84,7 +84,9 @@ C
**Component**
The part of a unit that contains your actual course content. A unit can contain one or more components. For more information, see :ref:`Components`.
The part of a unit that contains your actual course content. A unit can
contain one or more components. For more information, see :ref:`Developing
Course Components`.
.. _Course Accordion:
......@@ -152,9 +154,8 @@ D
responsible for receiving course data from edX, and transferring it securely
to researchers and other interested parties after it is received.
See `edX Research Guide`_.
.. _edX Research Guide: http://edx.readthedocs.org/projects/devdata/en/latest/
See the `edX Research
Guide<http://edx.readthedocs.org/projects/devdata/en/latest/>`.
.. _Discussion:
......@@ -229,7 +230,7 @@ F
**Forum**
See :ref:`Discussion`.
See `Discussion`_.
.. _G:
......@@ -407,19 +408,11 @@ P
**Preview Mode**
A view that allows you to see all the units of your course as students see them, regardless of whether the visibility of each unit is set to Public or Private and regardless of whether the release dates have passed.
See :ref:`Preview Your Course` for more information.
.. _Private Unit:
**Private Unit**
A unit whose **Visibility** option is set to Private so that students cannot see the unit, even if it is located in a subsection that has been released.
See :ref:`Public and Private Units` for more information.
A view that allows you to see all the units of your course as students see
them, regardless of the unit status and regardless of whether the release
dates have passed.
See :ref:`Preview Course Content` for more information.
......@@ -440,15 +433,6 @@ P
The page in the learning management system that shows students their scores on graded assignments in the course.
.. _Public Unit:
**Public Unit**
A unit whose **Visibility** option is set to Public so that the unit is visible to students, if the subsection that contains the unit has been released.
See :ref:`Public and Private Units` for more information.
.. _R:
****
......@@ -480,7 +464,7 @@ S
The topmost category in your course. A section can represent a time period in your course or another organizing principle.
See :ref:`Sections` for more information.
See :ref:`Developing Course Sections` for more information.
.. _Short Course Description:
......@@ -507,9 +491,7 @@ S
A division that represents a topic in your course, or another organizing principle. Subsections are found inside sections and contain units. Subsections can also be called "lessons."
See :ref:`Subsections` for more information.
See :ref:`Developing Course Subsections` for more information.
.. _T:
......
docs/en_us/course_authors/source/getting_started/index.rst
......@@ -11,4 +11,5 @@ Getting Started
accounts
get_started
accessibility
glossary
docs/en_us/course_authors/source/index.rst
......@@ -16,6 +16,7 @@ Building and Running an edX Course
change_log
getting_started/index
building_course/index
developing_course/index
creating_content/index
exercises_tools/index
releasing_course/index
......
docs/en_us/course_authors/source/releasing_course/beta_testing.rst
......@@ -158,9 +158,7 @@ access courseware:
+-------------------------------------------+------+------+
The course team can continue to add content in Studio after the beta test
begins. When new content is ready for testing, be sure to change the
**Visibility** setting for any units that are Private to Public. See
:ref:`Units` or :ref:`Publishing Your Course`.
begins. When new content is ready for testing, be sure to :ref:`publish the unit<Publish a Unit>`.
================================
Define When the Beta Test Starts
......
docs/en_us/course_authors/source/releasing_course/course_launching.rst
......@@ -35,7 +35,8 @@ starts follow.
**Review First Week Content**
* Verify that all units are present and published. See :ref:`Units`.
* Verify that all units are present and published. See :ref:`Developing Course
Units`.
* Check all assignments for completeness and verify their due dates. See
:ref:`Working with Problem Components`.
* Verify that videos, transcripts, and download links are in place and
......
docs/en_us/course_authors/source/releasing_course/index.rst
......@@ -7,10 +7,6 @@ Releasing Your Course
.. toctree::
:maxdepth: 2
view_course_content
set_content_releasedates
beta_testing
course_launching
staff_debug_info
d
staff_debug_info
\ No newline at end of file
docs/en_us/course_authors/source/releasing_course/set_content_releasedates.rst deleted 100644 → 0
.. _Publishing Your Course:
###########################
Publishing Your Course
###########################
When you have set up your course, established a grading system, and organized your course content,
you are ready to publish your course and make it available to students.
Understanding the content your students can view, and knowing how to change what students can view, is complex.
Read the following sections carefully:
* :ref:`Understanding Content Students Can View`
* :ref:`Release Dates`
* :ref:`Public and Private Units`
* :ref:`Modifying Public Units`
.. _Understanding Content Students Can View:
******************************************
Understanding Content Students Can View
******************************************
When you create a course on Studio, students cannot see any of your course content until the course start date has passed.
After the course start date has passed, whether a student can see your course materials depends on two settings that you can control: release dates and visibility.
* The **Release Date**. Sections and subsections have release dates. If the current date
of a section or subsection is before the release date, the content of that course element is
not yet published, and not visible to students.
For a student to view a subsection, both it and its containing section must
have a release date that is earlier than the current date. It is possible to
have a section that is released, but a subsection within that section that is
not released. In this case, students cannot view that subsection.
Course staff can see sections and subsections before the release date in the LMS.
* The unit must be **Public**. All units have a **Visibility** setting that is **Public** or **Private**.
When you create a unit, it is **Private** by default.
Students cannot view a **Private** unit, even if the containing section and subsection are released.
Students cannot view a **Public** unit if the containing section and subsection are *not* released.
Course staff *cannot* see Private units in the LMS.
In summary, for students to see content, the unit must be **Public**, and the containing section and
subsection must be released. If all these criteria are not met, students do not see that unit.
Continue reading this chapter for more details.
.. _Release Dates:
*******************
Release Dates
*******************
Release dates specify the dates when content is available to students.
Release dates are set at the section and subsection levels.
Neither a section nor its contents are visible to students until the release date passes.
However, course staff can see content in the LMS regardless of its release date.
.. note::
For courses created before January 14, 2014, when you create a new section or subsection, the default release date is January 1, 1970. This means that public units are immediately published, and you must change this date to the future to prevent students from viewing the content.
For courses created after January 14, 2014, the default release date is January 1, 2030. In this case, you must adjust the release date to the day you want students to be able to view the content.
========================================
Set the Release Date for a Section
========================================
You can set release date and time for each section.
Before the release date and time, students are not able to view any content in that section.
To set a release date for a section:
#. In the **Will Release:** field next to the section title, click **Edit**.
#. Enter the release date in MM/DD/YYYY format, and the UTC time.
#. Click **Save**.
========================================
Set the Release Date for a Subsection
========================================
Subsections inherit the release date of the section they are in, but you can
change this date so that different subsections are released at different times.
Note that if the release date for a subsection falls before the release date for
the section that contains it, students will not be able to see the subsection
until the release date for the *section* has passed. Section release dates
override subsection release dates.
To set the release date for a subsection:
#. Open the subsection.
#. Locate the **Subsection Settings** box in the top right corner.
#. Enter the release date in MM/DD/YYYY format, and the UTC time.
================================================
Synch the Release Date for a Subsection
================================================
You or other course staff could inadvertantly set the release date for a subsection
earlier than the release date for the containing section. In this situation, the subsection is
not released until the section is released.
To help you keep your course and release dates organized, Studio flags subsections with earlier release dates
than their containing section. In this situation, when you open the subsection, in the Subsection Settings,
you see the following message:
``The date above differs from the release date of <Section Name> - <Section release date and time>. Sync to <Section Name>.``
Click **Sync to <Section Name>** to have the subsection inherit the later section release date.
.. _Public and Private Units:
*************************
Public and Private Units
*************************
Units are released at the release date of the subsection they are in.
In addition, unites have a **Visibility** setting that you can set to **Public** or
**Private**.
When you create a unit, it is Private by default.
A Private unit is never visible to students, even if it is contained by a subsection that has been released.
When you change the visibility setting of a unit from Private to Public, you publish the unit and its contents.
You must set the Visibility to Public for students to be able to see the unit.
Course staff cannot see Private units in the LMS.
.. _Modifying Public Units:
*************************
Modifying Public Units
*************************
To make revisions to a unit that has been published, you create and edit a draft of that unit.
.. Warning::
There are additional implications to modifying a public unit that has graded
problem components students may have already completed. See :ref:`Modifying a
Released Problem` for more information.
To create a draft, go to the unit's page, and then click **edit a draft** in the right pane.
.. image:: ../Images/Viz_Revise_EditDraft.png
:width: 800
:alt: Image of a public unit with the edit a draft link circled
When you edit a draft of a unit, you can view the unit's contents in two ways.
* To view the already-published content as it appears in the live course, click **View the Live Version** in the upper-right corner of the page.
* To view the unpublished content as you're working on it, click **Preview**.
.. image:: ../Images/Viz_Revise_ViewLiveandPreview.png
:alt: Image of draft unit
When you're ready to publish the draft of your revised content,
click **replace it with this draft** in the right pane.
If you decide you don't want to keep the revised content, click **Delete Draft**.
.. image:: ../Images/Viz_Revise_ReplaceorDelete.png
:alt: Image of a unit settings panel with the replace it with this draft link circled
.. Warning:: Historical versions of units are not stored by Studio. After you replace the live version with a new draft, you cannot revert the unit to the previous version.
\ No newline at end of file
docs/en_us/course_authors/source/releasing_course/view_course_content.rst deleted 100644 → 0
.. _Testing Your Course:
###########################
Testing Your Course
###########################
The way your course looks in Studio is not the way students see and experience it. To test your course, while you develop course content and afterward, you must view and interact with your course from a student's point of view.
From within Studio, you can:
* :ref:`Preview Your Course`
* :ref:`View Your Live Course`
For information about setting up a beta test for your course, see :ref:`Beta_Testing`.
.. _Preview Your Course:
***********************
Preview Your Course
***********************
When you view your course through Preview mode, you see all the
units of your course, regardless of whether they are set to Public or
Private and regardless of whether the release dates have passed.
Using Preview mode is the only way to see content that is set to Private
**as a student would see it.**
You can enter Preview mode in two ways.
* On any subsection page, click **Preview Drafts**.
.. image:: ../Images/preview_draft.png
:width: 800
:alt: Image of a subsection with the Preview Drafts button circled
* On any Unit page, click **Preview**.
The following example shows the **Preview** button for a unit that
is set to Public.
.. image:: ../Images/preview_public.png
:width: 800
:alt: Image of a public unit with the Preview button circled
The following example shows the **Preview** button for a unit that
is set to Private.
.. image:: ../Images/preview_private.png
:width: 800
:alt: Image of a private unit with the Preview button circled
.. _View Your Live Course:
******************************************
Switch Between Studio and Your Live Course
******************************************
While you work in Studio, you can switch to your live course to see how your course appears to students. Because you are logged in as a course team member, when you switch to your live course you see the **Staff View**.
.. image:: ../Images/Live_Course_Staff_View.png
:width: 800
:alt: Image of the Courseware page in a live course with Staff View indicated at top right and a View Unit in Studio button
In **Staff View**:
* You see all of the units that are set to **Public**, regardless of the release dates of the containing section or subsection.
* You do not see units that are set to **Private**. To see Private units, you must use Preview mode as described in :ref:`Preview Your Course`.
* You can access the Instructor Dashboard, which has features and reports that help you run your course.
.. DOC-311 filed to add info about student vs. staff view
.. You can also change to **Student View**. In **Student View**, the release date settings for sections and subsections apply. You can still access the Instructor Dashboard, however.
.. To switch from **Staff View** to **Student View** and back again, click **Staff View** or **Student View**.
When you view your live course in **Staff View**, you can execute tests to make sure your course works the way you intend. For example, the course team can work through all of the problems to verify that the correct answer gets a green check for correct, and that any answer other than the correct one gets a red X for incorrect.
======================================
Go to Your Live Course from Studio
======================================
To switch from Studio to your live course, click **View Live** on any of these pages:
* The **Course Outline** page.
.. image:: ../Images/course_outline_view_live.png
:width: 800
:alt: Image of the course outline with the View Live button circled
* Any Subsection page.
.. image:: ../Images/subsection_view_live.png
:width: 800
:alt: Image of a subsection with the View Live button circled
* The Unit page, if the Unit is Public.
.. image:: ../Images/unit_view_live.png
:width: 800
:alt: Image of a unit with the View Live button circled
When you click **View Live**, the **Courseware** page or the corresponding subsection or unit page opens.
====================================
Go to Studio from Your Live Course
====================================
To switch from your live course to Studio, click **View {page} in Studio** on any of these pages:
* Any unit (shown in the :ref:`View Your Live Course` section above).
* The Instructor Dashboard.
.. image:: ../Images/Live_Course_Instructor_Dashboard.png
:width: 800
:alt: Image of the Instructor Dashboard in a live course with a View Course in Studio button
For information about the tasks you can complete on the Instructor Dashboard, see :ref:`Running Your Course Index`.
* The **Course Progress** page for a specified student.
.. image:: ../Images/Student_Progress.png
:width: 800
:alt: Image of the Course Progress page for a student with a View Grading in Studio button
For information about checking a student's progress, see :ref:`Review_grades`.
\ No newline at end of file
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment