Timelines Plugin final release 1.0.0

[Mohammad]

Announcement: New Timelines plugin

Date: Aug 9th, 2019

Release: 1.0.0 final release

Only work on TW5.1.20+ (it uses new filter operators and mathematical operators only exist in 5.1.20)

 

Timelines Plugin

9th August 2019 at 8:07am

Tiddlywiki5.1.18+

 

LicenseMIT

 

Release1.0.0

 

Statusbeta

How to use

Timelines is a collection of four macros for creating vertical and horizontal timeline and sequence. The content or description and data of events are stored in individual tiddlers.

Timelines contain two timeline macros and two sequence macros. A sequence macro shows event contents in sequence not necessarily in chronological order. The order can be determined by tag or list field or other methods.

The date of events can be stored in a separate field or the modified field can be used.

Syntax

<<timeline-horizontal filter limit:10 template:"" footer:"footer" 
                      class date:"modified" stateTiddler dateformat:"YYYY">>
<<sequence-horizontal filter limit:10 template:"" footer:"footer" 
                      class date:"modified" stateTiddler dateformat:"mmm DDth YYYY">>

<<timeline-vertical filter limit:10 template:"" footer:"footer" class date:"modified">>
<<sequence-vertical filter limit:10 template:"" footer:"footer" class date:"modified">>

Content and parameters

Parameter	Type	Description
filter	required	a Tiddlywiki filter to select tiddlers for presentation
limit	optional	maximum number of tiddlers to be shown. Default value is 10
template	optional	a template to display the tiddler content
footer	optional	the field name which stores an extra text to be displayed as footer
class	optional	an extra class to customize how tiddler content is displayed
date	optional	the field name which stores a date in standard Tiddlywiki format. Default field is modified
stateTiddler	optional	the name of a state tiddler to keep the state of events. Each call to macro needs a unique state tiddler
dateformat	optional	only in timeline-horizontal and timeline-vertical, the format for displaying event date.

More explanation with examples can be found at GitHub demo page.

The dateformat parameter

The dateformat lets to customize the event date displayed on the timeline.

timeline-horizontal

For timeline-horizontal macro the default value is YYYY, the other two forms of date are

• mmm DDth, and
• 0DD mmm YYYY.

Other format will not be displayed!

timeline-vertical

For the timeline-vertical macro the default value is mmm DDth YYYY, the other two forms of date are

• mmm DDth to show only the month and day and hide year
• YYYY to show only year and hide the month

Other format will not be displayed!

Install

Simply drag and drop $:/plugins/kookma/timelines into your wiki

Project code and demo

• GitHub demo page
• GitHub code page

Change log

1.0.0 – final release

9th August 2019

• The timeline-horizontal gets data format to control how event date is displayed
• Timelines macros have gotten new name for consistency
• Several demo tiddlers have been added
• Documentation has been improved

0.6.0 – beta release

31st July 2019

• New tehran timeline added
• New ilam timeline added

0.5.0 – first release

28th July 2019

• added gilan timeline
• added kerman timeline

Acknowledgement

• All Tiddlywikians

Your feedback is highly appreciated.

If you like it, star it at GitHub

Previous announcement:  https://groups.google.com/d/msg/tiddlywiki/aI3fAqChBGA/XavLLJ2pCgAJ

Best regards

Mohammad

[TonyM]

Mohammad

Excelent and great demo site. Thanks so much for this work. Lets see if lists now look a lot more beautiful.

Thanks
Tony

[Sylvain Naudin]

Very nice demo indeed ! Congrats and thank for your contributions.

Maybe update badge to match 5.1.20 ;-)

Tiddlywiki5.1.18+

 

Cheers,

Sylvain

[Mohammad]

Good point it even does not work in 5.1.18
😄

[Mohammad]

Thanks Tony
This plugin covers some of our previous discussion on conditional operations.

Thanks to great new filter operators in TW 5.1.20

Mohammad

[Mohammad]

Hi Sylvain,

 The Timelines now updated to 5.1.20 final release and has corrected those typo.

Thank you for your feedback.

Cheers

Mohammad