Commit 69ed9984 by Mark Hoeber

Reorganizatio of Setting up Course

DOC-188
parent af486423
.. _A Template For Course Overview:
========================================
A Template For Your Course Overview
========================================
Replace the placeholders in the following template with your information.
.. code-block:: html
<section class="about">
<h2>About This Course</h2>
<p>Include your long course description here. The long course description
should contain 150-400 words.</p>
<p>This is paragraph 2 of the long course description. Add more paragraphs
as needed. Make sure to enclose them in paragraph tags.</p>
<section>
<section class="prerequisites">
<h2>Prerequisites</h2>
<p>Add information about class prerequisites here.</p>
</section>
<section class="course-staff">
<h2>Course Staff</h2>
<article class="teacher">
<div class="teacher-image">
<!-- Replace the path below with the path to your faculty image. -->
<img src="/c4x/edX/edX101/asset/Placeholder_FacultyImage.jpg"
align="left" style="margin:0 20 px 0"/>
</div>
<h3>Staff Member</h3>
<p>Biography of instructor/staff member</p>
</article>
<article class="teacher">
<div class="teacher-image">
<img src="/c4x/edX/edX101/asset/Placeholder_FalcutyImage.jpg"/>
</div>
<h3>Staff Member Name</h3>
<p>Biography of instructor/staff member</p>
</article>
</section>
<section class="faq">
<section class="responses">
<h2>Frequently Asked Questions</h2>
<article class="response">
<h3>Do I need to buy a textbook?</h3>
<p>No, a free online version of Chemistry: Principles, Patterns, and
Applications, First Edition by Bruce Averill and Patricia Eldredge
will be available, though you can purchase a printed version
(published by FlatWorld Knowledge) if you'd like.</p>
</article>
<article class="response">
<h3>Question 2?</h3>
<p>Answer 2.</p>
</article>
</section>
</section>
<!--Paragraph: <p>CONTENT GOES IN HERE</p> -->
<!--Line break: <br/> -->
<!--Hyperlink: <a href="URL">LINK TEXT</a> -->
<!--Email hyperlink: <a href="mailto:EMAIL@ADDRESS.COM">LINK TEXT</a> -->
<!--Bold text: <b>TEXT</b> -->
<!--Italic text: <i>TEXT</i> -->
.. _Setting up a New Course:
###########################
Setting up a New Course
###########################
*******************
Overview
*******************
This chapter describes how to create and set up your course:
#. :ref:`Create a New Course`
#. :ref:`Edit Your Course`
#. :ref:`Use the Course Checklist`
#. :ref:`Add Course Team Members`
#. :ref:`Set Important Dates for Your Course`
#. :ref:`Describe Your Course`
#. :ref:`Add a Course Image`
#. :ref:`Add a Course Video`
#. :ref:`Set Course Requirements`
#. :ref:`Add Files to a Course`
#. :ref:`Add Pages`
#. :ref:`Add a Course Update`
#. :ref:`Add Course Handouts`
#. :ref:`Add Textbooks`
Also see the chapters :ref:`Establish a Grading Policy`, :ref:`Organizing Your Course Content`, and :ref:`Guidelines for Creating Accessible Content`.
.. _Edge: http://edge.edx.org
.. _edX.org: http://edx.org
.. _Create a New Course:
*******************
Create a New Course
*******************
#. Log in to Studio.
#. Click **New Course**.
#. Enter course information as needed and click **Create**.
.. image:: ../Images/new_course_info.png
:width: 800
.. note:: Enter new course information carefully. This information becomes part of the URL for your course. To change the URL after the course is created, you must contact edX through the Help site (http://help.edge.edx.org). Additionally, because this information becomes part of your course URL, the total number of characters in the following three fields must be 65 or fewer.
* For **Course Name**, enter the title of your course. For example, the name may be “Sets, Maps and Symmetry Groups". Use title capitalization for the course title.
* For **Organization**, enter the name of your university. Do not include whitespace or special characters.
* For **Course Number**, enter both a subject abbreviation and a number. For example, for public health course number 207, enter **PH207**. For math course 101x, enter **Math101x**. Do not include whitespace or special characters in the course number.
*Note: If your course will be open to the world, be sure to include the "x". If it is exclusively an on-campus offering, do not include the "x".*
* For **Course Run**, enter the term your course will run. Do not include whitespace or special characters.
The Course Run date you enter does not affect the default **Course Start Date**. See :ref:`Set Important Dates for Your Course` for more information.
4. Click **Save.**
You then see the empty Course Outline.
.. _Edit Your Course:
************************
Edit Your Course
************************
When you create a new course, the course opens in Studio automatically and you can begin editing.
If you come back to Studio later, your courses are listed on the Studio login page.
.. image:: ../Images/open_course.png
:width: 800
To open the course, click the course name.
When you open a course, you go to the Course Outline. The next topic discusses working with your course outline.
The rest of this page discusses other tasks you must do to set up your course.
.. _Use the Course Checklist:
************************
Use the Course Checklist
************************
You can use a Course Checklist within Studio to help you work through the tasks of building a course.
Categories of tasks in the Course Checklist include:
* Getting Started with Studio
* Draft a Rough Course Outline
* Explore edX's Support Tools
* Draft Your Course About Page
From the **Tools** menu, select **Checklists**.
.. image:: ../Images/checklist.png
:width: 800
As shown above for the **Add Course Team Members** task, if you hover over a task, a button is displayed that takes you to the page to complete that task.
You can expand and collapse sections of this page as needed.
You can check tasks as you complete them. Studio saves your changes automatically. Other course staff can see your changes.
.. _Add Course Team Members:
************************
Add Course Team Members
************************
Course team members are users who help you build your course.
Only a team member with Admin access can add or remove course team members, or grant Admin access to other team members.
Other course team members can edit the course and perform all tasks except adding and removing other new team members and granting Admin access.
.. note:: Any course team member can delete content created by other team members.
All course team members must be registered with Studio and have an active account.
To add a course team member:
#. Ensure you have Admin access.
#. Ensure that the new team member has registered with Studio.
#. From the **Settings** menu, select **Course Team**.
#. Click **Add a New Team Member**.
#. Enter the new team member's email address, then click **ADD USER**.
.. _Set Important Dates for Your Course:
***********************************
Set Important Dates for Your Course
***********************************
You must set dates and times for enrollment and for the course.
From the **Settings** menu, select **Schedule and Details**.
.. image:: ../Images/schedule.png
:alt: An image of the course schedule page.
Follow the on-screen text to enter the course and enrollment schedule.
.. note::
The Time fields on this page reflect the current time zone in your browser, depending on your geography. Course start times for students are shown as UTC.
.. _The Course Start Date:
==============================
The Course Start Date
==============================
.. note::
The default **Course Start Date** is set far into the future, to **01/01/2030 GMT**. This is to ensure that your course does not start before you intend it to. You must change the course start date to the date you want students to begin using the course.
Students see the course start date on their dashboards and on the course summary page.
The following example shows the course start date on the course summary page:
.. image:: ../Images/about-page-course-start.png
:alt: An image of the course summary page, with the start date circled.
.. note:: For courses on edX.org_, you must communicate the course start date to your edX Program Manager, to ensure the date is accurate on the course summary page.
In the dashboard, if the course has not yet started, students see the start date as in the following example:
.. image:: ../Images/dashboard-course-to-start.png
:alt: An image of a course that has not started in the student dashboard, with the start date circled.
If the course has started, students see the start date as in the following example:
.. image:: ../Images/dashboard-course.png
:alt: An image of a course listing in the student dashboard, with the start date circled.
.. _Set the Advertised Start Date:
==============================
Set the Advertised Start Date
==============================
You can set an advertised start date for your course that is different than the course start date you set in the **Schedule and Details** page. You may want to do this if there is uncertainty about the exact start date. For example, you could advertise the start date as **Spring, 2014**.
To set an advertised start date:
#. From the **Settings** menu, select **Advanced Settings**.
#. Find the policy key **advertised_start**. The default value is **null**.
#. Enter the date you want as an advertised start date. You can use any string, enclosed in double quotation marks. If you format the string as a date (for example, as 02/01/2014), the value is parsed and presented to students as a date.
.. image:: ../Images/advertised_start.png
:alt: Image of the advertised start date policy key
4. Click **Save Changes** at the bottom of the page.
The start date shown on the student's dashboard is now the value of the advertised_start policy key:
.. image:: ../Images/dashboard-course_adver_start.png
:alt: An image of a course listing in the student dashboard, with the advertised start date circled.
If you do not change the default course start date (01/01/2030), and the **advertised_start** policy value is ``null``, then the student dashboard does not list a start date for the course. Students just see that the course has not yet started:
.. image:: ../Images/dashboard-course_not_started.png
:alt: Image of a course listing in the student dashboard, with no start date.
.. _The Course End Date:
==============================
The Course End Date
==============================
When your course is completed, students see the course end date on their dashboards.
.. note:: For courses on edX.org_, you must communicate the course end date to your edX Program Manager, to ensure the date is accurate on the course summary page.
If grades and certificates are not yet issued, or if students enroll in an archived course after it has ended, the course appears in the dashboard as in the following example:
.. image:: ../Images/dashboard-wrapping-course.png
:alt: Image of a course on the student dashboard that has ended, but not been graded
If grades are complete and certificates are issued, students see the course, the end date, and the message as in the following example:
.. image:: ../Images/dashboard-completed-course.png
:alt: Image of a course on the student dashboard that has ended, but not been graded
.. _Describe Your Course:
************************
Describe Your Course
************************
On Edge_, students that you explicitly invite see the description of your course on the course summary page.
For example, the course description is circled in the following course summary page:
.. image:: ../Images/about-page-course-description.png
:alt: Image of a course summary with the description circled
.. note:: For courses on edX.org_, you must communicate the course description to your edX Program Manager, to ensure the content is accurate on the course summary page.
#. From the **Settings** menu, select **Schedule & Details**.
#. Scroll down to the **Introducing Your Course** section, then locate the **Course Overview** field.
.. image:: ../Images/course_overview.png
:width: 800
3. Overwrite the content as needed for your course, following the directions in the boilerplate text. Do not edit HTML tags. For a template that includes placeholders, see :ref:`A Template For Course Overview`.
.. note:: There is no save button. Studio automatically saves your changes.
4. Click **your course summary page** in the text beneath the field to test how the description will appear to students.
.. _Add a Course Image:
************************
Add a Course Image
************************
The course image that you add in Studio appears on the student dashboard.
On Edge_, the image also appears on the course summary page.
In the following example, the course image that was added in Studio is circled in the student dashboard:
.. image:: ../Images/dashboard-course-image.png
:alt: Image of the course image in the student dashboard
On edX.org_, the course image you add in Studio does not appear on the course summary page automatically. You must work directly with your edX Program Manager to set up the course summary page.
The course image should be a minimum of 660 pixels in width by 240 pixels in height, and in .JPG or .PNG format.
#. From the **Settings** menu, select **Schedule & Details**.
#. Scroll down to the **Course Image** section.
#. To select an image from your computer, click **Upload Course Image**, then follow the prompts to find and upload your image.
#. View your dashboard to test how the image will appear to students.
.. _Add a Course Video:
*********************************
Add a Course Introduction Video
*********************************
On Edge_, the course introduction video appears on the course summary page that students see.
.. note:: On edX.org_, you work directly with your Program Manager to set up the course video in the summary page.
In the following example, the course video is circled in the course summary page:
.. image:: ../Images/about-page-course-video.png
:alt: Image of the course video in the course summary page
The course video should excite and entice potential students to register, and reveal some of the personality the instructors bring to the course.
The video should answer these key questions:
* Who is teaching the course?
* What university or college is the course affiliated with?
* What topics and concepts are covered in your course?
* Why should a learner register for your course?
The video should deliver your message as concisely as possible and have a run time of less than 2 minutes.
Ensure your course introduction video follows the same :ref:`Compression Specifications` and :ref:`Video Formats` guidelines as course content videos.
To add a course introduction video:
#. Upload the course video to YouTube. Make note of the code that appears between **watch?v =** and **&feature** in the URL. This code appears in the green box below.
.. image:: ../Images/image127.png
:width: 800
2. From the **Settings** menu, select **Schedule & Details**.
#. Scroll down to the **Course Introduction Video** section.
#. In the field below the video box, enter the YouTube video ID (the code you copied in step 1). When you add the code, the video automatically loads in the video box. Studio automatically saves your changes.
#. View your course summary page to test how the video will appear to students.
.. _Set Course Requirements:
************************
Set Course Requirements
************************
The estimated Effort per Week appears on the Course Summary page that students see.
#. From the **Settings** menu, select **Schedule & Details**.
#. Scroll down to the **Requirements** section.
#. In the **Hours of Effort per Week** field, enter the number of hours you expect students to work on this course each week.
#. View your course summary page to test how the video will appear to students.
.. _Add Files to a Course:
**********************
Add Files to a Course
**********************
You can add files that you want students to access in the course. After you add a file,
you must link to it from a component, a course update, or in the course handouts. A file
is only visible to students if you create a link to it.
.. note:: Because the file name becomes part of the URL, students can see the name of the file when they open it. Avoid using file names such as AnswerKey.pdf.
.. warning:: If you upload a file with the same name as an existing course file, the original file is overwritten without warning.
To add files:
#. From the **Content** menu, select **Files & Uploads**.
#. Click **Upload New File**.
#. In the **Upload New File** dialog box, click **Choose File**.
#. In the **Open** dialog box, select one more files that you want to upload, then click **Open**.
#. To add more file, click **Load Another File** and repeat the previous step.
#. 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.
==================
File URLs
==================
In the Files & Uploads page, each file has has an **Embed URL** and an **External URL**:
.. image:: ../Images/files_uploads_urls.png
:alt: Image of the Files and Uploads page, with Embed URL and External URL columns circled
* You use the **Embed URL** to link to the file or image from a component, a course update, or a course handout.
* You use the **External URL** to reference the file or image from outside of your course. The external URL does not work if you lock the file unless the person accessing the URL is enrolled in the course.
.. warning:: You cannot use the External URL as the reference to a file or image from within your course.
You can double click a value in the **Embed URL** or **External URL** column to select the value, then copy it.
==================
Sort Files
==================
By default, files are sorted by the **Date Added** column, with the most recently added first.
Alternatively, can also sort the list by the **Name** column by clicking on the column header.
For either the the **Date Added** or **Name** column, you can switch the sort order from descending to ascending, and back, by clicking the column header a second time.
The current sort order is shown at the top of the file list, and the active sort column header is underlined:
.. image:: ../Images/file_sort.png
:alt: Sorting files in the Files & Uploads page
==================
Find Files
==================
The **Files & Uploads** page lists up to 50 files. If your course has more than 50 files, additional files are listed on 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
:alt: Pagination in the Files & Uploads page
==================
Lock a file
==================
By default, anyone can access a file you upload if they know the URL, even people not enrolled in your class.
To ensure that those not in your class cannot view the file, click the lock icon.
.. note:: The external URL does not work if you lock the file.
==================
Delete a file
==================
To delete a file, click the **x** icon next to the file. You are prompted to confirm the deletion.
.. warning:: If you have links to a file you delete, those links will be broken. Ensure you change those links before deleting the file.
.. _`Add Pages`:
****************
Add Pages
****************
By default, your course has the following pages:
* Courseware
* Course Info
* Discussion
* Wiki
* Progress
You cannot rename, reorder, or remove these pages.
You can add pages to your course. Each page appears in your course's navigation bar.
For example, the following navigation bar includes the default pages as well as the
**Course Schedule** and **Supplements & Instructor's Blog** pages.
.. image:: ../Images/page_bar_lms.png
:alt: Image of the page bar in the LMS
You can create other pages for the grading policy, course slides, or any other purpose. More examples of pages you can add are:
* A Google calendar, by embedding the code for it.
* A dynamic HTML calendar, using the template in :ref:`Appendix B`.
* An instant hangout. See :ref:`Using an Instant Hangout in Your Course` for more information.
To create a page:
#. From the **Content** menu, select **Pages**.
.. image:: ../Images/pages_page.png
:alt: Image of the Pages screen
2. Click **Add a New Page**. A page with the title **Empty** is added to the list:
.. image:: ../Images/pages_empty.png
:alt: Image of the Pages screen with a new Empty page
3. Click **Edit**. The HTML editor opens.
.. image:: ../Images/pages_editor.png
:alt: Image of the Page editor
4. Enter text for your page. See :ref:`The User Interface` for more information about using the editor.
#. Click **Settings** to edit the **Display Name**. The display name is the name of the page visible to students in the course.
#. Click **Save**.
The new page is immediately available to students, if the course has started.
==================
Reorder Pages
==================
You can reorder pages in your course by dragging and dropping the pages to different locations.
To move a page, hover over the element handle on the right side of the page row until the mouse pointer changes to a four-headed arrow. Then, click and drag the page to the location that you want.
.. note:: You cannot reorder the Courseware, Course Info, Discussion, Wiki, and Progress pages that your course includes by default
==================
Delete a Page
==================
To delete a page that you previously added, click the trash can icon in the row for the page. You are prompted to confirm the deletion.
.. _Add a Course Update:
**********************
Add a Course Update
**********************
You add updates to notify students of exams, changes in the course schedule, or anything else of a more urgent nature.
Students see course updates in **Course Info** tab when they log in to the course:
.. image:: ../Images/course_info.png
:width: 800
To add a course update:
#. From the **Content** menu, select **Updates**.
#. Click **New Update**.
#. Enter your update in the HTML editor that opens.
.. note:: You must enter the update in HTML. See :ref:`A Template For Course Overview`.
4. Click **Save**.
.. _Add Course Handouts:
**********************
Add Course Handouts
**********************
You can add course handouts that are visible to students on the **Course Info** page. To add an uploaded file to the course handouts, you will need its URL.
.. note:: You must :ref:`Add Files to a Course` before you can add them as course handouts.
#. From the **Content** menu, select **Updates**.
#. In the **Course Handouts** panel, click **Edit**.
#. Edit the HTML to add links to the files you uploaded. See :ref:`Add a Link in an HTML Component` for more information.
#. Click **Save**.
.. _Add Textbooks:
****************
Add Textbooks
****************
You can add PDF textbooks for your course.
.. note:: Do not use image files (for example, .PNG files) as textbooks for your course, as they are not accessible to screen readers. Review the :ref:`Best Practices for Accessible PDFs` for more information.
Each textbook that you add is displayed to students as a tab in the course navigation bar.
It's recommended that you upload a separate PDF file for each chapter of your textbook.
When students open the textbook tab in the course, they can navigate the textbook by chapter:
.. image:: ../Images/textbook_chapters.png
:width: 800
To add a textbook:
#. From the **Content** menu, select **Textbooks**.
#. Click **New Textbook**. The following screen opens:
.. image:: ../Images/textbook_new.png
:width: 800
3. Enter the **Textbook Name**.
#. Enter the first **Chapter Name**.
#. To upload a PDF file from your computer, click **Upload PDF**. Follow the prompts to upload your file.
#. To add more chapters, click **+Add a Chapter** and repeat steps 3 and 4.
#. Click **Save**.
\ No newline at end of file
.. _Creating a New Course:
###########################
Creating a New Course
###########################
*******************
Overview
*******************
This chapter describes how to create and set up your course:
* :ref:`Create a New Course`
* :ref:`Edit Your Course`
* :ref:`Use the Course Checklist`
* :ref:`Add Course Team Members`
You can also :ref:`Export a Course` and :ref:`Import a Course` through Studio.
You can do this when you need to edit the course in XML.
.. _Edge: http://edge.edx.org
.. _edX.org: http://edx.org
.. _Create a New Course:
*******************
Create a New Course
*******************
#. Log in to Studio.
#. Click **New Course**.
#. Enter course information as needed and click **Create**.
.. image:: ../Images/new_course_info.png
:alt: Image of the course creation page
.. note:: Enter new course information carefully. This information becomes
part of the URL for your course. To change the URL after the course is
created, you must contact edX through the Help site
(http://help.edge.edx.org). Additionally, because this information becomes
part of your course URL, the total number of characters in the following
three fields must be 65 or fewer.
* For **Course Name**, enter the title of your course. For example, the name
may be “Sets, Maps and Symmetry Groups". Use title capitalization for the
course title.
* For **Organization**, enter the name of your university. Do not include
whitespace or special characters.
* For **Course Number**, enter both a subject abbreviation and a number. For
example, for public health course number 207, enter **PH207**. For math
course 101x, enter **Math101x**. Do not include whitespace or special
characters in the course number.
.. note:: If your course will be open to the world, be sure to include the
"x". If it is exclusively an on-campus offering, do not include the "x".*
* For **Course Run**, enter the term your course will run. Do not include
whitespace or special characters.
The Course Run date you enter does not affect the default **Course Start
Date**. See :ref:`Set Important Dates for Your Course` for more
information.
4. Click **Save.**
You then see the empty Course Outline.
.. _Edit Your Course:
************************
Edit Your Course
************************
When you create a new course, the course opens in Studio automatically and you
can begin editing.
If you come back to Studio later, your courses are listed on the Studio login
page.
.. image:: ../Images/open_course.png
:alt: Image of the course on the Studio dashboard
To open the course, click the course name. You go to the Course Outline.
.. _Use the Course Checklist:
************************
Use the Course Checklist
************************
You can use a Course Checklist within Studio to help you work through the tasks
of building a course.
Categories of tasks in the Course Checklist include:
* Getting Started with Studio
* Draft a Rough Course Outline
* Explore edX's Support Tools
* Draft Your Course About Page
From the **Tools** menu, select **Checklists**.
.. image:: ../Images/checklist.png
:alt: Image of the course checklist
As shown above for the **Add Course Team Members** task, if you hover over a
task, a button is displayed that takes you to the page to complete that task.
You can expand and collapse sections of this page as needed.
You can check tasks as you complete them. Studio saves your changes
automatically. Other course staff can see your changes.
.. _Add Course Team Members:
************************
Add Course Team Members
************************
Course team members are users who help you build your course.
Only a team member with Admin access can add or remove course team members, or
grant Admin access to other team members.
Other course team members can edit the course and perform all tasks except
adding and removing other new team members and granting Admin access.
.. note:: Any course team member can delete content created by other team
members.
All course team members must be registered with Studio and have an active
account.
To add a course team member:
#. Ensure you have Admin access.
#. Ensure that the new team member has registered with Studio.
#. From the **Settings** menu, select **Course Team**.
#. Click **Add a New Team Member**.
#. Enter the new team member's email address, then click **ADD USER**.
......@@ -121,17 +121,22 @@ You configure the following fields for each assignment type:
The general category of the assignment. This name will be visible to students.
.. note:: All assignments of a particular type count the same toward the weight of that category. As a result, a homework assignment that contains 10 problems is worth the same percentage of a student's grade as a homework assignment that contains 20 problems.
.. note:: All assignments of a particular type count the same toward the
weight of that category. As a result, a homework assignment that contains
10 problems is worth the same percentage of a student's grade as a homework
assignment that contains 20 problems.
* **Abbreviation:**
This is the short name that appears next to an assignment on a student's **Progress** tab.
This is the short name that appears next to an assignment on a student's
**Progress** tab.
* **Weight of Total Grade:**
The assignments of this type together account for the percent value set in **Weight of Total Grade**.
The assignments of this type together account for the percent value set in
**Weight of Total Grade**.
The total weight of all assignment types must equal 100.
......@@ -141,7 +146,8 @@ You configure the following fields for each assignment type:
* **Total Number:**
The number of assignments of this type that you plan to include in your course.
The number of assignments of this type that you plan to include in your
course.
......
......@@ -15,8 +15,10 @@ There are several reasons you may want to export your course:
* To save your work
* To edit the XML in your course directly
* To create a backup copy of your course, which you can import if you want to revert the course back to a previous state
* To create a copy of your course that you can later import into another course instance and customize
* To create a backup copy of your course, which you can import if you want to
revert the course back to a previous state
* To create a copy of your course that you can later import into another course
instance and customize
* To share with another instructor for another class
......@@ -35,7 +37,7 @@ The following data is not exported with your course:
* User data
* Course team data
* Forum/discussion data
* Discussion data
* Certificates
To export a course:
......@@ -54,9 +56,9 @@ Import a Course
.. warning::
Content of the imported course replaces all the content of this course.
**You cannot undo a course import**. We recommend that you first export the current course,
so you have a backup copy of it.
Content of the imported course replaces all the content of this course.
**You cannot undo a course import**. We recommend that you first export the
current course, so you have a backup copy of it.
There are several reasons you may want to import a course:
......@@ -65,18 +67,20 @@ There are several reasons you may want to import a course:
* To load a course you developed outside of Studio
The course that you import must be in a .tar.gz file (that is, a .tar file compressed with GNU Zip).
This .tar.gz file must contain a course.xml file in a course data directory. The tar.gz file must
have the same name as the course data directory. It may also contain other files.
The course that you import must be in a .tar.gz file (that is, a .tar file
compressed with GNU Zip). This .tar.gz file must contain a course.xml file in a
course data directory. The tar.gz file must have the same name as the course
data directory. It may also contain other files.
If your course uses legacy layout structures, you may not be able to edit
the course in Studio, although it will probably appear correctly on Edge. To
make sure that your course is completely editable, ensure that all of your
material is embedded in a unit.
If your course uses legacy layout structures, you may not be able to edit the
course in Studio, although it will probably appear correctly on Edge. To make
sure that your course is completely editable, ensure that all of your material
is embedded in a unit.
The import process has five stages. During the first two stages, you must stay on the Course Import page.
You can leave this page after the Unpacking stage has completed. We recommend, however,
that you don't make important changes to your course until the import operation has completed.
The import process has five stages. During the first two stages, you must stay
on the Course Import page. You can leave this page after the Unpacking stage has
completed. We recommend, however, that you don't make important changes to your
course until the import operation has completed.
To import a course:
......
......@@ -7,9 +7,7 @@ Building a Course
.. toctree::
:maxdepth: 2
create_new_course
establish_grading_policy
organizing_course
creating_new_course
export_import_course
course_overview_template
dynamic_html_schedule
setting_up_student_view
establish_grading_policy
\ No newline at end of file
.. _Setting up the Student View:
######################################################
Setting up the Student View
######################################################
*******************
Overview
*******************
This chapter describes how you set up your course to be displayed in the course
summary page and in a student's dashboard. The information you configure for
your course is important for prospective and current students to understand.
See:
* :ref:`The Course Summary Page`
* :ref:`The Student Dashboard`
* :ref:`Set Important Dates for Your Course`
* :ref:`The Course Start Date`
* :ref:`Set the Advertised Start Date`
* :ref:`The Course End Date`
* :ref:`Describe Your Course`
* :ref:`Add a Course Image`
* :ref:`Add a Course Video`
* :ref:`Set Course Requirements`
* :ref:`A Template For Course Overview`
.. _Edge: http://edge.edx.org
.. _edX.org: http://edx.org
.. _The Course Summary Page:
***********************************
The Course Summary Page
***********************************
The following image shows an example course summary page. Students can see the
course summary page before registering, and may decide to register based on the
content of the page. You configure the contents of this page in Studio, as
described in this chapter:
.. image:: ../Images/about_page.png
:alt: An image of the course summary page.
.. _The Student Dashboard:
***********************************
The Student Dashboard
***********************************
If a student registers for your course, the course is then listed on the
dashboard, with the course image. From the dashboard, a student can open a
course that has started. If the course has not started, the student can see the
start date, as explained in this chapter.
.. image:: ../Images/dashboard.png
:alt: An image of the dashboard
.. _Set Important Dates for Your Course:
***********************************
Set Important Dates for Your Course
***********************************
You must set dates and times for enrollment and for the course.
In Studio, from the **Settings** menu, select **Schedule and Details**.
.. image:: ../Images/schedule.png
:alt: An image of the course schedule page.
Follow the on-screen text to enter the course and enrollment schedule.
.. note:: The Time fields on this page reflect the current time zone in your
browser, depending on your geography. Course start times for students are
shown as UTC.
.. _The Course Start Date:
***********************************
The Course Start Date
***********************************
.. note:: The default **Course Start Date** is set far into the future, to
**01/01/2030 GMT**. This is to ensure that your course does not start before
you intend it to. You must change the course start date to the date you want
students to begin using the course.
Students see the course start date on their dashboards and on the course summary
page.
The following example shows the course start date on the course summary page:
.. image:: ../Images/about-page-course-start.png
:alt: An image of the course summary page, with the start date circled.
.. note:: For courses on edX.org_, you must communicate the course start date to
your edX Program Manager, to ensure the date is accurate on the course
summary page.
In the dashboard, if the course has not yet started, students see the start date
as in the following example:
.. image:: ../Images/dashboard-course-to-start.png
:alt: An image of a course that has not started in the student dashboard, with
the start date circled.
If the course has started, students see the start date as in the following
example:
.. image:: ../Images/dashboard-course.png
:alt: An image of a course listing in the student dashboard, with the start
date circled
.. _Set the Advertised Start Date:
***********************************
Set the Advertised Start Date
***********************************
You can set an advertised start date for your course that is different than the
course start date you set in the **Schedule and Details** page. You may want to
do this if there is uncertainty about the exact start date. For example, you
could advertise the start date as **Spring, 2014**.
To set an advertised start date:
#. From the **Settings** menu, select **Advanced Settings**.
#. Find the policy key **advertised_start**. The default value is **null**.
#. Enter the date you want as an advertised start date. You can use any string,
enclosed in double quotation marks. If you format the string as a date (for
example, as 02/01/2014), the value is parsed and presented to students as a
date.
.. image:: ../Images/advertised_start.png
:alt: Image of the advertised start date policy key
4. Click **Save Changes** at the bottom of the page.
The start date shown on the student's dashboard is now the value of the
advertised_start policy key:
.. image:: ../Images/dashboard-course_adver_start.png
:alt: An image of a course listing in the student dashboard, with the
advertised start date circled.
If you do not change the default course start date (01/01/2030), and the
**advertised_start** policy value is ``null``, then the student dashboard does
not list a start date for the course. Students just see that the course has not
yet started:
.. image:: ../Images/dashboard-course_not_started.png
:alt: Image of a course listing in the student dashboard, with no start date
.. _The Course End Date:
***********************************
The Course End Date
***********************************
When your course is completed, students see the course end date on their
dashboards.
.. note:: For courses on edX.org_, you must communicate the course end date to
your edX Program Manager, to ensure the date is accurate on the course
summary page.
If grades and certificates are not yet issued, or if students enroll in an
archived course after it has ended, the course appears in the dashboard as in
the following example:
.. image:: ../Images/dashboard-wrapping-course.png
:alt: Image of a course on the student dashboard that has ended, but not been
graded
If grades are complete and certificates are issued, students see the course, the
end date, and the message as in the following example:
.. image:: ../Images/dashboard-completed-course.png
:alt: Image of a course on the student dashboard that has ended, but not been
graded
.. _Describe Your Course:
************************
Describe Your Course
************************
On Edge_, students that you explicitly invite see the description of your course
on the course summary page.
For example, the course description is circled in the following course summary
page:
.. image:: ../Images/about-page-course-description.png
:alt: Image of a course summary with the description circled
.. note:: For courses on edX.org_, you must communicate the course description
to your edX Program Manager, to ensure the content is accurate on the course
summary page.
#. From the **Settings** menu, select **Schedule & Details**.
#. Scroll down to the **Introducing Your Course** section, then locate the
**Course Overview** field.
.. image:: ../Images/course_overview.png
:alt: Image of the HTML course description.
3. Overwrite the content as needed for your course, following the directions in
the boilerplate text. Do not edit HTML tags. For a template that includes
placeholders, see :ref:`A Template For Course Overview`.
.. note:: There is no save button. Studio automatically saves your changes.
4. Click **your course summary page** in the text beneath the field to test how
the description will appear to students.
.. _Add a Course Image:
************************
Add a Course Image
************************
The course image that you add in Studio appears on the student dashboard.
On Edge_, the image also appears on the course summary page.
In the following example, the course image that was added in Studio is circled
in the student dashboard:
.. image:: ../Images/dashboard-course-image.png
:alt: Image of the course image in the student dashboard
On edX.org_, the course image you add in Studio does not appear on the course
summary page automatically. You must work directly with your edX Program Manager
to set up the course summary page.
The course image should be a minimum of 660 pixels in width by 240 pixels in
height, and in .JPG or .PNG format.
#. From the **Settings** menu, select **Schedule & Details**.
#. Scroll down to the **Course Image** section.
#. To select an image from your computer, click **Upload Course Image**, then
follow the prompts to find and upload your image.
#. View your dashboard to test how the image will appear to students.
.. _Add a Course Video:
*********************************
Add a Course Introduction Video
*********************************
On Edge_, the course introduction video appears on the course summary page that
students see.
.. note:: On edX.org_, you work directly with your Program Manager to set up the
course video in the summary page.
In the following example, the course video is circled in the course summary
page:
.. image:: ../Images/about-page-course-video.png
:alt: Image of the course video in the course summary page.
The course video should excite and entice potential students to register, and
reveal some of the personality the instructors bring to the course.
The video should answer these key questions:
* Who is teaching the course?
* What university or college is the course affiliated with?
* What topics and concepts are covered in your course?
* Why should a learner register for your course?
The video should deliver your message as concisely as possible and have a run
time of less than 2 minutes.
Ensure your course introduction video follows the same :ref:`Compression
Specifications` and :ref:`Video Formats` guidelines as course content videos.
To add a course introduction video:
#. Upload the course video to YouTube. Make note of the code that appears
between **watch?v =** and **&feature** in the URL. This code appears in the
green box below.
.. image:: ../Images/image127.png
:alt: Image of a sample course video
2. From the **Settings** menu, select **Schedule & Details**.
#. Scroll down to the **Course Introduction Video** section.
#. In the field below the video box, enter the YouTube video ID (the code you
copied in step 1). When you add the code, the video automatically loads in
the video box. Studio automatically saves your changes.
#. View your course summary page to test how the video will appear to students.
.. _Set Course Requirements:
************************
Set Course Requirements
************************
The estimated Effort per Week appears at the bottom of the course summary page.
#. From the **Settings** menu, select **Schedule & Details**.
#. Scroll down to the **Requirements** section.
#. In the **Hours of Effort per Week** field, enter the number of hours you
expect students to work on this course each week.
#. View your course summary page to test how the requirements will appear to students.
.. _A Template For Course Overview:
************************************************
A Template For Your Course Overview
************************************************
Replace the placeholders in the following template with your information.
.. code-block:: html
<section class="about">
<h2>About This Course</h2>
<p>Include your long course description here. The long course description
should contain 150-400 words.</p>
<p>This is paragraph 2 of the long course description. Add more paragraphs
as needed. Make sure to enclose them in paragraph tags.</p>
<section>
<section class="prerequisites">
<h2>Prerequisites</h2>
<p>Add information about class prerequisites here.</p>
</section>
<section class="course-staff">
<h2>Course Staff</h2>
<article class="teacher">
<div class="teacher-image">
<!-- Replace the path below with the path to your faculty image. -->
<img src="/c4x/edX/edX101/asset/Placeholder_FacultyImage.jpg"
align="left" style="margin:0 20 px 0"/>
</div>
<h3>Staff Member</h3>
<p>Biography of instructor/staff member</p>
</article>
<article class="teacher">
<div class="teacher-image">
<img src="/c4x/edX/edX101/asset/Placeholder_FalcutyImage.jpg"/>
</div>
<h3>Staff Member Name</h3>
<p>Biography of instructor/staff member</p>
</article>
</section>
<section class="faq">
<section class="responses">
<h2>Frequently Asked Questions</h2>
<article class="response">
<h3>Do I need to buy a textbook?</h3>
<p>No, a free online version of Chemistry: Principles, Patterns, and
Applications, First Edition by Bruce Averill and Patricia Eldredge
will be available, though you can purchase a printed version
(published by FlatWorld Knowledge) if you'd like.</p>
</article>
<article class="response">
<h3>Question 2?</h3>
<p>Answer 2.</p>
</article>
</section>
</section>
<!--Paragraph: <p>CONTENT GOES IN HERE</p> -->
<!--Line break: <br/> -->
<!--Hyperlink: <a href="URL">LINK TEXT</a> -->
<!--Email hyperlink: <a href="mailto:EMAIL@ADDRESS.COM">LINK TEXT</a> -->
<!--Bold text: <b>TEXT</b> -->
<!--Italic text: <i>TEXT</i> -->
\ No newline at end of file
......@@ -10,18 +10,29 @@ Change Log
* - Date
- Change
* - 04/02/14
- Reorganized the sections :ref:`Building a Course Index` and
:ref:`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 grading is applied to subsections only.
- Update the :ref:`Establish a Grading Policy` chapter to emphasize that
grading is applied to subsections only.
* -
- Updated the :ref:`Releasing Your Course Index` section to include :ref:`Launch`.
- Updated the :ref:`Releasing Your Course Index` section to include
:ref:`Launch`.
* - 03/31/14
- Expanded the :ref:`Grades` chapter to include the new :ref:`Review_Answers` section.
- Expanded the :ref:`Grades` chapter to include the new
:ref:`Review_Answers` section.
* - 03/27/14
- Updated the :ref:`Add Pages` section to reflect feature changes.
* - 03/27/14
- Updated the section on :ref:`Beta_Testing` to include the new "batch add" feature.
* - 03/19/14
- Updated the sections on :ref:`Beta_Testing`, :ref:`Discussions`, :ref:`Grades`, and :ref:`Student Data` with changes to the new Instructor Dashboard.
- Updated the :ref:`Adding Pages to a Course` section to reflect feature
changes.
* - 3/27/14
- Updated the section on :ref:`Beta_Testing` to include the new "batch add"
feature.
* - 3/19/14
- Updated the sections on :ref:`Beta_Testing`, :ref:`Discussions`,
:ref:`Grades`, and :ref:`Student Data` with changes to the new Instructor
Dashboard.
* - 03/17/14
- Reorganized this document into major sections:
......@@ -53,9 +64,11 @@ Change Log
* :ref:`Describe Your Course`
* - 02/25/14
- Updated :ref:`Add Files to a Course` section to include new External URL feature.
- Updated :ref:`Add Files to a Course` section to include new External URL
feature.
* -
- Updated :ref:`Add a Link to a File` and :ref:`Add an Image to an HTML Component` to specify you must use the file's Embed URL.
- Updated :ref:`Add a Link to a File` and :ref:`Add an Image to an HTML
Component` to specify you must use the file's Embed URL.
* - 02/24/14
- Created new chapter, :ref:`Getting Started with edX`.
* -
......@@ -63,42 +76,54 @@ Change Log
* - 02/21/14
- Added the :ref:`Beta_Testing` chapter.
* - 02/19/14
- Updated :ref:`Import LaTeX Code` to reflect new workflow and UI change for creating Latex HTML components.
- Updated :ref:`Import LaTeX Code` to reflect new workflow and UI change
for creating Latex HTML components.
* - 02/18/14
- Included several enhancements to the chapter :ref:`Establish a Grading Policy`
- Included several enhancements to the chapter :ref:`Establish a Grading
Policy`
* - 02/14/14
- Added :ref:`Additional Transcripts` section to :ref:`Working with Video Components`;
updated :ref:`Video Advanced Options`.
- Added :ref:`Additional Transcripts` section to :ref:`Working with Video
Components`; updated :ref:`Video Advanced Options`.
* -
- Added the :ref:`Course Data`, :ref:`Course_Staffing`, and :ref:`Enrollment` chapters.
- Added the :ref:`Course Data`, :ref:`Course_Staffing`, and
:ref:`Enrollment` chapters.
* - 02/11/14
- Added :ref:`Gene Explorer` and updated :ref:`Interactive Periodic Table` and :ref:`Molecule Editor` in :ref:`Additional Tools`.
- Added :ref:`Gene Explorer` and updated :ref:`Interactive Periodic Table`
and :ref:`Molecule Editor` in :ref:`Additional Tools`.
* - 02/07/14
- Added section on :ref:`Full Screen Image`.
* - 02/06/14
- Added :ref:`Interactive Periodic Table` and :ref:`Molecule Editor` to :ref:`Additional Tools`
- Added :ref:`Interactive Periodic Table` and :ref:`Molecule Editor` to
:ref:`Additional Tools`
* - 02/05/14
- Added section :ref:`Set the Advertised Start Date`.
* - 02/04/14
- Added the :ref:`Student Data` and :ref:`Grades` chapters.
* -
- Added :ref:`Additional Tools` topic with :ref:`Multiple Choice and Numerical Input` and :ref:`Protein Builder`.
- Added :ref:`Additional Tools` topic with :ref:`Multiple Choice and
Numerical Input` and :ref:`Protein Builder`.
* - 01/29/2014
- Added the chapter :ref:`Using an Instant Hangout in Your Course`.
* - 01/24/2014
- Added the :ref:`Discussions` and :ref:`Guidance for Discussion Moderators` chapters.
- Added the :ref:`Discussions` and :ref:`Guidance for Discussion
Moderators` chapters.
* -
- Added more detailed instructions to :ref:`Zooming image`
* - 01/21/2014
- Added information about accessibility in the topic :ref:`Add Textbooks`.
- Added information about accessibility in the topic :ref:`Adding
Textbooks`.
* - 01/14/2014
- Added info about scoring (:ref:`Access Scores`) and due dates in :ref:`Open Response Assessment Problems`.
- Added info about scoring (:ref:`ORA Access Scores`) and due dates in
:ref:`Open Response Assessment Problems`.
* - 01/13/2014
- Extensive updates to :ref:`Organizing Your Course Content` and :ref:`Working with HTML Components`.
- Extensive updates to :ref:`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 the **Files & Uploads** page.
- Updated :ref:`Add Files to a Course` to reflect addition of sorting to
the **Files & Uploads** page.
* -
- Updated :ref:`Set Important Dates for Your Course` to reflect change to default course start date to 2029.
- Updated :ref:`Set Important Dates for Your Course` to reflect change to
default course start date to 2029.
* - 01/07/2014
- Updated :ref:`Text Input` with info about multiple strings.
* -
......@@ -108,15 +133,20 @@ Change Log
* - 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 design.
- Updated the chapters :ref:`Organizing Your Course Content` and
:ref:`Testing Your Course` to reflect changes in the Course Outline
design.
* -
- Updated the topic :ref:`Add Files to a Course` to reflect addition of pagination to the Files & Uploads page.
- Updated the topic :ref:`Add Files to a Course` to reflect addition of
pagination to the Files & Uploads page.
* - 12/20/2013
- Made :ref:`ORA for Students` into template that instructors can customize.
- Made :ref:`ORA for Students` into template that instructors can
customize.
* - 12/19/2013
- Created :ref:`Tools`.
* - 12/18/2013
- Updated documentation about video player options in :ref:`Working with Video Components`.
- Updated documentation about video player options in :ref:`Working with
Video Components`.
* - 12/13/2013
- Created :ref:`LTI Component`.
* -
......@@ -126,10 +156,12 @@ Change Log
* - 12/11/2013
- Added the chapter :ref:`Guidelines for Creating Accessible Content`.
* - 12/10/2013
- Added note about number of responses in "Available to Grade" column in :ref:`Open Response Assessment Problems`.
- Added note about number of responses in "Available to Grade" column in
:ref:`Open Response Assessment Problems`.
* -
- Added :ref:`MathJax in Studio`.
* - 12/09/2013
- Created :ref:`MathJax in Studio`.
* - 12/05/2013
- Complete revision of edX Studio documentation and integration of edX101 content.
- Complete revision of edX Studio documentation and integration of edX101
content.
.. _Add Files to a Course:
###########################
Adding Files to a Course
###########################
*******************
Overview
*******************
To use images in your course content, or to use other documents such as a
syllabus, you must add the files to your course.
* :ref:`Add a File`
* :ref:`File URLs`
* :ref:`Sort Files`
* :ref:`Find Files`
* :ref:`Lock a File`
* :ref:`Delete a File`
.. _Add a File:
*******************
Add a File
*******************
You can add files that you want students to access in the course. After you add
a file, you must link to it from a component, a course update, or in the course
handouts. A file is only visible to students if you create a link to it.
.. note:: Because the file name becomes part of the URL, students can see the
name of the file when they open it. Avoid using file names such as
AnswerKey.pdf.
.. warning:: If you upload a file with the same name as an existing course file,
the original file is overwritten without warning.
To add files:
#. From the **Content** menu, select **Files & Uploads**.
#. Click **Upload New File**.
#. In the **Upload New File** dialog box, click **Choose File**.
#. In the **Open** dialog box, select one more files that you want to upload,
then click **Open**.
#. To add more file, click **Load Another File** and repeat the previous step.
#. 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.
.. _File URLs:
*******************
File URLs
*******************
In the Files & Uploads page, each file has has an **Embed URL** and an
**External URL**:
.. image:: ../Images/files_uploads_urls.png
:alt: Image of the Files and Uploads page, with Embed URL and External URL
columns circled
* You use the **Embed URL** to link to the file or image from a component, a
course update, or a course handout.
* You use the **External URL** to reference the file or image from outside of
your course. The external URL does not work if you lock the file unless the
person accessing the URL is enrolled in the course.
.. warning:: You cannot use the External URL as the reference to a file or
image from within your course.
You can double click a value in the **Embed URL** or **External URL** column to select the value, then copy it.
.. _Sort Files:
*******************
Sort Files
*******************
By default, files are sorted by the **Date Added** column, with the most
recently added first.
Alternatively, can also sort the list by the **Name** column by clicking on the
column header.
For either the the **Date Added** or **Name** column, you can switch the sort
order from descending to ascending, and back, by clicking the column header a
second time.
The current sort order is shown at the top of the file list, and the active sort
column header is underlined:
.. image:: ../Images/file_sort.png
:alt: Sorting files in the Files & Uploads page
.. _Find Files:
*******************
Find Files
*******************
The **Files & Uploads** page lists up to 50 files. If your course has more than
50 files, additional files are listed on 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
:alt: Pagination in the Files & Uploads page
.. _Lock a File:
*******************
Lock a File
*******************
By default, anyone can access a file you upload if they know the URL, even
people not enrolled in your class.
To ensure that those not in your class cannot view the file, click the lock
icon.
.. note:: The external URL does not work if you lock the file.
.. _Delete a File:
*******************
Delete a File
*******************
To delete a file, click the **x** icon next to the file. You are prompted to
confirm the deletion.
.. warning:: If you have links to a file you delete, those links will be broken.
Ensure you change those links before deleting the file.
\ No newline at end of file
......@@ -8,7 +8,7 @@ Working with Discussion Components
Overview
*******************
You can add a Discussion component to a Unit, to pose a question related to the
You can add a Discussion component to a unit, to pose a question related to the
Unit and give students a chance to respond and interact.
See the following topics:
......@@ -39,8 +39,8 @@ Create a Discussion Component
Discussion component is set to Private.
To create a new Discussion component in an existing Unit, ensure the Unit is
Private. For more information on Public and Private Units, see :ref:`Public and
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 the **discussion** icon.
......
......@@ -8,15 +8,22 @@ Working with Video Components
**********************
Introduction to Videos
**********************
You can create a video of your lecture and add it to your course with other components—such
as discussions and problems—to promote active learning. Adding a video to your course has several steps.
You can create a video of your lecture and add it to your course with other
components—such as discussions and problems—to promote active learning. Adding a
video to your course has several steps.
#. Create the video.
#. Create or obtain a transcript for the video.
#. Post the video online.
#. In Studio, create a Video component.
#. :ref:`Create the Video`.
#. :ref:`Create Transcript`.
#. :ref:`Post the Video Online`.
#. :ref:`Create a Video Component`.
.. note:: Review :ref:`Best Practices for Accessible Media` before adding videos to your course.
Also see:
* :ref:`Additional Transcripts`
* :ref:`Steps for sjson files`
.. note:: Review :ref:`Best Practices for Accessible Media` before adding videos
to your course.
.. _Create the Video:
......@@ -24,17 +31,21 @@ as discussions and problems—to promote active learning. Adding a video to your
Step 1. Create the Video
************************
Your video can contain whatever content you want. The `Producing Videos <https://edge.edx.org/courses/edX/edX101/How_to_Create_an_edX_Course/courseware/93451eee15ed47b0a310c19020e8dc64/a1b0835e986b4283b0f8871d97babb9a/>`_
section of our `edX101 <https://edge.edx.org/courses/edX/edX101/How_to_Create_an_edX_Course/about>`_
Your video can contain whatever content you want. The `Producing Videos <https:/
/edge.edx.org/courses/edX/edX101/How_to_Create_an_edX_Course/courseware/93451eee
15ed47b0a310c19020e8dc64/a1b0835e986b4283b0f8871d97babb9a/>`_ section of our
`edX101
<https://edge.edx.org/courses/edX/edX101/How_to_Create_an_edX_Course/about>`_
course has some helpful pointers for creating good video content.
.. _Compression Specifications:
====================================
Compression Specifications
--------------------------
====================================
When you create your video, edX recommends the following compression specs. (Note that
these are recommended but not required.)
When you create your video, edX recommends the following compression specs.
(Note that these are recommended but not required.)
.. list-table::
:widths: 10 20 20 20
......@@ -76,8 +87,9 @@ these are recommended but not required.)
.. _Video Formats:
==================
Video Formats
-------------
==================
The edX video player supports videos in .mp4, .mpeg, .ogg, and .webm format.
......@@ -87,47 +99,77 @@ The edX video player supports videos in .mp4, .mpeg, .ogg, and .webm format.
Step 2. Create or Obtain a Video Transcript
*********************************************
We strongly recommend that you associate a timed transcript with your video. Transcripts can be helpful for students whose first language isn't English, who can't watch the video, or who want to review the video's content. The transcript scrolls automatically while your video plays. When a student clicks a word in the transcript, the video opens to that word. You can also allow your students to download the transcript so that they can read it offline. You'll associate the transcript with the video when you create the Video component.
**To play automatically with the video, your transcript file must be an .srt file.** To create or obtain a transcript in .srt format, you can work with a company that provides captioning services. EdX works with `3Play Media <http://www.3playmedia.com>`_. `YouTube <http://www.youtube.com/>`_ also provides captioning services.
In addition to your .srt file, you can provide other transcripts with your video. For example, you can provide downloadable transcripts in a text format such as .txt or .pdf, and you can provide transcripts in different languages. For more information, see :ref:`Additional Transcripts`.
If you provide transcripts for students to download, a **Download transcript** button appears under the video. Students can then select either **SubRip (.srt) file** or **Text (.txt) file** to download the .srt or .txt transcript.
We strongly recommend that you associate a timed transcript with your video.
Transcripts can be helpful for students whose first language isn't English, who
can't watch the video, or who want to review the video's content. The transcript
scrolls automatically while your video plays. When a student clicks a word in
the transcript, the video opens to that word. You can also allow your students
to download the transcript so that they can read it offline. You'll associate
the transcript with the video when you create the Video component.
**To play automatically with the video, your transcript file must be an .srt
file.** To create or obtain a transcript in .srt format, you can work with a
company that provides captioning services. EdX works with `3Play Media
<http://www.3playmedia.com>`_. `YouTube <http://www.youtube.com/>`_ also
provides captioning services.
In addition to your .srt file, you can provide other transcripts with your
video. For example, you can provide downloadable transcripts in a text format
such as .txt or .pdf, and you can provide transcripts in different languages.
For more information, see :ref:`Additional Transcripts`.
If you provide transcripts for students to download, a **Download transcript**
button appears under the video. Students can then select either **SubRip (.srt)
file** or **Text (.txt) file** to download the .srt or .txt transcript.
.. image:: ../Images/transcript-download.png
.. note:: Some past courses have used .sjson files for video transcripts. If transcripts in your course uses this format, see :ref:`Steps for sjson files`. We don't recommend that you use .sjson files.
.. note:: Some past courses have used .sjson files for video transcripts. If
transcripts in your course uses this format, see :ref:`Steps for sjson
files`. We don't recommend that you use .sjson files.
.. _Post the Video Online:
*****************************
Step 3. Post the Video Online
*****************************
All course videos should be posted to YouTube. By default, the edX video player accesses your YouTube videos.
Because YouTube is not available in all locations, however, we recommend that you also post
copies of your videos on a third-party site such as `Amazon S3 <http://aws.amazon.com/s3/>`_. When a student views a video in your course, if YouTube is not available in that student’s location or if
the YouTube video doesn’t play, the video on the backup site starts playing automatically.
The student can also click a link to download the video from the backup site.
All course videos should be posted to YouTube. By default, the edX video player
accesses your YouTube videos.
After you post your video online, make sure you have the URL for the video. If you host copies of your video in more than one place, make sure you have the URL for each video location.
Because YouTube is not available in all locations, however, we recommend that
you also post copies of your videos on a third-party site such as `Amazon S3
<http://aws.amazon.com/s3/>`_. When a student views a video in your course, if
YouTube is not available in that student’s location or if the YouTube video
doesn’t play, the video on the backup site starts playing automatically. The
student can also click a link to download the video from the backup site.
After you post your video online, make sure you have the URL for the video. If
you host copies of your video in more than one place, make sure you have the URL
for each video location.
==================
YouTube
-------
==================
After you've created your video, upload the video to `YouTube <http://www.youtube.com/>`_.
After you've created your video, upload the video to `YouTube
<http://www.youtube.com/>`_.
.. note:: YouTube only hosts videos of up to 15 minutes. If you create a 0.75-speed option, you must make sure that your 1.0-speed video segments are only 11.25 minutes long so that YouTube can host all speeds. YouTube offers paid accounts that relax this restriction.
.. note:: YouTube only hosts videos of up to 15 minutes. If you create a
0.75-speed option, you must make sure that your 1.0-speed video segments are
only 11.25 minutes long so that YouTube can host all speeds. YouTube offers
paid accounts that relax this restriction.
==================
Other Sites
-----------
==================
You can use any video backup site that you want. However, keep in mind that the site where you
post the videos may have to handle a lot of traffic.
You can use any video backup site that you want. However, keep in mind that the
site where you post the videos may have to handle a lot of traffic.
.. note:: The URL for the video that you post on a third-party site must end in .mp4, .mpeg, .ogg, or .webm. EdX can't support videos that you post on sites such as Vimeo.
.. note:: The URL for the video that you post on a third-party site must end in
.mp4, .mpeg, .ogg, or .webm. EdX can't support videos that you post on sites
such as Vimeo.
......@@ -139,17 +181,20 @@ Step 4. Create a Video Component
#. Under **Add New Component**, click **Video**.
#. When the new video component appears, click **Edit**. The video editor opens to the **Basic** tab.
#. When the new video component appears, click **Edit**. The video editor opens
to the **Basic** tab.
.. image:: ../Images/VideoComponentEditor.png
:alt: Image of the video component editor
You'll replace the default values with your own.
#. In the **Display Name** field, enter the name you want students to see when they hover the mouse
over the unit in the course ribbon. This text also appears as a header for the video.
#. In the **Display Name** field, enter the name you want students to see when
they hover the mouse over the unit in the course ribbon. This text also
appears as a header for the video.
#. In the **Video URL** field, enter the URL of the video. For example, the URL may resemble one of the following.
#. In the **Video URL** field, enter the URL of the video. For example, the URL
may resemble one of the following.
::
......@@ -160,62 +205,102 @@ Step 4. Create a Video Component
#. Next to **Timed Transcript**, select an option.
- If edX already has a transcript for your video--for example, if you're using a video from an existing course--Studio automatically finds the transcript and associates the transcript with the video.
- If edX already has a transcript for your video--for example, if you're
using a video from an existing course--Studio automatically finds the
transcript and associates the transcript with the video.
If you want to modify the transcript, click **Download to Edit**. You can then make your changes and upload the new file by clicking **Upload New Timed Transcript**.
If you want to modify the transcript, click **Download to Edit**. You can
then make your changes and upload the new file by clicking **Upload New
Timed Transcript**.
- If your video has a transcript on YouTube, Studio automatically finds the transcript and asks if you want to import it. To use this YouTube transcript, click **Import from YouTube**. (If you want to modify the YouTube transcript, after Studio imports the transcript, click **Download to Edit**. You can then make your changes and upload the new file by clicking **Upload New Timed Transcript**.)
- If your video has a transcript on YouTube, Studio automatically finds the
transcript and asks if you want to import it. To use this YouTube
transcript, click **Import from YouTube**. (If you want to modify the
YouTube transcript, after Studio imports the transcript, click **Download
to Edit**. You can then make your changes and upload the new file by
clicking **Upload New Timed Transcript**.)
- If neither edX nor YouTube has a transcript for your video, and your transcript uses the .srt format, click **Upload New Timed Transcript** to upload the transcript file from your computer.
- If neither edX nor YouTube has a transcript for your video, and your
transcript uses the .srt format, click **Upload New Timed Transcript** to
upload the transcript file from your computer.
.. note::
* If your transcript uses the .sjson format, do not use this setting. For more information, see :ref:`Steps for sjson files`.
* If your transcript uses the .sjson format, do not use this setting.
For more information, see :ref:`Steps for sjson files`.
* If you want to provide a transcript in a format such as .txt or .pdf, do not use this setting to upload the transcript. For more information, see :ref:`Additional Transcripts`.
* If you want to provide a transcript in a format such as .txt or .pdf,
do not use this setting to upload the transcript. For more
information, see :ref:`Additional Transcripts`.
#. Optionally, click **Advanced** to set more options for the video. For a description of each option, see the list below.
#. Optionally, click **Advanced** to set more options for the video. For a
description of each option, see the list below.
#. Click **Save.**
.. _Video Advanced Options:
==================
Advanced Options
----------------
==================
The following options appear on the **Advanced** tab in the Video component.
* **Display Name**: The name that you want your students to see. This is the same as the **Display Name** field on the **Basic** tab.
* **Display Name**: The name that you want your students to see. This is the
same as the **Display Name** field on the **Basic** tab.
* **Download Transcript**: The URL for the transcript file for the video. This file is usually an .srt file, but can also be a .txt or .pdf file. (For more information about .txt and .pdf files, see :ref:`Additional Transcripts`.) The URL can be an external URL, such as **http://example.org/transcript.srt**, or the URL for a file that you've uploaded to your **Files & Uploads** page, such as **/static/example.srt**.
* **Download Transcript**: The URL for the transcript file for the video. This
file is usually an .srt file, but can also be a .txt or .pdf file. (For more
information about .txt and .pdf files, see :ref:`Additional Transcripts`.) The
URL can be an external URL, such as **http://example.org/transcript.srt**, or
the URL for a file that you've uploaded to your **Files & Uploads** page, such
as **/static/example.srt**.
This setting is related to **Transcript Download Allowed**.
* If you set **Transcript Download Allowed** to **True**, and you specify a file in the **Download Transcript** field, the file you've specified will be available for students to download.
* If you set **Transcript Download Allowed** to **True**, and you specify a
file in the **Download Transcript** field, the file you've specified will be
available for students to download.
* If you set **Transcript Download Allowed** to **True**, but you leave the **Download Transcript** field blank, the .srt transcript that automatically plays with the video will be available.
* If you set **Transcript Download Allowed** to **True**, but you leave the
**Download Transcript** field blank, the .srt transcript that automatically
plays with the video will be available.
* **End Time**: The time, formatted as hours, minutes, and seconds (HH:MM:SS), when you want the video to end.
* **End Time**: The time, formatted as hours, minutes, and seconds (HH:MM:SS),
when you want the video to end.
* **Start Time**: The time, formatted as hours, minutes, and seconds (HH:MM:SS), when you want the video to begin.
* **Start Time**: The time, formatted as hours, minutes, and seconds (HH:MM:SS),
when you want the video to begin.
* **Transcript (primary)**: The name of the .srt file from the **Timed Transcript** field on the **Basic** tab. This field is auto-populated. You don't have to change this setting.
* **Transcript (primary)**: The name of the .srt file from the **Timed
Transcript** field on the **Basic** tab. This field is auto-populated. You
don't have to change this setting.
If your transcript uses an .sjson file, see :ref:`Steps for sjson files`.
* **Transcript Display**: Specifies whether you want the transcript to show by default. Students can always turn transcripts on or off while they watch the video.
* **Transcript Display**: Specifies whether you want the transcript to show by
default. Students can always turn transcripts on or off while they watch the
video.
* **Transcript Download Allowed**: Specifies whether you want to allow your students to download a copy of the transcript.
* **Transcript Download Allowed**: Specifies whether you want to allow your
students to download a copy of the transcript.
* **Transcript Translations**: The transcript files for any additional languages. For more information, see :ref:`Transcripts in Additional Languages`.
* **Transcript Translations**: The transcript files for any additional
languages. For more information, see :ref:`Transcripts in Additional
Languages`.
* **Video Download Allowed**: Specifies whether you want to allow your students to download a copy of the video.
* **Video Download Allowed**: Specifies whether you want to allow your students
to download a copy of the video.
* **Video Sources**: Additional locations where you've posted the video. This field must contain a URL that ends in .mpeg, .mp4, .ogg, or .webm.
* **Video Sources**: Additional locations where you've posted the video. This
field must contain a URL that ends in .mpeg, .mp4, .ogg, or .webm.
* **YouTube ID, YouTube ID for .75x speed, YouTube ID for 1.25x speed, YouTube ID for 1.5x speed**: If you have uploaded separate videos to YouTube for different speeds of your video, enter the YouTube IDs for these videos in these fields.
* **YouTube ID, YouTube ID for .75x speed, YouTube ID for 1.25x speed, YouTube
ID for 1.5x speed**: If you have uploaded separate videos to YouTube for
different speeds of your video, enter the YouTube IDs for these videos in
these fields.
.. _Additional Transcripts:
......@@ -224,39 +309,62 @@ The following options appear on the **Advanced** tab in the Video component.
Additional Transcripts
**********************
You can provide your students with a downloadable transcript in a format such as .txt or .pdf in addition to the .srt transcript that plays along with the video.
You can provide your students with a downloadable transcript in a format such as
.txt or .pdf in addition to the .srt transcript that plays along with the video.
#. Upload the .txt or .pdf transcript to the **Files & Uploads** page or host it on an external website.
#. Upload the .txt or .pdf transcript to the **Files & Uploads** page or host it
on an external website.
#. In the Video component, click the **Advanced** tab.
#. In the **Download Transcript** field, enter the URL for the transcript. For more information, see :ref:`Video Advanced Options`.
#. In the **Download Transcript** field, enter the URL for the transcript. For
more information, see :ref:`Video Advanced Options`.
.. _Transcripts in Additional Languages:
====================================
Transcripts in Additional Languages
-----------------------------------
====================================
You can provide transcripts for your video in other languages. To do this, you'll work with a third-party service to obtain an .srt transcript file for each language, and then associate the .srt file with the video in Studio.
You can provide transcripts for your video in other languages. To do this,
you'll work with a third-party service to obtain an .srt transcript file for
each language, and then associate the .srt file with the video in Studio.
#. After you've obtained the .srt files for additional languages, upload the .srt transcript files for those languages to the **Files & Uploads** page. Make a note of the URL for each .srt file.
#. After you've obtained the .srt files for additional languages, upload the
.srt transcript files for those languages to the **Files & Uploads** page.
Make a note of the URL for each .srt file.
For more information about uploading files, see :ref:`Add Files to a Course`.
#. In Studio, open the Video component for the video.
#. On the **Advanced** tab, scroll down to **Transcript Translations**, and then click **Add**. Two boxes appear above the **Add** button.
#. On the **Advanced** tab, scroll down to **Transcript Translations**, and then
click **Add**. Two boxes appear above the **Add** button.
#. In the box on the left, enter the ISO 639-1 language code for the language of the transcript file. To find a language code, see the second column of the `Codes for the Representation of Names chart <http://www.loc.gov/standards/iso639-2/php/code_list.php>`_. For example, you might enter **es** for Spanish, or **ru** for Russian.
#. In the box on the left, enter the ISO 639-1 language code for the language of
the transcript file. To find a language code, see the second column of the
`Codes for the Representation of Names chart
<http://www.loc.gov/standards/iso639-2/php/code_list.php>`_. For example, you
might enter **es** for Spanish, or **ru** for Russian.
#. In the box on the right, enter the URL for the language transcript file you uploaded to the **Files & Uploads** page. For example, you might enter **/static/Video1_Spanish.srt** or **/static/Video1_Russian.srt**.
#. In the box on the right, enter the URL for the language transcript file you
uploaded to the **Files & Uploads** page. For example, you might enter
**/static/Video1_Spanish.srt** or **/static/Video1_Russian.srt**.
.. image:: ../Images/TranscriptTranslations.png
:alt: Image of Transcript Translations fields
.. note:: Make sure that all your transcript file names are unique to each video and language. If you use the same transcript name in more than one Video component, the same transcript will play for each video. To avoid this problem, you could name your foreign language transcript files according to the video's file name and the transcript language.
.. note:: Make sure that all your transcript file names are unique to each video
and language. If you use the same transcript name in more than one Video
component, the same transcript will play for each video. To avoid this
problem, you could name your foreign language transcript files according to
the video's file name and the transcript language.
For example, you may have two videos, named 12345abcde.mp4 and 54321edcba.mp4. Each video has a Russian transcript and a Spanish transcript. You can name the transcripts for the first video 12345abcde_ru.srt and 12345abcde_es.srt, and name the transcripts for the second video 54321edcba_ru.srt and 54321edcba_es.srt.
For example, you may have two videos, named 12345abcde.mp4 and 54321edcba.mp4.
Each video has a Russian transcript and a Spanish transcript. You can name the
transcripts for the first video 12345abcde_ru.srt and 12345abcde_es.srt, and
name the transcripts for the second video 54321edcba_ru.srt and
54321edcba_es.srt.
.. _Steps for sjson files:
......@@ -264,20 +372,26 @@ You can provide transcripts for your video in other languages. To do this, you'l
Steps for .sjson Files
**********************
If your course uses .sjson files, you'll upload the .sjson file for the video to the **Files & Uploads** page, and then specify the name of the .sjson file in the Video component.
If your course uses .sjson files, you'll upload the .sjson file for the video to
the **Files & Uploads** page, and then specify the name of the .sjson file in
the Video component.
.. note:: Only older courses that have used .sjson files in the past should use .sjson files. All new courses should use .srt files.
.. note:: Only older courses that have used .sjson files in the past should use
.sjson files. All new courses should use .srt files.
#. Obtain the .sjson file from a media company such as 3Play.
#. Change the name of the .sjson file to use the following format:
``subs_FILENAME.srt.sjson``
For example, if the name of your video is **Lecture1a**, the name of your .sjson file must be **subs_Lecture1a.srt.sjson**.
For example, if the name of your video is **Lecture1a**, the name of your
.sjson file must be **subs_Lecture1a.srt.sjson**.
#. Upload the .sjson file for your video to the **Files & Uploads** page.
#. Create a new video component.
#. On the **Basic** tab, enter the name that you want students to see in the **Display Name** field.
#. In the **Video URL** field, enter the URL of the video. For example, the URL may resemble one of the following.
#. On the **Basic** tab, enter the name that you want students to see in the
**Display Name** field.
#. In the **Video URL** field, enter the URL of the video. For example, the URL
may resemble one of the following.
::
......@@ -286,6 +400,8 @@ If your course uses .sjson files, you'll upload the .sjson file for the video to
https://s3.amazonaws.com/edx-course-videos/edx-edx101/EDXSPCPJSP13-G030300.mp4
#. Click the **Advanced** tab.
#. In the **Transcript (primary)** field, enter the file name of your video. Do not include `subs_` or `.sjson`. For the example in step 2, you would only enter **Lecture1a**.
#. In the **Transcript (primary)** field, enter the file name of your video. Do
not include `subs_` or `.sjson`. For the example in step 2, you would only
enter **Lecture1a**.
#. Set the other options that you want.
#. Click **Save**.
.. _Adding Course Updates and Handouts:
######################################################
Adding Course Updates and Handouts
######################################################
You add course updates and handouts in Studio.
Student's see the course updates and handouts in the **Course Info** tab in your
course:
.. image:: ../Images/course_info.png
:alt: Image of the Course Info page.
.. _Add a Course Update:
**********************
Add a Course Update
**********************
You add updates to notify students of exams, changes in the course schedule, or
anything else of a more urgent nature.
To add a course update:
#. From the **Content** menu, select **Updates**.
#. Click **New Update**.
#. Enter your update in the HTML editor that opens.
.. note:: You must enter the update in HTML.
4. Click **Save**.
.. _Add Course Handouts:
**********************
Add Course Handouts
**********************
You can add course handouts that are visible to students on the **Course Info**
page. To add an uploaded file to the course handouts, you will need its URL.
.. note:: You must :ref:`Add Files to a Course` before you can add them as
course handouts.
#. From the **Content** menu, select **Updates**.
#. In the **Course Handouts** panel, click **Edit**.
#. Edit the HTML to add links to the files you uploaded. See :ref:`Add a Link in
an HTML Component` for more information.
#. Click **Save**.
......@@ -9,6 +9,11 @@ Creating Course Content
:maxdepth: 2
accessibility
course_files
handouts_updates
textbooks
pages
organizing_course
create_html_component
create_video
create_discussion
......
......@@ -18,9 +18,12 @@ You organize your course in the following hierarchy:
* :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.
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.
.. note:: We recommend that you review :ref:`Guidelines for Creating Accessible
Content` before developing content for your course.
==================
......@@ -34,7 +37,8 @@ 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 callouts for sections, subsection, and units
: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:
......@@ -47,12 +51,15 @@ The following image shows the way this course content appears in the LMS:
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.
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.
#. 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.
......@@ -68,22 +75,29 @@ See :ref:`Publishing Your Course` for more information.
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."
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.
#. 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.
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.
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.
......@@ -96,15 +110,19 @@ You can also do the following.
- 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)
- 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`.
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 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`.
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:
......@@ -112,22 +130,32 @@ For more information about viewing drafts or the current version of your course,
Units
******
Subsections are divided into units. A unit, in turn, contains one or more components, such as HTML content, problems, and videos.
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:
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.
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.
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.
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.
- 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`.
- 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.
......@@ -135,13 +163,14 @@ 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.
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:
......@@ -149,26 +178,35 @@ After you create a new unit, you can create components in the unit.
Components
**********
A component is the part of a unit that contains your actual course content. A unit can contain one or more 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.
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.
- **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**.
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:
For more information, see the documentation for the specific component type that
you want:
- :ref:`Working with Discussion Components`
- :ref:`Working with HTML Components`
......@@ -179,20 +217,26 @@ For more information, see the documentation for the specific component type that
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`.
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:
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.
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 accordian.
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 accordian.
To set the display name for a component:
......@@ -205,38 +249,51 @@ To set the display name 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.
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`.
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 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:
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.
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`.
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.
.. 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:
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.
Click the Delete icon. Then follow instructions for the type of component you
are editing.
.. _Reorganize Your Course:
......@@ -244,14 +301,21 @@ Click the Delete icon. Then follow instructions for the type of component you a
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.
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.
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
: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.
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
:alt: Image of the course outline, with a unit being dragged to a different
location
\ No newline at end of file
.. _Appendix B:
.. _Adding Pages to a Course:
===========================================
###########################
Adding Pages to a Course
###########################
*******************
Overview
*******************
By default, your course has the following pages:
* Courseware
* Course Info
* Discussion
* Wiki
* Progress
You cannot rename, reorder, or remove these pages.
You can add pages to your course. Each page appears in your course's navigation bar.
For example, the following navigation bar includes the default pages as well as the
**Course Schedule** and **Supplements & Instructor's Blog** pages.
.. image:: ../Images/page_bar_lms.png
:alt: Image of the page bar in the LMS
You can create other pages for the grading policy, course slides, or any other purpose. More examples of pages you can add are:
* A Google calendar, by embedding the code for it.
* A dynamic HTML calendar, using the template in :ref:`Code for Dynamic HTML Schedule`.
* An instant hangout. See :ref:`Using an Instant Hangout in Your Course` for more information.
See:
* :ref:`Add a Page`
* :ref:`Reorder Pages`
* :ref:`Delete a Page`
* :ref:`Code for Dynamic HTML Schedule`
.. _`Add a Page`:
****************
Add a Page
****************
#. In Studio, from the **Content** menu, select **Pages**.
.. image:: ../Images/pages_page.png
:alt: Image of the Pages screen
2. Click **Add a New Page**. A page with the title **Empty** is added to the list:
.. image:: ../Images/pages_empty.png
:alt: Image of the Pages screen with a new Empty page
3. Click **Edit**. The HTML editor opens.
.. image:: ../Images/pages_editor.png
:alt: Image of the Page editor
4. Enter text for your page. See :ref:`The User Interface` for more information about using the editor.
#. Click **Settings** to edit the **Display Name**. The display name is the name of the page visible to students in the course.
#. Click **Save**.
The new page is immediately available to students, if the course has started.
.. _Reorder Pages:
****************
Reorder Pages
****************
You can reorder pages in your course by dragging and dropping the pages to different locations.
To move a page, hover over the element handle on the right side of the page row until the mouse pointer changes to a four-headed arrow. Then, click and drag the page to the location that you want.
.. note:: You cannot reorder the Courseware, Course Info, Discussion, Wiki, and Progress pages that your course includes by default
.. _Delete a Page:
****************
Delete a Page
****************
To delete a page that you previously added, click the trash can icon in the row for the page. You are prompted to confirm the deletion.
.. _Code for Dynamic HTML Schedule:
********************************
Code for Dynamic HTML Schedule
===========================================
********************************
You can use the following code in a page to provide a dynamic HTML schedule in your course.
.. code-block:: html
......
.. _Adding Textbooks:
###########################
Adding Textbooks
###########################
You can add PDF textbooks for your course.
.. note:: Do not use image files (for example, .PNG files) as textbooks for
your course, as they are not accessible to screen readers. Review the
:ref:`Best Practices for Accessible PDFs` for more information.
Each textbook that you add is displayed to students as a tab in the course
navigation bar.
It's recommended that you upload a separate PDF file for each chapter of your
textbook.
When students open the textbook tab in the course, they can navigate the
textbook by chapter:
.. image:: ../Images/textbook_chapters.png
:alt: Image of a textbook in a course.
To add a textbook:
#. From the **Content** menu, select **Textbooks**.
#. Click **New Textbook**. The following screen opens:
.. image:: ../Images/textbook_new.png
:alt: Image of the New Textbook page.
3. Enter the **Textbook Name**.
#. Enter the first **Chapter Name**.
#. To upload a PDF file from your computer, click **Upload PDF**. Follow the
prompts to upload your file.
#. To add more chapters, click **+Add a Chapter** and repeat steps 3 and 4.
#. Click **Save**.
\ No newline at end of file
......@@ -16,7 +16,7 @@ A
The course page that provides potential students with a course summary, prerequisites, a course video and image, and important dates.
See :ref:`Setting up a New Course` for more information.
See :ref:`The Course Summary Page` for more information.
.. _Advanced Editor-g:
......@@ -231,7 +231,7 @@ G
List of the items that a student's response should cover in an open response assessment.
See :ref:`Rubrics` for more information.
See :ref:`ORA Rubrics` for more information.
.. _H:
......@@ -383,7 +383,7 @@ P
Pages that supplement the courseware for a course. Each page appears in your course's navigation bar.
See :ref:`Add Pages` for more information.
See :ref:`Adding Pages to a Course` for more information.
.. _Preview Mode:
......@@ -443,7 +443,7 @@ R
List of the items that a student's response should cover in an open response assessment.
See :ref:`Rubrics` for more information.
See :ref:`ORA Rubrics` for more information.
......
......@@ -38,7 +38,7 @@ Instant Hangouts in Your Course
You can add one or more instant hangouts in your course. For example, you can add an instant hangout:
* In a page, to provide students with a hangout for the entire course. See :ref:`Add Pages` for more information.
* In a page, to provide students with a hangout for the entire course. See :ref:`Adding Pages to a Course` for more information.
* In an HTML component, to provide a hangout for students working on that specific course unit. See :ref:`Working with HTML Components` for more information about creating HTML components.
......
......@@ -58,7 +58,7 @@ see :ref:`ORA Self Assessment`, :ref:`ORA Peer Assessment`, and :ref:`ORA AI Ass
After you submit your response, your score will be available shortly - sometimes within a few
minutes. For information about how to access your score after your response has been graded,
see :ref:`ORA Access Scores`.
see :ref:`ORA Access Scores Students`.
If you want to experiment with open response assessments, you can try out the open
assessment problems in the `EdX Demo <https://courses.edx.org/courses/edX/DemoX/Demo_Course/info>`_
......@@ -291,7 +291,7 @@ student who submitted the response.
.. image:: ../Images/DoneGrading.png
When you see this message, you can access the score for your own
response. For more information, see :ref:`ORA Access Scores`.
response. For more information, see :ref:`ORA Access Scores Students`.
If you want to grade additional responses at any time, you can go back
to the **Peer Grading** page and click the name of the problem that you want
......@@ -339,9 +339,9 @@ responses, you may receive your grade within minutes, or you may have to wait
a few days. You won't receive a notification when your score is ready, so keep
checking back.
For more information about accessing your scores, see :ref:`ORA Access Scores`.
For more information about accessing your scores, see :ref:`ORA Access Scores Students`.
.. _ORA Access Scores:
.. _ORA Access Scores Students:
Access Scores and Feedback
--------------------------
......
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