Mod Events Calendar Documentation

Events Calendar Module Help

This module is designed to display the current month with clickable events and possibly the last and next month. A set of optional parameters can be specified to alter the behavior of this module via the administration module management parameters window. Although this module is not packaged with the events component, it is available for download at mosforge.net: mod_events_cal. It will need to be installed separately and made visible (ie. published) thru the mambo admin interface similarly to any other module.

Note also that the following documentation refers to the module parameters being used in the module parameter list thru the mambo module backend interface. This is the default usage and takes priority over any parameters which may be specified within the events component configuration interface here.

Output Format:

The module outputs the events within an html table representing the current month. The previous (last) and next month can be configured to be shown always or depending on published events and further restricted by a day limit when it should be shown.

Module Parameters:

This module will support the use of the following optional customization parameters thru the Mambo admin module management interface.

Parameters Definitions:

displayLastMonth

= none or 0 (default) : never display a Last Month's calendar.
= always : always display a Last Month's calendar.
= always,r : display a Last Month's calendar. Stop displaying Last Month's calendar if this month's current day of month is at least r.
= events : display a Last Month's calendar only if there were scheduled events in that month.
= events,r : display Last Month's calendar only if there were events scheduled for that month. Stop displaying Last Month's calendar if this month's current day of month is at least r.

displayNextMonth

= none or 0 (default) : never display a Next Month's calendar.
= always : always display a Next Month's calendar
= always,r : display a Next Month's calendar. Start displaying Next Month's calendar if this month's current day of month is within r days of the first day of Next month.
= events : display a Next Month's calendar (with current month) only if there are future scheduled events in that month.
= events,r : display Next Month's calendar only if there are events scheduled for that month.Start displaying Next Month's calendar if this month's current day of month is within r days of the first day of Next month.

Examples:

Ex. 1.

displayLastMonth=always,7
displayNextMonth=always,7
These parameters will show the previous month's calendar always (even if there was no event) until the 7th day of the current month. It will show the next months' calendar if there are only 7 days left in the current month.

Ex. 2.

displayNextMonth=events,14
This parameter will show the next months' calendar if there are only 14 days left in the current month.