Plugin Events
This Wiki Plugin displays upcoming events from the tiki site's calendars in a formatted table.Table of contents
Usage and Parameters
To use this plugin in a wiki page, use the syntax:Syntax for EVENT plugin
{EVENTS(calendarid=>1|2, maxdays=>365, max=>-1 , datetime=>0|1, desc=0|1)}{EVENTS}| Parameter | Accepted values | Default | Effect | Required? | Since |
|---|---|---|---|---|---|
| calendarid | ID numbers for the site calendars whose events are to be displayed, separated by vertical bars ("|"). | none | Future events from these calendars will be displayed (unless limited by other parameter settings). Future avents are displayed in ascending date order (that is, soonest ones first) across all the calendars referenced by this parameter. | y | |
| maxdays | Any number | 365 | Events occurring within this number of days in the future from today will be included in the list (unless limited by other parameter settings). 0 or negative numbers will result in all future events being displayed (unless limited by other parameter settings). | n | |
| max | Any number | 10 | Maximum number of events to display. 0 or negative numbers will result in all future events being displayed (unless limited by other parameter settings). | n | |
| datetime | 0 or 1 | 1 | Time is displayed with the date when set to 1 or by default. Date is always shown. | n | |
| desc | 0 or 1 | 1 | Displays the description of the event from the calendar when set to 1 or by default. | n |
Example
Below is an example using the 2 calendars at http://dev.tikiwiki.org/tiki-calendar.php. There are two calendars (ID's 1 and 2) and the code below accesses both of them.This code,
EVENT Plugin with datetime, max and maxdays parameters set
{EVENTS(calendarid=>1|2, datetime=>1, max=>8, maxdays=>15)}{EVENTS}Produced the following on May 3, 2009:
Although the max is set at eight, only four events are displayed. This is because there were only four events within 15 days (the maxdays setting) of the date the screenshot was made.
