Difference between revisions of "Help:Widget:Google Calendar"

From MozillaWiki
Jump to: navigation, search
(create demo page for google calendar)
 
(add related widgets section)
 
(7 intermediate revisions by the same user not shown)
Line 1: Line 1:
 +
== What is Widget:Google Calendar ==
 +
 +
The [http://www.mediawikiwidgets.org/Google_Calendar Google Calendar widget] allows you to add '''[http://www.google.com/calendar/embedhelper Google Calendar]''' widget to your wiki page.
 +
 +
It was originally created by [[mediawikiwiki:User:Sergey Chernyshev|Sergey Chernyshev]] for [http://www.techpresentations.org/Conferences#Current_.26_Upcoming_conferences upcoming conference calendar] on TechPresentations.org
 +
 +
== How do you use Widget:Google Calendar? ==
 +
 +
To insert this widget, use the following code:
 +
 +
<nowiki>{{#widget:</nowiki>{{PAGENAME}}<nowiki>
 +
|id=<calendar-id>
 +
}}</nowiki>
 +
 +
== Parameters ==
 +
 +
This widget accepts many optional parameters, allowing you to customize how your shared calendar looks.
 +
 +
* '''id''' - is a calendar ID (including <code>@calendar.google.com</code>, come match user email addresses) - can be found on calendar settings page
 +
* '''title''' - new title if you want to override calendar title (optional)
 +
* '''height''' and '''width''' define calendar dimensions, 100%x600 is default (only width can be defined in %).
 +
* '''color''' - events color (hex value. e.g. 5229A3) - only color used in [http://www.google.com/calendar/embedhelper Google's wizard] can be used.
 +
* '''bgcolor''' - background/border color (hex value. e.g. ffcc66)
 +
* '''weekstart''' - first day of the week (1-7)
 +
* '''lang''' - interface language (en, fr, ru and etc).
 +
* '''view''' - default view MONTH (default)/WEEK/AGENDA)
 +
* '''timezone''' - time zone defined as a string like "America/New_York", should be automatically detected if omitted
 +
* '''pvttk''' - This key is used to access non-public calendars.  All calendars must be on a single account. [Depreciated by Google: See https://support.google.com/calendar/answer/1631300?hl=en]
 +
* '''style''' - The style attribute to be applied to the iframe.
 +
* You can also trigger parts of the interface on and off:
 +
** '''showtitle''' - true (default)/false - shows title
 +
** '''shownav''' - true (default)/false - shows navigation arrows
 +
** '''showdate''' - true (default)/false - shows date
 +
** '''showtabs''' - true (default)/false - shows view tabs
 +
** '''showcals''' - true (default)/false - shows a calendar list
 +
** '''showprint''' - true (default)/false - shows a print icon
 +
** '''showtz''' - true (default)/false - shows timezone
 +
** '''border''' - true/false (default) - draws thin border around the widget
 +
* '''app''' - for [http://www.google.com/apps/ Google Apps for Your Domain] Calendars, specify the domain name for the account (<code><nowiki>http://www.google.com/calendar/hosted/</nowiki>'''yourdomain.com'''/render</code>)
 +
 +
=== Share your Google Calendar ===
 +
 +
In order for the calendar to be visible on MozillaWiki, you need to share the calendar publicly.
 +
'''
 +
Step 1:''' Go to the settings page for the calendar you want to share.
 +
 +
[[File:Google_Calendar_share_step_1.png]]
 +
 +
'''Step 2:''' Click the '''Share this Calendar''' link and modify the sharing settings as needed. You'll need to check '''Make this calendar public''' in order to allow all MozillaWiki visitors to see your embedded calendar. ''Please be sure you want to share the details of this calendar, including attendee details, before you share it.''
 +
 +
[[File:Google_Calendar_share_step_2.png]]
 +
 +
'''Step 3:''' Get the id for your shared calendar. You'll find this under the calendar's settings page, under the '''Calendar Details''' link towards the bottom:
 +
 +
[[File:Google_Calendar_-_get_id.png]]
 +
 +
== Real Example ==
 +
 +
This example shows US holidays.
 +
 +
<nowiki>{{#widget:Google Calendar
 +
|id=usa@holiday.calendar.google.com
 +
|title=US Holidays
 +
}}</nowiki>
 +
 +
{{#widget:Google Calendar
 +
|id=usa@holiday.calendar.google.com
 +
|title=US Holidays
 +
}}
 +
 +
This example shows US holidays using the weekly view:
 +
 +
<nowiki>{{#widget:Google Calendar
 +
|id=usa@holiday.calendar.google.com
 +
|view=WEEK
 +
|title=US Holidays
 +
}}</nowiki>
 +
 
{{#widget:Google Calendar
 
{{#widget:Google Calendar
 
|id=usa@holiday.calendar.google.com
 
|id=usa@holiday.calendar.google.com
−
|color=528800
+
|view=WEEK
−
|title=Test2
+
|title=US Holidays
 
}}
 
}}
 +
 +
== Related Widgets ==
 +
 +
* [[Help:Widget:Google Spreadsheet]]
 +
* [[Help:Widget:Google Presentation]]
 +
* [[Help:Widget:Google Document]]

Latest revision as of 05:13, 30 January 2015

What is Widget:Google Calendar

The Google Calendar widget allows you to add Google Calendar widget to your wiki page.

It was originally created by Sergey Chernyshev for upcoming conference calendar on TechPresentations.org

How do you use Widget:Google Calendar?

To insert this widget, use the following code: 

{{#widget:Widget:Google Calendar
|id=<calendar-id>
}}

Parameters

This widget accepts many optional parameters, allowing you to customize how your shared calendar looks.

  • id - is a calendar ID (including @calendar.google.com, come match user email addresses) - can be found on calendar settings page
  • title - new title if you want to override calendar title (optional)
  • height and width define calendar dimensions, 100%x600 is default (only width can be defined in %).
  • color - events color (hex value. e.g. 5229A3) - only color used in Google's wizard can be used.
  • bgcolor - background/border color (hex value. e.g. ffcc66)
  • weekstart - first day of the week (1-7)
  • lang - interface language (en, fr, ru and etc).
  • view - default view MONTH (default)/WEEK/AGENDA)
  • timezone - time zone defined as a string like "America/New_York", should be automatically detected if omitted
  • pvttk - This key is used to access non-public calendars. All calendars must be on a single account. [Depreciated by Google: See https://support.google.com/calendar/answer/1631300?hl=en]
  • style - The style attribute to be applied to the iframe.
  • You can also trigger parts of the interface on and off:
    • showtitle - true (default)/false - shows title
    • shownav - true (default)/false - shows navigation arrows
    • showdate - true (default)/false - shows date
    • showtabs - true (default)/false - shows view tabs
    • showcals - true (default)/false - shows a calendar list
    • showprint - true (default)/false - shows a print icon
    • showtz - true (default)/false - shows timezone
    • border - true/false (default) - draws thin border around the widget
  • app - for Google Apps for Your Domain Calendars, specify the domain name for the account (http://www.google.com/calendar/hosted/yourdomain.com/render)

Share your Google Calendar

In order for the calendar to be visible on MozillaWiki, you need to share the calendar publicly. Step 1: Go to the settings page for the calendar you want to share.

Google Calendar share step 1.png

Step 2: Click the Share this Calendar link and modify the sharing settings as needed. You'll need to check Make this calendar public in order to allow all MozillaWiki visitors to see your embedded calendar. Please be sure you want to share the details of this calendar, including attendee details, before you share it.

Google Calendar share step 2.png

Step 3: Get the id for your shared calendar. You'll find this under the calendar's settings page, under the Calendar Details link towards the bottom:

Google Calendar - get id.png

Real Example

This example shows US holidays. 

{{#widget:Google Calendar
|id=usa@holiday.calendar.google.com
|title=US Holidays
}}

This example shows US holidays using the weekly view: 

{{#widget:Google Calendar
|id=usa@holiday.calendar.google.com
|view=WEEK
|title=US Holidays
}}

Related Widgets

Retrieved from "https://wiki.mozilla.org/index.php?title=Help:Widget:Google_Calendar&oldid=1051618"