This is an old revision of the document!
Table of Contents
dwtimeline Plugin
Compatible with DokuWiki
- 2024-02-06 "Kaos" unknown
- 2023-04-04 "Jack Jackrum" unknown
- 2022-07-31 "Igor" yes
- 2020-07-29 "Hogfather" yes
Similar to csstimeline
dwtimeline provides a timeline with alternating boxes formatted in the style of the DokuWiki settings. Boxes for start and end are also possible.
Installation
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.
Examples/Usage
An entry in the timeline is made via milestones. The entry should have at least the following format:
<dwtimeline> <milestone> Between the milestone start and end, you can even use Wiki markup </milestone> </dwtimeline>
Syntax
The basic syntax is shown above.
A timeline starts with the <dwtimeline>
tag and ends with the </dwtimeline>
tag. The milestones are placed in between. The content of each milestone box is enclosed between the <milestone>
and </milestone>
tag.The content can contain normal DokuWiki syntax.
Every entry-tag can have options. But only the dwtimeline exit-tag can also have options.
The options must be in the following format: <entry option=“value”>
.
Option and value are separated by =
. The value must be enclosed by “
. The options do not understand DokuWiki syntax (exception: link
).
Option | Description | possible in |
---|---|---|
title | If set the top entry of a box. this is enclosed in an <h2> tag. | <dwtimeline> , <milestone> , </dwtimeline> |
description | If set the second entry of a box. this is enclosed in an <h3> tag. | <dwtimeline> , <milestone> , </dwtimeline> |
link | If set, the title becomes the link. The link must be in DokuWiki format ([[http://example.com|External Link]]). | <milestone> |
Examples:
Entry box
Entry and Exit box
<dwtimeline title="Title of Timeline" description="A additional description"> </dwtimeline title="End of Timeline">
Complete Timeline
<dwtimeline title="Title of Timeline" description="A additional description"> <milestone title="First milestone" description="My first timeline entry" > Between the milestone start and end, you can even use Wiki markup, e.g. images: {{:wiki:dokuwiki-128.png?100|}} </milestone> <milestone title="Second milestone with link" description="My second timeline entry" link="[[http://example.com|External Link]]"> A milestone entry accepts title, description and link as options. Everytime followed by ''='' and the option surrounded by ''"'': < code> title="Second milestone with link" description="My second timeline entry" link="[[http://example.com|External Link]]" < /code> This one is rendered at the **other** side of the //timeline// </milestone> <milestone title="Third milestone" description="My third timeline entry" link="[[playground:playground|]]"> This one is rendered at the other side of the timeline <WRAP center round info 60%> info box </WRAP> </milestone> </dwtimeline title="End of Timeline">
Configuration and Settings
The following settings are available in the configuration manager:
Setting | Description | Values[default] |
---|---|---|
direction | On which side should the timeline start (left,right)? The position of the first milestone box to the timeline. | [left ],right |
The following colours are used and depend on the style chosen:
Element | Color in style | style.ine |
---|---|---|
Box background and timeline | Neutral background color | @ini_background_neu |
Text | Main text color | @ini_text |
Timeline circle | The general link color | @ini_link |
Development
Change Log
- 2022-06-27
- Initial release
Known Bugs and Issues
- Nested milestone blocks are not possible
ToDo/Wish List
- Something that would be really nice would be to allow a date and/or time in the little circles. I honestly don't know how difficult this would be, or indeed if it is possible.
- Not at the moment, but I'm thinking about it. [saggi]