Jamroom Logo Jamroom 5 Core
is now Open Source!
Follow Jamroom on Twitter!

This document applies to Jamroom 3 only!
For current Jamroom 4 Documentation, visit the main Jamroom Documentation section.

{jr_blog} Index {jr_cart}

{jr_calendar}


{jr_calendar} is used for embedding a Jamroom Calendar or Event List into a Jamroom template.

Parameters:

Name Type Required Default Description
type string no "events" the "type" parameter tells Jamroom what type of output you want - either "display" which will show a small, embeddable calendar, or "events", which is used for listing events.
template string no n/a calendar template to use for output if using the "display" type.
header_template string no n/a Only available for the "events" type, this defines the template to use as the HEADER template for the output.
row_template string no n/a Only available for the "events" type, this defines the template to use as the ROW template for the output.
footer_template string no n/a Only available for the "events" type, this defines the template to use as the FOOTER template for the output.
tpl_dir string no "skin" directory containing the Jamroom template - can be "skin" or "theme"
theme string no n/a if a tpl_dir value of "theme" is given, then the name of the Artist Theme needs to be passed in with the theme parameter
skin string no n/a The skin parameter tells the function to look in the skins/<skin_name> directory to find the template.  If this is not supplied, the function will look in the Active Skin directory.
band_id mixed no n/a If a single band_id (or array of band_ids) is is given, then only events from the given ID's will be returned.
event_location string no n/a If an event_location parameter is given, then only events from the given location will be returned. a '%' sign can be used as a wild card in the location
range integer no n/a If given a "range" (in days), Jamroom will only show events that fall within the given range - i.e. a "range" of "15" would display all events happening in the next 15 days, calculated from the current day.
hour integer no n/a If given, the "hour" parameter will force Jamroom to only return Events that happen on that hour of the day.  Hour should be in 24 hour format - i.e. "17" would be 5pm.
day integer no n/a If given, the "day" parameter will force Jamroom to only return Events that happen on the given day. Format should be 2 digit day - i.e. "12"
month integer no n/a If given, the "month" parameter will force Jamroom to only return Events that happen in the given Month. Format should be 2 digit month - i.e. "03" for March.
year integer no n/a If given, the "year" parameter will force Jamroom to only return Events that happen in the given year.  Format is 4 digits - YYYY.
limit integer no n/a limits the number of events returned to the "limit" amount.
assign string no n/a optional "assign" parameter - if given, the output of the function will be assigned to a template variable of the same name.

 

Examples:

embedded {jr_calendar} function call in template, displaying an in line calendar for current month:

{jr_calendar type="display" template="jr_calendar_display_inset.tpl"}


embedded {jr_calendar} function call display an in line list of events for next 21 days at "Chicago" locations:

{jr_calendar template="jr_calendar_list.tpl" range="21" location="%Chicago%"}

{jr_blog} page 132 of 185 {jr_cart}
Solutions Products Support Community Company
Social Media Platform
Social Networking Software
Musician Website Manager
Community Builder
Jamroom 5
Jamroom 5 Modules
Jamroom Marketplace
Support Forum
Documentation
Support Center
Contact Support
Community Forum
Member Sites
Developers
About Us
Contact Us
Privacy Policy
©2003 - 2024 The Jamroom Network