When you publish your calendar, Trumba Connect generates RSS, Atom (XML), iCalendar (ICS), Comma Separated Value (CSV), and JSON feeds that visitors can access from your calendar. Visitors can subscribe to your RSS or Atom feed to get notified of your calendar updates as soon as you make them. They can download the ICS or CSV feeds to a file that they can then import into their own calendar or CSV-compatible programs.
By default, a calendar's feed shows six months of event information starting from the current day. This topic describes how to edit the date range and number of events that are sent through a feed and how to add xCal data to RSS feeds. You can make these changes in feeds that:
Note The information in this topic assumes that you have published your calendar or are familiar with the publishing process. Learn more about publishing calendars.
You can customize the feed that is sent when a visitor clicks the RSS button, or, on the Subscribe page, subscribes to the Atom (XML) feed, or downloads the ICS file.
For example, suppose you publish the annual calendar for the National Football League two months before the season actually begins. Avid fans will immediately begin subscribing to the feed. If the feed you provide covers events that take place starting in the current week and ending five weeks later, the feed will be empty and fans will be frustrated and confused. By changing the default start and end dates, you can provide fans with the season schedule information they need.
If you feed event data to Twitter or other services that show HTML tags rather than the formatted result, select No.
For the iCal feed, it's usually best to select No. Many calendar programs, including Microsoft Office Outlook, display the HTML tags rather than the formatted result.
You can opt to include an additional publish date. The source for that date can be either the event's start date or the date the event was added or changed.
You might want to include a publish date if many of your events are ongoing or if you frequently add new and update existing events.
Tip Under Image Settings, if you set Show Image to Yes but, in your feeds, you're not seeing the images you expect, try switching the Image Type setting to Event Image.
Enter a comma-delimited list of the allowed website URLs (domains), from which javascript can access the Trumba JSON feed.
Important http vs https are separate domains, and must be listed separately.
How and whether or not a feed preview displays depends upon:
Tip For RSS or Atom feeds, you can also preview a feed by copying the feed URL and using the URL to subscribe to the feed from within the feed reader you typically use.
If you want to provide links on your webpages for a choice of different feeds, you can build your own URLs in addition to customizing the default feed. For example, if you publish a calendar of events for a group of nightclubs, you might want provide viewers with the current week's all-ages vs. 21 and older shows, or the current week's shows at each club.
Note Although this topic addresses calendar publishers, anyone can use this information to create a custom URL to retrieve data from a Trumba Connect published calendar.
To add the query strings, at the end of the default URL for the feed, add a question mark (?) to begin the first parameter, and use an ampersand (&) to combine parameters. For example:
In your calendar settings, if you set Week display starts to Sunday, this will display events that occur between Sun. and Sat. of the week that includes Dec. 5, 2016. In other words, events that occur on Dec. 4–10.
The following table lists the feed-specific parameters you can use to customize an RSS, Atom, iCal, CSV, or JSON feed.
Tip Calendar feeds also support some spud URL parameters. For example, you can use the search parameter to display a feed consisting only of events that contain specific search terms. Use this table to identify spud parameters you can also use to customize feeds.
| Parameter | How to use it |
|---|---|
| startdate | Specify a start date. If not specified, uses the current date. Date format is yyyymmdd, for example, 20161205 for 5 Dec. 2016.
Note Formerly the date parameter was used to specify the start date. The date parameter is still supported for the time being, but for new feeds, please use startdate instead. |
| enddate | Specify an end date using the same date format as for startdate above. If not specified, all future events are included in the feed. |
| months | Number of calendar months to retrieve. Use months=0 to retrieve one day only. If excluded, the default setting is six months. |
| weeks | Number of calendar weeks to retrieve. |
| days | Number of days to retrieve (frequently used with the startdate parameter). |
| previousweeks | Number of weeks previous to the specified date to retrieve. If previousweeks is excluded, the feed will include two weeks' worth of events previous to the specified date (or the current date if date is not specified). |
| html | If you added HTML formatting to the event Notes and other multi-line text custom fields, this parameter controls whether or not to include that formatting in the event data. Values are 1 for Yes and 0 for No.
You can override the default Yes setting by adding html=0 to a feed URL. Use this approach if you feed events to Twitter and other services that do not support HTML tags. |
| customnotes | Most calendar programs, including Microsoft Office Outlook, that read the Trumba iCal feed do not recognize the feed's custom field data. You can use this parameter to include the custom field data at the top of the Description field.
Values are 1 (Yes, include fields in Description) and 0 (No, do not include fields in Description). You can override the default No setting by adding customnotes=1 to a feed URL. |
| xcal | Add xcal=1 to an RSS feed to include xCal-namespace data. Supported only by RSS. |
Time periods are based on calendar weeks and months. For example, if you specify a date and a number of months, the information returned will start from the first of the month specified in the date. Likewise, information returned for weeks is determined by the week start day in the calendar settings. Usually weeks are set to start on Sunday or Monday.
Use the xCal parameter to enable access to the calendar's RSS data via XSLT. If xcal=1, the RSS feed will include the following xCal tags for basic data that applies to the calendar or to each event.
| Tag | Applies to |
|---|---|
| xCal:prodid | calendar |
| xCal:version | calendar |
| xCal:method | calendar |
| xCal:summary | event |
| xCal:location | event |
| xCal:dtstart | event |
| xCal:duration | event |
| xCal:x-microsoft-cdo-alldayevent | event |
| xCal:description | event |
| xCal:uid | event |
For example, to the following default event information:
<item>
|
The following additional information appears:
<xCal:summary>Massenet's Manon</xCal:summary>
|
And the following calendar tags appear a the top of the feed.
<xCal:prodid>
-//Trumba Corporation//Trumba Connect Services 0.11.1402//EN
</xCal:prodid>
<xCal:version>2.0</xCal:version>
<xCal:method>PUBLISH</xCal:method>
<xCal:calscale>GREGORIAN</xCal:calscale>
|
The default base URL for a feed is always your calendar's address on the Trumba Connect hosted server, with the appropriate extension appended to it.
Trumba Connect makes your published calendar feeds available in two locations:
The information available in a feed depends on which URL you use.
You can publish calendars with password protection.
