====== Google Calendar Plugin ======

---- plugin ----
description: Embeds a Google Calendar into a wiki page
author     : Kite 
email      : Kite@puzzlers.org
type       : syntax
lastupdate : 2011-12-26
compatible : Binky
depends    : 
conflicts  : 
similar    : 
tags       : google, calendar, embed

downloadurl: https://github.com/lupo49/plugin-google_cal/tarball/master
sourcerepo:  https://github.com/lupo49/plugin-google_cal
bugtracker:  https://github.com/lupo49/plugin-google_cal/issues
----

This plugin integrates a [[http://www.google.com/intl/en/googlecalendar/overview.html|Google Calendar]] into a DokuWiki page.

With a serious nod to [[plugin:iframe]] by [[chris@jalakai.co.uk|Christopher Smith]].  Minimal changes were made (improvements, I hope).


===== Installation =====

^  Download | [[https://github.com/lupo49/plugin-google_cal/tarball/master|Current archive from github]] |


===== Syntax =====

  {{cal>kite@puzzlers.org[614,640]|Kite's Test}}

Pretty simple:
  * an email address with a shared/private calendar.
  * the [614,640] are width and height -- these are both optional, but must be enclosed in [ , ] if present.  If only one value is supplied, it is assumed to be the height.
  * the | marks the 'alternate text' used for a title; otherwise you get the default configured in Google.

  
===== Configuration =====

The plugin has one configuration setting, which can be set via the admin/configuration settings page.

  * $gcal_js_ok --- default value - ''false'', set to ''true'' to enable JavaScript URLs.
  * [[plugin:iframe]] by [[chris@jalakai.co.uk|Christopher Smith]] uses $js_ok 

I don't know if it is better to allow one value for both plugins, or not.  Also, due to the limited nature of this plugin, I don't think this option will actually make any difference.  It has not been tested.


===== Development =====

==== Changelog ====

{{rss>https://github.com/lupo49/plugin-google_cal/commits/master.atom date}}


===== FAQ =====

==== Specify just one calendar of Googles Calendars ====

I have several Google Calendars tied to my Gmail account.  Is there a way to specify just one calendar, or a sub-group (i.e. 3 out of 5 calendars).  --- //[[jungerle@gmail.com|Jason]] 2007-06-08 18:51//

The quick answer is yes.  At the Google calendar webpage, click on manage calendars.  Then click on the particular calendar that you are interested in using.  In the Calendar Address box you should see a calendar id that looks like a randomly generated bunch of letters @group.calendar.google.com.  Plug this in as the address instead of %%{{cal>yourname@gmail.com}}%%. I.e. %%{{cal>[randomletters]@group.calendar.google.com}}%%.  Seems to be working for me. Cheers. Ethan Farquhar 2007-08-13

==== Have calendar appear in a different language ====
I needed to display the calendar in French.  It would be nice if you could include a language variable in the future, but for now, here is how I did it:

Edit the following line near the end of syntax.php
  $renderer->doc .= "<iframe src='http://www.google.com/calendar/embed?src=$url&amp;height=$h&amp;title=$alt'".
and insert the following after $alt and before the '
  &amp;hl=fr
where fr = French, or use any two letter language code.
     
--- //[[doug.higby@gmail.com|DougH]] 2012-02-07 13:45//
==== Use different colors ====

I went to /My calendar/Settings/, selected a calendar, and under "Embed this Calendar" section, I clicked "Customize the color, size, and other options". This opens the editor for their >>frame code.  Select the calendars you want to display in the iframe, and the code will update.  

Remove this part:

<code xml>
<iframe src="http://www.google.com/calendar/embed?height=600&amp;wkst=1&amp;bgcolor=%23FFFFFF&amp;
</code>
That should leave you with "src=%your email address%.....etc.", copy everything after "src=" all the way to the end of the Time Zone section.
This should leave you with something like this:

<code=xml>
{{cal>myemailaddress%40gmail.com&amp;color=%231B887A&amp;src=xxxxrandomnumberhashxxxxxx%40group.calendar.google.com&amp;color=%232952A3&amp;src=xxxxrandomnumberhashxxxxxx%40group.calendar.google.com&amp;color=%23705770&amp;src=xxxxrandomnumberhashxxxxxx%40group.calendar.google.com&amp;color=%230D7813&amp;src=xxxxrandomnumberhashxxxxxx%40group.calendar.google.com&amp;color=%232952A3&amp;src=xxxxrandomnumberhashxxxxxx%40group.calendar.google.com&amp;color=%235229A3&amp;src=xxxxrandomnumberhashxxxxxx%40group.calendar.google.com&amp;color=%230D7813&amp;ctz=America%2FChicago[800,600]|It works!}}
</code>     
--- //[[bdunnaway@gmail.com|BrentDunnaway]] 2009-08-07 13:49//


===== Discussion =====

> Hi - I was wondering if it was possible to login to the calendar automatically when the page loads? Thanks - David

  * would there maybe be away to implement something similar to the workaround Giloux found in the case of the iCalendar plugin (https://www.dokuwiki.org/plugin:icalendar#authentication)?
  * Maybe implement something like this: ''http(s):[slash-slash]username:password[at]host:port/url-path'' //This will enable you to have direct access to pages that require authentication and/or are accessed via non-standard ports. Many system status pages are configured in this manner.// It doesn't work yet, I tried. Even when replacing ":" with "%3A"
  * Or something like [[http://www.php.net/manual/en/features.http-auth.php|this]]


> feature request: Is there any way (syntax or other) to have the calendar/frame displayed at the center of the page rather than on the left side? Tx -a-

> Hi, the frame displays "Events from one or more calendars could not be shown here because you do not have the permission to view them." until I log into my Google account... Obviously... Would there be a way to prevent that? Is there any setting in my Google account I could change? **Should I make the Calendar public** or anything? What would be the consequences from a security point of view? Tx -a-

> <del>Hi, although the default view mode in my Google account is "week", the calendar inside the frame on my wiki keeps on displaying the "month" view by default (I need to click on "week" every time). Is there any way to change that permanently? PROBABLY by using some trick similar to the one of //BrentDunnaway// to change colors... Tx -a-</del>

[EDIT]

Fixed!: I managed to have something looking more like what I wanted using this string: (capitals should be replaced by your desired values
  {{cal>GMAILUSERNAME%40gmail.com&amp&title=FIRSTWORD%20SECONDWORD%20THIRDWORD%20FOURTHWORD&amp&mode=WEEK&amp&amp&wkst=2&amp&bgcolor=%23666666&amp&color=%232952A3&amp&ctz=Europe%2FZurich"[DESIREDWIDTH,DESIREDHEIGHT]|TITLEDISPLAYEDINDW}}  

This was modified from what googles gives me in code (Calendar details -> embed this calendar)

  * For the ''title'': %26 (instead of a word) = "&"
  * For the ''mode'': ''WEEK'' is in capitals anyway
  * The ''bgcolor'' value defines the background color (here = dark grey)
  * ''color'' is the color of the events on the calendar (here: blue)
  * ''ctz'' is the time zone
  * ''wkst'' = week start on (1 = Sunday; 2= Monday; 7 = Saturday)
[END-OF-EDIT]

==== Future Directions  ====

  * This should be able to cope with an <iframe...></iframe> from Google; wasn't able to make that work this time around due to some parsing and regular expression problems.
    * This would be **GREAT**! :-D
  * This should probably check the user's email but ... since it has to go to Google's calendar engine anyway, I can rely on their response to be "reasonable" for now.