DokuWiki

It's better when it's simple

User Tools

Site Tools


plugin:dwtimeline

This is an old revision of the document!


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

plugin Provides a timeline in the style of DokuWiki

Last updated on
2022-06-27
Provides
Syntax
Repository
Source

Similar to csstimeline

Tagged with timeline

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>

A simple timeline

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).

OptionDescriptionpossible in
titleIf set the top entry of a box. this is enclosed in an <h2> tag.<dwtimeline>, <milestone>, </dwtimeline>
descriptionIf set the second entry of a box. this is enclosed in an <h3> tag.<dwtimeline>, <milestone>, </dwtimeline>
linkIf set, the title becomes the link. The link must be in DokuWiki format ([[http://example.com|External Link]]).<milestone>

Examples:

Entry box

<dwtimeline title="Title of Timeline" description="A additional description">
</dwtimeline>

Entry box

Entry and Exit box

<dwtimeline title="Title of Timeline" description="A additional description">
</dwtimeline title="End of Timeline">

Entry box

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">

Timeline

Configuration and Settings

The following settings are available in the configuration manager:

SettingDescriptionValues[default]
directionOn 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:

ElementColor in stylestyle.ine
Box background and timelineNeutral background color@ini_background_neu
TextMain text color@ini_text
Timeline circleThe general link color@ini_link

Development

Change Log

  • 2022-06-27
    • Initial release

Known Bugs and Issues

  1. 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]

Discussion

plugin/dwtimeline.1656414410.txt.gz · Last modified: 2022-06-28 13:06 by saggi

Except where otherwise noted, content on this wiki is licensed under the following license: CC Attribution-Share Alike 4.0 International
CC Attribution-Share Alike 4.0 International Donate Powered by PHP Valid HTML5 Valid CSS Driven by DokuWiki