Home › Templates ›

Template Variables

The following table presents all Sundial template variables and their usage.

Variable Properties
Add_Event_Link
Description Generates link and associated code offering the viewer the ability to add a new event using the event editting interface. If the user isn't presently within a valid Sundial administrative session, the user will be prompted to login to Sundial.
Always Available/Required Yes
Attributes
image Specifies the location of the image to be used as the add event link
text Specifies the text to be used as the add event link or, if an image is specified, specifies the image's alt attribute
width If the js method is used to open the event editor in a new window, specifies the width of the event editor window.
height If the js method is used to open the event editor in a new window, specifies the height of the event editor window.
onMouseOver Specifies the text to be displayed within a window's status area when the mouse pointer hovers over the add event link
onMouseOut Specifies the text to be displayed within the window's status area when the mouse pointer moves from the add event link
method

Specifies the method by which the event editor will be opened. Acceptable values include the following:

  • js - Specifies javascript code should open window. The js method allows for greater control over window attributes
  • target - Specifies the target attribute of an anchor tag should specify where the event editor open/appear
target If the target method is used to open the event editor, specifies the link's target.
Example %Add_Event_Link image="http://www.something.com/images/addEvent.gif" method="target" target="_blank" text="Add A New Event (Login Required)" onMouseOver="Click to add a new event to the calendar." onMouseOut="" width="600" height="600"%</p>
Edit_Event_Link
Description Generates link and associated code offering the viewer the ability to edit a given event using the event editting interface. If the user isn't presently within a valid Sundial administrative session, the user will be prompted to login to Sundial.
Always Available/Required Yes
Attributes
image Specifies the location of the image to be used as the edit event link
text Specifies the text to be used as the edit event link or, if an image is specified, specifies the image's alt attribute
width If the js method is used to open the event editor in a new window, specifies the width of the event editor window.
height If the js method is used to open the event editor in a new window, specifies the height of the event editor window.
onMouseOver Specifies the text to be displayed within a window's status area when the mouse pointer hovers over the edit event link
onMouseOut Specifies the text to be displayed within the window's status area when the mouse pointer moves from the edit event link
method

Specifies the method by which the event editor will be opened. Acceptable values include the following:

  • js - Specifies javascript code should open window. The js method allows for greater control over window attributes
  • target - Specifies the target attribute of an anchor tag should specify where the event editor open/appear
target If the target method is used to open the event editor, specifies the link's target.
Example %Edit_Event_Link image="http://www.something.com/images/editEvent.gif" method="target" target="_blank" text="Edit This Event (Login Required)" onMouseOver="Click To Edit This Event" onMouseOut="" width="600" height="600"%</p>
End_Date_Time
Description Time stamp indicating the end date and time of an event
Correspondence Event > Event Name and Date > Start Date & Start Time
Attributes
date Specifies the format string in which the date portion of the end date of an event should be returned. The default format string is 'F d, Y'
time Specifies the format string in which the time portion of the end time of an event should be returned. The default format string is 'g:i a'
showTimezone Toggle the display of the timezone in which the event's end time is presented. The default setting is 'Y', set to 'N' to turn off.
transform A comma separated list of transformations that may be applied to the value of the template variable. Transformations are applied as ordered in the list provided from left to right. Some transformations take attributes, which are specified by appending a colon (:) to the end of the transformation name, followed by the parameter value.
  • collapse - removes excessive newline characters
  • htmldecode - converts all HTML entities to their applicable characters
  • htmlencode - converts all applicable characters to HTML entities
  • lower - makes the value lowercase
  • ltrim - strips whitespace from the beginning of the value
  • nl2br - inserts HTML line breaks before all newlines in a value
  • reverse - reverses a value
  • rtrim - strips whitespace from the end of a value
  • striptags - strips tags from a value
  • title - converts a value to title case
  • trim - strips whitespace from the beginning and end of a string
  • truncate - outputs only the first 80 characters of a string and appends an ellipsis. Optional parameters allow you to override these options (e.g., transform='truncate:...:90').
  • ucfirst - makes a value's first character uppercase
  • ucwords - uppercase the first character of each word within the value
  • upper - makes a value uppercase
  • utf8_encode - encodes a string to UTF-8
Event_Contact_Email
Description The email address of the contact person/entity for the event
Correspondence Event > Event Contact Person/Entity > Email Address
Always Available/Required Yes
Attributes
transform A comma separated list of transformations that may be applied to the value of the template variable. Transformations are applied as ordered in the list provided from left to right. Some transformations take attributes, which are specified by appending a colon (:) to the end of the transformation name, followed by the parameter value.
  • collapse - removes excessive newline characters
  • htmldecode - converts all HTML entities to their applicable characters
  • htmlencode - converts all applicable characters to HTML entities
  • lower - makes the value lowercase
  • ltrim - strips whitespace from the beginning of the value
  • nl2br - inserts HTML line breaks before all newlines in a value
  • reverse - reverses a value
  • rtrim - strips whitespace from the end of a value
  • striptags - strips tags from a value
  • title - converts a value to title case
  • trim - strips whitespace from the beginning and end of a string
  • truncate - outputs only the first 80 characters of a string and appends an ellipsis. Optional parameters allow you to override these options (e.g., transform='truncate:...:90').
  • ucfirst - makes a value's first character uppercase
  • ucwords - uppercase the first character of each word within the value
  • upper - makes a value uppercase
  • utf8_encode - encodes a string to UTF-8
Event_Contact_Info
Description Formatted contact information directing viewers to the event's contact person/entity. Only populated contact information fields are displayed.
Always Available/Required Yes
Attributes
transform A comma separated list of transformations that may be applied to the value of the template variable. Transformations are applied as ordered in the list provided from left to right. Some transformations take attributes, which are specified by appending a colon (:) to the end of the transformation name, followed by the parameter value.
  • collapse - removes excessive newline characters
  • htmldecode - converts all HTML entities to their applicable characters
  • htmlencode - converts all applicable characters to HTML entities
  • lower - makes the value lowercase
  • ltrim - strips whitespace from the beginning of the value
  • nl2br - inserts HTML line breaks before all newlines in a value
  • reverse - reverses a value
  • rtrim - strips whitespace from the end of a value
  • striptags - strips tags from a value
  • title - converts a value to title case
  • trim - strips whitespace from the beginning and end of a string
  • truncate - outputs only the first 80 characters of a string and appends an ellipsis. Optional parameters allow you to override these options (e.g., transform='truncate:...:90').
  • ucfirst - makes a value's first character uppercase
  • ucwords - uppercase the first character of each word within the value
  • upper - makes a value uppercase
  • utf8_encode - encodes a string to UTF-8
Example

%Event_Contact_Info% might produce the following if all event contact fields have values.

For further information regarding this event, please contact %Event_Contact_Name% by sending email to %Event_Contact_Email% or by calling %Event_Contact_Phone%.
Event_Contact_Name
Description The name of the contact person/entity for the event
Correspondence Event > Event Contact Person/Entity > Name
Always Available/Required Yes
Attributes
transform A comma separated list of transformations that may be applied to the value of the template variable. Transformations are applied as ordered in the list provided from left to right. Some transformations take attributes, which are specified by appending a colon (:) to the end of the transformation name, followed by the parameter value.
  • collapse - removes excessive newline characters
  • htmldecode - converts all HTML entities to their applicable characters
  • htmlencode - converts all applicable characters to HTML entities
  • lower - makes the value lowercase
  • ltrim - strips whitespace from the beginning of the value
  • nl2br - inserts HTML line breaks before all newlines in a value
  • reverse - reverses a value
  • rtrim - strips whitespace from the end of a value
  • striptags - strips tags from a value
  • title - converts a value to title case
  • trim - strips whitespace from the beginning and end of a string
  • truncate - outputs only the first 80 characters of a string and appends an ellipsis. Optional parameters allow you to override these options (e.g., transform='truncate:...:90').
  • ucfirst - makes a value's first character uppercase
  • ucwords - uppercase the first character of each word within the value
  • upper - makes a value uppercase
  • utf8_encode - encodes a string to UTF-8
Event_Contact_Phone
Description The phone number of the contact person/entity for the event
Correspondence Event > Event Contact Person/Entity > Phone Number
Always Available/Required No
Attributes
transform A comma separated list of transformations that may be applied to the value of the template variable. Transformations are applied as ordered in the list provided from left to right. Some transformations take attributes, which are specified by appending a colon (:) to the end of the transformation name, followed by the parameter value.
  • collapse - removes excessive newline characters
  • htmldecode - converts all HTML entities to their applicable characters
  • htmlencode - converts all applicable characters to HTML entities
  • lower - makes the value lowercase
  • ltrim - strips whitespace from the beginning of the value
  • nl2br - inserts HTML line breaks before all newlines in a value
  • reverse - reverses a value
  • rtrim - strips whitespace from the end of a value
  • striptags - strips tags from a value
  • title - converts a value to title case
  • trim - strips whitespace from the beginning and end of a string
  • truncate - outputs only the first 80 characters of a string and appends an ellipsis. Optional parameters allow you to override these options (e.g., transform='truncate:...:90').
  • ucfirst - makes a value's first character uppercase
  • ucwords - uppercase the first character of each word within the value
  • upper - makes a value uppercase
  • utf8_encode - encodes a string to UTF-8
Event_Created
Description Time stamp indicating the date and time an event was created within Sundial
Correspondence (internal)
Attributes
transform A comma separated list of transformations that may be applied to the value of the template variable. Transformations are applied as ordered in the list provided from left to right. Some transformations take attributes, which are specified by appending a colon (:) to the end of the transformation name, followed by the parameter value.
  • collapse - removes excessive newline characters
  • htmldecode - converts all HTML entities to their applicable characters
  • htmlencode - converts all applicable characters to HTML entities
  • lower - makes the value lowercase
  • ltrim - strips whitespace from the beginning of the value
  • nl2br - inserts HTML line breaks before all newlines in a value
  • reverse - reverses a value
  • rtrim - strips whitespace from the end of a value
  • striptags - strips tags from a value
  • title - converts a value to title case
  • trim - strips whitespace from the beginning and end of a string
  • truncate - outputs only the first 80 characters of a string and appends an ellipsis. Optional parameters allow you to override these options (e.g., transform='truncate:...:90').
  • ucfirst - makes a value's first character uppercase
  • ucwords - uppercase the first character of each word within the value
  • upper - makes a value uppercase
  • utf8_encode - encodes a string to UTF-8
Event_Created_By
Description The numeric id of the user entity who created the event within the calendar system.
Correspondence (internal)
Always Available/Required Yes
Attributes
transform A comma separated list of transformations that may be applied to the value of the template variable. Transformations are applied as ordered in the list provided from left to right. Some transformations take attributes, which are specified by appending a colon (:) to the end of the transformation name, followed by the parameter value.
  • collapse - removes excessive newline characters
  • htmldecode - converts all HTML entities to their applicable characters
  • htmlencode - converts all applicable characters to HTML entities
  • lower - makes the value lowercase
  • ltrim - strips whitespace from the beginning of the value
  • nl2br - inserts HTML line breaks before all newlines in a value
  • reverse - reverses a value
  • rtrim - strips whitespace from the end of a value
  • striptags - strips tags from a value
  • title - converts a value to title case
  • trim - strips whitespace from the beginning and end of a string
  • truncate - outputs only the first 80 characters of a string and appends an ellipsis. Optional parameters allow you to override these options (e.g., transform='truncate:...:90').
  • ucfirst - makes a value's first character uppercase
  • ucwords - uppercase the first character of each word within the value
  • upper - makes a value uppercase
  • utf8_encode - encodes a string to UTF-8
Event_Date_Time
Description Displays a formatted event start and end dates/times taking account of events which span days.
Always Available/Required Yes
Attributes
date Specifies the format string in which the date portion of the start and end dates of an event should be returned. The default format string is 'F d, Y'
time Specifies the format string in which the time portion of the start and end times of an event should be returned. The default format string is 'g:i a'
showTimezone Toggle the display of the timezones in which the event's start and end times are presented. The default setting is 'Y', set to 'N' to turn off.
transform A comma separated list of transformations that may be applied to the value of the template variable. Transformations are applied as ordered in the list provided from left to right. Some transformations take attributes, which are specified by appending a colon (:) to the end of the transformation name, followed by the parameter value.
  • collapse - removes excessive newline characters
  • htmldecode - converts all HTML entities to their applicable characters
  • htmlencode - converts all applicable characters to HTML entities
  • lower - makes the value lowercase
  • ltrim - strips whitespace from the beginning of the value
  • nl2br - inserts HTML line breaks before all newlines in a value
  • reverse - reverses a value
  • rtrim - strips whitespace from the end of a value
  • striptags - strips tags from a value
  • title - converts a value to title case
  • trim - strips whitespace from the beginning and end of a string
  • truncate - outputs only the first 80 characters of a string and appends an ellipsis. Optional parameters allow you to override these options (e.g., transform='truncate:...:90').
  • ucfirst - makes a value's first character uppercase
  • ucwords - uppercase the first character of each word within the value
  • upper - makes a value uppercase
  • utf8_encode - encodes a string to UTF-8
Example

  • For non-spanning, non-all day events, the date and time appear much as follows:

    June 24, 2004 from 6:00 am to 11:00 am EDT

  • For non-spanning, all day events, the date and time appear much as follows:

    June 25, 2004, All Day Event

  • For day spanning, non-all day events, the date and time appear much as follows:

    June 03, 2004 to June 21, 2004 from 9:00 am to 12:00 am EDT

  • For day spanning, all day events, the date and time appear much as follows:

    June 03, 2004, All Day Event

  • If the date attribute is set to blank, the 'from' and ',' are removed as appropriate from the above examples.
Event_Description
Description The full description of the event. This field may contain formatted text.
Correspondence Event > Additional Information > Full Event Description/Summary
Always Available/Required No
Attributes
transform A comma separated list of transformations that may be applied to the value of the template variable. Transformations are applied as ordered in the list provided from left to right. Some transformations take attributes, which are specified by appending a colon (:) to the end of the transformation name, followed by the parameter value.
  • collapse - removes excessive newline characters
  • htmldecode - converts all HTML entities to their applicable characters
  • htmlencode - converts all applicable characters to HTML entities
  • lower - makes the value lowercase
  • ltrim - strips whitespace from the beginning of the value
  • nl2br - inserts HTML line breaks before all newlines in a value
  • reverse - reverses a value
  • rtrim - strips whitespace from the end of a value
  • striptags - strips tags from a value
  • title - converts a value to title case
  • trim - strips whitespace from the beginning and end of a string
  • truncate - outputs only the first 80 characters of a string and appends an ellipsis. Optional parameters allow you to override these options (e.g., transform='truncate:...:90').
  • ucfirst - makes a value's first character uppercase
  • ucwords - uppercase the first character of each word within the value
  • upper - makes a value uppercase
  • utf8_encode - encodes a string to UTF-8
Event_Detail_Link
Description Generates link and associated code offering the viewer the ability to display a given event using the Event Detail template specified via the event retrieval interface's eventDetail variable or the Event Detail template specified by the branding in use.
Always Available/Required Yes
Attributes
image Specifies the location of the image to be used as the event detail link
text Specifies the text to be used as the event detail link or, if an image is specified, specifies the image's alt attribute
context Specifies whether the event detail information should be encapsulated by header and footer templates. Acceptable values include the following:

 

  • standalone - Event detail information should be encapsulated
  • embedded - Event detail information should not be encapsulated
width If the js method is used to open the event detail information in a new window, specifies the width of the event detail window.
height If the js method is used to open the event detail information in a new window, specifies the height of the event detail window.
onMouseOver Specifies the text to be displayed within a window's status area when the mouse pointer hovers over the event detail link
onMouseOut Specifies the text to be displayed within the window's status area when the mouse pointer moves from the event detail link
method

Specifies the method by which the event detail information will be opened. Acceptable values include the following:

  • js - Specifies javascript code should open window. The js method allows for greater control over window attributes
  • target - Specifies the target attribute of an anchor tag should specify where the event detail information will open/appear
target If the target method is used to open the event detail information, specifies the link's target.
Example %Event_Detail_Link image="http://www.something.com/images/moreInfo.gif" method="target" target="_blank" text="For More Information, Click Here" onMouseOver="More Info Awaits..." onMouseOut="" width="600" height="600"%</p>
Event_ID
Description The unique event id of the event as stored by Sundial
Correspondence (internal)
Always Available/Required Yes
Attributes None
Event_Image
Description Displays image denoted as an event's primary image in the Media area of the Event Editting Interface (i.e. the image that is to represent an event).
Always Available/Required No
Attributes
identifier The size of the image to be displayed. The indentifier may be one of the following values:

 

  • thumb - Thumbnail Image (70 pixels in width)
  • small - Small Image (150 pixels in width)
  • medium - Medium Image (300 pixels in width)
  • large - Large Image (600 pixesl in width)

It is important to remember when one uploads an image within the Event Media area, that the image is converted to the above derivative jpeg formatted images, made to conform to a given width, but allowing their vertical size to follow their aspect ratio.
context The context attribute specifies whether a full <img> tag should be returned or only the URI of the image to be retrieved using the values standalone and embedded, respectively.
border In the standalone context, specifies whether the image should have a border
align In the standalone context, specifies the image's alignment with text and other objects.
Example %Event_Image identifier="thumb"%
Event_Location
Description Text describing the location or address of an event
Correspondence Event > Location > Event Location
Always Available/Required Yes
Attributes
transform A comma separated list of transformations that may be applied to the value of the template variable. Transformations are applied as ordered in the list provided from left to right. Some transformations take attributes, which are specified by appending a colon (:) to the end of the transformation name, followed by the parameter value.
  • collapse - removes excessive newline characters
  • htmldecode - converts all HTML entities to their applicable characters
  • htmlencode - converts all applicable characters to HTML entities
  • lower - makes the value lowercase
  • ltrim - strips whitespace from the beginning of the value
  • nl2br - inserts HTML line breaks before all newlines in a value
  • reverse - reverses a value
  • rtrim - strips whitespace from the end of a value
  • striptags - strips tags from a value
  • title - converts a value to title case
  • trim - strips whitespace from the beginning and end of a string
  • truncate - outputs only the first 80 characters of a string and appends an ellipsis. Optional parameters allow you to override these options (e.g., transform='truncate:...:90').
  • ucfirst - makes a value's first character uppercase
  • ucwords - uppercase the first character of each word within the value
  • upper - makes a value uppercase
  • utf8_encode - encodes a string to UTF-8
Event_Name
Description The name of the event
Correspondence Event > Event Name and Date > Name of Event
Always Available/Required Yes
Attributes
transform A comma separated list of transformations that may be applied to the value of the template variable. Transformations are applied as ordered in the list provided from left to right. Some transformations take attributes, which are specified by appending a colon (:) to the end of the transformation name, followed by the parameter value.
  • collapse - removes excessive newline characters
  • htmldecode - converts all HTML entities to their applicable characters
  • htmlencode - converts all applicable characters to HTML entities
  • lower - makes the value lowercase
  • ltrim - strips whitespace from the beginning of the value
  • nl2br - inserts HTML line breaks before all newlines in a value
  • reverse - reverses a value
  • rtrim - strips whitespace from the end of a value
  • striptags - strips tags from a value
  • title - converts a value to title case
  • trim - strips whitespace from the beginning and end of a string
  • truncate - outputs only the first 80 characters of a string and appends an ellipsis. Optional parameters allow you to override these options (e.g., transform='truncate:...:90').
  • ucfirst - makes a value's first character uppercase
  • ucwords - uppercase the first character of each word within the value
  • upper - makes a value uppercase
  • utf8_encode - encodes a string to UTF-8
Event_Owner_ID
Description The id number of the user entity who originally authored the event
Correspondence (internal)
Always Available/Required Yes
Attributes
transform A comma separated list of transformations that may be applied to the value of the template variable. Transformations are applied as ordered in the list provided from left to right. Some transformations take attributes, which are specified by appending a colon (:) to the end of the transformation name, followed by the parameter value.
  • collapse - removes excessive newline characters
  • htmldecode - converts all HTML entities to their applicable characters
  • htmlencode - converts all applicable characters to HTML entities
  • lower - makes the value lowercase
  • ltrim - strips whitespace from the beginning of the value
  • nl2br - inserts HTML line breaks before all newlines in a value
  • reverse - reverses a value
  • rtrim - strips whitespace from the end of a value
  • striptags - strips tags from a value
  • title - converts a value to title case
  • trim - strips whitespace from the beginning and end of a string
  • truncate - outputs only the first 80 characters of a string and appends an ellipsis. Optional parameters allow you to override these options (e.g., transform='truncate:...:90').
  • ucfirst - makes a value's first character uppercase
  • ucwords - uppercase the first character of each word within the value
  • upper - makes a value uppercase
  • utf8_encode - encodes a string to UTF-8
Event_Sites
Description Returns list of event sites describing location of this event
Correspondence Descriptors > Event Sites
Always Available/Required No
Attributes
none Message to display if no event sites have been associated wtih the event
pre Text to prefix start of list
post Text to suffix end of list
separator Text to be used as separator between event sites within list
siteCollection Boolean value specifying whether to return site collection. Defaults to 'true'.
transform A comma separated list of transformations that may be applied to the value of the template variable. Transformations are applied as ordered in the list provided from left to right. Some transformations take attributes, which are specified by appending a colon (:) to the end of the transformation name, followed by the parameter value.
  • collapse - removes excessive newline characters
  • htmldecode - converts all HTML entities to their applicable characters
  • htmlencode - converts all applicable characters to HTML entities
  • lower - makes the value lowercase
  • ltrim - strips whitespace from the beginning of the value
  • nl2br - inserts HTML line breaks before all newlines in a value
  • reverse - reverses a value
  • rtrim - strips whitespace from the end of a value
  • striptags - strips tags from a value
  • title - converts a value to title case
  • trim - strips whitespace from the beginning and end of a string
  • truncate - outputs only the first 80 characters of a string and appends an ellipsis. Optional parameters allow you to override these options (e.g., transform='truncate:...:90').
  • ucfirst - makes a value's first character uppercase
  • ucwords - uppercase the first character of each word within the value
  • upper - makes a value uppercase
  • utf8_encode - encodes a string to UTF-8
Example %Event_Sites separator="<br>" none="Nowhere"%
Event_Sponsors
Description Returns list of event sponsors
Correspondence Descriptors > Event Sponsors
Always Available/Required No
Attributes
none Message to display if no event sponsors have been associated with the event
pre Text to prefix start of list
post Text to suffix end of list
separator Text to be used as separator between event sponsors within list
primary Allows sponsors to be filtered or sorted by the primary sponsor.
  • all - All Event Sponsors (default)
  • first - Primary Sponsor listed before non-primary sponsors
  • only - Only the primary sponsor is listed
  • exclude - All non-primary sponsors are listed
transform A comma separated list of transformations that may be applied to the value of the template variable. Transformations are applied as ordered in the list provided from left to right. Some transformations take attributes, which are specified by appending a colon (:) to the end of the transformation name, followed by the parameter value.
  • collapse - removes excessive newline characters
  • htmldecode - converts all HTML entities to their applicable characters
  • htmlencode - converts all applicable characters to HTML entities
  • lower - makes the value lowercase
  • ltrim - strips whitespace from the beginning of the value
  • nl2br - inserts HTML line breaks before all newlines in a value
  • reverse - reverses a value
  • rtrim - strips whitespace from the end of a value
  • striptags - strips tags from a value
  • title - converts a value to title case
  • trim - strips whitespace from the beginning and end of a string
  • truncate - outputs only the first 80 characters of a string and appends an ellipsis. Optional parameters allow you to override these options (e.g., transform='truncate:...:90').
  • ucfirst - makes a value's first character uppercase
  • ucwords - uppercase the first character of each word within the value
  • upper - makes a value uppercase
  • utf8_encode - encodes a string to UTF-8
Example %Event_Sponsors separator=", " none="Help! We need a sponsor"%
Event_Status_Code
Description A code identifying the status of the event.
Correspondence Event > Event Name and Date > Event Status
Always Available/Required Yes
Attributes
transform A comma separated list of transformations that may be applied to the value of the template variable. Transformations are applied as ordered in the list provided from left to right. Some transformations take attributes, which are specified by appending a colon (:) to the end of the transformation name, followed by the parameter value.
  • collapse - removes excessive newline characters
  • htmldecode - converts all HTML entities to their applicable characters
  • htmlencode - converts all applicable characters to HTML entities
  • lower - makes the value lowercase
  • ltrim - strips whitespace from the beginning of the value
  • nl2br - inserts HTML line breaks before all newlines in a value
  • reverse - reverses a value
  • rtrim - strips whitespace from the end of a value
  • striptags - strips tags from a value
  • title - converts a value to title case
  • trim - strips whitespace from the beginning and end of a string
  • truncate - outputs only the first 80 characters of a string and appends an ellipsis. Optional parameters allow you to override these options (e.g., transform='truncate:...:90').
  • ucfirst - makes a value's first character uppercase
  • ucwords - uppercase the first character of each word within the value
  • upper - makes a value uppercase
  • utf8_encode - encodes a string to UTF-8
Example

Event status codes presently include the following:

  • A - Active
  • C - Cancelled
  • P - Postponed
  • T - Tentative
Event_Status_Text
Description If an event has a status other than active, displays a status message appropriate to the event's status
Correspondence Event > Event Name and Date > Event Status
Always Available/Required Yes
Attributes
transform A comma separated list of transformations that may be applied to the value of the template variable. Transformations are applied as ordered in the list provided from left to right. Some transformations take attributes, which are specified by appending a colon (:) to the end of the transformation name, followed by the parameter value.
  • collapse - removes excessive newline characters
  • htmldecode - converts all HTML entities to their applicable characters
  • htmlencode - converts all applicable characters to HTML entities
  • lower - makes the value lowercase
  • ltrim - strips whitespace from the beginning of the value
  • nl2br - inserts HTML line breaks before all newlines in a value
  • reverse - reverses a value
  • rtrim - strips whitespace from the end of a value
  • striptags - strips tags from a value
  • title - converts a value to title case
  • trim - strips whitespace from the beginning and end of a string
  • truncate - outputs only the first 80 characters of a string and appends an ellipsis. Optional parameters allow you to override these options (e.g., transform='truncate:...:90').
  • ucfirst - makes a value's first character uppercase
  • ucwords - uppercase the first character of each word within the value
  • upper - makes a value uppercase
  • utf8_encode - encodes a string to UTF-8
Example

Event status descriptions presently include the following:

  • Active
  • Cancelled
  • Postponed
  • Tentative
Event_Subject
Description The short description of the event. This field is often used as an introduction to the event or as a teaser prior to an event's detail display which presents further information.
Correspondence Event > Additional Information > Short Description
Always Available/Required Yes
Attributes
transform A comma separated list of transformations that may be applied to the value of the template variable. Transformations are applied as ordered in the list provided from left to right. Some transformations take attributes, which are specified by appending a colon (:) to the end of the transformation name, followed by the parameter value.
  • collapse - removes excessive newline characters
  • htmldecode - converts all HTML entities to their applicable characters
  • htmlencode - converts all applicable characters to HTML entities
  • lower - makes the value lowercase
  • ltrim - strips whitespace from the beginning of the value
  • nl2br - inserts HTML line breaks before all newlines in a value
  • reverse - reverses a value
  • rtrim - strips whitespace from the end of a value
  • striptags - strips tags from a value
  • title - converts a value to title case
  • trim - strips whitespace from the beginning and end of a string
  • truncate - outputs only the first 80 characters of a string and appends an ellipsis. Optional parameters allow you to override these options (e.g., transform='truncate:...:90').
  • ucfirst - makes a value's first character uppercase
  • ucwords - uppercase the first character of each word within the value
  • upper - makes a value uppercase
  • utf8_encode - encodes a string to UTF-8
Event_Time_Begin
Description Time stamp indicating the start date and time of an event
Correspondence Event > Event Name and Date > Start Date & Start Time
Attributes
transform A comma separated list of transformations that may be applied to the value of the template variable. Transformations are applied as ordered in the list provided from left to right. Some transformations take attributes, which are specified by appending a colon (:) to the end of the transformation name, followed by the parameter value.
  • collapse - removes excessive newline characters
  • htmldecode - converts all HTML entities to their applicable characters
  • htmlencode - converts all applicable characters to HTML entities
  • lower - makes the value lowercase
  • ltrim - strips whitespace from the beginning of the value
  • nl2br - inserts HTML line breaks before all newlines in a value
  • reverse - reverses a value
  • rtrim - strips whitespace from the end of a value
  • striptags - strips tags from a value
  • title - converts a value to title case
  • trim - strips whitespace from the beginning and end of a string
  • truncate - outputs only the first 80 characters of a string and appends an ellipsis. Optional parameters allow you to override these options (e.g., transform='truncate:...:90').
  • ucfirst - makes a value's first character uppercase
  • ucwords - uppercase the first character of each word within the value
  • upper - makes a value uppercase
  • utf8_encode - encodes a string to UTF-8
Event_Time_End
Description Time stamp indicating the end date and time of an event
Correspondence Event > Event Name and Date > Start Date & Start Time
Attributes
transform A comma separated list of transformations that may be applied to the value of the template variable. Transformations are applied as ordered in the list provided from left to right. Some transformations take attributes, which are specified by appending a colon (:) to the end of the transformation name, followed by the parameter value.
  • collapse - removes excessive newline characters
  • htmldecode - converts all HTML entities to their applicable characters
  • htmlencode - converts all applicable characters to HTML entities
  • lower - makes the value lowercase
  • ltrim - strips whitespace from the beginning of the value
  • nl2br - inserts HTML line breaks before all newlines in a value
  • reverse - reverses a value
  • rtrim - strips whitespace from the end of a value
  • striptags - strips tags from a value
  • title - converts a value to title case
  • trim - strips whitespace from the beginning and end of a string
  • truncate - outputs only the first 80 characters of a string and appends an ellipsis. Optional parameters allow you to override these options (e.g., transform='truncate:...:90').
  • ucfirst - makes a value's first character uppercase
  • ucwords - uppercase the first character of each word within the value
  • upper - makes a value uppercase
  • utf8_encode - encodes a string to UTF-8
Event_Types
Description Returns list of event types describing this event
Correspondence Descriptors > Event Types
Always Available/Required No
Attributes
none Message to display if no event types have been associated wtih the event
pre Text to prefix start of list
post Text to suffix end of list
separator Text to be used as separator between event types within list
transform A comma separated list of transformations that may be applied to the value of the template variable. Transformations are applied as ordered in the list provided from left to right. Some transformations take attributes, which are specified by appending a colon (:) to the end of the transformation name, followed by the parameter value.
  • collapse - removes excessive newline characters
  • htmldecode - converts all HTML entities to their applicable characters
  • htmlencode - converts all applicable characters to HTML entities
  • lower - makes the value lowercase
  • ltrim - strips whitespace from the beginning of the value
  • nl2br - inserts HTML line breaks before all newlines in a value
  • reverse - reverses a value
  • rtrim - strips whitespace from the end of a value
  • striptags - strips tags from a value
  • title - converts a value to title case
  • trim - strips whitespace from the beginning and end of a string
  • truncate - outputs only the first 80 characters of a string and appends an ellipsis. Optional parameters allow you to override these options (e.g., transform='truncate:...:90').
  • ucfirst - makes a value's first character uppercase
  • ucwords - uppercase the first character of each word within the value
  • upper - makes a value uppercase
  • utf8_encode - encodes a string to UTF-8
Example %Event_Types separator="<br>" none="No event types!"%
Event_URL
Description The URL a user may visit to find additional or more complete information about an event.
Correspondence Event > Additional Information > Event URL
Always Available/Required No
Attributes
transform A comma separated list of transformations that may be applied to the value of the template variable. Transformations are applied as ordered in the list provided from left to right. Some transformations take attributes, which are specified by appending a colon (:) to the end of the transformation name, followed by the parameter value.
  • collapse - removes excessive newline characters
  • htmldecode - converts all HTML entities to their applicable characters
  • htmlencode - converts all applicable characters to HTML entities
  • lower - makes the value lowercase
  • ltrim - strips whitespace from the beginning of the value
  • nl2br - inserts HTML line breaks before all newlines in a value
  • reverse - reverses a value
  • rtrim - strips whitespace from the end of a value
  • striptags - strips tags from a value
  • title - converts a value to title case
  • trim - strips whitespace from the beginning and end of a string
  • truncate - outputs only the first 80 characters of a string and appends an ellipsis. Optional parameters allow you to override these options (e.g., transform='truncate:...:90').
  • ucfirst - makes a value's first character uppercase
  • ucwords - uppercase the first character of each word within the value
  • upper - makes a value uppercase
  • utf8_encode - encodes a string to UTF-8
Event_Updated
Description Time stamp indicating the date and time an event was last updated within Sundial
Correspondence (internal)
Attributes
transform A comma separated list of transformations that may be applied to the value of the template variable. Transformations are applied as ordered in the list provided from left to right. Some transformations take attributes, which are specified by appending a colon (:) to the end of the transformation name, followed by the parameter value.
  • collapse - removes excessive newline characters
  • htmldecode - converts all HTML entities to their applicable characters
  • htmlencode - converts all applicable characters to HTML entities
  • lower - makes the value lowercase
  • ltrim - strips whitespace from the beginning of the value
  • nl2br - inserts HTML line breaks before all newlines in a value
  • reverse - reverses a value
  • rtrim - strips whitespace from the end of a value
  • striptags - strips tags from a value
  • title - converts a value to title case
  • trim - strips whitespace from the beginning and end of a string
  • truncate - outputs only the first 80 characters of a string and appends an ellipsis. Optional parameters allow you to override these options (e.g., transform='truncate:...:90').
  • ucfirst - makes a value's first character uppercase
  • ucwords - uppercase the first character of each word within the value
  • upper - makes a value uppercase
  • utf8_encode - encodes a string to UTF-8
Event_Updated_By
Description The numeric if of the user entity who last modified the event within the calendar system.
Correspondence (internal)
Always Available/Required Yes
Attributes
transform A comma separated list of transformations that may be applied to the value of the template variable. Transformations are applied as ordered in the list provided from left to right. Some transformations take attributes, which are specified by appending a colon (:) to the end of the transformation name, followed by the parameter value.
  • collapse - removes excessive newline characters
  • htmldecode - converts all HTML entities to their applicable characters
  • htmlencode - converts all applicable characters to HTML entities
  • lower - makes the value lowercase
  • ltrim - strips whitespace from the beginning of the value
  • nl2br - inserts HTML line breaks before all newlines in a value
  • reverse - reverses a value
  • rtrim - strips whitespace from the end of a value
  • striptags - strips tags from a value
  • title - converts a value to title case
  • trim - strips whitespace from the beginning and end of a string
  • truncate - outputs only the first 80 characters of a string and appends an ellipsis. Optional parameters allow you to override these options (e.g., transform='truncate:...:90').
  • ucfirst - makes a value's first character uppercase
  • ucwords - uppercase the first character of each word within the value
  • upper - makes a value uppercase
  • utf8_encode - encodes a string to UTF-8
Harris_RSVP_Link
Description Generates links to Harris Event Registration forms, assuming the event came from the Harris event feed and has registration enabled.
Always Available/Required Yes
Attributes None
Example

Alumni Express Registration: Sign in with a UNI and password
Public Registration: Sign in without a UNI and password
ICal_Link
Description Generates a link to the calendar's iCalendar download function which provides users the ability to download an event into their iCalendar compatible calendar. At the time of this writing, iCalendar-compatible calendars include the following:

 

 

  • Microsoft Outlook 2000 & 2000 (XP)

  • iCal for MacOS X Jaguar

  • Mozilla Calendar

 
Always Available/Required Yes
Attributes
image Specifies the location of the image to be used as the iCalendar download link
text Specifies the text to be used as the iCalendar download link or, if an image is specified, specifies the image's alt attribute
onMouseOver Specifies the text to be displayed within a window's status area when the mouse pointer hovers over the registration link
onMouseOut Specifies the text to be displayed within the window's status area when the mouse pointer moves from the registration link
template Assemblage of text and event template variables specifying the information to be displayed within the description field presented to the user
Example %ICalLink image="http://www.college.columbia.edu/calendar3/images/iCalendar.gif" text="Add To My Calendar" onMouseOver="Click To Add This Event To Your Calendar" onMouseOut=""%
More_Info_Link
Description If Event URL provided, generates link and associated code to URL providing more detailed information about event.
Always Available/Required No
Attributes
image Specifies the location of the image to be used as the more information link
text Specifies the text to be used as the more information link or, if an image is specified, specifies the image's alt attribute
onMouseOver Specifies the text to be displayed within a window's status area when the mouse pointer hovers over the link
onMouseOut Specifies the text to be displayed within the window's status area when the mouse pointer moves from the link
target Specifies the link's target
Example %More_Info_Link image="http://www.college.columbia.edu/calendar3/moreInfo.gif" text="Visit The Event"s Site For More Information" onMouseOver="Click Here for More Information" onMouseOut=""%</p>
RSVP_Link
Description Generates link and associated code to the event's registration form.
Always Available/Required Only if event offers registration
Attributes
image Specifies the location of the image to be used as the registration link
text Specifies the text to be used as the registration link or, if an image is specified, specifies the image's alt attribute
width If the js method is used to open the registration form in a new window, specifies the width of the registration window.
height If the js method is used to open the registration form in a new window, specifies the height of the registration window.
onMouseOver Specifies the text to be displayed within a window's status area when the mouse pointer hovers over the registration link
onMouseOut Specifies the text to be displayed within the window's status area when the mouse pointer moves from the registration link
method

Specifies the method by which the registration form will be opened. Acceptable values include the following:

  • js - Specifies javascript code should open window. The js method allows for greater control over window attributes
  • target - Specifies the target attribute of an anchor tag should specify where the registration form will open/appear
target If the target method is used to open the registration form, specifies the link's target
Example %RSVPLink image="http://www.college.columbia.edu/calendar3/register.gif" text="Register For This Event" onMouseOver="Click To Register For This Event" onMouseOut="" width="600" height="600"%</p>
RSVP_Text
Description If an event requests registration, displays text inviting viewers to register for an event with a corresponding button/link to the RSVP form.
Always Available/Required Only if event offers registration
Attributes
transform A comma separated list of transformations that may be applied to the value of the template variable. Transformations are applied as ordered in the list provided from left to right. Some transformations take attributes, which are specified by appending a colon (:) to the end of the transformation name, followed by the parameter value.
  • collapse - removes excessive newline characters
  • htmldecode - converts all HTML entities to their applicable characters
  • htmlencode - converts all applicable characters to HTML entities
  • lower - makes the value lowercase
  • ltrim - strips whitespace from the beginning of the value
  • nl2br - inserts HTML line breaks before all newlines in a value
  • reverse - reverses a value
  • rtrim - strips whitespace from the end of a value
  • striptags - strips tags from a value
  • title - converts a value to title case
  • trim - strips whitespace from the beginning and end of a string
  • truncate - outputs only the first 80 characters of a string and appends an ellipsis. Optional parameters allow you to override these options (e.g., transform='truncate:...:90').
  • ucfirst - makes a value's first character uppercase
  • ucwords - uppercase the first character of each word within the value
  • upper - makes a value uppercase
  • utf8_encode - encodes a string to UTF-8
Example

  • If registration had not yet opened, the message will read as follows:

    We encourage participants to register in advance. Registration begins on April 15, 2003 at 7:00pm EDT and ends on April 25, 2003 at 7:00pm EDT

  • If registration is presently available, the message will read as follows:

    We encourage participants to register in advance. Please register by April 25, 2003 at 7:00pm EDT

  • If registration period is over, the message will read as follows:

    The registration deadline for this event, April 25, 2004 at 7:00pm EDT, has passed.
Send_Event_Captcha_Image
Description Generates Captcha Image and associated code. Used to prevent spam and abuse of "Send to" option.
Always Available/Required Yes
Attributes None
Example %Send_Event_Captcha_Image%
Send_Event_Captcha_Secret
Description Text entered to match Captcha image. On "Send to" form, input type must be of name "Send_Event_Captcha_Secret" to capture user input.
Always Available/Required Yes
Attributes
transform A comma separated list of transformations that may be applied to the value of the template variable. Transformations are applied as ordered in the list provided from left to right. Some transformations take attributes, which are specified by appending a colon (:) to the end of the transformation name, followed by the parameter value.
  • collapse - removes excessive newline characters
  • htmldecode - converts all HTML entities to their applicable characters
  • htmlencode - converts all applicable characters to HTML entities
  • lower - makes the value lowercase
  • ltrim - strips whitespace from the beginning of the value
  • nl2br - inserts HTML line breaks before all newlines in a value
  • reverse - reverses a value
  • rtrim - strips whitespace from the end of a value
  • striptags - strips tags from a value
  • title - converts a value to title case
  • trim - strips whitespace from the beginning and end of a string
  • truncate - outputs only the first 80 characters of a string and appends an ellipsis. Optional parameters allow you to override these options (e.g., transform='truncate:...:90').
  • ucfirst - makes a value's first character uppercase
  • ucwords - uppercase the first character of each word within the value
  • upper - makes a value uppercase
  • utf8_encode - encodes a string to UTF-8
Example <input name="Send_Event_Captcha_Secret" size="20">
Send_Event_Comments
Description Body of "send event" email. On "Send to" form, input type must have the name "Send_Event_Comments" to capture user input.
Always Available/Required Yes
Attributes
transform A comma separated list of transformations that may be applied to the value of the template variable. Transformations are applied as ordered in the list provided from left to right. Some transformations take attributes, which are specified by appending a colon (:) to the end of the transformation name, followed by the parameter value.
  • collapse - removes excessive newline characters
  • htmldecode - converts all HTML entities to their applicable characters
  • htmlencode - converts all applicable characters to HTML entities
  • lower - makes the value lowercase
  • ltrim - strips whitespace from the beginning of the value
  • nl2br - inserts HTML line breaks before all newlines in a value
  • reverse - reverses a value
  • rtrim - strips whitespace from the end of a value
  • striptags - strips tags from a value
  • title - converts a value to title case
  • trim - strips whitespace from the beginning and end of a string
  • truncate - outputs only the first 80 characters of a string and appends an ellipsis. Optional parameters allow you to override these options (e.g., transform='truncate:...:90').
  • ucfirst - makes a value's first character uppercase
  • ucwords - uppercase the first character of each word within the value
  • upper - makes a value uppercase
  • utf8_encode - encodes a string to UTF-8
Example <textarea name="Send_Event_Comments" rows="5" cols="40">%Send_Event_Comments%</textarea>
Send_Event_Error
Description Contains the error message, should one exist, when using the Send Event feature.
Always Available/Required Yes
Attributes
transform A comma separated list of transformations that may be applied to the value of the template variable. Transformations are applied as ordered in the list provided from left to right. Some transformations take attributes, which are specified by appending a colon (:) to the end of the transformation name, followed by the parameter value.
  • collapse - removes excessive newline characters
  • htmldecode - converts all HTML entities to their applicable characters
  • htmlencode - converts all applicable characters to HTML entities
  • lower - makes the value lowercase
  • ltrim - strips whitespace from the beginning of the value
  • nl2br - inserts HTML line breaks before all newlines in a value
  • reverse - reverses a value
  • rtrim - strips whitespace from the end of a value
  • striptags - strips tags from a value
  • title - converts a value to title case
  • trim - strips whitespace from the beginning and end of a string
  • truncate - outputs only the first 80 characters of a string and appends an ellipsis. Optional parameters allow you to override these options (e.g., transform='truncate:...:90').
  • ucfirst - makes a value's first character uppercase
  • ucwords - uppercase the first character of each word within the value
  • upper - makes a value uppercase
  • utf8_encode - encodes a string to UTF-8
Example %Send_Event_Error%
Send_Event_From_Email
Description Email address of the user sending the event. On the "Send To" form input type must be of name "Send_Event_From_Email" to obtain the sender's email address.
Always Available/Required Yes
Attributes None
Example <input name="Send_Event_From_Email" value="%Send_Event_From_Email%" size="25">
Send_Event_From_Name
Description Name of user sending event. On the "Send To" form input type must be of name "Send_Event_From_Name" to obtain sender's name.
Always Available/Required Yes
Attributes
transform A comma separated list of transformations that may be applied to the value of the template variable. Transformations are applied as ordered in the list provided from left to right. Some transformations take attributes, which are specified by appending a colon (:) to the end of the transformation name, followed by the parameter value.
  • collapse - removes excessive newline characters
  • htmldecode - converts all HTML entities to their applicable characters
  • htmlencode - converts all applicable characters to HTML entities
  • lower - makes the value lowercase
  • ltrim - strips whitespace from the beginning of the value
  • nl2br - inserts HTML line breaks before all newlines in a value
  • reverse - reverses a value
  • rtrim - strips whitespace from the end of a value
  • striptags - strips tags from a value
  • title - converts a value to title case
  • trim - strips whitespace from the beginning and end of a string
  • truncate - outputs only the first 80 characters of a string and appends an ellipsis. Optional parameters allow you to override these options (e.g., transform='truncate:...:90').
  • ucfirst - makes a value's first character uppercase
  • ucwords - uppercase the first character of each word within the value
  • upper - makes a value uppercase
  • utf8_encode - encodes a string to UTF-8
Example <input name="Send_Event_From_Name" value="%Send_Event_From_Name%" size="25">
Send_Event_Link
Description Generates link and associated code to send to a friend form.
Always Available/Required Yes
Attributes
image Specifies the location of the image to be used as the send event link
text Specifies the text to be used as the send event link or, if an image is specified, specifies the image's alt attribute
context Specifies whether the event detail information should be encapsulated by header and footer templates. Acceptable values include the following:

 

  • standalone - Event detail information should be encapsulated
  • embedded - Event detail information should not be encapsulated
width If the js method is used to open the event detail information in a new window, specifies the width of the event detail window.
height If the js method is used to open the event detail information in a new window, specifies the height of the event detail window.
onMouseOver Specifies the text to be displayed within a window's status area when the mouse pointer hovers over the send event link
onMouseOut Specifies the text to be displayed within the window's status area when the mouse pointer moves from the send event link
method

Specifies the method by which the event detail information will be opened. Acceptable values include the following:

  • js - Specifies javascript code should open window. The js method allows for greater control over window attributes
  • target - Specifies the target attribute of an anchor tag should specify where the event detail information will open/appear
target If the target method is used to open the event detail information, specifies the link's target.
Example %Send_Event_Link image='%Sundial_URL%images/sundial_email_event.gif' text='Email Event'%
Send_Event_Subject
Description Subject of "send event" email. On "Send to" form input field must be of name "Send_Event_Subject" to capture user input.
Always Available/Required Yes
Attributes
transform A comma separated list of transformations that may be applied to the value of the template variable. Transformations are applied as ordered in the list provided from left to right. Some transformations take attributes, which are specified by appending a colon (:) to the end of the transformation name, followed by the parameter value.
  • collapse - removes excessive newline characters
  • htmldecode - converts all HTML entities to their applicable characters
  • htmlencode - converts all applicable characters to HTML entities
  • lower - makes the value lowercase
  • ltrim - strips whitespace from the beginning of the value
  • nl2br - inserts HTML line breaks before all newlines in a value
  • reverse - reverses a value
  • rtrim - strips whitespace from the end of a value
  • striptags - strips tags from a value
  • title - converts a value to title case
  • trim - strips whitespace from the beginning and end of a string
  • truncate - outputs only the first 80 characters of a string and appends an ellipsis. Optional parameters allow you to override these options (e.g., transform='truncate:...:90').
  • ucfirst - makes a value's first character uppercase
  • ucwords - uppercase the first character of each word within the value
  • upper - makes a value uppercase
  • utf8_encode - encodes a string to UTF-8
Example <input name="Send_Event_Subject" value="%Send_Event_Subject%" size="25">
Send_Event_To_Email
Description Email address of event notification recipient. If %Send_Event_To_Name% is not present, %Send_Event_To_Email% can contain multiple emails separated by commas or semi-colons. On "Sent to" form, input type should be "Send_Event_To_Email" to capture the email address.
Always Available/Required Yes
Attributes None
Example <input name="Send_Event_To_Email" value="%Send_Event_To_Email%" size="25">
Send_Event_To_Name
Description Name of event email recipient. When used on "Send to" form, input type must be "Send_Event_To_Name" to capture user input.
Always Available/Required Yes
Attributes None
Example <input name="Send_Event_To_Name" value="%Send_Event_To_Name%" size="25">
Send_Event_Url
Description Send_Event_Url provides the url to the script or wrapper being used. The primary use is for the action attribute of forms.
Always Available/Required Yes
Attributes None
Example <form name="foo" method="post" action="%Send_Event_Url%">
Session_User_Name
Description If a user is presently authenticated, displays the domain and user name of the user entity, otherwise indicates no user authenticated
Always Available/Required Yes
Attributes
none Message to be displayed if no user is authenticated to calendar system. By default, the message is 'Non-authenticated user'.
transform A comma separated list of transformations that may be applied to the value of the template variable. Transformations are applied as ordered in the list provided from left to right. Some transformations take attributes, which are specified by appending a colon (:) to the end of the transformation name, followed by the parameter value.
  • collapse - removes excessive newline characters
  • htmldecode - converts all HTML entities to their applicable characters
  • htmlencode - converts all applicable characters to HTML entities
  • lower - makes the value lowercase
  • ltrim - strips whitespace from the beginning of the value
  • nl2br - inserts HTML line breaks before all newlines in a value
  • reverse - reverses a value
  • rtrim - strips whitespace from the end of a value
  • striptags - strips tags from a value
  • title - converts a value to title case
  • trim - strips whitespace from the beginning and end of a string
  • truncate - outputs only the first 80 characters of a string and appends an ellipsis. Optional parameters allow you to override these options (e.g., transform='truncate:...:90').
  • ucfirst - makes a value's first character uppercase
  • ucwords - uppercase the first character of each word within the value
  • upper - makes a value uppercase
  • utf8_encode - encodes a string to UTF-8
Session_User_Security_Groups
Description If a user is presently authenticated, displays the domain and security groups/affiliations of the user. If no user is authenticated, displays the security group to which all users belong by default, 'local.Public/Everyone'
Always Available/Required Yes
Attributes
separator Text to be used as separator between security groups/affiliations within list
transform A comma separated list of transformations that may be applied to the value of the template variable. Transformations are applied as ordered in the list provided from left to right. Some transformations take attributes, which are specified by appending a colon (:) to the end of the transformation name, followed by the parameter value.
  • collapse - removes excessive newline characters
  • htmldecode - converts all HTML entities to their applicable characters
  • htmlencode - converts all applicable characters to HTML entities
  • lower - makes the value lowercase
  • ltrim - strips whitespace from the beginning of the value
  • nl2br - inserts HTML line breaks before all newlines in a value
  • reverse - reverses a value
  • rtrim - strips whitespace from the end of a value
  • striptags - strips tags from a value
  • title - converts a value to title case
  • trim - strips whitespace from the beginning and end of a string
  • truncate - outputs only the first 80 characters of a string and appends an ellipsis. Optional parameters allow you to override these options (e.g., transform='truncate:...:90').
  • ucfirst - makes a value's first character uppercase
  • ucwords - uppercase the first character of each word within the value
  • upper - makes a value uppercase
  • utf8_encode - encodes a string to UTF-8
Start_Date_Time
Description Time stamp indicating the start date and time of an event
Correspondence Event > Event Name and Date > Start Date & Start Time
Attributes
date Specifies the format string in which the date portion of the start date of an event should be returned. The default format string is 'F d, Y'
time Specifies the format string in which the time portion of the start time of an event should be returned. The default format string is 'g:i a'
showTimezone Toggle the display of the timezone in which the event's start time is presented. The default setting is 'Y', set to 'N' to turn off.
transform A comma separated list of transformations that may be applied to the value of the template variable. Transformations are applied as ordered in the list provided from left to right. Some transformations take attributes, which are specified by appending a colon (:) to the end of the transformation name, followed by the parameter value.
  • collapse - removes excessive newline characters
  • htmldecode - converts all HTML entities to their applicable characters
  • htmlencode - converts all applicable characters to HTML entities
  • lower - makes the value lowercase
  • ltrim - strips whitespace from the beginning of the value
  • nl2br - inserts HTML line breaks before all newlines in a value
  • reverse - reverses a value
  • rtrim - strips whitespace from the end of a value
  • striptags - strips tags from a value
  • title - converts a value to title case
  • trim - strips whitespace from the beginning and end of a string
  • truncate - outputs only the first 80 characters of a string and appends an ellipsis. Optional parameters allow you to override these options (e.g., transform='truncate:...:90').
  • ucfirst - makes a value's first character uppercase
  • ucwords - uppercase the first character of each word within the value
  • upper - makes a value uppercase
  • utf8_encode - encodes a string to UTF-8
Sub
Description Returns Template Variable attribute of sub event associated with displayed parent event.
Always Available/Required Yes
Attributes None
Example %Sub.Event_Name%
Sub_Block
Description Loops through all sub events of displayed parent event and returns Template Variable attribute of sub event. *Note: Must have closing tag.
Always Available/Required Yes
Attributes None
Example %Sub_Block%
%Event_Name%
%/Sub_Block%
Returns event name of each sub event.
Sundial_URL
Description The base URL of Sundial
Always Available/Required Yes
Attributes None
Example https://calendar.columbia.edu/sundial/
Super
Description Returns Template Variable attribute of parent event associated with selected child event.
Always Available/Required Yes
Attributes None
Example %Super.Event_Name%
Super_Block
Description Loops through all parent events of selected child event and returns Template Variable attribute of parent event. *Note: Must have closing tag.
Always Available/Required Yes
Attributes None
Example %Super_Block%
%Event_Name%
%/Super_Block%
Returns event name of each super event.
Revised: August 04, 2009
Tags: