8.13. Google Calendar Tool

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

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

8.13.1. 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:

A Google calendar in courseware

8.13.2. Embedding a Google Calendar in Your Course

Embedding a Google calendar in your course has three steps.

  1. Enable Google calendars in your course by using Studio or OLX.
  2. Make the Google calendar public and obtain its ID.
  3. Add the Google calendar to your course by using Studio or OLX.

8.13.2.1. Enable Google Calendars in the Course

You can enable Google Calendars in the course by using either Studio or OLX.

8.13.2.1.1. Enable Google Calendars in edX Studio

To enable Google Calendars in your course:

  1. From the Settings menu, select Advanced Settings.

  2. In the Advanced Module List field, place your cursor between the braces, and then type "google-calendar". If you see other values in this field, add a comma after the closing quotation mark for the last value, and then type "google-calendar". For example:

    Advanced modules setting for Google Calendars
  3. At the bottom of the page, select Save Changes.

8.13.2.1.2. Enable Google Calendars in OLX

To enable Google Calendars in your course, you edit the XML file that defines the course structure. You locate the course element’s advanced-modules attribute, and add the string google-calendar to it.

For example, the following XML code enables Google Calendars in a course. It also enables Google Drive files.

<course advanced_modules="[&quot;google-document&quot;,
    &quot;google-calendar&quot;]" display_name="Sample Course"
    start="2014-01-01T00:00:00Z">
    ...
</course>

For more information, see The Courseware Structure.

8.13.2.2. Make the Google Calendar Public and Obtain Its ID

Before you can add a Google calendar to your course, you must make the calendar public and obtain its ID.

Important

The tasks described in this section rely on the use of third-party software. Because the software is subject to change by its owner, the steps provided here are intended as guidelines and not as an exact procedure.

8.13.2.2.1. Make the Google Calendar Public

  1. Open the Google calendar.

  2. From the Settings menu, select Settings.

  3. Select the Calendars tab.

    You might have multiple calendars on the Calendars tab. Find the calendar that you want to share in your courseware.

  4. In the row for the calendar to share, in the Sharing column, select Edit Settings.

  5. Click the Share this Calendar tab, and then select Make this calendar public.

Google calendar settings
  1. Select Save.

    The Calendar Settings page closes, and you return to the Calendars tab. You continue by obtaining the Google calendar’s ID.

8.13.2.2.2. Obtain the Google Calendar ID

  1. On the Calendars tab, click the name of the calendar.

  2. Select the Calendar Details tab.

  3. 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 of Calendar Address label with the calendar ID to the right

    The calendar ID resembles the following text.

    abcdefghijklmnop1234567890@group.calendar.google.com

    Select and copy the calendar ID. You use this value to configure the Google calendar component in your course.

8.13.2.3. Add a Google Calendar in the Courseware

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

8.13.2.3.1. Add a Google Calendar Component in edX Studio

Make sure that you enable Google Calendars in your course before you add the Google Calendar component.

To add a Google calendar component:

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

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

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

    The Google calendar component in a unit page
  3. In the new component, select Edit.

    The Google calendar editor
  4. In the Display Name field, type the name for the component.

  5. In the Public Calendar ID field, paste the calendar ID you copied in the Obtain the Google Calendar ID task.

  6. 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.

  7. Select Save.

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

8.13.2.3.2. Add a Google Calendar XBlock in OLX

To add a Google calendar XBlock in OLX, create the google-calendar element. 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:

<google-calendar url_name="4115e717366045eaae7764b2e1f25e4c"
  calendar_id="abcdefghijklmnop1234567890@group.calendar.google.com"
  default_view="1" display_name="Class Schedule"/>

The value of the calendar_id attribute is the calendar ID that you copied in the Obtain the Google Calendar ID task.

Note

The edX Learning Management System sets the height and width values for Google Calendars. If you add these attributes, the LMS overrides your changes.

8.13.3. 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 Google user interface. You do not need to edit the Google Calendar component.