Help:ICalendar format
| ICalendar format |
|---|
| What: |
| Exports data in iCalendar format. |
| Provided by: |
| Semantic Result Formats |
| Added in version: |
| 1.4.2 |
| Removed in version: |
| still supported |
| Further Requirements: |
| none |
| Format name: |
| icalendar |
| Authors: |
| Markus Krötzsch, Denny Vrandecic, Jeroen De Dauw |
| Categories: |
| export |
The result format icalendar, part of Semantic Result Formats, is used to produce links for downloading data from a wiki in iCalendar format.
Contents |
Parameters
| Parameter | Type | Default | Description |
|---|---|---|---|
| limit | Whole number | 20 | The maximum number of results to return |
| offset | Whole number | 0 | The offset of the first result |
| headers | Text | show | Display the headers/property names |
| mainlabel | Text | no | The label to give to the main page name |
| link | Text | all | Show values as links |
| searchlabel | Text | no | The text for the link to results |
| title | Text | empty | The title of the calendar file |
| description | Text | empty | The description of the calendar file |
Example
{{#ask: [[Category:Person]]
| ?title = summary
| ?startdate = start
| ?enddate = end
| ?location = location
| ?description = description
| format=icalendar
}}
This would display a link to download the iCalendar file. Examples can be found on any event page on semanticweb.org, e.g. http://semanticweb.org/wiki/ISWC2008.
Data fields
Properties in printout statements should use one of the following labels, or otherwise are ignored in the resulting iCalendar. The available fields are:
- summary: the short description shown as the label of the calendar entry (type arbitrary, but String would be common), available from version 1.7.0
- start: the start date, must be of type Date,
- end: the end date, must be of type Date,
- location: the place of the event (type arbitrary, but Page would be common),
- description: description of a single event (not suported by all tools, but useful to have more than the short page name as an event name.
Remarks
Calendars work very well on most calendar tools, with the notable exception of MS Outlook up to version 2003. Only later versions of this tool can deal with calendars that have more than one event.
Calendar downloads can be used in two ways by a calendar software. Either the calendar is downloaded and imported into a local calendar, or it is subscribed to and updated regularly. In the former case, changes in the wiki will not affect the imported dates, while in the latter case changes in the wiki will be propagated to the subscriber of the calendar.
