Skip to content

E
edx-platform
Commit 229e9216 by spearce
Options

Update docs per Anant's feedback

parent 7692f0d8
Showing with 322 additions and 277 deletions
docs/course_authors/source/LaTeX_DoNotInclude 0 → 100644
.. _Import Content from LaTeX:
*************************
Import Content from LaTeX
*************************
If LaTeX is enabled for your course, you can create an HTML component from imported LaTeX code.
Studio uses a third-party LaTeX processor to convert LaTeX code to XML. The LaTeX processor must be up and running.
1. When creating the new HTML component, select **E-text Written in LaTeX**.
The new HTML component opens, with an **upload** link:
.. image:: Images/latex_upload.png
:width: 800
2. To upload a LaTeX file from your computer, click **upload**.
You are prompted to select a file. The file loads in the LaTeX editor.
3. In the LaTeX editor, click **Save & Compile to edX XML**.
The LaTeX content is added to the HTML component. For example:
.. image:: Images/Latex_component.png
:width: 800
4. Verify that your newly created component looks the way you want it to.
You can edit the HTML component with LaTeX as you can any other component.
In the editor, you can launch the LaTeX source compiler.
\ No newline at end of file
docs/course_authors/source/create_html_component.rst
...@@ -5,27 +5,60 @@ ...@@ -5,27 +5,60 @@
Working with HTML Components Working with HTML Components
############################# #############################
******************* ***********************
Overview HTML Component Overview
******************* ***********************
You use an HTML component to add and format text for your course. HTML components are the most basic building blocks of your course. You use HTML components to add and format text, links, images, and more.
You can add text, lists, links and images in an HTML component.
See the following topics: For more information, see the following topics:
* :ref:`The User Interface`
* :ref:`Create an HTML Component` * :ref:`Create an HTML Component`
* :ref:`Work with the Visual and HTML Editors`
* :ref:`Use the Announcement Template`
* :ref:`Use the Anonymous User ID Template`
* :ref:`Import Content from LaTex`
* :ref:`Add a Link in an HTML Component` * :ref:`Add a Link in an HTML Component`
* :ref:`Add an Image to an HTML Component` * :ref:`Add an Image to an HTML Component`
* :ref:`Import LaTeX Code`
.. note:: Ensure you understand the chapter :ref:`Organizing Your Course Content` before working with HTML components. .. note:: Review :ref:`Organizing Your Course Content` and :ref:`Best Practices for HTML Markup` before you start working with HTML components.
.. note:: Review :ref:`Best Practices for HTML Markup` before adding HTML components to your course. .. _The User Interface:
*****************************************
The HTML Component User Interface
*****************************************
When you create a new HTML component, you work with the HTML component editor. The editor has two views: **Visual view** and **HTML view.** To switch between Visual view and HTML view, click the tab in the upper-right corner of the component editor.
.. image:: Images/HTMLEditorTabs.gif
- **Visual view** provides a “what you see is what you get” (WYSIWYG) editor that allows you to format text by clicking the formatting buttons at the top of the editor. By default, every HTML component opens in Visual view.
Visual view includes the following formatting buttons.
.. image:: Images/HTML_VisualView_Toolbar.gif
#. Select a formatting style, such as heading 1, heading 2, or paragraph.
#. Format text in bold.
#. Format text in italics.
#. Underline text.
#. Create a bulleted list.
#. Create a numbered list.
#. Decrease the indent.
#. Indent text.
#. Format text as a blockquote.
#. Format text as code (i.e., in Courier font).
#. Create a link.
#. Delete the current link.
Visual view shows your content the way it will appear in the LMS. The following is the LMS rendition of the HTML component above.
.. image:: Images/HTMLComponent_VisualView_LMS.gif
- **HTML view** allows you to edit HTML code directly.
.. image:: Images/HTML_HTMLView.gif
.. note:: If you're in HTML view, you can always switch to Visual view to make sure your content looks the way you expect. For example, we recommend that you do this if you add an image or a link to an HTML component.
.. _Create an HTML Component: .. _Create an HTML Component:
...@@ -33,239 +66,213 @@ See the following topics: ...@@ -33,239 +66,213 @@ See the following topics:
Create an HTML Component Create an HTML Component
***************************** *****************************
To create a new HTML component in an existing unit, ensure the unit is private. To create an HTML component:
For more information on public and private units, see :ref:`Public and Private Units`.
#. Under **Add New Component**, click the **html** icon. 1. Under **Add New Component**, click **html**.
.. image:: Images/NewComponent_HTML.png .. image:: Images/NewComponent_HTML.gif
2. In the list that appears, click **Text**. 2. In the list that appears, click **Text**.
An empty component appears at the bottom of the Unit. An empty component appears at the bottom of the unit.
.. image:: Images/HTMLComponent_Edit.png .. image:: Images/HTMLComponent_Edit.gif
3. In the empty component, click **Edit**. 3. In the empty component, click **Edit**.
The HTML Component Editor opens.
.. image:: Images/HTMLEditor.png
4. Click **Settings** to enter the **Display Name** for the HTML component. The HTML component editor opens in Visual view.
.. image:: Images/HTMLEditor.gif
A student sees the Display when hovering your mouse over the icon for the Unit in the Subsection accordian. 4. Enter the text and formatting that you want, either by using the formatting buttons in Visual view or by manually adding HTML tags in HTML view.
Click **Save** to return to the Component Editor. 5. Enter a display name (the name that you want students to see). To do this, click **Settings** in the upper-right corner of the component editor, and then enter text in the **Display Name** field.
5. Enter text as needed. To return to the text editor, click **Editor** in the upper-right corner.
6. Click **Save** to save the HTML component. 6. Click **Save** to save the HTML component.
For more information, see: You can also add links and images to HTML components. Or, you can import LaTeX code. For more information, see:
* :ref:`Work with the Visual and HTML Editors`
* :ref:`Use the Announcement Template`
* :ref:`Import Content from LaTex`
* :ref:`Add a Link in an HTML Component` * :ref:`Add a Link in an HTML Component`
* :ref:`Add an Image to an HTML Component` * :ref:`Add an Image to an HTML Component`
* :ref:`Import LaTeX Code`
.. _Add a Link in an HTML Component:
***********************************
Add a Link in an HTML Component
***********************************
.. _Work with the Visual and HTML Editors: To add a link to a website, course unit, or file in an HTML component, you'll work with the **Insert/Edit Link** dialog box.
*****************************************
Work with the Visual and HTML Editors
*****************************************
The HTML Component editor has two views: the **Visual view** and the **HTML view.**
You select the view by clicking the tab in the upper-right of the component Editor. .. image:: /Images/HTML_Insert-EditLink_DBox.gif
.. image:: Images/HTMLEditorTabs.png For more information, see:
============== * :ref:`Add a Link to a Website`
Visual Editor * :ref:`Add a Link to a Course Unit`
============== * :ref:`Add a Link to a File`
The Visual view provides a “what you see is what you get” (WYSIWYG) editor for .. _Add a Link to a Website:
editing a pre-formatted version of the text.
.. image:: Images/HTMLEditor_Visual.png ============================
Add a Link to a Website
============================
Use the buttons at the top of the Visual editor to change the formatting as needed. To add a link to a website:
For example, you can enclose the title in heading tags, create bulleted or numbered lists,
or apply bold, italic, or underline formatting.
============== #. Select the text that you want to make into the link.
HTML Editor
==============
The HTML allows you to edit HTML code directly.
.. image:: Images/HTMLEditor_HTML.png #. Click the link icon in the toolbar.
.. note:: Studio processes the HTML code entered when saving it and before rendering #. In the **Insert/Edit Link** dialog box, enter the URL of the website that you want in the **Link URL** field.
it. Make sure that the text you create looks the way you expect if
you go back and forth between the Visual and HTML views.
.. _Use the Announcement Template: .. image:: Images/HTML_Insert-EditLink_Website.gif
************************************ #. If you want the link to open in a new window, click the drop-down arrow next to the **Target** field, and then select **Open Link in a New Window**. If not, you can leave the default value.
Use the Announcement Template
************************************
When you create a new HTML component, you can select to use a built-in Announcement template. #. Click **Insert**.
When creating the new HTML component, select **Announcement**. #. Save the HTML component and test the link.
.. image:: Images/HTML_Component_Type.png
:width: 600
The following screen opens.
.. image:: Images/image073.png .. _Add a Link to a Course Unit:
Edit the content of the announcement just as you would any HTML component. ============================
Add a Link to a Course Unit
============================
You can add a link to a course unit in an HTML component.
.. _Use the Anonymous User ID Template: #. Obtain the unit identifier of the unit you're linking to. To do this, open the unit page in Studio, and copy the unit ID from the **Unit Identifier** field under **Unit Location** in the right pane.
.. image:: /Images/UnitIdentifier.gif
************************************ #. Open the HTML component where you want to add the link.
Use the Anonymous User ID Template
************************************
When you create a new HTML component, you can select to use a built-in Anonymous User ID template. #. Select the text that you want to make into the link.
The Anonymous User ID template contains HTML set up for you to use a Qualtrics survey in your course. #. Click the link icon in the toolbar.
When creating the new HTML component, select **Anonymous User ID**. #. In the **Insert/Edit Link** dialog box, enter the following in the **Link URL** field.
.. image:: Images/HTML_Component_Type.png ``/jump_to_id/<unit identifier>``
:width: 600
Edit the content just as you would any HTML component. Make sure to replace <unit identifier> (including the brackets) with the unit
identifier that you copied in step 2, and make sure to include both forward slashes (/).
To use your survey, you must edit the link in the template to include your university and survey ID. .. image:: /Images/HTML_Insert-EditLink_CourseUnit.gif
You can also embed the survey in an iframe in the HTML component. #. If you want the link to open in a new window, click the drop-down arrow next to
the **Target** field, and then select **Open Link in a New Window**. If not, you can leave the default value.
For more details, read the instructions in the HTML view of the component. #. Click **Insert**.
#. Save the HTML component and test the link.
.. _Add a Link to a File:
============================
Add a Link to a File
============================
.. _Import Content from LaTeX: You can add a link in an HTML component to any file you've uploaded for the course. For more information about uploading files, see :ref:`Add Files to a Course`.
************************* #. On the **Files & Uploads** page, copy the URL of the file.
Import Content from LaTeX
*************************
If LaTeX is enabled for your course, you can create an HTML component from imported LaTeX code. .. image:: Images/HTML_Link_File.gif
Studio uses a third-party LaTeX processor to convert LaTeX code to XML. The LaTeX processor must be up and running. #. Select the text that you want to make into the link.
1. When creating the new HTML component, select **E-text Written in LaTeX**. #. Click the link icon in the toolbar.
The new HTML component opens, with an **upload** link: #. In the **Insert/Edit Link** dialog box, enter the following in the **Link URL** field.
.. image:: Images/latex_upload.png
:width: 800
2. To upload a LaTeX file from your computer, click **upload**. ``/static/FileName.type``
You are prompted to select a file. The file loads in the LaTeX editor. Make sure to include both forward slashes (/).
3. In the LaTeX editor, click **Save & Compile to edX XML**.
The LaTeX content is added to the HTML component. For example: .. image:: /Images/HTML_Insert-EditLink_File.gif
.. image:: Images/Latex_component.png
:width: 800
#. If you want the link to open in a new window, click the drop-down arrow next to
the **Target** field, and then select **Open Link in a New Window**. If not, you can leave the default value.
4. Verify that your newly created component looks the way you want it to. #. Click **Insert**.
You can edit the HTML component with LaTeX as you can any other component. #. Save the HTML component and test the link.
In the editor, you can launch the LaTeX source compiler.
.. _Add a Link in an HTML Component: .. _Add an Image to an HTML Component:
*********************************** ***********************************
Add a Link in an HTML Component Add an Image to an HTML Component
*********************************** ***********************************
You can add a link in an HTML component to any file you uploaded for the course. You can add any image that you have uploaded for the course to an HTML component. For more information about uploading images, see :ref:`Add Files to a Course`.
Find any copy the URL of the file in the Files & Uploads page. .. note:: Review :ref:`Best Practices for Describing Images` when you add images to HTML components.
See :ref:`Add Files to a Course` for more information. To add an image, you'll need the URL of the image that you uploaded to the course. You'll then create a link to the image in the HTML component.
While editing the HTML component: #. On the **Files & Uploads** page, copy the URL of the image that you want.
#. Switch to the HTML view. #. In the HTML component, switch to HTML view.
#. To create a link to a document, enter the following syntax, where URL OF FILE is the URL that you copied from the Files & Uploads Page and LINK TEXT is the text that the user will click. #. In the location where you want to add the image, enter an image tag that uses the following syntax.
``<p><a href="[URL OF FILE]">[LINK TEXT]</a></p>``
``<p><img src="[URL of file]" alt="[description]"/></p>``
For example, your image tag may resemble the following.
``<p><img src="/static/GreatLakes.gif" alt="Map of the Great Lakes" /></p>``
.. _Add a Link to a Course Unit: #. Switch back to Visual view to make sure your image appears.
============================ .. _Import LaTeX Code:
Add a Link to a Course Unit
============================
You can add a link to a course unit in an HTML component. ****************************************
Import LaTeX Code into an HTML Component
****************************************
#. Determine the unit identifier of the unit you're linking to. To do this, open the You can import LaTeX code into an HTML component. You might do this, for example, if you want to create "beautiful math" such as the following.
unit page in Studio, and locate the **Unit Identifier** field under **Unit Location** in the right pane.
#. Copy the unit identifier. .. image:: Images/HTML_LaTeX_LMS.gif
#. Open the HTML component where you want to add the link. .. warning:: The LaTeX processor that Studio uses to convert LaTeX code to XML is a third-party tool. We recommend that you use this feature with caution. If you do use it, make sure to work with your PM.
#. Select the text that you want to make into the link. This feature is not enabled by default. To enable it, you have to change the advanced settings in your course.
#. Click the link icon in the toolbar. To create an HTML component that contains LaTeX code:
#. In the Insert/Edit Link dialog box, enter the following in the Link URL field. #. Enable the policy key in your course.
Make sure to replace <unit identifier>(including the brackets) with the unit
identifier that you copied in step 2, and make sure to include both forward slashes (/).
``/jump_to_id/<unit identifier>``
#. If you want the link to open in a new window, click the drop-down arrow next to #. In Studio, click **Settings**, and then click **Advanced Settings**.
the Target field, and then select Open Link in a New Window. If not, you can leave the default value. #. On the **Advanced Settings** page, scroll down to the **use_latex_compiler** policy key.
#. In the **Policy Value** field next to the **use_latex_compiler** policy key, change **false** to **true**.
#. Click **Insert**. #. At the bottom of the page, click **Save Changes**.
#. Save the HTML component and test the link. #. In the unit where you want to create the component, click **html** under **Add New Component**, and then click **E-text Written in LaTeX**.
#. In the component that appears, click **upload** in the upper-right corner.
.. _Add an Image to an HTML Component: .. image:: Images/HTML_LaTeX.gif
*********************************** #. In the dialog box that opens, select a file, and then click **Open**.
Add an Image to an HTML Component
***********************************
You can add an any image that you have uploaded for the course to an HTML component. The file loads in the LaTeX editor.
You must upload the image before editing the HTML component.
Find and copy the URL of the image in the Files & Uploads page. .. image:: Images/HTML_LaTeXEditor.gif
See :ref:`Add Files to a Course` for more information. #. If you want to, make changes to the file.
.. note:: Review :ref:`Best Practices for Describing Images` when adding images to HTML components. #. In the LaTeX editor, click **Save & Compile to edX XML** in the lower-left corner.
While editing the HTML component: The component editor closes, and the unit page opens. You can see the way your LaTeX content looks.
#. Switch to the HTML view. .. image:: Images/HTML_LaTeX_CompEditor.gif
#. To add the image to a document, enter the following syntax, where URL OF FILE is the URL that you copied from the Files & Uploads Page. #. On the unit page, click **Preview** to verify that your content looks the way you want it to in the LMS.
``<p><img src="[URL OF FILE]"/></p>`` * If you see errors, go back to the unit page. Click **Edit** to open the component again, and then click **Launch Latex Source Compiler** in the lower-left corner of the component editor to edit the LaTeX code.
docs/course_authors/source/establish_grading_policy.rst
...@@ -155,6 +155,47 @@ Both Subsections can contain other content as well as the actual homework or lab ...@@ -155,6 +155,47 @@ Both Subsections can contain other content as well as the actual homework or lab
See :ref:`Working with Problem Components` for instructions on creating problems. See :ref:`Working with Problem Components` for instructions on creating problems.
=======================
Set the Grading Policy
=======================
You can designate a subsection as one of the assignment types that you specified in the grading policy.
You set the grading policy for the subsection from the course outline or from the subsection page.
From the course outline, click the checkmark next to the subsection. Then select a grading policy from the popup menu:
.. image:: Images/course_outline_set_grade.png
:width: 600
From the Subsection page, click the text next to the **Graded as** label, then select a grading policy from the popup menu:
.. image:: Images/subsection_set_grade.png
:width: 600
See :ref:`Establish a Grading Policy` for more information.
==================
Set the Due Date
==================
For subsections that contain graded problems, you can set a due date. Students must complete the problems in the subsection before the due date to get credit.
#. From the subsection page, click **SET A DUE DATE**. The Due Day and Due Time fields appear.
#. Place the cursor in the Due Date field, and pick a day from the popup calendar.
#. Place the cursor in the Due Time field and pick a time.
.. note:: When you set a due date, keep in mind that students will be in different time zones. By default, the time zone appears as UTC, not the student's local time. If you tell your students an assignment is due at 5:00 PM, make sure to specify that the time is 5:00 PM UTC and point them to a time converter.
Alternatively, you can :ref:`Set the Grace Period` for your assignments to cover any misunderstandings about time. For example, some classes have set a grace period of 1 day, 6 hours, and 1 minute. The grace period applies to all assignments.
For more information, see :ref:`Establish a Grading Policy`.
.. _student_view: .. _student_view:
************************** **************************
......
docs/course_authors/source/export_import_course.rst
...@@ -13,6 +13,7 @@ Export a Course ...@@ -13,6 +13,7 @@ Export a Course
*************** ***************
There are several reasons you may want to export your course: There are several reasons you may want to export your course:
* To save your work
* To edit the XML in your course directly * 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 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 copy of your course that you can later import into another course instance and customize
......
docs/course_authors/source/get_started.rst
...@@ -116,13 +116,13 @@ When you receive notice that you can create courses, log into Studio_. ...@@ -116,13 +116,13 @@ When you receive notice that you can create courses, log into Studio_.
You see the following page: You see the following page:
.. image:: Images/first_course.png .. image:: Images/first_course.png
:width: 800 :width: 600
#. Click **Create Your First Course**. #. Click **Create Your First Course**.
#. Enter course information as needed and click **Create**. #. Enter course information as needed and click **Create**.
.. image:: Images/new_course_info.png .. image:: Images/new_course_info.png
:width: 800 :width: 600
.. 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. .. 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.
...@@ -136,11 +136,11 @@ You see the following page: ...@@ -136,11 +136,11 @@ You see the following page:
3. Click **Save.** 3. Click **Save.**
You then see the empty Course Outline. Your new course opens to the **Course Outline** page. Because you haven't created any content yet, this page is empty.
In your browser’s address bar, notice that the URL of your course includes the course organization, number, and course run. In your browser’s address bar, notice that the URL of your course includes the course organization, number, and course run.
The rest of this documentation describes how you now build and run your course. But first, lets view your empty course on Edge. The rest of this documentation describes how you now build and run your course. But first, let's view your empty course on Edge.
.. _View Your Course on Edge: .. _View Your Course on Edge:
...@@ -154,7 +154,7 @@ In the Course Outline in Studio, click **View Live**. The course opens on Edge. ...@@ -154,7 +154,7 @@ In the Course Outline in Studio, click **View Live**. The course opens on Edge.
You can also go directly to Edge_. Log in if prompted. You see the course you just created listed: You can also go directly to Edge_. Log in if prompted. You see the course you just created listed:
.. image:: Images/new_course.png .. image:: Images/new_course.png
:width: 800 :width: 600
You can view the course and see that there is no content yet. You can view the course and see that there is no content yet.
...@@ -177,17 +177,18 @@ To publish courses on edX.org, you must have an agreement with edX and specific ...@@ -177,17 +177,18 @@ To publish courses on edX.org, you must have an agreement with edX and specific
.. _Register Your Course on edx.org: .. _Register Your Course on edx.org:
************************************ ************************************
Register Your Course on edX.org View Your Course on edX.org
************************************ ************************************
If you're creating your course on **edX**, you must register If your organization has an agreement with edX and you have specific approval, you can create a course on edX. To see the content of your course as students will see it, you must register for your course. You can then view it on the LMS.
for your course.
#. Create your course and add content.
#. On the **Course Outline** page, click the blue **View #. On the **Course Outline** page, click the blue **View
Live** button in the upper-right corner of your screen. Live** button in the upper-right corner of your screen.
Your course registration page opens in a new tab on the LMS. Your course registration page opens in a new tab on the LMS.
#. Click the blue **Register** button to register for your course. #. Click the blue **Register** button to register for your course. After you register for your course, it opens in the LMS.
#. In your browser, switch back to the tab that shows Studio. You will #. To continue working on your course, in your browser, switch back to the tab that shows Studio. You will
still be on the **Course Outline** page. still be on the **Course Outline** page.
docs/course_authors/source/organizing_course.rst
...@@ -13,13 +13,12 @@ How a Course is Organized ...@@ -13,13 +13,12 @@ How a Course is Organized
You organize your course in the following hierarchy: You organize your course in the following hierarchy:
- :ref:`Sections`, which contain - :ref:`Sections`, which contain
- :ref:`Subsections`, which contain - :ref:`subsections`, which contain
- :ref:`Units`, which contain - :ref:`units`, which contain
- :ref:`Components`, which contain your actual course content. - :ref:`components`, which contain your actual course content.
Studio provides you with flexibility when organizing your course. Studio provides you with flexibility when organizing your course. A common course model is for sections to correspond to weeks or chapters, and for subsections to correspond to lessons.
A common course model is for sections to correspond to weeks, and for subsections to correspond to lessons.
.. note:: We recommend that you review :ref:`Guidelines for Creating Accessible Content` before developing content for your course. .. note:: We recommend that you review :ref:`Guidelines for Creating Accessible Content` before developing content for your course.
...@@ -28,19 +27,17 @@ A common course model is for sections to correspond to weeks, and for subsection ...@@ -28,19 +27,17 @@ A common course model is for sections to correspond to weeks, and for subsection
The Course Outline The Course Outline
================== ==================
In Studio, you view your course organization through the Course Outline. In Studio, you view your course organization through the course outline.
To open the Course Outline, from the **Content** menu, select **Outline**. To open the course outline, on the **Content** menu, click **Outline**.
The following example shows a course outline with callouts to identify the different course elements: The following image shows the different elements of a course outline:
.. image:: Images/course_outline.png .. image:: Images/Course_Outline.gif
:width: 800
The following example shows how a student would view this course content: The following image shows the way this course content appears in the LMS:
.. image:: Images/course_outline_student_view.png .. image:: Images/Course_Outline_LMS.gif
:width: 800
.. _Sections: .. _Sections:
...@@ -48,18 +45,19 @@ The following example shows how a student would view this course content: ...@@ -48,18 +45,19 @@ The following example shows how a student would view this course content:
Sections Sections
******** ********
A section is the topmost category in your course. A Section can represent a time-period in your course, or another organizing principle. A section is the topmost category in your course. A section can represent a time period in your course, a chapter, or another organizing principle. A section contains one or more subsections.
To create a section: To create a section:
#. In the Course Outline, click **New Section**. #. In the course outline, click **New Section**.
#. In the field that opens at the top of the outline, enter the new Section name. #. In the field that opens at the top of the outline, enter the new section name.
#. Click **Save**. #. Click **Save**.
The new, empty section is placed at the bottom of the course outline. The new, empty section appears at the bottom of the course outline.
You must now add subsections to the section. You can now add subsections to the section.
Whether or not students see the new section depends on the release date.
Whether or not students see the new section depends on the release date.
See :ref:`Publishing Your Course` for more information. See :ref:`Publishing Your Course` for more information.
.. _Subsections: .. _Subsections:
...@@ -68,76 +66,42 @@ See :ref:`Publishing Your Course` for more information. ...@@ -68,76 +66,42 @@ See :ref:`Publishing Your Course` for more information.
Subsections Subsections
**************** ****************
Sections are divided into subsections. A subsection may represent a topic in your course, or another organizing principle. Sections are divided into subsections, 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."
You can set a subsection to an assignment type that you created when
you set up grading. You can then include assignments in the body of that
subsection. See :ref:`Establish a Grading Policy` for more information on grading.
To create a Subsection: To create a subsection:
#. At the bottom of the section, click **New Subsection**. #. On the **Course Outline** page, under the name of the section that you want, click **New Subsection**.
#. In the field that opens, enter the new Subsection name. #. In the field that opens at the bottom of the section, enter the new subsection name.
#. Click **Save**. #. Click **Save**.
The new, empty subsection is placed at the bottom of the section. The new, empty subsection appears at the bottom of the section. You can then add units to the subsection.
You must now add Units to the subsection.
Whether or not students see the new subsection depends on its release date.
See :ref:`Publishing Your Course` for more information.
================== ==================
Edit a Subsection Edit a Subsection
================== ==================
You can add and delete subsections, and select the grading policy, directly from the Course Outline.
You can also open the subsection in its own page, to perform those tasks as well as to
set the subsection release date, set a due date, preview a draft of the subsection, or view the live course.
Click on the subsection title. The subsection opens in its own 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.
.. image:: Images/subsection.png On the page for the subsection, you can see all the units in the subsection.
:width: 800
.. image:: Images/Subsection.gif
======================= You can also do the following.
Add a Graded Assignment
=======================
You can make a subsection a graded assignment. You select one of the assignment types that you specified in the grading policy. - Change the subsection name
- Add or delete a unit
- Set the subsection release date and time
- Set the subsection to be an assignment type
- Set a due date for the exercises in the subsection (if you set the assignment type of the subsection)
- Preview a draft of the subsection
- View the live version of your course
You select the assignment type for the Subsection from the Course Outline or from the Subsection page. Whether students can see a subsection depends on its release date. For more information, see :ref:`Publishing Your Course`.
From the Course Outline, click the checkmark next to the subsection. Then select the assignment type from the popup menu: For more information about setting assignment types, see :ref:`Establish a Grading Policy`.
.. image:: Images/course_outline_set_grade.png For more information about viewing drafts or the current version of your course, see :ref:`Preview Your Course` and :ref:`View Your Live Course`.
:width: 800
From the Subsection page, click the text next to the **Graded as** label, then select the assignment type from the popup menu:
.. image:: Images/subsection_set_grade.png
:width: 800
See :ref:`Establish a Grading Policy` for more information.
==================
Set the Due Date
==================
For subsections that contain graded problems, you can set a due date. Students must complete the problems in the subsection before the due date to get credit.
#. From the subsection page, click **SET A DUE DATE**. The Due Day and Due Time fields appear.
#. Place the cursor in the Due Date field, and pick a day from the popup calendar.
#. Place the cursor in the Due Time field and pick a time.
.. note:: When you set a due date, keep in mind that students will be in different time zones. By default, the time zone appears as UTC, not the student's local time. If you tell your students an assignment is due at 5:00 PM, make sure to specify that the time is 5:00 PM UTC and point them to a time converter.
Alternatively, you can :ref:`Set the Grace Period` for your assignments to cover any misunderstandings about time. For example, some classes have set a grace period of 1 day, 6 hours, and 1 minute. The grace period applies to all assignments.
For more information, see :ref:`Establish a Grading Policy`.
.. _Units: .. _Units:
...@@ -145,38 +109,33 @@ For more information, see :ref:`Establish a Grading Policy`. ...@@ -145,38 +109,33 @@ For more information, see :ref:`Establish a Grading Policy`.
Units Units
****** ******
Subsections are divided into units. A unit contains one or more components. Subsections are divided into units. A unit, in turn, contains one or more components.
For students, each unit in the subsection is represented as a link on the accordian at the top of the page. 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:
The following page shows a subsection that has nine Units:
.. image:: Images/units_students.png .. image:: Images/Units_LMS.gif
:width: 800
.. warning::
Studio does not have versioning or automatic
updating of 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 refresh your browser before you start working every time
you work with a private unit or edit a draft of a public 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.
To create a unit from the Course Outline or the subsection page: When you create a new unit, a page opens for that unit. On the unit page, you can do the following.
#. Within the subsection, click **New Unit**. - Specify the name that you want students to see. To do this, enter the name that you want in the **Display Name** field.
#. Enter the Display Name that students will see. - Create components in the unit.
#. Click a component type to add a the first component in the Unit. - Change the visibility of the unit. By default, the unit visibility is set to **Private**, so students will not be able to see the unit.Unless you want students to see the unit immediately, leave this setting as-is. For more information, see :ref:`Publishing Your Course`.
- Preview a draft of the unit.
- If a unit has been published, view the live version of the unit.
.. image:: Images/Unit_DisplayName_Studio.png After you create a new unit, you can create components in the unit.
#. Follow the instructions for the type of component, listed below. .. warning::
#. By default, the Unit visibility is **Private**, meaning students will not be able to see the Unit. Unless you want to publish the Unit to students immediately, leave this setting. See :ref:`Publishing Your Course` for more information on releasing your course.
The unit with the single component is placed at the bottom of the subsection. Studio does not have versioning and does not automatically update your browser between refreshes. Versioning is planned for future
releases, but, in the meantime, only one author should edit a unit, in one
browser, on only one tab. If a unit is open for editing in multiple browser
sessions, the session that saves last will overwrite any previously saved
content without displaying a warning. Also, older browser sessions can overwrite
more recent content, so you should refresh your browser before you start working every time
you work with a private unit or edit a draft of a public unit.
.. _Components: .. _Components:
...@@ -184,25 +143,29 @@ The unit with the single component is placed at the bottom of the subsection. ...@@ -184,25 +143,29 @@ The unit with the single component is placed at the bottom of the subsection.
Components Components
********** **********
A component is the part of a unit that contains your actual course content. A unit can 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 icon in the accordian at the top of the page. .. image:: Images/ComponentNames_CourseRibbon.gif
You add the first component when creating the unit. By default, Studio includes four types of components.
To add another component to the unit: - **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.
#. If the unit is public, change the **Visibility** setting to **Private**. You cannot modify a Public unit. To add a component to the unit, click the component type that you want under **Add New Component**.
#. In the **Add New Component** panel at the bottom of the unit, click the type of component to add.
.. image:: Images/Unit_DisplayName_Studio.png
#. Follow the instructions for the type of component:
* :ref:`Working with HTML Components` .. image:: Images/AddNewComponent.gif
* :ref:`Working with Video Components`
* :ref:`Working with Discussion Components`
* :ref:`Working with Problem Components`
For more information, see the documentation for the specific component type that you want:
- :ref:`Working with Discussion Components`
- :ref:`Working with HTML Components`
- :ref:`Working with Problem Components`
- :ref:`Working with Video Components`
.. _Reorganize Your Course: .. _Reorganize Your Course:
...@@ -210,14 +173,12 @@ To add another component to the unit: ...@@ -210,14 +173,12 @@ To add another component to the unit:
Reorganize Your Course Reorganize Your Course
********************** **********************
You can reorganize your course by dragging and dropping elements in the Course Outline. You can reorganize your course by dragging and dropping sections, subsections, units, and components. You can move elements on the **Course Outline** page or on an individual unit page.
To move a section, subsection, or unit, click the mouse on the element's handle on the right side of the outline, then move the element to the new location. To move 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.
Element handles are highlighed in the following image:
.. image:: Images/drag_drop.png .. image:: Images/DragAndDrop.gif
:width: 800
When you move a course element, a blue line indicates the new position. You can move a subsection to a new section, and a unit to a new subsection. When you move an element, a blue line indicates where the element will land when you release the mouse.
You can reorganize components within a unit in the same way. .. image:: Images/DragAndDrop_BlueLine.gif
\ No newline at end of file \ No newline at end of file
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment