Skip to content

Commit

Permalink
Merge pull request #550 from edx/ahodges/DOC2043
Browse files Browse the repository at this point in the history 
Fixes DOC-2264
  • Loading branch information
Alison Hodges committed Sep 15, 2015
2 parents a2c27c7 + 82a60cf commit aec2f3d
Show file tree
Hide file tree
Showing 7 changed files with 328 additions and 361 deletions.
411 changes: 190 additions & 221 deletions en_us/shared/accessibility/best_practices_course_content_dev.rst
View file

Large diffs are not rendered by default.

8 changes: 4 additions & 4 deletions ...ding_and_running_chapters/content_experiments/content_experiments_configure.rst
View file
Original file line number Diff line number Diff line change
Expand Up @@ -18,22 +18,22 @@ Enable Content Experiments
****************************************

To enable content experiments in your course, you add ``split_test`` to the
**Advanced Modules List** in Advanced Settings.
**Advanced Module List** in Advanced Settings.

.. note::
``split_test`` is the internal edX Platform name for a content experiment.

#. From the **Settings** menu, select **Advanced Settings**.

#. On the **Advanced Settings** page, locate **Advanced Modules List**.
#. On the **Advanced Settings** page, locate **Advanced Module List**.

#. In the **Advanced Modules List** field, add ``"split_test"``. Be sure that
#. In the **Advanced Module List** field, add ``"split_test"``. Be sure that
you include the double quotation marks.

If you have multiple values, ensure that they are separated by commas
(``,``).

For example, the text in the **Advanced Modules List** field may resemble
For example, the text in the **Advanced Module List** field may resemble
the following:

.. code-block:: json
Expand Down
75 changes: 31 additions & 44 deletions en_us/shared/exercises_tools/google_calendar.rst
View file
Original file line number Diff line number Diff line change
Expand Up @@ -4,46 +4,35 @@
Google Calendar Tool
#####################

This chapter describes how to embed Google calendars in your course. For more
information, see any of the following topics.
This topic describes how to embed Google calendars in your course.

* `Overview`_

* `Embedding a Google Calendar in Your Course`_

* `Enable Google Calendars in the Course`_

* `Enable Google Calendars in edX Studio`_
* `Enable Google Calendars in OLX`_

* `Make the Google Calendar Public and Obtain Its ID`_
* `Add a Google Calendar in the Courseware`_

* `Add a Google Calendar Component in edX Studio`_
* `Add a Google Calendar XBlock in OLX`_

* `Editing Google Calendars`_
.. contents::
:local:

You can also use Google Drive files, such as documents, spreadsheets, and
images, in your course. For more information, see :ref:`Google Drive Files
Tool`.

.. note:: Google services are not available in some regions and countries. If
Google services are not available in a learner's area, the learner might see
an “image unavailable” message in the place of the Google Drive file or
calendar. We strongly suggest that you provide alternative resources
for learners in these areas.
Be sure to review all supplemental materials to assure that they are accessible
before making them available through your course. For more information, see
:ref:`Accessibility Best Practices for Course Content Development`.

.. note:: Google services are not available in some regions and countries.
If Google services are not available in a learner's area, the learner might
see an "image unavailable" message in the place of the Google Drive file or
calendar. EdX strongly suggests that you provide alternative resources for
learners in these areas.

*********
Overview
*********

You can embed a Google calendar in your course so that students see the calendar
in the courseware. You can use a Google calendar to share quiz dates, office
hours, or other schedules of interest to students. For example:
You can embed a Google calendar in your course so that learners see the
calendar in the courseware. You can use a Google calendar to share quiz dates,
office hours, or other schedules of interest to learners. For example:

.. image:: ../../../shared/building_and_running_chapters/Images/google-calendar.png
:alt: A Google calendar in courseware
:alt: A Google calendar in courseware.

*******************************************
Embedding a Google Calendar in Your Course
Expand Down Expand Up @@ -128,7 +117,6 @@ public and obtain its ID.
Make the Google Calendar Public
**********************************************


#. Open the Google calendar.
#. From the **Settings** menu, select **Settings**.
#. Select the **Calendars** tab.
Expand All @@ -138,11 +126,11 @@ Make the Google Calendar Public

#. In the row for the calendar to share, in the **Sharing** column, select
**Edit Settings**.
#. Click the **Share this Calendar** tab, and then select **Make this calendar
#. Select the **Share this Calendar** tab, and then select **Make this calendar
public**.

.. image:: ../../../shared/building_and_running_chapters/Images/google-calendar-settings.png
:alt: Google calendar settings
:alt: Google calendar settings.

7. Select **Save**.

Expand All @@ -155,15 +143,15 @@ Make the Google Calendar Public
Obtain the Google Calendar ID
**********************************************

#. On the **Calendars** tab, click the name of the calendar.
#. On the **Calendars** tab, select the name of the calendar.
#. Select the **Calendar Details** tab.
#. Next to the **Calendar Address** label, look to the right of the three
colored **XML**, **ICAL**, and **HTML** buttons. In parentheses, you can see
the calendar ID.

.. image:: ../../../shared/building_and_running_chapters/Images/google-calendar-address.png
:width: 600
:alt: Image of Calendar Address label with the calendar ID to the right
:alt: Image of Calendar Address label with the calendar ID to the right.

The calendar ID resembles the following text.

Expand All @@ -178,7 +166,7 @@ Obtain the Google Calendar ID
Add a Google Calendar in the Courseware
========================================

To add a Google calendar in the courseware, you create aan advanced component
To add a Google calendar in the courseware, you create an advanced component
in Studio or create a Google calendar XBlock in OLX.

.. _Add a Google Calendar Component in edX Studio:
Expand All @@ -189,26 +177,26 @@ Add a Google Calendar Component in edX Studio
Make sure that you :ref:`enable Google Calendars in your course<Enable Google
Calendars in edX Studio>` before you add the Google Calendar component.

To add a Google calendar component:
To add a Google calendar component, follow these steps.

#. On the **Course Outline** page, open the unit where you want to add the
Google calendar component.

#. Under **Add New Component** click **Advanced**, and then select **Google
#. Under **Add New Component**, select **Advanced**, and then select **Google
Calendar**.

The new component is added to the unit, with the default edX Google calendar
embedded.

.. image:: ../../../shared/building_and_running_chapters/Images/google-calendar-studio.png
:width: 600
:alt: The Google calendar component in a unit page
:alt: The Google calendar component in a unit page.

#. In the new component, select **Edit**.

.. image:: ../../../shared/building_and_running_chapters/Images/google-calendar-edit.png
:width: 600
:alt: The Google calendar editor
:alt: The Google calendar editor.

#. In the **Display Name** field, type the name for the component.

Expand All @@ -217,14 +205,13 @@ To add a Google calendar component:

#. For the **Default View** field, select **Month**, **Week**, or **Agenda**.

This is the initial view that your students have of the calendar. Each
student can change his or her view.
This is the initial view that your learners have of the calendar. Each
learner can change his or her view.

#. Select **Save**.

You can then :ref:`Preview Course Content` to see how the unit with the Google
calendar will appear to students.

calendar will appear to learners.

.. _Add a Google Calendar XBlock in OLX:

Expand All @@ -236,7 +223,7 @@ You can embed this element in the ``vertical`` element, or you can embed this
element in its own file that is referenced within the vertical. For more
information, see `The Courseware Structure`_.

For example:
An example follows.

.. code-block:: xml
Expand All @@ -257,8 +244,8 @@ Editing Google Calendars
**************************

When you make changes to a Google calendar that is embedded in your course,
students see the updates immediately. You make changes to calendars with the
learners see the updates immediately. You make changes to calendars with the
Google user interface. You do not need to edit the Google Calendar component.


.. _The Courseware Structure: http://edx.readthedocs.org/projects/edx-open-learning-xml/en/latest/organizing-course/course-xml-file.html
.. _The Courseware Structure: http://edx.readthedocs.org/projects/edx-open-learning-xml/en/latest/organizing-course/course-xml-file.html
78 changes: 34 additions & 44 deletions en_us/shared/exercises_tools/google_docs.rst
View file
Original file line number Diff line number Diff line change
Expand Up @@ -4,45 +4,36 @@
Google Drive Files Tool
########################

This chapter describes how to embed Google Drive files, such as documents,
spreadsheets, and images, in your course. For more information, see any of the
following topics.
This topic describes how to embed Google Drive files, such as documents,
spreadsheets, and images, in your course.

* `Overview`_
* `Embedding a Google Drive File in Your Course`_

* `Enable Google Drive Files in Your Course`_

* `Enable Google Drive Files in edX Studio`_
* `Enable Google Drive Files in OLX`_

* `Obtain the Google Drive File Embed Code`_
* `Add a Google Drive File to Your Course`_

* `Add a Google Drive File Component in edX Studio`_
* `Add a Google Drive File XBlock in OLX`_

* `Editing Google Drive Files`_
.. contents::
:local:

You can also use :ref:`Google calendars<Google Calendar Tool>` in courseware.
For more information, see :ref:`Google Calendar Tool`.

Be sure to review all supplemental materials to assure that they are accessible
before making them available through your course. For more information, see
:ref:`Accessibility Best Practices for Course Content Development`.

.. note:: Google services are not available in some regions and countries. If
Google services are not available in a learner's area, the learner might see
an “image unavailable” message in the place of the Google Drive file or
calendar. We strongly suggest that you provide alternative resources
for learners in these areas.
Google services are not available in a learner's area, the learner might see
an "image unavailable" message in the place of the Google Drive file or
calendar. EdX strongly suggests that you provide alternative resources for
learners in these areas.

*********
Overview
*********

You can embed a Google Drive file in your course so that students see the file in
the courseware. For example, you can share a Google spreadsheet with students.
You can embed a Google Drive file in your course so that learners see the file
in the courseware. For example, you can share a Google spreadsheet with
learners.

.. image:: ../../../shared/building_and_running_chapters/Images/google-spreadsheet.png
:width: 600
:alt: A Google spreadsheet in courseware
:alt: A Google spreadsheet in courseware.

You can embed the following types of Google Drive files.

Expand All @@ -64,11 +55,10 @@ Embedding a Google Drive file in your course has three steps:

#. `Obtain the Google Drive File Embed Code`_.

#. :ref:`Add the Google Drive file to your course<Add a Google Drive File to Your
Course>` by using :ref:`Studio<Add a Google Drive File Component in edX
#. :ref:`Add the Google Drive file to your course<Add a Google Drive File to
Your Course>` by using :ref:`Studio<Add a Google Drive File Component in edX
Studio>` or :ref:`OLX<Add a Google Drive File XBlock in OLX>`.


.. _Enable Google Drive Files in Your Course:

========================================
Expand All @@ -82,7 +72,7 @@ You can enable Google Drive files in the course by using either Studio or OLX.
Enable Google Drive Files in edX Studio
***************************************

To enable Google Drive files in your course:
To enable Google Drive files in your course, follow these steps.

#. From the **Settings** menu, select **Advanced Settings**.

Expand All @@ -92,7 +82,7 @@ To enable Google Drive files in your course:
type ``"google-document"``. For example:

.. image:: ../../../shared/building_and_running_chapters/Images/google-advanced-setting.png
:alt: Advanced modules setting for Google documents
:alt: Advanced modules setting for Google documents.

#. At the bottom of the page, select **Save Changes**.

Expand Down Expand Up @@ -127,7 +117,7 @@ Publish the Google Drive File and Obtain the Embed Code
=======================================================

Before you can add a Google Drive file to your course, you must publish the
file to the web and obain the embed code for the file.
file to the web and obtain the embed code for the file.

.. important::
The task described in this section relies on the use of third-party software.
Expand All @@ -138,10 +128,10 @@ file to the web and obain the embed code for the file.
#. From the **File** menu, select **Publish to the web**.

.. image:: ../../../shared/building_and_running_chapters/Images/google-publish-to-web.png
:alt: The Google Drive file Publish to the web dialog box
:alt: The Google Drive file Publish to the web dialog box.

#. Click **Publish**, then select **OK** to confirm the action.
#. Click the **Embed** tab.
#. Select **Publish**, and then select **OK** to confirm the action.
#. Select the **Embed** tab.

.. image:: ../../../shared/building_and_running_chapters/Images/google-embed.png
:alt: The Google Drive file Publish to web Embed tab
Expand All @@ -162,7 +152,7 @@ Add a Google Drive File to Your Course
========================================

To add a Google Drive file in the courseware, you create an advanced
component in Studio or create a Google Document Xblock in OLX.
component in Studio or create a Google Document XBlock in OLX.

.. _Add a Google Drive File Component in edX Studio:

Expand All @@ -172,12 +162,12 @@ Add a Google Drive File Component in edX Studio
Ensure you :ref:`enable Google Drive files<Enable Google Drive Files in edX
Studio>` before you add the component.

To add a Google Drive file component:
To add a Google Drive file component, follow these steps.

#. On the Course Outline page, open the unit where you want to add the Google
Drive component.

#. Under **Add New Component** click **Advanced**, and then select **Google
#. Under **Add New Component**, select **Advanced**, and then select **Google
Document**.

The new component is added to the unit, with the default Google presentation
Expand All @@ -189,17 +179,17 @@ To add a Google Drive file component:
#. In the new component, select **Edit**.

.. image:: ../../../shared/building_and_running_chapters/Images/google-document-edit-studio.png
:alt: The Google Drive file editor
:alt: The Google Drive file editor.

#. In the **Display Name** field, type the name for the component.
#. In the **Display Name** field, enter the name for the component.

#. In the **Embed Code** field, paste the embed code you copied in the
#. In the **Embed Code** field, paste the embed code that you copied in the
`Obtain the Google Drive File Embed Code`_ task.

#. Click **Save**.
#. Select **Save**.

You can then :ref:`Preview Course Content` to see how the unit with the Google
drive file will appear to students.
drive file will appear to learners.

.. _Add a Google Drive File XBlock in OLX:

Expand Down Expand Up @@ -237,8 +227,8 @@ Editing Google Drive Files
**************************

When you edit and save a Google Drive file that is embedded in your course,
students see the updates immediately. You make changes to files with the
learners see the updates immediately. You make changes to files with the
Google user interface. You do not need to edit the Google Document component.


.. _The Courseware Structure: http://edx.readthedocs.org/projects/edx-open-learning-xml/en/latest/organizing-course/course-xml-file.html
.. _The Courseware Structure: http://edx.readthedocs.org/projects/edx-open-learning-xml/en/latest/organizing-course/course-xml-file.html
7 changes: 7 additions & 0 deletions en_us/shared/exercises_tools/lti_component.rst
View file
Original file line number Diff line number Diff line change
Expand Up @@ -33,6 +33,13 @@ When you add an LTI component to your course, the edX Learning Management
System (LMS) is the LTI tool consumer, and the external tool or content is the
LTI tool provider.

Be sure to review all supplemental materials to assure that they are accessible
before making them available through your course. For more information, see
:ref:`Accessibility Best Practices for Course Content Development`.


.. Alison Make this link V available when you add new LTI section to open source - Alison 14 Sept 15
.. You can also integrate content from an edX course into a remote learning management system such as Canvas or Blackboard. For more information about how to use Studio as an LTI tool provider, see :ref:`TBD`.
.. _LTI Information:
Expand Down

0 comments on commit aec2f3d

Please sign in to comment.