eventline Plugin

The eventline plugin integrates the MIT Simile Project Timeline with dokuwiki. This provides the ability to add an interactive timeline to a wiki page. Wiki users can edit timeline data for adding events. A timeline event can have a bubble popup with description, an image and an external link.

This is a modification of the tline plugin by Dan Kreiser. I wanted to remove the javascript from the user interface and make changes to the user API.

This plugin requires the following additional components that must be installed separately:

• Tools plugin
• Keywords plugin

1. Install the required plugin of Keywords (if not already installed).
2. Install the required plugin of Tools (if not already installed).
3. Modify Tools plugin. Upload the files from this release's /tools folder into the respective plugins/tools folders overwriting the baseline tools plugin files. (Note: If you were using the tools plugin save your current tools/conf/default.php file. The update will turn off all other tools. After the update modify the new default.php file to turn the tools you were using back on in the variable $conf['tools']).
4. Install the eventline plugin using the Plugin Manager and the download URL above. If you install this plugin manually, make sure it is installed in lib/plugins/eventline/
5. Modify the .htaccess file in the dokuwiki/data folder to allow access to xml files. Either save the current htaccess file and replace it with the one provided in this release's /data folder or add the following lines to your .htaccess file

<FilesMatch "\.(xml)$">
 Order Allow,Deny
 Allow from all
</FilesMatch>

See the plugin in action here: Glocal Focal Wiki. On that wiki the peace page also contains a timeline.

This plugin requires the following minimum syntax.

<eventline>&file=filename&</eventline>
{{keywords>timeline}}

• The filename can be any valid filename without the file extension. The file would not exist when creating the timeline. This file will be populated by the user with data for timeline events.
• The keywords plugin is used to identify the page as using the timeline and then the javascript needed is included on the page.

Save the page and clear the cache. The page should now display an empty timeline with a “Go to filename data” link.

Select the filename link and Create this page. This file will contain the timeline event data in XML format. Everything is contained within a <data> element. The data element is composed of one or more <event> elements. Event elements follow a format of

<event .... event parameters such as dates, title, and optional link and image >
A description
</event>

A sample data file is provided in /example/exampleDataForCutAndPaste.txt. You can cut and paste the sample data into your newly created filename file. The sample folder also contains images that you can upload for your wiki events using the dokuwiki button to insert images. Insert the images within the starting event brackets (<>) and not in the description section. (Note: That while the dokuwiki format to insert images works, the link in the event parameters must be link='…' and does not use the dokuwiki link format.)

At the end of the file after the </data> end tag add the following plugin code. This will provide an export selection that is used in the next step.

~~TOOLS:both~~

When ready save the file. The file page should display the plugin Tools selection to Export To Timeline in the top and bottom right corners of the page. Select this to export the dokuwiki formatted text file into a text formatted xml file.

Return to your timeline page and upon clearing the cache the timeline should now be populated with the data. The timeline should be able to be scrolled, events selected for display and the filtering/highlighting selectors can be used to focus on any words used in the events.

Basic syntax:

<eventline>&file=filename&</eventline>
{{keywords>timeline}}

Documentation of the syntax used in the data file can be found under Event attributes and data formats at SIMILE Timeline Documentation

The following table shows the parameters that can be added to the <eventline>...</eventline> plugin to allow users to configure thier timeline.

All parameters must be preceded and succeeded with an ampersand symbol (&). The format of a parameter is &parameter=value&. There are no quotes used and the & would not be repeated when specifying more than one parameter. An example would be

<eventline>&file=wiki&detailInterval=YEAR&overInterval=DECADE&</eventline>
{{keywords>timeline}}

All parameter defaults can be changed by modifying the /eventline/conf/default.php file.

This plugin is indebted to the tline plugin by Dan Kreiser. He provided the foundation for interfacing with the Simile code. The tline plugin contains additional localization capability.

• remove setting of keyword in code (2012/05/01 01:55)
• update date in info function for last change (2011/12/29 13:43)
• add set keyword to syntax.php (2011/12/29 13:31)
• Fix interference with Configuration Settings Page (2011/12/07 02:58)
• Add getInfo function (2011/11/13 00:59)
• first commit of all code (2011/10/12 19:07)
• first commit (2011/10/12 18:12)

1. Interferes with display of Dokuwiki Administration Configuration Settings Page (2011/12/06 - Closed)
   Issue closed. Fix is in Commit on 2011/12/06