Every Calendar +1 Documentation

Every Calendar +1 is a WordPress calendar / events plugin. Essentially it creates a new WordPress post type for calendars, and then allows users to create events, on these calendars. On a simple site only one calendar post will be needed and all events can be created on that calendar. For more complex sites (say something with regional offices that need there own calendar of events distinct from others) multiple calendars should be created and events added to the appropriate calendar.

Plugin Settings

You can configure the plugin by opening the EveryCal+1 Settings page. Here is a description of the options and what they mean for the administration and front end layout:

Should calendar authors be able to set the timezone of the calendar?

If this is disabled then all calendars will use the WordPress settings timezone.

If enabled the calendar edit page will show a drop down to choose a timezone from.

Pick which maps (e.g. Google Maps, Bing Maps) do you want to use for event locations.

Alternatively you can choose none to disable maps on all events.

Note: This feature is pluggable so support for any online map provider can be added.

Which external calendar providers (e.g. Google Calendar, Yahoo!) should be enabled?

You can enable as many as you wish. Any enabled providers will appear on the calendar edit page as an external source for calendar events - if you provide a URL for the provider its events will be displayed on that calendar on the site front end.

Note: This feature is pluggable so support for any online calendar provider can be added.

Which calendars should display featured events.

Events can be flagged as feature events on the event edit page.

Any calendar chosen will display all featured events from all calendars.

Specify the amount of time backwards and forwards the iCal, RSS, XML, etc... feeds from the calendar should include. You can also choose to include external calendars in the local feed, if you do, you should specify how long you want the external calendar data to be cached locally. The local cache stops the plugin from requesting the external calendar feed every time the local feed is built.

Controls how the calendar and events are rendered (i.e. the HTML) and a few display tweaks.

Export Icon: Should the export icon be displayed? And if so what image should it be?

Actions and Display Options:

        Show time on all day events: If an event is marked as all day show/don’t show the times

        Show (all day) on all day events: By default a “(all day)” is displayed disable it here

        Show popup on click: Show event details in a popup or go straight to event page

Calendar Template:

        You can click on the bolded heading for more help on the template

        Use these settings to change the HTML that is rendered for a calendar
Note: You MUST use id=”ecp1_calendar” on the container element

Event Template:

        You can click on the bolded heading for more help on the template

        Use these settings to change the HTML that is rendered for an event

        Note: You MUST use id=”ecp1_event” on the container element

Calendar Edit Page

Editing a calendar is very simple: click Calendars then the “New Calendar” button.

  1. Give your calendar a title (the same rules apply as per any WordPress post or page)
  2. Enter a brief description of the calendar

e.g. Events in Melbourne

The description cannot contain HTML (it will be filtered out).

  1. Use the colour picker to choose colours for the event text and background
  1. Optionally: Choose colours for feature events (if calendar shows featured events)
  1. External Events
  1. If you want to display events from an external calendar choose the provider
  2. Then paste the calendar link (must be supported by Adam Shaws’ Full Calendar)

For Google Calendar that is the XML feed link (the private one)

  1. You can also specify colours for events imported from this calendar
  1. Timezone: What timezone do events occur in (you are best to choose a country/city)
  2. Default View

Show as a month or week? (See below for both examples)

What day should be used as first day of the week?

Calendar Pages

This is a screenshot from the default 2011 theme when using a month view

Here is the same calendar for the week 15th August to 21st August in week view

Event Edit Page

The event edit page is extremely flexible. Create new events by clicking “New Event” or see a list of events by clicking on the “Events” link in the sidebar.

Give your event a title as per any normal WordPress post or page then dive into the options:

You can enter a website URL and / or a description for the event.

Descriptions are edited using the builtin WordPress WYSIWYG editor so can be formatted the same as any normal WordPress post or page. Descriptions are only shown on the event page not in the popups.

If you include only a URL then clicking on the “Read More” link will take users to that URL.

If you include only a description then the “Read More” link will go to the event page.

If you include both the “Read More” link will go to the event page with a “visit site” link added.

The start and finish date and times.
You should always enter a start and finish date (even for full day events).

As the event edit page says dates should be formatted as YYYY-MM-DD.

You can zoom the map in / out and it will be saved and shown to users at the level you set.

You must click the “Update” button to save any changes you make - they are not saved automatically even though the map has moved, changed, etc...

Gravity Forms

Events can also be imported from Gravity Forms (another WordPress plugin). This is provided as is and is and note that to import start / end dates you must be using PHP 5.3.0 or later. See http://au.php.net/manual/en/datetime.createfromformat.php for valid format strings.

Use the Gravity Forms plugin to create the following custom fields for your event post:

Once you have set ANY of these custom fields the Event admin screen will prompt you to import the values. You can set as many or as few as you like only the fields with values will be imported.

Once again start / end date importing requires PHP 5.3.0.

Note: Importing the values sets the plugin meta value: ecp1_ignore_gravity = Y. This means you will not be prompted again. If you want to be prompted to import again use the custom-fields at the bottom of the event edit page to remove or set this meta value to N.

Event Popups

On the calendar when you click an event you will see a popup with some summary details.

Note you can disable popups in the settings page (as described above) in which case the user will go straight to the event page or to the URL given on the event edit page above.

If you click on the “Location Map” link the popup will show a map:

You can enlarge the map by clicking “Large Map”:

Event Pages

This is a screenshot of the event page using the default template and the 2011 theme:

You can re-arrange the layout and change the titles by updating the Event Template on the settings page as described above. The template will be rendered as is so be very careful with your HTML.