Skip to content

E
edx-platform
Commit a982eba1 by Toddi Norum
Options

QA checkpoint

parent 6bcd11fb
Showing with 315 additions and 206 deletions
userdocs/source/ChangeLog.rst 0 → 100644
**Change Log**
============== ============================================================
DATE CHANGE
============== ============================================================
5/6/2013 Universal change to UTC for all GMT references. Changed “Add Course Catalog Information” to show URL and note that on this page, the course author sees local time from browser. Changed “Invite Students to Register” to reflect new link.
4/18/13 “Create a Discussion” graphic change
4/9/13 Changed order of sections (moved “Create a Lesson in Studio” after “Create a New Course”) Added content to “Export or Import a Course,”Create Lesson,” “Create Schedule,” and Upload a File to the Files & Updates Page” sections Revised “Add an Announcement or Update” section
3/22/13 Revised “Add Manual Policy Data” section. Added “Appendix C: Time Zones”
============== ============================================================
userdocs/source/Images/image287.png
userdocs/source/Images/image287.png

346 KB | W: | H:

userdocs/source/Images/image287.png

62.4 KB | W: | H:

userdocs/source/Images/image287.png
userdocs/source/Images/image287.png
userdocs/source/Images/image287.png
userdocs/source/Images/image287.png
  • 2-up
  • Swipe
  • Onion skin
userdocs/source/add_syllabus.rst
......@@ -15,7 +15,7 @@ might include your syllabus or information about your grading policy.
When you create a static page, the name of that page appears in your course's
navigation bar at the top of the page, along with **Courseware**, **Course
Info**, and other tabs. For example, the following navigation bar includes a
**Syllabus** static page and a **Projects** static page.
**Syllabus** static page and a **Projects** static page.
.. image:: images/image157.png
......@@ -125,7 +125,7 @@ the code for the dynamic schedule template.
Course Handouts
===============
***************
Your course handouts are available on Edge from the **Course Handouts** sidebar
......@@ -171,7 +171,7 @@ course but change the dates in your handout, you can easily find the Word file
on the **Files Uploads** page.
Note that you should be careful when you name files that you add to the **>Files
Note that you should be careful when you name files that you add to the **Files
& Uploads** page. Because the file name becomes part of the URL, students can
see the name of the file when they open it. Avoid using file names such as
"AnswerKey.pdf."
......@@ -189,7 +189,7 @@ To upload a file to the **Files & Uploads** page:
Uploads**.
2. On the **>Files & Uploads ** page, click **Upload New File**.
2. On the **>Files & Uploads** page, click **Upload New File**.
.. image:: images/image162.png
......@@ -198,7 +198,7 @@ Uploads**.
3. In the **Upload New File** dialog box, click **Choose File**.
4. In the **Open **dialog box, locate the file that you want, and then click
4. In the **Open** dialog box, locate the file that you want, and then click
**Open**.
To add another file, click **Load Another File**. To close the dialog box, click
......@@ -264,14 +264,14 @@ Your Assets Tab**.
Add an Announcement or Update
=============================
*****************************
You can add announcements or updates to welcome students to the class,
remind students of exams, notify students of changes in the course schedule,
and call out important steps students need to keep in mind. These updates
appear on the **Course Info **tab on edX or Edge. Because your course
automatically opens to the **Course Info **page, students will see the
appear on the **Course Info** tab on edX or Edge. Because your course
automatically opens to the **Course Info** page, students will see the
update as soon as they sign in.
......
userdocs/source/appendices/a.rst
.. raw:: latex
\newpage %
========================================
APPENDIX A-Template For Course Overview
========================================
......
userdocs/source/appendices/b.rst
.. raw:: latex
\newpage %
===========================================
APPENDIX B: Code for Dynamic HTML Schedule
===========================================
......
userdocs/source/appendices/c.rst
.. raw:: latex
\newpage %
======================================
APPENDIX C: Sample Student Login Guide
======================================
Create a login guide for your individual course.
**STUDENT LOGIN GUIDE FOR [COURSE NUMBER]**
**STUDENT LOGIN GUIDE FOR [COURSE NUMBER]**
How to Set Up Your edX Account and Register for Your Class
Welcome to [COURSE NAME] on edX!
This guide will walk you through setting up your student account with edX, registering for [COURSE NAME], and accessing the course materials.
**Step 1: Open the course registration page**
*Example*
.. code-block:: html
https://edge.edx.org/courses/[YOUR_CLASS_PATH]/about [REPLACE WITH URL TO YOUR REGISTRATION PAGE ON EDGE]
https://edge.edx.org/courses/edX/PHOTO101/Digital_SLR_Photography_101/about
The above URL should bring you to the course registration page: [REPLACE WITH SCREENSHOT OF YOUR REGISTRATION PAGE]
*Example*
How to Set Up Your edX Account and Register for Your Class
.. image:: ../images/image302.png
:width: 600
Welcome to [COURSE NAME] on edX!
This guide will walk you through setting up your student account with edX, registering for [COURSE NAME], and accessing the course materials.
**Step 1: Open the course registration page**
Go to https://edge.edx.org/courses/[YOUR_CLASS_PATH]/about [REPLACE WITH URL TO YOUR REGISTRATION PAGE ON EDGE]
The above URL should bring you to the course registration page: [REPLACE WITH SCREENSHOT OF YOUR REGISTRATION PAGE]
**Step 2: Request to register for the course**
Click on the blue Register for [NUMBER OF YOUR CLASS] button:
[REPLACE WITH PART OF YOUR SCREENSHOT ABOVE]
.. image:: ../images/image303.png
:width: 600
**Step 2: Request to register for the course**
Click on the blue Register for [NUMBER OF YOUR CLASS] button:
[REPLACE WITH PART OF YOUR SCREENSHOT ABOVE]
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.)
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
:width: 600
**Step 3: Create your account with edX**
**Step 3: Create your account with edX**
Fill out the form in the pop-up window: (Some tips:  Use an email address you check regularly. Also, the username you choose will also be your screen name in the course. This means the only name we will know you by is the username (not a first and last name). Please include your last name as part of your username so we can tell who you are on the forums.)
Fill out the form in the pop-up window: (Some tips:  Use an email address you check regularly. Also, the username you choose will also be your screen name in the course. This means the only name we will know you by is the username (not a first and last name). Please include your last name as part of your username so we can tell who you are on the forums.)
**Step 4: Activate your edX account**
**Step 4: Activate your edX account**
Check your email. This is where your course activation link has been sent. You must click on this to finalize your access to the course.
Check your email. This is where your course activation link has been sent. You must click on this to finalize your access to the course.
Congratulations! You should now have an edX account and be registered for [ENTER YOUR COURSE NUMBER].
Congratulations! You should now have an edX account and be registered for [ENTER YOUR COURSE NUMBER].
Proceed with Step 5 to access the class materials.
Proceed with Step 5 to access the class materials.
**Step 5: Log in to edX and go the course website**
**Step 5: Log in to edX and go the course website**
Log in to your account on edX at https://edge.edx.org/
by using the username and password you just created.
You will be taken to the main landing page of your edX edge account, which should now include a listing for [ENTER YOUR COURSE NUMBER]: [REPLACE WITH SCREENSHOT OF YOUR COURSE]
Log in to your account on edX at https://edge.edx.org/
by using the username and password you just created.
You will be taken to the main landing page of your edX edge account, which should now include a listing for [ENTER YOUR COURSE NUMBER]: [REPLACE WITH SCREENSHOT OF YOUR COURSE]
You can now click **View Courseware** to enter the main course website.
You can now click **View Courseware** to enter the main course website.
If you are experiencing problems with registration or with accessing the class website, please contact [SUPPORT CONTACT NAME] at [CLASS SUPPORT EMAIL].
If you are experiencing problems with registration or with accessing the class website, please contact [SUPPORT CONTACT NAME] at [CLASS SUPPORT EMAIL].
userdocs/source/appendices/d.rst
.. raw:: latex
\newpage %
======================
APPENDIX D: Time Zones
======================
......
userdocs/source/appendices/e.rst
.. raw:: latex
\newpage %
==========================
APPENDIX E: Problem Types
==========================
......@@ -11,20 +16,14 @@ answer options, presented as a drop-down list.
Option Response is structurally similar to Multiple Choice. Some conceptual
differences between the two include the following.
• The Multiple Choice radio button format makes it easier for students to read
• very long response options.
* The Multiple Choice radio button format makes it easier for students to read very long response options.
• The Option Response drop-down input format makes it more likely for students
to think of an answer and then search for it, rather than relying purely on
recognition to answer the question. The Multiple Choice format is more explicit
and visual. This makes it a more appropriate choice for presenting tricky or
complicated answer options which are intended to get the student to pause and
think.
* The Option Response drop-down input format makes it more likely for students to think of an answer and then search for it, rather than relying purely on recognition to answer the question. The Multiple Choice format is more explicit and visual. This makes it a more appropriate choice for presenting tricky or complicated answer options which are intended to get the student to pause and think.
Sample Problem:
.. image:: ../images/image287.png
:width: 600
:width: 600
**Problem Code:**
......@@ -39,7 +38,7 @@ Sample Problem:
options="('Multiple Choice','String Response',
'Numerical Response','External Response',
'Image Response')"
correct="Multiple Choice"/>
correct="Multiple Choice"/>1
</optionresponse>
<solution>
......@@ -78,12 +77,17 @@ Sample Problem:
<optionresponse>
.. image:: ../images/option_response1.png
.. image:: ../images/option_response1.png
<optioninput>
.. image:: ../images/optionresponse2.png
.. image:: ../images/optionresponse2.png
.. raw:: latex
\newpage %
Multiple Choice
......@@ -100,16 +104,13 @@ marked as incorrect, there is no correct response.
Multiple Choice is structurally similar to Option Response. Some conceptual
differences between the two include the following.
• The Multiple Choice radio button format makes it easier for students to read
• very long response options.
• The Multiple Choice radio button format makes it easier for students to read very long response options.
• The Option Response drop-down input format makes it more likely for students
• to think of an answer and then search for it, rather than relying purely on
• recognition to answer the question.
• The Option Response drop-down input format makes it more likely for students to think of an answer and then search for it, rather than relying purely on recognition to answer the question.
• The Multiple Choice format is more explicit and visual. This makes it a more
appropriate choice for presenting tricky or complicated answer options which are
intended to get the student to pause and think. Sample Problem:
• The Multiple Choice format is more explicit and visual. This makes it a more appropriate choice for presenting tricky or complicated answer options which areintended to get the student to pause and think.
Sample Problem:
.. image:: ../images/image289.png
:width: 600
......@@ -173,12 +174,17 @@ intended to get the student to pause and think. Sample Problem:
<choicegroup>
.. image:: ../images/multipleresponse2.png
.. image:: ../images/multipleresponse2.png
<choice>
.. image:: ../images/multipleresponse3.png
.. image:: ../images/multipleresponse3.png
.. raw:: latex
\newpage %
Checkbox
......@@ -235,6 +241,10 @@ Sample Problem:
</choiceresponse>
</problem>
.. raw:: latex
\newpage %
String Response
===============
......@@ -293,12 +303,16 @@ Sample Problem:
<stringresponse>
.. image:: ../images/stringresponse.png
.. image:: ../images/stringresponse.png
<textline>
.. image:: ../images/stringresponse2.png
.. image:: ../images/stringresponse2.png
.. raw:: latex
\newpage %
Numerical Response
......@@ -469,20 +483,25 @@ XML Attribute Information
<script>
.. image:: ../images/numericalresponse.png
.. image:: ../images/numericalresponse.png
<numericalresponse>
.. image:: ../images/numericalresponse2.png
.. image:: ../images/numericalresponse2.png
<responseparam>
.. image:: ../images/numericalresponse4.png
.. image:: ../images/numericalresponse4.png
<textline>
.. image:: ../images/numericalresponse5.png
.. image:: ../images/numericalresponse5.png
.. raw:: latex
\newpage %
......@@ -573,18 +592,23 @@ XML Attribute Information
<script>
.. image:: ../images/formularesponse.png
.. image:: ../images/formularesponse.png
<formularesponse>
.. image:: ../images/formularesponse3.png
.. image:: ../images/formularesponse3.png
<responseparam>
.. image:: ../images/formularesponse6.png
.. image:: ../images/formularesponse6.png
.. raw:: latex
\newpage %
Image Response
......@@ -626,11 +650,15 @@ XML Attribute Information
<imageresponse>
.. image:: ../images/imageresponse1.png
.. image:: ../images/imageresponse1.png
<imageinput>
.. image:: ../images/imageresponse2.png
.. image:: ../images/imageresponse2.png
.. raw:: latex
\newpage %
Custom Response
......@@ -755,6 +783,11 @@ Sample Problem:
</solution>
</problem>
.. raw:: latex
\newpage %
Chemical Equation Response
==========================
......@@ -792,6 +825,11 @@ Sample Problem:
<endouttext/>
</problem>
h
.. raw:: latex
\newpage %
Schematic Response
==================
......
userdocs/source/checking_student_progress.rst
......@@ -51,10 +51,13 @@ down view of the example Progress page for the student in the example above:
Again, note that point scores from graded sections are called "Problem
Scores", while point scores from ungraded sections are called "Practice
Scores".
.. raw:: latex
\newpage %
Checking Progress of Students as an Instructor
==============================================
**********************************************
To check the progress of the student through the course, visit the
......@@ -83,10 +86,14 @@ the weight of a live problem was changed during an assignment, and not
everyone has yet resubmitted their answers for that problem.) Scores and grades
are usually recomputed at the end of the semester before determining final
grades and issuing Certificates.*
.. raw:: latex
\newpage %
Assigning Final Grades and Issuing Certificates
===============================================
***********************************************
The final grades of a student in the course and the grading
rubric you have set are used to determine whether the student has earned a
......
userdocs/source/create_discussion.rst
......@@ -72,12 +72,17 @@ category and subcategory appear as follow in the category list in the discussion
forum:
.. image:: images/image065.png
:width: 300
9. In the **display_name** box, type a name for the discussion. The display name
appears when a student hovers the mouse over the ribbon.
10. Click **Save.**
.. raw:: latex
\newpage %
Seed a Discussion Space in Your Course
**************************************
......
userdocs/source/create_html_component.rst
......@@ -21,6 +21,9 @@ Note Studio processes the HTML code entered when saving it and before rendering
it. Make sure that the component you created looks the way you expect live if
you go back and forth between Visual and HTML view.
.. raw:: latex
\newpage %
Create a Basic HTML Component
*****************************
......@@ -40,12 +43,14 @@ following blank component appears.
3. Enter the information that you want, and then click **Save.**
*Note If you want to enter links to other pages or to images or to edit the
*Note: If you want to enter links to other pages or to images or to edit the
HTML directly, switch to the HTML tab.*
**To create a basic HTML component that includes a template you can use:**
.. raw:: latex
\newpage %
**To create a basic HTML component that includes a template you can use:**
1. Under **Add New Component,** click **html** and then click **Announcement.**
......@@ -66,6 +71,11 @@ HTML directly, switch to the HTML tab.*
3. Click **Save.**
.. raw:: latex
\newpage %
Create Links
************
......@@ -194,19 +204,22 @@ component appears.
7. Next to the number 1, type the following. Replace relative course directory,
location id of unit, and link text with your information. ::
<a href = "[[relative course directory]]/jump_to/[[location id of
<unit]]">[link text]</a>
Forexample,alinktothe“CreatinganHTMLComponent”unitinedx101resemblesthefollowing
.::
For example, a link to the “Creating an HTML Component” unit in edx101
resembles the following ::
<a href = "courses/edX/edX101/How_to_Create_an_edX_Course/jump_to/i4x://edX/ed
<X101/vertical/8713e94afd074e40991dcb675d1030b5">Creating an HTML
<Component</a>
.. raw:: latex
\newpage %
Import from LaTeX
*****************
......
userdocs/source/establish_course_settings.rst
......@@ -39,6 +39,11 @@ Add Collaborators
3. In the **email** box, type the mail address of the user, and then click **Add User**.
.. raw:: latex
\newpage %
Add Manual Policy Data
......@@ -70,6 +75,11 @@ Add Manual Policy Data
4. In the **Policy Value** box, enter the value of the policy.
.. raw:: latex
\newpage %
Add Course Catalog Information
......@@ -200,4 +210,4 @@ Add Weekly Time Requirements Information
2. Scroll down to the **Requirments** section.
3. In the **Hours of Effort per Week** box, enter the number of hours you expect students to work on this course each week.
3. In the **Hours of Effort per Week** box, enter the number of hours you expect students to work on this course each week.
\ No newline at end of file
userdocs/source/establish_grading_policy.rst
***************************
Establish a Grading Policy
***************************
......@@ -141,6 +140,11 @@ In the **Weight of Total Grade** field, omit the % sign. Be sure that your **Wei
.. _Create-Graded-Subsections:
.. raw:: latex
\newpage %
Create Subsections Containing Graded Assignments
**************************************************
......
userdocs/source/export_import_course deleted 100644 → 0
*************************
Export or Import a Course
*************************
Studio has an Import tool and an Export tool that allow you to import and
export courses.
Export a Course
***************
You can export a course that has been created in Studio. You can export a
course for use by another instructor, or you can back up your course.
For example, you may create a course in Studio, and then run that course. A
friend or colleague, including a friend from another institution, may be
interested in running their own customized version of that course. You can
export the course that you have created and give it to the other instructor.
That instructor can then import the course, make any changes that are
necessary to reflect that instructor's situation, and then release the
course to students.
Or, you may export your course, and then make changes to your course in
Studio. If you later want to revert to the earlier version of your course,
you can import the version that you exported. Be careful if you do this
while you are running your course, as you could lose your students' work.
When you export your course, Studio creates a **.tar.gz** file that includes
the following course data:
1. Course structure (the order of sections and subsections)
2. Individual units
3. Individual problems
4. Additional pages
5. Files on the Files & Uploads page
The exported file does not include the following data:
1. Student or user data
2. Discussion forum data
3. Course settings
4. Certificates
5. Grading information
Import a Course
***************
*Note: This feature should be used with caution!
Importing a new course will delete all course content currently associated with
your course and replace it with the contents of the uploaded file.
**Importing a course cannot be undone.*
You can import courses that have already been created in Studio. These can
be courses that you or someone else has created and exported.
The file that you import must be a **.tar.gz** file that contains, at a
minimum, a Course.xml file in a course data directory. The tar.gz file must
have the same name as the course data directory.
If your course uses legacy layout structures, you may not be able to edit
the course in Studio, although it will probably appear correctly on Edge. To
make sure that your course is completely editable, ensure that all of your
material is embedded in a unit.
To import a course:
1. On the navigation bar, click **Tools**, and then click **Import**.
.. image:: images/image243.png
2. Under **Course to Import**, click **Choose File**.
3. Locate the file that you want, and then click **Open**.
userdocs/source/export_import_course.rst
......@@ -5,6 +5,10 @@ Export or Import a Course
Studio has an Import tool and an Export tool that allow you to import and
export courses.
.. raw:: latex
\newpage %
Export a Course
***************
......@@ -64,6 +68,11 @@ The exported file does not include the following data:
5. Grading information
.. raw:: latex
\newpage %
Import a Course
......
userdocs/source/index.rst
......@@ -42,7 +42,7 @@ Appendices
==========
.. toctree::
:maxdepth: 2
:maxdepth: 3
:glob:
appendices/*
......
userdocs/source/modify_published_content.rst
......@@ -12,11 +12,12 @@ create a draft. The draft does not appear on edX or Edge. However, the draft
does appear when you view your content in Preview mode.
To create a draft, open the Unit that you want. Note that no **Edit **button
To create a draft, open the Unit that you want. Note that no **Edit** button
appears on the page for that Unit, and you cannot make changes to the Unit.
.. image:: images/image231.png
:width: 600
In the right pane, click the blue **edit a draft** link in the **Unit
......@@ -24,6 +25,7 @@ Settings** box.
.. image:: images/image233.png
:width: 600
After you click **edit a draft**, you can make changes to the Unit. You can
......@@ -31,6 +33,7 @@ edit existing content or add new content.
.. image:: images/image235.png
:width: 600
If you want to view the version of your content that is currently live,
......@@ -39,6 +42,7 @@ the page.
.. image:: images/image237.png
:width: 600
If you want to view the draft version that you are working on, click
......@@ -47,6 +51,7 @@ mode.****
.. image:: images/image239.png
:width: 600
When you are done making changes to the Unit, click the blue **replace it
......@@ -54,3 +59,4 @@ with this draft** link under **Unit Settings**.
.. image:: images/image241.png
:width: 600
userdocs/source/view_course_content.rst
......@@ -54,7 +54,6 @@ still creating it:
* In Studio
Note that the way your course looks in Studio is
not the way it looks to students on edX or Edge.
......@@ -70,7 +69,11 @@ still creating it:
the top of the screen.
* On edX or Edge as a Studeny
* On edX or Edge as a Student
.. raw:: latex
\newpage %
Outline View
......@@ -83,6 +86,11 @@ see the "macro" outline of your course, down to individual Units.
.. image:: images/image193.png
.. raw:: latex
\newpage %
Subsection View
===============
......@@ -96,6 +104,11 @@ are set to Public or Private. Private Units appear in light gray text with
.. image:: images/image195.png
.. raw:: latex
\newpage %
Unit View
=========
......@@ -144,6 +157,12 @@ Private Unit
.. image:: images/image203.png
.. raw:: latex
\newpage %
Preview Mode
============
......@@ -215,8 +234,8 @@ When you click Unit 2 in the course ribbon, you see the content in Unit 2:
When you view your course on edX or Edge as an instructor:
· You see all the Units of your course that you have set to Public.
· Release dates do not matter.
* You see all the Units of your course that you have set to Public.
* Release dates do not matter.
You do not see Units that are set to Private.
......@@ -279,9 +298,9 @@ see material that meets all three publishing conditions:
The course start date has passed.
· The release dates for the Section and Subsection have passed.
* The release dates for the Section and Subsection have passed.
· The Unit that contains the material is set to Public.
* The Unit that contains the material is set to Public.
You can use this view to make sure that material does not appear in your
......
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