Events API
Display mode: list
Show
show
Here are the tags available to show in event list:
| Tag | Description |
|---|---|
| __title__ | outputs the event title |
| __slug__ | the URL safe version of the title (more info) |
| __url__ | looks like "/events/slug" |
| __description__ | |
| __summary__ | |
| __group__ | comma separated list of group names |
| __groupslug__ | slug of one group associated with event |
| __cost__ | the cost of the event in dollars |
| __website__ | |
| __fulladdress__ | |
| __location__ | just the first line of the address |
| __city__ | |
| __state__ | |
| __coordname__ | name of the event coordinator |
| __coordemail__ | email address of the coordinator |
| __coordphone__ | phone number of the coordinator |
| __ commentNumber__ | number of comments for that event. I.E. Comments(3) |
| __eventstart__ | formattable date/time. Use __eventstart format='j/m/Y'__ a complete list of tags is available |
| __eventstartTwo__ | second formattable date/time |
| __eventstartThree__ | thrid formattable date/time |
| __eventend__ | formattable end date/time |
| __eventtimes__ | smart display of event start/end times |
| __startday__ | number for the day of the month |
| __startmonth__ | number for the month |
| __first__ | displays 'first' for the first record returned |
| __last__ | displays 'last' for the last record returned |
| __featured__ | displays 'featured' if record is featured |
| __registration__ | displays a link to a popup which handles the registration process. If registration is full. the text 'Registration Full' is displayed. |
| __imageurl__ |
The URL of the image for the event |
| __googlemap__ |
See Google Maps how to |
before_show
| Tag | Description |
|---|---|
| __date__ | formattable start date/time |
| __googlemap__ | See Googe Maps how to |
after_show
| Tag | Description |
|---|---|
| __date__ | formattable start date/time |
group_show
| Tag | Description |
|---|---|
| __title__ | will look like "November 15 2007" if grouped by day or "Novermber 2007" if by month |
Parameters
find_category
Only show items assigned to that category. Can find multiple categories with a comma separated list.
Example:
"find_category:category1,category2,category3",
find_group
Only show items assigned to that group. Can find multiple groups with a comma separated list.
Example:
"find_group:group1,group2,group3",
features
Only show items published as featured.
Example:
"features",
Monklet Example:
features="features"
nonfeatures
Only show items not published as featured.
Example:
"nonfeatures",
Monklet Example:nonfeatures="nonfeatures"
howmany
Sets the maximum number of items to display
Example:
"howmany:3",
howmanydays
Find items from the next X days. If neither howmanydays nor howmany are specified, the list will continue until every event has been listed once.
Example:
"howmanydays:10",
recurring
Decides if recurring events will be included in the list. Default is "yes".
Example:
"recurring:no",
repeatevent
If the list continues to a point when a recurring event would be listed again, repeatevents specifies if it will be shown. Default is "no".
Example:
"repeatevent:yes",
enablepast
Sets whether events that have concluded will be shown. Default is "no".
Example:
"enablepast:yes",
year/month/day
Returns all events for that year, month, or day.
Examples:
"year:2007","month:11","day:13",
"year:2007","month:11",
topLevelLink
Sets where event list pages will be on your site. Default is "events".
Example:
"topLevelLink:activities",
startdate
Will only show events that occur after this date. Format is flexible.
Example:
"startdate:12/7/07"
enddate
Will only show events that occur before this date. Format is flexible.
Example:
"enddate:12/17/07"
groupby
Groups the events by day or month.
Examples:
"groupby:day",
"groupby:month",
nocache
Prevents the output from being cached. Caching increases the speed of getContents considerably so this tag is not reccomended except for testing purposes, places where the output is random, events lists where the output is time sensitive, or context sensitve getContents. nocache does not apply to monklets.
example:
"nocache",
noecho
getConents default to 'print' the output. With noecho, you can assign the contents to a variable to be printed later. This is helpful if you have repeated content on a page.
example:
"noecho",
Display mode: detail
Show
show
Here are the tags available to show in event detail:
| Tag | Description |
|---|---|
| __title__ | outputs the sermon title |
| __slug__ | the URL safe version of the title (more info) |
| __url__ | looks like "/events/slug" |
| __description__ | |
| __summary__ | |
| __group__ | comma separated list of group names |
| __cost__ | the cost of the event in dollars |
| __website__ | |
| __fulladdress__ | |
| __location__ | just the first line of the address |
| __city__ | |
| __state__ | |
| __coordname__ | name of the event coordinator |
| __coordemail__ | email address of the coordinator |
| __coordphone__ | phone number of the coordinator |
| __ commentNumber __ | number of comments for that event. I.E. Comments(3) |
| __ commentList __ | displays a preformatted list of comments with a text box for new comments |
| __eventstart__ | formattable date/time. Use __eventstart format='j/m/Y'__ a complete list of tags is available |
| __eventstartTwo__ | second formattable date/time |
| __eventstartThree__ | thrid formattable date/time |
| __eventend__ | formattable end date/time |
| __eventtimes__ | smart display of event start/end times |
| __attendance__ | the attendance limit |
| __registration__ | displays a link to a popup which handles the registration process. If registration is full. the text 'Registration Full' is displayed. |
| __import__ |
returns the URL of an ICS file representing the event |
| __imageurl__ |
The URL of the image of the event |
| __googlemap__ | See Google Maps how to |
Parameters
find
Will accept either the plain slug or the date followed by slug. For example, an event titled "Weekly Activity" could be found with either "weekly-activity" or "2007-02-04-weekly-activity" assuming the start date is Feb. 4th 2007. The date options was added so that multiple events with the same title could be distinguised.
Display mode: Calendar
Parameters
headingletters
sets the number of letters in the day name at the top of the calendar. 4 or more will display the entire day name. Default is 1.
Example:
"headingletters:3",
topLevelLink
Sets where event list pages will be on your site. Default is "events".
Example:
"topLevelLink:activities",
numberOfMonths
sets the number of months to display
Example:
"numberOfMonths:3",
scrollingMonths
display all months at once or one at a time. Default is 'yes'.
Example:
"scrollingMonths:no",
nextPrev
If scrollingMonths is 'yes', sets the character or image users will click to toggle the month. Default is "»,«", which displays "« »".
Examples:
"nextPrev:>,<",
"nextPrev:<img src='next.jpg' alt='next' />,<img src='next.jpg' alt='previous' />",
monthid
Sets the html id's of the tables for months. Required if more than one calendar is on a page.
Example:
"monthid:eventCal",
cookie
Sets the name of the cookie used to remember which month the user viewed. Required if more than one calendar is on a page.
Example:
"cookie:calcookie",
eventTitles
Sets where the list of each days events is placed. Options are 'inDay'. 'belowMonth', 'followMouse'. Default is none. To use 'followMouse', you must include the following javascript in the head section of the page: "document.write('<div id="traildiv"></div>');"
Example:
"eventTitles:inDay",
eventTitlesXY
For "eventTitles:followMouse", sets how where the events box is in relation to the pointer. Default is '-170,0'.
Example:
"eventTitlesXY:5,5",
liclass
Sets the html class of of the li items around the event titles to the slug of a group the event is assigned to. "Group" is the only options presently.
Example:
"liclass:group",
features
Only show items published as featured.
Example:
"features",
Monklet Example:
features="features"
find_group
Only show items assigned to that group. Can find multiple groups with a comma separated list.
Example:
"find_group:group1,group2,group3",
enablepast
Sets whether events that have concluded will be shown. Default is "no".
Example:
"enablepast:yes",
recurring
Decides if recurring events will be included in the list. Default is "yes".
Example:
"recurring:no",
Display mode: Group
This will display a list of groups which have events assigned to them.
show
show
Here are the tags available to show in group list:
| Tag | Description |
|---|---|
| __title__ | outputs the group title |
| __slug__ | the URL safe version of the title (more info) |
| __email__ | the email address of the group coordinator |
| __type__ | The type of group it is |
parameters
find_category
Only show items assigned to that category. Can find multiple categories with a comma separated list.
Example:
"find_category:category1,category2,category3",