[ Learn how to update your events manually]
| Description: | Includes events from the university's events database on a page. Completely customizable display, from the number of events and what information for each to include to the html that is used to display them. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| Syntax: |
<cf_eventslist
Template = "template_name"
Categories = "categories,to,include"
SortByColumn = "column_to_sort_by"
SortByMethod = "ASC" or "DESC"
NumberOfEvents = "number_to_show"
AfterDateTime = "date_and_time_events_must_start_after"
BeforeDateTime = "date_and_time_events_must_end_before"
DetailsPage = "details_page"
QueryVariable = "details_page_query_variable"
DateFormat = "date_format"
TimeFormat = "time_format"
ShortDescriptionLength = "short_description_length"
EventKey = "event_key"
HoursBetweenUpdates = "number_of_hours"
ExcludeKeys = "DB_keys_to_exclude"
Debug = "1 or 0">
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| See also: | cf_newslist | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| Attributes: | The attributes that can be provided for this tag are all optional, but since the Category and the NumberOfEvents attributes both default to 'All', this would include every event in the database! Set some attributes to narrow down the scope of what is included. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| Returns: | Outputs the list of events according to search parameters and specified html. Also, creates several variables in the calling page. The first is needed to access the rest. A unique string of numbers is created when the tag is called. This string is used to create a file (in the same directory as the calling page) that is simply included when the page is requested. When a certain amount of time has passed, the tag automatically refreshes the data that is displayed. The variables created are listed below, with #unique# representing the unique string: eventsList_uniqueString = #unique# (the unique string itself) eventsList_contentFile_#unique# = path_to_file (the path to the include file that is created) eventsList_recreatedContentFile_#unique# = true or false (whether or not the file was refreshed this time) eventsList_queryRecordCount_#unique# = number (how many events were actually displayed by this tag, this time) eventsList_databaseKeysIncluded_#unique# = list (a comma-separated list of the database keys of the events that were included) |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| Appearance: | The UMASS Dartmouth Web Development team has created / will create a number of pre-set templates for what information is included on the page that calls the tag, and how that information is displayed. A list of these templates with a brief description of how they look follows: portals-today Shows events that are occurring between the current time and the end of the current day, displaying time and title only. portals-upcoming Shows events that will occur after the current day, displaying date and title only. ---> The appearance of events displayed with this tag is fully customizable, in that when the tag is called on a page, the html that is used to lay out the information can be provided as the body of the tag. See examples below for an illustration of this. If an html body is provided to the tag, then any value for the Template attribute is ignored. When creating this html, the following variables are used to specify where the event information is inserted:
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| How to update your events manually: | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| This custom tag is pre-set to automatically update itself every 12 hours. But you may have a need of manually refreshing the information that appears. In order to do this, you can copy the URL address of your page that shows events, and paste it into the text field below. Click on the 'Update' button, and you will be taken to your page, with the information updated. You can then bookmark that link, and any time you use this bookmark the events on your page will be manually refreshed. | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| How it works: | The first time that the tag is hit (ie. when the page that it is called from is requested), it generates a unique string of numbers from the attributes that are specified. It then creates a file in the same directory as the page it is called from. The file's name looks something like 'eventslist_134564.cfm'. It will create one file for each time that the tag is called with different attributes on pages in the same directory, but by the same logic, if two pages in the same directory call the tag with the same attributes, they will share a file. Each time after the first, when the page is requested, the tag will check to see when the file was last updated. If it is within a certain specified time limit, the page will just be included. If the time period has passed, then the file will be recreated, and then included. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| Examples: |
<cf_eventsList categories="All" template="portals-upcoming" sortbycolumn="Location" NumberOfEvents="10" /> There was an error using the specified template:Could not find the included template template_portals-upcoming.cfm. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
