Skip to content

E
edx-platform
Commit 8100e38f by Mark Hoeber
Options

edX Course Authors Doc Reorganization

parent 16523b99
Showing with 427 additions and 328 deletions
docs/en_us/course_authors/source/appendices/a.rst → docs/en_us/course_authors/source/building_course/course_overview_template.rst
.. raw:: latex
\newpage %
.. _Appendix A:
.. _A Template For Course Overview:
========================================
APPENDIX A-Template For Course Overview
A Template For Your Course Overview
========================================
......
docs/en_us/course_authors/source/create_new_course.rst → docs/en_us/course_authors/source/building_course/create_new_course.rst
......@@ -41,7 +41,7 @@ Create a New Course
#. Click **New Course**.
#. Enter course information as needed and click **Create**.
.. image:: Images/new_course_info.png
.. 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.
......@@ -73,7 +73,7 @@ When you create a new course, the course opens in Studio automatically and you c
If you come back to Studio later, your courses are listed on the Studio login page.
.. image:: Images/open_course.png
.. image:: ../Images/open_course.png
:width: 800
To open the course, click the course name.
......@@ -99,7 +99,7 @@ Categories of tasks in the Course Checklist include:
From the **Tools** menu, select **Checklists**.
.. image:: Images/checklist.png
.. image:: ../Images/checklist.png
:width: 800
......@@ -142,7 +142,7 @@ You must set dates and times for enrollment and for the course.
From the **Settings** menu, select **Schedule and Details**.
.. image:: Images/schedule.png
.. image:: ../Images/schedule.png
:alt: An image of the course schedule page.
Follow the on-screen text to enter the course and enrollment schedule.
......@@ -166,19 +166,19 @@ Students see the course start date on their dashboards and on the course summary
The following example shows the course start date on the course summary page:
.. image:: Images/about-page-course-start.png
.. 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
.. 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
.. image:: ../Images/dashboard-course.png
:alt: An image of a course listing in the student dashboard, with the start date circled.
......@@ -197,19 +197,19 @@ To set an advertised start date:
#. 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
.. 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
.. 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
.. image:: ../Images/dashboard-course_not_started.png
:alt: Image of a course listing in the student dashboard, with no start date.
......@@ -225,15 +225,16 @@ When your course is completed, students see the course end date on their dashboa
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
.. 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
.. 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:
************************
Describe Your Course
......@@ -243,7 +244,7 @@ On Edge_, students that you explicitly invite see the description of your course
For example, the course description is circled in the following course summary page:
.. image:: Images/about-page-course-description.png
.. 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.
......@@ -251,16 +252,16 @@ For example, the course description is circled in the following course summary p
#. 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
.. 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 :doc:`appendices/a`.
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:
************************
Add a Course Image
......@@ -272,7 +273,7 @@ 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
.. 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.
......@@ -284,7 +285,7 @@ The course image should be a minimum of 660 pixels in width by 240 pixels in hei
#. 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 Video:
*********************************
Add a Course Introduction Video
......@@ -296,7 +297,7 @@ On Edge_, the course introduction video appears on the course summary page that
In the following example, the course video is circled in the course summary page:
.. image:: Images/about-page-course-video.png
.. 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.
......@@ -317,7 +318,7 @@ 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
.. image:: ../Images/image127.png
:width: 800
2. From the **Settings** menu, select **Schedule & Details**.
......@@ -325,7 +326,7 @@ To add a course introduction video:
#. 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:
************************
Set Course Requirements
......@@ -337,7 +338,7 @@ The estimated Effort per Week appears on the Course Summary page that students s
#. 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:
**********************
Add Files to a Course
......@@ -369,7 +370,7 @@ File URLs
In the Files & Uploads page, each file has has an **Embed URL** and an **External URL**:
.. image:: Images/files_uploads_urls.png
.. 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.
......@@ -393,7 +394,7 @@ For either the the **Date Added** or **Name** column, you can switch the sort or
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
.. image:: ../Images/file_sort.png
:alt: Sorting files in the Files & Uploads page
......@@ -412,7 +413,7 @@ You can navigate through the pages listing files in two ways:
* At the bottom of the page, enter the page number to skip to, then tab out of the field:
.. image:: Images/file_pagination.png
.. image:: ../Images/file_pagination.png
:alt: Pagination in the Files & Uploads page
......@@ -433,7 +434,7 @@ To delete a file, click the **x** icon next to the file. You are prompted to co
.. 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 Static Pages`:
.. _Add Static Pages:
****************
Add Static Pages
......@@ -443,7 +444,7 @@ You can add static pages to your course. Each static page appears in your course
For example, the following navigation bar includes a
**Syllabus** and **Projects** static pages.
.. image:: Images/image157.png
.. image:: ../Images/image157.png
You can use static pages for a syllabus, grading policy, course handouts, or any other purpose.
......@@ -456,7 +457,7 @@ To create a static page:
#. From the **Content** menu, select **Static Pages**.
#. Click **New Page**. The following screen opens:
.. image:: Images/image161.png
.. image:: ../Images/image161.png
:width: 800
3. Click **Edit**.
......@@ -477,7 +478,7 @@ You can embed a Google calendar. Paste the embed code for the calendar in the st
You can also create a dynamic HTML calendar. See :ref:`Appendix B`.
.. _`Add a Course Update`:
.. _Add a Course Update:
**********************
Add a Course Update
......@@ -487,7 +488,7 @@ You add updates to notify students of exams, changes in the course schedule, or
Students see course updates in **Course Info** tab when they log in to the course:
.. image:: Images/course_info.png
.. image:: ../Images/course_info.png
:width: 800
To add a course update:
......@@ -496,11 +497,11 @@ To add a course update:
#. Click **New Update**.
#. Enter your update in the HTML editor that opens.
.. note:: You must enter the update in HTML. See :ref:`Appendix A`.
.. note:: You must enter the update in HTML. See :ref:`A Template For Course Overview`.
4. Click **Save**.
.. _`Add Course Handouts`:
.. _Add Course Handouts:
**********************
Add Course Handouts
......@@ -514,7 +515,7 @@ You can add course handouts that are visible to students on the **Course Info**
#. 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:
****************
Add Textbooks
......@@ -529,7 +530,7 @@ It's recommended that you upload a separate PDF file for each chapter of your te
When students open the textbook tab in the course, they can navigate the textbook by chapter:
.. image:: Images/textbook_chapters.png
.. image:: ../Images/textbook_chapters.png
:width: 800
To add a textbook:
......@@ -537,7 +538,7 @@ To add a textbook:
#. From the **Content** menu, select **Textbooks**.
#. Click **New Textbook**. The following screen opens:
.. image:: Images/textbook_new.png
.. image:: ../Images/textbook_new.png
:width: 800
3. Enter the **Textbook Name**.
......
docs/en_us/course_authors/source/appendices/b.rst → docs/en_us/course_authors/source/building_course/dynamic_html_schedule.rst
.. raw:: latex
\newpage %
.. _Appendix B:
===========================================
APPENDIX B: Code for Dynamic HTML Schedule
Code for Dynamic HTML Schedule
===========================================
::
.. code-block:: html
<div class= "syllabus">
......
docs/en_us/course_authors/source/establish_grading_policy.rst → docs/en_us/course_authors/source/building_course/establish_grading_policy.rst
......@@ -29,7 +29,7 @@ To set the grade range, from the **Settings** menu, select **Grading**.
The control for the grade range is at the top of the Grading page.
.. image:: Images/grade_range.png
.. image:: ../Images/grade_range.png
:width: 800
:alt: Image of the Grade Range control
......@@ -42,7 +42,7 @@ You use the grade range control to change these settings:
A new grade is added to the range between the existing grades. For example, if you add a grade in the default setting,
the grade range changes to **F** (0 to 50), **B** (50 to 75), and **A** (75 to 100):
.. image:: Images/grade_range_b.png
.. image:: ../Images/grade_range_b.png
:width: 800
:alt: Image of an altered Grade Range control
......@@ -176,13 +176,13 @@ You set the grading policy for the subsection from two places:
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
.. image:: ../Images/course_outline_set_grade.png
:width: 600
:alt: Image of the assignment type for a subsection
From the subsection page, click the text next to the **Graded as** label, then select a grading policy from the popup menu:
.. image:: Images/subsection_set_grade.png
.. image:: ../Images/subsection_set_grade.png
:width: 600
:alt: Image of the assignment type on the subsection page
......@@ -205,7 +205,7 @@ You can also :ref:`Set the Grace Period` for your assignments to cover any misun
Students see the due date in the course accordian under the subsection title. For example:
.. image:: Images/Subsection_due_date.png
.. image:: ../Images/Subsection_due_date.png
:alt: Image of subsection due dates in the course accordian
There are several problems in this subsection, all due November 3, 2013 at 23:30 UTC.
......@@ -220,7 +220,7 @@ The Student View of Grades
**************************
Once a grading policy is in place, students can view both their problem scores and the percent completed and current grade in the **Progress** tab for the course.
.. image:: Images/Progress_tab.png
.. image:: ../Images/Progress_tab.png
:width: 800
:alt: Image of the student Progress tab
......
docs/en_us/course_authors/source/building_course/index.rst 0 → 100644
.. _Building a Course Index:
##########################
Building a Course
##########################
.. toctree::
:maxdepth: 2
create_new_course
establish_grading_policy
organizing_course
export_import_course
course_overview_template
dynamic_html_schedule
docs/en_us/course_authors/source/organizing_course.rst → docs/en_us/course_authors/source/building_course/organizing_course.rst
......@@ -33,12 +33,12 @@ 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.gif
.. image:: ../Images/Course_Outline.png
:alt: Image of the course outline, with callouts for sections, subsection, and units
The following image shows the way this course content appears in the LMS:
.. image:: Images/Course_Outline_LMS.gif
.. image:: ../Images/Course_Outline_LMS.png
:alt: Image of sections from the student's point of view
.. _Sections:
......@@ -87,7 +87,7 @@ You add and delete subsections from the **Course Outline** page. You edit a subs
On the page for the subsection, you can see all the units in the subsection.
.. image:: Images/Subsection.gif
.. image:: ../Images/subsection.png
:alt: Image of the subsection page
You can also do the following.
......@@ -116,7 +116,7 @@ Subsections are divided into units. A unit, in turn, contains one or more compon
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.gif
.. 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.
......@@ -153,7 +153,7 @@ A component is the part of a unit that contains your actual course content. A un
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.gif
.. image:: ../Images/ComponentNames_CourseRibbon.png
:alt: Image of the component list for a unit
By default, Studio includes four types of components.
......@@ -165,7 +165,7 @@ By default, Studio includes four types of components.
To add a component to the unit, click the component type that you want under **Add New Component**.
.. image:: Images/AddNewComponent.gif
.. 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:
......@@ -183,7 +183,7 @@ You can edit a component only if the unit that contains it is Private, or if you
When you can edit the component, the Edit icon and the Display Name appear in the component header:
.. image:: Images/unit-edit.png
.. 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.
......@@ -200,7 +200,7 @@ To set the display name for a component:
#. Click **Settings**.
#. Edit the **Display Name** field.
.. image:: Images/display-name.png
.. image:: ../Images/display-name.png
:alt: Image of the Display Name field for a component.
4. Click **Save**.
......@@ -217,7 +217,7 @@ When you duplicate a component, a new copy of that component is added directly b
When you can duplicate the component, the Duplicate icon appears in the component header:
.. image:: Images/unit-dup.png
.. image:: ../Images/unit-dup.png
:alt: Image of a unit with Duplicate icon circled
......@@ -233,7 +233,7 @@ You can delete a component only if the unit that contains it is Private, or if y
When you can delete the component, the Delete icon appears in the component header:
.. image:: Images/unit-delete.png
.. 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.
......@@ -248,10 +248,10 @@ You can reorganize your course by dragging and dropping sections, subsections, u
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.gif
.. image:: ../Images/DragAndDropExample.png
:alt: Image of the course outline, with the handle for a unit selected for drag and drop
When you move an element, a blue line indicates where the element will land when you release the mouse.
.. image:: Images/DragAndDrop_BlueLine.gif
.. image:: ../Images/DragAndDrop_BlueLine.png
:alt: Image of the course outline, with a unit being dragged to a different location
\ No newline at end of file
docs/en_us/course_authors/source/change_log.rst
......@@ -10,8 +10,36 @@ Change Log
* - Date
- Change
* - 03/17/14
- Reorganized this document into major sections:
* :ref:`Getting Started Index`
* :ref:`Building a Course Index`
* :ref:`Creating Course Content Index`
* :ref:`Working with Problems Index`
* :ref:`Releasing Your Course Index`
* :ref:`Running Your Course Index`
* :ref:`Information for Your Students Index`
* - 03/10/14
- Added information about setting up your course summary page to :ref:`The Course Start Date`, :ref:`The Course End Date`, :ref:`Add a Course Image`, :ref:`Add a Course Video`, and :ref:`Describe Your Course`.
- Added information about setting up your course summary page to
* :ref:`The Course Start Date`
* :ref:`The Course End Date`
* :ref:`Add a Course Image`
* :ref:`Add a Course Video`
* :ref:`Describe Your Course`
* - 02/25/14
- Updated :ref:`Add Files to a Course` section to include new External URL feature.
* -
......
docs/en_us/course_authors/source/conf.py
......@@ -37,7 +37,7 @@ master_doc = 'index'
# General information about the project.
project = u'Building a Course with edX Studio'
project = u'Building and Running an edX Course'
copyright = u'2014, edX'
# The short X.Y version.
......
docs/en_us/course_authors/source/create_discussion.rst → docs/en_us/course_authors/source/creating_content/create_discussion.rst
......@@ -37,12 +37,12 @@ For more information on Public and Private Units, see :ref:`Public and Private U
#. Under **Add New Component**, click the **discussion** icon.
.. image:: Images/NewComponent_Discussion.png
.. image:: ../Images/NewComponent_Discussion.png
:alt: Image of the adding a new discussion component
The Discussion component is added:
.. image:: Images/EditDiscussionComponent.png
.. image:: ../Images/EditDiscussionComponent.png
:alt: Image of the discussion component with the Edit button circled
......@@ -50,7 +50,7 @@ For more information on Public and Private Units, see :ref:`Public and Private U
The Discussion component editor opens.
.. image:: Images/DiscussionComponentEditor.png
.. image:: ../Images/DiscussionComponentEditor.png
:alt: Image of the discussion component editor
#. Follow the guidelines in the editor to fill in the **Category**, **Display Name**, and **Subcategory**.
......@@ -65,7 +65,7 @@ A Student's View of the Discussion
For students, Discussion component names appear in the course ribbon at the top of the page:
.. image:: Images/DiscussionComponent_LMS_Ribbon.png
.. image:: ../Images/DiscussionComponent_LMS_Ribbon.png
:alt: Image of a unit from a student's point of view with the component list showing a discussion component
The Discussion space appears under other components in the unit.
......@@ -75,13 +75,13 @@ and a blue **New Post** button on the right.
In the following example, the Discussion component follows Video and HTML components:
.. image:: Images/DiscussionComponent_LMS.png
.. image:: ../Images/DiscussionComponent_LMS.png
:alt: Image of a video component followed by a discussion component
In the **Discussion** tab at the top of the page,
students can find the category and subcategory of the discussion in the left pane.
.. image:: Images/DiscussionComponent_Forum.png
.. image:: ../Images/DiscussionComponent_Forum.png
:alt: Image of the discussion page from a student's point of view
docs/en_us/course_authors/source/create_html_component.rst → docs/en_us/course_authors/source/creating_content/create_html_component.rst
......@@ -31,14 +31,14 @@ 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
.. image:: ../Images/HTMLEditorTabs.png
:alt: Image of the HTML component editor, with the Visual and HTML tabs circled
- **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
.. image:: ../Images/HTML_VisualView_Toolbar.png
:alt: Image of the HTML visual editor, with callouts for formatting buttons
#. Select a formatting style, such as heading 1, heading 2, or paragraph.
......@@ -56,12 +56,12 @@ When you create a new HTML component, you work with the HTML component editor. T
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
.. image:: ../Images/HTMLComponent_VisualView_LMS.png
:alt: Image of the visual view of the HTML component
- **HTML view** allows you to edit HTML code directly.
.. image:: Images/HTML_HTMLView.gif
.. image:: ../Images/HTML_HTMLView.png
:alt: Image of the HTML code view of the HTML component
.. 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.
......@@ -76,7 +76,7 @@ To create an HTML component:
1. Under **Add New Component**, click **html**.
.. image:: Images/NewComponent_HTML.gif
.. image:: ../Images/NewComponent_HTML.png
:alt: Image of adding a new HTML component
2. In the list that appears, click **Text**.
......@@ -85,14 +85,14 @@ To create an HTML component:
An empty component appears at the bottom of the unit.
.. image:: Images/HTMLComponent_Edit.png
.. image:: ../Images/HTMLComponent_Edit.png
:alt: Image of an empty HTML component
3. In the empty component, click **Edit**.
The HTML component editor opens in Visual view.
.. image:: Images/HTMLEditor.gif
.. image:: ../Images/HTMLEditor.png
:alt: Image of the HTML component Visual view
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.
......@@ -117,7 +117,7 @@ Add a Link in an HTML Component
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.
.. image:: /Images/HTML_Insert-EditLink_DBox.gif
.. image:: ../Images/HTML_Insert-EditLink_DBox.png
:alt: Image of the Insert/Edit Link dialog box
For more information, see:
......@@ -140,7 +140,7 @@ To add a link to a website:
#. In the **Insert/Edit Link** dialog box, enter the URL of the website that you want in the **Link URL** field.
.. image:: Images/HTML_Insert-EditLink_Website.gif
.. image:: ../Images/HTML_Insert-EditLink_Website.png
:alt: Image of the Insert/Edit Link dialog box
#. 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.
......@@ -160,7 +160,7 @@ You can add a link to a course unit in an HTML component.
#. 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.png
.. image:: ../Images/UnitIdentifier.png
:alt: Image of the unit page with the unit identifier circled
#. Open the HTML component where you want to add the link.
......@@ -176,7 +176,7 @@ You can add a link to a course unit in an 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 (/).
.. image:: /Images/HTML_Insert-EditLink_CourseUnit.gif
.. image:: ../Images/HTML_Insert-EditLink_CourseUnit.png
:alt: Image of the Inser/Edit Link dialog box with a link to a unit identifier
#. If you want the link to open in a new window, click the drop-down arrow next to
......@@ -196,12 +196,14 @@ You can add a link in an HTML component to any file you've uploaded for the cour
#. On the **Files & Uploads** page, copy the **Embed URL** of the file.
.. image:: Images/HTML_Link_File.png
.. image:: ../Images/HTML_Link_File.png
:alt: Image of Files and Uploads page with the URL field circled
.. note:: You must use the **Embed URL** to link to the file, not the **External URL**.
2. Select the text that you want to make into the link.
#. Click the link icon in the toolbar.
......@@ -212,8 +214,8 @@ You can add a link in an HTML component to any file you've uploaded for the cour
Make sure to include both forward slashes (/).
.. image:: /Images/HTML_Insert-EditLink_File.gif
:alt: Image of the Insert/Edit Link dialog box with a link to a file
.. image:: ../Images/HTML_Insert-EditLink_File.png
:alt: Image of the Inser/Edit Link dialog box with a link to a file
#. 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.
......@@ -239,7 +241,7 @@ To add an image, you'll need the URL of the image that you uploaded to the cours
#. On the **Files & Uploads** page, copy the **Embed URL** of the image that you want.
.. image:: Images/image_link.png
.. image:: ../Images/image_link.png
:alt: Image of the Files & Upload page with the Embed URL for the image circled
.. note:: You must use the **Embed URL** to add the image, not the **External URL**.
......@@ -252,7 +254,7 @@ To add an image, you'll need the URL of the image that you uploaded to the cours
Make sure to include both forward slashes (/).
.. image:: /Images/HTML_Insert-Edit_Image.png
.. image:: ../Images/HTML_Insert-Edit_Image.png
:alt: Image of the Insert/Edit Image dialog box with a link to a file
4. Enter alternative text in the Image Description field. See :ref:`Best Practices for Describing Images` for more information.
......@@ -265,6 +267,8 @@ To add an image, you'll need the URL of the image that you uploaded to the cours
.. note:: When you add the image URL in the format ``/static/FileName.type``, then later reopen the **Insert/Edit Image** dialog box, you see that the URL changes to ``/c4x/edX/Course-name/asset/FileName.type``. This URL is OK and you do not need to change it. In the HTML view, the URL appears as ``/static/FileName.type``.
``<p><img src="/static/GreatLakes.png" alt="Map of the Great Lakes" /></p>``
.. _Import LaTeX Code:
......@@ -275,7 +279,7 @@ Import LaTeX Code into an HTML Component
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.
.. image:: Images/HTML_LaTeX_LMS.gif
.. image:: ../Images/HTML_LaTeX_LMS.png
:alt: Image of math formulas created with LaTeX
.. 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.
......@@ -295,12 +299,12 @@ To create an HTML component that contains LaTeX code:
#. Click **Edit** to open the new component. The component editor opens.
.. image:: Images/latex_component.png
.. image:: ../Images/latex_component.png
:alt: Image of the HTML component editor with the Latex compiler.
4. In the componenent editor, click **Launch Latex Source Compiler**. The Latex editor opens.
.. image:: Images/HTML_LaTeXEditor.gif
.. image:: ../Images/HTML_LaTeXEditor.png
:alt: Image of the HTML component editor with the Latex compiler.
#. Write Latex code as needed. You can also upload a Latex file into the editor from your computer by clicking **Upload** in the bottom right corner.
......@@ -309,7 +313,7 @@ To create an HTML component that contains LaTeX code:
The component editor closes, and the unit page opens. You can see the way your LaTeX content looks.
.. image:: Images/HTML_LaTeX_CompEditor.png
.. image:: ../Images/HTML_LaTeX_CompEditor.png
:alt: Image of the LaTeX component
#. On the unit page, click **Preview** to verify that your content looks the way you want it to in the LMS.
......
docs/en_us/course_authors/source/create_video.rst → docs/en_us/course_authors/source/creating_content/create_video.rst
......@@ -95,7 +95,7 @@ In addition to your .srt file, you can provide other transcripts with your video
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
.. 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.
......@@ -141,7 +141,7 @@ Step 4. Create a Video Component
#. When the new video component appears, click **Edit**. The video editor opens to the **Basic** tab.
.. image:: Images/VideoComponentEditor.gif
.. image:: ../Images/VideoComponentEditor.png
:alt: Image of the video component editor
You'll replace the default values with your own.
......@@ -251,7 +251,7 @@ You can provide transcripts for your video in other languages. To do this, you'l
#. 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
.. 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.
......
docs/en_us/course_authors/source/creating_content/index.rst 0 → 100644
.. _Creating Course Content Index:
##########################
Creating Course Content
##########################
.. toctree::
:maxdepth: 2
accessibility
create_html_component
create_video
create_discussion
docs/en_us/course_authors/source/accounts.rst → docs/en_us/course_authors/source/getting_started/accounts.rst
......@@ -49,13 +49,13 @@ To get started, you register your account on edX.org_ and Edge_.
* For edX.org, go to the `registration page <https://courses.edx.org/register>`_:
.. image:: Images/edx_registration.png
.. image:: ../Images/edx_registration.png
:alt: Image of the edX.org registration page
* For Edge, go to https://edge.edx.org and click **Register**:
.. image:: Images/edge_register.png
.. image:: ../Images/edge_register.png
:alt: Image of the Edge registration page
Make sure to check both **I agree to the Terms of Service** and **I agree to the Honor Code**.
......@@ -83,7 +83,7 @@ To get started, you register your account on edX.org_ and Edge_.
3. Click the link in the e-mail to complete the activation. When you see the following page, your account has been activated:
.. image:: Images/activation_screen.png
.. image:: ../Images/activation_screen.png
:alt: Image of the Activation page
......@@ -116,12 +116,12 @@ The process to reset your password on edX.org and Edge is the same.
#. In the account information pane in the upper left corner, click **Reset Password**.
.. image:: Images/dashboard-password-reset.png
.. image:: ../Images/dashboard-password-reset.png
:alt: Image with the Reset Password link highlighted
A dialog box opens confirming that a message has been sent to your email address.
.. image:: Images/password-email-dialog.png
.. image:: ../Images/password-email-dialog.png
:alt: Image with the Reset Password link highlighted
3. When you receive the following e-mail message, click the link in the message::
......@@ -142,7 +142,7 @@ The process to reset your password on edX.org and Edge is the same.
4. When the following dialog box opens, enter your new password in both fields, and then click **Change My Password**:
.. image:: Images/reset_password.png
.. image:: ../Images/reset_password.png
:alt: Image of the Reset Password dialog box
.. note:: Your password can be any string.
......
docs/en_us/course_authors/source/get_started.rst → docs/en_us/course_authors/source/getting_started/get_started.rst
......@@ -39,7 +39,7 @@ You use Studio directly through your browser. You do not need any additional sof
Use Studio on Edge
******************
You can use Studio_ on Edge_ to build your own courses.
You can use Studio_ on Edge to build your own courses.
Go to: https://studio.edge.edx.org. Sign in with the account you created on Edge.
......@@ -52,6 +52,7 @@ You must then request access to create courses:
EdX then evaluates your request. When course creation permissions are granted, you receive an email message.
.. _Studio: https://studio.edge.edx.org
.. _Edge: http://edge.edx.org
.. _Create Your First Course:
......@@ -63,14 +64,14 @@ When you receive notice that you can create courses, log in to Studio_.
You see the following page:
.. image:: Images/first_course.png
.. image:: ../Images/first_course.png
:width: 600
:alt: Image of the Studio home page where you create your first course
#. Click **Create Your First Course**.
#. Enter course information as needed and click **Create**.
.. image:: Images/new_course_info.png
.. image:: ../Images/new_course_info.png
:width: 600
:alt: Image of the Create New Course page
......@@ -103,7 +104,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:
.. image:: Images/new_course.png
.. image:: ../Images/new_course.png
:width: 600
:alt: Image of the Edge Dashboard
......
docs/en_us/course_authors/source/glossary.rst → docs/en_us/course_authors/source/getting_started/glossary.rst
......@@ -135,7 +135,7 @@ C
**Custom Response Problem**
A custom response problem evaluates text responses from students using an embedded Python script. These problems are also called "write-your-own-grader" problems. For more information, see :ref:`Custom Response` and :ref:`Write-Your-Own-Grader`.
A custom response problem evaluates text responses from students using an embedded Python script. These problems are also called "write-your-own-grader" problems. For more information, see :ref:`Custom Python Evaluated Input` Custom Python-evaluated input (also called "write-your-own-grader" problems evaluate students'.
.. _D:
......
docs/en_us/course_authors/source/getting_started/index.rst 0 → 100644
.. _Getting Started Index:
################
Getting Started
################
.. toctree::
:maxdepth: 3
accounts
get_started
glossary
docs/en_us/course_authors/source/index.rst
......@@ -4,56 +4,19 @@
contain the root `toctree` directive.
Contents
========
Building and Running an edX Course
========================================
.. toctree::
:numbered:
:maxdepth: 5
:maxdepth: 2
read_me
change_log
accounts
get_started
create_new_course
establish_grading_policy
organizing_course
create_html_component
create_video
create_discussion
create_problem_component
common_problems
advanced_problems
specialized_problems
external_graders
open_response_assessment
google_hangouts
tools
additional_tools
set_content_releasedates
view_course_content
export_import_course
accessibility
checking_student_progress
ora_students
discussions
discussion_guidance_moderators
course_data
course_enrollment
course_staffing
beta_testing
course_student
course_grades
staff_debug_info
glossary
Appendices
==========
.. toctree::
:maxdepth: 3
:glob:
appendices/*
getting_started/index
building_course/index
creating_content/index
problems_tools/index
releasing_course/index
running_course/index
students/index
\ No newline at end of file
docs/en_us/course_authors/source/additional_tools.rst → docs/en_us/course_authors/source/problems_tools/additional_tools.rst
......@@ -31,7 +31,7 @@ Chemical Equation Problem
The chemical equation problem type allows the student to enter text that represents a chemical equation into a text box. The LMS converts that text into a chemical equation below the text box. The grader evaluates the student's response by using a Python script that you create and embed in the problem.
.. image:: /Images/ChemicalEquationExample.png
.. image:: ../Images/ChemicalEquationExample.png
:alt: Image of a chemical equation response problem
====================================
......@@ -191,7 +191,7 @@ Specifically, the Gene Explorer does the following:
#. Finds the start codon
#. Translates the mRNA
.. image:: /Images/GeneExplorer.png
.. image:: ../Images/GeneExplorer.png
:alt: Image of the Gene Explorer
For more information about the Gene Explorer, see `The Gene Explorer <http://intro.bio.umb.edu/GX/>`_.
......@@ -233,7 +233,7 @@ Interactive Periodic Table
You can create an interactive periodic table of the elements to help your students learn about various elements' properties. In the table below, detailed information about each element appears as the student moves the mouse over the element.
.. image:: /Images/Periodic_Table.gif
.. image:: ../Images/Periodic_Table.png
:alt: Image of the interactive periodic table
.. _Create the Periodic Table:
......@@ -271,7 +271,7 @@ Students can use the molecule editor to learn how to create molecules. The molec
The molecule editor incorporates two tools: the JSME molecule editor created by Peter Erl and Bruno Bienfait, and JSmol, a JavaScript-based molecular viewer from Jmol. (You don't need to download either of these tools--Studio uses them automatically.) For more information about the JSME molecule editor, see `JSME Molecule Editor <http://peter-ertl.com/jsme/index.html>`_. For more information about JSmol, see `JSmol <http://sourceforge.net/projects/jsmol/>`_.
.. image:: /Images/Molecule_Editor.gif
.. image:: ../Images/Molecule_Editor.png
:alt: Image of the molecule editor
.. _Create the Molecule Editor:
......@@ -433,7 +433,7 @@ Multiple Choice and Numerical Input Problem
You can create a problem that combines a multiple choice and numerical input problems. Students not only select a response from options that you provide, but also provide more specific information, if necessary.
.. image:: /Images/MultipleChoice_NumericalInput.gif
.. image:: ../Images/MultipleChoice_NumericalInput.png
:alt: Image of a multiple choice and numerical input problem
.. note:: Currently, students can only enter numerals in the text field. Students cannot enter words or mathematical expressions.
......@@ -479,7 +479,7 @@ Polls
You can run polls in your course so that your students can share opinions on different questions.
.. image:: /Images/PollExample.png
.. image:: ../Images/PollExample.png
.. note:: Creating a poll requires you to export your course, edit some of your course's XML files in a text editor, and then re-import your course. We recommend that you create a backup copy of your course before you create the poll. We also recommend that you only edit the files that will contain polls in the text editor if you're very familiar with editing XML.
......@@ -649,7 +649,7 @@ Protex Protein Builder
The Protex protein builder asks students to create specified protein shapes by stringing together amino acids. In the example below, the goal protein shape is a simple line.
.. image:: /Images/ProteinBuilder.gif
.. image:: ../Images/ProteinBuilder.png
:alt: Image of the protein builder
.. _Create the Protein Builder:
......
docs/en_us/course_authors/source/advanced_problems.rst → docs/en_us/course_authors/source/problems_tools/advanced_problems.rst
......@@ -43,7 +43,7 @@ elements such as voltage sources, capacitors, resistors, and MOSFETs on
an interactive grid. They then submit a DC, AC, or transient analysis of
their circuit to the system for grading.
.. image:: /Images/CircuitSchematicExample.gif
.. image:: ../Images/CircuitSchematicExample.png
:alt: Image of a circuit schematic builder
Create a Circuit Schematic Builder Problem
......@@ -131,7 +131,7 @@ The JS Input problem that you create must use HTML, JavaScript, and cascading st
(CSS). You can use any application creation tool, such as the Google Web Toolkit (GWT), to
create your JS Input problem.
.. image:: /Images/JavaScriptInputExample.gif
.. image:: ../Images/JavaScriptInputExample.png
:alt: Image of a JavaScript Input problem
Create a Custom JavaScript Display and Grading Problem
......@@ -247,7 +247,7 @@ Custom Python-Evaluated Input ("Write-Your-Own-Grader")
In custom Python-evaluated input (also called "write-your-own-grader problems" problems), the grader uses a Python script that you create and embed in the problem to evaluates a student's response or provide hints. These problems can be any type. Numerical input and text input problems are the most popular write-your-own-grader problems.
.. image:: Images/CustomPythonExample.png
.. image:: ../Images/CustomPythonExample.png
:alt: Image of a write your own grader problem
Custom Python-evaluated input problems can include the following:
......@@ -536,7 +536,7 @@ Drag and Drop
In drag and drop problems, students respond to a question by dragging
text or objects to a specific location on an image.
.. image:: Images/DragAndDropProblem.png
.. image:: ../Images/DragAndDropProblem.png
:alt: Image of a drag and drop problem
Create a Drag and Drop Problem
......@@ -596,7 +596,7 @@ In an image mapped input problem, students click inside a defined area
in an image. You define this area by including coordinates in the body
of the problem.
.. image:: Images/image294.png
.. image:: ../Images/ImageMappedInputExample.png
:alt: Image of an image mapped input problem
Create an Image Mapped Input Problem
......@@ -634,7 +634,8 @@ Math Expression Input
In math expression input problems, students enter text that represents a mathematical expression into a field, and the LMS changes that text to a symbolic expression that appears below that field.
.. image:: Images/MathExpressionInputExample.gif
.. image:: ../Images/MathExpressionInputExample.png
:alt: Image of math expression input problem
Unlike numerical input problems, which only allow integers and a few select constants, math expression problems can include unknown variables and more complicated symbolic expressions. The grader uses a numerical sampling to determine whether the student's response matches the instructor-provided math expression, to a specified numerical tolerance. The instructor must specify the allowed variables in the expression as well as the range of values for each variable.
......@@ -748,7 +749,7 @@ gives the student feedback or a hint based on that response so that the
student is more likely to answer correctly on the next attempt. These
problems can be text input or multiple choice problems.
.. image:: Images/ProblemWithAdaptiveHintExample.gif
.. image:: ../Images/ProblemWithAdaptiveHintExample.png
:alt: Image of a problem with an adaptive hint
Create a Problem with an Adaptive Hint
......@@ -781,7 +782,7 @@ adjustments.
information about how to create mathematical expressions in Studio using
MathJax, see *A Brief Introduction to MathJax in Studio*.
.. image:: Images/ProblemWrittenInLaTeX.gif
.. image:: ../Images/ProblemWrittenInLaTeX.png
:alt: Image of a problem written in LaTeX
Create a Problem Written in LaTeX
......
docs/en_us/course_authors/source/common_problems.rst → docs/en_us/course_authors/source/problems_tools/common_problems.rst
......@@ -38,7 +38,7 @@ list of possible answers. The student must select all the options that
apply to answer the problem correctly. Each checkbox problem must have
at least one correct answer.
.. image:: Images/CheckboxExample.gif
.. image:: ../Images/CheckboxExample.png
:alt: Image of a checkbox problem
==========================
......@@ -58,7 +58,7 @@ Simple Editor
#. Determine the text of the problem to use as a label, and then surround that text with two sets of angle brackets (>><<).
#. Select all the answer options, and then click the checkbox button.
.. image:: Images/ProbComponent_CheckboxIcon.gif
.. image:: ../Images/ProbComponent_CheckboxIcon.png
:alt: Image of the checkbox button
When you do this, brackets appear next to each answer choice.
......@@ -67,7 +67,7 @@ Simple Editor
#. In the component editor, select the text of the explanation, and then click the
explanation button to add explanation tags around the text.
.. image:: Images/ProbCompButton_Explanation.gif
.. image:: ../Images/ProbCompButton_Explanation.png
:alt: Image of the explanation button
#. On the **Settings** tab, specify the settings that you want.
......@@ -133,7 +133,7 @@ problems, whose answers are always visible directly below the question,
dropdown problems don't show answer choices until the student clicks
the dropdown arrow.
.. image:: Images/DropdownExample.gif
.. image:: ../Images/DropdownExample.png
:alt: Image of a dropdown problem
==========================
......@@ -156,7 +156,7 @@ To create a dropdown problem, follow these steps.
#. Determine the text of the problem to use as a label, and then surround that text with two sets of angle brackets (>><<).
#. Select all the answer options, and then click the dropdown button.
.. image:: Images/ProbCompButton_Dropdown.gif
.. image:: ../Images/ProbCompButton_Dropdown.png
:alt: Image of the dropdown button
When you do this, a double set of brackets ([[ ]]) appears and surrounds the
......@@ -166,7 +166,7 @@ To create a dropdown problem, follow these steps.
#. In the component editor, select the text of the explanation, and then click the
explanation button to add explanation tags around the text.
.. image:: Images/ProbCompButton_Explanation.gif
.. image:: ../Images/ProbCompButton_Explanation.png
:alt: Image of the explanation button
#. On the **Settings** tab, specify the settings that you want.
......@@ -226,7 +226,7 @@ don't appear until the student clicks the drop-down arrow, answer
choices for multiple choice problems are always visible directly below
the question.
.. image:: Images/MultipleChoiceExample.gif
.. image:: ../Images/MultipleChoiceExample.png
:alt: Image of a multiple choice problem
==================================
......@@ -247,7 +247,7 @@ Simple Editor
#. Determine the text of the problem to use as a label, and then surround that text with two sets of angle brackets (>><<).
#. Select all the answer options, and then click the multiple choice button.
.. image:: Images/ProbCompButton_MultChoice.gif
.. image:: ../Images/ProbCompButton_MultChoice.png
:alt: Image of the multiple choice button
When you do this, the component editor adds a pair of parentheses next to each
......@@ -258,7 +258,7 @@ Simple Editor
#. In the component editor, select the text of the explanation, and then click the
explanation button to add explanation tags around the text.
.. image:: Images/ProbCompButton_Explanation.gif
.. image:: ../Images/ProbCompButton_Explanation.png
:alt: Image of the explanation button
#. On the **Settings** tab, specify the settings that you want.
......@@ -325,7 +325,7 @@ Numerical Input
In numerical input problems, students enter numbers or specific and
relatively simple mathematical expressions to answer a question.
.. image:: Images/image292.png
.. image:: ../Images/image292.png
:alt: Image of a numerical input problem
Note that students' responses don't have to be exact for these problems. You can
......@@ -340,21 +340,21 @@ text that the student enters into mathematical symbols. The following
example shows the way Studio renders students' text responses in
numerical input problems.
.. image:: Images/Math5.gif
.. image:: ../Images/Math5.png
:alt: Image of a numerical input probem rendered by Studio
The following are a few more examples of the way that Studio renders numerical input
text that students enter.
.. image:: Images/Math1.gif
.. image:: ../Images/Math1.png
:alt: Image of a numerical input probem rendered by Studio
.. image:: Images/Math2.gif
.. image:: ../Images/Math2.png
:alt: Image of a numerical input probem rendered by Studio
.. image:: Images/Math3.gif
.. image:: ../Images/Math3.png
:alt: Image of a numerical input probem rendered by Studio
.. image:: Images/Math4.gif
.. image:: ../Images/Math4.png
:alt: Image of a numerical input probem rendered by Studio
.. image:: Images/Math5.gif
.. image:: ../Images/Math5.png
:alt: Image of a numerical input probem rendered by Studio
==================
......@@ -450,7 +450,7 @@ You can create numerical problems in the Simple Editor and in the Advanced Edito
For example, the following example problems require the Advanced Editor.
.. image:: Images/NumericalInput_Complex.png
.. image:: ../Images/NumericalInput_Complex.png
:alt: Image of a more complex numerical input problem
For more information about including a Python script in your problem, see :ref:`Custom Python Evaluated Input`.
......@@ -461,17 +461,18 @@ Simple Editor
#. Under **Add New Component**, click **Problem**.
#. In the **Select Problem Component Type** screen, click **Numerical
Input** on the **Common Problem Types** tab.
#. When the new Problem component appears, click **Edit**.
3. When the new Problem component appears, click **Edit**.
#. In the component editor, replace the sample problem text with your own text.
#. Determine the text of the problem to use as a label, and then surround that text with two sets of angle brackets (>><<).
#. Select the text of the answer, and then click the numerical input button.
.. image:: Images/ProbCompButton_NumInput.gif
.. image:: ../Images//ProbCompButton_NumInput.png
:alt: Image of the numerical input button
When you do this, an equal sign appears next to the answer.
When you do this, an equal sign appears next to the answer.
#. (Optional) Specify a margin of error, or tolerance. You can specify a percentage, number, or range.
7. (Optional) Specify a margin of error, or tolerance. You can specify a percentage, number, or range.
* To specify a percentage on either side of the correct answer, add **+-NUMBER%** after the answer. For example, if you want to include a 2% tolerance, add **+-2%**.
......@@ -479,13 +480,13 @@ Simple Editor
* To specify a range, use brackets [] or parentheses (). A bracket indicates that range includes the number next to it. A parenthesis indicates that the range does not include the number next to it. For example, if you specify **[5, 8)**, correct answers can be 5, 6, and 7, but not 8. Likewise, if you specify **(5, 8]**, correct answers can be 6, 7, and 8, but not 5.
#. In the component editor, select the text of the explanation, and then click the
8. In the component editor, select the text of the explanation, and then click the
explanation button to add explanation tags around the text.
.. image:: Images/ProbCompButton_Explanation.gif
.. image:: ../Images/ProbCompButton_Explanation.png
:alt: Image of athe explanation button
#. On the **Settings** tab, specify the settings that you want.
9. On the **Settings** tab, specify the settings that you want.
#. Click **Save**.
For the first example problem above, the text in the Problem component is the
......@@ -571,7 +572,7 @@ the instructor's specified answer exactly, including spelling and
punctuation, we recommend that you specify more than one attempt for
text input problems to allow for typographical errors.
.. image:: Images/TextInputExample.gif
.. image:: ../Images/TextInputExample.png
:alt: Image of a text input probem
==================================
......@@ -593,7 +594,7 @@ To create a text input problem in the Simple Editor, follow these steps.
#. Determine the text of the problem to use as a label, and then surround that text with two sets of angle brackets (>><<).
#. Select the text of the answer, and then click the text input button.
.. image:: Images/ProbCompButton_TextInput.gif
.. image:: ../Images/ProbCompButton_TextInput.png
:alt: Image of the text input button
When you do this, an equal sign appears next to the answer.
......@@ -602,7 +603,7 @@ To create a text input problem in the Simple Editor, follow these steps.
#. In the component editor, select the text of the explanation, and then click the
explanation button to add explanation tags around the text.
.. image:: Images/ProbCompButton_Explanation.gif
.. image:: ../Images/ProbCompButton_Explanation.png
:alt: Image of the explanation button
#. On the **Settings** tab, specify the settings that you want.
......@@ -772,4 +773,4 @@ You can provide hints that appear when students enter common incorrect answers i
The regular expression that the student enters must contain the part of the answer that the instructor specifies. For example, if an instructor has specified ``<answer=".*example answer.*" type="regexp">``, correct answers include ``example answered``, ``two example answers``, or even ``==example answer==``, but not ``examples`` or ``example anser``.
You can add ``regexp`` to the value of the ``type`` attribute, for example: ``type="ci regexp"`` or ``type="regexp"`` or ``type="regexp cs"``. In this case, any answer or hint are treated as regular expressions.
\ No newline at end of file
You can add ``regexp`` to the value of the ``type`` attribute, for example: ``type="ci regexp"`` or ``type="regexp"`` or ``type="regexp cs"``. In this case, any answer or hint are treated as regular expressions.
docs/en_us/course_authors/source/create_problem_component.rst → docs/en_us/course_authors/source/problems_tools/create_problem_component.rst
......@@ -42,7 +42,7 @@ The Student View of a Problem
All problems on the edX platform have several component parts.
.. image:: Images/AnatomyOfExercise1.gif
.. image:: ../Images//AnatomyOfExercise1.png
:alt: Image of a problem from a student's point of view, with callouts for elements of the problem
#. **Problem text.** The problem text can contain any standard HTML formatting.
......@@ -72,13 +72,13 @@ All problems on the edX platform have several component parts.
#. **Attempts.** The instructor may set a specific number of attempts or
allow unlimited attempts.
.. image:: Images/AnatomyOfExercise2.gif
.. image:: ../Images//AnatomyOfExercise2.png
:alt: Image of a problem from a student's point of view, with callouts for attempts and showing the answer
#. **Feedback.** After a student clicks **Check**, all problems return a
green check mark or a red X.
.. image:: Images/AnatomyofaProblem_Feedback.gif
.. image:: ../Images//AnatomyofaProblem_Feedback.png
:alt: Image of feedback checkmark and x from a student's point of view
#. **Correct answer.** Most problems require that the instructor specify
......@@ -92,14 +92,14 @@ All problems on the edX platform have several component parts.
#. **Hide Answer button.**
.. image:: Images/AnatomyOfExercise3.gif
.. image:: ../Images//AnatomyOfExercise3.png
:alt: Image of a problem in the course accordian
#. **Grading.** The instructor may specify whether a group of problems
is graded. If a group of problems is graded, a clock icon appears for
that assignment in the course accordion.
.. image:: Images/clock_icon.gif
.. image:: ../Images//clock_icon.png
#. **Due date.** The date that the problem is due. A problem that is
past due does not have a **Check** button. It also does not accept
......@@ -160,7 +160,7 @@ the text for you automatically. The toolbar buttons are the following:
The following image shows a multiple choice problem in the Simple Editor.
.. image:: Images/MultipleChoice_SimpleEditor.png
.. image:: ../Images//MultipleChoice_SimpleEditor.png
:alt: Image of a problem in the simple editor
.. _Advanced Editor:
......@@ -175,7 +175,7 @@ For more information about the XML for different problem types, see :ref:`Append
The following image shows the multiple choice problem above in the Advanced Editor
instead of the Simple Editor.
.. image:: Images/MultipleChoice_AdvancedEditor.png
.. image:: ../Images//MultipleChoice_AdvancedEditor.png
:alt: Image of a problem in the advanced editor
.. _Problem Settings:
......@@ -193,7 +193,7 @@ the component editor.
- **Randomization**
- **Show Answer**
.. image:: Images/ProbComponent_Attributes.png
.. image:: ../Images//ProbComponent_Attributes.png
:alt: Image of the Settings tab in a Problem component
===============
......@@ -204,7 +204,7 @@ This setting indicates the name of your problem. The display name
appears as a heading over the problem in the LMS and in the course
ribbon at the top of the page.
.. image:: Images/ProbComponent_LMS_DisplayName.gif
.. image:: ../Images//ProbComponent_LMS_DisplayName.png
:alt: Image of the problem in a unit page from a student's point of view
==============================
......@@ -227,7 +227,7 @@ Problem Weight
This setting specifies the maximum number of points possible for the
problem. The problem weight appears next to the problem title.
.. image:: Images/ProblemWeight_DD.gif
.. image:: ../Images//ProblemWeight_DD.png
:alt: Image of a problem from a student's point of view, with the possible points circled
By default, each response field, or “answer space,” in a Problem
......@@ -239,7 +239,7 @@ to answer, and thus has three response fields.
The following Problem component contains one text input problem,
and has just one response field.
.. image:: Images/ProblemWeight_TI.gif
.. image:: ../Images//ProblemWeight_TI.png
:alt: Image of a text input problem from a student's point of view
Computing Scores
......@@ -294,7 +294,7 @@ This setting specifies whether certain values in your problem change each time a
.. image:: Images/Rerandomize.gif
.. image:: ../Images//Rerandomize.png
If you want to change, or "randomize," specific values in your problem, you have to do both the following:
......@@ -385,7 +385,7 @@ page for the problem type.
in the Advanced component.
- :ref:`Open Response Assessment Problems` are a new kind of problem that allow you, the
students in your course, or a computer algorithm to grade responses in the form
of essays, files such as computer code, and images.
of essays, files such as computer code, and ../Images/.
.. _Multiple Problems in One Component:
......
docs/en_us/course_authors/source/appendices/e.rst → docs/en_us/course_authors/source/problems_tools/e.rst
......@@ -454,7 +454,7 @@ Template
</problem>
Tags
====
----
* ``<imageresponse>``: Indicates that the problem is an image mapped input problem.
* ``<imageinput>``: Specifies the image file and the region in the file that the student must click.
......@@ -737,7 +737,7 @@ Problem with a decimal tolerance
</problem>
Problem with a percentage tolerance
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.. code-block:: xml
......@@ -1163,4 +1163,3 @@ Surround the text of the hint.
docs/en_us/course_authors/source/external_graders.rst → docs/en_us/course_authors/source/problems_tools/external_graders.rst
......@@ -31,13 +31,13 @@ An external grader is particularly useful for software programming courses where
For example, you define a problem that requires students to submit Python code, and create a set of tests that an external grader can run to verify the submissions. When a student enters Python code for the problem and clicks **Check**, the code is sent to the grader for testing. If the code passes all tests, the grader returns the score and a string indicating that the solution is correct.
.. image:: Images/external-grader-correct.png
.. image:: ../Images/external-grader-correct.png
:alt: Image of a students view of a programming problem that uses an external grader, with a correct result
The external grader can return a string with results, which the student can see by clicking **See full output**. This can be particularly useful when the solution is not correct and you want to return information about the failed tests. For example:
.. image:: Images/external-grader-incorrect.png
.. image:: ../Images/external-grader-incorrect.png
:alt: Image of a students view of a programming problem that uses an external grader, with a correct result
.. _External Graders and XQueue:
......
docs/en_us/course_authors/source/appendices/f.rst → docs/en_us/course_authors/source/problems_tools/f.rst
.. _Appendix F:
Appendix F - Files for the Example Custom JavaScript Display and Grading Problem
Files for the Example Custom JavaScript Display and Grading Problem
================================================================================
For the example :ref:`Custom JavaScript Display and Grading` problem, you need the following files. You can find
......
docs/en_us/course_authors/source/appendices/g.rst → docs/en_us/course_authors/source/problems_tools/g.rst
......@@ -42,7 +42,7 @@ HTML (Text) Components
In the HTML component editor, you can use MathJax both in Visual view and in HTML view.
.. image:: ../Images/MathJax_HTML.gif
.. image:: ../Images/MathJax_HTML.png
:alt: Image of an HTML component with MathJax in both the Visual and HTML views
Problem Components
......@@ -56,5 +56,5 @@ explanation is enclosed in backslashes and parentheses, so it appears inline wit
Navier-Stokes equation is enclosed in backslashes and brackets, so it appears on its
own line.
.. image:: ../Images/MathJax_Problem.gif
.. image:: ../Images/MathJax_Problem.png
:alt: Image of a problem component with MathJax in both the Visual and HTML views
\ No newline at end of file
docs/en_us/course_authors/source/google_hangouts.rst → docs/en_us/course_authors/source/problems_tools/google_hangouts.rst
......@@ -52,28 +52,28 @@ The Student Experience
When you add the instant hangout to your course, a control for the hangout appears on that page. The following example shows the control in a course unit. The control shows that the student can start the hangout and be the first participant.
.. image:: Images/hangout_unit.png
.. image:: ../Images/hangout_unit.png
:alt: Image of the instant hangout control on a unit
To start the hangout, the student clicks **Start the Hangout**. (After the first student clicks **Start the Hangout**, other students see a **Join the Hangout** button.)
The following example shows the control in a static page when a hangout has already started. The control has a **Join the Hangout** button, and shows that one other student is already in the hangout.
.. image:: Images/hangout_static_page.png
.. image:: ../Images/hangout_static_page.png
:alt: Image of the instant hangout control on a static page
To join the hangout, the student clicks **Join the Hangout**.
If not already logged in, the student is prompted to log in to Google:
.. image:: Images/google_login.png
.. image:: ../Images/google_login.png
:alt: Image of the Google login page
Students who do not have a Google account can create one from the login page.
After the student has logged in to Google, the hangout opens in a separate browser window:
.. image:: Images/hangout.png
.. image:: ../Images/hangout.png
:alt: Image of the instant hangout
.. _Limitations:
......
docs/en_us/course_authors/source/problems_tools/index.rst 0 → 100644
.. _Working with Problems Index:
##########################
Working with Problems
##########################
.. toctree::
:maxdepth: 2
create_problem_component
common_problems
advanced_problems
specialized_problems
e
external_graders
open_response_assessment
tools
additional_tools
google_hangouts
f
g
docs/en_us/course_authors/source/open_response_assessment.rst → docs/en_us/course_authors/source/problems_tools/open_response_assessment.rst
......@@ -70,14 +70,14 @@ An open response assessment has three elements:
following example, the student performs a self assessment, then peers
perform peer assessments, and then an AI assessment runs.
.. image:: Images/CITL_AssmtTypes.gif
.. image:: ../Images/CITL_AssmtTypes.png
:alt: Image of ORA with assessment types circled
- The question that you want your students to answer. This appears near
the top of the component, followed by a field where the student
enters a response.
.. image:: Images/CITLsample.gif
.. image:: ../Images/CITLsample.png
:alt: Image of ORA question
- A rubric that you design. After the student enters a response and
......@@ -87,7 +87,7 @@ An open response assessment has three elements:
student sees a "Your response has been submitted" message but doesn't
see the rubric.)
.. image:: Images/CITL_SA_Rubric.gif
.. image:: ../Images/CITL_SA_Rubric.png
:alt: Image of ORA with rubric showing below the student's response
.. _ORA Types:
......@@ -184,7 +184,7 @@ Step 1. Create the ORA Component
scoring. You'll replace this sample content with the content for your
problem.
.. image:: Images/ORAComponentEditor.gif
.. image:: ../Images/ORAComponentEditor.png
:alt: Image of component editor with prompt, rubric, and assessment type highlighted
.. _Step 2:
......@@ -194,10 +194,10 @@ Step 2. Add the Question
#. In the component editor, locate the [prompt] tags.
.. image:: Images/ORA_Prompt.gif
.. image:: ../Images/ORA_Prompt.png
:alt: Image of component editor with prompt text highlighted
#. Replace the sample text between the **[prompt]** tags with the text of
2. Replace the sample text between the **[prompt]** tags with the text of
your question. When you replace the sample text, make sure you follow
these guidelines to avoid common formatting mistakes.
......@@ -216,10 +216,10 @@ Step 3. Add the Rubric
#. In the component editor, locate the [rubric] tags. (The sample rubric
is long, so you'll have to scroll down to locate the second tag.)
.. image:: Images/ORA_Rubric.gif
.. image:: ../Images/ORA_Rubric.png
:alt: Image of component editor with rubric text highlighted
#. Replace the sample rubric with the text of your rubric. Make sure to
2. Replace the sample rubric with the text of your rubric. Make sure to
do the following.
- Include the beginning and ending [rubric] tags.
......@@ -299,8 +299,8 @@ Set the Assessment Type and Scoring
#. In the component editor, locate the [tasks] tags.
.. image:: Images/ORA_Tasks.gif
:alt: Image of component editor with tasks tags and text highlighted
.. image:: ../Images/ORA_Tasks.png
:alt: Image of component editor with tasks tags and text highlighted
#. Replace the sample code with the code for your problem.
......@@ -322,13 +322,14 @@ The name of the problem appears as a heading above the problem in the
courseware. It also appears in the list of problems on the **Staff
Grading** page.
.. image:: Images/ORA_ProblemName1.gif
.. image:: ../Images/ORA_ProblemName1.png
:alt: Image of Staff Grading page with a problem name circled
To change the name:
#. In the upper-right corner of the component editor, click
**Settings**.
#. In the **Display Name** field, replace **Open Response Assessment**
with the name of your problem.
......@@ -342,7 +343,7 @@ responses a student has to peer grade and whether students can upload
files as part of their response, click the **Settings** tab, and then
specify the options that you want.
.. image:: Images/ORA_Settings.gif
.. image:: ../Images/ORA_Settings.png
:alt: Image of component editor with Settings tab selected
Open response assessments include the following settings.
......@@ -449,7 +450,7 @@ Step 7. Save the Problem
The component appears in Studio. In the upper right corner, you can
see the type of assessments that you have set for this problem.
.. image:: Images/ORA_Component.gif
.. image:: ../Images/ORA_Component.png
:alt: Image of ORA component with assessment types circled
.. _Step 8:
......@@ -485,7 +486,7 @@ the ORA problems for the course through this peer grading interface.
The **Peer Grading** page opens.
.. image:: Images/PGI_Single.gif
.. image:: ../Images/PGI_Single.png
:alt: Image of LMS open to the Peer Grading page for the course
When students submit responses for peer assessments in your course,
......@@ -519,10 +520,10 @@ week).
to the right of the word **location**. Press CTRL+C to copy this
string, starting with **i4x**.
.. image:: Images/PA_StaffDebug_Location.gif
.. image:: ../Images/PA_StaffDebug_Location.png
:alt: Image of Staff Debug screen with ORA problem location circled
#. Switch back to the unit in Studio. If the visibility of the unit is
5. Switch back to the unit in Studio. If the visibility of the unit is
set to **Public**, change the visibility to **Private**.
#. Scroll to the bottom of the unit, click **Advanced** under **Add New
Component**, and then click **Peer Grading Interface**.
......@@ -532,7 +533,7 @@ week).
alphanumeric characters that you copied in step 4. Then, change the
**Show Single Problem** setting to **True**.
.. image:: Images/PGI_CompEditor_Settings.gif
.. image:: ../Images/PGI_CompEditor_Settings.png
#. Click **Save** to close the component editor.
......@@ -549,18 +550,18 @@ Test your problem by adding and grading a response.
When you click **View Live**, the unit opens in the LMS in a new tab.
#. In the LMS, locate your ORA question, and then type your response in
3. In the LMS, locate your ORA question, and then type your response in
the Response field under the question.
.. image:: Images/ThreeAssmts_NoResponse.gif
.. image:: ../Images/ThreeAssmts_NoResponse.png
Note that when you view your ORA problem in the LMS as an instructor,
you see the following message below the problem. This message never
appears to students.
.. image:: Images/ORA_DuplicateWarning.gif
.. image:: ../Images/ORA_DuplicateWarning.png
#. Test the problem to make sure that it works as expected.
4. Test the problem to make sure that it works as expected.
To test your open response assessment, you may want to sign into your
course as a student, using an account that's different from the account
......@@ -601,19 +602,19 @@ The Staff Grading Page
When a response is available for you to grade, a yellow exclamation mark
appears next to **Open Ended Panel** at the top of the screen.
.. image:: Images/OpenEndedPanel.gif
.. image:: ../Images/OpenEndedPanel.png
To access the **Staff Grading** page, click **Open Ended Panel**.
When the **Open Ended Console** page opens, click **Staff Grading**.
Notice the **New submissions to grade** notification.
.. image:: Images/OpenEndedConsole_NewSubmissions.gif
.. image:: ../Images/OpenEndedConsole_NewSubmissions.png
When the **Staff Grading** page opens, information about your open
response assessment appears in several columns.
.. image:: Images/ProblemList-DemoCourse.gif
.. image:: ../Images/ProblemList-DemoCourse.png
+----------------------------------------------------+--------------------------------------------------------------------+
| **Problem Name** | The name of the problem. Click the name of the problem to open it. |
......@@ -653,9 +654,9 @@ Grade Responses
is a calculation of the difference between the scores that AI
algorithm provides and the scores that the instructor provides.
.. image:: Images/ResponseToGrade.gif
.. image:: ../Images/ResponseToGrade.png
#. In the rubric below the response, select the option that best
3. In the rubric below the response, select the option that best
describes the response.
#. If applicable, add additional feedback.
......@@ -668,20 +669,20 @@ Grade Responses
Flagged content is accessed on the **Staff Grading** page. If
necessary, course staff can ban a student from peer grading.
.. image:: Images/AdditionalFeedback.gif
.. image:: ../Images/AdditionalFeedback.png
#. When you are done grading the response, click **Submit**.
5. When you are done grading the response, click **Submit**.
When your course is running, another response opens automatically after
you grade the first response, and a message appears at the top of the
page.
.. image:: Images/FetchingNextSubmission.gif
.. image:: ../Images/FetchingNextSubmission.png
After you've graded all responses for this problem, **No more
submissions to grade** appears on the page.
.. image:: Images/NoMoreSubmissions.gif
.. image:: ../Images/NoMoreSubmissions.png
Click **Back to problem list** to return to the list of problems. You
can also wait for a few minutes and click **Re-check for submissions**
......@@ -749,14 +750,14 @@ You access your scores for your responses to AI and peer assessment problems thr
#. From any page in the LMS, click the **Open Ended Panel** tab at the
top of the page.
.. image:: Images/OpenEndedPanel.gif
.. image:: ../Images/OpenEndedPanel.png
#. On the **Open Ended Console** page, click **Problems You Have
2. On the **Open Ended Console** page, click **Problems You Have
Submitted**.
.. image:: Images/ProblemsYouHaveSubmitted.gif
.. image:: ../Images/ProblemsYouHaveSubmitted.png
#. On the **Open Ended Problems** page, check the **Status** column to
3. On the **Open Ended Problems** page, check the **Status** column to
see whether your responses have been graded.
#. When grading for a problem has been finished, click the name of a
problem in the list to see your score for that problem. When you
......@@ -769,11 +770,11 @@ graders.
**Graded AI Assessment**
.. image:: Images/AI_ScoredResponse.gif
.. image:: ../Images/AI_ScoredResponse.png
**Graded Peer Assessment**
.. image:: Images/Peer_ScoredResponse.gif
.. image:: ../Images/Peer_ScoredResponse.png
If you want to see the full rubric for either an AI or peer assessment,
click **Toggle Full Rubric**.
......@@ -782,4 +783,4 @@ click **Toggle Full Rubric**.
problems to see your score, you receive a message that lets you know how
many problems you still need to grade.
.. image:: Images/FeedbackNotAvailable.gif
.. image:: ../Images/FeedbackNotAvailable.png
docs/en_us/course_authors/source/specialized_problems.rst → docs/en_us/course_authors/source/problems_tools/specialized_problems.rst
......@@ -18,7 +18,7 @@ Specialized problems are advanced problems such as annotations. These problems a
By default, when you create a new component in Studio, you see the
following options.
.. image:: Images/AddNewComponent.gif
.. image:: ../Images/AddNewComponent.png
:alt: Image of the Add a New Component panel
To create a specialized problem, you must first add the Advanced
......@@ -30,10 +30,10 @@ component to your course. To do this, follow these steps.
Definition** section, and then locate the **advanced_modules**
policy key (this key is at the top of the list).
.. image:: Images/AdvancedModulesEmpty.gif
.. image:: ../Images/AdvancedModulesEmpty.png
:alt: Image of the Manual Policy Definition section of the Advanced Settings page
#. Under **Policy Value**, place your cursor between the brackets, and
3. Under **Policy Value**, place your cursor between the brackets, and
then enter the value for the type of problem that you want to create.
Make sure to include the quotation marks, but not the period.
......@@ -53,23 +53,23 @@ component to your course. To do this, follow these steps.
"annotatable","word_cloud"
.. image:: Images/AdvSettings_Before.png
.. image:: ../Images/AdvSettings_Before.png
:alt: Image of the Manual Policy Definition section of the Advanced Settings page, with specialized problems added
#. At the bottom of the page, click **Save Changes**.
4. At the bottom of the page, click **Save Changes**.
The page refreshes automatically. At the top of the page, you see a
notification that your changes have been saved.
The text in the **Policy Value** field now appears as follows.
.. image:: Images/AdvSettings_After.png
.. image:: ../Images/AdvSettings_After.png
:alt: Image of the Manual Policy Definition section of the Advanced Settings page, with specialized problems added after saving
#. Return to the unit where you want to add the specialized problem. The
5. Return to the unit where you want to add the specialized problem. The
list of possible components now contains an Advanced component.
.. image:: Images/AdvancedComponent.gif
.. image:: ../Images/AdvancedComponent.png
:alt: Image of the Add a New Component panel with the Advanced component option
When you click the Advanced component, you can see **Annotation** and **Word cloud** in the list. More information about how to create each problem is provided in the page for that problem type.
......@@ -86,7 +86,7 @@ questions appear when students hover the mouse over the highlighted
text. The questions also appear in a section below the text block, along
with space for students' responses.
.. image:: Images/AnnotationExample.gif
.. image:: ../Images/AnnotationExample.png
:alt: Image of an annotation problem
Create an Annotation Problem
......@@ -120,7 +120,7 @@ Add the **Annotation problem** segment of the problem.
placeholders with your own information.
::
::
<problem>
<annotationresponse>
......
docs/en_us/course_authors/source/tools.rst → docs/en_us/course_authors/source/problems_tools/tools.rst
......@@ -29,17 +29,17 @@ The Student View of a Full Screen Image
-----------------------------------------
The student sees the full screen image in a unit page. When the student hovers the mouse pointer over the image, the **Fullscreen** button appears:
.. image:: Images/image-modal.png
.. image:: ../Images/image-modal.png
:alt: Image of the full screen image tool with the Full Screen button.
When the student clicks **Fullscreen**, the image opens and expands in the full browser window. The buttons **Close**, **Zoom In**, and **Zoom Out** appear:
.. image:: Images/image-modal-window.png
.. image:: ../Images/image-modal-window.png
:alt: Image of the Image Modal tool with the Full Screen button.
The student can then zoom in on the image, and drag the image to view the desired part of it:
.. image:: Images/image-modeal-zoomed.png
.. image:: ../Images/image-modeal-zoomed.png
:alt: Image of the Image Modal tool with the Full Screen button.
......@@ -145,14 +145,14 @@ Step 1. Add LTI to the Advanced Modules Policy Key
Definition** section, and then locate the **advanced_modules**
policy key (this key is at the top of the list).
.. image:: Images/AdvancedModulesEmpty.gif
.. image:: ../Images/AdvancedModulesEmpty.png
:alt: Image of the advanced_modules key in the Advanced Settings page
#. Under **Policy Value**, place your cursor between the brackets, and
then enter **“lti”**. Make sure to include the quotation marks, but
not the period.
.. image:: Images/LTIPolicyKey.gif
.. image:: ../Images/LTIPolicyKey.png
:alt: Image of the advanced_modules key in the Advanced Settings page, with the LTI value added
**Note** If the **Policy Value** field already contains text, place your
......@@ -285,7 +285,7 @@ their thoughts to the group.
For example, the following word cloud was created from students'
responses to a question in a HarvardX course.
.. image:: Images/WordCloudExample.gif
.. image:: ../Images/WordCloudExample.png
:alt: Image of a word cloud problem
Create a Word Cloud Exercise
......@@ -332,7 +332,7 @@ Zooming Image Tool
You may want to present information to your students as an image. If your image is very large or very detailed, students may not be able to see all the information in the image. You can use the zooming image tool to enlarge areas of your image as the student moves the mouse over the image, as in the example below.
.. image:: Images/Zooming_Image.gif
.. image:: ../Images/Zooming_Image.png
:alt: Example zooming image tool showing a chemistry exercise
Components of a Zooming Image Tool
......@@ -381,7 +381,7 @@ Create a Zooming Image Tool
The HTML in your zooming image tool may resemble the following.
.. image:: Images/ZoomingImage_Modified.gif
.. image:: ../Images/ZoomingImage_Modified.png
:alt: Example HTML for a zooming image tool
#. Click **Save** to save the HTML component.
......
docs/en_us/course_authors/source/beta_testing.rst → docs/en_us/course_authors/source/releasing_course/beta_testing.rst
......@@ -129,7 +129,7 @@ To define the start of the beta test, you use Studio to specify a number of days
#. Scroll down to the ``days_early_for_beta`` **Policy Key**.
#. Set the **Policy Value** to a number of days before section and subsection **Release Day**s.
#. Set the **Policy Value** to a number of days before the **Release Day** for the section and subsection.
#. Click **Save Changes**.
......
docs/en_us/course_authors/source/appendices/d.rst → docs/en_us/course_authors/source/releasing_course/d.rst
.. raw:: latex
\newpage %
======================
APPENDIX D: Time Zones
Time Zones
======================
**Overview**
......
docs/en_us/course_authors/source/releasing_course/index.rst 0 → 100644
.. _Releasing Your Course Index:
##########################
Releasing Your Course
##########################
.. toctree::
:maxdepth: 2
beta_testing
view_course_content
set_content_releasedates
staff_debug_info
d
docs/en_us/course_authors/source/set_content_releasedates.rst → docs/en_us/course_authors/source/releasing_course/set_content_releasedates.rst
......@@ -149,7 +149,7 @@ To make revisions to a unit that has been published, you create and edit a draft
To create a draft, go to the unit's page, and then click **edit a draft** in the right pane.
.. image:: Images/Viz_Revise_EditDraft.png
.. image:: ../Images/Viz_Revise_EditDraft.png
:width: 800
:alt: Image of a public unit with the edit a draft link circled
......@@ -158,7 +158,7 @@ When you edit a draft of a unit, you can view the unit's contents in two ways.
* To view the already-published content as it appears in the live course, click **View the Live Version** in the upper-right corner of the page.
* To view the unpublished content as you're working on it, click **Preview**.
.. image:: Images/Viz_Revise_ViewLiveandPreview.png
.. image:: ../Images/Viz_Revise_ViewLiveandPreview.png
:alt: Image of draft unit
When you're ready to publish the draft of your revised content,
......@@ -166,7 +166,7 @@ click **replace it with this draft** in the right pane.
If you decide you don't want to keep the revised content, click **Delete Draft**.
.. image:: Images/Viz_Revise_ReplaceorDelete.png
.. image:: ../Images/Viz_Revise_ReplaceorDelete.png
:alt: Image of a unit settings panel with the replace it with this draft link circled
.. Warning:: Historical versions of units are not stored by Studio. After you replace the live version with a new draft, you cannot revert the unit to the previous version.
......
docs/en_us/course_authors/source/view_course_content.rst → docs/en_us/course_authors/source/releasing_course/view_course_content.rst
......@@ -34,7 +34,7 @@ You can enter Preview mode in two ways.
* On any subsection page, click **Preview Drafts**.
.. image:: Images/preview_draft.png
.. image:: ../Images/preview_draft.png
:width: 800
:alt: Image of a subsection with the Preview Drafts button circled
......@@ -43,7 +43,7 @@ You can enter Preview mode in two ways.
The following example shows the **Preview** button for a unit that
is set to Public.
.. image:: Images/preview_public.png
.. image:: ../Images/preview_public.png
:width: 800
:alt: Image of a public unit with the Preview button circled
......@@ -51,7 +51,7 @@ You can enter Preview mode in two ways.
The following example shows the **Preview** button for a unit that
is set to Private.
.. image:: Images/preview_private.png
.. image:: ../Images/preview_private.png
:width: 800
:alt: Image of a private unit with the Preview button circled
......@@ -72,19 +72,19 @@ You can view the live course from three different places in Studio:
* The **Course Outline** page.
.. image:: Images/course_outline_view_live.png
.. image:: ../Images/course_outline_view_live.png
:width: 800
:alt: Image of the course outline with the View Live button circled
* Any Subsection page.
.. image:: Images/subsection_view_live.png
.. image:: ../Images/subsection_view_live.png
:width: 800
:alt: Image of a subsection with the View Live button circled
* The Unit page, if the Unit is Public.
.. image:: Images/unit_view_live.png
.. image:: ../Images/unit_view_live.png
:width: 800
:alt: Image of a unit with the View Live button circled
docs/en_us/course_authors/source/checking_student_progress.rst → docs/en_us/course_authors/source/running_course/checking_student_progress.rst
......@@ -26,7 +26,7 @@ percent needed for each grade cutoff. Here is an example of a student's
progress through edX101.
.. image:: Images/image245.png
.. image:: ../Images/image245.png
:width: 800
:alt: Image of a student's Course Progress page with the grade cutoffs legend highlighted
......@@ -45,7 +45,7 @@ recorded for the student for all problems in the course. Here is a scrolled
down view of the example Progress page for the student in the example above:
.. image:: Images/image247.png
.. image:: ../Images/image247.png
:width: 800
:alt: Image of a student's Course Progress page with problems highlighted
......@@ -66,7 +66,7 @@ more course-specific tools get added. Here is the current view of the top of
the Grades page of the Instructor dashboard for edX101:
.. image:: Images/image249.png
.. image:: ../Images/image249.png
:width: 800
:alt: Image of the Grades tab of the Instructor Dashboard
......
docs/en_us/course_authors/source/course_enrollment.rst → docs/en_us/course_authors/source/running_course/course_enrollment.rst
......@@ -28,7 +28,7 @@ Before a student can be enrolled in a course, he or she must:
#. Activate the registered account by following the emailed instructions.
Students can then enroll themselves in edx.org courses, or can enroll in other courses if they know the URL. For a more detailed description of this process from a student's point of view, see :doc:`appendices/c`.
Students can then enroll themselves in edx.org courses, or can enroll in other courses if they know the URL. For a more detailed description of this process from a student's point of view, see :ref:`Sample Student Login Guide`.
Course authors and instructors can enroll students in a course either before or after the students register their user accounts.
......@@ -50,7 +50,7 @@ When you enroll students, you have options to:
An example of the email message that students receive when you select this option follows.
.. image:: Images/Course_Enrollment_Email.png
.. image:: ../Images/Course_Enrollment_Email.png
:alt: Email message inviting a student to enroll in the EdX 101 course
To enroll students or staff members:
......
docs/en_us/course_authors/source/course_grades.rst → docs/en_us/course_authors/source/running_course/course_grades.rst
......@@ -36,12 +36,12 @@ You establish a grading policy for your course when you create it in Studio. Whi
A list of the assignment types in your course displays. In this example, Homework is weighted as 60% of the grade.
.. image:: Images/Grading_Configuration.png
.. image:: ../Images/Grading_Configuration.png
:alt: XML of course assignment types and weights for grading
In Studio, you define this information by selecting **Settings** > **Grading**.
.. image:: Images/Grading_Configuration_Studio.png
.. image:: ../Images/Grading_Configuration_Studio.png
:alt: Studio example of homework assignment type and grading weight
For more information, see :ref:`Configure the Assignment Types`.
......@@ -115,7 +115,7 @@ To view current grades for a student:
The Course Progress page for the student displays a chart with the grade for each homework, lab, midterm, final, and any other assignment types in your course, and the total grade earned for the course to date.
.. image:: Images/Student_Progress.png
.. image:: ../Images/Student_Progress.png
:alt: A bar chart from a student's Progress page showing grade acheived for each assignment
=========================================================
......@@ -195,7 +195,7 @@ To find the unique identifier in the URL for a problem:
Information about the problem displays, including its location or URL. This URL ends with the type of module, which is typically "problem", and the unique identifier.
.. image:: Images/Problem_URL.png
.. image:: ../Images/Problem_URL.png
:alt: The Staff Debug view of a problem with the unique identifier indicated at the end of a URL address
......
docs/en_us/course_authors/source/course_student.rst → docs/en_us/course_authors/source/running_course/course_student.rst
......@@ -42,7 +42,7 @@ Student-reported data
When students register with edX, they select a public username and supply information about themselves. Most of this information is optional, so not all of the students who are enrolled in your course provide it.
.. image:: Images/Registration_page.png
.. image:: ../Images/Registration_page.png
:alt: Fields that collect student information during registration
Students then register for as many individual courses as they choose, which enrolls them in each selected course.
......@@ -82,7 +82,7 @@ To view or download student data:
A table of the student data displays, with one row for each enrolled student. Longer values, such as student goals, are truncated.
.. image:: Images/StudentData_Table.png
.. image:: ../Images/StudentData_Table.png
:alt: Table with columns for the collected data points and rows for each student on the Instructor Dashboard
.. note:: In the future, edX may also request that students select a language and location. This data is not collected at this time.
......@@ -111,10 +111,10 @@ To display demographic data for your students:
* The Gender Distribution and Level of Education sections show tables with counts of responses made by enrolled students.
.. image:: Images/Distribution_Education.png
.. image:: ../Images/Distribution_Education.png
:alt: Table with columns for different possible values for gender and total count reported for each value
.. image:: Images/Distribution_Gender.png
.. image:: ../Images/Distribution_Gender.png
:alt: Table with columns for different possible values for level of education completed and total count reported for each value
"No Data" is the sum of the students for whom no value exists for the demographic.
......
docs/en_us/course_authors/source/discussions.rst → docs/en_us/course_authors/source/running_course/discussions.rst
......@@ -89,7 +89,7 @@ To create a discussion category:
When students click the **Discussion** static page for your course, the drop-down list includes this new category.
.. image:: Images/NewCategory_Discussion.png
.. image:: ../Images/NewCategory_Discussion.png
:alt: Image of a new discussion category
.. _Assigning_discussion_roles:
......@@ -177,13 +177,13 @@ To encourage longer, threaded discussions rather than many similar, separate pos
* Pin a post.
Pinning a post makes it appear first in the discussion, so that it is more likely that students will see and respond to it. Otherwise, each post is listed in reverse chronological order or sorted as each student chooses. You can write your own post and then pin it, or pin a post by any author. Click **Pin Thread**.
.. image:: Images/Pin_Discussion.png
.. image:: ../Images/Pin_Discussion.png
:alt: Image of the pin icon for discussion posts
* Endorse a response.
Endorsing a response indicates that it provides value to the discussion, such as a correct answer to a question. Click the **check mark** that displays at upper right of the response.
.. image:: Images/Endorse_Discussion.png
.. image:: ../Images/Endorse_Discussion.png
:alt: Image of the Endorse button for discussion posts
* Close a thread.
......
docs/en_us/course_authors/source/running_course/index.rst 0 → 100644
.. _Running Your Course Index:
##########################
Running Your Course
##########################
.. toctree::
:maxdepth: 2
checking_student_progress
discussions
discussion_guidance_moderators
course_data
course_enrollment
course_staffing
course_student
course_grades
\ No newline at end of file
docs/en_us/course_authors/source/students/index.rst 0 → 100644
.. _Information for Your Students Index:
##############################
Information for Your Students
##############################
.. toctree::
:maxdepth: 2
ora_students
login_guide
docs/en_us/course_authors/source/appendices/c.rst → docs/en_us/course_authors/source/students/login_guide.rst
.. _Sample Student Login Guide:
======================================
APPENDIX C: Sample Student Login Guide
Sample Student Login Guide
======================================
Create a login guide for your individual course.
......@@ -46,7 +46,7 @@ Click on the blue Register for [NUMBER OF YOUR CLASS] button:
A pop-up user authentication window will appear. It will ask you to log in or sign up for edX. (If you already have an account with edX, use it to log in. You should now be registered for the course. Skip to Step 5. Otherwise, go on with Step 3.)
.. image:: ../Images/image305.png
.. image:: ../Images/Image305.png
:width: 600
:alt: Image of the registration page
......
docs/en_us/course_authors/source/ora_students.rst → docs/en_us/course_authors/source/students/ora_students.rst
......@@ -24,12 +24,12 @@ When you come to an open response assessment problem, you see the name of the
problem, the assessment types, the text of the question, the field where you'll
enter your response, and the **Save** and **Submit** buttons.
.. image:: /Images/ExampleORA.gif
.. image:: ../Images/ExampleORA.png
If an open response assessment asks you to submit a file, you'll also see a button
that you'll click to upload your file.
.. image:: /Images/ExampleORA_File.gif
.. image:: ../Images/ExampleORA_File.png
The *assessment types* can include *self assessment*, *peer assessment*, and *artificial intelligence (AI) assessment*. The
assessment types run in the order in which they appear in the problem.
......@@ -117,7 +117,7 @@ Perform a Self Assessment
#. When the rubric appears, compare your response with the rubric, and select the
option that you think is appropriate for each category.
.. image:: /Images/Rubric1.gif
.. image:: ../Images/Rubric1.png
#. Click **Submit assessment**.
......@@ -155,7 +155,7 @@ one peer grading interface. There may be just one peer grading interface
for the whole course, or each individual problem may have its own
separate peer grading interface.
.. image:: /Images/PGI_FromOEC_2Problems.gif
.. image:: ../Images/PGI_FromOEC_2Problems.png
Perform a Peer Assessment
......@@ -191,7 +191,7 @@ there are more essays from other students left to grade. If you haven't submitte
a response or no responses are available for grading, you see a yellow message in the
interface.*
.. image:: /Images/PAStudent_NoSubmissions.gif
.. image:: ../Images/PAStudent_NoSubmissions.png
There are several ways to access other students' responses, depending on
......@@ -203,7 +203,7 @@ the way that the course is set up.
When you see the list of problems that have responses available to grade,
click the name of the problem that you want to open it.
.. image:: /Images/PGI_FromOEC_2Problems.gif
.. image:: ../Images/PGI_FromOEC_2Problems.png
- Through the courseware, in a specific unit. This option is only available if the
instructor has included a peer grading interface for the problem in the body of
......@@ -211,7 +211,7 @@ the way that the course is set up.
the open response assessment problem. Scroll down past the response that you
submitted until you see the peer grading interface that appears below the problem.
.. image:: /Images/PGI_InUnitComposite.gif
.. image:: ../Images/PGI_InUnitComposite.png
- Through the courseware, in a separate section. This option may not be available
for your course. If it is, you'll see the section for peer grading in the
......@@ -220,7 +220,7 @@ the way that the course is set up.
that holds all the course peer grading interfaces. To access peer grading for
a problem, you click the problem name.
.. image:: /Images/PGI_Multiple-600x.gif
.. image:: ../Images/PGI_Multiple-600x.png
.. _Learn to Grade:
......@@ -244,9 +244,9 @@ other students' responses to the question.
#. Review the **How did I do?** message that you receive, and then click
**Continue**.
.. image:: /Images/PG_Calibration_Correct.gif
.. image:: ../Images/PG_Calibration_Correct.png
.. image:: /Images/PG_Calibration_Incorrect.gif
.. image:: ../Images/PG_Calibration_Incorrect.png
When you click **Continue**, the next student response appears for
you to grade, and you see a yellow **Calibration essay saved** message in
......@@ -288,7 +288,7 @@ student who submitted the response.
responses (usually 3). When you've graded enough responses, you
receive the following message.
.. image:: /Images/DoneGrading.gif
.. 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`.
......@@ -373,13 +373,13 @@ For *peer assessments* and *AI assessments*, you'll access your scores through t
For both AI and peer assessments, the score appears below your response
in an abbreviated version of the rubric.
.. image:: /Images/AIScoredResponse.gif
.. image:: ../Images/AIScoredResponse.png
For peer assessments, you can
also see the written feedback that your response received from different
graders.
.. image:: /Images/PeerScoredResponse.gif
.. image:: ../Images/PeerScoredResponse.png
If you want to see the full rubric for either an AI or peer assessment,
click **Toggle Full Rubric**.
......@@ -388,7 +388,7 @@ click **Toggle Full Rubric**.
problems to see your score, you receive a message that lets you know how
many problems you still need to grade.
.. image:: /Images/FeedbackNotAvailable.gif
.. image:: ../Images/FeedbackNotAvailable.png
For more information about grading peer assessments, see :ref:`ORA Peer Assessment`.
......
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