iCalendar Plugin

This plugin allows you to display events from iCalendar in your website. It was initially based on the icalevents plugin by Robert Rackl.

The plugin reads the *.ics file from a URL and parses it into DokuWiki using pre-defined Templates from the configuration.

Version 1.4:

• Added extendable 'showAs' parameter, which allows users to add their own templates.
• Altered templates to allow DokuWiki Syntax, rather than HTML.
• Added default, list and table templates.
• Fixed 'previewDays' issue.
• Improved behavior of the 'sort' parameter.
• Backward compatibility to older versions.

Version 1.3:

• Added parameter 'sort', which allows the entries to be sorted in reverse order.

Version 1.2:

• Fixed timezones for reoccuring events.

Version 1.1:

• Optional link to VEVENT, so that other users can add it to their calendar.
• Event descriptions may now contain DokuWiki syntax.

Version 1.0:

• Number of preview days is now optional.
• Dates are now displayed using the local timezone settings of the server.
• An optional 'to' date can be set to display events up until a certain date.
• A maximum number of entries to display can be set.
• The events can now be displayed in two alternate ways, using a listed format or an extended view format (see configuration_and_settings).
• Displays re-occuring events.
• Allow external and internal links in events to link to external or internal pages using the [[ExternalPage]] or [[ExternalPage|Description]] tags. (See Features)
• Automatically parses contents of an internal page into the event description using the [InternalPage] tag. (See Features)

Install the plugin using the Plugin Manager and the download URL above, which points to latest version of the plugin. Refer to Plugins on how to install plugins manually.

• {{iCalendar>http://host/myCalendar.ics}} ¹⁾
• {{iCalendar>http://host/myCalendar.ics#from=today&previewDays=30}} ²⁾
• {{iCalendar>http://host/myCalendar.ics#from=01/01/2011&previewDays=30}} ³⁾
• {{iCalendar>http://host/myCalendar.ics#from=today}} ⁴⁾
• {{iCalendar>http://host/myCalendar.ics#to=today}} ⁵⁾
• {{iCalendar>http://host/myCalendar.ics#from=today&numberOfEntries=5}} ⁶⁾
• {{iCalendar>http://host/myCalendar.ics#sort=DESC}} ⁷⁾
• {{iCalendar>http://host/myCalendar.ics#showAs=list}} ⁸⁾

View the Online Demonstration

{{iCalendar>icsUrl#key=value&..&key=value}}

Multiple key=value parameters can be set using the & as a seperator.

Available parameters:

The user may add their own configuration parameters for their entry templates. The appropriate configuration parameter for the template can be set via the syntax parameter showAs.

In order to make a new template, for example one that displays all entries as an unsorted list, the configuration files must be changed as follows:

conf/metadata.php

If you wish to alter your self-created template in the administration panel, you must setup the metadata for this parameter.

Example:

$meta['unsortedlist'] = array('');

conf/default.php

If you wish to set a default setting for the newly created parameter, you can set it up in default.php. This is optional, you can also use the administration panel to setup the configuration parameter.

$conf['unsortedlist'] = '  * {date}: {summary} ';

showAs

Once the configuration parameter has been added, you can use it in the plugin syntax:

{{iCalendar>http://host/myCalendar.ics#showAs=unsortedlist}}

Using the configuration parameters listHTML and viewHTML alternate HTML templates may be configured to display the events. The templates used for these parameters are plain HTML containing specific tags that will be interpreted by the plugin.

The templates, which can be configured in conf/default.php, or via the administraton panel, is parsed using the following tags:

default

===== {date}: {summary} =====

**Location**: {location_link}\\\\
{description}

list

====== {date}: {summary} ======
**<sup>Location: {location}</sup>**\\
{description}

viewHTML:

<h2>{summary}</h2><p><small><strong>{date}</strong></small><br /><br /><b>Location</b>: {location}<br /><br />{description}

listHTML:

<p><small><b>{date}</b></small><br/><b>{summary}</b><br/>{description}</p>

Here is a list of the files currently used in the plugin.

• 2011-11-19 Hotfix
  • Added hotfix, since p_render was called without the third parameter, which gave warnings. Should be fixed now.
• 2011-11-14 Version 1.4
  • Added extendable 'showAs' parameter, which allows users to add their own templates.
  • Altered templates to allow DokuWiki Syntax.
  • Added default, list and table templates.
  • Fixed 'previewDays' issue.
  • Improved behavior of the 'sort' parameter.
• 2011-11-09 Version 1.3
  • Added reverse sorting of entries
• 2011-11-06 Version 1.2
  • Minor bugfixes
  • Timezone fix for reoccuring events.
• 2011-10-09 Hotfix
  • Added hotfix, since p_render was called without the third parameter, which gave warnings. Should be fixed now.
• 2011-10-04 Version 1.1
  • Minor bugfixes
  • Event descriptions can now contain DokuWiki syntax, for Example [[URL|Description]].
  • Added 'includeLink' syntax parameter, which adds a link to the summary with the original VEVENT. By clicking the link, users are able to add the event to their own .ics calendar.
  • Added 'tformat' configuration parameter, where the time format can be configured.
• 2011-09-29 Version 1.0
  • Initial release

1. (Solved) When there is an url in the calendar event, the plugin renders it wrong. Sometimes it converts the slashes after http: to italic slashes. So the url is wrong and everything after http: is italic. The strange thing is, that this doesnt happen with every url.
   • If you wish to use URL's in your calendar event, please use the DokuWiki Syntax [[URL]]. I use standard DokuWiki functionality to turn the event description into HTML. The Syntax // is used for Italic by DokuWiki, so that could be the cause of the problem. Good luck! JDT
     • This works great thanks for the tip.
2. (Solved in v1.2) Maybe I found another bug: when I set a repeating event in Google Calendar, the plugin shows the time incorrect by 1 hour. When i set a normal event, the time is allright.
   • Thanks. Ok, I have found the timezone error, it seems that the DTSTART and DTEND times for repeating events have a different timezone than the normal events. I have now added the support for the TZID elements within DTSTART and DTEND which defines those individual timezones. I released Version 1.2 to this end, since many people currently use Version 1.1 and timezones are always a bit fiddly. I will look into reoccurring events more in the upcoming days, since the plugin currently only regards individual VEVENTs, but does not regard a single VEVENT being used for multiple events.JDT
3. (Solved in v1.4) 'previewDays' is not working for me. Using this command: {{iCalendar>http://obfuscated.my/icalfile#from=today&previewDays=30&showAsList=1}} I get all events from today through next year(Dec 2012). This is a calendar of holidays, so all events are 'all day events' (in case that's relevant). The calendar is stored in a Kerio Connect mail server. -MJM
   • Fixed in version 1.4.
4. (Solved in v1.4 Hotfix) In Version 1.4, this error is on every wikipage with icalendar: Warning: Missing argument 3 for p_render(), called in /www/htdocs/wiki/lib/plugins/iCalendar/syntax.php on line 247 and defined in /www/htdocs/wiki/inc/parserutils.php on line 647.
   • Hi, unfortunately, due to many changes, this error “slipped back in”. You can fix it by changing line 247 of syntax.php to

     $html = p_render($mode, p_get_instructions( $ret ), $info );

     or download v1.4 again, since I added a hotfix. JDT

• Support for reoccurring events.JDT

• Why did you make a new plugin, rather than adjust the existing icalevents plugin ?
  • Well, initially, I thought it would be best to change the existing plugin to fix a few bugs here and there, but as I got along, I found more and more things I wanted in the plugin, such as dynamically being able to adjust the presentation and adding new parameters. Whilst the icalevents plugin covers my basic needs, which is loading *.ics files and turning them into HTML, I did not want to start making loads of patches to the existing plugin, but rather have the option of altering the complete functionality.

1. (Solved in v1.3) Thanks for your work. Would it be possible to add an option to display the latest calendar entry on top and the oldest one at the bottom?
   • Hi there. I have added a new parameter 'sort' in Version 1.3, which you can set to DESC to sort in reverse order. I hope meets your requirement. JDT
     • Perfect, thank you very much.
2. (Added in v1.4) I'd love to be able to display the output in a table, or using multiple options - perhaps by expanding 'showAsList' into a generic 'showAs' directive: &showAs=table, &showAs=list, &showAs=day &showAs=week, &showAs=month, &showAs=year (or &showAs=planner, or &showAs=gantt). -MJM
   • Hi, I added this feature as described in v1.4 with three standard configurations &showAs=default, &showAs=list and &showAs=table. You can add your own templates by adding configuration parameters as described in Entry templates. I hope that meets your requirements. JDT
3. (Added in v1.4) I'd like to be able to specify wiki formatting as well as HTML in the template configurations, e.g. | {date} | {location} | {summary} (({description})) | (with the objective being to show a table with date, location and summary, with the description included as a footnote/mouse tip). -MJM
   • You should now be able to use DokuWiki syntax for your templates. If you wish to use HTML, you can use the <html></html> tags. JDT
4. Thanks for the useful plugin, Jannes! I had a problem with wiki formatting in multiline descriptions. For example, the following description in an event would not render as expected:

   DESCRIPTION:^  2:00 pm | Meeting: introduction and group assignments.  |\n^
      3:00 pm | Work on research proposal: Find a good scientific question.  |\
    n^  6:00 pm | Dinner.  |\n^  7:00 pm | Seminar.  |\n
        

   The problem seems to be that “\n” isn't interpreted as a linebreak. I was able to get it working by changing lines 119-123 in functions.php to

   	if                (preg_match($regex_description, $vevent, $description)) {
   		$entry['description'] = $description[1];
   		$entry['description'] = preg_replace("/[\r\n] ?/", "", $entry['description']);       
   		$entry['description'] = str_replace('\,', ',', $entry['description']);        
   		$entry['description'] = str_replace('\\n', "\n", $entry['description']); // added!  Replace newlines in description with actual linebreaks [Rik, 2011-12-27]
   	}

   Do you think this is worth adding? — Rik BlokRik Blok
   rikblok
   
   2011/12/28 04:54

1. What about https-Links?
   

when I use

• {{iCalendar>https://my.host.com/myCalendar.ics}}
  

I always get some error “cannot fetch ttps:\/\/my.host.com\/myCalendar.ics”

  //Paul//

Thank you for your contributions!