Skip to content

E
edx-platform
Commit 6ee5eb2e by Julian Arni
Options

Cherry-pick and fix Toddi's commit. 

  Which was giving git endless confusion on merge.
parent 21fcdc7f
Showing with 235 additions and 170 deletions
docs/course_authors/source/ChangeLog.rst deleted 100644 → 0
**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”
============== ============================================================
docs/course_authors/source/add_syllabus.rst
...@@ -134,8 +134,9 @@ upload the file to the **>Files & Uploads** page. When you do this, a URL is ...@@ -134,8 +134,9 @@ upload the file to the **>Files & Uploads** page. When you do this, a URL is
created for that file. You then use this URL to create a link to the file on the created for that file. You then use this URL to create a link to the file on the
**Handouts** sidebar. You create this link on the **Course Updates** page. **Handouts** sidebar. You create this link on the **Course Updates** page.
.. note::
*Note: You cannot upload videos to the Files & Uploads page.
You cannot upload videos to the Files & Uploads page.
Upload a File to the Files & Uploads page Upload a File to the Files & Uploads page
...@@ -177,9 +178,11 @@ see the name of the file when they open it. Avoid using file names such as ...@@ -177,9 +178,11 @@ see the name of the file when they open it. Avoid using file names such as
"AnswerKey.pdf." "AnswerKey.pdf."
**Warning** Uploading a file with the same name as a file that is already .. warning::
uploaded will cause the original file to be overwritten. There is not currently
a warning when you try to upload a file that has the same name. Uploading a file with the same name as a file that is already
uploaded will cause the original file to be overwritten. There is not currently
a warning when you try to upload a file that has the same name.
To upload a file to the **Files & Uploads** page: To upload a file to the **Files & Uploads** page:
...@@ -215,9 +218,11 @@ hyperlink. ...@@ -215,9 +218,11 @@ hyperlink.
.. image:: images/image164.png .. image:: images/image164.png
*Note: Currently, you cannot delete a file after you upload it to the **Files & .. note::
Uploads** page. You can replace a file by uploading another file with the same
name, but you cannot delete the file. Currently, you cannot delete a file after you upload it to the **Files &
Uploads** page. You can replace a file by uploading another file with the same
name, but you cannot delete the file.
...@@ -240,7 +245,7 @@ image:: images/image166.png ...@@ -240,7 +245,7 @@ image:: images/image166.png
3. In the XML box that appears, create links to your files. 3. In the XML box that appears, create links to your files.
o To create a link to a document, enter the following syntax, where URL OF FILE * To create a link to a document, enter the following syntax, where URL OF FILE
is the URL that you noted in step 5 of **Upload a File** on the **Files & is the URL that you noted in step 5 of **Upload a File** on the **Files &
Uploads Page** and LINK TEXT is the text that you want to appear in the Uploads Page** and LINK TEXT is the text that you want to appear in the
**Handouts** sidebar. **Handouts** sidebar.
...@@ -250,8 +255,8 @@ Uploads Page** and LINK TEXT is the text that you want to appear in the ...@@ -250,8 +255,8 @@ Uploads Page** and LINK TEXT is the text that you want to appear in the
<p><a href="[URL OF FILE]">[LINK TEXT]</a></p> <p><a href="[URL OF FILE]">[LINK TEXT]</a></p>
o To create a link to an image that you've uploaded, enter the following syntax, * To create a link to an image that you've uploaded, enter the following syntax,
where URL OF FILE is the URL that you noted in step 5 of **Upload a File to where URL OF FILE is the URL that you noted in step 5 of **Upload a File to
Your Assets Tab**. Your Assets Tab**.
.. code-block:: html .. code-block:: html
......
docs/course_authors/source/change_log.rst 0 → 100644
**********
Change Log
**********
============== ================================================================
DATE CHANGE
============== ================================================================
7/1/2013 Online help and pdf files finalized in Sphinx 1.2b1
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”
============== ================================================================
docs/course_authors/source/checking_student_progress.rst
...@@ -72,20 +72,25 @@ the Grades page of the Instructor dashboard for edX101: ...@@ -72,20 +72,25 @@ the Grades page of the Instructor dashboard for edX101:
Here you see several options for viewing or downloading student grades, Here you see several options for viewing or downloading student grades,
viewing individual progress through a course or resetting problem attempts. viewing individual progress through a course or resetting problem attempts.
(Note: only the top part of the Grades page is shown. The page continues
with some more information about course statistics.) The link to the .. note::
student's progress page should give you a view of exactly what the student
would see, including scores for graded and ungraded assignments. Only the top part of the Grades page is shown. The page continues
with some more information about course statistics. The link to the
student's progress page should give you a view of exactly what the student
*Note: The stored scores visible to you on the Instructor tab and to would see, including scores for graded and ungraded assignments.
the students from the Progress tab in the course on Edge are a snapshot of the
current state of the problem score database. They may be slightly out of
sync with actual problem scores. (Asynchronicities may happen if, for example, .. note::
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 The stored scores visible to you on the Instructor tab and to
are usually recomputed at the end of the semester before determining final the students from the Progress tab in the course on Edge are a snapshot of the
grades and issuing Certificates.* current state of the problem score database. They may be slightly out of
sync with actual problem scores. (Asynchronicities may happen if, for example,
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 .. raw:: latex
......
docs/course_authors/source/create_discussion.rst
...@@ -55,7 +55,9 @@ but you will not change the text in the large box. ...@@ -55,7 +55,9 @@ but you will not change the text in the large box.
.. image:: images/image063.png .. image:: images/image063.png
*Note: In the future, these boxes may be filled in for you with a default value.* .. note::
In the future, these boxes may be filled in for you with a default value.
7. In the **discussion_category** box, type the name of the category that you 7. In the **discussion_category** box, type the name of the category that you
want to create for the discussion. You can include spaces. want to create for the discussion. You can include spaces.
...@@ -63,8 +65,9 @@ want to create for the discussion. You can include spaces. ...@@ -63,8 +65,9 @@ want to create for the discussion. You can include spaces.
8. In the **discussion_target** box, type the name of the subcategory that you 8. In the **discussion_target** box, type the name of the subcategory that you
want to create for the discussion. You can include spaces. want to create for the discussion. You can include spaces.
*Note: The category and subcategory names only appear in the discussion forum for .. note::
*your course. They do not appear in the discussion space inside the Unit.* The category and subcategory names only appear in the discussion forum for
your course. They do not appear in the discussion space inside the Unit.
For example, if you set **discussion_category** to be “The Discussion Component” For example, if you set **discussion_category** to be “The Discussion Component”
and you set **discussion_target** to be “Online Instruction Methods,” the and you set **discussion_target** to be “Online Instruction Methods,” the
......
docs/course_authors/source/create_html_component.rst
...@@ -5,7 +5,6 @@ Create an HTML Component ...@@ -5,7 +5,6 @@ Create an HTML Component
.. image:: images/image067.png .. image:: images/image067.png
The HTML component is the most basic component type. These components are the The HTML component is the most basic component type. These components are the
building blocks of text-based courses. They are used to add information such as building blocks of text-based courses. They are used to add information such as
text, lists, links, and images to units. For example, you can use these text, lists, links, and images to units. For example, you can use these
...@@ -17,9 +16,11 @@ Visual view offers you a “what you see is what you get” (WYSIWYG) editor for ...@@ -17,9 +16,11 @@ Visual view offers you a “what you see is what you get” (WYSIWYG) editor for
editing a pre-formatted version of the text. HTML view gives you a text editor editing a pre-formatted version of the text. HTML view gives you a text editor
in which you can edit HTML code directly. in which you can edit HTML code directly.
Note Studio processes the HTML code entered when saving it and before rendering .. note::
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. 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 .. raw:: latex
...@@ -33,18 +34,18 @@ Create a Basic HTML Component ...@@ -33,18 +34,18 @@ Create a Basic HTML Component
1. Under Add New Component, click **html**, and then click **Empty.** The 1. Under Add New Component, click **html**, and then click **Empty.** The
following blank component appears. following blank component appears.
.. image:: images/image069.png .. image:: images/image069.png
2. In the blank component, click **Edit.** The HTML editor opens. 2. In the blank component, click **Edit.** The HTML editor opens.
.. image:: images/image071.png .. image:: images/image071.png
3. Enter the information that you want, and then click **Save.** 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::
HTML directly, switch to the HTML tab.*
If you want to enter links to other pages or to images or to edit the
HTML directly, switch to the HTML tab.
.. raw:: latex .. raw:: latex
...@@ -52,9 +53,8 @@ HTML directly, switch to the HTML tab.* ...@@ -52,9 +53,8 @@ HTML directly, switch to the HTML tab.*
**To create a basic HTML component that includes a template you can use:** **To create a basic HTML component that includes a template you can use:**
1. Under **Add New Component,** click **html** and then click **Announcement.** 1. Under **Add New Component,** click **html** and then click **Announcement.**
The following screen opens.
The following screen opens.
.. image:: images/image073.png .. image:: images/image073.png
...@@ -63,24 +63,24 @@ HTML directly, switch to the HTML tab.* ...@@ -63,24 +63,24 @@ HTML directly, switch to the HTML tab.*
The text editor opens in Visual view. Replace the template text with your The text editor opens in Visual view. Replace the template text with your
announcement text. announcement text.
*Note If you want to enter links to other pages or to images or to edit the .. note::
HTML directly, switch to the HTML tab.*
If you want to enter links to other pages or to images or to edit the
HTML directly, switch to the HTML tab.
.. image:: images/image075.png .. image:: images/image075.png
3. Click **Save.** 3. Click **Save.**
.. raw:: latex .. raw:: latex
\newpage % \newpage %
Create Links Create Links
************ ************
Link to a Handout or Image
**Link to a Handout or Image** ==========================
To link to a document, image, or other file that you uploaded to the Files & To link to a document, image, or other file that you uploaded to the Files &
Uploads page: Uploads page:
...@@ -93,45 +93,41 @@ To create a link to a document, enter the following syntax, where URL OF FILE is ...@@ -93,45 +93,41 @@ To create a link to a document, enter the following syntax, where URL OF FILE is
the URL that you noted in step 5 of Upload a File to the Files & Uploads Page the URL that you noted in step 5 of Upload a File to the Files & Uploads Page
and LINK TEXT is the text that the user will click. :: and LINK TEXT is the text that the user will click. ::
<p><a href="[URL OF FILE]">[LINK TEXT]</a></p> <p><a href="[URL OF FILE]">[LINK TEXT]</a></p>
For example, to create a link to the HTML template for the “About” page document For example, to create a link to the HTML template for the “About” page document
whose URL is /c4x/edX/edX101/asset/AboutPage_Template.txt, use the following whose URL is /c4x/edX/edX101/asset/AboutPage_Template.txt, use the following
code. :: code. ::
<p><a href="/c4x/edX/edX101/asset/AboutPage_Template.txt">HTML Template for <p><a href="/c4x/edX/edX101/asset/AboutPage_Template.txt">HTML Template for
<the "About" page</a></p> <the "About" page</a></p>
To create a link to an image that you’ve uploaded, enter the following syntax, To create a link to an image that you’ve uploaded, enter the following syntax,
where URL OF FILE is the URL that you noted in step 5 of Upload a File to the where URL OF FILE is the URL that you noted in step 5 of Upload a File to the
Files & Uploads Page. :: Files & Uploads Page. ::
<p><img src="[URL OF FILE]"/></p> <p><img src="[URL OF FILE]"/></p>
For example, to create a link to the CourseImage.jpg file whose URL is For example, to create a link to the CourseImage.jpg file whose URL is
/c4x/edX/edX101/asset/CourseImage.jpg, use the following code. :: /c4x/edX/edX101/asset/CourseImage.jpg, use the following code. ::
<p><img src="/c4x/edX/edX101/asset/CourseImage.jpg"></p> <p><img src="/c4x/edX/edX101/asset/CourseImage.jpg"></p>
When you use this code, the following image appears. When you use this code, the following image appears.
.. image:: images/image078.png .. image:: images/image078.png
:width: 800 :width: 800
3. Click **Save.** Your files or images appear in the component. 3. Click **Save.** Your files or images appear in the component.
**Link to Course Units** .. raw:: latex
\newpage %
Link to Course Units
====================
To direct the student to a specific place in your own course, you must add an To direct the student to a specific place in your own course, you must add an
HTML link to that unit. To do this: HTML link to that unit. To do this:
...@@ -139,55 +135,43 @@ HTML link to that unit. To do this: ...@@ -139,55 +135,43 @@ HTML link to that unit. To do this:
1. Determine the relative directory of your course. 1. Determine the relative directory of your course.
a. On the Course Settings tab, click the blue your course URL link under Basic a. On the Course Settings tab, click the blue your course URL link under Basic
Information. Information.
.. image:: images/image079.png .. image:: images/image079.png
:width: 800 :width: 800
The registration page for your course opens. The registration page for your course opens.
b. In the address bar at the top of the page, locate the URL. b. In the address bar at the top of the page, locate the URL.
c. Copy the part of the URL after “.org” and before “about”, including the c. Copy the part of the URL after “.org” and before “about”, including the
forward slashes. The syntax is the following. :: forward slashes. The syntax is the following. ::
/courses/[organization]/[course_number]/[course_name]/ /courses/[organization]/[course_number]/[course_name]/
For example, for edX101: How to Create an edX Course from edX, the complete URL For example, for edX101: How to Create an edX Course from edX, the complete URL
is the following. :: is the following. ::
https://edge.edx.org/courses/edX/edX101/How_to_create_an_edX_course/about https://edge.edx.org/courses/edX/edX101/How_to_create_an_edX_course/about
The relative directory is the following. :: The relative directory is the following. ::
/courses/edX/edX101/How_to_create_an_edX_course/ /courses/edX/edX101/How_to_create_an_edX_course/
2. Determine the location ID of the target unit. Studio generates the location 2. Determine the location ID of the target unit. Studio generates the location
ID for each unit when you create the unit. The location ID uses the following ID for each unit when you create the unit. The location ID uses the following
syntax. :: syntax. ::
i4x://<organization>/<course_number>/vertical/<url_name_of_unit> i4x://<organization>/<course_number>/vertical/<url_name_of_unit>
.. note::
*NOTE: To find the location ID, open the page of the unit you are trying to link To find the location ID, open the page of the unit you are trying to link
*to in Studio and look at the URL in the browser’s address bar. The location ID to in Studio and look at the URL in the browser’s address bar. The location ID
*is the text in the URL after edit, as in the following example. is the text in the URL after edit, as in the following example.
.. image:: images/image081.png
.. image:: images/image081.png
3. Open the unit that you want to link from. 3. Open the unit that you want to link from.
...@@ -207,58 +191,57 @@ location id of unit, and link text with your information. :: ...@@ -207,58 +191,57 @@ location id of unit, and link text with your information. ::
<a href = "[[relative course directory]]/jump_to/[[location id of <a href = "[[relative course directory]]/jump_to/[[location id of
<unit]]">[link text]</a> <unit]]">[link text]</a>
For example, a link to the “Creating an HTML Component” unit in edx101 For example, a link to the “Creating an HTML Component” unit in edx101
resembles the following :: resembles the following ::
<a href = "courses/edX/edX101/How_to_Create_an_edX_Course/jump_to/i4x://edX/ed <a href = "courses/edX/edX101/How_to_Create_an_edX_Course/jump_to/i4x://edX/ed
<X101/vertical/8713e94afd074e40991dcb675d1030b5">Creating an HTML <X101/vertical/8713e94afd074e40991dcb675d1030b5">Creating an HTML
<Component</a> <Component</a>
.. raw:: latex .. raw:: latex
\newpage % \newpage %
Import from LaTeX Import from LaTeX
***************** *****************
You can create an HTML component from imported LaTeX code. You can create an HTML component from imported LaTeX code.
*Note: This feature is currently under development.* .. note::
This feature is currently under development.
1. Under **Add New Component**, click **html**, and then click **E-text Written 1. Under **Add New Component**, click **html**, and then click **E-text Written
in LaTeX.** in LaTeX.**
.. image:: images/image067.png .. image:: images/image067.png
:width: 800 :width: 800
2. In the component that appears, click Edit. 2. In the component that appears, click Edit.
.. image:: images/image083.png .. image:: images/image083.png
:width: 800 :width: 800
3. The component editor opens. In the top left corner of the editor, click the 3. The component editor opens. In the top left corner of the editor, click the
yellow **Edit High Level Source** text. yellow **Edit High Level Source** text.
.. image:: images/image085.png .. image:: images/image085.png
:width: 800 :width: 800
4. In the **High Level Source Editing** screen that opens, replace the sample 4. In the **High Level Source Editing** screen that opens, replace the sample
code with your LaTeX code. code with your LaTeX code.
.. image:: images/image087.png .. image:: images/image087.png
:width: 800 :width: 800
5. Click **Save and compile to edX XML** to convert the LaTeX code into edX XML 5. Click **Save and compile to edX XML** to convert the LaTeX code into edX XML
code. code.
*Note: Studio uses a third-party LaTeX processor to convert LaTeX code to XML. .. note::
The LaTeX processor must be up and running.*
Studio uses a third-party LaTeX processor to convert LaTeX code to XML.
The LaTeX processor must be up and running.
6. Click **Save**. Verify that your newly created component looks the way you 6. Click **Save**. Verify that your newly created component looks the way you
want it to. want it to.
......
docs/course_authors/source/create_lesson.rst
...@@ -5,14 +5,16 @@ Create a Lesson in Studio ...@@ -5,14 +5,16 @@ Create a Lesson in Studio
Once you have created a course, you are ready to create content for that course. Once you have created a course, you are ready to create content for that course.
**CAUTION** *The alpha version of Studio does not have versioning or automatic .. warning::
updating of your browser between refreshes. Versioning is planned for future
releases, but, in the meantime, only one author should edit a unit, in one The alpha version of Studio does not have versioning or automatic
browser, on only one tab.  If a unit is open for editing in multiple browser updating of your browser between refreshes. Versioning is planned for future
sessions, the session that saves last will overwrite any previously saved refresheseleases, but, in the meantime, only one author should edit a unit, in one
content without displaying a warning. Also, older browser sessions can overwrite browser, on only one tab.  If a unit is open for editing in multiple browser
more recent content, so refresh your browser before you start working every time sessions, the session that saves last will overwrite any previously saved
you work with a private unit or edit a draft of a public unit.* content without displaying a warning. Also, older browser sessions can overwrite
more recent content, so refresh your browser before you start working every time
you work with a private unit or edit a draft of a public unit.
Introduction Introduction
...@@ -40,7 +42,9 @@ or private. ...@@ -40,7 +42,9 @@ or private.
.. image:: images/image031.png .. image:: images/image031.png
:width: 800 :width: 800
.. raw:: latex
\newpage %
Section Section
******* *******
...@@ -56,6 +60,10 @@ the content in the section is visible until its release date has passed. ...@@ -56,6 +60,10 @@ the content in the section is visible until its release date has passed.
For more information about how to create a section, see For more information about how to create a section, see
:doc:`create_section_sub_section`. :doc:`create_section_sub_section`.
.. raw:: latex
\newpage %
Subsection Subsection
********** **********
...@@ -77,6 +85,10 @@ its section. ...@@ -77,6 +85,10 @@ its section.
For more information about how to create a subsection, see For more information about how to create a subsection, see
:doc:`create_section_sub_section`. :doc:`create_section_sub_section`.
.. raw:: latex
\newpage %
Unit Unit
**** ****
...@@ -92,6 +104,10 @@ Note that by default, all units are set to **Private.** To make a unit visible ...@@ -92,6 +104,10 @@ Note that by default, all units are set to **Private.** To make a unit visible
to students, you have to explicitly change the unit’s visibility to **Public.** to students, you have to explicitly change the unit’s visibility to **Public.**
For more information see :doc:`set_content_releasedates` . For more information see :doc:`set_content_releasedates` .
.. raw:: latex
\newpage %
Component Component
********* *********
......
docs/course_authors/source/create_section_sub_section.rst
******************************* *******************************
Create a Section and Subsection Create a Section and Subsection
******************************* *******************************
...@@ -19,8 +18,10 @@ Create a Section and Subsection ...@@ -19,8 +18,10 @@ Create a Section and Subsection
3. In the **New Section** Name box, type a section name, and then click 3. In the **New Section** Name box, type a section name, and then click
**Save**. **Save**.
*Note: In most courses, the name of the first section is Week 1. .. note::
The section that you have created appears on the **Course Outline** page.
In most courses, the name of the first section is Week 1.
The section that you have created appears on the **Course Outline** page.
.. image:: images/image041.png .. image:: images/image041.png
:width: 800 :width: 800
......
docs/course_authors/source/create_video.rst
...@@ -9,47 +9,52 @@ To add a video to the unit, you must upload your video to YouTube, and then crea ...@@ -9,47 +9,52 @@ To add a video to the unit, you must upload your video to YouTube, and then crea
You can include videos that run at 0.75 speed, 1.25 speed, and 1.50 speed as well as at normal speed. To do this, you must upload each of these videos to YouTube separately. You can include videos that run at 0.75 speed, 1.25 speed, and 1.50 speed as well as at normal speed. To do this, you must upload each of these videos to YouTube separately.
*Note YouTube only hosts videos of up to 15 minutes. If you encode a 0.75 speed option, you must make .. note::
sure that source video segments are only 11.25 minutes long so that YouTube can host all speeds.
YouTube offers paid accounts that relax this restriction.*
1. Upload the video that you want to YouTube. Make note of the code that appears between **watch?v** YouTube only hosts videos of up to 15 minutes. If you encode a 0.75 speed option, you must make
= and **&feature** in the URL. This code appears in the green box below. sure that source video segments are only 11.25 minutes long so that YouTube can host all speeds.
YouTube offers paid accounts that relax this restriction.
.. image:: images/image053.png
:width: 800
2. In Studio, go to the unit that you want. 1. Upload the video that you want 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.
3. Under **Add New Component,** click **Video.** .. image:: images/image053.png
:width: 800 px
4. In the screen that appears, click **default.** 2. In Studio, go to the unit that you want.
5. When the new video component appears, click **edit**.** A video component opens, and a sample video 3. Under **Add New Component,** click **Video.**
begins playing automatically.
6. In the **display_name** box, type the text that you want the student to see when the student hovers 4. In the screen that appears, click **default.**
the mouse over the icon in the bar at the top of the page. This text also appears as a header
for the video.
7. Change the codes in the green boxes to the YouTube codes that you noted in step 1. The first 5. When the new video component appears, click **edit**.** A video component opens, and a sample video
code (immediately to the right of "0.75:") corresponds to the video at 0.75 speed, the next begins playing automatically.
corresponds to 1.0 speed, etc.
.. image:: images/image055.png 6. In the **display_name** box, type the text that you want the student to see when the student hovers
:width: 800 the mouse over the icon in the bar at the top of the page. This text also appears as a headerfor the video.
8. Click **Save.** 7. Change the codes in the green boxes to the YouTube codes that you noted in step 1. The first
code (immediately to the right of "0.75:") corresponds to the video at 0.75 speed, the next
corresponds to 1.0 speed, etc.
*Note All videos embedded using the edX player begin playing automatically. There is currently no way .. image:: images/image055.png
to turn off the autoplay feature.* :width: 800
8. Click **Save.**
.. note::
All videos embedded using the edX player begin playing automatically.
There is currently no way to turn off the autoplay feature.
**To add a transcript for your video:** **To add a transcript for your video:**
1. Save your srt.sjson file as **subs_YOUTUBEID.srt.sjson,** where **YOUTUBEID** is the YouTube ID of your video. 1. Save your srt.sjson file as **subs_YOUTUBEID.srt.sjson,** where **YOUTUBEID** is the YouTube ID of your video.
2. Upload the **subs_YOUTUBEID.srt.sjson** file to the **Files & Uploads** page. 2. Upload the **subs_YOUTUBEID.srt.sjson** file to the **Files & Uploads** page.
3. Create a link to this file by following the steps in the Add Items to the Handouts Sidebar 3. Create a link to this file by following the steps in the Add Items to the Handouts Sidebar
section. section.
docs/course_authors/source/establish_course_settings.rst
...@@ -106,7 +106,9 @@ Schedule and Details Page ...@@ -106,7 +106,9 @@ Schedule and Details Page
2. In the **Course Schedule** section, enter the date you want your course to start in the **Course Start Date** box, and then enter the time you want your course to start in the **Course** **Start Time** box. 2. In the **Course Schedule** section, enter the date you want your course to start in the **Course Start Date** box, and then enter the time you want your course to start in the **Course** **Start Time** box.
*Note: The Course Start Time on this screen will reflect the current time zone in your browser, depending on your geography. Course start times for students will show as UTC on Edge.* .. note::
The Course Start Time on this screen will reflect the current time zone in your browser, depending on your geography. Course start times for students will show as UTC on Edge.
3. In the **Course Schedule** section, enter the date you want your course to end in the **Course** **End Date ** 3. In the **Course Schedule** section, enter the date you want your course to end in the **Course** **End Date **
...@@ -127,7 +129,9 @@ Add Enrollment Information ...@@ -127,7 +129,9 @@ Add Enrollment Information
box, and then enter the time you want enrollment for your course to end in the **Enrollment End Time** box. box, and then enter the time you want enrollment for your course to end in the **Enrollment End Time** box.
*Note: The Enrollment dates on this screen will reflect the current time zone in your browser, depending on your geography. Enrollment times for students will show as UTC on Edge.* .. note::
The Enrollment dates on this screen will reflect the current time zone in your browser, depending on your geography. Enrollment times for students will show as UTC on Edge.
...@@ -156,7 +160,9 @@ can use that includes placeholders, see :doc:`appendices/a`. ...@@ -156,7 +160,9 @@ can use that includes placeholders, see :doc:`appendices/a`.
If your course has prerequisites, you can include that information in the course overview. If your course has prerequisites, you can include that information in the course overview.
*Note: There is no save button. Studio automatically saves your changes.* .. note::
There is no save button. Studio automatically saves your changes.
The following is example content for the **Course Overview** box: The following is example content for the **Course Overview** box:
...@@ -191,7 +197,9 @@ You can create an About video that will appear on the **About** page for your co ...@@ -191,7 +197,9 @@ You can create an About video that will appear on the **About** page for your co
4. In the **your YouTube video's ID** box, enter your video code. When you add the code, the video automatically appears in the field above the **your YouTube video's ID** box. 4. In the **your YouTube video's ID** box, enter your video code. When you add the code, the video automatically appears in the field above the **your YouTube video's ID** box.
*Note: There is no save button. Studio automatically saves your changes.* .. note::
There is no save button. Studio automatically saves your changes.
For example, your course introduction video appears as follows. For example, your course introduction video appears as follows.
......
docs/course_authors/source/establish_grading_policy.rst
...@@ -35,7 +35,9 @@ Create assignment types for the course and determine the weight of the student's ...@@ -35,7 +35,9 @@ Create assignment types for the course and determine the weight of the student's
Each subsection in your course can be designated as one of the assignment types that you have specified in the grading policy. You can also specify a release date and a due date. Each subsection in your course can be designated as one of the assignment types that you have specified in the grading policy. You can also specify a release date and a due date.
*Note: You can create problems in Studio without specifying that the subsection is an assignment type. However, problems do not count toward a student's grade unless you set the subsection as a graded assignment type.* .. note::
You can create problems in Studio without specifying that the subsection is an assignment type. However, problems do not count toward a student's grade unless you set the subsection as a graded assignment type.
For more information on creating problems, see `Create a Problem <Create_Problem.html>`_ . For more information on creating problems, see `Create a Problem <Create_Problem.html>`_ .
...@@ -62,7 +64,9 @@ To set the thresholds for course grades: ...@@ -62,7 +64,9 @@ To set the thresholds for course grades:
2. Under **Overall Grade Range**, click and drag the dividing line between grade divisions to move each threshold up or down. 2. Under **Overall Grade Range**, click and drag the dividing line between grade divisions to move each threshold up or down.
*Note: The default grade divisions are Pass and Fail. To add more grade divisions (such as A, B, C, or D), click the plus sign (+).* .. note::
The default grade divisions are Pass and Fail. To add more grade divisions (such as A, B, C, or D), click the plus sign (+).
.. image:: images/image133.png .. image:: images/image133.png
...@@ -151,7 +155,9 @@ Create Subsections Containing Graded Assignments ...@@ -151,7 +155,9 @@ Create Subsections Containing Graded Assignments
After you establish your grading rubric, you can create a graded assignment or a test for your students. To do this, you must first create a subsections and then set up grading for the subsection. This includes setting the assignment type, the assignment release date, and the due date. After you establish your grading rubric, you can create a graded assignment or a test for your students. To do this, you must first create a subsections and then set up grading for the subsection. This includes setting the assignment type, the assignment release date, and the due date.
*Note: When you set a due date, keep in mind that students will be in different time zones across the world. By default, the time zone appears as UTC-not the student's local time. If you tell your students an assignment is due at 5:00 PM, make sure to specify that the time is 5:00 PM UTC and point them to a time converter.* .. note::
When you set a due date, keep in mind that students will be in different time zones across the world. By default, the time zone appears as UTC-not the student's local time. If you tell your students an assignment is due at 5:00 PM, make sure to specify that the time is 5:00 PM UTC and point them to a time converter.
Alternatively, you can :ref:`set a grace period<Set-Grace-Period>` for your assignments to cover any misunderstandings about time. For example, some classes have set a grace period of 1 day, 6 hours, and 1 minute. This grace period applies to the entire course. Alternatively, you can :ref:`set a grace period<Set-Grace-Period>` for your assignments to cover any misunderstandings about time. For example, some classes have set a grace period of 1 day, 6 hours, and 1 minute. This grace period applies to the entire course.
...@@ -205,4 +211,6 @@ To set the assignment type for a subsection: ...@@ -205,4 +211,6 @@ To set the assignment type for a subsection:
.. image:: images/image153.png .. image:: images/image153.png
*Note: If you change an assignment type name in the Grading page, make sure the assignment type names on the Course Outline still match.* .. note::
\ No newline at end of file
If you change an assignment type name in the Grading page, make sure the assignment type names on the Course Outline still match.
\ No newline at end of file
docs/course_authors/source/export_import_course.rst
...@@ -6,9 +6,6 @@ Export or Import a Course ...@@ -6,9 +6,6 @@ Export or Import a Course
Studio has an Import tool and an Export tool that allow you to import and Studio has an Import tool and an Export tool that allow you to import and
export courses. export courses.
.. raw:: latex
\newpage %
Export a Course Export a Course
*************** ***************
...@@ -77,11 +74,15 @@ The exported file does not include the following data: ...@@ -77,11 +74,15 @@ The exported file does not include the following data:
Import a Course Import a Course
*************** ***************
*Note: This feature should be used with caution! .. warning::
Importing a new course will delete all course content currently associated with
your course and replace it with the contents of the uploaded file. This feature should be used with caution!
**Importing a course cannot be undone.* 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 You can import courses that have already been created in Studio. These can
......
docs/course_authors/source/get_started.rst
...@@ -2,12 +2,10 @@ ...@@ -2,12 +2,10 @@
.. image:: images/image001.png .. image:: images/image001.png
########################### ###########################
Getting Started with Studio Getting Started with Studio
########################### ###########################
************ ************
Introduction Introduction
...@@ -27,7 +25,7 @@ Studio (http://studio.edge.edx.org) is our web-based course authoring tool. It i ...@@ -27,7 +25,7 @@ Studio (http://studio.edge.edx.org) is our web-based course authoring tool. It i
**There is a workflow to getting started.** **There is a workflow to getting started.** Here is a quick summary:
...@@ -57,6 +55,10 @@ Studio (http://studio.edge.edx.org) is our web-based course authoring tool. It i ...@@ -57,6 +55,10 @@ Studio (http://studio.edge.edx.org) is our web-based course authoring tool. It i
.. image:: images/image027.png .. image:: images/image027.png
:width: 800 :width: 800
.. raw:: latex
\newpage %
***************** *****************
Create an Account Create an Account
...@@ -115,6 +117,10 @@ e. Click to select I agree to the Terms of Service. ...@@ -115,6 +117,10 @@ e. Click to select I agree to the Terms of Service.
.. image:: images/image017.png .. image:: images/image017.png
:width: 800 :width: 800
.. raw:: latex
\newpage %
******************* *******************
Create a New Course Create a New Course
******************* *******************
...@@ -137,7 +143,9 @@ To create a new course: ...@@ -137,7 +143,9 @@ To create a new course:
1. Click **New Course.** A screen opens. 1. Click **New Course.** A screen opens.
*Note: Enter your new course information carefully. This information becomes part of the URL for your course. To change the URL after the course is created, you must contact edX through the Help site (http://help.edge.edx.org). Additionally, because this information becomes part of your course URL, the total number of characters in the following three fields must be 65 or fewer.* .. note::
Enter your 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.
2. For **Course Name**, enter the title of your course. For example, the name may be “Sets, Maps and Symmetry Groups". Use title capitalization for the course title. 2. For **Course Name**, enter the title of your course. For example, the name may be “Sets, Maps and Symmetry Groups". Use title capitalization for the course title.
......
docs/course_authors/source/index.rst
...@@ -3,7 +3,6 @@ ...@@ -3,7 +3,6 @@
You can adapt this file completely to your liking, but it should at least You can adapt this file completely to your liking, but it should at least
contain the root `toctree` directive. contain the root `toctree` directive.
.. image:: images/image001.png
Contents Contents
...@@ -13,6 +12,7 @@ Contents ...@@ -13,6 +12,7 @@ Contents
.. toctree:: .. toctree::
:maxdepth: 5 :maxdepth: 5
read_me
get_started get_started
create_lesson create_lesson
create_section_sub_section create_section_sub_section
...@@ -32,6 +32,8 @@ Contents ...@@ -32,6 +32,8 @@ Contents
create_seed_wiki create_seed_wiki
invite_students_to_register invite_students_to_register
checking_student_progress checking_student_progress
change_log
...@@ -52,3 +54,4 @@ Appendices ...@@ -52,3 +54,4 @@ Appendices
docs/course_authors/source/set_content_releasedates.rst
...@@ -44,8 +44,10 @@ Individual units inherit the release date of the subsection they are in, but ...@@ -44,8 +44,10 @@ Individual units inherit the release date of the subsection they are in, but
have an additional **Visibility** setting that can be set to **Public** or have an additional **Visibility** setting that can be set to **Public** or
**Private**. Private units are never visible to students. **Private**. Private units are never visible to students.
*Note: You can modify private units directly. To modify a unit that is marked .. note::
Public you must create a draft.*
You can modify private units directly. To modify a unit that is marked
Public you must create a draft.
For more information, see :doc:`modify_published_content` . For more information, see :doc:`modify_published_content` .
......
docs/course_authors/source/view_course_content.rst
...@@ -54,8 +54,10 @@ still creating it: ...@@ -54,8 +54,10 @@ still creating it:
* In Studio * In Studio
Note that the way your course looks in Studio is .. note::
not the way it looks to students on edX or Edge.
The way your course looks in Studio is not the way it looks to students on
edX or Edge.
* On edX or Edge in Preview mode * On edX or Edge in Preview mode
......
userdocs/source/read_me.rst 0 → 100644
*******
Read Me
*******
This version of the edX "Getting Started with Studio" help and pdf documentation is created using Sphinx 1.2b1 and LaTex. You, the user community, can help update and revise this documentation project in GitHub at ::
edx\edX-platform\userdocs\source
with a pull request that will need approval from an engineering contact at edX.
The edX contact for this documenation is mchang@edx.org
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