Events Calendar Module

Version 1.0

Description

An Event Calendar that lists upcoming events and actions

Configuration

Below are the list of settings that the user can choose from for each configured data object of the Events Calendar Module module.

Configurable Settings
Number	Configurable Variable	Description	Input Type	Input Rules
1	Name	The Name of this Events Calendar Module. - This will also appear as the HTML title on top of the browser and will appear as part of the page title in search engine listings - keep it short and meaningful!	text	Mandatory Field. Plain Text Only.
2	Description	A short description of this Events Calendar Module. - This will be added into the HTML meta tag for the page in question and is important for search engines, so use several specifically descriptive words that match the content of the object. This will also appear on the management screens for this site. It is a good idea to give a brief description which will enable you to quickly identify which entries are which in lists of objects.	textarea	Mandatory Field. Plain Text Only.
3	Image	An icon file associated with this Events Calendar Module. - This allows you to link to the Events Calendar Module with an image instead of a text string. Enter the name of a valid local file.	text	Optional Field. Plain Text Only.
Events Calendar Module Basic Information
4	Short Title	The title that appears on top of the Page - A typical title would be Latest News	text	Mandatory Field. Plain Text Only.
5	Full title	The full title of the events calendar. - eg: Events Calendar	text	Optional Field. Plain Text Only.
Events Filter Settings
6	Category Filter	A choice of multiple categories from the site	multifilterselect	A selection from the topic and region and language Tables
7	Specific Author?	Enter the name of the specific author whose events will be listed (if any)	text	Optional Field. Plain Text Only.
8	Default Display Mode	What should the default display mode of the calendar be? - can be changed by user preferences	radio	Options: monthly, biweekly, weekly
9	Unmoderated	show unmoderated events? - If you check this setting, users will see all events, even those that have been hidden - use with care!	checkbox	On / Off
Event Page Text Settings
10	Calendar Notice	Allows you to make a piece of html appear at the top of the event calendar - Can be useful to advertise important events	textarea	Optional Field. HTML / PHP input allowed.
11	Calendar End Note	Allows you to make a piece of html appear at the bottom of every page - Can be useful to advertise important events	textarea	Optional Field. HTML / PHP input allowed.
12	No Stories Message	The message the will be displayed to the user when no articles are found that match their query - Try "Sorry, but no stories match your query"	textarea	Optional Field. HTML / PHP input allowed.
Various textual tidbits
13	Weekly Text	The text inviting the user to view weekly listings. - something like "view events by week"	text	Mandatory Field. Plain Text Only.
14	Monthly Text	The text inviting the user to view monthly listings. - something like "view events by month"	text	Mandatory Field. Plain Text Only.
15	Biweekly Text	The text inviting the user to view biweekly listings. - something like "view events by fortnight"	text	Mandatory Field. Plain Text Only.
16	Year text	The word "Year" - self explanatory no?	text	Mandatory Field. Plain Text Only.
17	Next text	The word "Next" - self explanatory no?	text	Mandatory Field. Plain Text Only.
18	Previous text	The word "Previous" - self explanatory no?	text	Mandatory Field. Plain Text Only.
19	Introductory Text	A piece of text that introduces the user to the calendar page - Put in an explanation of what the user can do here.	textarea	Optional Field. HTML / PHP input allowed.
Page Header Navigation Settings
20	Story Context	Show the topic / region / language / type of the stories? - This setting governs what navigation will appear on the top of the newswire column.	checkbox	On / Off
21	Next Pages Link	Show links to following and subsequent pages of the newswire? - This setting governs what navigation will appear on the top of the newswire column.	checkbox	On / Off
22	Other Modules Links?	Show links to the other modules of the site for alternative views? - This setting governs what navigation will appear on the top of the newswire column.	checkbox	On / Off
Page Footer Navigation Settings
23	Story Context	Show the topic / region / language / type of the stories? - This setting governs what navigation will appear at the bottom of the newswire column.	checkbox	On / Off
24	Next Pages Link	Show links to following and subsequent pages of the newswire? - This setting governs what navigation will appear at the bottom of the newswire column.	checkbox	On / Off
25	Other Modules Links?	Show links to the other modules of the site for alternative views? - This setting governs what navigation will appear at the bottom of the newswire column.	checkbox	On / Off
References to other objects
26	Page Layout	The Layout of the Event Calendar Page	reference	A reference to a data object of type page
27	Article View	The Article View that will be linked to for each event (choose none to use primary site article view module)	reference	A reference to a data object of type article
Access Control for this Events Calendar Module
Protect this Events Calendar Module from unauthorised users and from being used in other sections of the site
28	Protected	Should This Events Calendar Module be hidden from the public? - Check this box if you want this Events Calendar Module to be only visible to editors on the site. This can be useful for keeping certain pages hidden from public view.	checkbox	On / Off
29	Shared?	Should This Events Calendar Module be available to add to menus etc on other sections of this site? - Shared Data Objects can be added to menus, lists, pages and so on throughout the site, no matter what section the page that includes them is from. Objects that are not shared are only available within the site section where they are owned.	checkbox	On / Off

Display Modes

1. Short Title
2. Icon
3. Icon And Title
4. Long Title
5. Full Page

Bugs

To do List and requested features

--Oscailt Auto-generated Documentation 09 Jan 2006