Google Calendar Macro

Last modified by Vincent Massol on 2024/07/05 17:43

cogDisplay a Google Calendar inside a wiki page
TypeDoc (Velocity Macro)
Category
Developed by

Ludovic Dubost

Rating
0 Votes
LicenseGNU Lesser General Public License 2.1
Bundled With

XWiki Standard

Description

The Google Calendar Macros are bundled starting with XWiki Enterprise 1.7.1 and XWiki Enterprise 1.8

We show on this page different ways to display a Google Calendar using the XWiki Google Calendar Macro. We are using the French holidays calendar as an example.

Simple display of a calendar

#includeMacros("XWiki.GoogleCalendarMacros")
#googlecal("french__fr@holiday.calendar.google.com")
Param nameDescription
idID of the google account to display the calendar for

googleCalendar.png

Showing a calendar with a custom size

#includeMacros("XWiki.GoogleCalendarMacros")
#googlecalsize("french__fr@holiday.calendar.google.com","200", "200")
Param nameDescription
idID of the google account to display the calendar for
widthWidth of the calendar
heightHeight of the calendar

googleCalendarCustomSize.png

Showing a fully custom calendar

#includeMacros("XWiki.GoogleCalendarMacros")
## $id $token $width $height $showTitle $showNav $showDate $showPrint $showTabs $showCalendars $showTz $mode $language $bgcolor $color $ctz $border
#googlecalcustom("french__fr@holiday.calendar.google.com","","800", "600","0","0","0","0","0","1","1","WEEK","fr","%232952A3","","","3")
Param nameDescription
idID of the google account to display the calendar for
tokenPrivate token giving access to the Calendar. This token is 32 chars long and can be retrieved in the "Agenda Details" when accessing your "Private URL" of your calendar. You should use this parameter with care as it will display all your calendar events to anybody that can access the page in which you use this macro
widthWidth of the calendar
heightHeight of the calendar
showTitle0 to not show the title
showNav0 to not show the navigation buttons allowing to switch to previous/next week or month
showDate0 to not show the current period displayed
showPrint0 to not show the print button
showTabs0 to not show the tabs allowing to switch between MONTH,WEEK,AGENDA mode
showCalendars0 to not show the calendars list drop down button
showTzShow a message saying the timezone of the dates/hours
modeDefault mode to display (empty is Month display, WEEK is Week dispaly, AGENDA is the event display)
languageLanguage to display in (en,fr,de,..)
bgcolorBackground color of the calendar in the form #255455
colorColor of the events in the form #234567
ctzTimezone in which to display the calendar. Leave empty for default calendar Timezone
borderBorder in pixels (1,2,3)

customGoogleCalendar.png

Showing a Private calendar

You will need a token to show a private calendar. This token is 32 chars long and can be retrieved in the "Agenda Details" when accessing your "Private URL" of your calendar. You should use this parameter with care as it will display all your calendar events to anybody that can access the page in which you use this macro

#includeMacros("XWiki.GoogleCalendarMacros")
#googlecalprivate("french__fr@holiday.calendar.google.com","wrongtoken")
#googlecalprivatesize("french__fr@holiday.calendar.google.com","wrongtoken","200","200")
Param nameDescription
idID of the google account to display the calendar for
tokenPrivate token giving access to the Calendar. This token is 32 chars long and can be retrieved in the "Agenda Details" when accessing your "Private URL" of your calendar. You should use this parameter with care as it will display all your calendar events to anybody that can access the page in which you use this macro
widthWidth of the calendar
heightHeight of the calendar

Get Connected