Commit 05d02e5a by Alison Hodges

Merge pull request #3188 from edx/ahodges/documentation/UTF8

Ahodges/documentation/utf8
parents 5b305476 92de6ddd
......@@ -10,6 +10,8 @@ Change Log
* - Date
- Change
* - 4/7/14
- Expanded the :ref:`Course Data`, :ref:`Enrollment`, and :ref:`Course_Staffing` sections.
* - 04/03/14
- Updated the :ref:`Adding Pages to a Course` chapter to reflect ability to
:ref:`Show or Hide the Course Wiki Page`.
......
......@@ -4,7 +4,8 @@
Course Data
############################
After you create a course, you can access information about it from the Instructor Dashboard. You can find:
After you create a course, you can access information about it from the
Instructor Dashboard. You can find:
* Identifying information for the course.
......@@ -12,6 +13,10 @@ After you create a course, you can access information about it from the Instruct
* The defined grade cutoff for passing or failing.
*************************************************
Review Course Data
*************************************************
To view course data:
#. View the live version of your course.
......@@ -20,7 +25,54 @@ To view course data:
#. Click **Course Info** if necessary.
The Basic Course Information section of the page that opens lists information for the course.
The **Basic Course Information** section of the page that opens lists
information about the course.
.. image:: ../Images/Instructor_Dash_Course_Info.png
:alt: The basic course information section of the Instructor Dashboard
*************************************************
Sources in Studio of the Basic Course Information
*************************************************
The course data that displays on the Instructor Dashboard is defined in
Studio, or derived from data that you define in Studio.
* **Organization**: Specified in Studio when you create the course. Becomes
part of the course URL, and cannot be changed.
* **Course Number**: Specified in Studio when you create the course. Becomes
part of the course URL, and cannot be changed.
* **Course Name**: Specified in Studio when you create the course. Becomes
part of the course URL, and cannot be changed. In Studio, this field is
labeled **Course Run**.
* **Course Display Name**: Specified in Studio when you create the course. In
Studio, this field is labeled **Course Name**.
This name can be changed in Studio (not recommended if your course is live):
select **Settings** > **Advanced Settings** and scroll down to the policy key
labeled **display_name**. This setting changes the **Course Display Name** in the LMS only.
The illustration that follows shows the information collected by Studio for
a new course side-by-side with the same information in the **Basic Course
Information** section of the Instructor Dashboard.
.. image:: ../Images/Course_Info_Comparison.png
:alt: The Course Name in Studio and the Course Display Name in the LMS are boxed; the Course Run in Studio and the Course Name in the LMS are circled
:width: 800
* **Has the course started**: Derived from the **Course Start Date** and the
current date. This date can be changed in Studio (not recommended if your
course is live): select **Settings** > **Schedule & Details**.
* **Has the course ended**: Derived from the **Course End Date** and the
current date. This date can be changed in Studio (not recommended if your
course is live): select **Settings** > **Schedule & Details**.
.. You also use the Instructor Dashboard to set up the staff for your course, enroll students and access student data, and initiate, review, and adjust grades.
* **Grade Cutoffs**: Specified in Studio when you define the cutoff for a
failing grade. Students who earn exactly the cutoff value pass the course.
Grading can be changed in Studio (not recommended if your course is live):
select **Settings** > **Grading**.
......@@ -4,9 +4,14 @@
Enrollment
##########################
Course authors and instructors can enroll students in a course, see how many people are enrolled, and, when necessary, unenroll students.
Course authors and instructors can enroll students in a course, see how many
people are enrolled, and, when necessary, unenroll students.
Students can enroll themselves in a course during its defined enrollment period. For a ``www.edx.org`` course, enrollment is publicly available to anyone who registers an edX account. For other courses, such as those on ``edge.edx.org``, enrollment is limited to the students that you explicitly enroll and the students to whom you give the course URL.
Students can enroll themselves in a course during its defined enrollment
period. For a ``www.edx.org`` course, enrollment is publicly available to
anyone who registers an edX account. For other courses, such as those on
``edge.edx.org``, enrollment is limited to students who know the course URL
and students you explicitly enroll.
* :ref:`registration_enrollment`
......@@ -22,17 +27,25 @@ Students can enroll themselves in a course during its defined enrollment period.
Registration and Enrollment
*********************************
Before a student can be enrolled in a course, he or she must:
Before a student can enroll in a course, he or she must:
#. Register a user account, which includes supplying a valid email address, on ``www.edx.org``, ``edge.edx.org``, or your implementation of the edX platform.
#. Register a user account, which includes supplying a valid email address, on
``www.edx.org``, ``edge.edx.org``, or your implementation of the edX
platform. Each platform requires a separate user account.
#. 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 :ref:`Sample Student Login Guide`.
As long as the course **Enrollment End Date** has not passed, students who
have registered and activated user accounts can enroll themselves in
``www.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.
Course authors and instructors can enroll students in a course either before
or after the students register their user accounts.
To work on a course, all course staff members must also be registered and enrolled.
To work on a course, all course staff members must also have registered and
activated user accounts and be enrolled in the course.
.. _enroll_student:
......@@ -40,18 +53,33 @@ To work on a course, all course staff members must also be registered and enroll
Enroll Students in a Course
*********************************
You enroll students, and other course staff members, in your course by supplying their email addresses. After the **Enrollment End Date** for a course students can no longer enroll themselves; however, you can still explicitly enroll students.
You enroll students, and other course staff members, in your course by
supplying their email addresses. After the **Enrollment End Date** for a
course students can no longer enroll themselves; however, you can still
explicitly enroll students.
When you enroll students, you have options to:
When you enroll people in a course you have these options:
* **Auto Enroll**. Enrolls any student who already has a registered user account in the course immediately. Students who are not registered are enrolled as soon as they register and activate a user account for the same email address. As a result, students do not need to complete the explicit course enrollment step.
* **Auto Enroll**. When you choose this option, the people who you enroll do
not need to complete an explicit course enrollment step. Of the list of
email addresses that you supply, those that correspond to a registered user
account are immediately enrolled in the course. Email addresses on the list
that do not match a registered user account are enrolled as soon as the
account is registered and activated.
* **Notify students by email**. The email message includes the name of the course, a link to the registration page, and a reminder to use the same email address to register that you supplied for the student. Whether you choose to send a notification or not, enrolled students see your course on their dashboard when they log in.
* **Notify students by email**. When you choose this option, an email message
is automatically sent to each of the email addresses that you supply. The
message includes the name of the course, a link to the registration page,
and a reminder to use that same email address to register. Whether you
choose to send a notification or not, enrolled students see your course on
their dashboards when they log in.
An example of the email message that students receive when you select this option follows.
An example of the email message that enrollees receive when you select this
option follows.
.. image:: ../Images/Course_Enrollment_Email.png
:alt: Email message inviting a student to enroll in the EdX 101 course
:width: 800
To enroll students or staff members:
......@@ -61,11 +89,15 @@ To enroll students or staff members:
#. Click **Membership**.
#. In the Batch Enrollment section of the page, enter an email address or multiple addresses separated by commas or line feeds.
#. In the **Batch Enrollment** section of the page, enter an email address or
multiple addresses separated by commas or line feeds.
You can copy and paste data from a CSV file of email addresses. However, note that this feature is better suited to courses with smaller enrollments, rather than courses with massive enrollments.
You can copy and paste data from a CSV file of email addresses. However,
note that this feature is better suited to courses with smaller enrollments,
rather than courses with massive enrollments.
5. Optionally, select **Auto Enroll** to streamline the course enrollment process for the students.
5. Optionally, select **Auto Enroll** to streamline the course enrollment
process for the students.
#. Optionally, select **Notify students by email** to send students email.
......@@ -77,13 +109,19 @@ To enroll students or staff members:
View an Enrollment Count
***************************
After you create a course, you can access the total number of people who are enrolled in it. When you view an enrollment count, note that:
After you create a course, you can access the total number of people who are
enrolled in it. When you view an enrollment count, note that:
* In addition to students, the enrollment count includes the course author, course team members, instructors, and course staff. (In order to work with a course in Studio or the LMS, you must be enrolled in it.)
* In addition to students, the enrollment count includes the course author,
course team members, instructors, and course staff. (To work with a
course in Studio or the LMS, you must be enrolled in that course.)
* Students can unenroll from courses, and course authors and instructors can unenroll students when necessary.
* Students can unenroll from courses, and course authors and instructors can
unenroll students when necessary.
**Note**: The enrollment count displays the number of currently enrolled students and course team staff. It is not a historical count of everyone who has ever enrolled in the course.
**Note**: The enrollment count displays the number of currently enrolled
students and course team staff. It is not a historical count of everyone who
has ever enrolled in the course.
To view the enrollment count for a course:
......@@ -93,27 +131,37 @@ To view the enrollment count for a course:
#. Click **Course Info** if necessary.
The Enrollment Information section of the page that opens shows the total number of people who are currently enrolled.
The **Enrollment Information** section of the page that opens shows the total
number of people who are currently enrolled.
You can also view or download a list of the people who are enrolled in the course. See :ref:`Student Data`.
You can also view or download a list of the people who are enrolled in the
course. See :ref:`Student Data`.
.. _unenroll_student:
*********************************
Unenroll students from a course
Unenroll Students from a Course
*********************************
You can remove students from a course by unenrolling them. To prevent students from re-enrolling, course enrollment must also be closed. You use Studio to set the **Enrollment End Date** for the course to a date in the past. See :ref:`Set Important Dates for Your Course`.
You can remove students from a course by unenrolling them. To prevent students
from re-enrolling, course enrollment must also be closed. You use Studio to
set the **Enrollment End Date** for the course to a date in the past. See
:ref:`Set Important Dates for Your Course`.
To unenroll students, you supply the email addresses of enrolled students.
**Note**: Unenrollment does not delete data for a student. An unenrolled
student's state remains in the database and is reinstated if the student does
re-enroll.
**Note**: Unenrollment does not delete data for a student. An unenrolled student's state remains in the database and is reinstated if the student does re-enroll.
To unenroll students, you supply the email addresses of enrolled students.
#. View the live version of your course.
#. Click **Membership**.
#. In the Batch Enrollment section of the page, enter an email address or multiple addresses separated by commas or line feeds.
#. In the **Batch Enrollment** section of the page, enter an email address or
multiple addresses separated by commas or line feeds.
#. Click **Unenroll**. The course is no longer listed on the students' dashboards, and the students can no longer contribute to discussions or the wiki or access the courseware.
#. Click **Unenroll**. The course is no longer listed on the students'
dashboards, and the students can no longer contribute to discussions or the
wiki or access the courseware.
......@@ -296,11 +296,11 @@ Entries are sorted by the value in each column, starting with the ModuleID on th
Please note the following about the student answer distribution report:
* This report includes only problems that at least one student has answered since early March 2014. For those problems, this report only includes activity that occurred after October 2013.
* This report includes only problems that at least one student has answered since 6 March 2014. For those problems, this report only includes activity that occurred after October 2013.
* For checkboxes and multiple choice problems, the answer choices actually selected by a student after early March 2014 display as described above. Answer choices selected by at least one student after October 2013, but not selected since early March 2014, are included on the report but do not include an **AnswerValue**. The **ValueID** does display the internal identifiers, such as choice_1 and choice_2, for those answers.
* For checkboxes and multiple choice problems, the answer choices actually selected by a student after 6 March 2014 display as described above. Answer choices selected by at least one student after October 2013, but not selected since 6 March 2014, are included on the report but do not include an **AnswerValue**. The **ValueID** does display the internal identifiers, such as choice_1 and choice_2, for those answers.
* For problems that use the **Randomization** setting in Studio, if a particular answer has not been selected since early March 2014, the **Question** is blank for that answer.
* For problems that use the **Randomization** setting in Studio, if a particular answer has not been selected since 6 March 2014, the **Question** is blank for that answer.
* Problem **Count** values reflect the entire problem history. If you change a problem after it is released, it may not be possible for you to determine which answers were given before and after you made the change.
......
......@@ -4,25 +4,35 @@
Staffing
##########################
You can designate a team of people to help you run your course. Two roles are available to give your team members access to different options for working with students, grades, and other course staff.
You can designate a team of people to help you run your course. Two roles are
available to give your administrative team members access to different options
for working with students, grades, and other members of the staff.
* Staff members
* Course Staff
* Instructors
.. **Question**: how does this team, set up on the Instructor Dashboard, differ from the "Course Team Members" that you add in Studio (Settings > Course Team)?
You can also designate people to help you beta test a course and to moderate and manage discussions. Beta testers and discussion administrators must be enrolled in your course, but you do not need to give them a staff role. For more information, see :ref:`Assigning_discussion_roles`.
The administrative team that helps you run your course in the LMS can include
some, all, or none of the people who help you set up the course in Studio. You
assign these administrative roles in the LMS, separately from the roles you
assign in Studio. For more information on setting up a team in Studio, see
:ref:`Add Course Team Members`.
.. insert ":ref:`Beta_Testing` and " above after "see"
You can also designate teams of people to beta test your course and to
moderate and manage its discussions by assigning other LMS roles. The beta
testers and discussion administrators must be enrolled in your course, but
they do not need to have the Course Staff or Instructors role or a Studio
role. For more information, see :ref:`Beta_Testing` and
:ref:`Assigning_discussion_roles`.
You use these roles to define the team that helps you run your course. To help you develop a course in Studio, you set up a team in Studio. For more information, see :ref:`Add Course Team Members`.
****************************
Administrative Team Roles
****************************
**********************
Staff roles
**********************
To provide access to features on the LMS Instructor Dashboard you assign the Course Staff role or the Instructor role.
To provide access to features on the LMS Instructor Dashboard you assign the
Course Staff role or the Instructors role.
**Course Staff** can:
......@@ -40,25 +50,27 @@ To provide access to features on the LMS Instructor Dashboard you assign the Cou
**Instructors** have access to all of the same options for running the course as the course staff. They can also:
* Add and remove course staff.
* Add and remove Course Staff.
* Add and remove other instructors.
* Add and remove other Instructors.
* Add and remove beta testers.
* Add and remove Beta Testers.
* Add and remove discussion forum admins, moderators, and community TAs.
* Add and remove Discussion Admins, Discussion Moderators, and Discussion
Community TAs.
.. 12 Feb 14 Sarina: This all sounds right but there are other tasks (rescoring, etc) not mentioned. Probably worth nailing down what tasks can and cannot be done by a course staff.
**********************
Assign staff roles
Assign Staff Roles
**********************
Before you can assign the course staff or instructor role to a team member:
Before you can assign the Course Staff or Instructors role to a team member:
* You need the email address or username of each team member.
* Each team member must register a user account for that email address/username and enroll in your course.
* Each team member must register a user account for that email
address/username, activate the account, and enroll in your course.
To assign a staff role:
......@@ -68,9 +80,12 @@ To assign a staff role:
#. Click **Membership**.
#. In the Administration List Management section, use the drop-down list to select **Course Staff** or **Instructors**.
#. In the **Administration List Management** section, use the drop-down list to
select **Course Staff** or **Instructors**.
#. Under the list of users who currently have that role, enter an email address or username and click **Add** for the role type.
#. Under the list of users who currently have that role, enter an email
address or username and click **Add** for the role type.
To remove an assigned role, view the list of users and then click **Revoke access**.
To remove an assigned role, view the list of users and then click **Revoke
access**.
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