Presentation Variables

Presentation variables specify the look, feel, and behavior of the output returned via the event retrieval interface.

Variable		Abbreviation		Description / Usage
viewType		vt		Specifies the the view of events to present to users. The following view types are presently offered:   list Presents event information as a list according the branding's event list template. [ sample ] random Presents event information as a list according the branding's event list template, with the event order randomized [ sample ] detail Presents event information as a list according the branding's event detail template. [ sample ] day Presents event information using the day view template [ sample ] week Presents event information using the week view template [ sample ] weekday Presents event information using the week view template, but omits Saturday and Sunday [ sample ] month Presents event information using the month view template [ sample ] year Presents event information using the year view template [ sample ] miniMonth Presents event information using the mini-month view template [ sample ]
maxEventsDisplayed				When working within a month view type, specifies the maximum number of events to be listed for any given day, before overflowing into the day view with the "More Events" link.
contentType		ct		Specifies whether the calendar should send HTTP headers for HTML, XML, or RSS output.   By default, html output will be presented. When using the XML or RSS content type, the header, footer, and event listing templates must wrap the event information in the relevant tags.
context		con		Specifies whether the calendar should generate output as if it were a standalone browser page or simply provide output that might be embedded within another page.   By default, an embedded context is assumed. In standalone context, the content of the header and footer templates specified by the header and footer variables prefix and append to the output generated by the retrieval interface.
brand		br		Specifies the brand to be used in presenting event information returned. If left unspecified, the default brand of your installation is used.

Working With View Types

Should no viewType be specified, the default behavior of Sundial is to use the list view type to list events using the appropriate eventListing template as described within the Templates > Template Retrieval section of this manual.

The day, week, month, and year view types present event information in a graphically organized manner. When using these view types maxEvents criteria variable is ignored.

• The year view type presents twelve months of numeric calendars. Days of the month are highlighted and linked to the respective day view type should events occur on the given day. The year to present is determined from the dateStart specified.

• The month view type presents a tabular view for a given month. The month to present is determined from the month & year of the dateStart specified.

• The week view type presents a tabular view for a given week. The week to present is determined from the month & year of the dateStart specified.

• The day view type presents a tabular view for a given day. The day to present is determined from the month, day, & year of the dateStart specified.

The graphical organization of these view types is defined internally to the calendar, but can be customized via the specification of style sheet elements as per the documentation found at this URL:

https://calendar.columbia.edu/sundial//index.php?section=css.intro/

Through specification of additional event retrieval interface variables, the various view types articulate within one another.

Variable		Abbreviation		Description / Usage
navList				When working within a day, week, month, or year view type, provides linkage to list view of events.
delta				Decimal number expressed in number of hours or fraction of hour by which to group events within day & week view types
navYear				When working within a day, week, or month view type, provides linkages to year views as appropriate.
navMonth				When working within a day, week, or year view type, provides linkages to month views as appropriate.
navDay				When working within a week, month, or year view type, provides linkages to day views as appropriate.
navWeek				When working within a day, month, or year view type, provides linkages to week views as appropriate.
maxEvents		max		When working within a list view type, specifies the maximum number of events to be returned by the calendar in response to the event retrieval request.

Template Specification Variables

Variable		Abbreviation		Description / Usage
eventListing		el		Specifies a URI or name of a system template that may be used for the formatting and presentation of detailed event information if requested by a calendar user within the list view type. For more information, please see the Template Types section of this manual.
footer		f		Specifies a URI or the name of a system template whose contents will append the output returned by the retrieval interface. For more information, please see the Template Types section of this manual.
header		h		Specifies a URI or the name of a system template whose contents will prefix the output returned by the retrieval interface. For more information, please see the Template Types section of this manual.
noRecords		no		Specifies the URI or name of a system template whose content should be displayed in place of the content body normally returned by the retrieval interface should no events correspond to the criteria specified by the request to the retrieval interface. For more information, please see the Template Types section of this manual.
eventDetail		ed		Specifies a URI or name of a system template that may be used for the formatting and presentation of detailed event information if requested by a calendar user within the detail view type. For more information, please see the Template Types section of this manual.
emailFooter		ef		Specifies a URI or name of a system template providing a emailFooter template. For more information, please see the Template Types section of this manual.
childHeader		ch		Specifies a URI or name of a system template providing a childHeader template. For more information, please see the Template Types section of this manual.
childFooter		cf		Specifies a URI or name of a system template providing a childFooter template. For more information, please see the Template Types section of this manual.
emailHeader		eh		Specifies a URI or name of a system template providing a emailHeader template. For more information, please see the Template Types section of this manual.
attendee		at		Specifies a URI or name of a system template that may be used for the formatting and presentation of attendee information if requested by a calendar user. For more information, please see the Template Types section of this manual.