plugin:eventline
Differences
This shows you the differences between two versions of the page.
Both sides previous revisionPrevious revisionNext revision | Previous revisionLast revisionBoth sides next revision | ||
plugin:eventline [2013-01-10 18:44] – Fix du lien d'exemple 81.252.187.81 | plugin:eventline [2015-03-19 06:28] – 37.200.79.25 | ||
---|---|---|---|
Line 1: | Line 1: | ||
- | ====== | + | ====== |
---- plugin ---- | ---- plugin ---- | ||
- | description: | + | description: |
author | author | ||
email : tcafferty@glocalfocal.com | email : tcafferty@glocalfocal.com | ||
type : syntax, action | type : syntax, action | ||
- | lastupdate : 2011-12-29 | + | lastupdate : 2013-04-18 |
- | compatible : 2010-11-07, | + | compatible : 2010-11-07, |
- | depends | + | depends |
conflicts | conflicts | ||
similar | similar | ||
tags : timeline, time, diagram, media | tags : timeline, time, diagram, media | ||
- | downloadurl: | + | downloadurl: |
- | bugtracker : http:// | + | bugtracker : https:// |
- | sourcerepo : http:// | + | sourcerepo : https:// |
donationurl: | donationurl: | ||
+ | |||
+ | screenshot_img : | ||
---- | ---- | ||
- | The eventline plugin integrates the [[http:// | + | The eventline plugin integrates the [[http:// |
This is a modification of the tline plugin by Dan Kreiser. | This is a modification of the tline plugin by Dan Kreiser. | ||
Line 28: | Line 30: | ||
* [[plugin: | * [[plugin: | ||
- | * [[plugin: | ||
===== Installation ===== | ===== Installation ===== | ||
- | - Install the required plugin of Keywords (if not already installed). | ||
- Install the required plugin of Tools (if not already installed). | - Install the required plugin of Tools (if not already installed). | ||
- | - 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/ | + | - 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 '' |
- | - Modify the .htaccess file in the dokuwiki/ | + | |
- | < | + | |
- | < | + | |
- | Order Allow, | + | |
- | Allow from all | + | |
- | </ | + | |
- | </ | + | |
===== Examples/ | ===== Examples/ | ||
- | See the plugin in action here: [[http:// | + | See the plugin in action here: [[http:// |
+ | |||
+ | An example using some of the updates from 03/2013 such as a hotzone, colored icons, and html can be seen here [[http:// | ||
This plugin requires the following minimum syntax. | This plugin requires the following minimum syntax. | ||
Line 51: | Line 46: | ||
< | < | ||
< | < | ||
- | {{keywords> | ||
</ | </ | ||
* 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 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. | + | Save the page and clear the cache. The page should now display an empty timeline with a "Go to filename data" link. The link shows by default to all. You can set '' |
- | Select the filename link and Create this page. This file will contain the timeline event data in XML format. | + | Select the filename link and Create this page. **This file will contain the timeline event data in XML format. |
< | < | ||
Line 67: | Line 60: | ||
</ | </ | ||
- | A sample data file is provided in / | + | **A sample data file is provided in '' |
- | At the end of the file after the </ | + | At the end of the file after the '' |
< | < | ||
Line 75: | Line 68: | ||
</ | </ | ||
- | 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 | + | 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 |
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/ | 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/ | ||
+ | |||
+ | **Update**: The update on **June 01 2013** added the ability to create a timeline in french. To do this add the following keyword to the page that contains the timeline data. You would need the [[Keywords]] plugin to do that. | ||
+ | |||
+ | < | ||
+ | {{keywords> | ||
+ | </ | ||
+ | |||
+ | In addition when using french you must use double quotes when specifying event parameters and use single quotes when quoting anything in the description. Here is an example of an event listed in french | ||
+ | |||
+ | < | ||
+ | <event start=" | ||
+ | </ | ||
+ | |||
===== Syntax ===== | ===== Syntax ===== | ||
Line 83: | Line 89: | ||
< | < | ||
< | < | ||
- | {{keywords> | ||
</ | </ | ||
Line 90: | Line 95: | ||
===== Configuration and Settings ===== | ===== Configuration and Settings ===== | ||
- | The following table shows the parameters that can be added to the < | + | The following table shows the parameters that can be added to the < |
^ Parameter | ^ Parameter | ||
Line 98: | Line 103: | ||
| mouse | scroll, zoom, default | | mouse | scroll, zoom, default | ||
| center | | center | ||
- | | controls | + | | controls |
| bandPos | | bandPos | ||
| detailPercent | | detailPercent | ||
| overPercent | | overPercent | ||
- | | detailPixels | ||
- | | overPixels | ||
| detailInterval | | detailInterval | ||
| overInterval | | overInterval | ||
- | + | | hotzone | |
- | All parameters must be preceded and succeeded with an ampersand symbol (&). The format of a parameter is <nowiki>& | + | | hzStart, hzStart2, hzStart3 |
+ | | hzEnd, hzEnd2, hzEnd3 | ||
+ | | hzMagnify, hzMagnify2, hzMagnify3 | ||
+ | | hzUnit, hzUnit2, hzUnit3 | MILLISECOND, | ||
+ | All parameters must be preceded and succeeded with an ampersand symbol (&). The format of a parameter is <eventline>& | ||
< | < | ||
< | < | ||
- | {{keywords> | ||
</ | </ | ||
- | All parameter defaults can be changed by modifying the / | + | A hotzone can be specified. A hotzone is a place in the timeline that would focus in to a smaller time interval for that zone. This allows you to avoid crowding the timeline for an interval in which a lot of events would occur. You need to specify the start and end date of the hotzone, the time unit to use in the hotzone and the magnification size. For example a magnification of 2 would double the interval size. You can specify up to three hotzones by adding the parameters with a 2 or 3 at the end for the others. You do not need to specify hotzones that you are not using they will default to null. |
+ | |||
+ | :!: The following html feature does not work on dokuwiki versions after Adora Belle. | ||
+ | |||
+ | //The plugin allows limited use of html in your timeline data page. The user can specify the event description using dokuwiki syntax or some html. Currently not all dokuwiki syntax will work. It has been tested for the following dokuwiki syntax// | ||
+ | * new lines, | ||
+ | * links, | ||
+ | * bold and italics, | ||
+ | * and sup and sub html tags | ||
+ | |||
+ | Colored bubble pings were added in the 3/2013 update. These can now be referred to in the data file using the icon parameter. An example would be // | ||
+ | |||
+ | All parameter defaults can be changed by modifying the '' | ||
===== Acknowledgements ===== | ===== Acknowledgements ===== | ||
Line 124: | Line 142: | ||
=== Change Log === | === Change Log === | ||
- | {{rss>http:// | + | {{rss>https:// |
=== Known Bugs and Issues === | === Known Bugs and Issues === | ||
- | - Interferes with display of Dokuwiki Administration Configuration Settings Page (2011/ | + | - When using a dash (or minus sign, -) this can cause an odd special character in the xml file if the wrong dash/minus sign is used. This will cause the timeline not to processs and show blank. Not sure what the bad symbol |
+ | - Wikihtml feature does not work on dokuwiki versions after Adora Belle. | ||
=== ToDo/Wish List === | === ToDo/Wish List === | ||
- | + | * more timelines in 1 page would be kind ;) -- Celano, 2013-08-08 | |
===== FAQ ===== | ===== FAQ ===== | ||
Line 139: | Line 157: | ||
===== Discussion ===== | ===== Discussion ===== | ||
+ | > 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. | ||
+ | |||
+ | * I tried several times before I understood tools-plugin does not work in your playground. So you have to make it elsewhere, and it works very well! | ||
+ | * comments like ''< | ||
+ | |||
+ | Celano, 2013-08-08 | ||
+ | |||
+ | ==== Xml syntax ==== | ||
+ | |||
+ | There is a bug when dokuwiki " | ||
+ | |||
+ | Another problem with XML syntax : xml comments in events file are transformed and break the render because of spaces added inside xml comment tag. \\ | ||
+ | result example : <! -- Faire les liens vers le Blog | ||
+ | Added an issue : https:// | ||
+ | --- [[user> | ||
plugin/eventline.txt · Last modified: 2020-06-04 16:28 by StarArmy