Mura CMS (http://getmura.com) plugin to display Google Calendars
ColdFusion
Switch branches/tags
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
eventHandlers
plugin
.gitignore
README
index.cfm

README

This plugin extends the Component display object with a MuraGCal sub-type (creates a new sub-type of Component) for displaying Google Calendar(s) on your Mura CMS site's pages.

It allows you to create separate display objects for as many calendars as you want, each with individual display settings, and include them (individually or in any combination) into your pages. 

CHANGELOG:
1.3.20120318
- plugin now allows |-delimited list of Calendar IDs and Event Colors to display aggregated calendar of multiple individual calendars
- IMPORTANT: 'Default' extended attributes set for MuraGCal component sub-type created by the plugin is no longer used and is deleted on install/update! If you have a previous version of this plugin installed and have created component(s) based on it and used the 'Default' attributes set to configure them, make sure you edit the components and copy the 'Default' settings to 'MuraGCal Settings' attributes set in the Extended Attributes tab.

1.3.20111112
- initial release in Mura Plugin Store

I. INSTALLATION / UPDATING
- Download the plugin ZIP file. No need to un-pack it. 
- Go to Site Settings->Global Settings->Plugins tab.
- Click [Choose File] button under "Upload new plugin" and select plugin's ZIP file.
- Click [Deploy] button.
- IMPORTANT: Select a value (does not matter which one) for ALL radio buttons. You do not need to set any other plugin options at this time. Selecting radio button options is required because otherwise Mura's pluginManager.cfc will throw an error. (For some reason when plugin options are rendered on install/update none of default values specified in config.xml are rendered on screen, thus plugin options defined as radio buttons do not exist on form submit unless selected).
- Select which site(s) to enable the plugin for under Site Assignment
- click Update button

Now the plugin is installed.

Updating the plugin is exactly the same, except in step 3 above first go to Plugin Settings page for MuraGCal Plugin (click on pencil icon in the plugin's row), and click 'Update Plugin Version' link.

IMPORTANT: Updating to version 1.3.20120318 or later? READ THE IMPORTANT NOTE IN CHANGELOG ABOVE!

II. USE
After installing the plugin, you will have a new Component/MuraGCal component type in the Type selector on Components->Add Component page in Mura Admin.
First, create a new MuraGCal type component:
- go to Components->Add Component
- select "Component / MuraGCal" under Type
- enter Title (some descriptive name that will tell you which calendar and view mode this component displays is best, like 'GCal - US Holidays - Month View')
- do not enter anything into Content - it will not be displayed anyway
- click on Extended Attributes tab and configure the calendar (see CONFIGURATION OPTIONS below)
- click [Publish] button at the bottom of page to save the component

Repeat the above for every Google Calendar you want to use in your site.

To display MuraGcal calendar(s) on your page:
- open page for editing in Site Manager
- click on Content Objects tab
- select Components under Available Content Objects
- select the calendar component(s) you want to include in the components list and add it to one of your page's display regions. *Make sure your page uses a template that has the display region you add the component to.*
- if necessary, add any other calendar components you created to the same page
- click one of the buttons at the bottom of the page to save your changes

Voila, you now have a Google Calendar (or several) displayed in your page.

III. CONFIGURATION OPTIONS

Available config options are the same as allowed by Google Embeddable Calendar Helper (accessible via Calendar Settings in Google Calendar).

Google Calendar ID [required, string] :
ID(s) of Google Calendar(s) to display. This can be found on Calendar Details tab in Google Calendar settings. Separate multiple calendar IDs with | (pipe).

Calendar Title [required, string] :
Title of Google Calendar. Display can be controlled using 'Show Calendar Title?' option (below). REQUIRED - even if you set 'Show Calendar Title' to No, you still must give the calendar a title.

Calendar Width (px) [required, numeric, default=300] :
Width of calendar container, in pixels.

Calendar Height (px) [required, numeric, default=300] :
Height of calendar container, in pixels.

Calendar Mode [default=Agenda] :
Calendar display mode. Select between Agenda, Month or Week view.

Calendar Position [default=Center] :
Calendar position/alignment on page. Select between Center, Left or Right. Left/Right alignment is done using CSS float.

Show Calendar Title? [default=Yes] :
Select to show or hide calendar title

Show Date Selector? [default=No] :
Select to show or hide date selector (pop-out date picker for jumping to a date).

Show Tabs? [default=No] :
Select to show or hide tabs for switching calendar diapley mode.

Show Navigation Buttons? [default=No] :
Select to show or hide prev/next navigation buttons.

Show Print Icon? [default=No] :
Select to show or hide 'Print calendar' icon.

Show Border? [default=No] :
Select to show or hide border around calendar container.

Week start day [default=Sunday] :
Select first day of week.

Events Color [required, string, default=#36C] :
Hex code (3 or 6 characters) of calendar's events colour in #xxx or #xxxxxx format, OR a |-delimited list of such if using multiple calendar IDs.

Background Color [required, string, default=#fff] :
Hex code of calendar's background colour in #xxx or #xxxxxx format.

Calendar Footer [optional, string, default=''] :
Enter text/html to display below the calendar. Experimental. Use at your own risk :)