Skip to content

E
edx-platform
Commit c303687b by Mark Hoeber
Options

Merge pull request #2100 from edx/markhoeber/documentation/stud-1034 

Updates for 1-7-2014 release changes in Studio -- Outline and Files pages
parents afaa463f 628cc8b0
Showing with 105 additions and 60 deletions
docs/course_authors/source/change_log.rst
...@@ -8,10 +8,14 @@ Change Log ...@@ -8,10 +8,14 @@ Change Log
============== ================================================================ ============== ================================================================
DATE CHANGE DATE CHANGE
============== ================================================================ ============== ================================================================
12/05/2013 Complete revision of edX Studio documentation and integration 01/01/2014 Updated the chapters :ref:`Organizing Your Course Content` and
:ref:`Testing Your Course` to reflect changes in the Course Outline design.
01/01/2014 Updated the topic :ref:`Add Files to a Course` to reflect addition of
pagination to the Files & Uploads page.
12/10/2013 Added the appendix :ref:`MathJax in Studio`.
12/11/2013 Added the chapter :ref:`Guidelines for Creating Accessible Content`
12/12/2013 Added the edX :ref:`Glossary`
12/05/2013 Complete revision of edX Studio documentation and integration
of edX101 content. of edX101 content.
12/10/2013 Added MathJax appendix
12/11/2013 Added Accessibility chapter
12/12/2013 Added Glossary
============== ================================================================ ============== ================================================================
docs/course_authors/source/create_new_course.rst
...@@ -151,6 +151,10 @@ Describe Your Course ...@@ -151,6 +151,10 @@ Describe Your Course
The description of your course appears on the Course Summary page that students see, and includes a course summary, prerequisites, staff information and FAQs. The description of your course appears on the Course Summary page that students see, and includes a course summary, prerequisites, staff information and FAQs.
For courses on edX.org, the description is shown in the course catalog.
On Edge, there is no course catalog and users will not find your course description. You must explicitly invite students to participate in your course for them to find the description.
#. From the **Settings** menu, select **Schedule & Details**. #. From the **Settings** menu, select **Schedule & Details**.
#. Scroll down to the **Introducing Your Course** section, then locate the **Course Overview** field. #. Scroll down to the **Introducing Your Course** section, then locate the **Course Overview** field.
...@@ -232,6 +236,25 @@ To add a file: ...@@ -232,6 +236,25 @@ To add a file:
#. To close the dialog box, click the **x** in the top right corner. #. To close the dialog box, click the **x** in the top right corner.
When you close the dialog box, the new files appear on the **Files & Uploads** page. When you close the dialog box, the new files appear on the **Files & Uploads** page.
==================
Find Files
==================
Files are sorted by the Date Added column, with the most recently added first.
The **Files & Uploads** page lists up to 50 files. If your course has more the 50 files, additional files are listed in other pages.
The range of the files listed on the page, and the total number of files, are shown at the top of the page.
You can navigate through the pages listing files in two ways:
* Use the **<** and **>** buttons at the top and bottom of the list to navigate to the previous and next pages.
* At the bottom of the page, enter the page number to skip to, then tab out of the field:
.. image:: Images/file_pagination.png
================== ==================
Get the File URL Get the File URL
......
docs/course_authors/source/get_started.rst
...@@ -20,6 +20,7 @@ This chapter describes the tools you use to build an edX course, and how to crea ...@@ -20,6 +20,7 @@ This chapter describes the tools you use to build an edX course, and how to crea
* :ref:`Use Studio on Edge` * :ref:`Use Studio on Edge`
* :ref:`Create Your First Course` * :ref:`Create Your First Course`
* :ref:`View Your Course on Edge` * :ref:`View Your Course on Edge`
* :ref:`What is edX.org?`
* :ref:`Register Your Course on edX.org` * :ref:`Register Your Course on edX.org`
If you are using an instance of Open edX, some specifics in this chapter may not apply. If you are using an instance of Open edX, some specifics in this chapter may not apply.
...@@ -47,6 +48,8 @@ What is Edge? ...@@ -47,6 +48,8 @@ What is Edge?
EdX Edge_ is the site where you can create courses with Studio, then run courses through the edX Learning Management System. EdX Edge_ is the site where you can create courses with Studio, then run courses through the edX Learning Management System.
EdX Edge_ is also used to host SPOCs, or Small Private Online Courses.
Visually and functionally, edX Edge is the same as edX.org_. Visually and functionally, edX Edge is the same as edX.org_.
However, on Edge you can freely publish courses. However, on Edge you can freely publish courses.
There is no course catalog on Edge and other users will not find your course. You must explicitly invite students to participate in your course. There is no course catalog on Edge and other users will not find your course. You must explicitly invite students to participate in your course.
...@@ -157,6 +160,20 @@ You can view the course and see that there is no content yet. ...@@ -157,6 +160,20 @@ You can view the course and see that there is no content yet.
To build your course, keep reading this document. To build your course, keep reading this document.
.. _What is edX.org?:
*******************
What is edX.org?
*******************
edX.org_ is the site where edX hosts MOOCs, or Massive Open Online Courses, that are created with our institutional partners. These courses are open to students from around the world.
Courses on edX.org_ are listed publicly.
To publish courses on edX.org, you must have an agreement with edX and specific approval from your university.
.. _Register Your Course on edx.org: .. _Register Your Course on edx.org:
************************************ ************************************
......
docs/course_authors/source/index.rst
...@@ -12,6 +12,7 @@ Contents ...@@ -12,6 +12,7 @@ Contents
:maxdepth: 5 :maxdepth: 5
read_me read_me
change_log
get_started get_started
create_new_course create_new_course
establish_grading_policy establish_grading_policy
...@@ -32,7 +33,7 @@ Contents ...@@ -32,7 +33,7 @@ Contents
checking_student_progress checking_student_progress
ora_students ora_students
glossary glossary
change_log
......
docs/course_authors/source/organizing_course.rst
...@@ -19,7 +19,7 @@ You organize your course in the following hierarchy: ...@@ -19,7 +19,7 @@ You organize your course in the following hierarchy:
Studio provides you with flexibility when organizing your course. Studio provides you with flexibility when organizing your course.
A common course model is for Sections to correspond to weeks, and for Subsections to correspond to lessons. A common course model is for sections to correspond to weeks, 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. .. note:: We recommend that you review :ref:`Guidelines for Creating Accessible Content` before developing content for your course.
...@@ -48,18 +48,18 @@ The following example shows how a student would view this course content: ...@@ -48,18 +48,18 @@ The following example shows how a student would view this course content:
Sections Sections
******** ********
A Section is the topmost category in your course. A Section can represent a time-period in your course, or another organizing principle. A section is the topmost category in your course. A Section can represent a time-period in your course, or another organizing principle.
To create a Section: To create a section:
#. In the Course Outline, click **New Section**. #. In the Course Outline, click **New Section**.
#. In the field that opens at the top of the outline, enter the new Section name. #. In the field that opens at the top of the outline, enter the new Section name.
#. Click **Save**. #. Click **Save**.
The new, empty Section is placed at the bottom of the course outline. The new, empty section is placed at the bottom of the course outline.
You must now add Subsections to the Section. You must now add subsections to the section.
Whether or not students see the new Section depends on the release date. Whether or not students see the new section depends on the release date.
See :ref:`Publishing Your Course` for more information. See :ref:`Publishing Your Course` for more information.
.. _Subsections: .. _Subsections:
...@@ -68,54 +68,54 @@ See :ref:`Publishing Your Course` for more information. ...@@ -68,54 +68,54 @@ See :ref:`Publishing Your Course` for more information.
Subsections Subsections
**************** ****************
Sections are divided into Subsections. A Subsection may represent a topic in your course, or another organizing principle. Sections are divided into subsections. A subsection may represent a topic in your course, or another organizing principle.
You can set a Subsection to an assignment type that you created when You can set a subsection to an assignment type that you created when
you set up grading. You can then include assignments in the body of that you set up grading. You can then include assignments in the body of that
Subsection. For more information on grading, see LINK. subsection. See :ref:`Establish a Grading Policy` for more information on grading.
To create a Subsection: To create a Subsection:
#. Within the Section, click **New Subsection**. #. At the bottom of the section, click **New Subsection**.
#. In the field that opens at the bottom of the section, enter the new Subsection name. #. In the field that opens, enter the new Subsection name.
#. Click **Save**. #. Click **Save**.
The new, empty Subsection is placed at the bottom of the Section. The new, empty subsection is placed at the bottom of the section.
You must now add Units to the Subsection. You must now add Units to the subsection.
Whether or not students see the new Subsection depends on its release date. Whether or not students see the new subsection depends on its release date.
See LINK for more information on releasing your course. See :ref:`Publishing Your Course` for more information.
================== ==================
Edit a Subsection Edit a Subsection
================== ==================
You can add and delete Subsections, and select the grading policy, directly from the Course Outline. You can add and delete subsections, and select the grading policy, directly from the Course Outline.
You can also open the Subsection in its own page, to perform those tasks as well as to You can also open the subsection in its own page, to perform those tasks as well as to
set the Subsection release date, set a due date, preview a draft of the Subsection, or view the live course. set the subsection release date, set a due date, preview a draft of the subsection, or view the live course.
Click on the Subsection title. The Subsection opens in its own page: Click on the subsection title. The subsection opens in its own page:
.. image:: Images/subsection.png .. image:: Images/subsection.png
:width: 800 :width: 800
======================= =======================
Set the Grading Policy Add a Graded Assignment
======================= =======================
You can designate a Subsection as one of the assignment types that you specified in the grading policy. You can make a subsection a graded assignment. You select one of the assignment types that you specified in the grading policy.
You set the grading policy for the Subsection from the Course Outline or from the Subsection page. You select the assignment type for the Subsection from the Course Outline or from the Subsection page.
From the Course Outline, click the checkmark next to the Subsection. Then select a grading policy from the popup menu: From the Course Outline, click the checkmark next to the subsection. Then select the assignment type from the popup menu:
.. image:: Images/course_outline_set_grade.png .. image:: Images/course_outline_set_grade.png
:width: 800 :width: 800
From the Subsection page, click the text next to the **Graded as** label, then select a grading policy from the popup menu: From the Subsection page, click the text next to the **Graded as** label, then select the assignment type from the popup menu:
.. image:: Images/subsection_set_grade.png .. image:: Images/subsection_set_grade.png
:width: 800 :width: 800
...@@ -127,9 +127,9 @@ See :ref:`Establish a Grading Policy` for more information. ...@@ -127,9 +127,9 @@ See :ref:`Establish a Grading Policy` for more information.
Set the Due Date 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. 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.
#. From the Subsection page, click **SET A DUE DATE**. The Due Day and Due Time fields appear. #. 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 Date field, and pick a day from the popup calendar.
#. Place the cursor in the Due Time field and pick a time. #. Place the cursor in the Due Time field and pick a time.
...@@ -145,10 +145,10 @@ For more information, see :ref:`Establish a Grading Policy`. ...@@ -145,10 +145,10 @@ For more information, see :ref:`Establish a Grading Policy`.
Units Units
****** ******
Subsections are divided into Units. A Unit contains one or more Components. Subsections are divided into units. A unit contains one or more components.
For students, each Unit in the Subsection is represented as a link on the accordian at the top of the page. For students, each unit in the subsection is represented as a link on the accordian at the top of the page.
The following page shows a Subsection that has nine Units: The following page shows a subsection that has nine Units:
.. image:: Images/units_students.png .. image:: Images/units_students.png
:width: 800 :width: 800
...@@ -165,18 +165,18 @@ The following page shows a Subsection that has nine Units: ...@@ -165,18 +165,18 @@ The following page shows a Subsection that has nine Units:
you work with a private unit or edit a draft of a public unit. you work with a private unit or edit a draft of a public unit.
To create a Unit from the Course Outline or the Subsection page: To create a unit from the Course Outline or the subsection page:
#. Within the Subsection, click **New Unit**. #. Within the subsection, click **New Unit**.
#. Enter the Display Name that students will see. #. Enter the Display Name that students will see.
#. Click a Component type to add a the first Component in the Unit. #. Click a component type to add a the first component in the Unit.
.. image:: Images/Unit_DisplayName_Studio.png .. image:: Images/Unit_DisplayName_Studio.png
#. Follow the instructions for the type of Component, listed below. #. Follow the instructions for the type of component, listed below.
#. By default, the Unit visibility is **Private**, meaning students will not be able to see the Unit. Unless you want to publish the Unit to students immediately, leave this setting. See LINK for more information on releasing your course. #. By default, the Unit visibility is **Private**, meaning students will not be able to see the Unit. Unless you want to publish the Unit to students immediately, leave this setting. See :ref:`Publishing Your Course` for more information on releasing your course.
The Unit with the single Component is placed at the bottom of the Subsection. The unit with the single component is placed at the bottom of the subsection.
.. _Components: .. _Components:
...@@ -192,10 +192,10 @@ You add the first component when creating the unit. ...@@ -192,10 +192,10 @@ You add the first component when creating the unit.
To add another component to the unit: To add another component to the unit:
#. If the Unit is Public, change the **Visibility** setting to **Private**. You cannot modify a Public Unit. #. If the unit is public, change the **Visibility** setting to **Private**. You cannot modify a Public unit.
#. In the **Add New Component** panel at the bottom of the Unit, click the type of Component to add. #. In the **Add New Component** panel at the bottom of the unit, click the type of component to add.
.. image:: Images/Unit_DisplayName_Studio.png .. image:: Images/Unit_DisplayName_Studio.png
#. Follow the instructions for the type of Component: #. Follow the instructions for the type of component:
* :ref:`Working with HTML Components` * :ref:`Working with HTML Components`
* :ref:`Working with Video Components` * :ref:`Working with Video Components`
...@@ -212,12 +212,12 @@ Reorganize Your Course ...@@ -212,12 +212,12 @@ Reorganize Your Course
You can reorganize your course by dragging and dropping elements in the Course Outline. You can reorganize your course by dragging and dropping elements in the Course Outline.
To move a Section, Subsection, or Unit, click the mouse on the element's handle on the right side of the outline, then move the element to the new location. To move a section, subsection, or unit, click the mouse on the element's handle on the right side of the outline, then move the element to the new location.
Element handles are highlighed in the following image: Element handles are highlighed in the following image:
.. image:: Images/drag_drop.png .. image:: Images/drag_drop.png
:width: 800 :width: 800
When you move a course element, a blue line indicates the new position. You can move a Subsection to a new Section, and a Unit to a new Subsection. When you move a course element, a blue line indicates the new position. You can move a subsection to a new section, and a unit to a new subsection.
You can reorganize Components within a Unit in the same way. You can reorganize components within a unit in the same way.
\ No newline at end of file \ No newline at end of file
docs/course_authors/source/view_course_content.rst
...@@ -20,7 +20,7 @@ Preview Your Course ...@@ -20,7 +20,7 @@ Preview Your Course
*********************** ***********************
When you view your course through Preview mode, you see all the 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 units of your course, regardless of whether they are set to Public or
Private and regardless of whether the release dates have passed. Private and regardless of whether the release dates have passed.
...@@ -32,23 +32,23 @@ You can enter Preview mode in two ways. ...@@ -32,23 +32,23 @@ You can enter Preview mode in two ways.
* On any subsection page, click **Preview Drafts**. * On any subsection page, click **Preview Drafts**.
.. image:: Images/image205.png .. image:: Images/preview_draft.png
:width: 800 :width: 800
* On any Unit page, click **Preview**. * On any Unit page, click **Preview**.
The following example shows the **Preview** button for a unit that The following example shows the **Preview** button for a unit that
is set to Public. is set to Public.
.. image:: Images/image207.png .. image:: Images/preview_public.png
:width: 800 :width: 800
The following example shows the **Preview** button for a unit that The following example shows the **Preview** button for a unit that
is set to Private. is set to Private.
.. image:: Images/image209.png .. image:: Images/preview_private.png
:width: 800 :width: 800
.. _View Your Live Course: .. _View Your Live Course:
...@@ -65,16 +65,16 @@ You can view the live course from three different places in Studio: ...@@ -65,16 +65,16 @@ You can view the live course from three different places in Studio:
* The **Course Outline** page. * The **Course Outline** page.
.. image:: Images/image217.png .. image:: Images/course_outline_view_live.png
:width: 800 :width: 800
* Any Subsection page. * Any Subsection page.
.. image:: Images/image219.png .. image:: Images/subsection_view_live.png
:width: 800 :width: 800
* The Unit page, if the Unit is Public. * The Unit page, if the Unit is Public.
.. image:: Images/image221.png .. image:: Images/unit_view_live.png
:width: 800 :width: 800
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